FD.io VPP
v18.01.2-1-g9b554f3
Vector Packet Processing
Main Page
Related Pages
Modules
Namespaces
Data Structures
Source
Files
Symbols
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
vl_api_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
{
27
u32
client_index
;
28
u32
context
;
29
u8
is_server
;
30
u8
sock_filename[256];
31
u8
renumber
;
32
u32
custom_dev_instance
;
33
u8
use_custom_mac
;
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
{
45
u32
context
;
46
i32
retval
;
47
u32
sw_if_index
;
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
{
57
u32
client_index
;
58
u32
context
;
59
u32
sw_if_index
;
60
u8
is_server
;
61
u8
sock_filename[256];
62
u8
renumber
;
63
u32
custom_dev_instance
;
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
{
71
u32
client_index
;
72
u32
context
;
73
u32
sw_if_index
;
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
{
87
u32
context
;
88
u32
sw_if_index
;
89
u8
interface_name[64];
90
u32
virtio_net_hdr_sz
;
91
u64
features
;
92
u8
is_server
;
93
u8
sock_filename[256];
94
u32
num_regions
;
95
i32
sock_errno
;
96
};
97
98
define sw_interface_vhost_user_dump
99
{
100
u32
client_index
;
101
u32
context
;
102
};
103
/*
104
* Local Variables:
105
* eval: (c-set-style "gnu")
106
* End:
107
*/
vl_api_sw_interface_vhost_user_details_t::features
u64 features
Definition:
vhost_user.api:91
vl_api_create_vhost_user_if_reply_t::sw_if_index
u32 sw_if_index
Definition:
vhost_user.api:47
vl_api_sw_interface_vhost_user_details_t::sock_errno
i32 sock_errno
Definition:
vhost_user.api:95
vl_api_create_vhost_user_if_t::client_index
u32 client_index
Definition:
vhost_user.api:27
vl_api_version
#define vl_api_version(n, v)
Definition:
jvpp_registry.c:18
vl_api_sw_interface_vhost_user_details_t::num_regions
u32 num_regions
Definition:
vhost_user.api:94
vl_api_sw_interface_vhost_user_details_t::sw_if_index
u32 sw_if_index
Definition:
vhost_user.api:88
vl_api_sw_interface_vhost_user_dump_t::context
u32 context
Definition:
vhost_user.api:101
i32
int i32
Definition:
types.h:81
u64
unsigned long u64
Definition:
types.h:89
vl_api_delete_vhost_user_if_t::client_index
u32 client_index
Definition:
vhost_user.api:71
vl_api_modify_vhost_user_if_t::custom_dev_instance
u32 custom_dev_instance
Definition:
vhost_user.api:63
vl_api_create_vhost_user_if_t::context
u32 context
Definition:
vhost_user.api:28
vl_api_sw_interface_vhost_user_details_t::is_server
u8 is_server
Definition:
vhost_user.api:92
vl_api_create_vhost_user_if_t::use_custom_mac
u8 use_custom_mac
Definition:
vhost_user.api:33
vl_api_modify_vhost_user_if_t::context
u32 context
Definition:
vhost_user.api:58
vl_api_modify_vhost_user_if_t::sw_if_index
u32 sw_if_index
Definition:
vhost_user.api:59
vl_api_create_vhost_user_if_t::renumber
u8 renumber
Definition:
vhost_user.api:31
vl_api_create_vhost_user_if_reply_t::context
u32 context
Definition:
vhost_user.api:45
vl_api_modify_vhost_user_if_t::client_index
u32 client_index
Definition:
vhost_user.api:57
u32
unsigned int u32
Definition:
types.h:88
vl_api_modify_vhost_user_if_t::is_server
u8 is_server
Definition:
vhost_user.api:60
u8
unsigned char u8
Definition:
types.h:56
vl_api_delete_vhost_user_if_t::sw_if_index
u32 sw_if_index
Definition:
vhost_user.api:73
vl_api_delete_vhost_user_if_t::context
u32 context
Definition:
vhost_user.api:72
vl_api_create_vhost_user_if_t::custom_dev_instance
u32 custom_dev_instance
Definition:
vhost_user.api:32
vl_api_sw_interface_vhost_user_dump_t::client_index
u32 client_index
Definition:
vhost_user.api:100
vl_api_modify_vhost_user_if_t::renumber
u8 renumber
Definition:
vhost_user.api:62
vl_api_create_vhost_user_if_t::is_server
u8 is_server
Definition:
vhost_user.api:29
vl_api_sw_interface_vhost_user_details_t::context
u32 context
Definition:
vhost_user.api:87
vl_api_create_vhost_user_if_reply_t::retval
i32 retval
Definition:
vhost_user.api:46
vl_api_sw_interface_vhost_user_details_t::virtio_net_hdr_sz
u32 virtio_net_hdr_sz
Definition:
vhost_user.api:90
src
vnet
devices
virtio
vhost_user.api
Generated on Wed Sep 5 2018 06:02:29 for FD.io VPP by
1.8.11