FD.io VPP  v18.11-rc0-18-g2a3fb1a
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 = "1.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 mac_address - hardware address to use if 'use_custom_mac' is set
24 */
25 define create_vhost_user_if
26 {
30  u8 sock_filename[256];
34  u8 mac_address[6];
35  u8 tag[64];
36 };
37 
38 /** \brief vhost-user interface create response
39  @param context - sender context, to match reply w/ request
40  @param retval - return code for the request
41  @param sw_if_index - interface the operation is applied to
42 */
43 define create_vhost_user_if_reply
44 {
48 };
49 
50 /** \brief vhost-user interface modify request
51  @param client_index - opaque cookie to identify the sender
52  @param is_server - our side is socket server
53  @param sock_filename - unix socket filename, used to speak with frontend
54 */
55 autoreply define modify_vhost_user_if
56 {
61  u8 sock_filename[256];
64 };
65 
66 /** \brief vhost-user interface delete request
67  @param client_index - opaque cookie to identify the sender
68 */
69 autoreply define delete_vhost_user_if
70 {
74 };
75 
76 /** \brief Vhost-user interface details structure (fix this)
77  @param sw_if_index - index of the interface
78  @param interface_name - name of interface
79  @param virtio_net_hdr_sz - net header size
80  @param features - interface features
81  @param is_server - vhost-user server socket
82  @param sock_filename - socket filename
83  @param num_regions - number of used memory regions
84 */
85 define sw_interface_vhost_user_details
86 {
89  u8 interface_name[64];
93  u8 sock_filename[256];
96 };
97 
98 define sw_interface_vhost_user_dump
99 {
102 };
103 /*
104  * Local Variables:
105  * eval: (c-set-style "gnu")
106  * End:
107  */
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:81