Loading...
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
12#ifndef _HYPERV_VMBUS_H
13#define _HYPERV_VMBUS_H
14
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>
22
23#include "hv_trace.h"
24
25/*
26 * Timeout for services such as KVP and fcopy.
27 */
28#define HV_UTIL_TIMEOUT 30
29
30/*
31 * Timeout for guest-host handshake for services.
32 */
33#define HV_UTIL_NEGO_TIMEOUT 55
34
35
36/* Definitions for the monitored notification facility */
37union hv_monitor_trigger_group {
38 u64 as_uint64;
39 struct {
40 u32 pending;
41 u32 armed;
42 };
43};
44
45struct hv_monitor_parameter {
46 union hv_connection_id connectionid;
47 u16 flagnumber;
48 u16 rsvdz;
49};
50
51union hv_monitor_trigger_state {
52 u32 asu32;
53
54 struct {
55 u32 group_enable:4;
56 u32 rsvdz:28;
57 };
58};
59
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] | */
71/* | ... | */
72/* | 240 | Latency[0][0..3] | */
73/* | 340 | Rsvz3[0] | */
74/* | 440 | Parameter[0][0] | */
75/* | 448 | Parameter[0][1] | */
76/* | ... | */
77/* | 840 | Rsvd4[0] | */
78/* ------------------------------------------------------ */
79struct hv_monitor_page {
80 union hv_monitor_trigger_state trigger_state;
81 u32 rsvdz1;
82
83 union hv_monitor_trigger_group trigger_group[4];
84 u64 rsvdz2[3];
85
86 s32 next_checktime[4][32];
87
88 u16 latency[4][32];
89 u64 rsvdz3[32];
90
91 struct hv_monitor_parameter parameter[4][32];
92
93 u8 rsvdz4[1984];
94};
95
96#define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
97
98/* Definition of the hv_post_message hypercall input structure. */
99struct hv_input_post_message {
100 union hv_connection_id connectionid;
101 u32 reserved;
102 u32 message_type;
103 u32 payload_size;
104 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
105};
106
107
108enum {
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,
117};
118
119/*
120 * Per cpu state for channel handling
121 */
122struct hv_per_cpu_context {
123 void *synic_message_page;
124 void *synic_event_page;
125 /*
126 * buffer to post messages to the host.
127 */
128 void *post_msg_page;
129
130 /*
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
133 * basis.
134 */
135 struct tasklet_struct msg_dpc;
136};
137
138struct hv_context {
139 /* We only support running on top of Hyper-V
140 * So at this point this really can only contain the Hyper-V ID
141 */
142 u64 guestid;
143
144 struct hv_per_cpu_context __percpu *cpu_context;
145
146 /*
147 * To manage allocations in a NUMA node.
148 * Array indexed by numa node ID.
149 */
150 struct cpumask *hv_numa_map;
151};
152
153extern struct hv_context hv_context;
154
155/* Hv Interface */
156
157extern int hv_init(void);
158
159extern int hv_post_message(union hv_connection_id connection_id,
160 enum hv_message_type message_type,
161 void *payload, size_t payload_size);
162
163extern int hv_synic_alloc(void);
164
165extern void hv_synic_free(void);
166
167extern void hv_synic_enable_regs(unsigned int cpu);
168extern int hv_synic_init(unsigned int cpu);
169
170extern void hv_synic_disable_regs(unsigned int cpu);
171extern int hv_synic_cleanup(unsigned int cpu);
172
173/* Interface */
174
175void hv_ringbuffer_pre_init(struct vmbus_channel *channel);
176
177int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
178 struct page *pages, u32 pagecnt, u32 max_pkt_size);
179
180void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
181
182int hv_ringbuffer_write(struct vmbus_channel *channel,
183 const struct kvec *kv_list, u32 kv_count,
184 u64 requestid, u64 *trans_id);
185
186int hv_ringbuffer_read(struct vmbus_channel *channel,
187 void *buffer, u32 buflen, u32 *buffer_actual_len,
188 u64 *requestid, bool raw);
189
190/*
191 * The Maximum number of channels (16384) 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.
194 */
195#define MAX_NUM_CHANNELS ((HV_HYP_PAGE_SIZE >> 1) << 3)
196
197/* The value here must be in multiple of 32 */
198#define MAX_NUM_CHANNELS_SUPPORTED 256
199
200#define MAX_CHANNEL_RELIDS \
201 max(MAX_NUM_CHANNELS_SUPPORTED, HV_EVENT_FLAGS_COUNT)
202
203enum vmbus_connect_state {
204 DISCONNECTED,
205 CONNECTING,
206 CONNECTED,
207 DISCONNECTING
208};
209
210#define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
211
212/*
213 * The CPU that Hyper-V will interrupt for VMBUS messages, such as
214 * CHANNELMSG_OFFERCHANNEL and CHANNELMSG_RESCIND_CHANNELOFFER.
215 */
216#define VMBUS_CONNECT_CPU 0
217
218struct vmbus_connection {
219 u32 msg_conn_id;
220
221 atomic_t offer_in_progress;
222
223 enum vmbus_connect_state conn_state;
224
225 atomic_t next_gpadl_handle;
226
227 struct completion unload_event;
228 /*
229 * Represents channel interrupts. Each bit position represents a
230 * channel. When a channel sends an interrupt via VMBUS, it finds its
231 * bit in the sendInterruptPage, set it and calls Hv to generate a port
232 * event. The other end receives the port event and parse the
233 * recvInterruptPage to see which bit is set
234 */
235 void *int_page;
236 void *send_int_page;
237 void *recv_int_page;
238
239 /*
240 * 2 pages - 1st page for parent->child notification and 2nd
241 * is child->parent notification
242 */
243 struct hv_monitor_page *monitor_pages[2];
244 void *monitor_pages_original[2];
245 phys_addr_t monitor_pages_pa[2];
246 struct list_head chn_msg_list;
247 spinlock_t channelmsg_lock;
248
249 /* List of channels */
250 struct list_head chn_list;
251 struct mutex channel_mutex;
252
253 /* Array of channels */
254 struct vmbus_channel **channels;
255
256 /*
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.
260 */
261 struct workqueue_struct *work_queue;
262 struct workqueue_struct *handle_primary_chan_wq;
263 struct workqueue_struct *handle_sub_chan_wq;
264 struct workqueue_struct *rescind_work_queue;
265
266 /*
267 * On suspension of the vmbus, the accumulated offer messages
268 * must be dropped.
269 */
270 bool ignore_any_offer_msg;
271
272 /*
273 * The number of sub-channels and hv_sock channels that should be
274 * cleaned up upon suspend: sub-channels will be re-created upon
275 * resume, and hv_sock channels should not survive suspend.
276 */
277 atomic_t nr_chan_close_on_suspend;
278 /*
279 * vmbus_bus_suspend() waits for "nr_chan_close_on_suspend" to
280 * drop to zero.
281 */
282 struct completion ready_for_suspend_event;
283
284 /*
285 * The number of primary channels that should be "fixed up"
286 * upon resume: these channels are re-offered upon resume, and some
287 * fields of the channel offers (i.e. child_relid and connection_id)
288 * can change, so the old offermsg must be fixed up, before the resume
289 * callbacks of the VSC drivers start to further touch the channels.
290 */
291 atomic_t nr_chan_fixup_on_resume;
292 /*
293 * vmbus_bus_resume() waits for "nr_chan_fixup_on_resume" to
294 * drop to zero.
295 */
296 struct completion ready_for_resume_event;
297};
298
299
300struct vmbus_msginfo {
301 /* Bookkeeping stuff */
302 struct list_head msglist_entry;
303
304 /* The message itself */
305 unsigned char msg[];
306};
307
308
309extern struct vmbus_connection vmbus_connection;
310
311int vmbus_negotiate_version(struct vmbus_channel_msginfo *msginfo, u32 version);
312
313static inline void vmbus_send_interrupt(u32 relid)
314{
315 sync_set_bit(relid, vmbus_connection.send_int_page);
316}
317
318enum vmbus_message_handler_type {
319 /* The related handler can sleep. */
320 VMHT_BLOCKING = 0,
321
322 /* The related handler must NOT sleep. */
323 VMHT_NON_BLOCKING = 1,
324};
325
326struct vmbus_channel_message_table_entry {
327 enum vmbus_channel_message_type message_type;
328 enum vmbus_message_handler_type handler_type;
329 void (*message_handler)(struct vmbus_channel_message_header *msg);
330 u32 min_payload_len;
331};
332
333extern const struct vmbus_channel_message_table_entry
334 channel_message_table[CHANNELMSG_COUNT];
335
336
337/* General vmbus interface */
338
339struct hv_device *vmbus_device_create(const guid_t *type,
340 const guid_t *instance,
341 struct vmbus_channel *channel);
342
343int vmbus_device_register(struct hv_device *child_device_obj);
344void vmbus_device_unregister(struct hv_device *device_obj);
345int vmbus_add_channel_kobj(struct hv_device *device_obj,
346 struct vmbus_channel *channel);
347
348void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
349
350void vmbus_channel_map_relid(struct vmbus_channel *channel);
351void vmbus_channel_unmap_relid(struct vmbus_channel *channel);
352
353struct vmbus_channel *relid2channel(u32 relid);
354
355void vmbus_free_channels(void);
356
357/* Connection interface */
358
359int vmbus_connect(void);
360void vmbus_disconnect(void);
361
362int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
363
364void vmbus_on_event(unsigned long data);
365void vmbus_on_msg_dpc(unsigned long data);
366
367int hv_kvp_init(struct hv_util_service *srv);
368void hv_kvp_deinit(void);
369int hv_kvp_pre_suspend(void);
370int hv_kvp_pre_resume(void);
371void hv_kvp_onchannelcallback(void *context);
372
373int hv_vss_init(struct hv_util_service *srv);
374void hv_vss_deinit(void);
375int hv_vss_pre_suspend(void);
376int hv_vss_pre_resume(void);
377void hv_vss_onchannelcallback(void *context);
378
379int hv_fcopy_init(struct hv_util_service *srv);
380void hv_fcopy_deinit(void);
381int hv_fcopy_pre_suspend(void);
382int hv_fcopy_pre_resume(void);
383void hv_fcopy_onchannelcallback(void *context);
384void vmbus_initiate_unload(bool crash);
385
386static inline void hv_poll_channel(struct vmbus_channel *channel,
387 void (*cb)(void *))
388{
389 if (!channel)
390 return;
391 cb(channel);
392}
393
394enum hvutil_device_state {
395 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
396 HVUTIL_READY, /* userspace is registered */
397 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
398 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
399 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
400 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
401};
402
403enum delay {
404 INTERRUPT_DELAY = 0,
405 MESSAGE_DELAY = 1,
406};
407
408extern const struct vmbus_device vmbus_devs[];
409
410static inline bool hv_is_perf_channel(struct vmbus_channel *channel)
411{
412 return vmbus_devs[channel->device_id].perf_device;
413}
414
415static inline bool hv_is_allocated_cpu(unsigned int cpu)
416{
417 struct vmbus_channel *channel, *sc;
418
419 lockdep_assert_held(&vmbus_connection.channel_mutex);
420 /*
421 * List additions/deletions as well as updates of the target CPUs are
422 * protected by channel_mutex.
423 */
424 list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
425 if (!hv_is_perf_channel(channel))
426 continue;
427 if (channel->target_cpu == cpu)
428 return true;
429 list_for_each_entry(sc, &channel->sc_list, sc_list) {
430 if (sc->target_cpu == cpu)
431 return true;
432 }
433 }
434 return false;
435}
436
437static inline void hv_set_allocated_cpu(unsigned int cpu)
438{
439 cpumask_set_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
440}
441
442static inline void hv_clear_allocated_cpu(unsigned int cpu)
443{
444 if (hv_is_allocated_cpu(cpu))
445 return;
446 cpumask_clear_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
447}
448
449static inline void hv_update_allocated_cpus(unsigned int old_cpu,
450 unsigned int new_cpu)
451{
452 hv_set_allocated_cpu(new_cpu);
453 hv_clear_allocated_cpu(old_cpu);
454}
455
456#ifdef CONFIG_HYPERV_TESTING
457
458int hv_debug_add_dev_dir(struct hv_device *dev);
459void hv_debug_rm_dev_dir(struct hv_device *dev);
460void hv_debug_rm_all_dir(void);
461int hv_debug_init(void);
462void hv_debug_delay_test(struct vmbus_channel *channel, enum delay delay_type);
463
464#else /* CONFIG_HYPERV_TESTING */
465
466static inline void hv_debug_rm_dev_dir(struct hv_device *dev) {};
467static inline void hv_debug_rm_all_dir(void) {};
468static inline void hv_debug_delay_test(struct vmbus_channel *channel,
469 enum delay delay_type) {};
470static inline int hv_debug_init(void)
471{
472 return -1;
473}
474
475static inline int hv_debug_add_dev_dir(struct hv_device *dev)
476{
477 return -1;
478}
479
480#endif /* CONFIG_HYPERV_TESTING */
481
482#endif /* _HYPERV_VMBUS_H */
1/*
2 *
3 * Copyright (c) 2011, Microsoft Corporation.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307 USA.
17 *
18 * Authors:
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
21 * K. Y. Srinivasan <kys@microsoft.com>
22 *
23 */
24
25#ifndef _HYPERV_VMBUS_H
26#define _HYPERV_VMBUS_H
27
28#include <linux/list.h>
29#include <asm/sync_bitops.h>
30#include <linux/atomic.h>
31#include <linux/hyperv.h>
32
33/*
34 * Timeout for services such as KVP and fcopy.
35 */
36#define HV_UTIL_TIMEOUT 30
37
38/*
39 * Timeout for guest-host handshake for services.
40 */
41#define HV_UTIL_NEGO_TIMEOUT 55
42
43/*
44 * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
45 * is set by CPUID(HVCPUID_VERSION_FEATURES).
46 */
47enum hv_cpuid_function {
48 HVCPUID_VERSION_FEATURES = 0x00000001,
49 HVCPUID_VENDOR_MAXFUNCTION = 0x40000000,
50 HVCPUID_INTERFACE = 0x40000001,
51
52 /*
53 * The remaining functions depend on the value of
54 * HVCPUID_INTERFACE
55 */
56 HVCPUID_VERSION = 0x40000002,
57 HVCPUID_FEATURES = 0x40000003,
58 HVCPUID_ENLIGHTENMENT_INFO = 0x40000004,
59 HVCPUID_IMPLEMENTATION_LIMITS = 0x40000005,
60};
61
62#define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE 0x400
63
64#define HV_X64_MSR_CRASH_P0 0x40000100
65#define HV_X64_MSR_CRASH_P1 0x40000101
66#define HV_X64_MSR_CRASH_P2 0x40000102
67#define HV_X64_MSR_CRASH_P3 0x40000103
68#define HV_X64_MSR_CRASH_P4 0x40000104
69#define HV_X64_MSR_CRASH_CTL 0x40000105
70
71#define HV_CRASH_CTL_CRASH_NOTIFY (1ULL << 63)
72
73/* Define version of the synthetic interrupt controller. */
74#define HV_SYNIC_VERSION (1)
75
76#define HV_ANY_VP (0xFFFFFFFF)
77
78/* Define synthetic interrupt controller flag constants. */
79#define HV_EVENT_FLAGS_COUNT (256 * 8)
80#define HV_EVENT_FLAGS_BYTE_COUNT (256)
81#define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
82
83/* Define invalid partition identifier. */
84#define HV_PARTITION_ID_INVALID ((u64)0x0)
85
86/* Define port type. */
87enum hv_port_type {
88 HVPORT_MSG = 1,
89 HVPORT_EVENT = 2,
90 HVPORT_MONITOR = 3
91};
92
93/* Define port information structure. */
94struct hv_port_info {
95 enum hv_port_type port_type;
96 u32 padding;
97 union {
98 struct {
99 u32 target_sint;
100 u32 target_vp;
101 u64 rsvdz;
102 } message_port_info;
103 struct {
104 u32 target_sint;
105 u32 target_vp;
106 u16 base_flag_number;
107 u16 flag_count;
108 u32 rsvdz;
109 } event_port_info;
110 struct {
111 u64 monitor_address;
112 u64 rsvdz;
113 } monitor_port_info;
114 };
115};
116
117struct hv_connection_info {
118 enum hv_port_type port_type;
119 u32 padding;
120 union {
121 struct {
122 u64 rsvdz;
123 } message_connection_info;
124 struct {
125 u64 rsvdz;
126 } event_connection_info;
127 struct {
128 u64 monitor_address;
129 } monitor_connection_info;
130 };
131};
132
133/*
134 * Timer configuration register.
135 */
136union hv_timer_config {
137 u64 as_uint64;
138 struct {
139 u64 enable:1;
140 u64 periodic:1;
141 u64 lazy:1;
142 u64 auto_enable:1;
143 u64 reserved_z0:12;
144 u64 sintx:4;
145 u64 reserved_z1:44;
146 };
147};
148
149/* Define the number of message buffers associated with each port. */
150#define HV_PORT_MESSAGE_BUFFER_COUNT (16)
151
152/* Define the synthetic interrupt controller event flags format. */
153union hv_synic_event_flags {
154 u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
155 u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
156};
157
158/* Define the synthetic interrupt flags page layout. */
159struct hv_synic_event_flags_page {
160 union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
161};
162
163/* Define SynIC control register. */
164union hv_synic_scontrol {
165 u64 as_uint64;
166 struct {
167 u64 enable:1;
168 u64 reserved:63;
169 };
170};
171
172/* Define synthetic interrupt source. */
173union hv_synic_sint {
174 u64 as_uint64;
175 struct {
176 u64 vector:8;
177 u64 reserved1:8;
178 u64 masked:1;
179 u64 auto_eoi:1;
180 u64 reserved2:46;
181 };
182};
183
184/* Define the format of the SIMP register */
185union hv_synic_simp {
186 u64 as_uint64;
187 struct {
188 u64 simp_enabled:1;
189 u64 preserved:11;
190 u64 base_simp_gpa:52;
191 };
192};
193
194/* Define the format of the SIEFP register */
195union hv_synic_siefp {
196 u64 as_uint64;
197 struct {
198 u64 siefp_enabled:1;
199 u64 preserved:11;
200 u64 base_siefp_gpa:52;
201 };
202};
203
204/* Definitions for the monitored notification facility */
205union hv_monitor_trigger_group {
206 u64 as_uint64;
207 struct {
208 u32 pending;
209 u32 armed;
210 };
211};
212
213struct hv_monitor_parameter {
214 union hv_connection_id connectionid;
215 u16 flagnumber;
216 u16 rsvdz;
217};
218
219union hv_monitor_trigger_state {
220 u32 asu32;
221
222 struct {
223 u32 group_enable:4;
224 u32 rsvdz:28;
225 };
226};
227
228/* struct hv_monitor_page Layout */
229/* ------------------------------------------------------ */
230/* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
231/* | 8 | TriggerGroup[0] | */
232/* | 10 | TriggerGroup[1] | */
233/* | 18 | TriggerGroup[2] | */
234/* | 20 | TriggerGroup[3] | */
235/* | 28 | Rsvd2[0] | */
236/* | 30 | Rsvd2[1] | */
237/* | 38 | Rsvd2[2] | */
238/* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
239/* | ... | */
240/* | 240 | Latency[0][0..3] | */
241/* | 340 | Rsvz3[0] | */
242/* | 440 | Parameter[0][0] | */
243/* | 448 | Parameter[0][1] | */
244/* | ... | */
245/* | 840 | Rsvd4[0] | */
246/* ------------------------------------------------------ */
247struct hv_monitor_page {
248 union hv_monitor_trigger_state trigger_state;
249 u32 rsvdz1;
250
251 union hv_monitor_trigger_group trigger_group[4];
252 u64 rsvdz2[3];
253
254 s32 next_checktime[4][32];
255
256 u16 latency[4][32];
257 u64 rsvdz3[32];
258
259 struct hv_monitor_parameter parameter[4][32];
260
261 u8 rsvdz4[1984];
262};
263
264/* Definition of the hv_post_message hypercall input structure. */
265struct hv_input_post_message {
266 union hv_connection_id connectionid;
267 u32 reserved;
268 u32 message_type;
269 u32 payload_size;
270 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
271};
272
273/*
274 * Versioning definitions used for guests reporting themselves to the
275 * hypervisor, and visa versa.
276 */
277
278/* Version info reported by guest OS's */
279enum hv_guest_os_vendor {
280 HVGUESTOS_VENDOR_MICROSOFT = 0x0001
281};
282
283enum hv_guest_os_microsoft_ids {
284 HVGUESTOS_MICROSOFT_UNDEFINED = 0x00,
285 HVGUESTOS_MICROSOFT_MSDOS = 0x01,
286 HVGUESTOS_MICROSOFT_WINDOWS3X = 0x02,
287 HVGUESTOS_MICROSOFT_WINDOWS9X = 0x03,
288 HVGUESTOS_MICROSOFT_WINDOWSNT = 0x04,
289 HVGUESTOS_MICROSOFT_WINDOWSCE = 0x05
290};
291
292/*
293 * Declare the MSR used to identify the guest OS.
294 */
295#define HV_X64_MSR_GUEST_OS_ID 0x40000000
296
297union hv_x64_msr_guest_os_id_contents {
298 u64 as_uint64;
299 struct {
300 u64 build_number:16;
301 u64 service_version:8; /* Service Pack, etc. */
302 u64 minor_version:8;
303 u64 major_version:8;
304 u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
305 u64 vendor_id:16; /* enum hv_guest_os_vendor */
306 };
307};
308
309/*
310 * Declare the MSR used to setup pages used to communicate with the hypervisor.
311 */
312#define HV_X64_MSR_HYPERCALL 0x40000001
313
314union hv_x64_msr_hypercall_contents {
315 u64 as_uint64;
316 struct {
317 u64 enable:1;
318 u64 reserved:11;
319 u64 guest_physical_address:52;
320 };
321};
322
323
324enum {
325 VMBUS_MESSAGE_CONNECTION_ID = 1,
326 VMBUS_MESSAGE_PORT_ID = 1,
327 VMBUS_EVENT_CONNECTION_ID = 2,
328 VMBUS_EVENT_PORT_ID = 2,
329 VMBUS_MONITOR_CONNECTION_ID = 3,
330 VMBUS_MONITOR_PORT_ID = 3,
331 VMBUS_MESSAGE_SINT = 2,
332};
333
334/* #defines */
335
336#define HV_PRESENT_BIT 0x80000000
337
338/*
339 * The guest OS needs to register the guest ID with the hypervisor.
340 * The guest ID is a 64 bit entity and the structure of this ID is
341 * specified in the Hyper-V specification:
342 *
343 * http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
344 *
345 * While the current guideline does not specify how Linux guest ID(s)
346 * need to be generated, our plan is to publish the guidelines for
347 * Linux and other guest operating systems that currently are hosted
348 * on Hyper-V. The implementation here conforms to this yet
349 * unpublished guidelines.
350 *
351 *
352 * Bit(s)
353 * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
354 * 62:56 - Os Type; Linux is 0x100
355 * 55:48 - Distro specific identification
356 * 47:16 - Linux kernel version number
357 * 15:0 - Distro specific identification
358 *
359 *
360 */
361
362#define HV_LINUX_VENDOR_ID 0x8100
363
364/*
365 * Generate the guest ID based on the guideline described above.
366 */
367
368static inline __u64 generate_guest_id(__u8 d_info1, __u32 kernel_version,
369 __u16 d_info2)
370{
371 __u64 guest_id = 0;
372
373 guest_id = (((__u64)HV_LINUX_VENDOR_ID) << 48);
374 guest_id |= (((__u64)(d_info1)) << 48);
375 guest_id |= (((__u64)(kernel_version)) << 16);
376 guest_id |= ((__u64)(d_info2));
377
378 return guest_id;
379}
380
381
382#define HV_CPU_POWER_MANAGEMENT (1 << 0)
383#define HV_RECOMMENDATIONS_MAX 4
384
385#define HV_X64_MAX 5
386#define HV_CAPS_MAX 8
387
388
389#define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
390
391
392/* Service definitions */
393
394#define HV_SERVICE_PARENT_PORT (0)
395#define HV_SERVICE_PARENT_CONNECTION (0)
396
397#define HV_SERVICE_CONNECT_RESPONSE_SUCCESS (0)
398#define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER (1)
399#define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE (2)
400#define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
401
402#define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID (1)
403#define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID (2)
404#define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID (3)
405#define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID (4)
406#define HV_SERVICE_MAX_MESSAGE_ID (4)
407
408#define HV_SERVICE_PROTOCOL_VERSION (0x0010)
409#define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
410
411/* #define VMBUS_REVISION_NUMBER 6 */
412
413/* Our local vmbus's port and connection id. Anything >0 is fine */
414/* #define VMBUS_PORT_ID 11 */
415
416/* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
417static const uuid_le VMBUS_SERVICE_ID = {
418 .b = {
419 0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
420 0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
421 },
422};
423
424
425
426struct hv_context {
427 /* We only support running on top of Hyper-V
428 * So at this point this really can only contain the Hyper-V ID
429 */
430 u64 guestid;
431
432 void *hypercall_page;
433 void *tsc_page;
434
435 bool synic_initialized;
436
437 void *synic_message_page[NR_CPUS];
438 void *synic_event_page[NR_CPUS];
439 /*
440 * Hypervisor's notion of virtual processor ID is different from
441 * Linux' notion of CPU ID. This information can only be retrieved
442 * in the context of the calling CPU. Setup a map for easy access
443 * to this information:
444 *
445 * vp_index[a] is the Hyper-V's processor ID corresponding to
446 * Linux cpuid 'a'.
447 */
448 u32 vp_index[NR_CPUS];
449 /*
450 * Starting with win8, we can take channel interrupts on any CPU;
451 * we will manage the tasklet that handles events messages on a per CPU
452 * basis.
453 */
454 struct tasklet_struct *event_dpc[NR_CPUS];
455 struct tasklet_struct *msg_dpc[NR_CPUS];
456 /*
457 * To optimize the mapping of relid to channel, maintain
458 * per-cpu list of the channels based on their CPU affinity.
459 */
460 struct list_head percpu_list[NR_CPUS];
461 /*
462 * buffer to post messages to the host.
463 */
464 void *post_msg_page[NR_CPUS];
465 /*
466 * Support PV clockevent device.
467 */
468 struct clock_event_device *clk_evt[NR_CPUS];
469 /*
470 * To manage allocations in a NUMA node.
471 * Array indexed by numa node ID.
472 */
473 struct cpumask *hv_numa_map;
474};
475
476extern struct hv_context hv_context;
477
478struct ms_hyperv_tsc_page {
479 volatile u32 tsc_sequence;
480 u32 reserved1;
481 volatile u64 tsc_scale;
482 volatile s64 tsc_offset;
483 u64 reserved2[509];
484};
485
486struct hv_ring_buffer_debug_info {
487 u32 current_interrupt_mask;
488 u32 current_read_index;
489 u32 current_write_index;
490 u32 bytes_avail_toread;
491 u32 bytes_avail_towrite;
492};
493
494/* Hv Interface */
495
496extern int hv_init(void);
497
498extern void hv_cleanup(bool crash);
499
500extern int hv_post_message(union hv_connection_id connection_id,
501 enum hv_message_type message_type,
502 void *payload, size_t payload_size);
503
504extern int hv_synic_alloc(void);
505
506extern void hv_synic_free(void);
507
508extern void hv_synic_init(void *irqarg);
509
510extern void hv_synic_cleanup(void *arg);
511
512extern void hv_synic_clockevents_cleanup(void);
513
514/*
515 * Host version information.
516 */
517extern unsigned int host_info_eax;
518extern unsigned int host_info_ebx;
519extern unsigned int host_info_ecx;
520extern unsigned int host_info_edx;
521
522/* Interface */
523
524
525int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
526 struct page *pages, u32 pagecnt);
527
528void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
529
530int hv_ringbuffer_write(struct vmbus_channel *channel,
531 struct kvec *kv_list,
532 u32 kv_count, bool lock,
533 bool kick_q);
534
535int hv_ringbuffer_read(struct vmbus_channel *channel,
536 void *buffer, u32 buflen, u32 *buffer_actual_len,
537 u64 *requestid, bool raw);
538
539void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
540 struct hv_ring_buffer_debug_info *debug_info);
541
542void hv_begin_read(struct hv_ring_buffer_info *rbi);
543
544u32 hv_end_read(struct hv_ring_buffer_info *rbi);
545
546/*
547 * Maximum channels is determined by the size of the interrupt page
548 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
549 * and the other is receive endpoint interrupt
550 */
551#define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
552
553/* The value here must be in multiple of 32 */
554/* TODO: Need to make this configurable */
555#define MAX_NUM_CHANNELS_SUPPORTED 256
556
557
558enum vmbus_connect_state {
559 DISCONNECTED,
560 CONNECTING,
561 CONNECTED,
562 DISCONNECTING
563};
564
565#define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
566
567struct vmbus_connection {
568 enum vmbus_connect_state conn_state;
569
570 atomic_t next_gpadl_handle;
571
572 struct completion unload_event;
573 /*
574 * Represents channel interrupts. Each bit position represents a
575 * channel. When a channel sends an interrupt via VMBUS, it finds its
576 * bit in the sendInterruptPage, set it and calls Hv to generate a port
577 * event. The other end receives the port event and parse the
578 * recvInterruptPage to see which bit is set
579 */
580 void *int_page;
581 void *send_int_page;
582 void *recv_int_page;
583
584 /*
585 * 2 pages - 1st page for parent->child notification and 2nd
586 * is child->parent notification
587 */
588 struct hv_monitor_page *monitor_pages[2];
589 struct list_head chn_msg_list;
590 spinlock_t channelmsg_lock;
591
592 /* List of channels */
593 struct list_head chn_list;
594 struct mutex channel_mutex;
595
596 struct workqueue_struct *work_queue;
597};
598
599
600struct vmbus_msginfo {
601 /* Bookkeeping stuff */
602 struct list_head msglist_entry;
603
604 /* The message itself */
605 unsigned char msg[0];
606};
607
608
609extern struct vmbus_connection vmbus_connection;
610
611enum vmbus_message_handler_type {
612 /* The related handler can sleep. */
613 VMHT_BLOCKING = 0,
614
615 /* The related handler must NOT sleep. */
616 VMHT_NON_BLOCKING = 1,
617};
618
619struct vmbus_channel_message_table_entry {
620 enum vmbus_channel_message_type message_type;
621 enum vmbus_message_handler_type handler_type;
622 void (*message_handler)(struct vmbus_channel_message_header *msg);
623};
624
625extern struct vmbus_channel_message_table_entry
626 channel_message_table[CHANNELMSG_COUNT];
627
628/* Free the message slot and signal end-of-message if required */
629static inline void vmbus_signal_eom(struct hv_message *msg, u32 old_msg_type)
630{
631 /*
632 * On crash we're reading some other CPU's message page and we need
633 * to be careful: this other CPU may already had cleared the header
634 * and the host may already had delivered some other message there.
635 * In case we blindly write msg->header.message_type we're going
636 * to lose it. We can still lose a message of the same type but
637 * we count on the fact that there can only be one
638 * CHANNELMSG_UNLOAD_RESPONSE and we don't care about other messages
639 * on crash.
640 */
641 if (cmpxchg(&msg->header.message_type, old_msg_type,
642 HVMSG_NONE) != old_msg_type)
643 return;
644
645 /*
646 * Make sure the write to MessageType (ie set to
647 * HVMSG_NONE) happens before we read the
648 * MessagePending and EOMing. Otherwise, the EOMing
649 * will not deliver any more messages since there is
650 * no empty slot
651 */
652 mb();
653
654 if (msg->header.message_flags.msg_pending) {
655 /*
656 * This will cause message queue rescan to
657 * possibly deliver another msg from the
658 * hypervisor
659 */
660 wrmsrl(HV_X64_MSR_EOM, 0);
661 }
662}
663
664/* General vmbus interface */
665
666struct hv_device *vmbus_device_create(const uuid_le *type,
667 const uuid_le *instance,
668 struct vmbus_channel *channel);
669
670int vmbus_device_register(struct hv_device *child_device_obj);
671void vmbus_device_unregister(struct hv_device *device_obj);
672
673/* static void */
674/* VmbusChildDeviceDestroy( */
675/* struct hv_device *); */
676
677struct vmbus_channel *relid2channel(u32 relid);
678
679void vmbus_free_channels(void);
680
681/* Connection interface */
682
683int vmbus_connect(void);
684void vmbus_disconnect(void);
685
686int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
687
688void vmbus_on_event(unsigned long data);
689void vmbus_on_msg_dpc(unsigned long data);
690
691int hv_kvp_init(struct hv_util_service *);
692void hv_kvp_deinit(void);
693void hv_kvp_onchannelcallback(void *);
694
695int hv_vss_init(struct hv_util_service *);
696void hv_vss_deinit(void);
697void hv_vss_onchannelcallback(void *);
698
699int hv_fcopy_init(struct hv_util_service *);
700void hv_fcopy_deinit(void);
701void hv_fcopy_onchannelcallback(void *);
702void vmbus_initiate_unload(bool crash);
703
704static inline void hv_poll_channel(struct vmbus_channel *channel,
705 void (*cb)(void *))
706{
707 if (!channel)
708 return;
709
710 smp_call_function_single(channel->target_cpu, cb, channel, true);
711}
712
713enum hvutil_device_state {
714 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
715 HVUTIL_READY, /* userspace is registered */
716 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
717 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
718 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
719 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
720};
721
722#endif /* _HYPERV_VMBUS_H */