]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/unixctl.c
2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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.
23 #include "dynamic-string.h"
27 #include "poll-loop.h"
33 VLOG_DEFINE_THIS_MODULE(unixctl
);
35 COVERAGE_DEFINE(unixctl_received
);
36 COVERAGE_DEFINE(unixctl_replied
);
38 struct unixctl_command
{
40 int min_args
, max_args
;
49 /* Only one request can be in progress at a time. While the request is
50 * being processed, 'request_id' is populated, otherwise it is null. */
51 struct json
*request_id
; /* ID of the currently active request. */
54 /* Server for control connection. */
55 struct unixctl_server
{
56 struct pstream
*listener
;
60 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(5, 5);
62 static struct shash commands
= SHASH_INITIALIZER(&commands
);
65 unixctl_help(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
66 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
68 struct ds ds
= DS_EMPTY_INITIALIZER
;
69 const struct shash_node
**nodes
= shash_sort(&commands
);
72 ds_put_cstr(&ds
, "The available commands are:\n");
74 for (i
= 0; i
< shash_count(&commands
); i
++) {
75 const struct shash_node
*node
= nodes
[i
];
76 const struct unixctl_command
*command
= node
->data
;
78 ds_put_format(&ds
, " %-23s %s\n", node
->name
, command
->usage
);
82 unixctl_command_reply(conn
, ds_cstr(&ds
));
87 unixctl_version(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
88 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
90 unixctl_command_reply(conn
, get_program_version());
93 /* Registers a unixctl command with the given 'name'. 'usage' describes the
94 * arguments to the command; it is used only for presentation to the user in
97 * 'cb' is called when the command is received. It is passed an array
98 * containing the command name and arguments, plus a copy of 'aux'. Normally
99 * 'cb' should reply by calling unixctl_command_reply() or
100 * unixctl_command_reply_error() before it returns, but if the command cannot
101 * be handled immediately then it can defer the reply until later. A given
102 * connection can only process a single request at a time, so a reply must be
103 * made eventually to avoid blocking that connection. */
105 unixctl_command_register(const char *name
, const char *usage
,
106 int min_args
, int max_args
,
107 unixctl_cb_func
*cb
, void *aux
)
109 struct unixctl_command
*command
;
110 struct unixctl_command
*lookup
= shash_find_data(&commands
, name
);
112 ovs_assert(!lookup
|| lookup
->cb
== cb
);
118 command
= xmalloc(sizeof *command
);
119 command
->usage
= usage
;
120 command
->min_args
= min_args
;
121 command
->max_args
= max_args
;
124 shash_add(&commands
, name
, command
);
128 unixctl_command_reply__(struct unixctl_conn
*conn
,
129 bool success
, const char *body
)
131 struct json
*body_json
;
132 struct jsonrpc_msg
*reply
;
134 COVERAGE_INC(unixctl_replied
);
135 ovs_assert(conn
->request_id
);
141 if (body
[0] && body
[strlen(body
) - 1] != '\n') {
142 body_json
= json_string_create_nocopy(xasprintf("%s\n", body
));
144 body_json
= json_string_create(body
);
148 reply
= jsonrpc_create_reply(body_json
, conn
->request_id
);
150 reply
= jsonrpc_create_error(body_json
, conn
->request_id
);
153 /* If jsonrpc_send() returns an error, the run loop will take care of the
154 * problem eventually. */
155 jsonrpc_send(conn
->rpc
, reply
);
156 json_destroy(conn
->request_id
);
157 conn
->request_id
= NULL
;
160 /* Replies to the active unixctl connection 'conn'. 'result' is sent to the
161 * client indicating the command was processed successfully. Only one call to
162 * unixctl_command_reply() or unixctl_command_reply_error() may be made per
165 unixctl_command_reply(struct unixctl_conn
*conn
, const char *result
)
167 unixctl_command_reply__(conn
, true, result
);
170 /* Replies to the active unixctl connection 'conn'. 'error' is sent to the
171 * client indicating an error occured processing the command. Only one call to
172 * unixctl_command_reply() or unixctl_command_reply_error() may be made per
175 unixctl_command_reply_error(struct unixctl_conn
*conn
, const char *error
)
177 unixctl_command_reply__(conn
, false, error
);
180 /* Creates a unixctl server listening on 'path', which may be:
182 * - NULL, in which case <rundir>/<program>.<pid>.ctl is used.
184 * - "none", in which case the function will return successfully but
185 * no socket will actually be created.
187 * - A name that does not start with '/', in which case it is put in
190 * - An absolute path (starting with '/') that gives the exact name of
191 * the Unix domain socket to listen on.
193 * A program that (optionally) daemonizes itself should call this function
194 * *after* daemonization, so that the socket name contains the pid of the
195 * daemon instead of the pid of the program that exited. (Otherwise,
196 * "ovs-appctl --target=<program>" will fail.)
198 * Returns 0 if successful, otherwise a positive errno value. If successful,
199 * sets '*serverp' to the new unixctl_server (or to NULL if 'path' was "none"),
200 * otherwise to NULL. */
202 unixctl_server_create(const char *path
, struct unixctl_server
**serverp
)
204 struct unixctl_server
*server
;
205 struct pstream
*listener
;
210 if (path
&& !strcmp(path
, "none")) {
215 char *abs_path
= abs_file_name(ovs_rundir(), path
);
216 punix_path
= xasprintf("punix:%s", abs_path
);
219 punix_path
= xasprintf("punix:%s/%s.%ld.ctl", ovs_rundir(),
220 program_name
, (long int) getpid());
223 error
= pstream_open(punix_path
, &listener
, 0);
225 ovs_error(error
, "could not initialize control socket %s", punix_path
);
229 unixctl_command_register("help", "", 0, 0, unixctl_help
, NULL
);
230 unixctl_command_register("version", "", 0, 0, unixctl_version
, NULL
);
232 server
= xmalloc(sizeof *server
);
233 server
->listener
= listener
;
234 list_init(&server
->conns
);
243 process_command(struct unixctl_conn
*conn
, struct jsonrpc_msg
*request
)
247 struct unixctl_command
*command
;
248 struct json_array
*params
;
250 COVERAGE_INC(unixctl_received
);
251 conn
->request_id
= json_clone(request
->id
);
253 params
= json_array(request
->params
);
254 command
= shash_find_data(&commands
, request
->method
);
256 error
= xasprintf("\"%s\" is not a valid command", request
->method
);
257 } else if (params
->n
< command
->min_args
) {
258 error
= xasprintf("\"%s\" command requires at least %d arguments",
259 request
->method
, command
->min_args
);
260 } else if (params
->n
> command
->max_args
) {
261 error
= xasprintf("\"%s\" command takes at most %d arguments",
262 request
->method
, command
->max_args
);
264 struct svec argv
= SVEC_EMPTY_INITIALIZER
;
267 svec_add(&argv
, request
->method
);
268 for (i
= 0; i
< params
->n
; i
++) {
269 if (params
->elems
[i
]->type
!= JSON_STRING
) {
270 error
= xasprintf("\"%s\" command has non-string argument",
274 svec_add(&argv
, json_string(params
->elems
[i
]));
276 svec_terminate(&argv
);
279 command
->cb(conn
, argv
.n
, (const char **) argv
.names
,
287 unixctl_command_reply_error(conn
, error
);
293 run_connection(struct unixctl_conn
*conn
)
297 jsonrpc_run(conn
->rpc
);
298 error
= jsonrpc_get_status(conn
->rpc
);
299 if (error
|| jsonrpc_get_backlog(conn
->rpc
)) {
303 for (i
= 0; i
< 10; i
++) {
304 struct jsonrpc_msg
*msg
;
306 if (error
|| conn
->request_id
) {
310 jsonrpc_recv(conn
->rpc
, &msg
);
312 if (msg
->type
== JSONRPC_REQUEST
) {
313 process_command(conn
, msg
);
315 VLOG_WARN_RL(&rl
, "%s: received unexpected %s message",
316 jsonrpc_get_name(conn
->rpc
),
317 jsonrpc_msg_type_to_string(msg
->type
));
320 jsonrpc_msg_destroy(msg
);
322 error
= error
? error
: jsonrpc_get_status(conn
->rpc
);
329 kill_connection(struct unixctl_conn
*conn
)
331 list_remove(&conn
->node
);
332 jsonrpc_close(conn
->rpc
);
333 json_destroy(conn
->request_id
);
338 unixctl_server_run(struct unixctl_server
*server
)
340 struct unixctl_conn
*conn
, *next
;
347 for (i
= 0; i
< 10; i
++) {
348 struct stream
*stream
;
351 error
= pstream_accept(server
->listener
, &stream
);
353 struct unixctl_conn
*conn
= xzalloc(sizeof *conn
);
354 list_push_back(&server
->conns
, &conn
->node
);
355 conn
->rpc
= jsonrpc_open(stream
);
356 } else if (error
== EAGAIN
) {
359 VLOG_WARN_RL(&rl
, "%s: accept failed: %s",
360 pstream_get_name(server
->listener
),
365 LIST_FOR_EACH_SAFE (conn
, next
, node
, &server
->conns
) {
366 int error
= run_connection(conn
);
367 if (error
&& error
!= EAGAIN
) {
368 kill_connection(conn
);
374 unixctl_server_wait(struct unixctl_server
*server
)
376 struct unixctl_conn
*conn
;
382 pstream_wait(server
->listener
);
383 LIST_FOR_EACH (conn
, node
, &server
->conns
) {
384 jsonrpc_wait(conn
->rpc
);
385 if (!jsonrpc_get_backlog(conn
->rpc
)) {
386 jsonrpc_recv_wait(conn
->rpc
);
391 /* Destroys 'server' and stops listening for connections. */
393 unixctl_server_destroy(struct unixctl_server
*server
)
396 struct unixctl_conn
*conn
, *next
;
398 LIST_FOR_EACH_SAFE (conn
, next
, node
, &server
->conns
) {
399 kill_connection(conn
);
402 pstream_close(server
->listener
);
407 /* Connects to a unixctl server socket. 'path' should be the name of a unixctl
408 * server socket. If it does not start with '/', it will be prefixed with the
409 * rundir (e.g. /usr/local/var/run/openvswitch).
411 * Returns 0 if successful, otherwise a positive errno value. If successful,
412 * sets '*client' to the new jsonrpc, otherwise to NULL. */
414 unixctl_client_create(const char *path
, struct jsonrpc
**client
)
416 char *abs_path
, *unix_path
;
417 struct stream
*stream
;
422 abs_path
= abs_file_name(ovs_rundir(), path
);
423 unix_path
= xasprintf("unix:%s", abs_path
);
424 error
= stream_open_block(stream_open(unix_path
, &stream
, DSCP_DEFAULT
),
430 VLOG_WARN("failed to connect to %s", path
);
434 *client
= jsonrpc_open(stream
);
438 /* Executes 'command' on the server with an argument vector 'argv' containing
439 * 'argc' elements. If successfully communicated with the server, returns 0
440 * and sets '*result', or '*err' (not both) to the result or error the server
441 * returned. Otherwise, sets '*result' and '*err' to NULL and returns a
442 * positive errno value. The caller is responsible for freeing '*result' or
443 * '*err' if not NULL. */
445 unixctl_client_transact(struct jsonrpc
*client
, const char *command
, int argc
,
446 char *argv
[], char **result
, char **err
)
448 struct jsonrpc_msg
*request
, *reply
;
449 struct json
**json_args
, *params
;
455 json_args
= xmalloc(argc
* sizeof *json_args
);
456 for (i
= 0; i
< argc
; i
++) {
457 json_args
[i
] = json_string_create(argv
[i
]);
459 params
= json_array_create(json_args
, argc
);
460 request
= jsonrpc_create_request(command
, params
, NULL
);
462 error
= jsonrpc_transact_block(client
, request
, &reply
);
464 VLOG_WARN("error communicating with %s: %s", jsonrpc_get_name(client
),
470 if (reply
->error
->type
== JSON_STRING
) {
471 *err
= xstrdup(json_string(reply
->error
));
473 VLOG_WARN("%s: unexpected error type in JSON RPC reply: %s",
474 jsonrpc_get_name(client
),
475 json_type_to_string(reply
->error
->type
));
478 } else if (reply
->result
) {
479 if (reply
->result
->type
== JSON_STRING
) {
480 *result
= xstrdup(json_string(reply
->result
));
482 VLOG_WARN("%s: unexpected result type in JSON rpc reply: %s",
483 jsonrpc_get_name(client
),
484 json_type_to_string(reply
->result
->type
));
489 jsonrpc_msg_destroy(reply
);