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