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 <linux/atomic.h>
  31 #include <linux/hyperv.h>
  32
  33 /*
  34  * Timeout for services such as KVP and fcopy.
  35  */
  36 #define HV_UTIL_TIMEOUT 30
  37
  38 /*
  39  * Timeout for guest-host handshake for services.
  40  */
  41 #define HV_UTIL_NEGO_TIMEOUT 55
  42
  43 /*
  44  * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
  45  * is set by CPUID(HVCPUID_VERSION_FEATURES).
  46  */
  47 enum hv_cpuid_function {
  48         HVCPUID_VERSION_FEATURES                = 0x00000001,
  49         HVCPUID_VENDOR_MAXFUNCTION              = 0x40000000,
  50         HVCPUID_INTERFACE                       = 0x40000001,
  51
  52         /*
  53          * The remaining functions depend on the value of
  54          * HVCPUID_INTERFACE
  55          */
  56         HVCPUID_VERSION                 = 0x40000002,
  57         HVCPUID_FEATURES                        = 0x40000003,
  58         HVCPUID_ENLIGHTENMENT_INFO      = 0x40000004,
  59         HVCPUID_IMPLEMENTATION_LIMITS           = 0x40000005,
  60 };
  61
  62 #define  HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE   0x400
  63
  64 #define HV_X64_MSR_CRASH_P0   0x40000100
  65 #define HV_X64_MSR_CRASH_P1   0x40000101
  66 #define HV_X64_MSR_CRASH_P2   0x40000102
  67 #define HV_X64_MSR_CRASH_P3   0x40000103
  68 #define HV_X64_MSR_CRASH_P4   0x40000104
  69 #define HV_X64_MSR_CRASH_CTL  0x40000105
  70
  71 #define HV_CRASH_CTL_CRASH_NOTIFY (1ULL << 63)
  72
  73 /* Define version of the synthetic interrupt controller. */
  74 #define HV_SYNIC_VERSION                (1)
  75
  76 #define HV_ANY_VP                       (0xFFFFFFFF)
  77
  78 /* Define synthetic interrupt controller flag constants. */
  79 #define HV_EVENT_FLAGS_COUNT            (256 * 8)
  80 #define HV_EVENT_FLAGS_BYTE_COUNT       (256)
  81 #define HV_EVENT_FLAGS_DWORD_COUNT      (256 / sizeof(u32))
  82
  83 /* Define invalid partition identifier. */
  84 #define HV_PARTITION_ID_INVALID         ((u64)0x0)
  85
  86 /* Define port type. */
  87 enum hv_port_type {
  88         HVPORT_MSG      = 1,
  89         HVPORT_EVENT            = 2,
  90         HVPORT_MONITOR  = 3
  91 };
  92
  93 /* Define port information structure. */
  94 struct hv_port_info {
  95         enum hv_port_type port_type;
  96         u32 padding;
  97         union {
  98                 struct {
  99                         u32 target_sint;
 100                         u32 target_vp;
 101                         u64 rsvdz;
 102                 } message_port_info;
 103                 struct {
 104                         u32 target_sint;
 105                         u32 target_vp;
 106                         u16 base_flag_number;
 107                         u16 flag_count;
 108                         u32 rsvdz;
 109                 } event_port_info;
 110                 struct {
 111                         u64 monitor_address;
 112                         u64 rsvdz;
 113                 } monitor_port_info;
 114         };
 115 };
 116
 117 struct hv_connection_info {
 118         enum hv_port_type port_type;
 119         u32 padding;
 120         union {
 121                 struct {
 122                         u64 rsvdz;
 123                 } message_connection_info;
 124                 struct {
 125                         u64 rsvdz;
 126                 } event_connection_info;
 127                 struct {
 128                         u64 monitor_address;
 129                 } monitor_connection_info;
 130         };
 131 };
 132
 133 /*
 134  * Timer configuration register.
 135  */
 136 union hv_timer_config {
 137         u64 as_uint64;
 138         struct {
 139                 u64 enable:1;
 140                 u64 periodic:1;
 141                 u64 lazy:1;
 142                 u64 auto_enable:1;
 143                 u64 reserved_z0:12;
 144                 u64 sintx:4;
 145                 u64 reserved_z1:44;
 146         };
 147 };
 148
 149 /* Define the number of message buffers associated with each port. */
 150 #define HV_PORT_MESSAGE_BUFFER_COUNT    (16)
 151
 152 /* Define the synthetic interrupt controller event flags format. */
 153 union hv_synic_event_flags {
 154         u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
 155         u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
 156 };
 157
 158 /* Define the synthetic interrupt flags page layout. */
 159 struct hv_synic_event_flags_page {
 160         union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
 161 };
 162
 163 /* Define SynIC control register. */
 164 union hv_synic_scontrol {
 165         u64 as_uint64;
 166         struct {
 167                 u64 enable:1;
 168                 u64 reserved:63;
 169         };
 170 };
 171
 172 /* Define synthetic interrupt source. */
 173 union hv_synic_sint {
 174         u64 as_uint64;
 175         struct {
 176                 u64 vector:8;
 177                 u64 reserved1:8;
 178                 u64 masked:1;
 179                 u64 auto_eoi:1;
 180                 u64 reserved2:46;
 181         };
 182 };
 183
 184 /* Define the format of the SIMP register */
 185 union hv_synic_simp {
 186         u64 as_uint64;
 187         struct {
 188                 u64 simp_enabled:1;
 189                 u64 preserved:11;
 190                 u64 base_simp_gpa:52;
 191         };
 192 };
 193
 194 /* Define the format of the SIEFP register */
 195 union hv_synic_siefp {
 196         u64 as_uint64;
 197         struct {
 198                 u64 siefp_enabled:1;
 199                 u64 preserved:11;
 200                 u64 base_siefp_gpa:52;
 201         };
 202 };
 203
 204 /* Definitions for the monitored notification facility */
 205 union hv_monitor_trigger_group {
 206         u64 as_uint64;
 207         struct {
 208                 u32 pending;
 209                 u32 armed;
 210         };
 211 };
 212
 213 struct hv_monitor_parameter {
 214         union hv_connection_id connectionid;
 215         u16 flagnumber;
 216         u16 rsvdz;
 217 };
 218
 219 union hv_monitor_trigger_state {
 220         u32 asu32;
 221
 222         struct {
 223                 u32 group_enable:4;
 224                 u32 rsvdz:28;
 225         };
 226 };
 227
 228 /* struct hv_monitor_page Layout */
 229 /* ------------------------------------------------------ */
 230 /* | 0   | TriggerState (4 bytes) | Rsvd1 (4 bytes)     | */
 231 /* | 8   | TriggerGroup[0]                              | */
 232 /* | 10  | TriggerGroup[1]                              | */
 233 /* | 18  | TriggerGroup[2]                              | */
 234 /* | 20  | TriggerGroup[3]                              | */
 235 /* | 28  | Rsvd2[0]                                     | */
 236 /* | 30  | Rsvd2[1]                                     | */
 237 /* | 38  | Rsvd2[2]                                     | */
 238 /* | 40  | NextCheckTime[0][0]    | NextCheckTime[0][1] | */
 239 /* | ...                                                | */
 240 /* | 240 | Latency[0][0..3]                             | */
 241 /* | 340 | Rsvz3[0]                                     | */
 242 /* | 440 | Parameter[0][0]                              | */
 243 /* | 448 | Parameter[0][1]                              | */
 244 /* | ...                                                | */
 245 /* | 840 | Rsvd4[0]                                     | */
 246 /* ------------------------------------------------------ */
 247 struct hv_monitor_page {
 248         union hv_monitor_trigger_state trigger_state;
 249         u32 rsvdz1;
 250
 251         union hv_monitor_trigger_group trigger_group[4];
 252         u64 rsvdz2[3];
 253
 254         s32 next_checktime[4][32];
 255
 256         u16 latency[4][32];
 257         u64 rsvdz3[32];
 258
 259         struct hv_monitor_parameter parameter[4][32];
 260
 261         u8 rsvdz4[1984];
 262 };
 263
 264 /* Definition of the hv_post_message hypercall input structure. */
 265 struct hv_input_post_message {
 266         union hv_connection_id connectionid;
 267         u32 reserved;
 268         u32 message_type;
 269         u32 payload_size;
 270         u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
 271 };
 272
 273 /*
 274  * Versioning definitions used for guests reporting themselves to the
 275  * hypervisor, and visa versa.
 276  */
 277
 278 /* Version info reported by guest OS's */
 279 enum hv_guest_os_vendor {
 280         HVGUESTOS_VENDOR_MICROSOFT      = 0x0001
 281 };
 282
 283 enum hv_guest_os_microsoft_ids {
 284         HVGUESTOS_MICROSOFT_UNDEFINED   = 0x00,
 285         HVGUESTOS_MICROSOFT_MSDOS               = 0x01,
 286         HVGUESTOS_MICROSOFT_WINDOWS3X   = 0x02,
 287         HVGUESTOS_MICROSOFT_WINDOWS9X   = 0x03,
 288         HVGUESTOS_MICROSOFT_WINDOWSNT   = 0x04,
 289         HVGUESTOS_MICROSOFT_WINDOWSCE   = 0x05
 290 };
 291
 292 /*
 293  * Declare the MSR used to identify the guest OS.
 294  */
 295 #define HV_X64_MSR_GUEST_OS_ID  0x40000000
 296
 297 union hv_x64_msr_guest_os_id_contents {
 298         u64 as_uint64;
 299         struct {
 300                 u64 build_number:16;
 301                 u64 service_version:8; /* Service Pack, etc. */
 302                 u64 minor_version:8;
 303                 u64 major_version:8;
 304                 u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
 305                 u64 vendor_id:16; /* enum hv_guest_os_vendor */
 306         };
 307 };
 308
 309 enum {
 310         VMBUS_MESSAGE_CONNECTION_ID     = 1,
 311         VMBUS_MESSAGE_PORT_ID           = 1,
 312         VMBUS_EVENT_CONNECTION_ID       = 2,
 313         VMBUS_EVENT_PORT_ID             = 2,
 314         VMBUS_MONITOR_CONNECTION_ID     = 3,
 315         VMBUS_MONITOR_PORT_ID           = 3,
 316         VMBUS_MESSAGE_SINT              = 2,
 317 };
 318
 319 /* #defines */
 320
 321 #define HV_PRESENT_BIT                  0x80000000
 322
 323
 324 #define HV_CPU_POWER_MANAGEMENT         (1 << 0)
 325 #define HV_RECOMMENDATIONS_MAX          4
 326
 327 #define HV_X64_MAX                      5
 328 #define HV_CAPS_MAX                     8
 329
 330
 331 #define HV_HYPERCALL_PARAM_ALIGN        sizeof(u64)
 332
 333
 334 /* Service definitions */
 335
 336 #define HV_SERVICE_PARENT_PORT                          (0)
 337 #define HV_SERVICE_PARENT_CONNECTION                    (0)
 338
 339 #define HV_SERVICE_CONNECT_RESPONSE_SUCCESS             (0)
 340 #define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER   (1)
 341 #define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE     (2)
 342 #define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
 343
 344 #define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID           (1)
 345 #define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID          (2)
 346 #define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID        (3)
 347 #define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID       (4)
 348 #define HV_SERVICE_MAX_MESSAGE_ID                               (4)
 349
 350 #define HV_SERVICE_PROTOCOL_VERSION (0x0010)
 351 #define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
 352
 353 /* #define VMBUS_REVISION_NUMBER        6 */
 354
 355 /* Our local vmbus's port and connection id. Anything >0 is fine */
 356 /* #define VMBUS_PORT_ID                11 */
 357
 358 /* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
 359 static const uuid_le VMBUS_SERVICE_ID = {
 360         .b = {
 361                 0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
 362                 0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
 363         },
 364 };
 365
 366
 367
 368 struct hv_context {
 369         /* We only support running on top of Hyper-V
 370         * So at this point this really can only contain the Hyper-V ID
 371         */
 372         u64 guestid;
 373
 374         void *tsc_page;
 375
 376         bool synic_initialized;
 377
 378         void *synic_message_page[NR_CPUS];
 379         void *synic_event_page[NR_CPUS];
 380         /*
 381          * Hypervisor's notion of virtual processor ID is different from
 382          * Linux' notion of CPU ID. This information can only be retrieved
 383          * in the context of the calling CPU. Setup a map for easy access
 384          * to this information:
 385          *
 386          * vp_index[a] is the Hyper-V's processor ID corresponding to
 387          * Linux cpuid 'a'.
 388          */
 389         u32 vp_index[NR_CPUS];
 390         /*
 391          * Starting with win8, we can take channel interrupts on any CPU;
 392          * we will manage the tasklet that handles events messages on a per CPU
 393          * basis.
 394          */
 395         struct tasklet_struct *event_dpc[NR_CPUS];
 396         struct tasklet_struct *msg_dpc[NR_CPUS];
 397         /*
 398          * To optimize the mapping of relid to channel, maintain
 399          * per-cpu list of the channels based on their CPU affinity.
 400          */
 401         struct list_head percpu_list[NR_CPUS];
 402         /*
 403          * buffer to post messages to the host.
 404          */
 405         void *post_msg_page[NR_CPUS];
 406         /*
 407          * Support PV clockevent device.
 408          */
 409         struct clock_event_device *clk_evt[NR_CPUS];
 410         /*
 411          * To manage allocations in a NUMA node.
 412          * Array indexed by numa node ID.
 413          */
 414         struct cpumask *hv_numa_map;
 415 };
 416
 417 extern struct hv_context hv_context;
 418
 419 struct hv_ring_buffer_debug_info {
 420         u32 current_interrupt_mask;
 421         u32 current_read_index;
 422         u32 current_write_index;
 423         u32 bytes_avail_toread;
 424         u32 bytes_avail_towrite;
 425 };
 426
 427 /* Hv Interface */
 428
 429 extern int hv_init(void);
 430
 431 extern void hv_cleanup(bool crash);
 432
 433 extern int hv_post_message(union hv_connection_id connection_id,
 434                          enum hv_message_type message_type,
 435                          void *payload, size_t payload_size);
 436
 437 extern int hv_synic_alloc(void);
 438
 439 extern void hv_synic_free(void);
 440
 441 extern int hv_synic_init(unsigned int cpu);
 442
 443 extern int hv_synic_cleanup(unsigned int cpu);
 444
 445 extern void hv_synic_clockevents_cleanup(void);
 446
 447 /*
 448  * Host version information.
 449  */
 450 extern unsigned int host_info_eax;
 451 extern unsigned int host_info_ebx;
 452 extern unsigned int host_info_ecx;
 453 extern unsigned int host_info_edx;
 454
 455 /* Interface */
 456
 457
 458 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
 459                        struct page *pages, u32 pagecnt);
 460
 461 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
 462
 463 int hv_ringbuffer_write(struct vmbus_channel *channel,
 464                     struct kvec *kv_list,
 465                     u32 kv_count, bool lock,
 466                     bool kick_q);
 467
 468 int hv_ringbuffer_read(struct vmbus_channel *channel,
 469                        void *buffer, u32 buflen, u32 *buffer_actual_len,
 470                        u64 *requestid, bool raw);
 471
 472 void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
 473                             struct hv_ring_buffer_debug_info *debug_info);
 474
 475 void hv_begin_read(struct hv_ring_buffer_info *rbi);
 476
 477 u32 hv_end_read(struct hv_ring_buffer_info *rbi);
 478
 479 /*
 480  * Maximum channels is determined by the size of the interrupt page
 481  * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
 482  * and the other is receive endpoint interrupt
 483  */
 484 #define MAX_NUM_CHANNELS        ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
 485
 486 /* The value here must be in multiple of 32 */
 487 /* TODO: Need to make this configurable */
 488 #define MAX_NUM_CHANNELS_SUPPORTED      256
 489
 490
 491 enum vmbus_connect_state {
 492         DISCONNECTED,
 493         CONNECTING,
 494         CONNECTED,
 495         DISCONNECTING
 496 };
 497
 498 #define MAX_SIZE_CHANNEL_MESSAGE        HV_MESSAGE_PAYLOAD_BYTE_COUNT
 499
 500 struct vmbus_connection {
 501         enum vmbus_connect_state conn_state;
 502
 503         atomic_t next_gpadl_handle;
 504
 505         struct completion  unload_event;
 506         /*
 507          * Represents channel interrupts. Each bit position represents a
 508          * channel.  When a channel sends an interrupt via VMBUS, it finds its
 509          * bit in the sendInterruptPage, set it and calls Hv to generate a port
 510          * event. The other end receives the port event and parse the
 511          * recvInterruptPage to see which bit is set
 512          */
 513         void *int_page;
 514         void *send_int_page;
 515         void *recv_int_page;
 516
 517         /*
 518          * 2 pages - 1st page for parent->child notification and 2nd
 519          * is child->parent notification
 520          */
 521         struct hv_monitor_page *monitor_pages[2];
 522         struct list_head chn_msg_list;
 523         spinlock_t channelmsg_lock;
 524
 525         /* List of channels */
 526         struct list_head chn_list;
 527         struct mutex channel_mutex;
 528
 529         struct workqueue_struct *work_queue;
 530 };
 531
 532
 533 struct vmbus_msginfo {
 534         /* Bookkeeping stuff */
 535         struct list_head msglist_entry;
 536
 537         /* The message itself */
 538         unsigned char msg[0];
 539 };
 540
 541
 542 extern struct vmbus_connection vmbus_connection;
 543
 544 enum vmbus_message_handler_type {
 545         /* The related handler can sleep. */
 546         VMHT_BLOCKING = 0,
 547
 548         /* The related handler must NOT sleep. */
 549         VMHT_NON_BLOCKING = 1,
 550 };
 551
 552 struct vmbus_channel_message_table_entry {
 553         enum vmbus_channel_message_type message_type;
 554         enum vmbus_message_handler_type handler_type;
 555         void (*message_handler)(struct vmbus_channel_message_header *msg);
 556 };
 557
 558 extern struct vmbus_channel_message_table_entry
 559         channel_message_table[CHANNELMSG_COUNT];
 560
 561 /* Free the message slot and signal end-of-message if required */
 562 static inline void vmbus_signal_eom(struct hv_message *msg, u32 old_msg_type)
 563 {
 564         /*
 565          * On crash we're reading some other CPU's message page and we need
 566          * to be careful: this other CPU may already had cleared the header
 567          * and the host may already had delivered some other message there.
 568          * In case we blindly write msg->header.message_type we're going
 569          * to lose it. We can still lose a message of the same type but
 570          * we count on the fact that there can only be one
 571          * CHANNELMSG_UNLOAD_RESPONSE and we don't care about other messages
 572          * on crash.
 573          */
 574         if (cmpxchg(&msg->header.message_type, old_msg_type,
 575                     HVMSG_NONE) != old_msg_type)
 576                 return;
 577
 578         /*
 579          * Make sure the write to MessageType (ie set to
 580          * HVMSG_NONE) happens before we read the
 581          * MessagePending and EOMing. Otherwise, the EOMing
 582          * will not deliver any more messages since there is
 583          * no empty slot
 584          */
 585         mb();
 586
 587         if (msg->header.message_flags.msg_pending) {
 588                 /*
 589                  * This will cause message queue rescan to
 590                  * possibly deliver another msg from the
 591                  * hypervisor
 592                  */
 593                 wrmsrl(HV_X64_MSR_EOM, 0);
 594         }
 595 }
 596
 597 /* General vmbus interface */
 598
 599 struct hv_device *vmbus_device_create(const uuid_le *type,
 600                                       const uuid_le *instance,
 601                                       struct vmbus_channel *channel);
 602
 603 int vmbus_device_register(struct hv_device *child_device_obj);
 604 void vmbus_device_unregister(struct hv_device *device_obj);
 605
 606 /* static void */
 607 /* VmbusChildDeviceDestroy( */
 608 /* struct hv_device *); */
 609
 610 struct vmbus_channel *relid2channel(u32 relid);
 611
 612 void vmbus_free_channels(void);
 613
 614 /* Connection interface */
 615
 616 int vmbus_connect(void);
 617 void vmbus_disconnect(void);
 618
 619 int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
 620
 621 void vmbus_on_event(unsigned long data);
 622 void vmbus_on_msg_dpc(unsigned long data);
 623
 624 int hv_kvp_init(struct hv_util_service *);
 625 void hv_kvp_deinit(void);
 626 void hv_kvp_onchannelcallback(void *);
 627
 628 int hv_vss_init(struct hv_util_service *);
 629 void hv_vss_deinit(void);
 630 void hv_vss_onchannelcallback(void *);
 631
 632 int hv_fcopy_init(struct hv_util_service *);
 633 void hv_fcopy_deinit(void);
 634 void hv_fcopy_onchannelcallback(void *);
 635 void vmbus_initiate_unload(bool crash);
 636
 637 static inline void hv_poll_channel(struct vmbus_channel *channel,
 638                                    void (*cb)(void *))
 639 {
 640         if (!channel)
 641                 return;
 642
 643         smp_call_function_single(channel->target_cpu, cb, channel, true);
 644 }
 645
 646 enum hvutil_device_state {
 647         HVUTIL_DEVICE_INIT = 0,  /* driver is loaded, waiting for userspace */
 648         HVUTIL_READY,            /* userspace is registered */
 649         HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
 650         HVUTIL_USERSPACE_REQ,    /* request to userspace was sent */
 651         HVUTIL_USERSPACE_RECV,   /* reply from userspace was received */
 652         HVUTIL_DEVICE_DYING,     /* driver unload is in progress */
 653 };
 654
 655 #endif /* _HYPERV_VMBUS_H */