[ovs-dev] [PATCH] ovsdb-server: Write manager status information to Manager table.

Andrew Evans aevans at nicira.com
Fri Jan 28 23:17:49 UTC 2011


This commit makes the status of manager connections visible via the Manager
table in the database.  Two new columns have been created for this purpose:
'is_connected' and 'status'.  The former is a boolean flag, and the latter is a
string-string map which may contain the keys "last_error", "state", and
"time_in_state".

Feature #3692.
Requested-by: Keith Amidon <keith at nicira.com>
---
 lib/jsonrpc.c              |   33 +++++++++
 lib/jsonrpc.h              |    5 ++
 ovsdb/jsonrpc-server.c     |   86 ++++++++++++++++++++++++
 ovsdb/jsonrpc-server.h     |   15 ++++
 ovsdb/ovsdb-server.c       |  156 ++++++++++++++++++++++++++++++++++++++++----
 vswitchd/vswitch.ovsschema |   12 +++-
 vswitchd/vswitch.xml       |   30 +++++++++
 7 files changed, 321 insertions(+), 16 deletions(-)

diff --git a/lib/jsonrpc.c b/lib/jsonrpc.c
index 7c761ea..34ced1f 100644
--- a/lib/jsonrpc.c
+++ b/lib/jsonrpc.c
@@ -148,6 +148,26 @@ jsonrpc_get_status(const struct jsonrpc *rpc)
     return rpc->status;
 }
 
+static const char *
+jsonrpc_get_status_string(const struct jsonrpc *rpc)
+{
+    if (!rpc || !rpc->status) {
+        return NULL;
+    }
+    if (rpc->status < 0) {
+        return xstrdup(strerror(-rpc->status));
+    }
+
+    switch (rpc->status) {
+    case EOF:
+        return xstrdup("EOF");
+    case EPROTO:
+        return xstrdup("EPROTO");
+    default:
+        return xstrdup("*** UNKNOWN jsonrpc ERROR ***");
+    }
+}
+
 size_t
 jsonrpc_get_backlog(const struct jsonrpc *rpc)
 {
@@ -941,6 +961,19 @@ jsonrpc_session_get_seqno(const struct jsonrpc_session *s)
     return s->seqno;
 }
 
+const char *
+jsonrpc_session_get_last_error(const struct jsonrpc_session *s)
+{
+    return jsonrpc_get_status_string(s->rpc);
+}
+
+void
+jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session *s,
+                                    struct reconnect_stats *stats)
+{
+    reconnect_get_stats(s->reconnect, time_msec(), stats);
+}
+
 void
 jsonrpc_session_force_reconnect(struct jsonrpc_session *s)
 {
diff --git a/lib/jsonrpc.h b/lib/jsonrpc.h
index d95148c..4497f98 100644
--- a/lib/jsonrpc.h
+++ b/lib/jsonrpc.h
@@ -26,6 +26,7 @@
 struct json;
 struct jsonrpc_msg;
 struct pstream;
+struct reconnect_stats;
 struct stream;
 
 /* API for a JSON-RPC stream. */
@@ -113,6 +114,10 @@ void jsonrpc_session_recv_wait(struct jsonrpc_session *);
 bool jsonrpc_session_is_alive(const struct jsonrpc_session *);
 bool jsonrpc_session_is_connected(const struct jsonrpc_session *);
 unsigned int jsonrpc_session_get_seqno(const struct jsonrpc_session *);
+const char *jsonrpc_session_get_last_error(const struct jsonrpc_session *);
+void jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session *,
+                                         struct reconnect_stats *);
+
 void jsonrpc_session_force_reconnect(struct jsonrpc_session *);
 
 void jsonrpc_session_set_max_backoff(struct jsonrpc_session *,
diff --git a/ovsdb/jsonrpc-server.c b/ovsdb/jsonrpc-server.c
index 3edcfff..483de5d 100644
--- a/ovsdb/jsonrpc-server.c
+++ b/ovsdb/jsonrpc-server.c
@@ -53,6 +53,8 @@ static void ovsdb_jsonrpc_session_close_all(struct ovsdb_jsonrpc_remote *);
 static void ovsdb_jsonrpc_session_reconnect_all(struct ovsdb_jsonrpc_remote *);
 static void ovsdb_jsonrpc_session_set_all_options(
     struct ovsdb_jsonrpc_remote *, const struct ovsdb_jsonrpc_options *);
+static bool ovsdb_jsonrpc_session_get_status(
+    const struct ovsdb_jsonrpc_remote *remote, struct shash *status);
 
 /* Triggers. */
 static void ovsdb_jsonrpc_trigger_create(struct ovsdb_jsonrpc_session *,
@@ -194,6 +196,35 @@ ovsdb_jsonrpc_server_del_remote(struct shash_node *node)
     free(remote);
 }
 
+struct shash *
+ovsdb_jsonrpc_server_get_remote_status(const struct ovsdb_jsonrpc_server *svr)
+{
+    struct shash *statuses;
+    struct shash_node *node;
+
+    statuses = xmalloc(sizeof *statuses);
+    shash_init(statuses);
+
+    SHASH_FOR_EACH (node, &svr->remotes) {
+        const struct ovsdb_jsonrpc_remote *remote = node->data;
+
+        if (!ovsdb_jsonrpc_session_get_status(remote, statuses)) {
+            ; /* XXX: just return void? */
+        }
+    }
+    return statuses;
+}
+
+void
+ovsdb_jsonrpc_server_destroy_remote_status(struct shash *statuses)
+{
+    struct shash_node *node;
+
+    SHASH_FOR_EACH (node, statuses) {
+        shash_destroy(node->data);
+    }
+}
+
 /* Forces all of the JSON-RPC sessions managed by 'svr' to disconnect and
  * reconnect. */
 void
@@ -420,6 +451,61 @@ ovsdb_jsonrpc_session_set_all_options(
     }
 }
 
+static bool
+ovsdb_jsonrpc_session_get_status(const struct ovsdb_jsonrpc_remote *remote,
+                                 struct shash *statuses)
+{
+    const struct ovsdb_jsonrpc_session *s;
+    const struct jsonrpc_session *js;
+    const char *name;
+    struct shash *pairs;
+    bool *is_connected;
+    const char *last_error;
+    struct reconnect_stats stats;
+
+    /* We only look at the first session in the list. There should be only one
+     * node in the list for outbound connections. We don't track status for
+     * each individual inbound connection if someone configures the DB that
+     * way. Since outbound connections are the norm, this is fine. */
+    if (list_is_empty(&remote->sessions)) {
+        return true;  /* no sessions is not an error */
+    }
+    s = CONTAINER_OF(remote->sessions.next, struct ovsdb_jsonrpc_session, node);
+    if (!s) {
+        return false;
+    }
+
+    js = s->js;
+    if (!js) {
+        return false;
+    }
+
+    name = jsonrpc_session_get_name(js);
+    if (!name) {
+        return false;
+    }
+
+    /* pairs: hash of connection attribute names -> values */
+    pairs = xmalloc(sizeof *pairs);
+    shash_init(pairs);
+    shash_add(statuses, name, pairs);
+
+    is_connected = xmalloc(sizeof *is_connected);
+    *is_connected = jsonrpc_session_is_connected(js);
+    shash_add(pairs, "is_connected", is_connected);
+
+    last_error = jsonrpc_session_get_last_error(js);
+    if (last_error) {
+        shash_add(pairs, "last_error", last_error);
+    }
+
+    jsonrpc_session_get_reconnect_stats(js, &stats);
+    shash_add(pairs, "state", xstrdup(stats.state));
+    shash_add(pairs, "time_in_state", xasprintf("%u", stats.state_elapsed));
+
+    return true;
+}
+
 static const char *
 get_db_name(const struct ovsdb_jsonrpc_session *s)
 {
diff --git a/ovsdb/jsonrpc-server.h b/ovsdb/jsonrpc-server.h
index 9906e81..6d4dd31 100644
--- a/ovsdb/jsonrpc-server.h
+++ b/ovsdb/jsonrpc-server.h
@@ -16,6 +16,9 @@
 #ifndef OVSDB_JSONRPC_SERVER_H
 #define OVSDB_JSONRPC_SERVER_H 1
 
+#include <stdbool.h>
+#include <stddef.h>
+
 struct ovsdb;
 struct shash;
 
@@ -32,6 +35,18 @@ struct ovsdb_jsonrpc_options *ovsdb_jsonrpc_default_options(void);
 void ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *,
                                       const struct shash *);
 
+struct ovsdb_jsonrpc_remote_status {
+    const char *target;
+    bool is_connected;
+    struct {
+        char *keys[3];
+        char *values[3];
+        size_t n;
+    } pairs;
+};
+struct shash *ovsdb_jsonrpc_server_get_remote_status(const struct ovsdb_jsonrpc_server *);
+void ovsdb_jsonrpc_server_destroy_remote_status(struct shash *);
+
 void ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *);
 
 void ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *);
diff --git a/ovsdb/ovsdb-server.c b/ovsdb/ovsdb-server.c
index b4f2e42..e540233 100644
--- a/ovsdb/ovsdb-server.c
+++ b/ovsdb/ovsdb-server.c
@@ -43,6 +43,7 @@
 #include "svec.h"
 #include "table.h"
 #include "timeval.h"
+#include "transaction.h"
 #include "trigger.h"
 #include "util.h"
 #include "unixctl.h"
@@ -70,6 +71,8 @@ static void usage(void) NO_RETURN;
 static void reconfigure_from_db(struct ovsdb_jsonrpc_server *jsonrpc,
                                 const struct ovsdb *db, struct shash *remotes);
 
+static void update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc, struct ovsdb *db);
+
 int
 main(int argc, char *argv[])
 {
@@ -85,6 +88,7 @@ main(int argc, char *argv[])
     char *file_name;
     bool exiting;
     int retval;
+    static long long int status_timer = LLONG_MIN;
 
     proctitle_init(argc, argv);
     set_program_name(argv[0]);
@@ -145,6 +149,12 @@ main(int argc, char *argv[])
             exiting = true;
         }
 
+        /* update Manager status(es) every 5 seconds */
+        if (time_msec() >= status_timer) {
+            status_timer = time_msec() + 5000;
+            update_remote_status(jsonrpc, db);
+        }
+
         ovsdb_jsonrpc_server_wait(jsonrpc);
         unixctl_server_wait(unixctl);
         ovsdb_trigger_wait(db, time_msec());
@@ -272,36 +282,50 @@ add_remote(struct shash *remotes, const char *target)
     return options;
 }
 
-static const union ovsdb_atom *
-read_column(const struct ovsdb_row *row, const char *column_name,
-            enum ovsdb_atomic_type type)
+static struct ovsdb_datum *
+get_datum(struct ovsdb_row *row, const char *column_name,
+          const enum ovsdb_atomic_type key_type,
+          const enum ovsdb_atomic_type value_type,
+          const size_t n_max)
 {
     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
     const struct ovsdb_table_schema *schema = row->table->schema;
     const struct ovsdb_column *column;
-    const struct ovsdb_datum *datum;
 
     column = ovsdb_table_schema_get_column(schema, column_name);
     if (!column) {
         VLOG_DBG_RL(&rl, "Table `%s' has no `%s' column",
                     schema->name, column_name);
-        return false;
+        return NULL;
     }
 
-    if (column->type.key.type != type
-        || column->type.value.type != OVSDB_TYPE_VOID
-        || column->type.n_max != 1) {
+    if (column->type.key.type != key_type
+        || column->type.value.type != value_type
+        || column->type.n_max != n_max) {
         if (!VLOG_DROP_DBG(&rl)) {
             char *type_name = ovsdb_type_to_english(&column->type);
             VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
-                     "type %s.", schema->name, column_name, type_name,
-                     ovsdb_atomic_type_to_string(type));
+                     "key type %s, value type %s, max elements %zd.",
+                     schema->name, column_name, type_name,
+                     ovsdb_atomic_type_to_string(key_type),
+                     ovsdb_atomic_type_to_string(value_type),
+                     n_max);
+            free(type_name);
         }
-        return false;
+        return NULL;
     }
 
-    datum = &row->fields[column->index];
-    return datum->n ? datum->keys : NULL;
+    return &row->fields[column->index];
+}
+
+static const union ovsdb_atom *
+read_column(const struct ovsdb_row *row, const char *column_name,
+            enum ovsdb_atomic_type type)
+{
+    const struct ovsdb_datum *datum;
+
+    datum = get_datum((struct ovsdb_row *) row, column_name, type, OVSDB_TYPE_VOID, 1);
+    return !datum ? NULL : datum->n ? datum->keys : NULL;
 }
 
 static bool
@@ -326,6 +350,47 @@ read_string_column(const struct ovsdb_row *row, const char *column_name,
     return atom != NULL;
 }
 
+static bool
+write_bool_column(struct ovsdb_row *row, const char *column_name, bool value)
+{
+    struct ovsdb_datum *datum = get_datum(row, column_name, OVSDB_TYPE_BOOLEAN,
+                                          OVSDB_TYPE_VOID, 1);
+
+    if (datum) {
+        datum->keys[0].boolean = value;
+    }
+    return !!datum;
+}
+
+static bool
+write_shash_column(struct ovsdb_row *row, const char *column_name,
+                   struct shash *shash)
+{
+    size_t n = shash_count(shash);
+    struct ovsdb_datum *datum = get_datum(row, column_name, OVSDB_TYPE_STRING,
+                                          OVSDB_TYPE_STRING, UINT_MAX);
+    struct shash_node *node;
+
+    if (!datum) {
+        return false;  /* type mismatch */
+    }
+    if (datum->n != n) {
+        const struct ovsdb_column *column =
+            ovsdb_table_schema_get_column(row->table->schema, column_name);
+
+        ovsdb_datum_destroy(datum, &column->type);
+        datum->keys = xmalloc(n * sizeof *datum->keys);
+        datum->values = xmalloc(n * sizeof *datum->values);
+        datum->n = n;
+    }
+    n = 0;
+    SHASH_FOR_EACH (node, shash) {
+        datum->keys[n].string = xstrdup(node->name);  /* shash owns its key storage */
+        datum->values[n++].string = node->data;
+    }
+    return true;
+}
+
 /* Adds a remote and options to 'remotes', based on the Manager table row in
  * 'row'. */
 static void
@@ -393,6 +458,71 @@ query_db_remotes(const char *name, const struct ovsdb *db,
     }
 }
 
+static void
+update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
+                     struct ovsdb *db)
+{
+    struct ovsdb_table *table;
+    static const char *table_name = "Manager";
+
+    struct ovsdb_txn *txn;
+    struct shash *statuses;
+    struct ovsdb_row *row;
+
+    static const bool durable_txn = false;
+    struct ovsdb_error *error;
+
+    table = ovsdb_get_table(db, table_name);
+    if (!table) {
+        ovs_fatal(0, "no table named %s", table_name);
+    }
+
+    txn = ovsdb_txn_create(db);
+
+    statuses = ovsdb_jsonrpc_server_get_remote_status(jsonrpc);
+
+    HMAP_FOR_EACH (row, hmap_node, &table->rows) {
+        struct ovsdb_row *rw_row;
+        const char *target;
+        struct shash *pairs;
+        bool *is_connected;
+
+        rw_row = ovsdb_txn_row_modify(txn, row);  /* XXX: memory leak! */
+        if (!rw_row) {
+            ovs_fatal(0, "unable to modify row");
+        }
+
+        if (!read_string_column(rw_row, "target", &target)) {
+            ovs_fatal(0, "unable to get value of \"Manager.target\"");
+        }
+
+        pairs = shash_find_data(statuses, target);
+        if (!pairs) {
+            VLOG_WARN("No connection status information found for target `%s'",
+                      target);
+            continue;
+        }
+
+        is_connected = shash_find_and_delete(pairs, "is_connected");
+        if (is_connected) {
+            write_bool_column(rw_row, "is_connected", *is_connected);
+            free(is_connected);
+        } else {
+            VLOG_WARN("'is_connected' key missing for target `%s'", target);
+        }
+
+        /* store remainder of 'pairs' in 'status' column */
+        write_shash_column(rw_row, "status", pairs);
+    }
+
+    error = ovsdb_txn_commit(txn, durable_txn);
+    if (error) {
+        VLOG_ERR("update Manager status: transaction commit failed");
+    }
+
+    ovsdb_jsonrpc_server_destroy_remote_status(statuses);
+}
+
 /* Reconfigures ovsdb-server based on information in the database. */
 static void
 reconfigure_from_db(struct ovsdb_jsonrpc_server *jsonrpc,
diff --git a/vswitchd/vswitch.ovsschema b/vswitchd/vswitch.ovsschema
index 8d14221..8553499 100644
--- a/vswitchd/vswitch.ovsschema
+++ b/vswitchd/vswitch.ovsschema
@@ -1,6 +1,6 @@
 {"name": "Open_vSwitch",
- "version": "1.1.0",
- "cksum": "815766362 15358",
+ "version": "1.2.0",
+ "cksum": "2368100022 15573",
  "tables": {
    "Open_vSwitch": {
      "columns": {
@@ -412,7 +412,13 @@
                   "min": 0, "max": 1}},
        "external_ids": {
          "type": {"key": "string", "value": "string",
-                  "min": 0, "max": "unlimited"}}}},
+                  "min": 0, "max": "unlimited"}},
+       "is_connected": {
+         "type": "boolean",
+         "ephemeral": true},
+       "status": {
+         "type": {"key": "string", "value": "string", "min": 0, "max": "unlimited"},
+         "ephemeral": true}}},
    "SSL": {
      "columns": {
        "private_key": {
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 6565b95..8eef28d 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -2037,6 +2037,36 @@
         unique.  No common key-value pairs are currently defined.
       </column>
     </group>
+
+    <group title="Manager Status">
+      <column name="is_connected">
+        <code>true</code> if currently connected to this manager,
+        <code>false</code> otherwise.
+      </column>
+
+      <column name="status">
+        <p>Key-value pairs that report manager status.</p>
+        <dl>
+          <dt><code>last_error</code></dt>
+          <dd>A human-readable description of the last error on the connection
+            to the manager; i.e. <code>strerror(errno)</code>.  This key
+            will exist only if an error has occurred.</dd>
+        </dl>
+        <dl>
+          <dt><code>state</code></dt>
+          <dd>The state of the connection to the manager.  Possible values
+            are: <code>VOID</code>, <code>BACKOFF</code>,
+            <code>CONNECTING</code>, <code>ACTIVE</code>, and
+            <code>IDLE</code>.</dd>
+        </dl>
+        <dl>
+          <dt><code>time_in_state</code></dt>
+          <dd>Seconds since connecting to (if currently connected) or
+            disconnecting from (if currently disconnected) this
+            manager.</dd>
+        </dl>
+      </column>
+    </group>
   </table>
 
   <table name="NetFlow">
-- 
1.7.2.3





More information about the dev mailing list