ovsdb/jsonrpc-server.c

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
   2  *
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #include <config.h>
  17
  18 #include "jsonrpc-server.h"
  19
  20 #include <errno.h>
  21
  22 #include "bitmap.h"
  23 #include "column.h"
  24 #include "dynamic-string.h"
  25 #include "monitor.h"
  26 #include "json.h"
  27 #include "jsonrpc.h"
  28 #include "ovsdb-error.h"
  29 #include "ovsdb-parser.h"
  30 #include "ovsdb.h"
  31 #include "poll-loop.h"
  32 #include "reconnect.h"
  33 #include "row.h"
  34 #include "server.h"
  35 #include "simap.h"
  36 #include "stream.h"
  37 #include "table.h"
  38 #include "timeval.h"
  39 #include "transaction.h"
  40 #include "trigger.h"
  41 #include "openvswitch/vlog.h"
  42
  43 VLOG_DEFINE_THIS_MODULE(ovsdb_jsonrpc_server);
  44
  45 struct ovsdb_jsonrpc_remote;
  46 struct ovsdb_jsonrpc_session;
  47
  48 /* Set false to defeature monitor2, causing jsonrpc to respond to monitor2
  49  * method with an error.  */
  50 static bool monitor2_enable__ = true;
  51
  52 /* Message rate-limiting. */
  53 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  54
  55 /* Sessions. */
  56 static struct ovsdb_jsonrpc_session *ovsdb_jsonrpc_session_create(
  57     struct ovsdb_jsonrpc_remote *, struct jsonrpc_session *);
  58 static void ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *);
  59 static void ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *);
  60 static void ovsdb_jsonrpc_session_get_memory_usage_all(
  61     const struct ovsdb_jsonrpc_remote *, struct simap *usage);
  62 static void ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *);
  63 static void ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *);
  64 static void ovsdb_jsonrpc_session_set_all_options(
  65     struct ovsdb_jsonrpc_remote *, const struct ovsdb_jsonrpc_options *);
  66 static bool ovsdb_jsonrpc_session_get_status(
  67     const struct ovsdb_jsonrpc_remote *,
  68     struct ovsdb_jsonrpc_remote_status *);
  69 static void ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *);
  70 static void ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *);
  71 static void ovsdb_jsonrpc_session_send(struct ovsdb_jsonrpc_session *,
  72                                        struct jsonrpc_msg *);
  73
  74 /* Triggers. */
  75 static void ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *,
  76                                          struct ovsdb *,
  77                                          struct json *id, struct json *params);
  78 static struct ovsdb_jsonrpc_trigger *ovsdb_jsonrpc_trigger_find(
  79     struct ovsdb_jsonrpc_session *, const struct json *id, size_t hash);
  80 static void ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *);
  81 static void ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *);
  82 static void ovsdb_jsonrpc_trigger_complete_done(
  83     struct ovsdb_jsonrpc_session *);
  84
  85 /* Monitors. */
  86 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_create(
  87     struct ovsdb_jsonrpc_session *, struct ovsdb *, struct json *params,
  88     enum ovsdb_monitor_version, const struct json *request_id);
  89 static struct jsonrpc_msg *ovsdb_jsonrpc_monitor_cancel(
  90     struct ovsdb_jsonrpc_session *,
  91     struct json_array *params,
  92     const struct json *request_id);
  93 static void ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *);
  94 static void ovsdb_jsonrpc_monitor_flush_all(struct ovsdb_jsonrpc_session *);
  95 static bool ovsdb_jsonrpc_monitor_needs_flush(struct ovsdb_jsonrpc_session *);
  96 static struct json *ovsdb_jsonrpc_monitor_compose_update(
  97     struct ovsdb_jsonrpc_monitor *monitor, bool initial);
  98
  99 \f
 100 /* JSON-RPC database server. */
 101
 102 struct ovsdb_jsonrpc_server {
 103     struct ovsdb_server up;
 104     unsigned int n_sessions, max_sessions;
 105     struct shash remotes;      /* Contains "struct ovsdb_jsonrpc_remote *"s. */
 106 };
 107
 108 /* A configured remote.  This is either a passive stream listener plus a list
 109  * of the currently connected sessions, or a list of exactly one active
 110  * session. */
 111 struct ovsdb_jsonrpc_remote {
 112     struct ovsdb_jsonrpc_server *server;
 113     struct pstream *listener;   /* Listener, if passive. */
 114     struct ovs_list sessions;   /* List of "struct ovsdb_jsonrpc_session"s. */
 115     uint8_t dscp;
 116 };
 117
 118 static struct ovsdb_jsonrpc_remote *ovsdb_jsonrpc_server_add_remote(
 119     struct ovsdb_jsonrpc_server *, const char *name,
 120     const struct ovsdb_jsonrpc_options *options
 121 );
 122 static void ovsdb_jsonrpc_server_del_remote(struct shash_node *);
 123
 124 /* Creates and returns a new server to provide JSON-RPC access to an OVSDB.
 125  *
 126  * The caller must call ovsdb_jsonrpc_server_add_db() for each database to
 127  * which 'server' should provide access. */
 128 struct ovsdb_jsonrpc_server *
 129 ovsdb_jsonrpc_server_create(void)
 130 {
 131     struct ovsdb_jsonrpc_server *server = xzalloc(sizeof *server);
 132     ovsdb_server_init(&server->up);
 133     server->max_sessions = 330;   /* Random limit. */
 134     shash_init(&server->remotes);
 135     return server;
 136 }
 137
 138 /* Adds 'db' to the set of databases served out by 'svr'.  Returns true if
 139  * successful, false if 'db''s name is the same as some database already in
 140  * 'server'. */
 141 bool
 142 ovsdb_jsonrpc_server_add_db(struct ovsdb_jsonrpc_server *svr, struct ovsdb *db)
 143 {
 144     /* The OVSDB protocol doesn't have a way to notify a client that a
 145      * database has been added.  If some client tried to use the database
 146      * that we're adding and failed, then forcing it to reconnect seems like
 147      * a reasonable way to make it try again.
 148      *
 149      * If this is too big of a hammer in practice, we could be more selective,
 150      * e.g. disconnect only connections that actually tried to use a database
 151      * with 'db''s name. */
 152     ovsdb_jsonrpc_server_reconnect(svr);
 153
 154     return ovsdb_server_add_db(&svr->up, db);
 155 }
 156
 157 /* Removes 'db' from the set of databases served out by 'svr'.  Returns
 158  * true if successful, false if there is no database associated with 'db'. */
 159 bool
 160 ovsdb_jsonrpc_server_remove_db(struct ovsdb_jsonrpc_server *svr,
 161                                struct ovsdb *db)
 162 {
 163     /* There might be pointers to 'db' from 'svr', such as monitors or
 164      * outstanding transactions.  Disconnect all JSON-RPC connections to avoid
 165      * accesses to freed memory.
 166      *
 167      * If this is too big of a hammer in practice, we could be more selective,
 168      * e.g. disconnect only connections that actually reference 'db'. */
 169     ovsdb_jsonrpc_server_reconnect(svr);
 170
 171     return ovsdb_server_remove_db(&svr->up, db);
 172 }
 173
 174 void
 175 ovsdb_jsonrpc_server_destroy(struct ovsdb_jsonrpc_server *svr)
 176 {
 177     struct shash_node *node, *next;
 178
 179     SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
 180         ovsdb_jsonrpc_server_del_remote(node);
 181     }
 182     shash_destroy(&svr->remotes);
 183     ovsdb_server_destroy(&svr->up);
 184     free(svr);
 185 }
 186
 187 struct ovsdb_jsonrpc_options *
 188 ovsdb_jsonrpc_default_options(const char *target)
 189 {
 190     struct ovsdb_jsonrpc_options *options = xzalloc(sizeof *options);
 191     options->max_backoff = RECONNECT_DEFAULT_MAX_BACKOFF;
 192     options->probe_interval = (stream_or_pstream_needs_probes(target)
 193                                ? RECONNECT_DEFAULT_PROBE_INTERVAL
 194                                : 0);
 195     return options;
 196 }
 197
 198 /* Sets 'svr''s current set of remotes to the names in 'new_remotes', with
 199  * options in the struct ovsdb_jsonrpc_options supplied as the data values.
 200  *
 201  * A remote is an active or passive stream connection method, e.g. "pssl:" or
 202  * "tcp:1.2.3.4". */
 203 void
 204 ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *svr,
 205                                  const struct shash *new_remotes)
 206 {
 207     struct shash_node *node, *next;
 208
 209     SHASH_FOR_EACH_SAFE (node, next, &svr->remotes) {
 210         struct ovsdb_jsonrpc_remote *remote = node->data;
 211         struct ovsdb_jsonrpc_options *options
 212             = shash_find_data(new_remotes, node->name);
 213
 214         if (!options) {
 215             VLOG_INFO("%s: remote deconfigured", node->name);
 216             ovsdb_jsonrpc_server_del_remote(node);
 217         } else if (options->dscp != remote->dscp) {
 218             ovsdb_jsonrpc_server_del_remote(node);
 219          }
 220     }
 221     SHASH_FOR_EACH (node, new_remotes) {
 222         const struct ovsdb_jsonrpc_options *options = node->data;
 223         struct ovsdb_jsonrpc_remote *remote;
 224
 225         remote = shash_find_data(&svr->remotes, node->name);
 226         if (!remote) {
 227             remote = ovsdb_jsonrpc_server_add_remote(svr, node->name, options);
 228             if (!remote) {
 229                 continue;
 230             }
 231         }
 232
 233         ovsdb_jsonrpc_session_set_all_options(remote, options);
 234     }
 235 }
 236
 237 static struct ovsdb_jsonrpc_remote *
 238 ovsdb_jsonrpc_server_add_remote(struct ovsdb_jsonrpc_server *svr,
 239                                 const char *name,
 240                                 const struct ovsdb_jsonrpc_options *options)
 241 {
 242     struct ovsdb_jsonrpc_remote *remote;
 243     struct pstream *listener;
 244     int error;
 245
 246     error = jsonrpc_pstream_open(name, &listener, options->dscp);
 247     if (error && error != EAFNOSUPPORT) {
 248         VLOG_ERR_RL(&rl, "%s: listen failed: %s", name, ovs_strerror(error));
 249         return NULL;
 250     }
 251
 252     remote = xmalloc(sizeof *remote);
 253     remote->server = svr;
 254     remote->listener = listener;
 255     list_init(&remote->sessions);
 256     remote->dscp = options->dscp;
 257     shash_add(&svr->remotes, name, remote);
 258
 259     if (!listener) {
 260         ovsdb_jsonrpc_session_create(remote, jsonrpc_session_open(name, true));
 261     }
 262     return remote;
 263 }
 264
 265 static void
 266 ovsdb_jsonrpc_server_del_remote(struct shash_node *node)
 267 {
 268     struct ovsdb_jsonrpc_remote *remote = node->data;
 269
 270     ovsdb_jsonrpc_session_close_all(remote);
 271     pstream_close(remote->listener);
 272     shash_delete(&remote->server->remotes, node);
 273     free(remote);
 274 }
 275
 276 /* Stores status information for the remote named 'target', which should have
 277  * been configured on 'svr' with a call to ovsdb_jsonrpc_server_set_remotes(),
 278  * into '*status'.  On success returns true, on failure (if 'svr' doesn't have
 279  * a remote named 'target' or if that remote is an inbound remote that has no
 280  * active connections) returns false.  On failure, 'status' will be zeroed.
 281  */
 282 bool
 283 ovsdb_jsonrpc_server_get_remote_status(
 284     const struct ovsdb_jsonrpc_server *svr, const char *target,
 285     struct ovsdb_jsonrpc_remote_status *status)
 286 {
 287     const struct ovsdb_jsonrpc_remote *remote;
 288
 289     memset(status, 0, sizeof *status);
 290
 291     remote = shash_find_data(&svr->remotes, target);
 292     return remote && ovsdb_jsonrpc_session_get_status(remote, status);
 293 }
 294
 295 void
 296 ovsdb_jsonrpc_server_free_remote_status(
 297     struct ovsdb_jsonrpc_remote_status *status)
 298 {
 299     free(status->locks_held);
 300     free(status->locks_waiting);
 301     free(status->locks_lost);
 302 }
 303
 304 /* Forces all of the JSON-RPC sessions managed by 'svr' to disconnect and
 305  * reconnect. */
 306 void
 307 ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *svr)
 308 {
 309     struct shash_node *node;
 310
 311     SHASH_FOR_EACH (node, &svr->remotes) {
 312         struct ovsdb_jsonrpc_remote *remote = node->data;
 313
 314         ovsdb_jsonrpc_session_reconnect_all(remote);
 315     }
 316 }
 317
 318 void
 319 ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *svr)
 320 {
 321     struct shash_node *node;
 322
 323     SHASH_FOR_EACH (node, &svr->remotes) {
 324         struct ovsdb_jsonrpc_remote *remote = node->data;
 325
 326         if (remote->listener) {
 327             if (svr->n_sessions < svr->max_sessions) {
 328                 struct stream *stream;
 329                 int error;
 330
 331                 error = pstream_accept(remote->listener, &stream);
 332                 if (!error) {
 333                     struct jsonrpc_session *js;
 334                     js = jsonrpc_session_open_unreliably(jsonrpc_open(stream),
 335                                                          remote->dscp);
 336                     ovsdb_jsonrpc_session_create(remote, js);
 337                 } else if (error != EAGAIN) {
 338                     VLOG_WARN_RL(&rl, "%s: accept failed: %s",
 339                                  pstream_get_name(remote->listener),
 340                                  ovs_strerror(error));
 341                 }
 342             } else {
 343                 VLOG_WARN_RL(&rl, "%s: connection exceeded maximum (%d)",
 344                              pstream_get_name(remote->listener),
 345                              svr->max_sessions);
 346             }
 347         }
 348
 349         ovsdb_jsonrpc_session_run_all(remote);
 350     }
 351 }
 352
 353 void
 354 ovsdb_jsonrpc_server_wait(struct ovsdb_jsonrpc_server *svr)
 355 {
 356     struct shash_node *node;
 357
 358     SHASH_FOR_EACH (node, &svr->remotes) {
 359         struct ovsdb_jsonrpc_remote *remote = node->data;
 360
 361         if (remote->listener && svr->n_sessions < svr->max_sessions) {
 362             pstream_wait(remote->listener);
 363         }
 364
 365         ovsdb_jsonrpc_session_wait_all(remote);
 366     }
 367 }
 368
 369 /* Adds some memory usage statistics for 'svr' into 'usage', for use with
 370  * memory_report(). */
 371 void
 372 ovsdb_jsonrpc_server_get_memory_usage(const struct ovsdb_jsonrpc_server *svr,
 373                                       struct simap *usage)
 374 {
 375     struct shash_node *node;
 376
 377     simap_increase(usage, "sessions", svr->n_sessions);
 378     SHASH_FOR_EACH (node, &svr->remotes) {
 379         struct ovsdb_jsonrpc_remote *remote = node->data;
 380
 381         ovsdb_jsonrpc_session_get_memory_usage_all(remote, usage);
 382     }
 383 }
 384 \f
 385 /* JSON-RPC database server session. */
 386
 387 struct ovsdb_jsonrpc_session {
 388     struct ovs_list node;       /* Element in remote's sessions list. */
 389     struct ovsdb_session up;
 390     struct ovsdb_jsonrpc_remote *remote;
 391
 392     /* Triggers. */
 393     struct hmap triggers;       /* Hmap of "struct ovsdb_jsonrpc_trigger"s. */
 394
 395     /* Monitors. */
 396     struct hmap monitors;       /* Hmap of "struct ovsdb_jsonrpc_monitor"s. */
 397
 398     /* Network connectivity. */
 399     struct jsonrpc_session *js;  /* JSON-RPC session. */
 400     unsigned int js_seqno;       /* Last jsonrpc_session_get_seqno() value. */
 401 };
 402
 403 static void ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *);
 404 static int ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *);
 405 static void ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *);
 406 static void ovsdb_jsonrpc_session_get_memory_usage(
 407     const struct ovsdb_jsonrpc_session *, struct simap *usage);
 408 static void ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *,
 409                                              struct jsonrpc_msg *);
 410 static void ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *,
 411                                              struct jsonrpc_msg *);
 412
 413 static struct ovsdb_jsonrpc_session *
 414 ovsdb_jsonrpc_session_create(struct ovsdb_jsonrpc_remote *remote,
 415                              struct jsonrpc_session *js)
 416 {
 417     struct ovsdb_jsonrpc_session *s;
 418
 419     s = xzalloc(sizeof *s);
 420     ovsdb_session_init(&s->up, &remote->server->up);
 421     s->remote = remote;
 422     list_push_back(&remote->sessions, &s->node);
 423     hmap_init(&s->triggers);
 424     hmap_init(&s->monitors);
 425     s->js = js;
 426     s->js_seqno = jsonrpc_session_get_seqno(js);
 427
 428     remote->server->n_sessions++;
 429
 430     return s;
 431 }
 432
 433 static void
 434 ovsdb_jsonrpc_session_close(struct ovsdb_jsonrpc_session *s)
 435 {
 436     ovsdb_jsonrpc_monitor_remove_all(s);
 437     ovsdb_jsonrpc_session_unlock_all(s);
 438     ovsdb_jsonrpc_trigger_complete_all(s);
 439
 440     hmap_destroy(&s->monitors);
 441     hmap_destroy(&s->triggers);
 442
 443     jsonrpc_session_close(s->js);
 444     list_remove(&s->node);
 445     s->remote->server->n_sessions--;
 446     ovsdb_session_destroy(&s->up);
 447     free(s);
 448 }
 449
 450 static int
 451 ovsdb_jsonrpc_session_run(struct ovsdb_jsonrpc_session *s)
 452 {
 453     jsonrpc_session_run(s->js);
 454     if (s->js_seqno != jsonrpc_session_get_seqno(s->js)) {
 455         s->js_seqno = jsonrpc_session_get_seqno(s->js);
 456         ovsdb_jsonrpc_trigger_complete_all(s);
 457         ovsdb_jsonrpc_monitor_remove_all(s);
 458         ovsdb_jsonrpc_session_unlock_all(s);
 459     }
 460
 461     ovsdb_jsonrpc_trigger_complete_done(s);
 462
 463     if (!jsonrpc_session_get_backlog(s->js)) {
 464         struct jsonrpc_msg *msg;
 465
 466         ovsdb_jsonrpc_monitor_flush_all(s);
 467
 468         msg = jsonrpc_session_recv(s->js);
 469         if (msg) {
 470             if (msg->type == JSONRPC_REQUEST) {
 471                 ovsdb_jsonrpc_session_got_request(s, msg);
 472             } else if (msg->type == JSONRPC_NOTIFY) {
 473                 ovsdb_jsonrpc_session_got_notify(s, msg);
 474             } else {
 475                 VLOG_WARN("%s: received unexpected %s message",
 476                           jsonrpc_session_get_name(s->js),
 477                           jsonrpc_msg_type_to_string(msg->type));
 478                 jsonrpc_session_force_reconnect(s->js);
 479                 jsonrpc_msg_destroy(msg);
 480             }
 481         }
 482     }
 483     return jsonrpc_session_is_alive(s->js) ? 0 : ETIMEDOUT;
 484 }
 485
 486 static void
 487 ovsdb_jsonrpc_session_set_options(struct ovsdb_jsonrpc_session *session,
 488                                   const struct ovsdb_jsonrpc_options *options)
 489 {
 490     jsonrpc_session_set_max_backoff(session->js, options->max_backoff);
 491     jsonrpc_session_set_probe_interval(session->js, options->probe_interval);
 492     jsonrpc_session_set_dscp(session->js, options->dscp);
 493 }
 494
 495 static void
 496 ovsdb_jsonrpc_session_run_all(struct ovsdb_jsonrpc_remote *remote)
 497 {
 498     struct ovsdb_jsonrpc_session *s, *next;
 499
 500     LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
 501         int error = ovsdb_jsonrpc_session_run(s);
 502         if (error) {
 503             ovsdb_jsonrpc_session_close(s);
 504         }
 505     }
 506 }
 507
 508 static void
 509 ovsdb_jsonrpc_session_wait(struct ovsdb_jsonrpc_session *s)
 510 {
 511     jsonrpc_session_wait(s->js);
 512     if (!jsonrpc_session_get_backlog(s->js)) {
 513         if (ovsdb_jsonrpc_monitor_needs_flush(s)) {
 514             poll_immediate_wake();
 515         } else {
 516             jsonrpc_session_recv_wait(s->js);
 517         }
 518     }
 519 }
 520
 521 static void
 522 ovsdb_jsonrpc_session_wait_all(struct ovsdb_jsonrpc_remote *remote)
 523 {
 524     struct ovsdb_jsonrpc_session *s;
 525
 526     LIST_FOR_EACH (s, node, &remote->sessions) {
 527         ovsdb_jsonrpc_session_wait(s);
 528     }
 529 }
 530
 531 static void
 532 ovsdb_jsonrpc_session_get_memory_usage(const struct ovsdb_jsonrpc_session *s,
 533                                        struct simap *usage)
 534 {
 535     simap_increase(usage, "triggers", hmap_count(&s->triggers));
 536     simap_increase(usage, "monitors", hmap_count(&s->monitors));
 537     simap_increase(usage, "backlog", jsonrpc_session_get_backlog(s->js));
 538 }
 539
 540 static void
 541 ovsdb_jsonrpc_session_get_memory_usage_all(
 542     const struct ovsdb_jsonrpc_remote *remote,
 543     struct simap *usage)
 544 {
 545     struct ovsdb_jsonrpc_session *s;
 546
 547     LIST_FOR_EACH (s, node, &remote->sessions) {
 548         ovsdb_jsonrpc_session_get_memory_usage(s, usage);
 549     }
 550 }
 551
 552 static void
 553 ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *remote)
 554 {
 555     struct ovsdb_jsonrpc_session *s, *next;
 556
 557     LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
 558         ovsdb_jsonrpc_session_close(s);
 559     }
 560 }
 561
 562 /* Forces all of the JSON-RPC sessions managed by 'remote' to disconnect and
 563  * reconnect. */
 564 static void
 565 ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *remote)
 566 {
 567     struct ovsdb_jsonrpc_session *s, *next;
 568
 569     LIST_FOR_EACH_SAFE (s, next, node, &remote->sessions) {
 570         jsonrpc_session_force_reconnect(s->js);
 571         if (!jsonrpc_session_is_alive(s->js)) {
 572             ovsdb_jsonrpc_session_close(s);
 573         }
 574     }
 575 }
 576
 577 /* Sets the options for all of the JSON-RPC sessions managed by 'remote' to
 578  * 'options'.
 579  *
 580  * (The dscp value can't be changed directly; the caller must instead close and
 581  * re-open the session.) */
 582 static void
 583 ovsdb_jsonrpc_session_set_all_options(
 584     struct ovsdb_jsonrpc_remote *remote,
 585     const struct ovsdb_jsonrpc_options *options)
 586 {
 587     struct ovsdb_jsonrpc_session *s;
 588
 589     LIST_FOR_EACH (s, node, &remote->sessions) {
 590         ovsdb_jsonrpc_session_set_options(s, options);
 591     }
 592 }
 593
 594 static bool
 595 ovsdb_jsonrpc_session_get_status(const struct ovsdb_jsonrpc_remote *remote,
 596                                  struct ovsdb_jsonrpc_remote_status *status)
 597 {
 598     const struct ovsdb_jsonrpc_session *s;
 599     const struct jsonrpc_session *js;
 600     struct ovsdb_lock_waiter *waiter;
 601     struct reconnect_stats rstats;
 602     struct ds locks_held, locks_waiting, locks_lost;
 603
 604     status->bound_port = (remote->listener
 605                           ? pstream_get_bound_port(remote->listener)
 606                           : htons(0));
 607
 608     if (list_is_empty(&remote->sessions)) {
 609         return false;
 610     }
 611     s = CONTAINER_OF(remote->sessions.next, struct ovsdb_jsonrpc_session, node);
 612     js = s->js;
 613
 614     status->is_connected = jsonrpc_session_is_connected(js);
 615     status->last_error = jsonrpc_session_get_status(js);
 616
 617     jsonrpc_session_get_reconnect_stats(js, &rstats);
 618     status->state = rstats.state;
 619     status->sec_since_connect = rstats.msec_since_connect == UINT_MAX
 620         ? UINT_MAX : rstats.msec_since_connect / 1000;
 621     status->sec_since_disconnect = rstats.msec_since_disconnect == UINT_MAX
 622         ? UINT_MAX : rstats.msec_since_disconnect / 1000;
 623
 624     ds_init(&locks_held);
 625     ds_init(&locks_waiting);
 626     ds_init(&locks_lost);
 627     HMAP_FOR_EACH (waiter, session_node, &s->up.waiters) {
 628         struct ds *string;
 629
 630         string = (ovsdb_lock_waiter_is_owner(waiter) ? &locks_held
 631                   : waiter->mode == OVSDB_LOCK_WAIT ? &locks_waiting
 632                   : &locks_lost);
 633         if (string->length) {
 634             ds_put_char(string, ' ');
 635         }
 636         ds_put_cstr(string, waiter->lock_name);
 637     }
 638     status->locks_held = ds_steal_cstr(&locks_held);
 639     status->locks_waiting = ds_steal_cstr(&locks_waiting);
 640     status->locks_lost = ds_steal_cstr(&locks_lost);
 641
 642     status->n_connections = list_size(&remote->sessions);
 643
 644     return true;
 645 }
 646
 647 /* Examines 'request' to determine the database to which it relates, and then
 648  * searches 's' to find that database:
 649  *
 650  *    - If successful, returns the database and sets '*replyp' to NULL.
 651  *
 652  *    - If no such database exists, returns NULL and sets '*replyp' to an
 653  *      appropriate JSON-RPC error reply, owned by the caller. */
 654 static struct ovsdb *
 655 ovsdb_jsonrpc_lookup_db(const struct ovsdb_jsonrpc_session *s,
 656                         const struct jsonrpc_msg *request,
 657                         struct jsonrpc_msg **replyp)
 658 {
 659     struct json_array *params;
 660     struct ovsdb_error *error;
 661     const char *db_name;
 662     struct ovsdb *db;
 663
 664     params = json_array(request->params);
 665     if (!params->n || params->elems[0]->type != JSON_STRING) {
 666         error = ovsdb_syntax_error(
 667             request->params, NULL,
 668             "%s request params must begin with <db-name>", request->method);
 669         goto error;
 670     }
 671
 672     db_name = params->elems[0]->u.string;
 673     db = shash_find_data(&s->up.server->dbs, db_name);
 674     if (!db) {
 675         error = ovsdb_syntax_error(
 676             request->params, "unknown database",
 677             "%s request specifies unknown database %s",
 678             request->method, db_name);
 679         goto error;
 680     }
 681
 682     *replyp = NULL;
 683     return db;
 684
 685 error:
 686     *replyp = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
 687     ovsdb_error_destroy(error);
 688     return NULL;
 689 }
 690
 691 static struct ovsdb_error *
 692 ovsdb_jsonrpc_session_parse_lock_name(const struct jsonrpc_msg *request,
 693                                       const char **lock_namep)
 694 {
 695     const struct json_array *params;
 696
 697     params = json_array(request->params);
 698     if (params->n != 1 || params->elems[0]->type != JSON_STRING ||
 699         !ovsdb_parser_is_id(json_string(params->elems[0]))) {
 700         *lock_namep = NULL;
 701         return ovsdb_syntax_error(request->params, NULL,
 702                                   "%s request params must be <id>",
 703                                   request->method);
 704     }
 705
 706     *lock_namep = json_string(params->elems[0]);
 707     return NULL;
 708 }
 709
 710 static void
 711 ovsdb_jsonrpc_session_notify(struct ovsdb_session *session,
 712                              const char *lock_name,
 713                              const char *method)
 714 {
 715     struct ovsdb_jsonrpc_session *s;
 716     struct json *params;
 717
 718     s = CONTAINER_OF(session, struct ovsdb_jsonrpc_session, up);
 719     params = json_array_create_1(json_string_create(lock_name));
 720     ovsdb_jsonrpc_session_send(s, jsonrpc_create_notify(method, params));
 721 }
 722
 723 static struct jsonrpc_msg *
 724 ovsdb_jsonrpc_session_lock(struct ovsdb_jsonrpc_session *s,
 725                            struct jsonrpc_msg *request,
 726                            enum ovsdb_lock_mode mode)
 727 {
 728     struct ovsdb_lock_waiter *waiter;
 729     struct jsonrpc_msg *reply;
 730     struct ovsdb_error *error;
 731     struct ovsdb_session *victim;
 732     const char *lock_name;
 733     struct json *result;
 734
 735     error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
 736     if (error) {
 737         goto error;
 738     }
 739
 740     /* Report error if this session has issued a "lock" or "steal" without a
 741      * matching "unlock" for this lock. */
 742     waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
 743     if (waiter) {
 744         error = ovsdb_syntax_error(
 745             request->params, NULL,
 746             "must issue \"unlock\" before new \"%s\"", request->method);
 747         goto error;
 748     }
 749
 750     /* Get the lock, add us as a waiter. */
 751     waiter = ovsdb_server_lock(&s->remote->server->up, &s->up, lock_name, mode,
 752                                &victim);
 753     if (victim) {
 754         ovsdb_jsonrpc_session_notify(victim, lock_name, "stolen");
 755     }
 756
 757     result = json_object_create();
 758     json_object_put(result, "locked",
 759                     json_boolean_create(ovsdb_lock_waiter_is_owner(waiter)));
 760
 761     return jsonrpc_create_reply(result, request->id);
 762
 763 error:
 764     reply = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
 765     ovsdb_error_destroy(error);
 766     return reply;
 767 }
 768
 769 static void
 770 ovsdb_jsonrpc_session_unlock_all(struct ovsdb_jsonrpc_session *s)
 771 {
 772     struct ovsdb_lock_waiter *waiter, *next;
 773
 774     HMAP_FOR_EACH_SAFE (waiter, next, session_node, &s->up.waiters) {
 775         ovsdb_jsonrpc_session_unlock__(waiter);
 776     }
 777 }
 778
 779 static void
 780 ovsdb_jsonrpc_session_unlock__(struct ovsdb_lock_waiter *waiter)
 781 {
 782     struct ovsdb_lock *lock = waiter->lock;
 783
 784     if (lock) {
 785         struct ovsdb_session *new_owner = ovsdb_lock_waiter_remove(waiter);
 786         if (new_owner) {
 787             ovsdb_jsonrpc_session_notify(new_owner, lock->name, "locked");
 788         } else {
 789             /* ovsdb_server_lock() might have freed 'lock'. */
 790         }
 791     }
 792
 793     ovsdb_lock_waiter_destroy(waiter);
 794 }
 795
 796 static struct jsonrpc_msg *
 797 ovsdb_jsonrpc_session_unlock(struct ovsdb_jsonrpc_session *s,
 798                              struct jsonrpc_msg *request)
 799 {
 800     struct ovsdb_lock_waiter *waiter;
 801     struct jsonrpc_msg *reply;
 802     struct ovsdb_error *error;
 803     const char *lock_name;
 804
 805     error = ovsdb_jsonrpc_session_parse_lock_name(request, &lock_name);
 806     if (error) {
 807         goto error;
 808     }
 809
 810     /* Report error if this session has not issued a "lock" or "steal" for this
 811      * lock. */
 812     waiter = ovsdb_session_get_lock_waiter(&s->up, lock_name);
 813     if (!waiter) {
 814         error = ovsdb_syntax_error(
 815             request->params, NULL, "\"unlock\" without \"lock\" or \"steal\"");
 816         goto error;
 817     }
 818
 819     ovsdb_jsonrpc_session_unlock__(waiter);
 820
 821     return jsonrpc_create_reply(json_object_create(), request->id);
 822
 823 error:
 824     reply = jsonrpc_create_error(ovsdb_error_to_json(error), request->id);
 825     ovsdb_error_destroy(error);
 826     return reply;
 827 }
 828
 829 static struct jsonrpc_msg *
 830 execute_transaction(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
 831                     struct jsonrpc_msg *request)
 832 {
 833     ovsdb_jsonrpc_trigger_create(s, db, request->id, request->params);
 834     request->id = NULL;
 835     request->params = NULL;
 836     jsonrpc_msg_destroy(request);
 837     return NULL;
 838 }
 839
 840 static void
 841 ovsdb_jsonrpc_session_got_request(struct ovsdb_jsonrpc_session *s,
 842                                   struct jsonrpc_msg *request)
 843 {
 844     struct jsonrpc_msg *reply;
 845
 846     if (!strcmp(request->method, "transact")) {
 847         struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
 848         if (!reply) {
 849             reply = execute_transaction(s, db, request);
 850         }
 851     } else if (!strcmp(request->method, "monitor") ||
 852                (monitor2_enable__ && !strcmp(request->method, "monitor2"))) {
 853         struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
 854         if (!reply) {
 855             int l = strlen(request->method) - strlen("monitor");
 856             enum ovsdb_monitor_version version = l ? OVSDB_MONITOR_V2
 857                                                    : OVSDB_MONITOR_V1;
 858             reply = ovsdb_jsonrpc_monitor_create(s, db, request->params,
 859                                                  version, request->id);
 860         }
 861     } else if (!strcmp(request->method, "monitor_cancel")) {
 862         reply = ovsdb_jsonrpc_monitor_cancel(s, json_array(request->params),
 863                                              request->id);
 864     } else if (!strcmp(request->method, "get_schema")) {
 865         struct ovsdb *db = ovsdb_jsonrpc_lookup_db(s, request, &reply);
 866         if (!reply) {
 867             reply = jsonrpc_create_reply(ovsdb_schema_to_json(db->schema),
 868                                          request->id);
 869         }
 870     } else if (!strcmp(request->method, "list_dbs")) {
 871         size_t n_dbs = shash_count(&s->up.server->dbs);
 872         struct shash_node *node;
 873         struct json **dbs;
 874         size_t i;
 875
 876         dbs = xmalloc(n_dbs * sizeof *dbs);
 877         i = 0;
 878         SHASH_FOR_EACH (node, &s->up.server->dbs) {
 879             dbs[i++] = json_string_create(node->name);
 880         }
 881         reply = jsonrpc_create_reply(json_array_create(dbs, n_dbs),
 882                                      request->id);
 883     } else if (!strcmp(request->method, "lock")) {
 884         reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_WAIT);
 885     } else if (!strcmp(request->method, "steal")) {
 886         reply = ovsdb_jsonrpc_session_lock(s, request, OVSDB_LOCK_STEAL);
 887     } else if (!strcmp(request->method, "unlock")) {
 888         reply = ovsdb_jsonrpc_session_unlock(s, request);
 889     } else if (!strcmp(request->method, "echo")) {
 890         reply = jsonrpc_create_reply(json_clone(request->params), request->id);
 891     } else {
 892         reply = jsonrpc_create_error(json_string_create("unknown method"),
 893                                      request->id);
 894     }
 895
 896     if (reply) {
 897         jsonrpc_msg_destroy(request);
 898         ovsdb_jsonrpc_session_send(s, reply);
 899     }
 900 }
 901
 902 static void
 903 execute_cancel(struct ovsdb_jsonrpc_session *s, struct jsonrpc_msg *request)
 904 {
 905     if (json_array(request->params)->n == 1) {
 906         struct ovsdb_jsonrpc_trigger *t;
 907         struct json *id;
 908
 909         id = request->params->u.array.elems[0];
 910         t = ovsdb_jsonrpc_trigger_find(s, id, json_hash(id, 0));
 911         if (t) {
 912             ovsdb_jsonrpc_trigger_complete(t);
 913         }
 914     }
 915 }
 916
 917 static void
 918 ovsdb_jsonrpc_session_got_notify(struct ovsdb_jsonrpc_session *s,
 919                                  struct jsonrpc_msg *request)
 920 {
 921     if (!strcmp(request->method, "cancel")) {
 922         execute_cancel(s, request);
 923     }
 924     jsonrpc_msg_destroy(request);
 925 }
 926
 927 static void
 928 ovsdb_jsonrpc_session_send(struct ovsdb_jsonrpc_session *s,
 929                            struct jsonrpc_msg *msg)
 930 {
 931     ovsdb_jsonrpc_monitor_flush_all(s);
 932     jsonrpc_session_send(s->js, msg);
 933 }
 934 \f
 935 /* JSON-RPC database server triggers.
 936  *
 937  * (Every transaction is treated as a trigger even if it doesn't actually have
 938  * any "wait" operations.) */
 939
 940 struct ovsdb_jsonrpc_trigger {
 941     struct ovsdb_trigger trigger;
 942     struct hmap_node hmap_node; /* In session's "triggers" hmap. */
 943     struct json *id;
 944 };
 945
 946 static void
 947 ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
 948                              struct json *id, struct json *params)
 949 {
 950     struct ovsdb_jsonrpc_trigger *t;
 951     size_t hash;
 952
 953     /* Check for duplicate ID. */
 954     hash = json_hash(id, 0);
 955     t = ovsdb_jsonrpc_trigger_find(s, id, hash);
 956     if (t) {
 957         struct jsonrpc_msg *msg;
 958
 959         msg = jsonrpc_create_error(json_string_create("duplicate request ID"),
 960                                    id);
 961         ovsdb_jsonrpc_session_send(s, msg);
 962         json_destroy(id);
 963         json_destroy(params);
 964         return;
 965     }
 966
 967     /* Insert into trigger table. */
 968     t = xmalloc(sizeof *t);
 969     ovsdb_trigger_init(&s->up, db, &t->trigger, params, time_msec());
 970     t->id = id;
 971     hmap_insert(&s->triggers, &t->hmap_node, hash);
 972
 973     /* Complete early if possible. */
 974     if (ovsdb_trigger_is_complete(&t->trigger)) {
 975         ovsdb_jsonrpc_trigger_complete(t);
 976     }
 977 }
 978
 979 static struct ovsdb_jsonrpc_trigger *
 980 ovsdb_jsonrpc_trigger_find(struct ovsdb_jsonrpc_session *s,
 981                            const struct json *id, size_t hash)
 982 {
 983     struct ovsdb_jsonrpc_trigger *t;
 984
 985     HMAP_FOR_EACH_WITH_HASH (t, hmap_node, hash, &s->triggers) {
 986         if (json_equal(t->id, id)) {
 987             return t;
 988         }
 989     }
 990
 991     return NULL;
 992 }
 993
 994 static void
 995 ovsdb_jsonrpc_trigger_complete(struct ovsdb_jsonrpc_trigger *t)
 996 {
 997     struct ovsdb_jsonrpc_session *s;
 998
 999     s = CONTAINER_OF(t->trigger.session, struct ovsdb_jsonrpc_session, up);
1000
1001     if (jsonrpc_session_is_connected(s->js)) {
1002         struct jsonrpc_msg *reply;
1003         struct json *result;
1004
1005         result = ovsdb_trigger_steal_result(&t->trigger);
1006         if (result) {
1007             reply = jsonrpc_create_reply(result, t->id);
1008         } else {
1009             reply = jsonrpc_create_error(json_string_create("canceled"),
1010                                          t->id);
1011         }
1012         ovsdb_jsonrpc_session_send(s, reply);
1013     }
1014
1015     json_destroy(t->id);
1016     ovsdb_trigger_destroy(&t->trigger);
1017     hmap_remove(&s->triggers, &t->hmap_node);
1018     free(t);
1019 }
1020
1021 static void
1022 ovsdb_jsonrpc_trigger_complete_all(struct ovsdb_jsonrpc_session *s)
1023 {
1024     struct ovsdb_jsonrpc_trigger *t, *next;
1025     HMAP_FOR_EACH_SAFE (t, next, hmap_node, &s->triggers) {
1026         ovsdb_jsonrpc_trigger_complete(t);
1027     }
1028 }
1029
1030 static void
1031 ovsdb_jsonrpc_trigger_complete_done(struct ovsdb_jsonrpc_session *s)
1032 {
1033     while (!list_is_empty(&s->up.completions)) {
1034         struct ovsdb_jsonrpc_trigger *t
1035             = CONTAINER_OF(s->up.completions.next,
1036                            struct ovsdb_jsonrpc_trigger, trigger.node);
1037         ovsdb_jsonrpc_trigger_complete(t);
1038     }
1039 }
1040 \f
1041 /* Jsonrpc front end monitor. */
1042 struct ovsdb_jsonrpc_monitor {
1043     struct ovsdb_jsonrpc_session *session;
1044     struct ovsdb *db;
1045     struct hmap_node node;      /* In ovsdb_jsonrpc_session's "monitors". */
1046     struct json *monitor_id;
1047     struct ovsdb_monitor *dbmon;
1048     uint64_t unflushed;         /* The first transaction that has not been
1049                                        flushed to the jsonrpc remote client. */
1050     enum ovsdb_monitor_version version;
1051 };
1052
1053 static struct ovsdb_jsonrpc_monitor *
1054 ovsdb_jsonrpc_monitor_find(struct ovsdb_jsonrpc_session *s,
1055                            const struct json *monitor_id)
1056 {
1057     struct ovsdb_jsonrpc_monitor *m;
1058
1059     HMAP_FOR_EACH_WITH_HASH (m, node, json_hash(monitor_id, 0), &s->monitors) {
1060         if (json_equal(m->monitor_id, monitor_id)) {
1061             return m;
1062         }
1063     }
1064
1065     return NULL;
1066 }
1067
1068 static bool
1069 parse_bool(struct ovsdb_parser *parser, const char *name, bool default_value)
1070 {
1071     const struct json *json;
1072
1073     json = ovsdb_parser_member(parser, name, OP_BOOLEAN | OP_OPTIONAL);
1074     return json ? json_boolean(json) : default_value;
1075 }
1076
1077 static struct ovsdb_error * OVS_WARN_UNUSED_RESULT
1078 ovsdb_jsonrpc_parse_monitor_request(struct ovsdb_monitor *dbmon,
1079                                     const struct ovsdb_table *table,
1080                                     const struct json *monitor_request,
1081                                     size_t *allocated_columns)
1082 {
1083     const struct ovsdb_table_schema *ts = table->schema;
1084     enum ovsdb_monitor_selection select;
1085     const struct json *columns, *select_json;
1086     struct ovsdb_parser parser;
1087     struct ovsdb_error *error;
1088
1089     ovsdb_parser_init(&parser, monitor_request, "table %s", ts->name);
1090     columns = ovsdb_parser_member(&parser, "columns", OP_ARRAY | OP_OPTIONAL);
1091     select_json = ovsdb_parser_member(&parser, "select",
1092                                       OP_OBJECT | OP_OPTIONAL);
1093     error = ovsdb_parser_finish(&parser);
1094     if (error) {
1095         return error;
1096     }
1097
1098     if (select_json) {
1099         select = 0;
1100         ovsdb_parser_init(&parser, select_json, "table %s select", ts->name);
1101         if (parse_bool(&parser, "initial", true)) {
1102             select |= OJMS_INITIAL;
1103         }
1104         if (parse_bool(&parser, "insert", true)) {
1105             select |= OJMS_INSERT;
1106         }
1107         if (parse_bool(&parser, "delete", true)) {
1108             select |= OJMS_DELETE;
1109         }
1110         if (parse_bool(&parser, "modify", true)) {
1111             select |= OJMS_MODIFY;
1112         }
1113         error = ovsdb_parser_finish(&parser);
1114         if (error) {
1115             return error;
1116         }
1117     } else {
1118         select = OJMS_INITIAL | OJMS_INSERT | OJMS_DELETE | OJMS_MODIFY;
1119     }
1120
1121     ovsdb_monitor_table_add_select(dbmon, table, select);
1122     if (columns) {
1123         size_t i;
1124
1125         if (columns->type != JSON_ARRAY) {
1126             return ovsdb_syntax_error(columns, NULL,
1127                                       "array of column names expected");
1128         }
1129
1130         for (i = 0; i < columns->u.array.n; i++) {
1131             const struct ovsdb_column *column;
1132             const char *s;
1133
1134             if (columns->u.array.elems[i]->type != JSON_STRING) {
1135                 return ovsdb_syntax_error(columns, NULL,
1136                                           "array of column names expected");
1137             }
1138
1139             s = columns->u.array.elems[i]->u.string;
1140             column = shash_find_data(&table->schema->columns, s);
1141             if (!column) {
1142                 return ovsdb_syntax_error(columns, NULL, "%s is not a valid "
1143                                           "column name", s);
1144             }
1145             ovsdb_monitor_add_column(dbmon, table, column, select,
1146                                      allocated_columns);
1147         }
1148     } else {
1149         struct shash_node *node;
1150
1151         SHASH_FOR_EACH (node, &ts->columns) {
1152             const struct ovsdb_column *column = node->data;
1153             if (column->index != OVSDB_COL_UUID) {
1154                 ovsdb_monitor_add_column(dbmon, table, column, select,
1155                                          allocated_columns);
1156             }
1157         }
1158     }
1159
1160     return NULL;
1161 }
1162
1163 static struct jsonrpc_msg *
1164 ovsdb_jsonrpc_monitor_create(struct ovsdb_jsonrpc_session *s, struct ovsdb *db,
1165                              struct json *params,
1166                              enum ovsdb_monitor_version version,
1167                              const struct json *request_id)
1168 {
1169     struct ovsdb_jsonrpc_monitor *m = NULL;
1170     struct ovsdb_monitor *dbmon = NULL;
1171     struct json *monitor_id, *monitor_requests;
1172     struct ovsdb_error *error = NULL;
1173     struct shash_node *node;
1174     struct json *json;
1175
1176     if (json_array(params)->n != 3) {
1177         error = ovsdb_syntax_error(params, NULL, "invalid parameters");
1178         goto error;
1179     }
1180     monitor_id = params->u.array.elems[1];
1181     monitor_requests = params->u.array.elems[2];
1182     if (monitor_requests->type != JSON_OBJECT) {
1183         error = ovsdb_syntax_error(monitor_requests, NULL,
1184                                    "monitor-requests must be object");
1185         goto error;
1186     }
1187
1188     if (ovsdb_jsonrpc_monitor_find(s, monitor_id)) {
1189         error = ovsdb_syntax_error(monitor_id, NULL, "duplicate monitor ID");
1190         goto error;
1191     }
1192
1193     m = xzalloc(sizeof *m);
1194     m->session = s;
1195     m->db = db;
1196     m->dbmon = ovsdb_monitor_create(db, m);
1197     m->unflushed = 0;
1198     m->version = version;
1199     hmap_insert(&s->monitors, &m->node, json_hash(monitor_id, 0));
1200     m->monitor_id = json_clone(monitor_id);
1201
1202     SHASH_FOR_EACH (node, json_object(monitor_requests)) {
1203         const struct ovsdb_table *table;
1204         const char *column_name;
1205         size_t allocated_columns;
1206         const struct json *mr_value;
1207         size_t i;
1208
1209         table = ovsdb_get_table(m->db, node->name);
1210         if (!table) {
1211             error = ovsdb_syntax_error(NULL, NULL,
1212                                        "no table named %s", node->name);
1213             goto error;
1214         }
1215
1216         ovsdb_monitor_add_table(m->dbmon, table);
1217
1218         /* Parse columns. */
1219         mr_value = node->data;
1220         allocated_columns = 0;
1221         if (mr_value->type == JSON_ARRAY) {
1222             const struct json_array *array = &mr_value->u.array;
1223
1224             for (i = 0; i < array->n; i++) {
1225                 error = ovsdb_jsonrpc_parse_monitor_request(
1226                     m->dbmon, table, array->elems[i], &allocated_columns);
1227                 if (error) {
1228                     goto error;
1229                 }
1230             }
1231         } else {
1232             error = ovsdb_jsonrpc_parse_monitor_request(
1233                 m->dbmon, table, mr_value, &allocated_columns);
1234             if (error) {
1235                 goto error;
1236             }
1237         }
1238
1239         column_name = ovsdb_monitor_table_check_duplicates(m->dbmon, table);
1240
1241         if (column_name) {
1242             error = ovsdb_syntax_error(mr_value, NULL, "column %s "
1243                                        "mentioned more than once",
1244                                         column_name);
1245             goto error;
1246         }
1247     }
1248
1249     dbmon = ovsdb_monitor_add(m->dbmon);
1250     if (dbmon != m->dbmon) {
1251         /* Found an exisiting dbmon, reuse the current one. */
1252         ovsdb_monitor_remove_jsonrpc_monitor(m->dbmon, m);
1253         ovsdb_monitor_add_jsonrpc_monitor(dbmon, m);
1254         m->dbmon = dbmon;
1255     }
1256
1257     ovsdb_monitor_get_initial(m->dbmon);
1258     json = ovsdb_jsonrpc_monitor_compose_update(m, true);
1259     json = json ? json : json_object_create();
1260     return jsonrpc_create_reply(json, request_id);
1261
1262 error:
1263     if (m) {
1264         ovsdb_jsonrpc_monitor_destroy(m);
1265     }
1266
1267     json = ovsdb_error_to_json(error);
1268     ovsdb_error_destroy(error);
1269     return jsonrpc_create_error(json, request_id);
1270 }
1271
1272 static struct jsonrpc_msg *
1273 ovsdb_jsonrpc_monitor_cancel(struct ovsdb_jsonrpc_session *s,
1274                              struct json_array *params,
1275                              const struct json *request_id)
1276 {
1277     if (params->n != 1) {
1278         return jsonrpc_create_error(json_string_create("invalid parameters"),
1279                                     request_id);
1280     } else {
1281         struct ovsdb_jsonrpc_monitor *m;
1282
1283         m = ovsdb_jsonrpc_monitor_find(s, params->elems[0]);
1284         if (!m) {
1285             return jsonrpc_create_error(json_string_create("unknown monitor"),
1286                                         request_id);
1287         } else {
1288             ovsdb_jsonrpc_monitor_destroy(m);
1289             return jsonrpc_create_reply(json_object_create(), request_id);
1290         }
1291     }
1292 }
1293
1294 static void
1295 ovsdb_jsonrpc_monitor_remove_all(struct ovsdb_jsonrpc_session *s)
1296 {
1297     struct ovsdb_jsonrpc_monitor *m, *next;
1298
1299     HMAP_FOR_EACH_SAFE (m, next, node, &s->monitors) {
1300         ovsdb_jsonrpc_monitor_destroy(m);
1301     }
1302 }
1303
1304 static struct json *
1305 ovsdb_jsonrpc_monitor_compose_update(struct ovsdb_jsonrpc_monitor *m,
1306                                      bool initial)
1307 {
1308     return ovsdb_monitor_get_update(m->dbmon, initial, &m->unflushed,
1309                                     m->version);
1310 }
1311
1312 static bool
1313 ovsdb_jsonrpc_monitor_needs_flush(struct ovsdb_jsonrpc_session *s)
1314 {
1315     struct ovsdb_jsonrpc_monitor *m;
1316
1317     HMAP_FOR_EACH (m, node, &s->monitors) {
1318         if (ovsdb_monitor_needs_flush(m->dbmon, m->unflushed)) {
1319             return true;
1320         }
1321     }
1322
1323     return false;
1324 }
1325
1326 void
1327 ovsdb_jsonrpc_monitor_destroy(struct ovsdb_jsonrpc_monitor *m)
1328 {
1329     json_destroy(m->monitor_id);
1330     hmap_remove(&m->session->monitors, &m->node);
1331     ovsdb_monitor_remove_jsonrpc_monitor(m->dbmon, m);
1332     free(m);
1333 }
1334
1335 static struct jsonrpc_msg *
1336 ovsdb_jsonrpc_create_notify(const struct ovsdb_jsonrpc_monitor *m,
1337                             struct json *params)
1338 {
1339     const char *method;
1340
1341     switch(m->version) {
1342     case OVSDB_MONITOR_V1:
1343         method = "update";
1344         break;
1345     case OVSDB_MONITOR_V2:
1346         method = "update2";
1347         break;
1348     case OVSDB_MONITOR_VERSION_MAX:
1349     default:
1350         OVS_NOT_REACHED();
1351     }
1352
1353     return jsonrpc_create_notify(method, params);
1354 }
1355
1356 static void
1357 ovsdb_jsonrpc_monitor_flush_all(struct ovsdb_jsonrpc_session *s)
1358 {
1359     struct ovsdb_jsonrpc_monitor *m;
1360
1361     HMAP_FOR_EACH (m, node, &s->monitors) {
1362         struct json *json;
1363
1364         json = ovsdb_jsonrpc_monitor_compose_update(m, false);
1365         if (json) {
1366             struct jsonrpc_msg *msg;
1367             struct json *params;
1368
1369             params = json_array_create_2(json_clone(m->monitor_id), json);
1370             msg = ovsdb_jsonrpc_create_notify(m, params);
1371             jsonrpc_session_send(s->js, msg);
1372         }
1373     }
1374 }
1375
1376 void
1377 ovsdb_jsonrpc_disable_monitor2(void)
1378 {
1379     /* Once disabled, it is not possible to re-enable it. */
1380     monitor2_enable__ = false;
1381 }