2 *------------------------------------------------------------------
3 * classify_api.c - classify api
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
26 #include <vnet/classify/vnet_classify.h>
27 #include <vnet/classify/in_out_acl.h>
28 #include <vnet/classify/policer_classify.h>
29 #include <vnet/classify/flow_classify.h>
30 #include <vnet/l2/l2_classify.h>
32 #include <vnet/vnet_msg_enum.h>
34 #define vl_typedefs /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 #define vl_endianfun /* define message structures */
39 #include <vnet/vnet_all_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
45 #include <vnet/vnet_all_api_h.h>
48 #include <vlibapi/api_helper_macros.h>
50 #define foreach_vpe_api_msg \
51 _(CLASSIFY_ADD_DEL_TABLE, classify_add_del_table) \
52 _(CLASSIFY_ADD_DEL_SESSION, classify_add_del_session) \
53 _(CLASSIFY_TABLE_IDS,classify_table_ids) \
54 _(CLASSIFY_TABLE_BY_INTERFACE, classify_table_by_interface) \
55 _(CLASSIFY_TABLE_INFO,classify_table_info) \
56 _(CLASSIFY_SESSION_DUMP,classify_session_dump) \
57 _(POLICER_CLASSIFY_SET_INTERFACE, policer_classify_set_interface) \
58 _(POLICER_CLASSIFY_DUMP, policer_classify_dump) \
59 _(FLOW_CLASSIFY_SET_INTERFACE, flow_classify_set_interface) \
60 _(FLOW_CLASSIFY_DUMP, flow_classify_dump) \
61 _(INPUT_ACL_SET_INTERFACE, input_acl_set_interface) \
62 _(CLASSIFY_SET_INTERFACE_IP_TABLE, classify_set_interface_ip_table) \
63 _(CLASSIFY_SET_INTERFACE_L2_TABLES, classify_set_interface_l2_tables) \
64 _(OUTPUT_ACL_SET_INTERFACE, output_acl_set_interface)
66 #define foreach_classify_add_del_table_field \
76 static void vl_api_classify_add_del_table_t_handler
77 (vl_api_classify_add_del_table_t * mp)
79 vl_api_classify_add_del_table_reply_t *rmp;
80 vnet_classify_main_t *cm = &vnet_classify_main;
81 vnet_classify_table_t *t;
85 foreach_classify_add_del_table_field;
88 #define _(a) a = ntohl(mp->a);
89 foreach_classify_add_del_table_field;
92 if (mask_len != match_n_vectors * sizeof (u32x4))
94 rv = VNET_API_ERROR_INVALID_VALUE;
98 /* The underlying API fails silently, on purpose, so check here */
99 if (mp->is_add == 0) /* delete */
101 if (pool_is_free_index (cm->tables, table_index))
103 rv = VNET_API_ERROR_NO_SUCH_TABLE;
107 else /* add or update */
109 if (table_index != ~0 && pool_is_free_index (cm->tables, table_index))
113 u8 current_data_flag = mp->current_data_flag;
114 i16 current_data_offset = clib_net_to_host_i16 (mp->current_data_offset);
116 rv = vnet_classify_add_del_table
117 (cm, mp->mask, nbuckets, memory_size,
118 skip_n_vectors, match_n_vectors,
119 next_table_index, miss_next_index, &table_index,
120 current_data_flag, current_data_offset, mp->is_add, mp->del_chain);
124 REPLY_MACRO2(VL_API_CLASSIFY_ADD_DEL_TABLE_REPLY,
126 if (rv == 0 && mp->is_add)
128 t = pool_elt_at_index (cm->tables, table_index);
129 rmp->skip_n_vectors = htonl(t->skip_n_vectors);
130 rmp->match_n_vectors = htonl(t->match_n_vectors);
131 rmp->new_table_index = htonl(table_index);
135 rmp->skip_n_vectors = ~0;
136 rmp->match_n_vectors = ~0;
137 rmp->new_table_index = ~0;
143 static void vl_api_classify_add_del_session_t_handler
144 (vl_api_classify_add_del_session_t * mp)
146 vnet_classify_main_t *cm = &vnet_classify_main;
147 vl_api_classify_add_del_session_reply_t *rmp;
149 u32 table_index, hit_next_index, opaque_index, metadata, match_len;
152 vnet_classify_table_t *t;
154 table_index = ntohl (mp->table_index);
155 hit_next_index = ntohl (mp->hit_next_index);
156 opaque_index = ntohl (mp->opaque_index);
157 advance = ntohl (mp->advance);
159 metadata = ntohl (mp->metadata);
160 match_len = ntohl (mp->match_len);
162 if (pool_is_free_index (cm->tables, table_index))
164 rv = VNET_API_ERROR_NO_SUCH_TABLE;
168 t = pool_elt_at_index (cm->tables, table_index);
170 if (match_len != (t->skip_n_vectors + t->match_n_vectors) * sizeof (u32x4))
172 rv = VNET_API_ERROR_INVALID_VALUE;
176 rv = vnet_classify_add_del_session
177 (cm, table_index, mp->match, hit_next_index, opaque_index,
178 advance, action, metadata, mp->is_add);
181 REPLY_MACRO (VL_API_CLASSIFY_ADD_DEL_SESSION_REPLY);
185 vl_api_policer_classify_set_interface_t_handler
186 (vl_api_policer_classify_set_interface_t * mp)
188 vlib_main_t *vm = vlib_get_main ();
189 vl_api_policer_classify_set_interface_reply_t *rmp;
191 u32 sw_if_index, ip4_table_index, ip6_table_index, l2_table_index;
193 ip4_table_index = ntohl (mp->ip4_table_index);
194 ip6_table_index = ntohl (mp->ip6_table_index);
195 l2_table_index = ntohl (mp->l2_table_index);
196 sw_if_index = ntohl (mp->sw_if_index);
198 VALIDATE_SW_IF_INDEX (mp);
200 rv = vnet_set_policer_classify_intfc (vm, sw_if_index, ip4_table_index,
201 ip6_table_index, l2_table_index,
204 BAD_SW_IF_INDEX_LABEL;
206 REPLY_MACRO (VL_API_POLICER_CLASSIFY_SET_INTERFACE_REPLY);
210 send_policer_classify_details (u32 sw_if_index,
211 u32 table_index, vl_api_registration_t * reg,
214 vl_api_policer_classify_details_t *mp;
216 mp = vl_msg_api_alloc (sizeof (*mp));
217 clib_memset (mp, 0, sizeof (*mp));
218 mp->_vl_msg_id = ntohs (VL_API_POLICER_CLASSIFY_DETAILS);
219 mp->context = context;
220 mp->sw_if_index = htonl (sw_if_index);
221 mp->table_index = htonl (table_index);
223 vl_api_send_msg (reg, (u8 *) mp);
227 vl_api_policer_classify_dump_t_handler (vl_api_policer_classify_dump_t * mp)
229 vl_api_registration_t *reg;
230 policer_classify_main_t *pcm = &policer_classify_main;
233 u32 filter_sw_if_index;
235 reg = vl_api_client_index_to_registration (mp->client_index);
239 filter_sw_if_index = ntohl (mp->sw_if_index);
240 if (filter_sw_if_index
241 >= vec_len (pcm->classify_table_index_by_sw_if_index[mp->type]))
244 if (filter_sw_if_index != ~0)
246 &pcm->classify_table_index_by_sw_if_index[mp->type][filter_sw_if_index];
248 vec_tbl = pcm->classify_table_index_by_sw_if_index[mp->type];
250 if (vec_len (vec_tbl))
252 for (i = 0; i < vec_len (vec_tbl); i++)
254 if (vec_elt (vec_tbl, i) == ~0)
257 send_policer_classify_details (i, vec_elt (vec_tbl, i), reg,
264 vl_api_classify_table_ids_t_handler (vl_api_classify_table_ids_t * mp)
266 vl_api_registration_t *reg;
268 reg = vl_api_client_index_to_registration (mp->client_index);
272 vnet_classify_main_t *cm = &vnet_classify_main;
273 vnet_classify_table_t *t;
278 pool_foreach (t, cm->tables,
280 vec_add1 (table_ids, ntohl(t - cm->tables));
283 count = vec_len (table_ids);
285 vl_api_classify_table_ids_reply_t *rmp;
286 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp) + count * sizeof (u32));
287 rmp->_vl_msg_id = ntohs (VL_API_CLASSIFY_TABLE_IDS_REPLY);
288 rmp->context = mp->context;
289 rmp->count = ntohl (count);
290 clib_memcpy (rmp->ids, table_ids, count * sizeof (u32));
293 vl_api_send_msg (reg, (u8 *) rmp);
295 vec_free (table_ids);
299 vl_api_classify_table_by_interface_t_handler
300 (vl_api_classify_table_by_interface_t * mp)
302 vl_api_classify_table_by_interface_reply_t *rmp;
305 u32 sw_if_index = ntohl (mp->sw_if_index);
308 vec_validate (acl, IN_OUT_ACL_N_TABLES - 1);
311 VALIDATE_SW_IF_INDEX (mp);
313 in_out_acl_main_t *am = &in_out_acl_main;
318 for (type = 0; type < IN_OUT_ACL_N_TABLES; type++)
321 am->classify_table_index_by_sw_if_index[IN_OUT_ACL_INPUT_TABLE_GROUP]
323 if (vec_len (vec_tbl))
325 for (if_idx = 0; if_idx < vec_len (vec_tbl); if_idx++)
327 if (vec_elt (vec_tbl, if_idx) == ~0 || sw_if_index != if_idx)
331 acl[type] = vec_elt (vec_tbl, if_idx);
336 BAD_SW_IF_INDEX_LABEL;
339 REPLY_MACRO2(VL_API_CLASSIFY_TABLE_BY_INTERFACE_REPLY,
341 rmp->sw_if_index = ntohl(sw_if_index);
342 rmp->l2_table_id = ntohl(acl[IN_OUT_ACL_TABLE_L2]);
343 rmp->ip4_table_id = ntohl(acl[IN_OUT_ACL_TABLE_IP4]);
344 rmp->ip6_table_id = ntohl(acl[IN_OUT_ACL_TABLE_IP6]);
351 vl_api_classify_table_info_t_handler (vl_api_classify_table_info_t * mp)
353 vl_api_registration_t *reg;
355 reg = vl_api_client_index_to_registration (mp->client_index);
359 vl_api_classify_table_info_reply_t *rmp = 0;
361 vnet_classify_main_t *cm = &vnet_classify_main;
362 u32 table_id = ntohl (mp->table_id);
363 vnet_classify_table_t *t;
366 pool_foreach (t, cm->tables,
368 if (table_id == t - cm->tables)
370 rmp = vl_msg_api_alloc_as_if_client
371 (sizeof (*rmp) + t->match_n_vectors * sizeof (u32x4));
372 rmp->_vl_msg_id = ntohs (VL_API_CLASSIFY_TABLE_INFO_REPLY);
373 rmp->context = mp->context;
374 rmp->table_id = ntohl(table_id);
375 rmp->nbuckets = ntohl(t->nbuckets);
376 rmp->match_n_vectors = ntohl(t->match_n_vectors);
377 rmp->skip_n_vectors = ntohl(t->skip_n_vectors);
378 rmp->active_sessions = ntohl(t->active_elements);
379 rmp->next_table_index = ntohl(t->next_table_index);
380 rmp->miss_next_index = ntohl(t->miss_next_index);
381 rmp->mask_length = ntohl(t->match_n_vectors * sizeof (u32x4));
382 clib_memcpy(rmp->mask, t->mask, t->match_n_vectors * sizeof(u32x4));
391 rmp = vl_msg_api_alloc (sizeof (*rmp));
392 rmp->_vl_msg_id = ntohs ((VL_API_CLASSIFY_TABLE_INFO_REPLY));
393 rmp->context = mp->context;
394 rmp->retval = ntohl (VNET_API_ERROR_CLASSIFY_TABLE_NOT_FOUND);
397 vl_api_send_msg (reg, (u8 *) rmp);
401 send_classify_session_details (vl_api_registration_t * reg,
404 vnet_classify_entry_t * e, u32 context)
406 vl_api_classify_session_details_t *rmp;
408 rmp = vl_msg_api_alloc (sizeof (*rmp));
409 clib_memset (rmp, 0, sizeof (*rmp));
410 rmp->_vl_msg_id = ntohs (VL_API_CLASSIFY_SESSION_DETAILS);
411 rmp->context = context;
412 rmp->table_id = ntohl (table_id);
413 rmp->hit_next_index = ntohl (e->next_index);
414 rmp->advance = ntohl (e->advance);
415 rmp->opaque_index = ntohl (e->opaque_index);
416 rmp->match_length = ntohl (match_length);
417 clib_memcpy (rmp->match, e->key, match_length);
419 vl_api_send_msg (reg, (u8 *) rmp);
423 vl_api_classify_session_dump_t_handler (vl_api_classify_session_dump_t * mp)
425 vnet_classify_main_t *cm = &vnet_classify_main;
426 vl_api_registration_t *reg;
428 u32 table_id = ntohl (mp->table_id);
429 vnet_classify_table_t *t;
431 reg = vl_api_client_index_to_registration (mp->client_index);
436 pool_foreach (t, cm->tables,
438 if (table_id == t - cm->tables)
440 vnet_classify_bucket_t * b;
441 vnet_classify_entry_t * v, * save_v;
444 for (i = 0; i < t->nbuckets; i++)
450 save_v = vnet_classify_get_entry (t, b->offset);
451 for (j = 0; j < (1<<b->log2_pages); j++)
453 for (k = 0; k < t->entries_per_page; k++)
455 v = vnet_classify_entry_at_index
456 (t, save_v, j*t->entries_per_page + k);
457 if (vnet_classify_entry_is_free (v))
460 send_classify_session_details
461 (reg, table_id, t->match_n_vectors * sizeof (u32x4),
473 vl_api_flow_classify_set_interface_t_handler
474 (vl_api_flow_classify_set_interface_t * mp)
476 vlib_main_t *vm = vlib_get_main ();
477 vl_api_flow_classify_set_interface_reply_t *rmp;
479 u32 sw_if_index, ip4_table_index, ip6_table_index;
481 ip4_table_index = ntohl (mp->ip4_table_index);
482 ip6_table_index = ntohl (mp->ip6_table_index);
483 sw_if_index = ntohl (mp->sw_if_index);
485 VALIDATE_SW_IF_INDEX (mp);
487 rv = vnet_set_flow_classify_intfc (vm, sw_if_index, ip4_table_index,
488 ip6_table_index, mp->is_add);
490 BAD_SW_IF_INDEX_LABEL;
492 REPLY_MACRO (VL_API_FLOW_CLASSIFY_SET_INTERFACE_REPLY);
496 send_flow_classify_details (u32 sw_if_index,
497 u32 table_index, vl_api_registration_t * reg,
500 vl_api_flow_classify_details_t *mp;
502 mp = vl_msg_api_alloc (sizeof (*mp));
503 clib_memset (mp, 0, sizeof (*mp));
504 mp->_vl_msg_id = ntohs (VL_API_FLOW_CLASSIFY_DETAILS);
505 mp->context = context;
506 mp->sw_if_index = htonl (sw_if_index);
507 mp->table_index = htonl (table_index);
509 vl_api_send_msg (reg, (u8 *) mp);
513 vl_api_flow_classify_dump_t_handler (vl_api_flow_classify_dump_t * mp)
515 vl_api_registration_t *reg;
516 flow_classify_main_t *pcm = &flow_classify_main;
519 u32 filter_sw_if_index;
521 reg = vl_api_client_index_to_registration (mp->client_index);
525 filter_sw_if_index = ntohl (mp->sw_if_index);
526 if (filter_sw_if_index
527 >= vec_len (pcm->classify_table_index_by_sw_if_index[mp->type]))
530 if (filter_sw_if_index != ~0)
532 &pcm->classify_table_index_by_sw_if_index[mp->type][filter_sw_if_index];
534 vec_tbl = pcm->classify_table_index_by_sw_if_index[mp->type];
536 if (vec_len (vec_tbl))
538 for (i = 0; i < vec_len (vec_tbl); i++)
540 if (vec_elt (vec_tbl, i) == ~0)
543 send_flow_classify_details (i, vec_elt (vec_tbl, i), reg,
549 static void vl_api_classify_set_interface_ip_table_t_handler
550 (vl_api_classify_set_interface_ip_table_t * mp)
552 vlib_main_t *vm = vlib_get_main ();
553 vl_api_classify_set_interface_ip_table_reply_t *rmp;
556 VALIDATE_SW_IF_INDEX (mp);
558 u32 table_index = ntohl (mp->table_index);
559 u32 sw_if_index = ntohl (mp->sw_if_index);
562 rv = vnet_set_ip6_classify_intfc (vm, sw_if_index, table_index);
564 rv = vnet_set_ip4_classify_intfc (vm, sw_if_index, table_index);
566 BAD_SW_IF_INDEX_LABEL;
568 REPLY_MACRO (VL_API_CLASSIFY_SET_INTERFACE_IP_TABLE_REPLY);
571 static void vl_api_classify_set_interface_l2_tables_t_handler
572 (vl_api_classify_set_interface_l2_tables_t * mp)
574 vl_api_classify_set_interface_l2_tables_reply_t *rmp;
576 u32 sw_if_index, ip4_table_index, ip6_table_index, other_table_index;
579 ip4_table_index = ntohl (mp->ip4_table_index);
580 ip6_table_index = ntohl (mp->ip6_table_index);
581 other_table_index = ntohl (mp->other_table_index);
582 sw_if_index = ntohl (mp->sw_if_index);
584 VALIDATE_SW_IF_INDEX (mp);
587 rv = vnet_l2_input_classify_set_tables (sw_if_index, ip4_table_index,
591 rv = vnet_l2_output_classify_set_tables (sw_if_index, ip4_table_index,
597 if (ip4_table_index != ~0 || ip6_table_index != ~0
598 || other_table_index != ~0)
604 vnet_l2_input_classify_enable_disable (sw_if_index, enable);
606 vnet_l2_output_classify_enable_disable (sw_if_index, enable);
609 BAD_SW_IF_INDEX_LABEL;
611 REPLY_MACRO (VL_API_CLASSIFY_SET_INTERFACE_L2_TABLES_REPLY);
614 static void vl_api_input_acl_set_interface_t_handler
615 (vl_api_input_acl_set_interface_t * mp)
617 vlib_main_t *vm = vlib_get_main ();
618 vl_api_input_acl_set_interface_reply_t *rmp;
621 VALIDATE_SW_IF_INDEX (mp);
623 u32 ip4_table_index = ntohl (mp->ip4_table_index);
624 u32 ip6_table_index = ntohl (mp->ip6_table_index);
625 u32 l2_table_index = ntohl (mp->l2_table_index);
626 u32 sw_if_index = ntohl (mp->sw_if_index);
628 rv = vnet_set_input_acl_intfc (vm, sw_if_index, ip4_table_index,
629 ip6_table_index, l2_table_index, mp->is_add);
631 BAD_SW_IF_INDEX_LABEL;
633 REPLY_MACRO (VL_API_INPUT_ACL_SET_INTERFACE_REPLY);
636 static void vl_api_output_acl_set_interface_t_handler
637 (vl_api_output_acl_set_interface_t * mp)
639 vlib_main_t *vm = vlib_get_main ();
640 vl_api_output_acl_set_interface_reply_t *rmp;
643 VALIDATE_SW_IF_INDEX (mp);
645 u32 ip4_table_index = ntohl (mp->ip4_table_index);
646 u32 ip6_table_index = ntohl (mp->ip6_table_index);
647 u32 l2_table_index = ntohl (mp->l2_table_index);
648 u32 sw_if_index = ntohl (mp->sw_if_index);
650 rv = vnet_set_output_acl_intfc (vm, sw_if_index, ip4_table_index,
651 ip6_table_index, l2_table_index,
654 BAD_SW_IF_INDEX_LABEL;
656 REPLY_MACRO (VL_API_OUTPUT_ACL_SET_INTERFACE_REPLY);
660 * classify_api_hookup
661 * Add vpe's API message handlers to the table.
662 * vlib has already mapped shared memory and
663 * added the client registration handlers.
664 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
666 #define vl_msg_name_crc_list
667 #include <vnet/vnet_all_api_h.h>
668 #undef vl_msg_name_crc_list
671 setup_message_id_table (api_main_t * am)
673 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
674 foreach_vl_msg_name_crc_classify;
678 static clib_error_t *
679 classify_api_hookup (vlib_main_t * vm)
681 api_main_t *am = vlibapi_get_main ();
684 vl_msg_api_set_handlers(VL_API_##N, #n, \
685 vl_api_##n##_t_handler, \
687 vl_api_##n##_t_endian, \
688 vl_api_##n##_t_print, \
689 sizeof(vl_api_##n##_t), 1);
694 * Set up the (msg_name, crc, message-id) table
696 setup_message_id_table (am);
701 VLIB_API_INIT_FUNCTION (classify_api_hookup);
704 * fd.io coding-style-patch-verification: ON
707 * eval: (c-set-style "gnu")