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"
24 #include "dynamic-string.h"
27 #include "ovsdb-error.h"
28 #include "ovsdb-parser.h"
30 #include "reconnect.h"
37 #include "transaction.h"
41 VLOG_DEFINE_THIS_MODULE(ovsdb_jsonrpc_server);
43 struct ovsdb_jsonrpc_remote;
44 struct ovsdb_jsonrpc_session;
46 /* Message rate-limiting. */
47 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
50 static struct ovsdb_jsonrpc_session *ovsdb_jsonrpc_session_create(
51 struct ovsdb_jsonrpc_remote *, struct jsonrpc_session *);
52 static void ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *);
53 static void ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *);
54 static void ovsdb_jsonrpc_session_get_memory_usage_all(
55 const struct ovsdb_jsonrpc_remote *, struct simap *usage);
56 static void ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *);
57 static void ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *);
58 static void ovsdb_jsonrpc_session_set_all_options(
59 struct ovsdb_jsonrpc_remote *, const struct ovsdb_jsonrpc_options *);
60 static bool ovsdb_jsonrpc_session_get_status(
61 const struct ovsdb_jsonrpc_remote *,
62 struct ovsdb_jsonrpc_remote_status *);
63 static void ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *);
64 static void ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *);
67 static void ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *,
69 struct json *id, struct json *params);
70 static struct ovsdb_jsonrpc_trigger *ovsdb_jsonrpc_trigger_find(
71 struct ovsdb_jsonrpc_session *, const struct json *id, size_t hash);
72 static void ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *);
73 static void ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *);
74 static void ovsdb_jsonrpc_trigger_complete_done(
75 struct ovsdb_jsonrpc_session *);
78 static struct json *ovsdb_jsonrpc_monitor_create(
79 struct ovsdb_jsonrpc_session *, struct ovsdb *, struct json *params);
80 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_cancel(
81 struct ovsdb_jsonrpc_session *,
82 struct json_array *params,
83 const struct json *request_id);
84 static void ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *);
86 /* JSON-RPC database server. */
88 struct ovsdb_jsonrpc_server {
89 struct ovsdb_server up;
90 unsigned int n_sessions, max_sessions;
91 struct shash remotes; /* Contains "struct ovsdb_jsonrpc_remote *"s. */
94 /* A configured remote. This is either a passive stream listener plus a list
95 * of the currently connected sessions, or a list of exactly one active
97 struct ovsdb_jsonrpc_remote {
98 struct ovsdb_jsonrpc_server *server;
99 struct pstream *listener; /* Listener, if passive. */
100 struct list sessions; /* List of "struct ovsdb_jsonrpc_session"s. */
104 static struct ovsdb_jsonrpc_remote *ovsdb_jsonrpc_server_add_remote(
105 struct ovsdb_jsonrpc_server *, const char *name,
106 const struct ovsdb_jsonrpc_options *options
108 static void ovsdb_jsonrpc_server_del_remote(struct shash_node *);
110 /* Creates and returns a new server to provide JSON-RPC access to an OVSDB.
112 * The caller must call ovsdb_jsonrpc_server_add_db() for each database to
113 * which 'server' should provide access. */
114 struct ovsdb_jsonrpc_server *
115 ovsdb_jsonrpc_server_create(void)
117 struct ovsdb_jsonrpc_server *server = xzalloc(sizeof *server);
118 ovsdb_server_init(&server->up);
119 server->max_sessions = 64;
120 shash_init(&server->remotes);
124 /* Adds 'db' to the set of databases served out by 'svr'. Returns true if
125 * successful, false if 'db''s name is the same as some database already in
128 ovsdb_jsonrpc_server_add_db(struct ovsdb_jsonrpc_server *svr, struct ovsdb *db)
130 return ovsdb_server_add_db(&svr->up, db);
134 ovsdb_jsonrpc_server_destroy(struct ovsdb_jsonrpc_server *svr)
136 struct shash_node *node, *next;
138 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
139 ovsdb_jsonrpc_server_del_remote(node);
141 shash_destroy(&svr->remotes);
142 ovsdb_server_destroy(&svr->up);
146 struct ovsdb_jsonrpc_options *
147 ovsdb_jsonrpc_default_options(const char *target)
149 struct ovsdb_jsonrpc_options *options = xzalloc(sizeof *options);
150 options->max_backoff = RECONNECT_DEFAULT_MAX_BACKOFF;
151 options->probe_interval = (stream_or_pstream_needs_probes(target)
152 ? RECONNECT_DEFAULT_PROBE_INTERVAL
157 /* Sets 'svr''s current set of remotes to the names in 'new_remotes', with
158 * options in the struct ovsdb_jsonrpc_options supplied as the data values.
160 * A remote is an active or passive stream connection method, e.g. "pssl:" or
163 ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *svr,
164 const struct shash *new_remotes)
166 struct shash_node *node, *next;
168 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
169 if (!shash_find(new_remotes, node->name)) {
170 VLOG_INFO("%s: remote deconfigured", node->name);
171 ovsdb_jsonrpc_server_del_remote(node);
174 SHASH_FOR_EACH (node, new_remotes) {
175 const struct ovsdb_jsonrpc_options *options = node->data;
176 struct ovsdb_jsonrpc_remote *remote;
178 remote = shash_find_data(&svr->remotes, node->name);
180 remote = ovsdb_jsonrpc_server_add_remote(svr, node->name, options);
186 ovsdb_jsonrpc_session_set_all_options(remote, options);
190 static struct ovsdb_jsonrpc_remote *
191 ovsdb_jsonrpc_server_add_remote(struct ovsdb_jsonrpc_server *svr,
193 const struct ovsdb_jsonrpc_options *options)
195 struct ovsdb_jsonrpc_remote *remote;
196 struct pstream *listener;
199 error = jsonrpc_pstream_open(name, &listener, options->dscp);
200 if (error && error != EAFNOSUPPORT) {
201 VLOG_ERR_RL(&rl, "%s: listen failed: %s", name, strerror(error));
205 remote = xmalloc(sizeof *remote);
206 remote->server = svr;
207 remote->listener = listener;
208 list_init(&remote->sessions);
209 remote->dscp = options->dscp;
210 shash_add(&svr->remotes, name, remote);
213 ovsdb_jsonrpc_session_create(remote, jsonrpc_session_open(name));
219 ovsdb_jsonrpc_server_del_remote(struct shash_node *node)
221 struct ovsdb_jsonrpc_remote *remote = node->data;
223 ovsdb_jsonrpc_session_close_all(remote);
224 pstream_close(remote->listener);
225 shash_delete(&remote->server->remotes, node);
229 /* Stores status information for the remote named 'target', which should have
230 * been configured on 'svr' with a call to ovsdb_jsonrpc_server_set_remotes(),
231 * into '*status'. On success returns true, on failure (if 'svr' doesn't have
232 * a remote named 'target' or if that remote is an inbound remote that has no
233 * active connections) returns false. On failure, 'status' will be zeroed.
236 ovsdb_jsonrpc_server_get_remote_status(
237 const struct ovsdb_jsonrpc_server *svr, const char *target,
238 struct ovsdb_jsonrpc_remote_status *status)
240 const struct ovsdb_jsonrpc_remote *remote;
242 memset(status, 0, sizeof *status);
244 remote = shash_find_data(&svr->remotes, target);
245 return remote && ovsdb_jsonrpc_session_get_status(remote, status);
249 ovsdb_jsonrpc_server_free_remote_status(
250 struct ovsdb_jsonrpc_remote_status *status)
252 free(status->locks_held);
253 free(status->locks_waiting);
254 free(status->locks_lost);
257 /* Forces all of the JSON-RPC sessions managed by 'svr' to disconnect and
260 ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *svr)
262 struct shash_node *node;
264 SHASH_FOR_EACH (node, &svr->remotes) {
265 struct ovsdb_jsonrpc_remote *remote = node->data;
267 ovsdb_jsonrpc_session_reconnect_all(remote);
272 ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *svr)
274 struct shash_node *node;
276 SHASH_FOR_EACH (node, &svr->remotes) {
277 struct ovsdb_jsonrpc_remote *remote = node->data;
279 if (remote->listener && svr->n_sessions < svr->max_sessions) {
280 struct stream *stream;
283 error = pstream_accept(remote->listener, &stream);
285 struct jsonrpc_session *js;
286 js = jsonrpc_session_open_unreliably(jsonrpc_open(stream),
288 ovsdb_jsonrpc_session_create(remote, js);
289 } else if (error != EAGAIN) {
290 VLOG_WARN_RL(&rl, "%s: accept failed: %s",
291 pstream_get_name(remote->listener),
296 ovsdb_jsonrpc_session_run_all(remote);
301 ovsdb_jsonrpc_server_wait(struct ovsdb_jsonrpc_server *svr)
303 struct shash_node *node;
305 SHASH_FOR_EACH (node, &svr->remotes) {
306 struct ovsdb_jsonrpc_remote *remote = node->data;
308 if (remote->listener && svr->n_sessions < svr->max_sessions) {
309 pstream_wait(remote->listener);
312 ovsdb_jsonrpc_session_wait_all(remote);
316 /* Adds some memory usage statistics for 'svr' into 'usage', for use with
317 * memory_report(). */
319 ovsdb_jsonrpc_server_get_memory_usage(const struct ovsdb_jsonrpc_server *svr,
322 struct shash_node *node;
324 simap_increase(usage, "sessions", svr->n_sessions);
325 SHASH_FOR_EACH (node, &svr->remotes) {
326 struct ovsdb_jsonrpc_remote *remote = node->data;
328 ovsdb_jsonrpc_session_get_memory_usage_all(remote, usage);
332 /* JSON-RPC database server session. */
334 struct ovsdb_jsonrpc_session {
335 struct list node; /* Element in remote's sessions list. */
336 struct ovsdb_session up;
337 struct ovsdb_jsonrpc_remote *remote;
340 struct hmap triggers; /* Hmap of "struct ovsdb_jsonrpc_trigger"s. */
343 struct hmap monitors; /* Hmap of "struct ovsdb_jsonrpc_monitor"s. */
345 /* Network connectivity. */
346 struct jsonrpc_session *js; /* JSON-RPC session. */
347 unsigned int js_seqno; /* Last jsonrpc_session_get_seqno() value. */
350 static void ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *);
351 static int ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *);
352 static void ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *);
353 static void ovsdb_jsonrpc_session_get_memory_usage(
354 const struct ovsdb_jsonrpc_session *, struct simap *usage);
355 static void ovsdb_jsonrpc_session_set_options(
356 struct ovsdb_jsonrpc_session *, const struct ovsdb_jsonrpc_options *);
357 static void ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *,
358 struct jsonrpc_msg *);
359 static void ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *,
360 struct jsonrpc_msg *);
362 static struct ovsdb_jsonrpc_session *
363 ovsdb_jsonrpc_session_create(struct ovsdb_jsonrpc_remote *remote,
364 struct jsonrpc_session *js)
366 struct ovsdb_jsonrpc_session *s;
368 s = xzalloc(sizeof *s);
369 ovsdb_session_init(&s->up, &remote->server->up);
371 list_push_back(&remote->sessions, &s->node);
372 hmap_init(&s->triggers);
373 hmap_init(&s->monitors);
375 s->js_seqno = jsonrpc_session_get_seqno(js);
377 remote->server->n_sessions++;
383 ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *s)
385 ovsdb_jsonrpc_monitor_remove_all(s);
386 ovsdb_jsonrpc_session_unlock_all(s);
387 jsonrpc_session_close(s->js);
388 list_remove(&s->node);
389 ovsdb_session_destroy(&s->up);
390 s->remote->server->n_sessions--;
391 ovsdb_session_destroy(&s->up);
396 ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *s)
398 jsonrpc_session_run(s->js);
399 if (s->js_seqno != jsonrpc_session_get_seqno(s->js)) {
400 s->js_seqno = jsonrpc_session_get_seqno(s->js);
401 ovsdb_jsonrpc_trigger_complete_all(s);
402 ovsdb_jsonrpc_monitor_remove_all(s);
403 ovsdb_jsonrpc_session_unlock_all(s);
406 ovsdb_jsonrpc_trigger_complete_done(s);
408 if (!jsonrpc_session_get_backlog(s->js)) {
409 struct jsonrpc_msg *msg = jsonrpc_session_recv(s->js);
411 if (msg->type == JSONRPC_REQUEST) {
412 ovsdb_jsonrpc_session_got_request(s, msg);
413 } else if (msg->type == JSONRPC_NOTIFY) {
414 ovsdb_jsonrpc_session_got_notify(s, msg);
416 VLOG_WARN("%s: received unexpected %s message",
417 jsonrpc_session_get_name(s->js),
418 jsonrpc_msg_type_to_string(msg->type));
419 jsonrpc_session_force_reconnect(s->js);
420 jsonrpc_msg_destroy(msg);
424 return jsonrpc_session_is_alive(s->js) ? 0 : ETIMEDOUT;
428 ovsdb_jsonrpc_session_set_options(struct ovsdb_jsonrpc_session *session,
429 const struct ovsdb_jsonrpc_options *options)
431 jsonrpc_session_set_max_backoff(session->js, options->max_backoff);
432 jsonrpc_session_set_probe_interval(session->js, options->probe_interval);
433 jsonrpc_session_set_dscp(session->js, options->dscp);
437 ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *remote)
439 struct ovsdb_jsonrpc_session *s, *next;
441 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
442 int error = ovsdb_jsonrpc_session_run(s);
444 ovsdb_jsonrpc_session_close(s);
450 ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *s)
452 jsonrpc_session_wait(s->js);
453 if (!jsonrpc_session_get_backlog(s->js)) {
454 jsonrpc_session_recv_wait(s->js);
459 ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *remote)
461 struct ovsdb_jsonrpc_session *s;
463 LIST_FOR_EACH (s, node, &remote->sessions) {
464 ovsdb_jsonrpc_session_wait(s);
469 ovsdb_jsonrpc_session_get_memory_usage(const struct ovsdb_jsonrpc_session *s,
472 simap_increase(usage, "triggers", hmap_count(&s->triggers));
473 simap_increase(usage, "monitors", hmap_count(&s->monitors));
474 simap_increase(usage, "backlog", jsonrpc_session_get_backlog(s->js));
478 ovsdb_jsonrpc_session_get_memory_usage_all(
479 const struct ovsdb_jsonrpc_remote *remote,
482 struct ovsdb_jsonrpc_session *s;
484 LIST_FOR_EACH (s, node, &remote->sessions) {
485 ovsdb_jsonrpc_session_get_memory_usage(s, usage);
490 ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *remote)
492 struct ovsdb_jsonrpc_session *s, *next;
494 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
495 ovsdb_jsonrpc_session_close(s);
499 /* Forces all of the JSON-RPC sessions managed by 'remote' to disconnect and
502 ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *remote)
504 struct ovsdb_jsonrpc_session *s, *next;
506 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
507 jsonrpc_session_force_reconnect(s->js);
508 if (!jsonrpc_session_is_alive(s->js)) {
509 ovsdb_jsonrpc_session_close(s);
514 /* Sets the options for all of the JSON-RPC sessions managed by 'remote' to
517 ovsdb_jsonrpc_session_set_all_options(
518 struct ovsdb_jsonrpc_remote *remote,
519 const struct ovsdb_jsonrpc_options *options)
521 struct ovsdb_jsonrpc_session *s;
523 if (remote->listener) {
526 error = pstream_set_dscp(remote->listener, options->dscp);
528 VLOG_ERR("%s: set_dscp failed %s",
529 pstream_get_name(remote->listener), strerror(error));
531 remote->dscp = options->dscp;
534 * XXX race window between setting dscp to listening socket
535 * and accepting socket. Accepted socket may have old dscp value.
536 * Ignore this race window for now.
539 LIST_FOR_EACH (s, node, &remote->sessions) {
540 ovsdb_jsonrpc_session_set_options(s, options);
545 ovsdb_jsonrpc_session_get_status(const struct ovsdb_jsonrpc_remote *remote,
546 struct ovsdb_jsonrpc_remote_status *status)
548 const struct ovsdb_jsonrpc_session *s;
549 const struct jsonrpc_session *js;
550 struct ovsdb_lock_waiter *waiter;
551 struct reconnect_stats rstats;
552 struct ds locks_held, locks_waiting, locks_lost;
554 if (list_is_empty(&remote->sessions)) {
557 s = CONTAINER_OF(remote->sessions.next, struct ovsdb_jsonrpc_session, node);
560 status->is_connected = jsonrpc_session_is_connected(js);
561 status->last_error = jsonrpc_session_get_status(js);
563 jsonrpc_session_get_reconnect_stats(js, &rstats);
564 status->state = rstats.state;
565 status->sec_since_connect = rstats.msec_since_connect == UINT_MAX
566 ? UINT_MAX : rstats.msec_since_connect / 1000;
567 status->sec_since_disconnect = rstats.msec_since_disconnect == UINT_MAX
568 ? UINT_MAX : rstats.msec_since_disconnect / 1000;
570 ds_init(&locks_held);
571 ds_init(&locks_waiting);
572 ds_init(&locks_lost);
573 HMAP_FOR_EACH (waiter, session_node, &s->up.waiters) {
576 string = (ovsdb_lock_waiter_is_owner(waiter) ? &locks_held
577 : waiter->mode == OVSDB_LOCK_WAIT ? &locks_waiting
579 if (string->length) {
580 ds_put_char(string, ' ');
582 ds_put_cstr(string, waiter->lock_name);
584 status->locks_held = ds_steal_cstr(&locks_held);
585 status->locks_waiting = ds_steal_cstr(&locks_waiting);
586 status->locks_lost = ds_steal_cstr(&locks_lost);
588 status->n_connections = list_size(&remote->sessions);
593 /* Examines 'request' to determine the database to which it relates, and then
594 * searches 's' to find that database:
596 * - If successful, returns the database and sets '*replyp' to NULL.
598 * - If no such database exists, returns NULL and sets '*replyp' to an
599 * appropriate JSON-RPC error reply, owned by the caller. */
600 static struct ovsdb *
601 ovsdb_jsonrpc_lookup_db(const struct ovsdb_jsonrpc_session *s,
602 const struct jsonrpc_msg *request,
603 struct jsonrpc_msg **replyp)
605 struct json_array *params;
606 struct ovsdb_error *error;
610 params = json_array(request->params);
611 if (!params->n || params->elems[0]->type != JSON_STRING) {
612 error = ovsdb_syntax_error(
613 request->params, NULL,
614 "%s request params must begin with <db-name>", request->method);
618 db_name = params->elems[0]->u.string;
619 db = shash_find_data(&s->up.server->dbs, db_name);
621 error = ovsdb_syntax_error(
622 request->params, "unknown database",
623 "%s request specifies unknown database %s",
624 request->method, db_name);
632 *replyp = jsonrpc_create_reply(ovsdb_error_to_json(error), request->id);
633 ovsdb_error_destroy(error);
637 static struct ovsdb_error *
638 ovsdb_jsonrpc_session_parse_lock_name(const struct jsonrpc_msg *request,
639 const char **lock_namep)
641 const struct json_array *params;
643 params = json_array(request->params);
644 if (params->n != 1 || params->elems[0]->type != JSON_STRING ||
645 !ovsdb_parser_is_id(json_string(params->elems[0]))) {
647 return ovsdb_syntax_error(request->params, NULL,
648 "%s request params must be <id>",
652 *lock_namep = json_string(params->elems[0]);
657 ovsdb_jsonrpc_session_notify(struct ovsdb_session *session,
658 const char *lock_name,
661 struct ovsdb_jsonrpc_session *s;
664 s = CONTAINER_OF(session, struct ovsdb_jsonrpc_session, up);
665 params = json_array_create_1(json_string_create(lock_name));
666 jsonrpc_session_send(s->js, jsonrpc_create_notify(method, params));
669 static struct jsonrpc_msg *
670 ovsdb_jsonrpc_session_lock(struct ovsdb_jsonrpc_session *s,
671 struct jsonrpc_msg *request,
672 enum ovsdb_lock_mode mode)
674 struct ovsdb_lock_waiter *waiter;
675 struct jsonrpc_msg *reply;
676 struct ovsdb_error *error;
677 struct ovsdb_session *victim;
678 const char *lock_name;
681 error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
686 /* Report error if this session has issued a "lock" or "steal" without a
687 * matching "unlock" for this lock. */
688 waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
690 error = ovsdb_syntax_error(
691 request->params, NULL,
692 "must issue \"unlock\" before new \"%s\"", request->method);
696 /* Get the lock, add us as a waiter. */
697 waiter = ovsdb_server_lock(&s->remote->server->up, &s->up, lock_name, mode,
700 ovsdb_jsonrpc_session_notify(victim, lock_name, "stolen");
703 result = json_object_create();
704 json_object_put(result, "locked",
705 json_boolean_create(ovsdb_lock_waiter_is_owner(waiter)));
707 return jsonrpc_create_reply(result, request->id);
710 reply = jsonrpc_create_reply(ovsdb_error_to_json(error), request->id);
711 ovsdb_error_destroy(error);
716 ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *s)
718 struct ovsdb_lock_waiter *waiter, *next;
720 HMAP_FOR_EACH_SAFE (waiter, next, session_node, &s->up.waiters) {
721 ovsdb_jsonrpc_session_unlock__(waiter);
726 ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *waiter)
728 struct ovsdb_lock *lock = waiter->lock;
731 struct ovsdb_session *new_owner = ovsdb_lock_waiter_remove(waiter);
733 ovsdb_jsonrpc_session_notify(new_owner, lock->name, "locked");
735 /* ovsdb_server_lock() might have freed 'lock'. */
739 ovsdb_lock_waiter_destroy(waiter);
742 static struct jsonrpc_msg *
743 ovsdb_jsonrpc_session_unlock(struct ovsdb_jsonrpc_session *s,
744 struct jsonrpc_msg *request)
746 struct ovsdb_lock_waiter *waiter;
747 struct jsonrpc_msg *reply;
748 struct ovsdb_error *error;
749 const char *lock_name;
751 error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
756 /* Report error if this session has not issued a "lock" or "steal" for this
758 waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
760 error = ovsdb_syntax_error(
761 request->params, NULL, "\"unlock\" without \"lock\" or \"steal\"");
765 ovsdb_jsonrpc_session_unlock__(waiter);
767 return jsonrpc_create_reply(json_object_create(), request->id);
770 reply = jsonrpc_create_reply(ovsdb_error_to_json(error), request->id);
771 ovsdb_error_destroy(error);
775 static struct jsonrpc_msg *
776 execute_transaction(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
777 struct jsonrpc_msg *request)
779 ovsdb_jsonrpc_trigger_create(s, db, request->id, request->params);
781 request->params = NULL;
782 jsonrpc_msg_destroy(request);
787 ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *s,
788 struct jsonrpc_msg *request)
790 struct jsonrpc_msg *reply;
792 if (!strcmp(request->method, "transact")) {
793 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
795 reply = execute_transaction(s, db, request);
797 } else if (!strcmp(request->method, "monitor")) {
798 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
800 reply = jsonrpc_create_reply(
801 ovsdb_jsonrpc_monitor_create(s, db, request->params),
804 } else if (!strcmp(request->method, "monitor_cancel")) {
805 reply = ovsdb_jsonrpc_monitor_cancel(s, json_array(request->params),
807 } else if (!strcmp(request->method, "get_schema")) {
808 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
810 reply = jsonrpc_create_reply(ovsdb_schema_to_json(db->schema),
813 } else if (!strcmp(request->method, "list_dbs")) {
814 size_t n_dbs = shash_count(&s->up.server->dbs);
815 struct shash_node *node;
819 dbs = xmalloc(n_dbs * sizeof *dbs);
821 SHASH_FOR_EACH (node, &s->up.server->dbs) {
822 dbs[i++] = json_string_create(node->name);
824 reply = jsonrpc_create_reply(json_array_create(dbs, n_dbs),
826 } else if (!strcmp(request->method, "lock")) {
827 reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_WAIT);
828 } else if (!strcmp(request->method, "steal")) {
829 reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_STEAL);
830 } else if (!strcmp(request->method, "unlock")) {
831 reply = ovsdb_jsonrpc_session_unlock(s, request);
832 } else if (!strcmp(request->method, "echo")) {
833 reply = jsonrpc_create_reply(json_clone(request->params), request->id);
835 reply = jsonrpc_create_error(json_string_create("unknown method"),
840 jsonrpc_msg_destroy(request);
841 jsonrpc_session_send(s->js, reply);
846 execute_cancel(struct ovsdb_jsonrpc_session *s, struct jsonrpc_msg *request)
848 if (json_array(request->params)->n == 1) {
849 struct ovsdb_jsonrpc_trigger *t;
852 id = request->params->u.array.elems[0];
853 t = ovsdb_jsonrpc_trigger_find(s, id, json_hash(id, 0));
855 ovsdb_jsonrpc_trigger_complete(t);
861 ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *s,
862 struct jsonrpc_msg *request)
864 if (!strcmp(request->method, "cancel")) {
865 execute_cancel(s, request);
867 jsonrpc_msg_destroy(request);
870 /* JSON-RPC database server triggers.
872 * (Every transaction is treated as a trigger even if it doesn't actually have
873 * any "wait" operations.) */
875 struct ovsdb_jsonrpc_trigger {
876 struct ovsdb_trigger trigger;
877 struct hmap_node hmap_node; /* In session's "triggers" hmap. */
882 ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
883 struct json *id, struct json *params)
885 struct ovsdb_jsonrpc_trigger *t;
888 /* Check for duplicate ID. */
889 hash = json_hash(id, 0);
890 t = ovsdb_jsonrpc_trigger_find(s, id, hash);
892 struct jsonrpc_msg *msg;
894 msg = jsonrpc_create_error(json_string_create("duplicate request ID"),
896 jsonrpc_session_send(s->js, msg);
898 json_destroy(params);
902 /* Insert into trigger table. */
903 t = xmalloc(sizeof *t);
904 ovsdb_trigger_init(&s->up, db, &t->trigger, params, time_msec());
906 hmap_insert(&s->triggers, &t->hmap_node, hash);
908 /* Complete early if possible. */
909 if (ovsdb_trigger_is_complete(&t->trigger)) {
910 ovsdb_jsonrpc_trigger_complete(t);
914 static struct ovsdb_jsonrpc_trigger *
915 ovsdb_jsonrpc_trigger_find(struct ovsdb_jsonrpc_session *s,
916 const struct json *id, size_t hash)
918 struct ovsdb_jsonrpc_trigger *t;
920 HMAP_FOR_EACH_WITH_HASH (t, hmap_node, hash, &s->triggers) {
921 if (json_equal(t->id, id)) {
930 ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *t)
932 struct ovsdb_jsonrpc_session *s;
934 s = CONTAINER_OF(t->trigger.session, struct ovsdb_jsonrpc_session, up);
936 if (jsonrpc_session_is_connected(s->js)) {
937 struct jsonrpc_msg *reply;
940 result = ovsdb_trigger_steal_result(&t->trigger);
942 reply = jsonrpc_create_reply(result, t->id);
944 reply = jsonrpc_create_error(json_string_create("canceled"),
947 jsonrpc_session_send(s->js, reply);
951 ovsdb_trigger_destroy(&t->trigger);
952 hmap_remove(&s->triggers, &t->hmap_node);
957 ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *s)
959 struct ovsdb_jsonrpc_trigger *t, *next;
960 HMAP_FOR_EACH_SAFE (t, next, hmap_node, &s->triggers) {
961 ovsdb_jsonrpc_trigger_complete(t);
966 ovsdb_jsonrpc_trigger_complete_done(struct ovsdb_jsonrpc_session *s)
968 while (!list_is_empty(&s->up.completions)) {
969 struct ovsdb_jsonrpc_trigger *t
970 = CONTAINER_OF(s->up.completions.next,
971 struct ovsdb_jsonrpc_trigger, trigger.node);
972 ovsdb_jsonrpc_trigger_complete(t);
976 /* JSON-RPC database table monitors. */
978 enum ovsdb_jsonrpc_monitor_selection {
979 OJMS_INITIAL = 1 << 0, /* All rows when monitor is created. */
980 OJMS_INSERT = 1 << 1, /* New rows. */
981 OJMS_DELETE = 1 << 2, /* Deleted rows. */
982 OJMS_MODIFY = 1 << 3 /* Modified rows. */
985 /* A particular column being monitored. */
986 struct ovsdb_jsonrpc_monitor_column {
987 const struct ovsdb_column *column;
988 enum ovsdb_jsonrpc_monitor_selection select;
991 /* A particular table being monitored. */
992 struct ovsdb_jsonrpc_monitor_table {
993 const struct ovsdb_table *table;
995 /* This is the union (bitwise-OR) of the 'select' values in all of the
996 * members of 'columns' below. */
997 enum ovsdb_jsonrpc_monitor_selection select;
999 /* Columns being monitored. */
1000 struct ovsdb_jsonrpc_monitor_column *columns;
1004 /* A collection of tables being monitored. */
1005 struct ovsdb_jsonrpc_monitor {
1006 struct ovsdb_replica replica;
1007 struct ovsdb_jsonrpc_session *session;
1009 struct hmap_node node; /* In ovsdb_jsonrpc_session's "monitors". */
1011 struct json *monitor_id;
1012 struct shash tables; /* Holds "struct ovsdb_jsonrpc_monitor_table"s. */
1015 static const struct ovsdb_replica_class ovsdb_jsonrpc_replica_class;
1017 struct ovsdb_jsonrpc_monitor *ovsdb_jsonrpc_monitor_find(
1018 struct ovsdb_jsonrpc_session *, const struct json *monitor_id);
1019 static void ovsdb_jsonrpc_monitor_destroy(struct ovsdb_replica *);
1020 static struct json *ovsdb_jsonrpc_monitor_get_initial(
1021 const struct ovsdb_jsonrpc_monitor *);
1024 parse_bool(struct ovsdb_parser *parser, const char *name, bool default_value)
1026 const struct json *json;
1028 json = ovsdb_parser_member(parser, name, OP_BOOLEAN | OP_OPTIONAL);
1029 return json ? json_boolean(json) : default_value;
1032 struct ovsdb_jsonrpc_monitor *
1033 ovsdb_jsonrpc_monitor_find(struct ovsdb_jsonrpc_session *s,
1034 const struct json *monitor_id)
1036 struct ovsdb_jsonrpc_monitor *m;
1038 HMAP_FOR_EACH_WITH_HASH (m, node, json_hash(monitor_id, 0), &s->monitors) {
1039 if (json_equal(m->monitor_id, monitor_id)) {
1048 ovsdb_jsonrpc_add_monitor_column(struct ovsdb_jsonrpc_monitor_table *mt,
1049 const struct ovsdb_column *column,
1050 enum ovsdb_jsonrpc_monitor_selection select,
1051 size_t *allocated_columns)
1053 struct ovsdb_jsonrpc_monitor_column *c;
1055 if (mt->n_columns >= *allocated_columns) {
1056 mt->columns = x2nrealloc(mt->columns, allocated_columns,
1057 sizeof *mt->columns);
1060 c = &mt->columns[mt->n_columns++];
1066 compare_ovsdb_jsonrpc_monitor_column(const void *a_, const void *b_)
1068 const struct ovsdb_jsonrpc_monitor_column *a = a_;
1069 const struct ovsdb_jsonrpc_monitor_column *b = b_;
1071 return a->column < b->column ? -1 : a->column > b->column;
1074 static struct ovsdb_error * WARN_UNUSED_RESULT
1075 ovsdb_jsonrpc_parse_monitor_request(struct ovsdb_jsonrpc_monitor_table *mt,
1076 const struct json *monitor_request,
1077 size_t *allocated_columns)
1079 const struct ovsdb_table_schema *ts = mt->table->schema;
1080 enum ovsdb_jsonrpc_monitor_selection select;
1081 const struct json *columns, *select_json;
1082 struct ovsdb_parser parser;
1083 struct ovsdb_error *error;
1085 ovsdb_parser_init(&parser, monitor_request, "table %s", ts->name);
1086 columns = ovsdb_parser_member(&parser, "columns", OP_ARRAY | OP_OPTIONAL);
1087 select_json = ovsdb_parser_member(&parser, "select",
1088 OP_OBJECT | OP_OPTIONAL);
1089 error = ovsdb_parser_finish(&parser);
1096 ovsdb_parser_init(&parser, select_json, "table %s select", ts->name);
1097 if (parse_bool(&parser, "initial", true)) {
1098 select |= OJMS_INITIAL;
1100 if (parse_bool(&parser, "insert", true)) {
1101 select |= OJMS_INSERT;
1103 if (parse_bool(&parser, "delete", true)) {
1104 select |= OJMS_DELETE;
1106 if (parse_bool(&parser, "modify", true)) {
1107 select |= OJMS_MODIFY;
1109 error = ovsdb_parser_finish(&parser);
1114 select = OJMS_INITIAL | OJMS_INSERT | OJMS_DELETE | OJMS_MODIFY;
1116 mt->select |= select;
1121 if (columns->type != JSON_ARRAY) {
1122 return ovsdb_syntax_error(columns, NULL,
1123 "array of column names expected");
1126 for (i = 0; i < columns->u.array.n; i++) {
1127 const struct ovsdb_column *column;
1130 if (columns->u.array.elems[i]->type != JSON_STRING) {
1131 return ovsdb_syntax_error(columns, NULL,
1132 "array of column names expected");
1135 s = columns->u.array.elems[i]->u.string;
1136 column = shash_find_data(&mt->table->schema->columns, s);
1138 return ovsdb_syntax_error(columns, NULL, "%s is not a valid "
1141 ovsdb_jsonrpc_add_monitor_column(mt, column, select,
1145 struct shash_node *node;
1147 SHASH_FOR_EACH (node, &ts->columns) {
1148 const struct ovsdb_column *column = node->data;
1149 if (column->index != OVSDB_COL_UUID) {
1150 ovsdb_jsonrpc_add_monitor_column(mt, column, select,
1159 static struct json *
1160 ovsdb_jsonrpc_monitor_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
1161 struct json *params)
1163 struct ovsdb_jsonrpc_monitor *m = NULL;
1164 struct json *monitor_id, *monitor_requests;
1165 struct ovsdb_error *error = NULL;
1166 struct shash_node *node;
1169 if (json_array(params)->n != 3) {
1170 error = ovsdb_syntax_error(params, NULL, "invalid parameters");
1173 monitor_id = params->u.array.elems[1];
1174 monitor_requests = params->u.array.elems[2];
1175 if (monitor_requests->type != JSON_OBJECT) {
1176 error = ovsdb_syntax_error(monitor_requests, NULL,
1177 "monitor-requests must be object");
1181 if (ovsdb_jsonrpc_monitor_find(s, monitor_id)) {
1182 error = ovsdb_syntax_error(monitor_id, NULL, "duplicate monitor ID");
1186 m = xzalloc(sizeof *m);
1187 ovsdb_replica_init(&m->replica, &ovsdb_jsonrpc_replica_class);
1188 ovsdb_add_replica(db, &m->replica);
1191 hmap_insert(&s->monitors, &m->node, json_hash(monitor_id, 0));
1192 m->monitor_id = json_clone(monitor_id);
1193 shash_init(&m->tables);
1195 SHASH_FOR_EACH (node, json_object(monitor_requests)) {
1196 const struct ovsdb_table *table;
1197 struct ovsdb_jsonrpc_monitor_table *mt;
1198 size_t allocated_columns;
1199 const struct json *mr_value;
1202 table = ovsdb_get_table(m->db, node->name);
1204 error = ovsdb_syntax_error(NULL, NULL,
1205 "no table named %s", node->name);
1209 mt = xzalloc(sizeof *mt);
1211 shash_add(&m->tables, table->schema->name, mt);
1213 /* Parse columns. */
1214 mr_value = node->data;
1215 allocated_columns = 0;
1216 if (mr_value->type == JSON_ARRAY) {
1217 const struct json_array *array = &mr_value->u.array;
1219 for (i = 0; i < array->n; i++) {
1220 error = ovsdb_jsonrpc_parse_monitor_request(
1221 mt, array->elems[i], &allocated_columns);
1227 error = ovsdb_jsonrpc_parse_monitor_request(
1228 mt, mr_value, &allocated_columns);
1234 /* Check for duplicate columns. */
1235 qsort(mt->columns, mt->n_columns, sizeof *mt->columns,
1236 compare_ovsdb_jsonrpc_monitor_column);
1237 for (i = 1; i < mt->n_columns; i++) {
1238 if (mt->columns[i].column == mt->columns[i - 1].column) {
1239 error = ovsdb_syntax_error(mr_value, NULL, "column %s "
1240 "mentioned more than once",
1241 mt->columns[i].column->name);
1247 return ovsdb_jsonrpc_monitor_get_initial(m);
1251 ovsdb_remove_replica(m->db, &m->replica);
1254 json = ovsdb_error_to_json(error);
1255 ovsdb_error_destroy(error);
1259 static struct jsonrpc_msg *
1260 ovsdb_jsonrpc_monitor_cancel(struct ovsdb_jsonrpc_session *s,
1261 struct json_array *params,
1262 const struct json *request_id)
1264 if (params->n != 1) {
1265 return jsonrpc_create_error(json_string_create("invalid parameters"),
1268 struct ovsdb_jsonrpc_monitor *m;
1270 m = ovsdb_jsonrpc_monitor_find(s, params->elems[0]);
1272 return jsonrpc_create_error(json_string_create("unknown monitor"),
1275 ovsdb_remove_replica(m->db, &m->replica);
1276 return jsonrpc_create_reply(json_object_create(), request_id);
1282 ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *s)
1284 struct ovsdb_jsonrpc_monitor *m, *next;
1286 HMAP_FOR_EACH_SAFE (m, next, node, &s->monitors) {
1287 ovsdb_remove_replica(m->db, &m->replica);
1291 static struct ovsdb_jsonrpc_monitor *
1292 ovsdb_jsonrpc_monitor_cast(struct ovsdb_replica *replica)
1294 ovs_assert(replica->class == &ovsdb_jsonrpc_replica_class);
1295 return CONTAINER_OF(replica, struct ovsdb_jsonrpc_monitor, replica);
1298 struct ovsdb_jsonrpc_monitor_aux {
1299 bool initial; /* Sending initial contents of table? */
1300 const struct ovsdb_jsonrpc_monitor *monitor;
1301 struct json *json; /* JSON for the whole transaction. */
1303 /* Current table. */
1304 struct ovsdb_jsonrpc_monitor_table *mt;
1305 struct json *table_json; /* JSON for table's transaction. */
1309 any_reportable_change(const struct ovsdb_jsonrpc_monitor_table *mt,
1310 const unsigned long int *changed)
1314 for (i = 0; i < mt->n_columns; i++) {
1315 const struct ovsdb_jsonrpc_monitor_column *c = &mt->columns[i];
1316 unsigned int idx = c->column->index;
1318 if (c->select & OJMS_MODIFY && bitmap_is_set(changed, idx)) {
1327 ovsdb_jsonrpc_monitor_change_cb(const struct ovsdb_row *old,
1328 const struct ovsdb_row *new,
1329 const unsigned long int *changed,
1332 struct ovsdb_jsonrpc_monitor_aux *aux = aux_;
1333 const struct ovsdb_jsonrpc_monitor *m = aux->monitor;
1334 struct ovsdb_table *table = new ? new->table : old->table;
1335 enum ovsdb_jsonrpc_monitor_selection type;
1336 struct json *old_json, *new_json;
1337 struct json *row_json;
1338 char uuid[UUID_LEN + 1];
1341 if (!aux->mt || table != aux->mt->table) {
1342 aux->mt = shash_find_data(&m->tables, table->schema->name);
1343 aux->table_json = NULL;
1345 /* We don't care about rows in this table at all. Tell the caller
1351 type = (aux->initial ? OJMS_INITIAL
1352 : !old ? OJMS_INSERT
1353 : !new ? OJMS_DELETE
1355 if (!(aux->mt->select & type)) {
1356 /* We don't care about this type of change (but do want to be called
1357 * back for changes to other rows in the same table). */
1361 if (type == OJMS_MODIFY && !any_reportable_change(aux->mt, changed)) {
1362 /* Nothing of interest changed. */
1366 old_json = new_json = NULL;
1367 if (type & (OJMS_DELETE | OJMS_MODIFY)) {
1368 old_json = json_object_create();
1370 if (type & (OJMS_INITIAL | OJMS_INSERT | OJMS_MODIFY)) {
1371 new_json = json_object_create();
1373 for (i = 0; i < aux->mt->n_columns; i++) {
1374 const struct ovsdb_jsonrpc_monitor_column *c = &aux->mt->columns[i];
1375 const struct ovsdb_column *column = c->column;
1376 unsigned int idx = c->column->index;
1378 if (!(type & c->select)) {
1379 /* We don't care about this type of change for this particular
1380 * column (but we will care about it for some other column). */
1384 if ((type == OJMS_MODIFY && bitmap_is_set(changed, idx))
1385 || type == OJMS_DELETE) {
1386 json_object_put(old_json, column->name,
1387 ovsdb_datum_to_json(&old->fields[idx],
1390 if (type & (OJMS_INITIAL | OJMS_INSERT | OJMS_MODIFY)) {
1391 json_object_put(new_json, column->name,
1392 ovsdb_datum_to_json(&new->fields[idx],
1397 /* Create JSON object for transaction overall. */
1399 aux->json = json_object_create();
1402 /* Create JSON object for transaction on this table. */
1403 if (!aux->table_json) {
1404 aux->table_json = json_object_create();
1405 json_object_put(aux->json, aux->mt->table->schema->name,
1409 /* Create JSON object for transaction on this row. */
1410 row_json = json_object_create();
1412 json_object_put(row_json, "old", old_json);
1415 json_object_put(row_json, "new", new_json);
1418 /* Add JSON row to JSON table. */
1419 snprintf(uuid, sizeof uuid,
1420 UUID_FMT, UUID_ARGS(ovsdb_row_get_uuid(new ? new : old)));
1421 json_object_put(aux->table_json, uuid, row_json);
1427 ovsdb_jsonrpc_monitor_init_aux(struct ovsdb_jsonrpc_monitor_aux *aux,
1428 const struct ovsdb_jsonrpc_monitor *m,
1431 aux->initial = initial;
1435 aux->table_json = NULL;
1438 static struct ovsdb_error *
1439 ovsdb_jsonrpc_monitor_commit(struct ovsdb_replica *replica,
1440 const struct ovsdb_txn *txn,
1441 bool durable OVS_UNUSED)
1443 struct ovsdb_jsonrpc_monitor *m = ovsdb_jsonrpc_monitor_cast(replica);
1444 struct ovsdb_jsonrpc_monitor_aux aux;
1446 ovsdb_jsonrpc_monitor_init_aux(&aux, m, false);
1447 ovsdb_txn_for_each_change(txn, ovsdb_jsonrpc_monitor_change_cb, &aux);
1449 struct jsonrpc_msg *msg;
1450 struct json *params;
1452 params = json_array_create_2(json_clone(aux.monitor->monitor_id),
1454 msg = jsonrpc_create_notify("update", params);
1455 jsonrpc_session_send(aux.monitor->session->js, msg);
1461 static struct json *
1462 ovsdb_jsonrpc_monitor_get_initial(const struct ovsdb_jsonrpc_monitor *m)
1464 struct ovsdb_jsonrpc_monitor_aux aux;
1465 struct shash_node *node;
1467 ovsdb_jsonrpc_monitor_init_aux(&aux, m, true);
1468 SHASH_FOR_EACH (node, &m->tables) {
1469 struct ovsdb_jsonrpc_monitor_table *mt = node->data;
1471 if (mt->select & OJMS_INITIAL) {
1472 struct ovsdb_row *row;
1474 HMAP_FOR_EACH (row, hmap_node, &mt->table->rows) {
1475 ovsdb_jsonrpc_monitor_change_cb(NULL, row, NULL, &aux);
1479 return aux.json ? aux.json : json_object_create();
1483 ovsdb_jsonrpc_monitor_destroy(struct ovsdb_replica *replica)
1485 struct ovsdb_jsonrpc_monitor *m = ovsdb_jsonrpc_monitor_cast(replica);
1486 struct shash_node *node;
1488 json_destroy(m->monitor_id);
1489 SHASH_FOR_EACH (node, &m->tables) {
1490 struct ovsdb_jsonrpc_monitor_table *mt = node->data;
1494 shash_destroy(&m->tables);
1495 hmap_remove(&m->session->monitors, &m->node);
1499 static const struct ovsdb_replica_class ovsdb_jsonrpc_replica_class = {
1500 ovsdb_jsonrpc_monitor_commit,
1501 ovsdb_jsonrpc_monitor_destroy