drivers/staging/hv/Channel.c

   1 /*
   2  * Copyright (c) 2009, Microsoft Corporation.
   3  *
   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.
   7  *
   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
  11  * more details.
  12  *
  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.
  16  *
  17  * Authors:
  18  *   Haiyang Zhang <haiyangz@microsoft.com>
  19  *   Hank Janssen  <hjanssen@microsoft.com>
  20  */
  21 #include <linux/kernel.h>
  22 #include <linux/mm.h>
  23 #include <linux/slab.h>
  24 #include <linux/module.h>
  25 #include "osd.h"
  26 #include "logging.h"
  27 #include "VmbusPrivate.h"
  28
  29 /* Internal routines */
  30 static int VmbusChannelCreateGpadlHeader(
  31         void *Kbuffer,  /* must be phys and virt contiguous */
  32         u32 Size,       /* page-size multiple */
  33         struct vmbus_channel_msginfo **msgInfo,
  34         u32 *MessageCount);
  35 static void DumpVmbusChannel(struct vmbus_channel *channel);
  36 static void VmbusChannelSetEvent(struct vmbus_channel *channel);
  37
  38
  39 #if 0
  40 static void DumpMonitorPage(struct hv_monitor_page *MonitorPage)
  41 {
  42         int i = 0;
  43         int j = 0;
  44
  45         DPRINT_DBG(VMBUS, "monitorPage - %p, trigger state - %d",
  46                    MonitorPage, MonitorPage->TriggerState);
  47
  48         for (i = 0; i < 4; i++)
  49                 DPRINT_DBG(VMBUS, "trigger group (%d) - %llx", i,
  50                            MonitorPage->TriggerGroup[i].AsUINT64);
  51
  52         for (i = 0; i < 4; i++) {
  53                 for (j = 0; j < 32; j++) {
  54                         DPRINT_DBG(VMBUS, "latency (%d)(%d) - %llx", i, j,
  55                                    MonitorPage->Latency[i][j]);
  56                 }
  57         }
  58         for (i = 0; i < 4; i++) {
  59                 for (j = 0; j < 32; j++) {
  60                         DPRINT_DBG(VMBUS, "param-conn id (%d)(%d) - %d", i, j,
  61                                MonitorPage->Parameter[i][j].ConnectionId.Asu32);
  62                         DPRINT_DBG(VMBUS, "param-flag (%d)(%d) - %d", i, j,
  63                                 MonitorPage->Parameter[i][j].FlagNumber);
  64                 }
  65         }
  66 }
  67 #endif
  68
  69 /*
  70  * VmbusChannelSetEvent - Trigger an event notification on the specified
  71  * channel.
  72  */
  73 static void VmbusChannelSetEvent(struct vmbus_channel *Channel)
  74 {
  75         struct hv_monitor_page *monitorPage;
  76
  77         DPRINT_ENTER(VMBUS);
  78
  79         if (Channel->OfferMsg.MonitorAllocated) {
  80                 /* Each u32 represents 32 channels */
  81                 set_bit(Channel->OfferMsg.ChildRelId & 31,
  82                         (unsigned long *) gVmbusConnection.SendInterruptPage +
  83                         (Channel->OfferMsg.ChildRelId >> 5));
  84
  85                 monitorPage = gVmbusConnection.MonitorPages;
  86                 monitorPage++; /* Get the child to parent monitor page */
  87
  88                 set_bit(Channel->MonitorBit,
  89                         (unsigned long *)&monitorPage->TriggerGroup
  90                                         [Channel->MonitorGroup].Pending);
  91
  92         } else {
  93                 VmbusSetEvent(Channel->OfferMsg.ChildRelId);
  94         }
  95
  96         DPRINT_EXIT(VMBUS);
  97 }
  98
  99 #if 0
 100 static void VmbusChannelClearEvent(struct vmbus_channel *channel)
 101 {
 102         struct hv_monitor_page *monitorPage;
 103
 104         DPRINT_ENTER(VMBUS);
 105
 106         if (Channel->OfferMsg.MonitorAllocated) {
 107                 /* Each u32 represents 32 channels */
 108                 clear_bit(Channel->OfferMsg.ChildRelId & 31,
 109                           (unsigned long *)gVmbusConnection.SendInterruptPage +
 110                           (Channel->OfferMsg.ChildRelId >> 5));
 111
 112                 monitorPage =
 113                         (struct hv_monitor_page *)gVmbusConnection.MonitorPages;
 114                 monitorPage++; /* Get the child to parent monitor page */
 115
 116                 clear_bit(Channel->MonitorBit,
 117                           (unsigned long *)&monitorPage->TriggerGroup
 118                                         [Channel->MonitorGroup].Pending);
 119         }
 120
 121         DPRINT_EXIT(VMBUS);
 122 }
 123
 124 #endif
 125 /*
 126  * VmbusChannelGetDebugInfo -Retrieve various channel debug info
 127  */
 128 void VmbusChannelGetDebugInfo(struct vmbus_channel *Channel,
 129                               struct vmbus_channel_debug_info *DebugInfo)
 130 {
 131         struct hv_monitor_page *monitorPage;
 132         u8 monitorGroup = (u8)Channel->OfferMsg.MonitorId / 32;
 133         u8 monitorOffset = (u8)Channel->OfferMsg.MonitorId % 32;
 134         /* u32 monitorBit       = 1 << monitorOffset; */
 135
 136         DebugInfo->RelId = Channel->OfferMsg.ChildRelId;
 137         DebugInfo->State = Channel->State;
 138         memcpy(&DebugInfo->InterfaceType,
 139                &Channel->OfferMsg.Offer.InterfaceType, sizeof(struct hv_guid));
 140         memcpy(&DebugInfo->InterfaceInstance,
 141                &Channel->OfferMsg.Offer.InterfaceInstance,
 142                sizeof(struct hv_guid));
 143
 144         monitorPage = (struct hv_monitor_page *)gVmbusConnection.MonitorPages;
 145
 146         DebugInfo->MonitorId = Channel->OfferMsg.MonitorId;
 147
 148         DebugInfo->ServerMonitorPending =
 149                         monitorPage->TriggerGroup[monitorGroup].Pending;
 150         DebugInfo->ServerMonitorLatency =
 151                         monitorPage->Latency[monitorGroup][monitorOffset];
 152         DebugInfo->ServerMonitorConnectionId =
 153                         monitorPage->Parameter[monitorGroup]
 154                                               [monitorOffset].ConnectionId.u.Id;
 155
 156         monitorPage++;
 157
 158         DebugInfo->ClientMonitorPending =
 159                         monitorPage->TriggerGroup[monitorGroup].Pending;
 160         DebugInfo->ClientMonitorLatency =
 161                         monitorPage->Latency[monitorGroup][monitorOffset];
 162         DebugInfo->ClientMonitorConnectionId =
 163                         monitorPage->Parameter[monitorGroup]
 164                                               [monitorOffset].ConnectionId.u.Id;
 165
 166         RingBufferGetDebugInfo(&Channel->Inbound, &DebugInfo->Inbound);
 167         RingBufferGetDebugInfo(&Channel->Outbound, &DebugInfo->Outbound);
 168 }
 169
 170 /*
 171  * VmbusChannelOpen - Open the specified channel.
 172  */
 173 int VmbusChannelOpen(struct vmbus_channel *NewChannel, u32 SendRingBufferSize,
 174                      u32 RecvRingBufferSize, void *UserData, u32 UserDataLen,
 175                      void (*OnChannelCallback)(void *context), void *Context)
 176 {
 177         struct vmbus_channel_open_channel *openMsg;
 178         struct vmbus_channel_msginfo *openInfo;
 179         void *in, *out;
 180         unsigned long flags;
 181         int ret;
 182
 183         DPRINT_ENTER(VMBUS);
 184
 185         /* Aligned to page size */
 186         ASSERT(!(SendRingBufferSize & (PAGE_SIZE - 1)));
 187         ASSERT(!(RecvRingBufferSize & (PAGE_SIZE - 1)));
 188
 189         NewChannel->OnChannelCallback = OnChannelCallback;
 190         NewChannel->ChannelCallbackContext = Context;
 191
 192         /* Allocate the ring buffer */
 193         out = osd_PageAlloc((SendRingBufferSize + RecvRingBufferSize)
 194                              >> PAGE_SHIFT);
 195         ASSERT(out);
 196         ASSERT(((unsigned long)out & (PAGE_SIZE-1)) == 0);
 197
 198         in = (void *)((unsigned long)out + SendRingBufferSize);
 199
 200         NewChannel->RingBufferPages = out;
 201         NewChannel->RingBufferPageCount = (SendRingBufferSize +
 202                                            RecvRingBufferSize) >> PAGE_SHIFT;
 203
 204         RingBufferInit(&NewChannel->Outbound, out, SendRingBufferSize);
 205
 206         RingBufferInit(&NewChannel->Inbound, in, RecvRingBufferSize);
 207
 208         /* Establish the gpadl for the ring buffer */
 209         DPRINT_DBG(VMBUS, "Establishing ring buffer's gpadl for channel %p...",
 210                    NewChannel);
 211
 212         NewChannel->RingBufferGpadlHandle = 0;
 213
 214         ret = VmbusChannelEstablishGpadl(NewChannel,
 215                                          NewChannel->Outbound.RingBuffer,
 216                                          SendRingBufferSize +
 217                                          RecvRingBufferSize,
 218                                          &NewChannel->RingBufferGpadlHandle);
 219
 220         DPRINT_DBG(VMBUS, "channel %p <relid %d gpadl 0x%x send ring %p "
 221                    "size %d recv ring %p size %d, downstreamoffset %d>",
 222                    NewChannel, NewChannel->OfferMsg.ChildRelId,
 223                    NewChannel->RingBufferGpadlHandle,
 224                    NewChannel->Outbound.RingBuffer,
 225                    NewChannel->Outbound.RingSize,
 226                    NewChannel->Inbound.RingBuffer,
 227                    NewChannel->Inbound.RingSize,
 228                    SendRingBufferSize);
 229
 230         /* Create and init the channel open message */
 231         openInfo = kmalloc(sizeof(*openInfo) +
 232                            sizeof(struct vmbus_channel_open_channel),
 233                            GFP_KERNEL);
 234         ASSERT(openInfo != NULL);
 235
 236         openInfo->WaitEvent = osd_WaitEventCreate();
 237
 238         openMsg = (struct vmbus_channel_open_channel *)openInfo->Msg;
 239         openMsg->Header.MessageType = ChannelMessageOpenChannel;
 240         openMsg->OpenId = NewChannel->OfferMsg.ChildRelId; /* FIXME */
 241         openMsg->ChildRelId = NewChannel->OfferMsg.ChildRelId;
 242         openMsg->RingBufferGpadlHandle = NewChannel->RingBufferGpadlHandle;
 243         ASSERT(openMsg->RingBufferGpadlHandle);
 244         openMsg->DownstreamRingBufferPageOffset = SendRingBufferSize >>
 245                                                   PAGE_SHIFT;
 246         openMsg->ServerContextAreaGpadlHandle = 0; /* TODO */
 247
 248         ASSERT(UserDataLen <= MAX_USER_DEFINED_BYTES);
 249         if (UserDataLen)
 250                 memcpy(openMsg->UserData, UserData, UserDataLen);
 251
 252         spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
 253         list_add_tail(&openInfo->MsgListEntry,
 254                       &gVmbusConnection.ChannelMsgList);
 255         spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
 256
 257         DPRINT_DBG(VMBUS, "Sending channel open msg...");
 258
 259         ret = VmbusPostMessage(openMsg,
 260                                sizeof(struct vmbus_channel_open_channel));
 261         if (ret != 0) {
 262                 DPRINT_ERR(VMBUS, "unable to open channel - %d", ret);
 263                 goto Cleanup;
 264         }
 265
 266         /* FIXME: Need to time-out here */
 267         osd_WaitEventWait(openInfo->WaitEvent);
 268
 269         if (openInfo->Response.OpenResult.Status == 0)
 270                 DPRINT_INFO(VMBUS, "channel <%p> open success!!", NewChannel);
 271         else
 272                 DPRINT_INFO(VMBUS, "channel <%p> open failed - %d!!",
 273                             NewChannel, openInfo->Response.OpenResult.Status);
 274
 275 Cleanup:
 276         spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
 277         list_del(&openInfo->MsgListEntry);
 278         spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
 279
 280         kfree(openInfo->WaitEvent);
 281         kfree(openInfo);
 282
 283         DPRINT_EXIT(VMBUS);
 284
 285         return 0;
 286 }
 287
 288 /*
 289  * DumpGpadlBody - Dump the gpadl body message to the console for
 290  * debugging purposes.
 291  */
 292 static void DumpGpadlBody(struct vmbus_channel_gpadl_body *Gpadl, u32 Len)
 293 {
 294         int i;
 295         int pfnCount;
 296
 297         pfnCount = (Len - sizeof(struct vmbus_channel_gpadl_body)) /
 298                    sizeof(u64);
 299         DPRINT_DBG(VMBUS, "gpadl body - len %d pfn count %d", Len, pfnCount);
 300
 301         for (i = 0; i < pfnCount; i++)
 302                 DPRINT_DBG(VMBUS, "gpadl body  - %d) pfn %llu",
 303                            i, Gpadl->Pfn[i]);
 304 }
 305
 306 /*
 307  * DumpGpadlHeader - Dump the gpadl header message to the console for
 308  * debugging purposes.
 309  */
 310 static void DumpGpadlHeader(struct vmbus_channel_gpadl_header *Gpadl)
 311 {
 312         int i, j;
 313         int pageCount;
 314
 315         DPRINT_DBG(VMBUS,
 316                    "gpadl header - relid %d, range count %d, range buflen %d",
 317                    Gpadl->ChildRelId, Gpadl->RangeCount, Gpadl->RangeBufLen);
 318         for (i = 0; i < Gpadl->RangeCount; i++) {
 319                 pageCount = Gpadl->Range[i].ByteCount >> PAGE_SHIFT;
 320                 pageCount = (pageCount > 26) ? 26 : pageCount;
 321
 322                 DPRINT_DBG(VMBUS, "gpadl range %d - len %d offset %d "
 323                            "page count %d", i, Gpadl->Range[i].ByteCount,
 324                            Gpadl->Range[i].ByteOffset, pageCount);
 325
 326                 for (j = 0; j < pageCount; j++)
 327                         DPRINT_DBG(VMBUS, "%d) pfn %llu", j,
 328                                    Gpadl->Range[i].PfnArray[j]);
 329         }
 330 }
 331
 332 /*
 333  * VmbusChannelCreateGpadlHeader - Creates a gpadl for the specified buffer
 334  */
 335 static int VmbusChannelCreateGpadlHeader(void *Kbuffer, u32 Size,
 336                                          struct vmbus_channel_msginfo **MsgInfo,
 337                                          u32 *MessageCount)
 338 {
 339         int i;
 340         int pageCount;
 341         unsigned long long pfn;
 342         struct vmbus_channel_gpadl_header *gpaHeader;
 343         struct vmbus_channel_gpadl_body *gpadlBody;
 344         struct vmbus_channel_msginfo *msgHeader;
 345         struct vmbus_channel_msginfo *msgBody;
 346         u32 msgSize;
 347
 348         int pfnSum, pfnCount, pfnLeft, pfnCurr, pfnSize;
 349
 350         /* ASSERT((kbuffer & (PAGE_SIZE-1)) == 0); */
 351         ASSERT((Size & (PAGE_SIZE-1)) == 0);
 352
 353         pageCount = Size >> PAGE_SHIFT;
 354         pfn = virt_to_phys(Kbuffer) >> PAGE_SHIFT;
 355
 356         /* do we need a gpadl body msg */
 357         pfnSize = MAX_SIZE_CHANNEL_MESSAGE -
 358                   sizeof(struct vmbus_channel_gpadl_header) -
 359                   sizeof(struct gpa_range);
 360         pfnCount = pfnSize / sizeof(u64);
 361
 362         if (pageCount > pfnCount) {
 363                 /* we need a gpadl body */
 364                 /* fill in the header */
 365                 msgSize = sizeof(struct vmbus_channel_msginfo) +
 366                           sizeof(struct vmbus_channel_gpadl_header) +
 367                           sizeof(struct gpa_range) + pfnCount * sizeof(u64);
 368                 msgHeader =  kzalloc(msgSize, GFP_KERNEL);
 369
 370                 INIT_LIST_HEAD(&msgHeader->SubMsgList);
 371                 msgHeader->MessageSize = msgSize;
 372
 373                 gpaHeader = (struct vmbus_channel_gpadl_header *)msgHeader->Msg;
 374                 gpaHeader->RangeCount = 1;
 375                 gpaHeader->RangeBufLen = sizeof(struct gpa_range) +
 376                                          pageCount * sizeof(u64);
 377                 gpaHeader->Range[0].ByteOffset = 0;
 378                 gpaHeader->Range[0].ByteCount = Size;
 379                 for (i = 0; i < pfnCount; i++)
 380                         gpaHeader->Range[0].PfnArray[i] = pfn+i;
 381                 *MsgInfo = msgHeader;
 382                 *MessageCount = 1;
 383
 384                 pfnSum = pfnCount;
 385                 pfnLeft = pageCount - pfnCount;
 386
 387                 /* how many pfns can we fit */
 388                 pfnSize = MAX_SIZE_CHANNEL_MESSAGE -
 389                           sizeof(struct vmbus_channel_gpadl_body);
 390                 pfnCount = pfnSize / sizeof(u64);
 391
 392                 /* fill in the body */
 393                 while (pfnLeft) {
 394                         if (pfnLeft > pfnCount)
 395                                 pfnCurr = pfnCount;
 396                         else
 397                                 pfnCurr = pfnLeft;
 398
 399                         msgSize = sizeof(struct vmbus_channel_msginfo) +
 400                                   sizeof(struct vmbus_channel_gpadl_body) +
 401                                   pfnCurr * sizeof(u64);
 402                         msgBody = kzalloc(msgSize, GFP_KERNEL);
 403                         ASSERT(msgBody);
 404                         msgBody->MessageSize = msgSize;
 405                         (*MessageCount)++;
 406                         gpadlBody =
 407                                 (struct vmbus_channel_gpadl_body *)msgBody->Msg;
 408
 409                         /*
 410                          * FIXME:
 411                          * Gpadl is u32 and we are using a pointer which could
 412                          * be 64-bit
 413                          */
 414                         /* gpadlBody->Gpadl = kbuffer; */
 415                         for (i = 0; i < pfnCurr; i++)
 416                                 gpadlBody->Pfn[i] = pfn + pfnSum + i;
 417
 418                         /* add to msg header */
 419                         list_add_tail(&msgBody->MsgListEntry,
 420                                       &msgHeader->SubMsgList);
 421                         pfnSum += pfnCurr;
 422                         pfnLeft -= pfnCurr;
 423                 }
 424         } else {
 425                 /* everything fits in a header */
 426                 msgSize = sizeof(struct vmbus_channel_msginfo) +
 427                           sizeof(struct vmbus_channel_gpadl_header) +
 428                           sizeof(struct gpa_range) + pageCount * sizeof(u64);
 429                 msgHeader = kzalloc(msgSize, GFP_KERNEL);
 430                 msgHeader->MessageSize = msgSize;
 431
 432                 gpaHeader = (struct vmbus_channel_gpadl_header *)msgHeader->Msg;
 433                 gpaHeader->RangeCount = 1;
 434                 gpaHeader->RangeBufLen = sizeof(struct gpa_range) +
 435                                          pageCount * sizeof(u64);
 436                 gpaHeader->Range[0].ByteOffset = 0;
 437                 gpaHeader->Range[0].ByteCount = Size;
 438                 for (i = 0; i < pageCount; i++)
 439                         gpaHeader->Range[0].PfnArray[i] = pfn+i;
 440
 441                 *MsgInfo = msgHeader;
 442                 *MessageCount = 1;
 443         }
 444
 445         return 0;
 446 }
 447
 448 /*
 449  * VmbusChannelEstablishGpadl - Estabish a GPADL for the specified buffer
 450  *
 451  * @Channel: a channel
 452  * @Kbuffer: from kmalloc
 453  * @Size: page-size multiple
 454  * @GpadlHandle: some funky thing
 455  */
 456 int VmbusChannelEstablishGpadl(struct vmbus_channel *Channel, void *Kbuffer,
 457                                u32 Size, u32 *GpadlHandle)
 458 {
 459         struct vmbus_channel_gpadl_header *gpadlMsg;
 460         struct vmbus_channel_gpadl_body *gpadlBody;
 461         /* struct vmbus_channel_gpadl_created *gpadlCreated; */
 462         struct vmbus_channel_msginfo *msgInfo;
 463         struct vmbus_channel_msginfo *subMsgInfo;
 464         u32 msgCount;
 465         struct list_head *curr;
 466         u32 nextGpadlHandle;
 467         unsigned long flags;
 468         int ret;
 469
 470         DPRINT_ENTER(VMBUS);
 471
 472         nextGpadlHandle = atomic_read(&gVmbusConnection.NextGpadlHandle);
 473         atomic_inc(&gVmbusConnection.NextGpadlHandle);
 474
 475         VmbusChannelCreateGpadlHeader(Kbuffer, Size, &msgInfo, &msgCount);
 476         ASSERT(msgInfo != NULL);
 477         ASSERT(msgCount > 0);
 478
 479         msgInfo->WaitEvent = osd_WaitEventCreate();
 480         gpadlMsg = (struct vmbus_channel_gpadl_header *)msgInfo->Msg;
 481         gpadlMsg->Header.MessageType = ChannelMessageGpadlHeader;
 482         gpadlMsg->ChildRelId = Channel->OfferMsg.ChildRelId;
 483         gpadlMsg->Gpadl = nextGpadlHandle;
 484
 485         DumpGpadlHeader(gpadlMsg);
 486
 487         spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
 488         list_add_tail(&msgInfo->MsgListEntry,
 489                       &gVmbusConnection.ChannelMsgList);
 490
 491         spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
 492         DPRINT_DBG(VMBUS, "buffer %p, size %d msg cnt %d",
 493                    Kbuffer, Size, msgCount);
 494
 495         DPRINT_DBG(VMBUS, "Sending GPADL Header - len %zd",
 496                    msgInfo->MessageSize - sizeof(*msgInfo));
 497
 498         ret = VmbusPostMessage(gpadlMsg, msgInfo->MessageSize -
 499                                sizeof(*msgInfo));
 500         if (ret != 0) {
 501                 DPRINT_ERR(VMBUS, "Unable to open channel - %d", ret);
 502                 goto Cleanup;
 503         }
 504
 505         if (msgCount > 1) {
 506                 list_for_each(curr, &msgInfo->SubMsgList) {
 507
 508                         /* FIXME: should this use list_entry() instead ? */
 509                         subMsgInfo = (struct vmbus_channel_msginfo *)curr;
 510                         gpadlBody =
 511                              (struct vmbus_channel_gpadl_body *)subMsgInfo->Msg;
 512
 513                         gpadlBody->Header.MessageType = ChannelMessageGpadlBody;
 514                         gpadlBody->Gpadl = nextGpadlHandle;
 515
 516                         DPRINT_DBG(VMBUS, "Sending GPADL Body - len %zd",
 517                                    subMsgInfo->MessageSize -
 518                                    sizeof(*subMsgInfo));
 519
 520                         DumpGpadlBody(gpadlBody, subMsgInfo->MessageSize -
 521                                       sizeof(*subMsgInfo));
 522                         ret = VmbusPostMessage(gpadlBody,
 523                                                subMsgInfo->MessageSize -
 524                                                sizeof(*subMsgInfo));
 525                         ASSERT(ret == 0);
 526                 }
 527         }
 528         osd_WaitEventWait(msgInfo->WaitEvent);
 529
 530         /* At this point, we received the gpadl created msg */
 531         DPRINT_DBG(VMBUS, "Received GPADL created "
 532                    "(relid %d, status %d handle %x)",
 533                    Channel->OfferMsg.ChildRelId,
 534                    msgInfo->Response.GpadlCreated.CreationStatus,
 535                    gpadlMsg->Gpadl);
 536
 537         *GpadlHandle = gpadlMsg->Gpadl;
 538
 539 Cleanup:
 540         spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
 541         list_del(&msgInfo->MsgListEntry);
 542         spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
 543
 544         kfree(msgInfo->WaitEvent);
 545         kfree(msgInfo);
 546
 547         DPRINT_EXIT(VMBUS);
 548
 549         return ret;
 550 }
 551
 552 /*
 553  * VmbusChannelTeardownGpadl -Teardown the specified GPADL handle
 554  */
 555 int VmbusChannelTeardownGpadl(struct vmbus_channel *Channel, u32 GpadlHandle)
 556 {
 557         struct vmbus_channel_gpadl_teardown *msg;
 558         struct vmbus_channel_msginfo *info;
 559         unsigned long flags;
 560         int ret;
 561
 562         DPRINT_ENTER(VMBUS);
 563
 564         ASSERT(GpadlHandle != 0);
 565
 566         info = kmalloc(sizeof(*info) +
 567                        sizeof(struct vmbus_channel_gpadl_teardown), GFP_KERNEL);
 568         ASSERT(info != NULL);
 569
 570         info->WaitEvent = osd_WaitEventCreate();
 571
 572         msg = (struct vmbus_channel_gpadl_teardown *)info->Msg;
 573
 574         msg->Header.MessageType = ChannelMessageGpadlTeardown;
 575         msg->ChildRelId = Channel->OfferMsg.ChildRelId;
 576         msg->Gpadl = GpadlHandle;
 577
 578         spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
 579         list_add_tail(&info->MsgListEntry,
 580                       &gVmbusConnection.ChannelMsgList);
 581         spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
 582
 583         ret = VmbusPostMessage(msg,
 584                                sizeof(struct vmbus_channel_gpadl_teardown));
 585         if (ret != 0) {
 586                 /* TODO: */
 587                 /* something... */
 588         }
 589
 590         osd_WaitEventWait(info->WaitEvent);
 591
 592         /* Received a torndown response */
 593         spin_lock_irqsave(&gVmbusConnection.channelmsg_lock, flags);
 594         list_del(&info->MsgListEntry);
 595         spin_unlock_irqrestore(&gVmbusConnection.channelmsg_lock, flags);
 596
 597         kfree(info->WaitEvent);
 598         kfree(info);
 599
 600         DPRINT_EXIT(VMBUS);
 601
 602         return ret;
 603 }
 604
 605 /*
 606  * VmbusChannelClose - Close the specified channel
 607  */
 608 void VmbusChannelClose(struct vmbus_channel *Channel)
 609 {
 610         struct vmbus_channel_close_channel *msg;
 611         struct vmbus_channel_msginfo *info;
 612         unsigned long flags;
 613         int ret;
 614
 615         DPRINT_ENTER(VMBUS);
 616
 617         /* Stop callback and cancel the timer asap */
 618         Channel->OnChannelCallback = NULL;
 619         del_timer_sync(&Channel->poll_timer);
 620
 621         /* Send a closing message */
 622         info = kmalloc(sizeof(*info) +
 623                        sizeof(struct vmbus_channel_close_channel), GFP_KERNEL);
 624         ASSERT(info != NULL);
 625
 626         /* info->waitEvent = osd_WaitEventCreate(); */
 627
 628         msg = (struct vmbus_channel_close_channel *)info->Msg;
 629         msg->Header.MessageType = ChannelMessageCloseChannel;
 630         msg->ChildRelId = Channel->OfferMsg.ChildRelId;
 631
 632         ret = VmbusPostMessage(msg, sizeof(struct vmbus_channel_close_channel));
 633         if (ret != 0) {
 634                 /* TODO: */
 635                 /* something... */
 636         }
 637
 638         /* Tear down the gpadl for the channel's ring buffer */
 639         if (Channel->RingBufferGpadlHandle)
 640                 VmbusChannelTeardownGpadl(Channel,
 641                                           Channel->RingBufferGpadlHandle);
 642
 643         /* TODO: Send a msg to release the childRelId */
 644
 645         /* Cleanup the ring buffers for this channel */
 646         RingBufferCleanup(&Channel->Outbound);
 647         RingBufferCleanup(&Channel->Inbound);
 648
 649         osd_PageFree(Channel->RingBufferPages, Channel->RingBufferPageCount);
 650
 651         kfree(info);
 652
 653         /*
 654          * If we are closing the channel during an error path in
 655          * opening the channel, don't free the channel since the
 656          * caller will free the channel
 657          */
 658
 659         if (Channel->State == CHANNEL_OPEN_STATE) {
 660                 spin_lock_irqsave(&gVmbusConnection.channel_lock, flags);
 661                 list_del(&Channel->ListEntry);
 662                 spin_unlock_irqrestore(&gVmbusConnection.channel_lock, flags);
 663
 664                 FreeVmbusChannel(Channel);
 665         }
 666
 667         DPRINT_EXIT(VMBUS);
 668 }
 669
 670 /**
 671  * VmbusChannelSendPacket() - Send the specified buffer on the given channel
 672  * @Channel: Pointer to vmbus_channel structure.
 673  * @Buffer: Pointer to the buffer you want to receive the data into.
 674  * @BufferLen: Maximum size of what the the buffer will hold
 675  * @RequestId: Identifier of the request
 676  * @vmbus_packet_type: Type of packet that is being send e.g. negotiate, time
 677  * packet etc.
 678  *
 679  * Sends data in @Buffer directly to hyper-v via the vmbus
 680  * This will send the data unparsed to hyper-v.
 681  *
 682  * Mainly used by Hyper-V drivers.
 683  */
 684 int VmbusChannelSendPacket(struct vmbus_channel *Channel, const void *Buffer,
 685                            u32 BufferLen, u64 RequestId,
 686                            enum vmbus_packet_type Type, u32 Flags)
 687 {
 688         struct vmpacket_descriptor desc;
 689         u32 packetLen = sizeof(struct vmpacket_descriptor) + BufferLen;
 690         u32 packetLenAligned = ALIGN_UP(packetLen, sizeof(u64));
 691         struct scatterlist bufferList[3];
 692         u64 alignedData = 0;
 693         int ret;
 694
 695         DPRINT_ENTER(VMBUS);
 696         DPRINT_DBG(VMBUS, "channel %p buffer %p len %d",
 697                    Channel, Buffer, BufferLen);
 698
 699         DumpVmbusChannel(Channel);
 700
 701         ASSERT((packetLenAligned - packetLen) < sizeof(u64));
 702
 703         /* Setup the descriptor */
 704         desc.Type = Type; /* VmbusPacketTypeDataInBand; */
 705         desc.Flags = Flags; /* VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED; */
 706         /* in 8-bytes granularity */
 707         desc.DataOffset8 = sizeof(struct vmpacket_descriptor) >> 3;
 708         desc.Length8 = (u16)(packetLenAligned >> 3);
 709         desc.TransactionId = RequestId;
 710
 711         sg_init_table(bufferList, 3);
 712         sg_set_buf(&bufferList[0], &desc, sizeof(struct vmpacket_descriptor));
 713         sg_set_buf(&bufferList[1], Buffer, BufferLen);
 714         sg_set_buf(&bufferList[2], &alignedData, packetLenAligned - packetLen);
 715
 716         ret = RingBufferWrite(&Channel->Outbound, bufferList, 3);
 717
 718         /* TODO: We should determine if this is optional */
 719         if (ret == 0 && !GetRingBufferInterruptMask(&Channel->Outbound))
 720                 VmbusChannelSetEvent(Channel);
 721
 722         DPRINT_EXIT(VMBUS);
 723
 724         return ret;
 725 }
 726 EXPORT_SYMBOL(VmbusChannelSendPacket);
 727
 728 /*
 729  * VmbusChannelSendPacketPageBuffer - Send a range of single-page buffer
 730  * packets using a GPADL Direct packet type.
 731  */
 732 int VmbusChannelSendPacketPageBuffer(struct vmbus_channel *Channel,
 733                                      struct hv_page_buffer PageBuffers[],
 734                                      u32 PageCount, void *Buffer, u32 BufferLen,
 735                                      u64 RequestId)
 736 {
 737         int ret;
 738         int i;
 739         struct VMBUS_CHANNEL_PACKET_PAGE_BUFFER desc;
 740         u32 descSize;
 741         u32 packetLen;
 742         u32 packetLenAligned;
 743         struct scatterlist bufferList[3];
 744         u64 alignedData = 0;
 745
 746         DPRINT_ENTER(VMBUS);
 747
 748         ASSERT(PageCount <= MAX_PAGE_BUFFER_COUNT);
 749
 750         DumpVmbusChannel(Channel);
 751
 752         /*
 753          * Adjust the size down since VMBUS_CHANNEL_PACKET_PAGE_BUFFER is the
 754          * largest size we support
 755          */
 756         descSize = sizeof(struct VMBUS_CHANNEL_PACKET_PAGE_BUFFER) -
 757                           ((MAX_PAGE_BUFFER_COUNT - PageCount) *
 758                           sizeof(struct hv_page_buffer));
 759         packetLen = descSize + BufferLen;
 760         packetLenAligned = ALIGN_UP(packetLen, sizeof(u64));
 761
 762         ASSERT((packetLenAligned - packetLen) < sizeof(u64));
 763
 764         /* Setup the descriptor */
 765         desc.Type = VmbusPacketTypeDataUsingGpaDirect;
 766         desc.Flags = VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED;
 767         desc.DataOffset8 = descSize >> 3; /* in 8-bytes grandularity */
 768         desc.Length8 = (u16)(packetLenAligned >> 3);
 769         desc.TransactionId = RequestId;
 770         desc.RangeCount = PageCount;
 771
 772         for (i = 0; i < PageCount; i++) {
 773                 desc.Range[i].Length = PageBuffers[i].Length;
 774                 desc.Range[i].Offset = PageBuffers[i].Offset;
 775                 desc.Range[i].Pfn        = PageBuffers[i].Pfn;
 776         }
 777
 778         sg_init_table(bufferList, 3);
 779         sg_set_buf(&bufferList[0], &desc, descSize);
 780         sg_set_buf(&bufferList[1], Buffer, BufferLen);
 781         sg_set_buf(&bufferList[2], &alignedData, packetLenAligned - packetLen);
 782
 783         ret = RingBufferWrite(&Channel->Outbound, bufferList, 3);
 784
 785         /* TODO: We should determine if this is optional */
 786         if (ret == 0 && !GetRingBufferInterruptMask(&Channel->Outbound))
 787                 VmbusChannelSetEvent(Channel);
 788
 789         DPRINT_EXIT(VMBUS);
 790
 791         return ret;
 792 }
 793
 794 /*
 795  * VmbusChannelSendPacketMultiPageBuffer - Send a multi-page buffer packet
 796  * using a GPADL Direct packet type.
 797  */
 798 int VmbusChannelSendPacketMultiPageBuffer(struct vmbus_channel *Channel,
 799                                 struct hv_multipage_buffer *MultiPageBuffer,
 800                                 void *Buffer, u32 BufferLen, u64 RequestId)
 801 {
 802         int ret;
 803         struct VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER desc;
 804         u32 descSize;
 805         u32 packetLen;
 806         u32 packetLenAligned;
 807         struct scatterlist bufferList[3];
 808         u64 alignedData = 0;
 809         u32 PfnCount = NUM_PAGES_SPANNED(MultiPageBuffer->Offset,
 810                                          MultiPageBuffer->Length);
 811
 812         DPRINT_ENTER(VMBUS);
 813
 814         DumpVmbusChannel(Channel);
 815
 816         DPRINT_DBG(VMBUS, "data buffer - offset %u len %u pfn count %u",
 817                    MultiPageBuffer->Offset, MultiPageBuffer->Length, PfnCount);
 818
 819         ASSERT(PfnCount > 0);
 820         ASSERT(PfnCount <= MAX_MULTIPAGE_BUFFER_COUNT);
 821
 822         /*
 823          * Adjust the size down since VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER is
 824          * the largest size we support
 825          */
 826         descSize = sizeof(struct VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER) -
 827                           ((MAX_MULTIPAGE_BUFFER_COUNT - PfnCount) *
 828                           sizeof(u64));
 829         packetLen = descSize + BufferLen;
 830         packetLenAligned = ALIGN_UP(packetLen, sizeof(u64));
 831
 832         ASSERT((packetLenAligned - packetLen) < sizeof(u64));
 833
 834         /* Setup the descriptor */
 835         desc.Type = VmbusPacketTypeDataUsingGpaDirect;
 836         desc.Flags = VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED;
 837         desc.DataOffset8 = descSize >> 3; /* in 8-bytes grandularity */
 838         desc.Length8 = (u16)(packetLenAligned >> 3);
 839         desc.TransactionId = RequestId;
 840         desc.RangeCount = 1;
 841
 842         desc.Range.Length = MultiPageBuffer->Length;
 843         desc.Range.Offset = MultiPageBuffer->Offset;
 844
 845         memcpy(desc.Range.PfnArray, MultiPageBuffer->PfnArray,
 846                PfnCount * sizeof(u64));
 847
 848         sg_init_table(bufferList, 3);
 849         sg_set_buf(&bufferList[0], &desc, descSize);
 850         sg_set_buf(&bufferList[1], Buffer, BufferLen);
 851         sg_set_buf(&bufferList[2], &alignedData, packetLenAligned - packetLen);
 852
 853         ret = RingBufferWrite(&Channel->Outbound, bufferList, 3);
 854
 855         /* TODO: We should determine if this is optional */
 856         if (ret == 0 && !GetRingBufferInterruptMask(&Channel->Outbound))
 857                 VmbusChannelSetEvent(Channel);
 858
 859         DPRINT_EXIT(VMBUS);
 860
 861         return ret;
 862 }
 863
 864
 865 /**
 866  * VmbusChannelRecvPacket() - Retrieve the user packet on the specified channel
 867  * @Channel: Pointer to vmbus_channel structure.
 868  * @Buffer: Pointer to the buffer you want to receive the data into.
 869  * @BufferLen: Maximum size of what the the buffer will hold
 870  * @BufferActualLen: The actual size of the data after it was received
 871  * @RequestId: Identifier of the request
 872  *
 873  * Receives directly from the hyper-v vmbus and puts the data it received
 874  * into Buffer. This will receive the data unparsed from hyper-v.
 875  *
 876  * Mainly used by Hyper-V drivers.
 877  */
 878 int VmbusChannelRecvPacket(struct vmbus_channel *Channel, void *Buffer,
 879                            u32 BufferLen, u32 *BufferActualLen, u64 *RequestId)
 880 {
 881         struct vmpacket_descriptor desc;
 882         u32 packetLen;
 883         u32 userLen;
 884         int ret;
 885         unsigned long flags;
 886
 887         DPRINT_ENTER(VMBUS);
 888
 889         *BufferActualLen = 0;
 890         *RequestId = 0;
 891
 892         spin_lock_irqsave(&Channel->inbound_lock, flags);
 893
 894         ret = RingBufferPeek(&Channel->Inbound, &desc,
 895                              sizeof(struct vmpacket_descriptor));
 896         if (ret != 0) {
 897                 spin_unlock_irqrestore(&Channel->inbound_lock, flags);
 898
 899                 /* DPRINT_DBG(VMBUS, "nothing to read!!"); */
 900                 DPRINT_EXIT(VMBUS);
 901                 return 0;
 902         }
 903
 904         /* VmbusChannelClearEvent(Channel); */
 905
 906         packetLen = desc.Length8 << 3;
 907         userLen = packetLen - (desc.DataOffset8 << 3);
 908         /* ASSERT(userLen > 0); */
 909
 910         DPRINT_DBG(VMBUS, "packet received on channel %p relid %d <type %d "
 911                    "flag %d tid %llx pktlen %d datalen %d> ",
 912                    Channel, Channel->OfferMsg.ChildRelId, desc.Type,
 913                    desc.Flags, desc.TransactionId, packetLen, userLen);
 914
 915         *BufferActualLen = userLen;
 916
 917         if (userLen > BufferLen) {
 918                 spin_unlock_irqrestore(&Channel->inbound_lock, flags);
 919
 920                 DPRINT_ERR(VMBUS, "buffer too small - got %d needs %d",
 921                            BufferLen, userLen);
 922                 DPRINT_EXIT(VMBUS);
 923
 924                 return -1;
 925         }
 926
 927         *RequestId = desc.TransactionId;
 928
 929         /* Copy over the packet to the user buffer */
 930         ret = RingBufferRead(&Channel->Inbound, Buffer, userLen,
 931                              (desc.DataOffset8 << 3));
 932
 933         spin_unlock_irqrestore(&Channel->inbound_lock, flags);
 934
 935         DPRINT_EXIT(VMBUS);
 936
 937         return 0;
 938 }
 939 EXPORT_SYMBOL(VmbusChannelRecvPacket);
 940
 941 /*
 942  * VmbusChannelRecvPacketRaw - Retrieve the raw packet on the specified channel
 943  */
 944 int VmbusChannelRecvPacketRaw(struct vmbus_channel *Channel, void *Buffer,
 945                               u32 BufferLen, u32 *BufferActualLen,
 946                               u64 *RequestId)
 947 {
 948         struct vmpacket_descriptor desc;
 949         u32 packetLen;
 950         u32 userLen;
 951         int ret;
 952         unsigned long flags;
 953
 954         DPRINT_ENTER(VMBUS);
 955
 956         *BufferActualLen = 0;
 957         *RequestId = 0;
 958
 959         spin_lock_irqsave(&Channel->inbound_lock, flags);
 960
 961         ret = RingBufferPeek(&Channel->Inbound, &desc,
 962                              sizeof(struct vmpacket_descriptor));
 963         if (ret != 0) {
 964                 spin_unlock_irqrestore(&Channel->inbound_lock, flags);
 965
 966                 /* DPRINT_DBG(VMBUS, "nothing to read!!"); */
 967                 DPRINT_EXIT(VMBUS);
 968                 return 0;
 969         }
 970
 971         /* VmbusChannelClearEvent(Channel); */
 972
 973         packetLen = desc.Length8 << 3;
 974         userLen = packetLen - (desc.DataOffset8 << 3);
 975
 976         DPRINT_DBG(VMBUS, "packet received on channel %p relid %d <type %d "
 977                    "flag %d tid %llx pktlen %d datalen %d> ",
 978                    Channel, Channel->OfferMsg.ChildRelId, desc.Type,
 979                    desc.Flags, desc.TransactionId, packetLen, userLen);
 980
 981         *BufferActualLen = packetLen;
 982
 983         if (packetLen > BufferLen) {
 984                 spin_unlock_irqrestore(&Channel->inbound_lock, flags);
 985
 986                 DPRINT_ERR(VMBUS, "buffer too small - needed %d bytes but "
 987                            "got space for only %d bytes", packetLen, BufferLen);
 988                 DPRINT_EXIT(VMBUS);
 989                 return -2;
 990         }
 991
 992         *RequestId = desc.TransactionId;
 993
 994         /* Copy over the entire packet to the user buffer */
 995         ret = RingBufferRead(&Channel->Inbound, Buffer, packetLen, 0);
 996
 997         spin_unlock_irqrestore(&Channel->inbound_lock, flags);
 998
 999         DPRINT_EXIT(VMBUS);
1000
1001         return 0;
1002 }
1003
1004 /*
1005  * VmbusChannelOnChannelEvent - Channel event callback
1006  */
1007 void VmbusChannelOnChannelEvent(struct vmbus_channel *Channel)
1008 {
1009         DumpVmbusChannel(Channel);
1010         ASSERT(Channel->OnChannelCallback);
1011
1012         Channel->OnChannelCallback(Channel->ChannelCallbackContext);
1013
1014         mod_timer(&Channel->poll_timer, jiffies + usecs_to_jiffies(100));
1015 }
1016
1017 /*
1018  * VmbusChannelOnTimer - Timer event callback
1019  */
1020 void VmbusChannelOnTimer(unsigned long data)
1021 {
1022         struct vmbus_channel *channel = (struct vmbus_channel *)data;
1023
1024         if (channel->OnChannelCallback)
1025                 channel->OnChannelCallback(channel->ChannelCallbackContext);
1026 }
1027
1028 /*
1029  * DumpVmbusChannel - Dump vmbus channel info to the console
1030  */
1031 static void DumpVmbusChannel(struct vmbus_channel *Channel)
1032 {
1033         DPRINT_DBG(VMBUS, "Channel (%d)", Channel->OfferMsg.ChildRelId);
1034         DumpRingInfo(&Channel->Outbound, "Outbound ");
1035         DumpRingInfo(&Channel->Inbound, "Inbound ");
1036 }