bsd/sys/vsock_transport.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_TRANSPORT_H_
  30 #define _VSOCK_TRANSPORT_H_
  31 #ifdef  KERNEL_PRIVATE
  32
  33 #include <sys/cdefs.h>
  34
  35 __BEGIN_DECLS
  36
  37 #include <sys/queue.h>
  38 #include <sys/kernel_types.h>
  39 #include <sys/vsock.h>
  40
  41 #define VSOCK_MAX_PACKET_SIZE 65536
  42
  43 enum vsock_operation {
  44         VSOCK_REQUEST = 0,
  45         VSOCK_RESPONSE = 1,
  46         VSOCK_PAYLOAD = 2,
  47         VSOCK_SHUTDOWN = 3,
  48         VSOCK_SHUTDOWN_RECEIVE = 4,
  49         VSOCK_SHUTDOWN_SEND = 5,
  50         VSOCK_RESET = 6,
  51         VSOCK_CREDIT_UPDATE = 7,
  52         VSOCK_CREDIT_REQUEST = 8,
  53 };
  54
  55 struct vsock_address {
  56         uint32_t cid;
  57         uint32_t port;
  58 };
  59
  60 struct vsock_transport {
  61         void *provider;
  62         int (*get_cid)(void *provider, uint32_t *cid);
  63         int (*attach_socket)(void *provider);
  64         int (*detach_socket)(void *provider);
  65         int (*put_message)(void *provider, struct vsock_address src, struct vsock_address dst,
  66             enum vsock_operation op, uint32_t buf_alloc, uint32_t fwd_cnt, mbuf_t m);
  67 };
  68
  69 extern int vsock_add_transport(struct vsock_transport *transport);
  70 extern int vsock_remove_transport(struct vsock_transport *transport);
  71 extern int vsock_reset_transport(struct vsock_transport *transport);
  72 extern int vsock_put_message(struct vsock_address src, struct vsock_address dst,
  73     enum vsock_operation op, uint32_t buf_alloc, uint32_t fwd_cnt, mbuf_t m);
  74
  75 __END_DECLS
  76
  77 #endif /* KERNEL_PRIVATE */
  78 #endif /* _VSOCK_TRANSPORT_H_ */