lib/ovsdb-idl.h

   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 #ifndef OVSDB_IDL_H
  17 #define OVSDB_IDL_H 1
  18
  19 /* Open vSwitch Database Interface Definition Language (OVSDB IDL).
  20  *
  21  * The OVSDB IDL maintains an in-memory replica of a database.  It issues RPC
  22  * requests to an OVSDB database server and parses the responses, converting
  23  * raw JSON into data structures that are easier for clients to digest.  Most
  24  * notably, references to rows via UUID become C pointers.
  25  *
  26  * The IDL always presents a consistent snapshot of the database to its client,
  27  * that is, it won't present the effects of some part of a transaction applied
  28  * at the database server without presenting all of its effects.
  29  *
  30  * The IDL also assists with issuing database transactions.  The client creates
  31  * a transaction, manipulates the IDL data structures, and commits or aborts
  32  * the transaction.  The IDL then composes and issues the necessary JSON-RPC
  33  * requests and reports to the client whether the transaction completed
  34  * successfully.
  35  */
  36
  37 #include <stdbool.h>
  38 #include <stdint.h>
  39 #include "compiler.h"
  40 #include "ovsdb-types.h"
  41
  42 struct json;
  43 struct ovsdb_datum;
  44 struct ovsdb_idl_class;
  45 struct ovsdb_idl_row;
  46 struct ovsdb_idl_column;
  47 struct ovsdb_idl_table_class;
  48 struct uuid;
  49
  50 struct ovsdb_idl *ovsdb_idl_create(const char *remote,
  51                                    const struct ovsdb_idl_class *,
  52                                    bool monitor_everything_by_default,
  53                                    bool retry);
  54 void ovsdb_idl_destroy(struct ovsdb_idl *);
  55
  56 void ovsdb_idl_run(struct ovsdb_idl *);
  57 void ovsdb_idl_wait(struct ovsdb_idl *);
  58
  59 void ovsdb_idl_set_lock(struct ovsdb_idl *, const char *lock_name);
  60 bool ovsdb_idl_has_lock(const struct ovsdb_idl *);
  61 bool ovsdb_idl_is_lock_contended(const struct ovsdb_idl *);
  62
  63 unsigned int ovsdb_idl_get_seqno(const struct ovsdb_idl *);
  64 bool ovsdb_idl_has_ever_connected(const struct ovsdb_idl *);
  65 void ovsdb_idl_enable_reconnect(struct ovsdb_idl *);
  66 void ovsdb_idl_force_reconnect(struct ovsdb_idl *);
  67 void ovsdb_idl_verify_write_only(struct ovsdb_idl *);
  68
  69 bool ovsdb_idl_is_alive(const struct ovsdb_idl *);
  70 int ovsdb_idl_get_last_error(const struct ovsdb_idl *);
  71 \f
  72 /* Choosing columns and tables to replicate. */
  73
  74 /* Modes with which the IDL can monitor a column.
  75  *
  76  * If no bits are set, the column is not monitored at all.  Its value will
  77  * always appear to the client to be the default value for its type.
  78  *
  79  * If OVSDB_IDL_MONITOR is set, then the column is replicated.  Its value will
  80  * reflect the value in the database.  If OVSDB_IDL_ALERT is also set, then the
  81  * value returned by ovsdb_idl_get_seqno() will change when the column's value
  82  * changes.
  83  *
  84  * The possible mode combinations are:
  85  *
  86  *   - 0, for a column that a client doesn't care about.
  87  *
  88  *   - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT), for a column that a client wants
  89  *     to track and possibly update.
  90  *
  91  *   - OVSDB_IDL_MONITOR, for columns that a client treats as "write-only",
  92  *     that is, it updates them but doesn't want to get alerted about its own
  93  *     updates.  It also won't be alerted about other clients' updates, so this
  94  *     is suitable only for use by a client that "owns" a particular column.
  95  *
  96  *   - OVDSB_IDL_ALERT without OVSDB_IDL_MONITOR is not valid.
  97  *
  98  *   - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT | OVSDB_IDL_TRACK), for a column
  99  *     that a client wants to track using the change tracking
 100  *     ovsdb_idl_track_get_*() functions.
 101  */
 102 #define OVSDB_IDL_MONITOR (1 << 0) /* Monitor this column? */
 103 #define OVSDB_IDL_ALERT   (1 << 1) /* Alert client when column updated? */
 104 #define OVSDB_IDL_TRACK   (1 << 2)
 105
 106 void ovsdb_idl_add_column(struct ovsdb_idl *, const struct ovsdb_idl_column *);
 107 void ovsdb_idl_add_table(struct ovsdb_idl *,
 108                          const struct ovsdb_idl_table_class *);
 109
 110 void ovsdb_idl_omit(struct ovsdb_idl *, const struct ovsdb_idl_column *);
 111 void ovsdb_idl_omit_alert(struct ovsdb_idl *, const struct ovsdb_idl_column *);
 112
 113 /* Change tracking. */
 114 enum ovsdb_idl_change {
 115     OVSDB_IDL_CHANGE_INSERT,
 116     OVSDB_IDL_CHANGE_MODIFY,
 117     OVSDB_IDL_CHANGE_DELETE,
 118     OVSDB_IDL_CHANGE_MAX
 119 };
 120
 121 /* Row, table sequence numbers */
 122 unsigned int ovsdb_idl_table_get_seqno(
 123     const struct ovsdb_idl *idl,
 124     const struct ovsdb_idl_table_class *table_class);
 125 unsigned int ovsdb_idl_row_get_seqno(
 126     const struct ovsdb_idl_row *row,
 127     enum ovsdb_idl_change change);
 128
 129 void ovsdb_idl_track_add_column(struct ovsdb_idl *idl,
 130                                 const struct ovsdb_idl_column *column);
 131 void ovsdb_idl_track_add_all(struct ovsdb_idl *idl);
 132 const struct ovsdb_idl_row *ovsdb_idl_track_get_first(
 133     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *);
 134 const struct ovsdb_idl_row *ovsdb_idl_track_get_next(const struct ovsdb_idl_row *);
 135 bool ovsdb_idl_track_is_updated(const struct ovsdb_idl_row *row,
 136                                 const struct ovsdb_idl_column *column);
 137 void ovsdb_idl_track_clear(const struct ovsdb_idl *);
 138
 139 \f
 140 /* Reading the database replica. */
 141
 142 const struct ovsdb_idl_row *ovsdb_idl_get_row_for_uuid(
 143     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *,
 144     const struct uuid *);
 145 const struct ovsdb_idl_row *ovsdb_idl_first_row(
 146     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *);
 147 const struct ovsdb_idl_row *ovsdb_idl_next_row(const struct ovsdb_idl_row *);
 148
 149 const struct ovsdb_datum *ovsdb_idl_read(const struct ovsdb_idl_row *,
 150                                          const struct ovsdb_idl_column *);
 151 const struct ovsdb_datum *ovsdb_idl_get(const struct ovsdb_idl_row *,
 152                                         const struct ovsdb_idl_column *,
 153                                         enum ovsdb_atomic_type key_type,
 154                                         enum ovsdb_atomic_type value_type);
 155 bool ovsdb_idl_is_mutable(const struct ovsdb_idl_row *,
 156                           const struct ovsdb_idl_column *);
 157
 158 bool ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *);
 159 \f
 160 /* Transactions.
 161  *
 162  * A transaction may modify the contents of a database by modifying the values
 163  * of columns, deleting rows, inserting rows, or adding checks that columns in
 164  * the database have not changed ("verify" operations), through
 165  * ovsdb_idl_txn_*() functions.  (The OVSDB IDL code generator produces helper
 166  * functions that internally call the ovsdb_idl_txn_*() functions.  These are
 167  * likely to be more convenient.)
 168  *
 169  * Reading and writing columns and inserting and deleting rows are all
 170  * straightforward.  The reasons to verify columns are less obvious.
 171  * Verification is the key to maintaining transactional integrity.  Because
 172  * OVSDB handles multiple clients, it can happen that between the time that
 173  * OVSDB client A reads a column and writes a new value, OVSDB client B has
 174  * written that column.  Client A's write should not ordinarily overwrite
 175  * client B's, especially if the column in question is a "map" column that
 176  * contains several more or less independent data items.  If client A adds a
 177  * "verify" operation before it writes the column, then the transaction fails
 178  * in case client B modifies it first.  Client A will then see the new value of
 179  * the column and compose a new transaction based on the new contents written
 180  * by client B.
 181  *
 182  * When a transaction is complete, which must be before the next call to
 183  * ovsdb_idl_run() on 'idl', call ovsdb_idl_txn_commit() or
 184  * ovsdb_idl_txn_abort().
 185  *
 186  * The life-cycle of a transaction looks like this:
 187  *
 188  * 1. Create the transaction and record the initial sequence number:
 189  *
 190  *     seqno = ovsdb_idl_get_seqno(idl);
 191  *     txn = ovsdb_idl_txn_create(idl);
 192  *
 193  * 2. Modify the database with ovsdb_idl_txn_*() functions directly or
 194  *    indirectly.
 195  *
 196  * 3. Commit the transaction by calling ovsdb_idl_txn_commit().  The first call
 197  *    to this function probably returns TXN_INCOMPLETE.  The client must keep
 198  *    calling again along as this remains true, calling ovsdb_idl_run() in
 199  *    between to let the IDL do protocol processing.  (If the client doesn't
 200  *    have anything else to do in the meantime, it can use
 201  *    ovsdb_idl_txn_commit_block() to avoid having to loop itself.)
 202  *
 203  * 4. If the final status is TXN_TRY_AGAIN, wait for ovsdb_idl_get_seqno() to
 204  *    change from the saved 'seqno' (it's possible that it's already changed,
 205  *    in which case the client should not wait at all), then start over from
 206  *    step 1.  Only a call to ovsdb_idl_run() will change the return value of
 207  *    ovsdb_idl_get_seqno().  (ovsdb_idl_txn_commit_block() calls
 208  *    ovsdb_idl_run().)
 209  */
 210
 211 enum ovsdb_idl_txn_status {
 212     TXN_UNCOMMITTED,            /* Not yet committed or aborted. */
 213     TXN_UNCHANGED,              /* Transaction didn't include any changes. */
 214     TXN_INCOMPLETE,             /* Commit in progress, please wait. */
 215     TXN_ABORTED,                /* ovsdb_idl_txn_abort() called. */
 216     TXN_SUCCESS,                /* Commit successful. */
 217     TXN_TRY_AGAIN,              /* Commit failed because a "verify" operation
 218                                  * reported an inconsistency, due to a network
 219                                  * problem, or other transient failure.  Wait
 220                                  * for a change, then try again. */
 221     TXN_NOT_LOCKED,             /* Server hasn't given us the lock yet. */
 222     TXN_ERROR                   /* Commit failed due to a hard error. */
 223 };
 224
 225 const char *ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status);
 226
 227 struct ovsdb_idl_txn *ovsdb_idl_txn_create(struct ovsdb_idl *);
 228 void ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *, const char *, ...)
 229     OVS_PRINTF_FORMAT (2, 3);
 230 void ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *);
 231 void ovsdb_idl_txn_increment(struct ovsdb_idl_txn *,
 232                              const struct ovsdb_idl_row *,
 233                              const struct ovsdb_idl_column *);
 234 void ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *);
 235 void ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *);
 236 enum ovsdb_idl_txn_status ovsdb_idl_txn_commit(struct ovsdb_idl_txn *);
 237 enum ovsdb_idl_txn_status ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *);
 238 void ovsdb_idl_txn_abort(struct ovsdb_idl_txn *);
 239
 240 const char *ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *);
 241
 242 int64_t ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *);
 243 const struct uuid *ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *,
 244                                                  const struct uuid *);
 245
 246 void ovsdb_idl_txn_write(const struct ovsdb_idl_row *,
 247                          const struct ovsdb_idl_column *,
 248                          struct ovsdb_datum *);
 249 void ovsdb_idl_txn_write_clone(const struct ovsdb_idl_row *,
 250                                const struct ovsdb_idl_column *,
 251                                const struct ovsdb_datum *);
 252 void ovsdb_idl_txn_delete(const struct ovsdb_idl_row *);
 253 const struct ovsdb_idl_row *ovsdb_idl_txn_insert(
 254     struct ovsdb_idl_txn *, const struct ovsdb_idl_table_class *,
 255     const struct uuid *);
 256
 257 struct ovsdb_idl *ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *);
 258 void ovsdb_idl_get_initial_snapshot(struct ovsdb_idl *);
 259 \f
 260
 261 /* ovsdb_idl_loop provides an easy way to manage the transactions related
 262  * to 'idl' and to cope with different status during transaction. */
 263 struct ovsdb_idl_loop {
 264     struct ovsdb_idl *idl;
 265     unsigned int skip_seqno;
 266
 267     struct ovsdb_idl_txn *committing_txn;
 268     unsigned int precommit_seqno;
 269
 270     struct ovsdb_idl_txn *open_txn;
 271 };
 272
 273 #define OVSDB_IDL_LOOP_INITIALIZER(IDL) { .idl = (IDL) }
 274
 275 void ovsdb_idl_loop_destroy(struct ovsdb_idl_loop *);
 276 struct ovsdb_idl_txn *ovsdb_idl_loop_run(struct ovsdb_idl_loop *);
 277 void ovsdb_idl_loop_commit_and_wait(struct ovsdb_idl_loop *);
 278
 279 #endif /* ovsdb-idl.h */