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;
139 /* We only support running on top of Hyper-V
140 * So at this point this really can only contain the Hyper-V ID
144 struct hv_per_cpu_context __percpu *cpu_context;
147 * To manage allocations in a NUMA node.
148 * Array indexed by numa node ID.
150 struct cpumask *hv_numa_map;
153 extern struct hv_context hv_context;
157 extern int hv_init(void);
159 extern int hv_post_message(union hv_connection_id connection_id,
160 enum hv_message_type message_type,
161 void *payload, size_t payload_size);
163 extern int hv_synic_alloc(void);
165 extern void hv_synic_free(void);
167 extern void hv_synic_enable_regs(unsigned int cpu);
168 extern int hv_synic_init(unsigned int cpu);
170 extern void hv_synic_disable_regs(unsigned int cpu);
171 extern int hv_synic_cleanup(unsigned int cpu);
175 void hv_ringbuffer_pre_init(struct vmbus_channel *channel);
177 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
178 struct page *pages, u32 pagecnt);
180 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
182 int hv_ringbuffer_write(struct vmbus_channel *channel,
183 const struct kvec *kv_list, u32 kv_count,
186 int hv_ringbuffer_read(struct vmbus_channel *channel,
187 void *buffer, u32 buflen, u32 *buffer_actual_len,
188 u64 *requestid, bool raw);
191 * The Maximum number of channels (16348) is determined by the size of the
192 * interrupt page, which is HV_HYP_PAGE_SIZE. 1/2 of HV_HYP_PAGE_SIZE is to
193 * send endpoint interrupts, and the other is to receive endpoint interrupts.
195 #define MAX_NUM_CHANNELS ((HV_HYP_PAGE_SIZE >> 1) << 3)
197 /* The value here must be in multiple of 32 */
198 /* TODO: Need to make this configurable */
199 #define MAX_NUM_CHANNELS_SUPPORTED 256
201 #define MAX_CHANNEL_RELIDS \
202 max(MAX_NUM_CHANNELS_SUPPORTED, HV_EVENT_FLAGS_COUNT)
204 enum vmbus_connect_state {
211 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
214 * The CPU that Hyper-V will interrupt for VMBUS messages, such as
215 * CHANNELMSG_OFFERCHANNEL and CHANNELMSG_RESCIND_CHANNELOFFER.
217 #define VMBUS_CONNECT_CPU 0
219 struct vmbus_connection {
222 atomic_t offer_in_progress;
224 enum vmbus_connect_state conn_state;
226 atomic_t next_gpadl_handle;
228 struct completion unload_event;
230 * Represents channel interrupts. Each bit position represents a
231 * channel. When a channel sends an interrupt via VMBUS, it finds its
232 * bit in the sendInterruptPage, set it and calls Hv to generate a port
233 * event. The other end receives the port event and parse the
234 * recvInterruptPage to see which bit is set
241 * 2 pages - 1st page for parent->child notification and 2nd
242 * is child->parent notification
244 struct hv_monitor_page *monitor_pages[2];
245 struct list_head chn_msg_list;
246 spinlock_t channelmsg_lock;
248 /* List of channels */
249 struct list_head chn_list;
250 struct mutex channel_mutex;
252 /* Array of channels */
253 struct vmbus_channel **channels;
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 */
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);
325 extern const struct vmbus_channel_message_table_entry
326 channel_message_table[CHANNELMSG_COUNT];
329 /* General vmbus interface */
331 struct hv_device *vmbus_device_create(const guid_t *type,
332 const guid_t *instance,
333 struct vmbus_channel *channel);
335 int vmbus_device_register(struct hv_device *child_device_obj);
336 void vmbus_device_unregister(struct hv_device *device_obj);
337 int vmbus_add_channel_kobj(struct hv_device *device_obj,
338 struct vmbus_channel *channel);
340 void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
342 void vmbus_channel_map_relid(struct vmbus_channel *channel);
343 void vmbus_channel_unmap_relid(struct vmbus_channel *channel);
345 struct vmbus_channel *relid2channel(u32 relid);
347 void vmbus_free_channels(void);
349 /* Connection interface */
351 int vmbus_connect(void);
352 void vmbus_disconnect(void);
354 int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
356 void vmbus_on_event(unsigned long data);
357 void vmbus_on_msg_dpc(unsigned long data);
359 int hv_kvp_init(struct hv_util_service *srv);
360 void hv_kvp_deinit(void);
361 int hv_kvp_pre_suspend(void);
362 int hv_kvp_pre_resume(void);
363 void hv_kvp_onchannelcallback(void *context);
365 int hv_vss_init(struct hv_util_service *srv);
366 void hv_vss_deinit(void);
367 int hv_vss_pre_suspend(void);
368 int hv_vss_pre_resume(void);
369 void hv_vss_onchannelcallback(void *context);
371 int hv_fcopy_init(struct hv_util_service *srv);
372 void hv_fcopy_deinit(void);
373 int hv_fcopy_pre_suspend(void);
374 int hv_fcopy_pre_resume(void);
375 void hv_fcopy_onchannelcallback(void *context);
376 void vmbus_initiate_unload(bool crash);
378 static inline void hv_poll_channel(struct vmbus_channel *channel,
386 enum hvutil_device_state {
387 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
388 HVUTIL_READY, /* userspace is registered */
389 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
390 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
391 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
392 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
400 extern const struct vmbus_device vmbus_devs[];
402 static inline bool hv_is_perf_channel(struct vmbus_channel *channel)
404 return vmbus_devs[channel->device_id].perf_device;
407 static inline bool hv_is_alloced_cpu(unsigned int cpu)
409 struct vmbus_channel *channel, *sc;
411 lockdep_assert_held(&vmbus_connection.channel_mutex);
413 * List additions/deletions as well as updates of the target CPUs are
414 * protected by channel_mutex.
416 list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
417 if (!hv_is_perf_channel(channel))
419 if (channel->target_cpu == cpu)
421 list_for_each_entry(sc, &channel->sc_list, sc_list) {
422 if (sc->target_cpu == cpu)
429 static inline void hv_set_alloced_cpu(unsigned int cpu)
431 cpumask_set_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
434 static inline void hv_clear_alloced_cpu(unsigned int cpu)
436 if (hv_is_alloced_cpu(cpu))
438 cpumask_clear_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
441 static inline void hv_update_alloced_cpus(unsigned int old_cpu,
442 unsigned int new_cpu)
444 hv_set_alloced_cpu(new_cpu);
445 hv_clear_alloced_cpu(old_cpu);
448 #ifdef CONFIG_HYPERV_TESTING
450 int hv_debug_add_dev_dir(struct hv_device *dev);
451 void hv_debug_rm_dev_dir(struct hv_device *dev);
452 void hv_debug_rm_all_dir(void);
453 int hv_debug_init(void);
454 void hv_debug_delay_test(struct vmbus_channel *channel, enum delay delay_type);
456 #else /* CONFIG_HYPERV_TESTING */
458 static inline void hv_debug_rm_dev_dir(struct hv_device *dev) {};
459 static inline void hv_debug_rm_all_dir(void) {};
460 static inline void hv_debug_delay_test(struct vmbus_channel *channel,
461 enum delay delay_type) {};
462 static inline int hv_debug_init(void)
467 static inline int hv_debug_add_dev_dir(struct hv_device *dev)
472 #endif /* CONFIG_HYPERV_TESTING */
474 #endif /* _HYPERV_VMBUS_H */