bsd/sys/vsock.h

   1 /*
   2  * Copyright (c) 2020 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef _VSOCK_H_
  30 #define _VSOCK_H_
  31
  32 #include <sys/cdefs.h>
  33
  34 __BEGIN_DECLS
  35
  36 #include <sys/_types/_sa_family_t.h>
  37 #include <sys/ucred.h>
  38 #include <sys/socketvar.h>
  39
  40 #define VMADDR_CID_ANY (-1U)
  41 #define VMADDR_CID_HYPERVISOR 0
  42 #define VMADDR_CID_RESERVED 1
  43 #define VMADDR_CID_HOST 2
  44
  45 #define VMADDR_PORT_ANY (-1U)
  46
  47 #define IOCTL_VM_SOCKETS_GET_LOCAL_CID _IOR('s',  209, uint32_t)
  48
  49 struct sockaddr_vm {
  50         __uint8_t      svm_len;        /* total length */
  51         sa_family_t    svm_family;     /* Address family: AF_VSOCK */
  52         __uint16_t     svm_reserved1;
  53         __uint32_t     svm_port;       /* Port # in host byte order */
  54         __uint32_t     svm_cid;        /* Address in host byte order */
  55 } __attribute__((__packed__));
  56
  57 typedef u_quad_t vsock_gen_t;
  58
  59 struct xvsockpcb {
  60         u_int32_t      xv_len;            /* length of this structure */
  61         u_int64_t      xv_vsockpp;
  62         u_int32_t      xvp_local_cid;     /* local address cid */
  63         u_int32_t      xvp_local_port;    /* local address port */
  64         u_int32_t      xvp_remote_cid;    /* remote address cid */
  65         u_int32_t      xvp_remote_port;   /* remote address port */
  66         u_int32_t      xvp_rxcnt;         /* bytes received */
  67         u_int32_t      xvp_txcnt;         /* bytes transmitted */
  68         u_int32_t      xvp_peer_rxhiwat;  /* peer's receive buffer */
  69         u_int32_t      xvp_peer_rxcnt;    /* bytes received by peer */
  70         pid_t          xvp_last_pid;      /* last pid */
  71         vsock_gen_t    xvp_gencnt;        /* vsock generation count */
  72         struct xsocket xv_socket;
  73 };
  74
  75 struct  xvsockpgen {
  76         u_int32_t      xvg_len;      /* length of this structure */
  77         u_int64_t      xvg_count;    /* number of PCBs at this time */
  78         vsock_gen_t    xvg_gen;      /* generation count at this time */
  79         so_gen_t       xvg_sogen;    /* current socket generation count */
  80 };
  81
  82 __END_DECLS
  83
  84 #endif /* _VSOCK_H_ */