hyperv_vmbus.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. *
  4. * Copyright (c) 2011, Microsoft Corporation.
  5. *
  6. * Authors:
  7. * Haiyang Zhang <haiyangz@microsoft.com>
  8. * Hank Janssen <hjanssen@microsoft.com>
  9. * K. Y. Srinivasan <kys@microsoft.com>
  10. */
  11. #ifndef _HYPERV_VMBUS_H
  12. #define _HYPERV_VMBUS_H
  13. #include <linux/list.h>
  14. #include <linux/bitops.h>
  15. #include <asm/sync_bitops.h>
  16. #include <asm/hyperv-tlfs.h>
  17. #include <linux/atomic.h>
  18. #include <linux/hyperv.h>
  19. #include <linux/interrupt.h>
  20. #include "hv_trace.h"
  21. /*
  22. * Timeout for services such as KVP and fcopy.
  23. */
  24. #define HV_UTIL_TIMEOUT 30
  25. /*
  26. * Timeout for guest-host handshake for services.
  27. */
  28. #define HV_UTIL_NEGO_TIMEOUT 55
  29. /* Definitions for the monitored notification facility */
  30. union hv_monitor_trigger_group {
  31. u64 as_uint64;
  32. struct {
  33. u32 pending;
  34. u32 armed;
  35. };
  36. };
  37. struct hv_monitor_parameter {
  38. union hv_connection_id connectionid;
  39. u16 flagnumber;
  40. u16 rsvdz;
  41. };
  42. union hv_monitor_trigger_state {
  43. u32 asu32;
  44. struct {
  45. u32 group_enable:4;
  46. u32 rsvdz:28;
  47. };
  48. };
  49. /* struct hv_monitor_page Layout */
  50. /* ------------------------------------------------------ */
  51. /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
  52. /* | 8 | TriggerGroup[0] | */
  53. /* | 10 | TriggerGroup[1] | */
  54. /* | 18 | TriggerGroup[2] | */
  55. /* | 20 | TriggerGroup[3] | */
  56. /* | 28 | Rsvd2[0] | */
  57. /* | 30 | Rsvd2[1] | */
  58. /* | 38 | Rsvd2[2] | */
  59. /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
  60. /* | ... | */
  61. /* | 240 | Latency[0][0..3] | */
  62. /* | 340 | Rsvz3[0] | */
  63. /* | 440 | Parameter[0][0] | */
  64. /* | 448 | Parameter[0][1] | */
  65. /* | ... | */
  66. /* | 840 | Rsvd4[0] | */
  67. /* ------------------------------------------------------ */
  68. struct hv_monitor_page {
  69. union hv_monitor_trigger_state trigger_state;
  70. u32 rsvdz1;
  71. union hv_monitor_trigger_group trigger_group[4];
  72. u64 rsvdz2[3];
  73. s32 next_checktime[4][32];
  74. u16 latency[4][32];
  75. u64 rsvdz3[32];
  76. struct hv_monitor_parameter parameter[4][32];
  77. u8 rsvdz4[1984];
  78. };
  79. #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
  80. /* Definition of the hv_post_message hypercall input structure. */
  81. struct hv_input_post_message {
  82. union hv_connection_id connectionid;
  83. u32 reserved;
  84. u32 message_type;
  85. u32 payload_size;
  86. u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
  87. };
  88. enum {
  89. VMBUS_MESSAGE_CONNECTION_ID = 1,
  90. VMBUS_MESSAGE_CONNECTION_ID_4 = 4,
  91. VMBUS_MESSAGE_PORT_ID = 1,
  92. VMBUS_EVENT_CONNECTION_ID = 2,
  93. VMBUS_EVENT_PORT_ID = 2,
  94. VMBUS_MONITOR_CONNECTION_ID = 3,
  95. VMBUS_MONITOR_PORT_ID = 3,
  96. VMBUS_MESSAGE_SINT = 2,
  97. };
  98. /*
  99. * Per cpu state for channel handling
  100. */
  101. struct hv_per_cpu_context {
  102. void *synic_message_page;
  103. void *synic_event_page;
  104. /*
  105. * buffer to post messages to the host.
  106. */
  107. void *post_msg_page;
  108. /*
  109. * Starting with win8, we can take channel interrupts on any CPU;
  110. * we will manage the tasklet that handles events messages on a per CPU
  111. * basis.
  112. */
  113. struct tasklet_struct msg_dpc;
  114. };
  115. struct hv_context {
  116. /* We only support running on top of Hyper-V
  117. * So at this point this really can only contain the Hyper-V ID
  118. */
  119. u64 guestid;
  120. struct hv_per_cpu_context __percpu *cpu_context;
  121. /*
  122. * To manage allocations in a NUMA node.
  123. * Array indexed by numa node ID.
  124. */
  125. struct cpumask *hv_numa_map;
  126. };
  127. extern struct hv_context hv_context;
  128. /* Hv Interface */
  129. extern int hv_init(void);
  130. extern int hv_post_message(union hv_connection_id connection_id,
  131. enum hv_message_type message_type,
  132. void *payload, size_t payload_size);
  133. extern int hv_synic_alloc(void);
  134. extern void hv_synic_free(void);
  135. extern void hv_synic_enable_regs(unsigned int cpu);
  136. extern int hv_synic_init(unsigned int cpu);
  137. extern void hv_synic_disable_regs(unsigned int cpu);
  138. extern int hv_synic_cleanup(unsigned int cpu);
  139. /* Interface */
  140. void hv_ringbuffer_pre_init(struct vmbus_channel *channel);
  141. int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
  142. struct page *pages, u32 pagecnt);
  143. void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
  144. int hv_ringbuffer_write(struct vmbus_channel *channel,
  145. const struct kvec *kv_list, u32 kv_count);
  146. int hv_ringbuffer_read(struct vmbus_channel *channel,
  147. void *buffer, u32 buflen, u32 *buffer_actual_len,
  148. u64 *requestid, bool raw);
  149. /*
  150. * The Maximum number of channels (16348) is determined by the size of the
  151. * interrupt page, which is HV_HYP_PAGE_SIZE. 1/2 of HV_HYP_PAGE_SIZE is to
  152. * send endpoint interrupts, and the other is to receive endpoint interrupts.
  153. */
  154. #define MAX_NUM_CHANNELS ((HV_HYP_PAGE_SIZE >> 1) << 3)
  155. /* The value here must be in multiple of 32 */
  156. /* TODO: Need to make this configurable */
  157. #define MAX_NUM_CHANNELS_SUPPORTED 256
  158. #define MAX_CHANNEL_RELIDS \
  159. max(MAX_NUM_CHANNELS_SUPPORTED, HV_EVENT_FLAGS_COUNT)
  160. enum vmbus_connect_state {
  161. DISCONNECTED,
  162. CONNECTING,
  163. CONNECTED,
  164. DISCONNECTING
  165. };
  166. #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
  167. /*
  168. * The CPU that Hyper-V will interrupt for VMBUS messages, such as
  169. * CHANNELMSG_OFFERCHANNEL and CHANNELMSG_RESCIND_CHANNELOFFER.
  170. */
  171. #define VMBUS_CONNECT_CPU 0
  172. struct vmbus_connection {
  173. u32 msg_conn_id;
  174. atomic_t offer_in_progress;
  175. enum vmbus_connect_state conn_state;
  176. atomic_t next_gpadl_handle;
  177. struct completion unload_event;
  178. /*
  179. * Represents channel interrupts. Each bit position represents a
  180. * channel. When a channel sends an interrupt via VMBUS, it finds its
  181. * bit in the sendInterruptPage, set it and calls Hv to generate a port
  182. * event. The other end receives the port event and parse the
  183. * recvInterruptPage to see which bit is set
  184. */
  185. void *int_page;
  186. void *send_int_page;
  187. void *recv_int_page;
  188. /*
  189. * 2 pages - 1st page for parent->child notification and 2nd
  190. * is child->parent notification
  191. */
  192. struct hv_monitor_page *monitor_pages[2];
  193. struct list_head chn_msg_list;
  194. spinlock_t channelmsg_lock;
  195. /* List of channels */
  196. struct list_head chn_list;
  197. struct mutex channel_mutex;
  198. /* Array of channels */
  199. struct vmbus_channel **channels;
  200. /*
  201. * An offer message is handled first on the work_queue, and then
  202. * is further handled on handle_primary_chan_wq or
  203. * handle_sub_chan_wq.
  204. */
  205. struct workqueue_struct *work_queue;
  206. struct workqueue_struct *handle_primary_chan_wq;
  207. struct workqueue_struct *handle_sub_chan_wq;
  208. /*
  209. * The number of sub-channels and hv_sock channels that should be
  210. * cleaned up upon suspend: sub-channels will be re-created upon
  211. * resume, and hv_sock channels should not survive suspend.
  212. */
  213. atomic_t nr_chan_close_on_suspend;
  214. /*
  215. * vmbus_bus_suspend() waits for "nr_chan_close_on_suspend" to
  216. * drop to zero.
  217. */
  218. struct completion ready_for_suspend_event;
  219. /*
  220. * The number of primary channels that should be "fixed up"
  221. * upon resume: these channels are re-offered upon resume, and some
  222. * fields of the channel offers (i.e. child_relid and connection_id)
  223. * can change, so the old offermsg must be fixed up, before the resume
  224. * callbacks of the VSC drivers start to further touch the channels.
  225. */
  226. atomic_t nr_chan_fixup_on_resume;
  227. /*
  228. * vmbus_bus_resume() waits for "nr_chan_fixup_on_resume" to
  229. * drop to zero.
  230. */
  231. struct completion ready_for_resume_event;
  232. };
  233. struct vmbus_msginfo {
  234. /* Bookkeeping stuff */
  235. struct list_head msglist_entry;
  236. /* The message itself */
  237. unsigned char msg[];
  238. };
  239. extern struct vmbus_connection vmbus_connection;
  240. int vmbus_negotiate_version(struct vmbus_channel_msginfo *msginfo, u32 version);
  241. static inline void vmbus_send_interrupt(u32 relid)
  242. {
  243. sync_set_bit(relid, vmbus_connection.send_int_page);
  244. }
  245. enum vmbus_message_handler_type {
  246. /* The related handler can sleep. */
  247. VMHT_BLOCKING = 0,
  248. /* The related handler must NOT sleep. */
  249. VMHT_NON_BLOCKING = 1,
  250. };
  251. struct vmbus_channel_message_table_entry {
  252. enum vmbus_channel_message_type message_type;
  253. enum vmbus_message_handler_type handler_type;
  254. void (*message_handler)(struct vmbus_channel_message_header *msg);
  255. u32 min_payload_len;
  256. };
  257. extern const struct vmbus_channel_message_table_entry
  258. channel_message_table[CHANNELMSG_COUNT];
  259. /* General vmbus interface */
  260. struct hv_device *vmbus_device_create(const guid_t *type,
  261. const guid_t *instance,
  262. struct vmbus_channel *channel);
  263. int vmbus_device_register(struct hv_device *child_device_obj);
  264. void vmbus_device_unregister(struct hv_device *device_obj);
  265. int vmbus_add_channel_kobj(struct hv_device *device_obj,
  266. struct vmbus_channel *channel);
  267. void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
  268. void vmbus_channel_map_relid(struct vmbus_channel *channel);
  269. void vmbus_channel_unmap_relid(struct vmbus_channel *channel);
  270. struct vmbus_channel *relid2channel(u32 relid);
  271. void vmbus_free_channels(void);
  272. /* Connection interface */
  273. int vmbus_connect(void);
  274. void vmbus_disconnect(void);
  275. int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
  276. void vmbus_on_event(unsigned long data);
  277. void vmbus_on_msg_dpc(unsigned long data);
  278. int hv_kvp_init(struct hv_util_service *srv);
  279. void hv_kvp_deinit(void);
  280. int hv_kvp_pre_suspend(void);
  281. int hv_kvp_pre_resume(void);
  282. void hv_kvp_onchannelcallback(void *context);
  283. int hv_vss_init(struct hv_util_service *srv);
  284. void hv_vss_deinit(void);
  285. int hv_vss_pre_suspend(void);
  286. int hv_vss_pre_resume(void);
  287. void hv_vss_onchannelcallback(void *context);
  288. int hv_fcopy_init(struct hv_util_service *srv);
  289. void hv_fcopy_deinit(void);
  290. int hv_fcopy_pre_suspend(void);
  291. int hv_fcopy_pre_resume(void);
  292. void hv_fcopy_onchannelcallback(void *context);
  293. void vmbus_initiate_unload(bool crash);
  294. static inline void hv_poll_channel(struct vmbus_channel *channel,
  295. void (*cb)(void *))
  296. {
  297. if (!channel)
  298. return;
  299. cb(channel);
  300. }
  301. enum hvutil_device_state {
  302. HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
  303. HVUTIL_READY, /* userspace is registered */
  304. HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
  305. HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
  306. HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
  307. HVUTIL_DEVICE_DYING, /* driver unload is in progress */
  308. };
  309. enum delay {
  310. INTERRUPT_DELAY = 0,
  311. MESSAGE_DELAY = 1,
  312. };
  313. extern const struct vmbus_device vmbus_devs[];
  314. static inline bool hv_is_perf_channel(struct vmbus_channel *channel)
  315. {
  316. return vmbus_devs[channel->device_id].perf_device;
  317. }
  318. static inline bool hv_is_alloced_cpu(unsigned int cpu)
  319. {
  320. struct vmbus_channel *channel, *sc;
  321. lockdep_assert_held(&vmbus_connection.channel_mutex);
  322. /*
  323. * List additions/deletions as well as updates of the target CPUs are
  324. * protected by channel_mutex.
  325. */
  326. list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
  327. if (!hv_is_perf_channel(channel))
  328. continue;
  329. if (channel->target_cpu == cpu)
  330. return true;
  331. list_for_each_entry(sc, &channel->sc_list, sc_list) {
  332. if (sc->target_cpu == cpu)
  333. return true;
  334. }
  335. }
  336. return false;
  337. }
  338. static inline void hv_set_alloced_cpu(unsigned int cpu)
  339. {
  340. cpumask_set_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
  341. }
  342. static inline void hv_clear_alloced_cpu(unsigned int cpu)
  343. {
  344. if (hv_is_alloced_cpu(cpu))
  345. return;
  346. cpumask_clear_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
  347. }
  348. static inline void hv_update_alloced_cpus(unsigned int old_cpu,
  349. unsigned int new_cpu)
  350. {
  351. hv_set_alloced_cpu(new_cpu);
  352. hv_clear_alloced_cpu(old_cpu);
  353. }
  354. #ifdef CONFIG_HYPERV_TESTING
  355. int hv_debug_add_dev_dir(struct hv_device *dev);
  356. void hv_debug_rm_dev_dir(struct hv_device *dev);
  357. void hv_debug_rm_all_dir(void);
  358. int hv_debug_init(void);
  359. void hv_debug_delay_test(struct vmbus_channel *channel, enum delay delay_type);
  360. #else /* CONFIG_HYPERV_TESTING */
  361. static inline void hv_debug_rm_dev_dir(struct hv_device *dev) {};
  362. static inline void hv_debug_rm_all_dir(void) {};
  363. static inline void hv_debug_delay_test(struct vmbus_channel *channel,
  364. enum delay delay_type) {};
  365. static inline int hv_debug_init(void)
  366. {
  367. return -1;
  368. }
  369. static inline int hv_debug_add_dev_dir(struct hv_device *dev)
  370. {
  371. return -1;
  372. }
  373. #endif /* CONFIG_HYPERV_TESTING */
  374. #endif /* _HYPERV_VMBUS_H */