blob: 6c49d80aabd34d1308ee5f0ba661b1ae23442e44 [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15/*
16 * cli.c: Unix stdin/socket CLI.
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 */
Chris Lukeb5850972016-05-03 16:34:59 -040039/**
Chris Luke8e5b0412016-07-26 13:06:10 -040040 * @file
Chris Lukeb5850972016-05-03 16:34:59 -040041 * @brief Unix stdin/socket command line interface.
42 * Provides a command line interface so humans can interact with VPP.
43 * This is predominantly a debugging and testing mechanism.
44 */
Chris Luke90f52bf2016-09-12 08:55:13 -040045/*? %%clicmd:group_label Command line session %% ?*/
46/*? %%syscfg:group_label Command line session %% ?*/
Ed Warnickecb9cada2015-12-08 15:45:58 -070047
48#include <vlib/vlib.h>
49#include <vlib/unix/unix.h>
Chris Luke0aca5eb2016-04-25 13:48:54 -040050#include <vppinfra/timer.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070051
Chris Luke0aca5eb2016-04-25 13:48:54 -040052#include <ctype.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070053#include <fcntl.h>
54#include <sys/stat.h>
55#include <termios.h>
Chris Luke7afda3a2016-04-25 13:49:22 -040056#include <signal.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070057#include <unistd.h>
58#include <arpa/telnet.h>
Chris Luke7afda3a2016-04-25 13:49:22 -040059#include <sys/ioctl.h>
Damjan Marionf6616382017-06-21 12:01:37 +020060#include <sys/types.h>
61#include <unistd.h>
Damjan Marionceab7882018-01-19 20:56:12 +010062#include <limits.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070063
Chris Lukeb5850972016-05-03 16:34:59 -040064/** ANSI escape code. */
Chris Luke0aca5eb2016-04-25 13:48:54 -040065#define ESC "\x1b"
66
Chris Lukeb5850972016-05-03 16:34:59 -040067/** ANSI Control Sequence Introducer. */
Chris Luke0aca5eb2016-04-25 13:48:54 -040068#define CSI ESC "["
69
Chris Lukeb5850972016-05-03 16:34:59 -040070/** ANSI clear screen. */
Chris Luke7afda3a2016-04-25 13:49:22 -040071#define ANSI_CLEAR CSI "2J" CSI "1;1H"
Chris Lukeb5850972016-05-03 16:34:59 -040072/** ANSI reset color settings. */
Chris Luke7afda3a2016-04-25 13:49:22 -040073#define ANSI_RESET CSI "0m"
Chris Lukeb5850972016-05-03 16:34:59 -040074/** ANSI Start bold text. */
Chris Luke7afda3a2016-04-25 13:49:22 -040075#define ANSI_BOLD CSI "1m"
Chris Lukeb5850972016-05-03 16:34:59 -040076/** ANSI Stop bold text. */
Chris Luke7afda3a2016-04-25 13:49:22 -040077#define ANSI_DIM CSI "2m"
Chris Lukeb5850972016-05-03 16:34:59 -040078/** ANSI Start dark red text. */
Chris Luke7afda3a2016-04-25 13:49:22 -040079#define ANSI_DRED ANSI_DIM CSI "31m"
Chris Lukeb5850972016-05-03 16:34:59 -040080/** ANSI Start bright red text. */
Chris Luke7afda3a2016-04-25 13:49:22 -040081#define ANSI_BRED ANSI_BOLD CSI "31m"
Chris Lukeb5850972016-05-03 16:34:59 -040082/** ANSI clear line cursor is on. */
Chris Luke7afda3a2016-04-25 13:49:22 -040083#define ANSI_CLEARLINE CSI "2K"
Chris Lukeb5850972016-05-03 16:34:59 -040084/** ANSI scroll screen down one line. */
Chris Luke7afda3a2016-04-25 13:49:22 -040085#define ANSI_SCROLLDN CSI "1T"
Chris Lukeb5850972016-05-03 16:34:59 -040086/** ANSI save cursor position. */
Chris Luke7afda3a2016-04-25 13:49:22 -040087#define ANSI_SAVECURSOR CSI "s"
Chris Lukeb5850972016-05-03 16:34:59 -040088/** ANSI restore cursor position if previously saved. */
Chris Luke7afda3a2016-04-25 13:49:22 -040089#define ANSI_RESTCURSOR CSI "u"
Chris Luke0aca5eb2016-04-25 13:48:54 -040090
91/** Maximum depth into a byte stream from which to compile a Telnet
Chris Luke2d8bf302017-11-12 22:26:37 -050092 * protocol message. This is a safety measure. */
Chris Luke1aed76f2016-04-29 08:14:38 -040093#define UNIX_CLI_MAX_DEPTH_TELNET 24
Chris Luke0aca5eb2016-04-25 13:48:54 -040094
Chris Lukeb2bcad62017-09-18 08:51:22 -040095/** Maximum terminal width we will accept */
96#define UNIX_CLI_MAX_TERMINAL_WIDTH 512
Chris Lukeb2bcad62017-09-18 08:51:22 -040097/** Maximum terminal height we will accept */
98#define UNIX_CLI_MAX_TERMINAL_HEIGHT 512
Chris Luke2d8bf302017-11-12 22:26:37 -050099/** Default terminal height */
100#define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT 24
101/** Default terminal width */
102#define UNIX_CLI_DEFAULT_TERMINAL_WIDTH 80
Chris Luke0aca5eb2016-04-25 13:48:54 -0400103
Chris Lukeb5850972016-05-03 16:34:59 -0400104/** A CLI banner line. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400105typedef struct
106{
107 u8 *line; /**< The line to print. */
108 u32 length; /**< The length of the line without terminating NUL. */
Chris Luke572d8122016-04-25 13:49:07 -0400109} unix_cli_banner_t;
110
111#define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
112/** Plain welcome banner. */
113static unix_cli_banner_t unix_cli_banner[] = {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400114 _(" _______ _ _ _____ ___ \n"),
115 _(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
116 _(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
117 _(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
118 _("\n")
Chris Luke572d8122016-04-25 13:49:07 -0400119};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400120
Chris Luke572d8122016-04-25 13:49:07 -0400121/** ANSI color welcome banner. */
122static unix_cli_banner_t unix_cli_banner_color[] = {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400123 _(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
124 _(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
125 _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
126 _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
127 _("\n")
Chris Luke572d8122016-04-25 13:49:07 -0400128};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400129
Chris Luke572d8122016-04-25 13:49:07 -0400130#undef _
131
Chris Luke862623d2016-05-14 10:13:34 -0400132/** Pager line index */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400133typedef struct
134{
Chris Luke862623d2016-05-14 10:13:34 -0400135 /** Index into pager_vector */
136 u32 line;
137
138 /** Offset of the string in the line */
139 u32 offset;
140
141 /** Length of the string in the line */
142 u32 length;
143} unix_cli_pager_index_t;
144
Chris Luke572d8122016-04-25 13:49:07 -0400145
Chris Luke0aca5eb2016-04-25 13:48:54 -0400146/** Unix CLI session. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400147typedef struct
148{
Chris Lukeb5850972016-05-03 16:34:59 -0400149 /** The file index held by unix.c */
Damjan Marion56dd5432017-09-08 19:52:02 +0200150 u32 clib_file_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700151
Chris Lukeb5850972016-05-03 16:34:59 -0400152 /** Vector of output pending write to file descriptor. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400153 u8 *output_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700154
Chris Lukeb5850972016-05-03 16:34:59 -0400155 /** Vector of input saved by Unix input node to be processed by
Ed Warnickecb9cada2015-12-08 15:45:58 -0700156 CLI process. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400157 u8 *input_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700158
Chris Luke54ccf222016-07-25 16:38:11 -0400159 /** This session has command history. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700160 u8 has_history;
Chris Luke54ccf222016-07-25 16:38:11 -0400161 /** Array of vectors of commands in the history. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400162 u8 **command_history;
Chris Luke54ccf222016-07-25 16:38:11 -0400163 /** The command currently pointed at by the history cursor. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400164 u8 *current_command;
Chris Luke54ccf222016-07-25 16:38:11 -0400165 /** How far from the end of the history array the user has browsed. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700166 i32 excursion;
Chris Luke6b90fe32016-04-25 13:49:15 -0400167
Chris Lukeb5850972016-05-03 16:34:59 -0400168 /** Maximum number of history entries this session will store. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700169 u32 history_limit;
Chris Luke6b90fe32016-04-25 13:49:15 -0400170
Chris Lukeb5850972016-05-03 16:34:59 -0400171 /** Current command line counter */
Chris Luke6b90fe32016-04-25 13:49:15 -0400172 u32 command_number;
173
Chris Luke54ccf222016-07-25 16:38:11 -0400174 /** The string being searched for in the history. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400175 u8 *search_key;
Chris Luke54ccf222016-07-25 16:38:11 -0400176 /** If non-zero then the CLI is searching in the history array.
177 * - @c -1 means search backwards.
178 * - @c 1 means search forwards.
179 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700180 int search_mode;
181
Chris Lukeb5850972016-05-03 16:34:59 -0400182 /** Position of the insert cursor on the current input line */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400183 u32 cursor;
184
Chris Lukeb5850972016-05-03 16:34:59 -0400185 /** Line mode or char mode */
Chris Luke7afda3a2016-04-25 13:49:22 -0400186 u8 line_mode;
187
Chris Lukeb5850972016-05-03 16:34:59 -0400188 /** Set if the CRLF mode wants CR + LF */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400189 u8 crlf_mode;
190
Chris Lukeb5850972016-05-03 16:34:59 -0400191 /** Can we do ANSI output? */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400192 u8 ansi_capable;
193
Chris Lukeb5850972016-05-03 16:34:59 -0400194 /** Has the session started? */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400195 u8 started;
196
Chris Lukeb5850972016-05-03 16:34:59 -0400197 /** Disable the pager? */
Chris Luke7afda3a2016-04-25 13:49:22 -0400198 u8 no_pager;
199
Chris Luke03add7f2017-09-20 23:31:24 -0400200 /** Whether the session is interactive or not.
201 * Controls things like initial banner, the CLI prompt etc. */
202 u8 is_interactive;
203
204 /** Whether the session is attached to a socket. */
205 u8 is_socket;
206
207 /** If EPIPE has been detected, prevent further write-related
208 * activity on the descriptor.
209 */
210 u8 has_epipe;
211
Chris Lukeb5850972016-05-03 16:34:59 -0400212 /** Pager buffer */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400213 u8 **pager_vector;
Chris Luke7afda3a2016-04-25 13:49:22 -0400214
Chris Luke862623d2016-05-14 10:13:34 -0400215 /** Index of line fragments in the pager buffer */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400216 unix_cli_pager_index_t *pager_index;
Chris Luke7afda3a2016-04-25 13:49:22 -0400217
Chris Lukeb5850972016-05-03 16:34:59 -0400218 /** Line number of top of page */
Chris Luke7afda3a2016-04-25 13:49:22 -0400219 u32 pager_start;
220
Chris Lukeb5850972016-05-03 16:34:59 -0400221 /** Terminal width */
222 u32 width;
Chris Luke7afda3a2016-04-25 13:49:22 -0400223
Chris Lukeb5850972016-05-03 16:34:59 -0400224 /** Terminal height */
225 u32 height;
226
227 /** Process node identifier */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700228 u32 process_node_index;
Chris Lukefc379d22018-06-05 23:50:19 -0400229
230 /** The current direction of cursor travel.
231 * This is important since when advancing left-to-right, at the
232 * right hand edge of the console the terminal typically defers
233 * wrapping the cursor to the next line until a character is
234 * actually displayed.
235 * This messes up our heuristic for whether to use ANSI to return
236 * the cursor to the end of the line and instead we have to
237 * nudge the cursor to the next line.
238 * A Value of @c 0 means we're advancing left-to-right; @c 1 means
239 * the opposite.
240 */
241 u8 cursor_direction;
242
Ed Warnickecb9cada2015-12-08 15:45:58 -0700243} unix_cli_file_t;
244
Chris Lukeb5850972016-05-03 16:34:59 -0400245/** Resets the pager buffer and other data.
246 * @param f The CLI session whose pager needs to be reset.
247 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700248always_inline void
Dave Barach9b8ffd92016-07-08 08:13:45 -0400249unix_cli_pager_reset (unix_cli_file_t * f)
Chris Luke7afda3a2016-04-25 13:49:22 -0400250{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400251 u8 **p;
Chris Luke7afda3a2016-04-25 13:49:22 -0400252
Chris Luke862623d2016-05-14 10:13:34 -0400253 f->pager_start = 0;
254
255 vec_free (f->pager_index);
256 f->pager_index = 0;
257
Chris Luke7afda3a2016-04-25 13:49:22 -0400258 vec_foreach (p, f->pager_vector)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400259 {
260 vec_free (*p);
261 }
Chris Luke862623d2016-05-14 10:13:34 -0400262 vec_free (f->pager_vector);
Chris Luke7afda3a2016-04-25 13:49:22 -0400263 f->pager_vector = 0;
264}
265
Chris Lukeb5850972016-05-03 16:34:59 -0400266/** Release storage used by a CLI session.
267 * @param f The CLI session whose storage needs to be released.
268 */
Chris Luke7afda3a2016-04-25 13:49:22 -0400269always_inline void
Ed Warnickecb9cada2015-12-08 15:45:58 -0700270unix_cli_file_free (unix_cli_file_t * f)
271{
272 vec_free (f->output_vector);
273 vec_free (f->input_vector);
Chris Luke862623d2016-05-14 10:13:34 -0400274 unix_cli_pager_reset (f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700275}
276
Chris Lukeb5850972016-05-03 16:34:59 -0400277/** CLI actions */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400278typedef enum
279{
Chris Luke54ccf222016-07-25 16:38:11 -0400280 UNIX_CLI_PARSE_ACTION_NOACTION = 0, /**< No action */
281 UNIX_CLI_PARSE_ACTION_CRLF, /**< Carriage return, newline or enter */
282 UNIX_CLI_PARSE_ACTION_TAB, /**< Tab key */
283 UNIX_CLI_PARSE_ACTION_ERASE, /**< Erase cursor left */
284 UNIX_CLI_PARSE_ACTION_ERASERIGHT, /**< Erase cursor right */
285 UNIX_CLI_PARSE_ACTION_UP, /**< Up arrow */
286 UNIX_CLI_PARSE_ACTION_DOWN, /**< Down arrow */
287 UNIX_CLI_PARSE_ACTION_LEFT, /**< Left arrow */
288 UNIX_CLI_PARSE_ACTION_RIGHT, /**< Right arrow */
289 UNIX_CLI_PARSE_ACTION_HOME, /**< Home key (jump to start of line) */
290 UNIX_CLI_PARSE_ACTION_END, /**< End key (jump to end of line) */
291 UNIX_CLI_PARSE_ACTION_WORDLEFT, /**< Jump cursor to start of left word */
292 UNIX_CLI_PARSE_ACTION_WORDRIGHT, /**< Jump cursor to start of right word */
293 UNIX_CLI_PARSE_ACTION_ERASELINELEFT, /**< Erase line to left of cursor */
294 UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
295 UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
296 UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
297 UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
298 UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
299 UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400300
Chris Luke54ccf222016-07-25 16:38:11 -0400301 UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
302 UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
303 UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
304 UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
305 UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
306 UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
307 UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
308 UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
309 UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
310 UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
311 UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
Chris Luke7afda3a2016-04-25 13:49:22 -0400312
Chris Luke54ccf222016-07-25 16:38:11 -0400313 UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
314 UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400315} unix_cli_parse_action_t;
316
Chris Luke8e5b0412016-07-26 13:06:10 -0400317/** @brief Mapping of input buffer strings to action values.
Chris Luke0aca5eb2016-04-25 13:48:54 -0400318 * @note This won't work as a hash since we need to be able to do
319 * partial matches on the string.
320 */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400321typedef struct
322{
323 u8 *input; /**< Input string to match. */
324 u32 len; /**< Length of input without final NUL. */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400325 unix_cli_parse_action_t action; /**< Action to take when matched. */
326} unix_cli_parse_actions_t;
327
Chris Lukeb5850972016-05-03 16:34:59 -0400328/** @brief Given a capital ASCII letter character return a @c NUL terminated
Chris Luke0aca5eb2016-04-25 13:48:54 -0400329 * string with the control code for that letter.
Chris Lukeb5850972016-05-03 16:34:59 -0400330 *
331 * @param c An ASCII character.
332 * @return A @c NUL terminated string of type @c u8[].
333 *
334 * @par Example
335 * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
Chris Luke0aca5eb2016-04-25 13:48:54 -0400336 */
337#define CTL(c) (u8[]){ (c) - '@', 0 }
338
339#define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
Chris Lukeb5850972016-05-03 16:34:59 -0400340/**
341 * Patterns to match on a CLI input stream.
342 * @showinitializer
343 */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400344static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400345 /* Line handling */
346 _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
347 _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
348 _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
349 _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
Chris Luke0aca5eb2016-04-25 13:48:54 -0400350
Dave Barach9b8ffd92016-07-08 08:13:45 -0400351 /* Unix shell control codes */
352 _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
353 _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
354 _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
355 _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
356 _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
357 _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
358 _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
359 _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
360 _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
361 _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
362 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
363 _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
364 _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
365 _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
366 _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
367 _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400368
Dave Barach9b8ffd92016-07-08 08:13:45 -0400369 /* VT100 Normal mode - Broadest support */
370 _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
371 _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
372 _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
373 _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
374 _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
375 _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
376 _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
377 _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
378 _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400379
380 /* VT100 Application mode - Some Gnome Terminal functions use these */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400381 _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
382 _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
383 _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
384 _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
385 _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
386 _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
Chris Luke0aca5eb2016-04-25 13:48:54 -0400387
Dave Barach9b8ffd92016-07-08 08:13:45 -0400388 /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
389 _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
390 _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
Chris Luke0aca5eb2016-04-25 13:48:54 -0400391
Dave Barach9b8ffd92016-07-08 08:13:45 -0400392 /* Emacs-ish history search */
393 _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
394 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
Chris Luke0aca5eb2016-04-25 13:48:54 -0400395
Dave Barach9b8ffd92016-07-08 08:13:45 -0400396 /* Other protocol things */
397 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
398 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
399 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
Chris Luke0aca5eb2016-04-25 13:48:54 -0400400};
Chris Lukeb5850972016-05-03 16:34:59 -0400401
402/**
403 * Patterns to match when a CLI session is in the pager.
404 * @showinitializer
405 */
Chris Luke7afda3a2016-04-25 13:49:22 -0400406static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400407 /* Line handling */
408 _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
409 _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
410 _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
411 _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
Chris Luke7afda3a2016-04-25 13:49:22 -0400412
Dave Barach9b8ffd92016-07-08 08:13:45 -0400413 /* Pager commands */
414 _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
415 _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
416 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
417 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
418 _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
Chris Luke7afda3a2016-04-25 13:49:22 -0400419
Dave Barach9b8ffd92016-07-08 08:13:45 -0400420 /* VT100 */
421 _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
422 _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
423 _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
424 _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
Chris Luke7afda3a2016-04-25 13:49:22 -0400425
Dave Barach9b8ffd92016-07-08 08:13:45 -0400426 /* VT100 Application mode */
427 _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
428 _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
429 _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
430 _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
Chris Luke7afda3a2016-04-25 13:49:22 -0400431
Dave Barach9b8ffd92016-07-08 08:13:45 -0400432 /* ANSI X3.41-1974 */
433 _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
434 _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
435 _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
436 _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
Chris Luke7afda3a2016-04-25 13:49:22 -0400437
Dave Barach9b8ffd92016-07-08 08:13:45 -0400438 /* Other protocol things */
439 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
440 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
441 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
Chris Luke7afda3a2016-04-25 13:49:22 -0400442};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400443
Chris Luke0aca5eb2016-04-25 13:48:54 -0400444#undef _
445
Chris Lukeb5850972016-05-03 16:34:59 -0400446/** CLI session events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400447typedef enum
448{
Chris Lukeb5850972016-05-03 16:34:59 -0400449 UNIX_CLI_PROCESS_EVENT_READ_READY, /**< A file descriptor has data to be read. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400450 UNIX_CLI_PROCESS_EVENT_QUIT, /**< A CLI session wants to close. */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400451} unix_cli_process_event_type_t;
452
Chris Lukeb5850972016-05-03 16:34:59 -0400453/** CLI global state. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400454typedef struct
455{
Chris Lukeb5850972016-05-03 16:34:59 -0400456 /** Prompt string for CLI. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400457 u8 *cli_prompt;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700458
Chris Lukeb5850972016-05-03 16:34:59 -0400459 /** Vec pool of CLI sessions. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400460 unix_cli_file_t *cli_file_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700461
Chris Lukeb5850972016-05-03 16:34:59 -0400462 /** Vec pool of unused session indices. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400463 u32 *unused_cli_process_node_indices;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700464
Chris Lukeb5850972016-05-03 16:34:59 -0400465 /** The session index of the stdin cli */
Chris Luke7afda3a2016-04-25 13:49:22 -0400466 u32 stdin_cli_file_index;
467
Chris Lukeb5850972016-05-03 16:34:59 -0400468 /** File pool index of current input. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469 u32 current_input_file_index;
470} unix_cli_main_t;
471
Chris Lukeb5850972016-05-03 16:34:59 -0400472/** CLI global state */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700473static unix_cli_main_t unix_cli_main;
474
Chris Luke0aca5eb2016-04-25 13:48:54 -0400475/**
Chris Luke8e5b0412016-07-26 13:06:10 -0400476 * @brief Search for a byte sequence in the action list.
Chris Luke0aca5eb2016-04-25 13:48:54 -0400477 *
Chris Lukeb5850972016-05-03 16:34:59 -0400478 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
479 * the bytes in @a input of maximum length @a ilen bytes.
480 * When a match is made @a *matched indicates how many bytes were matched.
481 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
482 * whether no match was found, a partial match was found or a complete
483 * match was found and what action, if any, should be taken.
Chris Luke0aca5eb2016-04-25 13:48:54 -0400484 *
Chris Lukeb5850972016-05-03 16:34:59 -0400485 * @param[in] a Actions list to search within.
486 * @param[in] input String fragment to search for.
487 * @param[in] ilen Length of the string in 'input'.
488 * @param[out] matched Pointer to an integer that will contain the number
489 * of bytes matched when a complete match is found.
Chris Luke0aca5eb2016-04-25 13:48:54 -0400490 *
Chris Lukeb5850972016-05-03 16:34:59 -0400491 * @return Action from @ref unix_cli_parse_action_t that the string fragment
Chris Luke0aca5eb2016-04-25 13:48:54 -0400492 * matches.
Chris Lukeb5850972016-05-03 16:34:59 -0400493 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
494 * whole input string matches the start of at least one action.
495 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
Chris Luke0aca5eb2016-04-25 13:48:54 -0400496 * match at all.
497 */
498static unix_cli_parse_action_t
Dave Barach9b8ffd92016-07-08 08:13:45 -0400499unix_cli_match_action (unix_cli_parse_actions_t * a,
500 u8 * input, u32 ilen, i32 * matched)
Chris Luke0aca5eb2016-04-25 13:48:54 -0400501{
Chris Luke0aca5eb2016-04-25 13:48:54 -0400502 u8 partial = 0;
503
504 while (a->input)
505 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400506 if (ilen >= a->len)
507 {
508 /* see if the start of the input buffer exactly matches the current
509 * action string. */
510 if (memcmp (input, a->input, a->len) == 0)
511 {
512 *matched = a->len;
513 return a->action;
514 }
515 }
516 else
517 {
518 /* if the first ilen characters match, flag this as a partial -
519 * meaning keep collecting bytes in case of a future match */
520 if (memcmp (input, a->input, ilen) == 0)
521 partial = 1;
522 }
Chris Luke0aca5eb2016-04-25 13:48:54 -0400523
Dave Barach9b8ffd92016-07-08 08:13:45 -0400524 /* check next action */
525 a++;
Chris Luke0aca5eb2016-04-25 13:48:54 -0400526 }
527
528 return partial ?
Dave Barach9b8ffd92016-07-08 08:13:45 -0400529 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
Chris Luke0aca5eb2016-04-25 13:48:54 -0400530}
531
532
Chris Luke54ccf222016-07-25 16:38:11 -0400533/** Add bytes to the output vector and then flagg the I/O system that bytes
534 * are available to be sent.
535 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700536static void
Damjan Marion56dd5432017-09-08 19:52:02 +0200537unix_cli_add_pending_output (clib_file_t * uf,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700538 unix_cli_file_t * cf,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400539 u8 * buffer, uword buffer_bytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700540{
Damjan Marion56dd5432017-09-08 19:52:02 +0200541 clib_file_main_t *fm = &file_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700542
543 vec_add (cf->output_vector, buffer, buffer_bytes);
544 if (vec_len (cf->output_vector) > 0)
545 {
546 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
547 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400548 if (!skip_update)
Damjan Marion56dd5432017-09-08 19:52:02 +0200549 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700550 }
551}
552
Chris Luke54ccf222016-07-25 16:38:11 -0400553/** Delete all bytes from the output vector and flag the I/O system
554 * that no more bytes are available to be sent.
555 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700556static void
Damjan Marion56dd5432017-09-08 19:52:02 +0200557unix_cli_del_pending_output (clib_file_t * uf,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400558 unix_cli_file_t * cf, uword n_bytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700559{
Damjan Marion56dd5432017-09-08 19:52:02 +0200560 clib_file_main_t *fm = &file_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700561
562 vec_delete (cf->output_vector, n_bytes, 0);
563 if (vec_len (cf->output_vector) <= 0)
564 {
565 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
566 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400567 if (!skip_update)
Damjan Marion56dd5432017-09-08 19:52:02 +0200568 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700569 }
570}
571
Chris Luke8e5b0412016-07-26 13:06:10 -0400572/** @brief A bit like strchr with a buffer length limit.
Chris Luke0aca5eb2016-04-25 13:48:54 -0400573 * Search a buffer for the first instance of a character up to the limit of
574 * the buffer length. If found then return the position of that character.
575 *
576 * The key departure from strchr is that if the character is not found then
577 * return the buffer length.
578 *
579 * @param chr The byte value to search for.
580 * @param str The buffer in which to search for the value.
581 * @param len The depth into the buffer to search.
582 *
583 * @return The index of the first occurence of \c chr. If \c chr is not
584 * found then \c len instead.
585 */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400586always_inline word
587unix_vlib_findchr (u8 chr, u8 * str, word len)
Chris Luke0aca5eb2016-04-25 13:48:54 -0400588{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400589 word i = 0;
590 for (i = 0; i < len; i++, str++)
591 {
592 if (*str == chr)
593 return i;
594 }
595 return len;
Chris Luke0aca5eb2016-04-25 13:48:54 -0400596}
597
Chris Luke8e5b0412016-07-26 13:06:10 -0400598/** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
Chris Luke0aca5eb2016-04-25 13:48:54 -0400599 * Attempts to write given buffer to the file descriptor of the given
600 * Unix CLI session. If that session already has data in the output buffer
601 * or if the write attempt tells us to try again later then the given buffer
602 * is appended to the pending output buffer instead.
603 *
604 * This is typically called only from \c unix_vlib_cli_output_cooked since
605 * that is where CRLF handling occurs or from places where we explicitly do
606 * not want cooked handling.
607 *
608 * @param cf Unix CLI session of the desired stream to write to.
609 * @param uf The Unix file structure of the desired stream to write to.
610 * @param buffer Pointer to the buffer that needs to be written.
611 * @param buffer_bytes The number of bytes from \c buffer to write.
612 */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400613static void
614unix_vlib_cli_output_raw (unix_cli_file_t * cf,
Damjan Marion56dd5432017-09-08 19:52:02 +0200615 clib_file_t * uf, u8 * buffer, uword buffer_bytes)
Chris Luke0aca5eb2016-04-25 13:48:54 -0400616{
617 int n = 0;
618
Chris Luke03add7f2017-09-20 23:31:24 -0400619 if (cf->has_epipe) /* don't try writing anything */
620 return;
621
Chris Luke0aca5eb2016-04-25 13:48:54 -0400622 if (vec_len (cf->output_vector) == 0)
Chris Luke03add7f2017-09-20 23:31:24 -0400623 {
624 if (cf->is_socket)
625 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
626 n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
627 else
628 n = write (uf->file_descriptor, buffer, buffer_bytes);
629 }
Chris Luke0aca5eb2016-04-25 13:48:54 -0400630
631 if (n < 0 && errno != EAGAIN)
632 {
Chris Luke03add7f2017-09-20 23:31:24 -0400633 if (errno == EPIPE)
634 {
635 /* connection closed on us */
636 unix_main_t *um = &unix_main;
637 cf->has_epipe = 1;
638 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
639 UNIX_CLI_PROCESS_EVENT_QUIT,
640 uf->private_data);
641 }
642 else
643 {
644 clib_unix_warning ("write");
645 }
Chris Luke0aca5eb2016-04-25 13:48:54 -0400646 }
647 else if ((word) n < (word) buffer_bytes)
648 {
649 /* We got EAGAIN or we already have stuff in the buffer;
650 * queue up whatever didn't get sent for later. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400651 if (n < 0)
652 n = 0;
Chris Luke0aca5eb2016-04-25 13:48:54 -0400653 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
654 }
655}
656
Chris Luke8e5b0412016-07-26 13:06:10 -0400657/** @brief Process a buffer for CRLF handling before outputting it to the CLI.
Chris Luke0aca5eb2016-04-25 13:48:54 -0400658 *
659 * @param cf Unix CLI session of the desired stream to write to.
660 * @param uf The Unix file structure of the desired stream to write to.
661 * @param buffer Pointer to the buffer that needs to be written.
662 * @param buffer_bytes The number of bytes from \c buffer to write.
663 */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400664static void
665unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
Damjan Marion56dd5432017-09-08 19:52:02 +0200666 clib_file_t * uf,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400667 u8 * buffer, uword buffer_bytes)
Chris Luke0aca5eb2016-04-25 13:48:54 -0400668{
669 word end = 0, start = 0;
670
671 while (end < buffer_bytes)
672 {
673 if (cf->crlf_mode)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400674 {
675 /* iterate the line on \n's so we can insert a \r before it */
676 end = unix_vlib_findchr ('\n',
677 buffer + start,
678 buffer_bytes - start) + start;
679 }
Chris Luke0aca5eb2016-04-25 13:48:54 -0400680 else
Dave Barach9b8ffd92016-07-08 08:13:45 -0400681 {
682 /* otherwise just send the whole buffer */
683 end = buffer_bytes;
684 }
Chris Luke0aca5eb2016-04-25 13:48:54 -0400685
Dave Barach9b8ffd92016-07-08 08:13:45 -0400686 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
Chris Luke0aca5eb2016-04-25 13:48:54 -0400687
688 if (cf->crlf_mode)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400689 {
690 if (end < buffer_bytes)
691 {
692 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
693 end++; /* skip the \n that we already sent */
694 }
695 start = end;
696 }
Chris Luke0aca5eb2016-04-25 13:48:54 -0400697 }
Chris Lukefc379d22018-06-05 23:50:19 -0400698
699 /* Use the last character to determine the last direction of the cursor. */
700 if (buffer_bytes > 0)
701 cf->cursor_direction = (buffer[buffer_bytes - 1] == (u8) '\b');
702}
703
704/** @brief Moves the terminal cursor one character to the left, with
705 * special handling when it reaches the left edge of the terminal window.
706 *
707 * Ordinarily we can simply send a '\b' to move the cursor left, however
708 * most terminals will not reverse-wrap to the end of the previous line
709 * if the cursor is in the left-most column. To counter this we must
710 * check the cursor position + prompt length modulo terminal width and
711 * if available use some other means, such as ANSI terminal escape
712 * sequences, to move the cursor.
713 *
714 * @param cf Unix CLI session of the desired stream to write to.
715 * @param uf The Unix file structure of the desired stream to write to.
716 */
717static void
718unix_vlib_cli_output_cursor_left (unix_cli_file_t * cf, clib_file_t * uf)
719{
720 unix_cli_main_t *cm = &unix_cli_main;
721 static u8 *ansi = 0; /* assumes no reentry */
722 u32 position;
723
724 if (!cf->is_interactive || !cf->ansi_capable || !cf->width)
725 {
726 /* No special handling for dumb terminals */
727 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
728 return;
729 }
730
731 position = ((u32) vec_len (cm->cli_prompt) + cf->cursor) % cf->width;
732
733 if (position != 0)
734 {
735 /* No special handling required if we're not at the left edge */
736 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
737 return;
738 }
739
740 if (!cf->cursor_direction)
741 {
742 /* Special handling for when we are at the left edge but
743 * the cursor was going left-to-right, but in this situation
744 * xterm-like terminals actually hide the cursor off the right
745 * edge. A \b here seems to jump one char too many, so let's
746 * force the cursor onto the next line instead.
747 */
748 if (cf->cursor < vec_len (cf->current_command))
749 unix_vlib_cli_output_cooked (cf, uf, &cf->current_command[cf->cursor],
750 1);
751 else
752 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
753 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
754 }
755
756 /* Relocate the cursor at the right hand edge one line above */
757 ansi = format (ansi, CSI "A" CSI "%dC", cf->width - 1);
758 unix_vlib_cli_output_cooked (cf, uf, ansi, vec_len (ansi));
759 vec_reset_length (ansi); /* keep the vec around for next time */
760 cf->cursor_direction = 1; /* going backwards now */
Chris Luke0aca5eb2016-04-25 13:48:54 -0400761}
762
Chris Luke8e5b0412016-07-26 13:06:10 -0400763/** @brief Output the CLI prompt */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400764static void
Damjan Marion56dd5432017-09-08 19:52:02 +0200765unix_cli_cli_prompt (unix_cli_file_t * cf, clib_file_t * uf)
Chris Luke7afda3a2016-04-25 13:49:22 -0400766{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400767 unix_cli_main_t *cm = &unix_cli_main;
Chris Luke7afda3a2016-04-25 13:49:22 -0400768
Chris Luke03add7f2017-09-20 23:31:24 -0400769 if (cf->is_interactive) /* Only interactive sessions get a prompt */
770 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt,
771 vec_len (cm->cli_prompt));
Chris Luke7afda3a2016-04-25 13:49:22 -0400772}
773
Chris Luke8e5b0412016-07-26 13:06:10 -0400774/** @brief Output a pager prompt and show number of buffered lines */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400775static void
Damjan Marion56dd5432017-09-08 19:52:02 +0200776unix_cli_pager_prompt (unix_cli_file_t * cf, clib_file_t * uf)
Chris Luke7afda3a2016-04-25 13:49:22 -0400777{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400778 u8 *prompt;
Chris Luke270b6de2016-05-19 14:23:25 -0400779 u32 h;
780
781 h = cf->pager_start + (cf->height - 1);
782 if (h > vec_len (cf->pager_index))
783 h = vec_len (cf->pager_index);
Chris Luke7afda3a2016-04-25 13:49:22 -0400784
Dave Barach9b8ffd92016-07-08 08:13:45 -0400785 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
786 cf->ansi_capable ? ANSI_BOLD : "",
787 cf->pager_start + 1,
788 h,
789 vec_len (cf->pager_index),
790 cf->ansi_capable ? ANSI_RESET : "");
Chris Luke7afda3a2016-04-25 13:49:22 -0400791
Dave Barach9b8ffd92016-07-08 08:13:45 -0400792 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
Chris Luke7afda3a2016-04-25 13:49:22 -0400793
Dave Barach9b8ffd92016-07-08 08:13:45 -0400794 vec_free (prompt);
Chris Luke7afda3a2016-04-25 13:49:22 -0400795}
796
Chris Luke8e5b0412016-07-26 13:06:10 -0400797/** @brief Output a pager "skipping" message */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400798static void
Damjan Marion56dd5432017-09-08 19:52:02 +0200799unix_cli_pager_message (unix_cli_file_t * cf, clib_file_t * uf,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400800 char *message, char *postfix)
Chris Luke7afda3a2016-04-25 13:49:22 -0400801{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400802 u8 *prompt;
Chris Luke7afda3a2016-04-25 13:49:22 -0400803
Dave Barach9b8ffd92016-07-08 08:13:45 -0400804 prompt = format (0, "\r%s-- %s --%s%s",
805 cf->ansi_capable ? ANSI_BOLD : "",
806 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
Chris Luke7afda3a2016-04-25 13:49:22 -0400807
Dave Barach9b8ffd92016-07-08 08:13:45 -0400808 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
Chris Luke7afda3a2016-04-25 13:49:22 -0400809
Dave Barach9b8ffd92016-07-08 08:13:45 -0400810 vec_free (prompt);
Chris Luke7afda3a2016-04-25 13:49:22 -0400811}
812
Chris Luke8e5b0412016-07-26 13:06:10 -0400813/** @brief Erase the printed pager prompt */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400814static void
Damjan Marion56dd5432017-09-08 19:52:02 +0200815unix_cli_pager_prompt_erase (unix_cli_file_t * cf, clib_file_t * uf)
Chris Luke7afda3a2016-04-25 13:49:22 -0400816{
817 if (cf->ansi_capable)
818 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400819 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
820 unix_vlib_cli_output_cooked (cf, uf,
821 (u8 *) ANSI_CLEARLINE,
822 sizeof (ANSI_CLEARLINE) - 1);
Chris Luke7afda3a2016-04-25 13:49:22 -0400823 }
824 else
825 {
826 int i;
827
Dave Barach9b8ffd92016-07-08 08:13:45 -0400828 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
829 for (i = 0; i < cf->width - 1; i++)
830 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
831 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
Chris Luke7afda3a2016-04-25 13:49:22 -0400832 }
833}
834
Chris Luke8e5b0412016-07-26 13:06:10 -0400835/** @brief Uses an ANSI escape sequence to move the cursor */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400836static void
Damjan Marion56dd5432017-09-08 19:52:02 +0200837unix_cli_ansi_cursor (unix_cli_file_t * cf, clib_file_t * uf, u16 x, u16 y)
Chris Luke7afda3a2016-04-25 13:49:22 -0400838{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400839 u8 *str;
Chris Luke7afda3a2016-04-25 13:49:22 -0400840
Dave Barach9b8ffd92016-07-08 08:13:45 -0400841 str = format (0, "%s%d;%dH", CSI, y, x);
Chris Luke7afda3a2016-04-25 13:49:22 -0400842
Dave Barach9b8ffd92016-07-08 08:13:45 -0400843 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
Chris Luke7afda3a2016-04-25 13:49:22 -0400844
Dave Barach9b8ffd92016-07-08 08:13:45 -0400845 vec_free (str);
Chris Luke7afda3a2016-04-25 13:49:22 -0400846}
847
Chris Luke862623d2016-05-14 10:13:34 -0400848/** Redraw the currently displayed page of text.
849 * @param cf CLI session to redraw the pager buffer of.
850 * @param uf Unix file of the CLI session.
851 */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400852static void
Damjan Marion56dd5432017-09-08 19:52:02 +0200853unix_cli_pager_redraw (unix_cli_file_t * cf, clib_file_t * uf)
Chris Luke862623d2016-05-14 10:13:34 -0400854{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400855 unix_cli_pager_index_t *pi = NULL;
856 u8 *line = NULL;
Chris Luke862623d2016-05-14 10:13:34 -0400857 word i;
858
859 /* No active pager? Do nothing. */
860 if (!vec_len (cf->pager_index))
861 return;
862
863 if (cf->ansi_capable)
864 {
865 /* If we have ANSI, send the clear screen sequence */
866 unix_vlib_cli_output_cooked (cf, uf,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400867 (u8 *) ANSI_CLEAR,
868 sizeof (ANSI_CLEAR) - 1);
Chris Luke862623d2016-05-14 10:13:34 -0400869 }
870 else
871 {
872 /* Otherwise make sure we're on a blank line */
873 unix_cli_pager_prompt_erase (cf, uf);
874 }
875
876 /* (Re-)send the current page of content */
877 for (i = 0; i < cf->height - 1 &&
Dave Barach9b8ffd92016-07-08 08:13:45 -0400878 i + cf->pager_start < vec_len (cf->pager_index); i++)
Chris Luke862623d2016-05-14 10:13:34 -0400879 {
880 pi = &cf->pager_index[cf->pager_start + i];
881 line = cf->pager_vector[pi->line] + pi->offset;
882
883 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
884 }
885 /* if the last line didn't end in newline, add a newline */
886 if (pi && line[pi->length - 1] != '\n')
Dave Barach9b8ffd92016-07-08 08:13:45 -0400887 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
Chris Luke862623d2016-05-14 10:13:34 -0400888
889 unix_cli_pager_prompt (cf, uf);
890}
891
892/** @brief Process and add a line to the pager index.
893 * In normal operation this function will take the given character string
894 * found in @c line and with length @c len_or_index and iterates the over the
895 * contents, adding each line of text discovered within it to the
896 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
897 * strings longer than the width of the terminal.
898 *
899 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
900 * index of an existing line in the pager buffer; this simply means that the
901 * input line does not need to be cloned since we alreayd have it. This is
902 * typical if we are reindexing the pager buffer.
903 *
904 * @param cf The CLI session whose pager we are adding to.
905 * @param line The string of text to be indexed into the pager buffer.
906 * If @c line is @c NULL then the mode of operation
907 * changes slightly; see the description above.
908 * @param len_or_index If @c line is a pointer to a string then this parameter
909 * indicates the length of that string; Otherwise this
910 * value provides the index in the pager buffer of an
911 * existing string to be indexed.
912 */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400913static void
914unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
Chris Luke862623d2016-05-14 10:13:34 -0400915{
Neale Ranns9c2c2432017-12-05 13:34:36 -0800916 u8 *p = NULL;
Chris Luke862623d2016-05-14 10:13:34 -0400917 word i, j, k;
918 word line_index, len;
919 u32 width = cf->width;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400920 unix_cli_pager_index_t *pi;
Chris Luke862623d2016-05-14 10:13:34 -0400921
922 if (line == NULL)
923 {
924 /* Use a line already in the pager buffer */
925 line_index = len_or_index;
Neale Ranns9c2c2432017-12-05 13:34:36 -0800926 if (cf->pager_vector != NULL)
927 p = cf->pager_vector[line_index];
Chris Luke862623d2016-05-14 10:13:34 -0400928 len = vec_len (p);
929 }
930 else
931 {
932 len = len_or_index;
933 /* Add a copy of the raw string to the pager buffer */
934 p = vec_new (u8, len);
935 clib_memcpy (p, line, len);
936
937 /* store in pager buffer */
938 line_index = vec_len (cf->pager_vector);
939 vec_add1 (cf->pager_vector, p);
940 }
941
942 i = 0;
943 while (i < len)
944 {
945 /* Find the next line, or run to terminal width, or run to EOL */
946 int l = len - i;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400947 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
Chris Luke862623d2016-05-14 10:13:34 -0400948
Dave Barach9b8ffd92016-07-08 08:13:45 -0400949 if (j < l && p[j] == '\n') /* incl \n */
950 j++;
Chris Luke862623d2016-05-14 10:13:34 -0400951
952 /* Add the line to the index */
953 k = vec_len (cf->pager_index);
954 vec_validate (cf->pager_index, k);
955 pi = &cf->pager_index[k];
956
957 pi->line = line_index;
958 pi->offset = i;
959 pi->length = j;
960
961 i += j;
962 p += j;
963 }
964}
965
966/** @brief Reindex entire pager buffer.
967 * Resets the current pager index and then re-adds the lines in the pager
968 * buffer to the index.
969 *
970 * Additionally this function attempts to retain the current page start
971 * line offset by searching for the same top-of-screen line in the new index.
972 *
973 * @param cf The CLI session whose pager buffer should be reindexed.
974 */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400975static void
976unix_cli_pager_reindex (unix_cli_file_t * cf)
Chris Luke862623d2016-05-14 10:13:34 -0400977{
978 word i, old_line, old_offset;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400979 unix_cli_pager_index_t *pi;
Chris Luke862623d2016-05-14 10:13:34 -0400980
981 /* If there is nothing in the pager buffer then make sure the index
982 * is empty and move on.
983 */
984 if (cf->pager_vector == 0)
985 {
986 vec_reset_length (cf->pager_index);
987 return;
988 }
989
990 /* Retain a pointer to the current page start line so we can
991 * find it later
992 */
993 pi = &cf->pager_index[cf->pager_start];
994 old_line = pi->line;
995 old_offset = pi->offset;
996
997 /* Re-add the buffered lines to the index */
998 vec_reset_length (cf->pager_index);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400999 vec_foreach_index (i, cf->pager_vector)
1000 {
1001 unix_cli_pager_add_line (cf, NULL, i);
1002 }
Chris Luke862623d2016-05-14 10:13:34 -04001003
1004 /* Attempt to re-locate the previously stored page start line */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001005 vec_foreach_index (i, cf->pager_index)
1006 {
1007 pi = &cf->pager_index[i];
Chris Luke862623d2016-05-14 10:13:34 -04001008
Dave Barach9b8ffd92016-07-08 08:13:45 -04001009 if (pi->line == old_line &&
1010 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
1011 {
1012 /* Found it! */
1013 cf->pager_start = i;
1014 break;
1015 }
1016 }
Chris Luke862623d2016-05-14 10:13:34 -04001017
1018 /* In case the start line was not found (rare), ensure the pager start
1019 * index is within bounds
1020 */
1021 if (cf->pager_start >= vec_len (cf->pager_index))
1022 {
Chris Luke270b6de2016-05-19 14:23:25 -04001023 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001024 cf->pager_start = 0;
Chris Luke270b6de2016-05-19 14:23:25 -04001025 else
Dave Barach9b8ffd92016-07-08 08:13:45 -04001026 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
Chris Luke862623d2016-05-14 10:13:34 -04001027 }
1028}
1029
1030/** VLIB CLI output function.
1031 *
1032 * If the terminal has a pager configured then this function takes care
1033 * of collating output into the pager buffer; ensuring only the first page
1034 * is displayed and any lines in excess of the first page are buffered.
1035 *
1036 * If the maximum number of index lines in the buffer is exceeded then the
1037 * pager is cancelled and the contents of the current buffer are sent to the
1038 * terminal.
1039 *
1040 * If there is no pager configured then the output is sent directly to the
1041 * terminal.
1042 *
1043 * @param cli_file_index Index of the CLI session where this output is
1044 * directed.
1045 * @param buffer String of printabe bytes to be output.
1046 * @param buffer_bytes The number of bytes in @c buffer to be output.
1047 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001048static void
1049unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001050{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001051 unix_main_t *um = &unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +02001052 clib_file_main_t *fm = &file_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001053 unix_cli_main_t *cm = &unix_cli_main;
1054 unix_cli_file_t *cf;
Damjan Marion56dd5432017-09-08 19:52:02 +02001055 clib_file_t *uf;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001056
Ed Warnickecb9cada2015-12-08 15:45:58 -07001057 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
Damjan Marion56dd5432017-09-08 19:52:02 +02001058 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001059
Chris Luke7afda3a2016-04-25 13:49:22 -04001060 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
1061 {
Chris Luke862623d2016-05-14 10:13:34 -04001062 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
Chris Luke7afda3a2016-04-25 13:49:22 -04001063 }
1064 else
1065 {
Chris Luke862623d2016-05-14 10:13:34 -04001066 word row = vec_len (cf->pager_index);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001067 u8 *line;
1068 unix_cli_pager_index_t *pi;
Chris Luke7afda3a2016-04-25 13:49:22 -04001069
Chris Luke862623d2016-05-14 10:13:34 -04001070 /* Index and add the output lines to the pager buffer. */
1071 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
1072
1073 /* Now iterate what was added to display the lines.
1074 * If we reach the bottom of the page, display a prompt.
1075 */
1076 while (row < vec_len (cf->pager_index))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001077 {
1078 if (row < cf->height - 1)
1079 {
1080 /* output this line */
1081 pi = &cf->pager_index[row];
1082 line = cf->pager_vector[pi->line] + pi->offset;
1083 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
Chris Luke862623d2016-05-14 10:13:34 -04001084
Dave Barach9b8ffd92016-07-08 08:13:45 -04001085 /* if the last line didn't end in newline, and we're at the
1086 * bottom of the page, add a newline */
1087 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1088 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1089 }
1090 else
1091 {
1092 /* Display the pager prompt every 10 lines */
1093 if (!(row % 10))
1094 unix_cli_pager_prompt (cf, uf);
1095 }
1096 row++;
1097 }
Chris Luke7afda3a2016-04-25 13:49:22 -04001098
Chris Luke862623d2016-05-14 10:13:34 -04001099 /* Check if we went over the pager buffer limit */
1100 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001101 {
1102 /* Stop using the pager for the remainder of this CLI command */
1103 cf->no_pager = 2;
Chris Luke7afda3a2016-04-25 13:49:22 -04001104
Dave Barach9b8ffd92016-07-08 08:13:45 -04001105 /* If we likely printed the prompt, erase it */
1106 if (vec_len (cf->pager_index) > cf->height - 1)
1107 unix_cli_pager_prompt_erase (cf, uf);
Chris Luke7afda3a2016-04-25 13:49:22 -04001108
Dave Barach9b8ffd92016-07-08 08:13:45 -04001109 /* Dump out the contents of the buffer */
1110 for (row = cf->pager_start + (cf->height - 1);
1111 row < vec_len (cf->pager_index); row++)
1112 {
1113 pi = &cf->pager_index[row];
1114 line = cf->pager_vector[pi->line] + pi->offset;
1115 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1116 }
Chris Luke7afda3a2016-04-25 13:49:22 -04001117
Dave Barach9b8ffd92016-07-08 08:13:45 -04001118 unix_cli_pager_reset (cf);
1119 }
Chris Luke7afda3a2016-04-25 13:49:22 -04001120 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001121}
1122
Chris Luke862623d2016-05-14 10:13:34 -04001123/** Identify whether a terminal type is ANSI capable.
1124 *
Chris Luke54ccf222016-07-25 16:38:11 -04001125 * Compares the string given in @c term with a list of terminal types known
Chris Luke862623d2016-05-14 10:13:34 -04001126 * to support ANSI escape sequences.
1127 *
1128 * This list contains, for example, @c xterm, @c screen and @c ansi.
1129 *
1130 * @param term A string with a terminal type in it.
Chris Luke54ccf222016-07-25 16:38:11 -04001131 * @param len The length of the string in @c term.
Chris Luke862623d2016-05-14 10:13:34 -04001132 *
1133 * @return @c 1 if the terminal type is recognized as supporting ANSI
1134 * terminal sequences; @c 0 otherwise.
1135 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001136static u8
Chris Luke03add7f2017-09-20 23:31:24 -04001137unix_cli_terminal_type_ansi (u8 * term, uword len)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001138{
Chris Luke0aca5eb2016-04-25 13:48:54 -04001139 /* This may later be better done as a hash of some sort. */
1140#define _(a) do { \
1141 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1142 } while(0)
1143
1144 _("xterm");
1145 _("xterm-color");
Dave Barach9b8ffd92016-07-08 08:13:45 -04001146 _("xterm-256color"); /* iTerm on Mac */
Chris Luke0aca5eb2016-04-25 13:48:54 -04001147 _("screen");
Damjan Marion6e8ab162017-06-05 21:56:12 +02001148 _("screen-256color"); /* Screen and tmux */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001149 _("ansi"); /* Microsoft Telnet */
Chris Luke0aca5eb2016-04-25 13:48:54 -04001150#undef _
1151
1152 return 0;
1153}
1154
Chris Luke03add7f2017-09-20 23:31:24 -04001155/** Identify whether a terminal type is non-interactive.
1156 *
1157 * Compares the string given in @c term with a list of terminal types known
1158 * to be non-interactive, as send by tools such as @c vppctl .
1159 *
1160 * This list contains, for example, @c vppctl.
1161 *
1162 * @param term A string with a terminal type in it.
1163 * @param len The length of the string in @c term.
1164 *
1165 * @return @c 1 if the terminal type is recognized as being non-interactive;
1166 * @c 0 otherwise.
1167 */
1168static u8
1169unix_cli_terminal_type_noninteractive (u8 * term, uword len)
1170{
1171 /* This may later be better done as a hash of some sort. */
1172#define _(a) do { \
1173 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1174 } while(0)
1175
1176 _("vppctl");
1177#undef _
1178
1179 return 0;
1180}
1181
1182/** Set a session to be non-interactive. */
1183static void
1184unix_cli_set_session_noninteractive (unix_cli_file_t * cf)
1185{
1186 /* Non-interactive sessions don't get these */
1187 cf->is_interactive = 0;
1188 cf->no_pager = 1;
1189 cf->history_limit = 0;
1190 cf->has_history = 0;
1191 cf->line_mode = 1;
1192}
1193
Chris Luke8e5b0412016-07-26 13:06:10 -04001194/** @brief Emit initial welcome banner and prompt on a connection. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001195static void
1196unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
Chris Luke0aca5eb2016-04-25 13:48:54 -04001197{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001198 unix_main_t *um = &unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +02001199 clib_file_main_t *fm = &file_main;
1200 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
Chris Luke572d8122016-04-25 13:49:07 -04001201 unix_cli_banner_t *banner;
1202 int i, len;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001203
Chris Luke03add7f2017-09-20 23:31:24 -04001204 /* Mark the session as started if we get here */
1205 cf->started = 1;
1206
1207 if (!(cf->is_interactive)) /* No banner for non-interactive sessions */
1208 return;
1209
Chris Luke0aca5eb2016-04-25 13:48:54 -04001210 /*
1211 * Put the first bytes directly into the buffer so that further output is
1212 * queued until everything is ready. (oterwise initial prompt can appear
1213 * mid way through VPP initialization)
1214 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001215 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
Chris Luke572d8122016-04-25 13:49:07 -04001216
1217 if (!um->cli_no_banner)
1218 {
1219 if (cf->ansi_capable)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001220 {
1221 banner = unix_cli_banner_color;
1222 len = ARRAY_LEN (unix_cli_banner_color);
1223 }
Chris Luke572d8122016-04-25 13:49:07 -04001224 else
Dave Barach9b8ffd92016-07-08 08:13:45 -04001225 {
1226 banner = unix_cli_banner;
1227 len = ARRAY_LEN (unix_cli_banner);
1228 }
Chris Luke572d8122016-04-25 13:49:07 -04001229
1230 for (i = 0; i < len; i++)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001231 {
1232 unix_vlib_cli_output_cooked (cf, uf,
1233 banner[i].line, banner[i].length);
1234 }
1235 }
Chris Luke572d8122016-04-25 13:49:07 -04001236
1237 /* Prompt. */
Chris Luke7afda3a2016-04-25 13:49:22 -04001238 unix_cli_cli_prompt (cf, uf);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001239
Chris Luke0aca5eb2016-04-25 13:48:54 -04001240}
1241
Chris Luke8e5b0412016-07-26 13:06:10 -04001242/** @brief A failsafe triggered on a timer to ensure we send the prompt
Chris Luke0aca5eb2016-04-25 13:48:54 -04001243 * to telnet sessions that fail to negotiate the terminal type. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001244static void
1245unix_cli_file_welcome_timer (any arg, f64 delay)
Chris Luke0aca5eb2016-04-25 13:48:54 -04001246{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001247 unix_cli_main_t *cm = &unix_cli_main;
1248 unix_cli_file_t *cf;
1249 (void) delay;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001250
1251 /* Check the connection didn't close already */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001252 if (pool_is_free_index (cm->cli_file_pool, (uword) arg))
Chris Luke0aca5eb2016-04-25 13:48:54 -04001253 return;
1254
Dave Barach9b8ffd92016-07-08 08:13:45 -04001255 cf = pool_elt_at_index (cm->cli_file_pool, (uword) arg);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001256
1257 if (!cf->started)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001258 unix_cli_file_welcome (cm, cf);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001259}
1260
Chris Luke8e5b0412016-07-26 13:06:10 -04001261/** @brief A mostly no-op Telnet state machine.
Chris Luke0aca5eb2016-04-25 13:48:54 -04001262 * Process Telnet command bytes in a way that ensures we're mostly
1263 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1264 *
1265 * @return -1 if we need more bytes, otherwise a positive integer number of
1266 * bytes to consume from the input_vector, not including the initial
1267 * IAC byte.
1268 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001269static i32
1270unix_cli_process_telnet (unix_main_t * um,
1271 unix_cli_file_t * cf,
Damjan Marion56dd5432017-09-08 19:52:02 +02001272 clib_file_t * uf, u8 * input_vector, uword len)
Chris Luke0aca5eb2016-04-25 13:48:54 -04001273{
1274 /* Input_vector starts at IAC byte.
1275 * See if we have a complete message; if not, return -1 so we wait for more.
1276 * if we have a complete message, consume those bytes from the vector.
1277 */
1278 i32 consume = 0;
1279
1280 if (len == 1)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001281 return -1; /* want more bytes */
Chris Luke0aca5eb2016-04-25 13:48:54 -04001282
1283 switch (input_vector[1])
Ed Warnickecb9cada2015-12-08 15:45:58 -07001284 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04001285 case IAC:
1286 /* two IAC's in a row means to pass through 0xff.
1287 * since that makes no sense here, just consume it.
1288 */
1289 consume = 1;
1290 break;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001291
Dave Barach9b8ffd92016-07-08 08:13:45 -04001292 case WILL:
1293 case WONT:
1294 case DO:
1295 case DONT:
1296 /* Expect 3 bytes */
1297 if (vec_len (input_vector) < 3)
1298 return -1; /* want more bytes */
Chris Luke0aca5eb2016-04-25 13:48:54 -04001299
Dave Barach9b8ffd92016-07-08 08:13:45 -04001300 consume = 2;
1301 break;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001302
Dave Barach9b8ffd92016-07-08 08:13:45 -04001303 case SB:
1304 {
1305 /* Sub option - search ahead for IAC SE to end it */
1306 i32 i;
1307 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1308 {
1309 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1310 {
1311 /* We have a complete message; see if we care about it */
1312 switch (input_vector[2])
1313 {
1314 case TELOPT_TTYPE:
1315 if (input_vector[3] != 0)
1316 break;
Chris Luke03add7f2017-09-20 23:31:24 -04001317 {
1318 /* See if the the terminal type is recognized */
1319 u8 *term = input_vector + 4;
1320 uword len = i - 5;
1321
1322 /* See if the terminal type is ANSI capable */
1323 cf->ansi_capable =
1324 unix_cli_terminal_type_ansi (term, len);
1325
1326 /* See if the terminal type indicates non-interactive */
1327 if (unix_cli_terminal_type_noninteractive (term, len))
1328 unix_cli_set_session_noninteractive (cf);
1329 }
1330
Dave Barach9b8ffd92016-07-08 08:13:45 -04001331 /* If session not started, we can release the pause */
1332 if (!cf->started)
1333 /* Send the welcome banner and initial prompt */
1334 unix_cli_file_welcome (&unix_cli_main, cf);
1335 break;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001336
Dave Barach9b8ffd92016-07-08 08:13:45 -04001337 case TELOPT_NAWS:
1338 /* Window size */
1339 if (i != 8) /* check message is correct size */
1340 break;
Chris Lukeb2bcad62017-09-18 08:51:22 -04001341
Dave Barach9b8ffd92016-07-08 08:13:45 -04001342 cf->width =
1343 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
Chris Lukeb2bcad62017-09-18 08:51:22 -04001344 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1345 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
Chris Luke2d8bf302017-11-12 22:26:37 -05001346 if (cf->width == 0)
1347 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
Chris Lukeb2bcad62017-09-18 08:51:22 -04001348
Dave Barach9b8ffd92016-07-08 08:13:45 -04001349 cf->height =
1350 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
Chris Lukeb2bcad62017-09-18 08:51:22 -04001351 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1352 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
Chris Luke2d8bf302017-11-12 22:26:37 -05001353 if (cf->height == 0)
1354 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
Chris Lukeb2bcad62017-09-18 08:51:22 -04001355
Dave Barach9b8ffd92016-07-08 08:13:45 -04001356 /* reindex pager buffer */
1357 unix_cli_pager_reindex (cf);
1358 /* redraw page */
1359 unix_cli_pager_redraw (cf, uf);
1360 break;
Chris Luke7afda3a2016-04-25 13:49:22 -04001361
Dave Barach9b8ffd92016-07-08 08:13:45 -04001362 default:
1363 break;
1364 }
1365 /* Consume it all */
1366 consume = i;
1367 break;
1368 }
1369 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001370
Dave Barach9b8ffd92016-07-08 08:13:45 -04001371 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1372 consume = 1; /* hit max search depth, advance one byte */
Chris Luke0aca5eb2016-04-25 13:48:54 -04001373
Dave Barach9b8ffd92016-07-08 08:13:45 -04001374 if (consume == 0)
1375 return -1; /* want more bytes */
Chris Luke0aca5eb2016-04-25 13:48:54 -04001376
Dave Barach9b8ffd92016-07-08 08:13:45 -04001377 break;
1378 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001379
Dave Barach9b8ffd92016-07-08 08:13:45 -04001380 case GA:
1381 case EL:
1382 case EC:
1383 case AO:
1384 case IP:
1385 case BREAK:
1386 case DM:
1387 case NOP:
1388 case SE:
1389 case EOR:
1390 case ABORT:
1391 case SUSP:
1392 case xEOF:
1393 /* Simple one-byte messages */
1394 consume = 1;
1395 break;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001396
Dave Barach9b8ffd92016-07-08 08:13:45 -04001397 case AYT:
1398 /* Are You There - trigger a visible response */
1399 consume = 1;
1400 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1401 break;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001402
Dave Barach9b8ffd92016-07-08 08:13:45 -04001403 default:
1404 /* Unknown command! Eat the IAC byte */
1405 break;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001406 }
1407
Dave Barach9b8ffd92016-07-08 08:13:45 -04001408 return consume;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001409}
1410
Chris Luke8e5b0412016-07-26 13:06:10 -04001411/** @brief Process actionable input.
Chris Luke0aca5eb2016-04-25 13:48:54 -04001412 * Based on the \c action process the input; this typically involves
1413 * searching the command history or editing the current command line.
1414 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001415static int
1416unix_cli_line_process_one (unix_cli_main_t * cm,
1417 unix_main_t * um,
1418 unix_cli_file_t * cf,
Damjan Marion56dd5432017-09-08 19:52:02 +02001419 clib_file_t * uf,
Dave Barach9b8ffd92016-07-08 08:13:45 -04001420 u8 input, unix_cli_parse_action_t action)
Chris Luke0aca5eb2016-04-25 13:48:54 -04001421{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001422 u8 *prev;
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001423 u8 *save = 0;
1424 u8 **possible_commands;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001425 int j, delta;
1426
1427 switch (action)
1428 {
1429 case UNIX_CLI_PARSE_ACTION_NOACTION:
1430 break;
1431
Chris Luke0aca5eb2016-04-25 13:48:54 -04001432 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1433 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
Chris Luke7afda3a2016-04-25 13:49:22 -04001434 if (!cf->has_history || !cf->history_limit)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001435 break;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001436 if (cf->search_mode == 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001437 {
1438 /* Erase the current command (if any) */
Chris Lukefc379d22018-06-05 23:50:19 -04001439 for (; cf->cursor > 0; cf->cursor--)
1440 {
1441 unix_vlib_cli_output_cursor_left (cf, uf);
1442 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1443 unix_vlib_cli_output_cursor_left (cf, uf);
1444 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001445
Dave Barach9b8ffd92016-07-08 08:13:45 -04001446 vec_reset_length (cf->search_key);
1447 vec_reset_length (cf->current_command);
Chris Lukefc379d22018-06-05 23:50:19 -04001448
Dave Barach9b8ffd92016-07-08 08:13:45 -04001449 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1450 cf->search_mode = -1;
1451 else
1452 cf->search_mode = 1;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001453 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001454 else
Dave Barach9b8ffd92016-07-08 08:13:45 -04001455 {
1456 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1457 cf->search_mode = -1;
1458 else
1459 cf->search_mode = 1;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001460
Dave Barach9b8ffd92016-07-08 08:13:45 -04001461 cf->excursion += cf->search_mode;
1462 goto search_again;
1463 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001464 break;
1465
1466 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1467 /* Erase the command from the cursor to the start */
1468
Chris Lukefc379d22018-06-05 23:50:19 -04001469 j = cf->cursor;
1470 /* Shimmy backwards to the new end of line position */
Chris Luke0aca5eb2016-04-25 13:48:54 -04001471 delta = vec_len (cf->current_command) - cf->cursor;
Chris Lukefc379d22018-06-05 23:50:19 -04001472 for (; cf->cursor > delta; cf->cursor--)
1473 unix_vlib_cli_output_cursor_left (cf, uf);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001474 /* Zap from here to the end of what is currently displayed */
Chris Lukefc379d22018-06-05 23:50:19 -04001475 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001476 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001477 /* Get back to the start of the line */
Chris Lukefc379d22018-06-05 23:50:19 -04001478 for (; cf->cursor > 0; cf->cursor--)
1479 unix_vlib_cli_output_cursor_left (cf, uf);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001480
Chris Lukefc379d22018-06-05 23:50:19 -04001481 /* Delete the desired text from the command */
1482 memmove (cf->current_command, cf->current_command + j, delta);
1483 _vec_len (cf->current_command) = delta;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001484
1485 /* Print the new contents */
Chris Lukefc379d22018-06-05 23:50:19 -04001486 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1487 cf->cursor = delta; /* for backspace tracking */
1488
Chris Luke0aca5eb2016-04-25 13:48:54 -04001489 /* Shimmy back to the start */
Chris Lukefc379d22018-06-05 23:50:19 -04001490 for (; cf->cursor > 0; cf->cursor--)
1491 unix_vlib_cli_output_cursor_left (cf, uf);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001492
1493 cf->search_mode = 0;
1494 break;
1495
1496 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1497 /* Erase the command from the cursor to the end */
1498
Chris Lukefc379d22018-06-05 23:50:19 -04001499 j = cf->cursor;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001500 /* Zap from cursor to end of what is currently displayed */
Chris Lukefc379d22018-06-05 23:50:19 -04001501 for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001502 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001503 /* Get back to where we were */
Chris Lukefc379d22018-06-05 23:50:19 -04001504 for (; cf->cursor > j; cf->cursor--)
1505 unix_vlib_cli_output_cursor_left (cf, uf);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001506
1507 /* Truncate the line at the cursor */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001508 _vec_len (cf->current_command) = cf->cursor;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001509
1510 cf->search_mode = 0;
1511 break;
1512
1513 case UNIX_CLI_PARSE_ACTION_LEFT:
1514 if (cf->cursor > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001515 {
Chris Lukefc379d22018-06-05 23:50:19 -04001516 unix_vlib_cli_output_cursor_left (cf, uf);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001517 cf->cursor--;
1518 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001519
1520 cf->search_mode = 0;
1521 break;
1522
1523 case UNIX_CLI_PARSE_ACTION_RIGHT:
Dave Barach9b8ffd92016-07-08 08:13:45 -04001524 if (cf->cursor < vec_len (cf->current_command))
1525 {
1526 /* have to emit the character under the cursor */
1527 unix_vlib_cli_output_cooked (cf, uf,
1528 cf->current_command + cf->cursor, 1);
1529 cf->cursor++;
1530 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001531
1532 cf->search_mode = 0;
1533 break;
1534
1535 case UNIX_CLI_PARSE_ACTION_UP:
1536 case UNIX_CLI_PARSE_ACTION_DOWN:
Chris Luke7afda3a2016-04-25 13:49:22 -04001537 if (!cf->has_history || !cf->history_limit)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001538 break;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001539 cf->search_mode = 0;
1540 /* Erase the command */
Chris Lukefc379d22018-06-05 23:50:19 -04001541 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001542 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
Chris Lukefc379d22018-06-05 23:50:19 -04001543 for (; cf->cursor > 0; cf->cursor--)
1544 {
1545 unix_vlib_cli_output_cursor_left (cf, uf);
1546 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1547 unix_vlib_cli_output_cursor_left (cf, uf);
1548 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001549 vec_reset_length (cf->current_command);
1550 if (vec_len (cf->command_history))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001551 {
1552 if (action == UNIX_CLI_PARSE_ACTION_UP)
1553 delta = -1;
1554 else
1555 delta = 1;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001556
Dave Barach9b8ffd92016-07-08 08:13:45 -04001557 cf->excursion += delta;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001558
Dave Barach9b8ffd92016-07-08 08:13:45 -04001559 if (cf->excursion == vec_len (cf->command_history))
1560 {
1561 /* down-arrowed to last entry - want a blank line */
1562 _vec_len (cf->current_command) = 0;
1563 }
1564 else if (cf->excursion < 0)
1565 {
1566 /* up-arrowed over the start to the end, want a blank line */
1567 cf->excursion = vec_len (cf->command_history);
1568 _vec_len (cf->current_command) = 0;
1569 }
1570 else
1571 {
1572 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1573 /* down-arrowed past end - wrap to start */
1574 cf->excursion = 0;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001575
Dave Barach9b8ffd92016-07-08 08:13:45 -04001576 /* Print the command at the current position */
1577 prev = cf->command_history[cf->excursion];
1578 vec_validate (cf->current_command, vec_len (prev) - 1);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001579
Dave Barach9b8ffd92016-07-08 08:13:45 -04001580 clib_memcpy (cf->current_command, prev, vec_len (prev));
1581 _vec_len (cf->current_command) = vec_len (prev);
1582 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1583 vec_len (cf->current_command));
1584 }
Dave Barach9b8ffd92016-07-08 08:13:45 -04001585 }
Yoann Desmouceaux561ae0a2017-09-20 10:08:28 +02001586 cf->cursor = vec_len (cf->current_command);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001587 break;
1588
1589 case UNIX_CLI_PARSE_ACTION_HOME:
1590 if (vec_len (cf->current_command) && cf->cursor > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001591 {
Chris Lukefc379d22018-06-05 23:50:19 -04001592 for (; cf->cursor > 0; cf->cursor--)
1593 unix_vlib_cli_output_cursor_left (cf, uf);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001594 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001595
Chris Luke0aca5eb2016-04-25 13:48:54 -04001596 cf->search_mode = 0;
1597 break;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001598
Chris Luke0aca5eb2016-04-25 13:48:54 -04001599 case UNIX_CLI_PARSE_ACTION_END:
1600 if (vec_len (cf->current_command) &&
Dave Barach9b8ffd92016-07-08 08:13:45 -04001601 cf->cursor < vec_len (cf->current_command))
1602 {
1603 unix_vlib_cli_output_cooked (cf, uf,
1604 cf->current_command + cf->cursor,
1605 vec_len (cf->current_command) -
1606 cf->cursor);
1607 cf->cursor = vec_len (cf->current_command);
1608 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001609
1610 cf->search_mode = 0;
1611 break;
1612
1613 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1614 if (vec_len (cf->current_command) && cf->cursor > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001615 {
Chris Lukefc379d22018-06-05 23:50:19 -04001616 unix_vlib_cli_output_cursor_left (cf, uf);
1617 cf->cursor--;
Chris Luke0aca5eb2016-04-25 13:48:54 -04001618
Chris Lukefc379d22018-06-05 23:50:19 -04001619 while (cf->cursor && isspace (cf->current_command[cf->cursor]))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001620 {
Chris Lukefc379d22018-06-05 23:50:19 -04001621 unix_vlib_cli_output_cursor_left (cf, uf);
1622 cf->cursor--;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001623 }
Chris Lukefc379d22018-06-05 23:50:19 -04001624 while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001625 {
Chris Lukefc379d22018-06-05 23:50:19 -04001626 if (isspace (cf->current_command[cf->cursor - 1]))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001627 break;
Chris Lukefc379d22018-06-05 23:50:19 -04001628 unix_vlib_cli_output_cursor_left (cf, uf);
1629 cf->cursor--;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001630 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001631
Dave Barach9b8ffd92016-07-08 08:13:45 -04001632 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001633
1634 cf->search_mode = 0;
1635 break;
1636
1637 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1638 if (vec_len (cf->current_command) &&
Dave Barach9b8ffd92016-07-08 08:13:45 -04001639 cf->cursor < vec_len (cf->current_command))
1640 {
1641 int e = vec_len (cf->current_command);
1642 j = cf->cursor;
1643 while (j < e && !isspace (cf->current_command[j]))
1644 j++;
1645 while (j < e && isspace (cf->current_command[j]))
1646 j++;
1647 unix_vlib_cli_output_cooked (cf, uf,
1648 cf->current_command + cf->cursor,
1649 j - cf->cursor);
1650 cf->cursor = j;
1651 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001652
1653 cf->search_mode = 0;
1654 break;
1655
1656
1657 case UNIX_CLI_PARSE_ACTION_ERASE:
1658 if (vec_len (cf->current_command))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001659 {
1660 if (cf->cursor == vec_len (cf->current_command))
1661 {
Chris Lukefc379d22018-06-05 23:50:19 -04001662 unix_vlib_cli_output_cursor_left (cf, uf);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001663 cf->cursor--;
Chris Lukefc379d22018-06-05 23:50:19 -04001664 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1665 cf->cursor++;
1666 unix_vlib_cli_output_cursor_left (cf, uf);
1667 cf->cursor--;
1668 _vec_len (cf->current_command)--;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001669 }
1670 else if (cf->cursor > 0)
1671 {
1672 /* shift everything at & to the right of the cursor left by 1 */
1673 j = vec_len (cf->current_command) - cf->cursor;
1674 memmove (cf->current_command + cf->cursor - 1,
1675 cf->current_command + cf->cursor, j);
1676 _vec_len (cf->current_command)--;
Chris Lukefc379d22018-06-05 23:50:19 -04001677
Dave Barach9b8ffd92016-07-08 08:13:45 -04001678 /* redraw the rest of the line */
Chris Lukefc379d22018-06-05 23:50:19 -04001679 unix_vlib_cli_output_cursor_left (cf, uf);
1680 cf->cursor--;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001681 unix_vlib_cli_output_cooked (cf, uf,
1682 cf->current_command + cf->cursor,
1683 j);
Chris Lukefc379d22018-06-05 23:50:19 -04001684 cf->cursor += j;
1685 /* erase last char */
1686 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1687 cf->cursor++;
1688
Dave Barach9b8ffd92016-07-08 08:13:45 -04001689 /* and shift the terminal cursor back where it should be */
Chris Lukefc379d22018-06-05 23:50:19 -04001690 j += 2; /* account for old string length and offset position */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001691 while (--j)
Chris Lukefc379d22018-06-05 23:50:19 -04001692 {
1693 unix_vlib_cli_output_cursor_left (cf, uf);
1694 cf->cursor--;
1695 }
Dave Barach9b8ffd92016-07-08 08:13:45 -04001696 }
1697 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001698 cf->search_mode = 0;
1699 cf->excursion = 0;
1700 vec_reset_length (cf->search_key);
1701 break;
1702
1703 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1704 if (vec_len (cf->current_command))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001705 {
1706 if (cf->cursor < vec_len (cf->current_command))
1707 {
1708 /* shift everything to the right of the cursor left by 1 */
1709 j = vec_len (cf->current_command) - cf->cursor - 1;
1710 memmove (cf->current_command + cf->cursor,
1711 cf->current_command + cf->cursor + 1, j);
1712 _vec_len (cf->current_command)--;
1713 /* redraw the rest of the line */
1714 unix_vlib_cli_output_cooked (cf, uf,
1715 cf->current_command + cf->cursor,
1716 j);
Chris Lukefc379d22018-06-05 23:50:19 -04001717 cf->cursor += j;
1718 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1719 cf->cursor++;
1720 unix_vlib_cli_output_cursor_left (cf, uf);
1721 cf->cursor--;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001722 /* and shift the terminal cursor back where it should be */
1723 if (j)
1724 {
Chris Lukefc379d22018-06-05 23:50:19 -04001725 unix_vlib_cli_output_cursor_left (cf, uf);
1726 cf->cursor--;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001727 while (--j)
Chris Lukefc379d22018-06-05 23:50:19 -04001728 {
1729 unix_vlib_cli_output_cursor_left (cf, uf);
1730 cf->cursor--;
1731 }
Dave Barach9b8ffd92016-07-08 08:13:45 -04001732 }
1733 }
1734 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001735 else if (input == 'D' - '@')
Dave Barach9b8ffd92016-07-08 08:13:45 -04001736 {
1737 /* ^D with no command entered = quit */
1738 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1739 vlib_process_signal_event (um->vlib_main,
1740 vlib_current_process (um->vlib_main),
1741 UNIX_CLI_PROCESS_EVENT_QUIT,
1742 cf - cm->cli_file_pool);
1743 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04001744 cf->search_mode = 0;
1745 cf->excursion = 0;
1746 vec_reset_length (cf->search_key);
1747 break;
1748
1749 case UNIX_CLI_PARSE_ACTION_CLEAR:
1750 /* If we're in ANSI mode, clear the screen.
1751 * Then redraw the prompt and any existing command input, then put
1752 * the cursor back where it was in that line.
1753 */
1754 if (cf->ansi_capable)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001755 unix_vlib_cli_output_cooked (cf, uf,
1756 (u8 *) ANSI_CLEAR,
1757 sizeof (ANSI_CLEAR) - 1);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001758 else
Dave Barach9b8ffd92016-07-08 08:13:45 -04001759 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001760
1761 unix_vlib_cli_output_raw (cf, uf,
Dave Barach9b8ffd92016-07-08 08:13:45 -04001762 cm->cli_prompt, vec_len (cm->cli_prompt));
Chris Lukefc379d22018-06-05 23:50:19 -04001763 unix_vlib_cli_output_cooked (cf, uf,
1764 cf->current_command,
1765 vec_len (cf->current_command));
1766 j = cf->cursor;
1767 cf->cursor = vec_len (cf->current_command);
1768 for (; cf->cursor > j; cf->cursor--)
1769 unix_vlib_cli_output_cursor_left (cf, uf);
Chris Luke0aca5eb2016-04-25 13:48:54 -04001770
1771 break;
1772
Chris Luke7afda3a2016-04-25 13:49:22 -04001773 case UNIX_CLI_PARSE_ACTION_TAB:
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001774 if (cf->cursor < vec_len (cf->current_command))
1775 {
1776 /* if we are in the middle of a line, complete only if
1777 * the cursor points to whitespace */
1778 if (isspace (cf->current_command[cf->cursor]))
1779 {
1780 /* save and clear any input that is after the cursor */
1781 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1782 clib_memcpy (save, cf->current_command + cf->cursor,
1783 vec_len (cf->current_command) - cf->cursor);
1784 _vec_len (cf->current_command) = cf->cursor;
1785 }
1786 else
1787 {
1788 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1789 break;
1790 }
1791 }
1792 possible_commands =
1793 vlib_cli_get_possible_completions (cf->current_command);
1794 if (vec_len (possible_commands) == 1)
1795 {
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001796 u8 *completed = possible_commands[0];
Chris Lukefc379d22018-06-05 23:50:19 -04001797 j = cf->cursor;
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001798
1799 /* find the last word of current_command */
1800 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1801 {
Chris Lukefc379d22018-06-05 23:50:19 -04001802 unix_vlib_cli_output_cursor_left (cf, uf);
1803 cf->cursor--;
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001804 j--;
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001805 }
1806 _vec_len (cf->current_command) = j;
1807
1808 /* replace it with the newly expanded command */
1809 vec_append (cf->current_command, completed);
1810
1811 /* echo to the terminal */
Chris Lukefc379d22018-06-05 23:50:19 -04001812 unix_vlib_cli_output_cooked (cf, uf, completed,
1813 vec_len (completed));
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001814
1815 /* add one trailing space if needed */
1816 if (vec_len (save) == 0)
1817 {
1818 vec_add1 (cf->current_command, ' ');
Chris Lukefc379d22018-06-05 23:50:19 -04001819 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001820 }
1821
1822 cf->cursor = vec_len (cf->current_command);
1823
1824 }
1825 else if (vec_len (possible_commands) >= 2)
1826 {
1827 u8 **possible_command;
1828 uword max_command_len = 0, min_command_len = ~0;
Chris Lukefc379d22018-06-05 23:50:19 -04001829 u32 i;
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001830
1831 vec_foreach (possible_command, possible_commands)
1832 {
1833 if (vec_len (*possible_command) > max_command_len)
Chris Lukefc379d22018-06-05 23:50:19 -04001834 max_command_len = vec_len (*possible_command);
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001835 if (vec_len (*possible_command) < min_command_len)
Chris Lukefc379d22018-06-05 23:50:19 -04001836 min_command_len = vec_len (*possible_command);
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001837 }
1838
1839 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1840
1841 i = 0;
1842 vec_foreach (possible_command, possible_commands)
1843 {
1844 if (i + max_command_len >= cf->width)
1845 {
1846 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1847 i = 0;
1848 }
Chris Lukefc379d22018-06-05 23:50:19 -04001849 unix_vlib_cli_output_cooked (cf, uf, *possible_command,
1850 vec_len (*possible_command));
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001851 for (j = vec_len (*possible_command); j < max_command_len + 2;
1852 j++)
1853 {
Chris Lukefc379d22018-06-05 23:50:19 -04001854 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001855 }
1856 i += max_command_len + 2;
1857 }
1858
1859 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1860
1861 /* rewrite prompt */
1862 unix_cli_cli_prompt (cf, uf);
Chris Lukefc379d22018-06-05 23:50:19 -04001863 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1864 vec_len (cf->current_command));
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001865
1866 /* count length of last word */
1867 j = cf->cursor;
1868 i = 0;
1869 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1870 {
1871 j--;
1872 i++;
1873 }
1874
1875 /* determine smallest common command */
1876 for (; i < min_command_len; i++)
1877 {
1878 u8 common = '\0';
1879 int stop = 0;
Chris Lukefc379d22018-06-05 23:50:19 -04001880
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001881 vec_foreach (possible_command, possible_commands)
1882 {
1883 if (common == '\0')
1884 {
1885 common = (*possible_command)[i];
1886 }
1887 else if (common != (*possible_command)[i])
1888 {
1889 stop = 1;
1890 break;
1891 }
1892 }
Chris Lukefc379d22018-06-05 23:50:19 -04001893
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001894 if (!stop)
1895 {
1896 vec_add1 (cf->current_command, common);
1897 cf->cursor++;
Chris Lukefc379d22018-06-05 23:50:19 -04001898 unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001899 }
1900 else
1901 {
1902 break;
1903 }
1904 }
1905 }
1906 else
1907 {
1908 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1909 }
1910
1911 if (vec_len (save) > 0)
1912 {
1913 /* restore remaining input if tab was hit in the middle of a line */
Chris Lukefc379d22018-06-05 23:50:19 -04001914 unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
1915 cf->cursor += vec_len (save);
1916 for (j = 0; j < vec_len (save); j++, cf->cursor--)
1917 unix_vlib_cli_output_cursor_left (cf, uf);
Yoann Desmouceaux3060e072017-05-18 11:00:48 +02001918 vec_append (cf->current_command, save);
1919 vec_free (save);
1920 }
1921 vec_free (possible_commands);
1922
1923 break;
Chris Luke7afda3a2016-04-25 13:49:22 -04001924 case UNIX_CLI_PARSE_ACTION_YANK:
1925 /* TODO */
1926 break;
1927
1928
1929 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
1930 pager_quit:
1931 unix_cli_pager_prompt_erase (cf, uf);
1932 unix_cli_pager_reset (cf);
1933 unix_cli_cli_prompt (cf, uf);
1934 break;
1935
1936 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
1937 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
1938 /* show next page of the buffer */
Chris Luke70a745d2018-06-10 10:47:50 -04001939 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001940 {
1941 u8 *line = NULL;
1942 unix_cli_pager_index_t *pi = NULL;
Chris Luke862623d2016-05-14 10:13:34 -04001943
Dave Barach9b8ffd92016-07-08 08:13:45 -04001944 int m = cf->pager_start + (cf->height - 1);
1945 unix_cli_pager_prompt_erase (cf, uf);
1946 for (j = m;
1947 j < vec_len (cf->pager_index) && cf->pager_start < m;
1948 j++, cf->pager_start++)
1949 {
1950 pi = &cf->pager_index[j];
1951 line = cf->pager_vector[pi->line] + pi->offset;
1952 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1953 }
1954 /* if the last line didn't end in newline, add a newline */
1955 if (pi && line[pi->length - 1] != '\n')
1956 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1957 unix_cli_pager_prompt (cf, uf);
1958 }
Chris Luke7afda3a2016-04-25 13:49:22 -04001959 else
Dave Barach9b8ffd92016-07-08 08:13:45 -04001960 {
1961 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
1962 /* no more in buffer, exit, but only if it was <space> */
1963 goto pager_quit;
1964 }
Chris Luke7afda3a2016-04-25 13:49:22 -04001965 break;
1966
1967 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
1968 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
1969 /* display the next line of the buffer */
Chris Luke70a745d2018-06-10 10:47:50 -04001970 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001971 {
1972 u8 *line;
1973 unix_cli_pager_index_t *pi;
Chris Luke862623d2016-05-14 10:13:34 -04001974
Dave Barach9b8ffd92016-07-08 08:13:45 -04001975 unix_cli_pager_prompt_erase (cf, uf);
1976 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
1977 line = cf->pager_vector[pi->line] + pi->offset;
1978 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1979 cf->pager_start++;
1980 /* if the last line didn't end in newline, add a newline */
1981 if (line[pi->length - 1] != '\n')
1982 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1983 unix_cli_pager_prompt (cf, uf);
1984 }
Chris Luke7afda3a2016-04-25 13:49:22 -04001985 else
Dave Barach9b8ffd92016-07-08 08:13:45 -04001986 {
1987 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
1988 /* no more in buffer, exit, but only if it was <enter> */
1989 goto pager_quit;
1990 }
Chris Luke7afda3a2016-04-25 13:49:22 -04001991
1992 break;
1993
1994 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
1995 /* scroll the page back one line */
1996 if (cf->pager_start > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001997 {
1998 u8 *line = NULL;
1999 unix_cli_pager_index_t *pi = NULL;
Chris Luke862623d2016-05-14 10:13:34 -04002000
Dave Barach9b8ffd92016-07-08 08:13:45 -04002001 cf->pager_start--;
2002 if (cf->ansi_capable)
2003 {
2004 pi = &cf->pager_index[cf->pager_start];
2005 line = cf->pager_vector[pi->line] + pi->offset;
2006 unix_cli_pager_prompt_erase (cf, uf);
2007 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2008 sizeof (ANSI_SCROLLDN) - 1);
2009 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2010 sizeof (ANSI_SAVECURSOR) - 1);
2011 unix_cli_ansi_cursor (cf, uf, 1, 1);
2012 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2013 sizeof (ANSI_CLEARLINE) - 1);
2014 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2015 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2016 sizeof (ANSI_RESTCURSOR) - 1);
2017 unix_cli_pager_prompt_erase (cf, uf);
2018 unix_cli_pager_prompt (cf, uf);
2019 }
2020 else
2021 {
2022 int m = cf->pager_start + (cf->height - 1);
2023 unix_cli_pager_prompt_erase (cf, uf);
2024 for (j = cf->pager_start;
2025 j < vec_len (cf->pager_index) && j < m; j++)
2026 {
2027 pi = &cf->pager_index[j];
2028 line = cf->pager_vector[pi->line] + pi->offset;
2029 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2030 }
2031 /* if the last line didn't end in newline, add a newline */
2032 if (pi && line[pi->length - 1] != '\n')
2033 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2034 unix_cli_pager_prompt (cf, uf);
2035 }
2036 }
Chris Luke7afda3a2016-04-25 13:49:22 -04002037 break;
2038
2039 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2040 /* back to the first page of the buffer */
2041 if (cf->pager_start > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002042 {
2043 u8 *line = NULL;
2044 unix_cli_pager_index_t *pi = NULL;
Chris Luke862623d2016-05-14 10:13:34 -04002045
Dave Barach9b8ffd92016-07-08 08:13:45 -04002046 cf->pager_start = 0;
2047 int m = cf->pager_start + (cf->height - 1);
2048 unix_cli_pager_prompt_erase (cf, uf);
2049 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2050 j++)
2051 {
2052 pi = &cf->pager_index[j];
2053 line = cf->pager_vector[pi->line] + pi->offset;
2054 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2055 }
2056 /* if the last line didn't end in newline, add a newline */
2057 if (pi && line[pi->length - 1] != '\n')
2058 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2059 unix_cli_pager_prompt (cf, uf);
2060 }
Chris Luke7afda3a2016-04-25 13:49:22 -04002061 break;
2062
2063 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2064 /* skip to the last page of the buffer */
Chris Luke862623d2016-05-14 10:13:34 -04002065 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
Dave Barach9b8ffd92016-07-08 08:13:45 -04002066 {
2067 u8 *line = NULL;
2068 unix_cli_pager_index_t *pi = NULL;
Chris Luke862623d2016-05-14 10:13:34 -04002069
Dave Barach9b8ffd92016-07-08 08:13:45 -04002070 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2071 unix_cli_pager_prompt_erase (cf, uf);
2072 unix_cli_pager_message (cf, uf, "skipping", "\n");
2073 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2074 {
2075 pi = &cf->pager_index[j];
2076 line = cf->pager_vector[pi->line] + pi->offset;
2077 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2078 }
2079 /* if the last line didn't end in newline, add a newline */
2080 if (pi && line[pi->length - 1] != '\n')
2081 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2082 unix_cli_pager_prompt (cf, uf);
2083 }
Chris Luke7afda3a2016-04-25 13:49:22 -04002084 break;
2085
2086 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2087 /* wander back one page in the buffer */
2088 if (cf->pager_start > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002089 {
2090 u8 *line = NULL;
2091 unix_cli_pager_index_t *pi = NULL;
2092 int m;
Chris Luke862623d2016-05-14 10:13:34 -04002093
Dave Barach9b8ffd92016-07-08 08:13:45 -04002094 if (cf->pager_start >= cf->height)
2095 cf->pager_start -= cf->height - 1;
2096 else
2097 cf->pager_start = 0;
2098 m = cf->pager_start + cf->height - 1;
2099 unix_cli_pager_prompt_erase (cf, uf);
2100 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2101 j++)
2102 {
2103 pi = &cf->pager_index[j];
2104 line = cf->pager_vector[pi->line] + pi->offset;
2105 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2106 }
2107 /* if the last line didn't end in newline, add a newline */
2108 if (pi && line[pi->length - 1] != '\n')
2109 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2110 unix_cli_pager_prompt (cf, uf);
2111 }
Chris Luke7afda3a2016-04-25 13:49:22 -04002112 break;
2113
Chris Luke862623d2016-05-14 10:13:34 -04002114 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2115 /* Redraw the current pager screen */
2116 unix_cli_pager_redraw (cf, uf);
2117 break;
2118
Chris Luke7afda3a2016-04-25 13:49:22 -04002119 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2120 /* search forwards in the buffer */
2121 break;
2122
2123
Chris Luke0aca5eb2016-04-25 13:48:54 -04002124 case UNIX_CLI_PARSE_ACTION_CRLF:
2125 crlf:
Chris Luke0aca5eb2016-04-25 13:48:54 -04002126 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2127
Chris Luke7afda3a2016-04-25 13:49:22 -04002128 if (cf->has_history && cf->history_limit)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002129 {
2130 if (cf->command_history
2131 && vec_len (cf->command_history) >= cf->history_limit)
2132 {
2133 vec_free (cf->command_history[0]);
2134 vec_delete (cf->command_history, 1, 0);
2135 }
2136 /* Don't add blank lines to the cmd history */
2137 if (vec_len (cf->current_command))
2138 {
2139 /* Don't duplicate the previous command */
2140 j = vec_len (cf->command_history);
2141 if (j == 0 ||
2142 (vec_len (cf->current_command) !=
2143 vec_len (cf->command_history[j - 1])
2144 || memcmp (cf->current_command, cf->command_history[j - 1],
2145 vec_len (cf->current_command)) != 0))
2146 {
2147 /* copy the command to the history */
2148 u8 *c = 0;
2149 vec_append (c, cf->current_command);
2150 vec_add1 (cf->command_history, c);
2151 cf->command_number++;
2152 }
2153 }
2154 cf->excursion = vec_len (cf->command_history);
2155 }
Chris Luke93dcd1d2016-05-10 10:45:10 -04002156
Chris Luke0aca5eb2016-04-25 13:48:54 -04002157 cf->search_mode = 0;
2158 vec_reset_length (cf->search_key);
2159 cf->cursor = 0;
2160
2161 return 0;
2162
Chris Luke7afda3a2016-04-25 13:49:22 -04002163 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2164 case UNIX_CLI_PARSE_ACTION_NOMATCH:
Chris Luke862623d2016-05-14 10:13:34 -04002165 if (vec_len (cf->pager_index))
Dave Barach9b8ffd92016-07-08 08:13:45 -04002166 {
2167 /* no-op for now */
2168 }
Chris Lukefc379d22018-06-05 23:50:19 -04002169 else if (cf->has_history && cf->search_mode != 0 && isprint (input))
Dave Barach9b8ffd92016-07-08 08:13:45 -04002170 {
2171 int k, limit, offset;
2172 u8 *item;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002173
Dave Barach9b8ffd92016-07-08 08:13:45 -04002174 vec_add1 (cf->search_key, input);
Chris Luke0aca5eb2016-04-25 13:48:54 -04002175
Dave Barach9b8ffd92016-07-08 08:13:45 -04002176 search_again:
2177 for (j = 0; j < vec_len (cf->command_history); j++)
2178 {
2179 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2180 cf->excursion = 0;
2181 else if (cf->excursion < 0)
2182 cf->excursion = vec_len (cf->command_history) - 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002183
Dave Barach9b8ffd92016-07-08 08:13:45 -04002184 item = cf->command_history[cf->excursion];
Ed Warnickecb9cada2015-12-08 15:45:58 -07002185
Dave Barach9b8ffd92016-07-08 08:13:45 -04002186 limit = (vec_len (cf->search_key) > vec_len (item)) ?
2187 vec_len (item) : vec_len (cf->search_key);
Chris Luke0aca5eb2016-04-25 13:48:54 -04002188
Dave Barach9b8ffd92016-07-08 08:13:45 -04002189 for (offset = 0; offset <= vec_len (item) - limit; offset++)
2190 {
2191 for (k = 0; k < limit; k++)
2192 {
2193 if (item[k + offset] != cf->search_key[k])
2194 goto next_offset;
2195 }
2196 goto found_at_offset;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002197
Dave Barach9b8ffd92016-07-08 08:13:45 -04002198 next_offset:
2199 ;
2200 }
2201 goto next;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002202
Dave Barach9b8ffd92016-07-08 08:13:45 -04002203 found_at_offset:
Chris Lukefc379d22018-06-05 23:50:19 -04002204 for (; cf->cursor > 0; cf->cursor--)
2205 {
2206 unix_vlib_cli_output_cursor_left (cf, uf);
2207 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2208 unix_vlib_cli_output_cursor_left (cf, uf);
2209 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04002210
Dave Barach9b8ffd92016-07-08 08:13:45 -04002211 vec_validate (cf->current_command, vec_len (item) - 1);
2212 clib_memcpy (cf->current_command, item, vec_len (item));
2213 _vec_len (cf->current_command) = vec_len (item);
Chris Luke93dcd1d2016-05-10 10:45:10 -04002214
Dave Barach9b8ffd92016-07-08 08:13:45 -04002215 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2216 vec_len (cf->current_command));
2217 cf->cursor = vec_len (cf->current_command);
2218 goto found;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002219
Dave Barach9b8ffd92016-07-08 08:13:45 -04002220 next:
2221 cf->excursion += cf->search_mode;
2222 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04002223
Dave Barach9b8ffd92016-07-08 08:13:45 -04002224 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2225 vec_reset_length (cf->search_key);
2226 vec_reset_length (cf->current_command);
2227 cf->search_mode = 0;
2228 cf->cursor = 0;
2229 goto crlf;
2230 }
2231 else if (isprint (input)) /* skip any errant control codes */
2232 {
2233 if (cf->cursor == vec_len (cf->current_command))
2234 {
2235 /* Append to end */
2236 vec_add1 (cf->current_command, input);
2237 cf->cursor++;
Chris Luke7afda3a2016-04-25 13:49:22 -04002238
Dave Barach9b8ffd92016-07-08 08:13:45 -04002239 /* Echo the character back to the client */
Chris Lukefc379d22018-06-05 23:50:19 -04002240 unix_vlib_cli_output_cooked (cf, uf, &input, 1);
Dave Barach9b8ffd92016-07-08 08:13:45 -04002241 }
2242 else
2243 {
2244 /* Insert at cursor: resize +1 byte, move everything over */
2245 j = vec_len (cf->current_command) - cf->cursor;
2246 vec_add1 (cf->current_command, (u8) 'A');
2247 memmove (cf->current_command + cf->cursor + 1,
2248 cf->current_command + cf->cursor, j);
2249 cf->current_command[cf->cursor] = input;
2250 /* Redraw the line */
2251 j++;
Chris Lukefc379d22018-06-05 23:50:19 -04002252 unix_vlib_cli_output_cooked (cf, uf,
2253 cf->current_command + cf->cursor,
2254 j);
2255 cf->cursor += j;
2256 j--;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002257 /* Put terminal cursor back */
Chris Lukefc379d22018-06-05 23:50:19 -04002258 for (; j > 0; j--, cf->cursor--)
2259 unix_vlib_cli_output_cursor_left (cf, uf);
Dave Barach9b8ffd92016-07-08 08:13:45 -04002260 }
2261 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04002262 else
Dave Barach9b8ffd92016-07-08 08:13:45 -04002263 {
2264 /* no-op - not printable or otherwise not actionable */
2265 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04002266
2267 found:
2268
2269 break;
Chris Luke7afda3a2016-04-25 13:49:22 -04002270
2271 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2272 break;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002273 }
Dave Barach9b8ffd92016-07-08 08:13:45 -04002274 return 1;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002275}
2276
Chris Luke8e5b0412016-07-26 13:06:10 -04002277/** @brief Process input bytes on a stream to provide line editing and
Chris Luke0aca5eb2016-04-25 13:48:54 -04002278 * command history in the CLI. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002279static int
Damjan Marion56dd5432017-09-08 19:52:02 +02002280unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2281 clib_file_main_t * fm, unix_cli_file_t * cf)
Chris Luke0aca5eb2016-04-25 13:48:54 -04002282{
Damjan Marion56dd5432017-09-08 19:52:02 +02002283 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
Chris Luke0aca5eb2016-04-25 13:48:54 -04002284 int i;
2285
2286 for (i = 0; i < vec_len (cf->input_vector); i++)
2287 {
2288 unix_cli_parse_action_t action;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002289 i32 matched = 0;
Chris Luke7afda3a2016-04-25 13:49:22 -04002290 unix_cli_parse_actions_t *a;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002291
Chris Luke7afda3a2016-04-25 13:49:22 -04002292 /* If we're in the pager mode, search the pager actions */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002293 a =
2294 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2295 unix_cli_parse_strings;
Chris Luke7afda3a2016-04-25 13:49:22 -04002296
Chris Luke93dcd1d2016-05-10 10:45:10 -04002297 /* See if the input buffer is some sort of control code */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002298 action = unix_cli_match_action (a, &cf->input_vector[i],
2299 vec_len (cf->input_vector) - i,
2300 &matched);
Chris Luke0aca5eb2016-04-25 13:48:54 -04002301
2302 switch (action)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002303 {
2304 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2305 if (i)
2306 {
2307 /* There was a partial match which means we need more bytes
2308 * than the input buffer currently has.
2309 * Since the bytes before here have been processed, shift
2310 * the remaining contents to the start of the input buffer.
2311 */
2312 vec_delete (cf->input_vector, i, 0);
2313 }
2314 return 1; /* wait for more */
Chris Luke0aca5eb2016-04-25 13:48:54 -04002315
Dave Barach9b8ffd92016-07-08 08:13:45 -04002316 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2317 /* process telnet options */
2318 matched = unix_cli_process_telnet (um, cf, uf,
2319 cf->input_vector + i,
2320 vec_len (cf->input_vector) - i);
2321 if (matched < 0)
2322 {
Chris Luke03add7f2017-09-20 23:31:24 -04002323 /* There was a partial match which means we need more bytes
2324 * than the input buffer currently has.
2325 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002326 if (i)
2327 {
Chris Luke03add7f2017-09-20 23:31:24 -04002328 /*
Dave Barach9b8ffd92016-07-08 08:13:45 -04002329 * Since the bytes before here have been processed, shift
2330 * the remaining contents to the start of the input buffer.
2331 */
2332 vec_delete (cf->input_vector, i, 0);
2333 }
2334 return 1; /* wait for more */
2335 }
2336 break;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002337
Dave Barach9b8ffd92016-07-08 08:13:45 -04002338 default:
Chris Luke03add7f2017-09-20 23:31:24 -04002339 /* If telnet option processing switched us to line mode, get us
2340 * out of here!
2341 */
2342 if (cf->line_mode)
2343 {
2344 vec_delete (cf->input_vector, i, 0);
2345 cf->current_command = cf->input_vector;
2346 return 0;
2347 }
2348
Dave Barach9b8ffd92016-07-08 08:13:45 -04002349 /* process the action */
2350 if (!unix_cli_line_process_one (cm, um, cf, uf,
2351 cf->input_vector[i], action))
2352 {
2353 /* CRLF found. Consume the bytes from the input_vector */
2354 vec_delete (cf->input_vector, i + matched, 0);
2355 /* And tell our caller to execute cf->input_command */
2356 return 0;
2357 }
2358 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04002359
2360 i += matched;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002361 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04002362
Dave Barach9b8ffd92016-07-08 08:13:45 -04002363 vec_reset_length (cf->input_vector);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002364 return 1;
2365}
2366
Chris Luke8e5b0412016-07-26 13:06:10 -04002367/** @brief Process input to a CLI session. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002368static void
2369unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002370{
Dave Barach9b8ffd92016-07-08 08:13:45 -04002371 unix_main_t *um = &unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +02002372 clib_file_main_t *fm = &file_main;
2373 clib_file_t *uf;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002374 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002375 unformat_input_t input;
2376 int vlib_parse_eval (u8 *);
2377
Chris Luke03add7f2017-09-20 23:31:24 -04002378 cm->current_input_file_index = cli_file_index;
2379
Chris Luke93dcd1d2016-05-10 10:45:10 -04002380more:
Ed Warnickecb9cada2015-12-08 15:45:58 -07002381 /* Try vlibplex first. Someday... */
2382 if (0 && vlib_parse_eval (cf->input_vector) == 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002383 goto done;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002384
Chris Luke03add7f2017-09-20 23:31:24 -04002385
Chris Luke93dcd1d2016-05-10 10:45:10 -04002386 if (cf->line_mode)
2387 {
2388 /* just treat whatever we got as a complete line of input */
2389 cf->current_command = cf->input_vector;
2390 }
2391 else
2392 {
2393 /* Line edit, echo, etc. */
Damjan Marion56dd5432017-09-08 19:52:02 +02002394 if (unix_cli_line_edit (cm, um, fm, cf))
Dave Barach9b8ffd92016-07-08 08:13:45 -04002395 /* want more input */
2396 return;
Chris Luke93dcd1d2016-05-10 10:45:10 -04002397 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07002398
2399 if (um->log_fd)
2400 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04002401 static u8 *lv;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002402 vec_reset_length (lv);
Dave Barach9b8ffd92016-07-08 08:13:45 -04002403 lv = format (lv, "%U[%d]: %v",
2404 format_timeval, 0 /* current bat-time */ ,
2405 0 /* current bat-format */ ,
Chris Luke03add7f2017-09-20 23:31:24 -04002406 cli_file_index, cf->current_command);
2407 int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
Ed Warnickecb9cada2015-12-08 15:45:58 -07002408 }
2409
Chris Luke03add7f2017-09-20 23:31:24 -04002410 /* Build an unformat structure around our command */
Chris Luke93dcd1d2016-05-10 10:45:10 -04002411 unformat_init_vector (&input, cf->current_command);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002412
2413 /* Remove leading white space from input. */
2414 (void) unformat (&input, "");
2415
Dave Barach9b8ffd92016-07-08 08:13:45 -04002416 cf->pager_start = 0; /* start a new pager session */
Ed Warnickecb9cada2015-12-08 15:45:58 -07002417
2418 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002419 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2420 cli_file_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002421
Ed Warnickecb9cada2015-12-08 15:45:58 -07002422 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2423 input.buffer = 0;
2424
2425 unformat_free (&input);
2426
Chris Luke93dcd1d2016-05-10 10:45:10 -04002427 /* Re-fetch pointer since pool may have moved. */
2428 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
Damjan Marion56dd5432017-09-08 19:52:02 +02002429 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
Chris Luke93dcd1d2016-05-10 10:45:10 -04002430
Ed Warnickecb9cada2015-12-08 15:45:58 -07002431done:
Chris Luke93dcd1d2016-05-10 10:45:10 -04002432 /* reset vector; we'll re-use it later */
2433 if (cf->line_mode)
Chris Luke03add7f2017-09-20 23:31:24 -04002434 {
2435 vec_reset_length (cf->input_vector);
2436 cf->current_command = 0;
2437 }
Chris Luke93dcd1d2016-05-10 10:45:10 -04002438 else
Chris Luke03add7f2017-09-20 23:31:24 -04002439 {
2440 vec_reset_length (cf->current_command);
2441 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07002442
Chris Luke7afda3a2016-04-25 13:49:22 -04002443 if (cf->no_pager == 2)
2444 {
2445 /* Pager was programmatically disabled */
2446 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2447 cf->no_pager = um->cli_no_pager;
2448 }
2449
Dave Barach9b8ffd92016-07-08 08:13:45 -04002450 if (vec_len (cf->pager_index) == 0
2451 || vec_len (cf->pager_index) < cf->height)
Chris Luke7afda3a2016-04-25 13:49:22 -04002452 {
2453 /* There was no need for the pager */
2454 unix_cli_pager_reset (cf);
2455
2456 /* Prompt. */
2457 unix_cli_cli_prompt (cf, uf);
2458 }
2459 else
2460 {
2461 /* Display the pager prompt */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002462 unix_cli_pager_prompt (cf, uf);
Chris Luke7afda3a2016-04-25 13:49:22 -04002463 }
Chris Luke93dcd1d2016-05-10 10:45:10 -04002464
Dave Barach9b8ffd92016-07-08 08:13:45 -04002465 /* Any residual data in the input vector? */
2466 if (vec_len (cf->input_vector))
2467 goto more;
Chris Luke03add7f2017-09-20 23:31:24 -04002468
2469 /* For non-interactive sessions send a NUL byte.
2470 * Specifically this is because vppctl needs to see some traffic in
2471 * order to move on to closing the session. Commands with no output
2472 * would thus cause vppctl to hang indefinitely in non-interactive mode
2473 * since there is also no prompt sent after the command completes.
2474 */
2475 if (!cf->is_interactive)
2476 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002477}
2478
Chris Luke54ccf222016-07-25 16:38:11 -04002479/** Destroy a CLI session.
2480 * @note If we destroy the @c stdin session this additionally signals
2481 * the shutdown of VPP.
2482 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002483static void
2484unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002485{
Dave Barach9b8ffd92016-07-08 08:13:45 -04002486 unix_main_t *um = &unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +02002487 clib_file_main_t *fm = &file_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002488 unix_cli_file_t *cf;
Damjan Marion56dd5432017-09-08 19:52:02 +02002489 clib_file_t *uf;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002490 int i;
2491
2492 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
Damjan Marion56dd5432017-09-08 19:52:02 +02002493 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002494
2495 /* Quit/EOF on stdin means quit program. */
Chris Luke03add7f2017-09-20 23:31:24 -04002496 if (uf->file_descriptor == STDIN_FILENO)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002497 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2498
2499 vec_free (cf->current_command);
2500 vec_free (cf->search_key);
2501
2502 for (i = 0; i < vec_len (cf->command_history); i++)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002503 vec_free (cf->command_history[i]);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002504
2505 vec_free (cf->command_history);
2506
Damjan Marion56dd5432017-09-08 19:52:02 +02002507 clib_file_del (fm, uf);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002508
2509 unix_cli_file_free (cf);
2510 pool_put (cm->cli_file_pool, cf);
2511}
2512
Chris Luke54ccf222016-07-25 16:38:11 -04002513/** Handle system events. */
Ed Warnickecb9cada2015-12-08 15:45:58 -07002514static uword
2515unix_cli_process (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04002516 vlib_node_runtime_t * rt, vlib_frame_t * f)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002517{
Dave Barach9b8ffd92016-07-08 08:13:45 -04002518 unix_cli_main_t *cm = &unix_cli_main;
2519 uword i, *data = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002520
2521 while (1)
2522 {
2523 unix_cli_process_event_type_t event_type;
2524 vlib_process_wait_for_event (vm);
2525 event_type = vlib_process_get_events (vm, &data);
2526
2527 switch (event_type)
2528 {
2529 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2530 for (i = 0; i < vec_len (data); i++)
2531 unix_cli_process_input (cm, data[i]);
2532 break;
2533
2534 case UNIX_CLI_PROCESS_EVENT_QUIT:
2535 /* Kill this process. */
2536 for (i = 0; i < vec_len (data); i++)
2537 unix_cli_kill (cm, data[i]);
2538 goto done;
2539 }
2540
2541 if (data)
2542 _vec_len (data) = 0;
2543 }
2544
Dave Barach9b8ffd92016-07-08 08:13:45 -04002545done:
Ed Warnickecb9cada2015-12-08 15:45:58 -07002546 vec_free (data);
2547
2548 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2549
2550 /* Add node index so we can re-use this process later. */
2551 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2552
2553 return 0;
2554}
2555
Chris Luke54ccf222016-07-25 16:38:11 -04002556/** Called when a CLI session file descriptor can be written to without
2557 * blocking. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002558static clib_error_t *
Damjan Marion56dd5432017-09-08 19:52:02 +02002559unix_cli_write_ready (clib_file_t * uf)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002560{
Dave Barach9b8ffd92016-07-08 08:13:45 -04002561 unix_cli_main_t *cm = &unix_cli_main;
2562 unix_cli_file_t *cf;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002563 int n;
2564
2565 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2566
2567 /* Flush output vector. */
Chris Luke03add7f2017-09-20 23:31:24 -04002568 if (cf->is_socket)
2569 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2570 n = send (uf->file_descriptor,
2571 cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2572 else
2573 n = write (uf->file_descriptor,
2574 cf->output_vector, vec_len (cf->output_vector));
Ed Warnickecb9cada2015-12-08 15:45:58 -07002575
2576 if (n < 0 && errno != EAGAIN)
Chris Luke03add7f2017-09-20 23:31:24 -04002577 {
2578 if (errno == EPIPE)
2579 {
2580 /* connection closed on us */
2581 unix_main_t *um = &unix_main;
2582 cf->has_epipe = 1;
2583 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2584 UNIX_CLI_PROCESS_EVENT_QUIT,
2585 uf->private_data);
2586 }
2587 else
2588 {
2589 return clib_error_return_unix (0, "write");
2590 }
2591 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07002592
2593 else if (n > 0)
2594 unix_cli_del_pending_output (uf, cf, n);
2595
2596 return /* no error */ 0;
2597}
2598
Chris Luke54ccf222016-07-25 16:38:11 -04002599/** Called when a CLI session file descriptor has data to be read. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002600static clib_error_t *
Damjan Marion56dd5432017-09-08 19:52:02 +02002601unix_cli_read_ready (clib_file_t * uf)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002602{
Dave Barach9b8ffd92016-07-08 08:13:45 -04002603 unix_main_t *um = &unix_main;
2604 unix_cli_main_t *cm = &unix_cli_main;
2605 unix_cli_file_t *cf;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002606 uword l;
2607 int n, n_read, n_try;
2608
2609 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2610
2611 n = n_try = 4096;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002612 while (n == n_try)
2613 {
Ed Warnickecb9cada2015-12-08 15:45:58 -07002614 l = vec_len (cf->input_vector);
2615 vec_resize (cf->input_vector, l + n_try);
2616
2617 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2618
2619 /* Error? */
2620 if (n < 0 && errno != EAGAIN)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002621 return clib_error_return_unix (0, "read");
2622
Ed Warnickecb9cada2015-12-08 15:45:58 -07002623 n_read = n < 0 ? 0 : n;
2624 _vec_len (cf->input_vector) = l + n_read;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002625 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07002626
Dave Barach9b8ffd92016-07-08 08:13:45 -04002627 if (!(n < 0))
Ed Warnickecb9cada2015-12-08 15:45:58 -07002628 vlib_process_signal_event (um->vlib_main,
2629 cf->process_node_index,
2630 (n_read == 0
2631 ? UNIX_CLI_PROCESS_EVENT_QUIT
2632 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2633 /* event data */ uf->private_data);
2634
2635 return /* no error */ 0;
2636}
2637
Chris Luke03add7f2017-09-20 23:31:24 -04002638/** Called when a CLI session file descriptor has an error condition. */
2639static clib_error_t *
2640unix_cli_error_detected (clib_file_t * uf)
2641{
2642 unix_main_t *um = &unix_main;
2643 unix_cli_main_t *cm = &unix_cli_main;
2644 unix_cli_file_t *cf;
2645
2646 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2647 cf->has_epipe = 1; /* prevent writes while the close is pending */
2648 vlib_process_signal_event (um->vlib_main,
2649 cf->process_node_index,
2650 UNIX_CLI_PROCESS_EVENT_QUIT,
2651 /* event data */ uf->private_data);
2652
2653 return /* no error */ 0;
2654}
2655
Chris Lukeb5850972016-05-03 16:34:59 -04002656/** Store a new CLI session.
2657 * @param name The name of the session.
2658 * @param fd The file descriptor for the session I/O.
2659 * @return The session ID.
2660 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002661static u32
2662unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002663{
Dave Barach9b8ffd92016-07-08 08:13:45 -04002664 unix_main_t *um = &unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +02002665 clib_file_main_t *fm = &file_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002666 unix_cli_file_t *cf;
Damjan Marion56dd5432017-09-08 19:52:02 +02002667 clib_file_t template = { 0 };
Dave Barach9b8ffd92016-07-08 08:13:45 -04002668 vlib_main_t *vm = um->vlib_main;
2669 vlib_node_t *n;
Damjan Marionceab7882018-01-19 20:56:12 +01002670 u8 *file_desc = 0;
2671
2672 file_desc = format (0, "%s", name);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002673
2674 name = (char *) format (0, "unix-cli-%s", name);
2675
2676 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2677 {
2678 uword l = vec_len (cm->unused_cli_process_node_indices);
2679
2680 /* Find node and give it new name. */
2681 n = vlib_get_node (vm, cm->unused_cli_process_node_indices[l - 1]);
2682 vec_free (n->name);
2683 n->name = (u8 *) name;
2684
2685 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2686
2687 _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2688 }
2689 else
2690 {
2691 static vlib_node_registration_t r = {
2692 .function = unix_cli_process,
2693 .type = VLIB_NODE_TYPE_PROCESS,
Dave Barach96e12032016-06-09 15:32:48 -04002694 .process_log2_n_stack_bytes = 16,
Ed Warnickecb9cada2015-12-08 15:45:58 -07002695 };
2696
2697 r.name = name;
2698 vlib_register_node (vm, &r);
2699 vec_free (name);
2700
2701 n = vlib_get_node (vm, r.index);
2702 }
2703
2704 pool_get (cm->cli_file_pool, cf);
2705 memset (cf, 0, sizeof (*cf));
2706
2707 template.read_function = unix_cli_read_ready;
2708 template.write_function = unix_cli_write_ready;
Chris Luke03add7f2017-09-20 23:31:24 -04002709 template.error_function = unix_cli_error_detected;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002710 template.file_descriptor = fd;
2711 template.private_data = cf - cm->cli_file_pool;
Damjan Marionceab7882018-01-19 20:56:12 +01002712 template.description = file_desc;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002713
2714 cf->process_node_index = n->index;
Damjan Marion56dd5432017-09-08 19:52:02 +02002715 cf->clib_file_index = clib_file_add (fm, &template);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002716 cf->output_vector = 0;
2717 cf->input_vector = 0;
2718
Ed Warnickecb9cada2015-12-08 15:45:58 -07002719 vlib_start_process (vm, n->runtime_index);
Andrew Yourtchenko716d9592016-05-10 10:51:34 +00002720
Dave Barach9b8ffd92016-07-08 08:13:45 -04002721 vlib_process_t *p = vlib_get_process_from_node (vm, n);
Andrew Yourtchenko716d9592016-05-10 10:51:34 +00002722 p->output_function = unix_vlib_cli_output;
2723 p->output_function_arg = cf - cm->cli_file_pool;
2724
Ed Warnickecb9cada2015-12-08 15:45:58 -07002725 return cf - cm->cli_file_pool;
2726}
2727
Chris Lukeb5850972016-05-03 16:34:59 -04002728/** Telnet listening socket has a new connection. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002729static clib_error_t *
Damjan Marion56dd5432017-09-08 19:52:02 +02002730unix_cli_listen_read_ready (clib_file_t * uf)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002731{
Dave Barach9b8ffd92016-07-08 08:13:45 -04002732 unix_main_t *um = &unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +02002733 clib_file_main_t *fm = &file_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002734 unix_cli_main_t *cm = &unix_cli_main;
2735 clib_socket_t *s = &um->cli_listen_socket;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002736 clib_socket_t client;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002737 char *client_name;
2738 clib_error_t *error;
2739 unix_cli_file_t *cf;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002740 u32 cf_index;
2741
2742 error = clib_socket_accept (s, &client);
2743 if (error)
2744 return error;
2745
2746 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2747
2748 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2749 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
Chris Luke03add7f2017-09-20 23:31:24 -04002750 cf->is_socket = 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002751
2752 /* No longer need CLIB version of socket. */
2753 clib_socket_free (&client);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002754 vec_free (client_name);
2755
2756 /* if we're supposed to run telnet session in character mode (default) */
2757 if (um->cli_line_mode == 0)
2758 {
Chris Luke0aca5eb2016-04-25 13:48:54 -04002759 /*
2760 * Set telnet client character mode, echo on, suppress "go-ahead".
2761 * Technically these should be negotiated, but this works.
Ed Warnickecb9cada2015-12-08 15:45:58 -07002762 */
Chris Luke0aca5eb2016-04-25 13:48:54 -04002763 u8 charmode_option[] = {
Dave Barach9b8ffd92016-07-08 08:13:45 -04002764 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2765 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2766 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2767 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2768 IAC, WILL, TELOPT_ECHO, /* server will do echo */
2769 IAC, DONT, TELOPT_ECHO, /* client should not echo */
2770 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
2771 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
2772 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
2773 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
Chris Luke0aca5eb2016-04-25 13:48:54 -04002774 };
Ed Warnickecb9cada2015-12-08 15:45:58 -07002775
Chris Luke0aca5eb2016-04-25 13:48:54 -04002776 /* Enable history on this CLI */
Chris Luke7afda3a2016-04-25 13:49:22 -04002777 cf->history_limit = um->cli_history_limit;
2778 cf->has_history = cf->history_limit != 0;
2779
Chris Luke03add7f2017-09-20 23:31:24 -04002780 /* This is an interactive session until we decide otherwise */
2781 cf->is_interactive = 1;
2782
Chris Luke7afda3a2016-04-25 13:49:22 -04002783 /* Make sure this session is in line mode */
2784 cf->line_mode = 0;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002785
2786 /* We need CRLF */
2787 cf->crlf_mode = 1;
2788
Chris Luke7afda3a2016-04-25 13:49:22 -04002789 /* Setup the pager */
2790 cf->no_pager = um->cli_no_pager;
2791
Chris Luke2d8bf302017-11-12 22:26:37 -05002792 /* Default terminal dimensions, should the terminal
2793 * fail to provide any.
2794 */
2795 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2796 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
2797
Chris Luke0aca5eb2016-04-25 13:48:54 -04002798 /* Send the telnet options */
Chris Luke03add7f2017-09-20 23:31:24 -04002799 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
Chris Luke0aca5eb2016-04-25 13:48:54 -04002800 unix_vlib_cli_output_raw (cf, uf, charmode_option,
Dave Barach9b8ffd92016-07-08 08:13:45 -04002801 ARRAY_LEN (charmode_option));
Chris Luke0aca5eb2016-04-25 13:48:54 -04002802
2803 /* In case the client doesn't negotiate terminal type, use
2804 * a timer to kick off the initial prompt. */
2805 timer_call (unix_cli_file_welcome_timer, cf_index, 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002806 }
2807
2808 return error;
2809}
2810
Chris Lukeb5850972016-05-03 16:34:59 -04002811/** The system terminal has informed us that the window size
2812 * has changed.
2813 */
Chris Luke7afda3a2016-04-25 13:49:22 -04002814static void
2815unix_cli_resize_interrupt (int signum)
2816{
Damjan Marion56dd5432017-09-08 19:52:02 +02002817 clib_file_main_t *fm = &file_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002818 unix_cli_main_t *cm = &unix_cli_main;
2819 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
2820 cm->stdin_cli_file_index);
Damjan Marion56dd5432017-09-08 19:52:02 +02002821 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
Chris Luke7afda3a2016-04-25 13:49:22 -04002822 struct winsize ws;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002823 (void) signum;
Chris Luke7afda3a2016-04-25 13:49:22 -04002824
2825 /* Terminal resized, fetch the new size */
Chris Luke03add7f2017-09-20 23:31:24 -04002826 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
Dave Barachb2a6e252016-07-27 10:00:58 -04002827 {
2828 /* "Should never happen..." */
2829 clib_unix_warning ("TIOCGWINSZ");
2830 /* We can't trust ws.XXX... */
2831 return;
2832 }
Chris Lukeb2bcad62017-09-18 08:51:22 -04002833
Chris Luke7afda3a2016-04-25 13:49:22 -04002834 cf->width = ws.ws_col;
Chris Lukeb2bcad62017-09-18 08:51:22 -04002835 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
2836 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
Chris Luke2d8bf302017-11-12 22:26:37 -05002837 if (cf->width == 0)
2838 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
Chris Lukeb2bcad62017-09-18 08:51:22 -04002839
Chris Luke7afda3a2016-04-25 13:49:22 -04002840 cf->height = ws.ws_row;
Chris Lukeb2bcad62017-09-18 08:51:22 -04002841 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
2842 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
Chris Luke2d8bf302017-11-12 22:26:37 -05002843 if (cf->height == 0)
2844 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
Chris Luke862623d2016-05-14 10:13:34 -04002845
2846 /* Reindex the pager buffer */
2847 unix_cli_pager_reindex (cf);
2848
2849 /* Redraw the page */
2850 unix_cli_pager_redraw (cf, uf);
Chris Luke7afda3a2016-04-25 13:49:22 -04002851}
2852
Chris Lukeb5850972016-05-03 16:34:59 -04002853/** Handle configuration directives in the @em unix section. */
Ed Warnickecb9cada2015-12-08 15:45:58 -07002854static clib_error_t *
2855unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
2856{
Dave Barach9b8ffd92016-07-08 08:13:45 -04002857 unix_main_t *um = &unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +02002858 clib_file_main_t *fm = &file_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002859 unix_cli_main_t *cm = &unix_cli_main;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002860 int flags;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002861 clib_error_t *error = 0;
2862 unix_cli_file_t *cf;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002863 u32 cf_index;
2864 struct termios tio;
Chris Luke7afda3a2016-04-25 13:49:22 -04002865 struct sigaction sa;
2866 struct winsize ws;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002867 u8 *term;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002868
2869 /* We depend on unix flags being set. */
2870 if ((error = vlib_call_config_function (vm, unix_config)))
2871 return error;
2872
2873 if (um->flags & UNIX_FLAG_INTERACTIVE)
2874 {
Ed Warnickecb9cada2015-12-08 15:45:58 -07002875 /* Set stdin to be non-blocking. */
Chris Luke03add7f2017-09-20 23:31:24 -04002876 if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002877 flags = 0;
Chris Luke03add7f2017-09-20 23:31:24 -04002878 (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002879
Chris Luke03add7f2017-09-20 23:31:24 -04002880 cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
Chris Luke0aca5eb2016-04-25 13:48:54 -04002881 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
Chris Luke7afda3a2016-04-25 13:49:22 -04002882 cm->stdin_cli_file_index = cf_index;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002883
2884 /* If stdin is a tty and we are using chacracter mode, enable
2885 * history on the CLI and set the tty line discipline accordingly. */
Chris Luke03add7f2017-09-20 23:31:24 -04002886 if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002887 {
2888 /* Capture terminal resize events */
Ed Warnicke853e7202016-08-12 11:42:26 -07002889 memset (&sa, 0, sizeof (sa));
Dave Barach9b8ffd92016-07-08 08:13:45 -04002890 sa.sa_handler = unix_cli_resize_interrupt;
Dave Barach9b8ffd92016-07-08 08:13:45 -04002891 if (sigaction (SIGWINCH, &sa, 0) < 0)
2892 clib_panic ("sigaction");
Chris Luke7afda3a2016-04-25 13:49:22 -04002893
Dave Barach9b8ffd92016-07-08 08:13:45 -04002894 /* Retrieve the current terminal size */
Chris Luke03add7f2017-09-20 23:31:24 -04002895 ioctl (STDIN_FILENO, TIOCGWINSZ, &ws);
Dave Barach9b8ffd92016-07-08 08:13:45 -04002896 cf->width = ws.ws_col;
2897 cf->height = ws.ws_row;
Chris Luke7afda3a2016-04-25 13:49:22 -04002898
Dave Barach9b8ffd92016-07-08 08:13:45 -04002899 if (cf->width == 0 || cf->height == 0)
Dave Barachb66201f2017-09-22 13:34:39 -04002900 {
2901 /*
2902 * We have a tty, but no size. Use defaults.
2903 * vpp "unix interactive" inside emacs + gdb ends up here.
2904 */
Chris Luke2d8bf302017-11-12 22:26:37 -05002905 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2906 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
Dave Barachb66201f2017-09-22 13:34:39 -04002907 }
Chris Luke7afda3a2016-04-25 13:49:22 -04002908
Dave Barach9b8ffd92016-07-08 08:13:45 -04002909 /* Setup the history */
2910 cf->history_limit = um->cli_history_limit;
2911 cf->has_history = cf->history_limit != 0;
Chris Luke7afda3a2016-04-25 13:49:22 -04002912
Dave Barach9b8ffd92016-07-08 08:13:45 -04002913 /* Setup the pager */
2914 cf->no_pager = um->cli_no_pager;
Chris Luke7afda3a2016-04-25 13:49:22 -04002915
Chris Luke03add7f2017-09-20 23:31:24 -04002916 /* This is an interactive session until we decide otherwise */
2917 cf->is_interactive = 1;
2918
Dave Barach9b8ffd92016-07-08 08:13:45 -04002919 /* We're going to be in char by char mode */
2920 cf->line_mode = 0;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002921
Dave Barach9b8ffd92016-07-08 08:13:45 -04002922 /* Save the original tty state so we can restore it later */
Chris Luke03add7f2017-09-20 23:31:24 -04002923 tcgetattr (STDIN_FILENO, &um->tio_stdin);
Dave Barach9b8ffd92016-07-08 08:13:45 -04002924 um->tio_isset = 1;
Chris Luke0aca5eb2016-04-25 13:48:54 -04002925
Dave Barach9b8ffd92016-07-08 08:13:45 -04002926 /* Tweak the tty settings */
2927 tio = um->tio_stdin;
2928 /* echo off, canonical mode off, ext'd input processing off */
2929 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
2930 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
2931 tio.c_cc[VTIME] = 0; /* no timer */
Chris Luke03add7f2017-09-20 23:31:24 -04002932 tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
Chris Luke0aca5eb2016-04-25 13:48:54 -04002933
Dave Barach9b8ffd92016-07-08 08:13:45 -04002934 /* See if we can do ANSI/VT100 output */
2935 term = (u8 *) getenv ("TERM");
2936 if (term != NULL)
Chris Luke03add7f2017-09-20 23:31:24 -04002937 {
2938 int len = strlen ((char *) term);
2939 cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
2940 if (unix_cli_terminal_type_noninteractive (term, len))
2941 unix_cli_set_session_noninteractive (cf);
2942 }
Dave Barach9b8ffd92016-07-08 08:13:45 -04002943 }
Chris Luke7afda3a2016-04-25 13:49:22 -04002944 else
Dave Barach9b8ffd92016-07-08 08:13:45 -04002945 {
Chris Luke03add7f2017-09-20 23:31:24 -04002946 /* No tty, so make sure the session doesn't have tty-like features */
2947 unix_cli_set_session_noninteractive (cf);
Dave Barach9b8ffd92016-07-08 08:13:45 -04002948 }
Chris Luke0aca5eb2016-04-25 13:48:54 -04002949
2950 /* Send banner and initial prompt */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002951 unix_cli_file_welcome (cm, cf);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002952 }
2953
Ed Warnickea25bd1c2016-04-01 22:43:37 -05002954 /* If we have socket config, LISTEN, otherwise, don't */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002955 clib_socket_t *s = &um->cli_listen_socket;
2956 if (s->config && s->config[0] != 0)
2957 {
2958 /* CLI listen. */
Damjan Marion56dd5432017-09-08 19:52:02 +02002959 clib_file_t template = { 0 };
Ed Warnickecb9cada2015-12-08 15:45:58 -07002960
Damjan Marion57d963f2017-07-20 19:17:06 +02002961 /* mkdir of file socketu, only under /run */
2962 if (strncmp (s->config, "/run", 4) == 0)
Chris Luke475674e2017-07-05 18:02:53 -04002963 {
Damjan Marion57d963f2017-07-20 19:17:06 +02002964 u8 *tmp = format (0, "%s", s->config);
2965 int i = vec_len (tmp);
2966 while (i && tmp[--i] != '/')
2967 ;
2968
2969 tmp[i] = 0;
2970
2971 if (i)
2972 vlib_unix_recursive_mkdir ((char *) tmp);
2973 vec_free (tmp);
Chris Luke475674e2017-07-05 18:02:53 -04002974 }
2975
Damjan Marionf49921f2017-09-11 16:52:11 +02002976 s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
2977 CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002978 error = clib_socket_init (s);
Ed Warnickea25bd1c2016-04-01 22:43:37 -05002979
Dave Barach9b8ffd92016-07-08 08:13:45 -04002980 if (error)
2981 return error;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002982
Dave Barach9b8ffd92016-07-08 08:13:45 -04002983 template.read_function = unix_cli_listen_read_ready;
2984 template.file_descriptor = s->fd;
Damjan Marionceab7882018-01-19 20:56:12 +01002985 template.description = format (0, "cli listener %s", s->config);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002986
Damjan Marion56dd5432017-09-08 19:52:02 +02002987 clib_file_add (fm, &template);
Dave Barach9b8ffd92016-07-08 08:13:45 -04002988 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07002989
2990 /* Set CLI prompt. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002991 if (!cm->cli_prompt)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002992 cm->cli_prompt = format (0, "VLIB: ");
2993
2994 return 0;
2995}
2996
Chris Luke90f52bf2016-09-12 08:55:13 -04002997/*?
2998 * This module has no configurable parameters.
2999?*/
Ed Warnickecb9cada2015-12-08 15:45:58 -07003000VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3001
Chris Luke54ccf222016-07-25 16:38:11 -04003002/** Called when VPP is shutting down, this restores the system
3003 * terminal state if previously saved.
Chris Lukeb5850972016-05-03 16:34:59 -04003004 */
Chris Luke0aca5eb2016-04-25 13:48:54 -04003005static clib_error_t *
3006unix_cli_exit (vlib_main_t * vm)
3007{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003008 unix_main_t *um = &unix_main;
Chris Luke0aca5eb2016-04-25 13:48:54 -04003009
3010 /* If stdin is a tty and we saved the tty state, reset the tty state */
Chris Luke03add7f2017-09-20 23:31:24 -04003011 if (isatty (STDIN_FILENO) && um->tio_isset)
3012 tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
Chris Luke0aca5eb2016-04-25 13:48:54 -04003013
3014 return 0;
3015}
3016
3017VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3018
Chris Lukeb5850972016-05-03 16:34:59 -04003019/** Set the CLI prompt.
Chris Luke54ccf222016-07-25 16:38:11 -04003020 * @param prompt The C string to set the prompt to.
Chris Lukeb5850972016-05-03 16:34:59 -04003021 * @note This setting is global; it impacts all current
3022 * and future CLI sessions.
3023 */
Dave Barach9b8ffd92016-07-08 08:13:45 -04003024void
3025vlib_unix_cli_set_prompt (char *prompt)
Ed Warnickecb9cada2015-12-08 15:45:58 -07003026{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003027 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3028 unix_cli_main_t *cm = &unix_cli_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -07003029 if (cm->cli_prompt)
3030 vec_free (cm->cli_prompt);
3031 cm->cli_prompt = format (0, fmt, prompt);
3032}
3033
Chris Lukeb5850972016-05-03 16:34:59 -04003034/** CLI command to quit the terminal session.
3035 * @note If this is a stdin session then this will
3036 * shutdown VPP also.
3037 */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003038static clib_error_t *
3039unix_cli_quit (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04003040 unformat_input_t * input, vlib_cli_command_t * cmd)
Ed Warnickecb9cada2015-12-08 15:45:58 -07003041{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003042 unix_cli_main_t *cm = &unix_cli_main;
Chris Luke03add7f2017-09-20 23:31:24 -04003043 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3044 cm->current_input_file_index);
3045
3046 /* Cosmetic: suppress the final prompt from appearing before we die */
3047 cf->is_interactive = 0;
3048 cf->started = 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -07003049
3050 vlib_process_signal_event (vm,
3051 vlib_current_process (vm),
3052 UNIX_CLI_PROCESS_EVENT_QUIT,
3053 cm->current_input_file_index);
3054 return 0;
3055}
3056
Chris Luke54ccf222016-07-25 16:38:11 -04003057/*?
3058 * Terminates the current CLI session.
3059 *
3060 * If VPP is running in @em interactive mode and this is the console session
3061 * (that is, the session on @c stdin) then this will also terminate VPP.
3062?*/
Dave Barach9b8ffd92016-07-08 08:13:45 -04003063/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003064VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3065 .path = "quit",
3066 .short_help = "Exit CLI",
3067 .function = unix_cli_quit,
3068};
Dave Barach9b8ffd92016-07-08 08:13:45 -04003069/* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003070
Florin Coras33d16292018-03-16 09:13:37 -07003071/* *INDENT-OFF* */
3072VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3073 .path = "q",
3074 .short_help = "Exit CLI",
3075 .function = unix_cli_quit,
3076};
3077/* *INDENT-ON* */
3078
Chris Lukeb5850972016-05-03 16:34:59 -04003079/** CLI command to execute a VPP command script. */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003080static clib_error_t *
3081unix_cli_exec (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04003082 unformat_input_t * input, vlib_cli_command_t * cmd)
Ed Warnickecb9cada2015-12-08 15:45:58 -07003083{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003084 char *file_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -07003085 int fd;
3086 unformat_input_t sub_input;
Dave Barach9b8ffd92016-07-08 08:13:45 -04003087 clib_error_t *error;
Ed Warnickecb9cada2015-12-08 15:45:58 -07003088
3089 file_name = 0;
3090 fd = -1;
3091 error = 0;
3092
Dave Barach9b8ffd92016-07-08 08:13:45 -04003093 if (!unformat (input, "%s", &file_name))
Ed Warnickecb9cada2015-12-08 15:45:58 -07003094 {
3095 error = clib_error_return (0, "expecting file name, got `%U'",
3096 format_unformat_error, input);
3097 goto done;
3098 }
3099
3100 fd = open (file_name, O_RDONLY);
3101 if (fd < 0)
3102 {
3103 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3104 goto done;
3105 }
3106
3107 /* Make sure its a regular file. */
3108 {
3109 struct stat s;
3110
3111 if (fstat (fd, &s) < 0)
3112 {
3113 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3114 goto done;
3115 }
Dave Barach9b8ffd92016-07-08 08:13:45 -04003116
3117 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
Ed Warnickecb9cada2015-12-08 15:45:58 -07003118 {
3119 error = clib_error_return (0, "not a regular file `%s'", file_name);
3120 goto done;
3121 }
3122 }
3123
Dave Barach59b25652017-09-10 15:04:27 -04003124 unformat_init_clib_file (&sub_input, fd);
Ed Warnickecb9cada2015-12-08 15:45:58 -07003125
3126 vlib_cli_input (vm, &sub_input, 0, 0);
3127 unformat_free (&sub_input);
3128
Dave Barach9b8ffd92016-07-08 08:13:45 -04003129done:
Ed Warnickecb9cada2015-12-08 15:45:58 -07003130 if (fd > 0)
3131 close (fd);
3132 vec_free (file_name);
3133
3134 return error;
3135}
3136
Chris Luke54ccf222016-07-25 16:38:11 -04003137/*?
Billy McFall28cf3b72018-01-15 17:54:52 -05003138 * Executes a sequence of CLI commands which are read from a file. If
3139 * a command is unrecognised or otherwise invalid then the usual CLI
Chris Luke54ccf222016-07-25 16:38:11 -04003140 * feedback will be generated, however execution of subsequent commands
3141 * from the file will continue.
Billy McFall28cf3b72018-01-15 17:54:52 -05003142 *
3143 * The VPP code is indifferent to the file location. However, if SELinux
3144 * is enabled, then the file needs to have an SELinux label the VPP
3145 * process is allowed to access. For example, if a file is created in
3146 * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3147 * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3148 * process when SELinux is enabled.
3149 *
3150 * @cliexpar
3151 * Sample file:
3152 * @clistart
3153 * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3154 * set interface state GigabitEthernet0/8/0 up
3155 * set interface state GigabitEthernet0/9/0 up
3156 * @cliend
3157 * Example of how to execute a set of CLI commands from a file:
3158 * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
Chris Luke54ccf222016-07-25 16:38:11 -04003159?*/
Dave Barach9b8ffd92016-07-08 08:13:45 -04003160/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003161VLIB_CLI_COMMAND (cli_exec, static) = {
3162 .path = "exec",
Billy McFall28cf3b72018-01-15 17:54:52 -05003163 .short_help = "exec <filename>",
Ed Warnickecb9cada2015-12-08 15:45:58 -07003164 .function = unix_cli_exec,
Dave Barachb2ef4dd2016-03-23 08:56:01 -04003165 .is_mp_safe = 1,
Ed Warnickecb9cada2015-12-08 15:45:58 -07003166};
Dave Barach9b8ffd92016-07-08 08:13:45 -04003167/* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003168
Chris Lukeb5850972016-05-03 16:34:59 -04003169/** CLI command to show various unix error statistics. */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003170static clib_error_t *
3171unix_show_errors (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04003172 unformat_input_t * input, vlib_cli_command_t * cmd)
Ed Warnickecb9cada2015-12-08 15:45:58 -07003173{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003174 unix_main_t *um = &unix_main;
3175 clib_error_t *error = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -07003176 int i, n_errors_to_show;
Dave Barach9b8ffd92016-07-08 08:13:45 -04003177 unix_error_history_t *unix_errors = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -07003178
3179 n_errors_to_show = 1 << 30;
3180
3181 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3182 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04003183 if (!unformat (input, "%d", &n_errors_to_show))
Ed Warnickecb9cada2015-12-08 15:45:58 -07003184 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04003185 error =
3186 clib_error_return (0,
3187 "expecting integer number of errors to show, got `%U'",
3188 format_unformat_error, input);
Ed Warnickecb9cada2015-12-08 15:45:58 -07003189 goto done;
3190 }
3191 }
3192
Dave Barach9b8ffd92016-07-08 08:13:45 -04003193 n_errors_to_show =
3194 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
Ed Warnickecb9cada2015-12-08 15:45:58 -07003195
Dave Barach9b8ffd92016-07-08 08:13:45 -04003196 i =
3197 um->error_history_index >
3198 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -07003199
3200 while (n_errors_to_show > 0)
3201 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04003202 unix_error_history_t *eh = um->error_history + i;
Ed Warnickecb9cada2015-12-08 15:45:58 -07003203
Dave Barach9b8ffd92016-07-08 08:13:45 -04003204 if (!eh->error)
Ed Warnickecb9cada2015-12-08 15:45:58 -07003205 break;
3206
3207 vec_add1 (unix_errors, eh[0]);
3208 n_errors_to_show -= 1;
3209 if (i == 0)
3210 i = ARRAY_LEN (um->error_history) - 1;
3211 else
3212 i--;
3213 }
3214
3215 if (vec_len (unix_errors) == 0)
3216 vlib_cli_output (vm, "no Unix errors so far");
3217 else
3218 {
3219 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3220 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3221 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04003222 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
Ed Warnickecb9cada2015-12-08 15:45:58 -07003223 vlib_cli_output (vm, "%U: %U",
3224 format_time_interval, "h:m:s:u", eh->time,
3225 format_clib_error, eh->error);
3226 }
3227 vlib_cli_output (vm, "%U: time now",
3228 format_time_interval, "h:m:s:u", vlib_time_now (vm));
3229 }
3230
Dave Barach9b8ffd92016-07-08 08:13:45 -04003231done:
Ed Warnickecb9cada2015-12-08 15:45:58 -07003232 vec_free (unix_errors);
3233 return error;
3234}
3235
Dave Barach9b8ffd92016-07-08 08:13:45 -04003236/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003237VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
Damjan Marionceab7882018-01-19 20:56:12 +01003238 .path = "show unix errors",
Ed Warnickecb9cada2015-12-08 15:45:58 -07003239 .short_help = "Show Unix system call error history",
3240 .function = unix_show_errors,
3241};
Dave Barach9b8ffd92016-07-08 08:13:45 -04003242/* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003243
Damjan Marionceab7882018-01-19 20:56:12 +01003244/** CLI command to show various unix error statistics. */
3245static clib_error_t *
3246unix_show_files (vlib_main_t * vm,
3247 unformat_input_t * input, vlib_cli_command_t * cmd)
3248{
3249 clib_error_t *error = 0;
3250 clib_file_main_t *fm = &file_main;
3251 clib_file_t *f;
3252 char path[PATH_MAX];
3253 u8 *s = 0;
3254
3255 vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3256 "Read", "Write", "Error", "File Name", "Description");
3257
3258 /* *INDENT-OFF* */
3259 pool_foreach (f, fm->file_pool,(
3260 {
3261 int rv;
3262 s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3263 rv = readlink((char *) s, path, PATH_MAX - 1);
3264
3265 path[rv < 0 ? 0 : rv] = 0;
3266
3267 vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3268 f->file_descriptor, f->polling_thread_index,
3269 f->read_events, f->write_events, f->error_events,
3270 path, f->description);
3271 vec_reset_length (s);
3272 }));
3273 /* *INDENT-ON* */
3274 vec_free (s);
3275
3276 return error;
3277}
3278
3279/* *INDENT-OFF* */
3280VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3281 .path = "show unix files",
3282 .short_help = "Show Unix files in use",
3283 .function = unix_show_files,
3284};
3285/* *INDENT-ON* */
3286
Chris Lukeb5850972016-05-03 16:34:59 -04003287/** CLI command to show session command history. */
Ed Warnickecb9cada2015-12-08 15:45:58 -07003288static clib_error_t *
Chris Luke6b90fe32016-04-25 13:49:15 -04003289unix_cli_show_history (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04003290 unformat_input_t * input, vlib_cli_command_t * cmd)
Chris Luke6b90fe32016-04-25 13:49:15 -04003291{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003292 unix_cli_main_t *cm = &unix_cli_main;
3293 unix_cli_file_t *cf;
Chris Luke6b90fe32016-04-25 13:49:15 -04003294 int i, j;
3295
3296 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3297
Chris Luke03add7f2017-09-20 23:31:24 -04003298 if (!cf->is_interactive)
3299 return clib_error_return (0, "invalid for non-interactive sessions");
3300
Chris Luke7afda3a2016-04-25 13:49:22 -04003301 if (cf->has_history && cf->history_limit)
Chris Luke6b90fe32016-04-25 13:49:15 -04003302 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04003303 i = 1 + cf->command_number - vec_len (cf->command_history);
Chris Luke7afda3a2016-04-25 13:49:22 -04003304 for (j = 0; j < vec_len (cf->command_history); j++)
Dave Barach9b8ffd92016-07-08 08:13:45 -04003305 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
Chris Luke7afda3a2016-04-25 13:49:22 -04003306 }
3307 else
3308 {
3309 vlib_cli_output (vm, "History not enabled.\n");
Chris Luke6b90fe32016-04-25 13:49:15 -04003310 }
3311
3312 return 0;
3313}
3314
Chris Luke54ccf222016-07-25 16:38:11 -04003315/*?
3316 * Displays the command history for the current session, if any.
3317?*/
Dave Barach9b8ffd92016-07-08 08:13:45 -04003318/* *INDENT-OFF* */
Chris Luke6b90fe32016-04-25 13:49:15 -04003319VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3320 .path = "history",
3321 .short_help = "Show current session command history",
3322 .function = unix_cli_show_history,
3323};
Dave Barach9b8ffd92016-07-08 08:13:45 -04003324/* *INDENT-ON* */
Chris Luke6b90fe32016-04-25 13:49:15 -04003325
Chris Lukeb5850972016-05-03 16:34:59 -04003326/** CLI command to show terminal status. */
Chris Luke7afda3a2016-04-25 13:49:22 -04003327static clib_error_t *
3328unix_cli_show_terminal (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04003329 unformat_input_t * input, vlib_cli_command_t * cmd)
Chris Luke7afda3a2016-04-25 13:49:22 -04003330{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003331 unix_main_t *um = &unix_main;
3332 unix_cli_main_t *cm = &unix_cli_main;
3333 unix_cli_file_t *cf;
3334 vlib_node_t *n;
Chris Luke7afda3a2016-04-25 13:49:22 -04003335
3336 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3337 n = vlib_get_node (vm, cf->process_node_index);
3338
3339 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
Dave Barach9b8ffd92016-07-08 08:13:45 -04003340 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3341 "line-by-line" : "char-by-char");
Chris Luke7afda3a2016-04-25 13:49:22 -04003342 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3343 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
Dave Barach9b8ffd92016-07-08 08:13:45 -04003344 vlib_cli_output (vm, "ANSI capable: %s\n",
3345 cf->ansi_capable ? "yes" : "no");
Chris Luke03add7f2017-09-20 23:31:24 -04003346 vlib_cli_output (vm, "Interactive: %s\n",
3347 cf->is_interactive ? "yes" : "no");
Chris Luke7afda3a2016-04-25 13:49:22 -04003348 vlib_cli_output (vm, "History enabled: %s%s\n",
Dave Barach9b8ffd92016-07-08 08:13:45 -04003349 cf->has_history ? "yes" : "no", !cf->has_history
3350 || cf->history_limit ? "" :
3351 " (disabled by history limit)");
Chris Luke7afda3a2016-04-25 13:49:22 -04003352 if (cf->has_history)
3353 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3354 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
Dave Barach9b8ffd92016-07-08 08:13:45 -04003355 cf->no_pager ? "no" : "yes",
3356 cf->no_pager
3357 || cf->height ? "" : " (disabled by terminal height)",
3358 cf->no_pager
3359 || um->cli_pager_buffer_limit ? "" :
3360 " (disabled by buffer limit)");
Chris Luke7afda3a2016-04-25 13:49:22 -04003361 if (!cf->no_pager)
3362 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
Dave Barach9b8ffd92016-07-08 08:13:45 -04003363 vlib_cli_output (vm, "CRLF mode: %s\n",
3364 cf->crlf_mode ? "CR+LF" : "LF");
Chris Luke7afda3a2016-04-25 13:49:22 -04003365
3366 return 0;
3367}
3368
Chris Luke54ccf222016-07-25 16:38:11 -04003369/*?
3370 * Displays various information about the state of the current terminal
3371 * session.
3372 *
3373 * @cliexpar
3374 * @cliexstart{show terminal}
3375 * Terminal name: unix-cli-stdin
3376 * Terminal mode: char-by-char
3377 * Terminal width: 123
3378 * Terminal height: 48
3379 * ANSI capable: yes
Chris Luke03add7f2017-09-20 23:31:24 -04003380 * Interactive: yes
Chris Luke54ccf222016-07-25 16:38:11 -04003381 * History enabled: yes
3382 * History limit: 50
3383 * Pager enabled: yes
3384 * Pager limit: 100000
3385 * CRLF mode: LF
3386 * @cliexend
3387?*/
Dave Barach9b8ffd92016-07-08 08:13:45 -04003388/* *INDENT-OFF* */
Chris Luke7afda3a2016-04-25 13:49:22 -04003389VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3390 .path = "show terminal",
3391 .short_help = "Show current session terminal settings",
3392 .function = unix_cli_show_terminal,
3393};
Dave Barach9b8ffd92016-07-08 08:13:45 -04003394/* *INDENT-ON* */
Chris Luke7afda3a2016-04-25 13:49:22 -04003395
Chris Luke03add7f2017-09-20 23:31:24 -04003396/** CLI command to display a list of CLI sessions. */
3397static clib_error_t *
3398unix_cli_show_cli_sessions (vlib_main_t * vm,
3399 unformat_input_t * input,
3400 vlib_cli_command_t * cmd)
3401{
Chris Luke03add7f2017-09-20 23:31:24 -04003402 unix_cli_main_t *cm = &unix_cli_main;
3403 clib_file_main_t *fm = &file_main;
3404 unix_cli_file_t *cf;
3405 clib_file_t *uf;
3406 vlib_node_t *n;
3407
3408 vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3409
3410#define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3411 /* *INDENT-OFF* */
3412 pool_foreach (cf, cm->cli_file_pool, ({
3413 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3414 n = vlib_get_node (vm, cf->process_node_index);
3415 vlib_cli_output (vm,
3416 "%-5d %-5d %-20v %c%c%c%c%c\n",
3417 cf->process_node_index,
3418 uf->file_descriptor,
3419 n->name,
3420 fl (cf->is_interactive, 'i'),
3421 fl (cf->is_socket, 's'),
3422 fl (cf->line_mode, 'l'),
3423 fl (cf->has_epipe, 'p'),
3424 fl (cf->ansi_capable, 'a'));
3425 }));
3426 /* *INDENT-ON* */
3427#undef fl
3428
3429 return 0;
3430}
3431
3432/*?
3433 * Displays a summary of all the current CLI sessions.
3434 *
3435 * Typically used to diagnose connection issues with the CLI
3436 * socket.
3437 *
3438 * @cliexpar
3439 * @cliexstart{show cli-sessions}
3440 * PNI FD Name Flags
3441 * 343 0 unix-cli-stdin IslpA
3442 * 344 7 unix-cli-local:20 ISlpA
3443 * 346 8 unix-cli-local:21 iSLpa
3444 * @cliexend
3445
3446 * In this example we have the debug console of the running process
3447 * on stdin/out, we have an interactive socket session and we also
3448 * have a non-interactive socket session.
3449 *
3450 * Fields:
3451 *
3452 * - @em PNI: Process node index.
3453 * - @em FD: Unix file descriptor.
3454 * - @em Name: Name of the session.
3455 * - @em Flags: Various flags that describe the state of the session.
3456 *
3457 * @em Flags have the following meanings; lower-case typically negates
3458 * upper-case:
3459 *
3460 * - @em I Interactive session.
3461 * - @em S Connected by socket.
3462 * - @em s Not a socket, likely stdin.
3463 * - @em L Line-by-line mode.
3464 * - @em l Char-by-char mode.
3465 * - @em P EPIPE detected on connection; it will close soon.
3466 * - @em A ANSI-capable terminal.
3467?*/
3468/* *INDENT-OFF* */
3469VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3470 .path = "show cli-sessions",
3471 .short_help = "Show current CLI sessions",
3472 .function = unix_cli_show_cli_sessions,
3473};
3474/* *INDENT-ON* */
3475
Chris Lukeb5850972016-05-03 16:34:59 -04003476/** CLI command to set terminal pager settings. */
Chris Luke7afda3a2016-04-25 13:49:22 -04003477static clib_error_t *
3478unix_cli_set_terminal_pager (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04003479 unformat_input_t * input,
3480 vlib_cli_command_t * cmd)
Chris Luke7afda3a2016-04-25 13:49:22 -04003481{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003482 unix_main_t *um = &unix_main;
3483 unix_cli_main_t *cm = &unix_cli_main;
3484 unix_cli_file_t *cf;
3485 unformat_input_t _line_input, *line_input = &_line_input;
Billy McFalla9a20e72017-02-15 11:39:12 -05003486 clib_error_t *error = 0;
Chris Luke7afda3a2016-04-25 13:49:22 -04003487
Chris Luke03add7f2017-09-20 23:31:24 -04003488 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3489
3490 if (!cf->is_interactive)
3491 return clib_error_return (0, "invalid for non-interactive sessions");
3492
Dave Barach9b8ffd92016-07-08 08:13:45 -04003493 if (!unformat_user (input, unformat_line_input, line_input))
Chris Luke7afda3a2016-04-25 13:49:22 -04003494 return 0;
3495
Chris Luke7afda3a2016-04-25 13:49:22 -04003496 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3497 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04003498 if (unformat (line_input, "on"))
3499 cf->no_pager = 0;
3500 else if (unformat (line_input, "off"))
3501 cf->no_pager = 1;
3502 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3503 vlib_cli_output (vm,
3504 "Pager limit set to %u lines; note, this is global.\n",
3505 um->cli_pager_buffer_limit);
3506 else
Billy McFalla9a20e72017-02-15 11:39:12 -05003507 {
3508 error = clib_error_return (0, "unknown parameter: `%U`",
3509 format_unformat_error, line_input);
3510 goto done;
3511 }
Dave Barach9b8ffd92016-07-08 08:13:45 -04003512 }
Chris Luke7afda3a2016-04-25 13:49:22 -04003513
Billy McFalla9a20e72017-02-15 11:39:12 -05003514done:
Dave Barach9b8ffd92016-07-08 08:13:45 -04003515 unformat_free (line_input);
Chris Luke7afda3a2016-04-25 13:49:22 -04003516
Billy McFalla9a20e72017-02-15 11:39:12 -05003517 return error;
Chris Luke7afda3a2016-04-25 13:49:22 -04003518}
3519
Chris Luke54ccf222016-07-25 16:38:11 -04003520/*?
3521 * Enables or disables the terminal pager for this session. Generally
3522 * this defaults to enabled.
3523 *
3524 * Additionally allows the pager buffer size to be set; though note that
3525 * this value is set globally and not per session.
3526?*/
Dave Barach9b8ffd92016-07-08 08:13:45 -04003527/* *INDENT-OFF* */
Chris Luke7afda3a2016-04-25 13:49:22 -04003528VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3529 .path = "set terminal pager",
3530 .short_help = "set terminal pager [on|off] [limit <lines>]",
3531 .function = unix_cli_set_terminal_pager,
3532};
Dave Barach9b8ffd92016-07-08 08:13:45 -04003533/* *INDENT-ON* */
Chris Luke7afda3a2016-04-25 13:49:22 -04003534
Chris Lukeb5850972016-05-03 16:34:59 -04003535/** CLI command to set terminal history settings. */
Chris Luke7afda3a2016-04-25 13:49:22 -04003536static clib_error_t *
3537unix_cli_set_terminal_history (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04003538 unformat_input_t * input,
3539 vlib_cli_command_t * cmd)
Chris Luke7afda3a2016-04-25 13:49:22 -04003540{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003541 unix_cli_main_t *cm = &unix_cli_main;
3542 unix_cli_file_t *cf;
3543 unformat_input_t _line_input, *line_input = &_line_input;
Chris Luke7afda3a2016-04-25 13:49:22 -04003544 u32 limit;
Billy McFalla9a20e72017-02-15 11:39:12 -05003545 clib_error_t *error = 0;
Chris Luke7afda3a2016-04-25 13:49:22 -04003546
Chris Luke03add7f2017-09-20 23:31:24 -04003547 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3548
3549 if (!cf->is_interactive)
3550 return clib_error_return (0, "invalid for non-interactive sessions");
3551
Dave Barach9b8ffd92016-07-08 08:13:45 -04003552 if (!unformat_user (input, unformat_line_input, line_input))
Chris Luke7afda3a2016-04-25 13:49:22 -04003553 return 0;
3554
Chris Luke7afda3a2016-04-25 13:49:22 -04003555 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3556 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04003557 if (unformat (line_input, "on"))
3558 cf->has_history = 1;
3559 else if (unformat (line_input, "off"))
3560 cf->has_history = 0;
3561 else if (unformat (line_input, "limit %u", &cf->history_limit))
3562 ;
3563 else
Billy McFalla9a20e72017-02-15 11:39:12 -05003564 {
3565 error = clib_error_return (0, "unknown parameter: `%U`",
3566 format_unformat_error, line_input);
3567 goto done;
3568 }
Chris Luke7afda3a2016-04-25 13:49:22 -04003569
Dave Barach9b8ffd92016-07-08 08:13:45 -04003570 /* If we reduced history size, or turned it off, purge the history */
3571 limit = cf->has_history ? cf->history_limit : 0;
Chris Luke7afda3a2016-04-25 13:49:22 -04003572
Dave Barach9b8ffd92016-07-08 08:13:45 -04003573 while (cf->command_history && vec_len (cf->command_history) >= limit)
3574 {
3575 vec_free (cf->command_history[0]);
3576 vec_delete (cf->command_history, 1, 0);
3577 }
3578 }
Chris Luke7afda3a2016-04-25 13:49:22 -04003579
Billy McFalla9a20e72017-02-15 11:39:12 -05003580done:
Dave Barach9b8ffd92016-07-08 08:13:45 -04003581 unformat_free (line_input);
Chris Luke7afda3a2016-04-25 13:49:22 -04003582
Billy McFalla9a20e72017-02-15 11:39:12 -05003583 return error;
Chris Luke7afda3a2016-04-25 13:49:22 -04003584}
3585
Chris Luke54ccf222016-07-25 16:38:11 -04003586/*?
3587 * Enables or disables the command history function of the current
3588 * terminal. Generally this defaults to enabled.
3589 *
3590 * This command also allows the maximum size of the history buffer for
3591 * this session to be altered.
3592?*/
Dave Barach9b8ffd92016-07-08 08:13:45 -04003593/* *INDENT-OFF* */
Chris Luke7afda3a2016-04-25 13:49:22 -04003594VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3595 .path = "set terminal history",
3596 .short_help = "set terminal history [on|off] [limit <lines>]",
3597 .function = unix_cli_set_terminal_history,
3598};
Dave Barach9b8ffd92016-07-08 08:13:45 -04003599/* *INDENT-ON* */
Chris Luke7afda3a2016-04-25 13:49:22 -04003600
Chris Lukeb5850972016-05-03 16:34:59 -04003601/** CLI command to set terminal ANSI settings. */
Chris Luke7afda3a2016-04-25 13:49:22 -04003602static clib_error_t *
3603unix_cli_set_terminal_ansi (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04003604 unformat_input_t * input,
3605 vlib_cli_command_t * cmd)
Chris Luke7afda3a2016-04-25 13:49:22 -04003606{
Dave Barach9b8ffd92016-07-08 08:13:45 -04003607 unix_cli_main_t *cm = &unix_cli_main;
3608 unix_cli_file_t *cf;
Chris Luke7afda3a2016-04-25 13:49:22 -04003609
3610 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3611
Chris Luke03add7f2017-09-20 23:31:24 -04003612 if (!cf->is_interactive)
3613 return clib_error_return (0, "invalid for non-interactive sessions");
3614
Chris Luke7afda3a2016-04-25 13:49:22 -04003615 if (unformat (input, "on"))
3616 cf->ansi_capable = 1;
3617 else if (unformat (input, "off"))
3618 cf->ansi_capable = 0;
3619 else
3620 return clib_error_return (0, "unknown parameter: `%U`",
Dave Barach9b8ffd92016-07-08 08:13:45 -04003621 format_unformat_error, input);
Chris Luke7afda3a2016-04-25 13:49:22 -04003622
3623 return 0;
3624}
3625
Chris Luke54ccf222016-07-25 16:38:11 -04003626/*?
3627 * Enables or disables the use of ANSI control sequences by this terminal.
3628 * The default will vary based on terminal detection at the start of the
3629 * session.
3630 *
3631 * ANSI control sequences are used in a small number of places to provide,
3632 * for example, color text output and to control the cursor in the pager.
3633?*/
Dave Barach9b8ffd92016-07-08 08:13:45 -04003634/* *INDENT-OFF* */
Chris Luke7afda3a2016-04-25 13:49:22 -04003635VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3636 .path = "set terminal ansi",
3637 .short_help = "set terminal ansi [on|off]",
3638 .function = unix_cli_set_terminal_ansi,
3639};
Dave Barach9b8ffd92016-07-08 08:13:45 -04003640/* *INDENT-ON* */
Chris Luke6b90fe32016-04-25 13:49:15 -04003641
3642static clib_error_t *
Ed Warnickecb9cada2015-12-08 15:45:58 -07003643unix_cli_init (vlib_main_t * vm)
3644{
3645 return 0;
3646}
3647
3648VLIB_INIT_FUNCTION (unix_cli_init);
Dave Barach9b8ffd92016-07-08 08:13:45 -04003649
3650/*
3651 * fd.io coding-style-patch-verification: ON
3652 *
3653 * Local Variables:
3654 * eval: (c-set-style "gnu")
3655 * End:
3656 */