1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 /* Open vSwitch Database Interface Definition Language (OVSDB IDL).
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.
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.
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
40 #include "ovsdb-types.h"
41 #include "ovsdb-data.h"
42 #include "openvswitch/list.h"
43 #include "ovsdb-condition.h"
47 struct ovsdb_idl_class
;
49 struct ovsdb_idl_column
;
50 struct ovsdb_idl_table_class
;
53 struct ovsdb_idl
*ovsdb_idl_create(const char *remote
,
54 const struct ovsdb_idl_class
*,
55 bool monitor_everything_by_default
,
57 void ovsdb_idl_set_remote(struct ovsdb_idl
*, const char *, bool);
58 void ovsdb_idl_destroy(struct ovsdb_idl
*);
60 void ovsdb_idl_run(struct ovsdb_idl
*);
61 void ovsdb_idl_wait(struct ovsdb_idl
*);
63 void ovsdb_idl_set_lock(struct ovsdb_idl
*, const char *lock_name
);
64 bool ovsdb_idl_has_lock(const struct ovsdb_idl
*);
65 bool ovsdb_idl_is_lock_contended(const struct ovsdb_idl
*);
67 const struct uuid
* ovsdb_idl_get_monitor_id(const struct ovsdb_idl
*);
68 unsigned int ovsdb_idl_get_seqno(const struct ovsdb_idl
*);
69 bool ovsdb_idl_has_ever_connected(const struct ovsdb_idl
*);
70 void ovsdb_idl_enable_reconnect(struct ovsdb_idl
*);
71 void ovsdb_idl_force_reconnect(struct ovsdb_idl
*);
72 void ovsdb_idl_verify_write_only(struct ovsdb_idl
*);
74 bool ovsdb_idl_is_alive(const struct ovsdb_idl
*);
75 int ovsdb_idl_get_last_error(const struct ovsdb_idl
*);
77 void ovsdb_idl_set_probe_interval(const struct ovsdb_idl
*, int probe_interval
);
79 /* Choosing columns and tables to replicate. */
81 /* Modes with which the IDL can monitor a column.
83 * If no bits are set, the column is not monitored at all. Its value will
84 * always appear to the client to be the default value for its type.
86 * If OVSDB_IDL_MONITOR is set, then the column is replicated. Its value will
87 * reflect the value in the database. If OVSDB_IDL_ALERT is also set, then the
88 * value returned by ovsdb_idl_get_seqno() will change when the column's value
91 * The possible mode combinations are:
93 * - 0, for a column that a client doesn't care about.
95 * - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT), for a column that a client wants
96 * to track and possibly update.
98 * - OVSDB_IDL_MONITOR, for columns that a client treats as "write-only",
99 * that is, it updates them but doesn't want to get alerted about its own
100 * updates. It also won't be alerted about other clients' updates, so this
101 * is suitable only for use by a client that "owns" a particular column.
103 * - OVDSB_IDL_ALERT without OVSDB_IDL_MONITOR is not valid.
105 * - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT | OVSDB_IDL_TRACK), for a column
106 * that a client wants to track using the change tracking
107 * ovsdb_idl_track_get_*() functions.
109 #define OVSDB_IDL_MONITOR (1 << 0) /* Monitor this column? */
110 #define OVSDB_IDL_ALERT (1 << 1) /* Alert client when column updated? */
111 #define OVSDB_IDL_TRACK (1 << 2)
113 void ovsdb_idl_add_column(struct ovsdb_idl
*, const struct ovsdb_idl_column
*);
114 void ovsdb_idl_add_table(struct ovsdb_idl
*,
115 const struct ovsdb_idl_table_class
*);
117 void ovsdb_idl_omit(struct ovsdb_idl
*, const struct ovsdb_idl_column
*);
118 void ovsdb_idl_omit_alert(struct ovsdb_idl
*, const struct ovsdb_idl_column
*);
122 * In OVSDB, change tracking is applied at each client in the IDL layer. This
123 * means that when a client makes a request to track changes on a particular
124 * table, they are essentially requesting information about the incremental
125 * changes to that table from the point in time that the request is made. Once
126 * the client clears tracked changes, that information will no longer be
129 * The implication of the above is that if a client requires replaying
130 * untracked history, it faces the choice of either trying to remember changes
131 * itself (which translates into a memory leak) or of being structured with a
132 * path for processing the full untracked table as well as a path that
133 * processes incremental changes. */
134 enum ovsdb_idl_change
{
135 OVSDB_IDL_CHANGE_INSERT
,
136 OVSDB_IDL_CHANGE_MODIFY
,
137 OVSDB_IDL_CHANGE_DELETE
,
141 /* Row, table sequence numbers */
142 unsigned int ovsdb_idl_table_get_seqno(
143 const struct ovsdb_idl
*idl
,
144 const struct ovsdb_idl_table_class
*table_class
);
145 unsigned int ovsdb_idl_row_get_seqno(
146 const struct ovsdb_idl_row
*row
,
147 enum ovsdb_idl_change change
);
149 void ovsdb_idl_track_add_column(struct ovsdb_idl
*idl
,
150 const struct ovsdb_idl_column
*column
);
151 void ovsdb_idl_track_add_all(struct ovsdb_idl
*idl
);
152 const struct ovsdb_idl_row
*ovsdb_idl_track_get_first(
153 const struct ovsdb_idl
*, const struct ovsdb_idl_table_class
*);
154 const struct ovsdb_idl_row
*ovsdb_idl_track_get_next(const struct ovsdb_idl_row
*);
155 bool ovsdb_idl_track_is_updated(const struct ovsdb_idl_row
*row
,
156 const struct ovsdb_idl_column
*column
);
157 void ovsdb_idl_track_clear(const struct ovsdb_idl
*);
160 /* Reading the database replica. */
162 const struct ovsdb_idl_row
*ovsdb_idl_get_row_for_uuid(
163 const struct ovsdb_idl
*, const struct ovsdb_idl_table_class
*,
164 const struct uuid
*);
165 const struct ovsdb_idl_row
*ovsdb_idl_first_row(
166 const struct ovsdb_idl
*, const struct ovsdb_idl_table_class
*);
167 const struct ovsdb_idl_row
*ovsdb_idl_next_row(const struct ovsdb_idl_row
*);
169 const struct ovsdb_datum
*ovsdb_idl_read(const struct ovsdb_idl_row
*,
170 const struct ovsdb_idl_column
*);
171 const struct ovsdb_datum
*ovsdb_idl_get(const struct ovsdb_idl_row
*,
172 const struct ovsdb_idl_column
*,
173 enum ovsdb_atomic_type key_type
,
174 enum ovsdb_atomic_type value_type
);
175 bool ovsdb_idl_is_mutable(const struct ovsdb_idl_row
*,
176 const struct ovsdb_idl_column
*);
178 bool ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row
*);
182 * A transaction may modify the contents of a database by modifying the values
183 * of columns, deleting rows, inserting rows, or adding checks that columns in
184 * the database have not changed ("verify" operations), through
185 * ovsdb_idl_txn_*() functions. (The OVSDB IDL code generator produces helper
186 * functions that internally call the ovsdb_idl_txn_*() functions. These are
187 * likely to be more convenient.)
189 * Reading and writing columns and inserting and deleting rows are all
190 * straightforward. The reasons to verify columns are less obvious.
191 * Verification is the key to maintaining transactional integrity. Because
192 * OVSDB handles multiple clients, it can happen that between the time that
193 * OVSDB client A reads a column and writes a new value, OVSDB client B has
194 * written that column. Client A's write should not ordinarily overwrite
195 * client B's, especially if the column in question is a "map" column that
196 * contains several more or less independent data items. If client A adds a
197 * "verify" operation before it writes the column, then the transaction fails
198 * in case client B modifies it first. Client A will then see the new value of
199 * the column and compose a new transaction based on the new contents written
202 * When a transaction is complete, which must be before the next call to
203 * ovsdb_idl_run() on 'idl', call ovsdb_idl_txn_commit() or
204 * ovsdb_idl_txn_abort().
206 * The life-cycle of a transaction looks like this:
208 * 1. Create the transaction and record the initial sequence number:
210 * seqno = ovsdb_idl_get_seqno(idl);
211 * txn = ovsdb_idl_txn_create(idl);
213 * 2. Modify the database with ovsdb_idl_txn_*() functions directly or
216 * 3. Commit the transaction by calling ovsdb_idl_txn_commit(). The first call
217 * to this function probably returns TXN_INCOMPLETE. The client must keep
218 * calling again along as this remains true, calling ovsdb_idl_run() in
219 * between to let the IDL do protocol processing. (If the client doesn't
220 * have anything else to do in the meantime, it can use
221 * ovsdb_idl_txn_commit_block() to avoid having to loop itself.)
223 * 4. If the final status is TXN_TRY_AGAIN, wait for ovsdb_idl_get_seqno() to
224 * change from the saved 'seqno' (it's possible that it's already changed,
225 * in which case the client should not wait at all), then start over from
226 * step 1. Only a call to ovsdb_idl_run() will change the return value of
227 * ovsdb_idl_get_seqno(). (ovsdb_idl_txn_commit_block() calls
231 enum ovsdb_idl_txn_status
{
232 TXN_UNCOMMITTED
, /* Not yet committed or aborted. */
233 TXN_UNCHANGED
, /* Transaction didn't include any changes. */
234 TXN_INCOMPLETE
, /* Commit in progress, please wait. */
235 TXN_ABORTED
, /* ovsdb_idl_txn_abort() called. */
236 TXN_SUCCESS
, /* Commit successful. */
237 TXN_TRY_AGAIN
, /* Commit failed because a "verify" operation
238 * reported an inconsistency, due to a network
239 * problem, or other transient failure. Wait
240 * for a change, then try again. */
241 TXN_NOT_LOCKED
, /* Server hasn't given us the lock yet. */
242 TXN_ERROR
/* Commit failed due to a hard error. */
245 const char *ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status
);
247 struct ovsdb_idl_txn
*ovsdb_idl_txn_create(struct ovsdb_idl
*);
248 void ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn
*, const char *, ...)
249 OVS_PRINTF_FORMAT (2, 3);
250 void ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn
*);
251 void ovsdb_idl_txn_increment(struct ovsdb_idl_txn
*,
252 const struct ovsdb_idl_row
*,
253 const struct ovsdb_idl_column
*,
255 void ovsdb_idl_txn_destroy(struct ovsdb_idl_txn
*);
256 void ovsdb_idl_txn_wait(const struct ovsdb_idl_txn
*);
257 enum ovsdb_idl_txn_status
ovsdb_idl_txn_commit(struct ovsdb_idl_txn
*);
258 enum ovsdb_idl_txn_status
ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn
*);
259 void ovsdb_idl_txn_abort(struct ovsdb_idl_txn
*);
261 const char *ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn
*);
263 int64_t ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn
*);
264 const struct uuid
*ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn
*,
265 const struct uuid
*);
267 void ovsdb_idl_txn_write(const struct ovsdb_idl_row
*,
268 const struct ovsdb_idl_column
*,
269 struct ovsdb_datum
*);
270 void ovsdb_idl_txn_write_clone(const struct ovsdb_idl_row
*,
271 const struct ovsdb_idl_column
*,
272 const struct ovsdb_datum
*);
273 void ovsdb_idl_txn_write_partial_map(const struct ovsdb_idl_row
*,
274 const struct ovsdb_idl_column
*,
275 struct ovsdb_datum
*);
276 void ovsdb_idl_txn_delete_partial_map(const struct ovsdb_idl_row
*,
277 const struct ovsdb_idl_column
*,
278 struct ovsdb_datum
*);
279 void ovsdb_idl_txn_write_partial_set(const struct ovsdb_idl_row
*,
280 const struct ovsdb_idl_column
*,
281 struct ovsdb_datum
*);
282 void ovsdb_idl_txn_delete_partial_set(const struct ovsdb_idl_row
*,
283 const struct ovsdb_idl_column
*,
284 struct ovsdb_datum
*);
285 void ovsdb_idl_txn_delete(const struct ovsdb_idl_row
*);
286 const struct ovsdb_idl_row
*ovsdb_idl_txn_insert(
287 struct ovsdb_idl_txn
*, const struct ovsdb_idl_table_class
*,
288 const struct uuid
*);
290 struct ovsdb_idl
*ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn
*);
291 void ovsdb_idl_get_initial_snapshot(struct ovsdb_idl
*);
294 /* ovsdb_idl_loop provides an easy way to manage the transactions related
295 * to 'idl' and to cope with different status during transaction. */
296 struct ovsdb_idl_loop
{
297 struct ovsdb_idl
*idl
;
298 unsigned int skip_seqno
;
300 struct ovsdb_idl_txn
*committing_txn
;
301 unsigned int precommit_seqno
;
303 struct ovsdb_idl_txn
*open_txn
;
305 /* These members allow a client a simple, stateless way to keep track of
306 * transactions that commit: when a transaction commits successfully,
307 * ovsdb_idl_loop_commit_and_wait() copies 'next_cfg' to 'cur_cfg'. Thus,
308 * the client can set 'next_cfg' to a value that indicates a successful
309 * commit and check 'cur_cfg' on each iteration. */
314 #define OVSDB_IDL_LOOP_INITIALIZER(IDL) { .idl = (IDL) }
316 void ovsdb_idl_loop_destroy(struct ovsdb_idl_loop
*);
317 struct ovsdb_idl_txn
*ovsdb_idl_loop_run(struct ovsdb_idl_loop
*);
318 int ovsdb_idl_loop_commit_and_wait(struct ovsdb_idl_loop
*);
320 /* Conditional Replication
321 * =======================
323 * By default, when the IDL replicates a particular table in the database, it
324 * replicates every row in the table. These functions allow the client to
325 * specify that only selected rows should be replicated, by constructing a
326 * per-table condition that specifies the rows to replicate.
329 void ovsdb_idl_condition_reset(struct ovsdb_idl
*idl
,
330 const struct ovsdb_idl_table_class
*tc
);
331 void ovsdb_idl_condition_add_clause(struct ovsdb_idl
*idl
,
332 const struct ovsdb_idl_table_class
*tc
,
333 enum ovsdb_function function
,
334 const struct ovsdb_idl_column
*column
,
335 const struct ovsdb_datum
*arg
);
336 void ovsdb_idl_condition_remove_clause(struct ovsdb_idl
*idl
,
337 const struct ovsdb_idl_table_class
*tc
,
338 enum ovsdb_function function
,
339 const struct ovsdb_idl_column
*column
,
340 const struct ovsdb_datum
*arg
);
342 #endif /* ovsdb-idl.h */