+// SPDX-License-Identifier: GPL-2.0
+
/*
* Copyright (C) 2001 Cluster File Systems, Inc.
*
* Copyright (c) 2014, 2017, Intel Corporation.
*
- * This file is part of Lustre, http://www.sf.net/projects/lustre/
- *
- * Lustre is free software; you can redistribute it and/or
- * modify it under the terms of version 2 of the GNU General Public
- * License as published by the Free Software Foundation.
+ */
+
+/*
+ * This file is part of Lustre, http://www.lustre.org/
*
- * Lustre is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * libcfs/libcfs/parser.c
*
- * You should have received a copy of the GNU General Public License
- * along with Lustre; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * A command line parser.
*
*/
#include <libcfs/util/parser.h>
#include <linux/lustre/lustre_ver.h>
-static command_t * top_level; /* Top level of commands, initialized by
- * InitParser */
-static char * parser_prompt = NULL;/* Parser prompt, set by InitParser */
-static int done; /* Set to 1 if user types exit or quit */
-static int ignore_errors; /* Normally, the parser will quit when
- an error occurs in non-interacive
- mode. Setting this to non-zero will
- force it to keep buggering on. */
-
+/* Top level of commands */
+static command_t top_level[MAXCMDS];
+/* Set to 1 if user types exit or quit */
+static int done;
+/*
+ * Normally, the parser will quit when an error occurs in non-interacive
+ * mode. Setting this to non-zero will force it to keep buggering on.
+ */
+static int ignore_errors;
-/* static functions */
static char *skipwhitespace(char *s);
static char *skiptowhitespace(char *s);
static command_t *find_cmd(char *name, command_t cmds[], char **next);
static int process(char *s, char **next, command_t *lookup, command_t **result,
char **prev);
-
-static char * skipwhitespace(char * s)
+static int line2args(char *line, char **argv, int maxargs);
+static int cfs_parser_commands(command_t *cmds);
+static int cfs_parser_execarg(int argc, char **argv, command_t cmds[]);
+static int cfs_parser_list_commands(const command_t *cmdlist, int line_len,
+ int col_num);
+static int cfs_parser_list(int argc, char **argv);
+static int cfs_parser_help(int argc, char **argv);
+static int cfs_parser_quit(int argc, char **argv);
+static int cfs_parser_version(int argc, char **argv);
+static int cfs_parser_ignore_errors(int argc, char **argv);
+
+command_t override_cmdlist[] = {
+ { .pc_name = "quit", .pc_func = cfs_parser_quit, .pc_help = "quit" },
+ { .pc_name = "exit", .pc_func = cfs_parser_quit, .pc_help = "exit" },
+ { .pc_name = "help", .pc_func = cfs_parser_help,
+ .pc_help = "provide useful information about a command" },
+ { .pc_name = "--help", .pc_func = cfs_parser_help,
+ .pc_help = "provide useful information about a command" },
+ { .pc_name = "version", .pc_func = cfs_parser_version,
+ .pc_help = "show program version" },
+ { .pc_name = "--version", .pc_func = cfs_parser_version,
+ .pc_help = "show program version" },
+ { .pc_name = "list-commands", .pc_func = cfs_parser_list,
+ .pc_help = "list available commands" },
+ { .pc_name = "--list-commands", .pc_func = cfs_parser_list,
+ .pc_help = "list available commands" },
+ { .pc_name = "--ignore_errors", .pc_func = cfs_parser_ignore_errors,
+ .pc_help = "ignore errors that occur during script processing"},
+ { .pc_name = "ignore_errors", .pc_func = cfs_parser_ignore_errors,
+ .pc_help = "ignore errors that occur during script processing"},
+ { .pc_name = 0, .pc_func = NULL, .pc_help = 0 }
+};
+
+static char *skipwhitespace(char *s)
{
- char * t;
- int len;
+ char *t;
+ int len;
- len = (int)strlen(s);
- for (t = s; t <= s + len && isspace(*t); t++);
- return(t);
+ len = (int)strlen(s);
+ for (t = s; t <= s + len && isspace(*t); t++)
+ ;
+ return t;
}
-
-static char * skiptowhitespace(char * s)
+static char *skiptowhitespace(char *s)
{
- char * t;
+ char *t;
- for (t = s; *t && !isspace(*t); t++);
- return(t);
+ for (t = s; *t && !isspace(*t); t++)
+ ;
+ return t;
}
static int line2args(char *line, char **argv, int maxargs)
int i = 0;
arg = strtok(line, " \t");
- if (arg == NULL || maxargs < 1)
+ if (!arg || maxargs < 1)
return 0;
argv[i++] = arg;
}
/* find a command -- return it if unique otherwise print alternatives */
-static command_t *Parser_findargcmd(char *name, command_t cmds[])
+static command_t *cfs_parser_findargcmd(char *name, command_t cmds[])
{
- command_t *cmd;
+ command_t *cmd;
+
+ for (cmd = cmds; cmd->pc_name; cmd++) {
+ if (strcmp(name, cmd->pc_name) == 0)
+ return cmd;
+ }
+ return NULL;
+}
+
+static int cfs_parser_ignore_errors(int argc, char **argv)
+{
+ (void) argc;
+ (void) argv;
+
+ ignore_errors = 1;
- for (cmd = cmds; cmd->pc_name; cmd++) {
- if (strcmp(name, cmd->pc_name) == 0)
- return cmd;
- }
- return NULL;
+ return 0;
}
-void Parser_ignore_errors(int ignore)
+int cfs_parser(int argc, char **argv, command_t cmds[])
{
- ignore_errors = ignore;
+ command_t *cmd;
+ int rc = 0;
+ int i = 0;
+
+ done = 0;
+
+ for (cmd = override_cmdlist; cmd->pc_name && i < MAXCMDS; cmd++)
+ top_level[i++] = *cmd;
+
+ for (cmd = cmds; cmd->pc_name && i < MAXCMDS; cmd++)
+ top_level[i++] = *cmd;
+
+ if (argc > 1)
+ rc = cfs_parser_execarg(argc - 1, argv + 1, cmds);
+ else
+ rc = cfs_parser_commands(cmds);
+
+ return rc;
}
-int Parser_execarg(int argc, char **argv, command_t cmds[])
+static int cfs_parser_execarg(int argc, char **argv, command_t cmds[])
{
command_t *cmd;
- cmd = Parser_findargcmd(argv[0], cmds);
- if (cmd != NULL && cmd->pc_func != NULL) {
- int rc = (cmd->pc_func)(argc, argv);
- if (rc == CMD_HELP)
- fprintf(stderr, "%s\n", cmd->pc_help);
+ cmd = cfs_parser_findargcmd(argv[0], override_cmdlist);
+
+ if (!cmd)
+ cmd = cfs_parser_findargcmd(argv[0], cmds);
+
+ if (cmd && cmd->pc_func) {
+ int rc = cmd->pc_func(argc, argv);
+
+ if (rc == CMD_HELP) {
+ fprintf(stdout, "%s\n", cmd->pc_help);
+ fflush(stdout);
+ }
return rc;
- } else {
- printf("Try interactive use without arguments or use one of:\n");
- for (cmd = cmds; cmd->pc_name; cmd++)
- printf("\"%s\"\n", cmd->pc_name);
- printf("as argument.\n");
}
+
+ fprintf(stderr,
+ "%s: '%s' is not a valid command. See '%s --list-commands'.\n",
+ program_invocation_short_name, argv[0],
+ program_invocation_short_name);
+
return -1;
}
-/* returns the command_t * (NULL if not found) corresponding to a
- _partial_ match with the first token in name. It sets *next to
- point to the following token. Does not modify *name. */
-static command_t * find_cmd(char * name, command_t cmds[], char ** next)
+/*
+ * Returns the command_t * (NULL if not found) corresponding to a
+ * _partial_ match with the first token in name. It sets *next to
+ * point to the following token. Does not modify *name.
+ */
+static command_t *find_cmd(char *name, command_t cmds[], char **next)
{
- int i, len;
-
- if (!cmds || !name )
- return NULL;
-
- /* This sets name to point to the first non-white space character,
- and next to the first whitespace after name, len to the length: do
- this with strtok*/
- name = skipwhitespace(name);
- *next = skiptowhitespace(name);
- len = (int)(*next - name);
- if (len == 0)
- return NULL;
-
- for (i = 0; cmds[i].pc_name; i++) {
- if (strncasecmp(name, cmds[i].pc_name, len) == 0) {
- *next = skipwhitespace(*next);
- return(&cmds[i]);
- }
- }
- return NULL;
+ int i, len;
+
+ if (!cmds || !name)
+ return NULL;
+
+ /*
+ * This sets name to point to the first non-white space character,
+ * and next to the first whitespace after name, len to the length: do
+ * this with strtok
+ */
+ name = skipwhitespace(name);
+ *next = skiptowhitespace(name);
+ len = (int)(*next - name);
+ if (len == 0)
+ return NULL;
+
+ for (i = 0; cmds[i].pc_name; i++) {
+ if (strncasecmp(name, cmds[i].pc_name, len) == 0) {
+ *next = skipwhitespace(*next);
+ return &cmds[i];
+ }
+ }
+ return NULL;
}
-/* Recursively process a command line string s and find the command
- corresponding to it. This can be ambiguous, full, incomplete,
- non-existent. */
-static int process(char *s, char ** next, command_t *lookup,
- command_t **result, char **prev)
+/*
+ * Recursively process a command line string s and find the command
+ * corresponding to it. This can be ambiguous, full, incomplete,
+ * non-existent.
+ */
+static int process(char *s, char **next, command_t *lookup,
+ command_t **result, char **prev)
{
- *result = find_cmd(s, lookup, next);
- *prev = s;
-
- /* non existent */
- if (!*result)
- return CMD_NONE;
-
- /* found entry: is it ambigous, i.e. not exact command name and
- more than one command in the list matches. Note that find_cmd
- points to the first ambiguous entry */
- if (strncasecmp(s, (*result)->pc_name, strlen((*result)->pc_name))) {
- char *another_next;
- command_t *another_result = find_cmd(s, (*result) + 1,
- &another_next);
- int found_another = 0;
-
- while (another_result) {
- if (strncasecmp(s, another_result->pc_name,
- strlen(another_result->pc_name)) == 0){
- *result = another_result;
- *next = another_next;
- goto got_it;
- }
- another_result = find_cmd(s, another_result + 1,
- &another_next);
- found_another = 1;
- }
- if (found_another)
- return CMD_AMBIG;
- }
+ static int depth;
+
+ *result = find_cmd(s, lookup, next);
+ *prev = s;
+
+ /* non existent */
+ if (!*result)
+ return CMD_NONE;
+
+ /*
+ * found entry: is it ambigous, i.e. not exact command name and
+ * more than one command in the list matches. Note that find_cmd
+ * points to the first ambiguous entry
+ */
+ if (strncasecmp(s, (*result)->pc_name, strlen((*result)->pc_name))) {
+ char *another_next;
+ int found_another = 0;
+
+ command_t *another_result = find_cmd(s, (*result) + 1,
+ &another_next);
+ while (another_result) {
+ if (strncasecmp(s, another_result->pc_name,
+ strlen(another_result->pc_name)) == 0) {
+ *result = another_result;
+ *next = another_next;
+ goto got_it;
+ }
+ another_result = find_cmd(s, another_result + 1,
+ &another_next);
+ found_another = 1;
+
+ /*
+ * In some circumstances, process will fail to find a
+ * suitable command. We want to be able to escape both
+ * the while loop and the recursion. So, track the
+ * number of times we've been here and give up if
+ * things start to get out-of-hand.
+ */
+ if (depth > 50)
+ return CMD_NONE;
+
+ depth++;
+ }
+ if (found_another)
+ return CMD_AMBIG;
+ }
got_it:
/* found a unique command: component or full? */
- if ((*result)->pc_func != NULL) {
+ if ((*result)->pc_func)
return CMD_COMPLETE;
- } else {
- if (**next == '\0') {
- return CMD_INCOMPLETE;
- } else {
- return process(*next, next, (*result)->pc_sub_cmd,
- result, prev);
- }
- }
+
+ if (**next == '\0')
+ return CMD_INCOMPLETE;
+ return process(*next, next, (*result)->pc_sub_cmd,
+ result, prev);
}
#ifdef HAVE_LIBREADLINE
-static command_t * match_tbl; /* Command completion against this table */
-static char * command_generator(const char * text, int state)
+static command_t *match_tbl; /* Command completion against this table */
+static char *command_generator(const char *text, int state)
{
- static int index,
- len;
- char *name;
-
- /* Do we have a match table? */
- if (!match_tbl)
- return NULL;
-
- /* If this is the first time called on this word, state is 0 */
- if (!state) {
- index = 0;
- len = (int)strlen(text);
- }
-
- /* Return next name in the command list that paritally matches test */
- while ( (name = (match_tbl + index)->pc_name) ) {
- index++;
-
- if (strncasecmp(name, text, len) == 0) {
- return(strdup(name));
- }
- }
-
- /* No more matches */
- return NULL;
+ static int index, len;
+ char *name;
+
+ /* Do we have a match table? */
+ if (!match_tbl)
+ return NULL;
+
+ /* If this is the first time called on this word, state is 0 */
+ if (!state) {
+ index = 0;
+ len = (int)strlen(text);
+ }
+
+ /* Return next name in the command list that paritally matches test */
+ while ((name = (match_tbl + index)->pc_name)) {
+ index++;
+
+ if (strncasecmp(name, text, len) == 0)
+ return strdup(name);
+ }
+
+ /* No more matches */
+ return NULL;
}
/* probably called by readline */
static char **command_completion(const char *text, int start, int end)
{
- command_t * table;
- char * pos;
+ command_t *table;
+ char *pos;
- match_tbl = top_level;
-
- for (table = find_cmd(rl_line_buffer, match_tbl, &pos);
- table; table = find_cmd(pos, match_tbl, &pos))
- {
+ match_tbl = top_level;
- if (*(pos - 1) == ' ') match_tbl = table->pc_sub_cmd;
- }
+ for (table = find_cmd(rl_line_buffer, match_tbl, &pos);
+ table; table = find_cmd(pos, match_tbl, &pos)) {
+ if (*(pos - 1) == ' ')
+ match_tbl = table->pc_sub_cmd;
+ }
return rl_completion_matches(text, command_generator);
}
#endif
/* take a string and execute the function or print help */
-int execute_line(char * line)
+static int execute_line(char *line)
{
- command_t *cmd, *ambig;
- char *prev;
- char *next, *tmp;
- char *argv[MAXARGS];
- int i;
- int rc = 0;
+ command_t *cmd, *ambig;
+ char *prev;
+ char *next, *tmp;
+ char *argv[MAXARGS];
+ int i;
+ int rc = 0;
switch (process(line, &next, top_level, &cmd, &prev)) {
case CMD_AMBIG:
fprintf(stderr, "\n");
break;
case CMD_NONE:
- fprintf(stderr, "No such command, type help\n");
+ fprintf(stderr, "No such command. Try --list-commands to see available commands.\n");
break;
case CMD_INCOMPLETE:
- fprintf(stderr, "'%s' incomplete command. Use '%s x' where "
- "x is one of:\n", line, line);
+ fprintf(stderr,
+ "'%s' incomplete command. Use '%s x' where x is one of:\n",
+ line, line);
fprintf(stderr, "\t");
for (i = 0; cmd->pc_sub_cmd[i].pc_name; i++)
fprintf(stderr, "%s ", cmd->pc_sub_cmd[i].pc_name);
case CMD_COMPLETE:
optind = 0;
i = line2args(line, argv, MAXARGS);
- rc = (cmd->pc_func)(i, argv);
+ rc = cmd->pc_func(i, argv);
- if (rc == CMD_HELP)
- fprintf(stderr, "%s\n", cmd->pc_help);
+ if (rc == CMD_HELP) {
+ fprintf(stdout, "%s\n", cmd->pc_help);
+ fflush(stdout);
+ }
break;
}
static void noop_void_fn(void) { }
#endif
-/* just in case you're ever in an airplane and discover you
- * forgot to install readline-dev. :) */
+/*
+ * just in case you're ever in an airplane and discover you
+ * forgot to install readline-dev. :)
+ */
static int init_input(void)
{
int interactive = isatty(fileno(stdin));
#ifndef HAVE_LIBREADLINE
#define add_history(s)
-char * readline(char * prompt)
+static char *readline(char *prompt)
{
- int size = 2048;
- char *line = malloc(size);
- char *ptr = line;
- int c;
- int eof = 0;
-
- if (line == NULL)
- return NULL;
- if (prompt)
- printf ("%s", prompt);
-
- while (1) {
- if ((c = fgetc(stdin)) != EOF) {
- if (c == '\n')
- goto out;
- *ptr++ = (char)c;
-
- if (ptr - line >= size - 1) {
- char *tmp;
-
- size *= 2;
- tmp = malloc(size);
- if (tmp == NULL)
- goto outfree;
- memcpy(tmp, line, ptr - line);
- ptr = tmp + (ptr - line);
- free(line);
- line = tmp;
- }
- } else {
- eof = 1;
- if (ferror(stdin) || feof(stdin))
- goto outfree;
- goto out;
- }
- }
+ int size = 2048;
+ char *line = malloc(size);
+ char *ptr = line;
+ int c;
+ int eof = 0;
+
+ if (!line)
+ return NULL;
+ if (prompt)
+ printf("%s", prompt);
+
+ while (1) {
+ if ((c = fgetc(stdin)) != EOF) {
+ if (c == '\n')
+ goto out;
+ *ptr++ = (char)c;
+
+ if (ptr - line >= size - 1) {
+ char *tmp;
+
+ size *= 2;
+ tmp = malloc(size);
+ if (!tmp)
+ goto outfree;
+ memcpy(tmp, line, ptr - line);
+ ptr = tmp + (ptr - line);
+ free(line);
+ line = tmp;
+ }
+ } else {
+ eof = 1;
+ if (ferror(stdin) || feof(stdin))
+ goto outfree;
+ goto out;
+ }
+ }
out:
- *ptr = 0;
- if (eof && (strlen(line) == 0)) {
- free(line);
- line = NULL;
- }
- return line;
+ *ptr = 0;
+ if (eof && (strlen(line) == 0)) {
+ free(line);
+ line = NULL;
+ }
+ return line;
outfree:
- free(line);
- return NULL;
+ free(line);
+ return NULL;
}
#endif
/* this is the command execution machine */
-int Parser_commands(void)
+static int cfs_parser_commands(command_t *cmds)
{
- char *line, *s;
- int rc = 0, save_error = 0;
- int interactive;
-
- interactive = init_input();
-
- while(!done) {
- line = readline(interactive ? parser_prompt : NULL);
-
- if (!line) break;
-
- s = skipwhitespace(line);
-
- if (*s) {
- add_history(s);
- rc = execute_line(s);
- }
- /* stop on error if not-interactive */
- if (rc != 0 && !interactive) {
- if (save_error == 0)
- save_error = rc;
- if (!ignore_errors)
- done = 1;
- }
-
- free(line);
- }
- if (save_error)
- rc = save_error;
- return rc;
-}
+ char *line, *s;
+ int rc = 0, save_error = 0;
+ int interactive;
+ interactive = init_input();
-/* sets the parser prompt */
-void Parser_init(char * prompt, command_t * cmds)
-{
- done = 0;
- top_level = cmds;
- if (parser_prompt) free(parser_prompt);
- parser_prompt = strdup(prompt);
-}
+ while (!done) {
+ line = readline(interactive ? "> " : NULL);
-/* frees the parser prompt */
-void Parser_exit(int argc, char *argv[])
-{
- done = 1;
- free(parser_prompt);
- parser_prompt = NULL;
-}
-
-/* convert a string to an integer */
-int Parser_int(char *s, int *val)
-{
- int ret;
-
- if (*s != '0')
- ret = sscanf(s, "%d", val);
- else if (*(s+1) != 'x')
- ret = sscanf(s, "%o", val);
- else {
- s++;
- ret = sscanf(++s, "%x", val);
- }
-
- return(ret);
-}
+ if (!line)
+ break;
+ s = skipwhitespace(line);
-void Parser_qhelp(int argc, char *argv[]) {
+ if (*s) {
+ add_history(s);
+ rc = execute_line(s);
+ }
+ /* stop on error if not-interactive */
+ if (rc != 0 && !interactive) {
+ if (save_error == 0)
+ save_error = rc;
+ if (!ignore_errors)
+ done = 1;
+ }
+ free(line);
+ }
- printf("usage: %s [COMMAND] [OPTIONS]... [ARGS]\n",
- program_invocation_short_name);
- printf("Without any parameters, interactive mode is invoked\n");
+ if (save_error)
+ rc = save_error;
- printf("Try '%s help <COMMAND>' or '%s --list-commands' for more information\n",
- program_invocation_short_name, program_invocation_short_name);
+ return rc;
}
-int Parser_help(int argc, char **argv)
+static int cfs_parser_help(int argc, char **argv)
{
- char line[1024];
- char *next, *prev, *tmp;
- command_t *result, *ambig;
- int i;
-
- if ( argc == 1 ) {
- Parser_qhelp(argc, argv);
- return 0;
- }
+ char line[1024];
+ char *next, *prev, *tmp;
+ command_t *result, *ambig;
+ int i;
+
+ if (argc == 1) {
+ printf("usage: %s [COMMAND] [OPTIONS]... [ARGS]\n",
+ program_invocation_short_name);
+ printf("Without any parameters, interactive mode is invoked\n");
+ printf("Try '%s help <COMMAND>', or '%s --list-commands' for a list of commands.\n",
+ program_invocation_short_name,
+ program_invocation_short_name);
+ return 0;
+ }
- /* Joining command line arguments without space is not critical here
+ /*
+ * Joining command line arguments without space is not critical here
* because of this string is used for search a help topic and assume
* that only one argument will be (the name of topic). For example:
* lst > help ping run
- * pingrun: Unknown command. */
+ * pingrun: Unknown command.
+ */
line[0] = '\0';
for (i = 1; i < argc; i++) {
- if (strlen(argv[i]) >= sizeof(line) - strlen(line))
+ if (strlen(argv[i]) >= sizeof(line) - strlen(line) - 1)
return -E2BIG;
- /* The function strlcat() cannot be used here because of
+ /*
+ * The function strlcat() cannot be used here because of
* this function is used in LNet utils that is not linked
- * with libcfs.a. */
- strncat(line, argv[i], sizeof(line) - strlen(line));
+ * with libcfs.a.
+ */
+ strncat(line, argv[i], sizeof(line) - strlen(line) - 1);
}
- switch ( process(line, &next, top_level, &result, &prev) ) {
- case CMD_COMPLETE:
- fprintf(stderr, "%s: %s\n",line, result->pc_help);
- break;
- case CMD_NONE:
- fprintf(stderr, "%s: Unknown command.\n", line);
- break;
- case CMD_INCOMPLETE:
- fprintf(stderr,
- "'%s' incomplete command. Use '%s x' where x is one of:\n",
- line, line);
- fprintf(stderr, "\t");
- for (i = 0; result->pc_sub_cmd[i].pc_name; i++) {
- fprintf(stderr, "%s ", result->pc_sub_cmd[i].pc_name);
- }
- fprintf(stderr, "\n");
- break;
- case CMD_AMBIG:
- fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
- while( (ambig = find_cmd(prev, result, &tmp)) ) {
- fprintf(stderr, "%s ", ambig->pc_name);
- result = ambig + 1;
- }
- fprintf(stderr, "\n");
- break;
- }
- return 0;
-}
-
-
-void Parser_printhelp(char *cmd)
-{
- char *argv[] = { "help", cmd };
- Parser_help(2, argv);
+ switch (process(line, &next, top_level, &result, &prev)) {
+ case CMD_COMPLETE:
+ fprintf(stderr, "%s: %s\n", line, result->pc_help);
+ break;
+ case CMD_NONE:
+ fprintf(stderr, "%s: '%s' is not a valid command. See '%s --list-commands'.\n",
+ program_invocation_short_name, line,
+ program_invocation_short_name);
+ break;
+ case CMD_INCOMPLETE:
+ fprintf(stderr,
+ "'%s' incomplete command. Use '%s x' where x is one of:\n",
+ line, line);
+ fprintf(stderr, "\t");
+ for (i = 0; result->pc_sub_cmd[i].pc_name; i++)
+ fprintf(stderr, "%s ", result->pc_sub_cmd[i].pc_name);
+ fprintf(stderr, "\n");
+ break;
+ case CMD_AMBIG:
+ fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
+ while ((ambig = find_cmd(prev, result, &tmp))) {
+ fprintf(stderr, "%s ", ambig->pc_name);
+ result = ambig + 1;
+ }
+ fprintf(stderr, "\n");
+ break;
+ }
+ return 0;
}
-
-/*************************************************************************
- * COMMANDS *
- *************************************************************************/
-
/**
- * Parser_list_commands() - Output a list of the supported commands.
+ * cfs_parser_list_commands() - Output a list of the supported commands.
* @cmdlist: Array of structures describing the commands.
- * @buffer: String buffer used to temporarily store the output text.
- * @buf_size: Length of the string buffer.
- * @parent_cmd: When called recursively, contains the name of the parent cmd.
- * @col_start: Column where printing should begin.
+ * @line_len: Length of output line.
* @col_num: The number of commands printed in a single row.
*
* The commands and subcommands supported by the utility are printed, arranged
- * into several columns for readability. If a command supports subcommands, the
- * function is called recursively, and the name of the parent command is
- * supplied so that it can be prepended to the names of the subcommands.
+ * into several columns for readability.
*
* Return: The number of items that were printed.
*/
-int Parser_list_commands(const command_t *cmdlist, char *buffer,
- size_t buf_size, const char *parent_cmd,
- int col_start, int col_num)
+static int cfs_parser_list_commands(const command_t *cmdlist, int line_len,
+ int col_num)
{
- int col = col_start;
int char_max;
- int len;
int count = 0;
- int rc;
+ int col = 0;
- if (col_start >= col_num)
- return 0;
+ int nprinted = 0;
+ int offset = 0;
- char_max = (buf_size - 1) / col_num; /* Reserve 1 char for NUL */
+ char_max = line_len / col_num;
- for (; cmdlist->pc_name != NULL; cmdlist++) {
- if (cmdlist->pc_func == NULL && cmdlist->pc_sub_cmd == NULL)
+ for (; cmdlist->pc_name; cmdlist++) {
+ if (!cmdlist->pc_func && !cmdlist->pc_sub_cmd)
break;
count++;
- if (parent_cmd != NULL)
- len = snprintf(&buffer[col * char_max],
- char_max + 1, "%s %s", parent_cmd,
- cmdlist->pc_name);
- else
- len = snprintf(&buffer[col * char_max],
- char_max + 1, "%s", cmdlist->pc_name);
-
- /* Add trailing spaces to pad the entry to the column size */
- if (len < char_max) {
- snprintf(&buffer[col * char_max] + len,
- char_max - len + 1, "%*s", char_max - len,
- " ");
- } else {
- buffer[(col + 1) * char_max - 1] = ' ';
- }
+
+ nprinted = fprintf(stdout, "%-*s ", char_max - offset - 1,
+ cmdlist->pc_name);
+ /*
+ * when a column is too wide, save offset so subsequent columns
+ * can be aligned properly
+ */
+ offset = offset + nprinted - char_max;
+ offset = offset > 0 ? offset : 0;
col++;
if (col >= col_num) {
- fprintf(stdout, "%s\n", buffer);
+ fprintf(stdout, "\n");
col = 0;
- buffer[0] = '\0';
- }
-
- if (cmdlist->pc_sub_cmd != NULL) {
- rc = Parser_list_commands(cmdlist->pc_sub_cmd, buffer,
- buf_size, cmdlist->pc_name,
- col, col_num);
- col = (col + rc) % col_num;
- count += rc;
+ offset = 0;
}
}
- if (parent_cmd == NULL && col != 0)
- fprintf(stdout, "%s\n", buffer);
+ if (col != 0)
+ fprintf(stdout, "\n");
return count;
}
-char *Parser_getstr(const char *prompt, const char *deft, char *res,
- size_t len)
+static int cfs_parser_quit(int argc, char **argv)
{
- char *line = NULL;
- int size = strlen(prompt) + strlen(deft) + 8;
- char *theprompt;
- theprompt = malloc(size);
- assert(theprompt);
-
- sprintf(theprompt, "%s [%s]: ", prompt, deft);
-
- line = readline(theprompt);
- free(theprompt);
-
- /* The function strlcpy() cannot be used here because of
- * this function is used in LNet utils that is not linked
- * with libcfs.a. */
- if (line == NULL || *line == '\0')
- strncpy(res, deft, len);
- else
- strncpy(res, line, len);
- res[len - 1] = '\0';
-
- if (line != NULL) {
- free(line);
- return res;
- }
- return NULL;
-}
+ (void) argc;
+ (void) argv;
-/* get integer from prompt, loop forever to get it */
-int Parser_getint(const char *prompt, long min, long max, long deft, int base)
-{
- int rc;
- long result;
- char *line;
- int size = strlen(prompt) + 40;
- char *theprompt = malloc(size);
- assert(theprompt);
- sprintf(theprompt,"%s [%ld, (0x%lx)]: ", prompt, deft, deft);
-
- fflush(stdout);
-
- do {
- line = NULL;
- line = readline(theprompt);
- if ( !line ) {
- fprintf(stdout, "Please enter an integer.\n");
- fflush(stdout);
- continue;
- }
- if ( *line == '\0' ) {
- free(line);
- result = deft;
- break;
- }
- rc = Parser_arg2int(line, &result, base);
- free(line);
- if ( rc != 0 ) {
- fprintf(stdout, "Invalid string.\n");
- fflush(stdout);
- } else if ( result > max || result < min ) {
- fprintf(stdout, "Error: response must lie between %ld and %ld.\n",
- min, max);
- fflush(stdout);
- } else {
- break;
- }
- } while ( 1 ) ;
-
- if (theprompt)
- free(theprompt);
- return result;
+ done = 1;
+ return 0;
}
-/* get boolean (starting with YyNn; loop forever */
-int Parser_getbool(const char *prompt, int deft)
-{
- int result = 0;
- char *line;
- int size = strlen(prompt) + 8;
- char *theprompt = malloc(size);
- assert(theprompt);
-
- fflush(stdout);
-
- if ( deft != 0 && deft != 1 ) {
- fprintf(stderr, "Error: Parser_getbool given bad default %d\n",
- deft);
- assert ( 0 );
- }
- sprintf(theprompt, "%s [%s]: ", prompt, (deft==0)? "N" : "Y");
-
- do {
- line = NULL;
- line = readline(theprompt);
- if ( line == NULL ) {
- result = deft;
- break;
- }
- if ( *line == '\0' ) {
- result = deft;
- break;
- }
- if ( *line == 'y' || *line == 'Y' ) {
- result = 1;
- break;
- }
- if ( *line == 'n' || *line == 'N' ) {
- result = 0;
- break;
- }
- if ( line )
- free(line);
- fprintf(stdout, "Invalid string. Must start with yY or nN\n");
- fflush(stdout);
- } while ( 1 );
-
- if ( line )
- free(line);
- if ( theprompt )
- free(theprompt);
- return result;
-}
-
-/* parse int out of a string or prompt for it */
-long Parser_intarg(const char *inp, const char *prompt, int deft,
- int min, int max, int base)
-{
- long result;
- int rc;
-
- rc = Parser_arg2int(inp, &result, base);
-
- if ( rc == 0 ) {
- return result;
- } else {
- return Parser_getint(prompt, deft, min, max, base);
- }
-}
-
-/* parse int out of a string or prompt for it */
-char *Parser_strarg(char *inp, const char *prompt, const char *deft,
- char *answer, int len)
-{
- if ( inp == NULL || *inp == '\0' ) {
- return Parser_getstr(prompt, deft, answer, len);
- } else
- return inp;
-}
-
-/* change a string into a number: return 0 on success. No invalid characters
- allowed. The processing of base and validity follows strtol(3)*/
-int Parser_arg2int(const char *inp, long *result, int base)
+static int cfs_parser_version(int argc, char **argv)
{
- char *endptr;
+ (void) argc;
+ (void) argv;
- if ( (base !=0) && (base < 2 || base > 36) )
- return 1;
-
- *result = strtol(inp, &endptr, base);
+ fprintf(stdout, "%s %s\n", program_invocation_short_name,
+ LUSTRE_VERSION_STRING);
- if ( *inp != '\0' && *endptr == '\0' )
- return 0;
- else
- return 1;
+ return 0;
}
-/* Convert human readable size string to and int; "1k" -> 1000 */
-int Parser_size(unsigned long *sizep, char *str)
+static int cfs_parser_list(int argc, char **argv)
{
- unsigned long size;
- char mod[32];
-
- switch (sscanf(str, "%lu%1[gGmMkK]", &size, mod)) {
- default:
- return -1;
-
- case 1:
- *sizep = size;
- return 0;
-
- case 2:
- switch (*mod) {
- case 'g':
- case 'G':
- *sizep = size << 30;
- return 0;
-
- case 'm':
- case 'M':
- *sizep = size << 20;
- return 0;
-
- case 'k':
- case 'K':
- *sizep = size << 10;
- return 0;
-
- default:
- *sizep = size;
- return 0;
+ command_t *cmd;
+ int num_cmds_listed;
+
+ (void) argc;
+ (void) argv;
+
+ cmd = top_level;
+ while (cmd->pc_name != NULL) {
+ if (!cmd->pc_func) {
+ /*
+ * print the command category
+ */
+ printf("\n%s\n", cmd->pc_name);
+ cmd++;
}
+ num_cmds_listed = cfs_parser_list_commands(cmd, 80, 4);
+ cmd += num_cmds_listed;
}
-}
-
-/* Convert a string boolean to an int; "enable" -> 1 */
-int Parser_bool (int *b, char *str) {
- if (!strcasecmp (str, "no") ||
- !strcasecmp (str, "n") ||
- !strcasecmp (str, "off") ||
- !strcasecmp (str, "down") ||
- !strcasecmp (str, "disable"))
- {
- *b = 0;
- return (0);
- }
-
- if (!strcasecmp (str, "yes") ||
- !strcasecmp (str, "y") ||
- !strcasecmp (str, "on") ||
- !strcasecmp (str, "up") ||
- !strcasecmp (str, "enable"))
- {
- *b = 1;
- return (0);
- }
-
- return (-1);
-}
-int Parser_quit(int argc, char **argv)
-{
- argc = argc;
- argv = argv;
- done = 1;
- return 0;
-}
-
-int Parser_version(int argc, char **argv)
-{
- fprintf(stdout, "%s %s\n", program_invocation_short_name,
- LUSTRE_VERSION_STRING);
return 0;
}
git://git.whamcloud.com / fs / lustre-release.git / blobdiff