1 /* Copyright (c) 2009, 2010, 2011 Nicira Networks
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"
27 #include "ovsdb-error.h"
28 #include "ovsdb-parser.h"
30 #include "reconnect.h"
35 #include "transaction.h"
39 VLOG_DEFINE_THIS_MODULE(ovsdb_jsonrpc_server);
41 struct ovsdb_jsonrpc_remote;
42 struct ovsdb_jsonrpc_session;
44 /* Message rate-limiting. */
45 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
48 static struct ovsdb_jsonrpc_session *ovsdb_jsonrpc_session_create(
49 struct ovsdb_jsonrpc_remote *, struct jsonrpc_session *);
50 static void ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *);
51 static void ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *);
52 static void ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *);
53 static void ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *);
54 static void ovsdb_jsonrpc_session_set_all_options(
55 struct ovsdb_jsonrpc_remote *, const struct ovsdb_jsonrpc_options *);
56 static void ovsdb_jsonrpc_session_get_status(
57 const struct ovsdb_jsonrpc_remote *,
61 static void ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *,
62 struct json *id, struct json *params);
63 static struct ovsdb_jsonrpc_trigger *ovsdb_jsonrpc_trigger_find(
64 struct ovsdb_jsonrpc_session *, const struct json *id, size_t hash);
65 static void ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *);
66 static void ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *);
67 static void ovsdb_jsonrpc_trigger_complete_done(
68 struct ovsdb_jsonrpc_session *);
71 static struct json *ovsdb_jsonrpc_monitor_create(
72 struct ovsdb_jsonrpc_session *, struct json *params);
73 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_cancel(
74 struct ovsdb_jsonrpc_session *,
75 struct json_array *params,
76 const struct json *request_id);
77 static void ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *);
79 /* JSON-RPC database server. */
81 struct ovsdb_jsonrpc_server {
83 unsigned int n_sessions, max_sessions;
84 struct shash remotes; /* Contains "struct ovsdb_jsonrpc_remote *"s. */
87 /* A configured remote. This is either a passive stream listener plus a list
88 * of the currently connected sessions, or a list of exactly one active
90 struct ovsdb_jsonrpc_remote {
91 struct ovsdb_jsonrpc_server *server;
92 struct pstream *listener; /* Listener, if passive. */
93 struct list sessions; /* List of "struct ovsdb_jsonrpc_session"s. */
96 static struct ovsdb_jsonrpc_remote *ovsdb_jsonrpc_server_add_remote(
97 struct ovsdb_jsonrpc_server *, const char *name);
98 static void ovsdb_jsonrpc_server_del_remote(struct shash_node *);
100 struct ovsdb_jsonrpc_server *
101 ovsdb_jsonrpc_server_create(struct ovsdb *db)
103 struct ovsdb_jsonrpc_server *server = xzalloc(sizeof *server);
105 server->max_sessions = 64;
106 shash_init(&server->remotes);
111 ovsdb_jsonrpc_server_destroy(struct ovsdb_jsonrpc_server *svr)
113 struct shash_node *node, *next;
115 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
116 ovsdb_jsonrpc_server_del_remote(node);
118 shash_destroy(&svr->remotes);
122 struct ovsdb_jsonrpc_options *
123 ovsdb_jsonrpc_default_options(void)
125 struct ovsdb_jsonrpc_options *options = xzalloc(sizeof *options);
126 options->probe_interval = RECONNECT_DEFAULT_PROBE_INTERVAL;
127 options->max_backoff = RECONNECT_DEFAULT_MAX_BACKOFF;
131 /* Sets 'svr''s current set of remotes to the names in 'new_remotes', with
132 * options in the struct ovsdb_jsonrpc_options supplied as the data values.
134 * A remote is an active or passive stream connection method, e.g. "pssl:" or
137 ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *svr,
138 const struct shash *new_remotes)
140 struct shash_node *node, *next;
142 SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
143 if (!shash_find(new_remotes, node->name)) {
144 ovsdb_jsonrpc_server_del_remote(node);
147 SHASH_FOR_EACH (node, new_remotes) {
148 const struct ovsdb_jsonrpc_options *options = node->data;
149 struct ovsdb_jsonrpc_remote *remote;
151 remote = shash_find_data(&svr->remotes, node->name);
153 remote = ovsdb_jsonrpc_server_add_remote(svr, node->name);
159 ovsdb_jsonrpc_session_set_all_options(remote, options);
163 static struct ovsdb_jsonrpc_remote *
164 ovsdb_jsonrpc_server_add_remote(struct ovsdb_jsonrpc_server *svr,
167 struct ovsdb_jsonrpc_remote *remote;
168 struct pstream *listener;
171 error = jsonrpc_pstream_open(name, &listener);
172 if (error && error != EAFNOSUPPORT) {
173 VLOG_ERR_RL(&rl, "%s: listen failed: %s", name, strerror(error));
177 remote = xmalloc(sizeof *remote);
178 remote->server = svr;
179 remote->listener = listener;
180 list_init(&remote->sessions);
181 shash_add(&svr->remotes, name, remote);
184 ovsdb_jsonrpc_session_create(remote, jsonrpc_session_open(name));
190 ovsdb_jsonrpc_server_del_remote(struct shash_node *node)
192 struct ovsdb_jsonrpc_remote *remote = node->data;
194 ovsdb_jsonrpc_session_close_all(remote);
195 pstream_close(remote->listener);
196 shash_delete(&remote->server->remotes, node);
201 ovsdb_jsonrpc_server_get_remote_status(const struct ovsdb_jsonrpc_server *svr,
202 struct shash *statuses)
204 struct shash_node *node;
206 shash_init(statuses);
208 SHASH_FOR_EACH (node, &svr->remotes) {
209 const struct ovsdb_jsonrpc_remote *remote = node->data;
211 ovsdb_jsonrpc_session_get_status(remote, statuses);
215 /* Forces all of the JSON-RPC sessions managed by 'svr' to disconnect and
218 ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *svr)
220 struct shash_node *node;
222 SHASH_FOR_EACH (node, &svr->remotes) {
223 struct ovsdb_jsonrpc_remote *remote = node->data;
225 ovsdb_jsonrpc_session_reconnect_all(remote);
230 ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *svr)
232 struct shash_node *node;
234 SHASH_FOR_EACH (node, &svr->remotes) {
235 struct ovsdb_jsonrpc_remote *remote = node->data;
237 if (remote->listener && svr->n_sessions < svr->max_sessions) {
238 struct stream *stream;
241 error = pstream_accept(remote->listener, &stream);
243 struct jsonrpc_session *js;
244 js = jsonrpc_session_open_unreliably(jsonrpc_open(stream));
245 ovsdb_jsonrpc_session_create(remote, js);
246 } else if (error != EAGAIN) {
247 VLOG_WARN_RL(&rl, "%s: accept failed: %s",
248 pstream_get_name(remote->listener),
253 ovsdb_jsonrpc_session_run_all(remote);
258 ovsdb_jsonrpc_server_wait(struct ovsdb_jsonrpc_server *svr)
260 struct shash_node *node;
262 SHASH_FOR_EACH (node, &svr->remotes) {
263 struct ovsdb_jsonrpc_remote *remote = node->data;
265 if (remote->listener && svr->n_sessions < svr->max_sessions) {
266 pstream_wait(remote->listener);
269 ovsdb_jsonrpc_session_wait_all(remote);
273 /* JSON-RPC database server session. */
275 struct ovsdb_jsonrpc_session {
276 struct ovsdb_jsonrpc_remote *remote;
277 struct list node; /* Element in remote's sessions list. */
280 struct hmap triggers; /* Hmap of "struct ovsdb_jsonrpc_trigger"s. */
281 struct list completions; /* Completed triggers. */
284 struct hmap monitors; /* Hmap of "struct ovsdb_jsonrpc_monitor"s. */
286 /* Network connectivity. */
287 struct jsonrpc_session *js; /* JSON-RPC session. */
288 unsigned int js_seqno; /* Last jsonrpc_session_get_seqno() value. */
291 static void ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *);
292 static int ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *);
293 static void ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *);
294 static void ovsdb_jsonrpc_session_set_options(
295 struct ovsdb_jsonrpc_session *, const struct ovsdb_jsonrpc_options *);
296 static void ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *,
297 struct jsonrpc_msg *);
298 static void ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *,
299 struct jsonrpc_msg *);
301 static struct ovsdb_jsonrpc_session *
302 ovsdb_jsonrpc_session_create(struct ovsdb_jsonrpc_remote *remote,
303 struct jsonrpc_session *js)
305 struct ovsdb_jsonrpc_session *s;
307 s = xzalloc(sizeof *s);
309 list_push_back(&remote->sessions, &s->node);
310 hmap_init(&s->triggers);
311 hmap_init(&s->monitors);
312 list_init(&s->completions);
314 s->js_seqno = jsonrpc_session_get_seqno(js);
316 remote->server->n_sessions++;
322 ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *s)
324 ovsdb_jsonrpc_monitor_remove_all(s);
325 jsonrpc_session_close(s->js);
326 list_remove(&s->node);
327 s->remote->server->n_sessions--;
332 ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *s)
334 jsonrpc_session_run(s->js);
335 if (s->js_seqno != jsonrpc_session_get_seqno(s->js)) {
336 s->js_seqno = jsonrpc_session_get_seqno(s->js);
337 ovsdb_jsonrpc_trigger_complete_all(s);
338 ovsdb_jsonrpc_monitor_remove_all(s);
341 ovsdb_jsonrpc_trigger_complete_done(s);
343 if (!jsonrpc_session_get_backlog(s->js)) {
344 struct jsonrpc_msg *msg = jsonrpc_session_recv(s->js);
346 if (msg->type == JSONRPC_REQUEST) {
347 ovsdb_jsonrpc_session_got_request(s, msg);
348 } else if (msg->type == JSONRPC_NOTIFY) {
349 ovsdb_jsonrpc_session_got_notify(s, msg);
351 VLOG_WARN("%s: received unexpected %s message",
352 jsonrpc_session_get_name(s->js),
353 jsonrpc_msg_type_to_string(msg->type));
354 jsonrpc_session_force_reconnect(s->js);
355 jsonrpc_msg_destroy(msg);
359 return jsonrpc_session_is_alive(s->js) ? 0 : ETIMEDOUT;
363 ovsdb_jsonrpc_session_set_options(struct ovsdb_jsonrpc_session *session,
364 const struct ovsdb_jsonrpc_options *options)
366 jsonrpc_session_set_max_backoff(session->js, options->max_backoff);
367 jsonrpc_session_set_probe_interval(session->js, options->probe_interval);
371 ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *remote)
373 struct ovsdb_jsonrpc_session *s, *next;
375 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
376 int error = ovsdb_jsonrpc_session_run(s);
378 ovsdb_jsonrpc_session_close(s);
384 ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *s)
386 jsonrpc_session_wait(s->js);
387 if (!jsonrpc_session_get_backlog(s->js)) {
388 jsonrpc_session_recv_wait(s->js);
393 ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *remote)
395 struct ovsdb_jsonrpc_session *s;
397 LIST_FOR_EACH (s, node, &remote->sessions) {
398 ovsdb_jsonrpc_session_wait(s);
403 ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *remote)
405 struct ovsdb_jsonrpc_session *s, *next;
407 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
408 ovsdb_jsonrpc_session_close(s);
412 /* Forces all of the JSON-RPC sessions managed by 'remote' to disconnect and
415 ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *remote)
417 struct ovsdb_jsonrpc_session *s, *next;
419 LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
420 jsonrpc_session_force_reconnect(s->js);
421 if (!jsonrpc_session_is_alive(s->js)) {
422 ovsdb_jsonrpc_session_close(s);
427 /* Sets the options for all of the JSON-RPC sessions managed by 'remote' to
430 ovsdb_jsonrpc_session_set_all_options(
431 struct ovsdb_jsonrpc_remote *remote,
432 const struct ovsdb_jsonrpc_options *options)
434 struct ovsdb_jsonrpc_session *s;
436 LIST_FOR_EACH (s, node, &remote->sessions) {
437 ovsdb_jsonrpc_session_set_options(s, options);
442 ovsdb_jsonrpc_session_get_status(const struct ovsdb_jsonrpc_remote *remote,
445 const struct ovsdb_jsonrpc_session *s;
446 const struct jsonrpc_session *js;
448 struct ovsdb_jsonrpc_remote_status *status;
449 struct reconnect_stats rstats;
451 /* We only look at the first session in the list. There should be only one
452 * node in the list for outbound connections. We don't track status for
453 * each individual inbound connection if someone configures the DB that
454 * way. Since outbound connections are the norm, this is fine. */
455 if (list_is_empty(&remote->sessions)) {
458 s = CONTAINER_OF(remote->sessions.next, struct ovsdb_jsonrpc_session, node);
463 name = jsonrpc_session_get_name(js);
465 status = xzalloc(sizeof *status);
466 shash_add(shash, name, status);
468 status->is_connected = jsonrpc_session_is_connected(js);
469 status->last_error = jsonrpc_session_get_status(js);
471 jsonrpc_session_get_reconnect_stats(js, &rstats);
472 status->state = rstats.state;
473 status->sec_since_connect = rstats.msec_since_connect == UINT_MAX
474 ? UINT_MAX : rstats.msec_since_connect / 1000;
475 status->sec_since_disconnect = rstats.msec_since_disconnect == UINT_MAX
476 ? UINT_MAX : rstats.msec_since_disconnect / 1000;
480 get_db_name(const struct ovsdb_jsonrpc_session *s)
482 return s->remote->server->db->schema->name;
485 static struct jsonrpc_msg *
486 ovsdb_jsonrpc_check_db_name(const struct ovsdb_jsonrpc_session *s,
487 const struct jsonrpc_msg *request)
489 struct json_array *params;
490 const char *want_db_name;
491 const char *have_db_name;
492 struct ovsdb_error *error;
493 struct jsonrpc_msg *reply;
495 params = json_array(request->params);
496 if (!params->n || params->elems[0]->type != JSON_STRING) {
497 error = ovsdb_syntax_error(
498 request->params, NULL,
499 "%s request params must begin with <db-name>", request->method);
503 want_db_name = params->elems[0]->u.string;
504 have_db_name = get_db_name(s);
505 if (strcmp(want_db_name, have_db_name)) {
506 error = ovsdb_syntax_error(
507 request->params, "unknown database",
508 "%s request specifies unknown database %s",
509 request->method, want_db_name);
516 reply = jsonrpc_create_reply(ovsdb_error_to_json(error), request->id);
517 ovsdb_error_destroy(error);
521 static struct jsonrpc_msg *
522 execute_transaction(struct ovsdb_jsonrpc_session *s,
523 struct jsonrpc_msg *request)
525 ovsdb_jsonrpc_trigger_create(s, request->id, request->params);
527 request->params = NULL;
528 jsonrpc_msg_destroy(request);
533 ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *s,
534 struct jsonrpc_msg *request)
536 struct jsonrpc_msg *reply;
538 if (!strcmp(request->method, "transact")) {
539 reply = ovsdb_jsonrpc_check_db_name(s, request);
541 reply = execute_transaction(s, request);
543 } else if (!strcmp(request->method, "monitor")) {
544 reply = ovsdb_jsonrpc_check_db_name(s, request);
546 reply = jsonrpc_create_reply(
547 ovsdb_jsonrpc_monitor_create(s, request->params), request->id);
549 } else if (!strcmp(request->method, "monitor_cancel")) {
550 reply = ovsdb_jsonrpc_monitor_cancel(s, json_array(request->params),
552 } else if (!strcmp(request->method, "get_schema")) {
553 reply = ovsdb_jsonrpc_check_db_name(s, request);
555 reply = jsonrpc_create_reply(
556 ovsdb_schema_to_json(s->remote->server->db->schema),
559 } else if (!strcmp(request->method, "list_dbs")) {
560 reply = jsonrpc_create_reply(
561 json_array_create_1(json_string_create(get_db_name(s))),
563 } else if (!strcmp(request->method, "echo")) {
564 reply = jsonrpc_create_reply(json_clone(request->params), request->id);
566 reply = jsonrpc_create_error(json_string_create("unknown method"),
571 jsonrpc_msg_destroy(request);
572 jsonrpc_session_send(s->js, reply);
577 execute_cancel(struct ovsdb_jsonrpc_session *s, struct jsonrpc_msg *request)
579 if (json_array(request->params)->n == 1) {
580 struct ovsdb_jsonrpc_trigger *t;
583 id = request->params->u.array.elems[0];
584 t = ovsdb_jsonrpc_trigger_find(s, id, json_hash(id, 0));
586 ovsdb_jsonrpc_trigger_complete(t);
592 ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *s,
593 struct jsonrpc_msg *request)
595 if (!strcmp(request->method, "cancel")) {
596 execute_cancel(s, request);
598 jsonrpc_msg_destroy(request);
601 /* JSON-RPC database server triggers.
603 * (Every transaction is treated as a trigger even if it doesn't actually have
604 * any "wait" operations.) */
606 struct ovsdb_jsonrpc_trigger {
607 struct ovsdb_trigger trigger;
608 struct ovsdb_jsonrpc_session *session;
609 struct hmap_node hmap_node; /* In session's "triggers" hmap. */
614 ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *s,
615 struct json *id, struct json *params)
617 struct ovsdb_jsonrpc_trigger *t;
620 /* Check for duplicate ID. */
621 hash = json_hash(id, 0);
622 t = ovsdb_jsonrpc_trigger_find(s, id, hash);
624 struct jsonrpc_msg *msg;
626 msg = jsonrpc_create_error(json_string_create("duplicate request ID"),
628 jsonrpc_session_send(s->js, msg);
630 json_destroy(params);
634 /* Insert into trigger table. */
635 t = xmalloc(sizeof *t);
636 ovsdb_trigger_init(s->remote->server->db,
637 &t->trigger, params, &s->completions,
641 hmap_insert(&s->triggers, &t->hmap_node, hash);
643 /* Complete early if possible. */
644 if (ovsdb_trigger_is_complete(&t->trigger)) {
645 ovsdb_jsonrpc_trigger_complete(t);
649 static struct ovsdb_jsonrpc_trigger *
650 ovsdb_jsonrpc_trigger_find(struct ovsdb_jsonrpc_session *s,
651 const struct json *id, size_t hash)
653 struct ovsdb_jsonrpc_trigger *t;
655 HMAP_FOR_EACH_WITH_HASH (t, hmap_node, hash, &s->triggers) {
656 if (json_equal(t->id, id)) {
665 ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *t)
667 struct ovsdb_jsonrpc_session *s = t->session;
669 if (jsonrpc_session_is_connected(s->js)) {
670 struct jsonrpc_msg *reply;
673 result = ovsdb_trigger_steal_result(&t->trigger);
675 reply = jsonrpc_create_reply(result, t->id);
677 reply = jsonrpc_create_error(json_string_create("canceled"),
680 jsonrpc_session_send(s->js, reply);
684 ovsdb_trigger_destroy(&t->trigger);
685 hmap_remove(&s->triggers, &t->hmap_node);
690 ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *s)
692 struct ovsdb_jsonrpc_trigger *t, *next;
693 HMAP_FOR_EACH_SAFE (t, next, hmap_node, &s->triggers) {
694 ovsdb_jsonrpc_trigger_complete(t);
699 ovsdb_jsonrpc_trigger_complete_done(struct ovsdb_jsonrpc_session *s)
701 while (!list_is_empty(&s->completions)) {
702 struct ovsdb_jsonrpc_trigger *t
703 = CONTAINER_OF(s->completions.next,
704 struct ovsdb_jsonrpc_trigger, trigger.node);
705 ovsdb_jsonrpc_trigger_complete(t);
709 /* JSON-RPC database table monitors. */
711 enum ovsdb_jsonrpc_monitor_selection {
712 OJMS_INITIAL = 1 << 0, /* All rows when monitor is created. */
713 OJMS_INSERT = 1 << 1, /* New rows. */
714 OJMS_DELETE = 1 << 2, /* Deleted rows. */
715 OJMS_MODIFY = 1 << 3 /* Modified rows. */
718 /* A particular column being monitored. */
719 struct ovsdb_jsonrpc_monitor_column {
720 const struct ovsdb_column *column;
721 enum ovsdb_jsonrpc_monitor_selection select;
724 /* A particular table being monitored. */
725 struct ovsdb_jsonrpc_monitor_table {
726 const struct ovsdb_table *table;
728 /* This is the union (bitwise-OR) of the 'select' values in all of the
729 * members of 'columns' below. */
730 enum ovsdb_jsonrpc_monitor_selection select;
732 /* Columns being monitored. */
733 struct ovsdb_jsonrpc_monitor_column *columns;
737 /* A collection of tables being monitored. */
738 struct ovsdb_jsonrpc_monitor {
739 struct ovsdb_replica replica;
740 struct ovsdb_jsonrpc_session *session;
741 struct hmap_node node; /* In ovsdb_jsonrpc_session's "monitors". */
743 struct json *monitor_id;
744 struct shash tables; /* Holds "struct ovsdb_jsonrpc_monitor_table"s. */
747 static const struct ovsdb_replica_class ovsdb_jsonrpc_replica_class;
749 struct ovsdb_jsonrpc_monitor *ovsdb_jsonrpc_monitor_find(
750 struct ovsdb_jsonrpc_session *, const struct json *monitor_id);
751 static void ovsdb_jsonrpc_monitor_destroy(struct ovsdb_replica *);
752 static struct json *ovsdb_jsonrpc_monitor_get_initial(
753 const struct ovsdb_jsonrpc_monitor *);
756 parse_bool(struct ovsdb_parser *parser, const char *name, bool default_value)
758 const struct json *json;
760 json = ovsdb_parser_member(parser, name, OP_BOOLEAN | OP_OPTIONAL);
761 return json ? json_boolean(json) : default_value;
764 struct ovsdb_jsonrpc_monitor *
765 ovsdb_jsonrpc_monitor_find(struct ovsdb_jsonrpc_session *s,
766 const struct json *monitor_id)
768 struct ovsdb_jsonrpc_monitor *m;
770 HMAP_FOR_EACH_WITH_HASH (m, node, json_hash(monitor_id, 0), &s->monitors) {
771 if (json_equal(m->monitor_id, monitor_id)) {
780 ovsdb_jsonrpc_add_monitor_column(struct ovsdb_jsonrpc_monitor_table *mt,
781 const struct ovsdb_column *column,
782 enum ovsdb_jsonrpc_monitor_selection select,
783 size_t *allocated_columns)
785 struct ovsdb_jsonrpc_monitor_column *c;
787 if (mt->n_columns >= *allocated_columns) {
788 mt->columns = x2nrealloc(mt->columns, allocated_columns,
789 sizeof *mt->columns);
792 c = &mt->columns[mt->n_columns++];
798 compare_ovsdb_jsonrpc_monitor_column(const void *a_, const void *b_)
800 const struct ovsdb_jsonrpc_monitor_column *a = a_;
801 const struct ovsdb_jsonrpc_monitor_column *b = b_;
803 return a->column < b->column ? -1 : a->column > b->column;
806 static struct ovsdb_error * WARN_UNUSED_RESULT
807 ovsdb_jsonrpc_parse_monitor_request(struct ovsdb_jsonrpc_monitor_table *mt,
808 const struct json *monitor_request,
809 size_t *allocated_columns)
811 const struct ovsdb_table_schema *ts = mt->table->schema;
812 enum ovsdb_jsonrpc_monitor_selection select;
813 const struct json *columns, *select_json;
814 struct ovsdb_parser parser;
815 struct ovsdb_error *error;
817 ovsdb_parser_init(&parser, monitor_request, "table %s", ts->name);
818 columns = ovsdb_parser_member(&parser, "columns", OP_ARRAY | OP_OPTIONAL);
819 select_json = ovsdb_parser_member(&parser, "select",
820 OP_OBJECT | OP_OPTIONAL);
821 error = ovsdb_parser_finish(&parser);
828 ovsdb_parser_init(&parser, select_json, "table %s select", ts->name);
829 if (parse_bool(&parser, "initial", true)) {
830 select |= OJMS_INITIAL;
832 if (parse_bool(&parser, "insert", true)) {
833 select |= OJMS_INSERT;
835 if (parse_bool(&parser, "delete", true)) {
836 select |= OJMS_DELETE;
838 if (parse_bool(&parser, "modify", true)) {
839 select |= OJMS_MODIFY;
841 error = ovsdb_parser_finish(&parser);
846 select = OJMS_INITIAL | OJMS_INSERT | OJMS_DELETE | OJMS_MODIFY;
848 mt->select |= select;
853 if (columns->type != JSON_ARRAY) {
854 return ovsdb_syntax_error(columns, NULL,
855 "array of column names expected");
858 for (i = 0; i < columns->u.array.n; i++) {
859 const struct ovsdb_column *column;
862 if (columns->u.array.elems[i]->type != JSON_STRING) {
863 return ovsdb_syntax_error(columns, NULL,
864 "array of column names expected");
867 s = columns->u.array.elems[i]->u.string;
868 column = shash_find_data(&mt->table->schema->columns, s);
870 return ovsdb_syntax_error(columns, NULL, "%s is not a valid "
873 ovsdb_jsonrpc_add_monitor_column(mt, column, select,
877 struct shash_node *node;
879 SHASH_FOR_EACH (node, &ts->columns) {
880 const struct ovsdb_column *column = node->data;
881 if (column->index != OVSDB_COL_UUID) {
882 ovsdb_jsonrpc_add_monitor_column(mt, column, select,
892 ovsdb_jsonrpc_monitor_create(struct ovsdb_jsonrpc_session *s,
895 struct ovsdb_jsonrpc_monitor *m = NULL;
896 struct json *monitor_id, *monitor_requests;
897 struct ovsdb_error *error = NULL;
898 struct shash_node *node;
901 if (json_array(params)->n != 3) {
902 error = ovsdb_syntax_error(params, NULL, "invalid parameters");
905 monitor_id = params->u.array.elems[1];
906 monitor_requests = params->u.array.elems[2];
907 if (monitor_requests->type != JSON_OBJECT) {
908 error = ovsdb_syntax_error(monitor_requests, NULL,
909 "monitor-requests must be object");
913 if (ovsdb_jsonrpc_monitor_find(s, monitor_id)) {
914 error = ovsdb_syntax_error(monitor_id, NULL, "duplicate monitor ID");
918 m = xzalloc(sizeof *m);
919 ovsdb_replica_init(&m->replica, &ovsdb_jsonrpc_replica_class);
920 ovsdb_add_replica(s->remote->server->db, &m->replica);
922 hmap_insert(&s->monitors, &m->node, json_hash(monitor_id, 0));
923 m->monitor_id = json_clone(monitor_id);
924 shash_init(&m->tables);
926 SHASH_FOR_EACH (node, json_object(monitor_requests)) {
927 const struct ovsdb_table *table;
928 struct ovsdb_jsonrpc_monitor_table *mt;
929 size_t allocated_columns;
930 const struct json *mr_value;
933 table = ovsdb_get_table(s->remote->server->db, node->name);
935 error = ovsdb_syntax_error(NULL, NULL,
936 "no table named %s", node->name);
940 mt = xzalloc(sizeof *mt);
942 shash_add(&m->tables, table->schema->name, mt);
945 mr_value = node->data;
946 allocated_columns = 0;
947 if (mr_value->type == JSON_ARRAY) {
948 const struct json_array *array = &mr_value->u.array;
950 for (i = 0; i < array->n; i++) {
951 error = ovsdb_jsonrpc_parse_monitor_request(
952 mt, array->elems[i], &allocated_columns);
958 error = ovsdb_jsonrpc_parse_monitor_request(
959 mt, mr_value, &allocated_columns);
965 /* Check for duplicate columns. */
966 qsort(mt->columns, mt->n_columns, sizeof *mt->columns,
967 compare_ovsdb_jsonrpc_monitor_column);
968 for (i = 1; i < mt->n_columns; i++) {
969 if (mt->columns[i].column == mt->columns[i - 1].column) {
970 error = ovsdb_syntax_error(mr_value, NULL, "column %s "
971 "mentioned more than once",
972 mt->columns[i].column->name);
978 return ovsdb_jsonrpc_monitor_get_initial(m);
982 ovsdb_remove_replica(s->remote->server->db, &m->replica);
985 json = ovsdb_error_to_json(error);
986 ovsdb_error_destroy(error);
990 static struct jsonrpc_msg *
991 ovsdb_jsonrpc_monitor_cancel(struct ovsdb_jsonrpc_session *s,
992 struct json_array *params,
993 const struct json *request_id)
995 if (params->n != 1) {
996 return jsonrpc_create_error(json_string_create("invalid parameters"),
999 struct ovsdb_jsonrpc_monitor *m;
1001 m = ovsdb_jsonrpc_monitor_find(s, params->elems[0]);
1003 return jsonrpc_create_error(json_string_create("unknown monitor"),
1006 ovsdb_remove_replica(s->remote->server->db, &m->replica);
1007 return jsonrpc_create_reply(json_object_create(), request_id);
1013 ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *s)
1015 struct ovsdb_jsonrpc_monitor *m, *next;
1017 HMAP_FOR_EACH_SAFE (m, next, node, &s->monitors) {
1018 ovsdb_remove_replica(s->remote->server->db, &m->replica);
1022 static struct ovsdb_jsonrpc_monitor *
1023 ovsdb_jsonrpc_monitor_cast(struct ovsdb_replica *replica)
1025 assert(replica->class == &ovsdb_jsonrpc_replica_class);
1026 return CONTAINER_OF(replica, struct ovsdb_jsonrpc_monitor, replica);
1029 struct ovsdb_jsonrpc_monitor_aux {
1030 bool initial; /* Sending initial contents of table? */
1031 const struct ovsdb_jsonrpc_monitor *monitor;
1032 struct json *json; /* JSON for the whole transaction. */
1034 /* Current table. */
1035 struct ovsdb_jsonrpc_monitor_table *mt;
1036 struct json *table_json; /* JSON for table's transaction. */
1040 any_reportable_change(const struct ovsdb_jsonrpc_monitor_table *mt,
1041 const unsigned long int *changed)
1045 for (i = 0; i < mt->n_columns; i++) {
1046 const struct ovsdb_jsonrpc_monitor_column *c = &mt->columns[i];
1047 unsigned int idx = c->column->index;
1049 if (c->select & OJMS_MODIFY && bitmap_is_set(changed, idx)) {
1058 ovsdb_jsonrpc_monitor_change_cb(const struct ovsdb_row *old,
1059 const struct ovsdb_row *new,
1060 const unsigned long int *changed,
1063 struct ovsdb_jsonrpc_monitor_aux *aux = aux_;
1064 const struct ovsdb_jsonrpc_monitor *m = aux->monitor;
1065 struct ovsdb_table *table = new ? new->table : old->table;
1066 enum ovsdb_jsonrpc_monitor_selection type;
1067 struct json *old_json, *new_json;
1068 struct json *row_json;
1069 char uuid[UUID_LEN + 1];
1072 if (!aux->mt || table != aux->mt->table) {
1073 aux->mt = shash_find_data(&m->tables, table->schema->name);
1074 aux->table_json = NULL;
1076 /* We don't care about rows in this table at all. Tell the caller
1082 type = (aux->initial ? OJMS_INITIAL
1083 : !old ? OJMS_INSERT
1084 : !new ? OJMS_DELETE
1086 if (!(aux->mt->select & type)) {
1087 /* We don't care about this type of change (but do want to be called
1088 * back for changes to other rows in the same table). */
1092 if (type == OJMS_MODIFY && !any_reportable_change(aux->mt, changed)) {
1093 /* Nothing of interest changed. */
1097 old_json = new_json = NULL;
1098 if (type & (OJMS_DELETE | OJMS_MODIFY)) {
1099 old_json = json_object_create();
1101 if (type & (OJMS_INITIAL | OJMS_INSERT | OJMS_MODIFY)) {
1102 new_json = json_object_create();
1104 for (i = 0; i < aux->mt->n_columns; i++) {
1105 const struct ovsdb_jsonrpc_monitor_column *c = &aux->mt->columns[i];
1106 const struct ovsdb_column *column = c->column;
1107 unsigned int idx = c->column->index;
1109 if (!(type & c->select)) {
1110 /* We don't care about this type of change for this particular
1111 * column (but we will care about it for some other column). */
1115 if ((type == OJMS_MODIFY && bitmap_is_set(changed, idx))
1116 || type == OJMS_DELETE) {
1117 json_object_put(old_json, column->name,
1118 ovsdb_datum_to_json(&old->fields[idx],
1121 if (type & (OJMS_INITIAL | OJMS_INSERT | OJMS_MODIFY)) {
1122 json_object_put(new_json, column->name,
1123 ovsdb_datum_to_json(&new->fields[idx],
1128 /* Create JSON object for transaction overall. */
1130 aux->json = json_object_create();
1133 /* Create JSON object for transaction on this table. */
1134 if (!aux->table_json) {
1135 aux->table_json = json_object_create();
1136 json_object_put(aux->json, aux->mt->table->schema->name,
1140 /* Create JSON object for transaction on this row. */
1141 row_json = json_object_create();
1143 json_object_put(row_json, "old", old_json);
1146 json_object_put(row_json, "new", new_json);
1149 /* Add JSON row to JSON table. */
1150 snprintf(uuid, sizeof uuid,
1151 UUID_FMT, UUID_ARGS(ovsdb_row_get_uuid(new ? new : old)));
1152 json_object_put(aux->table_json, uuid, row_json);
1158 ovsdb_jsonrpc_monitor_init_aux(struct ovsdb_jsonrpc_monitor_aux *aux,
1159 const struct ovsdb_jsonrpc_monitor *m,
1162 aux->initial = initial;
1166 aux->table_json = NULL;
1169 static struct ovsdb_error *
1170 ovsdb_jsonrpc_monitor_commit(struct ovsdb_replica *replica,
1171 const struct ovsdb_txn *txn,
1172 bool durable OVS_UNUSED)
1174 struct ovsdb_jsonrpc_monitor *m = ovsdb_jsonrpc_monitor_cast(replica);
1175 struct ovsdb_jsonrpc_monitor_aux aux;
1177 ovsdb_jsonrpc_monitor_init_aux(&aux, m, false);
1178 ovsdb_txn_for_each_change(txn, ovsdb_jsonrpc_monitor_change_cb, &aux);
1180 struct jsonrpc_msg *msg;
1181 struct json *params;
1183 params = json_array_create_2(json_clone(aux.monitor->monitor_id),
1185 msg = jsonrpc_create_notify("update", params);
1186 jsonrpc_session_send(aux.monitor->session->js, msg);
1192 static struct json *
1193 ovsdb_jsonrpc_monitor_get_initial(const struct ovsdb_jsonrpc_monitor *m)
1195 struct ovsdb_jsonrpc_monitor_aux aux;
1196 struct shash_node *node;
1198 ovsdb_jsonrpc_monitor_init_aux(&aux, m, true);
1199 SHASH_FOR_EACH (node, &m->tables) {
1200 struct ovsdb_jsonrpc_monitor_table *mt = node->data;
1202 if (mt->select & OJMS_INITIAL) {
1203 struct ovsdb_row *row;
1205 HMAP_FOR_EACH (row, hmap_node, &mt->table->rows) {
1206 ovsdb_jsonrpc_monitor_change_cb(NULL, row, NULL, &aux);
1210 return aux.json ? aux.json : json_object_create();
1214 ovsdb_jsonrpc_monitor_destroy(struct ovsdb_replica *replica)
1216 struct ovsdb_jsonrpc_monitor *m = ovsdb_jsonrpc_monitor_cast(replica);
1217 struct shash_node *node;
1219 json_destroy(m->monitor_id);
1220 SHASH_FOR_EACH (node, &m->tables) {
1221 struct ovsdb_jsonrpc_monitor_table *mt = node->data;
1225 shash_destroy(&m->tables);
1226 hmap_remove(&m->session->monitors, &m->node);
1230 static const struct ovsdb_replica_class ovsdb_jsonrpc_replica_class = {
1231 ovsdb_jsonrpc_monitor_commit,
1232 ovsdb_jsonrpc_monitor_destroy