[linux-block.git] / drivers / hv / hyperv_vmbus.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 *
 * Copyright (c) 2011, Microsoft Corporation.
 *
 * Authors:
 *   Haiyang Zhang <haiyangz@microsoft.com>
 *   Hank Janssen  <hjanssen@microsoft.com>
 *   K. Y. Srinivasan <kys@microsoft.com>
 */

#ifndef _HYPERV_VMBUS_H
#define _HYPERV_VMBUS_H

#include <linux/list.h>
#include <linux/bitops.h>
#include <asm/sync_bitops.h>
#include <asm/hyperv-tlfs.h>
#include <linux/atomic.h>
#include <linux/hyperv.h>
#include <linux/interrupt.h>

#include "hv_trace.h"

/*
 * Timeout for services such as KVP and fcopy.
 */
#define HV_UTIL_TIMEOUT 30

/*
 * Timeout for guest-host handshake for services.
 */
#define HV_UTIL_NEGO_TIMEOUT 55


/* Definitions for the monitored notification facility */
union hv_monitor_trigger_group {
	u64 as_uint64;
	struct {
		u32 pending;
		u32 armed;
	};
};

struct hv_monitor_parameter {
	union hv_connection_id connectionid;
	u16 flagnumber;
	u16 rsvdz;
};

union hv_monitor_trigger_state {
	u32 asu32;

	struct {
		u32 group_enable:4;
		u32 rsvdz:28;
	};
};

/* struct hv_monitor_page Layout */
/* ------------------------------------------------------ */
/* | 0   | TriggerState (4 bytes) | Rsvd1 (4 bytes)     | */
/* | 8   | TriggerGroup[0]                              | */
/* | 10  | TriggerGroup[1]                              | */
/* | 18  | TriggerGroup[2]                              | */
/* | 20  | TriggerGroup[3]                              | */
/* | 28  | Rsvd2[0]                                     | */
/* | 30  | Rsvd2[1]                                     | */
/* | 38  | Rsvd2[2]                                     | */
/* | 40  | NextCheckTime[0][0]    | NextCheckTime[0][1] | */
/* | ...                                                | */
/* | 240 | Latency[0][0..3]                             | */
/* | 340 | Rsvz3[0]                                     | */
/* | 440 | Parameter[0][0]                              | */
/* | 448 | Parameter[0][1]                              | */
/* | ...                                                | */
/* | 840 | Rsvd4[0]                                     | */
/* ------------------------------------------------------ */
struct hv_monitor_page {
	union hv_monitor_trigger_state trigger_state;
	u32 rsvdz1;

	union hv_monitor_trigger_group trigger_group[4];
	u64 rsvdz2[3];

	s32 next_checktime[4][32];

	u16 latency[4][32];
	u64 rsvdz3[32];

	struct hv_monitor_parameter parameter[4][32];

	u8 rsvdz4[1984];
};

#define HV_HYPERCALL_PARAM_ALIGN	sizeof(u64)

/* Definition of the hv_post_message hypercall input structure. */
struct hv_input_post_message {
	union hv_connection_id connectionid;
	u32 reserved;
	u32 message_type;
	u32 payload_size;
	u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
};


enum {
	VMBUS_MESSAGE_CONNECTION_ID	= 1,
	VMBUS_MESSAGE_CONNECTION_ID_4	= 4,
	VMBUS_MESSAGE_PORT_ID		= 1,
	VMBUS_EVENT_CONNECTION_ID	= 2,
	VMBUS_EVENT_PORT_ID		= 2,
	VMBUS_MONITOR_CONNECTION_ID	= 3,
	VMBUS_MONITOR_PORT_ID		= 3,
	VMBUS_MESSAGE_SINT		= 2,
};

/*
 * Per cpu state for channel handling
 */
struct hv_per_cpu_context {
	void *synic_message_page;
	void *synic_event_page;
	/*
	 * buffer to post messages to the host.
	 */
	void *post_msg_page;

	/*
	 * Starting with win8, we can take channel interrupts on any CPU;
	 * we will manage the tasklet that handles events messages on a per CPU
	 * basis.
	 */
	struct tasklet_struct msg_dpc;
};

struct hv_context {
	/* We only support running on top of Hyper-V
	 * So at this point this really can only contain the Hyper-V ID
	 */
	u64 guestid;

	struct hv_per_cpu_context __percpu *cpu_context;

	/*
	 * To manage allocations in a NUMA node.
	 * Array indexed by numa node ID.
	 */
	struct cpumask *hv_numa_map;
};

extern struct hv_context hv_context;

/* Hv Interface */

extern int hv_init(void);

extern int hv_post_message(union hv_connection_id connection_id,
			 enum hv_message_type message_type,
			 void *payload, size_t payload_size);

extern int hv_synic_alloc(void);

extern void hv_synic_free(void);

extern void hv_synic_enable_regs(unsigned int cpu);
extern int hv_synic_init(unsigned int cpu);

extern void hv_synic_disable_regs(unsigned int cpu);
extern int hv_synic_cleanup(unsigned int cpu);

/* Interface */

void hv_ringbuffer_pre_init(struct vmbus_channel *channel);

int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
		       struct page *pages, u32 pagecnt, u32 max_pkt_size);

void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);

int hv_ringbuffer_write(struct vmbus_channel *channel,
			const struct kvec *kv_list, u32 kv_count,
			u64 requestid, u64 *trans_id);

int hv_ringbuffer_read(struct vmbus_channel *channel,
		       void *buffer, u32 buflen, u32 *buffer_actual_len,
		       u64 *requestid, bool raw);

/*
 * The Maximum number of channels (16384) is determined by the size of the
 * interrupt page, which is HV_HYP_PAGE_SIZE. 1/2 of HV_HYP_PAGE_SIZE is to
 * send endpoint interrupts, and the other is to receive endpoint interrupts.
 */
#define MAX_NUM_CHANNELS	((HV_HYP_PAGE_SIZE >> 1) << 3)

/* The value here must be in multiple of 32 */
#define MAX_NUM_CHANNELS_SUPPORTED	256

#define MAX_CHANNEL_RELIDS					\
	max(MAX_NUM_CHANNELS_SUPPORTED, HV_EVENT_FLAGS_COUNT)

enum vmbus_connect_state {
	DISCONNECTED,
	CONNECTING,
	CONNECTED,
	DISCONNECTING
};

#define MAX_SIZE_CHANNEL_MESSAGE	HV_MESSAGE_PAYLOAD_BYTE_COUNT

/*
 * The CPU that Hyper-V will interrupt for VMBUS messages, such as
 * CHANNELMSG_OFFERCHANNEL and CHANNELMSG_RESCIND_CHANNELOFFER.
 */
#define VMBUS_CONNECT_CPU	0

struct vmbus_connection {
	u32 msg_conn_id;

	atomic_t offer_in_progress;

	enum vmbus_connect_state conn_state;

	atomic_t next_gpadl_handle;

	struct completion  unload_event;
	/*
	 * Represents channel interrupts. Each bit position represents a
	 * channel.  When a channel sends an interrupt via VMBUS, it finds its
	 * bit in the sendInterruptPage, set it and calls Hv to generate a port
	 * event. The other end receives the port event and parse the
	 * recvInterruptPage to see which bit is set
	 */
	void *int_page;
	void *send_int_page;
	void *recv_int_page;

	/*
	 * 2 pages - 1st page for parent->child notification and 2nd
	 * is child->parent notification
	 */
	struct hv_monitor_page *monitor_pages[2];
	void *monitor_pages_original[2];
	phys_addr_t monitor_pages_pa[2];
	struct list_head chn_msg_list;
	spinlock_t channelmsg_lock;

	/* List of channels */
	struct list_head chn_list;
	struct mutex channel_mutex;

	/* Array of channels */
	struct vmbus_channel **channels;

	/*
	 * An offer message is handled first on the work_queue, and then
	 * is further handled on handle_primary_chan_wq or
	 * handle_sub_chan_wq.
	 */
	struct workqueue_struct *work_queue;
	struct workqueue_struct *handle_primary_chan_wq;
	struct workqueue_struct *handle_sub_chan_wq;
	struct workqueue_struct *rescind_work_queue;

	/*
	 * On suspension of the vmbus, the accumulated offer messages
	 * must be dropped.
	 */
	bool ignore_any_offer_msg;

	/*
	 * The number of sub-channels and hv_sock channels that should be
	 * cleaned up upon suspend: sub-channels will be re-created upon
	 * resume, and hv_sock channels should not survive suspend.
	 */
	atomic_t nr_chan_close_on_suspend;
	/*
	 * vmbus_bus_suspend() waits for "nr_chan_close_on_suspend" to
	 * drop to zero.
	 */
	struct completion ready_for_suspend_event;

	/*
	 * The number of primary channels that should be "fixed up"
	 * upon resume: these channels are re-offered upon resume, and some
	 * fields of the channel offers (i.e. child_relid and connection_id)
	 * can change, so the old offermsg must be fixed up, before the resume
	 * callbacks of the VSC drivers start to further touch the channels.
	 */
	atomic_t nr_chan_fixup_on_resume;
	/*
	 * vmbus_bus_resume() waits for "nr_chan_fixup_on_resume" to
	 * drop to zero.
	 */
	struct completion ready_for_resume_event;
};


struct vmbus_msginfo {
	/* Bookkeeping stuff */
	struct list_head msglist_entry;

	/* The message itself */
	unsigned char msg[];
};


extern struct vmbus_connection vmbus_connection;

int vmbus_negotiate_version(struct vmbus_channel_msginfo *msginfo, u32 version);

static inline void vmbus_send_interrupt(u32 relid)
{
	sync_set_bit(relid, vmbus_connection.send_int_page);
}

enum vmbus_message_handler_type {
	/* The related handler can sleep. */
	VMHT_BLOCKING = 0,

	/* The related handler must NOT sleep. */
	VMHT_NON_BLOCKING = 1,
};

struct vmbus_channel_message_table_entry {
	enum vmbus_channel_message_type message_type;
	enum vmbus_message_handler_type handler_type;
	void (*message_handler)(struct vmbus_channel_message_header *msg);
	u32 min_payload_len;
};

extern const struct vmbus_channel_message_table_entry
	channel_message_table[CHANNELMSG_COUNT];


/* General vmbus interface */

struct hv_device *vmbus_device_create(const guid_t *type,
				      const guid_t *instance,
				      struct vmbus_channel *channel);

int vmbus_device_register(struct hv_device *child_device_obj);
void vmbus_device_unregister(struct hv_device *device_obj);
int vmbus_add_channel_kobj(struct hv_device *device_obj,
			   struct vmbus_channel *channel);

void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);

void vmbus_channel_map_relid(struct vmbus_channel *channel);
void vmbus_channel_unmap_relid(struct vmbus_channel *channel);

struct vmbus_channel *relid2channel(u32 relid);

void vmbus_free_channels(void);

/* Connection interface */

int vmbus_connect(void);
void vmbus_disconnect(void);

int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);

void vmbus_on_event(unsigned long data);
void vmbus_on_msg_dpc(unsigned long data);

int hv_kvp_init(struct hv_util_service *srv);
void hv_kvp_deinit(void);
int hv_kvp_pre_suspend(void);
int hv_kvp_pre_resume(void);
void hv_kvp_onchannelcallback(void *context);

int hv_vss_init(struct hv_util_service *srv);
void hv_vss_deinit(void);
int hv_vss_pre_suspend(void);
int hv_vss_pre_resume(void);
void hv_vss_onchannelcallback(void *context);

int hv_fcopy_init(struct hv_util_service *srv);
void hv_fcopy_deinit(void);
int hv_fcopy_pre_suspend(void);
int hv_fcopy_pre_resume(void);
void hv_fcopy_onchannelcallback(void *context);
void vmbus_initiate_unload(bool crash);

static inline void hv_poll_channel(struct vmbus_channel *channel,
				   void (*cb)(void *))
{
	if (!channel)
		return;
	cb(channel);
}

enum hvutil_device_state {
	HVUTIL_DEVICE_INIT = 0,  /* driver is loaded, waiting for userspace */
	HVUTIL_READY,            /* userspace is registered */
	HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
	HVUTIL_USERSPACE_REQ,    /* request to userspace was sent */
	HVUTIL_USERSPACE_RECV,   /* reply from userspace was received */
	HVUTIL_DEVICE_DYING,     /* driver unload is in progress */
};

enum delay {
	INTERRUPT_DELAY = 0,
	MESSAGE_DELAY   = 1,
};

extern const struct vmbus_device vmbus_devs[];

static inline bool hv_is_perf_channel(struct vmbus_channel *channel)
{
	return vmbus_devs[channel->device_id].perf_device;
}

static inline bool hv_is_allocated_cpu(unsigned int cpu)
{
	struct vmbus_channel *channel, *sc;

	lockdep_assert_held(&vmbus_connection.channel_mutex);
	/*
	 * List additions/deletions as well as updates of the target CPUs are
	 * protected by channel_mutex.
	 */
	list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
		if (!hv_is_perf_channel(channel))
			continue;
		if (channel->target_cpu == cpu)
			return true;
		list_for_each_entry(sc, &channel->sc_list, sc_list) {
			if (sc->target_cpu == cpu)
				return true;
		}
	}
	return false;
}

static inline void hv_set_allocated_cpu(unsigned int cpu)
{
	cpumask_set_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
}

static inline void hv_clear_allocated_cpu(unsigned int cpu)
{
	if (hv_is_allocated_cpu(cpu))
		return;
	cpumask_clear_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
}

static inline void hv_update_allocated_cpus(unsigned int old_cpu,
					  unsigned int new_cpu)
{
	hv_set_allocated_cpu(new_cpu);
	hv_clear_allocated_cpu(old_cpu);
}

#ifdef CONFIG_HYPERV_TESTING

int hv_debug_add_dev_dir(struct hv_device *dev);
void hv_debug_rm_dev_dir(struct hv_device *dev);
void hv_debug_rm_all_dir(void);
int hv_debug_init(void);
void hv_debug_delay_test(struct vmbus_channel *channel, enum delay delay_type);

#else /* CONFIG_HYPERV_TESTING */

static inline void hv_debug_rm_dev_dir(struct hv_device *dev) {};
static inline void hv_debug_rm_all_dir(void) {};
static inline void hv_debug_delay_test(struct vmbus_channel *channel,
				       enum delay delay_type) {};
static inline int hv_debug_init(void)
{
	return -1;
}

static inline int hv_debug_add_dev_dir(struct hv_device *dev)
{
	return -1;
}

#endif /* CONFIG_HYPERV_TESTING */

#endif /* _HYPERV_VMBUS_H */
Commit	Line	Data
3b20eb23	1	/* SPDX-License-Identifier: GPL-2.0-only */
0f2a6619 S	2	/*
	3	*
	4	* Copyright (c) 2011, Microsoft Corporation.
	5	*
0f2a6619 S	6	* Authors:
	7	* Haiyang Zhang <haiyangz@microsoft.com>
	8	* Hank Janssen <hjanssen@microsoft.com>
	9	* K. Y. Srinivasan <kys@microsoft.com>
0f2a6619 S	10	*/
	11
	12	#ifndef _HYPERV_VMBUS_H
	13	#define _HYPERV_VMBUS_H
	14
43c698b9	15	#include <linux/list.h>
8017c996	16	#include <linux/bitops.h>
43c698b9	17	#include <asm/sync_bitops.h>
5a485803	18	#include <asm/hyperv-tlfs.h>
43c698b9	19	#include <linux/atomic.h>
46a97191	20	#include <linux/hyperv.h>
37cdd991	21	#include <linux/interrupt.h>
43c698b9	22
c9fe0f8f VK	23	#include "hv_trace.h"
c9fe0f8f VK	24
c0b200cf S	25	/*
	26	* Timeout for services such as KVP and fcopy.
	27	*/
	28	#define HV_UTIL_TIMEOUT 30
	29
4dbfc2e6 VK	30	/*
	31	* Timeout for guest-host handshake for services.
	32	*/
d7edd31b	33	#define HV_UTIL_NEGO_TIMEOUT 55
4dbfc2e6	34
afbdc4a9 S	35
	36	/* Definitions for the monitored notification facility */
	37	union hv_monitor_trigger_group {
	38	u64 as_uint64;
	39	struct {
	40	u32 pending;
	41	u32 armed;
	42	};
	43	};
	44
	45	struct hv_monitor_parameter {
	46	union hv_connection_id connectionid;
	47	u16 flagnumber;
	48	u16 rsvdz;
	49	};
	50
	51	union 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	/* ------------------------------------------------------ */
	79	struct 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
8e27a236 S	96	#define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
8e27a236 S	97
afbdc4a9 S	98	/* Definition of the hv_post_message hypercall input structure. */
	99	struct hv_input_post_message {
	100	union hv_connection_id connectionid;
	101	u32 reserved;
7797dcf6	102	u32 message_type;
afbdc4a9 S	103	u32 payload_size;
	104	u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
	105	};
	106
afbdc4a9	107
3645a917 S	108	enum {
3645a917 S	109	VMBUS_MESSAGE_CONNECTION_ID = 1,
ae20b254	110	VMBUS_MESSAGE_CONNECTION_ID_4 = 4,
3645a917 S	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
37cdd991 SH	119	/*
	120	* Per cpu state for channel handling
	121	*/
	122	struct 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	*/
37cdd991	135	struct tasklet_struct msg_dpc;
37cdd991 SH	136	};
37cdd991 SH	137
3645a917 S	138	struct hv_context {
3645a917 S	139	/* We only support running on top of Hyper-V
2a9d7de2 SH	140	* So at this point this really can only contain the Hyper-V ID
2a9d7de2 SH	141	*/
3645a917 S	142	u64 guestid;
3645a917 S	143
37cdd991 SH	144	struct hv_per_cpu_context __percpu *cpu_context;
37cdd991 SH	145
9f01ec53 S	146	/*
	147	* To manage allocations in a NUMA node.
	148	* Array indexed by numa node ID.
	149	*/
	150	struct cpumask *hv_numa_map;
3645a917 S	151	};
	152
	153	extern struct hv_context hv_context;
	154
3645a917 S	155	/* Hv Interface */
	156
	157	extern int hv_init(void);
	158
415f0a02	159	extern int hv_post_message(union hv_connection_id connection_id,
3645a917 S	160	enum hv_message_type message_type,
	161	void *payload, size_t payload_size);
	162
2608fb65 JW	163	extern int hv_synic_alloc(void);
	164
	165	extern void hv_synic_free(void);
	166
dba61cda	167	extern void hv_synic_enable_regs(unsigned int cpu);
76d36ab7	168	extern int hv_synic_init(unsigned int cpu);
3645a917	169
dba61cda	170	extern void hv_synic_disable_regs(unsigned int cpu);
76d36ab7	171	extern int hv_synic_cleanup(unsigned int cpu);
3645a917	172
940655c1 S	173	/* Interface */
940655c1 S	174
14948e39	175	void hv_ringbuffer_pre_init(struct vmbus_channel *channel);
940655c1	176
9988ce68	177	int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
adae1e93	178	struct page *pages, u32 pagecnt, u32 max_pkt_size);
940655c1 S	179
	180	void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
	181
1f6ee4e7	182	int hv_ringbuffer_write(struct vmbus_channel *channel,
e8b7db38	183	const struct kvec *kv_list, u32 kv_count,
b03afa57	184	u64 requestid, u64 *trans_id);
940655c1	185
3372592a	186	int hv_ringbuffer_read(struct vmbus_channel *channel,
940b68e2	187	void buffer, u32 buflen, u32 buffer_actual_len,
3372592a	188	u64 *requestid, bool raw);
940655c1	189
89b2ca47	190	/*
5c641fee	191	* The Maximum number of channels (16384) is determined by the size of the
83527ef7 MN	192	* interrupt page, which is HV_HYP_PAGE_SIZE. 1/2 of HV_HYP_PAGE_SIZE is to
83527ef7 MN	193	* send endpoint interrupts, and the other is to receive endpoint interrupts.
89b2ca47	194	*/
83527ef7	195	#define MAX_NUM_CHANNELS ((HV_HYP_PAGE_SIZE >> 1) << 3)
89b2ca47 S	196
89b2ca47 S	197	/* The value here must be in multiple of 32 */
89b2ca47 S	198	#define MAX_NUM_CHANNELS_SUPPORTED 256
89b2ca47 S	199
8b6a877c APM	200	#define MAX_CHANNEL_RELIDS \
8b6a877c APM	201	max(MAX_NUM_CHANNELS_SUPPORTED, HV_EVENT_FLAGS_COUNT)
89b2ca47 S	202
	203	enum 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
8a857c55 APM	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
54a66265	217
8a857c55	218	struct vmbus_connection {
ae20b254 DC	219	u32 msg_conn_id;
ae20b254 DC	220
54a66265 S	221	atomic_t offer_in_progress;
54a66265 S	222
89b2ca47 S	223	enum vmbus_connect_state conn_state;
	224
	225	atomic_t next_gpadl_handle;
	226
2db84eff	227	struct completion unload_event;
89b2ca47 S	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	*/
8681db44	243	struct hv_monitor_page *monitor_pages[2];
f2f136c0 TL	244	void *monitor_pages_original[2];
f2f136c0 TL	245	phys_addr_t monitor_pages_pa[2];
89b2ca47 S	246	struct list_head chn_msg_list;
	247	spinlock_t channelmsg_lock;
	248
	249	/* List of channels */
	250	struct list_head chn_list;
d6f591e3	251	struct mutex channel_mutex;
89b2ca47	252
8b6a877c APM	253	/* Array of channels */
	254	struct vmbus_channel **channels;
	255
37c2578c DC	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	*/
89b2ca47	261	struct workqueue_struct *work_queue;
37c2578c DC	262	struct workqueue_struct *handle_primary_chan_wq;
37c2578c DC	263	struct workqueue_struct *handle_sub_chan_wq;
52be9355 SG	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;
b307b389 DC	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;
d8bd2d44 DC	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;
89b2ca47 S	297	};
	298
	299
	300	struct vmbus_msginfo {
	301	/* Bookkeeping stuff */
	302	struct list_head msglist_entry;
	303
	304	/* The message itself */
032d4a48	305	unsigned char msg[];
89b2ca47 S	306	};
	307
	308
	309	extern struct vmbus_connection vmbus_connection;
	310
f53335e3 DC	311	int vmbus_negotiate_version(struct vmbus_channel_msginfo *msginfo, u32 version);
f53335e3 DC	312
5c1bec61 SH	313	static inline void vmbus_send_interrupt(u32 relid)
	314	{
	315	sync_set_bit(relid, vmbus_connection.send_int_page);
	316	}
	317
652594c7 DC	318	enum 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
	326	struct 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);
52c7803f	330	u32 min_payload_len;
652594c7 DC	331	};
652594c7 DC	332
e6242fa0	333	extern const struct vmbus_channel_message_table_entry
652594c7 DC	334	channel_message_table[CHANNELMSG_COUNT];
652594c7 DC	335
0f70b669	336
89b2ca47 S	337	/* General vmbus interface */
89b2ca47 S	338
593db803 AS	339	struct hv_device vmbus_device_create(const guid_t type,
593db803 AS	340	const guid_t *instance,
1b9d48f2	341	struct vmbus_channel *channel);
89b2ca47	342
22794281	343	int vmbus_device_register(struct hv_device *child_device_obj);
696453ba	344	void vmbus_device_unregister(struct hv_device *device_obj);
c2e5df61 SH	345	int vmbus_add_channel_kobj(struct hv_device *device_obj,
c2e5df61 SH	346	struct vmbus_channel *channel);
89b2ca47	347
46fc1548 KB	348	void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
46fc1548 KB	349
8b6a877c APM	350	void vmbus_channel_map_relid(struct vmbus_channel *channel);
	351	void vmbus_channel_unmap_relid(struct vmbus_channel *channel);
	352
d43e2fe7	353	struct vmbus_channel *relid2channel(u32 relid);
89b2ca47	354
93e5bd06	355	void vmbus_free_channels(void);
89b2ca47 S	356
	357	/* Connection interface */
	358
	359	int vmbus_connect(void);
09a19628	360	void vmbus_disconnect(void);
89b2ca47	361
c0bb0392	362	int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
89b2ca47	363
89b2ca47	364	void vmbus_on_event(unsigned long data);
d81274aa	365	void vmbus_on_msg_dpc(unsigned long data);
89b2ca47	366
2a9d7de2	367	int hv_kvp_init(struct hv_util_service *srv);
3647a83d	368	void hv_kvp_deinit(void);
54e19d34 DC	369	int hv_kvp_pre_suspend(void);
54e19d34 DC	370	int hv_kvp_pre_resume(void);
2a9d7de2	371	void hv_kvp_onchannelcallback(void *context);
3647a83d	372
2a9d7de2	373	int hv_vss_init(struct hv_util_service *srv);
3647a83d	374	void hv_vss_deinit(void);
54e19d34 DC	375	int hv_vss_pre_suspend(void);
54e19d34 DC	376	int hv_vss_pre_resume(void);
2a9d7de2	377	void hv_vss_onchannelcallback(void *context);
3647a83d	378
2a9d7de2	379	int hv_fcopy_init(struct hv_util_service *srv);
01325476	380	void hv_fcopy_deinit(void);
54e19d34 DC	381	int hv_fcopy_pre_suspend(void);
54e19d34 DC	382	int hv_fcopy_pre_resume(void);
2a9d7de2	383	void hv_fcopy_onchannelcallback(void *context);
75ff3a8a	384	void vmbus_initiate_unload(bool crash);
01325476	385
8efe78fd VK	386	static inline void hv_poll_channel(struct vmbus_channel *channel,
	387	void (cb)(void ))
	388	{
	389	if (!channel)
	390	return;
238d2ed8	391	cb(channel);
8efe78fd	392	}
89b2ca47	393
636c88da VK	394	enum 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
af9ca6f9 BB	403	enum delay {
	404	INTERRUPT_DELAY = 0,
	405	MESSAGE_DELAY = 1,
	406	};
	407
afaa33da APM	408	extern const struct vmbus_device vmbus_devs[];
	409
	410	static inline bool hv_is_perf_channel(struct vmbus_channel *channel)
	411	{
	412	return vmbus_devs[channel->device_id].perf_device;
	413	}
	414
de96e8a0	415	static inline bool hv_is_allocated_cpu(unsigned int cpu)
afaa33da APM	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
de96e8a0	437	static inline void hv_set_allocated_cpu(unsigned int cpu)
afaa33da APM	438	{
	439	cpumask_set_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
	440	}
	441
de96e8a0	442	static inline void hv_clear_allocated_cpu(unsigned int cpu)
afaa33da	443	{
de96e8a0	444	if (hv_is_allocated_cpu(cpu))
afaa33da APM	445	return;
	446	cpumask_clear_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
	447	}
	448
de96e8a0	449	static inline void hv_update_allocated_cpus(unsigned int old_cpu,
afaa33da APM	450	unsigned int new_cpu)
afaa33da APM	451	{
de96e8a0 VK	452	hv_set_allocated_cpu(new_cpu);
de96e8a0 VK	453	hv_clear_allocated_cpu(old_cpu);
afaa33da APM	454	}
afaa33da APM	455
af9ca6f9 BB	456	#ifdef CONFIG_HYPERV_TESTING
	457
	458	int hv_debug_add_dev_dir(struct hv_device *dev);
	459	void hv_debug_rm_dev_dir(struct hv_device *dev);
	460	void hv_debug_rm_all_dir(void);
	461	int hv_debug_init(void);
	462	void hv_debug_delay_test(struct vmbus_channel *channel, enum delay delay_type);
	463
	464	#else /* CONFIG_HYPERV_TESTING */
	465
	466	static inline void hv_debug_rm_dev_dir(struct hv_device *dev) {};
	467	static inline void hv_debug_rm_all_dir(void) {};
	468	static inline void hv_debug_delay_test(struct vmbus_channel *channel,
	469	enum delay delay_type) {};
	470	static inline int hv_debug_init(void)
	471	{
	472	return -1;
	473	}
	474
	475	static inline int hv_debug_add_dev_dir(struct hv_device *dev)
	476	{
	477	return -1;
	478	}
	479
	480	#endif /* CONFIG_HYPERV_TESTING */
	481
0f2a6619	482	#endif /* _HYPERV_VMBUS_H */