ovs-cfg-mod: Add -T, --timeout option.

diff --git a/utilities/ovs-cfg-mod.8.in b/utilities/ovs-cfg-mod.8.in
index 0d1e474629959e466075c1db1c236c6bba8920ed..5b96f288ede04ba36a332026a42e83b3257dd210 100644 (file)
--- a/utilities/ovs-cfg-mod.8.in
+++ b/utilities/ovs-cfg-mod.8.in
@@ -1,82 +1,98 @@
-.TH ovs-cfg-mod 8 "April 2009" "Open vSwitch" "Open vSwitch Manual"
-.ds PN ovs-cfg-mod
+.\" -*- nroff -*-
+.de IQ
+.  br
+.  ns
+.  IP "\\$1"
+..
+.TH ovs\-cfg\-mod 8 "June 2009" "Open vSwitch" "Open vSwitch Manual"
+.ds PN ovs\-cfg\-mod
 .
 .SH NAME
-ovs-cfg-mod \- Safely manage a ovs\-vswitchd.conf-style configuration file
+ovs\-cfg\-mod \- Safely manage a ovs\-vswitchd.conf\-style configuration file
 .
 .SH SYNOPSIS
-.B ovs-cfg-mod
---config-file=\fIfile\fR [ \fIaction\fR ][ \fIaction\fR \fI...\fR ]
+\fB ovs\-cfg\-mod \fR[\fB\-T \fItimeout\fR] \fB\-F \fIfile\fR
+[\fIaction\fR] [\fIaction\fR...\fR]
 .
 .SH DESCRIPTION
-A program for managing a \fovs\-vswitchd.conf\fR(5)-style configuration
-file.  \fBovs-cfg-mod\fR uses the same locking mechanisms as
+A program for managing a \fovs\-vswitchd.conf\fR(5)\-style configuration
+file.  \fBovs\-cfg\-mod\fR uses the same locking mechanisms as
 \fBovs\-vswitchd\fR and its related utilities.  This allows it to be
-run safely on "live" configurations.
-
-The \fB--config-file\fR argument must be the first argument provided:
-.TP
-\fB-F\fR \fIfile\fR, \fB--config-file=\fIfile\fR
-.
-Use \fIfile\fR as the configuration file to modify.
-
+run safely on ``live'' configurations.
+.
+.SH OPTIONS
+.SS "Specifying the Configuration File"
+.
+.IP "\fB\-T\fR \fItimeout\fR
+.IQ "\fB\-\-timeout=\fItimeout\fR
+By default, \fBovs\-cfg\-mod\fR will wait forever to lock the
+configuration file specified on \fB\-F\fR or \fB\-\-config\-file\fR.  This
+option makes \fBovs\-cfg\-mod\fR wait no more than \fItimeout\fR
+milliseconds to obtain the lock, after which it exits unsuccessfully.
+.
+If it is present, this option must be specified before \fB\-F\fR or
+\fB\-\-config\-file\fR.
+.
+.IP "\fB\-F\fR \fIfile\fR"
+.IQ "\fB\-\-config\-file=\fIfile\fR"
+Use \fIfile\fR as the configuration file to query or modify.
+.
+This option is required.  It must be specified before any action
+options.
+.
 .SS "Specifying Actions"
-After a configuration file is specified, a series of one or more
-actions follows.  These are executed in the order provided and under a
+A series of one or more action options may follow the configuration
+file options.  These are executed in the order provided and under a
 single lock instance, so they appear atomic to external viewers of
 \fIfile\fR.
-
+.
 As discussed in \fBovs\-vswitchd.conf\fR(5), each line in the
-configuration file consists of a key-value pair.  Actions generally
+configuration file consists of a key\-value pair.  Actions generally
 take either a \fIkey\fR or \fIentry\fR argument.  A \fIkey\fR is a
-dot-separated description of a configuration option.  A \fIentry\fR is
-a key-value pair, separated by the '=' sign.
-
+dot\-separated description of a configuration option.  A \fIentry\fR is
+a key\-value pair, separated by the \fB=\fR sign.
+.
 The following actions are supported:
-
-.TP
-\fB-a\fR \fIentry\fR, \fB--add=\fIentry\fR
 .
+.IP "\fB\-a\fR \fIentry\fR"
+.IQ "\fB\-\-add=\fIentry\fR"
 Add \fIentry\fR to \fIfile\fR.  Please note that duplicates are
 allowed, so if a unique key is required, a delete must be done first.
-
-.TP
-\fB-d\fR \fIentry\fR, \fB--del-entry=\fIentry\fR
 .
+.IP "\fB\-d\fR \fIentry\fR"
+.IQ "\fB\-\-del\-entry=\fIentry\fR"
 Delete \fIentry\fR from \fIfile\fR.  Deletes only the first entry 
 that matches \fIentry\fR.  
-
-.TP
-\fB-D\fR \fIkey\fR, \fB--del-section=\fIkey\fR
 .
+.IP "\fB\-D\fR \fIkey\fR"
+.IQ "\fB\-\-del\-section=\fIkey\fR"
 Delete section \fIkey\fR from \fIfile\fR.  
-
-.IP "\fB--del-match=\fIpattern\fR"
+.
+.IP "\fB\-\-del\-match=\fIpattern\fR"
 Deletes every entry that matches the given shell glob \fIpattern\fR.
-For example, \fB--del-match=bridge.*.port=*\fR deletes all the ports
-from every bridge, and \fB--del-match=bonding.bond0.*\fR is equivalent
-to \fB--del-section=bonding.bond0\fR.
-
-.TP
-\fB-q\fR \fIkey\fR, \fB--query=\fIkey\fR
+For example, \fB\-\-del\-match=bridge.*.port=*\fR deletes all the ports
+from every bridge, and \fB\-\-del\-match=bonding.bond0.*\fR is equivalent
+to \fB\-\-del\-section=bonding.bond0\fR.
 .
+.IP "\fB\-q\fR \fIkey\fR"
+.IQ "\fB\-\-query=\fIkey\fR"
 Queries \fIfile\fR for entries that match \fIkey\fR.  Each matching
 value is printed on a separate line.  Duplicates will be printed
 multiple times.  
 .
-.IP "\fB-c\fR, \fB--changes\fR"
-.
+.IP "\fB\-c\fR"
+.IQ "\fB\-\-changes\fR"
 Logs all of the changes made to the configuration file in a ``unified
-diff''-like format.  Only actual changes are logged, so that if, for
-example, a \fB--del-match\fR action did not match any key-value pairs,
+diff''\-like format.  Only actual changes are logged, so that if, for
+example, a \fB\-\-del\-match\fR action did not match any key\-value pairs,
 then nothing will be logged due to that action.  Furthermore, only the
-net effects of changes are logged: if a key-value pair was deleted and
-then an identical key-value pair was added back, then nothing would be
+net effects of changes are logged: if a key\-value pair was deleted and
+then an identical key\-value pair was added back, then nothing would be
 logged due to those changes.
 .
 This action logs changes that have taken effect at the point where it
 is inserted.  Thus, if it is given before any other action, it will
-not log any changes.  If \fB--changes\fR is given more than once,
+not log any changes.  If \fB\-\-changes\fR is given more than once,
 instances after the first log only the changes since the previous
 instance.
 .

diff --git a/utilities/ovs-cfg-mod.c b/utilities/ovs-cfg-mod.c
index cb21a8d870bd4474a91d3d81bfc9d8f96be0fa51..53ebd00a9cc73c804009a0c17fe55232aa9dff10 100644 (file)
--- a/utilities/ovs-cfg-mod.c
+++ b/utilities/ovs-cfg-mod.c
@@ -50,6 +50,7 @@ usage(char *prog_name, int exit_code)
 {
     printf("Usage: %s --config-file=FILE ACTIONS\n"
            "\nConfig:\n"
+           "  -T, --timeout=MS        wait at most MS milliseconds for lock\n"
            "  -F, --config-file=FILE  use configuration FILE\n"
            "\nActions:\n"
            "  -a, --add=ENTRY         add ENTRY\n"
@@ -66,7 +67,7 @@ usage(char *prog_name, int exit_code)
 }
 
 static void 
-open_config(char *config_file) 
+open_config(char *config_file, int timeout) 
 {
     int error;
 
@@ -76,7 +77,7 @@ open_config(char *config_file)
                 config_file);
     }
 
-    error = cfg_lock(NULL, 0);
+    error = cfg_lock(NULL, timeout);
     if (error) {
         ovs_fatal(error, "could not lock configuration file\n");
     }
@@ -131,6 +132,7 @@ int main(int argc, char *argv[])
     };
     static const struct option long_options[] = {
         {"config-file",  required_argument, 0, 'F'},
+        {"timeout",      required_argument, 0, 'T'},
         {"add",          required_argument, 0, 'a'},
         {"del-entry",    required_argument, 0, 'd'},
         {"del-section",  required_argument, 0, 'D'},
@@ -144,6 +146,7 @@ int main(int argc, char *argv[])
     };
     char *short_options;
     bool config_set = false;
+    int timeout = INT_MAX;
 
     set_program_name(argv[0]);
     time_init();
@@ -164,8 +167,16 @@ int main(int argc, char *argv[])
         }
 
         switch (option) {
+        case 'T':
+            if (config_set) {
+                ovs_fatal(0, "--timeout or -T must be specified "
+                          "before --file or -F");
+            }
+            timeout = atoi(optarg);
+            break;
+
         case 'F': 
-            open_config(optarg);
+            open_config(optarg, timeout);
             config_set = true;
             break;