FD.io VPP
v20.01-48-g3e0dafb74
Vector Packet Processing
pg.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
/** \file
17
18
This file defines packet-generator interface APIs.
19
*/
20
21
option
version
=
"1.1.0"
;
22
23
/** \brief PacketGenerator create interface request
24
@param client_index - opaque cookie to identify the sender
25
@param context - sender context, to match reply w/ request
26
@param interface_id - interface index
27
@param enable_gso - enable gso on this interface
28
@param gso_size - gso size on this interface
29
*/
30
define pg_create_interface
31
{
32
u32
client_index
;
33
u32
context
;
34
u32
interface_id
;
35
u8
gso_enabled
;
36
u32
gso_size
;
37
};
38
39
/** \brief PacketGenerator create interface response
40
@param context - sender context, to match reply w/ request
41
@param retval - return value for request
42
*/
43
define pg_create_interface_reply
44
{
45
u32
context
;
46
i32
retval
;
47
u32
sw_if_index
;
48
};
49
50
/** \brief PacketGenerator capture packets on given interface request
51
@param client_index - opaque cookie to identify the sender
52
@param context - sender context, to match reply w/ request
53
@param interface_id - pg interface index
54
@param is_enabled - 1 if enabling streams, 0 if disabling
55
@param count - number of packets to be captured
56
@param pcap_file - pacp file name to store captured packets
57
*/
58
autoreply define
pg_capture
59
{
60
u32
client_index
;
61
u32
context
;
62
u32
interface_id
;
63
u8
is_enabled
;
64
u32
count
;
65
u32
pcap_name_length
;
66
u8
pcap_file_name[pcap_name_length];
67
};
68
69
/** \brief Enable / disable packet generator request
70
@param client_index - opaque cookie to identify the sender
71
@param context - sender context, to match reply w/ request
72
@param is_enabled - 1 if enabling streams, 0 if disabling
73
@param stream - stream name to be enable/disabled, if not specified handle all streams
74
*/
75
autoreply define
pg_enable_disable
76
{
77
u32
client_index
;
78
u32
context
;
79
u8
is_enabled
;
80
u32
stream_name_length
;
81
u8
stream_name[stream_name_length];
82
};
83
84
/*
85
* Local Variables:
86
* eval: (c-set-style "gnu")
87
* End:
88
*/
vl_api_pg_create_interface_t::gso_enabled
u8 gso_enabled
Definition:
pg.api:35
pg_capture
clib_error_t * pg_capture(pg_capture_args_t *a)
Definition:
cli.c:81
vl_api_pg_capture_t::context
u32 context
Definition:
pg.api:61
vl_api_pg_create_interface_reply_t::context
u32 context
Definition:
pg.api:45
vl_api_pg_capture_t::is_enabled
u8 is_enabled
Definition:
pg.api:63
u8
unsigned char u8
Definition:
types.h:56
vl_api_pg_create_interface_t::interface_id
u32 interface_id
Definition:
pg.api:34
vl_api_pg_enable_disable_t::stream_name_length
u32 stream_name_length
Definition:
pg.api:80
u32
unsigned int u32
Definition:
types.h:88
vl_api_pg_create_interface_reply_t::sw_if_index
u32 sw_if_index
Definition:
pg.api:47
vl_api_pg_capture_t::count
u32 count
Definition:
pg.api:64
vl_api_pg_create_interface_t::gso_size
u32 gso_size
Definition:
pg.api:36
vl_api_pg_capture_t::pcap_name_length
u32 pcap_name_length
Definition:
pg.api:65
vl_api_pg_enable_disable_t::context
u32 context
Definition:
pg.api:78
version
option version
Definition:
pg.api:21
vl_api_pg_create_interface_reply_t::retval
i32 retval
Definition:
pg.api:46
i32
signed int i32
Definition:
types.h:77
pg_enable_disable
void pg_enable_disable(u32 stream_index, int is_enable)
Definition:
cli.c:58
vl_api_pg_capture_t::client_index
u32 client_index
Definition:
pg.api:60
vl_api_pg_create_interface_t::client_index
u32 client_index
Definition:
pg.api:32
vl_api_pg_enable_disable_t::is_enabled
u8 is_enabled
Definition:
pg.api:79
vl_api_pg_capture_t::interface_id
u32 interface_id
Definition:
pg.api:62
vl_api_pg_enable_disable_t::client_index
u32 client_index
Definition:
pg.api:77
vl_api_pg_create_interface_t::context
u32 context
Definition:
pg.api:33
src
vnet
pg
pg.api
Generated on Wed Sep 9 2020 00:05:29 for FD.io VPP by
1.8.13