lib/librte_acl/rte_acl.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33
  34 #include <rte_acl.h>
  35 #include "acl.h"
  36
  37 TAILQ_HEAD(rte_acl_list, rte_tailq_entry);
  38
  39 static struct rte_tailq_elem rte_acl_tailq = {
  40         .name = "RTE_ACL",
  41 };
  42 EAL_REGISTER_TAILQ(rte_acl_tailq)
  43
  44 /*
  45  * If the compiler doesn't support AVX2 instructions,
  46  * then the dummy one would be used instead for AVX2 classify method.
  47  */
  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)
  54 {
  55         return -ENOTSUP;
  56 }
  57
  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)
  64 {
  65         return -ENOTSUP;
  66 }
  67
  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)
  74 {
  75         return -ENOTSUP;
  76 }
  77
  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,
  84 };
  85
  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;
  89
  90 static void
  91 rte_acl_set_default_classify(enum rte_acl_classify_alg alg)
  92 {
  93         rte_acl_default_classify = alg;
  94 }
  95
  96 extern int
  97 rte_acl_set_ctx_classify(struct rte_acl_ctx *ctx, enum rte_acl_classify_alg alg)
  98 {
  99         if (ctx == NULL || (uint32_t)alg >= RTE_DIM(classify_fns))
 100                 return -EINVAL;
 101
 102         ctx->alg = alg;
 103         return 0;
 104 }
 105
 106 /*
 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.
 111  */
 112 static void __attribute__((constructor))
 113 rte_acl_init(void)
 114 {
 115         enum rte_acl_classify_alg alg = RTE_ACL_CLASSIFY_DEFAULT;
 116
 117 #ifdef RTE_ARCH_ARM64
 118         alg =  RTE_ACL_CLASSIFY_NEON;
 119 #else
 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))
 124 #else
 125         if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_1))
 126 #endif
 127                 alg = RTE_ACL_CLASSIFY_SSE;
 128
 129 #endif
 130         rte_acl_set_default_classify(alg);
 131 }
 132
 133 int
 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)
 137 {
 138         if (categories != 1 &&
 139                         ((RTE_ACL_RESULTS_MULTIPLIER - 1) & categories) != 0)
 140                 return -EINVAL;
 141
 142         return classify_fns[alg](ctx, data, results, num, categories);
 143 }
 144
 145 int
 146 rte_acl_classify(const struct rte_acl_ctx *ctx, const uint8_t **data,
 147         uint32_t *results, uint32_t num, uint32_t categories)
 148 {
 149         return rte_acl_classify_alg(ctx, data, results, num, categories,
 150                 ctx->alg);
 151 }
 152
 153 struct rte_acl_ctx *
 154 rte_acl_find_existing(const char *name)
 155 {
 156         struct rte_acl_ctx *ctx = NULL;
 157         struct rte_acl_list *acl_list;
 158         struct rte_tailq_entry *te;
 159
 160         acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
 161
 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)
 166                         break;
 167         }
 168         rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
 169
 170         if (te == NULL) {
 171                 rte_errno = ENOENT;
 172                 return NULL;
 173         }
 174         return ctx;
 175 }
 176
 177 void
 178 rte_acl_free(struct rte_acl_ctx *ctx)
 179 {
 180         struct rte_acl_list *acl_list;
 181         struct rte_tailq_entry *te;
 182
 183         if (ctx == NULL)
 184                 return;
 185
 186         acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
 187
 188         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 189
 190         /* find our tailq entry */
 191         TAILQ_FOREACH(te, acl_list, next) {
 192                 if (te->data == (void *) ctx)
 193                         break;
 194         }
 195         if (te == NULL) {
 196                 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 197                 return;
 198         }
 199
 200         TAILQ_REMOVE(acl_list, te, next);
 201
 202         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 203
 204         rte_free(ctx->mem);
 205         rte_free(ctx);
 206         rte_free(te);
 207 }
 208
 209 struct rte_acl_ctx *
 210 rte_acl_create(const struct rte_acl_param *param)
 211 {
 212         size_t sz;
 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)];
 217
 218         acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
 219
 220         /* check that input parameters are valid. */
 221         if (param == NULL || param->name == NULL) {
 222                 rte_errno = EINVAL;
 223                 return NULL;
 224         }
 225
 226         snprintf(name, sizeof(name), "ACL_%s", param->name);
 227
 228         /* calculate amount of memory required for pattern set. */
 229         sz = sizeof(*ctx) + param->max_rule_num * param->rule_size;
 230
 231         /* get EAL TAILQ lock. */
 232         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 233
 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)
 238                         break;
 239         }
 240
 241         /* if ACL with such name doesn't exist, then create a new one. */
 242         if (te == NULL) {
 243                 ctx = NULL;
 244                 te = rte_zmalloc("ACL_TAILQ_ENTRY", sizeof(*te), 0);
 245
 246                 if (te == NULL) {
 247                         RTE_LOG(ERR, ACL, "Cannot allocate tailq entry!\n");
 248                         goto exit;
 249                 }
 250
 251                 ctx = rte_zmalloc_socket(name, sz, RTE_CACHE_LINE_SIZE, param->socket_id);
 252
 253                 if (ctx == NULL) {
 254                         RTE_LOG(ERR, ACL,
 255                                 "allocation of %zu bytes on socket %d for %s failed\n",
 256                                 sz, param->socket_id, name);
 257                         rte_free(te);
 258                         goto exit;
 259                 }
 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);
 267
 268                 te->data = (void *) ctx;
 269
 270                 TAILQ_INSERT_TAIL(acl_list, te, next);
 271         }
 272
 273 exit:
 274         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 275         return ctx;
 276 }
 277
 278 static int
 279 acl_add_rules(struct rte_acl_ctx *ctx, const void *rules, uint32_t num)
 280 {
 281         uint8_t *pos;
 282
 283         if (num + ctx->num_rules > ctx->max_rules)
 284                 return -ENOMEM;
 285
 286         pos = ctx->rules;
 287         pos += ctx->rule_sz * ctx->num_rules;
 288         memcpy(pos, rules, num * ctx->rule_sz);
 289         ctx->num_rules += num;
 290
 291         return 0;
 292 }
 293
 294 static int
 295 acl_check_rule(const struct rte_acl_rule_data *rd)
 296 {
 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)
 302                 return -EINVAL;
 303         return 0;
 304 }
 305
 306 int
 307 rte_acl_add_rules(struct rte_acl_ctx *ctx, const struct rte_acl_rule *rules,
 308         uint32_t num)
 309 {
 310         const struct rte_acl_rule *rv;
 311         uint32_t i;
 312         int32_t rc;
 313
 314         if (ctx == NULL || rules == NULL || 0 == ctx->rule_sz)
 315                 return -EINVAL;
 316
 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);
 321                 if (rc != 0) {
 322                         RTE_LOG(ERR, ACL, "%s(%s): rule #%u is invalid\n",
 323                                 __func__, ctx->name, i + 1);
 324                         return rc;
 325                 }
 326         }
 327
 328         return acl_add_rules(ctx, rules, num);
 329 }
 330
 331 /*
 332  * Reset all rules.
 333  * Note that RT structures are not affected.
 334  */
 335 void
 336 rte_acl_reset_rules(struct rte_acl_ctx *ctx)
 337 {
 338         if (ctx != NULL)
 339                 ctx->num_rules = 0;
 340 }
 341
 342 /*
 343  * Reset all rules and destroys RT structures.
 344  */
 345 void
 346 rte_acl_reset(struct rte_acl_ctx *ctx)
 347 {
 348         if (ctx != NULL) {
 349                 rte_acl_reset_rules(ctx);
 350                 rte_acl_build(ctx, &ctx->config);
 351         }
 352 }
 353
 354 /*
 355  * Dump ACL context to the stdout.
 356  */
 357 void
 358 rte_acl_dump(const struct rte_acl_ctx *ctx)
 359 {
 360         if (!ctx)
 361                 return;
 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);
 370 }
 371
 372 /*
 373  * Dump all ACL contexts to the stdout.
 374  */
 375 void
 376 rte_acl_list_dump(void)
 377 {
 378         struct rte_acl_ctx *ctx;
 379         struct rte_acl_list *acl_list;
 380         struct rte_tailq_entry *te;
 381
 382         acl_list = RTE_TAILQ_CAST(rte_acl_tailq.head, rte_acl_list);
 383
 384         rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
 385         TAILQ_FOREACH(te, acl_list, next) {
 386                 ctx = (struct rte_acl_ctx *) te->data;
 387                 rte_acl_dump(ctx);
 388         }
 389         rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
 390 }