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 #include "include/osd.h"
26 #include "include/logging.h"
28 #include "VmbusPrivate.h"
32 typedef void (*PFN_CHANNEL_MESSAGE_HANDLER)(VMBUS_CHANNEL_MESSAGE_HEADER* msg);
34 typedef struct _VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY {
35 VMBUS_CHANNEL_MESSAGE_TYPE messageType;
36 PFN_CHANNEL_MESSAGE_HANDLER messageHandler;
37 } VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY;
39 /* Internal routines */
43 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
46 VmbusChannelOnOpenResult(
47 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
51 VmbusChannelOnOfferRescind(
52 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
56 VmbusChannelOnGpadlCreated(
57 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
61 VmbusChannelOnGpadlTorndown(
62 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
66 VmbusChannelOnOffersDelivered(
67 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
71 VmbusChannelOnVersionResponse(
72 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
76 VmbusChannelProcessOffer(
81 VmbusChannelProcessRescindOffer(
88 #define MAX_NUM_DEVICE_CLASSES_SUPPORTED 4
90 static const GUID gSupportedDeviceClasses[MAX_NUM_DEVICE_CLASSES_SUPPORTED]= {
91 /* {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f} */
92 {.Data = {0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f}},/* Storage - SCSI */
93 /* {F8615163-DF3E-46c5-913F-F2D2F965ED0E} */
94 {.Data = {0x63, 0x51, 0x61, 0xF8, 0x3E, 0xDF, 0xc5, 0x46, 0x91, 0x3F, 0xF2, 0xD2, 0xF9, 0x65, 0xED, 0x0E}}, /* Network */
95 /* {CFA8B69E-5B4A-4cc0-B98B-8BA1A1F3F95A} */
96 {.Data = {0x9E, 0xB6, 0xA8, 0xCF, 0x4A, 0x5B, 0xc0, 0x4c, 0xB9, 0x8B, 0x8B, 0xA1, 0xA1, 0xF3, 0xF9, 0x5A}}, /* Input */
97 /* {32412632-86cb-44a2-9b5c-50d1417354f5} */
98 {.Data = {0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5}}, /* IDE */
102 /* Channel message dispatch table */
103 static VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY gChannelMessageTable[ChannelMessageCount]= {
104 {ChannelMessageInvalid, NULL},
105 {ChannelMessageOfferChannel, VmbusChannelOnOffer},
106 {ChannelMessageRescindChannelOffer, VmbusChannelOnOfferRescind},
107 {ChannelMessageRequestOffers, NULL},
108 {ChannelMessageAllOffersDelivered, VmbusChannelOnOffersDelivered},
109 {ChannelMessageOpenChannel, NULL},
110 {ChannelMessageOpenChannelResult, VmbusChannelOnOpenResult},
111 {ChannelMessageCloseChannel, NULL},
112 {ChannelMessageGpadlHeader, NULL},
113 {ChannelMessageGpadlBody, NULL},
114 {ChannelMessageGpadlCreated, VmbusChannelOnGpadlCreated},
115 {ChannelMessageGpadlTeardown, NULL},
116 {ChannelMessageGpadlTorndown, VmbusChannelOnGpadlTorndown},
117 {ChannelMessageRelIdReleased, NULL},
118 {ChannelMessageInitiateContact, NULL},
119 {ChannelMessageVersionResponse, VmbusChannelOnVersionResponse},
120 {ChannelMessageUnload, NULL},
129 Allocate and initialize a vmbus channel object
132 static VMBUS_CHANNEL* AllocVmbusChannel(void)
134 VMBUS_CHANNEL* channel;
136 channel = kzalloc(sizeof(VMBUS_CHANNEL), GFP_ATOMIC);
142 spin_lock_init(&channel->inbound_lock);
144 init_timer(&channel->poll_timer);
145 channel->poll_timer.data = (unsigned long)channel;
146 channel->poll_timer.function = VmbusChannelOnTimer;
148 /* channel->dataWorkQueue = WorkQueueCreate("data"); */
149 channel->ControlWQ = create_workqueue("hv_vmbus_ctl");
150 if (!channel->ControlWQ)
162 ReleaseVmbusChannel()
165 Release the vmbus channel object itself
168 static inline void ReleaseVmbusChannel(void* Context)
170 VMBUS_CHANNEL* channel = (VMBUS_CHANNEL*)Context;
174 DPRINT_DBG(VMBUS, "releasing channel (%p)", channel);
175 destroy_workqueue(channel->ControlWQ);
176 DPRINT_DBG(VMBUS, "channel released (%p)", channel);
189 Release the resources used by the vmbus channel object
192 static void FreeVmbusChannel(VMBUS_CHANNEL* Channel)
194 del_timer(&Channel->poll_timer);
196 /* We have to release the channel's workqueue/thread in the vmbus's workqueue/thread context */
197 /* ie we can't destroy ourselves. */
198 osd_schedule_callback(gVmbusConnection.WorkQueue, ReleaseVmbusChannel,
206 VmbusChannelProcessOffer()
209 Process the offer by creating a channel/device associated with this offer
213 VmbusChannelProcessOffer(
218 VMBUS_CHANNEL* newChannel=(VMBUS_CHANNEL*)context;
222 VMBUS_CHANNEL* channel;
227 /* Make sure this is a new offer */
228 spin_lock_irqsave(&gVmbusConnection.channel_lock, flags);
230 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelList)
232 channel = CONTAINING_RECORD(curr, VMBUS_CHANNEL, ListEntry);
234 if (!memcmp(&channel->OfferMsg.Offer.InterfaceType, &newChannel->OfferMsg.Offer.InterfaceType,sizeof(GUID)) &&
235 !memcmp(&channel->OfferMsg.Offer.InterfaceInstance, &newChannel->OfferMsg.Offer.InterfaceInstance, sizeof(GUID)))
244 INSERT_TAIL_LIST(&gVmbusConnection.ChannelList, &newChannel->ListEntry);
246 spin_unlock_irqrestore(&gVmbusConnection.channel_lock, flags);
250 DPRINT_DBG(VMBUS, "Ignoring duplicate offer for relid (%d)", newChannel->OfferMsg.ChildRelId);
251 FreeVmbusChannel(newChannel);
256 /* Start the process of binding this offer to the driver */
257 /* We need to set the DeviceObject field before calling VmbusChildDeviceAdd() */
258 newChannel->DeviceObject = VmbusChildDeviceCreate(
259 newChannel->OfferMsg.Offer.InterfaceType,
260 newChannel->OfferMsg.Offer.InterfaceInstance,
263 DPRINT_DBG(VMBUS, "child device object allocated - %p", newChannel->DeviceObject);
266 * Add the new device to the bus. This will kick off device-driver
267 * binding which eventually invokes the device driver's AddDevice()
271 ret = VmbusChildDeviceAdd(newChannel->DeviceObject);
274 DPRINT_ERR(VMBUS, "unable to add child device object (relid %d)",
275 newChannel->OfferMsg.ChildRelId);
277 spin_lock_irqsave(&gVmbusConnection.channel_lock, flags);
278 REMOVE_ENTRY_LIST(&newChannel->ListEntry);
279 spin_unlock_irqrestore(&gVmbusConnection.channel_lock, flags);
281 FreeVmbusChannel(newChannel);
286 * This state is used to indicate a successful open
287 * so that when we do close the channel normally, we
288 * can cleanup properly
290 newChannel->State = CHANNEL_OPEN_STATE;
298 VmbusChannelProcessRescindOffer()
301 Rescind the offer by initiating a device removal
305 VmbusChannelProcessRescindOffer(
309 VMBUS_CHANNEL* channel=(VMBUS_CHANNEL*)context;
313 VmbusChildDeviceRemove(channel->DeviceObject);
322 VmbusChannelOnOffer()
325 Handler for channel offers from vmbus in parent partition. We ignore all offers except
326 network and storage offers. For each network and storage offers, we create a channel object
327 and queue a work item to the channel object to process the offer synchronously
332 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
335 VMBUS_CHANNEL_OFFER_CHANNEL* offer = (VMBUS_CHANNEL_OFFER_CHANNEL*)hdr;
336 VMBUS_CHANNEL* newChannel;
345 for (i=0; i<MAX_NUM_DEVICE_CLASSES_SUPPORTED; i++)
347 if (memcmp(&offer->Offer.InterfaceType, &gSupportedDeviceClasses[i], sizeof(GUID)) == 0)
356 DPRINT_DBG(VMBUS, "Ignoring channel offer notification for child relid %d", offer->ChildRelId);
362 guidType = &offer->Offer.InterfaceType;
363 guidInstance = &offer->Offer.InterfaceInstance;
365 DPRINT_INFO(VMBUS, "Channel offer notification - child relid %d monitor id %d allocated %d, "
366 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x%02x%02x} "
367 "instance {%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x%02x%02x}",
370 offer->MonitorAllocated,
371 guidType->Data[3], guidType->Data[2], guidType->Data[1], guidType->Data[0], guidType->Data[5], guidType->Data[4], guidType->Data[7], guidType->Data[6], guidType->Data[8], guidType->Data[9], guidType->Data[10], guidType->Data[11], guidType->Data[12], guidType->Data[13], guidType->Data[14], guidType->Data[15],
372 guidInstance->Data[3], guidInstance->Data[2], guidInstance->Data[1], guidInstance->Data[0], guidInstance->Data[5], guidInstance->Data[4], guidInstance->Data[7], guidInstance->Data[6], guidInstance->Data[8], guidInstance->Data[9], guidInstance->Data[10], guidInstance->Data[11], guidInstance->Data[12], guidInstance->Data[13], guidInstance->Data[14], guidInstance->Data[15]);
374 /* Allocate the channel object and save this offer. */
375 newChannel = AllocVmbusChannel();
378 DPRINT_ERR(VMBUS, "unable to allocate channel object");
382 DPRINT_DBG(VMBUS, "channel object allocated - %p", newChannel);
384 memcpy(&newChannel->OfferMsg, offer, sizeof(VMBUS_CHANNEL_OFFER_CHANNEL));
385 newChannel->MonitorGroup = (u8)offer->MonitorId / 32;
386 newChannel->MonitorBit = (u8)offer->MonitorId % 32;
388 /* TODO: Make sure the offer comes from our parent partition */
389 osd_schedule_callback(newChannel->ControlWQ, VmbusChannelProcessOffer,
399 VmbusChannelOnOfferRescind()
402 Rescind offer handler. We queue a work item to process this offer
407 VmbusChannelOnOfferRescind(
408 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
411 VMBUS_CHANNEL_RESCIND_OFFER* rescind = (VMBUS_CHANNEL_RESCIND_OFFER*)hdr;
412 VMBUS_CHANNEL* channel;
416 channel = GetChannelFromRelId(rescind->ChildRelId);
419 DPRINT_DBG(VMBUS, "channel not found for relId %d", rescind->ChildRelId);
423 osd_schedule_callback(channel->ControlWQ,
424 VmbusChannelProcessRescindOffer,
434 VmbusChannelOnOffersDelivered()
437 This is invoked when all offers have been delivered.
442 VmbusChannelOnOffersDelivered(
443 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
454 VmbusChannelOnOpenResult()
457 Open result handler. This is invoked when we received a response
458 to our channel open request. Find the matching request, copy the
459 response and signal the requesting thread.
463 VmbusChannelOnOpenResult(
464 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
467 VMBUS_CHANNEL_OPEN_RESULT* result = (VMBUS_CHANNEL_OPEN_RESULT*)hdr;
470 VMBUS_CHANNEL_MSGINFO* msgInfo;
471 VMBUS_CHANNEL_MESSAGE_HEADER* requestHeader;
472 VMBUS_CHANNEL_OPEN_CHANNEL* openMsg;
477 DPRINT_DBG(VMBUS, "vmbus open result - %d", result->Status);
479 /* Find the open msg, copy the result and signal/unblock the wait event */
480 spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
482 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelMsgList)
484 msgInfo = (VMBUS_CHANNEL_MSGINFO*) curr;
485 requestHeader = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
487 if (requestHeader->MessageType == ChannelMessageOpenChannel)
489 openMsg = (VMBUS_CHANNEL_OPEN_CHANNEL*)msgInfo->Msg;
490 if (openMsg->ChildRelId == result->ChildRelId &&
491 openMsg->OpenId == result->OpenId)
493 memcpy(&msgInfo->Response.OpenResult, result, sizeof(VMBUS_CHANNEL_OPEN_RESULT));
494 osd_WaitEventSet(msgInfo->WaitEvent);
499 spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
508 VmbusChannelOnGpadlCreated()
511 GPADL created handler. This is invoked when we received a response
512 to our gpadl create request. Find the matching request, copy the
513 response and signal the requesting thread.
517 VmbusChannelOnGpadlCreated(
518 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
521 VMBUS_CHANNEL_GPADL_CREATED *gpadlCreated = (VMBUS_CHANNEL_GPADL_CREATED*)hdr;
524 VMBUS_CHANNEL_MSGINFO *msgInfo;
525 VMBUS_CHANNEL_MESSAGE_HEADER *requestHeader;
526 VMBUS_CHANNEL_GPADL_HEADER *gpadlHeader;
531 DPRINT_DBG(VMBUS, "vmbus gpadl created result - %d", gpadlCreated->CreationStatus);
533 /* Find the establish msg, copy the result and signal/unblock the wait event */
534 spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
536 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelMsgList)
538 msgInfo = (VMBUS_CHANNEL_MSGINFO*) curr;
539 requestHeader = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
541 if (requestHeader->MessageType == ChannelMessageGpadlHeader)
543 gpadlHeader = (VMBUS_CHANNEL_GPADL_HEADER*)requestHeader;
545 if ((gpadlCreated->ChildRelId == gpadlHeader->ChildRelId) &&
546 (gpadlCreated->Gpadl == gpadlHeader->Gpadl))
548 memcpy(&msgInfo->Response.GpadlCreated, gpadlCreated, sizeof(VMBUS_CHANNEL_GPADL_CREATED));
549 osd_WaitEventSet(msgInfo->WaitEvent);
554 spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
563 VmbusChannelOnGpadlTorndown()
566 GPADL torndown handler. This is invoked when we received a response
567 to our gpadl teardown request. Find the matching request, copy the
568 response and signal the requesting thread.
572 VmbusChannelOnGpadlTorndown(
573 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
576 VMBUS_CHANNEL_GPADL_TORNDOWN* gpadlTorndown = (VMBUS_CHANNEL_GPADL_TORNDOWN*)hdr;
579 VMBUS_CHANNEL_MSGINFO* msgInfo;
580 VMBUS_CHANNEL_MESSAGE_HEADER *requestHeader;
581 VMBUS_CHANNEL_GPADL_TEARDOWN *gpadlTeardown;
586 /* Find the open msg, copy the result and signal/unblock the wait event */
587 spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
589 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelMsgList)
591 msgInfo = (VMBUS_CHANNEL_MSGINFO*) curr;
592 requestHeader = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
594 if (requestHeader->MessageType == ChannelMessageGpadlTeardown)
596 gpadlTeardown = (VMBUS_CHANNEL_GPADL_TEARDOWN*)requestHeader;
598 if (gpadlTorndown->Gpadl == gpadlTeardown->Gpadl)
600 memcpy(&msgInfo->Response.GpadlTorndown, gpadlTorndown, sizeof(VMBUS_CHANNEL_GPADL_TORNDOWN));
601 osd_WaitEventSet(msgInfo->WaitEvent);
606 spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
615 VmbusChannelOnVersionResponse()
618 Version response handler. This is invoked when we received a response
619 to our initiate contact request. Find the matching request, copy the
620 response and signal the requesting thread.
624 VmbusChannelOnVersionResponse(
625 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
630 VMBUS_CHANNEL_MSGINFO *msgInfo;
631 VMBUS_CHANNEL_MESSAGE_HEADER *requestHeader;
632 VMBUS_CHANNEL_INITIATE_CONTACT *initiate;
633 VMBUS_CHANNEL_VERSION_RESPONSE *versionResponse = (VMBUS_CHANNEL_VERSION_RESPONSE*)hdr;
638 spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
640 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelMsgList)
642 msgInfo = (VMBUS_CHANNEL_MSGINFO*) curr;
643 requestHeader = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
645 if (requestHeader->MessageType == ChannelMessageInitiateContact)
647 initiate = (VMBUS_CHANNEL_INITIATE_CONTACT*)requestHeader;
648 memcpy(&msgInfo->Response.VersionResponse, versionResponse, sizeof(VMBUS_CHANNEL_VERSION_RESPONSE));
649 osd_WaitEventSet(msgInfo->WaitEvent);
652 spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
661 VmbusOnChannelMessage()
664 Handler for channel protocol messages.
665 This is invoked in the vmbus worker thread context.
669 VmbusOnChannelMessage(
673 HV_MESSAGE *msg=(HV_MESSAGE*)Context;
674 VMBUS_CHANNEL_MESSAGE_HEADER* hdr;
679 hdr = (VMBUS_CHANNEL_MESSAGE_HEADER*)msg->u.Payload;
680 size=msg->Header.PayloadSize;
682 DPRINT_DBG(VMBUS, "message type %d size %d", hdr->MessageType, size);
684 if (hdr->MessageType >= ChannelMessageCount)
686 DPRINT_ERR(VMBUS, "Received invalid channel message type %d size %d", hdr->MessageType, size);
687 print_hex_dump_bytes("", DUMP_PREFIX_NONE,
688 (unsigned char *)msg->u.Payload, size);
693 if (gChannelMessageTable[hdr->MessageType].messageHandler)
695 gChannelMessageTable[hdr->MessageType].messageHandler(hdr);
699 DPRINT_ERR(VMBUS, "Unhandled channel message type %d", hdr->MessageType);
702 /* Free the msg that was allocated in VmbusOnMsgDPC() */
711 VmbusChannelRequestOffers()
714 Send a request to get all our pending offers.
718 VmbusChannelRequestOffers(
723 VMBUS_CHANNEL_MESSAGE_HEADER* msg;
724 VMBUS_CHANNEL_MSGINFO* msgInfo;
728 msgInfo = kmalloc(sizeof(VMBUS_CHANNEL_MSGINFO) + sizeof(VMBUS_CHANNEL_MESSAGE_HEADER), GFP_KERNEL);
729 ASSERT(msgInfo != NULL);
731 msgInfo->WaitEvent = osd_WaitEventCreate();
732 msg = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
734 msg->MessageType = ChannelMessageRequestOffers;
736 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
737 INSERT_TAIL_LIST(&gVmbusConnection.channelMsgList, &msgInfo->msgListEntry);
738 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
740 ret = VmbusPostMessage(msg, sizeof(VMBUS_CHANNEL_MESSAGE_HEADER));
743 DPRINT_ERR(VMBUS, "Unable to request offers - %d", ret);
745 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
746 REMOVE_ENTRY_LIST(&msgInfo->msgListEntry);
747 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
751 /* osd_WaitEventWait(msgInfo->waitEvent); */
753 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
754 REMOVE_ENTRY_LIST(&msgInfo->msgListEntry);
755 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
761 kfree(msgInfo->WaitEvent);
773 VmbusChannelReleaseUnattachedChannels()
776 Release channels that are unattached/unconnected ie (no drivers associated)
780 VmbusChannelReleaseUnattachedChannels(
785 VMBUS_CHANNEL *channel;
786 VMBUS_CHANNEL *start=NULL;
789 spin_lock_irqsave(&gVmbusConnection.channel_lock, flags);
791 while (!IsListEmpty(&gVmbusConnection.ChannelList))
793 entry = TOP_LIST_ENTRY(&gVmbusConnection.ChannelList);
794 channel = CONTAINING_RECORD(entry, VMBUS_CHANNEL, ListEntry);
796 if (channel == start)
799 if (!channel->DeviceObject->Driver)
801 REMOVE_ENTRY_LIST(&channel->ListEntry);
802 DPRINT_INFO(VMBUS, "Releasing unattached device object %p", channel->DeviceObject);
804 VmbusChildDeviceRemove(channel->DeviceObject);
805 FreeVmbusChannel(channel);
816 spin_unlock_irqrestore(&gVmbusConnection.channel_lock, flags);