1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include "jsonrpc-server.h"
24 #include "dynamic-string.h"
28 #include "ovsdb-error.h"
29 #include "ovsdb-parser.h"
31 #include "poll-loop.h"
32 #include "reconnect.h"
39 #include "transaction.h"
41 #include "openvswitch/vlog.h"
43 VLOG_DEFINE_THIS_MODULE(ovsdb_jsonrpc_server);
45 struct ovsdb_jsonrpc_remote;
46 struct ovsdb_jsonrpc_session;
48 /* Set false to defeature monitor2, causing jsonrpc to respond to monitor2
49 * method with an error. */
50 static bool monitor2_enable__ = true;
52 /* Message rate-limiting. */
53 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
56 static struct ovsdb_jsonrpc_session *ovsdb_jsonrpc_session_create(
57 struct ovsdb_jsonrpc_remote *, struct jsonrpc_session *);
58 static void ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *);
59 static void ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *);
60 static void ovsdb_jsonrpc_session_get_memory_usage_all(
61 const struct ovsdb_jsonrpc_remote *, struct simap *usage);
62 static void ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *);
63 static void ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *);
64 static void ovsdb_jsonrpc_session_set_all_options(
65 struct ovsdb_jsonrpc_remote *, const struct ovsdb_jsonrpc_options *);
66 static bool ovsdb_jsonrpc_session_get_status(
67 const struct ovsdb_jsonrpc_remote *,
68 struct ovsdb_jsonrpc_remote_status *);
69 static void ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *);
70 static void ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *);
71 static void ovsdb_jsonrpc_session_send(struct ovsdb_jsonrpc_session *,
72 struct jsonrpc_msg *);
75 static void ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *,
77 struct json *id, struct json *params);
78 static struct ovsdb_jsonrpc_trigger *ovsdb_jsonrpc_trigger_find(
79 struct ovsdb_jsonrpc_session *, const struct json *id, size_t hash);
80 static void ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *);
81 static void ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *);
82 static void ovsdb_jsonrpc_trigger_complete_done(
83 struct ovsdb_jsonrpc_session *);
86 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_create(
87 struct ovsdb_jsonrpc_session *, struct ovsdb *, struct json *params,
88 enum ovsdb_monitor_version, const struct json *request_id);
89 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_cancel(
90 struct ovsdb_jsonrpc_session *,
91 struct json_array *params,
92 const struct json *request_id);
93 static void ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *);
94 static void ovsdb_jsonrpc_monitor_flush_all(struct ovsdb_jsonrpc_session *);
95 static bool ovsdb_jsonrpc_monitor_needs_flush(struct ovsdb_jsonrpc_session *);
96 static struct json *ovsdb_jsonrpc_monitor_compose_update(
97 struct ovsdb_jsonrpc_monitor *monitor, bool initial);
100 /* JSON-RPC database server. */
102 struct ovsdb_jsonrpc_server {
103 struct ovsdb_server up;
104 unsigned int n_sessions, max_sessions;
105 struct shash remotes; /* Contains "struct ovsdb_jsonrpc_remote *"s. */
108 /* A configured remote. This is either a passive stream listener plus a list
109 * of the currently connected sessions, or a list of exactly one active
111 struct ovsdb_jsonrpc_remote {
112 struct ovsdb_jsonrpc_server *server;
113 struct pstream *listener; /* Listener, if passive. */
114 struct ovs_list sessions; /* List of "struct ovsdb_jsonrpc_session"s. */
118 static struct ovsdb_jsonrpc_remote *ovsdb_jsonrpc_server_add_remote(
119 struct ovsdb_jsonrpc_server *, const char *name,
120 const struct ovsdb_jsonrpc_options *options
122 static void ovsdb_jsonrpc_server_del_remote(struct shash_node *);
124 /* Creates and returns a new server to provide JSON-RPC access to an OVSDB.
126 * The caller must call ovsdb_jsonrpc_server_add_db() for each database to
127 * which 'server' should provide access. */
128 struct ovsdb_jsonrpc_server *
129 ovsdb_jsonrpc_server_create(void)
131 struct ovsdb_jsonrpc_server *server = xzalloc(sizeof *server);
132 ovsdb_server_init(&server->up);
133 server->max_sessions = 330; /* Random limit. */
134 shash_init(&server->remotes);
138 /* Adds 'db' to the set of databases served out by 'svr'. Returns true if
139 * successful, false if 'db''s name is the same as some database already in
142 ovsdb_jsonrpc_server_add_db(struct ovsdb_jsonrpc_server *svr, struct ovsdb *db)
144 /* The OVSDB protocol doesn't have a way to notify a client that a
145 * database has been added. If some client tried to use the database
146 * that we're adding and failed, then forcing it to reconnect seems like
147 * a reasonable way to make it try again.
149 * If this is too big of a hammer in practice, we could be more selective,
150 * e.g. disconnect only connections that actually tried to use a database
151 * with 'db''s name. */
152 ovsdb_jsonrpc_server_reconnect(svr);
154 return ovsdb_server_add_db(&svr->up, db);
157 /* Removes 'db' from the set of databases served out by 'svr'. Returns
158 * true if successful, false if there is no database associated with 'db'. */
160 ovsdb_jsonrpc_server_remove_db(struct ovsdb_jsonrpc_server *svr,
163 /* There might be pointers to 'db' from 'svr', such as monitors or
164 * outstanding transactions. Disconnect all JSON-RPC connections to avoid
165 * accesses to freed memory.
167 * If this is too big of a hammer in practice, we could be more selective,
168 * e.g. disconnect only connections that actually reference 'db'. */
169 ovsdb_jsonrpc_server_reconnect(svr);
171 return ovsdb_server_remove_db(&svr->up, db);
175 ovsdb_jsonrpc_server_destroy(struct ovsdb_jsonrpc_server *svr)
177 struct shash_node *node, *next;
179 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
180 ovsdb_jsonrpc_server_del_remote(node);
182 shash_destroy(&svr->remotes);
183 ovsdb_server_destroy(&svr->up);
187 struct ovsdb_jsonrpc_options *
188 ovsdb_jsonrpc_default_options(const char *target)
190 struct ovsdb_jsonrpc_options *options = xzalloc(sizeof *options);
191 options->max_backoff = RECONNECT_DEFAULT_MAX_BACKOFF;
192 options->probe_interval = (stream_or_pstream_needs_probes(target)
193 ? RECONNECT_DEFAULT_PROBE_INTERVAL
198 /* Sets 'svr''s current set of remotes to the names in 'new_remotes', with
199 * options in the struct ovsdb_jsonrpc_options supplied as the data values.
201 * A remote is an active or passive stream connection method, e.g. "pssl:" or
204 ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *svr,
205 const struct shash *new_remotes)
207 struct shash_node *node, *next;
209 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
210 struct ovsdb_jsonrpc_remote *remote = node->data;
211 struct ovsdb_jsonrpc_options *options
212 = shash_find_data(new_remotes, node->name);
215 VLOG_INFO("%s: remote deconfigured", node->name);
216 ovsdb_jsonrpc_server_del_remote(node);
217 } else if (options->dscp != remote->dscp) {
218 ovsdb_jsonrpc_server_del_remote(node);
221 SHASH_FOR_EACH (node, new_remotes) {
222 const struct ovsdb_jsonrpc_options *options = node->data;
223 struct ovsdb_jsonrpc_remote *remote;
225 remote = shash_find_data(&svr->remotes, node->name);
227 remote = ovsdb_jsonrpc_server_add_remote(svr, node->name, options);
233 ovsdb_jsonrpc_session_set_all_options(remote, options);
237 static struct ovsdb_jsonrpc_remote *
238 ovsdb_jsonrpc_server_add_remote(struct ovsdb_jsonrpc_server *svr,
240 const struct ovsdb_jsonrpc_options *options)
242 struct ovsdb_jsonrpc_remote *remote;
243 struct pstream *listener;
246 error = jsonrpc_pstream_open(name, &listener, options->dscp);
247 if (error && error != EAFNOSUPPORT) {
248 VLOG_ERR_RL(&rl, "%s: listen failed: %s", name, ovs_strerror(error));
252 remote = xmalloc(sizeof *remote);
253 remote->server = svr;
254 remote->listener = listener;
255 list_init(&remote->sessions);
256 remote->dscp = options->dscp;
257 shash_add(&svr->remotes, name, remote);
260 ovsdb_jsonrpc_session_create(remote, jsonrpc_session_open(name, true));
266 ovsdb_jsonrpc_server_del_remote(struct shash_node *node)
268 struct ovsdb_jsonrpc_remote *remote = node->data;
270 ovsdb_jsonrpc_session_close_all(remote);
271 pstream_close(remote->listener);
272 shash_delete(&remote->server->remotes, node);
276 /* Stores status information for the remote named 'target', which should have
277 * been configured on 'svr' with a call to ovsdb_jsonrpc_server_set_remotes(),
278 * into '*status'. On success returns true, on failure (if 'svr' doesn't have
279 * a remote named 'target' or if that remote is an inbound remote that has no
280 * active connections) returns false. On failure, 'status' will be zeroed.
283 ovsdb_jsonrpc_server_get_remote_status(
284 const struct ovsdb_jsonrpc_server *svr, const char *target,
285 struct ovsdb_jsonrpc_remote_status *status)
287 const struct ovsdb_jsonrpc_remote *remote;
289 memset(status, 0, sizeof *status);
291 remote = shash_find_data(&svr->remotes, target);
292 return remote && ovsdb_jsonrpc_session_get_status(remote, status);
296 ovsdb_jsonrpc_server_free_remote_status(
297 struct ovsdb_jsonrpc_remote_status *status)
299 free(status->locks_held);
300 free(status->locks_waiting);
301 free(status->locks_lost);
304 /* Forces all of the JSON-RPC sessions managed by 'svr' to disconnect and
307 ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *svr)
309 struct shash_node *node;
311 SHASH_FOR_EACH (node, &svr->remotes) {
312 struct ovsdb_jsonrpc_remote *remote = node->data;
314 ovsdb_jsonrpc_session_reconnect_all(remote);
319 ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *svr)
321 struct shash_node *node;
323 SHASH_FOR_EACH (node, &svr->remotes) {
324 struct ovsdb_jsonrpc_remote *remote = node->data;
326 if (remote->listener) {
327 if (svr->n_sessions < svr->max_sessions) {
328 struct stream *stream;
331 error = pstream_accept(remote->listener, &stream);
333 struct jsonrpc_session *js;
334 js = jsonrpc_session_open_unreliably(jsonrpc_open(stream),
336 ovsdb_jsonrpc_session_create(remote, js);
337 } else if (error != EAGAIN) {
338 VLOG_WARN_RL(&rl, "%s: accept failed: %s",
339 pstream_get_name(remote->listener),
340 ovs_strerror(error));
343 VLOG_WARN_RL(&rl, "%s: connection exceeded maximum (%d)",
344 pstream_get_name(remote->listener),
349 ovsdb_jsonrpc_session_run_all(remote);
354 ovsdb_jsonrpc_server_wait(struct ovsdb_jsonrpc_server *svr)
356 struct shash_node *node;
358 SHASH_FOR_EACH (node, &svr->remotes) {
359 struct ovsdb_jsonrpc_remote *remote = node->data;
361 if (remote->listener && svr->n_sessions < svr->max_sessions) {
362 pstream_wait(remote->listener);
365 ovsdb_jsonrpc_session_wait_all(remote);
369 /* Adds some memory usage statistics for 'svr' into 'usage', for use with
370 * memory_report(). */
372 ovsdb_jsonrpc_server_get_memory_usage(const struct ovsdb_jsonrpc_server *svr,
375 struct shash_node *node;
377 simap_increase(usage, "sessions", svr->n_sessions);
378 SHASH_FOR_EACH (node, &svr->remotes) {
379 struct ovsdb_jsonrpc_remote *remote = node->data;
381 ovsdb_jsonrpc_session_get_memory_usage_all(remote, usage);
385 /* JSON-RPC database server session. */
387 struct ovsdb_jsonrpc_session {
388 struct ovs_list node; /* Element in remote's sessions list. */
389 struct ovsdb_session up;
390 struct ovsdb_jsonrpc_remote *remote;
393 struct hmap triggers; /* Hmap of "struct ovsdb_jsonrpc_trigger"s. */
396 struct hmap monitors; /* Hmap of "struct ovsdb_jsonrpc_monitor"s. */
398 /* Network connectivity. */
399 struct jsonrpc_session *js; /* JSON-RPC session. */
400 unsigned int js_seqno; /* Last jsonrpc_session_get_seqno() value. */
403 static void ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *);
404 static int ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *);
405 static void ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *);
406 static void ovsdb_jsonrpc_session_get_memory_usage(
407 const struct ovsdb_jsonrpc_session *, struct simap *usage);
408 static void ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *,
409 struct jsonrpc_msg *);
410 static void ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *,
411 struct jsonrpc_msg *);
413 static struct ovsdb_jsonrpc_session *
414 ovsdb_jsonrpc_session_create(struct ovsdb_jsonrpc_remote *remote,
415 struct jsonrpc_session *js)
417 struct ovsdb_jsonrpc_session *s;
419 s = xzalloc(sizeof *s);
420 ovsdb_session_init(&s->up, &remote->server->up);
422 list_push_back(&remote->sessions, &s->node);
423 hmap_init(&s->triggers);
424 hmap_init(&s->monitors);
426 s->js_seqno = jsonrpc_session_get_seqno(js);
428 remote->server->n_sessions++;
434 ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *s)
436 ovsdb_jsonrpc_monitor_remove_all(s);
437 ovsdb_jsonrpc_session_unlock_all(s);
438 ovsdb_jsonrpc_trigger_complete_all(s);
440 hmap_destroy(&s->monitors);
441 hmap_destroy(&s->triggers);
443 jsonrpc_session_close(s->js);
444 list_remove(&s->node);
445 s->remote->server->n_sessions--;
446 ovsdb_session_destroy(&s->up);
451 ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *s)
453 jsonrpc_session_run(s->js);
454 if (s->js_seqno != jsonrpc_session_get_seqno(s->js)) {
455 s->js_seqno = jsonrpc_session_get_seqno(s->js);
456 ovsdb_jsonrpc_trigger_complete_all(s);
457 ovsdb_jsonrpc_monitor_remove_all(s);
458 ovsdb_jsonrpc_session_unlock_all(s);
461 ovsdb_jsonrpc_trigger_complete_done(s);
463 if (!jsonrpc_session_get_backlog(s->js)) {
464 struct jsonrpc_msg *msg;
466 ovsdb_jsonrpc_monitor_flush_all(s);
468 msg = jsonrpc_session_recv(s->js);
470 if (msg->type == JSONRPC_REQUEST) {
471 ovsdb_jsonrpc_session_got_request(s, msg);
472 } else if (msg->type == JSONRPC_NOTIFY) {
473 ovsdb_jsonrpc_session_got_notify(s, msg);
475 VLOG_WARN("%s: received unexpected %s message",
476 jsonrpc_session_get_name(s->js),
477 jsonrpc_msg_type_to_string(msg->type));
478 jsonrpc_session_force_reconnect(s->js);
479 jsonrpc_msg_destroy(msg);
483 return jsonrpc_session_is_alive(s->js) ? 0 : ETIMEDOUT;
487 ovsdb_jsonrpc_session_set_options(struct ovsdb_jsonrpc_session *session,
488 const struct ovsdb_jsonrpc_options *options)
490 jsonrpc_session_set_max_backoff(session->js, options->max_backoff);
491 jsonrpc_session_set_probe_interval(session->js, options->probe_interval);
492 jsonrpc_session_set_dscp(session->js, options->dscp);
496 ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *remote)
498 struct ovsdb_jsonrpc_session *s, *next;
500 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
501 int error = ovsdb_jsonrpc_session_run(s);
503 ovsdb_jsonrpc_session_close(s);
509 ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *s)
511 jsonrpc_session_wait(s->js);
512 if (!jsonrpc_session_get_backlog(s->js)) {
513 if (ovsdb_jsonrpc_monitor_needs_flush(s)) {
514 poll_immediate_wake();
516 jsonrpc_session_recv_wait(s->js);
522 ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *remote)
524 struct ovsdb_jsonrpc_session *s;
526 LIST_FOR_EACH (s, node, &remote->sessions) {
527 ovsdb_jsonrpc_session_wait(s);
532 ovsdb_jsonrpc_session_get_memory_usage(const struct ovsdb_jsonrpc_session *s,
535 simap_increase(usage, "triggers", hmap_count(&s->triggers));
536 simap_increase(usage, "backlog", jsonrpc_session_get_backlog(s->js));
540 ovsdb_jsonrpc_session_get_memory_usage_all(
541 const struct ovsdb_jsonrpc_remote *remote,
544 struct ovsdb_jsonrpc_session *s;
546 LIST_FOR_EACH (s, node, &remote->sessions) {
547 ovsdb_jsonrpc_session_get_memory_usage(s, usage);
552 ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *remote)
554 struct ovsdb_jsonrpc_session *s, *next;
556 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
557 ovsdb_jsonrpc_session_close(s);
561 /* Forces all of the JSON-RPC sessions managed by 'remote' to disconnect and
564 ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *remote)
566 struct ovsdb_jsonrpc_session *s, *next;
568 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
569 jsonrpc_session_force_reconnect(s->js);
570 if (!jsonrpc_session_is_alive(s->js)) {
571 ovsdb_jsonrpc_session_close(s);
576 /* Sets the options for all of the JSON-RPC sessions managed by 'remote' to
579 * (The dscp value can't be changed directly; the caller must instead close and
580 * re-open the session.) */
582 ovsdb_jsonrpc_session_set_all_options(
583 struct ovsdb_jsonrpc_remote *remote,
584 const struct ovsdb_jsonrpc_options *options)
586 struct ovsdb_jsonrpc_session *s;
588 LIST_FOR_EACH (s, node, &remote->sessions) {
589 ovsdb_jsonrpc_session_set_options(s, options);
594 ovsdb_jsonrpc_session_get_status(const struct ovsdb_jsonrpc_remote *remote,
595 struct ovsdb_jsonrpc_remote_status *status)
597 const struct ovsdb_jsonrpc_session *s;
598 const struct jsonrpc_session *js;
599 struct ovsdb_lock_waiter *waiter;
600 struct reconnect_stats rstats;
601 struct ds locks_held, locks_waiting, locks_lost;
603 status->bound_port = (remote->listener
604 ? pstream_get_bound_port(remote->listener)
607 if (list_is_empty(&remote->sessions)) {
610 s = CONTAINER_OF(remote->sessions.next, struct ovsdb_jsonrpc_session, node);
613 status->is_connected = jsonrpc_session_is_connected(js);
614 status->last_error = jsonrpc_session_get_status(js);
616 jsonrpc_session_get_reconnect_stats(js, &rstats);
617 status->state = rstats.state;
618 status->sec_since_connect = rstats.msec_since_connect == UINT_MAX
619 ? UINT_MAX : rstats.msec_since_connect / 1000;
620 status->sec_since_disconnect = rstats.msec_since_disconnect == UINT_MAX
621 ? UINT_MAX : rstats.msec_since_disconnect / 1000;
623 ds_init(&locks_held);
624 ds_init(&locks_waiting);
625 ds_init(&locks_lost);
626 HMAP_FOR_EACH (waiter, session_node, &s->up.waiters) {
629 string = (ovsdb_lock_waiter_is_owner(waiter) ? &locks_held
630 : waiter->mode == OVSDB_LOCK_WAIT ? &locks_waiting
632 if (string->length) {
633 ds_put_char(string, ' ');
635 ds_put_cstr(string, waiter->lock_name);
637 status->locks_held = ds_steal_cstr(&locks_held);
638 status->locks_waiting = ds_steal_cstr(&locks_waiting);
639 status->locks_lost = ds_steal_cstr(&locks_lost);
641 status->n_connections = list_size(&remote->sessions);
646 /* Examines 'request' to determine the database to which it relates, and then
647 * searches 's' to find that database:
649 * - If successful, returns the database and sets '*replyp' to NULL.
651 * - If no such database exists, returns NULL and sets '*replyp' to an
652 * appropriate JSON-RPC error reply, owned by the caller. */
653 static struct ovsdb *
654 ovsdb_jsonrpc_lookup_db(const struct ovsdb_jsonrpc_session *s,
655 const struct jsonrpc_msg *request,
656 struct jsonrpc_msg **replyp)
658 struct json_array *params;
659 struct ovsdb_error *error;
663 params = json_array(request->params);
664 if (!params->n || params->elems[0]->type != JSON_STRING) {
665 error = ovsdb_syntax_error(
666 request->params, NULL,
667 "%s request params must begin with <db-name>", request->method);
671 db_name = params->elems[0]->u.string;
672 db = shash_find_data(&s->up.server->dbs, db_name);
674 error = ovsdb_syntax_error(
675 request->params, "unknown database",
676 "%s request specifies unknown database %s",
677 request->method, db_name);
685 *replyp = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
686 ovsdb_error_destroy(error);
690 static struct ovsdb_error *
691 ovsdb_jsonrpc_session_parse_lock_name(const struct jsonrpc_msg *request,
692 const char **lock_namep)
694 const struct json_array *params;
696 params = json_array(request->params);
697 if (params->n != 1 || params->elems[0]->type != JSON_STRING ||
698 !ovsdb_parser_is_id(json_string(params->elems[0]))) {
700 return ovsdb_syntax_error(request->params, NULL,
701 "%s request params must be <id>",
705 *lock_namep = json_string(params->elems[0]);
710 ovsdb_jsonrpc_session_notify(struct ovsdb_session *session,
711 const char *lock_name,
714 struct ovsdb_jsonrpc_session *s;
717 s = CONTAINER_OF(session, struct ovsdb_jsonrpc_session, up);
718 params = json_array_create_1(json_string_create(lock_name));
719 ovsdb_jsonrpc_session_send(s, jsonrpc_create_notify(method, params));
722 static struct jsonrpc_msg *
723 ovsdb_jsonrpc_session_lock(struct ovsdb_jsonrpc_session *s,
724 struct jsonrpc_msg *request,
725 enum ovsdb_lock_mode mode)
727 struct ovsdb_lock_waiter *waiter;
728 struct jsonrpc_msg *reply;
729 struct ovsdb_error *error;
730 struct ovsdb_session *victim;
731 const char *lock_name;
734 error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
739 /* Report error if this session has issued a "lock" or "steal" without a
740 * matching "unlock" for this lock. */
741 waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
743 error = ovsdb_syntax_error(
744 request->params, NULL,
745 "must issue \"unlock\" before new \"%s\"", request->method);
749 /* Get the lock, add us as a waiter. */
750 waiter = ovsdb_server_lock(&s->remote->server->up, &s->up, lock_name, mode,
753 ovsdb_jsonrpc_session_notify(victim, lock_name, "stolen");
756 result = json_object_create();
757 json_object_put(result, "locked",
758 json_boolean_create(ovsdb_lock_waiter_is_owner(waiter)));
760 return jsonrpc_create_reply(result, request->id);
763 reply = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
764 ovsdb_error_destroy(error);
769 ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *s)
771 struct ovsdb_lock_waiter *waiter, *next;
773 HMAP_FOR_EACH_SAFE (waiter, next, session_node, &s->up.waiters) {
774 ovsdb_jsonrpc_session_unlock__(waiter);
779 ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *waiter)
781 struct ovsdb_lock *lock = waiter->lock;
784 struct ovsdb_session *new_owner = ovsdb_lock_waiter_remove(waiter);
786 ovsdb_jsonrpc_session_notify(new_owner, lock->name, "locked");
788 /* ovsdb_server_lock() might have freed 'lock'. */
792 ovsdb_lock_waiter_destroy(waiter);
795 static struct jsonrpc_msg *
796 ovsdb_jsonrpc_session_unlock(struct ovsdb_jsonrpc_session *s,
797 struct jsonrpc_msg *request)
799 struct ovsdb_lock_waiter *waiter;
800 struct jsonrpc_msg *reply;
801 struct ovsdb_error *error;
802 const char *lock_name;
804 error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
809 /* Report error if this session has not issued a "lock" or "steal" for this
811 waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
813 error = ovsdb_syntax_error(
814 request->params, NULL, "\"unlock\" without \"lock\" or \"steal\"");
818 ovsdb_jsonrpc_session_unlock__(waiter);
820 return jsonrpc_create_reply(json_object_create(), request->id);
823 reply = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
824 ovsdb_error_destroy(error);
828 static struct jsonrpc_msg *
829 execute_transaction(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
830 struct jsonrpc_msg *request)
832 ovsdb_jsonrpc_trigger_create(s, db, request->id, request->params);
834 request->params = NULL;
835 jsonrpc_msg_destroy(request);
840 ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *s,
841 struct jsonrpc_msg *request)
843 struct jsonrpc_msg *reply;
845 if (!strcmp(request->method, "transact")) {
846 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
848 reply = execute_transaction(s, db, request);
850 } else if (!strcmp(request->method, "monitor") ||
851 (monitor2_enable__ && !strcmp(request->method, "monitor2"))) {
852 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
854 int l = strlen(request->method) - strlen("monitor");
855 enum ovsdb_monitor_version version = l ? OVSDB_MONITOR_V2
857 reply = ovsdb_jsonrpc_monitor_create(s, db, request->params,
858 version, request->id);
860 } else if (!strcmp(request->method, "monitor_cancel")) {
861 reply = ovsdb_jsonrpc_monitor_cancel(s, json_array(request->params),
863 } else if (!strcmp(request->method, "get_schema")) {
864 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
866 reply = jsonrpc_create_reply(ovsdb_schema_to_json(db->schema),
869 } else if (!strcmp(request->method, "list_dbs")) {
870 size_t n_dbs = shash_count(&s->up.server->dbs);
871 struct shash_node *node;
875 dbs = xmalloc(n_dbs * sizeof *dbs);
877 SHASH_FOR_EACH (node, &s->up.server->dbs) {
878 dbs[i++] = json_string_create(node->name);
880 reply = jsonrpc_create_reply(json_array_create(dbs, n_dbs),
882 } else if (!strcmp(request->method, "lock")) {
883 reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_WAIT);
884 } else if (!strcmp(request->method, "steal")) {
885 reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_STEAL);
886 } else if (!strcmp(request->method, "unlock")) {
887 reply = ovsdb_jsonrpc_session_unlock(s, request);
888 } else if (!strcmp(request->method, "echo")) {
889 reply = jsonrpc_create_reply(json_clone(request->params), request->id);
891 reply = jsonrpc_create_error(json_string_create("unknown method"),
896 jsonrpc_msg_destroy(request);
897 ovsdb_jsonrpc_session_send(s, reply);
902 execute_cancel(struct ovsdb_jsonrpc_session *s, struct jsonrpc_msg *request)
904 if (json_array(request->params)->n == 1) {
905 struct ovsdb_jsonrpc_trigger *t;
908 id = request->params->u.array.elems[0];
909 t = ovsdb_jsonrpc_trigger_find(s, id, json_hash(id, 0));
911 ovsdb_jsonrpc_trigger_complete(t);
917 ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *s,
918 struct jsonrpc_msg *request)
920 if (!strcmp(request->method, "cancel")) {
921 execute_cancel(s, request);
923 jsonrpc_msg_destroy(request);
927 ovsdb_jsonrpc_session_send(struct ovsdb_jsonrpc_session *s,
928 struct jsonrpc_msg *msg)
930 ovsdb_jsonrpc_monitor_flush_all(s);
931 jsonrpc_session_send(s->js, msg);
934 /* JSON-RPC database server triggers.
936 * (Every transaction is treated as a trigger even if it doesn't actually have
937 * any "wait" operations.) */
939 struct ovsdb_jsonrpc_trigger {
940 struct ovsdb_trigger trigger;
941 struct hmap_node hmap_node; /* In session's "triggers" hmap. */
946 ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
947 struct json *id, struct json *params)
949 struct ovsdb_jsonrpc_trigger *t;
952 /* Check for duplicate ID. */
953 hash = json_hash(id, 0);
954 t = ovsdb_jsonrpc_trigger_find(s, id, hash);
956 struct jsonrpc_msg *msg;
958 msg = jsonrpc_create_error(json_string_create("duplicate request ID"),
960 ovsdb_jsonrpc_session_send(s, msg);
962 json_destroy(params);
966 /* Insert into trigger table. */
967 t = xmalloc(sizeof *t);
968 ovsdb_trigger_init(&s->up, db, &t->trigger, params, time_msec());
970 hmap_insert(&s->triggers, &t->hmap_node, hash);
972 /* Complete early if possible. */
973 if (ovsdb_trigger_is_complete(&t->trigger)) {
974 ovsdb_jsonrpc_trigger_complete(t);
978 static struct ovsdb_jsonrpc_trigger *
979 ovsdb_jsonrpc_trigger_find(struct ovsdb_jsonrpc_session *s,
980 const struct json *id, size_t hash)
982 struct ovsdb_jsonrpc_trigger *t;
984 HMAP_FOR_EACH_WITH_HASH (t, hmap_node, hash, &s->triggers) {
985 if (json_equal(t->id, id)) {
994 ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *t)
996 struct ovsdb_jsonrpc_session *s;
998 s = CONTAINER_OF(t->trigger.session, struct ovsdb_jsonrpc_session, up);
1000 if (jsonrpc_session_is_connected(s->js)) {
1001 struct jsonrpc_msg *reply;
1002 struct json *result;
1004 result = ovsdb_trigger_steal_result(&t->trigger);
1006 reply = jsonrpc_create_reply(result, t->id);
1008 reply = jsonrpc_create_error(json_string_create("canceled"),
1011 ovsdb_jsonrpc_session_send(s, reply);
1014 json_destroy(t->id);
1015 ovsdb_trigger_destroy(&t->trigger);
1016 hmap_remove(&s->triggers, &t->hmap_node);
1021 ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *s)
1023 struct ovsdb_jsonrpc_trigger *t, *next;
1024 HMAP_FOR_EACH_SAFE (t, next, hmap_node, &s->triggers) {
1025 ovsdb_jsonrpc_trigger_complete(t);
1030 ovsdb_jsonrpc_trigger_complete_done(struct ovsdb_jsonrpc_session *s)
1032 while (!list_is_empty(&s->up.completions)) {
1033 struct ovsdb_jsonrpc_trigger *t
1034 = CONTAINER_OF(s->up.completions.next,
1035 struct ovsdb_jsonrpc_trigger, trigger.node);
1036 ovsdb_jsonrpc_trigger_complete(t);
1040 /* Jsonrpc front end monitor. */
1041 struct ovsdb_jsonrpc_monitor {
1042 struct ovsdb_jsonrpc_session *session;
1044 struct hmap_node node; /* In ovsdb_jsonrpc_session's "monitors". */
1045 struct json *monitor_id;
1046 struct ovsdb_monitor *dbmon;
1047 uint64_t unflushed; /* The first transaction that has not been
1048 flushed to the jsonrpc remote client. */
1049 enum ovsdb_monitor_version version;
1052 static struct ovsdb_jsonrpc_monitor *
1053 ovsdb_jsonrpc_monitor_find(struct ovsdb_jsonrpc_session *s,
1054 const struct json *monitor_id)
1056 struct ovsdb_jsonrpc_monitor *m;
1058 HMAP_FOR_EACH_WITH_HASH (m, node, json_hash(monitor_id, 0), &s->monitors) {
1059 if (json_equal(m->monitor_id, monitor_id)) {
1068 parse_bool(struct ovsdb_parser *parser, const char *name, bool default_value)
1070 const struct json *json;
1072 json = ovsdb_parser_member(parser, name, OP_BOOLEAN | OP_OPTIONAL);
1073 return json ? json_boolean(json) : default_value;
1076 static struct ovsdb_error * OVS_WARN_UNUSED_RESULT
1077 ovsdb_jsonrpc_parse_monitor_request(struct ovsdb_monitor *dbmon,
1078 const struct ovsdb_table *table,
1079 const struct json *monitor_request,
1080 size_t *allocated_columns)
1082 const struct ovsdb_table_schema *ts = table->schema;
1083 enum ovsdb_monitor_selection select;
1084 const struct json *columns, *select_json;
1085 struct ovsdb_parser parser;
1086 struct ovsdb_error *error;
1088 ovsdb_parser_init(&parser, monitor_request, "table %s", ts->name);
1089 columns = ovsdb_parser_member(&parser, "columns", OP_ARRAY | OP_OPTIONAL);
1090 select_json = ovsdb_parser_member(&parser, "select",
1091 OP_OBJECT | OP_OPTIONAL);
1092 error = ovsdb_parser_finish(&parser);
1099 ovsdb_parser_init(&parser, select_json, "table %s select", ts->name);
1100 if (parse_bool(&parser, "initial", true)) {
1101 select |= OJMS_INITIAL;
1103 if (parse_bool(&parser, "insert", true)) {
1104 select |= OJMS_INSERT;
1106 if (parse_bool(&parser, "delete", true)) {
1107 select |= OJMS_DELETE;
1109 if (parse_bool(&parser, "modify", true)) {
1110 select |= OJMS_MODIFY;
1112 error = ovsdb_parser_finish(&parser);
1117 select = OJMS_INITIAL | OJMS_INSERT | OJMS_DELETE | OJMS_MODIFY;
1120 ovsdb_monitor_table_add_select(dbmon, table, select);
1124 if (columns->type != JSON_ARRAY) {
1125 return ovsdb_syntax_error(columns, NULL,
1126 "array of column names expected");
1129 for (i = 0; i < columns->u.array.n; i++) {
1130 const struct ovsdb_column *column;
1133 if (columns->u.array.elems[i]->type != JSON_STRING) {
1134 return ovsdb_syntax_error(columns, NULL,
1135 "array of column names expected");
1138 s = columns->u.array.elems[i]->u.string;
1139 column = shash_find_data(&table->schema->columns, s);
1141 return ovsdb_syntax_error(columns, NULL, "%s is not a valid "
1144 ovsdb_monitor_add_column(dbmon, table, column, select,
1148 struct shash_node *node;
1150 SHASH_FOR_EACH (node, &ts->columns) {
1151 const struct ovsdb_column *column = node->data;
1152 if (column->index != OVSDB_COL_UUID) {
1153 ovsdb_monitor_add_column(dbmon, table, column, select,
1162 static struct jsonrpc_msg *
1163 ovsdb_jsonrpc_monitor_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
1164 struct json *params,
1165 enum ovsdb_monitor_version version,
1166 const struct json *request_id)
1168 struct ovsdb_jsonrpc_monitor *m = NULL;
1169 struct ovsdb_monitor *dbmon = NULL;
1170 struct json *monitor_id, *monitor_requests;
1171 struct ovsdb_error *error = NULL;
1172 struct shash_node *node;
1175 if (json_array(params)->n != 3) {
1176 error = ovsdb_syntax_error(params, NULL, "invalid parameters");
1179 monitor_id = params->u.array.elems[1];
1180 monitor_requests = params->u.array.elems[2];
1181 if (monitor_requests->type != JSON_OBJECT) {
1182 error = ovsdb_syntax_error(monitor_requests, NULL,
1183 "monitor-requests must be object");
1187 if (ovsdb_jsonrpc_monitor_find(s, monitor_id)) {
1188 error = ovsdb_syntax_error(monitor_id, NULL, "duplicate monitor ID");
1192 m = xzalloc(sizeof *m);
1195 m->dbmon = ovsdb_monitor_create(db, m);
1197 m->version = version;
1198 hmap_insert(&s->monitors, &m->node, json_hash(monitor_id, 0));
1199 m->monitor_id = json_clone(monitor_id);
1201 SHASH_FOR_EACH (node, json_object(monitor_requests)) {
1202 const struct ovsdb_table *table;
1203 const char *column_name;
1204 size_t allocated_columns;
1205 const struct json *mr_value;
1208 table = ovsdb_get_table(m->db, node->name);
1210 error = ovsdb_syntax_error(NULL, NULL,
1211 "no table named %s", node->name);
1215 ovsdb_monitor_add_table(m->dbmon, table);
1217 /* Parse columns. */
1218 mr_value = node->data;
1219 allocated_columns = 0;
1220 if (mr_value->type == JSON_ARRAY) {
1221 const struct json_array *array = &mr_value->u.array;
1223 for (i = 0; i < array->n; i++) {
1224 error = ovsdb_jsonrpc_parse_monitor_request(
1225 m->dbmon, table, array->elems[i], &allocated_columns);
1231 error = ovsdb_jsonrpc_parse_monitor_request(
1232 m->dbmon, table, mr_value, &allocated_columns);
1238 column_name = ovsdb_monitor_table_check_duplicates(m->dbmon, table);
1241 error = ovsdb_syntax_error(mr_value, NULL, "column %s "
1242 "mentioned more than once",
1248 dbmon = ovsdb_monitor_add(m->dbmon);
1249 if (dbmon != m->dbmon) {
1250 /* Found an exisiting dbmon, reuse the current one. */
1251 ovsdb_monitor_remove_jsonrpc_monitor(m->dbmon, m);
1252 ovsdb_monitor_add_jsonrpc_monitor(dbmon, m);
1256 ovsdb_monitor_get_initial(m->dbmon);
1257 json = ovsdb_jsonrpc_monitor_compose_update(m, true);
1258 json = json ? json : json_object_create();
1259 return jsonrpc_create_reply(json, request_id);
1263 ovsdb_jsonrpc_monitor_destroy(m);
1266 json = ovsdb_error_to_json(error);
1267 ovsdb_error_destroy(error);
1268 return jsonrpc_create_error(json, request_id);
1271 static struct jsonrpc_msg *
1272 ovsdb_jsonrpc_monitor_cancel(struct ovsdb_jsonrpc_session *s,
1273 struct json_array *params,
1274 const struct json *request_id)
1276 if (params->n != 1) {
1277 return jsonrpc_create_error(json_string_create("invalid parameters"),
1280 struct ovsdb_jsonrpc_monitor *m;
1282 m = ovsdb_jsonrpc_monitor_find(s, params->elems[0]);
1284 return jsonrpc_create_error(json_string_create("unknown monitor"),
1287 ovsdb_jsonrpc_monitor_destroy(m);
1288 return jsonrpc_create_reply(json_object_create(), request_id);
1294 ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *s)
1296 struct ovsdb_jsonrpc_monitor *m, *next;
1298 HMAP_FOR_EACH_SAFE (m, next, node, &s->monitors) {
1299 ovsdb_jsonrpc_monitor_destroy(m);
1303 static struct json *
1304 ovsdb_jsonrpc_monitor_compose_update(struct ovsdb_jsonrpc_monitor *m,
1307 return ovsdb_monitor_get_update(m->dbmon, initial, &m->unflushed,
1312 ovsdb_jsonrpc_monitor_needs_flush(struct ovsdb_jsonrpc_session *s)
1314 struct ovsdb_jsonrpc_monitor *m;
1316 HMAP_FOR_EACH (m, node, &s->monitors) {
1317 if (ovsdb_monitor_needs_flush(m->dbmon, m->unflushed)) {
1326 ovsdb_jsonrpc_monitor_destroy(struct ovsdb_jsonrpc_monitor *m)
1328 json_destroy(m->monitor_id);
1329 hmap_remove(&m->session->monitors, &m->node);
1330 ovsdb_monitor_remove_jsonrpc_monitor(m->dbmon, m);
1334 static struct jsonrpc_msg *
1335 ovsdb_jsonrpc_create_notify(const struct ovsdb_jsonrpc_monitor *m,
1336 struct json *params)
1340 switch(m->version) {
1341 case OVSDB_MONITOR_V1:
1344 case OVSDB_MONITOR_V2:
1347 case OVSDB_MONITOR_VERSION_MAX:
1352 return jsonrpc_create_notify(method, params);
1356 ovsdb_jsonrpc_monitor_flush_all(struct ovsdb_jsonrpc_session *s)
1358 struct ovsdb_jsonrpc_monitor *m;
1360 HMAP_FOR_EACH (m, node, &s->monitors) {
1363 json = ovsdb_jsonrpc_monitor_compose_update(m, false);
1365 struct jsonrpc_msg *msg;
1366 struct json *params;
1368 params = json_array_create_2(json_clone(m->monitor_id), json);
1369 msg = ovsdb_jsonrpc_create_notify(m, params);
1370 jsonrpc_session_send(s->js, msg);
1376 ovsdb_jsonrpc_disable_monitor2(void)
1378 /* Once disabled, it is not possible to re-enable it. */
1379 monitor2_enable__ = false;