1 /* Copyright (c) 2009, 2010, 2011, 2012 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"
25 #include "dynamic-string.h"
28 #include "ovsdb-error.h"
29 #include "ovsdb-parser.h"
31 #include "reconnect.h"
38 #include "transaction.h"
42 VLOG_DEFINE_THIS_MODULE(ovsdb_jsonrpc_server);
44 struct ovsdb_jsonrpc_remote;
45 struct ovsdb_jsonrpc_session;
47 /* Message rate-limiting. */
48 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
51 static struct ovsdb_jsonrpc_session *ovsdb_jsonrpc_session_create(
52 struct ovsdb_jsonrpc_remote *, struct jsonrpc_session *);
53 static void ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *);
54 static void ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *);
55 static void ovsdb_jsonrpc_session_get_memory_usage_all(
56 const struct ovsdb_jsonrpc_remote *, struct simap *usage);
57 static void ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *);
58 static void ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *);
59 static void ovsdb_jsonrpc_session_set_all_options(
60 struct ovsdb_jsonrpc_remote *, const struct ovsdb_jsonrpc_options *);
61 static bool ovsdb_jsonrpc_session_get_status(
62 const struct ovsdb_jsonrpc_remote *,
63 struct ovsdb_jsonrpc_remote_status *);
64 static void ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *);
65 static void ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *);
68 static void ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *,
70 struct json *id, struct json *params);
71 static struct ovsdb_jsonrpc_trigger *ovsdb_jsonrpc_trigger_find(
72 struct ovsdb_jsonrpc_session *, const struct json *id, size_t hash);
73 static void ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *);
74 static void ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *);
75 static void ovsdb_jsonrpc_trigger_complete_done(
76 struct ovsdb_jsonrpc_session *);
79 static struct json *ovsdb_jsonrpc_monitor_create(
80 struct ovsdb_jsonrpc_session *, struct ovsdb *, struct json *params);
81 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_cancel(
82 struct ovsdb_jsonrpc_session *,
83 struct json_array *params,
84 const struct json *request_id);
85 static void ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *);
87 /* JSON-RPC database server. */
89 struct ovsdb_jsonrpc_server {
90 struct ovsdb_server up;
91 unsigned int n_sessions, max_sessions;
92 struct shash remotes; /* Contains "struct ovsdb_jsonrpc_remote *"s. */
95 /* A configured remote. This is either a passive stream listener plus a list
96 * of the currently connected sessions, or a list of exactly one active
98 struct ovsdb_jsonrpc_remote {
99 struct ovsdb_jsonrpc_server *server;
100 struct pstream *listener; /* Listener, if passive. */
101 struct list sessions; /* List of "struct ovsdb_jsonrpc_session"s. */
105 static struct ovsdb_jsonrpc_remote *ovsdb_jsonrpc_server_add_remote(
106 struct ovsdb_jsonrpc_server *, const char *name,
107 const struct ovsdb_jsonrpc_options *options
109 static void ovsdb_jsonrpc_server_del_remote(struct shash_node *);
111 /* Creates and returns a new server to provide JSON-RPC access to an OVSDB.
113 * The caller must call ovsdb_jsonrpc_server_add_db() for each database to
114 * which 'server' should provide access. */
115 struct ovsdb_jsonrpc_server *
116 ovsdb_jsonrpc_server_create(void)
118 struct ovsdb_jsonrpc_server *server = xzalloc(sizeof *server);
119 ovsdb_server_init(&server->up);
120 server->max_sessions = 64;
121 shash_init(&server->remotes);
125 /* Adds 'db' to the set of databases served out by 'svr'. Returns true if
126 * successful, false if 'db''s name is the same as some database already in
129 ovsdb_jsonrpc_server_add_db(struct ovsdb_jsonrpc_server *svr, struct ovsdb *db)
131 return ovsdb_server_add_db(&svr->up, db);
135 ovsdb_jsonrpc_server_destroy(struct ovsdb_jsonrpc_server *svr)
137 struct shash_node *node, *next;
139 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
140 ovsdb_jsonrpc_server_del_remote(node);
142 shash_destroy(&svr->remotes);
143 ovsdb_server_destroy(&svr->up);
147 struct ovsdb_jsonrpc_options *
148 ovsdb_jsonrpc_default_options(const char *target)
150 struct ovsdb_jsonrpc_options *options = xzalloc(sizeof *options);
151 options->max_backoff = RECONNECT_DEFAULT_MAX_BACKOFF;
152 options->probe_interval = (stream_or_pstream_needs_probes(target)
153 ? RECONNECT_DEFAULT_PROBE_INTERVAL
158 /* Sets 'svr''s current set of remotes to the names in 'new_remotes', with
159 * options in the struct ovsdb_jsonrpc_options supplied as the data values.
161 * A remote is an active or passive stream connection method, e.g. "pssl:" or
164 ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *svr,
165 const struct shash *new_remotes)
167 struct shash_node *node, *next;
169 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
170 if (!shash_find(new_remotes, node->name)) {
171 VLOG_INFO("%s: remote deconfigured", node->name);
172 ovsdb_jsonrpc_server_del_remote(node);
175 SHASH_FOR_EACH (node, new_remotes) {
176 const struct ovsdb_jsonrpc_options *options = node->data;
177 struct ovsdb_jsonrpc_remote *remote;
179 remote = shash_find_data(&svr->remotes, node->name);
181 remote = ovsdb_jsonrpc_server_add_remote(svr, node->name, options);
187 ovsdb_jsonrpc_session_set_all_options(remote, options);
191 static struct ovsdb_jsonrpc_remote *
192 ovsdb_jsonrpc_server_add_remote(struct ovsdb_jsonrpc_server *svr,
194 const struct ovsdb_jsonrpc_options *options)
196 struct ovsdb_jsonrpc_remote *remote;
197 struct pstream *listener;
200 error = jsonrpc_pstream_open(name, &listener, options->dscp);
201 if (error && error != EAFNOSUPPORT) {
202 VLOG_ERR_RL(&rl, "%s: listen failed: %s", name, strerror(error));
206 remote = xmalloc(sizeof *remote);
207 remote->server = svr;
208 remote->listener = listener;
209 list_init(&remote->sessions);
210 remote->dscp = options->dscp;
211 shash_add(&svr->remotes, name, remote);
214 ovsdb_jsonrpc_session_create(remote, jsonrpc_session_open(name));
220 ovsdb_jsonrpc_server_del_remote(struct shash_node *node)
222 struct ovsdb_jsonrpc_remote *remote = node->data;
224 ovsdb_jsonrpc_session_close_all(remote);
225 pstream_close(remote->listener);
226 shash_delete(&remote->server->remotes, node);
230 /* Stores status information for the remote named 'target', which should have
231 * been configured on 'svr' with a call to ovsdb_jsonrpc_server_set_remotes(),
232 * into '*status'. On success returns true, on failure (if 'svr' doesn't have
233 * a remote named 'target' or if that remote is an inbound remote that has no
234 * active connections) returns false. On failure, 'status' will be zeroed.
237 ovsdb_jsonrpc_server_get_remote_status(
238 const struct ovsdb_jsonrpc_server *svr, const char *target,
239 struct ovsdb_jsonrpc_remote_status *status)
241 const struct ovsdb_jsonrpc_remote *remote;
243 memset(status, 0, sizeof *status);
245 remote = shash_find_data(&svr->remotes, target);
246 return remote && ovsdb_jsonrpc_session_get_status(remote, status);
250 ovsdb_jsonrpc_server_free_remote_status(
251 struct ovsdb_jsonrpc_remote_status *status)
253 free(status->locks_held);
254 free(status->locks_waiting);
255 free(status->locks_lost);
258 /* Forces all of the JSON-RPC sessions managed by 'svr' to disconnect and
261 ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *svr)
263 struct shash_node *node;
265 SHASH_FOR_EACH (node, &svr->remotes) {
266 struct ovsdb_jsonrpc_remote *remote = node->data;
268 ovsdb_jsonrpc_session_reconnect_all(remote);
273 ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *svr)
275 struct shash_node *node;
277 SHASH_FOR_EACH (node, &svr->remotes) {
278 struct ovsdb_jsonrpc_remote *remote = node->data;
280 if (remote->listener && svr->n_sessions < svr->max_sessions) {
281 struct stream *stream;
284 error = pstream_accept(remote->listener, &stream);
286 struct jsonrpc_session *js;
287 js = jsonrpc_session_open_unreliably(jsonrpc_open(stream),
289 ovsdb_jsonrpc_session_create(remote, js);
290 } else if (error != EAGAIN) {
291 VLOG_WARN_RL(&rl, "%s: accept failed: %s",
292 pstream_get_name(remote->listener),
297 ovsdb_jsonrpc_session_run_all(remote);
302 ovsdb_jsonrpc_server_wait(struct ovsdb_jsonrpc_server *svr)
304 struct shash_node *node;
306 SHASH_FOR_EACH (node, &svr->remotes) {
307 struct ovsdb_jsonrpc_remote *remote = node->data;
309 if (remote->listener && svr->n_sessions < svr->max_sessions) {
310 pstream_wait(remote->listener);
313 ovsdb_jsonrpc_session_wait_all(remote);
317 /* Adds some memory usage statistics for 'svr' into 'usage', for use with
318 * memory_report(). */
320 ovsdb_jsonrpc_server_get_memory_usage(const struct ovsdb_jsonrpc_server *svr,
323 struct shash_node *node;
325 simap_increase(usage, "sessions", svr->n_sessions);
326 SHASH_FOR_EACH (node, &svr->remotes) {
327 struct ovsdb_jsonrpc_remote *remote = node->data;
329 ovsdb_jsonrpc_session_get_memory_usage_all(remote, usage);
333 /* JSON-RPC database server session. */
335 struct ovsdb_jsonrpc_session {
336 struct list node; /* Element in remote's sessions list. */
337 struct ovsdb_session up;
338 struct ovsdb_jsonrpc_remote *remote;
341 struct hmap triggers; /* Hmap of "struct ovsdb_jsonrpc_trigger"s. */
344 struct hmap monitors; /* Hmap of "struct ovsdb_jsonrpc_monitor"s. */
346 /* Network connectivity. */
347 struct jsonrpc_session *js; /* JSON-RPC session. */
348 unsigned int js_seqno; /* Last jsonrpc_session_get_seqno() value. */
351 static void ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *);
352 static int ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *);
353 static void ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *);
354 static void ovsdb_jsonrpc_session_get_memory_usage(
355 const struct ovsdb_jsonrpc_session *, struct simap *usage);
356 static void ovsdb_jsonrpc_session_set_options(
357 struct ovsdb_jsonrpc_session *, const struct ovsdb_jsonrpc_options *);
358 static void ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *,
359 struct jsonrpc_msg *);
360 static void ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *,
361 struct jsonrpc_msg *);
363 static struct ovsdb_jsonrpc_session *
364 ovsdb_jsonrpc_session_create(struct ovsdb_jsonrpc_remote *remote,
365 struct jsonrpc_session *js)
367 struct ovsdb_jsonrpc_session *s;
369 s = xzalloc(sizeof *s);
370 ovsdb_session_init(&s->up, &remote->server->up);
372 list_push_back(&remote->sessions, &s->node);
373 hmap_init(&s->triggers);
374 hmap_init(&s->monitors);
376 s->js_seqno = jsonrpc_session_get_seqno(js);
378 remote->server->n_sessions++;
384 ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *s)
386 ovsdb_jsonrpc_monitor_remove_all(s);
387 ovsdb_jsonrpc_session_unlock_all(s);
388 jsonrpc_session_close(s->js);
389 list_remove(&s->node);
390 ovsdb_session_destroy(&s->up);
391 s->remote->server->n_sessions--;
392 ovsdb_session_destroy(&s->up);
397 ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *s)
399 jsonrpc_session_run(s->js);
400 if (s->js_seqno != jsonrpc_session_get_seqno(s->js)) {
401 s->js_seqno = jsonrpc_session_get_seqno(s->js);
402 ovsdb_jsonrpc_trigger_complete_all(s);
403 ovsdb_jsonrpc_monitor_remove_all(s);
404 ovsdb_jsonrpc_session_unlock_all(s);
407 ovsdb_jsonrpc_trigger_complete_done(s);
409 if (!jsonrpc_session_get_backlog(s->js)) {
410 struct jsonrpc_msg *msg = jsonrpc_session_recv(s->js);
412 if (msg->type == JSONRPC_REQUEST) {
413 ovsdb_jsonrpc_session_got_request(s, msg);
414 } else if (msg->type == JSONRPC_NOTIFY) {
415 ovsdb_jsonrpc_session_got_notify(s, msg);
417 VLOG_WARN("%s: received unexpected %s message",
418 jsonrpc_session_get_name(s->js),
419 jsonrpc_msg_type_to_string(msg->type));
420 jsonrpc_session_force_reconnect(s->js);
421 jsonrpc_msg_destroy(msg);
425 return jsonrpc_session_is_alive(s->js) ? 0 : ETIMEDOUT;
429 ovsdb_jsonrpc_session_set_options(struct ovsdb_jsonrpc_session *session,
430 const struct ovsdb_jsonrpc_options *options)
432 jsonrpc_session_set_max_backoff(session->js, options->max_backoff);
433 jsonrpc_session_set_probe_interval(session->js, options->probe_interval);
434 jsonrpc_session_set_dscp(session->js, options->dscp);
438 ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *remote)
440 struct ovsdb_jsonrpc_session *s, *next;
442 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
443 int error = ovsdb_jsonrpc_session_run(s);
445 ovsdb_jsonrpc_session_close(s);
451 ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *s)
453 jsonrpc_session_wait(s->js);
454 if (!jsonrpc_session_get_backlog(s->js)) {
455 jsonrpc_session_recv_wait(s->js);
460 ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *remote)
462 struct ovsdb_jsonrpc_session *s;
464 LIST_FOR_EACH (s, node, &remote->sessions) {
465 ovsdb_jsonrpc_session_wait(s);
470 ovsdb_jsonrpc_session_get_memory_usage(const struct ovsdb_jsonrpc_session *s,
473 simap_increase(usage, "triggers", hmap_count(&s->triggers));
474 simap_increase(usage, "monitors", hmap_count(&s->monitors));
475 simap_increase(usage, "backlog", jsonrpc_session_get_backlog(s->js));
479 ovsdb_jsonrpc_session_get_memory_usage_all(
480 const struct ovsdb_jsonrpc_remote *remote,
483 struct ovsdb_jsonrpc_session *s;
485 LIST_FOR_EACH (s, node, &remote->sessions) {
486 ovsdb_jsonrpc_session_get_memory_usage(s, usage);
491 ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *remote)
493 struct ovsdb_jsonrpc_session *s, *next;
495 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
496 ovsdb_jsonrpc_session_close(s);
500 /* Forces all of the JSON-RPC sessions managed by 'remote' to disconnect and
503 ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *remote)
505 struct ovsdb_jsonrpc_session *s, *next;
507 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
508 jsonrpc_session_force_reconnect(s->js);
509 if (!jsonrpc_session_is_alive(s->js)) {
510 ovsdb_jsonrpc_session_close(s);
515 /* Sets the options for all of the JSON-RPC sessions managed by 'remote' to
518 ovsdb_jsonrpc_session_set_all_options(
519 struct ovsdb_jsonrpc_remote *remote,
520 const struct ovsdb_jsonrpc_options *options)
522 struct ovsdb_jsonrpc_session *s;
524 if (remote->listener) {
527 error = pstream_set_dscp(remote->listener, options->dscp);
529 VLOG_ERR("%s: set_dscp failed %s",
530 pstream_get_name(remote->listener), strerror(error));
532 remote->dscp = options->dscp;
535 * TODO:XXX race window between setting dscp to listening socket
536 * and accepting socket. Accepted socket may have old dscp value.
537 * Ignore this race window for now.
540 LIST_FOR_EACH (s, node, &remote->sessions) {
541 ovsdb_jsonrpc_session_set_options(s, options);
546 ovsdb_jsonrpc_session_get_status(const struct ovsdb_jsonrpc_remote *remote,
547 struct ovsdb_jsonrpc_remote_status *status)
549 const struct ovsdb_jsonrpc_session *s;
550 const struct jsonrpc_session *js;
551 struct ovsdb_lock_waiter *waiter;
552 struct reconnect_stats rstats;
553 struct ds locks_held, locks_waiting, locks_lost;
555 if (list_is_empty(&remote->sessions)) {
558 s = CONTAINER_OF(remote->sessions.next, struct ovsdb_jsonrpc_session, node);
561 status->is_connected = jsonrpc_session_is_connected(js);
562 status->last_error = jsonrpc_session_get_status(js);
564 jsonrpc_session_get_reconnect_stats(js, &rstats);
565 status->state = rstats.state;
566 status->sec_since_connect = rstats.msec_since_connect == UINT_MAX
567 ? UINT_MAX : rstats.msec_since_connect / 1000;
568 status->sec_since_disconnect = rstats.msec_since_disconnect == UINT_MAX
569 ? UINT_MAX : rstats.msec_since_disconnect / 1000;
571 ds_init(&locks_held);
572 ds_init(&locks_waiting);
573 ds_init(&locks_lost);
574 HMAP_FOR_EACH (waiter, session_node, &s->up.waiters) {
577 string = (ovsdb_lock_waiter_is_owner(waiter) ? &locks_held
578 : waiter->mode == OVSDB_LOCK_WAIT ? &locks_waiting
580 if (string->length) {
581 ds_put_char(string, ' ');
583 ds_put_cstr(string, waiter->lock_name);
585 status->locks_held = ds_steal_cstr(&locks_held);
586 status->locks_waiting = ds_steal_cstr(&locks_waiting);
587 status->locks_lost = ds_steal_cstr(&locks_lost);
589 status->n_connections = list_size(&remote->sessions);
594 /* Examines 'request' to determine the database to which it relates, and then
595 * searches 's' to find that database:
597 * - If successful, returns the database and sets '*replyp' to NULL.
599 * - If no such database exists, returns NULL and sets '*replyp' to an
600 * appropriate JSON-RPC error reply, owned by the caller. */
601 static struct ovsdb *
602 ovsdb_jsonrpc_lookup_db(const struct ovsdb_jsonrpc_session *s,
603 const struct jsonrpc_msg *request,
604 struct jsonrpc_msg **replyp)
606 struct json_array *params;
607 struct ovsdb_error *error;
611 params = json_array(request->params);
612 if (!params->n || params->elems[0]->type != JSON_STRING) {
613 error = ovsdb_syntax_error(
614 request->params, NULL,
615 "%s request params must begin with <db-name>", request->method);
619 db_name = params->elems[0]->u.string;
620 db = shash_find_data(&s->up.server->dbs, db_name);
622 error = ovsdb_syntax_error(
623 request->params, "unknown database",
624 "%s request specifies unknown database %s",
625 request->method, db_name);
633 *replyp = jsonrpc_create_reply(ovsdb_error_to_json(error), request->id);
634 ovsdb_error_destroy(error);
638 static struct ovsdb_error *
639 ovsdb_jsonrpc_session_parse_lock_name(const struct jsonrpc_msg *request,
640 const char **lock_namep)
642 const struct json_array *params;
644 params = json_array(request->params);
645 if (params->n != 1 || params->elems[0]->type != JSON_STRING ||
646 !ovsdb_parser_is_id(json_string(params->elems[0]))) {
648 return ovsdb_syntax_error(request->params, NULL,
649 "%s request params must be <id>",
653 *lock_namep = json_string(params->elems[0]);
658 ovsdb_jsonrpc_session_notify(struct ovsdb_session *session,
659 const char *lock_name,
662 struct ovsdb_jsonrpc_session *s;
665 s = CONTAINER_OF(session, struct ovsdb_jsonrpc_session, up);
666 params = json_array_create_1(json_string_create(lock_name));
667 jsonrpc_session_send(s->js, jsonrpc_create_notify(method, params));
670 static struct jsonrpc_msg *
671 ovsdb_jsonrpc_session_lock(struct ovsdb_jsonrpc_session *s,
672 struct jsonrpc_msg *request,
673 enum ovsdb_lock_mode mode)
675 struct ovsdb_lock_waiter *waiter;
676 struct jsonrpc_msg *reply;
677 struct ovsdb_error *error;
678 struct ovsdb_session *victim;
679 const char *lock_name;
682 error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
687 /* Report error if this session has issued a "lock" or "steal" without a
688 * matching "unlock" for this lock. */
689 waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
691 error = ovsdb_syntax_error(
692 request->params, NULL,
693 "must issue \"unlock\" before new \"%s\"", request->method);
697 /* Get the lock, add us as a waiter. */
698 waiter = ovsdb_server_lock(&s->remote->server->up, &s->up, lock_name, mode,
701 ovsdb_jsonrpc_session_notify(victim, lock_name, "stolen");
704 result = json_object_create();
705 json_object_put(result, "locked",
706 json_boolean_create(ovsdb_lock_waiter_is_owner(waiter)));
708 return jsonrpc_create_reply(result, request->id);
711 reply = jsonrpc_create_reply(ovsdb_error_to_json(error), request->id);
712 ovsdb_error_destroy(error);
717 ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *s)
719 struct ovsdb_lock_waiter *waiter, *next;
721 HMAP_FOR_EACH_SAFE (waiter, next, session_node, &s->up.waiters) {
722 ovsdb_jsonrpc_session_unlock__(waiter);
727 ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *waiter)
729 struct ovsdb_lock *lock = waiter->lock;
732 struct ovsdb_session *new_owner = ovsdb_lock_waiter_remove(waiter);
734 ovsdb_jsonrpc_session_notify(new_owner, lock->name, "locked");
736 /* ovsdb_server_lock() might have freed 'lock'. */
740 ovsdb_lock_waiter_destroy(waiter);
743 static struct jsonrpc_msg *
744 ovsdb_jsonrpc_session_unlock(struct ovsdb_jsonrpc_session *s,
745 struct jsonrpc_msg *request)
747 struct ovsdb_lock_waiter *waiter;
748 struct jsonrpc_msg *reply;
749 struct ovsdb_error *error;
750 const char *lock_name;
752 error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
757 /* Report error if this session has not issued a "lock" or "steal" for this
759 waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
761 error = ovsdb_syntax_error(
762 request->params, NULL, "\"unlock\" without \"lock\" or \"steal\"");
766 ovsdb_jsonrpc_session_unlock__(waiter);
768 return jsonrpc_create_reply(json_object_create(), request->id);
771 reply = jsonrpc_create_reply(ovsdb_error_to_json(error), request->id);
772 ovsdb_error_destroy(error);
776 static struct jsonrpc_msg *
777 execute_transaction(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
778 struct jsonrpc_msg *request)
780 ovsdb_jsonrpc_trigger_create(s, db, request->id, request->params);
782 request->params = NULL;
783 jsonrpc_msg_destroy(request);
788 ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *s,
789 struct jsonrpc_msg *request)
791 struct jsonrpc_msg *reply;
793 if (!strcmp(request->method, "transact")) {
794 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
796 reply = execute_transaction(s, db, request);
798 } else if (!strcmp(request->method, "monitor")) {
799 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
801 reply = jsonrpc_create_reply(
802 ovsdb_jsonrpc_monitor_create(s, db, request->params),
805 } else if (!strcmp(request->method, "monitor_cancel")) {
806 reply = ovsdb_jsonrpc_monitor_cancel(s, json_array(request->params),
808 } else if (!strcmp(request->method, "get_schema")) {
809 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
811 reply = jsonrpc_create_reply(ovsdb_schema_to_json(db->schema),
814 } else if (!strcmp(request->method, "list_dbs")) {
815 size_t n_dbs = shash_count(&s->up.server->dbs);
816 struct shash_node *node;
820 dbs = xmalloc(n_dbs * sizeof *dbs);
822 SHASH_FOR_EACH (node, &s->up.server->dbs) {
823 dbs[i++] = json_string_create(node->name);
825 reply = jsonrpc_create_reply(json_array_create(dbs, n_dbs),
827 } else if (!strcmp(request->method, "lock")) {
828 reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_WAIT);
829 } else if (!strcmp(request->method, "steal")) {
830 reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_STEAL);
831 } else if (!strcmp(request->method, "unlock")) {
832 reply = ovsdb_jsonrpc_session_unlock(s, request);
833 } else if (!strcmp(request->method, "echo")) {
834 reply = jsonrpc_create_reply(json_clone(request->params), request->id);
836 reply = jsonrpc_create_error(json_string_create("unknown method"),
841 jsonrpc_msg_destroy(request);
842 jsonrpc_session_send(s->js, reply);
847 execute_cancel(struct ovsdb_jsonrpc_session *s, struct jsonrpc_msg *request)
849 if (json_array(request->params)->n == 1) {
850 struct ovsdb_jsonrpc_trigger *t;
853 id = request->params->u.array.elems[0];
854 t = ovsdb_jsonrpc_trigger_find(s, id, json_hash(id, 0));
856 ovsdb_jsonrpc_trigger_complete(t);
862 ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *s,
863 struct jsonrpc_msg *request)
865 if (!strcmp(request->method, "cancel")) {
866 execute_cancel(s, request);
868 jsonrpc_msg_destroy(request);
871 /* JSON-RPC database server triggers.
873 * (Every transaction is treated as a trigger even if it doesn't actually have
874 * any "wait" operations.) */
876 struct ovsdb_jsonrpc_trigger {
877 struct ovsdb_trigger trigger;
878 struct hmap_node hmap_node; /* In session's "triggers" hmap. */
883 ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
884 struct json *id, struct json *params)
886 struct ovsdb_jsonrpc_trigger *t;
889 /* Check for duplicate ID. */
890 hash = json_hash(id, 0);
891 t = ovsdb_jsonrpc_trigger_find(s, id, hash);
893 struct jsonrpc_msg *msg;
895 msg = jsonrpc_create_error(json_string_create("duplicate request ID"),
897 jsonrpc_session_send(s->js, msg);
899 json_destroy(params);
903 /* Insert into trigger table. */
904 t = xmalloc(sizeof *t);
905 ovsdb_trigger_init(&s->up, db, &t->trigger, params, time_msec());
907 hmap_insert(&s->triggers, &t->hmap_node, hash);
909 /* Complete early if possible. */
910 if (ovsdb_trigger_is_complete(&t->trigger)) {
911 ovsdb_jsonrpc_trigger_complete(t);
915 static struct ovsdb_jsonrpc_trigger *
916 ovsdb_jsonrpc_trigger_find(struct ovsdb_jsonrpc_session *s,
917 const struct json *id, size_t hash)
919 struct ovsdb_jsonrpc_trigger *t;
921 HMAP_FOR_EACH_WITH_HASH (t, hmap_node, hash, &s->triggers) {
922 if (json_equal(t->id, id)) {
931 ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *t)
933 struct ovsdb_jsonrpc_session *s;
935 s = CONTAINER_OF(t->trigger.session, struct ovsdb_jsonrpc_session, up);
937 if (jsonrpc_session_is_connected(s->js)) {
938 struct jsonrpc_msg *reply;
941 result = ovsdb_trigger_steal_result(&t->trigger);
943 reply = jsonrpc_create_reply(result, t->id);
945 reply = jsonrpc_create_error(json_string_create("canceled"),
948 jsonrpc_session_send(s->js, reply);
952 ovsdb_trigger_destroy(&t->trigger);
953 hmap_remove(&s->triggers, &t->hmap_node);
958 ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *s)
960 struct ovsdb_jsonrpc_trigger *t, *next;
961 HMAP_FOR_EACH_SAFE (t, next, hmap_node, &s->triggers) {
962 ovsdb_jsonrpc_trigger_complete(t);
967 ovsdb_jsonrpc_trigger_complete_done(struct ovsdb_jsonrpc_session *s)
969 while (!list_is_empty(&s->up.completions)) {
970 struct ovsdb_jsonrpc_trigger *t
971 = CONTAINER_OF(s->up.completions.next,
972 struct ovsdb_jsonrpc_trigger, trigger.node);
973 ovsdb_jsonrpc_trigger_complete(t);
977 /* JSON-RPC database table monitors. */
979 enum ovsdb_jsonrpc_monitor_selection {
980 OJMS_INITIAL = 1 << 0, /* All rows when monitor is created. */
981 OJMS_INSERT = 1 << 1, /* New rows. */
982 OJMS_DELETE = 1 << 2, /* Deleted rows. */
983 OJMS_MODIFY = 1 << 3 /* Modified rows. */
986 /* A particular column being monitored. */
987 struct ovsdb_jsonrpc_monitor_column {
988 const struct ovsdb_column *column;
989 enum ovsdb_jsonrpc_monitor_selection select;
992 /* A particular table being monitored. */
993 struct ovsdb_jsonrpc_monitor_table {
994 const struct ovsdb_table *table;
996 /* This is the union (bitwise-OR) of the 'select' values in all of the
997 * members of 'columns' below. */
998 enum ovsdb_jsonrpc_monitor_selection select;
1000 /* Columns being monitored. */
1001 struct ovsdb_jsonrpc_monitor_column *columns;
1005 /* A collection of tables being monitored. */
1006 struct ovsdb_jsonrpc_monitor {
1007 struct ovsdb_replica replica;
1008 struct ovsdb_jsonrpc_session *session;
1010 struct hmap_node node; /* In ovsdb_jsonrpc_session's "monitors". */
1012 struct json *monitor_id;
1013 struct shash tables; /* Holds "struct ovsdb_jsonrpc_monitor_table"s. */
1016 static const struct ovsdb_replica_class ovsdb_jsonrpc_replica_class;
1018 struct ovsdb_jsonrpc_monitor *ovsdb_jsonrpc_monitor_find(
1019 struct ovsdb_jsonrpc_session *, const struct json *monitor_id);
1020 static void ovsdb_jsonrpc_monitor_destroy(struct ovsdb_replica *);
1021 static struct json *ovsdb_jsonrpc_monitor_get_initial(
1022 const struct ovsdb_jsonrpc_monitor *);
1025 parse_bool(struct ovsdb_parser *parser, const char *name, bool default_value)
1027 const struct json *json;
1029 json = ovsdb_parser_member(parser, name, OP_BOOLEAN | OP_OPTIONAL);
1030 return json ? json_boolean(json) : default_value;
1033 struct ovsdb_jsonrpc_monitor *
1034 ovsdb_jsonrpc_monitor_find(struct ovsdb_jsonrpc_session *s,
1035 const struct json *monitor_id)
1037 struct ovsdb_jsonrpc_monitor *m;
1039 HMAP_FOR_EACH_WITH_HASH (m, node, json_hash(monitor_id, 0), &s->monitors) {
1040 if (json_equal(m->monitor_id, monitor_id)) {
1049 ovsdb_jsonrpc_add_monitor_column(struct ovsdb_jsonrpc_monitor_table *mt,
1050 const struct ovsdb_column *column,
1051 enum ovsdb_jsonrpc_monitor_selection select,
1052 size_t *allocated_columns)
1054 struct ovsdb_jsonrpc_monitor_column *c;
1056 if (mt->n_columns >= *allocated_columns) {
1057 mt->columns = x2nrealloc(mt->columns, allocated_columns,
1058 sizeof *mt->columns);
1061 c = &mt->columns[mt->n_columns++];
1067 compare_ovsdb_jsonrpc_monitor_column(const void *a_, const void *b_)
1069 const struct ovsdb_jsonrpc_monitor_column *a = a_;
1070 const struct ovsdb_jsonrpc_monitor_column *b = b_;
1072 return a->column < b->column ? -1 : a->column > b->column;
1075 static struct ovsdb_error * WARN_UNUSED_RESULT
1076 ovsdb_jsonrpc_parse_monitor_request(struct ovsdb_jsonrpc_monitor_table *mt,
1077 const struct json *monitor_request,
1078 size_t *allocated_columns)
1080 const struct ovsdb_table_schema *ts = mt->table->schema;
1081 enum ovsdb_jsonrpc_monitor_selection select;
1082 const struct json *columns, *select_json;
1083 struct ovsdb_parser parser;
1084 struct ovsdb_error *error;
1086 ovsdb_parser_init(&parser, monitor_request, "table %s", ts->name);
1087 columns = ovsdb_parser_member(&parser, "columns", OP_ARRAY | OP_OPTIONAL);
1088 select_json = ovsdb_parser_member(&parser, "select",
1089 OP_OBJECT | OP_OPTIONAL);
1090 error = ovsdb_parser_finish(&parser);
1097 ovsdb_parser_init(&parser, select_json, "table %s select", ts->name);
1098 if (parse_bool(&parser, "initial", true)) {
1099 select |= OJMS_INITIAL;
1101 if (parse_bool(&parser, "insert", true)) {
1102 select |= OJMS_INSERT;
1104 if (parse_bool(&parser, "delete", true)) {
1105 select |= OJMS_DELETE;
1107 if (parse_bool(&parser, "modify", true)) {
1108 select |= OJMS_MODIFY;
1110 error = ovsdb_parser_finish(&parser);
1115 select = OJMS_INITIAL | OJMS_INSERT | OJMS_DELETE | OJMS_MODIFY;
1117 mt->select |= select;
1122 if (columns->type != JSON_ARRAY) {
1123 return ovsdb_syntax_error(columns, NULL,
1124 "array of column names expected");
1127 for (i = 0; i < columns->u.array.n; i++) {
1128 const struct ovsdb_column *column;
1131 if (columns->u.array.elems[i]->type != JSON_STRING) {
1132 return ovsdb_syntax_error(columns, NULL,
1133 "array of column names expected");
1136 s = columns->u.array.elems[i]->u.string;
1137 column = shash_find_data(&mt->table->schema->columns, s);
1139 return ovsdb_syntax_error(columns, NULL, "%s is not a valid "
1142 ovsdb_jsonrpc_add_monitor_column(mt, column, select,
1146 struct shash_node *node;
1148 SHASH_FOR_EACH (node, &ts->columns) {
1149 const struct ovsdb_column *column = node->data;
1150 if (column->index != OVSDB_COL_UUID) {
1151 ovsdb_jsonrpc_add_monitor_column(mt, column, select,
1160 static struct json *
1161 ovsdb_jsonrpc_monitor_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
1162 struct json *params)
1164 struct ovsdb_jsonrpc_monitor *m = NULL;
1165 struct json *monitor_id, *monitor_requests;
1166 struct ovsdb_error *error = NULL;
1167 struct shash_node *node;
1170 if (json_array(params)->n != 3) {
1171 error = ovsdb_syntax_error(params, NULL, "invalid parameters");
1174 monitor_id = params->u.array.elems[1];
1175 monitor_requests = params->u.array.elems[2];
1176 if (monitor_requests->type != JSON_OBJECT) {
1177 error = ovsdb_syntax_error(monitor_requests, NULL,
1178 "monitor-requests must be object");
1182 if (ovsdb_jsonrpc_monitor_find(s, monitor_id)) {
1183 error = ovsdb_syntax_error(monitor_id, NULL, "duplicate monitor ID");
1187 m = xzalloc(sizeof *m);
1188 ovsdb_replica_init(&m->replica, &ovsdb_jsonrpc_replica_class);
1189 ovsdb_add_replica(db, &m->replica);
1192 hmap_insert(&s->monitors, &m->node, json_hash(monitor_id, 0));
1193 m->monitor_id = json_clone(monitor_id);
1194 shash_init(&m->tables);
1196 SHASH_FOR_EACH (node, json_object(monitor_requests)) {
1197 const struct ovsdb_table *table;
1198 struct ovsdb_jsonrpc_monitor_table *mt;
1199 size_t allocated_columns;
1200 const struct json *mr_value;
1203 table = ovsdb_get_table(m->db, node->name);
1205 error = ovsdb_syntax_error(NULL, NULL,
1206 "no table named %s", node->name);
1210 mt = xzalloc(sizeof *mt);
1212 shash_add(&m->tables, table->schema->name, mt);
1214 /* Parse columns. */
1215 mr_value = node->data;
1216 allocated_columns = 0;
1217 if (mr_value->type == JSON_ARRAY) {
1218 const struct json_array *array = &mr_value->u.array;
1220 for (i = 0; i < array->n; i++) {
1221 error = ovsdb_jsonrpc_parse_monitor_request(
1222 mt, array->elems[i], &allocated_columns);
1228 error = ovsdb_jsonrpc_parse_monitor_request(
1229 mt, mr_value, &allocated_columns);
1235 /* Check for duplicate columns. */
1236 qsort(mt->columns, mt->n_columns, sizeof *mt->columns,
1237 compare_ovsdb_jsonrpc_monitor_column);
1238 for (i = 1; i < mt->n_columns; i++) {
1239 if (mt->columns[i].column == mt->columns[i - 1].column) {
1240 error = ovsdb_syntax_error(mr_value, NULL, "column %s "
1241 "mentioned more than once",
1242 mt->columns[i].column->name);
1248 return ovsdb_jsonrpc_monitor_get_initial(m);
1252 ovsdb_remove_replica(m->db, &m->replica);
1255 json = ovsdb_error_to_json(error);
1256 ovsdb_error_destroy(error);
1260 static struct jsonrpc_msg *
1261 ovsdb_jsonrpc_monitor_cancel(struct ovsdb_jsonrpc_session *s,
1262 struct json_array *params,
1263 const struct json *request_id)
1265 if (params->n != 1) {
1266 return jsonrpc_create_error(json_string_create("invalid parameters"),
1269 struct ovsdb_jsonrpc_monitor *m;
1271 m = ovsdb_jsonrpc_monitor_find(s, params->elems[0]);
1273 return jsonrpc_create_error(json_string_create("unknown monitor"),
1276 ovsdb_remove_replica(m->db, &m->replica);
1277 return jsonrpc_create_reply(json_object_create(), request_id);
1283 ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *s)
1285 struct ovsdb_jsonrpc_monitor *m, *next;
1287 HMAP_FOR_EACH_SAFE (m, next, node, &s->monitors) {
1288 ovsdb_remove_replica(m->db, &m->replica);
1292 static struct ovsdb_jsonrpc_monitor *
1293 ovsdb_jsonrpc_monitor_cast(struct ovsdb_replica *replica)
1295 assert(replica->class == &ovsdb_jsonrpc_replica_class);
1296 return CONTAINER_OF(replica, struct ovsdb_jsonrpc_monitor, replica);
1299 struct ovsdb_jsonrpc_monitor_aux {
1300 bool initial; /* Sending initial contents of table? */
1301 const struct ovsdb_jsonrpc_monitor *monitor;
1302 struct json *json; /* JSON for the whole transaction. */
1304 /* Current table. */
1305 struct ovsdb_jsonrpc_monitor_table *mt;
1306 struct json *table_json; /* JSON for table's transaction. */
1310 any_reportable_change(const struct ovsdb_jsonrpc_monitor_table *mt,
1311 const unsigned long int *changed)
1315 for (i = 0; i < mt->n_columns; i++) {
1316 const struct ovsdb_jsonrpc_monitor_column *c = &mt->columns[i];
1317 unsigned int idx = c->column->index;
1319 if (c->select & OJMS_MODIFY && bitmap_is_set(changed, idx)) {
1328 ovsdb_jsonrpc_monitor_change_cb(const struct ovsdb_row *old,
1329 const struct ovsdb_row *new,
1330 const unsigned long int *changed,
1333 struct ovsdb_jsonrpc_monitor_aux *aux = aux_;
1334 const struct ovsdb_jsonrpc_monitor *m = aux->monitor;
1335 struct ovsdb_table *table = new ? new->table : old->table;
1336 enum ovsdb_jsonrpc_monitor_selection type;
1337 struct json *old_json, *new_json;
1338 struct json *row_json;
1339 char uuid[UUID_LEN + 1];
1342 if (!aux->mt || table != aux->mt->table) {
1343 aux->mt = shash_find_data(&m->tables, table->schema->name);
1344 aux->table_json = NULL;
1346 /* We don't care about rows in this table at all. Tell the caller
1352 type = (aux->initial ? OJMS_INITIAL
1353 : !old ? OJMS_INSERT
1354 : !new ? OJMS_DELETE
1356 if (!(aux->mt->select & type)) {
1357 /* We don't care about this type of change (but do want to be called
1358 * back for changes to other rows in the same table). */
1362 if (type == OJMS_MODIFY && !any_reportable_change(aux->mt, changed)) {
1363 /* Nothing of interest changed. */
1367 old_json = new_json = NULL;
1368 if (type & (OJMS_DELETE | OJMS_MODIFY)) {
1369 old_json = json_object_create();
1371 if (type & (OJMS_INITIAL | OJMS_INSERT | OJMS_MODIFY)) {
1372 new_json = json_object_create();
1374 for (i = 0; i < aux->mt->n_columns; i++) {
1375 const struct ovsdb_jsonrpc_monitor_column *c = &aux->mt->columns[i];
1376 const struct ovsdb_column *column = c->column;
1377 unsigned int idx = c->column->index;
1379 if (!(type & c->select)) {
1380 /* We don't care about this type of change for this particular
1381 * column (but we will care about it for some other column). */
1385 if ((type == OJMS_MODIFY && bitmap_is_set(changed, idx))
1386 || type == OJMS_DELETE) {
1387 json_object_put(old_json, column->name,
1388 ovsdb_datum_to_json(&old->fields[idx],
1391 if (type & (OJMS_INITIAL | OJMS_INSERT | OJMS_MODIFY)) {
1392 json_object_put(new_json, column->name,
1393 ovsdb_datum_to_json(&new->fields[idx],
1398 /* Create JSON object for transaction overall. */
1400 aux->json = json_object_create();
1403 /* Create JSON object for transaction on this table. */
1404 if (!aux->table_json) {
1405 aux->table_json = json_object_create();
1406 json_object_put(aux->json, aux->mt->table->schema->name,
1410 /* Create JSON object for transaction on this row. */
1411 row_json = json_object_create();
1413 json_object_put(row_json, "old", old_json);
1416 json_object_put(row_json, "new", new_json);
1419 /* Add JSON row to JSON table. */
1420 snprintf(uuid, sizeof uuid,
1421 UUID_FMT, UUID_ARGS(ovsdb_row_get_uuid(new ? new : old)));
1422 json_object_put(aux->table_json, uuid, row_json);
1428 ovsdb_jsonrpc_monitor_init_aux(struct ovsdb_jsonrpc_monitor_aux *aux,
1429 const struct ovsdb_jsonrpc_monitor *m,
1432 aux->initial = initial;
1436 aux->table_json = NULL;
1439 static struct ovsdb_error *
1440 ovsdb_jsonrpc_monitor_commit(struct ovsdb_replica *replica,
1441 const struct ovsdb_txn *txn,
1442 bool durable OVS_UNUSED)
1444 struct ovsdb_jsonrpc_monitor *m = ovsdb_jsonrpc_monitor_cast(replica);
1445 struct ovsdb_jsonrpc_monitor_aux aux;
1447 ovsdb_jsonrpc_monitor_init_aux(&aux, m, false);
1448 ovsdb_txn_for_each_change(txn, ovsdb_jsonrpc_monitor_change_cb, &aux);
1450 struct jsonrpc_msg *msg;
1451 struct json *params;
1453 params = json_array_create_2(json_clone(aux.monitor->monitor_id),
1455 msg = jsonrpc_create_notify("update", params);
1456 jsonrpc_session_send(aux.monitor->session->js, msg);
1462 static struct json *
1463 ovsdb_jsonrpc_monitor_get_initial(const struct ovsdb_jsonrpc_monitor *m)
1465 struct ovsdb_jsonrpc_monitor_aux aux;
1466 struct shash_node *node;
1468 ovsdb_jsonrpc_monitor_init_aux(&aux, m, true);
1469 SHASH_FOR_EACH (node, &m->tables) {
1470 struct ovsdb_jsonrpc_monitor_table *mt = node->data;
1472 if (mt->select & OJMS_INITIAL) {
1473 struct ovsdb_row *row;
1475 HMAP_FOR_EACH (row, hmap_node, &mt->table->rows) {
1476 ovsdb_jsonrpc_monitor_change_cb(NULL, row, NULL, &aux);
1480 return aux.json ? aux.json : json_object_create();
1484 ovsdb_jsonrpc_monitor_destroy(struct ovsdb_replica *replica)
1486 struct ovsdb_jsonrpc_monitor *m = ovsdb_jsonrpc_monitor_cast(replica);
1487 struct shash_node *node;
1489 json_destroy(m->monitor_id);
1490 SHASH_FOR_EACH (node, &m->tables) {
1491 struct ovsdb_jsonrpc_monitor_table *mt = node->data;
1495 shash_destroy(&m->tables);
1496 hmap_remove(&m->session->monitors, &m->node);
1500 static const struct ovsdb_replica_class ovsdb_jsonrpc_replica_class = {
1501 ovsdb_jsonrpc_monitor_commit,
1502 ovsdb_jsonrpc_monitor_destroy