1 /* SPDX-License-Identifier: GPL-2.0-only */
4 * Copyright (c) 2011, Microsoft Corporation.
7 * Haiyang Zhang <haiyangz@microsoft.com>
8 * Hank Janssen <hjanssen@microsoft.com>
9 * K. Y. Srinivasan <kys@microsoft.com>
12 #ifndef _HYPERV_VMBUS_H
13 #define _HYPERV_VMBUS_H
15 #include <linux/list.h>
16 #include <asm/sync_bitops.h>
17 #include <asm/hyperv-tlfs.h>
18 #include <linux/atomic.h>
19 #include <linux/hyperv.h>
20 #include <linux/interrupt.h>
25 * Timeout for services such as KVP and fcopy.
27 #define HV_UTIL_TIMEOUT 30
30 * Timeout for guest-host handshake for services.
32 #define HV_UTIL_NEGO_TIMEOUT 55
35 /* Definitions for the monitored notification facility */
36 union hv_monitor_trigger_group {
44 struct hv_monitor_parameter {
45 union hv_connection_id connectionid;
50 union hv_monitor_trigger_state {
59 /* struct hv_monitor_page Layout */
60 /* ------------------------------------------------------ */
61 /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
62 /* | 8 | TriggerGroup[0] | */
63 /* | 10 | TriggerGroup[1] | */
64 /* | 18 | TriggerGroup[2] | */
65 /* | 20 | TriggerGroup[3] | */
66 /* | 28 | Rsvd2[0] | */
67 /* | 30 | Rsvd2[1] | */
68 /* | 38 | Rsvd2[2] | */
69 /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
71 /* | 240 | Latency[0][0..3] | */
72 /* | 340 | Rsvz3[0] | */
73 /* | 440 | Parameter[0][0] | */
74 /* | 448 | Parameter[0][1] | */
76 /* | 840 | Rsvd4[0] | */
77 /* ------------------------------------------------------ */
78 struct hv_monitor_page {
79 union hv_monitor_trigger_state trigger_state;
82 union hv_monitor_trigger_group trigger_group[4];
85 s32 next_checktime[4][32];
90 struct hv_monitor_parameter parameter[4][32];
95 #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
97 /* Definition of the hv_post_message hypercall input structure. */
98 struct hv_input_post_message {
99 union hv_connection_id connectionid;
103 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
108 VMBUS_MESSAGE_CONNECTION_ID = 1,
109 VMBUS_MESSAGE_CONNECTION_ID_4 = 4,
110 VMBUS_MESSAGE_PORT_ID = 1,
111 VMBUS_EVENT_CONNECTION_ID = 2,
112 VMBUS_EVENT_PORT_ID = 2,
113 VMBUS_MONITOR_CONNECTION_ID = 3,
114 VMBUS_MONITOR_PORT_ID = 3,
115 VMBUS_MESSAGE_SINT = 2,
119 * Per cpu state for channel handling
121 struct hv_per_cpu_context {
122 void *synic_message_page;
123 void *synic_event_page;
125 * buffer to post messages to the host.
130 * Starting with win8, we can take channel interrupts on any CPU;
131 * we will manage the tasklet that handles events messages on a per CPU
134 struct tasklet_struct msg_dpc;
137 * To optimize the mapping of relid to channel, maintain
138 * per-cpu list of the channels based on their CPU affinity.
140 struct list_head chan_list;
141 struct clock_event_device *clk_evt;
145 /* We only support running on top of Hyper-V
146 * So at this point this really can only contain the Hyper-V ID
152 struct hv_per_cpu_context __percpu *cpu_context;
155 * To manage allocations in a NUMA node.
156 * Array indexed by numa node ID.
158 struct cpumask *hv_numa_map;
161 extern struct hv_context hv_context;
165 extern int hv_init(void);
167 extern int hv_post_message(union hv_connection_id connection_id,
168 enum hv_message_type message_type,
169 void *payload, size_t payload_size);
171 extern int hv_synic_alloc(void);
173 extern void hv_synic_free(void);
175 extern int hv_synic_init(unsigned int cpu);
177 extern int hv_synic_cleanup(unsigned int cpu);
179 extern void hv_synic_clockevents_cleanup(void);
183 void hv_ringbuffer_pre_init(struct vmbus_channel *channel);
185 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
186 struct page *pages, u32 pagecnt);
188 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
190 int hv_ringbuffer_write(struct vmbus_channel *channel,
191 const struct kvec *kv_list, u32 kv_count);
193 int hv_ringbuffer_read(struct vmbus_channel *channel,
194 void *buffer, u32 buflen, u32 *buffer_actual_len,
195 u64 *requestid, bool raw);
198 * Maximum channels is determined by the size of the interrupt page
199 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
200 * and the other is receive endpoint interrupt
202 #define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
204 /* The value here must be in multiple of 32 */
205 /* TODO: Need to make this configurable */
206 #define MAX_NUM_CHANNELS_SUPPORTED 256
209 enum vmbus_connect_state {
216 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
218 struct vmbus_connection {
220 * CPU on which the initial host contact was made.
226 atomic_t offer_in_progress;
228 enum vmbus_connect_state conn_state;
230 atomic_t next_gpadl_handle;
232 struct completion unload_event;
234 * Represents channel interrupts. Each bit position represents a
235 * channel. When a channel sends an interrupt via VMBUS, it finds its
236 * bit in the sendInterruptPage, set it and calls Hv to generate a port
237 * event. The other end receives the port event and parse the
238 * recvInterruptPage to see which bit is set
245 * 2 pages - 1st page for parent->child notification and 2nd
246 * is child->parent notification
248 struct hv_monitor_page *monitor_pages[2];
249 struct list_head chn_msg_list;
250 spinlock_t channelmsg_lock;
252 /* List of channels */
253 struct list_head chn_list;
254 struct mutex channel_mutex;
257 * An offer message is handled first on the work_queue, and then
258 * is further handled on handle_primary_chan_wq or
259 * handle_sub_chan_wq.
261 struct workqueue_struct *work_queue;
262 struct workqueue_struct *handle_primary_chan_wq;
263 struct workqueue_struct *handle_sub_chan_wq;
267 struct vmbus_msginfo {
268 /* Bookkeeping stuff */
269 struct list_head msglist_entry;
271 /* The message itself */
272 unsigned char msg[0];
276 extern struct vmbus_connection vmbus_connection;
278 static inline void vmbus_send_interrupt(u32 relid)
280 sync_set_bit(relid, vmbus_connection.send_int_page);
283 enum vmbus_message_handler_type {
284 /* The related handler can sleep. */
287 /* The related handler must NOT sleep. */
288 VMHT_NON_BLOCKING = 1,
291 struct vmbus_channel_message_table_entry {
292 enum vmbus_channel_message_type message_type;
293 enum vmbus_message_handler_type handler_type;
294 void (*message_handler)(struct vmbus_channel_message_header *msg);
297 extern const struct vmbus_channel_message_table_entry
298 channel_message_table[CHANNELMSG_COUNT];
301 /* General vmbus interface */
303 struct hv_device *vmbus_device_create(const guid_t *type,
304 const guid_t *instance,
305 struct vmbus_channel *channel);
307 int vmbus_device_register(struct hv_device *child_device_obj);
308 void vmbus_device_unregister(struct hv_device *device_obj);
309 int vmbus_add_channel_kobj(struct hv_device *device_obj,
310 struct vmbus_channel *channel);
312 void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
314 struct vmbus_channel *relid2channel(u32 relid);
316 void vmbus_free_channels(void);
318 /* Connection interface */
320 int vmbus_connect(void);
321 void vmbus_disconnect(void);
323 int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
325 void vmbus_on_event(unsigned long data);
326 void vmbus_on_msg_dpc(unsigned long data);
328 int hv_kvp_init(struct hv_util_service *srv);
329 void hv_kvp_deinit(void);
330 void hv_kvp_onchannelcallback(void *context);
332 int hv_vss_init(struct hv_util_service *srv);
333 void hv_vss_deinit(void);
334 void hv_vss_onchannelcallback(void *context);
336 int hv_fcopy_init(struct hv_util_service *srv);
337 void hv_fcopy_deinit(void);
338 void hv_fcopy_onchannelcallback(void *context);
339 void vmbus_initiate_unload(bool crash);
341 static inline void hv_poll_channel(struct vmbus_channel *channel,
347 if (in_interrupt() && (channel->target_cpu == smp_processor_id())) {
351 smp_call_function_single(channel->target_cpu, cb, channel, true);
354 enum hvutil_device_state {
355 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
356 HVUTIL_READY, /* userspace is registered */
357 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
358 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
359 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
360 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
363 #endif /* _HYPERV_VMBUS_H */