From: "Kinsella, Ray" <mdr@ashroe.eu> To: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>, dev@dpdk.org Cc: Dmitry Malloy <dmitrym@microsoft.com>, Narcisa Ana Maria Vasile <Narcisa.Vasile@microsoft.com>, Fady Bader <fady@mellanox.com>, Tal Shnaiderman <talshn@mellanox.com>, "Kadam, Pallavi" <pallavi.kadam@intel.com>, Olivier Matz <olivier.matz@6wind.com>, Neil Horman <nhorman@tuxdriver.com> Subject: Re: [dpdk-dev] [PATCH v2 1/7] cmdline: make implementation opaque Date: Wed, 5 Aug 2020 10:31:31 +0100 Message-ID: <727edaf3-a8a8-e55a-ce36-8bde541c810d@ashroe.eu> (raw) In-Reply-To: <20200730210652.14568-2-dmitry.kozliuk@gmail.com> On 30/07/2020 22:06, Dmitry Kozlyuk wrote: > struct cmdline exposes platform-specific members it contains, most > notably struct termios that is only available on Unix. Make the > structure opaque. > > Remove tests checking struct cmdline content as meaningless. > > Add cmdline_get_rdline() to access history buffer. > The new function is currently used only in tests. Should it be INTERNAL then? Is it useful outside of the test cases? > > Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com> > --- > app/test-cmdline/commands.c | 8 +++-- > app/test/test_cmdline_lib.c | 42 +++++++++------------- > lib/librte_cmdline/cmdline.c | 10 ++++-- > lib/librte_cmdline/cmdline.h | 15 ++++---- > lib/librte_cmdline/cmdline_parse.c | 4 +-- > lib/librte_cmdline/cmdline_private.h | 22 ++++++++++++ > lib/librte_cmdline/cmdline_socket.c | 6 ++-- > lib/librte_cmdline/rte_cmdline_version.map | 8 +++++ > 8 files changed, 68 insertions(+), 47 deletions(-) > create mode 100644 lib/librte_cmdline/cmdline_private.h > > diff --git a/app/test-cmdline/commands.c b/app/test-cmdline/commands.c > index d67c0ca6a..ff7ac973e 100644 > --- a/app/test-cmdline/commands.c > +++ b/app/test-cmdline/commands.c > @@ -294,8 +294,10 @@ cmd_get_history_bufsize_parsed(__rte_unused void *parsed_result, > struct cmdline *cl, > __rte_unused void *data) > { > + struct rdline *rdl = cmdline_get_rdline(cl); > + > cmdline_printf(cl, "History buffer size: %zu\n", > - sizeof(cl->rdl.history_buf)); > + sizeof(rdl->history_buf)); > } > > cmdline_parse_token_string_t cmd_get_history_bufsize_tok = > @@ -326,7 +328,9 @@ cmd_clear_history_parsed(__rte_unused void *parsed_result, > struct cmdline *cl, > __rte_unused void *data) > { > - rdline_clear_history(&cl->rdl); > + struct rdline *rdl = cmdline_get_rdline(cl); > + > + rdline_clear_history(rdl); > } > > cmdline_parse_token_string_t cmd_clear_history_tok = > diff --git a/app/test/test_cmdline_lib.c b/app/test/test_cmdline_lib.c > index dec465da5..a7f5a7f7f 100644 > --- a/app/test/test_cmdline_lib.c > +++ b/app/test/test_cmdline_lib.c > @@ -46,22 +46,29 @@ complete_buffer(__rte_unused struct rdline *rdl, > static int > test_cmdline_parse_fns(void) > { > - struct cmdline cl; > + struct cmdline *cl; > + cmdline_parse_ctx_t ctx; > int i = 0; > char dst[CMDLINE_TEST_BUFSIZE]; > > + cl = cmdline_new(&ctx, "prompt", -1, -1); > + if (cl == NULL) { > + printf("Error: cannot create cmdline to test parse fns!\n"); > + return -1; > + } > + > if (cmdline_parse(NULL, "buffer") >= 0) > goto error; > - if (cmdline_parse(&cl, NULL) >= 0) > + if (cmdline_parse(cl, NULL) >= 0) > goto error; > > if (cmdline_complete(NULL, "buffer", &i, dst, sizeof(dst)) >= 0) > goto error; > - if (cmdline_complete(&cl, NULL, &i, dst, sizeof(dst)) >= 0) > + if (cmdline_complete(cl, NULL, &i, dst, sizeof(dst)) >= 0) > goto error; > - if (cmdline_complete(&cl, "buffer", NULL, dst, sizeof(dst)) >= 0) > + if (cmdline_complete(cl, "buffer", NULL, dst, sizeof(dst)) >= 0) > goto error; > - if (cmdline_complete(&cl, "buffer", &i, NULL, sizeof(dst)) >= 0) > + if (cmdline_complete(cl, "buffer", &i, NULL, sizeof(dst)) >= 0) > goto error; > > return 0; > @@ -166,11 +173,11 @@ static int > test_cmdline_fns(void) > { > cmdline_parse_ctx_t ctx; > - struct cmdline cl, *tmp; > + struct cmdline *cl; > > memset(&ctx, 0, sizeof(ctx)); > - tmp = cmdline_new(&ctx, "test", -1, -1); > - if (tmp == NULL) > + cl = cmdline_new(&ctx, "test", -1, -1); > + if (cl == NULL) > goto error; > > if (cmdline_new(NULL, "prompt", 0, 0) != NULL) > @@ -179,7 +186,7 @@ test_cmdline_fns(void) > goto error; > if (cmdline_in(NULL, "buffer", CMDLINE_TEST_BUFSIZE) >= 0) > goto error; > - if (cmdline_in(&cl, NULL, CMDLINE_TEST_BUFSIZE) >= 0) > + if (cmdline_in(cl, NULL, CMDLINE_TEST_BUFSIZE) >= 0) > goto error; > if (cmdline_write_char(NULL, 0) >= 0) > goto error; > @@ -188,31 +195,14 @@ test_cmdline_fns(void) > cmdline_set_prompt(NULL, "prompt"); > cmdline_free(NULL); > cmdline_printf(NULL, "format"); > - /* this should fail as stream handles are invalid */ > - cmdline_printf(tmp, "format"); > cmdline_interact(NULL); > cmdline_quit(NULL); > > - /* check if void calls change anything when they should fail */ > - cl = *tmp; > - > - cmdline_printf(&cl, NULL); > - if (memcmp(&cl, tmp, sizeof(cl))) goto mismatch; > - cmdline_set_prompt(&cl, NULL); > - if (memcmp(&cl, tmp, sizeof(cl))) goto mismatch; > - cmdline_in(&cl, NULL, CMDLINE_TEST_BUFSIZE); > - if (memcmp(&cl, tmp, sizeof(cl))) goto mismatch; > - > - cmdline_free(tmp); > - > return 0; > > error: > printf("Error: function accepted null parameter!\n"); > return -1; > -mismatch: > - printf("Error: data changed!\n"); > - return -1; > } > > /* test library functions. the point of these tests is not so much to test > diff --git a/lib/librte_cmdline/cmdline.c b/lib/librte_cmdline/cmdline.c > index cfd703e5b..6f3fdd598 100644 > --- a/lib/librte_cmdline/cmdline.c > +++ b/lib/librte_cmdline/cmdline.c > @@ -13,14 +13,12 @@ > #include <fcntl.h> > #include <poll.h> > #include <errno.h> > -#include <termios.h> > #include <netinet/in.h> > > #include <rte_string_fns.h> > > -#include "cmdline_parse.h" > -#include "cmdline_rdline.h" > #include "cmdline.h" > +#include "cmdline_private.h" > > static void > cmdline_valid_buffer(struct rdline *rdl, const char *buf, > @@ -103,6 +101,12 @@ cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out) > return cl; > } > > +struct rdline* > +cmdline_get_rdline(struct cmdline *cl) > +{ > + return &cl->rdl; > +} > + > void > cmdline_free(struct cmdline *cl) > { > diff --git a/lib/librte_cmdline/cmdline.h b/lib/librte_cmdline/cmdline.h > index 243f99d20..96674dfda 100644 > --- a/lib/librte_cmdline/cmdline.h > +++ b/lib/librte_cmdline/cmdline.h > @@ -8,8 +8,8 @@ > #define _CMDLINE_H_ > > #include <rte_common.h> > +#include <rte_compat.h> > > -#include <termios.h> > #include <cmdline_rdline.h> > #include <cmdline_parse.h> > > @@ -23,14 +23,7 @@ > extern "C" { > #endif > > -struct cmdline { > - int s_in; > - int s_out; > - cmdline_parse_ctx_t *ctx; > - struct rdline rdl; > - char prompt[RDLINE_PROMPT_SIZE]; > - struct termios oldterm; > -}; > +struct cmdline; > > struct cmdline *cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out); > void cmdline_set_prompt(struct cmdline *cl, const char *prompt); > @@ -40,6 +33,10 @@ void cmdline_printf(const struct cmdline *cl, const char *fmt, ...) > int cmdline_in(struct cmdline *cl, const char *buf, int size); > int cmdline_write_char(struct rdline *rdl, char c); > > +__rte_experimental > +struct rdline * > +cmdline_get_rdline(struct cmdline *cl); > + > /** > * This function is nonblocking equivalent of ``cmdline_interact()``. It polls > * *cl* for one character and interpret it. If return value is *RDLINE_EXITED* > diff --git a/lib/librte_cmdline/cmdline_parse.c b/lib/librte_cmdline/cmdline_parse.c > index b57b30e8f..ea0979158 100644 > --- a/lib/librte_cmdline/cmdline_parse.c > +++ b/lib/librte_cmdline/cmdline_parse.c > @@ -10,15 +10,13 @@ > #include <string.h> > #include <inttypes.h> > #include <ctype.h> > -#include <termios.h> > > #include <netinet/in.h> > > #include <rte_string_fns.h> > > -#include "cmdline_rdline.h" > -#include "cmdline_parse.h" > #include "cmdline.h" > +#include "cmdline_private.h" > > #ifdef RTE_LIBRTE_CMDLINE_DEBUG > #define debug_printf printf > diff --git a/lib/librte_cmdline/cmdline_private.h b/lib/librte_cmdline/cmdline_private.h > new file mode 100644 > index 000000000..3b1c70e9f > --- /dev/null > +++ b/lib/librte_cmdline/cmdline_private.h > @@ -0,0 +1,22 @@ > +/* SPDX-License-Identifier: BSD-3-Clause > + * Copyright (c) 2020 Dmitry Kozlyuk > + */ > + > +#ifndef _CMDLINE_PRIVATE_H_ > +#define _CMDLINE_PRIVATE_H_ > + > +#include <termios.h> > + > +#include <cmdline_rdline.h> > +#include <cmdline_parse.h> > + > +struct cmdline { > + int s_in; > + int s_out; > + cmdline_parse_ctx_t *ctx; > + struct rdline rdl; > + char prompt[RDLINE_PROMPT_SIZE]; > + struct termios oldterm; > +}; > + > +#endif > diff --git a/lib/librte_cmdline/cmdline_socket.c b/lib/librte_cmdline/cmdline_socket.c > index ecb3d82b6..5e4b734d6 100644 > --- a/lib/librte_cmdline/cmdline_socket.c > +++ b/lib/librte_cmdline/cmdline_socket.c > @@ -11,12 +11,10 @@ > #include <stdarg.h> > #include <inttypes.h> > #include <fcntl.h> > -#include <termios.h> > > -#include "cmdline_parse.h" > -#include "cmdline_rdline.h" > -#include "cmdline_socket.h" > #include "cmdline.h" > +#include "cmdline_private.h" > +#include "cmdline_socket.h" > > struct cmdline * > cmdline_file_new(cmdline_parse_ctx_t *ctx, const char *prompt, const char *path) > diff --git a/lib/librte_cmdline/rte_cmdline_version.map b/lib/librte_cmdline/rte_cmdline_version.map > index 95fce812f..135ecc71f 100644 > --- a/lib/librte_cmdline/rte_cmdline_version.map > +++ b/lib/librte_cmdline/rte_cmdline_version.map > @@ -69,3 +69,11 @@ DPDK_20.0 { > > local: *; > }; > + > +EXPERIMENTAL { > + global: > + > + cmdline_get_rdline; > + > + local: *; > +}; >
next prev parent reply other threads:[~2020-08-05 9:31 UTC|newest] Thread overview: 50+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-06-20 21:05 [dpdk-dev] [PATCH 0/7] cmdline: support Windows Dmitry Kozlyuk 2020-06-20 21:05 ` [dpdk-dev] [PATCH 1/7] cmdline: make implementation opaque Dmitry Kozlyuk 2020-06-20 21:05 ` [dpdk-dev] [PATCH 2/7] cmdline: add internal wrappers for terminal handling Dmitry Kozlyuk 2020-06-20 21:05 ` [dpdk-dev] [PATCH 3/7] cmdline: add internal wrappers for character input Dmitry Kozlyuk 2020-06-20 21:05 ` [dpdk-dev] [PATCH 4/7] cmdline: add internal wrapper for vdprintf Dmitry Kozlyuk 2020-06-20 21:05 ` [dpdk-dev] [PATCH 5/7] eal/windows: improve compatibility networking headers Dmitry Kozlyuk 2020-06-20 21:05 ` [dpdk-dev] [PATCH 6/7] cmdline: support Windows Dmitry Kozlyuk 2020-06-28 14:20 ` Fady Bader 2020-06-29 6:23 ` Ranjit Menon 2020-06-29 7:42 ` Dmitry Kozlyuk 2020-06-29 8:12 ` Tal Shnaiderman 2020-06-29 23:56 ` Dmitry Kozlyuk 2020-07-08 1:09 ` Dmitry Kozlyuk 2020-06-20 21:05 ` [dpdk-dev] [PATCH 7/7] examples/cmdline: build on Windows Dmitry Kozlyuk 2020-07-17 22:16 ` [dpdk-dev] [PATCH 0/7] cmdline: support Windows Narcisa Ana Maria Vasile 2020-07-30 18:08 ` Kadam, Pallavi 2020-07-30 21:06 ` [dpdk-dev] [PATCH v2 " Dmitry Kozlyuk 2020-07-30 21:06 ` [dpdk-dev] [PATCH v2 1/7] cmdline: make implementation opaque Dmitry Kozlyuk 2020-08-05 9:31 ` Kinsella, Ray [this message] 2020-08-05 11:17 ` Dmitry Kozlyuk 2020-09-30 8:11 ` Kinsella, Ray 2020-09-30 15:26 ` Dmitry Kozlyuk 2020-09-17 13:34 ` Olivier Matz 2020-09-17 17:05 ` Stephen Hemminger 2020-09-18 8:33 ` Bruce Richardson 2020-09-18 12:13 ` Ferruh Yigit 2020-09-18 13:23 ` Kinsella, Ray 2020-09-17 23:13 ` Dmitry Kozlyuk 2020-09-18 13:31 ` Kinsella, Ray 2020-07-30 21:06 ` [dpdk-dev] [PATCH v2 2/7] cmdline: add internal wrappers for terminal handling Dmitry Kozlyuk 2020-07-30 21:06 ` [dpdk-dev] [PATCH v2 3/7] cmdline: add internal wrappers for character input Dmitry Kozlyuk 2020-07-30 21:06 ` [dpdk-dev] [PATCH v2 4/7] cmdline: add internal wrapper for vdprintf Dmitry Kozlyuk 2020-07-30 21:06 ` [dpdk-dev] [PATCH v2 5/7] eal/windows: improve compatibility networking headers Dmitry Kozlyuk 2020-07-30 21:06 ` [dpdk-dev] [PATCH v2 6/7] cmdline: support Windows Dmitry Kozlyuk 2020-07-30 21:06 ` [dpdk-dev] [PATCH v2 7/7] examples/cmdline: build on Windows Dmitry Kozlyuk 2020-09-26 1:33 ` [dpdk-dev] [EXTERNAL] " Narcisa Ana Maria Vasile 2020-09-26 6:03 ` Khoa To 2020-09-28 21:50 ` [dpdk-dev] [PATCH v3 0/7] cmdline: support Windows Dmitry Kozlyuk 2020-09-28 21:50 ` [dpdk-dev] [PATCH v3 1/7] cmdline: make implementation logically opaque Dmitry Kozlyuk 2020-09-30 8:12 ` Kinsella, Ray 2020-09-28 21:50 ` [dpdk-dev] [PATCH v3 2/7] cmdline: add internal wrappers for terminal handling Dmitry Kozlyuk 2020-09-28 21:50 ` [dpdk-dev] [PATCH v3 3/7] cmdline: add internal wrappers for character input Dmitry Kozlyuk 2020-09-28 21:50 ` [dpdk-dev] [PATCH v3 4/7] cmdline: add internal wrapper for vdprintf Dmitry Kozlyuk 2020-09-28 21:50 ` [dpdk-dev] [PATCH v3 5/7] eal/windows: improve compatibility networking headers Dmitry Kozlyuk 2020-09-28 21:50 ` [dpdk-dev] [PATCH v3 6/7] cmdline: support Windows Dmitry Kozlyuk 2020-10-14 22:31 ` Thomas Monjalon 2020-09-28 21:50 ` [dpdk-dev] [PATCH v3 7/7] examples/cmdline: build on Windows Dmitry Kozlyuk 2020-10-14 22:33 ` Thomas Monjalon 2020-10-05 15:33 ` [dpdk-dev] [PATCH v3 0/7] cmdline: support Windows Olivier Matz 2020-10-14 22:41 ` Thomas Monjalon
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=727edaf3-a8a8-e55a-ce36-8bde541c810d@ashroe.eu \ --to=mdr@ashroe.eu \ --cc=Narcisa.Vasile@microsoft.com \ --cc=dev@dpdk.org \ --cc=dmitry.kozliuk@gmail.com \ --cc=dmitrym@microsoft.com \ --cc=fady@mellanox.com \ --cc=nhorman@tuxdriver.com \ --cc=olivier.matz@6wind.com \ --cc=pallavi.kadam@intel.com \ --cc=talshn@mellanox.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
DPDK patches and discussions This inbox may be cloned and mirrored by anyone: git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \ dev@dpdk.org public-inbox-index dev Example config snippet for mirrors. Newsgroup available over NNTP: nntp://inbox.dpdk.org/inbox.dpdk.dev AGPL code for this site: git clone https://public-inbox.org/public-inbox.git