aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp/stats/stats.api
blob: 7f745859610ee88d5020c8b0eed8832c1fee9422 (plain)
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
 * 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 the stats API 
*/


/** \brief Want Stats, enable/disable ALL stats updates
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param enable_disable - 1 = enable stats, 0 = disable
    @param pid - pid of process requesting stats updates
*/
autoreply define want_stats
{
  u32 client_index;
  u32 context;
  u32 enable_disable;
  u32 pid;
};

/** \brief Want Interface Simple Stats, register for detailed interface stats
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param enable_disable - 1 = enable stats, 0 = disable
    @param pid - pid of process requesting stats updates
*/
autoreply define want_interface_simple_stats
{
  u32 client_index;
  u32 context;
  u32 enable_disable;
  u32 pid;
};

/** \brief Want Interface Combined Stats, register for continuous stats
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param enable_disable - 1 = enable stats, 0 = disable
    @param pid - pid of process requesting stats updates
*/
autoreply define want_interface_combined_stats
{
  u32 client_index;
  u32 context;
  u32 enable_disable;
  u32 pid;
};

/** \brief Want IP4 FIB Stats, register for continuous stats
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param enable_disable - 1 = enable stats, 0 = disable
    @param pid - pid of process requesting stats updates
*/
autoreply define want_ip4_fib_stats
{
  u32 client_index;
  u32 context;
  u32 enable_disable;
  u32 pid;
};

/** \brief Want IP6 FIB Stats, register for continuous stats
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param enable_disable - 1 = enable stats, 0 = disable
    @param pid - pid of process requesting stats updates
*/
autoreply define want_ip6_fib_stats
{
  u32 client_index;
  u32 context;
  u32 enable_disable;
  u32 pid;
};

/** \brief Want IP4 NBR Stats, register for continuous stats
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param enable_disable - 1 = enable stats, 0 = disable
    @param pid - pid of process requesting stats updates
*/
autoreply define want_ip4_nbr_stats
{
  u32 client_index;
  u32 context;
  u32 enable_disable;
  u32 pid;
};

/** \brief Want IP6 NBR Stats, register for continuous stats
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param enable_disable - 1 = enable stats, 0 = disable
    @param pid - pid of process requesting stats updates
*/
autoreply define want_ip6_nbr_stats
{
  u32 client_index;
  u32 context;
  u32 enable_disable;
  u32 pid;
};

typeonly manual_print manual_endian define ip4_fib_counter
{
  u32 address;
  u8 address_length;
  u64 packets;
  u64 bytes;
};

manual_print manual_endian define vnet_ip4_fib_counters
{
  u32 vrf_id;
  u32 count;
  vl_api_ip4_fib_counter_t c[count];
};

typeonly manual_print manual_endian define ip4_nbr_counter
{
  u32 address;
  u8  link_type;
  u64 packets;
  u64 bytes;
};

/**
 * @brief Per-neighbour (i.e. per-adjacency) coutners
 * @param count The size of the array of counters
 * @param sw_if_index The interface the adjacency is on
 * @param begin Flag to indicate this is the first set of stats for this
 *        interface. If this flag is not set the it is a continuation of
 *        stats for this interface
 * @param  c counters
 */
manual_print manual_endian define vnet_ip4_nbr_counters
{
  u32 count;
  u32 sw_if_index;
  u8 begin;
  vl_api_ip4_nbr_counter_t c[count];
};

typeonly manual_print manual_endian define ip6_fib_counter
{
  u64 address[2];
  u8 address_length;
  u64 packets;
  u64 bytes;
};

manual_print manual_endian define vnet_ip6_fib_counters
{
  u32 vrf_id;
  u32 count;
  vl_api_ip6_fib_counter_t c[count];
};

typeonly manual_print manual_endian define ip6_nbr_counter
{
  u64 address[2];
  u8  link_type;
  u64 packets;
  u64 bytes;
};

manual_print manual_endian define vnet_ip6_nbr_counters
{
  u32 count;
  u32 sw_if_index;
  u8 begin;
  vl_api_ip6_nbr_counter_t c[count];
};


/** \brief Request for a single block of summary stats
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
*/
define vnet_get_summary_stats
{
  u32 client_index;
  u32 context;
};

/** \brief Reply for vnet_get_summary_stats request
    @param context - sender context, to match reply w/ request
    @param retval - return code for request
    @param total_pkts -  
    @param total_bytes -
    @param vector_rate - 
*/
define vnet_get_summary_stats_reply
{
  u32 context;
  i32 retval;
  u64 total_pkts[2];
  u64 total_bytes[2];
  f64 vector_rate;
};

/*
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
>resources.libraries.python.QemuUtils | ... | Force Tags | 3_NODE_SINGLE_LINK_TOPO | PERFTEST | HW_ENV | MRR | ... | NIC_Intel-X520-DA2 | ETH | L2BDMACLRN | BASE | VHOST | VM | VHOST_256 | ... | CFS_OPT | ... | Suite Setup | Set up 3-node performance topology with DUT's NIC model | ... | L2 | Intel-X520-DA2 | Suite Teardown | Tear down 3-node performance topology | ... | Test Setup | Set up performance test | Test Teardown | Tear down performance mrr test with vhost and VM with dpdk-testpmd | ... | dut1_node=${dut1} | dut1_vm_refs=${dut1_vm_refs} | ... | dut2_node=${dut2} | dut2_vm_refs=${dut2_vm_refs} | ... | Test Template | Local Template | ... | Documentation | *Raw results L2BD test cases with vhost* | ... | ... | *[Top] Network Topologies:* TG-DUT1-DUT2-TG 3-node circular topology | ... | with single links between nodes. | ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L2 switching of IPv4. 802.1q | ... | tagging is applied on link between DUT1 and DUT2. | ... | *[Cfg] DUT configuration:* DUT1 and DUT2 are configured with L2 bridge- | ... | domain and MAC learning enabled. Qemu Guest is connected to VPP via | ... | vhost-user interfaces. Guest is running DPDK testpmd interconnecting | ... | vhost-user interfaces using 5 cores pinned to cpus 5-9 and 2048M | ... | memory. Testpmd is using socket-mem=1024M (512x2M hugepages), 5 cores | ... | (1 main core and 4 cores dedicated for io), forwarding mode is set to | ... | io, rxd/txd=256, burst=64. Scheduler policy is set to SCHED_RR with | ... | priority 1 for all Qemu CPUs. DUT1, DUT2 are tested with 2p10GE NIC X520 | ... | Niantic by Intel. | ... | *[Ver] TG verification:* In MaxReceivedRate test TG sends traffic | ... | at line rate and reports total received/sent packets over trial period. | ... | Test packets are generated by TG on | ... | links to DUTs. TG traffic profile contains two L3 flow-groups | ... | (flow-group per direction, 253 flows per flow-group) with all packets | ... | containing Ethernet header, IPv4 header with IP protocol=61 and static | ... | payload. MAC addresses are matching MAC addresses of the TG node | ... | interfaces. | ... | *[Ref] Applicable standard specifications:* RFC2544. *** Variables *** # X520-DA2 bandwidth limit | ${s_limit}= | ${10000000000} # Traffic profile: | ${traffic_profile}= | trex-sl-3n-ethip4-ip4src254 *** Keywords *** | Local Template | | [Documentation] | | ... | [Cfg] DUT runs L2BD switching config. | | ... | Each DUT uses ${phy_cores} physical core(s) for worker threads. | | ... | [Ver] Measure MaxReceivedRate for ${framesize}B frames using single\ | | ... | trial throughput test. | | ... | | ... | *Arguments:* | | ... | - framesize - Framesize in Bytes in integer or string (IMIX_v4_1). | | ... | Type: integer, string | | ... | - phy_cores - Number of physical cores. Type: integer | | ... | - rxq - Number of RX queues, default value: ${None}. Type: integer | | ... | | [Arguments] | ${framesize} | ${phy_cores} | ${rxq}=${None} | | ... | | ${dut1_vm_refs}= | Create Dictionary | | ${dut2_vm_refs}= | Create Dictionary | | Set Test Variable | ${dut1_vm_refs} | | Set Test Variable | ${dut2_vm_refs} | | ... | | Given Add worker threads and rxqueues to all DUTs | ${phy_cores} | ${rxq} | | And Add PCI devices to all DUTs | | ${max_rate} | ${jumbo} = | Get Max Rate And Jumbo And Handle Multi Seg | | ... | ${s_limit} | ${framesize} | | And Apply startup configuration on all VPP DUTs | | When Initialize L2 bridge domains with Vhost-User | nf_nodes=${1} | | And Configure guest VMs with dpdk-testpmd connected via vhost-user | | ... | vm_count=${1} | jumbo=${jumbo} | perf_qemu_qsz=${256} | | ... | use_tuned_cfs=${True} | | And Setup Scheduler Policy for Vpp On All DUTs | | Then Traffic should pass with maximum rate | | ... | ${max_rate}pps | ${framesize} | ${traffic_profile} *** Test Cases *** | tc01-64B-1c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 64B | 1C | | framesize=${64} | phy_cores=${1} | tc02-64B-2c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 64B | 2C | | framesize=${64} | phy_cores=${2} | tc03-64B-4c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 64B | 4C | | framesize=${64} | phy_cores=${4} | tc04-1518B-1c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 1518B | 1C | | framesize=${1518} | phy_cores=${1} | tc05-1518B-2c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 1518B | 2C | | framesize=${1518} | phy_cores=${2} | tc06-1518B-4c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 1518B | 4C | | framesize=${1518} | phy_cores=${4} | tc07-9000B-1c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 9000B | 1C | | framesize=${9000} | phy_cores=${1} | tc08-9000B-2c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 9000B | 2C | | framesize=${9000} | phy_cores=${2} | tc09-9000B-4c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | 9000B | 4C | | framesize=${9000} | phy_cores=${4} | tc10-IMIX-1c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | IMIX | 1C | | framesize=IMIX_v4_1 | phy_cores=${1} | tc11-IMIX-2c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | IMIX | 2C | | framesize=IMIX_v4_1 | phy_cores=${2} | tc12-IMIX-4c-eth-l2bdbasemaclrn-eth-2vhostvr256-1vm-cfsrr1-mrr | | [Tags] | IMIX | 4C | | framesize=IMIX_v4_1 | phy_cores=${4}