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