FD.io VPP  v18.10-32-g1161dda
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 = "2.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 mac_address - hardware address to use if 'use_custom_mac' is set
26 */
27 define create_vhost_user_if
28 {
32  u8 sock_filename[256];
39  u8 tag[64];
40 };
41 
42 /** \brief vhost-user interface create response
43  @param context - sender context, to match reply w/ request
44  @param retval - return code for the request
45  @param sw_if_index - interface the operation is applied to
46 */
47 define create_vhost_user_if_reply
48 {
52 };
53 
54 /** \brief vhost-user interface modify request
55  @param client_index - opaque cookie to identify the sender
56  @param is_server - our side is socket server
57  @param sock_filename - unix socket filename, used to speak with frontend
58 */
59 autoreply define modify_vhost_user_if
60 {
65  u8 sock_filename[256];
68 };
69 
70 /** \brief vhost-user interface delete request
71  @param client_index - opaque cookie to identify the sender
72 */
73 autoreply define delete_vhost_user_if
74 {
78 };
79 
80 /** \brief Vhost-user interface details structure (fix this)
81  @param sw_if_index - index of the interface
82  @param interface_name - name of interface
83  @param virtio_net_hdr_sz - net header size
84  @param features - interface features
85  @param is_server - vhost-user server socket
86  @param sock_filename - socket filename
87  @param num_regions - number of used memory regions
88 */
89 define sw_interface_vhost_user_details
90 {
93  u8 interface_name[64];
97  u8 sock_filename[256];
100 };
101 
102 define sw_interface_vhost_user_dump
103 {
106 };
107 /*
108  * Local Variables:
109  * eval: (c-set-style "gnu")
110  * End:
111  */
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
typedef mac_address
signed int i32
Definition: types.h:77