[dpdk-dev] [PATCH 1/2] examples/ipsec-secgw: set default to IPsec library mode

[Iremonger, Bernard]

Hi Konstantin,

<snip>

> > Set the default code path to librte_ipsec mode.
> > Add parameter 0 | 1 to -l option
> > Check for conflicting options, -w -a -e and reassembly options are not
> > supported in legacy mode.
> > Show fragment table size.
> > Update print_usage.
> > Update the ipsec-secgw guide.
> > Update the release notes.
> >
> > Signed-off-by: Bernard Iremonger <bernard.iremonger at intel.com>
> > ---
> >  doc/guides/rel_notes/release_19_11.rst   |  8 ++++++
> >  doc/guides/sample_app_ug/ipsec_secgw.rst |  6 +++--
> >  examples/ipsec-secgw/ipsec-secgw.c       | 44 ++++++++++++++++++++---
> ---------
> >  3 files changed, 40 insertions(+), 18 deletions(-)
> >
> > diff --git a/doc/guides/rel_notes/release_19_11.rst
> > b/doc/guides/rel_notes/release_19_11.rst
> > index 8490d89..70143c5 100644
> > --- a/doc/guides/rel_notes/release_19_11.rst
> > +++ b/doc/guides/rel_notes/release_19_11.rst
> > @@ -56,6 +56,14 @@ New Features
> >       Also, make sure to start the actual text at the margin.
> >
> =========================================================
> >
> > +* **Updated the IPsec Security Gateway application.**
> > +
> > +  The ``librte_ipsec`` code path is now the default code path in
> > + ``ipsec-secgw``
> > +
> > +  * The ``-l`` command line option has been extended to take a 0 | 1
> argument.
> > +    0 enables the code path that uses legacy code.
> > +    1 enables the code path that uses ``librte_ipsec``.
> >
> >  Removed Items
> >  -------------
> > diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst
> > b/doc/guides/sample_app_ug/ipsec_secgw.rst
> > index ad2d79e..17b00c0 100644
> > --- a/doc/guides/sample_app_ug/ipsec_secgw.rst
> > +++ b/doc/guides/sample_app_ug/ipsec_secgw.rst
> > @@ -92,7 +92,7 @@ The application has a number of command line
> options::
> >
> >     ./build/ipsec-secgw [EAL options] --
> >                          -p PORTMASK -P -u PORTMASK -j FRAMESIZE
> > -                        -l -w REPLAY_WINOW_SIZE -e -a
> > +                        -l 0 -w REPLAY_WINOW_SIZE -e -a
> >                          --config (port,queue,lcore)[,(port,queue,lcore]
> >                          --single-sa SAIDX
> >                          --rxoffload MASK @@ -120,7 +120,9 @@ Where:
> >      Minimum value: RTE_MBUF_DEFAULT_BUF_SIZE (2176)
> >      Maximum value: UINT16_MAX (65535).
> >
> > -*   ``-l``: enables code-path that uses librte_ipsec.
> > +*   ``-l 0 | 1``: Default is ``librte_ipsec`` code path.
> > +    0 enables the code path that uses legacy code.
> > +    1 enables the code path that uses ``librte_ipsec``.
> >
> >  *   ``-w REPLAY_WINOW_SIZE``: specifies the IPsec sequence number
> replay window
> >      size for each Security Association (available only with
> > librte_ipsec diff --git a/examples/ipsec-secgw/ipsec-secgw.c
> > b/examples/ipsec-secgw/ipsec-secgw.c
> > index 0d1fd6a..3e4b9e0 100644
> > --- a/examples/ipsec-secgw/ipsec-secgw.c
> > +++ b/examples/ipsec-secgw/ipsec-secgw.c
> > @@ -188,7 +188,7 @@ static uint32_t frame_buf_size =
> > RTE_MBUF_DEFAULT_BUF_SIZE;  static uint32_t mtu_size =
> RTE_ETHER_MTU;
> >
> >  /* application wide librte_ipsec/SA parameters */ -struct app_sa_prm
> > app_sa_prm = {.enable = 0};
> > +struct app_sa_prm app_sa_prm = {.enable = 1};
> >
> >  struct lcore_rx_queue {
> >  	uint16_t port_id;
> > @@ -1259,7 +1259,7 @@ print_usage(const char *prgname)
> >  		" [-P]"
> >  		" [-u PORTMASK]"
> >  		" [-j FRAMESIZE]"
> > -		" [-l]"
> > +		" [-l 0 | 1]"
> >  		" [-w REPLAY_WINDOW_SIZE]"
> >  		" [-e]"
> >  		" [-a]"
> > @@ -1277,7 +1277,8 @@ print_usage(const char *prgname)
> >  		"  -u PORTMASK: Hexadecimal bitmask of unprotected
> ports\n"
> >  		"  -j FRAMESIZE: Data buffer size, minimum (and default)\n"
> >  		"     value: RTE_MBUF_DEFAULT_BUF_SIZE\n"
> > -		"  -l enables code-path that uses librte_ipsec\n"
> > +		"  -l 0 enables code-path that uses the legacy code\n"
> > +		"  -l 1 enables code-path that uses librte_ipsec\n"
> >  		"  -w REPLAY_WINDOW_SIZE specifies IPsec SQN replay
> window\n"
> >  		"     size for each SA\n"
> >  		"  -e enables ESN\n"
> > @@ -1418,6 +1419,7 @@ print_app_sa_prm(const struct app_sa_prm
> *prm)
> >  	printf("replay window size: %u\n", prm->window_size);
> >  	printf("ESN: %s\n", (prm->enable_esn == 0) ? "disabled" :
> "enabled");
> >  	printf("SA flags: %#" PRIx64 "\n", prm->flags);
> > +	printf("Fragment Table size %u\n", frag_tbl_sz);
> >  }
> >
> >  static int32_t
> > @@ -1431,7 +1433,7 @@ parse_args(int32_t argc, char **argv)
> >
> >  	argvopt = argv;
> >
> > -	while ((opt = getopt_long(argc, argvopt, "aelp:Pu:f:j:w:",
> > +	while ((opt = getopt_long(argc, argvopt, "aep:Pu:f:j:w:l:",
> >  				lgopts, &option_index)) != EOF) {
> >
> >  		switch (opt) {
> > @@ -1483,18 +1485,28 @@ parse_args(int32_t argc, char **argv)
> >  			printf("Custom frame buffer size %u\n",
> frame_buf_size);
> >  			break;
> >  		case 'l':
> > -			app_sa_prm.enable = 1;
> > +			ret = parse_decimal(optarg);
> > +			if (ret == -1) {
> > +				printf("Invalid argument l %s\n", optarg);
> 
> Just as a nit, probably a bit better:
> printf("Invalid argument: \'%s\' for: \'%c\' option\n", optarg, opt); Apart from
> that:
> Acked-by: Konstantin Ananyev <konstantin.ananyev at intel.com>
> Tested-by: Konstantin Ananyev <konstantin.ananyev at intel.com>

I will send a v2.

Regards,

Bernard

<snip>