From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 5C923A0C43; Tue, 28 Sep 2021 21:47:51 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 19D6D410F6; Tue, 28 Sep 2021 21:47:43 +0200 (CEST) Received: from mail-lf1-f42.google.com (mail-lf1-f42.google.com [209.85.167.42]) by mails.dpdk.org (Postfix) with ESMTP id 2B268410E4 for ; Tue, 28 Sep 2021 21:47:39 +0200 (CEST) Received: by mail-lf1-f42.google.com with SMTP id b15so759796lfe.7 for ; Tue, 28 Sep 2021 12:47:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=wYQWW1vGGadsVk+J9suMSzwPkDeeNUPhsEQCQOG18b8=; b=jd9cIpNtNc6D9T4O9Wb3qkwqpsZpXH39mPpPgSrf93lrGVe2naraR7eDbHzc6j/FNS H7KzaN0YY37b7/yMO3B+FIEa+4tLHV2N3b5VB+EX2ZnTSCk2Mge/KndewR2zM1imhmrF c9XHFXhKGoK2Z85KxUG0mHkgvZ4nxhNtnK/Rp0HF/W9PKj9xePxHzOYUVD0Kf0YtgIUU taIwNQhflzGp2H/Bn99RRTOuF/FyxxEnGcgHh60XoH7AyO7akcK+BlM/ch7nxGZI6w2R yVcb+nCM4HWKsud5qi36UPnO4YJmA5D27In+V8dRK88YWZz0AQlwmE97h73EMwC0xPxN iWkQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=wYQWW1vGGadsVk+J9suMSzwPkDeeNUPhsEQCQOG18b8=; b=y/1X210l1MUiNNxk7rnIyOQDb0TA/zIvLoyG33qJdu69aXUkFewn80L3zf6R4SGId8 +8oyZmEp/D6+xbaUJmVzEuTS5Orn6uvgZt8bV4ijIYvlm/4Q1VhVWrZc36M9/2gbdFHl qgFrZx+5X3q+h3x7Nc8ftPZAuNTE8XIUkJoZNOBm0SqbCCxfNsVtHk04Zd5/cSF1tp6K u6k2go/yHoIFBcRXpCUmgryR9d7Fv45epthVonSyto1J6RAaq7mf8pQ93c2uLgMDjSsX 5JnNJEY+2k0vldn8lw3e/0UsbYakoG9B12x3zWp3doLRd1u4c/SpGN25brrcTN4lCeCM LBOA== X-Gm-Message-State: AOAM532EIX1oGxuLacc3w5R+Y8i6eiohZ+MvARHclFkmuYXCTifGXHOs RP0Oz0tBu9oFVZEbsHQAYYxtS3+I+7g= X-Google-Smtp-Source: ABdhPJwC2DN3ElKkbfdZ6L1gMoy5U36RbM896iKP6KkPIuiSzLc3tZJDh3IDqrrjB6T5ra4gOW2gLg== X-Received: by 2002:a2e:2201:: with SMTP id i1mr1725577lji.483.1632858458256; Tue, 28 Sep 2021 12:47:38 -0700 (PDT) Received: from sovereign.. (broadband-37-110-65-23.ip.moscow.rt.ru. [37.110.65.23]) by smtp.gmail.com with ESMTPSA id 8sm1871ljf.39.2021.09.28.12.47.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 28 Sep 2021 12:47:37 -0700 (PDT) From: Dmitry Kozlyuk To: dev@dpdk.org Cc: David Marchand , Olivier Matz , Dmitry Kozlyuk , Gregory Etelson Date: Tue, 28 Sep 2021 22:47:14 +0300 Message-Id: <20210928194714.365563-3-dmitry.kozliuk@gmail.com> X-Mailer: git-send-email 2.29.3 In-Reply-To: <20210928194714.365563-1-dmitry.kozliuk@gmail.com> References: <20210910231639.789066-2-dmitry.kozliuk@gmail.com> <20210928194714.365563-1-dmitry.kozliuk@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 2/2] cmdline: make struct rdline opaque X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Hide struct rdline definition and some RDLINE_* constants in order to be able to change internal buffer sizes transparently to the user. Add new functions: * rdline_create(): allocate and initialize struct rdline. This function replaces rdline_init() and takes an extra parameter: opaque user data for the callbacks. * rdline_free(): deallocate struct rdline. * rdline_get_history_buffer_size(): for use in tests. * rdline_get_opaque(): to obtain user data in callback functions. Remove rdline_init() function from library headers and export list, because using it requires the knowledge of sizeof(struct rdline). Signed-off-by: Dmitry Kozlyuk --- app/test-cmdline/commands.c | 2 +- app/test/test_cmdline_lib.c | 19 +++++--- lib/cmdline/cmdline.c | 3 +- lib/cmdline/cmdline_cirbuf.c | 1 - lib/cmdline/cmdline_private.h | 49 +++++++++++++++++++++ lib/cmdline/cmdline_rdline.c | 50 +++++++++++++++++++-- lib/cmdline/cmdline_rdline.h | 83 ++++++++++++----------------------- lib/cmdline/version.map | 8 +++- 8 files changed, 146 insertions(+), 69 deletions(-) diff --git a/app/test-cmdline/commands.c b/app/test-cmdline/commands.c index d732976f08..a13e1d1afd 100644 --- a/app/test-cmdline/commands.c +++ b/app/test-cmdline/commands.c @@ -297,7 +297,7 @@ cmd_get_history_bufsize_parsed(__rte_unused void *parsed_result, struct rdline *rdl = cmdline_get_rdline(cl); cmdline_printf(cl, "History buffer size: %zu\n", - sizeof(rdl->history_buf)); + rdline_get_history_buffer_size(rdl)); } cmdline_parse_token_string_t cmd_get_history_bufsize_tok = diff --git a/app/test/test_cmdline_lib.c b/app/test/test_cmdline_lib.c index d5a09b4541..367dcad5be 100644 --- a/app/test/test_cmdline_lib.c +++ b/app/test/test_cmdline_lib.c @@ -83,18 +83,18 @@ test_cmdline_parse_fns(void) static int test_cmdline_rdline_fns(void) { - struct rdline rdl; + struct rdline *rdl = NULL; rdline_write_char_t *wc = &cmdline_write_char; rdline_validate_t *v = &valid_buffer; rdline_complete_t *c = &complete_buffer; - if (rdline_init(NULL, wc, v, c) >= 0) + if (rdline_create(NULL, wc, v, c, NULL) >= 0) goto error; - if (rdline_init(&rdl, NULL, v, c) >= 0) + if (rdline_create(&rdl, NULL, v, c, NULL) >= 0) goto error; - if (rdline_init(&rdl, wc, NULL, c) >= 0) + if (rdline_create(&rdl, wc, NULL, c, NULL) >= 0) goto error; - if (rdline_init(&rdl, wc, v, NULL) >= 0) + if (rdline_create(&rdl, wc, v, NULL, NULL) >= 0) goto error; if (rdline_char_in(NULL, 0) >= 0) goto error; @@ -102,25 +102,30 @@ test_cmdline_rdline_fns(void) goto error; if (rdline_add_history(NULL, "history") >= 0) goto error; - if (rdline_add_history(&rdl, NULL) >= 0) + if (rdline_add_history(rdl, NULL) >= 0) goto error; if (rdline_get_history_item(NULL, 0) != NULL) goto error; /* void functions */ + rdline_get_history_buffer_size(NULL); + rdline_get_opaque(NULL); rdline_newline(NULL, "prompt"); - rdline_newline(&rdl, NULL); + rdline_newline(rdl, NULL); rdline_stop(NULL); rdline_quit(NULL); rdline_restart(NULL); rdline_redisplay(NULL); rdline_reset(NULL); rdline_clear_history(NULL); + rdline_free(NULL); + rdline_free(rdl); return 0; error: printf("Error: function accepted null parameter!\n"); + rdline_free(rdl); return -1; } diff --git a/lib/cmdline/cmdline.c b/lib/cmdline/cmdline.c index a176d15130..8f1854cb0b 100644 --- a/lib/cmdline/cmdline.c +++ b/lib/cmdline/cmdline.c @@ -85,13 +85,12 @@ cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out) cl->ctx = ctx; ret = rdline_init(&cl->rdl, cmdline_write_char, cmdline_valid_buffer, - cmdline_complete_buffer); + cmdline_complete_buffer, cl); if (ret != 0) { free(cl); return NULL; } - cl->rdl.opaque = cl; cmdline_set_prompt(cl, prompt); rdline_newline(&cl->rdl, cl->prompt); diff --git a/lib/cmdline/cmdline_cirbuf.c b/lib/cmdline/cmdline_cirbuf.c index 829a8af563..cbb76a7016 100644 --- a/lib/cmdline/cmdline_cirbuf.c +++ b/lib/cmdline/cmdline_cirbuf.c @@ -10,7 +10,6 @@ #include "cmdline_cirbuf.h" - int cirbuf_init(struct cirbuf *cbuf, char *buf, unsigned int start, unsigned int maxlen) { diff --git a/lib/cmdline/cmdline_private.h b/lib/cmdline/cmdline_private.h index 2e93674c66..c2e906d8de 100644 --- a/lib/cmdline/cmdline_private.h +++ b/lib/cmdline/cmdline_private.h @@ -17,6 +17,49 @@ #include +#define RDLINE_BUF_SIZE 512 +#define RDLINE_PROMPT_SIZE 32 +#define RDLINE_VT100_BUF_SIZE 8 +#define RDLINE_HISTORY_BUF_SIZE BUFSIZ +#define RDLINE_HISTORY_MAX_LINE 64 + +enum rdline_status { + RDLINE_INIT, + RDLINE_RUNNING, + RDLINE_EXITED +}; + +struct rdline { + enum rdline_status status; + /* rdline bufs */ + struct cirbuf left; + struct cirbuf right; + char left_buf[RDLINE_BUF_SIZE+2]; /* reserve 2 chars for the \n\0 */ + char right_buf[RDLINE_BUF_SIZE]; + + char prompt[RDLINE_PROMPT_SIZE]; + unsigned int prompt_size; + + char kill_buf[RDLINE_BUF_SIZE]; + unsigned int kill_size; + + /* history */ + struct cirbuf history; + char history_buf[RDLINE_HISTORY_BUF_SIZE]; + int history_cur_line; + + /* callbacks and func pointers */ + rdline_write_char_t *write_char; + rdline_validate_t *validate; + rdline_complete_t *complete; + + /* vt100 parser */ + struct cmdline_vt100 vt100; + + /* opaque pointer */ + void *opaque; +}; + #ifdef RTE_EXEC_ENV_WINDOWS struct terminal { DWORD input_mode; @@ -57,4 +100,10 @@ ssize_t cmdline_read_char(struct cmdline *cl, char *c); __rte_format_printf(2, 0) int cmdline_vdprintf(int fd, const char *format, va_list op); +int rdline_init(struct rdline *rdl, + rdline_write_char_t *write_char, + rdline_validate_t *validate, + rdline_complete_t *complete, + void *opaque); + #endif diff --git a/lib/cmdline/cmdline_rdline.c b/lib/cmdline/cmdline_rdline.c index 2cb53e38f2..a525513465 100644 --- a/lib/cmdline/cmdline_rdline.c +++ b/lib/cmdline/cmdline_rdline.c @@ -13,6 +13,7 @@ #include #include "cmdline_cirbuf.h" +#include "cmdline_private.h" #include "cmdline_rdline.h" static void rdline_puts(struct rdline *rdl, const char *buf); @@ -37,9 +38,10 @@ isblank2(char c) int rdline_init(struct rdline *rdl, - rdline_write_char_t *write_char, - rdline_validate_t *validate, - rdline_complete_t *complete) + rdline_write_char_t *write_char, + rdline_validate_t *validate, + rdline_complete_t *complete, + void *opaque) { if (!rdl || !write_char || !validate || !complete) return -EINVAL; @@ -47,10 +49,40 @@ rdline_init(struct rdline *rdl, rdl->validate = validate; rdl->complete = complete; rdl->write_char = write_char; + rdl->opaque = opaque; rdl->status = RDLINE_INIT; return cirbuf_init(&rdl->history, rdl->history_buf, 0, RDLINE_HISTORY_BUF_SIZE); } +int +rdline_create(struct rdline **out, + rdline_write_char_t *write_char, + rdline_validate_t *validate, + rdline_complete_t *complete, + void *opaque) +{ + struct rdline *rdl; + int ret; + + if (out == NULL) + return -EINVAL; + rdl = malloc(sizeof(*rdl)); + if (rdl == NULL) + return -ENOMEM; + ret = rdline_init(rdl, write_char, validate, complete, opaque); + if (ret < 0) + free(rdl); + else + *out = rdl; + return ret; +} + +void +rdline_free(struct rdline *rdl) +{ + free(rdl); +} + void rdline_newline(struct rdline *rdl, const char *prompt) { @@ -564,6 +596,18 @@ rdline_get_history_item(struct rdline * rdl, unsigned int idx) return NULL; } +size_t +rdline_get_history_buffer_size(struct rdline *rdl) +{ + return sizeof(rdl->history_buf); +} + +void * +rdline_get_opaque(struct rdline *rdl) +{ + return rdl != NULL ? rdl->opaque : NULL; +} + int rdline_add_history(struct rdline * rdl, const char * buf) { diff --git a/lib/cmdline/cmdline_rdline.h b/lib/cmdline/cmdline_rdline.h index d2170293de..df69c7992f 100644 --- a/lib/cmdline/cmdline_rdline.h +++ b/lib/cmdline/cmdline_rdline.h @@ -10,9 +10,7 @@ /** * This file is a small equivalent to the GNU readline library, but it * was originally designed for small systems, like Atmel AVR - * microcontrollers (8 bits). Indeed, we don't use any malloc that is - * sometimes not implemented (or just not recommended) on such - * systems. + * microcontrollers (8 bits). It only uses malloc() on object creation. * * Obviously, it does not support as many things as the GNU readline, * but at least it supports some interesting features like a kill @@ -38,19 +36,6 @@ extern "C" { #endif -/* configuration */ -#define RDLINE_BUF_SIZE 512 -#define RDLINE_PROMPT_SIZE 32 -#define RDLINE_VT100_BUF_SIZE 8 -#define RDLINE_HISTORY_BUF_SIZE BUFSIZ -#define RDLINE_HISTORY_MAX_LINE 64 - -enum rdline_status { - RDLINE_INIT, - RDLINE_RUNNING, - RDLINE_EXITED -}; - struct rdline; typedef int (rdline_write_char_t)(struct rdline *rdl, char); @@ -60,52 +45,32 @@ typedef int (rdline_complete_t)(struct rdline *rdl, const char *buf, char *dstbuf, unsigned int dstsize, int *state); -struct rdline { - enum rdline_status status; - /* rdline bufs */ - struct cirbuf left; - struct cirbuf right; - char left_buf[RDLINE_BUF_SIZE+2]; /* reserve 2 chars for the \n\0 */ - char right_buf[RDLINE_BUF_SIZE]; - - char prompt[RDLINE_PROMPT_SIZE]; - unsigned int prompt_size; - - char kill_buf[RDLINE_BUF_SIZE]; - unsigned int kill_size; - - /* history */ - struct cirbuf history; - char history_buf[RDLINE_HISTORY_BUF_SIZE]; - int history_cur_line; - - /* callbacks and func pointers */ - rdline_write_char_t *write_char; - rdline_validate_t *validate; - rdline_complete_t *complete; - - /* vt100 parser */ - struct cmdline_vt100 vt100; - - /* opaque pointer */ - void *opaque; -}; - /** - * Init fields for a struct rdline. Call this only once at the beginning - * of your program. - * \param rdl A pointer to an uninitialized struct rdline + * Allocate and initialize a new rdline instance. + * + * \param rdl Receives a pointer to the allocated structure. * \param write_char The function used by the function to write a character * \param validate A pointer to the function to execute when the * user validates the buffer. * \param complete A pointer to the function to execute when the * user completes the buffer. + * \param opaque User data for use in the callbacks. + * + * \return 0 on success, negative errno-style code in failure. */ -int rdline_init(struct rdline *rdl, - rdline_write_char_t *write_char, - rdline_validate_t *validate, - rdline_complete_t *complete); +int rdline_create(struct rdline **rdl, + rdline_write_char_t *write_char, + rdline_validate_t *validate, + rdline_complete_t *complete, + void *opaque); +/** + * Free an rdline instance. + * + * \param rdl A pointer to an initialized struct rdline. + * If NULL, this function is a no-op. + */ +void rdline_free(struct rdline *rdl); /** * Init the current buffer, and display a prompt. @@ -194,6 +159,16 @@ void rdline_clear_history(struct rdline *rdl); */ char *rdline_get_history_item(struct rdline *rdl, unsigned int i); +/** + * Get maximum history buffer size. + */ +size_t rdline_get_history_buffer_size(struct rdline *rdl); + +/** + * Get the opaque pointer supplied on struct rdline creation. + */ +void *rdline_get_opaque(struct rdline *rdl); + #ifdef __cplusplus } #endif diff --git a/lib/cmdline/version.map b/lib/cmdline/version.map index 980adb4f23..13feb4d0a5 100644 --- a/lib/cmdline/version.map +++ b/lib/cmdline/version.map @@ -57,7 +57,6 @@ DPDK_22 { rdline_clear_history; rdline_get_buffer; rdline_get_history_item; - rdline_init; rdline_newline; rdline_quit; rdline_redisplay; @@ -73,7 +72,14 @@ DPDK_22 { EXPERIMENTAL { global: + # added in 20.11 cmdline_get_rdline; + # added in 21.11 + rdline_create; + rdline_free; + rdline_get_history_buffer_size; + rdline_get_opaque; + local: *; }; -- 2.29.3