qos: QoS dump APIs
[vpp.git] / src / vnet / qos / qos_record.c
1 /*
2  * Copyright (c) 2018 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 #include <vnet/qos/qos_record.h>
17 #include <vnet/ip/ip.h>
18 #include <vnet/ip/ip6_to_ip4.h>
19 #include <vnet/feature/feature.h>
20 #include <vnet/qos/qos_types.h>
21 #include <vnet/l2/l2_input.h>
22 #include <vnet/l2/feat_bitmap.h>
23
24 /**
25  * Per-interface, per-protocol vector of feature on/off configurations
26  */
27 u8 *qos_record_configs[QOS_N_SOURCES];
28 u32 l2_qos_input_next[QOS_N_SOURCES][32];
29
30 static void
31 qos_record_feature_config (u32 sw_if_index,
32                            qos_source_t input_source, u8 enable)
33 {
34   switch (input_source)
35     {
36     case QOS_SOURCE_IP:
37       vnet_feature_enable_disable ("ip6-unicast", "ip6-qos-record",
38                                    sw_if_index, enable, NULL, 0);
39       vnet_feature_enable_disable ("ip6-multicast", "ip6-qos-record",
40                                    sw_if_index, enable, NULL, 0);
41       vnet_feature_enable_disable ("ip4-unicast", "ip4-qos-record",
42                                    sw_if_index, enable, NULL, 0);
43       vnet_feature_enable_disable ("ip4-multicast", "ip4-qos-record",
44                                    sw_if_index, enable, NULL, 0);
45       l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_L2_IP_QOS_RECORD,
46                                   enable);
47       break;
48     case QOS_SOURCE_MPLS:
49       vnet_feature_enable_disable ("mpls-input", "mpls-qos-record",
50                                    sw_if_index, enable, NULL, 0);
51       break;
52     case QOS_SOURCE_VLAN:
53       vnet_feature_enable_disable ("ip6-unicast", "vlan-ip6-qos-record",
54                                    sw_if_index, enable, NULL, 0);
55       vnet_feature_enable_disable ("ip6-multicast", "vlan-ip6-qos-record",
56                                    sw_if_index, enable, NULL, 0);
57       vnet_feature_enable_disable ("ip4-unicast", "vlan-ip4-qos-record",
58                                    sw_if_index, enable, NULL, 0);
59       vnet_feature_enable_disable ("ip4-multicast", "vlan-ip4-qos-record",
60                                    sw_if_index, enable, NULL, 0);
61       vnet_feature_enable_disable ("mpls-input", "vlan-mpls-qos-record",
62                                    sw_if_index, enable, NULL, 0);
63       break;
64     case QOS_SOURCE_EXT:
65       /* not a valid option for recording */
66       break;
67     }
68 }
69
70 int
71 qos_record_enable (u32 sw_if_index, qos_source_t input_source)
72 {
73   vec_validate (qos_record_configs[input_source], sw_if_index);
74
75   if (0 == qos_record_configs[input_source][sw_if_index])
76     {
77       qos_record_feature_config (sw_if_index, input_source, 1);
78     }
79
80   qos_record_configs[input_source][sw_if_index]++;
81   return (0);
82 }
83
84 int
85 qos_record_disable (u32 sw_if_index, qos_source_t input_source)
86 {
87   if (vec_len (qos_record_configs[input_source]) <= sw_if_index)
88     return VNET_API_ERROR_NO_MATCHING_INTERFACE;
89
90   if (0 == qos_record_configs[input_source][sw_if_index])
91     return VNET_API_ERROR_VALUE_EXIST;
92
93   qos_record_configs[input_source][sw_if_index]--;
94
95   if (0 == qos_record_configs[input_source][sw_if_index])
96     {
97       qos_record_feature_config (sw_if_index, input_source, 0);
98     }
99
100   return (0);
101 }
102
103 void
104 qos_record_walk (qos_record_walk_cb_t fn, void *c)
105 {
106   qos_source_t qs;
107
108   FOR_EACH_QOS_SOURCE (qs)
109   {
110     u32 sw_if_index;
111
112     vec_foreach_index (sw_if_index, qos_record_configs[qs])
113     {
114       if (0 != qos_record_configs[qs][sw_if_index])
115         fn (sw_if_index, qs, c);
116     }
117   }
118 }
119
120 /*
121  * Disable recording feature for all protocols when the interface
122  * is deleted
123  */
124 static clib_error_t *
125 qos_record_ip_interface_add_del (vnet_main_t * vnm,
126                                  u32 sw_if_index, u32 is_add)
127 {
128   if (!is_add)
129     {
130       qos_source_t qs;
131
132       FOR_EACH_QOS_SOURCE (qs)
133       {
134         while (qos_record_disable (sw_if_index, qs) == 0);
135       }
136     }
137
138   return (NULL);
139 }
140
141 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (qos_record_ip_interface_add_del);
142
143 clib_error_t *
144 qos_record_init (vlib_main_t * vm)
145 {
146   qos_source_t qs;
147   vlib_node_t *node = vlib_get_node_by_name (vm, (u8 *) "l2-ip-qos-record");
148
149   /* Initialize the feature next-node indexes */
150   FOR_EACH_QOS_SOURCE (qs)
151     feat_bitmap_init_next_nodes (vm,
152                                  node->index,
153                                  L2INPUT_N_FEAT,
154                                  l2input_get_feat_names (),
155                                  l2_qos_input_next[qs]);
156   return 0;
157 }
158
159 VLIB_INIT_FUNCTION (qos_record_init);
160
161 static clib_error_t *
162 qos_record_cli (vlib_main_t * vm,
163                 unformat_input_t * input, vlib_cli_command_t * cmd)
164 {
165   vnet_main_t *vnm = vnet_get_main ();
166   u32 sw_if_index, qs;
167   u8 enable;
168
169   qs = 0xff;
170   enable = 1;
171   sw_if_index = ~0;
172
173   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
174     {
175       if (unformat (input, "%U", unformat_vnet_sw_interface,
176                     vnm, &sw_if_index))
177         ;
178       else if (unformat (input, "%U", unformat_qos_source, &qs))
179         ;
180       else if (unformat (input, "enable"))
181         enable = 1;
182       else if (unformat (input, "disable"))
183         enable = 0;
184       else
185         break;
186     }
187
188   if (~0 == sw_if_index)
189     return clib_error_return (0, "interface must be specified");
190   if (0xff == qs)
191     return clib_error_return (0, "input location must be specified");
192
193   if (enable)
194     qos_record_enable (sw_if_index, qs);
195   else
196     qos_record_disable (sw_if_index, qs);
197
198   return (NULL);
199 }
200
201 /*?
202  * Enable QoS bit recording on an interface using the packet's input DSCP bits
203  * Which input QoS bits to use are either; IP, MPLS or VLAN. If more than
204  * one protocol is chosen (which is foolish) the higher layers override the
205  * lower.
206  *
207  * @cliexpar
208  * @cliexcmd{qos record ip GigEthernet0/1/0}
209  ?*/
210 /* *INDENT-OFF* */
211 VLIB_CLI_COMMAND (qos_record_command, static) = {
212   .path = "qos record",
213   .short_help = "qos record <record-source> <INTERFACE> [disable]",
214   .function = qos_record_cli,
215   .is_mp_safe = 1,
216 };
217 /* *INDENT-ON* */
218
219 static void
220 qos_record_show_one_interface (vlib_main_t * vm, u32 sw_if_index)
221 {
222   u8 n_cfgs[QOS_N_SOURCES] = { };
223   qos_source_t qs;
224   bool set;
225
226   set = false;
227
228   FOR_EACH_QOS_SOURCE (qs)
229   {
230     if (vec_len (qos_record_configs[qs]) <= sw_if_index)
231       continue;
232     if (0 != (n_cfgs[qs] = qos_record_configs[qs][sw_if_index]))
233       set = true;
234   }
235
236   if (set)
237     {
238       vlib_cli_output (vm, " %U:", format_vnet_sw_if_index_name,
239                        vnet_get_main (), sw_if_index);
240
241       FOR_EACH_QOS_SOURCE (qs)
242       {
243         if (n_cfgs[qs] != 0)
244           vlib_cli_output (vm, "  %U", format_qos_source, qs);
245       }
246     }
247 }
248
249 static clib_error_t *
250 qos_record_show (vlib_main_t * vm,
251                  unformat_input_t * input, vlib_cli_command_t * cmd)
252 {
253   vnet_main_t *vnm = vnet_get_main ();
254   qos_source_t qs;
255   u32 sw_if_index;
256
257   sw_if_index = ~0;
258
259   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
260     {
261       if (unformat (input, "%U", unformat_vnet_sw_interface,
262                     vnm, &sw_if_index))
263         ;
264     }
265
266   if (~0 == sw_if_index)
267     {
268       u32 ii, n_ints = 0;
269
270       FOR_EACH_QOS_SOURCE (qs)
271       {
272         n_ints = clib_max (n_ints, vec_len (qos_record_configs[qs]));
273       }
274
275       for (ii = 0; ii < n_ints; ii++)
276         {
277           qos_record_show_one_interface (vm, ii);
278         }
279     }
280   else
281     qos_record_show_one_interface (vm, sw_if_index);
282
283   return (NULL);
284 }
285
286 /*?
287  * Show Egress Qos Maps
288  *
289  * @cliexpar
290  * @cliexcmd{show qos egress map}
291  ?*/
292 /* *INDENT-OFF* */
293 VLIB_CLI_COMMAND (qos_record_show_command, static) = {
294   .path = "show qos record",
295   .short_help = "show qos record [interface]",
296   .function = qos_record_show,
297   .is_mp_safe = 1,
298 };
299 /* *INDENT-ON* */
300
301 /*
302  * fd.io coding-style-patch-verification: ON
303  *
304  * Local Variables:
305  * eval: (c-set-style "gnu")
306  * End:
307  */