FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
vhost_user.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 option version = "4.0.1";
17 
18 import "vnet/interface_types.api";
19 import "vnet/ethernet/ethernet_types.api";
20 import "vnet/devices/virtio/virtio_types.api";
21 
22 /** \brief vhost-user interface create request
23  @param client_index - opaque cookie to identify the sender
24  @param is_server - our side is socket server
25  @param sock_filename - unix socket filename, used to speak with frontend
26  @param use_custom_mac - enable or disable the use of the provided hardware address
27  @param disable_mrg_rxbuf - disable the use of merge receive buffers
28  @param disable_indirect_desc - disable the use of indirect descriptors which driver can use
29  @param enable_gso - enable gso support (default 0)
30  @param enable_packed - enable packed ring support (default 0)
31  @param mac_address - hardware address to use if 'use_custom_mac' is set
32 */
33 define create_vhost_user_if
34 {
37  bool is_server;
38  string sock_filename[256];
39  bool renumber;
42  bool enable_gso;
46  vl_api_mac_address_t mac_address;
47  string tag[64];
48 };
49 
50 /** \brief vhost-user interface create response
51  @param context - sender context, to match reply w/ request
52  @param retval - return code for the request
53  @param sw_if_index - interface the operation is applied to
54 */
55 define create_vhost_user_if_reply
56 {
59  vl_api_interface_index_t sw_if_index;
60 };
61 
62 /** \brief vhost-user interface modify request
63  @param client_index - opaque cookie to identify the sender
64  @param is_server - our side is socket server
65  @param sock_filename - unix socket filename, used to speak with frontend
66  @param enable_gso - enable gso support (default 0)
67  @param enable_packed - enable packed ring support (default 0)
68 */
69 autoreply define modify_vhost_user_if
70 {
73  vl_api_interface_index_t sw_if_index;
74  bool is_server;
75  string sock_filename[256];
76  bool renumber;
77  bool enable_gso;
80 };
81 
82 /** \brief vhost-user interface delete request
83  @param client_index - opaque cookie to identify the sender
84 */
85 autoreply define delete_vhost_user_if
86 {
89  vl_api_interface_index_t sw_if_index;
90 };
91 
92 /** \brief Vhost-user interface details structure (fix this)
93  @param sw_if_index - index of the interface
94  @param interface_name - name of interface
95  @param virtio_net_hdr_sz - net header size
96  @param features_first_32 - interface features, first 32 bits
97  @param features_last_32 - interface features, last 32 bits
98  @param is_server - vhost-user server socket
99  @param sock_filename - socket filename
100  @param num_regions - number of used memory regions
101  @param sock_errno - socket errno
102 */
103 define sw_interface_vhost_user_details
104 {
106  vl_api_interface_index_t sw_if_index;
107  string interface_name[64];
109  vl_api_virtio_net_features_first_32_t features_first_32;
110  vl_api_virtio_net_features_last_32_t features_last_32;
111  bool is_server;
112  string sock_filename[256];
115 };
116 
117 /** \brief Vhost-user interface dump request
118  @param sw_if_index - filter by sw_if_index
119 */
120 define sw_interface_vhost_user_dump
121 {
124  vl_api_interface_index_t sw_if_index [default=0xffffffff];
125 };
126 /*
127  * Local Variables:
128  * eval: (c-set-style "gnu")
129  * End:
130  */
vl_api_mac_address_t mac_address
Definition: vhost_user.api:46
vl_api_virtio_net_features_last_32_t features_last_32
Definition: vhost_user.api:110
unsigned int u32
Definition: types.h:88
option version
Definition: vhost_user.api:16
vl_api_interface_index_t sw_if_index
Definition: vhost_user.api:89
vl_api_interface_index_t sw_if_index
Definition: vhost_user.api:106
vl_api_virtio_net_features_first_32_t features_first_32
Definition: vhost_user.api:109
signed int i32
Definition: types.h:77
vl_api_interface_index_t sw_if_index
Definition: vhost_user.api:73
vl_api_interface_index_t sw_if_index
Definition: vhost_user.api:59
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33