vm_sockets.h 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. /*
  2. * VMware vSockets Driver
  3. *
  4. * Copyright (C) 2007-2013 VMware, Inc. All rights reserved.
  5. *
  6. * This program is free software; you can redistribute it and/or modify it
  7. * under the terms of the GNU General Public License as published by the Free
  8. * Software Foundation version 2 and no later version.
  9. *
  10. * This program is distributed in the hope that it will be useful, but WITHOUT
  11. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12. * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13. * more details.
  14. */
  15. #ifndef _VM_SOCKETS_H
  16. #define _VM_SOCKETS_H
  17. #include <linux/socket.h>
  18. /* Option name for STREAM socket buffer size. Use as the option name in
  19. * setsockopt(3) or getsockopt(3) to set or get an unsigned long long that
  20. * specifies the size of the buffer underlying a vSockets STREAM socket.
  21. * Value is clamped to the MIN and MAX.
  22. */
  23. #define SO_VM_SOCKETS_BUFFER_SIZE 0
  24. /* Option name for STREAM socket minimum buffer size. Use as the option name
  25. * in setsockopt(3) or getsockopt(3) to set or get an unsigned long long that
  26. * specifies the minimum size allowed for the buffer underlying a vSockets
  27. * STREAM socket.
  28. */
  29. #define SO_VM_SOCKETS_BUFFER_MIN_SIZE 1
  30. /* Option name for STREAM socket maximum buffer size. Use as the option name
  31. * in setsockopt(3) or getsockopt(3) to set or get an unsigned long long
  32. * that specifies the maximum size allowed for the buffer underlying a
  33. * vSockets STREAM socket.
  34. */
  35. #define SO_VM_SOCKETS_BUFFER_MAX_SIZE 2
  36. /* Option name for socket peer's host-specific VM ID. Use as the option name
  37. * in getsockopt(3) to get a host-specific identifier for the peer endpoint's
  38. * VM. The identifier is a signed integer.
  39. * Only available for hypervisor endpoints.
  40. */
  41. #define SO_VM_SOCKETS_PEER_HOST_VM_ID 3
  42. /* Option name for determining if a socket is trusted. Use as the option name
  43. * in getsockopt(3) to determine if a socket is trusted. The value is a
  44. * signed integer.
  45. */
  46. #define SO_VM_SOCKETS_TRUSTED 5
  47. /* Option name for STREAM socket connection timeout. Use as the option name
  48. * in setsockopt(3) or getsockopt(3) to set or get the connection
  49. * timeout for a STREAM socket.
  50. */
  51. #define SO_VM_SOCKETS_CONNECT_TIMEOUT 6
  52. /* Option name for using non-blocking send/receive. Use as the option name
  53. * for setsockopt(3) or getsockopt(3) to set or get the non-blocking
  54. * transmit/receive flag for a STREAM socket. This flag determines whether
  55. * send() and recv() can be called in non-blocking contexts for the given
  56. * socket. The value is a signed integer.
  57. *
  58. * This option is only relevant to kernel endpoints, where descheduling the
  59. * thread of execution is not allowed, for example, while holding a spinlock.
  60. * It is not to be confused with conventional non-blocking socket operations.
  61. *
  62. * Only available for hypervisor endpoints.
  63. */
  64. #define SO_VM_SOCKETS_NONBLOCK_TXRX 7
  65. /* The vSocket equivalent of INADDR_ANY. This works for the svm_cid field of
  66. * sockaddr_vm and indicates the context ID of the current endpoint.
  67. */
  68. #define VMADDR_CID_ANY -1U
  69. /* Bind to any available port. Works for the svm_port field of
  70. * sockaddr_vm.
  71. */
  72. #define VMADDR_PORT_ANY -1U
  73. /* Use this as the destination CID in an address when referring to the
  74. * hypervisor. VMCI relies on it being 0, but this would be useful for other
  75. * transports too.
  76. */
  77. #define VMADDR_CID_HYPERVISOR 0
  78. /* This CID is specific to VMCI and can be considered reserved (even VMCI
  79. * doesn't use it anymore, it's a legacy value from an older release).
  80. */
  81. #define VMADDR_CID_RESERVED 1
  82. /* Use this as the destination CID in an address when referring to the host
  83. * (any process other than the hypervisor). VMCI relies on it being 2, but
  84. * this would be useful for other transports too.
  85. */
  86. #define VMADDR_CID_HOST 2
  87. /* Invalid vSockets version. */
  88. #define VM_SOCKETS_INVALID_VERSION -1U
  89. /* The epoch (first) component of the vSockets version. A single byte
  90. * representing the epoch component of the vSockets version.
  91. */
  92. #define VM_SOCKETS_VERSION_EPOCH(_v) (((_v) & 0xFF000000) >> 24)
  93. /* The major (second) component of the vSockets version. A single byte
  94. * representing the major component of the vSockets version. Typically
  95. * changes for every major release of a product.
  96. */
  97. #define VM_SOCKETS_VERSION_MAJOR(_v) (((_v) & 0x00FF0000) >> 16)
  98. /* The minor (third) component of the vSockets version. Two bytes representing
  99. * the minor component of the vSockets version.
  100. */
  101. #define VM_SOCKETS_VERSION_MINOR(_v) (((_v) & 0x0000FFFF))
  102. /* Address structure for vSockets. The address family should be set to
  103. * AF_VSOCK. The structure members should all align on their natural
  104. * boundaries without resorting to compiler packing directives. The total size
  105. * of this structure should be exactly the same as that of struct sockaddr.
  106. */
  107. struct sockaddr_vm {
  108. __kernel_sa_family_t svm_family;
  109. unsigned short svm_reserved1;
  110. unsigned int svm_port;
  111. unsigned int svm_cid;
  112. unsigned char svm_zero[sizeof(struct sockaddr) -
  113. sizeof(sa_family_t) -
  114. sizeof(unsigned short) -
  115. sizeof(unsigned int) - sizeof(unsigned int)];
  116. };
  117. #define IOCTL_VM_SOCKETS_GET_LOCAL_CID _IO(7, 0xb9)
  118. #endif /* _VM_SOCKETS_H */