PageRenderTime 61ms CodeModel.GetById 29ms RepoModel.GetById 1ms app.codeStats 0ms

/drivers/hv/hyperv_vmbus.h

https://github.com/mveerendra/linux
C Header | 475 lines | 261 code | 99 blank | 115 comment | 7 complexity | 02d7fcd395ea76bb303b44b092baa3eb MD5 | raw file
  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, u32 max_pkt_size);
  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. u64 requestid);
  147. int hv_ringbuffer_read(struct vmbus_channel *channel,
  148. void *buffer, u32 buflen, u32 *buffer_actual_len,
  149. u64 *requestid, bool raw);
  150. /*
  151. * The Maximum number of channels (16384) is determined by the size of the
  152. * interrupt page, which is HV_HYP_PAGE_SIZE. 1/2 of HV_HYP_PAGE_SIZE is to
  153. * send endpoint interrupts, and the other is to receive endpoint interrupts.
  154. */
  155. #define MAX_NUM_CHANNELS ((HV_HYP_PAGE_SIZE >> 1) << 3)
  156. /* The value here must be in multiple of 32 */
  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. void *monitor_pages_original[2];
  194. phys_addr_t monitor_pages_pa[2];
  195. struct list_head chn_msg_list;
  196. spinlock_t channelmsg_lock;
  197. /* List of channels */
  198. struct list_head chn_list;
  199. struct mutex channel_mutex;
  200. /* Array of channels */
  201. struct vmbus_channel **channels;
  202. /*
  203. * An offer message is handled first on the work_queue, and then
  204. * is further handled on handle_primary_chan_wq or
  205. * handle_sub_chan_wq.
  206. */
  207. struct workqueue_struct *work_queue;
  208. struct workqueue_struct *handle_primary_chan_wq;
  209. struct workqueue_struct *handle_sub_chan_wq;
  210. /*
  211. * The number of sub-channels and hv_sock channels that should be
  212. * cleaned up upon suspend: sub-channels will be re-created upon
  213. * resume, and hv_sock channels should not survive suspend.
  214. */
  215. atomic_t nr_chan_close_on_suspend;
  216. /*
  217. * vmbus_bus_suspend() waits for "nr_chan_close_on_suspend" to
  218. * drop to zero.
  219. */
  220. struct completion ready_for_suspend_event;
  221. /*
  222. * The number of primary channels that should be "fixed up"
  223. * upon resume: these channels are re-offered upon resume, and some
  224. * fields of the channel offers (i.e. child_relid and connection_id)
  225. * can change, so the old offermsg must be fixed up, before the resume
  226. * callbacks of the VSC drivers start to further touch the channels.
  227. */
  228. atomic_t nr_chan_fixup_on_resume;
  229. /*
  230. * vmbus_bus_resume() waits for "nr_chan_fixup_on_resume" to
  231. * drop to zero.
  232. */
  233. struct completion ready_for_resume_event;
  234. };
  235. struct vmbus_msginfo {
  236. /* Bookkeeping stuff */
  237. struct list_head msglist_entry;
  238. /* The message itself */
  239. unsigned char msg[];
  240. };
  241. extern struct vmbus_connection vmbus_connection;
  242. int vmbus_negotiate_version(struct vmbus_channel_msginfo *msginfo, u32 version);
  243. static inline void vmbus_send_interrupt(u32 relid)
  244. {
  245. sync_set_bit(relid, vmbus_connection.send_int_page);
  246. }
  247. enum vmbus_message_handler_type {
  248. /* The related handler can sleep. */
  249. VMHT_BLOCKING = 0,
  250. /* The related handler must NOT sleep. */
  251. VMHT_NON_BLOCKING = 1,
  252. };
  253. struct vmbus_channel_message_table_entry {
  254. enum vmbus_channel_message_type message_type;
  255. enum vmbus_message_handler_type handler_type;
  256. void (*message_handler)(struct vmbus_channel_message_header *msg);
  257. u32 min_payload_len;
  258. };
  259. extern const struct vmbus_channel_message_table_entry
  260. channel_message_table[CHANNELMSG_COUNT];
  261. /* General vmbus interface */
  262. struct hv_device *vmbus_device_create(const guid_t *type,
  263. const guid_t *instance,
  264. struct vmbus_channel *channel);
  265. int vmbus_device_register(struct hv_device *child_device_obj);
  266. void vmbus_device_unregister(struct hv_device *device_obj);
  267. int vmbus_add_channel_kobj(struct hv_device *device_obj,
  268. struct vmbus_channel *channel);
  269. void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
  270. void vmbus_channel_map_relid(struct vmbus_channel *channel);
  271. void vmbus_channel_unmap_relid(struct vmbus_channel *channel);
  272. struct vmbus_channel *relid2channel(u32 relid);
  273. void vmbus_free_channels(void);
  274. /* Connection interface */
  275. int vmbus_connect(void);
  276. void vmbus_disconnect(void);
  277. int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
  278. void vmbus_on_event(unsigned long data);
  279. void vmbus_on_msg_dpc(unsigned long data);
  280. int hv_kvp_init(struct hv_util_service *srv);
  281. void hv_kvp_deinit(void);
  282. int hv_kvp_pre_suspend(void);
  283. int hv_kvp_pre_resume(void);
  284. void hv_kvp_onchannelcallback(void *context);
  285. int hv_vss_init(struct hv_util_service *srv);
  286. void hv_vss_deinit(void);
  287. int hv_vss_pre_suspend(void);
  288. int hv_vss_pre_resume(void);
  289. void hv_vss_onchannelcallback(void *context);
  290. int hv_fcopy_init(struct hv_util_service *srv);
  291. void hv_fcopy_deinit(void);
  292. int hv_fcopy_pre_suspend(void);
  293. int hv_fcopy_pre_resume(void);
  294. void hv_fcopy_onchannelcallback(void *context);
  295. void vmbus_initiate_unload(bool crash);
  296. static inline void hv_poll_channel(struct vmbus_channel *channel,
  297. void (*cb)(void *))
  298. {
  299. if (!channel)
  300. return;
  301. cb(channel);
  302. }
  303. enum hvutil_device_state {
  304. HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
  305. HVUTIL_READY, /* userspace is registered */
  306. HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
  307. HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
  308. HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
  309. HVUTIL_DEVICE_DYING, /* driver unload is in progress */
  310. };
  311. enum delay {
  312. INTERRUPT_DELAY = 0,
  313. MESSAGE_DELAY = 1,
  314. };
  315. extern const struct vmbus_device vmbus_devs[];
  316. static inline bool hv_is_perf_channel(struct vmbus_channel *channel)
  317. {
  318. return vmbus_devs[channel->device_id].perf_device;
  319. }
  320. static inline bool hv_is_allocated_cpu(unsigned int cpu)
  321. {
  322. struct vmbus_channel *channel, *sc;
  323. lockdep_assert_held(&vmbus_connection.channel_mutex);
  324. /*
  325. * List additions/deletions as well as updates of the target CPUs are
  326. * protected by channel_mutex.
  327. */
  328. list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
  329. if (!hv_is_perf_channel(channel))
  330. continue;
  331. if (channel->target_cpu == cpu)
  332. return true;
  333. list_for_each_entry(sc, &channel->sc_list, sc_list) {
  334. if (sc->target_cpu == cpu)
  335. return true;
  336. }
  337. }
  338. return false;
  339. }
  340. static inline void hv_set_allocated_cpu(unsigned int cpu)
  341. {
  342. cpumask_set_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
  343. }
  344. static inline void hv_clear_allocated_cpu(unsigned int cpu)
  345. {
  346. if (hv_is_allocated_cpu(cpu))
  347. return;
  348. cpumask_clear_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
  349. }
  350. static inline void hv_update_allocated_cpus(unsigned int old_cpu,
  351. unsigned int new_cpu)
  352. {
  353. hv_set_allocated_cpu(new_cpu);
  354. hv_clear_allocated_cpu(old_cpu);
  355. }
  356. #ifdef CONFIG_HYPERV_TESTING
  357. int hv_debug_add_dev_dir(struct hv_device *dev);
  358. void hv_debug_rm_dev_dir(struct hv_device *dev);
  359. void hv_debug_rm_all_dir(void);
  360. int hv_debug_init(void);
  361. void hv_debug_delay_test(struct vmbus_channel *channel, enum delay delay_type);
  362. #else /* CONFIG_HYPERV_TESTING */
  363. static inline void hv_debug_rm_dev_dir(struct hv_device *dev) {};
  364. static inline void hv_debug_rm_all_dir(void) {};
  365. static inline void hv_debug_delay_test(struct vmbus_channel *channel,
  366. enum delay delay_type) {};
  367. static inline int hv_debug_init(void)
  368. {
  369. return -1;
  370. }
  371. static inline int hv_debug_add_dev_dir(struct hv_device *dev)
  372. {
  373. return -1;
  374. }
  375. #endif /* CONFIG_HYPERV_TESTING */
  376. #endif /* _HYPERV_VMBUS_H */