[v11,06/12] app/graph: support IPv4 lookup command line interfaces

  From: Sunil Kumar Kori <skori@marvell.com>

Adds ipv4_lookup module to configure LPM table. This LPM table
will be used for IPv4 lookup and forwarding.

Following commands are exposed:
 - ipv4_lookup route add ipv4 <ip> netmask <mask> via <ip>
 - help ipv4_lookup

Signed-off-by: Sunil Kumar Kori <skori@marvell.com>
Signed-off-by: Rakesh Kudurumalla <rkudurumalla@marvell.com>
---
 app/graph/cli.c            |   2 +
 app/graph/ethdev.c         |   2 +-
 app/graph/ip4_route.c      | 221 +++++++++++++++++++++++++++++++++++++
 app/graph/meson.build      |   1 +
 app/graph/module_api.h     |   1 +
 app/graph/route.h          |  26 +++++
 app/graph/route_priv.h     |  44 ++++++++
 doc/guides/tools/graph.rst |   9 ++
 8 files changed, 305 insertions(+), 1 deletion(-)
 create mode 100644 app/graph/ip4_route.c
 create mode 100644 app/graph/route.h
 create mode 100644 app/graph/route_priv.h
  

Acked-By: Nithin Dabilpuram <ndabilpuram@marvell.com>

On Fri, Oct 20, 2023 at 8:07 PM <skori@marvell.com> wrote:
>
> From: Sunil Kumar Kori <skori@marvell.com>
>
> Adds ipv4_lookup module to configure LPM table. This LPM table
> will be used for IPv4 lookup and forwarding.
>
> Following commands are exposed:
>  - ipv4_lookup route add ipv4 <ip> netmask <mask> via <ip>
>  - help ipv4_lookup
>
> Signed-off-by: Sunil Kumar Kori <skori@marvell.com>
> Signed-off-by: Rakesh Kudurumalla <rkudurumalla@marvell.com>
> ---
>  app/graph/cli.c            |   2 +
>  app/graph/ethdev.c         |   2 +-
>  app/graph/ip4_route.c      | 221 +++++++++++++++++++++++++++++++++++++
>  app/graph/meson.build      |   1 +
>  app/graph/module_api.h     |   1 +
>  app/graph/route.h          |  26 +++++
>  app/graph/route_priv.h     |  44 ++++++++
>  doc/guides/tools/graph.rst |   9 ++
>  8 files changed, 305 insertions(+), 1 deletion(-)
>  create mode 100644 app/graph/ip4_route.c
>  create mode 100644 app/graph/route.h
>  create mode 100644 app/graph/route_priv.h
>
> diff --git a/app/graph/cli.c b/app/graph/cli.c
> index fa394fade6..25785ea4dc 100644
> --- a/app/graph/cli.c
> +++ b/app/graph/cli.c
> @@ -30,6 +30,8 @@ cmdline_parse_ctx_t modules_ctx[] = {
>         (cmdline_parse_inst_t *)&ethdev_ip6_cmd_ctx,
>         (cmdline_parse_inst_t *)&ethdev_cmd_ctx,
>         (cmdline_parse_inst_t *)&ethdev_help_cmd_ctx,
> +       (cmdline_parse_inst_t *)&ipv4_lookup_cmd_ctx,
> +       (cmdline_parse_inst_t *)&ipv4_lookup_help_cmd_ctx,
>         NULL,
>  };
>
> diff --git a/app/graph/ethdev.c b/app/graph/ethdev.c
> index 8df55b4b12..4e4d23b692 100644
> --- a/app/graph/ethdev.c
> +++ b/app/graph/ethdev.c
> @@ -164,7 +164,7 @@ ethdev_stop(void)
>         }
>
>         ethdev_list_clean();
> -       rte_eal_cleanup();
> +       route_ip4_list_clean();
>         printf("Bye...\n");
>  }
>
> diff --git a/app/graph/ip4_route.c b/app/graph/ip4_route.c
> new file mode 100644
> index 0000000000..db3354c270
> --- /dev/null
> +++ b/app/graph/ip4_route.c
> @@ -0,0 +1,221 @@
> +/* SPDX-License-Identifier: BSD-3-Clause
> + * Copyright(c) 2023 Marvell.
> + */
> +
> +#include <stdio.h>
> +#include <stdlib.h>
> +#include <string.h>
> +
> +#include <cmdline_parse.h>
> +#include <cmdline_parse_num.h>
> +#include <cmdline_parse_string.h>
> +#include <cmdline_socket.h>
> +#include <rte_node_ip4_api.h>
> +
> +#include "module_api.h"
> +#include "route_priv.h"
> +
> +static const char
> +cmd_ipv4_lookup_help[] = "ipv4_lookup route add ipv4 <ip> netmask <mask> via <ip>";
> +
> +struct ip4_route route4 = TAILQ_HEAD_INITIALIZER(route4);
> +
> +
> +void
> +route_ip4_list_clean(void)
> +{
> +       struct route_ipv4_config *route;
> +
> +       while (!TAILQ_EMPTY(&route4)) {
> +               route = TAILQ_FIRST(&route4);
> +               TAILQ_REMOVE(&route4, route, next);
> +       }
> +}
> +
> +static struct route_ipv4_config *
> +find_route4_entry(struct route_ipv4_config *route)
> +{
> +       struct route_ipv4_config *ipv4route;
> +
> +       TAILQ_FOREACH(ipv4route, &route4, next) {
> +               if (!memcmp(ipv4route, route, sizeof(*route)))
> +                       return ipv4route;
> +       }
> +       return NULL;
> +
> +}
> +
> +static uint8_t
> +convert_netmask_to_depth(uint32_t netmask)
> +{
> +       uint8_t zerobits = 0;
> +
> +       while ((netmask & 0x1) == 0) {
> +               netmask = netmask >> 1;
> +               zerobits++;
> +       }
> +
> +       return (32 - zerobits);
> +}
> +
> +static int
> +route4_rewirte_table_update(struct route_ipv4_config *ipv4route)
> +{
> +       uint8_t depth;
> +       int portid;
> +
> +       portid = ethdev_portid_by_ip4(ipv4route->via, ipv4route->netmask);
> +       if (portid < 0) {
> +               printf("Invalid portid found to install the route\n");
> +               return portid;
> +       }
> +
> +       depth = convert_netmask_to_depth(ipv4route->netmask);
> +
> +       return rte_node_ip4_route_add(ipv4route->ip, depth, portid,
> +                       RTE_NODE_IP4_LOOKUP_NEXT_REWRITE);
> +}
> +
> +static int
> +route_ip4_add(struct route_ipv4_config *route)
> +{
> +       struct route_ipv4_config *ipv4route;
> +       int rc = -EINVAL;
> +
> +       ipv4route = find_route4_entry(route);
> +
> +       if (!ipv4route) {
> +               ipv4route = malloc(sizeof(struct route_ipv4_config));
> +               if (!ipv4route)
> +                       return -ENOMEM;
> +       } else {
> +               return 0;
> +       }
> +
> +       ipv4route->ip = route->ip;
> +       ipv4route->netmask = route->netmask;
> +       ipv4route->via = route->via;
> +       ipv4route->is_used = true;
> +
> +       /* FIXME: Get graph status here and then update table */
> +       rc = route4_rewirte_table_update(ipv4route);
> +       if (rc)
> +               goto free;
> +
> +       TAILQ_INSERT_TAIL(&route4, ipv4route, next);
> +       return 0;
> +free:
> +       free(ipv4route);
> +       return rc;
> +}
> +
> +int
> +route_ip4_add_to_lookup(void)
> +{
> +       struct route_ipv4_config *route = NULL;
> +       int rc = -EINVAL;
> +
> +       TAILQ_FOREACH(route, &route4, next) {
> +               rc = route4_rewirte_table_update(route);
> +               if (rc < 0)
> +                       return rc;
> +       }
> +
> +       return 0;
> +}
> +
> +static void
> +cli_ipv4_lookup_help(__rte_unused void *parsed_result, __rte_unused struct cmdline *cl,
> +                    __rte_unused void *data)
> +{
> +       size_t len;
> +
> +       len = strlen(conn->msg_out);
> +       conn->msg_out += len;
> +       snprintf(conn->msg_out, conn->msg_out_len_max, "\n%s\n%s\n",
> +                "--------------------------- ipv4_lookup command help ---------------------------",
> +                cmd_ipv4_lookup_help);
> +
> +       len = strlen(conn->msg_out);
> +       conn->msg_out_len_max -= len;
> +}
> +
> +static void
> +cli_ipv4_lookup(void *parsed_result, __rte_unused struct cmdline *cl, void *data __rte_unused)
> +{
> +       struct ip4_lookup_cmd_tokens *res = parsed_result;
> +       struct route_ipv4_config config;
> +       int rc = -EINVAL;
> +
> +       if (parser_ip4_read(&config.ip, res->ip)) {
> +               printf(MSG_ARG_INVALID, "ipv4");
> +               return;
> +       }
> +
> +       if (parser_ip4_read(&config.netmask, res->mask)) {
> +               printf(MSG_ARG_INVALID, "netmask");
> +               return;
> +       }
> +
> +       if (parser_ip4_read(&config.via, res->via_ip)) {
> +               printf(MSG_ARG_INVALID, "via ip");
> +               return;
> +       }
> +
> +       rc = route_ip4_add(&config);
> +       if (rc < 0)
> +               printf(MSG_CMD_FAIL, res->cmd);
> +}
> +
> +cmdline_parse_token_string_t ip4_lookup_cmd =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, cmd, "ipv4_lookup");
> +cmdline_parse_token_string_t ip4_lookup_route =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, route, "route");
> +cmdline_parse_token_string_t ip4_lookup_add =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, add, "add");
> +cmdline_parse_token_string_t ip4_lookup_ip4 =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, ip4, "ipv4");
> +cmdline_parse_token_string_t ip4_lookup_ip =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, ip, NULL);
> +cmdline_parse_token_string_t ip4_lookup_netmask =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, netmask, "netmask");
> +cmdline_parse_token_string_t ip4_lookup_mask =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, mask, NULL);
> +cmdline_parse_token_string_t ip4_lookup_via =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, via, "via");
> +cmdline_parse_token_string_t ip4_lookup_via_ip =
> +       TOKEN_STRING_INITIALIZER(struct ip4_lookup_cmd_tokens, via_ip, NULL);
> +
> +cmdline_parse_inst_t ipv4_lookup_cmd_ctx = {
> +       .f = cli_ipv4_lookup,
> +       .data = NULL,
> +       .help_str = cmd_ipv4_lookup_help,
> +       .tokens = {
> +               (void *)&ip4_lookup_cmd,
> +               (void *)&ip4_lookup_route,
> +               (void *)&ip4_lookup_add,
> +               (void *)&ip4_lookup_ip4,
> +               (void *)&ip4_lookup_ip,
> +               (void *)&ip4_lookup_netmask,
> +               (void *)&ip4_lookup_mask,
> +               (void *)&ip4_lookup_via,
> +               (void *)&ip4_lookup_via_ip,
> +               NULL,
> +       },
> +};
> +
> +cmdline_parse_token_string_t ipv4_lookup_help_cmd =
> +       TOKEN_STRING_INITIALIZER(struct ipv4_lookup_help_cmd_tokens, cmd, "help");
> +cmdline_parse_token_string_t ipv4_lookup_help_module =
> +       TOKEN_STRING_INITIALIZER(struct ipv4_lookup_help_cmd_tokens, module, "ipv4_lookup");
> +
> +cmdline_parse_inst_t ipv4_lookup_help_cmd_ctx = {
> +       .f = cli_ipv4_lookup_help,
> +       .data = NULL,
> +       .help_str = "",
> +       .tokens = {
> +               (void *)&ipv4_lookup_help_cmd,
> +               (void *)&ipv4_lookup_help_module,
> +               NULL,
> +       },
> +};
> diff --git a/app/graph/meson.build b/app/graph/meson.build
> index c17e0cc63e..1f35f82583 100644
> --- a/app/graph/meson.build
> +++ b/app/graph/meson.build
> @@ -13,6 +13,7 @@ sources = files(
>          'cli.c',
>          'conn.c',
>          'ethdev.c',
> +        'ip4_route.c',
>          'main.c',
>          'mempool.c',
>          'utils.c',
> diff --git a/app/graph/module_api.h b/app/graph/module_api.h
> index e8a6ccb562..bd4d245c75 100644
> --- a/app/graph/module_api.h
> +++ b/app/graph/module_api.h
> @@ -12,6 +12,7 @@
>  #include "conn.h"
>  #include "ethdev.h"
>  #include "mempool.h"
> +#include "route.h"
>  #include "utils.h"
>  /*
>   * Externs
> diff --git a/app/graph/route.h b/app/graph/route.h
> new file mode 100644
> index 0000000000..a44d401d55
> --- /dev/null
> +++ b/app/graph/route.h
> @@ -0,0 +1,26 @@
> +/* SPDX-License-Identifier: BSD-3-Clause
> + * Copyright(c) 2023 Marvell.
> + */
> +
> +#ifndef APP_GRAPH_ROUTE_H
> +#define APP_GRAPH_ROUTE_H
> +
> +#define MAX_ROUTE_ENTRIES 32
> +
> +extern cmdline_parse_inst_t ipv4_lookup_cmd_ctx;
> +extern cmdline_parse_inst_t ipv4_lookup_help_cmd_ctx;
> +
> +struct route_ipv4_config {
> +       TAILQ_ENTRY(route_ipv4_config) next;
> +       uint32_t ip;
> +       uint32_t netmask;
> +       uint32_t via;
> +       bool is_used;
> +};
> +
> +TAILQ_HEAD(ip4_route, route_ipv4_config);
> +
> +int route_ip4_add_to_lookup(void);
> +void route_ip4_list_clean(void);
> +
> +#endif
> diff --git a/app/graph/route_priv.h b/app/graph/route_priv.h
> new file mode 100644
> index 0000000000..f363a551a9
> --- /dev/null
> +++ b/app/graph/route_priv.h
> @@ -0,0 +1,44 @@
> +/* SPDX-License-Identifier: BSD-3-Clause
> + * Copyright(c) 2023 Marvell.
> + */
> +
> +#ifndef APP_GRAPH_ROUTE_PRIV_H
> +#define APP_GRAPH_ROUTE_PRIV_H
> +
> +#define MAX_ROUTE_ENTRIES 32
> +
> +struct ip4_lookup_cmd_tokens {
> +       cmdline_fixed_string_t cmd;
> +       cmdline_fixed_string_t route;
> +       cmdline_fixed_string_t add;
> +       cmdline_fixed_string_t ip4;
> +       cmdline_fixed_string_t ip;
> +       cmdline_fixed_string_t netmask;
> +       cmdline_fixed_string_t mask;
> +       cmdline_fixed_string_t via;
> +       cmdline_fixed_string_t via_ip;
> +};
> +
> +struct ip6_lookup_cmd_tokens {
> +       cmdline_fixed_string_t cmd;
> +       cmdline_fixed_string_t route;
> +       cmdline_fixed_string_t add;
> +       cmdline_fixed_string_t ip6;
> +       cmdline_fixed_string_t ip;
> +       cmdline_fixed_string_t netmask;
> +       cmdline_fixed_string_t mask;
> +       cmdline_fixed_string_t via;
> +       cmdline_fixed_string_t via_ip;
> +};
> +
> +struct ipv4_lookup_help_cmd_tokens {
> +       cmdline_fixed_string_t cmd;
> +       cmdline_fixed_string_t module;
> +};
> +
> +struct ipv6_lookup_help_cmd_tokens {
> +       cmdline_fixed_string_t cmd;
> +       cmdline_fixed_string_t module;
> +};
> +
> +#endif
> diff --git a/doc/guides/tools/graph.rst b/doc/guides/tools/graph.rst
> index 5dedea97de..7530ef6f65 100644
> --- a/doc/guides/tools/graph.rst
> +++ b/doc/guides/tools/graph.rst
> @@ -112,6 +112,15 @@ file to express the requested use case configuration.
>     | help ethdev                          | | Command to dump ethdev help     |   Yes   |    Yes   |
>     |                                      | | message.                        |         |          |
>     +--------------------------------------+-----------------------------------+---------+----------+
> +   | | ipv4_lookup route add ipv4 <ip>    | | Command to add a route into     |   Yes   |    Yes   |
> +   | |  netmask <mask> via <ip>           | | ``ipv4_lookup`` LPM table. It is|         |          |
> +   |                                      | | needed if user wishes to route  |         |          |
> +   |                                      | | the packets based on LPM lookup |         |          |
> +   |                                      | | table.                          |         |          |
> +   +--------------------------------------+-----------------------------------+---------+----------+
> +   | help ipv4_lookup                     | | Command to dump ``ipv4_lookup`` |   Yes   |    Yes   |
> +   |                                      | | help message.                   |         |          |
> +   +--------------------------------------+-----------------------------------+---------+----------+
>
>  Runtime configuration
>  ---------------------
> --
> 2.25.1
>