app/test/test_table_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_hexdump.h>
  35 #include "test_table.h"
  36 #include "test_table_acl.h"
  37
  38 #define IPv4(a, b, c, d) ((uint32_t)(((a) & 0xff) << 24) |              \
  39         (((b) & 0xff) << 16) |                                          \
  40         (((c) & 0xff) << 8) |                                           \
  41         ((d) & 0xff))
  42
  43 /*
  44  * Rule and trace formats definitions.
  45  **/
  46
  47 struct ipv4_5tuple {
  48         uint8_t  proto;
  49         uint32_t ip_src;
  50         uint32_t ip_dst;
  51         uint16_t port_src;
  52         uint16_t port_dst;
  53 };
  54
  55 enum {
  56         PROTO_FIELD_IPV4,
  57         SRC_FIELD_IPV4,
  58         DST_FIELD_IPV4,
  59         SRCP_FIELD_IPV4,
  60         DSTP_FIELD_IPV4,
  61         NUM_FIELDS_IPV4
  62 };
  63
  64 struct rte_acl_field_def ipv4_defs[NUM_FIELDS_IPV4] = {
  65         {
  66                 .type = RTE_ACL_FIELD_TYPE_BITMASK,
  67                 .size = sizeof(uint8_t),
  68                 .field_index = PROTO_FIELD_IPV4,
  69                 .input_index = PROTO_FIELD_IPV4,
  70                 .offset = offsetof(struct ipv4_5tuple, proto),
  71         },
  72         {
  73                 .type = RTE_ACL_FIELD_TYPE_MASK,
  74                 .size = sizeof(uint32_t),
  75                 .field_index = SRC_FIELD_IPV4,
  76                 .input_index = SRC_FIELD_IPV4,
  77                 .offset = offsetof(struct ipv4_5tuple, ip_src),
  78         },
  79         {
  80                 .type = RTE_ACL_FIELD_TYPE_MASK,
  81                 .size = sizeof(uint32_t),
  82                 .field_index = DST_FIELD_IPV4,
  83                 .input_index = DST_FIELD_IPV4,
  84                 .offset = offsetof(struct ipv4_5tuple, ip_dst),
  85         },
  86         {
  87                 .type = RTE_ACL_FIELD_TYPE_RANGE,
  88                 .size = sizeof(uint16_t),
  89                 .field_index = SRCP_FIELD_IPV4,
  90                 .input_index = SRCP_FIELD_IPV4,
  91                 .offset = offsetof(struct ipv4_5tuple, port_src),
  92         },
  93         {
  94                 .type = RTE_ACL_FIELD_TYPE_RANGE,
  95                 .size = sizeof(uint16_t),
  96                 .field_index = DSTP_FIELD_IPV4,
  97                 .input_index = SRCP_FIELD_IPV4,
  98                 .offset = offsetof(struct ipv4_5tuple, port_dst),
  99         },
 100 };
 101
 102 struct rte_table_acl_rule_add_params table_acl_IPv4_rule;
 103
 104 typedef int (*parse_5tuple)(char *text,
 105         struct rte_table_acl_rule_add_params *rule);
 106
 107 /*
 108 * The order of the fields in the rule string after the initial '@'
 109 */
 110 enum {
 111         CB_FLD_SRC_ADDR,
 112         CB_FLD_DST_ADDR,
 113         CB_FLD_SRC_PORT_RANGE,
 114         CB_FLD_DST_PORT_RANGE,
 115         CB_FLD_PROTO,
 116         CB_FLD_NUM,
 117 };
 118
 119
 120 #define GET_CB_FIELD(in, fd, base, lim, dlm)                            \
 121 do {                                                                    \
 122         unsigned long val;                                              \
 123         char *end;                                                      \
 124                                                                         \
 125         errno = 0;                                                      \
 126         val = strtoul((in), &end, (base));                              \
 127         if (errno != 0 || end[0] != (dlm) || val > (lim))               \
 128                 return -EINVAL;                                         \
 129         (fd) = (typeof(fd)) val;                                        \
 130         (in) = end + 1;                                                 \
 131 } while (0)
 132
 133
 134
 135
 136 static int
 137 parse_ipv4_net(const char *in, uint32_t *addr, uint32_t *mask_len)
 138 {
 139         uint8_t a, b, c, d, m;
 140
 141         GET_CB_FIELD(in, a, 0, UINT8_MAX, '.');
 142         GET_CB_FIELD(in, b, 0, UINT8_MAX, '.');
 143         GET_CB_FIELD(in, c, 0, UINT8_MAX, '.');
 144         GET_CB_FIELD(in, d, 0, UINT8_MAX, '/');
 145         GET_CB_FIELD(in, m, 0, sizeof(uint32_t) * CHAR_BIT, 0);
 146
 147         addr[0] = IPv4(a, b, c, d);
 148         mask_len[0] = m;
 149
 150         return 0;
 151 }
 152
 153 static int
 154 parse_port_range(const char *in, uint16_t *port_low, uint16_t *port_high)
 155 {
 156         uint16_t a, b;
 157
 158         GET_CB_FIELD(in, a, 0, UINT16_MAX, ':');
 159         GET_CB_FIELD(in, b, 0, UINT16_MAX, 0);
 160
 161         port_low[0] = a;
 162         port_high[0] = b;
 163
 164         return 0;
 165 }
 166
 167 static int
 168 parse_cb_ipv4_rule(char *str, struct rte_table_acl_rule_add_params *v)
 169 {
 170         int i, rc;
 171         char *s, *sp, *in[CB_FLD_NUM];
 172         static const char *dlm = " \t\n";
 173
 174         /*
 175         ** Skip leading '@'
 176         */
 177         if (strchr(str, '@') != str)
 178                 return -EINVAL;
 179
 180         s = str + 1;
 181
 182         /*
 183         * Populate the 'in' array with the location of each
 184         * field in the string we're parsing
 185         */
 186         for (i = 0; i != DIM(in); i++) {
 187                 in[i] = strtok_r(s, dlm, &sp);
 188                 if (in[i] == NULL)
 189                         return -EINVAL;
 190                 s = NULL;
 191         }
 192
 193         /* Parse x.x.x.x/x */
 194         rc = parse_ipv4_net(in[CB_FLD_SRC_ADDR],
 195                 &v->field_value[SRC_FIELD_IPV4].value.u32,
 196                 &v->field_value[SRC_FIELD_IPV4].mask_range.u32);
 197         if (rc != 0) {
 198                 RTE_LOG(ERR, PIPELINE, "failed to read src address/mask: %s\n",
 199                         in[CB_FLD_SRC_ADDR]);
 200                 return rc;
 201         }
 202
 203         printf("V=%u, mask=%u\n", v->field_value[SRC_FIELD_IPV4].value.u32,
 204                 v->field_value[SRC_FIELD_IPV4].mask_range.u32);
 205
 206         /* Parse x.x.x.x/x */
 207         rc = parse_ipv4_net(in[CB_FLD_DST_ADDR],
 208                 &v->field_value[DST_FIELD_IPV4].value.u32,
 209                 &v->field_value[DST_FIELD_IPV4].mask_range.u32);
 210         if (rc != 0) {
 211                 RTE_LOG(ERR, PIPELINE, "failed to read dest address/mask: %s\n",
 212                         in[CB_FLD_DST_ADDR]);
 213                 return rc;
 214         }
 215
 216         printf("V=%u, mask=%u\n", v->field_value[DST_FIELD_IPV4].value.u32,
 217         v->field_value[DST_FIELD_IPV4].mask_range.u32);
 218         /* Parse n:n */
 219         rc = parse_port_range(in[CB_FLD_SRC_PORT_RANGE],
 220                 &v->field_value[SRCP_FIELD_IPV4].value.u16,
 221                 &v->field_value[SRCP_FIELD_IPV4].mask_range.u16);
 222         if (rc != 0) {
 223                 RTE_LOG(ERR, PIPELINE, "failed to read source port range: %s\n",
 224                         in[CB_FLD_SRC_PORT_RANGE]);
 225                 return rc;
 226         }
 227
 228         printf("V=%u, mask=%u\n", v->field_value[SRCP_FIELD_IPV4].value.u16,
 229                 v->field_value[SRCP_FIELD_IPV4].mask_range.u16);
 230         /* Parse n:n */
 231         rc = parse_port_range(in[CB_FLD_DST_PORT_RANGE],
 232                 &v->field_value[DSTP_FIELD_IPV4].value.u16,
 233                 &v->field_value[DSTP_FIELD_IPV4].mask_range.u16);
 234         if (rc != 0) {
 235                 RTE_LOG(ERR, PIPELINE, "failed to read dest port range: %s\n",
 236                         in[CB_FLD_DST_PORT_RANGE]);
 237                 return rc;
 238         }
 239
 240         printf("V=%u, mask=%u\n", v->field_value[DSTP_FIELD_IPV4].value.u16,
 241                 v->field_value[DSTP_FIELD_IPV4].mask_range.u16);
 242         /* parse 0/0xnn */
 243         GET_CB_FIELD(in[CB_FLD_PROTO],
 244                 v->field_value[PROTO_FIELD_IPV4].value.u8,
 245                 0, UINT8_MAX, '/');
 246         GET_CB_FIELD(in[CB_FLD_PROTO],
 247                 v->field_value[PROTO_FIELD_IPV4].mask_range.u8,
 248                 0, UINT8_MAX, 0);
 249
 250         printf("V=%u, mask=%u\n",
 251                 (unsigned int)v->field_value[PROTO_FIELD_IPV4].value.u8,
 252                 v->field_value[PROTO_FIELD_IPV4].mask_range.u8);
 253         return 0;
 254 }
 255
 256
 257 /*
 258  * The format for these rules DO NOT need the port ranges to be
 259  * separated by ' : ', just ':'. It's a lot more readable and
 260  * cleaner, IMO.
 261  */
 262 char lines[][128] = {
 263         "@0.0.0.0/0 0.0.0.0/0 0:65535 0:65535 2/0xff", /* Protocol check */
 264         "@192.168.3.1/32 0.0.0.0/0 0:65535 0:65535 0/0", /* Src IP checl */
 265         "@0.0.0.0/0 10.4.4.1/32 0:65535 0:65535 0/0", /* dst IP check */
 266         "@0.0.0.0/0 0.0.0.0/0 105:105 0:65535 0/0", /* src port check */
 267         "@0.0.0.0/0 0.0.0.0/0 0:65535 206:206 0/0", /* dst port check */
 268 };
 269
 270 char line[128];
 271
 272
 273 static int
 274 setup_acl_pipeline(void)
 275 {
 276         int ret;
 277         int i;
 278         struct rte_pipeline_params pipeline_params = {
 279                 .name = "PIPELINE",
 280                 .socket_id = 0,
 281         };
 282         uint32_t n;
 283         struct rte_table_acl_rule_add_params rule_params;
 284         struct rte_pipeline_table_acl_rule_delete_params *delete_params;
 285         parse_5tuple parser;
 286         char acl_name[64];
 287
 288         /* Pipeline configuration */
 289         p = rte_pipeline_create(&pipeline_params);
 290         if (p == NULL) {
 291                 RTE_LOG(INFO, PIPELINE, "%s: Failed to configure pipeline\n",
 292                         __func__);
 293                 goto fail;
 294         }
 295
 296         /* Input port configuration */
 297         for (i = 0; i < N_PORTS; i++) {
 298                 struct rte_port_ring_reader_params port_ring_params = {
 299                         .ring = rings_rx[i],
 300                 };
 301
 302                 struct rte_pipeline_port_in_params port_params = {
 303                         .ops = &rte_port_ring_reader_ops,
 304                         .arg_create = (void *) &port_ring_params,
 305                         .f_action = NULL,
 306                         .burst_size = BURST_SIZE,
 307                 };
 308
 309                 /* Put in action for some ports */
 310                 if (i)
 311                         port_params.f_action = port_in_action;
 312
 313                 ret = rte_pipeline_port_in_create(p, &port_params,
 314                         &port_in_id[i]);
 315                 if (ret) {
 316                         rte_panic("Unable to configure input port %d, ret:%d\n",
 317                                 i, ret);
 318                         goto fail;
 319                 }
 320         }
 321
 322         /* output Port configuration */
 323         for (i = 0; i < N_PORTS; i++) {
 324                 struct rte_port_ring_writer_params port_ring_params = {
 325                         .ring = rings_tx[i],
 326                         .tx_burst_sz = BURST_SIZE,
 327                 };
 328
 329                 struct rte_pipeline_port_out_params port_params = {
 330                         .ops = &rte_port_ring_writer_ops,
 331                         .arg_create = (void *) &port_ring_params,
 332                         .f_action = NULL,
 333                         .arg_ah = NULL,
 334                 };
 335
 336
 337                 if (rte_pipeline_port_out_create(p, &port_params,
 338                         &port_out_id[i])) {
 339                         rte_panic("Unable to configure output port %d\n", i);
 340                         goto fail;
 341                 }
 342         }
 343
 344         /* Table configuration  */
 345         for (i = 0; i < N_PORTS; i++) {
 346                 struct rte_pipeline_table_params table_params;
 347
 348                 /* Set up defaults for stub */
 349                 table_params.ops = &rte_table_stub_ops;
 350                 table_params.arg_create = NULL;
 351                 table_params.f_action_hit = action_handler_hit;
 352                 table_params.f_action_miss = NULL;
 353                 table_params.action_data_size = 0;
 354
 355                 RTE_LOG(INFO, PIPELINE, "miss_action=%x\n",
 356                         table_entry_miss_action);
 357
 358                 printf("RTE_ACL_RULE_SZ(%zu) = %zu\n", DIM(ipv4_defs),
 359                         RTE_ACL_RULE_SZ(DIM(ipv4_defs)));
 360
 361                 struct rte_table_acl_params acl_params;
 362
 363                 acl_params.n_rules = 1 << 5;
 364                 acl_params.n_rule_fields = DIM(ipv4_defs);
 365                 snprintf(acl_name, sizeof(acl_name), "ACL%d", i);
 366                 acl_params.name = acl_name;
 367                 memcpy(acl_params.field_format, ipv4_defs, sizeof(ipv4_defs));
 368
 369                 table_params.ops = &rte_table_acl_ops;
 370                 table_params.arg_create = &acl_params;
 371
 372                 if (rte_pipeline_table_create(p, &table_params, &table_id[i])) {
 373                         rte_panic("Unable to configure table %u\n", i);
 374                         goto fail;
 375                 }
 376
 377                 if (connect_miss_action_to_table) {
 378                         if (rte_pipeline_table_create(p, &table_params,
 379                                 &table_id[i+2])) {
 380                                 rte_panic("Unable to configure table %u\n", i);
 381                                 goto fail;
 382                         }
 383                 }
 384         }
 385
 386         for (i = 0; i < N_PORTS; i++) {
 387                 if (rte_pipeline_port_in_connect_to_table(p, port_in_id[i],
 388                         table_id[i])) {
 389                         rte_panic("Unable to connect input port %u to "
 390                                 "table %u\n",
 391                                 port_in_id[i],  table_id[i]);
 392                         goto fail;
 393                 }
 394         }
 395
 396         /* Add entries to tables */
 397         for (i = 0; i < N_PORTS; i++) {
 398                 struct rte_pipeline_table_entry table_entry = {
 399                         .action = RTE_PIPELINE_ACTION_PORT,
 400                         {.port_id = port_out_id[i^1]},
 401                 };
 402                 int key_found;
 403                 struct rte_pipeline_table_entry *entry_ptr;
 404
 405                 memset(&rule_params, 0, sizeof(rule_params));
 406                 parser = parse_cb_ipv4_rule;
 407
 408                 for (n = 1; n <= 5; n++) {
 409                         snprintf(line, sizeof(line), "%s", lines[n-1]);
 410                         printf("PARSING [%s]\n", line);
 411
 412                         ret = parser(line, &rule_params);
 413                         if (ret != 0) {
 414                                 RTE_LOG(ERR, PIPELINE,
 415                                         "line %u: parse_cb_ipv4vlan_rule"
 416                                         " failed, error code: %d (%s)\n",
 417                                         n, ret, strerror(-ret));
 418                                 return ret;
 419                         }
 420
 421                         rule_params.priority = RTE_ACL_MAX_PRIORITY - n;
 422
 423                         ret = rte_pipeline_table_entry_add(p, table_id[i],
 424                                 &rule_params,
 425                                 &table_entry, &key_found, &entry_ptr);
 426                         if (ret < 0) {
 427                                 rte_panic("Add entry to table %u failed (%d)\n",
 428                                         table_id[i], ret);
 429                                 goto fail;
 430                         }
 431                 }
 432
 433                 /* delete a few rules */
 434                 for (n = 2; n <= 3; n++) {
 435                         snprintf(line, sizeof(line), "%s", lines[n-1]);
 436                         printf("PARSING [%s]\n", line);
 437
 438                         ret = parser(line, &rule_params);
 439                         if (ret != 0) {
 440                                 RTE_LOG(ERR, PIPELINE, "line %u: parse rule "
 441                                         " failed, error code: %d (%s)\n",
 442                                         n, ret, strerror(-ret));
 443                                 return ret;
 444                         }
 445
 446                         delete_params = (struct
 447                                 rte_pipeline_table_acl_rule_delete_params *)
 448                                 &(rule_params.field_value[0]);
 449                         ret = rte_pipeline_table_entry_delete(p, table_id[i],
 450                                 delete_params, &key_found, NULL);
 451                         if (ret < 0) {
 452                                 rte_panic("Add entry to table %u failed (%d)\n",
 453                                         table_id[i], ret);
 454                                 goto fail;
 455                         } else
 456                                 printf("Deleted Rule.\n");
 457                 }
 458
 459
 460                 /* Try to add duplicates */
 461                 for (n = 1; n <= 5; n++) {
 462                         snprintf(line, sizeof(line), "%s", lines[n-1]);
 463                         printf("PARSING [%s]\n", line);
 464
 465                         ret = parser(line, &rule_params);
 466                         if (ret != 0) {
 467                                 RTE_LOG(ERR, PIPELINE, "line %u: parse rule"
 468                                         " failed, error code: %d (%s)\n",
 469                                         n, ret, strerror(-ret));
 470                                 return ret;
 471                         }
 472
 473                         rule_params.priority = RTE_ACL_MAX_PRIORITY - n;
 474
 475                         ret = rte_pipeline_table_entry_add(p, table_id[i],
 476                                 &rule_params,
 477                                 &table_entry, &key_found, &entry_ptr);
 478                         if (ret < 0) {
 479                                 rte_panic("Add entry to table %u failed (%d)\n",
 480                                         table_id[i], ret);
 481                                 goto fail;
 482                         }
 483                 }
 484         }
 485
 486         /* Enable input ports */
 487         for (i = 0; i < N_PORTS ; i++)
 488                 if (rte_pipeline_port_in_enable(p, port_in_id[i]))
 489                         rte_panic("Unable to enable input port %u\n",
 490                                 port_in_id[i]);
 491
 492         /* Check pipeline consistency */
 493         if (rte_pipeline_check(p) < 0) {
 494                 rte_panic("Pipeline consistency check failed\n");
 495                 goto fail;
 496         }
 497
 498         return  0;
 499 fail:
 500
 501         return -1;
 502 }
 503
 504 static int
 505 test_pipeline_single_filter(int expected_count)
 506 {
 507         int i, j, ret, tx_count;
 508         struct ipv4_5tuple five_tuple;
 509
 510         /* Allocate a few mbufs and manually insert into the rings. */
 511         for (i = 0; i < N_PORTS; i++) {
 512                 for (j = 0; j < 8; j++) {
 513                         struct rte_mbuf *mbuf;
 514
 515                         mbuf = rte_pktmbuf_alloc(pool);
 516                         if (mbuf == NULL)
 517                                 /* this will cause test failure after cleanup
 518                                  * of already enqueued mbufs, as the mbuf
 519                                  * counts won't match */
 520                                 break;
 521                         memset(rte_pktmbuf_mtod(mbuf, char *), 0x00,
 522                                 sizeof(struct ipv4_5tuple));
 523
 524                         five_tuple.proto = j;
 525                         five_tuple.ip_src = rte_bswap32(IPv4(192, 168, j, 1));
 526                         five_tuple.ip_dst = rte_bswap32(IPv4(10, 4, j, 1));
 527                         five_tuple.port_src = rte_bswap16(100 + j);
 528                         five_tuple.port_dst = rte_bswap16(200 + j);
 529
 530                         memcpy(rte_pktmbuf_mtod(mbuf, char *), &five_tuple,
 531                                 sizeof(struct ipv4_5tuple));
 532                         RTE_LOG(INFO, PIPELINE, "%s: Enqueue onto ring %d\n",
 533                                 __func__, i);
 534                         rte_ring_enqueue(rings_rx[i], mbuf);
 535                 }
 536         }
 537
 538         /* Run pipeline once */
 539         rte_pipeline_run(p);
 540
 541         rte_pipeline_flush(p);
 542
 543         tx_count = 0;
 544
 545         for (i = 0; i < N_PORTS; i++) {
 546                 void *objs[RING_TX_SIZE];
 547                 struct rte_mbuf *mbuf;
 548
 549                 ret = rte_ring_sc_dequeue_burst(rings_tx[i], objs, 10);
 550                 if (ret <= 0) {
 551                         printf("Got no objects from ring %d - error code %d\n",
 552                                 i, ret);
 553                 } else {
 554                         printf("Got %d object(s) from ring %d!\n", ret, i);
 555                         for (j = 0; j < ret; j++) {
 556                                 mbuf = (struct rte_mbuf *)objs[j];
 557                                 rte_hexdump(stdout, "mbuf",
 558                                         rte_pktmbuf_mtod(mbuf, char *), 64);
 559                                 rte_pktmbuf_free(mbuf);
 560                         }
 561                         tx_count += ret;
 562                 }
 563         }
 564
 565         if (tx_count != expected_count) {
 566                 RTE_LOG(INFO, PIPELINE,
 567                         "%s: Unexpected packets for ACL test, "
 568                         "expected %d, got %d\n",
 569                         __func__, expected_count, tx_count);
 570                 goto fail;
 571         }
 572
 573         rte_pipeline_free(p);
 574
 575         return  0;
 576 fail:
 577         return -1;
 578
 579 }
 580
 581 int
 582 test_table_ACL(void)
 583 {
 584
 585
 586         override_hit_mask = 0xFF; /* All packets are a hit */
 587
 588         setup_acl_pipeline();
 589         if (test_pipeline_single_filter(10) < 0)
 590                 return -1;
 591
 592         return 0;
 593 }