Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Copyright (c) 2009, 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 | * |
| 22 | */ |
| 23 | |
| 24 | |
| 25 | #ifndef _CHANNEL_MGMT_H_ |
| 26 | #define _CHANNEL_MGMT_H_ |
| 27 | |
Bill Pemberton | 53af545 | 2009-09-11 21:46:44 -0400 | [diff] [blame] | 28 | #include <linux/list.h> |
Milan Dadok | 9fcfeab | 2009-10-28 23:23:50 +0100 | [diff] [blame] | 29 | #include <linux/timer.h> |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 30 | #include "RingBuffer.h" |
Greg Kroah-Hartman | 0197e34 | 2009-08-28 16:24:34 -0700 | [diff] [blame] | 31 | #include "VmbusChannelInterface.h" |
Greg Kroah-Hartman | 216260d | 2009-08-28 16:24:48 -0700 | [diff] [blame] | 32 | #include "VmbusPacketFormat.h" |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 33 | |
Greg Kroah-Hartman | 2def7b8 | 2009-08-28 16:22:33 -0700 | [diff] [blame] | 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, |
| 56 | #endif |
| 57 | ChannelMessageCount |
Hank Janssen | 78f98ba | 2009-10-16 20:11:36 +0000 | [diff] [blame] | 58 | }; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 59 | |
Greg Kroah-Hartman | 2def7b8 | 2009-08-28 16:22:33 -0700 | [diff] [blame] | 60 | struct vmbus_channel_message_header { |
| 61 | enum vmbus_channel_message_type MessageType; |
| 62 | u32 Padding; |
| 63 | } __attribute__((packed)); |
| 64 | |
| 65 | /* Query VMBus Version parameters */ |
| 66 | struct vmbus_channel_query_vmbus_version { |
| 67 | struct vmbus_channel_message_header Header; |
| 68 | u32 Version; |
| 69 | } __attribute__((packed)); |
| 70 | |
| 71 | /* VMBus Version Supported parameters */ |
| 72 | struct vmbus_channel_version_supported { |
| 73 | struct vmbus_channel_message_header Header; |
| 74 | bool VersionSupported; |
| 75 | } __attribute__((packed)); |
| 76 | |
| 77 | /* Offer Channel parameters */ |
| 78 | struct vmbus_channel_offer_channel { |
| 79 | struct vmbus_channel_message_header Header; |
| 80 | struct vmbus_channel_offer Offer; |
| 81 | u32 ChildRelId; |
| 82 | u8 MonitorId; |
| 83 | bool MonitorAllocated; |
| 84 | } __attribute__((packed)); |
| 85 | |
| 86 | /* Rescind Offer parameters */ |
| 87 | struct vmbus_channel_rescind_offer { |
| 88 | struct vmbus_channel_message_header Header; |
| 89 | u32 ChildRelId; |
| 90 | } __attribute__((packed)); |
| 91 | |
| 92 | /* |
| 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 |
| 97 | * ID |
| 98 | * Flush Client -- no parameters, SynIC message contains the partition ID |
| 99 | */ |
| 100 | |
| 101 | /* Open Channel parameters */ |
| 102 | struct vmbus_channel_open_channel { |
| 103 | struct vmbus_channel_message_header Header; |
| 104 | |
| 105 | /* Identifies the specific VMBus channel that is being opened. */ |
| 106 | u32 ChildRelId; |
| 107 | |
| 108 | /* ID making a particular open request at a channel offer unique. */ |
| 109 | u32 OpenId; |
| 110 | |
| 111 | /* GPADL for the channel's ring buffer. */ |
| 112 | u32 RingBufferGpadlHandle; |
| 113 | |
| 114 | /* GPADL for the channel's server context save area. */ |
| 115 | u32 ServerContextAreaGpadlHandle; |
| 116 | |
| 117 | /* |
| 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). |
| 121 | */ |
| 122 | u32 DownstreamRingBufferPageOffset; |
| 123 | |
| 124 | /* User-specific data to be passed along to the server endpoint. */ |
| 125 | unsigned char UserData[MAX_USER_DEFINED_BYTES]; |
| 126 | } __attribute__((packed)); |
| 127 | |
| 128 | /* Open Channel Result parameters */ |
| 129 | struct vmbus_channel_open_result { |
| 130 | struct vmbus_channel_message_header Header; |
| 131 | u32 ChildRelId; |
| 132 | u32 OpenId; |
| 133 | u32 Status; |
| 134 | } __attribute__((packed)); |
| 135 | |
| 136 | /* Close channel parameters; */ |
| 137 | struct vmbus_channel_close_channel { |
| 138 | struct vmbus_channel_message_header Header; |
| 139 | u32 ChildRelId; |
| 140 | } __attribute__((packed)); |
| 141 | |
| 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 |
| 146 | |
| 147 | /* |
| 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. |
| 152 | */ |
| 153 | struct vmbus_channel_gpadl_header { |
| 154 | struct vmbus_channel_message_header Header; |
| 155 | u32 ChildRelId; |
| 156 | u32 Gpadl; |
| 157 | u16 RangeBufLen; |
| 158 | u16 RangeCount; |
| 159 | struct gpa_range Range[0]; |
| 160 | } __attribute__((packed)); |
| 161 | |
| 162 | /* This is the followup packet that contains more PFNs. */ |
| 163 | struct vmbus_channel_gpadl_body { |
| 164 | struct vmbus_channel_message_header Header; |
| 165 | u32 MessageNumber; |
| 166 | u32 Gpadl; |
| 167 | u64 Pfn[0]; |
| 168 | } __attribute__((packed)); |
| 169 | |
| 170 | struct vmbus_channel_gpadl_created { |
| 171 | struct vmbus_channel_message_header Header; |
| 172 | u32 ChildRelId; |
| 173 | u32 Gpadl; |
| 174 | u32 CreationStatus; |
| 175 | } __attribute__((packed)); |
| 176 | |
| 177 | struct vmbus_channel_gpadl_teardown { |
| 178 | struct vmbus_channel_message_header Header; |
| 179 | u32 ChildRelId; |
| 180 | u32 Gpadl; |
| 181 | } __attribute__((packed)); |
| 182 | |
| 183 | struct vmbus_channel_gpadl_torndown { |
| 184 | struct vmbus_channel_message_header Header; |
| 185 | u32 Gpadl; |
| 186 | } __attribute__((packed)); |
| 187 | |
| 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; |
| 192 | u64 ViewRangeLength; |
| 193 | u32 ChildRelId; |
| 194 | } __attribute__((packed)); |
| 195 | |
| 196 | struct vmbus_channel_view_range_remove { |
| 197 | struct vmbus_channel_message_header Header; |
| 198 | PHYSICAL_ADDRESS ViewRangeBase; |
| 199 | u32 ChildRelId; |
| 200 | } __attribute__((packed)); |
| 201 | #endif |
| 202 | |
| 203 | struct vmbus_channel_relid_released { |
| 204 | struct vmbus_channel_message_header Header; |
| 205 | u32 ChildRelId; |
| 206 | } __attribute__((packed)); |
| 207 | |
| 208 | struct vmbus_channel_initiate_contact { |
| 209 | struct vmbus_channel_message_header Header; |
| 210 | u32 VMBusVersionRequested; |
| 211 | u32 Padding2; |
| 212 | u64 InterruptPage; |
| 213 | u64 MonitorPage1; |
| 214 | u64 MonitorPage2; |
| 215 | } __attribute__((packed)); |
| 216 | |
| 217 | struct vmbus_channel_version_response { |
| 218 | struct vmbus_channel_message_header Header; |
| 219 | bool VersionSupported; |
| 220 | } __attribute__((packed)); |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 221 | |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 222 | enum vmbus_channel_state { |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 223 | CHANNEL_OFFER_STATE, |
| 224 | CHANNEL_OPENING_STATE, |
| 225 | CHANNEL_OPEN_STATE, |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 226 | }; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 227 | |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 228 | struct vmbus_channel { |
Bill Pemberton | 53af545 | 2009-09-11 21:46:44 -0400 | [diff] [blame] | 229 | struct list_head ListEntry; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 230 | |
Nicolas Palix | 3d3b551 | 2009-07-28 17:32:53 +0200 | [diff] [blame] | 231 | struct hv_device *DeviceObject; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 232 | |
Greg Kroah-Hartman | c8a429a | 2009-07-29 15:40:57 -0700 | [diff] [blame] | 233 | struct timer_list poll_timer; /* SA-111 workaround */ |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 234 | |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 235 | enum vmbus_channel_state State; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 236 | |
Greg Kroah-Hartman | 8225021 | 2009-08-26 15:16:04 -0700 | [diff] [blame] | 237 | struct vmbus_channel_offer_channel OfferMsg; |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 238 | /* |
| 239 | * These are based on the OfferMsg.MonitorId. |
| 240 | * Save it here for easy access. |
| 241 | */ |
| 242 | u8 MonitorGroup; |
| 243 | u8 MonitorBit; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 244 | |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 245 | u32 RingBufferGpadlHandle; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 246 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 247 | /* Allocated memory for ring buffer */ |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 248 | void *RingBufferPages; |
| 249 | u32 RingBufferPageCount; |
| 250 | RING_BUFFER_INFO Outbound; /* send to parent */ |
| 251 | RING_BUFFER_INFO Inbound; /* receive from parent */ |
Greg Kroah-Hartman | 54411c4 | 2009-07-15 14:48:32 -0700 | [diff] [blame] | 252 | spinlock_t inbound_lock; |
Bill Pemberton | df8d9b1 | 2009-07-27 16:47:45 -0400 | [diff] [blame] | 253 | struct workqueue_struct *ControlWQ; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 254 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 255 | /* Channel callback are invoked in this workqueue context */ |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 256 | /* HANDLE dataWorkQueue; */ |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 257 | |
Greg Kroah-Hartman | 7903506 | 2009-09-02 11:44:19 -0700 | [diff] [blame] | 258 | void (*OnChannelCallback)(void *context); |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 259 | void *ChannelCallbackContext; |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 260 | }; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 261 | |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 262 | struct vmbus_channel_debug_info { |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 263 | u32 RelId; |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 264 | enum vmbus_channel_state State; |
Greg Kroah-Hartman | caf26a3 | 2009-08-19 16:17:03 -0700 | [diff] [blame] | 265 | struct hv_guid InterfaceType; |
| 266 | struct hv_guid InterfaceInstance; |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 267 | u32 MonitorId; |
| 268 | u32 ServerMonitorPending; |
| 269 | u32 ServerMonitorLatency; |
| 270 | u32 ServerMonitorConnectionId; |
| 271 | u32 ClientMonitorPending; |
| 272 | u32 ClientMonitorLatency; |
| 273 | u32 ClientMonitorConnectionId; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 274 | |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 275 | RING_BUFFER_DEBUG_INFO Inbound; |
| 276 | RING_BUFFER_DEBUG_INFO Outbound; |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 277 | }; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 278 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 279 | /* |
| 280 | * Represents each channel msg on the vmbus connection This is a |
| 281 | * variable-size data structure depending on the msg type itself |
| 282 | */ |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 283 | struct vmbus_channel_msginfo { |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 284 | /* Bookkeeping stuff */ |
Bill Pemberton | 53af545 | 2009-09-11 21:46:44 -0400 | [diff] [blame] | 285 | struct list_head MsgListEntry; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 286 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 287 | /* So far, this is only used to handle gpadl body message */ |
Bill Pemberton | 53af545 | 2009-09-11 21:46:44 -0400 | [diff] [blame] | 288 | struct list_head SubMsgList; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 289 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 290 | /* Synchronize the request/response if needed */ |
Bill Pemberton | aedb444 | 2009-07-28 13:46:24 -0400 | [diff] [blame] | 291 | struct osd_waitevent *WaitEvent; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 292 | |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 293 | union { |
Greg Kroah-Hartman | 8225021 | 2009-08-26 15:16:04 -0700 | [diff] [blame] | 294 | struct vmbus_channel_version_supported VersionSupported; |
| 295 | struct vmbus_channel_open_result OpenResult; |
| 296 | struct vmbus_channel_gpadl_torndown GpadlTorndown; |
| 297 | struct vmbus_channel_gpadl_created GpadlCreated; |
| 298 | struct vmbus_channel_version_response VersionResponse; |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 299 | } Response; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 300 | |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 301 | u32 MessageSize; |
| 302 | /* |
| 303 | * The channel message that goes out on the "wire". |
| 304 | * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header |
| 305 | */ |
| 306 | unsigned char Msg[0]; |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 307 | }; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 308 | |
| 309 | |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 310 | struct vmbus_channel *AllocVmbusChannel(void); |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 311 | |
Greg Kroah-Hartman | aded7165 | 2009-08-18 15:21:19 -0700 | [diff] [blame] | 312 | void FreeVmbusChannel(struct vmbus_channel *Channel); |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 313 | |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 314 | void VmbusOnChannelMessage(void *Context); |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 315 | |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 316 | int VmbusChannelRequestOffers(void); |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 317 | |
Greg Kroah-Hartman | b239549c | 2009-08-17 17:22:08 -0700 | [diff] [blame] | 318 | void VmbusChannelReleaseUnattachedChannels(void); |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 319 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 320 | #endif /* _CHANNEL_MGMT_H_ */ |