vhost_user.h 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /* Vhost-user protocol */
  3. #ifndef __VHOST_USER_H__
  4. #define __VHOST_USER_H__
  5. /* Message flags */
  6. #define VHOST_USER_FLAG_REPLY BIT(2)
  7. #define VHOST_USER_FLAG_NEED_REPLY BIT(3)
  8. /* Feature bits */
  9. #define VHOST_USER_F_PROTOCOL_FEATURES 30
  10. /* Protocol feature bits */
  11. #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
  12. #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
  13. #define VHOST_USER_PROTOCOL_F_CONFIG 9
  14. #define VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS 14
  15. /* Vring state index masks */
  16. #define VHOST_USER_VRING_INDEX_MASK 0xff
  17. #define VHOST_USER_VRING_POLL_MASK BIT(8)
  18. /* Supported version */
  19. #define VHOST_USER_VERSION 1
  20. /* Supported transport features */
  21. #define VHOST_USER_SUPPORTED_F BIT_ULL(VHOST_USER_F_PROTOCOL_FEATURES)
  22. /* Supported protocol features */
  23. #define VHOST_USER_SUPPORTED_PROTOCOL_F (BIT_ULL(VHOST_USER_PROTOCOL_F_REPLY_ACK) | \
  24. BIT_ULL(VHOST_USER_PROTOCOL_F_SLAVE_REQ) | \
  25. BIT_ULL(VHOST_USER_PROTOCOL_F_CONFIG) | \
  26. BIT_ULL(VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS))
  27. enum vhost_user_request {
  28. VHOST_USER_GET_FEATURES = 1,
  29. VHOST_USER_SET_FEATURES = 2,
  30. VHOST_USER_SET_OWNER = 3,
  31. VHOST_USER_RESET_OWNER = 4,
  32. VHOST_USER_SET_MEM_TABLE = 5,
  33. VHOST_USER_SET_LOG_BASE = 6,
  34. VHOST_USER_SET_LOG_FD = 7,
  35. VHOST_USER_SET_VRING_NUM = 8,
  36. VHOST_USER_SET_VRING_ADDR = 9,
  37. VHOST_USER_SET_VRING_BASE = 10,
  38. VHOST_USER_GET_VRING_BASE = 11,
  39. VHOST_USER_SET_VRING_KICK = 12,
  40. VHOST_USER_SET_VRING_CALL = 13,
  41. VHOST_USER_SET_VRING_ERR = 14,
  42. VHOST_USER_GET_PROTOCOL_FEATURES = 15,
  43. VHOST_USER_SET_PROTOCOL_FEATURES = 16,
  44. VHOST_USER_GET_QUEUE_NUM = 17,
  45. VHOST_USER_SET_VRING_ENABLE = 18,
  46. VHOST_USER_SEND_RARP = 19,
  47. VHOST_USER_NET_SEND_MTU = 20,
  48. VHOST_USER_SET_SLAVE_REQ_FD = 21,
  49. VHOST_USER_IOTLB_MSG = 22,
  50. VHOST_USER_SET_VRING_ENDIAN = 23,
  51. VHOST_USER_GET_CONFIG = 24,
  52. VHOST_USER_SET_CONFIG = 25,
  53. VHOST_USER_VRING_KICK = 35,
  54. };
  55. enum vhost_user_slave_request {
  56. VHOST_USER_SLAVE_IOTLB_MSG = 1,
  57. VHOST_USER_SLAVE_CONFIG_CHANGE_MSG = 2,
  58. VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
  59. VHOST_USER_SLAVE_VRING_CALL = 4,
  60. };
  61. struct vhost_user_header {
  62. /*
  63. * Use enum vhost_user_request for outgoing messages,
  64. * uses enum vhost_user_slave_request for incoming ones.
  65. */
  66. u32 request;
  67. u32 flags;
  68. u32 size;
  69. } __packed;
  70. struct vhost_user_config {
  71. u32 offset;
  72. u32 size;
  73. u32 flags;
  74. u8 payload[]; /* Variable length */
  75. } __packed;
  76. struct vhost_user_vring_state {
  77. u32 index;
  78. u32 num;
  79. } __packed;
  80. struct vhost_user_vring_addr {
  81. u32 index;
  82. u32 flags;
  83. u64 desc, used, avail, log;
  84. } __packed;
  85. struct vhost_user_mem_region {
  86. u64 guest_addr;
  87. u64 size;
  88. u64 user_addr;
  89. u64 mmap_offset;
  90. } __packed;
  91. struct vhost_user_mem_regions {
  92. u32 num;
  93. u32 padding;
  94. struct vhost_user_mem_region regions[2]; /* Currently supporting 2 */
  95. } __packed;
  96. union vhost_user_payload {
  97. u64 integer;
  98. struct vhost_user_config config;
  99. struct vhost_user_vring_state vring_state;
  100. struct vhost_user_vring_addr vring_addr;
  101. struct vhost_user_mem_regions mem_regions;
  102. };
  103. struct vhost_user_msg {
  104. struct vhost_user_header header;
  105. union vhost_user_payload payload;
  106. } __packed;
  107. #endif