3 * Copyright (c) 2009, Microsoft Corporation.
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.
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
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.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
25 #ifndef _CHANNEL_MGMT_H_
26 #define _CHANNEL_MGMT_H_
29 #include "RingBuffer.h"
31 #include "include/VmbusChannelInterface.h"
32 #include "include/VmbusPacketFormat.h"
34 /* Version 1 messages */
35 enum vmbus_channel_message_type
{
36 ChannelMessageInvalid
= 0,
37 ChannelMessageOfferChannel
= 1,
38 ChannelMessageRescindChannelOffer
= 2,
39 ChannelMessageRequestOffers
= 3,
40 ChannelMessageAllOffersDelivered
= 4,
41 ChannelMessageOpenChannel
= 5,
42 ChannelMessageOpenChannelResult
= 6,
43 ChannelMessageCloseChannel
= 7,
44 ChannelMessageGpadlHeader
= 8,
45 ChannelMessageGpadlBody
= 9,
46 ChannelMessageGpadlCreated
= 10,
47 ChannelMessageGpadlTeardown
= 11,
48 ChannelMessageGpadlTorndown
= 12,
49 ChannelMessageRelIdReleased
= 13,
50 ChannelMessageInitiateContact
= 14,
51 ChannelMessageVersionResponse
= 15,
52 ChannelMessageUnload
= 16,
53 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
54 ChannelMessageViewRangeAdd
= 17,
55 ChannelMessageViewRangeRemove
= 18,
58 } __attribute__((packed
));
60 struct vmbus_channel_message_header
{
61 enum vmbus_channel_message_type MessageType
;
63 } __attribute__((packed
));
65 /* Query VMBus Version parameters */
66 struct vmbus_channel_query_vmbus_version
{
67 struct vmbus_channel_message_header Header
;
69 } __attribute__((packed
));
71 /* VMBus Version Supported parameters */
72 struct vmbus_channel_version_supported
{
73 struct vmbus_channel_message_header Header
;
74 bool VersionSupported
;
75 } __attribute__((packed
));
77 /* Offer Channel parameters */
78 struct vmbus_channel_offer_channel
{
79 struct vmbus_channel_message_header Header
;
80 struct vmbus_channel_offer Offer
;
83 bool MonitorAllocated
;
84 } __attribute__((packed
));
86 /* Rescind Offer parameters */
87 struct vmbus_channel_rescind_offer
{
88 struct vmbus_channel_message_header Header
;
90 } __attribute__((packed
));
93 * Request Offer -- no parameters, SynIC message contains the partition ID
94 * Set Snoop -- no parameters, SynIC message contains the partition ID
95 * Clear Snoop -- no parameters, SynIC message contains the partition ID
96 * All Offers Delivered -- no parameters, SynIC message contains the partition
98 * Flush Client -- no parameters, SynIC message contains the partition ID
101 /* Open Channel parameters */
102 struct vmbus_channel_open_channel
{
103 struct vmbus_channel_message_header Header
;
105 /* Identifies the specific VMBus channel that is being opened. */
108 /* ID making a particular open request at a channel offer unique. */
111 /* GPADL for the channel's ring buffer. */
112 u32 RingBufferGpadlHandle
;
114 /* GPADL for the channel's server context save area. */
115 u32 ServerContextAreaGpadlHandle
;
118 * The upstream ring buffer begins at offset zero in the memory
119 * described by RingBufferGpadlHandle. The downstream ring buffer
120 * follows it at this offset (in pages).
122 u32 DownstreamRingBufferPageOffset
;
124 /* User-specific data to be passed along to the server endpoint. */
125 unsigned char UserData
[MAX_USER_DEFINED_BYTES
];
126 } __attribute__((packed
));
128 /* Open Channel Result parameters */
129 struct vmbus_channel_open_result
{
130 struct vmbus_channel_message_header Header
;
134 } __attribute__((packed
));
136 /* Close channel parameters; */
137 struct vmbus_channel_close_channel
{
138 struct vmbus_channel_message_header Header
;
140 } __attribute__((packed
));
142 /* Channel Message GPADL */
143 #define GPADL_TYPE_RING_BUFFER 1
144 #define GPADL_TYPE_SERVER_SAVE_AREA 2
145 #define GPADL_TYPE_TRANSACTION 8
148 * The number of PFNs in a GPADL message is defined by the number of
149 * pages that would be spanned by ByteCount and ByteOffset. If the
150 * implied number of PFNs won't fit in this packet, there will be a
151 * follow-up packet that contains more.
153 struct vmbus_channel_gpadl_header
{
154 struct vmbus_channel_message_header Header
;
159 struct gpa_range Range
[0];
160 } __attribute__((packed
));
162 /* This is the followup packet that contains more PFNs. */
163 struct vmbus_channel_gpadl_body
{
164 struct vmbus_channel_message_header Header
;
168 } __attribute__((packed
));
170 struct vmbus_channel_gpadl_created
{
171 struct vmbus_channel_message_header Header
;
175 } __attribute__((packed
));
177 struct vmbus_channel_gpadl_teardown
{
178 struct vmbus_channel_message_header Header
;
181 } __attribute__((packed
));
183 struct vmbus_channel_gpadl_torndown
{
184 struct vmbus_channel_message_header Header
;
186 } __attribute__((packed
));
188 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
189 struct vmbus_channel_view_range_add
{
190 struct vmbus_channel_message_header Header
;
191 PHYSICAL_ADDRESS ViewRangeBase
;
194 } __attribute__((packed
));
196 struct vmbus_channel_view_range_remove
{
197 struct vmbus_channel_message_header Header
;
198 PHYSICAL_ADDRESS ViewRangeBase
;
200 } __attribute__((packed
));
203 struct vmbus_channel_relid_released
{
204 struct vmbus_channel_message_header Header
;
206 } __attribute__((packed
));
208 struct vmbus_channel_initiate_contact
{
209 struct vmbus_channel_message_header Header
;
210 u32 VMBusVersionRequested
;
215 } __attribute__((packed
));
217 struct vmbus_channel_version_response
{
218 struct vmbus_channel_message_header Header
;
219 bool VersionSupported
;
220 } __attribute__((packed
));
222 typedef void (*PFN_CHANNEL_CALLBACK
)(void *context
);
224 enum vmbus_channel_state
{
226 CHANNEL_OPENING_STATE
,
230 struct vmbus_channel
{
231 LIST_ENTRY ListEntry
;
233 struct hv_device
*DeviceObject
;
235 struct timer_list poll_timer
; /* SA-111 workaround */
237 enum vmbus_channel_state State
;
239 struct vmbus_channel_offer_channel OfferMsg
;
241 * These are based on the OfferMsg.MonitorId.
242 * Save it here for easy access.
247 u32 RingBufferGpadlHandle
;
249 /* Allocated memory for ring buffer */
250 void *RingBufferPages
;
251 u32 RingBufferPageCount
;
252 RING_BUFFER_INFO Outbound
; /* send to parent */
253 RING_BUFFER_INFO Inbound
; /* receive from parent */
254 spinlock_t inbound_lock
;
255 struct workqueue_struct
*ControlWQ
;
257 /* Channel callback are invoked in this workqueue context */
258 /* HANDLE dataWorkQueue; */
260 PFN_CHANNEL_CALLBACK OnChannelCallback
;
261 void *ChannelCallbackContext
;
264 struct vmbus_channel_debug_info
{
266 enum vmbus_channel_state State
;
267 struct hv_guid InterfaceType
;
268 struct hv_guid InterfaceInstance
;
270 u32 ServerMonitorPending
;
271 u32 ServerMonitorLatency
;
272 u32 ServerMonitorConnectionId
;
273 u32 ClientMonitorPending
;
274 u32 ClientMonitorLatency
;
275 u32 ClientMonitorConnectionId
;
277 RING_BUFFER_DEBUG_INFO Inbound
;
278 RING_BUFFER_DEBUG_INFO Outbound
;
282 * Represents each channel msg on the vmbus connection This is a
283 * variable-size data structure depending on the msg type itself
285 struct vmbus_channel_msginfo
{
286 /* Bookkeeping stuff */
287 LIST_ENTRY MsgListEntry
;
289 /* So far, this is only used to handle gpadl body message */
290 LIST_ENTRY SubMsgList
;
292 /* Synchronize the request/response if needed */
293 struct osd_waitevent
*WaitEvent
;
296 struct vmbus_channel_version_supported VersionSupported
;
297 struct vmbus_channel_open_result OpenResult
;
298 struct vmbus_channel_gpadl_torndown GpadlTorndown
;
299 struct vmbus_channel_gpadl_created GpadlCreated
;
300 struct vmbus_channel_version_response VersionResponse
;
305 * The channel message that goes out on the "wire".
306 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
308 unsigned char Msg
[0];
312 struct vmbus_channel
*AllocVmbusChannel(void);
314 void FreeVmbusChannel(struct vmbus_channel
*Channel
);
316 void VmbusOnChannelMessage(void *Context
);
318 int VmbusChannelRequestOffers(void);
320 void VmbusChannelReleaseUnattachedChannels(void);
322 #endif /* _CHANNEL_MGMT_H_ */