3 * Copyright (c) 2011, Microsoft Corporation.
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.
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
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.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
21 * K. Y. Srinivasan <kys@microsoft.com>
28 #include <linux/types.h>
32 * Implementation of host controlled snapshot of the guest.
35 #define VSS_OP_REGISTER 128
44 * Following operations are only supported with IC version >= 5.0
46 VSS_OP_FREEZE, /* Freeze the file systems in the VM */
47 VSS_OP_THAW, /* Unfreeze the file systems */
49 VSS_OP_COUNT /* Number of operations, must be last */
54 * Header for all VSS messages.
59 } __attribute__((packed));
63 * Flag values for the hv_vss_check_feature. Linux supports only
66 #define VSS_HBU_NO_AUTO_RECOVERY 0x00000005
68 struct hv_vss_check_feature {
70 } __attribute__((packed));
72 struct hv_vss_check_dm_info {
74 } __attribute__((packed));
78 struct hv_vss_hdr vss_hdr;
82 struct hv_vss_check_feature vss_cf;
83 struct hv_vss_check_dm_info dm_info;
85 } __attribute__((packed));
88 * An implementation of HyperV key value pair (KVP) functionality for Linux.
91 * Copyright (C) 2010, Novell, Inc.
92 * Author : K. Y. Srinivasan <ksrinivasan@novell.com>
97 * Maximum value size - used for both key names and value data, and includes
98 * any applicable NULL terminators.
100 * Note: This limit is somewhat arbitrary, but falls easily within what is
101 * supported for all native guests (back to Win 2000) and what is reasonable
102 * for the IC KVP exchange functionality. Note that Windows Me/98/95 are
103 * limited to 255 character key names.
105 * MSDN recommends not storing data values larger than 2048 bytes in the
108 * Note: This value is used in defining the KVP exchange message - this value
109 * cannot be modified without affecting the message size and compatibility.
113 * bytes, including any null terminators
115 #define HV_KVP_EXCHANGE_MAX_VALUE_SIZE (2048)
119 * Maximum key size - the registry limit for the length of an entry name
120 * is 256 characters, including the null terminator
123 #define HV_KVP_EXCHANGE_MAX_KEY_SIZE (512)
126 * In Linux, we implement the KVP functionality in two components:
127 * 1) The kernel component which is packaged as part of the hv_utils driver
128 * is responsible for communicating with the host and responsible for
129 * implementing the host/guest protocol. 2) A user level daemon that is
130 * responsible for data gathering.
132 * Host/Guest Protocol: The host iterates over an index and expects the guest
133 * to assign a key name to the index and also return the value corresponding to
134 * the key. The host will have atmost one KVP transaction outstanding at any
135 * given point in time. The host side iteration stops when the guest returns
136 * an error. Microsoft has specified the following mapping of key names to
137 * host specified index:
140 * 0 FullyQualifiedDomainName
141 * 1 IntegrationServicesVersion
142 * 2 NetworkAddressIPv4
143 * 3 NetworkAddressIPv6
149 * 9 ProcessorArchitecture
151 * The Windows host expects the Key Name and Key Value to be encoded in utf16.
153 * Guest Kernel/KVP Daemon Protocol: As noted earlier, we implement all of the
154 * data gathering functionality in a user mode daemon. The user level daemon
155 * is also responsible for binding the key name to the index as well. The
156 * kernel and user-level daemon communicate using a connector channel.
158 * The user mode component first registers with the
159 * the kernel component. Subsequently, the kernel component requests, data
160 * for the specified keys. In response to this message the user mode component
161 * fills in the value corresponding to the specified key. We overload the
162 * sequence field in the cn_msg header to define our KVP message types.
165 * The kernel component simply acts as a conduit for communication between the
166 * Windows host and the user-level daemon. The kernel component passes up the
167 * index received from the Host to the user-level daemon. If the index is
168 * valid (supported), the corresponding key as well as its
169 * value (both are strings) is returned. If the index is invalid
170 * (not supported), a NULL key string is returned.
175 * Registry value types.
183 * As we look at expanding the KVP functionality to include
184 * IP injection functionality, we need to maintain binary
185 * compatibility with older daemons.
187 * The KVP opcodes are defined by the host and it was unfortunate
188 * that I chose to treat the registration operation as part of the
189 * KVP operations defined by the host.
190 * Here is the level of compatibility
191 * (between the user level daemon and the kernel KVP driver) that we
194 * An older daemon will always be supported on a newer driver.
195 * A given user level daemon will require a minimal version of the
197 * If we cannot handle the version differences, we will fail gracefully
198 * (this can happen when we have a user level daemon that is more
199 * advanced than the KVP driver.
201 * We will use values used in this handshake for determining if we have
202 * workable user level daemon and the kernel driver. We begin by taking the
203 * registration opcode out of the KVP opcode namespace. We will however,
204 * maintain compatibility with the existing user-level daemon code.
208 * Daemon code not supporting IP injection (legacy daemon).
211 #define KVP_OP_REGISTER 4
214 * Daemon code supporting IP injection.
215 * The KVP opcode field is used to communicate the
216 * registration information; so define a namespace that
217 * will be distinct from the host defined KVP opcode.
220 #define KVP_OP_REGISTER1 100
222 enum hv_kvp_exchg_op {
229 KVP_OP_COUNT /* Number of operations, must be last. */
232 enum hv_kvp_exchg_pool {
233 KVP_POOL_EXTERNAL = 0,
236 KVP_POOL_AUTO_EXTERNAL,
237 KVP_POOL_AUTO_INTERNAL,
238 KVP_POOL_COUNT /* Number of pools, must be last. */
242 * Some Hyper-V status codes.
245 #define HV_S_OK 0x00000000
246 #define HV_E_FAIL 0x80004005
247 #define HV_S_CONT 0x80070103
248 #define HV_ERROR_NOT_SUPPORTED 0x80070032
249 #define HV_ERROR_MACHINE_LOCKED 0x800704F7
250 #define HV_ERROR_DEVICE_NOT_CONNECTED 0x8007048F
251 #define HV_INVALIDARG 0x80070057
252 #define HV_GUID_NOTFOUND 0x80041002
254 #define ADDR_FAMILY_NONE 0x00
255 #define ADDR_FAMILY_IPV4 0x01
256 #define ADDR_FAMILY_IPV6 0x02
258 #define MAX_ADAPTER_ID_SIZE 128
259 #define MAX_IP_ADDR_SIZE 1024
260 #define MAX_GATEWAY_SIZE 512
263 struct hv_kvp_ipaddr_value {
264 __u16 adapter_id[MAX_ADAPTER_ID_SIZE];
267 __u16 ip_addr[MAX_IP_ADDR_SIZE];
268 __u16 sub_net[MAX_IP_ADDR_SIZE];
269 __u16 gate_way[MAX_GATEWAY_SIZE];
270 __u16 dns_addr[MAX_IP_ADDR_SIZE];
271 } __attribute__((packed));
278 } __attribute__((packed));
280 struct hv_kvp_exchg_msg_value {
284 __u8 key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
286 __u8 value[HV_KVP_EXCHANGE_MAX_VALUE_SIZE];
290 } __attribute__((packed));
292 struct hv_kvp_msg_enumerate {
294 struct hv_kvp_exchg_msg_value data;
295 } __attribute__((packed));
297 struct hv_kvp_msg_get {
298 struct hv_kvp_exchg_msg_value data;
301 struct hv_kvp_msg_set {
302 struct hv_kvp_exchg_msg_value data;
305 struct hv_kvp_msg_delete {
307 __u8 key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
310 struct hv_kvp_register {
311 __u8 version[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
316 struct hv_kvp_hdr kvp_hdr;
320 struct hv_kvp_msg_get kvp_get;
321 struct hv_kvp_msg_set kvp_set;
322 struct hv_kvp_msg_delete kvp_delete;
323 struct hv_kvp_msg_enumerate kvp_enum_data;
324 struct hv_kvp_ipaddr_value kvp_ip_val;
325 struct hv_kvp_register kvp_register;
327 } __attribute__((packed));
329 struct hv_kvp_ip_msg {
332 struct hv_kvp_ipaddr_value kvp_ip_val;
333 } __attribute__((packed));
336 #include <linux/scatterlist.h>
337 #include <linux/list.h>
338 #include <linux/uuid.h>
339 #include <linux/timer.h>
340 #include <linux/workqueue.h>
341 #include <linux/completion.h>
342 #include <linux/device.h>
343 #include <linux/mod_devicetable.h>
346 #define MAX_PAGE_BUFFER_COUNT 19
347 #define MAX_MULTIPAGE_BUFFER_COUNT 32 /* 128K */
349 #pragma pack(push, 1)
351 /* Single-page buffer */
352 struct hv_page_buffer {
358 /* Multiple-page buffer */
359 struct hv_multipage_buffer {
360 /* Length and Offset determines the # of pfns in the array */
363 u64 pfn_array[MAX_MULTIPAGE_BUFFER_COUNT];
366 /* 0x18 includes the proprietary packet header */
367 #define MAX_PAGE_BUFFER_PACKET (0x18 + \
368 (sizeof(struct hv_page_buffer) * \
369 MAX_PAGE_BUFFER_COUNT))
370 #define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \
371 sizeof(struct hv_multipage_buffer))
376 struct hv_ring_buffer {
377 /* Offset in bytes from the start of ring data below */
380 /* Offset in bytes from the start of ring data below */
386 * Win8 uses some of the reserved bits to implement
387 * interrupt driven flow management. On the send side
388 * we can request that the receiver interrupt the sender
389 * when the ring transitions from being full to being able
390 * to handle a message of size "pending_send_sz".
392 * Add necessary state for this enhancement.
400 u32 feat_pending_send_sz:1;
405 /* Pad it to PAGE_SIZE so that data starts on page boundary */
409 * Ring data starts here + RingDataStartOffset
410 * !!! DO NOT place any fields below this !!!
415 struct hv_ring_buffer_info {
416 struct hv_ring_buffer *ring_buffer;
417 u32 ring_size; /* Include the shared header */
418 spinlock_t ring_lock;
420 u32 ring_datasize; /* < ring_size */
421 u32 ring_data_startoffset;
424 struct hv_ring_buffer_debug_info {
425 u32 current_interrupt_mask;
426 u32 current_read_index;
427 u32 current_write_index;
428 u32 bytes_avail_toread;
429 u32 bytes_avail_towrite;
435 * hv_get_ringbuffer_availbytes()
437 * Get number of bytes available to read and to write to
438 * for the specified ring buffer
441 hv_get_ringbuffer_availbytes(struct hv_ring_buffer_info *rbi,
442 u32 *read, u32 *write)
444 u32 read_loc, write_loc, dsize;
446 smp_read_barrier_depends();
448 /* Capture the read/write indices before they changed */
449 read_loc = rbi->ring_buffer->read_index;
450 write_loc = rbi->ring_buffer->write_index;
451 dsize = rbi->ring_datasize;
453 *write = write_loc >= read_loc ? dsize - (write_loc - read_loc) :
454 read_loc - write_loc;
455 *read = dsize - *write;
460 * We use the same version numbering for all Hyper-V modules.
462 * Definition of versioning is as follows;
464 * Major Number Changes for these scenarios;
465 * 1. When a new version of Windows Hyper-V
467 * 2. A Major change has occurred in the
469 * (For example the merge for the first time
470 * into the kernel) Every time the Major Number
471 * changes, the Revision number is reset to 0.
472 * Minor Number Changes when new functionality is added
473 * to the Linux IC's that is not a bug fix.
475 * 3.1 - Added completed hv_utils driver. Shutdown/Heartbeat/Timesync
477 #define HV_DRV_VERSION "3.1"
480 * VMBUS version is 32 bit entity broken up into
481 * two 16 bit quantities: major_number. minor_number.
483 * 0 . 13 (Windows Server 2008)
488 #define VERSION_WS2008 ((0 << 16) | (13))
489 #define VERSION_WIN7 ((1 << 16) | (1))
490 #define VERSION_WIN8 ((2 << 16) | (4))
492 #define VERSION_INVAL -1
494 #define VERSION_CURRENT VERSION_WIN8
496 /* Make maximum size of pipe payload of 16K */
497 #define MAX_PIPE_DATA_PAYLOAD (sizeof(u8) * 16384)
499 /* Define PipeMode values. */
500 #define VMBUS_PIPE_TYPE_BYTE 0x00000000
501 #define VMBUS_PIPE_TYPE_MESSAGE 0x00000004
503 /* The size of the user defined data buffer for non-pipe offers. */
504 #define MAX_USER_DEFINED_BYTES 120
506 /* The size of the user defined data buffer for pipe offers. */
507 #define MAX_PIPE_USER_DEFINED_BYTES 116
510 * At the center of the Channel Management library is the Channel Offer. This
511 * struct contains the fundamental information about an offer.
513 struct vmbus_channel_offer {
518 * These two fields are not currently used.
524 u16 mmio_megabytes; /* in bytes * 1024 * 1024 */
527 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */
529 unsigned char user_def[MAX_USER_DEFINED_BYTES];
534 * The following sructure is an integrated pipe protocol, which
535 * is implemented on top of standard user-defined data. Pipe
536 * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own
541 unsigned char user_def[MAX_PIPE_USER_DEFINED_BYTES];
545 * The sub_channel_index is defined in win8.
547 u16 sub_channel_index;
552 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE 1
553 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES 2
554 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS 4
555 #define VMBUS_CHANNEL_NAMED_PIPE_MODE 0x10
556 #define VMBUS_CHANNEL_LOOPBACK_OFFER 0x100
557 #define VMBUS_CHANNEL_PARENT_OFFER 0x200
558 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION 0x400
560 struct vmpacket_descriptor {
568 struct vmpacket_header {
569 u32 prev_pkt_start_offset;
570 struct vmpacket_descriptor descriptor;
573 struct vmtransfer_page_range {
578 struct vmtransfer_page_packet_header {
579 struct vmpacket_descriptor d;
584 struct vmtransfer_page_range ranges[1];
587 struct vmgpadl_packet_header {
588 struct vmpacket_descriptor d;
593 struct vmadd_remove_transfer_page_set {
594 struct vmpacket_descriptor d;
601 * This structure defines a range in guest physical space that can be made to
602 * look virtually contiguous.
611 * This is the format for an Establish Gpadl packet, which contains a handle by
612 * which this GPADL will be known and a set of GPA ranges associated with it.
613 * This can be converted to a MDL by the guest OS. If there are multiple GPA
614 * ranges, then the resulting MDL will be "chained," representing multiple VA
617 struct vmestablish_gpadl {
618 struct vmpacket_descriptor d;
621 struct gpa_range range[1];
625 * This is the format for a Teardown Gpadl packet, which indicates that the
626 * GPADL handle in the Establish Gpadl packet will never be referenced again.
628 struct vmteardown_gpadl {
629 struct vmpacket_descriptor d;
631 u32 reserved; /* for alignment to a 8-byte boundary */
635 * This is the format for a GPA-Direct packet, which contains a set of GPA
636 * ranges, in addition to commands and/or data.
638 struct vmdata_gpa_direct {
639 struct vmpacket_descriptor d;
642 struct gpa_range range[1];
645 /* This is the format for a Additional Data Packet. */
646 struct vmadditional_data {
647 struct vmpacket_descriptor d;
651 unsigned char data[1];
654 union vmpacket_largest_possible_header {
655 struct vmpacket_descriptor simple_hdr;
656 struct vmtransfer_page_packet_header xfer_page_hdr;
657 struct vmgpadl_packet_header gpadl_hdr;
658 struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr;
659 struct vmestablish_gpadl establish_gpadl_hdr;
660 struct vmteardown_gpadl teardown_gpadl_hdr;
661 struct vmdata_gpa_direct data_gpa_direct_hdr;
664 #define VMPACKET_DATA_START_ADDRESS(__packet) \
665 (void *)(((unsigned char *)__packet) + \
666 ((struct vmpacket_descriptor)__packet)->offset8 * 8)
668 #define VMPACKET_DATA_LENGTH(__packet) \
669 ((((struct vmpacket_descriptor)__packet)->len8 - \
670 ((struct vmpacket_descriptor)__packet)->offset8) * 8)
672 #define VMPACKET_TRANSFER_MODE(__packet) \
673 (((struct IMPACT)__packet)->type)
675 enum vmbus_packet_type {
676 VM_PKT_INVALID = 0x0,
678 VM_PKT_ADD_XFER_PAGESET = 0x2,
679 VM_PKT_RM_XFER_PAGESET = 0x3,
680 VM_PKT_ESTABLISH_GPADL = 0x4,
681 VM_PKT_TEARDOWN_GPADL = 0x5,
682 VM_PKT_DATA_INBAND = 0x6,
683 VM_PKT_DATA_USING_XFER_PAGES = 0x7,
684 VM_PKT_DATA_USING_GPADL = 0x8,
685 VM_PKT_DATA_USING_GPA_DIRECT = 0x9,
686 VM_PKT_CANCEL_REQUEST = 0xa,
688 VM_PKT_DATA_USING_ADDITIONAL_PKT = 0xc,
689 VM_PKT_ADDITIONAL_DATA = 0xd
692 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
695 /* Version 1 messages */
696 enum vmbus_channel_message_type {
697 CHANNELMSG_INVALID = 0,
698 CHANNELMSG_OFFERCHANNEL = 1,
699 CHANNELMSG_RESCIND_CHANNELOFFER = 2,
700 CHANNELMSG_REQUESTOFFERS = 3,
701 CHANNELMSG_ALLOFFERS_DELIVERED = 4,
702 CHANNELMSG_OPENCHANNEL = 5,
703 CHANNELMSG_OPENCHANNEL_RESULT = 6,
704 CHANNELMSG_CLOSECHANNEL = 7,
705 CHANNELMSG_GPADL_HEADER = 8,
706 CHANNELMSG_GPADL_BODY = 9,
707 CHANNELMSG_GPADL_CREATED = 10,
708 CHANNELMSG_GPADL_TEARDOWN = 11,
709 CHANNELMSG_GPADL_TORNDOWN = 12,
710 CHANNELMSG_RELID_RELEASED = 13,
711 CHANNELMSG_INITIATE_CONTACT = 14,
712 CHANNELMSG_VERSION_RESPONSE = 15,
713 CHANNELMSG_UNLOAD = 16,
714 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
715 CHANNELMSG_VIEWRANGE_ADD = 17,
716 CHANNELMSG_VIEWRANGE_REMOVE = 18,
721 struct vmbus_channel_message_header {
722 enum vmbus_channel_message_type msgtype;
726 /* Query VMBus Version parameters */
727 struct vmbus_channel_query_vmbus_version {
728 struct vmbus_channel_message_header header;
732 /* VMBus Version Supported parameters */
733 struct vmbus_channel_version_supported {
734 struct vmbus_channel_message_header header;
735 u8 version_supported;
738 /* Offer Channel parameters */
739 struct vmbus_channel_offer_channel {
740 struct vmbus_channel_message_header header;
741 struct vmbus_channel_offer offer;
745 * win7 and beyond splits this field into a bit field.
747 u8 monitor_allocated:1;
750 * These are new fields added in win7 and later.
751 * Do not access these fields without checking the
752 * negotiated protocol.
754 * If "is_dedicated_interrupt" is set, we must not set the
755 * associated bit in the channel bitmap while sending the
756 * interrupt to the host.
758 * connection_id is to be used in signaling the host.
760 u16 is_dedicated_interrupt:1;
765 /* Rescind Offer parameters */
766 struct vmbus_channel_rescind_offer {
767 struct vmbus_channel_message_header header;
772 * Request Offer -- no parameters, SynIC message contains the partition ID
773 * Set Snoop -- no parameters, SynIC message contains the partition ID
774 * Clear Snoop -- no parameters, SynIC message contains the partition ID
775 * All Offers Delivered -- no parameters, SynIC message contains the partition
777 * Flush Client -- no parameters, SynIC message contains the partition ID
780 /* Open Channel parameters */
781 struct vmbus_channel_open_channel {
782 struct vmbus_channel_message_header header;
784 /* Identifies the specific VMBus channel that is being opened. */
787 /* ID making a particular open request at a channel offer unique. */
790 /* GPADL for the channel's ring buffer. */
791 u32 ringbuffer_gpadlhandle;
794 * Starting with win8, this field will be used to specify
795 * the target virtual processor on which to deliver the interrupt for
796 * the host to guest communication.
797 * Prior to win8, incoming channel interrupts would only
798 * be delivered on cpu 0. Setting this value to 0 would
799 * preserve the earlier behavior.
804 * The upstream ring buffer begins at offset zero in the memory
805 * described by RingBufferGpadlHandle. The downstream ring buffer
806 * follows it at this offset (in pages).
808 u32 downstream_ringbuffer_pageoffset;
810 /* User-specific data to be passed along to the server endpoint. */
811 unsigned char userdata[MAX_USER_DEFINED_BYTES];
814 /* Open Channel Result parameters */
815 struct vmbus_channel_open_result {
816 struct vmbus_channel_message_header header;
822 /* Close channel parameters; */
823 struct vmbus_channel_close_channel {
824 struct vmbus_channel_message_header header;
828 /* Channel Message GPADL */
829 #define GPADL_TYPE_RING_BUFFER 1
830 #define GPADL_TYPE_SERVER_SAVE_AREA 2
831 #define GPADL_TYPE_TRANSACTION 8
834 * The number of PFNs in a GPADL message is defined by the number of
835 * pages that would be spanned by ByteCount and ByteOffset. If the
836 * implied number of PFNs won't fit in this packet, there will be a
837 * follow-up packet that contains more.
839 struct vmbus_channel_gpadl_header {
840 struct vmbus_channel_message_header header;
845 struct gpa_range range[0];
848 /* This is the followup packet that contains more PFNs. */
849 struct vmbus_channel_gpadl_body {
850 struct vmbus_channel_message_header header;
856 struct vmbus_channel_gpadl_created {
857 struct vmbus_channel_message_header header;
863 struct vmbus_channel_gpadl_teardown {
864 struct vmbus_channel_message_header header;
869 struct vmbus_channel_gpadl_torndown {
870 struct vmbus_channel_message_header header;
874 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
875 struct vmbus_channel_view_range_add {
876 struct vmbus_channel_message_header header;
877 PHYSICAL_ADDRESS viewrange_base;
878 u64 viewrange_length;
882 struct vmbus_channel_view_range_remove {
883 struct vmbus_channel_message_header header;
884 PHYSICAL_ADDRESS viewrange_base;
889 struct vmbus_channel_relid_released {
890 struct vmbus_channel_message_header header;
894 struct vmbus_channel_initiate_contact {
895 struct vmbus_channel_message_header header;
896 u32 vmbus_version_requested;
903 struct vmbus_channel_version_response {
904 struct vmbus_channel_message_header header;
905 u8 version_supported;
908 enum vmbus_channel_state {
910 CHANNEL_OPENING_STATE,
912 CHANNEL_OPENED_STATE,
915 struct vmbus_channel_debug_info {
917 enum vmbus_channel_state state;
918 uuid_le interfacetype;
919 uuid_le interface_instance;
921 u32 servermonitor_pending;
922 u32 servermonitor_latency;
923 u32 servermonitor_connectionid;
924 u32 clientmonitor_pending;
925 u32 clientmonitor_latency;
926 u32 clientmonitor_connectionid;
928 struct hv_ring_buffer_debug_info inbound;
929 struct hv_ring_buffer_debug_info outbound;
933 * Represents each channel msg on the vmbus connection This is a
934 * variable-size data structure depending on the msg type itself
936 struct vmbus_channel_msginfo {
937 /* Bookkeeping stuff */
938 struct list_head msglistentry;
940 /* So far, this is only used to handle gpadl body message */
941 struct list_head submsglist;
943 /* Synchronize the request/response if needed */
944 struct completion waitevent;
946 struct vmbus_channel_version_supported version_supported;
947 struct vmbus_channel_open_result open_result;
948 struct vmbus_channel_gpadl_torndown gpadl_torndown;
949 struct vmbus_channel_gpadl_created gpadl_created;
950 struct vmbus_channel_version_response version_response;
955 * The channel message that goes out on the "wire".
956 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
958 unsigned char msg[0];
961 struct vmbus_close_msg {
962 struct vmbus_channel_msginfo info;
963 struct vmbus_channel_close_channel msg;
966 /* Define connection identifier type. */
967 union hv_connection_id {
975 /* Definition of the hv_signal_event hypercall input structure. */
976 struct hv_input_signal_event {
977 union hv_connection_id connectionid;
982 struct hv_input_signal_event_buffer {
984 struct hv_input_signal_event event;
987 struct vmbus_channel {
988 struct list_head listentry;
990 struct hv_device *device_obj;
992 struct work_struct work;
994 enum vmbus_channel_state state;
996 struct vmbus_channel_offer_channel offermsg;
998 * These are based on the OfferMsg.MonitorId.
999 * Save it here for easy access.
1004 u32 ringbuffer_gpadlhandle;
1006 /* Allocated memory for ring buffer */
1007 void *ringbuffer_pages;
1008 u32 ringbuffer_pagecount;
1009 struct hv_ring_buffer_info outbound; /* send to parent */
1010 struct hv_ring_buffer_info inbound; /* receive from parent */
1011 spinlock_t inbound_lock;
1012 struct workqueue_struct *controlwq;
1014 struct vmbus_close_msg close_msg;
1016 /* Channel callback are invoked in this workqueue context */
1017 /* HANDLE dataWorkQueue; */
1019 void (*onchannel_callback)(void *context);
1020 void *channel_callback_context;
1023 * A channel can be marked for efficient (batched)
1025 * If batched_reading is set to "true", we read until the
1026 * channel is empty and hold off interrupts from the host
1027 * during the entire read process.
1028 * If batched_reading is set to "false", the client is not
1029 * going to perform batched reading.
1031 * By default we will enable batched reading; specific
1032 * drivers that don't want this behavior can turn it off.
1035 bool batched_reading;
1037 bool is_dedicated_interrupt;
1038 struct hv_input_signal_event_buffer sig_buf;
1039 struct hv_input_signal_event *sig_event;
1042 * Starting with win8, this field will be used to specify
1043 * the target virtual processor on which to deliver the interrupt for
1044 * the host to guest communication.
1045 * Prior to win8, incoming channel interrupts would only
1046 * be delivered on cpu 0. Setting this value to 0 would
1047 * preserve the earlier behavior.
1051 * Support for sub-channels. For high performance devices,
1052 * it will be useful to have multiple sub-channels to support
1053 * a scalable communication infrastructure with the host.
1054 * The support for sub-channels is implemented as an extention
1055 * to the current infrastructure.
1056 * The initial offer is considered the primary channel and this
1057 * offer message will indicate if the host supports sub-channels.
1058 * The guest is free to ask for sub-channels to be offerred and can
1059 * open these sub-channels as a normal "primary" channel. However,
1060 * all sub-channels will have the same type and instance guids as the
1061 * primary channel. Requests sent on a given channel will result in a
1062 * response on the same channel.
1066 * Sub-channel creation callback. This callback will be called in
1067 * process context when a sub-channel offer is received from the host.
1068 * The guest can open the sub-channel in the context of this callback.
1070 void (*sc_creation_callback)(struct vmbus_channel *new_sc);
1074 * All Sub-channels of a primary channel are linked here.
1076 struct list_head sc_list;
1078 * The primary channel this sub-channel belongs to.
1079 * This will be NULL for the primary channel.
1081 struct vmbus_channel *primary_channel;
1084 static inline void set_channel_read_state(struct vmbus_channel *c, bool state)
1086 c->batched_reading = state;
1089 void vmbus_onmessage(void *context);
1091 int vmbus_request_offers(void);
1094 * APIs for managing sub-channels.
1097 void vmbus_set_sc_create_callback(struct vmbus_channel *primary_channel,
1098 void (*sc_cr_cb)(struct vmbus_channel *new_sc));
1101 * Retrieve the (sub) channel on which to send an outgoing request.
1102 * When a primary channel has multiple sub-channels, we choose a
1103 * channel whose VCPU binding is closest to the VCPU on which
1104 * this call is being made.
1106 struct vmbus_channel *vmbus_get_outgoing_channel(struct vmbus_channel *primary);
1109 * Check if sub-channels have already been offerred. This API will be useful
1110 * when the driver is unloaded after establishing sub-channels. In this case,
1111 * when the driver is re-loaded, the driver would have to check if the
1112 * subchannels have already been established before attempting to request
1113 * the creation of sub-channels.
1114 * This function returns TRUE to indicate that subchannels have already been
1116 * This function should be invoked after setting the callback function for
1117 * sub-channel creation.
1119 bool vmbus_are_subchannels_present(struct vmbus_channel *primary);
1121 /* The format must be the same as struct vmdata_gpa_direct */
1122 struct vmbus_channel_packet_page_buffer {
1130 struct hv_page_buffer range[MAX_PAGE_BUFFER_COUNT];
1133 /* The format must be the same as struct vmdata_gpa_direct */
1134 struct vmbus_channel_packet_multipage_buffer {
1141 u32 rangecount; /* Always 1 in this case */
1142 struct hv_multipage_buffer range;
1146 extern int vmbus_open(struct vmbus_channel *channel,
1147 u32 send_ringbuffersize,
1148 u32 recv_ringbuffersize,
1151 void(*onchannel_callback)(void *context),
1154 extern void vmbus_close(struct vmbus_channel *channel);
1156 extern int vmbus_sendpacket(struct vmbus_channel *channel,
1160 enum vmbus_packet_type type,
1163 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel *channel,
1164 struct hv_page_buffer pagebuffers[],
1170 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel *channel,
1171 struct hv_multipage_buffer *mpb,
1176 extern int vmbus_establish_gpadl(struct vmbus_channel *channel,
1181 extern int vmbus_teardown_gpadl(struct vmbus_channel *channel,
1184 extern int vmbus_recvpacket(struct vmbus_channel *channel,
1187 u32 *buffer_actual_len,
1190 extern int vmbus_recvpacket_raw(struct vmbus_channel *channel,
1193 u32 *buffer_actual_len,
1197 extern void vmbus_get_debug_info(struct vmbus_channel *channel,
1198 struct vmbus_channel_debug_info *debug);
1200 extern void vmbus_ontimer(unsigned long data);
1202 struct hv_dev_port_info {
1206 u32 bytes_avail_toread;
1207 u32 bytes_avail_towrite;
1210 /* Base driver object */
1214 /* the device type supported by this driver */
1216 const struct hv_vmbus_device_id *id_table;
1218 struct device_driver driver;
1220 int (*probe)(struct hv_device *, const struct hv_vmbus_device_id *);
1221 int (*remove)(struct hv_device *);
1222 void (*shutdown)(struct hv_device *);
1226 /* Base device object */
1228 /* the device type id of this device */
1231 /* the device instance id of this device */
1232 uuid_le dev_instance;
1234 struct device device;
1236 struct vmbus_channel *channel;
1240 static inline struct hv_device *device_to_hv_device(struct device *d)
1242 return container_of(d, struct hv_device, device);
1245 static inline struct hv_driver *drv_to_hv_drv(struct device_driver *d)
1247 return container_of(d, struct hv_driver, driver);
1250 static inline void hv_set_drvdata(struct hv_device *dev, void *data)
1252 dev_set_drvdata(&dev->device, data);
1255 static inline void *hv_get_drvdata(struct hv_device *dev)
1257 return dev_get_drvdata(&dev->device);
1260 /* Vmbus interface */
1261 #define vmbus_driver_register(driver) \
1262 __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
1263 int __must_check __vmbus_driver_register(struct hv_driver *hv_driver,
1264 struct module *owner,
1265 const char *mod_name);
1266 void vmbus_driver_unregister(struct hv_driver *hv_driver);
1269 * VMBUS_DEVICE - macro used to describe a specific hyperv vmbus device
1271 * This macro is used to create a struct hv_vmbus_device_id that matches a
1274 #define VMBUS_DEVICE(g0, g1, g2, g3, g4, g5, g6, g7, \
1275 g8, g9, ga, gb, gc, gd, ge, gf) \
1276 .guid = { g0, g1, g2, g3, g4, g5, g6, g7, \
1277 g8, g9, ga, gb, gc, gd, ge, gf },
1280 * GUID definitions of various offer types - services offered to the guest.
1285 * {f8615163-df3e-46c5-913f-f2d2f965ed0e}
1287 #define HV_NIC_GUID \
1289 0x63, 0x51, 0x61, 0xf8, 0x3e, 0xdf, 0xc5, 0x46, \
1290 0x91, 0x3f, 0xf2, 0xd2, 0xf9, 0x65, 0xed, 0x0e \
1295 * {32412632-86cb-44a2-9b5c-50d1417354f5}
1297 #define HV_IDE_GUID \
1299 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, \
1300 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5 \
1305 * {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f}
1307 #define HV_SCSI_GUID \
1309 0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, \
1310 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f \
1315 * {0e0b6031-5213-4934-818b-38d90ced39db}
1317 #define HV_SHUTDOWN_GUID \
1319 0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49, \
1320 0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb \
1325 * {9527E630-D0AE-497b-ADCE-E80AB0175CAF}
1327 #define HV_TS_GUID \
1329 0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49, \
1330 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf \
1335 * {57164f39-9115-4e78-ab55-382f3bd5422d}
1337 #define HV_HEART_BEAT_GUID \
1339 0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e, \
1340 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d \
1345 * {a9a0f4e7-5a45-4d96-b827-8a841e8c03e6}
1347 #define HV_KVP_GUID \
1349 0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d, \
1350 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6 \
1354 * Dynamic memory GUID
1355 * {525074dc-8985-46e2-8057-a307dc18a502}
1357 #define HV_DM_GUID \
1359 0xdc, 0x74, 0x50, 0X52, 0x85, 0x89, 0xe2, 0x46, \
1360 0x80, 0x57, 0xa3, 0x07, 0xdc, 0x18, 0xa5, 0x02 \
1365 * {cfa8b69e-5b4a-4cc0-b98b-8ba1a1f3f95a}
1367 #define HV_MOUSE_GUID \
1369 0x9e, 0xb6, 0xa8, 0xcf, 0x4a, 0x5b, 0xc0, 0x4c, \
1370 0xb9, 0x8b, 0x8b, 0xa1, 0xa1, 0xf3, 0xf9, 0x5a \
1374 * VSS (Backup/Restore) GUID
1376 #define HV_VSS_GUID \
1378 0x29, 0x2e, 0xfa, 0x35, 0x23, 0xea, 0x36, 0x42, \
1379 0x96, 0xae, 0x3a, 0x6e, 0xba, 0xcb, 0xa4, 0x40 \
1382 * Synthetic Video GUID
1383 * {DA0A7802-E377-4aac-8E77-0558EB1073F8}
1385 #define HV_SYNTHVID_GUID \
1387 0x02, 0x78, 0x0a, 0xda, 0x77, 0xe3, 0xac, 0x4a, \
1388 0x8e, 0x77, 0x05, 0x58, 0xeb, 0x10, 0x73, 0xf8 \
1392 * Common header for Hyper-V ICs
1395 #define ICMSGTYPE_NEGOTIATE 0
1396 #define ICMSGTYPE_HEARTBEAT 1
1397 #define ICMSGTYPE_KVPEXCHANGE 2
1398 #define ICMSGTYPE_SHUTDOWN 3
1399 #define ICMSGTYPE_TIMESYNC 4
1400 #define ICMSGTYPE_VSS 5
1402 #define ICMSGHDRFLAG_TRANSACTION 1
1403 #define ICMSGHDRFLAG_REQUEST 2
1404 #define ICMSGHDRFLAG_RESPONSE 4
1408 * While we want to handle util services as regular devices,
1409 * there is only one instance of each of these services; so
1410 * we statically allocate the service specific state.
1413 struct hv_util_service {
1415 void (*util_cb)(void *);
1416 int (*util_init)(struct hv_util_service *);
1417 void (*util_deinit)(void);
1420 struct vmbuspipe_hdr {
1431 struct ic_version icverframe;
1433 struct ic_version icvermsg;
1436 u8 ictransaction_id;
1441 struct icmsg_negotiate {
1445 struct ic_version icversion_data[1]; /* any size array */
1448 struct shutdown_msg_data {
1450 u32 timeout_seconds;
1452 u8 display_message[2048];
1455 struct heartbeat_msg_data {
1460 /* Time Sync IC defs */
1461 #define ICTIMESYNCFLAG_PROBE 0
1462 #define ICTIMESYNCFLAG_SYNC 1
1463 #define ICTIMESYNCFLAG_SAMPLE 2
1466 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */
1468 #define WLTIMEDELTA 116444736000000000LL
1471 struct ictimesync_data {
1478 struct hyperv_service_callback {
1482 struct vmbus_channel *channel;
1483 void (*callback) (void *context);
1486 #define MAX_SRV_VER 0x7ffffff
1487 extern void vmbus_prep_negotiate_resp(struct icmsg_hdr *,
1488 struct icmsg_negotiate *, u8 *, int,
1491 int hv_kvp_init(struct hv_util_service *);
1492 void hv_kvp_deinit(void);
1493 void hv_kvp_onchannelcallback(void *);
1495 int hv_vss_init(struct hv_util_service *);
1496 void hv_vss_deinit(void);
1497 void hv_vss_onchannelcallback(void *);
1500 * Negotiated version with the Host.
1503 extern __u32 vmbus_proto_version;
1505 #endif /* __KERNEL__ */
1506 #endif /* _HYPERV_H */