]>
git.proxmox.com Git - ovs.git/blob - lib/jsonrpc.c
2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 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 "poll-loop.h"
30 #include "reconnect.h"
35 VLOG_DEFINE_THIS_MODULE(jsonrpc
);
38 struct stream
*stream
;
44 uint8_t input_buffer
[512];
45 struct json_parser
*parser
;
46 struct jsonrpc_msg
*received
;
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 void jsonrpc_received(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 ports if none is specified. */
63 jsonrpc_stream_open(const char *name
, struct stream
**streamp
, uint8_t dscp
)
65 return stream_open_with_default_ports(name
, JSONRPC_TCP_PORT
,
66 JSONRPC_SSL_PORT
, streamp
,
70 /* This is just the same as pstream_open() except that it uses the default
71 * JSONRPC ports if none is specified. */
73 jsonrpc_pstream_open(const char *name
, struct pstream
**pstreamp
, uint8_t dscp
)
75 return pstream_open_with_default_ports(name
, JSONRPC_TCP_PORT
,
76 JSONRPC_SSL_PORT
, pstreamp
, dscp
);
79 /* Returns a new JSON-RPC stream that uses 'stream' for input and output. The
80 * new jsonrpc object takes ownership of 'stream'. */
82 jsonrpc_open(struct stream
*stream
)
86 ovs_assert(stream
!= NULL
);
88 rpc
= xzalloc(sizeof *rpc
);
89 rpc
->name
= xstrdup(stream_get_name(stream
));
91 byteq_init(&rpc
->input
, rpc
->input_buffer
, sizeof rpc
->input_buffer
);
92 list_init(&rpc
->output
);
97 /* Destroys 'rpc', closing the stream on which it is based, and frees its
100 jsonrpc_close(struct jsonrpc
*rpc
)
103 jsonrpc_cleanup(rpc
);
109 /* Performs periodic maintenance on 'rpc', such as flushing output buffers. */
111 jsonrpc_run(struct jsonrpc
*rpc
)
117 stream_run(rpc
->stream
);
118 while (!list_is_empty(&rpc
->output
)) {
119 struct ofpbuf
*buf
= ofpbuf_from_list(rpc
->output
.next
);
122 retval
= stream_send(rpc
->stream
, buf
->data
, buf
->size
);
124 rpc
->backlog
-= retval
;
125 ofpbuf_pull(buf
, retval
);
127 list_remove(&buf
->list_node
);
131 if (retval
!= -EAGAIN
) {
132 VLOG_WARN_RL(&rl
, "%s: send error: %s",
133 rpc
->name
, ovs_strerror(-retval
));
134 jsonrpc_error(rpc
, -retval
);
141 /* Arranges for the poll loop to wake up when 'rpc' needs to perform
142 * maintenance activities. */
144 jsonrpc_wait(struct jsonrpc
*rpc
)
147 stream_run_wait(rpc
->stream
);
148 if (!list_is_empty(&rpc
->output
)) {
149 stream_send_wait(rpc
->stream
);
155 * Returns the current status of 'rpc'. The possible return values are:
158 * - EOF: end of file (remote end closed connection; not necessarily an error).
160 * When this functions nonzero, 'rpc' is effectively out of commission. 'rpc'
161 * will not receive any more messages and any further messages that one
162 * attempts to send with 'rpc' will be discarded. The caller can keep 'rpc'
163 * around as long as it wants, but it's not going to provide any more useful
167 jsonrpc_get_status(const struct jsonrpc
*rpc
)
172 /* Returns the number of bytes buffered by 'rpc' to be written to the
173 * underlying stream. Always returns 0 if 'rpc' has encountered an error or if
174 * the remote end closed the connection. */
176 jsonrpc_get_backlog(const struct jsonrpc
*rpc
)
178 return rpc
->status
? 0 : rpc
->backlog
;
181 /* Returns the number of bytes that have been received on 'rpc''s underlying
182 * stream. (The value wraps around if it exceeds UINT_MAX.) */
184 jsonrpc_get_received_bytes(const struct jsonrpc
*rpc
)
186 return rpc
->input
.head
;
189 /* Returns 'rpc''s name, that is, the name returned by stream_get_name() for
190 * the stream underlying 'rpc' when 'rpc' was created. */
192 jsonrpc_get_name(const struct jsonrpc
*rpc
)
198 jsonrpc_log_msg(const struct jsonrpc
*rpc
, const char *title
,
199 const struct jsonrpc_msg
*msg
)
201 if (VLOG_IS_DBG_ENABLED()) {
202 struct ds s
= DS_EMPTY_INITIALIZER
;
204 ds_put_format(&s
, ", method=\"%s\"", msg
->method
);
207 ds_put_cstr(&s
, ", params=");
208 json_to_ds(msg
->params
, 0, &s
);
211 ds_put_cstr(&s
, ", result=");
212 json_to_ds(msg
->result
, 0, &s
);
215 ds_put_cstr(&s
, ", error=");
216 json_to_ds(msg
->error
, 0, &s
);
219 ds_put_cstr(&s
, ", id=");
220 json_to_ds(msg
->id
, 0, &s
);
222 VLOG_DBG("%s: %s %s%s", rpc
->name
, title
,
223 jsonrpc_msg_type_to_string(msg
->type
), ds_cstr(&s
));
228 /* Schedules 'msg' to be sent on 'rpc' and returns 'rpc''s status (as with
229 * jsonrpc_get_status()).
231 * If 'msg' cannot be sent immediately, it is appended to a buffer. The caller
232 * is responsible for ensuring that the amount of buffered data is somehow
233 * limited. (jsonrpc_get_backlog() returns the amount of data currently
234 * buffered in 'rpc'.)
236 * Always takes ownership of 'msg', regardless of success. */
238 jsonrpc_send(struct jsonrpc
*rpc
, struct jsonrpc_msg
*msg
)
246 jsonrpc_msg_destroy(msg
);
250 jsonrpc_log_msg(rpc
, "send", msg
);
252 json
= jsonrpc_msg_to_json(msg
);
253 s
= json_to_string(json
, 0);
257 buf
= xmalloc(sizeof *buf
);
258 ofpbuf_use(buf
, s
, length
);
260 list_push_back(&rpc
->output
, &buf
->list_node
);
261 rpc
->backlog
+= length
;
263 if (rpc
->backlog
== length
) {
269 /* Attempts to receive a message from 'rpc'.
271 * If successful, stores the received message in '*msgp' and returns 0. The
272 * caller takes ownership of '*msgp' and must eventually destroy it with
273 * jsonrpc_msg_destroy().
275 * Otherwise, stores NULL in '*msgp' and returns one of the following:
277 * - EAGAIN: No message has been received.
279 * - EOF: The remote end closed the connection gracefully.
281 * - Otherwise an errno value that represents a JSON-RPC protocol violation
282 * or another error fatal to the connection. 'rpc' will not send or
283 * receive any more messages.
286 jsonrpc_recv(struct jsonrpc
*rpc
, struct jsonrpc_msg
**msgp
)
295 for (i
= 0; i
< 50; i
++) {
297 *msgp
= rpc
->received
;
298 rpc
->received
= NULL
;
300 } else if (byteq_is_empty(&rpc
->input
)) {
304 chunk
= byteq_headroom(&rpc
->input
);
305 retval
= stream_recv(rpc
->stream
, byteq_head(&rpc
->input
), chunk
);
307 if (retval
== -EAGAIN
) {
310 VLOG_WARN_RL(&rl
, "%s: receive error: %s",
311 rpc
->name
, ovs_strerror(-retval
));
312 jsonrpc_error(rpc
, -retval
);
315 } else if (retval
== 0) {
316 jsonrpc_error(rpc
, EOF
);
319 byteq_advance_head(&rpc
->input
, retval
);
324 rpc
->parser
= json_parser_create(0);
326 n
= byteq_tailroom(&rpc
->input
);
327 used
= json_parser_feed(rpc
->parser
,
328 (char *) byteq_tail(&rpc
->input
), n
);
329 byteq_advance_tail(&rpc
->input
, used
);
330 if (json_parser_is_done(rpc
->parser
)) {
331 jsonrpc_received(rpc
);
333 const struct byteq
*q
= &rpc
->input
;
334 if (q
->head
<= q
->size
) {
335 stream_report_content(q
->buffer
, q
->head
,
337 THIS_MODULE
, rpc
->name
);
348 /* Causes the poll loop to wake up when jsonrpc_recv() may return a value other
351 jsonrpc_recv_wait(struct jsonrpc
*rpc
)
353 if (rpc
->status
|| rpc
->received
|| !byteq_is_empty(&rpc
->input
)) {
354 (poll_immediate_wake
)(rpc
->name
);
356 stream_recv_wait(rpc
->stream
);
360 /* Sends 'msg' on 'rpc' and waits for it to be successfully queued to the
361 * underlying stream. Returns 0 if 'msg' was sent successfully, otherwise a
362 * status value (see jsonrpc_get_status()).
364 * Always takes ownership of 'msg', regardless of success. */
366 jsonrpc_send_block(struct jsonrpc
*rpc
, struct jsonrpc_msg
*msg
)
372 error
= jsonrpc_send(rpc
, msg
);
379 if (list_is_empty(&rpc
->output
) || rpc
->status
) {
387 /* Waits for a message to be received on 'rpc'. Same semantics as
388 * jsonrpc_recv() except that EAGAIN will never be returned. */
390 jsonrpc_recv_block(struct jsonrpc
*rpc
, struct jsonrpc_msg
**msgp
)
393 int error
= jsonrpc_recv(rpc
, msgp
);
394 if (error
!= EAGAIN
) {
401 jsonrpc_recv_wait(rpc
);
406 /* Sends 'request' to 'rpc' then waits for a reply. The return value is 0 if
407 * successful, in which case '*replyp' is set to the reply, which the caller
408 * must eventually free with jsonrpc_msg_destroy(). Otherwise returns a status
409 * value (see jsonrpc_get_status()).
411 * Discards any message received on 'rpc' that is not a reply to 'request'
412 * (based on message id).
414 * Always takes ownership of 'request', regardless of success. */
416 jsonrpc_transact_block(struct jsonrpc
*rpc
, struct jsonrpc_msg
*request
,
417 struct jsonrpc_msg
**replyp
)
419 struct jsonrpc_msg
*reply
= NULL
;
423 id
= json_clone(request
->id
);
424 error
= jsonrpc_send_block(rpc
, request
);
427 error
= jsonrpc_recv_block(rpc
, &reply
);
431 if ((reply
->type
== JSONRPC_REPLY
|| reply
->type
== JSONRPC_ERROR
)
432 && json_equal(id
, reply
->id
)) {
435 jsonrpc_msg_destroy(reply
);
438 *replyp
= error
? NULL
: reply
;
444 jsonrpc_received(struct jsonrpc
*rpc
)
446 struct jsonrpc_msg
*msg
;
450 json
= json_parser_finish(rpc
->parser
);
452 if (json
->type
== JSON_STRING
) {
453 VLOG_WARN_RL(&rl
, "%s: error parsing stream: %s",
454 rpc
->name
, json_string(json
));
455 jsonrpc_error(rpc
, EPROTO
);
460 error
= jsonrpc_msg_from_json(json
, &msg
);
462 VLOG_WARN_RL(&rl
, "%s: received bad JSON-RPC message: %s",
465 jsonrpc_error(rpc
, EPROTO
);
469 jsonrpc_log_msg(rpc
, "received", msg
);
474 jsonrpc_error(struct jsonrpc
*rpc
, int error
)
479 jsonrpc_cleanup(rpc
);
484 jsonrpc_cleanup(struct jsonrpc
*rpc
)
486 stream_close(rpc
->stream
);
489 json_parser_abort(rpc
->parser
);
492 jsonrpc_msg_destroy(rpc
->received
);
493 rpc
->received
= NULL
;
495 ofpbuf_list_delete(&rpc
->output
);
499 static struct jsonrpc_msg
*
500 jsonrpc_create(enum jsonrpc_msg_type type
, const char *method
,
501 struct json
*params
, struct json
*result
, struct json
*error
,
504 struct jsonrpc_msg
*msg
= xmalloc(sizeof *msg
);
506 msg
->method
= method
? xstrdup(method
) : NULL
;
507 msg
->params
= params
;
508 msg
->result
= result
;
515 jsonrpc_create_id(void)
517 static unsigned int id
;
518 return json_integer_create(id
++);
522 jsonrpc_create_request(const char *method
, struct json
*params
,
525 struct json
*id
= jsonrpc_create_id();
527 *idp
= json_clone(id
);
529 return jsonrpc_create(JSONRPC_REQUEST
, method
, params
, NULL
, NULL
, id
);
533 jsonrpc_create_notify(const char *method
, struct json
*params
)
535 return jsonrpc_create(JSONRPC_NOTIFY
, method
, params
, NULL
, NULL
, NULL
);
539 jsonrpc_create_reply(struct json
*result
, const struct json
*id
)
541 return jsonrpc_create(JSONRPC_REPLY
, NULL
, NULL
, result
, NULL
,
546 jsonrpc_create_error(struct json
*error
, const struct json
*id
)
548 return jsonrpc_create(JSONRPC_REPLY
, NULL
, NULL
, NULL
, error
,
553 jsonrpc_msg_type_to_string(enum jsonrpc_msg_type type
)
556 case JSONRPC_REQUEST
:
560 return "notification";
572 jsonrpc_msg_is_valid(const struct jsonrpc_msg
*m
)
574 const char *type_name
;
575 unsigned int pattern
;
577 if (m
->params
&& m
->params
->type
!= JSON_ARRAY
) {
578 return xstrdup("\"params\" must be JSON array");
582 case JSONRPC_REQUEST
:
599 return xasprintf("invalid JSON-RPC message type %d", m
->type
);
602 type_name
= jsonrpc_msg_type_to_string(m
->type
);
603 if ((m
->method
!= NULL
) != ((pattern
& 0x10000) != 0)) {
604 return xasprintf("%s must%s have \"method\"",
605 type_name
, (pattern
& 0x10000) ? "" : " not");
608 if ((m
->params
!= NULL
) != ((pattern
& 0x1000) != 0)) {
609 return xasprintf("%s must%s have \"params\"",
610 type_name
, (pattern
& 0x1000) ? "" : " not");
613 if ((m
->result
!= NULL
) != ((pattern
& 0x100) != 0)) {
614 return xasprintf("%s must%s have \"result\"",
615 type_name
, (pattern
& 0x100) ? "" : " not");
618 if ((m
->error
!= NULL
) != ((pattern
& 0x10) != 0)) {
619 return xasprintf("%s must%s have \"error\"",
620 type_name
, (pattern
& 0x10) ? "" : " not");
623 if ((m
->id
!= NULL
) != ((pattern
& 0x1) != 0)) {
624 return xasprintf("%s must%s have \"id\"",
625 type_name
, (pattern
& 0x1) ? "" : " not");
632 jsonrpc_msg_destroy(struct jsonrpc_msg
*m
)
636 json_destroy(m
->params
);
637 json_destroy(m
->result
);
638 json_destroy(m
->error
);
645 null_from_json_null(struct json
*json
)
647 if (json
&& json
->type
== JSON_NULL
) {
655 jsonrpc_msg_from_json(struct json
*json
, struct jsonrpc_msg
**msgp
)
657 struct json
*method
= NULL
;
658 struct jsonrpc_msg
*msg
= NULL
;
659 struct shash
*object
;
662 if (json
->type
!= JSON_OBJECT
) {
663 error
= xstrdup("message is not a JSON object");
666 object
= json_object(json
);
668 method
= shash_find_and_delete(object
, "method");
669 if (method
&& method
->type
!= JSON_STRING
) {
670 error
= xstrdup("method is not a JSON string");
674 msg
= xzalloc(sizeof *msg
);
675 msg
->method
= method
? xstrdup(method
->u
.string
) : NULL
;
676 msg
->params
= null_from_json_null(shash_find_and_delete(object
, "params"));
677 msg
->result
= null_from_json_null(shash_find_and_delete(object
, "result"));
678 msg
->error
= null_from_json_null(shash_find_and_delete(object
, "error"));
679 msg
->id
= null_from_json_null(shash_find_and_delete(object
, "id"));
680 msg
->type
= (msg
->result
? JSONRPC_REPLY
681 : msg
->error
? JSONRPC_ERROR
682 : msg
->id
? JSONRPC_REQUEST
684 if (!shash_is_empty(object
)) {
685 error
= xasprintf("message has unexpected member \"%s\"",
686 shash_first(object
)->name
);
689 error
= jsonrpc_msg_is_valid(msg
);
695 json_destroy(method
);
698 jsonrpc_msg_destroy(msg
);
706 jsonrpc_msg_to_json(struct jsonrpc_msg
*m
)
708 struct json
*json
= json_object_create();
711 json_object_put(json
, "method", json_string_create_nocopy(m
->method
));
715 json_object_put(json
, "params", m
->params
);
719 json_object_put(json
, "result", m
->result
);
720 } else if (m
->type
== JSONRPC_ERROR
) {
721 json_object_put(json
, "result", json_null_create());
725 json_object_put(json
, "error", m
->error
);
726 } else if (m
->type
== JSONRPC_REPLY
) {
727 json_object_put(json
, "error", json_null_create());
731 json_object_put(json
, "id", m
->id
);
732 } else if (m
->type
== JSONRPC_NOTIFY
) {
733 json_object_put(json
, "id", json_null_create());
741 /* A JSON-RPC session with reconnection. */
743 struct jsonrpc_session
{
744 struct reconnect
*reconnect
;
746 struct stream
*stream
;
747 struct pstream
*pstream
;
753 /* Creates and returns a jsonrpc_session to 'name', which should be a string
754 * acceptable to stream_open() or pstream_open().
756 * If 'name' is an active connection method, e.g. "tcp:127.1.2.3", the new
757 * jsonrpc_session connects to 'name'. If 'retry' is true, then the new
758 * session connects and reconnects to 'name', with backoff. If 'retry' is
759 * false, the new session will only try to connect once and after a connection
760 * failure or a disconnection jsonrpc_session_is_alive() will return false for
763 * If 'name' is a passive connection method, e.g. "ptcp:", the new
764 * jsonrpc_session listens for connections to 'name'. It maintains at most one
765 * connection at any given time. Any new connection causes the previous one
766 * (if any) to be dropped. */
767 struct jsonrpc_session
*
768 jsonrpc_session_open(const char *name
, bool retry
)
770 struct jsonrpc_session
*s
;
772 s
= xmalloc(sizeof *s
);
773 s
->reconnect
= reconnect_create(time_msec());
774 reconnect_set_name(s
->reconnect
, name
);
775 reconnect_enable(s
->reconnect
, time_msec());
783 if (!pstream_verify_name(name
)) {
784 reconnect_set_passive(s
->reconnect
, true, time_msec());
786 reconnect_set_max_tries(s
->reconnect
, 1);
787 reconnect_set_backoff(s
->reconnect
, INT_MAX
, INT_MAX
);
790 if (!stream_or_pstream_needs_probes(name
)) {
791 reconnect_set_probe_interval(s
->reconnect
, 0);
797 /* Creates and returns a jsonrpc_session that is initially connected to
798 * 'jsonrpc'. If the connection is dropped, it will not be reconnected.
800 * On the assumption that such connections are likely to be short-lived
801 * (e.g. from ovs-vsctl), informational logging for them is suppressed. */
802 struct jsonrpc_session
*
803 jsonrpc_session_open_unreliably(struct jsonrpc
*jsonrpc
, uint8_t dscp
)
805 struct jsonrpc_session
*s
;
807 s
= xmalloc(sizeof *s
);
808 s
->reconnect
= reconnect_create(time_msec());
809 reconnect_set_quiet(s
->reconnect
, true);
810 reconnect_set_name(s
->reconnect
, jsonrpc_get_name(jsonrpc
));
811 reconnect_set_max_tries(s
->reconnect
, 0);
812 reconnect_connected(s
->reconnect
, time_msec());
823 jsonrpc_session_close(struct jsonrpc_session
*s
)
826 jsonrpc_close(s
->rpc
);
827 reconnect_destroy(s
->reconnect
);
828 stream_close(s
->stream
);
829 pstream_close(s
->pstream
);
835 jsonrpc_session_disconnect(struct jsonrpc_session
*s
)
838 jsonrpc_error(s
->rpc
, EOF
);
839 jsonrpc_close(s
->rpc
);
842 } else if (s
->stream
) {
843 stream_close(s
->stream
);
850 jsonrpc_session_connect(struct jsonrpc_session
*s
)
852 const char *name
= reconnect_get_name(s
->reconnect
);
855 jsonrpc_session_disconnect(s
);
856 if (!reconnect_is_passive(s
->reconnect
)) {
857 error
= jsonrpc_stream_open(name
, &s
->stream
, s
->dscp
);
859 reconnect_connecting(s
->reconnect
, time_msec());
861 s
->last_error
= error
;
864 error
= s
->pstream
? 0 : jsonrpc_pstream_open(name
, &s
->pstream
,
867 reconnect_listening(s
->reconnect
, time_msec());
872 reconnect_connect_failed(s
->reconnect
, time_msec(), error
);
878 jsonrpc_session_run(struct jsonrpc_session
*s
)
881 struct stream
*stream
;
884 error
= pstream_accept(s
->pstream
, &stream
);
886 if (s
->rpc
|| s
->stream
) {
888 "%s: new connection replacing active connection",
889 reconnect_get_name(s
->reconnect
));
890 jsonrpc_session_disconnect(s
);
892 reconnect_connected(s
->reconnect
, time_msec());
893 s
->rpc
= jsonrpc_open(stream
);
894 } else if (error
!= EAGAIN
) {
895 reconnect_listen_error(s
->reconnect
, time_msec(), error
);
896 pstream_close(s
->pstream
);
905 backlog
= jsonrpc_get_backlog(s
->rpc
);
907 if (jsonrpc_get_backlog(s
->rpc
) < backlog
) {
908 /* Data previously caught in a queue was successfully sent (or
909 * there's an error, which we'll catch below.)
911 * We don't count data that is successfully sent immediately as
912 * activity, because there's a lot of queuing downstream from us,
913 * which means that we can push a lot of data into a connection
914 * that has stalled and won't ever recover.
916 reconnect_activity(s
->reconnect
, time_msec());
919 error
= jsonrpc_get_status(s
->rpc
);
921 reconnect_disconnected(s
->reconnect
, time_msec(), error
);
922 jsonrpc_session_disconnect(s
);
923 s
->last_error
= error
;
925 } else if (s
->stream
) {
928 stream_run(s
->stream
);
929 error
= stream_connect(s
->stream
);
931 reconnect_connected(s
->reconnect
, time_msec());
932 s
->rpc
= jsonrpc_open(s
->stream
);
934 } else if (error
!= EAGAIN
) {
935 reconnect_connect_failed(s
->reconnect
, time_msec(), error
);
936 stream_close(s
->stream
);
941 switch (reconnect_run(s
->reconnect
, time_msec())) {
942 case RECONNECT_CONNECT
:
943 jsonrpc_session_connect(s
);
946 case RECONNECT_DISCONNECT
:
947 reconnect_disconnected(s
->reconnect
, time_msec(), 0);
948 jsonrpc_session_disconnect(s
);
951 case RECONNECT_PROBE
:
954 struct jsonrpc_msg
*request
;
956 params
= json_array_create_empty();
957 request
= jsonrpc_create_request("echo", params
, NULL
);
958 json_destroy(request
->id
);
959 request
->id
= json_string_create("echo");
960 jsonrpc_send(s
->rpc
, request
);
967 jsonrpc_session_wait(struct jsonrpc_session
*s
)
970 jsonrpc_wait(s
->rpc
);
971 } else if (s
->stream
) {
972 stream_run_wait(s
->stream
);
973 stream_connect_wait(s
->stream
);
976 pstream_wait(s
->pstream
);
978 reconnect_wait(s
->reconnect
, time_msec());
982 jsonrpc_session_get_backlog(const struct jsonrpc_session
*s
)
984 return s
->rpc
? jsonrpc_get_backlog(s
->rpc
) : 0;
987 /* Always returns a pointer to a valid C string, assuming 's' was initialized
990 jsonrpc_session_get_name(const struct jsonrpc_session
*s
)
992 return reconnect_get_name(s
->reconnect
);
995 /* Always takes ownership of 'msg', regardless of success. */
997 jsonrpc_session_send(struct jsonrpc_session
*s
, struct jsonrpc_msg
*msg
)
1000 return jsonrpc_send(s
->rpc
, msg
);
1002 jsonrpc_msg_destroy(msg
);
1007 struct jsonrpc_msg
*
1008 jsonrpc_session_recv(struct jsonrpc_session
*s
)
1011 unsigned int received_bytes
;
1012 struct jsonrpc_msg
*msg
;
1014 received_bytes
= jsonrpc_get_received_bytes(s
->rpc
);
1015 jsonrpc_recv(s
->rpc
, &msg
);
1016 if (received_bytes
!= jsonrpc_get_received_bytes(s
->rpc
)) {
1017 /* Data was successfully received.
1019 * Previously we only counted receiving a full message as activity,
1020 * but with large messages or a slow connection that policy could
1021 * time out the session mid-message. */
1022 reconnect_activity(s
->reconnect
, time_msec());
1026 if (msg
->type
== JSONRPC_REQUEST
&& !strcmp(msg
->method
, "echo")) {
1027 /* Echo request. Send reply. */
1028 struct jsonrpc_msg
*reply
;
1030 reply
= jsonrpc_create_reply(json_clone(msg
->params
), msg
->id
);
1031 jsonrpc_session_send(s
, reply
);
1032 } else if (msg
->type
== JSONRPC_REPLY
1033 && msg
->id
&& msg
->id
->type
== JSON_STRING
1034 && !strcmp(msg
->id
->u
.string
, "echo")) {
1035 /* It's a reply to our echo request. Suppress it. */
1039 jsonrpc_msg_destroy(msg
);
1046 jsonrpc_session_recv_wait(struct jsonrpc_session
*s
)
1049 jsonrpc_recv_wait(s
->rpc
);
1054 jsonrpc_session_is_alive(const struct jsonrpc_session
*s
)
1056 return s
->rpc
|| s
->stream
|| reconnect_get_max_tries(s
->reconnect
);
1060 jsonrpc_session_is_connected(const struct jsonrpc_session
*s
)
1062 return s
->rpc
!= NULL
;
1066 jsonrpc_session_get_seqno(const struct jsonrpc_session
*s
)
1072 jsonrpc_session_get_status(const struct jsonrpc_session
*s
)
1074 return s
&& s
->rpc
? jsonrpc_get_status(s
->rpc
) : 0;
1078 jsonrpc_session_get_last_error(const struct jsonrpc_session
*s
)
1080 return s
->last_error
;
1084 jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session
*s
,
1085 struct reconnect_stats
*stats
)
1087 reconnect_get_stats(s
->reconnect
, time_msec(), stats
);
1091 jsonrpc_session_force_reconnect(struct jsonrpc_session
*s
)
1093 reconnect_force_reconnect(s
->reconnect
, time_msec());
1097 jsonrpc_session_set_max_backoff(struct jsonrpc_session
*s
, int max_backoff
)
1099 reconnect_set_backoff(s
->reconnect
, 0, max_backoff
);
1103 jsonrpc_session_set_probe_interval(struct jsonrpc_session
*s
,
1106 reconnect_set_probe_interval(s
->reconnect
, probe_interval
);
1110 jsonrpc_session_set_dscp(struct jsonrpc_session
*s
,
1113 if (s
->dscp
!= dscp
) {
1117 error
= pstream_set_dscp(s
->pstream
, dscp
);
1119 VLOG_ERR("%s: failed set_dscp %s",
1120 reconnect_get_name(s
->reconnect
),
1121 ovs_strerror(error
));
1124 * XXX race window between setting dscp to listening socket
1125 * and accepting socket. accepted socket may have old dscp value.
1126 * Ignore this race window for now.
1130 jsonrpc_session_force_reconnect(s
);