ovsdb-server: Add --run option.
authorBen Pfaff <blp@nicira.com>
Fri, 12 Feb 2010 19:17:17 +0000 (11:17 -0800)
committerBen Pfaff <blp@nicira.com>
Mon, 15 Feb 2010 19:31:06 +0000 (11:31 -0800)
Bug #2398.

ovsdb/ovsdb-server.1.in
ovsdb/ovsdb-server.c

index 4c6ceddde3c71989e67db04fb21f8abd9eca9bfc..17c955e37336d0e78c86afe39f9bf808932d8942 100644 (file)
@@ -9,6 +9,7 @@ ovsdb\-server \- Open vSwitch database server
 \fBovsdb\-server\fR
 \fIdatabase\fR
 [\fB--remote=\fIremote\fR]\&...
+[\fB--run=\fIcommand\fR]
 .so lib/daemon-syn.man
 .so lib/vlog-syn.man
 .so lib/common-syn.man
@@ -33,6 +34,18 @@ Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
 .so ovsdb/remote-active.man
 .RE
 .
+.IP "\fB\-\-run=\fIcommand\fR]"
+Ordinarily \fBovsdb\-server\fR runs forever, or until it is told to
+exit (see \fBRUNTIME MANAGEMENT COMMANDS\fR below).  With this option,
+\fBovsdb\-server\fR instead starts a shell subprocess running
+\fIcommand\fR.  When the subprocess terminates, \fBovsdb\-server\fR
+also exits gracefully.  If the subprocess exits normally with exit
+code 0, then \fBovsdb\-server\fR exits with exit code 0 also;
+otherwise, it exits with exit code 1.
+.IP
+This option can be useful where a database server is needed only to
+run a single command, e.g.:
+.B "ovsdb-server --remote=punix:socket --run='ovsdb-client dump unix:socket Open_vSwitch'"
 .SS "Daemon Options"
 .so lib/daemon.man
 .SS "Logging Options"
@@ -44,6 +57,10 @@ Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
 \fBovs\-appctl\fR(8) can send commands to a running
 \fBovsdb\-server\fR process.  The currently supported commands are
 described below.
+.SS "OVSDB-SERVER COMMANDS"
+These commands are specific to \fBovsdb\-server\fR.
+.IP "\fBexit\fR"
+Causes \fBovsdb\-server\fR to gracefully terminate.
 .so lib/vlog-unixctl.man
 .SH "SEE ALSO"
 .
index eccbf7d1466d2be110b0713e116aced8ac6ca99c..ac3ae4a91fbcbcce32335845c255169df34ee91a 100644 (file)
@@ -52,7 +52,8 @@
 static unixctl_cb_func ovsdb_server_exit;
 
 static void parse_options(int argc, char *argv[], char **file_namep,
-                          struct shash *remotes, char **unixctl_pathp);
+                          struct shash *remotes, char **unixctl_pathp,
+                          char **run_command);
 static void usage(void) NO_RETURN;
 
 static void set_remotes(struct ovsdb_jsonrpc_server *jsonrpc,
@@ -62,11 +63,13 @@ int
 main(int argc, char *argv[])
 {
     char *unixctl_path = NULL;
+    char *run_command = NULL;
     struct unixctl_server *unixctl;
     struct ovsdb_jsonrpc_server *jsonrpc;
     struct shash remotes;
     struct ovsdb_error *error;
     struct ovsdb *db;
+    struct process *run_process;
     char *file_name;
     bool exiting;
     int retval;
@@ -78,7 +81,8 @@ main(int argc, char *argv[])
     signal(SIGPIPE, SIG_IGN);
     process_init();
 
-    parse_options(argc, argv, &file_name, &remotes, &unixctl_path);
+    parse_options(argc, argv, &file_name, &remotes, &unixctl_path,
+                  &run_command);
 
     die_if_already_running();
     daemonize_start();
@@ -96,6 +100,22 @@ main(int argc, char *argv[])
         exit(EXIT_FAILURE);
     }
 
+    if (run_command) {
+        char *run_argv[4];
+
+        run_argv[0] = "/bin/sh";
+        run_argv[1] = "-c";
+        run_argv[2] = run_command;
+        run_argv[3] = NULL;
+
+        retval = process_start(run_argv, NULL, 0, NULL, 0, &run_process);
+        if (retval) {
+            ovs_fatal(retval, "%s: process failed to start", run_command);
+        }
+    } else {
+        run_process = NULL;
+    }
+
     daemonize_complete();
 
     unixctl_command_register("exit", ovsdb_server_exit, &exiting);
@@ -106,10 +126,16 @@ main(int argc, char *argv[])
         ovsdb_jsonrpc_server_run(jsonrpc);
         unixctl_server_run(unixctl);
         ovsdb_trigger_run(db, time_msec());
+        if (run_process && process_exited(run_process)) {
+            exiting = true;
+        }
 
         ovsdb_jsonrpc_server_wait(jsonrpc);
         unixctl_server_wait(unixctl);
         ovsdb_trigger_wait(db, time_msec());
+        if (run_process) {
+            process_wait(run_process);
+        }
         poll_block();
     }
     ovsdb_jsonrpc_server_destroy(jsonrpc);
@@ -117,6 +143,14 @@ main(int argc, char *argv[])
     shash_destroy(&remotes);
     unixctl_server_destroy(unixctl);
 
+    if (run_process && process_exited(run_process)) {
+        int status = process_status(run_process);
+        if (status) {
+            ovs_fatal(0, "%s: child exited, %s",
+                      run_command, process_status_msg(status));
+        }
+    }
+
     return 0;
 }
 
@@ -202,12 +236,14 @@ ovsdb_server_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED,
 
 static void
 parse_options(int argc, char *argv[], char **file_namep,
-              struct shash *remotes, char **unixctl_pathp)
+              struct shash *remotes, char **unixctl_pathp,
+              char **run_command)
 {
     enum {
         OPT_DUMMY = UCHAR_MAX + 1,
         OPT_REMOTE,
         OPT_UNIXCTL,
+        OPT_RUN,
         OPT_BOOTSTRAP_CA_CERT,
         VLOG_OPTION_ENUMS,
         LEAK_CHECKER_OPTION_ENUMS
@@ -215,6 +251,7 @@ parse_options(int argc, char *argv[], char **file_namep,
     static struct option long_options[] = {
         {"remote",      required_argument, 0, OPT_REMOTE},
         {"unixctl",     required_argument, 0, OPT_UNIXCTL},
+        {"run",         required_argument, 0, OPT_RUN},
         {"help",        no_argument, 0, 'h'},
         {"version",     no_argument, 0, 'V'},
         DAEMON_LONG_OPTIONS,
@@ -246,6 +283,10 @@ parse_options(int argc, char *argv[], char **file_namep,
             *unixctl_pathp = optarg;
             break;
 
+        case OPT_RUN:
+            *run_command = optarg;
+            break;
+
         case 'h':
             usage();
 
@@ -301,6 +342,7 @@ usage(void)
     daemon_usage();
     vlog_usage();
     printf("\nOther options:\n"
+           "  --run COMMAND           run COMMAND as subprocess then exit\n"
            "  -h, --help              display this help message\n"
            "  -V, --version           display version information\n");
     leak_checker_usage();