/*
- * Copyright (c) 2008 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2013, 2014 Nicira, Inc.
*
- * Permission to use, copy, modify, and/or distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
*/
#include <config.h>
#include "command-line.h"
#include <getopt.h>
#include <limits.h>
+#include <stdlib.h>
+#include "dynamic-string.h"
+#include "ovs-thread.h"
#include "util.h"
-#include "vlog.h"
+#include "openvswitch/vlog.h"
+
+VLOG_DEFINE_THIS_MODULE(command_line);
/* Given the GNU-style long options in 'options', returns a string that may be
* 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;
-
+
for (; options->name; options++) {
const struct option *o = options;
if (o->flag == NULL && o->val > 0 && o->val <= UCHAR_MAX) {
}
}
*p = '\0';
-
+
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:
+ * struct ovs_cmdl_context ctx = {
+ * .argc = argc - optind,
+ * .argv = argv + optind,
+ * };
+ * ovs_cmdl_run_command(&ctx, my_commands);
+ * */
+void
+ovs_cmdl_run_command(struct ovs_cmdl_context *ctx, const struct ovs_cmdl_command commands[])
+{
+ const struct ovs_cmdl_command *p;
+
+ 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, 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);
+ } else if (n_arg > p->max_args) {
+ VLOG_FATAL("'%s' command takes at most %d arguments",
+ p->name, p->max_args);
+ } else {
+ p->handler(ctx);
+ if (ferror(stdout)) {
+ VLOG_FATAL("write to stdout failed");
+ }
+ if (ferror(stderr)) {
+ VLOG_FATAL("write to stderr failed");
+ }
+ return;
+ }
+ }
+ }
+
+ VLOG_FATAL("unknown command '%s'; use --help for help", ctx->argv[0]);
+}
+\f
+/* Process title. */
+
+#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.
+ *
+ * This modifies the argv[] array so that it no longer points into the memory
+ * that it originally does. Later, proctitle_set() might overwrite that
+ * memory. That means that this function should be called before anything else
+ * that accesses the process's argv[] array. Ideally, it should be called
+ * before anything else, period, at the very beginning of program
+ * execution. */
+void
+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;
+ argv[0] = xstrdup(argv[0]);
+
+ for (i = 1; i < argc; i++) {
+ size_t size = strlen(argv[i]) + 1;
+
+ /* Add (argv[i], strlen(argv[i])+1) to (argv_start, argv_size). */
+ if (argv[i] + size == argv_start) {
+ /* Arguments grow downward in memory. */
+ argv_start -= size;
+ argv_size += size;
+ } else if (argv[i] == argv_start + argv_size) {
+ /* Arguments grow upward in memory. */
+ argv_size += size;
+ } else {
+ /* Arguments not contiguous. (Is this really Linux?) */
+ }
+
+ /* 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
+ovs_cmdl_proctitle_set(const char *format, ...)
+{
+ va_list args;
+ int n;
+
+ ovs_mutex_lock(&proctitle_mutex);
+ if (!argv_start || argv_size < 8) {
+ goto out;
+ }
+
+ if (!saved_proctitle) {
+ saved_proctitle = xmemdup(argv_start, argv_size);
+ }
+
+ va_start(args, format);
+ n = snprintf(argv_start, argv_size, "%s: ", program_name);
+ if (n < argv_size) {
+ n += vsnprintf(argv_start + n, argv_size - n, format, args);
+ }
+ if (n >= argv_size) {
+ /* The name is too long, so add an ellipsis at the end. */
+ strcpy(&argv_start[argv_size - 4], "...");
+ } else {
+ /* Fill the extra space with null bytes, so that trailing bytes don't
+ * show up in the command line. */
+ 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
+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__ */
+/* Stubs that don't do anything on non-Linux systems. */
+
+void
+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
+ovs_cmdl_proctitle_set(const char *format OVS_UNUSED, ...)
+{
+}
+#endif
+
+void
+ovs_cmdl_proctitle_restore(void)
+{
+}
+#endif /* !__linux__ */
projects / cascardo / ovs.git / blobdiff