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_set_remote(struct ovsdb_idl *, const char *, bool);
  55 void ovsdb_idl_destroy(struct ovsdb_idl *);
  56
  57 void ovsdb_idl_run(struct ovsdb_idl *);
  58 void ovsdb_idl_wait(struct ovsdb_idl *);
  59
  60 void ovsdb_idl_set_lock(struct ovsdb_idl *, const char *lock_name);
  61 bool ovsdb_idl_has_lock(const struct ovsdb_idl *);
  62 bool ovsdb_idl_is_lock_contended(const struct ovsdb_idl *);
  63
  64 unsigned int ovsdb_idl_get_seqno(const struct ovsdb_idl *);
  65 bool ovsdb_idl_has_ever_connected(const struct ovsdb_idl *);
  66 void ovsdb_idl_enable_reconnect(struct ovsdb_idl *);
  67 void ovsdb_idl_force_reconnect(struct ovsdb_idl *);
  68 void ovsdb_idl_verify_write_only(struct ovsdb_idl *);
  69
  70 bool ovsdb_idl_is_alive(const struct ovsdb_idl *);
  71 int ovsdb_idl_get_last_error(const struct ovsdb_idl *);
  72
  73 void ovsdb_idl_set_probe_interval(const struct ovsdb_idl *, int probe_interval);
  74 \f
  75 /* Choosing columns and tables to replicate. */
  76
  77 /* Modes with which the IDL can monitor a column.
  78  *
  79  * If no bits are set, the column is not monitored at all.  Its value will
  80  * always appear to the client to be the default value for its type.
  81  *
  82  * If OVSDB_IDL_MONITOR is set, then the column is replicated.  Its value will
  83  * reflect the value in the database.  If OVSDB_IDL_ALERT is also set, then the
  84  * value returned by ovsdb_idl_get_seqno() will change when the column's value
  85  * changes.
  86  *
  87  * The possible mode combinations are:
  88  *
  89  *   - 0, for a column that a client doesn't care about.
  90  *
  91  *   - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT), for a column that a client wants
  92  *     to track and possibly update.
  93  *
  94  *   - OVSDB_IDL_MONITOR, for columns that a client treats as "write-only",
  95  *     that is, it updates them but doesn't want to get alerted about its own
  96  *     updates.  It also won't be alerted about other clients' updates, so this
  97  *     is suitable only for use by a client that "owns" a particular column.
  98  *
  99  *   - OVDSB_IDL_ALERT without OVSDB_IDL_MONITOR is not valid.
 100  *
 101  *   - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT | OVSDB_IDL_TRACK), for a column
 102  *     that a client wants to track using the change tracking
 103  *     ovsdb_idl_track_get_*() functions.
 104  */
 105 #define OVSDB_IDL_MONITOR (1 << 0) /* Monitor this column? */
 106 #define OVSDB_IDL_ALERT   (1 << 1) /* Alert client when column updated? */
 107 #define OVSDB_IDL_TRACK   (1 << 2)
 108
 109 void ovsdb_idl_add_column(struct ovsdb_idl *, const struct ovsdb_idl_column *);
 110 void ovsdb_idl_add_table(struct ovsdb_idl *,
 111                          const struct ovsdb_idl_table_class *);
 112
 113 void ovsdb_idl_omit(struct ovsdb_idl *, const struct ovsdb_idl_column *);
 114 void ovsdb_idl_omit_alert(struct ovsdb_idl *, const struct ovsdb_idl_column *);
 115
 116 /* Change tracking.
 117  *
 118  * In OVSDB, change tracking is applied at each client in the IDL layer.  This
 119  * means that when a client makes a request to track changes on a particular
 120  * table, they are essentially requesting information about the incremental
 121  * changes to that table from the point in time that the request is made.  Once
 122  * the client clears tracked changes, that information will no longer be
 123  * available.
 124  *
 125  * The implication of the above is that if a client requires replaying
 126  * untracked history, it faces the choice of either trying to remember changes
 127  * itself (which translates into a memory leak) or of being structured with a
 128  * path for processing the full untracked table as well as a path that
 129  * processes incremental changes. */
 130 enum ovsdb_idl_change {
 131     OVSDB_IDL_CHANGE_INSERT,
 132     OVSDB_IDL_CHANGE_MODIFY,
 133     OVSDB_IDL_CHANGE_DELETE,
 134     OVSDB_IDL_CHANGE_MAX
 135 };
 136
 137 /* Row, table sequence numbers */
 138 unsigned int ovsdb_idl_table_get_seqno(
 139     const struct ovsdb_idl *idl,
 140     const struct ovsdb_idl_table_class *table_class);
 141 unsigned int ovsdb_idl_row_get_seqno(
 142     const struct ovsdb_idl_row *row,
 143     enum ovsdb_idl_change change);
 144
 145 void ovsdb_idl_track_add_column(struct ovsdb_idl *idl,
 146                                 const struct ovsdb_idl_column *column);
 147 void ovsdb_idl_track_add_all(struct ovsdb_idl *idl);
 148 const struct ovsdb_idl_row *ovsdb_idl_track_get_first(
 149     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *);
 150 const struct ovsdb_idl_row *ovsdb_idl_track_get_next(const struct ovsdb_idl_row *);
 151 bool ovsdb_idl_track_is_updated(const struct ovsdb_idl_row *row,
 152                                 const struct ovsdb_idl_column *column);
 153 void ovsdb_idl_track_clear(const struct ovsdb_idl *);
 154
 155 \f
 156 /* Reading the database replica. */
 157
 158 const struct ovsdb_idl_row *ovsdb_idl_get_row_for_uuid(
 159     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *,
 160     const struct uuid *);
 161 const struct ovsdb_idl_row *ovsdb_idl_first_row(
 162     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *);
 163 const struct ovsdb_idl_row *ovsdb_idl_next_row(const struct ovsdb_idl_row *);
 164
 165 const struct ovsdb_datum *ovsdb_idl_read(const struct ovsdb_idl_row *,
 166                                          const struct ovsdb_idl_column *);
 167 const struct ovsdb_datum *ovsdb_idl_get(const struct ovsdb_idl_row *,
 168                                         const struct ovsdb_idl_column *,
 169                                         enum ovsdb_atomic_type key_type,
 170                                         enum ovsdb_atomic_type value_type);
 171 bool ovsdb_idl_is_mutable(const struct ovsdb_idl_row *,
 172                           const struct ovsdb_idl_column *);
 173
 174 bool ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *);
 175 \f
 176 /* Transactions.
 177  *
 178  * A transaction may modify the contents of a database by modifying the values
 179  * of columns, deleting rows, inserting rows, or adding checks that columns in
 180  * the database have not changed ("verify" operations), through
 181  * ovsdb_idl_txn_*() functions.  (The OVSDB IDL code generator produces helper
 182  * functions that internally call the ovsdb_idl_txn_*() functions.  These are
 183  * likely to be more convenient.)
 184  *
 185  * Reading and writing columns and inserting and deleting rows are all
 186  * straightforward.  The reasons to verify columns are less obvious.
 187  * Verification is the key to maintaining transactional integrity.  Because
 188  * OVSDB handles multiple clients, it can happen that between the time that
 189  * OVSDB client A reads a column and writes a new value, OVSDB client B has
 190  * written that column.  Client A's write should not ordinarily overwrite
 191  * client B's, especially if the column in question is a "map" column that
 192  * contains several more or less independent data items.  If client A adds a
 193  * "verify" operation before it writes the column, then the transaction fails
 194  * in case client B modifies it first.  Client A will then see the new value of
 195  * the column and compose a new transaction based on the new contents written
 196  * by client B.
 197  *
 198  * When a transaction is complete, which must be before the next call to
 199  * ovsdb_idl_run() on 'idl', call ovsdb_idl_txn_commit() or
 200  * ovsdb_idl_txn_abort().
 201  *
 202  * The life-cycle of a transaction looks like this:
 203  *
 204  * 1. Create the transaction and record the initial sequence number:
 205  *
 206  *     seqno = ovsdb_idl_get_seqno(idl);
 207  *     txn = ovsdb_idl_txn_create(idl);
 208  *
 209  * 2. Modify the database with ovsdb_idl_txn_*() functions directly or
 210  *    indirectly.
 211  *
 212  * 3. Commit the transaction by calling ovsdb_idl_txn_commit().  The first call
 213  *    to this function probably returns TXN_INCOMPLETE.  The client must keep
 214  *    calling again along as this remains true, calling ovsdb_idl_run() in
 215  *    between to let the IDL do protocol processing.  (If the client doesn't
 216  *    have anything else to do in the meantime, it can use
 217  *    ovsdb_idl_txn_commit_block() to avoid having to loop itself.)
 218  *
 219  * 4. If the final status is TXN_TRY_AGAIN, wait for ovsdb_idl_get_seqno() to
 220  *    change from the saved 'seqno' (it's possible that it's already changed,
 221  *    in which case the client should not wait at all), then start over from
 222  *    step 1.  Only a call to ovsdb_idl_run() will change the return value of
 223  *    ovsdb_idl_get_seqno().  (ovsdb_idl_txn_commit_block() calls
 224  *    ovsdb_idl_run().)
 225  */
 226
 227 enum ovsdb_idl_txn_status {
 228     TXN_UNCOMMITTED,            /* Not yet committed or aborted. */
 229     TXN_UNCHANGED,              /* Transaction didn't include any changes. */
 230     TXN_INCOMPLETE,             /* Commit in progress, please wait. */
 231     TXN_ABORTED,                /* ovsdb_idl_txn_abort() called. */
 232     TXN_SUCCESS,                /* Commit successful. */
 233     TXN_TRY_AGAIN,              /* Commit failed because a "verify" operation
 234                                  * reported an inconsistency, due to a network
 235                                  * problem, or other transient failure.  Wait
 236                                  * for a change, then try again. */
 237     TXN_NOT_LOCKED,             /* Server hasn't given us the lock yet. */
 238     TXN_ERROR                   /* Commit failed due to a hard error. */
 239 };
 240
 241 const char *ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status);
 242
 243 struct ovsdb_idl_txn *ovsdb_idl_txn_create(struct ovsdb_idl *);
 244 void ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *, const char *, ...)
 245     OVS_PRINTF_FORMAT (2, 3);
 246 void ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *);
 247 void ovsdb_idl_txn_increment(struct ovsdb_idl_txn *,
 248                              const struct ovsdb_idl_row *,
 249                              const struct ovsdb_idl_column *);
 250 void ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *);
 251 void ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *);
 252 enum ovsdb_idl_txn_status ovsdb_idl_txn_commit(struct ovsdb_idl_txn *);
 253 enum ovsdb_idl_txn_status ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *);
 254 void ovsdb_idl_txn_abort(struct ovsdb_idl_txn *);
 255
 256 const char *ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *);
 257
 258 int64_t ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *);
 259 const struct uuid *ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *,
 260                                                  const struct uuid *);
 261
 262 void ovsdb_idl_txn_write(const struct ovsdb_idl_row *,
 263                          const struct ovsdb_idl_column *,
 264                          struct ovsdb_datum *);
 265 void ovsdb_idl_txn_write_clone(const struct ovsdb_idl_row *,
 266                                const struct ovsdb_idl_column *,
 267                                const struct ovsdb_datum *);
 268 void ovsdb_idl_txn_write_partial_map(const struct ovsdb_idl_row *,
 269                                      const struct ovsdb_idl_column *,
 270                                      struct ovsdb_datum *);
 271 void ovsdb_idl_txn_delete_partial_map(const struct ovsdb_idl_row *,
 272                                       const struct ovsdb_idl_column *,
 273                                       struct ovsdb_datum *);
 274 void ovsdb_idl_txn_delete(const struct ovsdb_idl_row *);
 275 const struct ovsdb_idl_row *ovsdb_idl_txn_insert(
 276     struct ovsdb_idl_txn *, const struct ovsdb_idl_table_class *,
 277     const struct uuid *);
 278
 279 struct ovsdb_idl *ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *);
 280 void ovsdb_idl_get_initial_snapshot(struct ovsdb_idl *);
 281 \f
 282
 283 /* ovsdb_idl_loop provides an easy way to manage the transactions related
 284  * to 'idl' and to cope with different status during transaction. */
 285 struct ovsdb_idl_loop {
 286     struct ovsdb_idl *idl;
 287     unsigned int skip_seqno;
 288
 289     struct ovsdb_idl_txn *committing_txn;
 290     unsigned int precommit_seqno;
 291
 292     struct ovsdb_idl_txn *open_txn;
 293 };
 294
 295 #define OVSDB_IDL_LOOP_INITIALIZER(IDL) { .idl = (IDL) }
 296
 297 void ovsdb_idl_loop_destroy(struct ovsdb_idl_loop *);
 298 struct ovsdb_idl_txn *ovsdb_idl_loop_run(struct ovsdb_idl_loop *);
 299 void ovsdb_idl_loop_commit_and_wait(struct ovsdb_idl_loop *);
 300
 301 #endif /* ovsdb-idl.h */