X-Git-Url: http://git.cascardo.eti.br/?a=blobdiff_plain;f=lib%2Fcommand-line.c;h=7b668a13971a8f28b2139e771d6b8c436eccf51e;hb=8b8ef592521e32d0e32581bf39c5d2a5cd445977;hp=70b1f4d1b1f2b38bb764f41e9db46c7952442a1f;hpb=666afb55e84e9118812de81a75655ec9567b7a5b;p=cascardo%2Fovs.git diff --git a/lib/command-line.c b/lib/command-line.c index 70b1f4d1b..7b668a139 100644 --- a/lib/command-line.c +++ b/lib/command-line.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc. + * Copyright (c) 2008, 2009, 2010, 2011, 2013, 2014 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,8 +19,10 @@ #include #include #include +#include "dynamic-string.h" +#include "ovs-thread.h" #include "util.h" -#include "vlog.h" +#include "openvswitch/vlog.h" VLOG_DEFINE_THIS_MODULE(command_line); @@ -28,7 +30,7 @@ VLOG_DEFINE_THIS_MODULE(command_line); * passed to getopt() with the corresponding short options. The caller is * responsible for freeing the string. */ char * -long_options_to_short_options(const struct option options[]) +ovs_cmdl_long_options_to_short_options(const struct option options[]) { char short_options[UCHAR_MAX * 3 + 1]; char *p = short_options; @@ -50,24 +52,65 @@ long_options_to_short_options(const struct option options[]) return xstrdup(short_options); } +/* Given the 'struct ovs_cmdl_command' array, prints the usage of all commands. */ +void +ovs_cmdl_print_commands(const struct ovs_cmdl_command commands[]) +{ + struct ds ds = DS_EMPTY_INITIALIZER; + + ds_put_cstr(&ds, "The available commands are:\n"); + for (; commands->name; commands++) { + const struct ovs_cmdl_command *c = commands; + ds_put_format(&ds, " %-23s %s\n", c->name, c->usage ? c->usage : ""); + } + printf("%s", ds.string); + ds_destroy(&ds); +} + +/* Given the GNU-style options in 'options', prints all options. */ +void +ovs_cmdl_print_options(const struct option options[]) +{ + struct ds ds = DS_EMPTY_INITIALIZER; + + for (; options->name; options++) { + const struct option *o = options; + const char *arg = o->has_arg == required_argument ? "ARG" : "[ARG]"; + + ds_put_format(&ds, "--%s%s%s\n", o->name, o->has_arg ? "=" : "", + o->has_arg ? arg : ""); + if (o->flag == NULL && o->val > 0 && o->val <= UCHAR_MAX) { + ds_put_format(&ds, "-%c %s\n", o->val, o->has_arg ? arg : ""); + } + } + printf("%s", ds.string); + ds_destroy(&ds); +} + /* Runs the command designated by argv[0] within the command table specified by * 'commands', which must be terminated by a command whose 'name' member is a * null pointer. * * Command-line options should be stripped off, so that a typical invocation - * looks like "run_command(argc - optind, argv + optind, my_commands);". */ + * looks like: + * struct ovs_cmdl_context ctx = { + * .argc = argc - optind, + * .argv = argv + optind, + * }; + * ovs_cmdl_run_command(&ctx, my_commands); + * */ void -run_command(int argc, char *argv[], const struct command commands[]) +ovs_cmdl_run_command(struct ovs_cmdl_context *ctx, const struct ovs_cmdl_command commands[]) { - const struct command *p; + const struct ovs_cmdl_command *p; - if (argc < 1) { + if (ctx->argc < 1) { ovs_fatal(0, "missing command name; use --help for help"); } for (p = commands; p->name != NULL; p++) { - if (!strcmp(p->name, argv[0])) { - int n_arg = argc - 1; + if (!strcmp(p->name, ctx->argv[0])) { + int n_arg = ctx->argc - 1; if (n_arg < p->min_args) { VLOG_FATAL( "'%s' command requires at least %d arguments", p->name, p->min_args); @@ -75,7 +118,7 @@ run_command(int argc, char *argv[], const struct command commands[]) VLOG_FATAL("'%s' command takes at most %d arguments", p->name, p->max_args); } else { - p->handler(argc, argv); + p->handler(ctx); if (ferror(stdout)) { VLOG_FATAL("write to stdout failed"); } @@ -87,15 +130,22 @@ run_command(int argc, char *argv[], const struct command commands[]) } } - VLOG_FATAL("unknown command '%s'; use --help for help", argv[0]); + VLOG_FATAL("unknown command '%s'; use --help for help", ctx->argv[0]); } /* Process title. */ -#ifdef LINUX_DATAPATH -static char *argv_start; /* Start of command-line arguments in memory. */ -static size_t argv_size; /* Number of bytes of command-line arguments. */ -static char *saved_proctitle; /* Saved command-line arguments. */ +#ifdef __linux__ +static struct ovs_mutex proctitle_mutex = OVS_MUTEX_INITIALIZER; + +/* Start of command-line arguments in memory. */ +static char *argv_start OVS_GUARDED_BY(proctitle_mutex); + +/* Number of bytes of command-line arguments. */ +static size_t argv_size OVS_GUARDED_BY(proctitle_mutex); + +/* Saved command-line arguments. */ +static char *saved_proctitle OVS_GUARDED_BY(proctitle_mutex); /* Prepares the process so that proctitle_set() can later succeed. * @@ -106,15 +156,17 @@ static char *saved_proctitle; /* Saved command-line arguments. */ * before anything else, period, at the very beginning of program * execution. */ void -proctitle_init(int argc, char **argv) +ovs_cmdl_proctitle_init(int argc, char **argv) { int i; + assert_single_threaded(); if (!argc || !argv[0]) { /* This situation should never occur, but... */ return; } + ovs_mutex_lock(&proctitle_mutex); /* Specialized version of first loop iteration below. */ argv_start = argv[0]; argv_size = strlen(argv[0]) + 1; @@ -138,18 +190,20 @@ proctitle_init(int argc, char **argv) /* Copy out the old argument so we can reuse the space. */ argv[i] = xstrdup(argv[i]); } + ovs_mutex_unlock(&proctitle_mutex); } /* Changes the name of the process, as shown by "ps", to the program name * followed by 'format', which is formatted as if by printf(). */ void -proctitle_set(const char *format, ...) +ovs_cmdl_proctitle_set(const char *format, ...) { va_list args; int n; + ovs_mutex_lock(&proctitle_mutex); if (!argv_start || argv_size < 8) { - return; + goto out; } if (!saved_proctitle) { @@ -170,36 +224,41 @@ proctitle_set(const char *format, ...) memset(&argv_start[n], '\0', argv_size - n); } va_end(args); + +out: + ovs_mutex_unlock(&proctitle_mutex); } /* Restores the process's original command line, as seen by "ps". */ void -proctitle_restore(void) +ovs_cmdl_proctitle_restore(void) { + ovs_mutex_lock(&proctitle_mutex); if (saved_proctitle) { memcpy(argv_start, saved_proctitle, argv_size); free(saved_proctitle); saved_proctitle = NULL; } + ovs_mutex_unlock(&proctitle_mutex); } -#else /* !LINUX_DATAPATH*/ +#else /* !__linux__ */ /* Stubs that don't do anything on non-Linux systems. */ void -proctitle_init(int argc OVS_UNUSED, char **argv OVS_UNUSED) +ovs_cmdl_proctitle_init(int argc OVS_UNUSED, char **argv OVS_UNUSED) { } #if !(defined(__FreeBSD__) || defined(__NetBSD__)) /* On these platforms we #define this to setproctitle. */ void -proctitle_set(const char *format OVS_UNUSED, ...) +ovs_cmdl_proctitle_set(const char *format OVS_UNUSED, ...) { } #endif void -proctitle_restore(void) +ovs_cmdl_proctitle_restore(void) { } -#endif /* !LINUX_DATAPATH */ +#endif /* !__linux__ */