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_DUMP, policer_dump)
51 vl_api_policer_add_del_t_handler (vl_api_policer_add_del_t * mp)
53 vlib_main_t *vm = vlib_get_main ();
54 vl_api_policer_add_del_reply_t *rmp;
57 qos_pol_cfg_params_st cfg;
61 name = format (0, "%s", mp->name);
62 vec_terminate_c_string (name);
64 clib_memset (&cfg, 0, sizeof (cfg));
65 cfg.rfc = (qos_policer_type_en) mp->type;
66 cfg.rnd_type = (qos_round_type_en) mp->round_type;
67 cfg.rate_type = (qos_rate_type_en) mp->rate_type;
68 cfg.rb.kbps.cir_kbps = ntohl (mp->cir);
69 cfg.rb.kbps.eir_kbps = ntohl (mp->eir);
70 cfg.rb.kbps.cb_bytes = clib_net_to_host_u64 (mp->cb);
71 cfg.rb.kbps.eb_bytes = clib_net_to_host_u64 (mp->eb);
72 cfg.conform_action.action_type =
73 (qos_action_type_en) mp->conform_action.type;
74 cfg.conform_action.dscp = mp->conform_action.dscp;
75 cfg.exceed_action.action_type = (qos_action_type_en) mp->exceed_action.type;
76 cfg.exceed_action.dscp = mp->exceed_action.dscp;
77 cfg.violate_action.action_type =
78 (qos_action_type_en) mp->violate_action.type;
79 cfg.violate_action.dscp = mp->violate_action.dscp;
81 cfg.color_aware = mp->color_aware;
83 error = policer_add_del (vm, name, &cfg, &policer_index, mp->is_add);
86 rv = VNET_API_ERROR_UNSPECIFIED;
89 REPLY_MACRO2(VL_API_POLICER_ADD_DEL_REPLY,
91 if (rv == 0 && mp->is_add)
92 rmp->policer_index = ntohl(policer_index);
94 rmp->policer_index = ~0;
100 vl_api_policer_bind_t_handler (vl_api_policer_bind_t *mp)
102 vl_api_policer_bind_reply_t *rmp;
108 name = format (0, "%s", mp->name);
109 vec_terminate_c_string (name);
111 worker_index = ntohl (mp->worker_index);
112 bind_enable = mp->bind_enable;
114 rv = policer_bind_worker (name, worker_index, bind_enable);
116 REPLY_MACRO (VL_API_POLICER_BIND_REPLY);
120 send_policer_details (u8 *name, qos_pol_cfg_params_st *config,
121 policer_read_response_type_st *templ,
122 vl_api_registration_t *reg, u32 context)
124 vl_api_policer_details_t *mp;
126 mp = vl_msg_api_alloc (sizeof (*mp));
127 clib_memset (mp, 0, sizeof (*mp));
128 mp->_vl_msg_id = ntohs (VL_API_POLICER_DETAILS);
129 mp->context = context;
130 mp->cir = htonl (config->rb.kbps.cir_kbps);
131 mp->eir = htonl (config->rb.kbps.eir_kbps);
132 mp->cb = clib_host_to_net_u64 (config->rb.kbps.cb_bytes);
133 mp->eb = clib_host_to_net_u64 (config->rb.kbps.eb_bytes);
134 mp->rate_type = (vl_api_sse2_qos_rate_type_t) config->rate_type;
135 mp->round_type = (vl_api_sse2_qos_round_type_t) config->rnd_type;
136 mp->type = (vl_api_sse2_qos_policer_type_t) config->rfc;
137 mp->conform_action.type =
138 (vl_api_sse2_qos_action_type_t) config->conform_action.action_type;
139 mp->conform_action.dscp = config->conform_action.dscp;
140 mp->exceed_action.type =
141 (vl_api_sse2_qos_action_type_t) config->exceed_action.action_type;
142 mp->exceed_action.dscp = config->exceed_action.dscp;
143 mp->violate_action.type =
144 (vl_api_sse2_qos_action_type_t) config->violate_action.action_type;
145 mp->violate_action.dscp = config->violate_action.dscp;
146 mp->single_rate = templ->single_rate ? 1 : 0;
147 mp->color_aware = templ->color_aware ? 1 : 0;
148 mp->scale = htonl (templ->scale);
149 mp->cir_tokens_per_period = htonl (templ->cir_tokens_per_period);
150 mp->pir_tokens_per_period = htonl (templ->pir_tokens_per_period);
151 mp->current_limit = htonl (templ->current_limit);
152 mp->current_bucket = htonl (templ->current_bucket);
153 mp->extended_limit = htonl (templ->extended_limit);
154 mp->extended_bucket = htonl (templ->extended_bucket);
155 mp->last_update_time = clib_host_to_net_u64 (templ->last_update_time);
157 strncpy ((char *) mp->name, (char *) name, ARRAY_LEN (mp->name) - 1);
159 vl_api_send_msg (reg, (u8 *) mp);
163 vl_api_policer_dump_t_handler (vl_api_policer_dump_t * mp)
165 vl_api_registration_t *reg;
166 vnet_policer_main_t *pm = &vnet_policer_main;
172 qos_pol_cfg_params_st *config;
173 policer_read_response_type_st *templ;
175 reg = vl_api_client_index_to_registration (mp->client_index);
179 if (mp->match_name_valid)
181 match_name = format (0, "%s%c", mp->match_name, 0);
182 vec_terminate_c_string (match_name);
185 if (mp->match_name_valid)
187 p = hash_get_mem (pm->policer_config_by_name, match_name);
191 config = pool_elt_at_index (pm->configs, pool_index);
192 templ = pool_elt_at_index (pm->policer_templates, pool_index);
193 send_policer_details (match_name, config, templ, reg, mp->context);
199 hash_foreach_pair (hp, pm->policer_config_by_name,
201 name = (u8 *) hp->key;
202 pool_index = hp->value[0];
203 config = pool_elt_at_index (pm->configs, pool_index);
204 templ = pool_elt_at_index (pm->policer_templates, pool_index);
205 send_policer_details(name, config, templ, reg, mp->context);
213 * Add vpe's API message handlers to the table.
214 * vlib has already mapped shared memory and
215 * added the client registration handlers.
216 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
218 #define vl_msg_name_crc_list
219 #include <vnet/vnet_all_api_h.h>
220 #undef vl_msg_name_crc_list
223 setup_message_id_table (api_main_t * am)
225 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
226 foreach_vl_msg_name_crc_policer;
230 static clib_error_t *
231 policer_api_hookup (vlib_main_t * vm)
233 api_main_t *am = vlibapi_get_main ();
236 vl_msg_api_set_handlers(VL_API_##N, #n, \
237 vl_api_##n##_t_handler, \
239 vl_api_##n##_t_endian, \
240 vl_api_##n##_t_print, \
241 sizeof(vl_api_##n##_t), 1);
245 * Set up the (msg_name, crc, message-id) table
247 setup_message_id_table (am);
252 VLIB_API_INIT_FUNCTION (policer_api_hookup);
255 * fd.io coding-style-patch-verification: ON
258 * eval: (c-set-style "gnu")