drivers/hv/hyperv_vmbus.h

   1 /*
   2  *
   3  * Copyright (c) 2011, Microsoft Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU General Public License,
   7  * version 2, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  16  * Place - Suite 330, Boston, MA 02111-1307 USA.
  17  *
  18  * Authors:
  19  *   Haiyang Zhang <haiyangz@microsoft.com>
  20  *   Hank Janssen  <hjanssen@microsoft.com>
  21  *   K. Y. Srinivasan <kys@microsoft.com>
  22  *
  23  */
  24
  25 #ifndef _HYPERV_VMBUS_H
  26 #define _HYPERV_VMBUS_H
  27
  28 #include <linux/list.h>
  29 #include <linux/bitops.h>
  30 #include <asm/sync_bitops.h>
  31 #include <asm/hyperv-tlfs.h>
  32 #include <linux/atomic.h>
  33 #include <linux/hyperv.h>
  34 #include <linux/interrupt.h>
  35
  36 #include "hv_trace.h"
  37
  38 /*
  39  * Timeout for services such as KVP and fcopy.
  40  */
  41 #define HV_UTIL_TIMEOUT 30
  42
  43 /*
  44  * Timeout for guest-host handshake for services.
  45  */
  46 #define HV_UTIL_NEGO_TIMEOUT 55
  47
  48 /* Define synthetic interrupt controller flag constants. */
  49 #define HV_EVENT_FLAGS_COUNT            (256 * 8)
  50 #define HV_EVENT_FLAGS_LONG_COUNT       (256 / sizeof(unsigned long))
  51
  52 /*
  53  * Timer configuration register.
  54  */
  55 union hv_timer_config {
  56         u64 as_uint64;
  57         struct {
  58                 u64 enable:1;
  59                 u64 periodic:1;
  60                 u64 lazy:1;
  61                 u64 auto_enable:1;
  62                 u64 apic_vector:8;
  63                 u64 direct_mode:1;
  64                 u64 reserved_z0:3;
  65                 u64 sintx:4;
  66                 u64 reserved_z1:44;
  67         };
  68 };
  69
  70
  71 /* Define the synthetic interrupt controller event flags format. */
  72 union hv_synic_event_flags {
  73         unsigned long flags[HV_EVENT_FLAGS_LONG_COUNT];
  74 };
  75
  76 /* Define SynIC control register. */
  77 union hv_synic_scontrol {
  78         u64 as_uint64;
  79         struct {
  80                 u64 enable:1;
  81                 u64 reserved:63;
  82         };
  83 };
  84
  85 /* Define synthetic interrupt source. */
  86 union hv_synic_sint {
  87         u64 as_uint64;
  88         struct {
  89                 u64 vector:8;
  90                 u64 reserved1:8;
  91                 u64 masked:1;
  92                 u64 auto_eoi:1;
  93                 u64 reserved2:46;
  94         };
  95 };
  96
  97 /* Define the format of the SIMP register */
  98 union hv_synic_simp {
  99         u64 as_uint64;
 100         struct {
 101                 u64 simp_enabled:1;
 102                 u64 preserved:11;
 103                 u64 base_simp_gpa:52;
 104         };
 105 };
 106
 107 /* Define the format of the SIEFP register */
 108 union hv_synic_siefp {
 109         u64 as_uint64;
 110         struct {
 111                 u64 siefp_enabled:1;
 112                 u64 preserved:11;
 113                 u64 base_siefp_gpa:52;
 114         };
 115 };
 116
 117 /* Definitions for the monitored notification facility */
 118 union hv_monitor_trigger_group {
 119         u64 as_uint64;
 120         struct {
 121                 u32 pending;
 122                 u32 armed;
 123         };
 124 };
 125
 126 struct hv_monitor_parameter {
 127         union hv_connection_id connectionid;
 128         u16 flagnumber;
 129         u16 rsvdz;
 130 };
 131
 132 union hv_monitor_trigger_state {
 133         u32 asu32;
 134
 135         struct {
 136                 u32 group_enable:4;
 137                 u32 rsvdz:28;
 138         };
 139 };
 140
 141 /* struct hv_monitor_page Layout */
 142 /* ------------------------------------------------------ */
 143 /* | 0   | TriggerState (4 bytes) | Rsvd1 (4 bytes)     | */
 144 /* | 8   | TriggerGroup[0]                              | */
 145 /* | 10  | TriggerGroup[1]                              | */
 146 /* | 18  | TriggerGroup[2]                              | */
 147 /* | 20  | TriggerGroup[3]                              | */
 148 /* | 28  | Rsvd2[0]                                     | */
 149 /* | 30  | Rsvd2[1]                                     | */
 150 /* | 38  | Rsvd2[2]                                     | */
 151 /* | 40  | NextCheckTime[0][0]    | NextCheckTime[0][1] | */
 152 /* | ...                                                | */
 153 /* | 240 | Latency[0][0..3]                             | */
 154 /* | 340 | Rsvz3[0]                                     | */
 155 /* | 440 | Parameter[0][0]                              | */
 156 /* | 448 | Parameter[0][1]                              | */
 157 /* | ...                                                | */
 158 /* | 840 | Rsvd4[0]                                     | */
 159 /* ------------------------------------------------------ */
 160 struct hv_monitor_page {
 161         union hv_monitor_trigger_state trigger_state;
 162         u32 rsvdz1;
 163
 164         union hv_monitor_trigger_group trigger_group[4];
 165         u64 rsvdz2[3];
 166
 167         s32 next_checktime[4][32];
 168
 169         u16 latency[4][32];
 170         u64 rsvdz3[32];
 171
 172         struct hv_monitor_parameter parameter[4][32];
 173
 174         u8 rsvdz4[1984];
 175 };
 176
 177 #define HV_HYPERCALL_PARAM_ALIGN        sizeof(u64)
 178
 179 /* Definition of the hv_post_message hypercall input structure. */
 180 struct hv_input_post_message {
 181         union hv_connection_id connectionid;
 182         u32 reserved;
 183         u32 message_type;
 184         u32 payload_size;
 185         u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
 186 };
 187
 188
 189 enum {
 190         VMBUS_MESSAGE_CONNECTION_ID     = 1,
 191         VMBUS_MESSAGE_CONNECTION_ID_4   = 4,
 192         VMBUS_MESSAGE_PORT_ID           = 1,
 193         VMBUS_EVENT_CONNECTION_ID       = 2,
 194         VMBUS_EVENT_PORT_ID             = 2,
 195         VMBUS_MONITOR_CONNECTION_ID     = 3,
 196         VMBUS_MONITOR_PORT_ID           = 3,
 197         VMBUS_MESSAGE_SINT              = 2,
 198 };
 199
 200 /*
 201  * Per cpu state for channel handling
 202  */
 203 struct hv_per_cpu_context {
 204         void *synic_message_page;
 205         void *synic_event_page;
 206         /*
 207          * buffer to post messages to the host.
 208          */
 209         void *post_msg_page;
 210
 211         /*
 212          * Starting with win8, we can take channel interrupts on any CPU;
 213          * we will manage the tasklet that handles events messages on a per CPU
 214          * basis.
 215          */
 216         struct tasklet_struct msg_dpc;
 217
 218         /*
 219          * To optimize the mapping of relid to channel, maintain
 220          * per-cpu list of the channels based on their CPU affinity.
 221          */
 222         struct list_head chan_list;
 223         struct clock_event_device *clk_evt;
 224 };
 225
 226 struct hv_context {
 227         /* We only support running on top of Hyper-V
 228          * So at this point this really can only contain the Hyper-V ID
 229          */
 230         u64 guestid;
 231
 232         void *tsc_page;
 233
 234         bool synic_initialized;
 235
 236         struct hv_per_cpu_context __percpu *cpu_context;
 237
 238         /*
 239          * To manage allocations in a NUMA node.
 240          * Array indexed by numa node ID.
 241          */
 242         struct cpumask *hv_numa_map;
 243 };
 244
 245 extern struct hv_context hv_context;
 246
 247 /* Hv Interface */
 248
 249 extern int hv_init(void);
 250
 251 extern int hv_post_message(union hv_connection_id connection_id,
 252                          enum hv_message_type message_type,
 253                          void *payload, size_t payload_size);
 254
 255 extern int hv_synic_alloc(void);
 256
 257 extern void hv_synic_free(void);
 258
 259 extern int hv_synic_init(unsigned int cpu);
 260
 261 extern int hv_synic_cleanup(unsigned int cpu);
 262
 263 extern void hv_synic_clockevents_cleanup(void);
 264
 265 /* Interface */
 266
 267
 268 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
 269                        struct page *pages, u32 pagecnt);
 270
 271 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
 272
 273 int hv_ringbuffer_write(struct vmbus_channel *channel,
 274                         const struct kvec *kv_list, u32 kv_count);
 275
 276 int hv_ringbuffer_read(struct vmbus_channel *channel,
 277                        void *buffer, u32 buflen, u32 *buffer_actual_len,
 278                        u64 *requestid, bool raw);
 279
 280 /*
 281  * Maximum channels is determined by the size of the interrupt page
 282  * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
 283  * and the other is receive endpoint interrupt
 284  */
 285 #define MAX_NUM_CHANNELS        ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
 286
 287 /* The value here must be in multiple of 32 */
 288 /* TODO: Need to make this configurable */
 289 #define MAX_NUM_CHANNELS_SUPPORTED      256
 290
 291
 292 enum vmbus_connect_state {
 293         DISCONNECTED,
 294         CONNECTING,
 295         CONNECTED,
 296         DISCONNECTING
 297 };
 298
 299 #define MAX_SIZE_CHANNEL_MESSAGE        HV_MESSAGE_PAYLOAD_BYTE_COUNT
 300
 301 struct vmbus_connection {
 302         /*
 303          * CPU on which the initial host contact was made.
 304          */
 305         int connect_cpu;
 306
 307         u32 msg_conn_id;
 308
 309         atomic_t offer_in_progress;
 310
 311         enum vmbus_connect_state conn_state;
 312
 313         atomic_t next_gpadl_handle;
 314
 315         struct completion  unload_event;
 316         /*
 317          * Represents channel interrupts. Each bit position represents a
 318          * channel.  When a channel sends an interrupt via VMBUS, it finds its
 319          * bit in the sendInterruptPage, set it and calls Hv to generate a port
 320          * event. The other end receives the port event and parse the
 321          * recvInterruptPage to see which bit is set
 322          */
 323         void *int_page;
 324         void *send_int_page;
 325         void *recv_int_page;
 326
 327         /*
 328          * 2 pages - 1st page for parent->child notification and 2nd
 329          * is child->parent notification
 330          */
 331         struct hv_monitor_page *monitor_pages[2];
 332         struct list_head chn_msg_list;
 333         spinlock_t channelmsg_lock;
 334
 335         /* List of channels */
 336         struct list_head chn_list;
 337         struct mutex channel_mutex;
 338
 339         /*
 340          * An offer message is handled first on the work_queue, and then
 341          * is further handled on handle_primary_chan_wq or
 342          * handle_sub_chan_wq.
 343          */
 344         struct workqueue_struct *work_queue;
 345         struct workqueue_struct *handle_primary_chan_wq;
 346         struct workqueue_struct *handle_sub_chan_wq;
 347 };
 348
 349
 350 struct vmbus_msginfo {
 351         /* Bookkeeping stuff */
 352         struct list_head msglist_entry;
 353
 354         /* The message itself */
 355         unsigned char msg[0];
 356 };
 357
 358
 359 extern struct vmbus_connection vmbus_connection;
 360
 361 static inline void vmbus_send_interrupt(u32 relid)
 362 {
 363         sync_set_bit(relid, vmbus_connection.send_int_page);
 364 }
 365
 366 enum vmbus_message_handler_type {
 367         /* The related handler can sleep. */
 368         VMHT_BLOCKING = 0,
 369
 370         /* The related handler must NOT sleep. */
 371         VMHT_NON_BLOCKING = 1,
 372 };
 373
 374 struct vmbus_channel_message_table_entry {
 375         enum vmbus_channel_message_type message_type;
 376         enum vmbus_message_handler_type handler_type;
 377         void (*message_handler)(struct vmbus_channel_message_header *msg);
 378 };
 379
 380 extern const struct vmbus_channel_message_table_entry
 381         channel_message_table[CHANNELMSG_COUNT];
 382
 383
 384 /* General vmbus interface */
 385
 386 struct hv_device *vmbus_device_create(const uuid_le *type,
 387                                       const uuid_le *instance,
 388                                       struct vmbus_channel *channel);
 389
 390 int vmbus_device_register(struct hv_device *child_device_obj);
 391 void vmbus_device_unregister(struct hv_device *device_obj);
 392 int vmbus_add_channel_kobj(struct hv_device *device_obj,
 393                            struct vmbus_channel *channel);
 394
 395 void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
 396
 397 struct vmbus_channel *relid2channel(u32 relid);
 398
 399 void vmbus_free_channels(void);
 400
 401 /* Connection interface */
 402
 403 int vmbus_connect(void);
 404 void vmbus_disconnect(void);
 405
 406 int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
 407
 408 void vmbus_on_event(unsigned long data);
 409 void vmbus_on_msg_dpc(unsigned long data);
 410
 411 int hv_kvp_init(struct hv_util_service *srv);
 412 void hv_kvp_deinit(void);
 413 void hv_kvp_onchannelcallback(void *context);
 414
 415 int hv_vss_init(struct hv_util_service *srv);
 416 void hv_vss_deinit(void);
 417 void hv_vss_onchannelcallback(void *context);
 418
 419 int hv_fcopy_init(struct hv_util_service *srv);
 420 void hv_fcopy_deinit(void);
 421 void hv_fcopy_onchannelcallback(void *context);
 422 void vmbus_initiate_unload(bool crash);
 423
 424 static inline void hv_poll_channel(struct vmbus_channel *channel,
 425                                    void (*cb)(void *))
 426 {
 427         if (!channel)
 428                 return;
 429
 430         if (in_interrupt() && (channel->target_cpu == smp_processor_id())) {
 431                 cb(channel);
 432                 return;
 433         }
 434         smp_call_function_single(channel->target_cpu, cb, channel, true);
 435 }
 436
 437 enum hvutil_device_state {
 438         HVUTIL_DEVICE_INIT = 0,  /* driver is loaded, waiting for userspace */
 439         HVUTIL_READY,            /* userspace is registered */
 440         HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
 441         HVUTIL_USERSPACE_REQ,    /* request to userspace was sent */
 442         HVUTIL_USERSPACE_RECV,   /* reply from userspace was received */
 443         HVUTIL_DEVICE_DYING,     /* driver unload is in progress */
 444 };
 445
 446 #endif /* _HYPERV_VMBUS_H */