2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
24 #include "dynamic-string.h"
25 #include "fatal-signal.h"
29 #include "ovs-thread.h"
30 #include "poll-loop.h"
31 #include "reconnect.h"
36 VLOG_DEFINE_THIS_MODULE(jsonrpc);
39 struct stream *stream;
45 uint8_t input_buffer[512];
46 struct json_parser *parser;
49 struct list output; /* Contains "struct ofpbuf"s. */
53 /* Rate limit for error messages. */
54 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 5);
56 static struct jsonrpc_msg *jsonrpc_parse_received_message(struct jsonrpc *);
57 static void jsonrpc_cleanup(struct jsonrpc *);
58 static void jsonrpc_error(struct jsonrpc *, int error);
60 /* This is just the same as stream_open() except that it uses the default
61 * JSONRPC port if none is specified. */
63 jsonrpc_stream_open(const char *name, struct stream **streamp, uint8_t dscp)
65 return stream_open_with_default_port(name, OVSDB_OLD_PORT,
69 /* This is just the same as pstream_open() except that it uses the default
70 * JSONRPC port if none is specified. */
72 jsonrpc_pstream_open(const char *name, struct pstream **pstreamp, uint8_t dscp)
74 return pstream_open_with_default_port(name, OVSDB_OLD_PORT,
78 /* Returns a new JSON-RPC stream that uses 'stream' for input and output. The
79 * new jsonrpc object takes ownership of 'stream'. */
81 jsonrpc_open(struct stream *stream)
85 ovs_assert(stream != NULL);
87 rpc = xzalloc(sizeof *rpc);
88 rpc->name = xstrdup(stream_get_name(stream));
90 byteq_init(&rpc->input, rpc->input_buffer, sizeof rpc->input_buffer);
91 list_init(&rpc->output);
96 /* Destroys 'rpc', closing the stream on which it is based, and frees its
99 jsonrpc_close(struct jsonrpc *rpc)
102 jsonrpc_cleanup(rpc);
108 /* Performs periodic maintenance on 'rpc', such as flushing output buffers. */
110 jsonrpc_run(struct jsonrpc *rpc)
116 stream_run(rpc->stream);
117 while (!list_is_empty(&rpc->output)) {
118 struct ofpbuf *buf = ofpbuf_from_list(rpc->output.next);
121 retval = stream_send(rpc->stream, ofpbuf_data(buf), ofpbuf_size(buf));
123 rpc->backlog -= retval;
124 ofpbuf_pull(buf, retval);
125 if (!ofpbuf_size(buf)) {
126 list_remove(&buf->list_node);
130 if (retval != -EAGAIN) {
131 VLOG_WARN_RL(&rl, "%s: send error: %s",
132 rpc->name, ovs_strerror(-retval));
133 jsonrpc_error(rpc, -retval);
140 /* Arranges for the poll loop to wake up when 'rpc' needs to perform
141 * maintenance activities. */
143 jsonrpc_wait(struct jsonrpc *rpc)
146 stream_run_wait(rpc->stream);
147 if (!list_is_empty(&rpc->output)) {
148 stream_send_wait(rpc->stream);
154 * Returns the current status of 'rpc'. The possible return values are:
157 * - EOF: end of file (remote end closed connection; not necessarily an error).
159 * When this functions nonzero, 'rpc' is effectively out of commission. 'rpc'
160 * will not receive any more messages and any further messages that one
161 * attempts to send with 'rpc' will be discarded. The caller can keep 'rpc'
162 * around as long as it wants, but it's not going to provide any more useful
166 jsonrpc_get_status(const struct jsonrpc *rpc)
171 /* Returns the number of bytes buffered by 'rpc' to be written to the
172 * underlying stream. Always returns 0 if 'rpc' has encountered an error or if
173 * the remote end closed the connection. */
175 jsonrpc_get_backlog(const struct jsonrpc *rpc)
177 return rpc->status ? 0 : rpc->backlog;
180 /* Returns the number of bytes that have been received on 'rpc''s underlying
181 * stream. (The value wraps around if it exceeds UINT_MAX.) */
183 jsonrpc_get_received_bytes(const struct jsonrpc *rpc)
185 return rpc->input.head;
188 /* Returns 'rpc''s name, that is, the name returned by stream_get_name() for
189 * the stream underlying 'rpc' when 'rpc' was created. */
191 jsonrpc_get_name(const struct jsonrpc *rpc)
197 jsonrpc_log_msg(const struct jsonrpc *rpc, const char *title,
198 const struct jsonrpc_msg *msg)
200 if (VLOG_IS_DBG_ENABLED()) {
201 struct ds s = DS_EMPTY_INITIALIZER;
203 ds_put_format(&s, ", method=\"%s\"", msg->method);
206 ds_put_cstr(&s, ", params=");
207 json_to_ds(msg->params, 0, &s);
210 ds_put_cstr(&s, ", result=");
211 json_to_ds(msg->result, 0, &s);
214 ds_put_cstr(&s, ", error=");
215 json_to_ds(msg->error, 0, &s);
218 ds_put_cstr(&s, ", id=");
219 json_to_ds(msg->id, 0, &s);
221 VLOG_DBG("%s: %s %s%s", rpc->name, title,
222 jsonrpc_msg_type_to_string(msg->type), ds_cstr(&s));
227 /* Schedules 'msg' to be sent on 'rpc' and returns 'rpc''s status (as with
228 * jsonrpc_get_status()).
230 * If 'msg' cannot be sent immediately, it is appended to a buffer. The caller
231 * is responsible for ensuring that the amount of buffered data is somehow
232 * limited. (jsonrpc_get_backlog() returns the amount of data currently
233 * buffered in 'rpc'.)
235 * Always takes ownership of 'msg', regardless of success. */
237 jsonrpc_send(struct jsonrpc *rpc, struct jsonrpc_msg *msg)
245 jsonrpc_msg_destroy(msg);
249 jsonrpc_log_msg(rpc, "send", msg);
251 json = jsonrpc_msg_to_json(msg);
252 s = json_to_string(json, 0);
256 buf = xmalloc(sizeof *buf);
257 ofpbuf_use(buf, s, length);
258 ofpbuf_set_size(buf, length);
259 list_push_back(&rpc->output, &buf->list_node);
260 rpc->backlog += length;
262 if (rpc->backlog == length) {
268 /* Attempts to receive a message from 'rpc'.
270 * If successful, stores the received message in '*msgp' and returns 0. The
271 * caller takes ownership of '*msgp' and must eventually destroy it with
272 * jsonrpc_msg_destroy().
274 * Otherwise, stores NULL in '*msgp' and returns one of the following:
276 * - EAGAIN: No message has been received.
278 * - EOF: The remote end closed the connection gracefully.
280 * - Otherwise an errno value that represents a JSON-RPC protocol violation
281 * or another error fatal to the connection. 'rpc' will not send or
282 * receive any more messages.
285 jsonrpc_recv(struct jsonrpc *rpc, struct jsonrpc_msg **msgp)
294 for (i = 0; i < 50; i++) {
297 /* Fill our input buffer if it's empty. */
298 if (byteq_is_empty(&rpc->input)) {
302 chunk = byteq_headroom(&rpc->input);
303 retval = stream_recv(rpc->stream, byteq_head(&rpc->input), chunk);
305 if (retval == -EAGAIN) {
308 VLOG_WARN_RL(&rl, "%s: receive error: %s",
309 rpc->name, ovs_strerror(-retval));
310 jsonrpc_error(rpc, -retval);
313 } else if (retval == 0) {
314 jsonrpc_error(rpc, EOF);
317 byteq_advance_head(&rpc->input, retval);
320 /* We have some input. Feed it into the JSON parser. */
322 rpc->parser = json_parser_create(0);
324 n = byteq_tailroom(&rpc->input);
325 used = json_parser_feed(rpc->parser,
326 (char *) byteq_tail(&rpc->input), n);
327 byteq_advance_tail(&rpc->input, used);
329 /* If we have complete JSON, attempt to parse it as JSON-RPC. */
330 if (json_parser_is_done(rpc->parser)) {
331 *msgp = jsonrpc_parse_received_message(rpc);
337 const struct byteq *q = &rpc->input;
338 if (q->head <= q->size) {
339 stream_report_content(q->buffer, q->head, STREAM_JSONRPC,
340 THIS_MODULE, rpc->name);
350 /* Causes the poll loop to wake up when jsonrpc_recv() may return a value other
353 jsonrpc_recv_wait(struct jsonrpc *rpc)
355 if (rpc->status || !byteq_is_empty(&rpc->input)) {
356 poll_immediate_wake_at(rpc->name);
358 stream_recv_wait(rpc->stream);
362 /* Sends 'msg' on 'rpc' and waits for it to be successfully queued to the
363 * underlying stream. Returns 0 if 'msg' was sent successfully, otherwise a
364 * status value (see jsonrpc_get_status()).
366 * Always takes ownership of 'msg', regardless of success. */
368 jsonrpc_send_block(struct jsonrpc *rpc, struct jsonrpc_msg *msg)
374 error = jsonrpc_send(rpc, msg);
381 if (list_is_empty(&rpc->output) || rpc->status) {
389 /* Waits for a message to be received on 'rpc'. Same semantics as
390 * jsonrpc_recv() except that EAGAIN will never be returned. */
392 jsonrpc_recv_block(struct jsonrpc *rpc, struct jsonrpc_msg **msgp)
395 int error = jsonrpc_recv(rpc, msgp);
396 if (error != EAGAIN) {
403 jsonrpc_recv_wait(rpc);
408 /* Sends 'request' to 'rpc' then waits for a reply. The return value is 0 if
409 * successful, in which case '*replyp' is set to the reply, which the caller
410 * must eventually free with jsonrpc_msg_destroy(). Otherwise returns a status
411 * value (see jsonrpc_get_status()).
413 * Discards any message received on 'rpc' that is not a reply to 'request'
414 * (based on message id).
416 * Always takes ownership of 'request', regardless of success. */
418 jsonrpc_transact_block(struct jsonrpc *rpc, struct jsonrpc_msg *request,
419 struct jsonrpc_msg **replyp)
421 struct jsonrpc_msg *reply = NULL;
425 id = json_clone(request->id);
426 error = jsonrpc_send_block(rpc, request);
429 error = jsonrpc_recv_block(rpc, &reply);
433 if ((reply->type == JSONRPC_REPLY || reply->type == JSONRPC_ERROR)
434 && json_equal(id, reply->id)) {
437 jsonrpc_msg_destroy(reply);
440 *replyp = error ? NULL : reply;
445 /* Attempts to parse the content of 'rpc->parser' (which is complete JSON) as a
446 * JSON-RPC message. If successful, returns the JSON-RPC message. On failure,
447 * signals an error on 'rpc' with jsonrpc_error() and returns NULL. */
448 static struct jsonrpc_msg *
449 jsonrpc_parse_received_message(struct jsonrpc *rpc)
451 struct jsonrpc_msg *msg;
455 json = json_parser_finish(rpc->parser);
457 if (json->type == JSON_STRING) {
458 VLOG_WARN_RL(&rl, "%s: error parsing stream: %s",
459 rpc->name, json_string(json));
460 jsonrpc_error(rpc, EPROTO);
465 error = jsonrpc_msg_from_json(json, &msg);
467 VLOG_WARN_RL(&rl, "%s: received bad JSON-RPC message: %s",
470 jsonrpc_error(rpc, EPROTO);
474 jsonrpc_log_msg(rpc, "received", msg);
479 jsonrpc_error(struct jsonrpc *rpc, int error)
484 jsonrpc_cleanup(rpc);
489 jsonrpc_cleanup(struct jsonrpc *rpc)
491 stream_close(rpc->stream);
494 json_parser_abort(rpc->parser);
497 ofpbuf_list_delete(&rpc->output);
501 static struct jsonrpc_msg *
502 jsonrpc_create(enum jsonrpc_msg_type type, const char *method,
503 struct json *params, struct json *result, struct json *error,
506 struct jsonrpc_msg *msg = xmalloc(sizeof *msg);
508 msg->method = method ? xstrdup(method) : NULL;
509 msg->params = params;
510 msg->result = result;
517 jsonrpc_create_id(void)
519 static atomic_uint next_id = ATOMIC_VAR_INIT(0);
522 atomic_add(&next_id, 1, &id);
523 return json_integer_create(id);
527 jsonrpc_create_request(const char *method, struct json *params,
530 struct json *id = jsonrpc_create_id();
532 *idp = json_clone(id);
534 return jsonrpc_create(JSONRPC_REQUEST, method, params, NULL, NULL, id);
538 jsonrpc_create_notify(const char *method, struct json *params)
540 return jsonrpc_create(JSONRPC_NOTIFY, method, params, NULL, NULL, NULL);
544 jsonrpc_create_reply(struct json *result, const struct json *id)
546 return jsonrpc_create(JSONRPC_REPLY, NULL, NULL, result, NULL,
551 jsonrpc_create_error(struct json *error, const struct json *id)
553 return jsonrpc_create(JSONRPC_REPLY, NULL, NULL, NULL, error,
558 jsonrpc_msg_type_to_string(enum jsonrpc_msg_type type)
561 case JSONRPC_REQUEST:
565 return "notification";
577 jsonrpc_msg_is_valid(const struct jsonrpc_msg *m)
579 const char *type_name;
580 unsigned int pattern;
582 if (m->params && m->params->type != JSON_ARRAY) {
583 return xstrdup("\"params\" must be JSON array");
587 case JSONRPC_REQUEST:
604 return xasprintf("invalid JSON-RPC message type %d", m->type);
607 type_name = jsonrpc_msg_type_to_string(m->type);
608 if ((m->method != NULL) != ((pattern & 0x10000) != 0)) {
609 return xasprintf("%s must%s have \"method\"",
610 type_name, (pattern & 0x10000) ? "" : " not");
613 if ((m->params != NULL) != ((pattern & 0x1000) != 0)) {
614 return xasprintf("%s must%s have \"params\"",
615 type_name, (pattern & 0x1000) ? "" : " not");
618 if ((m->result != NULL) != ((pattern & 0x100) != 0)) {
619 return xasprintf("%s must%s have \"result\"",
620 type_name, (pattern & 0x100) ? "" : " not");
623 if ((m->error != NULL) != ((pattern & 0x10) != 0)) {
624 return xasprintf("%s must%s have \"error\"",
625 type_name, (pattern & 0x10) ? "" : " not");
628 if ((m->id != NULL) != ((pattern & 0x1) != 0)) {
629 return xasprintf("%s must%s have \"id\"",
630 type_name, (pattern & 0x1) ? "" : " not");
637 jsonrpc_msg_destroy(struct jsonrpc_msg *m)
641 json_destroy(m->params);
642 json_destroy(m->result);
643 json_destroy(m->error);
650 null_from_json_null(struct json *json)
652 if (json && json->type == JSON_NULL) {
660 jsonrpc_msg_from_json(struct json *json, struct jsonrpc_msg **msgp)
662 struct json *method = NULL;
663 struct jsonrpc_msg *msg = NULL;
664 struct shash *object;
667 if (json->type != JSON_OBJECT) {
668 error = xstrdup("message is not a JSON object");
671 object = json_object(json);
673 method = shash_find_and_delete(object, "method");
674 if (method && method->type != JSON_STRING) {
675 error = xstrdup("method is not a JSON string");
679 msg = xzalloc(sizeof *msg);
680 msg->method = method ? xstrdup(method->u.string) : NULL;
681 msg->params = null_from_json_null(shash_find_and_delete(object, "params"));
682 msg->result = null_from_json_null(shash_find_and_delete(object, "result"));
683 msg->error = null_from_json_null(shash_find_and_delete(object, "error"));
684 msg->id = null_from_json_null(shash_find_and_delete(object, "id"));
685 msg->type = (msg->result ? JSONRPC_REPLY
686 : msg->error ? JSONRPC_ERROR
687 : msg->id ? JSONRPC_REQUEST
689 if (!shash_is_empty(object)) {
690 error = xasprintf("message has unexpected member \"%s\"",
691 shash_first(object)->name);
694 error = jsonrpc_msg_is_valid(msg);
700 json_destroy(method);
703 jsonrpc_msg_destroy(msg);
711 jsonrpc_msg_to_json(struct jsonrpc_msg *m)
713 struct json *json = json_object_create();
716 json_object_put(json, "method", json_string_create_nocopy(m->method));
720 json_object_put(json, "params", m->params);
724 json_object_put(json, "result", m->result);
725 } else if (m->type == JSONRPC_ERROR) {
726 json_object_put(json, "result", json_null_create());
730 json_object_put(json, "error", m->error);
731 } else if (m->type == JSONRPC_REPLY) {
732 json_object_put(json, "error", json_null_create());
736 json_object_put(json, "id", m->id);
737 } else if (m->type == JSONRPC_NOTIFY) {
738 json_object_put(json, "id", json_null_create());
746 /* A JSON-RPC session with reconnection. */
748 struct jsonrpc_session {
749 struct reconnect *reconnect;
751 struct stream *stream;
752 struct pstream *pstream;
758 /* Creates and returns a jsonrpc_session to 'name', which should be a string
759 * acceptable to stream_open() or pstream_open().
761 * If 'name' is an active connection method, e.g. "tcp:127.1.2.3", the new
762 * jsonrpc_session connects to 'name'. If 'retry' is true, then the new
763 * session connects and reconnects to 'name', with backoff. If 'retry' is
764 * false, the new session will only try to connect once and after a connection
765 * failure or a disconnection jsonrpc_session_is_alive() will return false for
768 * If 'name' is a passive connection method, e.g. "ptcp:", the new
769 * jsonrpc_session listens for connections to 'name'. It maintains at most one
770 * connection at any given time. Any new connection causes the previous one
771 * (if any) to be dropped. */
772 struct jsonrpc_session *
773 jsonrpc_session_open(const char *name, bool retry)
775 struct jsonrpc_session *s;
777 s = xmalloc(sizeof *s);
778 s->reconnect = reconnect_create(time_msec());
779 reconnect_set_name(s->reconnect, name);
780 reconnect_enable(s->reconnect, time_msec());
788 if (!pstream_verify_name(name)) {
789 reconnect_set_passive(s->reconnect, true, time_msec());
791 reconnect_set_max_tries(s->reconnect, 1);
792 reconnect_set_backoff(s->reconnect, INT_MAX, INT_MAX);
795 if (!stream_or_pstream_needs_probes(name)) {
796 reconnect_set_probe_interval(s->reconnect, 0);
802 /* Creates and returns a jsonrpc_session that is initially connected to
803 * 'jsonrpc'. If the connection is dropped, it will not be reconnected.
805 * On the assumption that such connections are likely to be short-lived
806 * (e.g. from ovs-vsctl), informational logging for them is suppressed. */
807 struct jsonrpc_session *
808 jsonrpc_session_open_unreliably(struct jsonrpc *jsonrpc, uint8_t dscp)
810 struct jsonrpc_session *s;
812 s = xmalloc(sizeof *s);
813 s->reconnect = reconnect_create(time_msec());
814 reconnect_set_quiet(s->reconnect, true);
815 reconnect_set_name(s->reconnect, jsonrpc_get_name(jsonrpc));
816 reconnect_set_max_tries(s->reconnect, 0);
817 reconnect_connected(s->reconnect, time_msec());
828 jsonrpc_session_close(struct jsonrpc_session *s)
831 jsonrpc_close(s->rpc);
832 reconnect_destroy(s->reconnect);
833 stream_close(s->stream);
834 pstream_close(s->pstream);
840 jsonrpc_session_disconnect(struct jsonrpc_session *s)
843 jsonrpc_error(s->rpc, EOF);
844 jsonrpc_close(s->rpc);
847 } else if (s->stream) {
848 stream_close(s->stream);
855 jsonrpc_session_connect(struct jsonrpc_session *s)
857 const char *name = reconnect_get_name(s->reconnect);
860 jsonrpc_session_disconnect(s);
861 if (!reconnect_is_passive(s->reconnect)) {
862 error = jsonrpc_stream_open(name, &s->stream, s->dscp);
864 reconnect_connecting(s->reconnect, time_msec());
866 s->last_error = error;
869 error = s->pstream ? 0 : jsonrpc_pstream_open(name, &s->pstream,
872 reconnect_listening(s->reconnect, time_msec());
877 reconnect_connect_failed(s->reconnect, time_msec(), error);
883 jsonrpc_session_run(struct jsonrpc_session *s)
886 struct stream *stream;
889 error = pstream_accept(s->pstream, &stream);
891 if (s->rpc || s->stream) {
893 "%s: new connection replacing active connection",
894 reconnect_get_name(s->reconnect));
895 jsonrpc_session_disconnect(s);
897 reconnect_connected(s->reconnect, time_msec());
898 s->rpc = jsonrpc_open(stream);
899 } else if (error != EAGAIN) {
900 reconnect_listen_error(s->reconnect, time_msec(), error);
901 pstream_close(s->pstream);
910 backlog = jsonrpc_get_backlog(s->rpc);
912 if (jsonrpc_get_backlog(s->rpc) < backlog) {
913 /* Data previously caught in a queue was successfully sent (or
914 * there's an error, which we'll catch below.)
916 * We don't count data that is successfully sent immediately as
917 * activity, because there's a lot of queuing downstream from us,
918 * which means that we can push a lot of data into a connection
919 * that has stalled and won't ever recover.
921 reconnect_activity(s->reconnect, time_msec());
924 error = jsonrpc_get_status(s->rpc);
926 reconnect_disconnected(s->reconnect, time_msec(), error);
927 jsonrpc_session_disconnect(s);
928 s->last_error = error;
930 } else if (s->stream) {
933 stream_run(s->stream);
934 error = stream_connect(s->stream);
936 reconnect_connected(s->reconnect, time_msec());
937 s->rpc = jsonrpc_open(s->stream);
939 } else if (error != EAGAIN) {
940 reconnect_connect_failed(s->reconnect, time_msec(), error);
941 stream_close(s->stream);
946 switch (reconnect_run(s->reconnect, time_msec())) {
947 case RECONNECT_CONNECT:
948 jsonrpc_session_connect(s);
951 case RECONNECT_DISCONNECT:
952 reconnect_disconnected(s->reconnect, time_msec(), 0);
953 jsonrpc_session_disconnect(s);
956 case RECONNECT_PROBE:
959 struct jsonrpc_msg *request;
961 params = json_array_create_empty();
962 request = jsonrpc_create_request("echo", params, NULL);
963 json_destroy(request->id);
964 request->id = json_string_create("echo");
965 jsonrpc_send(s->rpc, request);
972 jsonrpc_session_wait(struct jsonrpc_session *s)
975 jsonrpc_wait(s->rpc);
976 } else if (s->stream) {
977 stream_run_wait(s->stream);
978 stream_connect_wait(s->stream);
981 pstream_wait(s->pstream);
983 reconnect_wait(s->reconnect, time_msec());
987 jsonrpc_session_get_backlog(const struct jsonrpc_session *s)
989 return s->rpc ? jsonrpc_get_backlog(s->rpc) : 0;
992 /* Always returns a pointer to a valid C string, assuming 's' was initialized
995 jsonrpc_session_get_name(const struct jsonrpc_session *s)
997 return reconnect_get_name(s->reconnect);
1000 /* Always takes ownership of 'msg', regardless of success. */
1002 jsonrpc_session_send(struct jsonrpc_session *s, struct jsonrpc_msg *msg)
1005 return jsonrpc_send(s->rpc, msg);
1007 jsonrpc_msg_destroy(msg);
1012 struct jsonrpc_msg *
1013 jsonrpc_session_recv(struct jsonrpc_session *s)
1016 unsigned int received_bytes;
1017 struct jsonrpc_msg *msg;
1019 received_bytes = jsonrpc_get_received_bytes(s->rpc);
1020 jsonrpc_recv(s->rpc, &msg);
1021 if (received_bytes != jsonrpc_get_received_bytes(s->rpc)) {
1022 /* Data was successfully received.
1024 * Previously we only counted receiving a full message as activity,
1025 * but with large messages or a slow connection that policy could
1026 * time out the session mid-message. */
1027 reconnect_activity(s->reconnect, time_msec());
1031 if (msg->type == JSONRPC_REQUEST && !strcmp(msg->method, "echo")) {
1032 /* Echo request. Send reply. */
1033 struct jsonrpc_msg *reply;
1035 reply = jsonrpc_create_reply(json_clone(msg->params), msg->id);
1036 jsonrpc_session_send(s, reply);
1037 } else if (msg->type == JSONRPC_REPLY
1038 && msg->id && msg->id->type == JSON_STRING
1039 && !strcmp(msg->id->u.string, "echo")) {
1040 /* It's a reply to our echo request. Suppress it. */
1044 jsonrpc_msg_destroy(msg);
1051 jsonrpc_session_recv_wait(struct jsonrpc_session *s)
1054 jsonrpc_recv_wait(s->rpc);
1059 jsonrpc_session_is_alive(const struct jsonrpc_session *s)
1061 return s->rpc || s->stream || reconnect_get_max_tries(s->reconnect);
1065 jsonrpc_session_is_connected(const struct jsonrpc_session *s)
1067 return s->rpc != NULL;
1071 jsonrpc_session_get_seqno(const struct jsonrpc_session *s)
1077 jsonrpc_session_get_status(const struct jsonrpc_session *s)
1079 return s && s->rpc ? jsonrpc_get_status(s->rpc) : 0;
1083 jsonrpc_session_get_last_error(const struct jsonrpc_session *s)
1085 return s->last_error;
1089 jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session *s,
1090 struct reconnect_stats *stats)
1092 reconnect_get_stats(s->reconnect, time_msec(), stats);
1096 jsonrpc_session_enable_reconnect(struct jsonrpc_session *s)
1098 reconnect_set_max_tries(s->reconnect, UINT_MAX);
1099 reconnect_set_backoff(s->reconnect, RECONNECT_DEFAULT_MIN_BACKOFF,
1100 RECONNECT_DEFAULT_MAX_BACKOFF);
1104 jsonrpc_session_force_reconnect(struct jsonrpc_session *s)
1106 reconnect_force_reconnect(s->reconnect, time_msec());
1110 jsonrpc_session_set_max_backoff(struct jsonrpc_session *s, int max_backoff)
1112 reconnect_set_backoff(s->reconnect, 0, max_backoff);
1116 jsonrpc_session_set_probe_interval(struct jsonrpc_session *s,
1119 reconnect_set_probe_interval(s->reconnect, probe_interval);
1123 jsonrpc_session_set_dscp(struct jsonrpc_session *s,
1126 if (s->dscp != dscp) {
1130 error = pstream_set_dscp(s->pstream, dscp);
1132 VLOG_ERR("%s: failed set_dscp %s",
1133 reconnect_get_name(s->reconnect),
1134 ovs_strerror(error));
1137 * XXX race window between setting dscp to listening socket
1138 * and accepting socket. accepted socket may have old dscp value.
1139 * Ignore this race window for now.
1143 jsonrpc_session_force_reconnect(s);