From: "Burakov, Anatoly" <anatoly.burakov@intel.com>
To: Adrien Mazarguil <adrien.mazarguil@6wind.com>,
Olivier Matz <olivier.matz@6wind.com>
Cc: dev@dpdk.org, Keith Wiles <keith.wiles@intel.com>,
Jingjing Wu <jingjing.wu@intel.com>,
Thomas Monjalon <thomas@monjalon.net>,
Ferruh Yigit <ferruh.yigit@intel.com>,
Jim Thompson <jim@netgate.com>
Subject: Re: [dpdk-dev] [PATCH v1] cmdline: rework as a wrapper to libedit
Date: Tue, 17 Apr 2018 16:59:30 +0100 [thread overview]
Message-ID: <e118280a-c24d-7482-95ce-5cd5ff9522ea@intel.com> (raw)
In-Reply-To: <20180417152016.5163-1-adrien.mazarguil@6wind.com>
On 17-Apr-18 4:21 PM, Adrien Mazarguil wrote:
> Disclaimer: this patch must not be confused with the CLI library [1]
> (work in progress) that will eventually supersede librte_cmdline itself
> with a different API.
>
> Rather, it modifies librte_cmdline to delegate all the heavy lifting
> (terminal and history handling), strips unused features and re-implements
> what remains of its public API as a wrapper to the editline library (also
> known as libedit) [2], a well-known, BSD-licensed and widely available
> library used by many projects which does everything needed and more [3].
>
> This approach was chosen because converting librte_cmdline as a wrapper to
> a more capable library was easier and faster than addressing its
> shortcomings and results in much less code to maintain in DPDK.
>
> It also provides a drop-in solution for applications that rely on
> librte_cmdline. They benefit from greatly improved command line handling
> without a meaningful impact on their code base.
>
> The main motivation behind this patch is testpmd's flow (rte_flow) command,
> which requires support for dynamic tokens and very long lines that must be
> broken down when displayed. This is not supported by librte_cmdline's
> limited terminal handling capabilities, resulting in a rather frustrating
> user experience.
>
> It had to be addressed given the importance of testpmd as one of the
> primary tool used by PMD developers.
>
> This rework results in the following changes:
>
> - Removed circular buffer management interface for command history
> (cmdline_cirbuf.c), command history being handled by libedit.
> - Removed raw command-line interpreter (cmdline_rdline.c).
> - Removed raw terminal handler (cmdline_vt100.c).
> - Removed all test/example code for the above.
> - Re-implemented high level interactive and non-interactive command-line
> handlers (cmdline.c and cmdline_socket.c) on top of libedit using its
> native interface, not its readline compatibility layer.
> - Made struct cmdline opaque so that applications relying on librte_cmdline
> do not need to include any libedit headers.
> - Applications do not need to include cmdline_rdline.h anymore.
> - Terminal resizing is now automatically handled.
> - New external dependency for applications relying on librte_cmdline.
> - Major version bump due to the ABI impact of these changes.
>
> [1] http://dpdk.org/browse/draft/dpdk-draft-cli/
> [2] http://thrysoee.dk/editline/
> [3] http://netbsd.gw.com/cgi-bin/man-cgi?editline++NetBSD-current
>
> Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> Cc: Olivier Matz <olivier.matz@6wind.com>
> Cc: Keith Wiles <keith.wiles@intel.com>
> Cc: Jingjing Wu <jingjing.wu@intel.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>
> Cc: Ferruh Yigit <ferruh.yigit@intel.com>
> Cc: Jim Thompson <jim@netgate.com>
>
> --
>
> No fundamental change since the original RFC [4], except it's been rebased
> several times and Meson build support was added in the meantime. Commit log
> was also shortened a bit.
>
> I'm re-sending this because I think it's useful, at least to me (duh). As
> the maintainer of rte_flow, I spend most of my time typing flow commands in
> testpmd and libedit makes that a pleasant experience.
>
> Try it out! And don't hesitate to send your acked-by line to get this in
> time for 18.05 :)
>
> [4] http://dpdk.org/ml/archives/dev/2017-November/081605.html
> ---
<...>
> + uint32_t error:1;
> + char prompt[RDLINE_PROMPT_SIZE];
> +};
> +
> +void
> +cmdline_set_prompt(struct cmdline *cl, const char *prompt)
> {
> - struct cmdline *cl = rdl->opaque;
> - int ret;
> - ret = cmdline_parse(cl, buf);
> - if (ret == CMDLINE_PARSE_AMBIGUOUS)
> - cmdline_printf(cl, "Ambiguous command\n");
> - else if (ret == CMDLINE_PARSE_NOMATCH)
> - cmdline_printf(cl, "Command not found\n");
> - else if (ret == CMDLINE_PARSE_BAD_ARGS)
> - cmdline_printf(cl, "Bad arguments\n");
> + if (!cl || !prompt)
> + return;
> + snprintf(cl->prompt, sizeof(cl->prompt), "%s", prompt);
Didn't look through the entire patch yet, but this stood out - please
use strlcpy() :)
--
Thanks,
Anatoly
next prev parent reply other threads:[~2018-04-17 15:59 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-09 13:43 [dpdk-dev] [RFC] " Adrien Mazarguil
2017-11-15 4:12 ` Wiles, Keith
2017-11-15 8:04 ` Olivier MATZ
2017-11-15 16:31 ` Wiles, Keith
2017-11-16 9:23 ` Adrien Mazarguil
2017-11-16 16:48 ` Wiles, Keith
2017-11-16 18:07 ` Thomas Monjalon
2017-11-16 17:06 ` Ferruh Yigit
2017-11-16 17:27 ` Wiles, Keith
2017-11-16 18:05 ` Thomas Monjalon
2017-11-16 16:53 ` Jim Thompson
2018-04-17 15:21 ` [dpdk-dev] [PATCH v1] " Adrien Mazarguil
2018-04-17 15:59 ` Burakov, Anatoly [this message]
2018-04-19 15:13 ` [dpdk-dev] [PATCH v2] " Adrien Mazarguil
2018-06-26 13:21 ` Olivier Matz
2018-06-26 13:33 ` Olivier Matz
2018-06-27 10:36 ` Bruce Richardson
2018-06-27 11:35 ` Olivier Matz
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=e118280a-c24d-7482-95ce-5cd5ff9522ea@intel.com \
--to=anatoly.burakov@intel.com \
--cc=adrien.mazarguil@6wind.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=jim@netgate.com \
--cc=jingjing.wu@intel.com \
--cc=keith.wiles@intel.com \
--cc=olivier.matz@6wind.com \
--cc=thomas@monjalon.net \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).