2 *------------------------------------------------------------------
3 * policer_api.c - policer 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>
25 #include <vnet/policer/policer.h>
27 #include <vnet/vnet_msg_enum.h>
29 #define vl_typedefs /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
33 #define vl_endianfun /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
40 #include <vnet/vnet_all_api_h.h>
43 #include <vlibapi/api_helper_macros.h>
45 #define foreach_vpe_api_msg \
46 _ (POLICER_ADD_DEL, policer_add_del) \
47 _ (POLICER_BIND, policer_bind) \
48 _ (POLICER_INPUT, policer_input) \
49 _ (POLICER_DUMP, policer_dump)
52 vl_api_policer_add_del_t_handler (vl_api_policer_add_del_t * mp)
54 vlib_main_t *vm = vlib_get_main ();
55 vl_api_policer_add_del_reply_t *rmp;
58 qos_pol_cfg_params_st cfg;
62 name = format (0, "%s", mp->name);
63 vec_terminate_c_string (name);
65 clib_memset (&cfg, 0, sizeof (cfg));
66 cfg.rfc = (qos_policer_type_en) mp->type;
67 cfg.rnd_type = (qos_round_type_en) mp->round_type;
68 cfg.rate_type = (qos_rate_type_en) mp->rate_type;
69 cfg.rb.kbps.cir_kbps = ntohl (mp->cir);
70 cfg.rb.kbps.eir_kbps = ntohl (mp->eir);
71 cfg.rb.kbps.cb_bytes = clib_net_to_host_u64 (mp->cb);
72 cfg.rb.kbps.eb_bytes = clib_net_to_host_u64 (mp->eb);
73 cfg.conform_action.action_type =
74 (qos_action_type_en) mp->conform_action.type;
75 cfg.conform_action.dscp = mp->conform_action.dscp;
76 cfg.exceed_action.action_type = (qos_action_type_en) mp->exceed_action.type;
77 cfg.exceed_action.dscp = mp->exceed_action.dscp;
78 cfg.violate_action.action_type =
79 (qos_action_type_en) mp->violate_action.type;
80 cfg.violate_action.dscp = mp->violate_action.dscp;
82 cfg.color_aware = mp->color_aware;
84 error = policer_add_del (vm, name, &cfg, &policer_index, mp->is_add);
87 rv = VNET_API_ERROR_UNSPECIFIED;
90 REPLY_MACRO2(VL_API_POLICER_ADD_DEL_REPLY,
92 if (rv == 0 && mp->is_add)
93 rmp->policer_index = ntohl(policer_index);
95 rmp->policer_index = ~0;
101 vl_api_policer_bind_t_handler (vl_api_policer_bind_t *mp)
103 vl_api_policer_bind_reply_t *rmp;
109 name = format (0, "%s", mp->name);
110 vec_terminate_c_string (name);
112 worker_index = ntohl (mp->worker_index);
113 bind_enable = mp->bind_enable;
115 rv = policer_bind_worker (name, worker_index, bind_enable);
117 REPLY_MACRO (VL_API_POLICER_BIND_REPLY);
121 vl_api_policer_input_t_handler (vl_api_policer_input_t *mp)
123 vl_api_policer_bind_reply_t *rmp;
129 VALIDATE_SW_IF_INDEX (mp);
131 name = format (0, "%s", mp->name);
132 vec_terminate_c_string (name);
134 sw_if_index = ntohl (mp->sw_if_index);
137 rv = policer_input (name, sw_if_index, apply);
140 BAD_SW_IF_INDEX_LABEL;
141 REPLY_MACRO (VL_API_POLICER_INPUT_REPLY);
145 send_policer_details (u8 *name, qos_pol_cfg_params_st *config,
146 policer_t *templ, vl_api_registration_t *reg,
149 vl_api_policer_details_t *mp;
151 mp = vl_msg_api_alloc (sizeof (*mp));
152 clib_memset (mp, 0, sizeof (*mp));
153 mp->_vl_msg_id = ntohs (VL_API_POLICER_DETAILS);
154 mp->context = context;
155 mp->cir = htonl (config->rb.kbps.cir_kbps);
156 mp->eir = htonl (config->rb.kbps.eir_kbps);
157 mp->cb = clib_host_to_net_u64 (config->rb.kbps.cb_bytes);
158 mp->eb = clib_host_to_net_u64 (config->rb.kbps.eb_bytes);
159 mp->rate_type = (vl_api_sse2_qos_rate_type_t) config->rate_type;
160 mp->round_type = (vl_api_sse2_qos_round_type_t) config->rnd_type;
161 mp->type = (vl_api_sse2_qos_policer_type_t) config->rfc;
162 mp->conform_action.type =
163 (vl_api_sse2_qos_action_type_t) config->conform_action.action_type;
164 mp->conform_action.dscp = config->conform_action.dscp;
165 mp->exceed_action.type =
166 (vl_api_sse2_qos_action_type_t) config->exceed_action.action_type;
167 mp->exceed_action.dscp = config->exceed_action.dscp;
168 mp->violate_action.type =
169 (vl_api_sse2_qos_action_type_t) config->violate_action.action_type;
170 mp->violate_action.dscp = config->violate_action.dscp;
171 mp->single_rate = templ->single_rate ? 1 : 0;
172 mp->color_aware = templ->color_aware ? 1 : 0;
173 mp->scale = htonl (templ->scale);
174 mp->cir_tokens_per_period = htonl (templ->cir_tokens_per_period);
175 mp->pir_tokens_per_period = htonl (templ->pir_tokens_per_period);
176 mp->current_limit = htonl (templ->current_limit);
177 mp->current_bucket = htonl (templ->current_bucket);
178 mp->extended_limit = htonl (templ->extended_limit);
179 mp->extended_bucket = htonl (templ->extended_bucket);
180 mp->last_update_time = clib_host_to_net_u64 (templ->last_update_time);
182 strncpy ((char *) mp->name, (char *) name, ARRAY_LEN (mp->name) - 1);
184 vl_api_send_msg (reg, (u8 *) mp);
188 vl_api_policer_dump_t_handler (vl_api_policer_dump_t * mp)
190 vl_api_registration_t *reg;
191 vnet_policer_main_t *pm = &vnet_policer_main;
197 qos_pol_cfg_params_st *config;
200 reg = vl_api_client_index_to_registration (mp->client_index);
204 if (mp->match_name_valid)
206 match_name = format (0, "%s%c", mp->match_name, 0);
207 vec_terminate_c_string (match_name);
210 if (mp->match_name_valid)
212 p = hash_get_mem (pm->policer_config_by_name, match_name);
216 config = pool_elt_at_index (pm->configs, pool_index);
217 templ = pool_elt_at_index (pm->policer_templates, pool_index);
218 send_policer_details (match_name, config, templ, reg, mp->context);
224 hash_foreach_pair (hp, pm->policer_config_by_name,
226 name = (u8 *) hp->key;
227 pool_index = hp->value[0];
228 config = pool_elt_at_index (pm->configs, pool_index);
229 templ = pool_elt_at_index (pm->policer_templates, pool_index);
230 send_policer_details(name, config, templ, reg, mp->context);
238 * Add vpe's API message handlers to the table.
239 * vlib has already mapped shared memory and
240 * added the client registration handlers.
241 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
243 #define vl_msg_name_crc_list
244 #include <vnet/vnet_all_api_h.h>
245 #undef vl_msg_name_crc_list
248 setup_message_id_table (api_main_t * am)
250 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
251 foreach_vl_msg_name_crc_policer;
255 static clib_error_t *
256 policer_api_hookup (vlib_main_t * vm)
258 api_main_t *am = vlibapi_get_main ();
261 vl_msg_api_set_handlers(VL_API_##N, #n, \
262 vl_api_##n##_t_handler, \
264 vl_api_##n##_t_endian, \
265 vl_api_##n##_t_print, \
266 sizeof(vl_api_##n##_t), 1);
270 * Set up the (msg_name, crc, message-id) table
272 setup_message_id_table (am);
277 VLIB_API_INIT_FUNCTION (policer_api_hookup);
280 * fd.io coding-style-patch-verification: ON
283 * eval: (c-set-style "gnu")