2 * Copyright (c) 2009, Microsoft Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 * Place - Suite 330, Boston, MA 02111-1307 USA.
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/kernel.h>
24 #include <linux/sched.h>
25 #include <linux/wait.h>
27 #include <linux/slab.h>
28 #include <linux/list.h>
29 #include <linux/module.h>
30 #include <linux/completion.h>
31 #include <linux/hyperv.h>
33 #include "hyperv_vmbus.h"
35 struct vmbus_channel_message_table_entry {
36 enum vmbus_channel_message_type message_type;
37 void (*message_handler)(struct vmbus_channel_message_header *msg);
42 * vmbus_prep_negotiate_resp() - Create default response for Hyper-V Negotiate message
43 * @icmsghdrp: Pointer to msg header structure
44 * @icmsg_negotiate: Pointer to negotiate message structure
45 * @buf: Raw buffer channel data
47 * @icmsghdrp is of type &struct icmsg_hdr.
48 * @negop is of type &struct icmsg_negotiate.
49 * Set up and fill in default negotiate response message.
51 * The max_fw_version specifies the maximum framework version that
52 * we can support and max _srv_version specifies the maximum service
53 * version we can support. A special value MAX_SRV_VER can be
54 * specified to indicate that we can handle the maximum version
55 * exposed by the host.
57 * Mainly used by Hyper-V drivers.
59 void vmbus_prep_negotiate_resp(struct icmsg_hdr *icmsghdrp,
60 struct icmsg_negotiate *negop, u8 *buf,
61 int max_fw_version, int max_srv_version)
67 icmsghdrp->icmsgsize = 0x10;
69 negop = (struct icmsg_negotiate *)&buf[
70 sizeof(struct vmbuspipe_hdr) +
71 sizeof(struct icmsg_hdr)];
73 icframe_vercnt = negop->icframe_vercnt;
74 icmsg_vercnt = negop->icmsg_vercnt;
77 * Select the framework version number we will
81 for (i = 0; i < negop->icframe_vercnt; i++) {
82 if (negop->icversion_data[i].major <= max_fw_version)
83 icframe_vercnt = negop->icversion_data[i].major;
86 for (i = negop->icframe_vercnt;
87 (i < negop->icframe_vercnt + negop->icmsg_vercnt); i++) {
88 if (negop->icversion_data[i].major <= max_srv_version)
89 icmsg_vercnt = negop->icversion_data[i].major;
93 * Respond with the maximum framework and service
94 * version numbers we can support.
96 negop->icframe_vercnt = 1;
97 negop->icmsg_vercnt = 1;
98 negop->icversion_data[0].major = icframe_vercnt;
99 negop->icversion_data[0].minor = 0;
100 negop->icversion_data[1].major = icmsg_vercnt;
101 negop->icversion_data[1].minor = 0;
104 EXPORT_SYMBOL_GPL(vmbus_prep_negotiate_resp);
107 * alloc_channel - Allocate and initialize a vmbus channel object
109 static struct vmbus_channel *alloc_channel(void)
111 struct vmbus_channel *channel;
113 channel = kzalloc(sizeof(*channel), GFP_ATOMIC);
117 spin_lock_init(&channel->inbound_lock);
119 channel->controlwq = create_workqueue("hv_vmbus_ctl");
120 if (!channel->controlwq) {
129 * release_hannel - Release the vmbus channel object itself
131 static void release_channel(struct work_struct *work)
133 struct vmbus_channel *channel = container_of(work,
134 struct vmbus_channel,
137 destroy_workqueue(channel->controlwq);
143 * free_channel - Release the resources used by the vmbus channel object
145 static void free_channel(struct vmbus_channel *channel)
149 * We have to release the channel's workqueue/thread in the vmbus's
150 * workqueue/thread context
151 * ie we can't destroy ourselves.
153 INIT_WORK(&channel->work, release_channel);
154 queue_work(vmbus_connection.work_queue, &channel->work);
160 * vmbus_process_rescind_offer -
161 * Rescind the offer by initiating a device removal
163 static void vmbus_process_rescind_offer(struct work_struct *work)
165 struct vmbus_channel *channel = container_of(work,
166 struct vmbus_channel,
169 vmbus_device_unregister(channel->device_obj);
172 void vmbus_free_channels(void)
174 struct vmbus_channel *channel;
176 list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
177 vmbus_device_unregister(channel->device_obj);
178 kfree(channel->device_obj);
179 free_channel(channel);
184 * vmbus_process_offer - Process the offer by creating a channel/device
185 * associated with this offer
187 static void vmbus_process_offer(struct work_struct *work)
189 struct vmbus_channel *newchannel = container_of(work,
190 struct vmbus_channel,
192 struct vmbus_channel *channel;
197 /* The next possible work is rescind handling */
198 INIT_WORK(&newchannel->work, vmbus_process_rescind_offer);
200 /* Make sure this is a new offer */
201 spin_lock_irqsave(&vmbus_connection.channel_lock, flags);
203 list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
204 if (!uuid_le_cmp(channel->offermsg.offer.if_type,
205 newchannel->offermsg.offer.if_type) &&
206 !uuid_le_cmp(channel->offermsg.offer.if_instance,
207 newchannel->offermsg.offer.if_instance)) {
214 list_add_tail(&newchannel->listentry,
215 &vmbus_connection.chn_list);
217 spin_unlock_irqrestore(&vmbus_connection.channel_lock, flags);
220 free_channel(newchannel);
225 * Start the process of binding this offer to the driver
226 * We need to set the DeviceObject field before calling
227 * vmbus_child_dev_add()
229 newchannel->device_obj = vmbus_device_create(
230 &newchannel->offermsg.offer.if_type,
231 &newchannel->offermsg.offer.if_instance,
235 * Add the new device to the bus. This will kick off device-driver
236 * binding which eventually invokes the device driver's AddDevice()
239 ret = vmbus_device_register(newchannel->device_obj);
241 pr_err("unable to add child device object (relid %d)\n",
242 newchannel->offermsg.child_relid);
244 spin_lock_irqsave(&vmbus_connection.channel_lock, flags);
245 list_del(&newchannel->listentry);
246 spin_unlock_irqrestore(&vmbus_connection.channel_lock, flags);
247 kfree(newchannel->device_obj);
249 free_channel(newchannel);
252 * This state is used to indicate a successful open
253 * so that when we do close the channel normally, we
254 * can cleanup properly
256 newchannel->state = CHANNEL_OPEN_STATE;
261 * vmbus_onoffer - Handler for channel offers from vmbus in parent partition.
264 static void vmbus_onoffer(struct vmbus_channel_message_header *hdr)
266 struct vmbus_channel_offer_channel *offer;
267 struct vmbus_channel *newchannel;
269 offer = (struct vmbus_channel_offer_channel *)hdr;
271 /* Allocate the channel object and save this offer. */
272 newchannel = alloc_channel();
274 pr_err("Unable to allocate channel object\n");
278 memcpy(&newchannel->offermsg, offer,
279 sizeof(struct vmbus_channel_offer_channel));
280 newchannel->monitor_grp = (u8)offer->monitorid / 32;
281 newchannel->monitor_bit = (u8)offer->monitorid % 32;
283 INIT_WORK(&newchannel->work, vmbus_process_offer);
284 queue_work(newchannel->controlwq, &newchannel->work);
288 * vmbus_onoffer_rescind - Rescind offer handler.
290 * We queue a work item to process this offer synchronously
292 static void vmbus_onoffer_rescind(struct vmbus_channel_message_header *hdr)
294 struct vmbus_channel_rescind_offer *rescind;
295 struct vmbus_channel *channel;
297 rescind = (struct vmbus_channel_rescind_offer *)hdr;
298 channel = relid2channel(rescind->child_relid);
301 /* Just return here, no channel found */
304 /* work is initialized for vmbus_process_rescind_offer() from
305 * vmbus_process_offer() where the channel got created */
306 queue_work(channel->controlwq, &channel->work);
310 * vmbus_onoffers_delivered -
311 * This is invoked when all offers have been delivered.
313 * Nothing to do here.
315 static void vmbus_onoffers_delivered(
316 struct vmbus_channel_message_header *hdr)
321 * vmbus_onopen_result - Open result handler.
323 * This is invoked when we received a response to our channel open request.
324 * Find the matching request, copy the response and signal the requesting
327 static void vmbus_onopen_result(struct vmbus_channel_message_header *hdr)
329 struct vmbus_channel_open_result *result;
330 struct vmbus_channel_msginfo *msginfo;
331 struct vmbus_channel_message_header *requestheader;
332 struct vmbus_channel_open_channel *openmsg;
335 result = (struct vmbus_channel_open_result *)hdr;
338 * Find the open msg, copy the result and signal/unblock the wait event
340 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
342 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
345 (struct vmbus_channel_message_header *)msginfo->msg;
347 if (requestheader->msgtype == CHANNELMSG_OPENCHANNEL) {
349 (struct vmbus_channel_open_channel *)msginfo->msg;
350 if (openmsg->child_relid == result->child_relid &&
351 openmsg->openid == result->openid) {
352 memcpy(&msginfo->response.open_result,
355 struct vmbus_channel_open_result));
356 complete(&msginfo->waitevent);
361 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
365 * vmbus_ongpadl_created - GPADL created handler.
367 * This is invoked when we received a response to our gpadl create request.
368 * Find the matching request, copy the response and signal the requesting
371 static void vmbus_ongpadl_created(struct vmbus_channel_message_header *hdr)
373 struct vmbus_channel_gpadl_created *gpadlcreated;
374 struct vmbus_channel_msginfo *msginfo;
375 struct vmbus_channel_message_header *requestheader;
376 struct vmbus_channel_gpadl_header *gpadlheader;
379 gpadlcreated = (struct vmbus_channel_gpadl_created *)hdr;
382 * Find the establish msg, copy the result and signal/unblock the wait
385 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
387 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
390 (struct vmbus_channel_message_header *)msginfo->msg;
392 if (requestheader->msgtype == CHANNELMSG_GPADL_HEADER) {
394 (struct vmbus_channel_gpadl_header *)requestheader;
396 if ((gpadlcreated->child_relid ==
397 gpadlheader->child_relid) &&
398 (gpadlcreated->gpadl == gpadlheader->gpadl)) {
399 memcpy(&msginfo->response.gpadl_created,
402 struct vmbus_channel_gpadl_created));
403 complete(&msginfo->waitevent);
408 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
412 * vmbus_ongpadl_torndown - GPADL torndown handler.
414 * This is invoked when we received a response to our gpadl teardown request.
415 * Find the matching request, copy the response and signal the requesting
418 static void vmbus_ongpadl_torndown(
419 struct vmbus_channel_message_header *hdr)
421 struct vmbus_channel_gpadl_torndown *gpadl_torndown;
422 struct vmbus_channel_msginfo *msginfo;
423 struct vmbus_channel_message_header *requestheader;
424 struct vmbus_channel_gpadl_teardown *gpadl_teardown;
427 gpadl_torndown = (struct vmbus_channel_gpadl_torndown *)hdr;
430 * Find the open msg, copy the result and signal/unblock the wait event
432 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
434 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
437 (struct vmbus_channel_message_header *)msginfo->msg;
439 if (requestheader->msgtype == CHANNELMSG_GPADL_TEARDOWN) {
441 (struct vmbus_channel_gpadl_teardown *)requestheader;
443 if (gpadl_torndown->gpadl == gpadl_teardown->gpadl) {
444 memcpy(&msginfo->response.gpadl_torndown,
447 struct vmbus_channel_gpadl_torndown));
448 complete(&msginfo->waitevent);
453 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
457 * vmbus_onversion_response - Version response handler
459 * This is invoked when we received a response to our initiate contact request.
460 * Find the matching request, copy the response and signal the requesting
463 static void vmbus_onversion_response(
464 struct vmbus_channel_message_header *hdr)
466 struct vmbus_channel_msginfo *msginfo;
467 struct vmbus_channel_message_header *requestheader;
468 struct vmbus_channel_version_response *version_response;
471 version_response = (struct vmbus_channel_version_response *)hdr;
472 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
474 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
477 (struct vmbus_channel_message_header *)msginfo->msg;
479 if (requestheader->msgtype ==
480 CHANNELMSG_INITIATE_CONTACT) {
481 memcpy(&msginfo->response.version_response,
483 sizeof(struct vmbus_channel_version_response));
484 complete(&msginfo->waitevent);
487 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
490 /* Channel message dispatch table */
491 static struct vmbus_channel_message_table_entry
492 channel_message_table[CHANNELMSG_COUNT] = {
493 {CHANNELMSG_INVALID, NULL},
494 {CHANNELMSG_OFFERCHANNEL, vmbus_onoffer},
495 {CHANNELMSG_RESCIND_CHANNELOFFER, vmbus_onoffer_rescind},
496 {CHANNELMSG_REQUESTOFFERS, NULL},
497 {CHANNELMSG_ALLOFFERS_DELIVERED, vmbus_onoffers_delivered},
498 {CHANNELMSG_OPENCHANNEL, NULL},
499 {CHANNELMSG_OPENCHANNEL_RESULT, vmbus_onopen_result},
500 {CHANNELMSG_CLOSECHANNEL, NULL},
501 {CHANNELMSG_GPADL_HEADER, NULL},
502 {CHANNELMSG_GPADL_BODY, NULL},
503 {CHANNELMSG_GPADL_CREATED, vmbus_ongpadl_created},
504 {CHANNELMSG_GPADL_TEARDOWN, NULL},
505 {CHANNELMSG_GPADL_TORNDOWN, vmbus_ongpadl_torndown},
506 {CHANNELMSG_RELID_RELEASED, NULL},
507 {CHANNELMSG_INITIATE_CONTACT, NULL},
508 {CHANNELMSG_VERSION_RESPONSE, vmbus_onversion_response},
509 {CHANNELMSG_UNLOAD, NULL},
513 * vmbus_onmessage - Handler for channel protocol messages.
515 * This is invoked in the vmbus worker thread context.
517 void vmbus_onmessage(void *context)
519 struct hv_message *msg = context;
520 struct vmbus_channel_message_header *hdr;
523 hdr = (struct vmbus_channel_message_header *)msg->u.payload;
524 size = msg->header.payload_size;
526 if (hdr->msgtype >= CHANNELMSG_COUNT) {
527 pr_err("Received invalid channel message type %d size %d\n",
529 print_hex_dump_bytes("", DUMP_PREFIX_NONE,
530 (unsigned char *)msg->u.payload, size);
534 if (channel_message_table[hdr->msgtype].message_handler)
535 channel_message_table[hdr->msgtype].message_handler(hdr);
537 pr_err("Unhandled channel message type %d\n", hdr->msgtype);
541 * vmbus_request_offers - Send a request to get all our pending offers.
543 int vmbus_request_offers(void)
545 struct vmbus_channel_message_header *msg;
546 struct vmbus_channel_msginfo *msginfo;
549 msginfo = kmalloc(sizeof(*msginfo) +
550 sizeof(struct vmbus_channel_message_header),
555 init_completion(&msginfo->waitevent);
557 msg = (struct vmbus_channel_message_header *)msginfo->msg;
559 msg->msgtype = CHANNELMSG_REQUESTOFFERS;
562 ret = vmbus_post_msg(msg,
563 sizeof(struct vmbus_channel_message_header));
565 pr_err("Unable to request offers - %d\n", ret);
570 t = wait_for_completion_timeout(&msginfo->waitevent, 5*HZ);