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 int __attribute__ ((weak))
59 rte_acl_classify_sse(__rte_unused const struct rte_acl_ctx *ctx,
60 __rte_unused const uint8_t **data,
61 __rte_unused uint32_t *results,
62 __rte_unused uint32_t num,
63 __rte_unused uint32_t categories)
68 int __attribute__ ((weak))
69 rte_acl_classify_neon(__rte_unused const struct rte_acl_ctx *ctx,
70 __rte_unused const uint8_t **data,
71 __rte_unused uint32_t *results,
72 __rte_unused uint32_t num,
73 __rte_unused uint32_t categories)
78 static const rte_acl_classify_t classify_fns[] = {
79 [RTE_ACL_CLASSIFY_DEFAULT] = rte_acl_classify_scalar,
80 [RTE_ACL_CLASSIFY_SCALAR] = rte_acl_classify_scalar,
81 [RTE_ACL_CLASSIFY_SSE] = rte_acl_classify_sse,
82 [RTE_ACL_CLASSIFY_AVX2] = rte_acl_classify_avx2,
83 [RTE_ACL_CLASSIFY_NEON] = rte_acl_classify_neon,
86 /* by default, use always available scalar code path. */
87 static enum rte_acl_classify_alg rte_acl_default_classify =
88 RTE_ACL_CLASSIFY_SCALAR;
91 rte_acl_set_default_classify(enum rte_acl_classify_alg alg)
93 rte_acl_default_classify = alg;
97 rte_acl_set_ctx_classify(struct rte_acl_ctx *ctx, enum rte_acl_classify_alg alg)
99 if (ctx == NULL || (uint32_t)alg >= RTE_DIM(classify_fns))
107 * Select highest available classify method as default one.
108 * Note that CLASSIFY_AVX2 should be set as a default only
109 * if both conditions are met:
110 * at build time compiler supports AVX2 and target cpu supports AVX2.
112 static void __attribute__((constructor))
115 enum rte_acl_classify_alg alg = RTE_ACL_CLASSIFY_DEFAULT;
117 #ifdef RTE_ARCH_ARM64
118 alg = RTE_ACL_CLASSIFY_NEON;
120 #ifdef CC_AVX2_SUPPORT
121 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
122 alg = RTE_ACL_CLASSIFY_AVX2;
123 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
125 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
127 alg = RTE_ACL_CLASSIFY_SSE;
130 rte_acl_set_default_classify(alg);
134 rte_acl_classify_alg(const struct rte_acl_ctx *ctx, const uint8_t **data,
135 uint32_t *results, uint32_t num, uint32_t categories,
136 enum rte_acl_classify_alg alg)
138 if (categories != 1 &&
139 ((RTE_ACL_RESULTS_MULTIPLIER - 1) & categories) != 0)
142 return classify_fns[alg](ctx, data, results, num, categories);
146 rte_acl_classify(const struct rte_acl_ctx *ctx, const uint8_t **data,
147 uint32_t *results, uint32_t num, uint32_t categories)
149 return rte_acl_classify_alg(ctx, data, results, num, categories,
154 rte_acl_find_existing(const char *name)
156 struct rte_acl_ctx *ctx = NULL;
157 struct rte_acl_list *acl_list;
158 struct rte_tailq_entry *te;
160 acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
162 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
163 TAILQ_FOREACH(te, acl_list, next) {
164 ctx = (struct rte_acl_ctx *) te->data;
165 if (strncmp(name, ctx->name, sizeof(ctx->name)) == 0)
168 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
178 rte_acl_free(struct rte_acl_ctx *ctx)
180 struct rte_acl_list *acl_list;
181 struct rte_tailq_entry *te;
186 acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
188 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
190 /* find our tailq entry */
191 TAILQ_FOREACH(te, acl_list, next) {
192 if (te->data == (void *) ctx)
196 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
200 TAILQ_REMOVE(acl_list, te, next);
202 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
210 rte_acl_create(const struct rte_acl_param *param)
213 struct rte_acl_ctx *ctx;
214 struct rte_acl_list *acl_list;
215 struct rte_tailq_entry *te;
216 char name[sizeof(ctx->name)];
218 acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
220 /* check that input parameters are valid. */
221 if (param == NULL || param->name == NULL) {
226 snprintf(name, sizeof(name), "ACL_%s", param->name);
228 /* calculate amount of memory required for pattern set. */
229 sz = sizeof(*ctx) + param->max_rule_num * param->rule_size;
231 /* get EAL TAILQ lock. */
232 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
234 /* if we already have one with that name */
235 TAILQ_FOREACH(te, acl_list, next) {
236 ctx = (struct rte_acl_ctx *) te->data;
237 if (strncmp(param->name, ctx->name, sizeof(ctx->name)) == 0)
241 /* if ACL with such name doesn't exist, then create a new one. */
244 te = rte_zmalloc("ACL_TAILQ_ENTRY", sizeof(*te), 0);
247 RTE_LOG(ERR, ACL, "Cannot allocate tailq entry!\n");
251 ctx = rte_zmalloc_socket(name, sz, RTE_CACHE_LINE_SIZE, param->socket_id);
255 "allocation of %zu bytes on socket %d for %s failed\n",
256 sz, param->socket_id, name);
260 /* init new allocated context. */
261 ctx->rules = ctx + 1;
262 ctx->max_rules = param->max_rule_num;
263 ctx->rule_sz = param->rule_size;
264 ctx->socket_id = param->socket_id;
265 ctx->alg = rte_acl_default_classify;
266 snprintf(ctx->name, sizeof(ctx->name), "%s", param->name);
268 te->data = (void *) ctx;
270 TAILQ_INSERT_TAIL(acl_list, te, next);
274 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
279 acl_add_rules(struct rte_acl_ctx *ctx, const void *rules, uint32_t num)
283 if (num + ctx->num_rules > ctx->max_rules)
287 pos += ctx->rule_sz * ctx->num_rules;
288 memcpy(pos, rules, num * ctx->rule_sz);
289 ctx->num_rules += num;
295 acl_check_rule(const struct rte_acl_rule_data *rd)
297 if ((RTE_LEN2MASK(RTE_ACL_MAX_CATEGORIES, typeof(rd->category_mask)) &
298 rd->category_mask) == 0 ||
299 rd->priority > RTE_ACL_MAX_PRIORITY ||
300 rd->priority < RTE_ACL_MIN_PRIORITY ||
301 rd->userdata == RTE_ACL_INVALID_USERDATA)
307 rte_acl_add_rules(struct rte_acl_ctx *ctx, const struct rte_acl_rule *rules,
310 const struct rte_acl_rule *rv;
314 if (ctx == NULL || rules == NULL || 0 == ctx->rule_sz)
317 for (i = 0; i != num; i++) {
318 rv = (const struct rte_acl_rule *)
319 ((uintptr_t)rules + i * ctx->rule_sz);
320 rc = acl_check_rule(&rv->data);
322 RTE_LOG(ERR, ACL, "%s(%s): rule #%u is invalid\n",
323 __func__, ctx->name, i + 1);
328 return acl_add_rules(ctx, rules, num);
333 * Note that RT structures are not affected.
336 rte_acl_reset_rules(struct rte_acl_ctx *ctx)
343 * Reset all rules and destroys RT structures.
346 rte_acl_reset(struct rte_acl_ctx *ctx)
349 rte_acl_reset_rules(ctx);
350 rte_acl_build(ctx, &ctx->config);
355 * Dump ACL context to the stdout.
358 rte_acl_dump(const struct rte_acl_ctx *ctx)
362 printf("acl context <%s>@%p\n", ctx->name, ctx);
363 printf(" socket_id=%"PRId32"\n", ctx->socket_id);
364 printf(" alg=%"PRId32"\n", ctx->alg);
365 printf(" max_rules=%"PRIu32"\n", ctx->max_rules);
366 printf(" rule_size=%"PRIu32"\n", ctx->rule_sz);
367 printf(" num_rules=%"PRIu32"\n", ctx->num_rules);
368 printf(" num_categories=%"PRIu32"\n", ctx->num_categories);
369 printf(" num_tries=%"PRIu32"\n", ctx->num_tries);
373 * Dump all ACL contexts to the stdout.
376 rte_acl_list_dump(void)
378 struct rte_acl_ctx *ctx;
379 struct rte_acl_list *acl_list;
380 struct rte_tailq_entry *te;
382 acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
384 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
385 TAILQ_FOREACH(te, acl_list, next) {
386 ctx = (struct rte_acl_ctx *) te->data;
389 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);