4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 TAILQ_HEAD(rte_acl_list, rte_tailq_entry);
39 static struct rte_tailq_elem rte_acl_tailq = {
42 EAL_REGISTER_TAILQ(rte_acl_tailq)
45 * If the compiler doesn't support AVX2 instructions,
46 * then the dummy one would be used instead for AVX2 classify method.
48 int __attribute__ ((weak))
49 rte_acl_classify_avx2(__rte_unused const struct rte_acl_ctx *ctx,
50 __rte_unused const uint8_t **data,
51 __rte_unused uint32_t *results,
52 __rte_unused uint32_t num,
53 __rte_unused uint32_t categories)
58 static const rte_acl_classify_t classify_fns[] = {
59 [RTE_ACL_CLASSIFY_DEFAULT] = rte_acl_classify_scalar,
60 [RTE_ACL_CLASSIFY_SCALAR] = rte_acl_classify_scalar,
61 [RTE_ACL_CLASSIFY_SSE] = rte_acl_classify_sse,
62 [RTE_ACL_CLASSIFY_AVX2] = rte_acl_classify_avx2,
65 /* by default, use always available scalar code path. */
66 static enum rte_acl_classify_alg rte_acl_default_classify =
67 RTE_ACL_CLASSIFY_SCALAR;
70 rte_acl_set_default_classify(enum rte_acl_classify_alg alg)
72 rte_acl_default_classify = alg;
76 rte_acl_set_ctx_classify(struct rte_acl_ctx *ctx, enum rte_acl_classify_alg alg)
78 if (ctx == NULL || (uint32_t)alg >= RTE_DIM(classify_fns))
86 * Select highest available classify method as default one.
87 * Note that CLASSIFY_AVX2 should be set as a default only
88 * if both conditions are met:
89 * at build time compiler supports AVX2 and target cpu supports AVX2.
91 static void __attribute__((constructor))
94 enum rte_acl_classify_alg alg = RTE_ACL_CLASSIFY_DEFAULT;
96 #ifdef CC_AVX2_SUPPORT
97 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
98 alg = RTE_ACL_CLASSIFY_AVX2;
99 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
101 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
103 alg = RTE_ACL_CLASSIFY_SSE;
105 rte_acl_set_default_classify(alg);
109 rte_acl_classify_alg(const struct rte_acl_ctx *ctx, const uint8_t **data,
110 uint32_t *results, uint32_t num, uint32_t categories,
111 enum rte_acl_classify_alg alg)
113 if (categories != 1 &&
114 ((RTE_ACL_RESULTS_MULTIPLIER - 1) & categories) != 0)
117 return classify_fns[alg](ctx, data, results, num, categories);
121 rte_acl_classify(const struct rte_acl_ctx *ctx, const uint8_t **data,
122 uint32_t *results, uint32_t num, uint32_t categories)
124 return rte_acl_classify_alg(ctx, data, results, num, categories,
129 rte_acl_find_existing(const char *name)
131 struct rte_acl_ctx *ctx = NULL;
132 struct rte_acl_list *acl_list;
133 struct rte_tailq_entry *te;
135 acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
137 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
138 TAILQ_FOREACH(te, acl_list, next) {
139 ctx = (struct rte_acl_ctx *) te->data;
140 if (strncmp(name, ctx->name, sizeof(ctx->name)) == 0)
143 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
153 rte_acl_free(struct rte_acl_ctx *ctx)
155 struct rte_acl_list *acl_list;
156 struct rte_tailq_entry *te;
161 acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
163 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
165 /* find our tailq entry */
166 TAILQ_FOREACH(te, acl_list, next) {
167 if (te->data == (void *) ctx)
171 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
175 TAILQ_REMOVE(acl_list, te, next);
177 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
185 rte_acl_create(const struct rte_acl_param *param)
188 struct rte_acl_ctx *ctx;
189 struct rte_acl_list *acl_list;
190 struct rte_tailq_entry *te;
191 char name[sizeof(ctx->name)];
193 acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
195 /* check that input parameters are valid. */
196 if (param == NULL || param->name == NULL) {
201 snprintf(name, sizeof(name), "ACL_%s", param->name);
203 /* calculate amount of memory required for pattern set. */
204 sz = sizeof(*ctx) + param->max_rule_num * param->rule_size;
206 /* get EAL TAILQ lock. */
207 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
209 /* if we already have one with that name */
210 TAILQ_FOREACH(te, acl_list, next) {
211 ctx = (struct rte_acl_ctx *) te->data;
212 if (strncmp(param->name, ctx->name, sizeof(ctx->name)) == 0)
216 /* if ACL with such name doesn't exist, then create a new one. */
219 te = rte_zmalloc("ACL_TAILQ_ENTRY", sizeof(*te), 0);
222 RTE_LOG(ERR, ACL, "Cannot allocate tailq entry!\n");
226 ctx = rte_zmalloc_socket(name, sz, RTE_CACHE_LINE_SIZE, param->socket_id);
230 "allocation of %zu bytes on socket %d for %s failed\n",
231 sz, param->socket_id, name);
235 /* init new allocated context. */
236 ctx->rules = ctx + 1;
237 ctx->max_rules = param->max_rule_num;
238 ctx->rule_sz = param->rule_size;
239 ctx->socket_id = param->socket_id;
240 ctx->alg = rte_acl_default_classify;
241 snprintf(ctx->name, sizeof(ctx->name), "%s", param->name);
243 te->data = (void *) ctx;
245 TAILQ_INSERT_TAIL(acl_list, te, next);
249 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
254 acl_add_rules(struct rte_acl_ctx *ctx, const void *rules, uint32_t num)
258 if (num + ctx->num_rules > ctx->max_rules)
262 pos += ctx->rule_sz * ctx->num_rules;
263 memcpy(pos, rules, num * ctx->rule_sz);
264 ctx->num_rules += num;
270 acl_check_rule(const struct rte_acl_rule_data *rd)
272 if ((RTE_LEN2MASK(RTE_ACL_MAX_CATEGORIES, typeof(rd->category_mask)) &
273 rd->category_mask) == 0 ||
274 rd->priority > RTE_ACL_MAX_PRIORITY ||
275 rd->priority < RTE_ACL_MIN_PRIORITY ||
276 rd->userdata == RTE_ACL_INVALID_USERDATA)
282 rte_acl_add_rules(struct rte_acl_ctx *ctx, const struct rte_acl_rule *rules,
285 const struct rte_acl_rule *rv;
289 if (ctx == NULL || rules == NULL || 0 == ctx->rule_sz)
292 for (i = 0; i != num; i++) {
293 rv = (const struct rte_acl_rule *)
294 ((uintptr_t)rules + i * ctx->rule_sz);
295 rc = acl_check_rule(&rv->data);
297 RTE_LOG(ERR, ACL, "%s(%s): rule #%u is invalid\n",
298 __func__, ctx->name, i + 1);
303 return acl_add_rules(ctx, rules, num);
308 * Note that RT structures are not affected.
311 rte_acl_reset_rules(struct rte_acl_ctx *ctx)
318 * Reset all rules and destroys RT structures.
321 rte_acl_reset(struct rte_acl_ctx *ctx)
324 rte_acl_reset_rules(ctx);
325 rte_acl_build(ctx, &ctx->config);
330 * Dump ACL context to the stdout.
333 rte_acl_dump(const struct rte_acl_ctx *ctx)
337 printf("acl context <%s>@%p\n", ctx->name, ctx);
338 printf(" socket_id=%"PRId32"\n", ctx->socket_id);
339 printf(" alg=%"PRId32"\n", ctx->alg);
340 printf(" max_rules=%"PRIu32"\n", ctx->max_rules);
341 printf(" rule_size=%"PRIu32"\n", ctx->rule_sz);
342 printf(" num_rules=%"PRIu32"\n", ctx->num_rules);
343 printf(" num_categories=%"PRIu32"\n", ctx->num_categories);
344 printf(" num_tries=%"PRIu32"\n", ctx->num_tries);
348 * Dump all ACL contexts to the stdout.
351 rte_acl_list_dump(void)
353 struct rte_acl_ctx *ctx;
354 struct rte_acl_list *acl_list;
355 struct rte_tailq_entry *te;
357 acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
359 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
360 TAILQ_FOREACH(te, acl_list, next) {
361 ctx = (struct rte_acl_ctx *) te->data;
364 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);