qos: QoS dump APIs
[vpp.git] / src / vnet / qos / qos_mark.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/ip/ip.h>
17 #include <vnet/feature/feature.h>
18 #include <vnet/qos/qos_egress_map.h>
19 #include <vnet/qos/qos_mark.h>
20
21 /**
22  * per-interface vector of which MAP is used by which interface
23  * for each output source
24  */
25 index_t *qos_mark_configs[QOS_N_SOURCES];
26
27 void
28 qos_mark_ip_enable_disable (u32 sw_if_index, u8 enable)
29 {
30   vnet_feature_enable_disable ("ip6-output", "ip6-qos-mark",
31                                sw_if_index, enable, NULL, 0);
32   vnet_feature_enable_disable ("ip4-output", "ip4-qos-mark",
33                                sw_if_index, enable, NULL, 0);
34 }
35
36 void
37 qos_mark_vlan_enable_disable (u32 sw_if_index, u8 enable)
38 {
39   /*
40    * one cannot run a feature on a sub-interface, so we need
41    * to enable a feature on all the L3 output paths
42    */
43   vnet_feature_enable_disable ("ip6-output", "vlan-ip6-qos-mark",
44                                sw_if_index, enable, NULL, 0);
45   vnet_feature_enable_disable ("ip4-output", "vlan-ip4-qos-mark",
46                                sw_if_index, enable, NULL, 0);
47   vnet_feature_enable_disable ("mpls-output", "vlan-mpls-qos-mark",
48                                sw_if_index, enable, NULL, 0);
49 }
50
51 void
52 qos_mark_mpls_enable_disable (u32 sw_if_index, u8 enable)
53 {
54   vnet_feature_enable_disable ("mpls-output", "mpls-qos-mark",
55                                sw_if_index, enable, NULL, 0);
56 }
57
58 static void
59 qos_egress_map_feature_config (u32 sw_if_index, qos_source_t qs, u8 enable)
60 {
61   switch (qs)
62     {
63     case QOS_SOURCE_EXT:
64       ASSERT (0);
65       break;
66     case QOS_SOURCE_VLAN:
67       qos_mark_vlan_enable_disable (sw_if_index, enable);
68       break;
69     case QOS_SOURCE_MPLS:
70       qos_mark_mpls_enable_disable (sw_if_index, enable);
71       break;
72     case QOS_SOURCE_IP:
73       qos_mark_ip_enable_disable (sw_if_index, enable);
74       break;
75     }
76 }
77
78 int
79 qos_mark_enable (u32 sw_if_index,
80                  qos_source_t output_source, qos_egress_map_id_t mid)
81 {
82   index_t qemi;
83
84   vec_validate_init_empty (qos_mark_configs[output_source],
85                            sw_if_index, INDEX_INVALID);
86
87   qemi = qos_egress_map_find (mid);
88
89   if (INDEX_INVALID == qemi)
90     return VNET_API_ERROR_NO_SUCH_TABLE;
91
92   if (INDEX_INVALID == qos_mark_configs[output_source][sw_if_index])
93     {
94       qos_egress_map_feature_config (sw_if_index, output_source, 1);
95     }
96
97   qos_mark_configs[output_source][sw_if_index] = qemi;
98
99   return (0);
100 }
101
102 int
103 qos_mark_disable (u32 sw_if_index, qos_source_t output_source)
104 {
105   if (vec_len (qos_mark_configs[output_source]) <= sw_if_index)
106     return VNET_API_ERROR_NO_MATCHING_INTERFACE;
107   if (INDEX_INVALID == qos_mark_configs[output_source][sw_if_index])
108     return VNET_API_ERROR_VALUE_EXIST;
109
110   if (INDEX_INVALID != qos_mark_configs[output_source][sw_if_index])
111     {
112       qos_egress_map_feature_config (sw_if_index, output_source, 0);
113     }
114
115   qos_mark_configs[output_source][sw_if_index] = INDEX_INVALID;
116
117   return (0);
118 }
119
120 void
121 qos_mark_walk (qos_mark_walk_cb_t fn, void *c)
122 {
123   qos_source_t qs;
124
125   FOR_EACH_QOS_SOURCE (qs)
126   {
127     u32 sw_if_index;
128
129     vec_foreach_index (sw_if_index, qos_mark_configs[qs])
130     {
131       if (INDEX_INVALID != qos_mark_configs[qs][sw_if_index])
132         fn (sw_if_index,
133             qos_egress_map_get_id (qos_mark_configs[qs][sw_if_index]), qs, c);
134     }
135   }
136 }
137
138 static clib_error_t *
139 qos_mark_cli (vlib_main_t * vm,
140               unformat_input_t * input, vlib_cli_command_t * cmd)
141 {
142   qos_egress_map_id_t map_id;
143   u32 sw_if_index, qs;
144   vnet_main_t *vnm;
145   int rv, enable;
146
147   vnm = vnet_get_main ();
148   map_id = ~0;
149   qs = 0xff;
150   enable = 1;
151
152   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
153     {
154       if (unformat (input, "id %d", &map_id))
155         ;
156       else if (unformat (input, "disable"))
157         enable = 0;
158       else if (unformat (input, "%U", unformat_qos_source, &qs))
159         ;
160       else if (unformat (input, "%U",
161                          unformat_vnet_sw_interface, vnm, &sw_if_index))
162         ;
163       else
164         break;
165     }
166
167   if (~0 == sw_if_index)
168     return clib_error_return (0, "interface must be specified");
169   if (0xff == qs)
170     return clib_error_return (0, "output location must be specified");
171
172   if (enable)
173     rv = qos_mark_enable (sw_if_index, qs, map_id);
174   else
175     rv = qos_mark_disable (sw_if_index, qs);
176
177   if (0 == rv)
178     return (NULL);
179
180   return clib_error_return (0, "Failed to map interface");
181 }
182
183 /*?
184  * Apply a QoS egress mapping table to an interface for QoS marking packets
185  * at the given output protocol.
186  *
187  * @cliexpar
188  * @cliexcmd{qos egress interface GigEthernet0/9/0 id 0 output ip}
189  ?*/
190 /* *INDENT-OFF* */
191 VLIB_CLI_COMMAND (qos_egress_map_interface_command, static) = {
192   .path = "qos mark",
193   .short_help = "qos mark <SOURCE> <INTERFACE> id <MAP>",
194   .function = qos_mark_cli,
195   .is_mp_safe = 1,
196 };
197 /* *INDENT-ON* */
198
199 static void
200 qos_mark_show_one_interface (vlib_main_t * vm, u32 sw_if_index)
201 {
202   index_t qemis[QOS_N_SOURCES];
203   qos_source_t qs;
204   bool set;
205
206   set = false;
207   clib_memset_u32 (qemis, INDEX_INVALID, QOS_N_SOURCES);
208
209   FOR_EACH_QOS_SOURCE (qs)
210   {
211     if (vec_len (qos_mark_configs[qs]) <= sw_if_index)
212       continue;
213     if (INDEX_INVALID != (qemis[qs] = qos_mark_configs[qs][sw_if_index]))
214       set = true;
215   }
216
217   if (set)
218     {
219       vlib_cli_output (vm, " %U:", format_vnet_sw_if_index_name,
220                        vnet_get_main (), sw_if_index);
221
222       FOR_EACH_QOS_SOURCE (qs)
223       {
224         if (qemis[qs] != INDEX_INVALID)
225           vlib_cli_output (vm, "  %U: map:%d", format_qos_source, qs,
226                            qemis[qs]);
227       }
228     }
229 }
230
231 static clib_error_t *
232 qos_mark_show (vlib_main_t * vm,
233                unformat_input_t * input, vlib_cli_command_t * cmd)
234 {
235   vnet_main_t *vnm = vnet_get_main ();
236   qos_source_t qs;
237   u32 sw_if_index;
238
239   sw_if_index = ~0;
240
241   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
242     {
243       if (unformat (input, "%U", unformat_vnet_sw_interface,
244                     vnm, &sw_if_index))
245         ;
246     }
247
248   if (~0 == sw_if_index)
249     {
250       u32 ii, n_ints = 0;
251
252       FOR_EACH_QOS_SOURCE (qs)
253       {
254         n_ints = clib_max (n_ints, vec_len (qos_mark_configs[qs]));
255       }
256
257       for (ii = 0; ii < n_ints; ii++)
258         {
259           qos_mark_show_one_interface (vm, ii);
260         }
261     }
262   else
263     qos_mark_show_one_interface (vm, sw_if_index);
264
265   return (NULL);
266 }
267
268 /*?
269  * Show Egress Qos Maps
270  *
271  * @cliexpar
272  * @cliexcmd{show qos egress map}
273  ?*/
274 /* *INDENT-OFF* */
275 VLIB_CLI_COMMAND (qos_mark_show_command, static) = {
276   .path = "show qos mark",
277   .short_help = "show qos mark [interface]",
278   .function = qos_mark_show,
279   .is_mp_safe = 1,
280 };
281 /* *INDENT-ON* */
282
283 /*
284  * fd.io coding-style-patch-verification: ON
285  *
286 * Local Variables:
287 * eval: (c-set-style "gnu")
288 * End:
289 *
290 */