FD.io VPP  v19.08.3-2-gbabecb413
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 = "3.0.0";
17 
18 /** \brief vhost-user interface create request
19  @param client_index - opaque cookie to identify the sender
20  @param is_server - our side is socket server
21  @param sock_filename - unix socket filename, used to speak with frontend
22  @param use_custom_mac - enable or disable the use of the provided hardware address
23  @param disable_mrg_rxbuf - disable the use of merge receive buffers
24  @param disable_indirect_desc - disable the use of indirect descriptors which driver can use
25  @param enable_gso - enable gso support (default 0)
26  @param mac_address - hardware address to use if 'use_custom_mac' is set
27 */
28 define create_vhost_user_if
29 {
33  u8 sock_filename[256];
41  u8 tag[64];
42 };
43 
44 /** \brief vhost-user interface create response
45  @param context - sender context, to match reply w/ request
46  @param retval - return code for the request
47  @param sw_if_index - interface the operation is applied to
48 */
49 define create_vhost_user_if_reply
50 {
54 };
55 
56 /** \brief vhost-user interface modify request
57  @param client_index - opaque cookie to identify the sender
58  @param is_server - our side is socket server
59  @param sock_filename - unix socket filename, used to speak with frontend
60  @param enable_gso - enable gso support (default 0)
61 */
62 autoreply define modify_vhost_user_if
63 {
68  u8 sock_filename[256];
72 };
73 
74 /** \brief vhost-user interface delete request
75  @param client_index - opaque cookie to identify the sender
76 */
77 autoreply define delete_vhost_user_if
78 {
82 };
83 
84 /** \brief Vhost-user interface details structure (fix this)
85  @param sw_if_index - index of the interface
86  @param interface_name - name of interface
87  @param virtio_net_hdr_sz - net header size
88  @param features - interface features
89  @param is_server - vhost-user server socket
90  @param sock_filename - socket filename
91  @param num_regions - number of used memory regions
92 */
93 define sw_interface_vhost_user_details
94 {
97  u8 interface_name[64];
101  u8 sock_filename[256];
104 };
105 
106 define sw_interface_vhost_user_dump
107 {
110 };
111 /*
112  * Local Variables:
113  * eval: (c-set-style "gnu")
114  * End:
115  */
unsigned long u64
Definition: types.h:89
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
option version
Definition: vhost_user.api:16
signed int i32
Definition: types.h:77
u8 mac_address[6]