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 /* Message rate-limiting. */
49 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
52 static struct ovsdb_jsonrpc_session *ovsdb_jsonrpc_session_create(
53 struct ovsdb_jsonrpc_remote *, struct jsonrpc_session *);
54 static void ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *);
55 static void ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *);
56 static void ovsdb_jsonrpc_session_get_memory_usage_all(
57 const struct ovsdb_jsonrpc_remote *, struct simap *usage);
58 static void ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *);
59 static void ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *);
60 static void ovsdb_jsonrpc_session_set_all_options(
61 struct ovsdb_jsonrpc_remote *, const struct ovsdb_jsonrpc_options *);
62 static bool ovsdb_jsonrpc_session_get_status(
63 const struct ovsdb_jsonrpc_remote *,
64 struct ovsdb_jsonrpc_remote_status *);
65 static void ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *);
66 static void ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *);
67 static void ovsdb_jsonrpc_session_send(struct ovsdb_jsonrpc_session *,
68 struct jsonrpc_msg *);
71 static void ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *,
73 struct json *id, struct json *params);
74 static struct ovsdb_jsonrpc_trigger *ovsdb_jsonrpc_trigger_find(
75 struct ovsdb_jsonrpc_session *, const struct json *id, size_t hash);
76 static void ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *);
77 static void ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *);
78 static void ovsdb_jsonrpc_trigger_complete_done(
79 struct ovsdb_jsonrpc_session *);
82 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_create(
83 struct ovsdb_jsonrpc_session *, struct ovsdb *, struct json *params,
84 enum ovsdb_monitor_version, const struct json *request_id);
85 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_cancel(
86 struct ovsdb_jsonrpc_session *,
87 struct json_array *params,
88 const struct json *request_id);
89 static void ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *);
90 static void ovsdb_jsonrpc_monitor_flush_all(struct ovsdb_jsonrpc_session *);
91 static bool ovsdb_jsonrpc_monitor_needs_flush(struct ovsdb_jsonrpc_session *);
92 static struct json *ovsdb_jsonrpc_monitor_compose_update(
93 struct ovsdb_jsonrpc_monitor *monitor, bool initial);
96 /* JSON-RPC database server. */
98 struct ovsdb_jsonrpc_server {
99 struct ovsdb_server up;
100 unsigned int n_sessions, max_sessions;
101 struct shash remotes; /* Contains "struct ovsdb_jsonrpc_remote *"s. */
104 /* A configured remote. This is either a passive stream listener plus a list
105 * of the currently connected sessions, or a list of exactly one active
107 struct ovsdb_jsonrpc_remote {
108 struct ovsdb_jsonrpc_server *server;
109 struct pstream *listener; /* Listener, if passive. */
110 struct ovs_list sessions; /* List of "struct ovsdb_jsonrpc_session"s. */
114 static struct ovsdb_jsonrpc_remote *ovsdb_jsonrpc_server_add_remote(
115 struct ovsdb_jsonrpc_server *, const char *name,
116 const struct ovsdb_jsonrpc_options *options
118 static void ovsdb_jsonrpc_server_del_remote(struct shash_node *);
120 /* Creates and returns a new server to provide JSON-RPC access to an OVSDB.
122 * The caller must call ovsdb_jsonrpc_server_add_db() for each database to
123 * which 'server' should provide access. */
124 struct ovsdb_jsonrpc_server *
125 ovsdb_jsonrpc_server_create(void)
127 struct ovsdb_jsonrpc_server *server = xzalloc(sizeof *server);
128 ovsdb_server_init(&server->up);
129 server->max_sessions = 330; /* Random limit. */
130 shash_init(&server->remotes);
134 /* Adds 'db' to the set of databases served out by 'svr'. Returns true if
135 * successful, false if 'db''s name is the same as some database already in
138 ovsdb_jsonrpc_server_add_db(struct ovsdb_jsonrpc_server *svr, struct ovsdb *db)
140 /* The OVSDB protocol doesn't have a way to notify a client that a
141 * database has been added. If some client tried to use the database
142 * that we're adding and failed, then forcing it to reconnect seems like
143 * a reasonable way to make it try again.
145 * If this is too big of a hammer in practice, we could be more selective,
146 * e.g. disconnect only connections that actually tried to use a database
147 * with 'db''s name. */
148 ovsdb_jsonrpc_server_reconnect(svr);
150 return ovsdb_server_add_db(&svr->up, db);
153 /* Removes 'db' from the set of databases served out by 'svr'. Returns
154 * true if successful, false if there is no database associated with 'db'. */
156 ovsdb_jsonrpc_server_remove_db(struct ovsdb_jsonrpc_server *svr,
159 /* There might be pointers to 'db' from 'svr', such as monitors or
160 * outstanding transactions. Disconnect all JSON-RPC connections to avoid
161 * accesses to freed memory.
163 * If this is too big of a hammer in practice, we could be more selective,
164 * e.g. disconnect only connections that actually reference 'db'. */
165 ovsdb_jsonrpc_server_reconnect(svr);
167 return ovsdb_server_remove_db(&svr->up, db);
171 ovsdb_jsonrpc_server_destroy(struct ovsdb_jsonrpc_server *svr)
173 struct shash_node *node, *next;
175 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
176 ovsdb_jsonrpc_server_del_remote(node);
178 shash_destroy(&svr->remotes);
179 ovsdb_server_destroy(&svr->up);
183 struct ovsdb_jsonrpc_options *
184 ovsdb_jsonrpc_default_options(const char *target)
186 struct ovsdb_jsonrpc_options *options = xzalloc(sizeof *options);
187 options->max_backoff = RECONNECT_DEFAULT_MAX_BACKOFF;
188 options->probe_interval = (stream_or_pstream_needs_probes(target)
189 ? RECONNECT_DEFAULT_PROBE_INTERVAL
194 /* Sets 'svr''s current set of remotes to the names in 'new_remotes', with
195 * options in the struct ovsdb_jsonrpc_options supplied as the data values.
197 * A remote is an active or passive stream connection method, e.g. "pssl:" or
200 ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *svr,
201 const struct shash *new_remotes)
203 struct shash_node *node, *next;
205 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
206 struct ovsdb_jsonrpc_remote *remote = node->data;
207 struct ovsdb_jsonrpc_options *options
208 = shash_find_data(new_remotes, node->name);
211 VLOG_INFO("%s: remote deconfigured", node->name);
212 ovsdb_jsonrpc_server_del_remote(node);
213 } else if (options->dscp != remote->dscp) {
214 ovsdb_jsonrpc_server_del_remote(node);
217 SHASH_FOR_EACH (node, new_remotes) {
218 const struct ovsdb_jsonrpc_options *options = node->data;
219 struct ovsdb_jsonrpc_remote *remote;
221 remote = shash_find_data(&svr->remotes, node->name);
223 remote = ovsdb_jsonrpc_server_add_remote(svr, node->name, options);
229 ovsdb_jsonrpc_session_set_all_options(remote, options);
233 static struct ovsdb_jsonrpc_remote *
234 ovsdb_jsonrpc_server_add_remote(struct ovsdb_jsonrpc_server *svr,
236 const struct ovsdb_jsonrpc_options *options)
238 struct ovsdb_jsonrpc_remote *remote;
239 struct pstream *listener;
242 error = jsonrpc_pstream_open(name, &listener, options->dscp);
243 if (error && error != EAFNOSUPPORT) {
244 VLOG_ERR_RL(&rl, "%s: listen failed: %s", name, ovs_strerror(error));
248 remote = xmalloc(sizeof *remote);
249 remote->server = svr;
250 remote->listener = listener;
251 list_init(&remote->sessions);
252 remote->dscp = options->dscp;
253 shash_add(&svr->remotes, name, remote);
256 ovsdb_jsonrpc_session_create(remote, jsonrpc_session_open(name, true));
262 ovsdb_jsonrpc_server_del_remote(struct shash_node *node)
264 struct ovsdb_jsonrpc_remote *remote = node->data;
266 ovsdb_jsonrpc_session_close_all(remote);
267 pstream_close(remote->listener);
268 shash_delete(&remote->server->remotes, node);
272 /* Stores status information for the remote named 'target', which should have
273 * been configured on 'svr' with a call to ovsdb_jsonrpc_server_set_remotes(),
274 * into '*status'. On success returns true, on failure (if 'svr' doesn't have
275 * a remote named 'target' or if that remote is an inbound remote that has no
276 * active connections) returns false. On failure, 'status' will be zeroed.
279 ovsdb_jsonrpc_server_get_remote_status(
280 const struct ovsdb_jsonrpc_server *svr, const char *target,
281 struct ovsdb_jsonrpc_remote_status *status)
283 const struct ovsdb_jsonrpc_remote *remote;
285 memset(status, 0, sizeof *status);
287 remote = shash_find_data(&svr->remotes, target);
288 return remote && ovsdb_jsonrpc_session_get_status(remote, status);
292 ovsdb_jsonrpc_server_free_remote_status(
293 struct ovsdb_jsonrpc_remote_status *status)
295 free(status->locks_held);
296 free(status->locks_waiting);
297 free(status->locks_lost);
300 /* Forces all of the JSON-RPC sessions managed by 'svr' to disconnect and
303 ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *svr)
305 struct shash_node *node;
307 SHASH_FOR_EACH (node, &svr->remotes) {
308 struct ovsdb_jsonrpc_remote *remote = node->data;
310 ovsdb_jsonrpc_session_reconnect_all(remote);
315 ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *svr)
317 struct shash_node *node;
319 SHASH_FOR_EACH (node, &svr->remotes) {
320 struct ovsdb_jsonrpc_remote *remote = node->data;
322 if (remote->listener) {
323 if (svr->n_sessions < svr->max_sessions) {
324 struct stream *stream;
327 error = pstream_accept(remote->listener, &stream);
329 struct jsonrpc_session *js;
330 js = jsonrpc_session_open_unreliably(jsonrpc_open(stream),
332 ovsdb_jsonrpc_session_create(remote, js);
333 } else if (error != EAGAIN) {
334 VLOG_WARN_RL(&rl, "%s: accept failed: %s",
335 pstream_get_name(remote->listener),
336 ovs_strerror(error));
339 VLOG_WARN_RL(&rl, "%s: connection exceeded maximum (%d)",
340 pstream_get_name(remote->listener),
345 ovsdb_jsonrpc_session_run_all(remote);
350 ovsdb_jsonrpc_server_wait(struct ovsdb_jsonrpc_server *svr)
352 struct shash_node *node;
354 SHASH_FOR_EACH (node, &svr->remotes) {
355 struct ovsdb_jsonrpc_remote *remote = node->data;
357 if (remote->listener && svr->n_sessions < svr->max_sessions) {
358 pstream_wait(remote->listener);
361 ovsdb_jsonrpc_session_wait_all(remote);
365 /* Adds some memory usage statistics for 'svr' into 'usage', for use with
366 * memory_report(). */
368 ovsdb_jsonrpc_server_get_memory_usage(const struct ovsdb_jsonrpc_server *svr,
371 struct shash_node *node;
373 simap_increase(usage, "sessions", svr->n_sessions);
374 SHASH_FOR_EACH (node, &svr->remotes) {
375 struct ovsdb_jsonrpc_remote *remote = node->data;
377 ovsdb_jsonrpc_session_get_memory_usage_all(remote, usage);
381 /* JSON-RPC database server session. */
383 struct ovsdb_jsonrpc_session {
384 struct ovs_list node; /* Element in remote's sessions list. */
385 struct ovsdb_session up;
386 struct ovsdb_jsonrpc_remote *remote;
389 struct hmap triggers; /* Hmap of "struct ovsdb_jsonrpc_trigger"s. */
392 struct hmap monitors; /* Hmap of "struct ovsdb_jsonrpc_monitor"s. */
394 /* Network connectivity. */
395 struct jsonrpc_session *js; /* JSON-RPC session. */
396 unsigned int js_seqno; /* Last jsonrpc_session_get_seqno() value. */
399 static void ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *);
400 static int ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *);
401 static void ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *);
402 static void ovsdb_jsonrpc_session_get_memory_usage(
403 const struct ovsdb_jsonrpc_session *, struct simap *usage);
404 static void ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *,
405 struct jsonrpc_msg *);
406 static void ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *,
407 struct jsonrpc_msg *);
409 static struct ovsdb_jsonrpc_session *
410 ovsdb_jsonrpc_session_create(struct ovsdb_jsonrpc_remote *remote,
411 struct jsonrpc_session *js)
413 struct ovsdb_jsonrpc_session *s;
415 s = xzalloc(sizeof *s);
416 ovsdb_session_init(&s->up, &remote->server->up);
418 list_push_back(&remote->sessions, &s->node);
419 hmap_init(&s->triggers);
420 hmap_init(&s->monitors);
422 s->js_seqno = jsonrpc_session_get_seqno(js);
424 remote->server->n_sessions++;
430 ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *s)
432 ovsdb_jsonrpc_monitor_remove_all(s);
433 ovsdb_jsonrpc_session_unlock_all(s);
434 ovsdb_jsonrpc_trigger_complete_all(s);
436 hmap_destroy(&s->monitors);
437 hmap_destroy(&s->triggers);
439 jsonrpc_session_close(s->js);
440 list_remove(&s->node);
441 s->remote->server->n_sessions--;
442 ovsdb_session_destroy(&s->up);
447 ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *s)
449 jsonrpc_session_run(s->js);
450 if (s->js_seqno != jsonrpc_session_get_seqno(s->js)) {
451 s->js_seqno = jsonrpc_session_get_seqno(s->js);
452 ovsdb_jsonrpc_trigger_complete_all(s);
453 ovsdb_jsonrpc_monitor_remove_all(s);
454 ovsdb_jsonrpc_session_unlock_all(s);
457 ovsdb_jsonrpc_trigger_complete_done(s);
459 if (!jsonrpc_session_get_backlog(s->js)) {
460 struct jsonrpc_msg *msg;
462 ovsdb_jsonrpc_monitor_flush_all(s);
464 msg = jsonrpc_session_recv(s->js);
466 if (msg->type == JSONRPC_REQUEST) {
467 ovsdb_jsonrpc_session_got_request(s, msg);
468 } else if (msg->type == JSONRPC_NOTIFY) {
469 ovsdb_jsonrpc_session_got_notify(s, msg);
471 VLOG_WARN("%s: received unexpected %s message",
472 jsonrpc_session_get_name(s->js),
473 jsonrpc_msg_type_to_string(msg->type));
474 jsonrpc_session_force_reconnect(s->js);
475 jsonrpc_msg_destroy(msg);
479 return jsonrpc_session_is_alive(s->js) ? 0 : ETIMEDOUT;
483 ovsdb_jsonrpc_session_set_options(struct ovsdb_jsonrpc_session *session,
484 const struct ovsdb_jsonrpc_options *options)
486 jsonrpc_session_set_max_backoff(session->js, options->max_backoff);
487 jsonrpc_session_set_probe_interval(session->js, options->probe_interval);
488 jsonrpc_session_set_dscp(session->js, options->dscp);
492 ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *remote)
494 struct ovsdb_jsonrpc_session *s, *next;
496 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
497 int error = ovsdb_jsonrpc_session_run(s);
499 ovsdb_jsonrpc_session_close(s);
505 ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *s)
507 jsonrpc_session_wait(s->js);
508 if (!jsonrpc_session_get_backlog(s->js)) {
509 if (ovsdb_jsonrpc_monitor_needs_flush(s)) {
510 poll_immediate_wake();
512 jsonrpc_session_recv_wait(s->js);
518 ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *remote)
520 struct ovsdb_jsonrpc_session *s;
522 LIST_FOR_EACH (s, node, &remote->sessions) {
523 ovsdb_jsonrpc_session_wait(s);
528 ovsdb_jsonrpc_session_get_memory_usage(const struct ovsdb_jsonrpc_session *s,
531 simap_increase(usage, "triggers", hmap_count(&s->triggers));
532 simap_increase(usage, "monitors", hmap_count(&s->monitors));
533 simap_increase(usage, "backlog", jsonrpc_session_get_backlog(s->js));
537 ovsdb_jsonrpc_session_get_memory_usage_all(
538 const struct ovsdb_jsonrpc_remote *remote,
541 struct ovsdb_jsonrpc_session *s;
543 LIST_FOR_EACH (s, node, &remote->sessions) {
544 ovsdb_jsonrpc_session_get_memory_usage(s, usage);
549 ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *remote)
551 struct ovsdb_jsonrpc_session *s, *next;
553 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
554 ovsdb_jsonrpc_session_close(s);
558 /* Forces all of the JSON-RPC sessions managed by 'remote' to disconnect and
561 ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *remote)
563 struct ovsdb_jsonrpc_session *s, *next;
565 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
566 jsonrpc_session_force_reconnect(s->js);
567 if (!jsonrpc_session_is_alive(s->js)) {
568 ovsdb_jsonrpc_session_close(s);
573 /* Sets the options for all of the JSON-RPC sessions managed by 'remote' to
576 * (The dscp value can't be changed directly; the caller must instead close and
577 * re-open the session.) */
579 ovsdb_jsonrpc_session_set_all_options(
580 struct ovsdb_jsonrpc_remote *remote,
581 const struct ovsdb_jsonrpc_options *options)
583 struct ovsdb_jsonrpc_session *s;
585 LIST_FOR_EACH (s, node, &remote->sessions) {
586 ovsdb_jsonrpc_session_set_options(s, options);
591 ovsdb_jsonrpc_session_get_status(const struct ovsdb_jsonrpc_remote *remote,
592 struct ovsdb_jsonrpc_remote_status *status)
594 const struct ovsdb_jsonrpc_session *s;
595 const struct jsonrpc_session *js;
596 struct ovsdb_lock_waiter *waiter;
597 struct reconnect_stats rstats;
598 struct ds locks_held, locks_waiting, locks_lost;
600 status->bound_port = (remote->listener
601 ? pstream_get_bound_port(remote->listener)
604 if (list_is_empty(&remote->sessions)) {
607 s = CONTAINER_OF(remote->sessions.next, struct ovsdb_jsonrpc_session, node);
610 status->is_connected = jsonrpc_session_is_connected(js);
611 status->last_error = jsonrpc_session_get_status(js);
613 jsonrpc_session_get_reconnect_stats(js, &rstats);
614 status->state = rstats.state;
615 status->sec_since_connect = rstats.msec_since_connect == UINT_MAX
616 ? UINT_MAX : rstats.msec_since_connect / 1000;
617 status->sec_since_disconnect = rstats.msec_since_disconnect == UINT_MAX
618 ? UINT_MAX : rstats.msec_since_disconnect / 1000;
620 ds_init(&locks_held);
621 ds_init(&locks_waiting);
622 ds_init(&locks_lost);
623 HMAP_FOR_EACH (waiter, session_node, &s->up.waiters) {
626 string = (ovsdb_lock_waiter_is_owner(waiter) ? &locks_held
627 : waiter->mode == OVSDB_LOCK_WAIT ? &locks_waiting
629 if (string->length) {
630 ds_put_char(string, ' ');
632 ds_put_cstr(string, waiter->lock_name);
634 status->locks_held = ds_steal_cstr(&locks_held);
635 status->locks_waiting = ds_steal_cstr(&locks_waiting);
636 status->locks_lost = ds_steal_cstr(&locks_lost);
638 status->n_connections = list_size(&remote->sessions);
643 /* Examines 'request' to determine the database to which it relates, and then
644 * searches 's' to find that database:
646 * - If successful, returns the database and sets '*replyp' to NULL.
648 * - If no such database exists, returns NULL and sets '*replyp' to an
649 * appropriate JSON-RPC error reply, owned by the caller. */
650 static struct ovsdb *
651 ovsdb_jsonrpc_lookup_db(const struct ovsdb_jsonrpc_session *s,
652 const struct jsonrpc_msg *request,
653 struct jsonrpc_msg **replyp)
655 struct json_array *params;
656 struct ovsdb_error *error;
660 params = json_array(request->params);
661 if (!params->n || params->elems[0]->type != JSON_STRING) {
662 error = ovsdb_syntax_error(
663 request->params, NULL,
664 "%s request params must begin with <db-name>", request->method);
668 db_name = params->elems[0]->u.string;
669 db = shash_find_data(&s->up.server->dbs, db_name);
671 error = ovsdb_syntax_error(
672 request->params, "unknown database",
673 "%s request specifies unknown database %s",
674 request->method, db_name);
682 *replyp = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
683 ovsdb_error_destroy(error);
687 static struct ovsdb_error *
688 ovsdb_jsonrpc_session_parse_lock_name(const struct jsonrpc_msg *request,
689 const char **lock_namep)
691 const struct json_array *params;
693 params = json_array(request->params);
694 if (params->n != 1 || params->elems[0]->type != JSON_STRING ||
695 !ovsdb_parser_is_id(json_string(params->elems[0]))) {
697 return ovsdb_syntax_error(request->params, NULL,
698 "%s request params must be <id>",
702 *lock_namep = json_string(params->elems[0]);
707 ovsdb_jsonrpc_session_notify(struct ovsdb_session *session,
708 const char *lock_name,
711 struct ovsdb_jsonrpc_session *s;
714 s = CONTAINER_OF(session, struct ovsdb_jsonrpc_session, up);
715 params = json_array_create_1(json_string_create(lock_name));
716 ovsdb_jsonrpc_session_send(s, jsonrpc_create_notify(method, params));
719 static struct jsonrpc_msg *
720 ovsdb_jsonrpc_session_lock(struct ovsdb_jsonrpc_session *s,
721 struct jsonrpc_msg *request,
722 enum ovsdb_lock_mode mode)
724 struct ovsdb_lock_waiter *waiter;
725 struct jsonrpc_msg *reply;
726 struct ovsdb_error *error;
727 struct ovsdb_session *victim;
728 const char *lock_name;
731 error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
736 /* Report error if this session has issued a "lock" or "steal" without a
737 * matching "unlock" for this lock. */
738 waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
740 error = ovsdb_syntax_error(
741 request->params, NULL,
742 "must issue \"unlock\" before new \"%s\"", request->method);
746 /* Get the lock, add us as a waiter. */
747 waiter = ovsdb_server_lock(&s->remote->server->up, &s->up, lock_name, mode,
750 ovsdb_jsonrpc_session_notify(victim, lock_name, "stolen");
753 result = json_object_create();
754 json_object_put(result, "locked",
755 json_boolean_create(ovsdb_lock_waiter_is_owner(waiter)));
757 return jsonrpc_create_reply(result, request->id);
760 reply = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
761 ovsdb_error_destroy(error);
766 ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *s)
768 struct ovsdb_lock_waiter *waiter, *next;
770 HMAP_FOR_EACH_SAFE (waiter, next, session_node, &s->up.waiters) {
771 ovsdb_jsonrpc_session_unlock__(waiter);
776 ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *waiter)
778 struct ovsdb_lock *lock = waiter->lock;
781 struct ovsdb_session *new_owner = ovsdb_lock_waiter_remove(waiter);
783 ovsdb_jsonrpc_session_notify(new_owner, lock->name, "locked");
785 /* ovsdb_server_lock() might have freed 'lock'. */
789 ovsdb_lock_waiter_destroy(waiter);
792 static struct jsonrpc_msg *
793 ovsdb_jsonrpc_session_unlock(struct ovsdb_jsonrpc_session *s,
794 struct jsonrpc_msg *request)
796 struct ovsdb_lock_waiter *waiter;
797 struct jsonrpc_msg *reply;
798 struct ovsdb_error *error;
799 const char *lock_name;
801 error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
806 /* Report error if this session has not issued a "lock" or "steal" for this
808 waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
810 error = ovsdb_syntax_error(
811 request->params, NULL, "\"unlock\" without \"lock\" or \"steal\"");
815 ovsdb_jsonrpc_session_unlock__(waiter);
817 return jsonrpc_create_reply(json_object_create(), request->id);
820 reply = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
821 ovsdb_error_destroy(error);
825 static struct jsonrpc_msg *
826 execute_transaction(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
827 struct jsonrpc_msg *request)
829 ovsdb_jsonrpc_trigger_create(s, db, request->id, request->params);
831 request->params = NULL;
832 jsonrpc_msg_destroy(request);
837 ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *s,
838 struct jsonrpc_msg *request)
840 struct jsonrpc_msg *reply;
842 if (!strcmp(request->method, "transact")) {
843 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
845 reply = execute_transaction(s, db, request);
847 } else if (!strcmp(request->method, "monitor") ||
848 !strcmp(request->method, "monitor2")) {
849 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
851 int l = strlen(request->method) - strlen("monitor");
852 enum ovsdb_monitor_version version = l ? OVSDB_MONITOR_V2
854 reply = ovsdb_jsonrpc_monitor_create(s, db, request->params,
855 version, request->id);
857 } else if (!strcmp(request->method, "monitor_cancel")) {
858 reply = ovsdb_jsonrpc_monitor_cancel(s, json_array(request->params),
860 } else if (!strcmp(request->method, "get_schema")) {
861 struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
863 reply = jsonrpc_create_reply(ovsdb_schema_to_json(db->schema),
866 } else if (!strcmp(request->method, "list_dbs")) {
867 size_t n_dbs = shash_count(&s->up.server->dbs);
868 struct shash_node *node;
872 dbs = xmalloc(n_dbs * sizeof *dbs);
874 SHASH_FOR_EACH (node, &s->up.server->dbs) {
875 dbs[i++] = json_string_create(node->name);
877 reply = jsonrpc_create_reply(json_array_create(dbs, n_dbs),
879 } else if (!strcmp(request->method, "lock")) {
880 reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_WAIT);
881 } else if (!strcmp(request->method, "steal")) {
882 reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_STEAL);
883 } else if (!strcmp(request->method, "unlock")) {
884 reply = ovsdb_jsonrpc_session_unlock(s, request);
885 } else if (!strcmp(request->method, "echo")) {
886 reply = jsonrpc_create_reply(json_clone(request->params), request->id);
888 reply = jsonrpc_create_error(json_string_create("unknown method"),
893 jsonrpc_msg_destroy(request);
894 ovsdb_jsonrpc_session_send(s, reply);
899 execute_cancel(struct ovsdb_jsonrpc_session *s, struct jsonrpc_msg *request)
901 if (json_array(request->params)->n == 1) {
902 struct ovsdb_jsonrpc_trigger *t;
905 id = request->params->u.array.elems[0];
906 t = ovsdb_jsonrpc_trigger_find(s, id, json_hash(id, 0));
908 ovsdb_jsonrpc_trigger_complete(t);
914 ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *s,
915 struct jsonrpc_msg *request)
917 if (!strcmp(request->method, "cancel")) {
918 execute_cancel(s, request);
920 jsonrpc_msg_destroy(request);
924 ovsdb_jsonrpc_session_send(struct ovsdb_jsonrpc_session *s,
925 struct jsonrpc_msg *msg)
927 ovsdb_jsonrpc_monitor_flush_all(s);
928 jsonrpc_session_send(s->js, msg);
931 /* JSON-RPC database server triggers.
933 * (Every transaction is treated as a trigger even if it doesn't actually have
934 * any "wait" operations.) */
936 struct ovsdb_jsonrpc_trigger {
937 struct ovsdb_trigger trigger;
938 struct hmap_node hmap_node; /* In session's "triggers" hmap. */
943 ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
944 struct json *id, struct json *params)
946 struct ovsdb_jsonrpc_trigger *t;
949 /* Check for duplicate ID. */
950 hash = json_hash(id, 0);
951 t = ovsdb_jsonrpc_trigger_find(s, id, hash);
953 struct jsonrpc_msg *msg;
955 msg = jsonrpc_create_error(json_string_create("duplicate request ID"),
957 ovsdb_jsonrpc_session_send(s, msg);
959 json_destroy(params);
963 /* Insert into trigger table. */
964 t = xmalloc(sizeof *t);
965 ovsdb_trigger_init(&s->up, db, &t->trigger, params, time_msec());
967 hmap_insert(&s->triggers, &t->hmap_node, hash);
969 /* Complete early if possible. */
970 if (ovsdb_trigger_is_complete(&t->trigger)) {
971 ovsdb_jsonrpc_trigger_complete(t);
975 static struct ovsdb_jsonrpc_trigger *
976 ovsdb_jsonrpc_trigger_find(struct ovsdb_jsonrpc_session *s,
977 const struct json *id, size_t hash)
979 struct ovsdb_jsonrpc_trigger *t;
981 HMAP_FOR_EACH_WITH_HASH (t, hmap_node, hash, &s->triggers) {
982 if (json_equal(t->id, id)) {
991 ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *t)
993 struct ovsdb_jsonrpc_session *s;
995 s = CONTAINER_OF(t->trigger.session, struct ovsdb_jsonrpc_session, up);
997 if (jsonrpc_session_is_connected(s->js)) {
998 struct jsonrpc_msg *reply;
1001 result = ovsdb_trigger_steal_result(&t->trigger);
1003 reply = jsonrpc_create_reply(result, t->id);
1005 reply = jsonrpc_create_error(json_string_create("canceled"),
1008 ovsdb_jsonrpc_session_send(s, reply);
1011 json_destroy(t->id);
1012 ovsdb_trigger_destroy(&t->trigger);
1013 hmap_remove(&s->triggers, &t->hmap_node);
1018 ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *s)
1020 struct ovsdb_jsonrpc_trigger *t, *next;
1021 HMAP_FOR_EACH_SAFE (t, next, hmap_node, &s->triggers) {
1022 ovsdb_jsonrpc_trigger_complete(t);
1027 ovsdb_jsonrpc_trigger_complete_done(struct ovsdb_jsonrpc_session *s)
1029 while (!list_is_empty(&s->up.completions)) {
1030 struct ovsdb_jsonrpc_trigger *t
1031 = CONTAINER_OF(s->up.completions.next,
1032 struct ovsdb_jsonrpc_trigger, trigger.node);
1033 ovsdb_jsonrpc_trigger_complete(t);
1037 /* Jsonrpc front end monitor. */
1038 struct ovsdb_jsonrpc_monitor {
1039 struct ovsdb_jsonrpc_session *session;
1041 struct hmap_node node; /* In ovsdb_jsonrpc_session's "monitors". */
1042 struct json *monitor_id;
1043 struct ovsdb_monitor *dbmon;
1044 uint64_t unflushed; /* The first transaction that has not been
1045 flushed to the jsonrpc remote client. */
1046 enum ovsdb_monitor_version version;
1049 static struct ovsdb_jsonrpc_monitor *
1050 ovsdb_jsonrpc_monitor_find(struct ovsdb_jsonrpc_session *s,
1051 const struct json *monitor_id)
1053 struct ovsdb_jsonrpc_monitor *m;
1055 HMAP_FOR_EACH_WITH_HASH (m, node, json_hash(monitor_id, 0), &s->monitors) {
1056 if (json_equal(m->monitor_id, monitor_id)) {
1065 parse_bool(struct ovsdb_parser *parser, const char *name, bool default_value)
1067 const struct json *json;
1069 json = ovsdb_parser_member(parser, name, OP_BOOLEAN | OP_OPTIONAL);
1070 return json ? json_boolean(json) : default_value;
1073 static struct ovsdb_error * OVS_WARN_UNUSED_RESULT
1074 ovsdb_jsonrpc_parse_monitor_request(struct ovsdb_monitor *dbmon,
1075 const struct ovsdb_table *table,
1076 const struct json *monitor_request,
1077 size_t *allocated_columns)
1079 const struct ovsdb_table_schema *ts = table->schema;
1080 enum ovsdb_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;
1117 ovsdb_monitor_table_add_select(dbmon, table, 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(&table->schema->columns, s);
1138 return ovsdb_syntax_error(columns, NULL, "%s is not a valid "
1141 ovsdb_monitor_add_column(dbmon, table, 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_monitor_add_column(dbmon, table, column, select,
1159 static struct jsonrpc_msg *
1160 ovsdb_jsonrpc_monitor_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
1161 struct json *params,
1162 enum ovsdb_monitor_version version,
1163 const struct json *request_id)
1165 struct ovsdb_jsonrpc_monitor *m = NULL;
1166 struct ovsdb_monitor *dbmon = NULL;
1167 struct json *monitor_id, *monitor_requests;
1168 struct ovsdb_error *error = NULL;
1169 struct shash_node *node;
1172 if (json_array(params)->n != 3) {
1173 error = ovsdb_syntax_error(params, NULL, "invalid parameters");
1176 monitor_id = params->u.array.elems[1];
1177 monitor_requests = params->u.array.elems[2];
1178 if (monitor_requests->type != JSON_OBJECT) {
1179 error = ovsdb_syntax_error(monitor_requests, NULL,
1180 "monitor-requests must be object");
1184 if (ovsdb_jsonrpc_monitor_find(s, monitor_id)) {
1185 error = ovsdb_syntax_error(monitor_id, NULL, "duplicate monitor ID");
1189 m = xzalloc(sizeof *m);
1192 m->dbmon = ovsdb_monitor_create(db, m);
1194 m->version = version;
1195 hmap_insert(&s->monitors, &m->node, json_hash(monitor_id, 0));
1196 m->monitor_id = json_clone(monitor_id);
1198 SHASH_FOR_EACH (node, json_object(monitor_requests)) {
1199 const struct ovsdb_table *table;
1200 const char *column_name;
1201 size_t allocated_columns;
1202 const struct json *mr_value;
1205 table = ovsdb_get_table(m->db, node->name);
1207 error = ovsdb_syntax_error(NULL, NULL,
1208 "no table named %s", node->name);
1212 ovsdb_monitor_add_table(m->dbmon, table);
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 m->dbmon, table, array->elems[i], &allocated_columns);
1228 error = ovsdb_jsonrpc_parse_monitor_request(
1229 m->dbmon, table, mr_value, &allocated_columns);
1235 column_name = ovsdb_monitor_table_check_duplicates(m->dbmon, table);
1238 error = ovsdb_syntax_error(mr_value, NULL, "column %s "
1239 "mentioned more than once",
1245 dbmon = ovsdb_monitor_add(m->dbmon);
1246 if (dbmon != m->dbmon) {
1247 /* Found an exisiting dbmon, reuse the current one. */
1248 ovsdb_monitor_remove_jsonrpc_monitor(m->dbmon, m);
1249 ovsdb_monitor_add_jsonrpc_monitor(dbmon, m);
1253 ovsdb_monitor_get_initial(m->dbmon);
1254 json = ovsdb_jsonrpc_monitor_compose_update(m, true);
1255 json = json ? json : json_object_create();
1256 return jsonrpc_create_reply(json, request_id);
1260 ovsdb_jsonrpc_monitor_destroy(m);
1263 json = ovsdb_error_to_json(error);
1264 ovsdb_error_destroy(error);
1265 return jsonrpc_create_error(json, request_id);
1268 static struct jsonrpc_msg *
1269 ovsdb_jsonrpc_monitor_cancel(struct ovsdb_jsonrpc_session *s,
1270 struct json_array *params,
1271 const struct json *request_id)
1273 if (params->n != 1) {
1274 return jsonrpc_create_error(json_string_create("invalid parameters"),
1277 struct ovsdb_jsonrpc_monitor *m;
1279 m = ovsdb_jsonrpc_monitor_find(s, params->elems[0]);
1281 return jsonrpc_create_error(json_string_create("unknown monitor"),
1284 ovsdb_jsonrpc_monitor_destroy(m);
1285 return jsonrpc_create_reply(json_object_create(), request_id);
1291 ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *s)
1293 struct ovsdb_jsonrpc_monitor *m, *next;
1295 HMAP_FOR_EACH_SAFE (m, next, node, &s->monitors) {
1296 ovsdb_jsonrpc_monitor_destroy(m);
1300 static struct json *
1301 ovsdb_jsonrpc_monitor_compose_update(struct ovsdb_jsonrpc_monitor *m,
1304 return ovsdb_monitor_get_update(m->dbmon, initial, &m->unflushed,
1309 ovsdb_jsonrpc_monitor_needs_flush(struct ovsdb_jsonrpc_session *s)
1311 struct ovsdb_jsonrpc_monitor *m;
1313 HMAP_FOR_EACH (m, node, &s->monitors) {
1314 if (ovsdb_monitor_needs_flush(m->dbmon, m->unflushed)) {
1323 ovsdb_jsonrpc_monitor_destroy(struct ovsdb_jsonrpc_monitor *m)
1325 json_destroy(m->monitor_id);
1326 hmap_remove(&m->session->monitors, &m->node);
1327 ovsdb_monitor_remove_jsonrpc_monitor(m->dbmon, m);
1331 static struct jsonrpc_msg *
1332 ovsdb_jsonrpc_create_notify(const struct ovsdb_jsonrpc_monitor *m,
1333 struct json *params)
1337 switch(m->version) {
1338 case OVSDB_MONITOR_V1:
1341 case OVSDB_MONITOR_V2:
1344 case OVSDB_MONITOR_VERSION_MAX:
1349 return jsonrpc_create_notify(method, params);
1353 ovsdb_jsonrpc_monitor_flush_all(struct ovsdb_jsonrpc_session *s)
1355 struct ovsdb_jsonrpc_monitor *m;
1357 HMAP_FOR_EACH (m, node, &s->monitors) {
1360 json = ovsdb_jsonrpc_monitor_compose_update(m, false);
1362 struct jsonrpc_msg *msg;
1363 struct json *params;
1365 params = json_array_create_2(json_clone(m->monitor_id), json);
1366 msg = ovsdb_jsonrpc_create_notify(m, params);
1367 jsonrpc_session_send(s->js, msg);