/*
- * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
+ * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include "jsonrpc.h"
-#include <assert.h>
#include <errno.h>
#include "byteq.h"
#include "json.h"
#include "list.h"
#include "ofpbuf.h"
+#include "ovs-thread.h"
#include "poll-loop.h"
#include "reconnect.h"
#include "stream.h"
#include "timeval.h"
-#include "vlog.h"
+#include "openvswitch/vlog.h"
VLOG_DEFINE_THIS_MODULE(jsonrpc);
\f
/* Input. */
struct byteq input;
+ uint8_t input_buffer[512];
struct json_parser *parser;
- struct jsonrpc_msg *received;
/* Output. */
- struct list output; /* Contains "struct ofpbuf"s. */
+ struct ovs_list output; /* Contains "struct ofpbuf"s. */
+ size_t output_count; /* Number of elements in "output". */
size_t backlog;
};
/* Rate limit for error messages. */
static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 5);
-static void jsonrpc_received(struct jsonrpc *);
+static struct jsonrpc_msg *jsonrpc_parse_received_message(struct jsonrpc *);
static void jsonrpc_cleanup(struct jsonrpc *);
static void jsonrpc_error(struct jsonrpc *, int error);
/* This is just the same as stream_open() except that it uses the default
- * JSONRPC ports if none is specified. */
+ * JSONRPC port if none is specified. */
int
-jsonrpc_stream_open(const char *name, struct stream **streamp)
+jsonrpc_stream_open(const char *name, struct stream **streamp, uint8_t dscp)
{
- return stream_open_with_default_ports(name, JSONRPC_TCP_PORT,
- JSONRPC_SSL_PORT, streamp);
+ return stream_open_with_default_port(name, OVSDB_PORT, streamp, dscp);
}
/* This is just the same as pstream_open() except that it uses the default
- * JSONRPC ports if none is specified. */
+ * JSONRPC port if none is specified. */
int
-jsonrpc_pstream_open(const char *name, struct pstream **pstreamp)
+jsonrpc_pstream_open(const char *name, struct pstream **pstreamp, uint8_t dscp)
{
- return pstream_open_with_default_ports(name, JSONRPC_TCP_PORT,
- JSONRPC_SSL_PORT, pstreamp);
+ return pstream_open_with_default_port(name, OVSDB_PORT, pstreamp, dscp);
}
/* Returns a new JSON-RPC stream that uses 'stream' for input and output. The
{
struct jsonrpc *rpc;
- assert(stream != NULL);
+ ovs_assert(stream != NULL);
rpc = xzalloc(sizeof *rpc);
rpc->name = xstrdup(stream_get_name(stream));
rpc->stream = stream;
- byteq_init(&rpc->input);
+ byteq_init(&rpc->input, rpc->input_buffer, sizeof rpc->input_buffer);
list_init(&rpc->output);
return rpc;
ofpbuf_pull(buf, retval);
if (!buf->size) {
list_remove(&buf->list_node);
+ rpc->output_count--;
ofpbuf_delete(buf);
}
} else {
if (retval != -EAGAIN) {
VLOG_WARN_RL(&rl, "%s: send error: %s",
- rpc->name, strerror(-retval));
+ rpc->name, ovs_strerror(-retval));
jsonrpc_error(rpc, -retval);
}
break;
return rpc->status ? 0 : rpc->backlog;
}
+/* Returns the number of bytes that have been received on 'rpc''s underlying
+ * stream. (The value wraps around if it exceeds UINT_MAX.) */
+unsigned int
+jsonrpc_get_received_bytes(const struct jsonrpc *rpc)
+{
+ return rpc->input.head;
+}
+
/* Returns 'rpc''s name, that is, the name returned by stream_get_name() for
* the stream underlying 'rpc' when 'rpc' was created. */
const char *
{
struct ofpbuf *buf;
struct json *json;
+ struct ds ds = DS_EMPTY_INITIALIZER;
size_t length;
- char *s;
if (rpc->status) {
jsonrpc_msg_destroy(msg);
jsonrpc_log_msg(rpc, "send", msg);
json = jsonrpc_msg_to_json(msg);
- s = json_to_string(json, 0);
- length = strlen(s);
+ json_to_ds(json, 0, &ds);
+ length = ds.length;
json_destroy(json);
buf = xmalloc(sizeof *buf);
- ofpbuf_use(buf, s, length);
- buf->size = length;
+ ofpbuf_use_ds(buf, &ds);
list_push_back(&rpc->output, &buf->list_node);
+ rpc->output_count++;
rpc->backlog += length;
+ if (rpc->output_count >= 50) {
+ VLOG_INFO_RL(&rl, "excessive sending backlog, jsonrpc: %s, num of"
+ " msgs: %"PRIuSIZE", backlog: %"PRIuSIZE".", rpc->name,
+ rpc->output_count, rpc->backlog);
+ }
+
if (rpc->backlog == length) {
jsonrpc_run(rpc);
}
int
jsonrpc_recv(struct jsonrpc *rpc, struct jsonrpc_msg **msgp)
{
+ int i;
+
*msgp = NULL;
if (rpc->status) {
return rpc->status;
}
- while (!rpc->received) {
+ for (i = 0; i < 50; i++) {
+ size_t n, used;
+
+ /* Fill our input buffer if it's empty. */
if (byteq_is_empty(&rpc->input)) {
size_t chunk;
int retval;
return EAGAIN;
} else {
VLOG_WARN_RL(&rl, "%s: receive error: %s",
- rpc->name, strerror(-retval));
+ rpc->name, ovs_strerror(-retval));
jsonrpc_error(rpc, -retval);
return rpc->status;
}
return EOF;
}
byteq_advance_head(&rpc->input, retval);
- } else {
- size_t n, used;
+ }
- if (!rpc->parser) {
- rpc->parser = json_parser_create(0);
+ /* We have some input. Feed it into the JSON parser. */
+ if (!rpc->parser) {
+ rpc->parser = json_parser_create(0);
+ }
+ n = byteq_tailroom(&rpc->input);
+ used = json_parser_feed(rpc->parser,
+ (char *) byteq_tail(&rpc->input), n);
+ byteq_advance_tail(&rpc->input, used);
+
+ /* If we have complete JSON, attempt to parse it as JSON-RPC. */
+ if (json_parser_is_done(rpc->parser)) {
+ *msgp = jsonrpc_parse_received_message(rpc);
+ if (*msgp) {
+ return 0;
}
- n = byteq_tailroom(&rpc->input);
- used = json_parser_feed(rpc->parser,
- (char *) byteq_tail(&rpc->input), n);
- byteq_advance_tail(&rpc->input, used);
- if (json_parser_is_done(rpc->parser)) {
- jsonrpc_received(rpc);
- if (rpc->status) {
- const struct byteq *q = &rpc->input;
- if (q->head <= BYTEQ_SIZE) {
- stream_report_content(q->buffer, q->head,
- STREAM_JSONRPC,
- THIS_MODULE, rpc->name);
- }
- return rpc->status;
+
+ if (rpc->status) {
+ const struct byteq *q = &rpc->input;
+ if (q->head <= q->size) {
+ stream_report_content(q->buffer, q->head, STREAM_JSONRPC,
+ &this_module, rpc->name);
}
+ return rpc->status;
}
}
}
- *msgp = rpc->received;
- rpc->received = NULL;
- return 0;
+ return EAGAIN;
}
/* Causes the poll loop to wake up when jsonrpc_recv() may return a value other
void
jsonrpc_recv_wait(struct jsonrpc *rpc)
{
- if (rpc->status || rpc->received || !byteq_is_empty(&rpc->input)) {
- (poll_immediate_wake)(rpc->name);
+ if (rpc->status || !byteq_is_empty(&rpc->input)) {
+ poll_immediate_wake_at(rpc->name);
} else {
stream_recv_wait(rpc->stream);
}
return error;
}
-static void
-jsonrpc_received(struct jsonrpc *rpc)
+/* Attempts to parse the content of 'rpc->parser' (which is complete JSON) as a
+ * JSON-RPC message. If successful, returns the JSON-RPC message. On failure,
+ * signals an error on 'rpc' with jsonrpc_error() and returns NULL. */
+static struct jsonrpc_msg *
+jsonrpc_parse_received_message(struct jsonrpc *rpc)
{
struct jsonrpc_msg *msg;
struct json *json;
rpc->name, json_string(json));
jsonrpc_error(rpc, EPROTO);
json_destroy(json);
- return;
+ return NULL;
}
error = jsonrpc_msg_from_json(json, &msg);
rpc->name, error);
free(error);
jsonrpc_error(rpc, EPROTO);
- return;
+ return NULL;
}
jsonrpc_log_msg(rpc, "received", msg);
- rpc->received = msg;
+ return msg;
}
static void
jsonrpc_error(struct jsonrpc *rpc, int error)
{
- assert(error);
+ ovs_assert(error);
if (!rpc->status) {
rpc->status = error;
jsonrpc_cleanup(rpc);
json_parser_abort(rpc->parser);
rpc->parser = NULL;
- jsonrpc_msg_destroy(rpc->received);
- rpc->received = NULL;
-
ofpbuf_list_delete(&rpc->output);
rpc->backlog = 0;
+ rpc->output_count = 0;
}
\f
static struct jsonrpc_msg *
static struct json *
jsonrpc_create_id(void)
{
- static unsigned int id;
- return json_integer_create(id++);
+ static atomic_count next_id = ATOMIC_COUNT_INIT(0);
+ unsigned int id;
+
+ id = atomic_count_inc(&next_id);
+ return json_integer_create(id);
}
struct jsonrpc_msg *
struct jsonrpc *rpc;
struct stream *stream;
struct pstream *pstream;
+ int last_error;
unsigned int seqno;
+ uint8_t dscp;
};
/* Creates and returns a jsonrpc_session to 'name', which should be a string
* acceptable to stream_open() or pstream_open().
*
* If 'name' is an active connection method, e.g. "tcp:127.1.2.3", the new
- * jsonrpc_session connects and reconnects, with back-off, to 'name'.
+ * jsonrpc_session connects to 'name'. If 'retry' is true, then the new
+ * session connects and reconnects to 'name', with backoff. If 'retry' is
+ * false, the new session will only try to connect once and after a connection
+ * failure or a disconnection jsonrpc_session_is_alive() will return false for
+ * the new session.
*
* If 'name' is a passive connection method, e.g. "ptcp:", the new
* jsonrpc_session listens for connections to 'name'. It maintains at most one
* connection at any given time. Any new connection causes the previous one
* (if any) to be dropped. */
struct jsonrpc_session *
-jsonrpc_session_open(const char *name)
+jsonrpc_session_open(const char *name, bool retry)
{
struct jsonrpc_session *s;
s->stream = NULL;
s->pstream = NULL;
s->seqno = 0;
+ s->dscp = 0;
+ s->last_error = 0;
if (!pstream_verify_name(name)) {
reconnect_set_passive(s->reconnect, true, time_msec());
+ } else if (!retry) {
+ reconnect_set_max_tries(s->reconnect, 1);
+ reconnect_set_backoff(s->reconnect, INT_MAX, INT_MAX);
+ }
+
+ if (!stream_or_pstream_needs_probes(name)) {
+ reconnect_set_probe_interval(s->reconnect, 0);
}
return s;
* On the assumption that such connections are likely to be short-lived
* (e.g. from ovs-vsctl), informational logging for them is suppressed. */
struct jsonrpc_session *
-jsonrpc_session_open_unreliably(struct jsonrpc *jsonrpc)
+jsonrpc_session_open_unreliably(struct jsonrpc *jsonrpc, uint8_t dscp)
{
struct jsonrpc_session *s;
reconnect_set_name(s->reconnect, jsonrpc_get_name(jsonrpc));
reconnect_set_max_tries(s->reconnect, 0);
reconnect_connected(s->reconnect, time_msec());
+ s->dscp = dscp;
s->rpc = jsonrpc;
s->stream = NULL;
s->pstream = NULL;
jsonrpc_session_disconnect(s);
if (!reconnect_is_passive(s->reconnect)) {
- error = jsonrpc_stream_open(name, &s->stream);
+ error = jsonrpc_stream_open(name, &s->stream, s->dscp);
if (!error) {
reconnect_connecting(s->reconnect, time_msec());
+ } else {
+ s->last_error = error;
}
} else {
- error = s->pstream ? 0 : jsonrpc_pstream_open(name, &s->pstream);
+ error = s->pstream ? 0 : jsonrpc_pstream_open(name, &s->pstream,
+ s->dscp);
if (!error) {
reconnect_listening(s->reconnect, time_msec());
}
}
if (s->rpc) {
+ size_t backlog;
int error;
+ backlog = jsonrpc_get_backlog(s->rpc);
jsonrpc_run(s->rpc);
+ if (jsonrpc_get_backlog(s->rpc) < backlog) {
+ /* Data previously caught in a queue was successfully sent (or
+ * there's an error, which we'll catch below.)
+ *
+ * We don't count data that is successfully sent immediately as
+ * activity, because there's a lot of queuing downstream from us,
+ * which means that we can push a lot of data into a connection
+ * that has stalled and won't ever recover.
+ */
+ reconnect_activity(s->reconnect, time_msec());
+ }
+
error = jsonrpc_get_status(s->rpc);
if (error) {
reconnect_disconnected(s->reconnect, time_msec(), error);
jsonrpc_session_disconnect(s);
+ s->last_error = error;
}
} else if (s->stream) {
int error;
reconnect_connect_failed(s->reconnect, time_msec(), error);
stream_close(s->stream);
s->stream = NULL;
+ s->last_error = error;
}
}
jsonrpc_session_recv(struct jsonrpc_session *s)
{
if (s->rpc) {
+ unsigned int received_bytes;
struct jsonrpc_msg *msg;
+
+ received_bytes = jsonrpc_get_received_bytes(s->rpc);
jsonrpc_recv(s->rpc, &msg);
+ if (received_bytes != jsonrpc_get_received_bytes(s->rpc)) {
+ /* Data was successfully received.
+ *
+ * Previously we only counted receiving a full message as activity,
+ * but with large messages or a slow connection that policy could
+ * time out the session mid-message. */
+ reconnect_activity(s->reconnect, time_msec());
+ }
+
if (msg) {
- reconnect_received(s->reconnect, time_msec());
if (msg->type == JSONRPC_REQUEST && !strcmp(msg->method, "echo")) {
/* Echo request. Send reply. */
struct jsonrpc_msg *reply;
}
}
+/* Returns true if 's' is currently connected or trying to connect. */
bool
jsonrpc_session_is_alive(const struct jsonrpc_session *s)
{
return s->rpc || s->stream || reconnect_get_max_tries(s->reconnect);
}
+/* Returns true if 's' is currently connected. */
bool
jsonrpc_session_is_connected(const struct jsonrpc_session *s)
{
return s->rpc != NULL;
}
+/* Returns a sequence number for 's'. The sequence number increments every
+ * time 's' connects or disconnects. Thus, a caller can use the change (or
+ * lack of change) in the sequence number to figure out whether the underlying
+ * connection is the same as before. */
unsigned int
jsonrpc_session_get_seqno(const struct jsonrpc_session *s)
{
return s->seqno;
}
+/* Returns the current status of 's'. If 's' is NULL or is disconnected, this
+ * is 0, otherwise it is the status of the connection, as reported by
+ * jsonrpc_get_status(). */
int
jsonrpc_session_get_status(const struct jsonrpc_session *s)
{
return s && s->rpc ? jsonrpc_get_status(s->rpc) : 0;
}
+/* Returns the last error reported on a connection by 's'. The return value is
+ * 0 only if no connection made by 's' has ever encountered an error. See
+ * jsonrpc_get_status() for return value interpretation. */
+int
+jsonrpc_session_get_last_error(const struct jsonrpc_session *s)
+{
+ return s->last_error;
+}
+
+/* Populates 'stats' with statistics from 's'. */
void
jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session *s,
struct reconnect_stats *stats)
reconnect_get_stats(s->reconnect, time_msec(), stats);
}
+/* Enables 's' to reconnect to the peer if the connection drops. */
+void
+jsonrpc_session_enable_reconnect(struct jsonrpc_session *s)
+{
+ reconnect_set_max_tries(s->reconnect, UINT_MAX);
+ reconnect_set_backoff(s->reconnect, RECONNECT_DEFAULT_MIN_BACKOFF,
+ RECONNECT_DEFAULT_MAX_BACKOFF);
+}
+
+/* Forces 's' to drop its connection (if any) and reconnect. */
void
jsonrpc_session_force_reconnect(struct jsonrpc_session *s)
{
reconnect_force_reconnect(s->reconnect, time_msec());
}
+/* Sets 'max_backoff' as the maximum time, in milliseconds, to wait after a
+ * connection attempt fails before attempting to connect again. */
void
jsonrpc_session_set_max_backoff(struct jsonrpc_session *s, int max_backoff)
{
reconnect_set_backoff(s->reconnect, 0, max_backoff);
}
+/* Sets the "probe interval" for 's' to 'probe_interval', in milliseconds. If
+ * this is zero, it disables the connection keepalive feature. Otherwise, if
+ * 's' is idle for 'probe_interval' milliseconds then 's' will send an echo
+ * request and, if no reply is received within an additional 'probe_interval'
+ * milliseconds, close the connection (then reconnect, if that feature is
+ * enabled). */
void
jsonrpc_session_set_probe_interval(struct jsonrpc_session *s,
int probe_interval)
{
reconnect_set_probe_interval(s->reconnect, probe_interval);
}
+
+/* Sets the DSCP value used for 's''s connection to 'dscp'. If this is
+ * different from the DSCP value currently in use then the connection is closed
+ * and reconnected. */
+void
+jsonrpc_session_set_dscp(struct jsonrpc_session *s, uint8_t dscp)
+{
+ if (s->dscp != dscp) {
+ pstream_close(s->pstream);
+ s->pstream = NULL;
+
+ s->dscp = dscp;
+ jsonrpc_session_force_reconnect(s);
+ }
+}
projects / cascardo / ovs.git / blobdiff