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"
38 typedef void (*PFN_CHANNEL_MESSAGE_HANDLER)(VMBUS_CHANNEL_MESSAGE_HEADER* msg);
40 typedef struct _VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY {
41 VMBUS_CHANNEL_MESSAGE_TYPE messageType;
42 PFN_CHANNEL_MESSAGE_HANDLER messageHandler;
43 } VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY;
51 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
54 VmbusChannelOnOpenResult(
55 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
59 VmbusChannelOnOfferRescind(
60 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
64 VmbusChannelOnGpadlCreated(
65 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
69 VmbusChannelOnGpadlTorndown(
70 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
74 VmbusChannelOnOffersDelivered(
75 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
79 VmbusChannelOnVersionResponse(
80 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
84 VmbusChannelProcessOffer(
89 VmbusChannelProcessRescindOffer(
98 #define MAX_NUM_DEVICE_CLASSES_SUPPORTED 4
100 const GUID gSupportedDeviceClasses[MAX_NUM_DEVICE_CLASSES_SUPPORTED]= {
101 //{ba6163d9-04a1-4d29-b605-72e2ffb1dc7f}
102 {.Data = {0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f}},// Storage - SCSI
103 //{F8615163-DF3E-46c5-913F-F2D2F965ED0E}
104 {.Data = {0x63, 0x51, 0x61, 0xF8, 0x3E, 0xDF, 0xc5, 0x46, 0x91, 0x3F, 0xF2, 0xD2, 0xF9, 0x65, 0xED, 0x0E}}, // Network
105 //{CFA8B69E-5B4A-4cc0-B98B-8BA1A1F3F95A}
106 {.Data = {0x9E, 0xB6, 0xA8, 0xCF, 0x4A, 0x5B, 0xc0, 0x4c, 0xB9, 0x8B, 0x8B, 0xA1, 0xA1, 0xF3, 0xF9, 0x5A}}, // Input
107 //{32412632-86cb-44a2-9b5c-50d1417354f5}
108 {.Data = {0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5}}, // IDE
112 // Channel message dispatch table
113 VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY gChannelMessageTable[ChannelMessageCount]= {
114 {ChannelMessageInvalid, NULL},
115 {ChannelMessageOfferChannel, VmbusChannelOnOffer},
116 {ChannelMessageRescindChannelOffer, VmbusChannelOnOfferRescind},
117 {ChannelMessageRequestOffers, NULL},
118 {ChannelMessageAllOffersDelivered, VmbusChannelOnOffersDelivered},
119 {ChannelMessageOpenChannel, NULL},
120 {ChannelMessageOpenChannelResult, VmbusChannelOnOpenResult},
121 {ChannelMessageCloseChannel, NULL},
122 {ChannelMessageGpadlHeader, NULL},
123 {ChannelMessageGpadlBody, NULL},
124 {ChannelMessageGpadlCreated, VmbusChannelOnGpadlCreated},
125 {ChannelMessageGpadlTeardown, NULL},
126 {ChannelMessageGpadlTorndown, VmbusChannelOnGpadlTorndown},
127 {ChannelMessageRelIdReleased, NULL},
128 {ChannelMessageInitiateContact, NULL},
129 {ChannelMessageVersionResponse, VmbusChannelOnVersionResponse},
130 {ChannelMessageUnload, NULL},
139 Allocate and initialize a vmbus channel object
142 VMBUS_CHANNEL* AllocVmbusChannel(void)
144 VMBUS_CHANNEL* channel;
146 channel = kzalloc(sizeof(VMBUS_CHANNEL), GFP_ATOMIC);
152 spin_lock_init(&channel->inbound_lock);
154 channel->PollTimer = TimerCreate(VmbusChannelOnTimer, channel);
155 if (!channel->PollTimer)
161 //channel->dataWorkQueue = WorkQueueCreate("data");
162 channel->ControlWQ = WorkQueueCreate("control");
163 if (!channel->ControlWQ)
165 TimerClose(channel->PollTimer);
176 ReleaseVmbusChannel()
179 Release the vmbus channel object itself
182 static inline void ReleaseVmbusChannel(void* Context)
184 VMBUS_CHANNEL* channel = (VMBUS_CHANNEL*)Context;
188 DPRINT_DBG(VMBUS, "releasing channel (%p)", channel);
189 WorkQueueClose(channel->ControlWQ);
190 DPRINT_DBG(VMBUS, "channel released (%p)", channel);
203 Release the resources used by the vmbus channel object
206 void FreeVmbusChannel(VMBUS_CHANNEL* Channel)
208 TimerClose(Channel->PollTimer);
210 // We have to release the channel's workqueue/thread in the vmbus's workqueue/thread context
211 // ie we can't destroy ourselves.
212 WorkQueueQueueWorkItem(gVmbusConnection.WorkQueue, ReleaseVmbusChannel, (void*)Channel);
219 VmbusChannelProcessOffer()
222 Process the offer by creating a channel/device associated with this offer
226 VmbusChannelProcessOffer(
231 VMBUS_CHANNEL* newChannel=(VMBUS_CHANNEL*)context;
235 VMBUS_CHANNEL* channel;
239 // Make sure this is a new offer
240 SpinlockAcquire(gVmbusConnection.ChannelLock);
242 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelList)
244 channel = CONTAINING_RECORD(curr, VMBUS_CHANNEL, ListEntry);
246 if (!memcmp(&channel->OfferMsg.Offer.InterfaceType, &newChannel->OfferMsg.Offer.InterfaceType,sizeof(GUID)) &&
247 !memcmp(&channel->OfferMsg.Offer.InterfaceInstance, &newChannel->OfferMsg.Offer.InterfaceInstance, sizeof(GUID)))
256 INSERT_TAIL_LIST(&gVmbusConnection.ChannelList, &newChannel->ListEntry);
258 SpinlockRelease(gVmbusConnection.ChannelLock);
262 DPRINT_DBG(VMBUS, "Ignoring duplicate offer for relid (%d)", newChannel->OfferMsg.ChildRelId);
263 FreeVmbusChannel(newChannel);
268 // Start the process of binding this offer to the driver
269 // We need to set the DeviceObject field before calling VmbusChildDeviceAdd()
270 newChannel->DeviceObject = VmbusChildDeviceCreate(
271 newChannel->OfferMsg.Offer.InterfaceType,
272 newChannel->OfferMsg.Offer.InterfaceInstance,
275 DPRINT_DBG(VMBUS, "child device object allocated - %p", newChannel->DeviceObject);
277 // Add the new device to the bus. This will kick off device-driver binding
278 // which eventually invokes the device driver's AddDevice() method.
279 ret = VmbusChildDeviceAdd(newChannel->DeviceObject);
282 DPRINT_ERR(VMBUS, "unable to add child device object (relid %d)",
283 newChannel->OfferMsg.ChildRelId);
285 SpinlockAcquire(gVmbusConnection.ChannelLock);
286 REMOVE_ENTRY_LIST(&newChannel->ListEntry);
287 SpinlockRelease(gVmbusConnection.ChannelLock);
289 FreeVmbusChannel(newChannel);
293 // This state is used to indicate a successful open so that when we do close the channel normally,
294 // we can cleanup properly
295 newChannel->State = CHANNEL_OPEN_STATE;
303 VmbusChannelProcessRescindOffer()
306 Rescind the offer by initiating a device removal
310 VmbusChannelProcessRescindOffer(
314 VMBUS_CHANNEL* channel=(VMBUS_CHANNEL*)context;
318 VmbusChildDeviceRemove(channel->DeviceObject);
327 VmbusChannelOnOffer()
330 Handler for channel offers from vmbus in parent partition. We ignore all offers except
331 network and storage offers. For each network and storage offers, we create a channel object
332 and queue a work item to the channel object to process the offer synchronously
337 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
340 VMBUS_CHANNEL_OFFER_CHANNEL* offer = (VMBUS_CHANNEL_OFFER_CHANNEL*)hdr;
341 VMBUS_CHANNEL* newChannel;
350 for (i=0; i<MAX_NUM_DEVICE_CLASSES_SUPPORTED; i++)
352 if (memcmp(&offer->Offer.InterfaceType, &gSupportedDeviceClasses[i], sizeof(GUID)) == 0)
361 DPRINT_DBG(VMBUS, "Ignoring channel offer notification for child relid %d", offer->ChildRelId);
367 guidType = &offer->Offer.InterfaceType;
368 guidInstance = &offer->Offer.InterfaceInstance;
370 DPRINT_INFO(VMBUS, "Channel offer notification - child relid %d monitor id %d allocated %d, "
371 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x%02x%02x} "
372 "instance {%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x%02x%02x}",
375 offer->MonitorAllocated,
376 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],
377 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]);
379 // Allocate the channel object and save this offer.
380 newChannel = AllocVmbusChannel();
383 DPRINT_ERR(VMBUS, "unable to allocate channel object");
387 DPRINT_DBG(VMBUS, "channel object allocated - %p", newChannel);
389 memcpy(&newChannel->OfferMsg, offer, sizeof(VMBUS_CHANNEL_OFFER_CHANNEL));
390 newChannel->MonitorGroup = (u8)offer->MonitorId / 32;
391 newChannel->MonitorBit = (u8)offer->MonitorId % 32;
393 // TODO: Make sure the offer comes from our parent partition
394 WorkQueueQueueWorkItem(newChannel->ControlWQ, VmbusChannelProcessOffer, newChannel);
403 VmbusChannelOnOfferRescind()
406 Rescind offer handler. We queue a work item to process this offer
411 VmbusChannelOnOfferRescind(
412 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
415 VMBUS_CHANNEL_RESCIND_OFFER* rescind = (VMBUS_CHANNEL_RESCIND_OFFER*)hdr;
416 VMBUS_CHANNEL* channel;
420 channel = GetChannelFromRelId(rescind->ChildRelId);
423 DPRINT_DBG(VMBUS, "channel not found for relId %d", rescind->ChildRelId);
427 WorkQueueQueueWorkItem(channel->ControlWQ, VmbusChannelProcessRescindOffer, channel);
436 VmbusChannelOnOffersDelivered()
439 This is invoked when all offers have been delivered.
444 VmbusChannelOnOffersDelivered(
445 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
456 VmbusChannelOnOpenResult()
459 Open result handler. This is invoked when we received a response
460 to our channel open request. Find the matching request, copy the
461 response and signal the requesting thread.
465 VmbusChannelOnOpenResult(
466 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
469 VMBUS_CHANNEL_OPEN_RESULT* result = (VMBUS_CHANNEL_OPEN_RESULT*)hdr;
472 VMBUS_CHANNEL_MSGINFO* msgInfo;
473 VMBUS_CHANNEL_MESSAGE_HEADER* requestHeader;
474 VMBUS_CHANNEL_OPEN_CHANNEL* openMsg;
479 DPRINT_DBG(VMBUS, "vmbus open result - %d", result->Status);
481 // Find the open msg, copy the result and signal/unblock the wait event
482 spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
484 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelMsgList)
486 msgInfo = (VMBUS_CHANNEL_MSGINFO*) curr;
487 requestHeader = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
489 if (requestHeader->MessageType == ChannelMessageOpenChannel)
491 openMsg = (VMBUS_CHANNEL_OPEN_CHANNEL*)msgInfo->Msg;
492 if (openMsg->ChildRelId == result->ChildRelId &&
493 openMsg->OpenId == result->OpenId)
495 memcpy(&msgInfo->Response.OpenResult, result, sizeof(VMBUS_CHANNEL_OPEN_RESULT));
496 WaitEventSet(msgInfo->WaitEvent);
501 spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
510 VmbusChannelOnGpadlCreated()
513 GPADL created handler. This is invoked when we received a response
514 to our gpadl create request. Find the matching request, copy the
515 response and signal the requesting thread.
519 VmbusChannelOnGpadlCreated(
520 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
523 VMBUS_CHANNEL_GPADL_CREATED *gpadlCreated = (VMBUS_CHANNEL_GPADL_CREATED*)hdr;
526 VMBUS_CHANNEL_MSGINFO *msgInfo;
527 VMBUS_CHANNEL_MESSAGE_HEADER *requestHeader;
528 VMBUS_CHANNEL_GPADL_HEADER *gpadlHeader;
533 DPRINT_DBG(VMBUS, "vmbus gpadl created result - %d", gpadlCreated->CreationStatus);
535 // Find the establish msg, copy the result and signal/unblock the wait event
536 spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
538 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelMsgList)
540 msgInfo = (VMBUS_CHANNEL_MSGINFO*) curr;
541 requestHeader = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
543 if (requestHeader->MessageType == ChannelMessageGpadlHeader)
545 gpadlHeader = (VMBUS_CHANNEL_GPADL_HEADER*)requestHeader;
547 if ((gpadlCreated->ChildRelId == gpadlHeader->ChildRelId) &&
548 (gpadlCreated->Gpadl == gpadlHeader->Gpadl))
550 memcpy(&msgInfo->Response.GpadlCreated, gpadlCreated, sizeof(VMBUS_CHANNEL_GPADL_CREATED));
551 WaitEventSet(msgInfo->WaitEvent);
556 spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
565 VmbusChannelOnGpadlTorndown()
568 GPADL torndown handler. This is invoked when we received a response
569 to our gpadl teardown request. Find the matching request, copy the
570 response and signal the requesting thread.
574 VmbusChannelOnGpadlTorndown(
575 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
578 VMBUS_CHANNEL_GPADL_TORNDOWN* gpadlTorndown = (VMBUS_CHANNEL_GPADL_TORNDOWN*)hdr;
581 VMBUS_CHANNEL_MSGINFO* msgInfo;
582 VMBUS_CHANNEL_MESSAGE_HEADER *requestHeader;
583 VMBUS_CHANNEL_GPADL_TEARDOWN *gpadlTeardown;
588 // Find the open msg, copy the result and signal/unblock the wait event
589 spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
591 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelMsgList)
593 msgInfo = (VMBUS_CHANNEL_MSGINFO*) curr;
594 requestHeader = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
596 if (requestHeader->MessageType == ChannelMessageGpadlTeardown)
598 gpadlTeardown = (VMBUS_CHANNEL_GPADL_TEARDOWN*)requestHeader;
600 if (gpadlTorndown->Gpadl == gpadlTeardown->Gpadl)
602 memcpy(&msgInfo->Response.GpadlTorndown, gpadlTorndown, sizeof(VMBUS_CHANNEL_GPADL_TORNDOWN));
603 WaitEventSet(msgInfo->WaitEvent);
608 spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
617 VmbusChannelOnVersionResponse()
620 Version response handler. This is invoked when we received a response
621 to our initiate contact request. Find the matching request, copy the
622 response and signal the requesting thread.
626 VmbusChannelOnVersionResponse(
627 PVMBUS_CHANNEL_MESSAGE_HEADER hdr
632 VMBUS_CHANNEL_MSGINFO *msgInfo;
633 VMBUS_CHANNEL_MESSAGE_HEADER *requestHeader;
634 VMBUS_CHANNEL_INITIATE_CONTACT *initiate;
635 VMBUS_CHANNEL_VERSION_RESPONSE *versionResponse = (VMBUS_CHANNEL_VERSION_RESPONSE*)hdr;
640 spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
642 ITERATE_LIST_ENTRIES(anchor, curr, &gVmbusConnection.ChannelMsgList)
644 msgInfo = (VMBUS_CHANNEL_MSGINFO*) curr;
645 requestHeader = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
647 if (requestHeader->MessageType == ChannelMessageInitiateContact)
649 initiate = (VMBUS_CHANNEL_INITIATE_CONTACT*)requestHeader;
650 memcpy(&msgInfo->Response.VersionResponse, versionResponse, sizeof(VMBUS_CHANNEL_VERSION_RESPONSE));
651 WaitEventSet(msgInfo->WaitEvent);
654 spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
663 VmbusOnChannelMessage()
666 Handler for channel protocol messages.
667 This is invoked in the vmbus worker thread context.
671 VmbusOnChannelMessage(
675 HV_MESSAGE *msg=(HV_MESSAGE*)Context;
676 VMBUS_CHANNEL_MESSAGE_HEADER* hdr;
681 hdr = (VMBUS_CHANNEL_MESSAGE_HEADER*)msg->u.Payload;
682 size=msg->Header.PayloadSize;
684 DPRINT_DBG(VMBUS, "message type %d size %d", hdr->MessageType, size);
686 if (hdr->MessageType >= ChannelMessageCount)
688 DPRINT_ERR(VMBUS, "Received invalid channel message type %d size %d", hdr->MessageType, size);
689 PrintBytes((unsigned char *)msg->u.Payload, size);
694 if (gChannelMessageTable[hdr->MessageType].messageHandler)
696 gChannelMessageTable[hdr->MessageType].messageHandler(hdr);
700 DPRINT_ERR(VMBUS, "Unhandled channel message type %d", hdr->MessageType);
703 // Free the msg that was allocated in VmbusOnMsgDPC()
712 VmbusChannelRequestOffers()
715 Send a request to get all our pending offers.
719 VmbusChannelRequestOffers(
724 VMBUS_CHANNEL_MESSAGE_HEADER* msg;
725 VMBUS_CHANNEL_MSGINFO* msgInfo;
729 msgInfo = kmalloc(sizeof(VMBUS_CHANNEL_MSGINFO) + sizeof(VMBUS_CHANNEL_MESSAGE_HEADER), GFP_KERNEL);
730 ASSERT(msgInfo != NULL);
732 msgInfo->WaitEvent = WaitEventCreate();
733 msg = (VMBUS_CHANNEL_MESSAGE_HEADER*)msgInfo->Msg;
735 msg->MessageType = ChannelMessageRequestOffers;
737 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
738 INSERT_TAIL_LIST(&gVmbusConnection.channelMsgList, &msgInfo->msgListEntry);
739 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
741 ret = VmbusPostMessage(msg, sizeof(VMBUS_CHANNEL_MESSAGE_HEADER));
744 DPRINT_ERR(VMBUS, "Unable to request offers - %d", ret);
746 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
747 REMOVE_ENTRY_LIST(&msgInfo->msgListEntry);
748 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
752 //WaitEventWait(msgInfo->waitEvent);
754 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
755 REMOVE_ENTRY_LIST(&msgInfo->msgListEntry);
756 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
762 WaitEventClose(msgInfo->WaitEvent);
774 VmbusChannelReleaseUnattachedChannels()
777 Release channels that are unattached/unconnected ie (no drivers associated)
781 VmbusChannelReleaseUnattachedChannels(
786 VMBUS_CHANNEL *channel;
787 VMBUS_CHANNEL *start=NULL;
789 SpinlockAcquire(gVmbusConnection.ChannelLock);
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 SpinlockRelease(gVmbusConnection.ChannelLock);