2 * Copyright (c) 2008, 2009, 2010, 2011, 2013, 2014 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "command-line.h"
22 #include "openvswitch/dynamic-string.h"
23 #include "ovs-thread.h"
25 #include "openvswitch/vlog.h"
27 VLOG_DEFINE_THIS_MODULE(command_line
);
29 /* Given the GNU-style long options in 'options', returns a string that may be
30 * passed to getopt() with the corresponding short options. The caller is
31 * responsible for freeing the string. */
33 ovs_cmdl_long_options_to_short_options(const struct option options
[])
35 char short_options
[UCHAR_MAX
* 3 + 1];
36 char *p
= short_options
;
38 for (; options
->name
; options
++) {
39 const struct option
*o
= options
;
40 if (o
->flag
== NULL
&& o
->val
> 0 && o
->val
<= UCHAR_MAX
) {
42 if (o
->has_arg
== required_argument
) {
44 } else if (o
->has_arg
== optional_argument
) {
52 return xstrdup(short_options
);
55 /* Given the 'struct ovs_cmdl_command' array, prints the usage of all commands. */
57 ovs_cmdl_print_commands(const struct ovs_cmdl_command commands
[])
59 struct ds ds
= DS_EMPTY_INITIALIZER
;
61 ds_put_cstr(&ds
, "The available commands are:\n");
62 for (; commands
->name
; commands
++) {
63 const struct ovs_cmdl_command
*c
= commands
;
64 ds_put_format(&ds
, " %-23s %s\n", c
->name
, c
->usage
? c
->usage
: "");
66 printf("%s", ds
.string
);
70 /* Given the GNU-style options in 'options', prints all options. */
72 ovs_cmdl_print_options(const struct option options
[])
74 struct ds ds
= DS_EMPTY_INITIALIZER
;
76 for (; options
->name
; options
++) {
77 const struct option
*o
= options
;
78 const char *arg
= o
->has_arg
== required_argument
? "ARG" : "[ARG]";
80 ds_put_format(&ds
, "--%s%s%s\n", o
->name
, o
->has_arg
? "=" : "",
81 o
->has_arg
? arg
: "");
82 if (o
->flag
== NULL
&& o
->val
> 0 && o
->val
<= UCHAR_MAX
) {
83 ds_put_format(&ds
, "-%c %s\n", o
->val
, o
->has_arg
? arg
: "");
86 printf("%s", ds
.string
);
91 ovs_cmdl_run_command__(struct ovs_cmdl_context
*ctx
,
92 const struct ovs_cmdl_command commands
[],
95 const struct ovs_cmdl_command
*p
;
98 ovs_fatal(0, "missing command name; use --help for help");
101 for (p
= commands
; p
->name
!= NULL
; p
++) {
102 if (!strcmp(p
->name
, ctx
->argv
[0])) {
103 int n_arg
= ctx
->argc
- 1;
104 if (n_arg
< p
->min_args
) {
105 VLOG_FATAL( "'%s' command requires at least %d arguments",
106 p
->name
, p
->min_args
);
107 } else if (n_arg
> p
->max_args
) {
108 VLOG_FATAL("'%s' command takes at most %d arguments",
109 p
->name
, p
->max_args
);
111 if (p
->mode
== OVS_RW
&& read_only
) {
112 VLOG_FATAL("'%s' command does not work in read only mode",
116 if (ferror(stdout
)) {
117 VLOG_FATAL("write to stdout failed");
119 if (ferror(stderr
)) {
120 VLOG_FATAL("write to stderr failed");
127 VLOG_FATAL("unknown command '%s'; use --help for help", ctx
->argv
[0]);
130 /* Runs the command designated by argv[0] within the command table specified by
131 * 'commands', which must be terminated by a command whose 'name' member is a
134 * Command-line options should be stripped off, so that a typical invocation
136 * struct ovs_cmdl_context ctx = {
137 * .argc = argc - optind,
138 * .argv = argv + optind,
140 * ovs_cmdl_run_command(&ctx, my_commands);
143 ovs_cmdl_run_command(struct ovs_cmdl_context
*ctx
,
144 const struct ovs_cmdl_command commands
[])
146 ovs_cmdl_run_command__(ctx
, commands
, false);
150 ovs_cmdl_run_command_read_only(struct ovs_cmdl_context
*ctx
,
151 const struct ovs_cmdl_command commands
[])
153 ovs_cmdl_run_command__(ctx
, commands
, true);
159 static struct ovs_mutex proctitle_mutex
= OVS_MUTEX_INITIALIZER
;
161 /* Start of command-line arguments in memory. */
162 static char *argv_start
OVS_GUARDED_BY(proctitle_mutex
);
164 /* Number of bytes of command-line arguments. */
165 static size_t argv_size
OVS_GUARDED_BY(proctitle_mutex
);
167 /* Saved command-line arguments. */
168 static char *saved_proctitle
OVS_GUARDED_BY(proctitle_mutex
);
170 /* Prepares the process so that proctitle_set() can later succeed.
172 * This modifies the argv[] array so that it no longer points into the memory
173 * that it originally does. Later, proctitle_set() might overwrite that
174 * memory. That means that this function should be called before anything else
175 * that accesses the process's argv[] array. Ideally, it should be called
176 * before anything else, period, at the very beginning of program
179 ovs_cmdl_proctitle_init(int argc
, char **argv
)
183 assert_single_threaded();
184 if (!argc
|| !argv
[0]) {
185 /* This situation should never occur, but... */
189 ovs_mutex_lock(&proctitle_mutex
);
190 /* Specialized version of first loop iteration below. */
191 argv_start
= argv
[0];
192 argv_size
= strlen(argv
[0]) + 1;
193 argv
[0] = xstrdup(argv
[0]);
195 for (i
= 1; i
< argc
; i
++) {
196 size_t size
= strlen(argv
[i
]) + 1;
198 /* Add (argv[i], strlen(argv[i])+1) to (argv_start, argv_size). */
199 if (argv
[i
] + size
== argv_start
) {
200 /* Arguments grow downward in memory. */
203 } else if (argv
[i
] == argv_start
+ argv_size
) {
204 /* Arguments grow upward in memory. */
207 /* Arguments not contiguous. (Is this really Linux?) */
210 /* Copy out the old argument so we can reuse the space. */
211 argv
[i
] = xstrdup(argv
[i
]);
213 ovs_mutex_unlock(&proctitle_mutex
);
216 /* Changes the name of the process, as shown by "ps", to the program name
217 * followed by 'format', which is formatted as if by printf(). */
219 ovs_cmdl_proctitle_set(const char *format
, ...)
224 ovs_mutex_lock(&proctitle_mutex
);
225 if (!argv_start
|| argv_size
< 8) {
229 if (!saved_proctitle
) {
230 saved_proctitle
= xmemdup(argv_start
, argv_size
);
233 va_start(args
, format
);
234 n
= snprintf(argv_start
, argv_size
, "%s: ", program_name
);
236 n
+= vsnprintf(argv_start
+ n
, argv_size
- n
, format
, args
);
238 if (n
>= argv_size
) {
239 /* The name is too long, so add an ellipsis at the end. */
240 strcpy(&argv_start
[argv_size
- 4], "...");
242 /* Fill the extra space with null bytes, so that trailing bytes don't
243 * show up in the command line. */
244 memset(&argv_start
[n
], '\0', argv_size
- n
);
249 ovs_mutex_unlock(&proctitle_mutex
);
252 /* Restores the process's original command line, as seen by "ps". */
254 ovs_cmdl_proctitle_restore(void)
256 ovs_mutex_lock(&proctitle_mutex
);
257 if (saved_proctitle
) {
258 memcpy(argv_start
, saved_proctitle
, argv_size
);
259 free(saved_proctitle
);
260 saved_proctitle
= NULL
;
262 ovs_mutex_unlock(&proctitle_mutex
);
264 #else /* !__linux__ */
265 /* Stubs that don't do anything on non-Linux systems. */
268 ovs_cmdl_proctitle_init(int argc OVS_UNUSED
, char **argv OVS_UNUSED
)
272 #if !(defined(__FreeBSD__) || defined(__NetBSD__))
273 /* On these platforms we #define this to setproctitle. */
275 ovs_cmdl_proctitle_set(const char *format OVS_UNUSED
, ...)
281 ovs_cmdl_proctitle_restore(void)
284 #endif /* !__linux__ */