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 <linux/kernel.h>
29 #include "VmbusPrivate.h"
33 typedef void (*PFN_CHANNEL_MESSAGE_HANDLER
)(struct vmbus_channel_message_header
*msg
);
35 typedef struct _VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY
{
36 enum vmbus_channel_message_type messageType
;
37 PFN_CHANNEL_MESSAGE_HANDLER messageHandler
;
38 } VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY
;
40 /* Internal routines */
41 static void VmbusChannelOnOffer(struct vmbus_channel_message_header
*hdr
);
42 static void VmbusChannelOnOpenResult(struct vmbus_channel_message_header
*hdr
);
43 static void VmbusChannelOnOfferRescind(struct vmbus_channel_message_header
*hdr
);
44 static void VmbusChannelOnGpadlCreated(struct vmbus_channel_message_header
*hdr
);
45 static void VmbusChannelOnGpadlTorndown(struct vmbus_channel_message_header
*hdr
);
46 static void VmbusChannelOnOffersDelivered(struct vmbus_channel_message_header
*hdr
);
47 static void VmbusChannelOnVersionResponse(struct vmbus_channel_message_header
*hdr
);
48 static void VmbusChannelProcessOffer(void * context
);
49 static void VmbusChannelProcessRescindOffer(void * context
);
54 #define MAX_NUM_DEVICE_CLASSES_SUPPORTED 4
56 static const struct hv_guid gSupportedDeviceClasses
[MAX_NUM_DEVICE_CLASSES_SUPPORTED
] = {
57 /* {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f} */
61 0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d,
62 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f
66 /* {F8615163-DF3E-46c5-913F-F2D2F965ED0E} */
70 0x63, 0x51, 0x61, 0xF8, 0x3E, 0xDF, 0xc5, 0x46,
71 0x91, 0x3F, 0xF2, 0xD2, 0xF9, 0x65, 0xED, 0x0E
75 /* {CFA8B69E-5B4A-4cc0-B98B-8BA1A1F3F95A} */
79 0x9E, 0xB6, 0xA8, 0xCF, 0x4A, 0x5B, 0xc0, 0x4c,
80 0xB9, 0x8B, 0x8B, 0xA1, 0xA1, 0xF3, 0xF9, 0x5A
84 /* {32412632-86cb-44a2-9b5c-50d1417354f5} */
88 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44,
89 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5
94 /* Channel message dispatch table */
95 static VMBUS_CHANNEL_MESSAGE_TABLE_ENTRY gChannelMessageTable
[ChannelMessageCount
]= {
96 {ChannelMessageInvalid
, NULL
},
97 {ChannelMessageOfferChannel
, VmbusChannelOnOffer
},
98 {ChannelMessageRescindChannelOffer
, VmbusChannelOnOfferRescind
},
99 {ChannelMessageRequestOffers
, NULL
},
100 {ChannelMessageAllOffersDelivered
, VmbusChannelOnOffersDelivered
},
101 {ChannelMessageOpenChannel
, NULL
},
102 {ChannelMessageOpenChannelResult
, VmbusChannelOnOpenResult
},
103 {ChannelMessageCloseChannel
, NULL
},
104 {ChannelMessageGpadlHeader
, NULL
},
105 {ChannelMessageGpadlBody
, NULL
},
106 {ChannelMessageGpadlCreated
, VmbusChannelOnGpadlCreated
},
107 {ChannelMessageGpadlTeardown
, NULL
},
108 {ChannelMessageGpadlTorndown
, VmbusChannelOnGpadlTorndown
},
109 {ChannelMessageRelIdReleased
, NULL
},
110 {ChannelMessageInitiateContact
, NULL
},
111 {ChannelMessageVersionResponse
, VmbusChannelOnVersionResponse
},
112 {ChannelMessageUnload
, NULL
},
121 Allocate and initialize a vmbus channel object
124 struct vmbus_channel
*AllocVmbusChannel(void)
126 struct vmbus_channel
*channel
;
128 channel
= kzalloc(sizeof(*channel
), GFP_ATOMIC
);
134 spin_lock_init(&channel
->inbound_lock
);
136 init_timer(&channel
->poll_timer
);
137 channel
->poll_timer
.data
= (unsigned long)channel
;
138 channel
->poll_timer
.function
= VmbusChannelOnTimer
;
140 /* channel->dataWorkQueue = WorkQueueCreate("data"); */
141 channel
->ControlWQ
= create_workqueue("hv_vmbus_ctl");
142 if (!channel
->ControlWQ
)
154 ReleaseVmbusChannel()
157 Release the vmbus channel object itself
160 static inline void ReleaseVmbusChannel(void* Context
)
162 struct vmbus_channel
*channel
= Context
;
166 DPRINT_DBG(VMBUS
, "releasing channel (%p)", channel
);
167 destroy_workqueue(channel
->ControlWQ
);
168 DPRINT_DBG(VMBUS
, "channel released (%p)", channel
);
181 Release the resources used by the vmbus channel object
184 void FreeVmbusChannel(struct vmbus_channel
*Channel
)
186 del_timer(&Channel
->poll_timer
);
188 /* We have to release the channel's workqueue/thread in the vmbus's workqueue/thread context */
189 /* ie we can't destroy ourselves. */
190 osd_schedule_callback(gVmbusConnection
.WorkQueue
, ReleaseVmbusChannel
,
198 VmbusChannelProcessOffer()
201 Process the offer by creating a channel/device associated with this offer
205 VmbusChannelProcessOffer(
210 struct vmbus_channel
*newChannel
= context
;
211 struct vmbus_channel
*channel
;
219 /* Make sure this is a new offer */
220 spin_lock_irqsave(&gVmbusConnection
.channel_lock
, flags
);
222 ITERATE_LIST_ENTRIES(anchor
, curr
, &gVmbusConnection
.ChannelList
)
224 channel
= CONTAINING_RECORD(curr
, struct vmbus_channel
, ListEntry
);
226 if (!memcmp(&channel
->OfferMsg
.Offer
.InterfaceType
, &newChannel
->OfferMsg
.Offer
.InterfaceType
,sizeof(struct hv_guid
)) &&
227 !memcmp(&channel
->OfferMsg
.Offer
.InterfaceInstance
, &newChannel
->OfferMsg
.Offer
.InterfaceInstance
, sizeof(struct hv_guid
)))
236 INSERT_TAIL_LIST(&gVmbusConnection
.ChannelList
, &newChannel
->ListEntry
);
238 spin_unlock_irqrestore(&gVmbusConnection
.channel_lock
, flags
);
242 DPRINT_DBG(VMBUS
, "Ignoring duplicate offer for relid (%d)", newChannel
->OfferMsg
.ChildRelId
);
243 FreeVmbusChannel(newChannel
);
248 /* Start the process of binding this offer to the driver */
249 /* We need to set the DeviceObject field before calling VmbusChildDeviceAdd() */
250 newChannel
->DeviceObject
= VmbusChildDeviceCreate(
251 &newChannel
->OfferMsg
.Offer
.InterfaceType
,
252 &newChannel
->OfferMsg
.Offer
.InterfaceInstance
,
255 DPRINT_DBG(VMBUS
, "child device object allocated - %p", newChannel
->DeviceObject
);
258 * Add the new device to the bus. This will kick off device-driver
259 * binding which eventually invokes the device driver's AddDevice()
263 ret
= VmbusChildDeviceAdd(newChannel
->DeviceObject
);
266 DPRINT_ERR(VMBUS
, "unable to add child device object (relid %d)",
267 newChannel
->OfferMsg
.ChildRelId
);
269 spin_lock_irqsave(&gVmbusConnection
.channel_lock
, flags
);
270 REMOVE_ENTRY_LIST(&newChannel
->ListEntry
);
271 spin_unlock_irqrestore(&gVmbusConnection
.channel_lock
, flags
);
273 FreeVmbusChannel(newChannel
);
278 * This state is used to indicate a successful open
279 * so that when we do close the channel normally, we
280 * can cleanup properly
282 newChannel
->State
= CHANNEL_OPEN_STATE
;
290 VmbusChannelProcessRescindOffer()
293 Rescind the offer by initiating a device removal
297 VmbusChannelProcessRescindOffer(
301 struct vmbus_channel
*channel
= context
;
305 VmbusChildDeviceRemove(channel
->DeviceObject
);
314 VmbusChannelOnOffer()
317 Handler for channel offers from vmbus in parent partition. We ignore all offers except
318 network and storage offers. For each network and storage offers, we create a channel object
319 and queue a work item to the channel object to process the offer synchronously
322 static void VmbusChannelOnOffer(struct vmbus_channel_message_header
*hdr
)
324 struct vmbus_channel_offer_channel
*offer
= (struct vmbus_channel_offer_channel
*)hdr
;
325 struct vmbus_channel
*newChannel
;
327 struct hv_guid
*guidType
;
328 struct hv_guid
*guidInstance
;
334 for (i
=0; i
<MAX_NUM_DEVICE_CLASSES_SUPPORTED
; i
++)
336 if (memcmp(&offer
->Offer
.InterfaceType
, &gSupportedDeviceClasses
[i
], sizeof(struct hv_guid
)) == 0)
345 DPRINT_DBG(VMBUS
, "Ignoring channel offer notification for child relid %d", offer
->ChildRelId
);
351 guidType
= &offer
->Offer
.InterfaceType
;
352 guidInstance
= &offer
->Offer
.InterfaceInstance
;
354 DPRINT_INFO(VMBUS
, "Channel offer notification - child relid %d monitor id %d allocated %d, "
355 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x%02x%02x} "
356 "instance {%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x%02x%02x}",
359 offer
->MonitorAllocated
,
360 guidType
->data
[3], guidType
->data
[2], guidType
->data
[1], guidType
->data
[0],
361 guidType
->data
[5], guidType
->data
[4], guidType
->data
[7], guidType
->data
[6],
362 guidType
->data
[8], guidType
->data
[9], guidType
->data
[10], guidType
->data
[11],
363 guidType
->data
[12], guidType
->data
[13], guidType
->data
[14], guidType
->data
[15],
364 guidInstance
->data
[3], guidInstance
->data
[2], guidInstance
->data
[1], guidInstance
->data
[0],
365 guidInstance
->data
[5], guidInstance
->data
[4], guidInstance
->data
[7], guidInstance
->data
[6],
366 guidInstance
->data
[8], guidInstance
->data
[9], guidInstance
->data
[10], guidInstance
->data
[11],
367 guidInstance
->data
[12], guidInstance
->data
[13], guidInstance
->data
[14], guidInstance
->data
[15]);
369 /* Allocate the channel object and save this offer. */
370 newChannel
= AllocVmbusChannel();
373 DPRINT_ERR(VMBUS
, "unable to allocate channel object");
377 DPRINT_DBG(VMBUS
, "channel object allocated - %p", newChannel
);
379 memcpy(&newChannel
->OfferMsg
, offer
, sizeof(struct vmbus_channel_offer_channel
));
380 newChannel
->MonitorGroup
= (u8
)offer
->MonitorId
/ 32;
381 newChannel
->MonitorBit
= (u8
)offer
->MonitorId
% 32;
383 /* TODO: Make sure the offer comes from our parent partition */
384 osd_schedule_callback(newChannel
->ControlWQ
, VmbusChannelProcessOffer
,
394 VmbusChannelOnOfferRescind()
397 Rescind offer handler. We queue a work item to process this offer
401 static void VmbusChannelOnOfferRescind(struct vmbus_channel_message_header
*hdr
)
403 struct vmbus_channel_rescind_offer
*rescind
= (struct vmbus_channel_rescind_offer
*)hdr
;
404 struct vmbus_channel
*channel
;
408 channel
= GetChannelFromRelId(rescind
->ChildRelId
);
411 DPRINT_DBG(VMBUS
, "channel not found for relId %d", rescind
->ChildRelId
);
415 osd_schedule_callback(channel
->ControlWQ
,
416 VmbusChannelProcessRescindOffer
,
426 VmbusChannelOnOffersDelivered()
429 This is invoked when all offers have been delivered.
433 static void VmbusChannelOnOffersDelivered(struct vmbus_channel_message_header
*hdr
)
443 VmbusChannelOnOpenResult()
446 Open result handler. This is invoked when we received a response
447 to our channel open request. Find the matching request, copy the
448 response and signal the requesting thread.
451 static void VmbusChannelOnOpenResult(struct vmbus_channel_message_header
*hdr
)
453 struct vmbus_channel_open_result
*result
= (struct vmbus_channel_open_result
*)hdr
;
456 struct vmbus_channel_msginfo
*msgInfo
;
457 struct vmbus_channel_message_header
*requestHeader
;
458 struct vmbus_channel_open_channel
*openMsg
;
463 DPRINT_DBG(VMBUS
, "vmbus open result - %d", result
->Status
);
465 /* Find the open msg, copy the result and signal/unblock the wait event */
466 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
468 ITERATE_LIST_ENTRIES(anchor
, curr
, &gVmbusConnection
.ChannelMsgList
)
470 msgInfo
= (struct vmbus_channel_msginfo
*)curr
;
471 requestHeader
= (struct vmbus_channel_message_header
*)msgInfo
->Msg
;
473 if (requestHeader
->MessageType
== ChannelMessageOpenChannel
)
475 openMsg
= (struct vmbus_channel_open_channel
*)msgInfo
->Msg
;
476 if (openMsg
->ChildRelId
== result
->ChildRelId
&&
477 openMsg
->OpenId
== result
->OpenId
)
479 memcpy(&msgInfo
->Response
.OpenResult
, result
, sizeof(struct vmbus_channel_open_result
));
480 osd_WaitEventSet(msgInfo
->WaitEvent
);
485 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
494 VmbusChannelOnGpadlCreated()
497 GPADL created handler. This is invoked when we received a response
498 to our gpadl create request. Find the matching request, copy the
499 response and signal the requesting thread.
502 static void VmbusChannelOnGpadlCreated(struct vmbus_channel_message_header
*hdr
)
504 struct vmbus_channel_gpadl_created
*gpadlCreated
= (struct vmbus_channel_gpadl_created
*)hdr
;
507 struct vmbus_channel_msginfo
*msgInfo
;
508 struct vmbus_channel_message_header
*requestHeader
;
509 struct vmbus_channel_gpadl_header
*gpadlHeader
;
514 DPRINT_DBG(VMBUS
, "vmbus gpadl created result - %d", gpadlCreated
->CreationStatus
);
516 /* Find the establish msg, copy the result and signal/unblock the wait event */
517 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
519 ITERATE_LIST_ENTRIES(anchor
, curr
, &gVmbusConnection
.ChannelMsgList
)
521 msgInfo
= (struct vmbus_channel_msginfo
*)curr
;
522 requestHeader
= (struct vmbus_channel_message_header
*)msgInfo
->Msg
;
524 if (requestHeader
->MessageType
== ChannelMessageGpadlHeader
)
526 gpadlHeader
= (struct vmbus_channel_gpadl_header
*)requestHeader
;
528 if ((gpadlCreated
->ChildRelId
== gpadlHeader
->ChildRelId
) &&
529 (gpadlCreated
->Gpadl
== gpadlHeader
->Gpadl
))
531 memcpy(&msgInfo
->Response
.GpadlCreated
, gpadlCreated
, sizeof(struct vmbus_channel_gpadl_created
));
532 osd_WaitEventSet(msgInfo
->WaitEvent
);
537 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
546 VmbusChannelOnGpadlTorndown()
549 GPADL torndown handler. This is invoked when we received a response
550 to our gpadl teardown request. Find the matching request, copy the
551 response and signal the requesting thread.
554 static void VmbusChannelOnGpadlTorndown(struct vmbus_channel_message_header
*hdr
)
556 struct vmbus_channel_gpadl_torndown
* gpadlTorndown
= (struct vmbus_channel_gpadl_torndown
*)hdr
;
559 struct vmbus_channel_msginfo
*msgInfo
;
560 struct vmbus_channel_message_header
*requestHeader
;
561 struct vmbus_channel_gpadl_teardown
*gpadlTeardown
;
566 /* Find the open msg, copy the result and signal/unblock the wait event */
567 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
569 ITERATE_LIST_ENTRIES(anchor
, curr
, &gVmbusConnection
.ChannelMsgList
)
571 msgInfo
= (struct vmbus_channel_msginfo
*)curr
;
572 requestHeader
= (struct vmbus_channel_message_header
*)msgInfo
->Msg
;
574 if (requestHeader
->MessageType
== ChannelMessageGpadlTeardown
)
576 gpadlTeardown
= (struct vmbus_channel_gpadl_teardown
*)requestHeader
;
578 if (gpadlTorndown
->Gpadl
== gpadlTeardown
->Gpadl
)
580 memcpy(&msgInfo
->Response
.GpadlTorndown
, gpadlTorndown
, sizeof(struct vmbus_channel_gpadl_torndown
));
581 osd_WaitEventSet(msgInfo
->WaitEvent
);
586 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
595 VmbusChannelOnVersionResponse()
598 Version response handler. This is invoked when we received a response
599 to our initiate contact request. Find the matching request, copy the
600 response and signal the requesting thread.
603 static void VmbusChannelOnVersionResponse(struct vmbus_channel_message_header
*hdr
)
607 struct vmbus_channel_msginfo
*msgInfo
;
608 struct vmbus_channel_message_header
*requestHeader
;
609 struct vmbus_channel_initiate_contact
*initiate
;
610 struct vmbus_channel_version_response
*versionResponse
= (struct vmbus_channel_version_response
*)hdr
;
615 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
617 ITERATE_LIST_ENTRIES(anchor
, curr
, &gVmbusConnection
.ChannelMsgList
)
619 msgInfo
= (struct vmbus_channel_msginfo
*)curr
;
620 requestHeader
= (struct vmbus_channel_message_header
*)msgInfo
->Msg
;
622 if (requestHeader
->MessageType
== ChannelMessageInitiateContact
)
624 initiate
= (struct vmbus_channel_initiate_contact
*)requestHeader
;
625 memcpy(&msgInfo
->Response
.VersionResponse
, versionResponse
, sizeof(struct vmbus_channel_version_response
));
626 osd_WaitEventSet(msgInfo
->WaitEvent
);
629 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
638 VmbusOnChannelMessage()
641 Handler for channel protocol messages.
642 This is invoked in the vmbus worker thread context.
645 void VmbusOnChannelMessage(void *Context
)
647 struct hv_message
*msg
= Context
;
648 struct vmbus_channel_message_header
*hdr
;
653 hdr
= (struct vmbus_channel_message_header
*)msg
->u
.Payload
;
654 size
=msg
->Header
.PayloadSize
;
656 DPRINT_DBG(VMBUS
, "message type %d size %d", hdr
->MessageType
, size
);
658 if (hdr
->MessageType
>= ChannelMessageCount
)
660 DPRINT_ERR(VMBUS
, "Received invalid channel message type %d size %d", hdr
->MessageType
, size
);
661 print_hex_dump_bytes("", DUMP_PREFIX_NONE
,
662 (unsigned char *)msg
->u
.Payload
, size
);
667 if (gChannelMessageTable
[hdr
->MessageType
].messageHandler
)
669 gChannelMessageTable
[hdr
->MessageType
].messageHandler(hdr
);
673 DPRINT_ERR(VMBUS
, "Unhandled channel message type %d", hdr
->MessageType
);
676 /* Free the msg that was allocated in VmbusOnMsgDPC() */
685 VmbusChannelRequestOffers()
688 Send a request to get all our pending offers.
691 int VmbusChannelRequestOffers(void)
694 struct vmbus_channel_message_header
*msg
;
695 struct vmbus_channel_msginfo
*msgInfo
;
699 msgInfo
= kmalloc(sizeof(*msgInfo
) + sizeof(struct vmbus_channel_message_header
), GFP_KERNEL
);
700 ASSERT(msgInfo
!= NULL
);
702 msgInfo
->WaitEvent
= osd_WaitEventCreate();
703 msg
= (struct vmbus_channel_message_header
*)msgInfo
->Msg
;
705 msg
->MessageType
= ChannelMessageRequestOffers
;
707 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
708 INSERT_TAIL_LIST(&gVmbusConnection.channelMsgList, &msgInfo->msgListEntry);
709 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
711 ret
= VmbusPostMessage(msg
, sizeof(struct vmbus_channel_message_header
));
714 DPRINT_ERR(VMBUS
, "Unable to request offers - %d", ret
);
716 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
717 REMOVE_ENTRY_LIST(&msgInfo->msgListEntry);
718 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
722 /* osd_WaitEventWait(msgInfo->waitEvent); */
724 /*SpinlockAcquire(gVmbusConnection.channelMsgLock);
725 REMOVE_ENTRY_LIST(&msgInfo->msgListEntry);
726 SpinlockRelease(gVmbusConnection.channelMsgLock);*/
732 kfree(msgInfo
->WaitEvent
);
744 VmbusChannelReleaseUnattachedChannels()
747 Release channels that are unattached/unconnected ie (no drivers associated)
750 void VmbusChannelReleaseUnattachedChannels(void)
753 struct vmbus_channel
*channel
;
754 struct vmbus_channel
*start
= NULL
;
757 spin_lock_irqsave(&gVmbusConnection
.channel_lock
, flags
);
759 while (!IsListEmpty(&gVmbusConnection
.ChannelList
))
761 entry
= TOP_LIST_ENTRY(&gVmbusConnection
.ChannelList
);
762 channel
= CONTAINING_RECORD(entry
, struct vmbus_channel
, ListEntry
);
764 if (channel
== start
)
767 if (!channel
->DeviceObject
->Driver
)
769 REMOVE_ENTRY_LIST(&channel
->ListEntry
);
770 DPRINT_INFO(VMBUS
, "Releasing unattached device object %p", channel
->DeviceObject
);
772 VmbusChildDeviceRemove(channel
->DeviceObject
);
773 FreeVmbusChannel(channel
);
784 spin_unlock_irqrestore(&gVmbusConnection
.channel_lock
, flags
);