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>
24 #include <linux/kernel.h>
28 #include "VmbusPrivate.h"
30 /* Internal routines */
31 static int VmbusChannelCreateGpadlHeader(
32 void * Kbuffer
, /* must be phys and virt contiguous */
33 u32 Size
, /* page-size multiple */
34 struct vmbus_channel_msginfo
**msgInfo
,
37 static void DumpVmbusChannel(struct vmbus_channel
*channel
);
38 static void VmbusChannelSetEvent(struct vmbus_channel
*channel
);
44 struct hv_monitor_page
*MonitorPage
50 DPRINT_DBG(VMBUS
, "monitorPage - %p, trigger state - %d", MonitorPage
, MonitorPage
->TriggerState
);
54 DPRINT_DBG(VMBUS
, "trigger group (%d) - %llx", i
, MonitorPage
->TriggerGroup
[i
].AsUINT64
);
61 DPRINT_DBG(VMBUS
, "latency (%d)(%d) - %llx", i
, j
, MonitorPage
->Latency
[i
][j
]);
68 DPRINT_DBG(VMBUS
, "param-conn id (%d)(%d) - %d", i
, j
, MonitorPage
->Parameter
[i
][j
].ConnectionId
.Asu32
);
69 DPRINT_DBG(VMBUS
, "param-flag (%d)(%d) - %d", i
, j
, MonitorPage
->Parameter
[i
][j
].FlagNumber
);
79 VmbusChannelSetEvent()
82 Trigger an event notification on the specified channel.
85 static void VmbusChannelSetEvent(struct vmbus_channel
*Channel
)
87 struct hv_monitor_page
*monitorPage
;
91 if (Channel
->OfferMsg
.MonitorAllocated
)
93 /* Each u32 represents 32 channels */
94 set_bit(Channel
->OfferMsg
.ChildRelId
& 31,
95 (unsigned long *) gVmbusConnection
.SendInterruptPage
+
96 (Channel
->OfferMsg
.ChildRelId
>> 5) );
98 monitorPage
= (struct hv_monitor_page
*)gVmbusConnection
.MonitorPages
;
99 monitorPage
++; /* Get the child to parent monitor page */
101 set_bit(Channel
->MonitorBit
,
102 (unsigned long *) &monitorPage
->TriggerGroup
[Channel
->MonitorGroup
].Pending
);
107 VmbusSetEvent(Channel
->OfferMsg
.ChildRelId
);
114 static void VmbusChannelClearEvent(struct vmbus_channel
*channel
)
116 struct hv_monitor_page
*monitorPage
;
120 if (Channel
->OfferMsg
.MonitorAllocated
)
122 /* Each u32 represents 32 channels */
123 clear_bit(Channel
->OfferMsg
.ChildRelId
& 31,
124 (unsigned long *) gVmbusConnection
.SendInterruptPage
+ (Channel
->OfferMsg
.ChildRelId
>> 5));
126 monitorPage
= (struct hv_monitor_page
*)gVmbusConnection
.MonitorPages
;
127 monitorPage
++; /* Get the child to parent monitor page */
129 clear_bit(Channel
->MonitorBit
,
130 (unsigned long *) &monitorPage
->TriggerGroup
[Channel
->MonitorGroup
].Pending
);
140 VmbusChannelGetDebugInfo()
143 Retrieve various channel debug info
146 void VmbusChannelGetDebugInfo(struct vmbus_channel
*Channel
,
147 struct vmbus_channel_debug_info
*DebugInfo
)
149 struct hv_monitor_page
*monitorPage
;
150 u8 monitorGroup
= (u8
)Channel
->OfferMsg
.MonitorId
/ 32;
151 u8 monitorOffset
= (u8
)Channel
->OfferMsg
.MonitorId
% 32;
152 /* u32 monitorBit = 1 << monitorOffset; */
154 DebugInfo
->RelId
= Channel
->OfferMsg
.ChildRelId
;
155 DebugInfo
->State
= Channel
->State
;
156 memcpy(&DebugInfo
->InterfaceType
, &Channel
->OfferMsg
.Offer
.InterfaceType
, sizeof(struct hv_guid
));
157 memcpy(&DebugInfo
->InterfaceInstance
, &Channel
->OfferMsg
.Offer
.InterfaceInstance
, sizeof(struct hv_guid
));
159 monitorPage
= (struct hv_monitor_page
*)gVmbusConnection
.MonitorPages
;
161 DebugInfo
->MonitorId
= Channel
->OfferMsg
.MonitorId
;
163 DebugInfo
->ServerMonitorPending
= monitorPage
->TriggerGroup
[monitorGroup
].Pending
;
164 DebugInfo
->ServerMonitorLatency
= monitorPage
->Latency
[monitorGroup
][ monitorOffset
];
165 DebugInfo
->ServerMonitorConnectionId
= monitorPage
->Parameter
[monitorGroup
][ monitorOffset
].ConnectionId
.u
.Id
;
169 DebugInfo
->ClientMonitorPending
= monitorPage
->TriggerGroup
[monitorGroup
].Pending
;
170 DebugInfo
->ClientMonitorLatency
= monitorPage
->Latency
[monitorGroup
][ monitorOffset
];
171 DebugInfo
->ClientMonitorConnectionId
= monitorPage
->Parameter
[monitorGroup
][ monitorOffset
].ConnectionId
.u
.Id
;
173 RingBufferGetDebugInfo(&Channel
->Inbound
, &DebugInfo
->Inbound
);
174 RingBufferGetDebugInfo(&Channel
->Outbound
, &DebugInfo
->Outbound
);
184 Open the specified channel.
187 int VmbusChannelOpen(struct vmbus_channel
*NewChannel
,
188 u32 SendRingBufferSize
,
189 u32 RecvRingBufferSize
,
192 PFN_CHANNEL_CALLBACK pfnOnChannelCallback
,
197 struct vmbus_channel_open_channel
*openMsg
;
198 struct vmbus_channel_msginfo
*openInfo
;
204 /* Aligned to page size */
205 ASSERT(!(SendRingBufferSize
& (PAGE_SIZE
-1)));
206 ASSERT(!(RecvRingBufferSize
& (PAGE_SIZE
-1)));
208 NewChannel
->OnChannelCallback
= pfnOnChannelCallback
;
209 NewChannel
->ChannelCallbackContext
= Context
;
211 /* Allocate the ring buffer */
212 out
= osd_PageAlloc((SendRingBufferSize
+ RecvRingBufferSize
) >> PAGE_SHIFT
);
213 /* out = kzalloc(sendRingBufferSize + recvRingBufferSize, GFP_KERNEL); */
215 ASSERT(((unsigned long)out
& (PAGE_SIZE
-1)) == 0);
217 in
= (void*)((unsigned long)out
+ SendRingBufferSize
);
219 NewChannel
->RingBufferPages
= out
;
220 NewChannel
->RingBufferPageCount
= (SendRingBufferSize
+ RecvRingBufferSize
) >> PAGE_SHIFT
;
222 RingBufferInit(&NewChannel
->Outbound
, out
, SendRingBufferSize
);
224 RingBufferInit(&NewChannel
->Inbound
, in
, RecvRingBufferSize
);
226 /* Establish the gpadl for the ring buffer */
227 DPRINT_DBG(VMBUS
, "Establishing ring buffer's gpadl for channel %p...", NewChannel
);
229 NewChannel
->RingBufferGpadlHandle
= 0;
231 ret
= VmbusChannelEstablishGpadl(NewChannel
,
232 NewChannel
->Outbound
.RingBuffer
,
233 SendRingBufferSize
+ RecvRingBufferSize
,
234 &NewChannel
->RingBufferGpadlHandle
);
236 DPRINT_DBG(VMBUS
, "channel %p <relid %d gpadl 0x%x send ring %p size %d recv ring %p size %d, downstreamoffset %d>",
238 NewChannel
->OfferMsg
.ChildRelId
,
239 NewChannel
->RingBufferGpadlHandle
,
240 NewChannel
->Outbound
.RingBuffer
,
241 NewChannel
->Outbound
.RingSize
,
242 NewChannel
->Inbound
.RingBuffer
,
243 NewChannel
->Inbound
.RingSize
,
246 /* Create and init the channel open message */
247 openInfo
= kmalloc(sizeof(*openInfo
) + sizeof(struct vmbus_channel_open_channel
), GFP_KERNEL
);
248 ASSERT(openInfo
!= NULL
);
250 openInfo
->WaitEvent
= osd_WaitEventCreate();
252 openMsg
= (struct vmbus_channel_open_channel
*)openInfo
->Msg
;
253 openMsg
->Header
.MessageType
= ChannelMessageOpenChannel
;
254 openMsg
->OpenId
= NewChannel
->OfferMsg
.ChildRelId
; /* FIXME */
255 openMsg
->ChildRelId
= NewChannel
->OfferMsg
.ChildRelId
;
256 openMsg
->RingBufferGpadlHandle
= NewChannel
->RingBufferGpadlHandle
;
257 ASSERT(openMsg
->RingBufferGpadlHandle
);
258 openMsg
->DownstreamRingBufferPageOffset
= SendRingBufferSize
>> PAGE_SHIFT
;
259 openMsg
->ServerContextAreaGpadlHandle
= 0; /* TODO */
261 ASSERT(UserDataLen
<= MAX_USER_DEFINED_BYTES
);
264 memcpy(openMsg
->UserData
, UserData
, UserDataLen
);
267 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
268 INSERT_TAIL_LIST(&gVmbusConnection
.ChannelMsgList
, &openInfo
->MsgListEntry
);
269 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
271 DPRINT_DBG(VMBUS
, "Sending channel open msg...");
273 ret
= VmbusPostMessage(openMsg
, sizeof(struct vmbus_channel_open_channel
));
276 DPRINT_ERR(VMBUS
, "unable to open channel - %d", ret
);
280 /* FIXME: Need to time-out here */
281 osd_WaitEventWait(openInfo
->WaitEvent
);
283 if (openInfo
->Response
.OpenResult
.Status
== 0)
285 DPRINT_INFO(VMBUS
, "channel <%p> open success!!", NewChannel
);
289 DPRINT_INFO(VMBUS
, "channel <%p> open failed - %d!!", NewChannel
, openInfo
->Response
.OpenResult
.Status
);
293 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
294 REMOVE_ENTRY_LIST(&openInfo
->MsgListEntry
);
295 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
297 kfree(openInfo
->WaitEvent
);
311 Dump the gpadl body message to the console for debugging purposes.
314 static void DumpGpadlBody(struct vmbus_channel_gpadl_body
*Gpadl
, u32 Len
)
319 pfnCount
= (Len
- sizeof(struct vmbus_channel_gpadl_body
))/ sizeof(u64
);
320 DPRINT_DBG(VMBUS
, "gpadl body - len %d pfn count %d", Len
, pfnCount
);
322 for (i
=0; i
< pfnCount
; i
++)
324 DPRINT_DBG(VMBUS
, "gpadl body - %d) pfn %llu", i
, Gpadl
->Pfn
[i
]);
335 Dump the gpadl header message to the console for debugging purposes.
338 static void DumpGpadlHeader(struct vmbus_channel_gpadl_header
*Gpadl
)
344 DPRINT_DBG(VMBUS
, "gpadl header - relid %d, range count %d, range buflen %d",
348 for (i
=0; i
< Gpadl
->RangeCount
; i
++)
350 pageCount
= Gpadl
->Range
[i
].ByteCount
>> PAGE_SHIFT
;
351 pageCount
= (pageCount
> 26)? 26 : pageCount
;
353 DPRINT_DBG(VMBUS
, "gpadl range %d - len %d offset %d page count %d",
354 i
, Gpadl
->Range
[i
].ByteCount
, Gpadl
->Range
[i
].ByteOffset
, pageCount
);
356 for (j
=0; j
< pageCount
; j
++)
358 DPRINT_DBG(VMBUS
, "%d) pfn %llu", j
, Gpadl
->Range
[i
].PfnArray
[j
]);
366 VmbusChannelCreateGpadlHeader()
369 Creates a gpadl for the specified buffer
373 VmbusChannelCreateGpadlHeader(
374 void * Kbuffer
, /* from kmalloc() */
375 u32 Size
, /* page-size multiple */
376 struct vmbus_channel_msginfo
**MsgInfo
,
381 unsigned long long pfn
;
382 struct vmbus_channel_gpadl_header
*gpaHeader
;
383 struct vmbus_channel_gpadl_body
*gpadlBody
;
384 struct vmbus_channel_msginfo
*msgHeader
;
385 struct vmbus_channel_msginfo
*msgBody
;
388 int pfnSum
, pfnCount
, pfnLeft
, pfnCurr
, pfnSize
;
390 /* ASSERT( (kbuffer & (PAGE_SIZE-1)) == 0); */
391 ASSERT( (Size
& (PAGE_SIZE
-1)) == 0);
393 pageCount
= Size
>> PAGE_SHIFT
;
394 pfn
= virt_to_phys(Kbuffer
) >> PAGE_SHIFT
;
396 /* do we need a gpadl body msg */
397 pfnSize
= MAX_SIZE_CHANNEL_MESSAGE
- sizeof(struct vmbus_channel_gpadl_header
) - sizeof(struct gpa_range
);
398 pfnCount
= pfnSize
/ sizeof(u64
);
400 if (pageCount
> pfnCount
) /* we need a gpadl body */
402 /* fill in the header */
403 msgSize
= sizeof(struct vmbus_channel_msginfo
) + sizeof(struct vmbus_channel_gpadl_header
) + sizeof(struct gpa_range
) + pfnCount
*sizeof(u64
);
404 msgHeader
= kzalloc(msgSize
, GFP_KERNEL
);
406 INITIALIZE_LIST_HEAD(&msgHeader
->SubMsgList
);
407 msgHeader
->MessageSize
=msgSize
;
409 gpaHeader
= (struct vmbus_channel_gpadl_header
*)msgHeader
->Msg
;
410 gpaHeader
->RangeCount
= 1;
411 gpaHeader
->RangeBufLen
= sizeof(struct gpa_range
) + pageCount
*sizeof(u64
);
412 gpaHeader
->Range
[0].ByteOffset
= 0;
413 gpaHeader
->Range
[0].ByteCount
= Size
;
414 for (i
=0; i
<pfnCount
; i
++)
416 gpaHeader
->Range
[0].PfnArray
[i
] = pfn
+i
;
418 *MsgInfo
= msgHeader
;
422 pfnLeft
= pageCount
- pfnCount
;
424 /* how many pfns can we fit */
425 pfnSize
= MAX_SIZE_CHANNEL_MESSAGE
- sizeof(struct vmbus_channel_gpadl_body
);
426 pfnCount
= pfnSize
/ sizeof(u64
);
428 /* fill in the body */
431 if (pfnLeft
> pfnCount
)
440 msgSize
= sizeof(struct vmbus_channel_msginfo
) + sizeof(struct vmbus_channel_gpadl_body
) + pfnCurr
*sizeof(u64
);
441 msgBody
= kzalloc(msgSize
, GFP_KERNEL
);
443 msgBody
->MessageSize
= msgSize
;
445 gpadlBody
= (struct vmbus_channel_gpadl_body
*)msgBody
->Msg
;
447 /* FIXME: Gpadl is u32 and we are using a pointer which could be 64-bit */
448 /* gpadlBody->Gpadl = kbuffer; */
449 for (i
=0; i
<pfnCurr
; i
++)
451 gpadlBody
->Pfn
[i
] = pfn
+ pfnSum
+ i
;
454 /* add to msg header */
455 INSERT_TAIL_LIST(&msgHeader
->SubMsgList
, &msgBody
->MsgListEntry
);
462 /* everything fits in a header */
463 msgSize
= sizeof(struct vmbus_channel_msginfo
) + sizeof(struct vmbus_channel_gpadl_header
) + sizeof(struct gpa_range
) + pageCount
*sizeof(u64
);
464 msgHeader
= kzalloc(msgSize
, GFP_KERNEL
);
465 msgHeader
->MessageSize
=msgSize
;
467 gpaHeader
= (struct vmbus_channel_gpadl_header
*)msgHeader
->Msg
;
468 gpaHeader
->RangeCount
= 1;
469 gpaHeader
->RangeBufLen
= sizeof(struct gpa_range
) + pageCount
*sizeof(u64
);
470 gpaHeader
->Range
[0].ByteOffset
= 0;
471 gpaHeader
->Range
[0].ByteCount
= Size
;
472 for (i
=0; i
<pageCount
; i
++)
474 gpaHeader
->Range
[0].PfnArray
[i
] = pfn
+i
;
477 *MsgInfo
= msgHeader
;
488 VmbusChannelEstablishGpadl()
491 Estabish a GPADL for the specified buffer
494 int VmbusChannelEstablishGpadl(struct vmbus_channel
*Channel
,
495 void * Kbuffer
, /* from kmalloc() */
496 u32 Size
, /* page-size multiple */
501 struct vmbus_channel_gpadl_header
*gpadlMsg
;
502 struct vmbus_channel_gpadl_body
*gpadlBody
;
503 /* struct vmbus_channel_gpadl_created *gpadlCreated; */
505 struct vmbus_channel_msginfo
*msgInfo
;
506 struct vmbus_channel_msginfo
*subMsgInfo
;
516 nextGpadlHandle
= atomic_read(&gVmbusConnection
.NextGpadlHandle
);
517 atomic_inc(&gVmbusConnection
.NextGpadlHandle
);
519 VmbusChannelCreateGpadlHeader(Kbuffer
, Size
, &msgInfo
, &msgCount
);
520 ASSERT(msgInfo
!= NULL
);
523 msgInfo
->WaitEvent
= osd_WaitEventCreate();
524 gpadlMsg
= (struct vmbus_channel_gpadl_header
*)msgInfo
->Msg
;
525 gpadlMsg
->Header
.MessageType
= ChannelMessageGpadlHeader
;
526 gpadlMsg
->ChildRelId
= Channel
->OfferMsg
.ChildRelId
;
527 gpadlMsg
->Gpadl
= nextGpadlHandle
;
529 DumpGpadlHeader(gpadlMsg
);
531 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
532 INSERT_TAIL_LIST(&gVmbusConnection
.ChannelMsgList
, &msgInfo
->MsgListEntry
);
533 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
535 DPRINT_DBG(VMBUS
, "buffer %p, size %d msg cnt %d", Kbuffer
, Size
, msgCount
);
537 DPRINT_DBG(VMBUS
, "Sending GPADL Header - len %zd", msgInfo
->MessageSize
- sizeof(*msgInfo
));
539 ret
= VmbusPostMessage(gpadlMsg
, msgInfo
->MessageSize
- sizeof(*msgInfo
));
542 DPRINT_ERR(VMBUS
, "Unable to open channel - %d", ret
);
548 ITERATE_LIST_ENTRIES(anchor
, curr
, &msgInfo
->SubMsgList
)
550 subMsgInfo
= (struct vmbus_channel_msginfo
*)curr
;
551 gpadlBody
= (struct vmbus_channel_gpadl_body
*)subMsgInfo
->Msg
;
553 gpadlBody
->Header
.MessageType
= ChannelMessageGpadlBody
;
554 gpadlBody
->Gpadl
= nextGpadlHandle
;
556 DPRINT_DBG(VMBUS
, "Sending GPADL Body - len %zd", subMsgInfo
->MessageSize
- sizeof(*subMsgInfo
));
558 DumpGpadlBody(gpadlBody
, subMsgInfo
->MessageSize
- sizeof(*subMsgInfo
));
559 ret
= VmbusPostMessage(gpadlBody
, subMsgInfo
->MessageSize
- sizeof(*subMsgInfo
));
563 osd_WaitEventWait(msgInfo
->WaitEvent
);
565 /* At this point, we received the gpadl created msg */
566 DPRINT_DBG(VMBUS
, "Received GPADL created (relid %d, status %d handle %x)",
567 Channel
->OfferMsg
.ChildRelId
,
568 msgInfo
->Response
.GpadlCreated
.CreationStatus
,
571 *GpadlHandle
= gpadlMsg
->Gpadl
;
574 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
575 REMOVE_ENTRY_LIST(&msgInfo
->MsgListEntry
);
576 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
578 kfree(msgInfo
->WaitEvent
);
591 VmbusChannelTeardownGpadl()
594 Teardown the specified GPADL handle
597 int VmbusChannelTeardownGpadl(struct vmbus_channel
*Channel
, u32 GpadlHandle
)
600 struct vmbus_channel_gpadl_teardown
*msg
;
601 struct vmbus_channel_msginfo
*info
;
606 ASSERT(GpadlHandle
!= 0);
608 info
= kmalloc(sizeof(*info
) + sizeof(struct vmbus_channel_gpadl_teardown
), GFP_KERNEL
);
609 ASSERT(info
!= NULL
);
611 info
->WaitEvent
= osd_WaitEventCreate();
613 msg
= (struct vmbus_channel_gpadl_teardown
*)info
->Msg
;
615 msg
->Header
.MessageType
= ChannelMessageGpadlTeardown
;
616 msg
->ChildRelId
= Channel
->OfferMsg
.ChildRelId
;
617 msg
->Gpadl
= GpadlHandle
;
619 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
620 INSERT_TAIL_LIST(&gVmbusConnection
.ChannelMsgList
, &info
->MsgListEntry
);
621 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
623 ret
= VmbusPostMessage(msg
, sizeof(struct vmbus_channel_gpadl_teardown
));
629 osd_WaitEventWait(info
->WaitEvent
);
631 /* Received a torndown response */
632 spin_lock_irqsave(&gVmbusConnection
.channelmsg_lock
, flags
);
633 REMOVE_ENTRY_LIST(&info
->MsgListEntry
);
634 spin_unlock_irqrestore(&gVmbusConnection
.channelmsg_lock
, flags
);
636 kfree(info
->WaitEvent
);
651 Close the specified channel
654 void VmbusChannelClose(struct vmbus_channel
*Channel
)
657 struct vmbus_channel_close_channel
*msg
;
658 struct vmbus_channel_msginfo
*info
;
663 /* Stop callback and cancel the timer asap */
664 Channel
->OnChannelCallback
= NULL
;
665 del_timer(&Channel
->poll_timer
);
667 /* Send a closing message */
668 info
= kmalloc(sizeof(*info
) + sizeof(struct vmbus_channel_close_channel
), GFP_KERNEL
);
669 ASSERT(info
!= NULL
);
671 /* info->waitEvent = osd_WaitEventCreate(); */
673 msg
= (struct vmbus_channel_close_channel
*)info
->Msg
;
674 msg
->Header
.MessageType
= ChannelMessageCloseChannel
;
675 msg
->ChildRelId
= Channel
->OfferMsg
.ChildRelId
;
677 ret
= VmbusPostMessage(msg
, sizeof(struct vmbus_channel_close_channel
));
683 /* Tear down the gpadl for the channel's ring buffer */
684 if (Channel
->RingBufferGpadlHandle
)
686 VmbusChannelTeardownGpadl(Channel
, Channel
->RingBufferGpadlHandle
);
689 /* TODO: Send a msg to release the childRelId */
691 /* Cleanup the ring buffers for this channel */
692 RingBufferCleanup(&Channel
->Outbound
);
693 RingBufferCleanup(&Channel
->Inbound
);
695 osd_PageFree(Channel
->RingBufferPages
, Channel
->RingBufferPageCount
);
701 * If we are closing the channel during an error path in
702 * opening the channel, don't free the channel since the
703 * caller will free the channel
706 if (Channel
->State
== CHANNEL_OPEN_STATE
)
708 spin_lock_irqsave(&gVmbusConnection
.channel_lock
, flags
);
709 REMOVE_ENTRY_LIST(&Channel
->ListEntry
);
710 spin_unlock_irqrestore(&gVmbusConnection
.channel_lock
, flags
);
712 FreeVmbusChannel(Channel
);
722 VmbusChannelSendPacket()
725 Send the specified buffer on the given channel
728 int VmbusChannelSendPacket(struct vmbus_channel
*Channel
,
732 enum vmbus_packet_type Type
,
737 struct vmpacket_descriptor desc
;
738 u32 packetLen
= sizeof(struct vmpacket_descriptor
) + BufferLen
;
739 u32 packetLenAligned
= ALIGN_UP(packetLen
, sizeof(u64
));
740 struct scatterlist bufferList
[3];
744 DPRINT_DBG(VMBUS
, "channel %p buffer %p len %d", Channel
, Buffer
, BufferLen
);
746 DumpVmbusChannel(Channel
);
748 ASSERT((packetLenAligned
- packetLen
) < sizeof(u64
));
750 /* Setup the descriptor */
751 desc
.Type
= Type
; /* VmbusPacketTypeDataInBand; */
752 desc
.Flags
= Flags
; /* VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED; */
753 desc
.DataOffset8
= sizeof(struct vmpacket_descriptor
) >> 3; /* in 8-bytes granularity */
754 desc
.Length8
= (u16
)(packetLenAligned
>> 3);
755 desc
.TransactionId
= RequestId
;
757 sg_init_table(bufferList
,3);
758 sg_set_buf(&bufferList
[0], &desc
, sizeof(struct vmpacket_descriptor
));
759 sg_set_buf(&bufferList
[1], Buffer
, BufferLen
);
760 sg_set_buf(&bufferList
[2], &alignedData
, packetLenAligned
- packetLen
);
762 ret
= RingBufferWrite(
767 /* TODO: We should determine if this is optional */
768 if (ret
== 0 && !GetRingBufferInterruptMask(&Channel
->Outbound
))
770 VmbusChannelSetEvent(Channel
);
782 VmbusChannelSendPacketPageBuffer()
785 Send a range of single-page buffer packets using a GPADL Direct packet type.
788 int VmbusChannelSendPacketPageBuffer(struct vmbus_channel
*Channel
,
789 struct hv_page_buffer PageBuffers
[],
798 struct VMBUS_CHANNEL_PACKET_PAGE_BUFFER desc
;
801 u32 packetLenAligned
;
802 struct scatterlist bufferList
[3];
807 ASSERT(PageCount
<= MAX_PAGE_BUFFER_COUNT
);
809 DumpVmbusChannel(Channel
);
811 /* Adjust the size down since VMBUS_CHANNEL_PACKET_PAGE_BUFFER is the largest size we support */
812 descSize
= sizeof(struct VMBUS_CHANNEL_PACKET_PAGE_BUFFER
) - ((MAX_PAGE_BUFFER_COUNT
- PageCount
)*sizeof(struct hv_page_buffer
));
813 packetLen
= descSize
+ BufferLen
;
814 packetLenAligned
= ALIGN_UP(packetLen
, sizeof(u64
));
816 ASSERT((packetLenAligned
- packetLen
) < sizeof(u64
));
818 /* Setup the descriptor */
819 desc
.Type
= VmbusPacketTypeDataUsingGpaDirect
;
820 desc
.Flags
= VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED
;
821 desc
.DataOffset8
= descSize
>> 3; /* in 8-bytes grandularity */
822 desc
.Length8
= (u16
)(packetLenAligned
>> 3);
823 desc
.TransactionId
= RequestId
;
824 desc
.RangeCount
= PageCount
;
826 for (i
=0; i
<PageCount
; i
++)
828 desc
.Range
[i
].Length
= PageBuffers
[i
].Length
;
829 desc
.Range
[i
].Offset
= PageBuffers
[i
].Offset
;
830 desc
.Range
[i
].Pfn
= PageBuffers
[i
].Pfn
;
833 sg_init_table(bufferList
,3);
834 sg_set_buf(&bufferList
[0], &desc
, descSize
);
835 sg_set_buf(&bufferList
[1], Buffer
, BufferLen
);
836 sg_set_buf(&bufferList
[2], &alignedData
, packetLenAligned
- packetLen
);
838 ret
= RingBufferWrite(
843 /* TODO: We should determine if this is optional */
844 if (ret
== 0 && !GetRingBufferInterruptMask(&Channel
->Outbound
))
846 VmbusChannelSetEvent(Channel
);
859 VmbusChannelSendPacketMultiPageBuffer()
862 Send a multi-page buffer packet using a GPADL Direct packet type.
865 int VmbusChannelSendPacketMultiPageBuffer(struct vmbus_channel
*Channel
,
866 struct hv_multipage_buffer
*MultiPageBuffer
,
873 struct VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER desc
;
876 u32 packetLenAligned
;
877 struct scatterlist bufferList
[3];
879 u32 PfnCount
= NUM_PAGES_SPANNED(MultiPageBuffer
->Offset
, MultiPageBuffer
->Length
);
883 DumpVmbusChannel(Channel
);
885 DPRINT_DBG(VMBUS
, "data buffer - offset %u len %u pfn count %u", MultiPageBuffer
->Offset
, MultiPageBuffer
->Length
, PfnCount
);
887 ASSERT(PfnCount
> 0);
888 ASSERT(PfnCount
<= MAX_MULTIPAGE_BUFFER_COUNT
);
890 /* Adjust the size down since VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER is the largest size we support */
891 descSize
= sizeof(struct VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER
) - ((MAX_MULTIPAGE_BUFFER_COUNT
- PfnCount
)*sizeof(u64
));
892 packetLen
= descSize
+ BufferLen
;
893 packetLenAligned
= ALIGN_UP(packetLen
, sizeof(u64
));
895 ASSERT((packetLenAligned
- packetLen
) < sizeof(u64
));
897 /* Setup the descriptor */
898 desc
.Type
= VmbusPacketTypeDataUsingGpaDirect
;
899 desc
.Flags
= VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED
;
900 desc
.DataOffset8
= descSize
>> 3; /* in 8-bytes grandularity */
901 desc
.Length8
= (u16
)(packetLenAligned
>> 3);
902 desc
.TransactionId
= RequestId
;
905 desc
.Range
.Length
= MultiPageBuffer
->Length
;
906 desc
.Range
.Offset
= MultiPageBuffer
->Offset
;
908 memcpy(desc
.Range
.PfnArray
, MultiPageBuffer
->PfnArray
, PfnCount
*sizeof(u64
));
910 sg_init_table(bufferList
,3);
911 sg_set_buf(&bufferList
[0], &desc
, descSize
);
912 sg_set_buf(&bufferList
[1], Buffer
, BufferLen
);
913 sg_set_buf(&bufferList
[2], &alignedData
, packetLenAligned
- packetLen
);
915 ret
= RingBufferWrite(
920 /* TODO: We should determine if this is optional */
921 if (ret
== 0 && !GetRingBufferInterruptMask(&Channel
->Outbound
))
923 VmbusChannelSetEvent(Channel
);
935 VmbusChannelRecvPacket()
938 Retrieve the user packet on the specified channel
941 /* TODO: Do we ever receive a gpa direct packet other than the ones we send ? */
942 int VmbusChannelRecvPacket(struct vmbus_channel
*Channel
,
945 u32
*BufferActualLen
,
948 struct vmpacket_descriptor desc
;
956 *BufferActualLen
= 0;
959 spin_lock_irqsave(&Channel
->inbound_lock
, flags
);
961 ret
= RingBufferPeek(&Channel
->Inbound
, &desc
, sizeof(struct vmpacket_descriptor
));
964 spin_unlock_irqrestore(&Channel
->inbound_lock
, flags
);
966 /* DPRINT_DBG(VMBUS, "nothing to read!!"); */
971 /* VmbusChannelClearEvent(Channel); */
973 packetLen
= desc
.Length8
<< 3;
974 userLen
= packetLen
- (desc
.DataOffset8
<< 3);
975 /* ASSERT(userLen > 0); */
977 DPRINT_DBG(VMBUS
, "packet received on channel %p relid %d <type %d flag %d tid %llx pktlen %d datalen %d> ",
979 Channel
->OfferMsg
.ChildRelId
,
982 desc
.TransactionId
, packetLen
, userLen
);
984 *BufferActualLen
= userLen
;
986 if (userLen
> BufferLen
)
988 spin_unlock_irqrestore(&Channel
->inbound_lock
, flags
);
990 DPRINT_ERR(VMBUS
, "buffer too small - got %d needs %d", BufferLen
, userLen
);
996 *RequestId
= desc
.TransactionId
;
998 /* Copy over the packet to the user buffer */
999 ret
= RingBufferRead(&Channel
->Inbound
, Buffer
, userLen
, (desc
.DataOffset8
<< 3));
1001 spin_unlock_irqrestore(&Channel
->inbound_lock
, flags
);
1011 VmbusChannelRecvPacketRaw()
1014 Retrieve the raw packet on the specified channel
1017 int VmbusChannelRecvPacketRaw(struct vmbus_channel
*Channel
,
1020 u32
* BufferActualLen
,
1024 struct vmpacket_descriptor desc
;
1028 unsigned long flags
;
1030 DPRINT_ENTER(VMBUS
);
1032 *BufferActualLen
= 0;
1035 spin_lock_irqsave(&Channel
->inbound_lock
, flags
);
1037 ret
= RingBufferPeek(&Channel
->Inbound
, &desc
, sizeof(struct vmpacket_descriptor
));
1040 spin_unlock_irqrestore(&Channel
->inbound_lock
, flags
);
1042 /* DPRINT_DBG(VMBUS, "nothing to read!!"); */
1047 /* VmbusChannelClearEvent(Channel); */
1049 packetLen
= desc
.Length8
<< 3;
1050 userLen
= packetLen
- (desc
.DataOffset8
<< 3);
1052 DPRINT_DBG(VMBUS
, "packet received on channel %p relid %d <type %d flag %d tid %llx pktlen %d datalen %d> ",
1054 Channel
->OfferMsg
.ChildRelId
,
1057 desc
.TransactionId
, packetLen
, userLen
);
1059 *BufferActualLen
= packetLen
;
1061 if (packetLen
> BufferLen
)
1063 spin_unlock_irqrestore(&Channel
->inbound_lock
, flags
);
1065 DPRINT_ERR(VMBUS
, "buffer too small - needed %d bytes but got space for only %d bytes", packetLen
, BufferLen
);
1070 *RequestId
= desc
.TransactionId
;
1072 /* Copy over the entire packet to the user buffer */
1073 ret
= RingBufferRead(&Channel
->Inbound
, Buffer
, packetLen
, 0);
1075 spin_unlock_irqrestore(&Channel
->inbound_lock
, flags
);
1086 VmbusChannelOnChannelEvent()
1089 Channel event callback
1092 void VmbusChannelOnChannelEvent(struct vmbus_channel
*Channel
)
1094 DumpVmbusChannel(Channel
);
1095 ASSERT(Channel
->OnChannelCallback
);
1096 #ifdef ENABLE_POLLING
1097 del_timer(&Channel
->poll_timer
);
1098 Channel
->OnChannelCallback(Channel
->ChannelCallbackContext
);
1099 channel
->poll_timer
.expires(jiffies
+ usecs_to_jiffies(100);
1100 add_timer(&channel
->poll_timer
);
1102 Channel
->OnChannelCallback(Channel
->ChannelCallbackContext
);
1109 VmbusChannelOnTimer()
1112 Timer event callback
1115 void VmbusChannelOnTimer(unsigned long data
)
1117 struct vmbus_channel
*channel
= (struct vmbus_channel
*)data
;
1119 if (channel
->OnChannelCallback
)
1121 channel
->OnChannelCallback(channel
->ChannelCallbackContext
);
1122 #ifdef ENABLE_POLLING
1123 channel
->poll_timer
.expires(jiffies
+ usecs_to_jiffies(100);
1124 add_timer(&channel
->poll_timer
);
1136 Dump vmbus channel info to the console
1139 static void DumpVmbusChannel(struct vmbus_channel
*Channel
)
1141 DPRINT_DBG(VMBUS
, "Channel (%d)", Channel
->OfferMsg
.ChildRelId
);
1142 DumpRingInfo(&Channel
->Outbound
, "Outbound ");
1143 DumpRingInfo(&Channel
->Inbound
, "Inbound ");