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 <linux/bitops.h>
17 #include <asm/sync_bitops.h>
18 #include <asm/hyperv-tlfs.h>
19 #include <linux/atomic.h>
20 #include <linux/hyperv.h>
21 #include <linux/interrupt.h>
26 * Timeout for services such as KVP and fcopy.
28 #define HV_UTIL_TIMEOUT 30
31 * Timeout for guest-host handshake for services.
33 #define HV_UTIL_NEGO_TIMEOUT 55
36 /* Definitions for the monitored notification facility */
37 union hv_monitor_trigger_group {
45 struct hv_monitor_parameter {
46 union hv_connection_id connectionid;
51 union hv_monitor_trigger_state {
60 /* struct hv_monitor_page Layout */
61 /* ------------------------------------------------------ */
62 /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
63 /* | 8 | TriggerGroup[0] | */
64 /* | 10 | TriggerGroup[1] | */
65 /* | 18 | TriggerGroup[2] | */
66 /* | 20 | TriggerGroup[3] | */
67 /* | 28 | Rsvd2[0] | */
68 /* | 30 | Rsvd2[1] | */
69 /* | 38 | Rsvd2[2] | */
70 /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
72 /* | 240 | Latency[0][0..3] | */
73 /* | 340 | Rsvz3[0] | */
74 /* | 440 | Parameter[0][0] | */
75 /* | 448 | Parameter[0][1] | */
77 /* | 840 | Rsvd4[0] | */
78 /* ------------------------------------------------------ */
79 struct hv_monitor_page {
80 union hv_monitor_trigger_state trigger_state;
83 union hv_monitor_trigger_group trigger_group[4];
86 s32 next_checktime[4][32];
91 struct hv_monitor_parameter parameter[4][32];
96 #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
98 /* Definition of the hv_post_message hypercall input structure. */
99 struct hv_input_post_message {
100 union hv_connection_id connectionid;
104 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
109 VMBUS_MESSAGE_CONNECTION_ID = 1,
110 VMBUS_MESSAGE_CONNECTION_ID_4 = 4,
111 VMBUS_MESSAGE_PORT_ID = 1,
112 VMBUS_EVENT_CONNECTION_ID = 2,
113 VMBUS_EVENT_PORT_ID = 2,
114 VMBUS_MONITOR_CONNECTION_ID = 3,
115 VMBUS_MONITOR_PORT_ID = 3,
116 VMBUS_MESSAGE_SINT = 2,
120 * Per cpu state for channel handling
122 struct hv_per_cpu_context {
123 void *synic_message_page;
124 void *synic_event_page;
126 * buffer to post messages to the host.
131 * Starting with win8, we can take channel interrupts on any CPU;
132 * we will manage the tasklet that handles events messages on a per CPU
135 struct tasklet_struct msg_dpc;
138 * To optimize the mapping of relid to channel, maintain
139 * per-cpu list of the channels based on their CPU affinity.
141 struct list_head chan_list;
145 /* We only support running on top of Hyper-V
146 * So at this point this really can only contain the Hyper-V ID
150 struct hv_per_cpu_context __percpu *cpu_context;
153 * To manage allocations in a NUMA node.
154 * Array indexed by numa node ID.
156 struct cpumask *hv_numa_map;
159 extern struct hv_context hv_context;
163 extern int hv_init(void);
165 extern int hv_post_message(union hv_connection_id connection_id,
166 enum hv_message_type message_type,
167 void *payload, size_t payload_size);
169 extern int hv_synic_alloc(void);
171 extern void hv_synic_free(void);
173 extern void hv_synic_enable_regs(unsigned int cpu);
174 extern int hv_synic_init(unsigned int cpu);
176 extern void hv_synic_disable_regs(unsigned int cpu);
177 extern int hv_synic_cleanup(unsigned int cpu);
181 void hv_ringbuffer_pre_init(struct vmbus_channel *channel);
183 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
184 struct page *pages, u32 pagecnt);
186 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
188 int hv_ringbuffer_write(struct vmbus_channel *channel,
189 const struct kvec *kv_list, u32 kv_count);
191 int hv_ringbuffer_read(struct vmbus_channel *channel,
192 void *buffer, u32 buflen, u32 *buffer_actual_len,
193 u64 *requestid, bool raw);
196 * The Maximum number of channels (16348) is determined by the size of the
197 * interrupt page, which is HV_HYP_PAGE_SIZE. 1/2 of HV_HYP_PAGE_SIZE is to
198 * send endpoint interrupts, and the other is to receive endpoint interrupts.
200 #define MAX_NUM_CHANNELS ((HV_HYP_PAGE_SIZE >> 1) << 3)
202 /* The value here must be in multiple of 32 */
203 /* TODO: Need to make this configurable */
204 #define MAX_NUM_CHANNELS_SUPPORTED 256
207 enum vmbus_connect_state {
214 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
217 * The CPU that Hyper-V will interrupt for VMBUS messages, such as
218 * CHANNELMSG_OFFERCHANNEL and CHANNELMSG_RESCIND_CHANNELOFFER.
220 #define VMBUS_CONNECT_CPU 0
222 struct vmbus_connection {
225 atomic_t offer_in_progress;
227 enum vmbus_connect_state conn_state;
229 atomic_t next_gpadl_handle;
231 struct completion unload_event;
233 * Represents channel interrupts. Each bit position represents a
234 * channel. When a channel sends an interrupt via VMBUS, it finds its
235 * bit in the sendInterruptPage, set it and calls Hv to generate a port
236 * event. The other end receives the port event and parse the
237 * recvInterruptPage to see which bit is set
244 * 2 pages - 1st page for parent->child notification and 2nd
245 * is child->parent notification
247 struct hv_monitor_page *monitor_pages[2];
248 struct list_head chn_msg_list;
249 spinlock_t channelmsg_lock;
251 /* List of channels */
252 struct list_head chn_list;
253 struct mutex channel_mutex;
256 * An offer message is handled first on the work_queue, and then
257 * is further handled on handle_primary_chan_wq or
258 * handle_sub_chan_wq.
260 struct workqueue_struct *work_queue;
261 struct workqueue_struct *handle_primary_chan_wq;
262 struct workqueue_struct *handle_sub_chan_wq;
265 * The number of sub-channels and hv_sock channels that should be
266 * cleaned up upon suspend: sub-channels will be re-created upon
267 * resume, and hv_sock channels should not survive suspend.
269 atomic_t nr_chan_close_on_suspend;
271 * vmbus_bus_suspend() waits for "nr_chan_close_on_suspend" to
274 struct completion ready_for_suspend_event;
277 * The number of primary channels that should be "fixed up"
278 * upon resume: these channels are re-offered upon resume, and some
279 * fields of the channel offers (i.e. child_relid and connection_id)
280 * can change, so the old offermsg must be fixed up, before the resume
281 * callbacks of the VSC drivers start to further touch the channels.
283 atomic_t nr_chan_fixup_on_resume;
285 * vmbus_bus_resume() waits for "nr_chan_fixup_on_resume" to
288 struct completion ready_for_resume_event;
292 struct vmbus_msginfo {
293 /* Bookkeeping stuff */
294 struct list_head msglist_entry;
296 /* The message itself */
297 unsigned char msg[0];
301 extern struct vmbus_connection vmbus_connection;
303 int vmbus_negotiate_version(struct vmbus_channel_msginfo *msginfo, u32 version);
305 static inline void vmbus_send_interrupt(u32 relid)
307 sync_set_bit(relid, vmbus_connection.send_int_page);
310 enum vmbus_message_handler_type {
311 /* The related handler can sleep. */
314 /* The related handler must NOT sleep. */
315 VMHT_NON_BLOCKING = 1,
318 struct vmbus_channel_message_table_entry {
319 enum vmbus_channel_message_type message_type;
320 enum vmbus_message_handler_type handler_type;
321 void (*message_handler)(struct vmbus_channel_message_header *msg);
324 extern const struct vmbus_channel_message_table_entry
325 channel_message_table[CHANNELMSG_COUNT];
328 /* General vmbus interface */
330 struct hv_device *vmbus_device_create(const guid_t *type,
331 const guid_t *instance,
332 struct vmbus_channel *channel);
334 int vmbus_device_register(struct hv_device *child_device_obj);
335 void vmbus_device_unregister(struct hv_device *device_obj);
336 int vmbus_add_channel_kobj(struct hv_device *device_obj,
337 struct vmbus_channel *channel);
339 void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
341 struct vmbus_channel *relid2channel(u32 relid);
343 void vmbus_free_channels(void);
345 /* Connection interface */
347 int vmbus_connect(void);
348 void vmbus_disconnect(void);
350 int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
352 void vmbus_on_event(unsigned long data);
353 void vmbus_on_msg_dpc(unsigned long data);
355 int hv_kvp_init(struct hv_util_service *srv);
356 void hv_kvp_deinit(void);
357 void hv_kvp_onchannelcallback(void *context);
359 int hv_vss_init(struct hv_util_service *srv);
360 void hv_vss_deinit(void);
361 void hv_vss_onchannelcallback(void *context);
363 int hv_fcopy_init(struct hv_util_service *srv);
364 void hv_fcopy_deinit(void);
365 void hv_fcopy_onchannelcallback(void *context);
366 void vmbus_initiate_unload(bool crash);
368 static inline void hv_poll_channel(struct vmbus_channel *channel,
374 if (in_interrupt() && (channel->target_cpu == smp_processor_id())) {
378 smp_call_function_single(channel->target_cpu, cb, channel, true);
381 enum hvutil_device_state {
382 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
383 HVUTIL_READY, /* userspace is registered */
384 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
385 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
386 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
387 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
390 #endif /* _HYPERV_VMBUS_H */