2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2016 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 "openvswitch/dynamic-string.h"
24 #include "openvswitch/json.h"
26 #include "openvswitch/list.h"
27 #include "poll-loop.h"
28 #include "openvswitch/shash.h"
30 #include "stream-provider.h"
32 #include "openvswitch/vlog.h"
34 VLOG_DEFINE_THIS_MODULE(unixctl);
36 COVERAGE_DEFINE(unixctl_received);
37 COVERAGE_DEFINE(unixctl_replied);
39 struct unixctl_command {
41 int min_args, max_args;
50 /* Only one request can be in progress at a time. While the request is
51 * being processed, 'request_id' is populated, otherwise it is null. */
52 struct json *request_id; /* ID of the currently active request. */
55 /* Server for control connection. */
56 struct unixctl_server {
57 struct pstream *listener;
58 struct ovs_list conns;
61 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 5);
63 static struct shash commands = SHASH_INITIALIZER(&commands);
66 unixctl_list_commands(struct unixctl_conn *conn, int argc OVS_UNUSED,
67 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
69 struct ds ds = DS_EMPTY_INITIALIZER;
70 const struct shash_node **nodes = shash_sort(&commands);
73 ds_put_cstr(&ds, "The available commands are:\n");
75 for (i = 0; i < shash_count(&commands); i++) {
76 const struct shash_node *node = nodes[i];
77 const struct unixctl_command *command = node->data;
79 ds_put_format(&ds, " %-23s %s\n", node->name, command->usage);
83 unixctl_command_reply(conn, ds_cstr(&ds));
88 unixctl_version(struct unixctl_conn *conn, int argc OVS_UNUSED,
89 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
91 unixctl_command_reply(conn, ovs_get_program_version());
94 /* Registers a unixctl command with the given 'name'. 'usage' describes the
95 * arguments to the command; it is used only for presentation to the user in
96 * "list-commands" output.
98 * 'cb' is called when the command is received. It is passed an array
99 * containing the command name and arguments, plus a copy of 'aux'. Normally
100 * 'cb' should reply by calling unixctl_command_reply() or
101 * unixctl_command_reply_error() before it returns, but if the command cannot
102 * be handled immediately then it can defer the reply until later. A given
103 * connection can only process a single request at a time, so a reply must be
104 * made eventually to avoid blocking that connection. */
106 unixctl_command_register(const char *name, const char *usage,
107 int min_args, int max_args,
108 unixctl_cb_func *cb, void *aux)
110 struct unixctl_command *command;
111 struct unixctl_command *lookup = shash_find_data(&commands, name);
113 ovs_assert(!lookup || lookup->cb == cb);
119 command = xmalloc(sizeof *command);
120 command->usage = usage;
121 command->min_args = min_args;
122 command->max_args = max_args;
125 shash_add(&commands, name, command);
129 unixctl_command_reply__(struct unixctl_conn *conn,
130 bool success, const char *body)
132 struct json *body_json;
133 struct jsonrpc_msg *reply;
135 COVERAGE_INC(unixctl_replied);
136 ovs_assert(conn->request_id);
142 if (body[0] && body[strlen(body) - 1] != '\n') {
143 body_json = json_string_create_nocopy(xasprintf("%s\n", body));
145 body_json = json_string_create(body);
149 reply = jsonrpc_create_reply(body_json, conn->request_id);
151 reply = jsonrpc_create_error(body_json, conn->request_id);
154 if (VLOG_IS_DBG_ENABLED()) {
155 char *id = json_to_string(conn->request_id, 0);
156 VLOG_DBG("replying with %s, id=%s: \"%s\"",
157 success ? "success" : "error", id, body);
161 /* If jsonrpc_send() returns an error, the run loop will take care of the
162 * problem eventually. */
163 jsonrpc_send(conn->rpc, reply);
164 json_destroy(conn->request_id);
165 conn->request_id = NULL;
168 /* Replies to the active unixctl connection 'conn'. 'result' is sent to the
169 * client indicating the command was processed successfully. Only one call to
170 * unixctl_command_reply() or unixctl_command_reply_error() may be made per
173 unixctl_command_reply(struct unixctl_conn *conn, const char *result)
175 unixctl_command_reply__(conn, true, result);
178 /* Replies to the active unixctl connection 'conn'. 'error' is sent to the
179 * client indicating an error occurred processing the command. Only one call to
180 * unixctl_command_reply() or unixctl_command_reply_error() may be made per
183 unixctl_command_reply_error(struct unixctl_conn *conn, const char *error)
185 unixctl_command_reply__(conn, false, error);
188 /* Creates a unixctl server listening on 'path', which for POSIX may be:
190 * - NULL, in which case <rundir>/<program>.<pid>.ctl is used.
192 * - A name that does not start with '/', in which case it is put in
195 * - An absolute path (starting with '/') that gives the exact name of
196 * the Unix domain socket to listen on.
198 * For Windows, a kernel assigned TCP port is used and written in 'path'
201 * - NULL, in which case <rundir>/<program>.ctl is used.
203 * - An absolute path that gives the name of the file.
205 * For both POSIX and Windows, if the path is "none", the function will
206 * return successfully but no socket will actually be created.
208 * A program that (optionally) daemonizes itself should call this function
209 * *after* daemonization, so that the socket name contains the pid of the
210 * daemon instead of the pid of the program that exited. (Otherwise,
211 * "ovs-appctl --target=<program>" will fail.)
213 * Returns 0 if successful, otherwise a positive errno value. If successful,
214 * sets '*serverp' to the new unixctl_server (or to NULL if 'path' was "none"),
215 * otherwise to NULL. */
217 unixctl_server_create(const char *path, struct unixctl_server **serverp)
219 struct unixctl_server *server;
220 struct pstream *listener;
225 if (path && !strcmp(path, "none")) {
232 abs_path = abs_file_name(ovs_rundir(), path);
234 abs_path = xstrdup(path);
236 punix_path = xasprintf("punix:%s", abs_path);
240 punix_path = xasprintf("punix:%s/%s.%ld.ctl", ovs_rundir(),
241 program_name, (long int) getpid());
243 punix_path = xasprintf("punix:%s/%s.ctl", ovs_rundir(), program_name);
247 error = pstream_open(punix_path, &listener, 0);
249 ovs_error(error, "could not initialize control socket %s", punix_path);
253 unixctl_command_register("list-commands", "", 0, 0, unixctl_list_commands,
255 unixctl_command_register("version", "", 0, 0, unixctl_version, NULL);
257 server = xmalloc(sizeof *server);
258 server->listener = listener;
259 ovs_list_init(&server->conns);
268 process_command(struct unixctl_conn *conn, struct jsonrpc_msg *request)
272 struct unixctl_command *command;
273 struct json_array *params;
275 COVERAGE_INC(unixctl_received);
276 conn->request_id = json_clone(request->id);
278 if (VLOG_IS_DBG_ENABLED()) {
279 char *params_s = json_to_string(request->params, 0);
280 char *id_s = json_to_string(request->id, 0);
281 VLOG_DBG("received request %s%s, id=%s",
282 request->method, params_s, id_s);
287 params = json_array(request->params);
288 command = shash_find_data(&commands, request->method);
290 error = xasprintf("\"%s\" is not a valid command", request->method);
291 } else if (params->n < command->min_args) {
292 error = xasprintf("\"%s\" command requires at least %d arguments",
293 request->method, command->min_args);
294 } else if (params->n > command->max_args) {
295 error = xasprintf("\"%s\" command takes at most %d arguments",
296 request->method, command->max_args);
298 struct svec argv = SVEC_EMPTY_INITIALIZER;
301 svec_add(&argv, request->method);
302 for (i = 0; i < params->n; i++) {
303 if (params->elems[i]->type != JSON_STRING) {
304 error = xasprintf("\"%s\" command has non-string argument",
308 svec_add(&argv, json_string(params->elems[i]));
310 svec_terminate(&argv);
313 command->cb(conn, argv.n, (const char **) argv.names,
321 unixctl_command_reply_error(conn, error);
327 run_connection(struct unixctl_conn *conn)
331 jsonrpc_run(conn->rpc);
332 error = jsonrpc_get_status(conn->rpc);
333 if (error || jsonrpc_get_backlog(conn->rpc)) {
337 for (i = 0; i < 10; i++) {
338 struct jsonrpc_msg *msg;
340 if (error || conn->request_id) {
344 jsonrpc_recv(conn->rpc, &msg);
346 if (msg->type == JSONRPC_REQUEST) {
347 process_command(conn, msg);
349 VLOG_WARN_RL(&rl, "%s: received unexpected %s message",
350 jsonrpc_get_name(conn->rpc),
351 jsonrpc_msg_type_to_string(msg->type));
354 jsonrpc_msg_destroy(msg);
356 error = error ? error : jsonrpc_get_status(conn->rpc);
363 kill_connection(struct unixctl_conn *conn)
365 ovs_list_remove(&conn->node);
366 jsonrpc_close(conn->rpc);
367 json_destroy(conn->request_id);
372 unixctl_server_run(struct unixctl_server *server)
374 struct unixctl_conn *conn, *next;
381 for (i = 0; i < 10; i++) {
382 struct stream *stream;
385 error = pstream_accept(server->listener, &stream);
387 struct unixctl_conn *conn = xzalloc(sizeof *conn);
388 ovs_list_push_back(&server->conns, &conn->node);
389 conn->rpc = jsonrpc_open(stream);
390 } else if (error == EAGAIN) {
393 VLOG_WARN_RL(&rl, "%s: accept failed: %s",
394 pstream_get_name(server->listener),
395 ovs_strerror(error));
399 LIST_FOR_EACH_SAFE (conn, next, node, &server->conns) {
400 int error = run_connection(conn);
401 if (error && error != EAGAIN) {
402 kill_connection(conn);
408 unixctl_server_wait(struct unixctl_server *server)
410 struct unixctl_conn *conn;
416 pstream_wait(server->listener);
417 LIST_FOR_EACH (conn, node, &server->conns) {
418 jsonrpc_wait(conn->rpc);
419 if (!jsonrpc_get_backlog(conn->rpc)) {
420 jsonrpc_recv_wait(conn->rpc);
425 /* Destroys 'server' and stops listening for connections. */
427 unixctl_server_destroy(struct unixctl_server *server)
430 struct unixctl_conn *conn, *next;
432 LIST_FOR_EACH_SAFE (conn, next, node, &server->conns) {
433 kill_connection(conn);
436 pstream_close(server->listener);
441 /* On POSIX based systems, connects to a unixctl server socket. 'path' should
442 * be the name of a unixctl server socket. If it does not start with '/', it
443 * will be prefixed with the rundir (e.g. /usr/local/var/run/openvswitch).
445 * On Windows, connects to a localhost TCP port as written inside 'path'.
446 * 'path' should be an absolute path of the file.
448 * Returns 0 if successful, otherwise a positive errno value. If successful,
449 * sets '*client' to the new jsonrpc, otherwise to NULL. */
451 unixctl_client_create(const char *path, struct jsonrpc **client)
453 char *abs_path, *unix_path;
454 struct stream *stream;
458 abs_path = xstrdup(path);
460 abs_path = abs_file_name(ovs_rundir(), path);
462 unix_path = xasprintf("unix:%s", abs_path);
466 error = stream_open_block(stream_open(unix_path, &stream, DSCP_DEFAULT),
472 VLOG_WARN("failed to connect to %s", path);
476 *client = jsonrpc_open(stream);
480 /* Executes 'command' on the server with an argument vector 'argv' containing
481 * 'argc' elements. If successfully communicated with the server, returns 0
482 * and sets '*result', or '*err' (not both) to the result or error the server
483 * returned. Otherwise, sets '*result' and '*err' to NULL and returns a
484 * positive errno value. The caller is responsible for freeing '*result' or
485 * '*err' if not NULL. */
487 unixctl_client_transact(struct jsonrpc *client, const char *command, int argc,
488 char *argv[], char **result, char **err)
490 struct jsonrpc_msg *request, *reply;
491 struct json **json_args, *params;
497 json_args = xmalloc(argc * sizeof *json_args);
498 for (i = 0; i < argc; i++) {
499 json_args[i] = json_string_create(argv[i]);
501 params = json_array_create(json_args, argc);
502 request = jsonrpc_create_request(command, params, NULL);
504 error = jsonrpc_transact_block(client, request, &reply);
506 VLOG_WARN("error communicating with %s: %s", jsonrpc_get_name(client),
507 ovs_retval_to_string(error));
512 if (reply->error->type == JSON_STRING) {
513 *err = xstrdup(json_string(reply->error));
515 VLOG_WARN("%s: unexpected error type in JSON RPC reply: %s",
516 jsonrpc_get_name(client),
517 json_type_to_string(reply->error->type));
520 } else if (reply->result) {
521 if (reply->result->type == JSON_STRING) {
522 *result = xstrdup(json_string(reply->result));
524 VLOG_WARN("%s: unexpected result type in JSON rpc reply: %s",
525 jsonrpc_get_name(client),
526 json_type_to_string(reply->result->type));
531 jsonrpc_msg_destroy(reply);