FD.io VPP  v17.07.01-10-g3be13f0
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 /** \brief vhost-user interface create request
17  @param client_index - opaque cookie to identify the sender
18  @param is_server - our side is socket server
19  @param sock_filename - unix socket filename, used to speak with frontend
20  @param use_custom_mac - enable or disable the use of the provided hardware address
21  @param mac_address - hardware address to use if 'use_custom_mac' is set
22  @param operation_mode - polling=0, interrupt=1, or adaptive=2
23 */
24 define create_vhost_user_if
25 {
29  u8 sock_filename[256];
33  u8 mac_address[6];
34  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  @param operation_mode - polling=0, interrupt=1, or adaptive=2
55 */
56 autoreply define modify_vhost_user_if
57 {
62  u8 sock_filename[256];
66 };
67 
68 /** \brief vhost-user interface delete request
69  @param client_index - opaque cookie to identify the sender
70 */
71 autoreply define delete_vhost_user_if
72 {
76 };
77 
78 /** \brief Vhost-user interface details structure (fix this)
79  @param sw_if_index - index of the interface
80  @param interface_name - name of interface
81  @param virtio_net_hdr_sz - net header size
82  @param features - interface features
83  @param is_server - vhost-user server socket
84  @param sock_filename - socket filename
85  @param num_regions - number of used memory regions
86  @param operation_mode - polling=0, interrupt=1, or adaptive=2
87 */
88 define sw_interface_vhost_user_details
89 {
92  u8 interface_name[64];
96  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  */
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
unsigned int u32
Definition: types.h:88
unsigned char u8
Definition: types.h:56