/*********************************************************
 * Copyright (C) 2007 VMware, Inc. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation version 2 and no later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 *********************************************************/

/*
 * vsockCommon.h --
 *
 *    VSockets common constants, types and functions.
 */


#ifndef _VSOCK_COMMON_H_
#define _VSOCK_COMMON_H_

/*
 * VMCISockGetAFValueInt is defined separately from VMCISock_GetAFValue because
 * it is used in several different contexts. In particular it is called from
 * vsockAddr.c which gets compiled into both our kernel modules as well as
 * the user level vsock library. In the linux kernel we need different behavior
 * than external kernel modules using VMCI Sockets api inside the kernel.
 */

#if defined VMX86_VMX
   /*
    * The VMX is a very special case because hypervisor sockets do not go
    * through the host kernel and thus do not require an address family.
    */
#  define VMCI_SOCKETS_AF_VALUE 0
#  define VMCISockGetAFValueInt() VMCI_SOCKETS_AF_VALUE
#elif defined _WIN32
#  define VMCI_SOCKETS_AF_VALUE 28
#  if defined WINNT_DDK
#     define _WIN2K_COMPAT_SLIST_USAGE
#     include <ntddk.h>
#     include <windef.h>
#     define _INC_WINDOWS
      /* In the kernel we can't call into the provider. */
#     define VMCISockGetAFValueInt() VMCI_SOCKETS_AF_VALUE
#  else // WINNT_DDK
      /* In userland, just use the normal exported userlevel api. */
#     define VMCISockGetAFValueInt() VMCISock_GetAFValue()
#     include <windows.h>
#  endif // WINNT_DDK
#elif defined VMKERNEL
#  include "uwvmkAPI.h"
#  define VMCI_SOCKETS_AF_VALUE AF_VMCI /* Defined in uwvmkAPI.h. */
   /* The address family is fixed in the vmkernel. */
#  define VMCISockGetAFValueInt() VMCI_SOCKETS_AF_VALUE
#elif defined linux
#  if defined __KERNEL__
   /* Include compat_page.h now so PAGE_SIZE and friends don't get redefined. */
#     include "driver-config.h"
#     include "compat_page.h"
    /*
     * In the kernel we call back into af_vsock.c to get the address family
     * being used.  Otherwise an ioctl(2) is performed (see vmci_sockets.h).
     */
      extern int VSockVmci_GetAFValue(void);
#     define VMCISockGetAFValueInt() VSockVmci_GetAFValue()
#  else // __KERNEL__
      /* In userland, just use the normal exported userlevel api. */
#     define VMCISockGetAFValueInt() VMCISock_GetAFValue()
#  endif
#elif defined __APPLE__
#  if defined KERNEL
#     include <IOKit/system.h>
#     define VMCI_SOCKETS_AF_VALUE   14
#     define VMCISockGetAFValueInt() VMCI_SOCKETS_AF_VALUE
#  else // KERNEL
#     define VMCISockGetAFValueInt() VMCISock_GetAFValue()
#  endif // KERNEL
#endif // __APPLE__

#include "vmware.h"
#include "vm_basic_asm.h"
#include "vmci_defs.h"
#include "vmci_call_defs.h"
#include "vmci_infrastructure.h"
#include "vmci_sockets_int.h"
#include "vmci_sockets.h"

#if defined WINNT_DDK
#  include <winsock2.h>
#endif // WINNT_DDK

#include "vsockAddr.h"
#include "vsockSocketWrapper.h"


/*
 * Local VSocket control packet resource ID.
 *
 * Stream sockets to the hypervisor were added later so VSOCK_PACKET_RID was
 * already assigned to another application. VSOCK_PACKET_HYPERVISOR_RID is
 * used instead.
 */
#if defined VMX86_VMX
#  define VSOCK_PACKET_LOCAL_RID  VSOCK_PACKET_HYPERVISOR_RID
#else
#  define VSOCK_PACKET_LOCAL_RID  VSOCK_PACKET_RID
#endif


/* Memory allocation flags. */
#define VSOCK_MEMORY_NORMAL   0
#define VSOCK_MEMORY_ATOMIC   (1 << 0)
#define VSOCK_MEMORY_NONPAGED (1 << 1)


/*
 *-----------------------------------------------------------------------------
 *
 * VSockVA64ToPtr --
 *
 *      Convert a VA64 to a pointer.
 *
 * Results:
 *      Virtual address.
 *
 * Side effects:
 *      None
 *
 *-----------------------------------------------------------------------------
 */

static INLINE void *
VSockVA64ToPtr(VA64 va64) // IN
{
#ifdef VM_X86_64
   ASSERT_ON_COMPILE(sizeof (void *) == 8);
#else
   ASSERT_ON_COMPILE(sizeof (void *) == 4);
   // Check that nothing of value will be lost.
   ASSERT(!(va64 >> 32));
#endif
   return (void *)(uintptr_t)va64;
}


/*
 *-----------------------------------------------------------------------------
 *
 * VSockPtrToVA64 --
 *
 *      Convert a pointer to a VA64.
 *
 * Results:
 *      Virtual address.
 *
 * Side effects:
 *      None
 *
 *-----------------------------------------------------------------------------
 */

static INLINE VA64
VSockPtrToVA64(void const *ptr) // IN
{
   ASSERT_ON_COMPILE(sizeof ptr <= sizeof (VA64));
   return (VA64)(uintptr_t)ptr;
}


#if defined(_WIN32) && !defined(WINNT_DDK)
/* VSock transport provider structures */
__declspec(selectany) extern const WSAPROTOCOL_INFOW vsockProtocolInfos[] = {
   {
      (XP1_CONNECTIONLESS |      /* No connection required. */
       XP1_MESSAGE_ORIENTED),    /* Message. */
      0,                         /* Reserved. */
      0,                         /* Reserved. */
      0,                         /* Reserved. */
      PFL_MATCHES_PROTOCOL_ZERO, /* Always protocol 0. */
      { 0 },                     /* None. */
      0,                         /* Assigned by Winsock. */
      { 1, 0 },                  /* Base provider. */
      0,                         /* Version 0. */
      VMCI_SOCKETS_AF_VALUE,     /* VMCI sockets protocol. */
      16,                        /* Maximum address length in bytes. */
      16,                        /* Minimum address length in bytes. */
      SOCK_DGRAM,                /* STREAM. */
      0,                         /* Protocol. */
      0,                         /* Protocol max offset. */
      BIGENDIAN,                 /* Network byte order. */
      SECURITY_PROTOCOL_NONE,    /* No security. */
      0,                         /* Message size unimportant. */
      0,                         /* None. */
      L"VMCI sockets DGRAM"      /* Protocol name. */
   },
   {
      (XP1_GUARANTEED_DELIVERY | /* Guaranteed delivery. */
       XP1_GUARANTEED_ORDER |    /* Guaranteed order. */
       XP1_GRACEFUL_CLOSE),      /* Graceful close. */
      0,                         /* Reserved. */
      0,                         /* Reserved. */
      0,                         /* Reserved. */
      PFL_MATCHES_PROTOCOL_ZERO, /* Always protocol 0. */
      { 0 },                     /* None. */
      0,                         /* Assigned by Winsock. */
      { 1, 0 },                  /* Base provider. */
      0,                         /* Version 0. */
      VMCI_SOCKETS_AF_VALUE,     /* VMCI sockets protocol. */
      16,                        /* Maximum address length in bytes. */
      16,                        /* Minimum address length in bytes. */
      SOCK_STREAM,               /* STREAM. */
      0,                         /* Protocol. */
      0,                         /* Protocol max offset. */
      BIGENDIAN,                 /* Network byte order. */
      SECURITY_PROTOCOL_NONE,    /* No security. */
      0,                         /* Message size unimportant. */
      0,                         /* None. */
      L"VMCI sockets STREAM"     /* Protocol name. */
   },
};

__declspec(selectany) extern const
size_t numVSockProtocolInfos = ARRAYSIZE(vsockProtocolInfos);

/* {570ADC4B-67B2-42ce-92B2-ACD33D88D842} */
__declspec(selectany) extern const GUID vsockProviderID = {
   0x570adc4b, 0x67b2, 0x42ce,
   { 0x92, 0xb2, 0xac, 0xd3, 0x3d, 0x88, 0xd8, 0x42 }
};
#endif // _WIN32 && !WINNT_DDK


#endif // _VSOCK_COMMON_H_
