1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
* Copyright (c) 2015-2016 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** \file
This file defines packet-generator interface APIs.
*/
option version = "2.1.0";
import "vnet/interface_types.api";
enum pg_interface_mode : u8
{
PG_API_MODE_ETHERNET = 0,
PG_API_MODE_IP4,
PG_API_MODE_IP6,
};
/** \brief PacketGenerator create interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param interface_id - interface index
@param gso_enabled - enable gso on this interface
@param gso_size - gso size on this interface
*/
define pg_create_interface
{
option deprecated;
u32 client_index;
u32 context;
vl_api_interface_index_t interface_id;
bool gso_enabled;
u32 gso_size;
};
define pg_create_interface_v2
{
u32 client_index;
u32 context;
vl_api_interface_index_t interface_id;
bool gso_enabled;
u32 gso_size;
vl_api_pg_interface_mode_t mode;
};
/** \brief PacketGenerator create interface response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define pg_create_interface_reply
{
option deprecated;
u32 context;
i32 retval;
vl_api_interface_index_t sw_if_index;
};
define pg_create_interface_v2_reply
{
u32 context;
i32 retval;
vl_api_interface_index_t sw_if_index;
};
/** \brief PacketGenerator delete interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface index
*/
autoreply define pg_delete_interface
{
u32 client_index;
u32 context;
vl_api_interface_index_t sw_if_index;
};
/** \brief PacketGenerator interface enable/disable packet coalesce
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param interface_id - interface index
@param coalesce_enabled - enable/disable packet coalesce on this interface
*/
autoreply define pg_interface_enable_disable_coalesce
{
u32 client_index;
u32 context;
vl_api_interface_index_t sw_if_index;
bool coalesce_enabled;
option status="in_progress";
};
/** \brief PacketGenerator capture packets on given interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param interface_id - pg interface index
@param is_enabled - 1 if enabling streams, 0 if disabling
@param count - number of packets to be captured
@param pcap_file_name - pacp file name to store captured packets
*/
autoreply define pg_capture
{
u32 client_index;
u32 context;
vl_api_interface_index_t interface_id;
bool is_enabled [default=true];
u32 count;
string pcap_file_name[];
};
/** \brief Enable / disable packet generator request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_enabled - 1 if enabling streams, 0 if disabling
@param stream_name - stream name to be enable/disabled, if not specified handle all streams
*/
autoreply define pg_enable_disable
{
u32 client_index;
u32 context;
bool is_enabled [default=true];
string stream_name[];
};
/*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
