2 * Copyright (C) 2001 Cluster File Systems, Inc.
4 * This file is part of Lustre, http://www.sf.net/projects/lustre/
6 * Lustre is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
10 * Lustre is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with Lustre; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <lustre_ver.h>
22 #include <libcfs/libcfsutil.h>
24 static command_t * top_level; /* Top level of commands, initialized by
26 static char * parser_prompt = NULL;/* Parser prompt, set by InitParser */
27 static int done; /* Set to 1 if user types exit or quit */
28 static int ignore_errors; /* Normally, the parser will quit when
29 an error occurs in non-interacive
30 mode. Setting this to non-zero will
31 force it to keep buggering on. */
34 /* static functions */
35 static char *skipwhitespace(char *s);
36 static char *skiptowhitespace(char *s);
37 static command_t *find_cmd(char *name, command_t cmds[], char **next);
38 static int process(char *s, char **next, command_t *lookup, command_t **result,
40 static void print_commands(char *str, command_t *table);
42 static char * skipwhitespace(char * s)
48 for (t = s; t <= s + len && isspace(*t); t++);
53 static char * skiptowhitespace(char * s)
57 for (t = s; *t && !isspace(*t); t++);
61 static int line2args(char *line, char **argv, int maxargs)
66 arg = strtok(line, " \t");
67 if (arg == NULL || maxargs < 1)
71 while ((arg = strtok(NULL, " \t")) != NULL && i < maxargs)
76 /* find a command -- return it if unique otherwise print alternatives */
77 static command_t *Parser_findargcmd(char *name, command_t cmds[])
81 for (cmd = cmds; cmd->pc_name; cmd++) {
82 if (strcmp(name, cmd->pc_name) == 0)
88 void Parser_ignore_errors(int ignore)
90 ignore_errors = ignore;
93 int Parser_execarg(int argc, char **argv, command_t cmds[])
97 cmd = Parser_findargcmd(argv[0], cmds);
99 int rc = (cmd->pc_func)(argc, argv);
101 fprintf(stderr, "%s\n", cmd->pc_help);
104 printf("Try interactive use without arguments or use one of:\n");
105 for (cmd = cmds; cmd->pc_name; cmd++)
106 printf("\"%s\"\n", cmd->pc_name);
107 printf("as argument.\n");
112 /* returns the command_t * (NULL if not found) corresponding to a
113 _partial_ match with the first token in name. It sets *next to
114 point to the following token. Does not modify *name. */
115 static command_t * find_cmd(char * name, command_t cmds[], char ** next)
122 /* This sets name to point to the first non-white space character,
123 and next to the first whitespace after name, len to the length: do
125 name = skipwhitespace(name);
126 *next = skiptowhitespace(name);
127 len = (int)(*next - name);
131 for (i = 0; cmds[i].pc_name; i++) {
132 if (strncasecmp(name, cmds[i].pc_name, len) == 0) {
133 *next = skipwhitespace(*next);
140 /* Recursively process a command line string s and find the command
141 corresponding to it. This can be ambiguous, full, incomplete,
143 static int process(char *s, char ** next, command_t *lookup,
144 command_t **result, char **prev)
146 *result = find_cmd(s, lookup, next);
153 /* found entry: is it ambigous, i.e. not exact command name and
154 more than one command in the list matches. Note that find_cmd
155 points to the first ambiguous entry */
156 if (strncasecmp(s, (*result)->pc_name, strlen((*result)->pc_name))) {
158 command_t *another_result = find_cmd(s, (*result) + 1,
160 int found_another = 0;
162 while (another_result) {
163 if (strncasecmp(s, another_result->pc_name,
164 strlen(another_result->pc_name)) == 0){
165 *result = another_result;
166 *next = another_next;
169 another_result = find_cmd(s, another_result + 1,
178 /* found a unique command: component or full? */
179 if ( (*result)->pc_func ) {
182 if ( *next == '\0' ) {
183 return CMD_INCOMPLETE;
185 return process(*next, next, (*result)->pc_sub_cmd,
191 #ifdef HAVE_LIBREADLINE
192 static command_t * match_tbl; /* Command completion against this table */
193 static char * command_generator(const char * text, int state)
199 /* Do we have a match table? */
203 /* If this is the first time called on this word, state is 0 */
206 len = (int)strlen(text);
209 /* Return next name in the command list that paritally matches test */
210 while ( (name = (match_tbl + index)->pc_name) ) {
213 if (strncasecmp(name, text, len) == 0) {
214 return(strdup(name));
218 /* No more matches */
222 /* probably called by readline */
223 static char **command_completion(const char *text, int start, int end)
228 match_tbl = top_level;
230 for (table = find_cmd(rl_line_buffer, match_tbl, &pos);
231 table; table = find_cmd(pos, match_tbl, &pos))
234 if (*(pos - 1) == ' ') match_tbl = table->pc_sub_cmd;
237 return completion_matches(text, command_generator);
241 /* take a string and execute the function or print help */
242 int execute_line(char * line)
244 command_t *cmd, *ambig;
251 switch (process(line, &next, top_level, &cmd, &prev)) {
253 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
254 while( (ambig = find_cmd(prev, cmd, &tmp)) ) {
255 fprintf(stderr, "%s ", ambig->pc_name);
258 fprintf(stderr, "\n");
261 fprintf(stderr, "No such command, type help\n");
265 "'%s' incomplete command. Use '%s x' where x is one of:\n",
267 fprintf(stderr, "\t");
268 for (i = 0; cmd->pc_sub_cmd[i].pc_name; i++) {
269 fprintf(stderr, "%s ", cmd->pc_sub_cmd[i].pc_name);
271 fprintf(stderr, "\n");
274 i = line2args(line, argv, MAXARGS);
275 rc = (cmd->pc_func)(i, argv);
278 fprintf(stderr, "%s\n", cmd->pc_help);
286 #ifdef HAVE_LIBREADLINE
287 static void noop_int_fn(int unused) { }
288 static void noop_void_fn(void) { }
291 /* just in case you're ever in an airplane and discover you
292 * forgot to install readline-dev. :) */
293 static int init_input(void)
295 int interactive = isatty(fileno(stdin));
297 #ifdef HAVE_LIBREADLINE
299 stifle_history(HISTORY);
302 rl_prep_term_function = noop_int_fn;
303 rl_deprep_term_function = noop_void_fn;
306 rl_attempted_completion_function = command_completion;
307 rl_completion_entry_function = command_generator;
312 #ifndef HAVE_LIBREADLINE
313 #define add_history(s)
314 char * readline(char * prompt)
317 char *line = malloc(size);
325 printf ("%s", prompt);
328 if ((c = fgetc(stdin)) != EOF) {
333 if (ptr - line >= size - 1) {
340 memcpy(tmp, line, ptr - line);
341 ptr = tmp + (ptr - line);
347 if (ferror(stdin) || feof(stdin))
354 if (eof && (strlen(line) == 0)) {
365 /* this is the command execution machine */
366 int Parser_commands(void)
369 int rc = 0, save_error = 0;
372 interactive = init_input();
375 line = readline(interactive ? parser_prompt : NULL);
379 s = skipwhitespace(line);
383 rc = execute_line(s);
385 /* stop on error if not-interactive */
386 if (rc != 0 && !interactive) {
401 /* sets the parser prompt */
402 void Parser_init(char * prompt, command_t * cmds)
406 if (parser_prompt) free(parser_prompt);
407 parser_prompt = strdup(prompt);
410 /* frees the parser prompt */
411 void Parser_exit(int argc, char *argv[])
415 parser_prompt = NULL;
418 /* convert a string to an integer */
419 int Parser_int(char *s, int *val)
424 ret = sscanf(s, "%d", val);
425 else if (*(s+1) != 'x')
426 ret = sscanf(s, "%o", val);
429 ret = sscanf(++s, "%x", val);
436 void Parser_qhelp(int argc, char *argv[]) {
438 printf("Available commands are:\n");
440 print_commands(NULL, top_level);
441 printf("For more help type: help command-name\n");
444 int Parser_help(int argc, char **argv)
447 char *next, *prev, *tmp;
448 command_t *result, *ambig;
452 Parser_qhelp(argc, argv);
456 /* Joining command line arguments without space is not critical here
457 * because of this string is used for search a help topic and assume
458 * that only one argument will be (the name of topic). For example:
459 * lst > help ping run
460 * pingrun: Unknown command. */
462 for (i = 1; i < argc; i++) {
463 if (strlen(argv[i]) >= sizeof(line) - strlen(line))
465 /* The function strlcat() cannot be used here because of
466 * this function is used in LNet utils that is not linked
468 strncat(line, argv[i], sizeof(line) - strlen(line));
471 switch ( process(line, &next, top_level, &result, &prev) ) {
473 fprintf(stderr, "%s: %s\n",line, result->pc_help);
476 fprintf(stderr, "%s: Unknown command.\n", line);
480 "'%s' incomplete command. Use '%s x' where x is one of:\n",
482 fprintf(stderr, "\t");
483 for (i = 0; result->pc_sub_cmd[i].pc_name; i++) {
484 fprintf(stderr, "%s ", result->pc_sub_cmd[i].pc_name);
486 fprintf(stderr, "\n");
489 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
490 while( (ambig = find_cmd(prev, result, &tmp)) ) {
491 fprintf(stderr, "%s ", ambig->pc_name);
494 fprintf(stderr, "\n");
501 void Parser_printhelp(char *cmd)
503 char *argv[] = { "help", cmd };
504 Parser_help(2, argv);
508 /*************************************************************************
510 *************************************************************************/
511 static void print_commands(char * str, command_t * table) {
515 for (cmds = table; cmds->pc_name; cmds++) {
517 if (str) printf("\t%s %s\n", str, cmds->pc_name);
518 else printf("\t%s\n", cmds->pc_name);
520 if (cmds->pc_sub_cmd) {
522 sprintf(buf, "%s %s", str, cmds->pc_name);
523 print_commands(buf, cmds->pc_sub_cmd);
525 print_commands(cmds->pc_name, cmds->pc_sub_cmd);
531 char *Parser_getstr(const char *prompt, const char *deft, char *res,
535 int size = strlen(prompt) + strlen(deft) + 8;
537 theprompt = malloc(size);
540 sprintf(theprompt, "%s [%s]: ", prompt, deft);
542 line = readline(theprompt);
545 /* The function strlcpy() cannot be used here because of
546 * this function is used in LNet utils that is not linked
548 if (line == NULL || *line == '\0')
549 strncpy(res, deft, len);
551 strncpy(res, line, len);
561 /* get integer from prompt, loop forever to get it */
562 int Parser_getint(const char *prompt, long min, long max, long deft, int base)
567 int size = strlen(prompt) + 40;
568 char *theprompt = malloc(size);
570 sprintf(theprompt,"%s [%ld, (0x%lx)]: ", prompt, deft, deft);
576 line = readline(theprompt);
578 fprintf(stdout, "Please enter an integer.\n");
582 if ( *line == '\0' ) {
587 rc = Parser_arg2int(line, &result, base);
590 fprintf(stdout, "Invalid string.\n");
592 } else if ( result > max || result < min ) {
593 fprintf(stdout, "Error: response must lie between %ld and %ld.\n",
607 /* get boolean (starting with YyNn; loop forever */
608 int Parser_getbool(const char *prompt, int deft)
612 int size = strlen(prompt) + 8;
613 char *theprompt = malloc(size);
618 if ( deft != 0 && deft != 1 ) {
619 fprintf(stderr, "Error: Parser_getbool given bad default %d\n",
623 sprintf(theprompt, "%s [%s]: ", prompt, (deft==0)? "N" : "Y");
627 line = readline(theprompt);
628 if ( line == NULL ) {
632 if ( *line == '\0' ) {
636 if ( *line == 'y' || *line == 'Y' ) {
640 if ( *line == 'n' || *line == 'N' ) {
646 fprintf(stdout, "Invalid string. Must start with yY or nN\n");
657 /* parse int out of a string or prompt for it */
658 long Parser_intarg(const char *inp, const char *prompt, int deft,
659 int min, int max, int base)
664 rc = Parser_arg2int(inp, &result, base);
669 return Parser_getint(prompt, deft, min, max, base);
673 /* parse int out of a string or prompt for it */
674 char *Parser_strarg(char *inp, const char *prompt, const char *deft,
675 char *answer, int len)
677 if ( inp == NULL || *inp == '\0' ) {
678 return Parser_getstr(prompt, deft, answer, len);
683 /* change a string into a number: return 0 on success. No invalid characters
684 allowed. The processing of base and validity follows strtol(3)*/
685 int Parser_arg2int(const char *inp, long *result, int base)
689 if ( (base !=0) && (base < 2 || base > 36) )
692 *result = strtol(inp, &endptr, base);
694 if ( *inp != '\0' && *endptr == '\0' )
700 /* Convert human readable size string to and int; "1k" -> 1000 */
701 int Parser_size (int *sizep, char *str) {
705 switch (sscanf (str, "%d%1[gGmMkK]", &size, mod)) {
737 /* Convert a string boolean to an int; "enable" -> 1 */
738 int Parser_bool (int *b, char *str) {
739 if (!strcasecmp (str, "no") ||
740 !strcasecmp (str, "n") ||
741 !strcasecmp (str, "off") ||
742 !strcasecmp (str, "down") ||
743 !strcasecmp (str, "disable"))
749 if (!strcasecmp (str, "yes") ||
750 !strcasecmp (str, "y") ||
751 !strcasecmp (str, "on") ||
752 !strcasecmp (str, "up") ||
753 !strcasecmp (str, "enable"))
762 int Parser_quit(int argc, char **argv)
770 int Parser_version(int argc, char **argv)
772 fprintf(stdout, "%s %s\n", program_invocation_short_name,
773 LUSTRE_VERSION_STRING);