1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
2 * Copyright (C) 2016 Hewlett Packard Enterprise Development LP
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 /* Open vSwitch Database Interface Definition Language (OVSDB IDL).
22 * The OVSDB IDL maintains an in-memory replica of a database. It issues RPC
23 * requests to an OVSDB database server and parses the responses, converting
24 * raw JSON into data structures that are easier for clients to digest. Most
25 * notably, references to rows via UUID become C pointers.
27 * The IDL always presents a consistent snapshot of the database to its client,
28 * that is, it won't present the effects of some part of a transaction applied
29 * at the database server without presenting all of its effects.
31 * The IDL also assists with issuing database transactions. The client creates
32 * a transaction, manipulates the IDL data structures, and commits or aborts
33 * the transaction. The IDL then composes and issues the necessary JSON-RPC
34 * requests and reports to the client whether the transaction completed
41 #include "ovsdb-types.h"
42 #include "ovsdb-data.h"
43 #include "openvswitch/list.h"
44 #include "ovsdb-condition.h"
53 struct ovsdb_idl_class
;
55 struct ovsdb_idl_column
;
56 struct ovsdb_idl_table_class
;
59 struct ovsdb_idl
*ovsdb_idl_create(const char *remote
,
60 const struct ovsdb_idl_class
*,
61 bool monitor_everything_by_default
,
63 void ovsdb_idl_set_remote(struct ovsdb_idl
*, const char *, bool);
64 void ovsdb_idl_destroy(struct ovsdb_idl
*);
66 void ovsdb_idl_set_leader_only(struct ovsdb_idl
*, bool leader_only
);
68 void ovsdb_idl_run(struct ovsdb_idl
*);
69 void ovsdb_idl_wait(struct ovsdb_idl
*);
71 void ovsdb_idl_set_lock(struct ovsdb_idl
*, const char *lock_name
);
72 bool ovsdb_idl_has_lock(const struct ovsdb_idl
*);
73 bool ovsdb_idl_is_lock_contended(const struct ovsdb_idl
*);
75 const struct uuid
* ovsdb_idl_get_monitor_id(const struct ovsdb_idl
*);
76 unsigned int ovsdb_idl_get_seqno(const struct ovsdb_idl
*);
77 bool ovsdb_idl_has_ever_connected(const struct ovsdb_idl
*);
78 void ovsdb_idl_enable_reconnect(struct ovsdb_idl
*);
79 void ovsdb_idl_force_reconnect(struct ovsdb_idl
*);
80 void ovsdb_idl_verify_write_only(struct ovsdb_idl
*);
82 bool ovsdb_idl_is_alive(const struct ovsdb_idl
*);
83 bool ovsdb_idl_is_connected(const struct ovsdb_idl
*idl
);
84 int ovsdb_idl_get_last_error(const struct ovsdb_idl
*);
86 void ovsdb_idl_set_probe_interval(const struct ovsdb_idl
*, int probe_interval
);
88 void ovsdb_idl_check_consistency(const struct ovsdb_idl
*);
90 const struct ovsdb_idl_class
*ovsdb_idl_get_class(const struct ovsdb_idl
*);
91 const struct ovsdb_idl_table_class
*ovsdb_idl_table_class_from_column(
92 const struct ovsdb_idl_class
*, const struct ovsdb_idl_column
*);
94 /* Choosing columns and tables to replicate. */
96 /* Modes with which the IDL can monitor a column.
98 * If no bits are set, the column is not monitored at all. Its value will
99 * always appear to the client to be the default value for its type.
101 * If OVSDB_IDL_MONITOR is set, then the column is replicated. Its value will
102 * reflect the value in the database. If OVSDB_IDL_ALERT is also set, then the
103 * value returned by ovsdb_idl_get_seqno() will change when the column's value
106 * The possible mode combinations are:
108 * - 0, for a column that a client doesn't care about.
110 * - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT), for a column that a client wants
111 * to track and possibly update.
113 * - OVSDB_IDL_MONITOR, for columns that a client treats as "write-only",
114 * that is, it updates them but doesn't want to get alerted about its own
115 * updates. It also won't be alerted about other clients' updates, so this
116 * is suitable only for use by a client that "owns" a particular column.
118 * - OVDSB_IDL_ALERT without OVSDB_IDL_MONITOR is not valid.
120 * - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT | OVSDB_IDL_TRACK), for a column
121 * that a client wants to track using the change tracking
122 * ovsdb_idl_track_get_*() functions.
124 #define OVSDB_IDL_MONITOR (1 << 0) /* Monitor this column? */
125 #define OVSDB_IDL_ALERT (1 << 1) /* Alert client when column updated? */
126 #define OVSDB_IDL_TRACK (1 << 2)
128 void ovsdb_idl_add_column(struct ovsdb_idl
*, const struct ovsdb_idl_column
*);
129 void ovsdb_idl_add_table(struct ovsdb_idl
*,
130 const struct ovsdb_idl_table_class
*);
132 void ovsdb_idl_omit(struct ovsdb_idl
*, const struct ovsdb_idl_column
*);
133 void ovsdb_idl_omit_alert(struct ovsdb_idl
*, const struct ovsdb_idl_column
*);
137 * In OVSDB, change tracking is applied at each client in the IDL layer. This
138 * means that when a client makes a request to track changes on a particular
139 * table, they are essentially requesting information about the incremental
140 * changes to that table from the point in time that the request is made. Once
141 * the client clears tracked changes, that information will no longer be
144 * The implication of the above is that if a client requires replaying
145 * untracked history, it faces the choice of either trying to remember changes
146 * itself (which translates into a memory leak) or of being structured with a
147 * path for processing the full untracked table as well as a path that
148 * processes incremental changes. */
149 enum ovsdb_idl_change
{
150 OVSDB_IDL_CHANGE_INSERT
,
151 OVSDB_IDL_CHANGE_MODIFY
,
152 OVSDB_IDL_CHANGE_DELETE
,
156 /* Row, table sequence numbers */
157 unsigned int ovsdb_idl_table_get_seqno(
158 const struct ovsdb_idl
*idl
,
159 const struct ovsdb_idl_table_class
*table_class
);
160 unsigned int ovsdb_idl_row_get_seqno(
161 const struct ovsdb_idl_row
*row
,
162 enum ovsdb_idl_change change
);
164 void ovsdb_idl_track_add_column(struct ovsdb_idl
*idl
,
165 const struct ovsdb_idl_column
*column
);
166 void ovsdb_idl_track_add_all(struct ovsdb_idl
*idl
);
167 const struct ovsdb_idl_row
*ovsdb_idl_track_get_first(
168 const struct ovsdb_idl
*, const struct ovsdb_idl_table_class
*);
169 const struct ovsdb_idl_row
*ovsdb_idl_track_get_next(const struct ovsdb_idl_row
*);
170 bool ovsdb_idl_track_is_updated(const struct ovsdb_idl_row
*row
,
171 const struct ovsdb_idl_column
*column
);
172 void ovsdb_idl_track_clear(struct ovsdb_idl
*);
175 /* Reading the database replica. */
177 const struct ovsdb_idl_row
*ovsdb_idl_get_row_for_uuid(
178 const struct ovsdb_idl
*, const struct ovsdb_idl_table_class
*,
179 const struct uuid
*);
180 const struct ovsdb_idl_row
*ovsdb_idl_first_row(
181 const struct ovsdb_idl
*, const struct ovsdb_idl_table_class
*);
182 const struct ovsdb_idl_row
*ovsdb_idl_next_row(const struct ovsdb_idl_row
*);
184 const struct ovsdb_datum
*ovsdb_idl_read(const struct ovsdb_idl_row
*,
185 const struct ovsdb_idl_column
*);
186 const struct ovsdb_datum
*ovsdb_idl_get(const struct ovsdb_idl_row
*,
187 const struct ovsdb_idl_column
*,
188 enum ovsdb_atomic_type key_type
,
189 enum ovsdb_atomic_type value_type
);
190 bool ovsdb_idl_is_mutable(const struct ovsdb_idl_row
*,
191 const struct ovsdb_idl_column
*);
193 bool ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row
*);
197 * A transaction may modify the contents of a database by modifying the values
198 * of columns, deleting rows, inserting rows, or adding checks that columns in
199 * the database have not changed ("verify" operations), through
200 * ovsdb_idl_txn_*() functions. (The OVSDB IDL code generator produces helper
201 * functions that internally call the ovsdb_idl_txn_*() functions. These are
202 * likely to be more convenient.)
204 * Reading and writing columns and inserting and deleting rows are all
205 * straightforward. The reasons to verify columns are less obvious.
206 * Verification is the key to maintaining transactional integrity. Because
207 * OVSDB handles multiple clients, it can happen that between the time that
208 * OVSDB client A reads a column and writes a new value, OVSDB client B has
209 * written that column. Client A's write should not ordinarily overwrite
210 * client B's, especially if the column in question is a "map" column that
211 * contains several more or less independent data items. If client A adds a
212 * "verify" operation before it writes the column, then the transaction fails
213 * in case client B modifies it first. Client A will then see the new value of
214 * the column and compose a new transaction based on the new contents written
217 * When a transaction is complete, which must be before the next call to
218 * ovsdb_idl_run() on 'idl', call ovsdb_idl_txn_commit() or
219 * ovsdb_idl_txn_abort().
221 * The life-cycle of a transaction looks like this:
223 * 1. Create the transaction and record the initial sequence number:
225 * seqno = ovsdb_idl_get_seqno(idl);
226 * txn = ovsdb_idl_txn_create(idl);
228 * 2. Modify the database with ovsdb_idl_txn_*() functions directly or
231 * 3. Commit the transaction by calling ovsdb_idl_txn_commit(). The first call
232 * to this function probably returns TXN_INCOMPLETE. The client must keep
233 * calling again along as this remains true, calling ovsdb_idl_run() in
234 * between to let the IDL do protocol processing. (If the client doesn't
235 * have anything else to do in the meantime, it can use
236 * ovsdb_idl_txn_commit_block() to avoid having to loop itself.)
238 * 4. If the final status is TXN_TRY_AGAIN, wait for ovsdb_idl_get_seqno() to
239 * change from the saved 'seqno' (it's possible that it's already changed,
240 * in which case the client should not wait at all), then start over from
241 * step 1. Only a call to ovsdb_idl_run() will change the return value of
242 * ovsdb_idl_get_seqno(). (ovsdb_idl_txn_commit_block() calls
246 enum ovsdb_idl_txn_status
{
247 TXN_UNCOMMITTED
, /* Not yet committed or aborted. */
248 TXN_UNCHANGED
, /* Transaction didn't include any changes. */
249 TXN_INCOMPLETE
, /* Commit in progress, please wait. */
250 TXN_ABORTED
, /* ovsdb_idl_txn_abort() called. */
251 TXN_SUCCESS
, /* Commit successful. */
252 TXN_TRY_AGAIN
, /* Commit failed because a "verify" operation
253 * reported an inconsistency, due to a network
254 * problem, or other transient failure. Wait
255 * for a change, then try again. */
256 TXN_NOT_LOCKED
, /* Server hasn't given us the lock yet. */
257 TXN_ERROR
/* Commit failed due to a hard error. */
260 const char *ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status
);
262 struct ovsdb_idl_txn
*ovsdb_idl_txn_create(struct ovsdb_idl
*);
263 void ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn
*, const char *, ...)
264 OVS_PRINTF_FORMAT (2, 3);
265 void ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn
*);
266 void ovsdb_idl_txn_increment(struct ovsdb_idl_txn
*,
267 const struct ovsdb_idl_row
*,
268 const struct ovsdb_idl_column
*,
270 void ovsdb_idl_txn_destroy(struct ovsdb_idl_txn
*);
271 void ovsdb_idl_txn_wait(const struct ovsdb_idl_txn
*);
272 enum ovsdb_idl_txn_status
ovsdb_idl_txn_commit(struct ovsdb_idl_txn
*);
273 enum ovsdb_idl_txn_status
ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn
*);
274 void ovsdb_idl_txn_abort(struct ovsdb_idl_txn
*);
276 const char *ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn
*);
278 int64_t ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn
*);
279 const struct uuid
*ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn
*,
280 const struct uuid
*);
282 void ovsdb_idl_txn_write(const struct ovsdb_idl_row
*,
283 const struct ovsdb_idl_column
*,
284 struct ovsdb_datum
*);
285 void ovsdb_idl_txn_write_clone(const struct ovsdb_idl_row
*,
286 const struct ovsdb_idl_column
*,
287 const struct ovsdb_datum
*);
288 void ovsdb_idl_txn_write_partial_map(const struct ovsdb_idl_row
*,
289 const struct ovsdb_idl_column
*,
290 struct ovsdb_datum
*);
291 void ovsdb_idl_txn_delete_partial_map(const struct ovsdb_idl_row
*,
292 const struct ovsdb_idl_column
*,
293 struct ovsdb_datum
*);
294 void ovsdb_idl_txn_write_partial_set(const struct ovsdb_idl_row
*,
295 const struct ovsdb_idl_column
*,
296 struct ovsdb_datum
*);
297 void ovsdb_idl_txn_delete_partial_set(const struct ovsdb_idl_row
*,
298 const struct ovsdb_idl_column
*,
299 struct ovsdb_datum
*);
300 void ovsdb_idl_txn_delete(const struct ovsdb_idl_row
*);
301 const struct ovsdb_idl_row
*ovsdb_idl_txn_insert(
302 struct ovsdb_idl_txn
*, const struct ovsdb_idl_table_class
*,
303 const struct uuid
*);
305 struct ovsdb_idl
*ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn
*);
306 void ovsdb_idl_get_initial_snapshot(struct ovsdb_idl
*);
309 /* ovsdb_idl_loop provides an easy way to manage the transactions related
310 * to 'idl' and to cope with different status during transaction. */
311 struct ovsdb_idl_loop
{
312 struct ovsdb_idl
*idl
;
313 unsigned int skip_seqno
;
315 struct ovsdb_idl_txn
*committing_txn
;
316 unsigned int precommit_seqno
;
318 struct ovsdb_idl_txn
*open_txn
;
320 /* These members allow a client a simple, stateless way to keep track of
321 * transactions that commit: when a transaction commits successfully,
322 * ovsdb_idl_loop_commit_and_wait() copies 'next_cfg' to 'cur_cfg'. Thus,
323 * the client can set 'next_cfg' to a value that indicates a successful
324 * commit and check 'cur_cfg' on each iteration. */
329 #define OVSDB_IDL_LOOP_INITIALIZER(IDL) { .idl = (IDL) }
331 void ovsdb_idl_loop_destroy(struct ovsdb_idl_loop
*);
332 struct ovsdb_idl_txn
*ovsdb_idl_loop_run(struct ovsdb_idl_loop
*);
333 int ovsdb_idl_loop_commit_and_wait(struct ovsdb_idl_loop
*);
335 /* Conditional Replication
336 * =======================
338 * By default, when the IDL replicates a particular table in the database, it
339 * replicates every row in the table. These functions allow the client to
340 * specify that only selected rows should be replicated, by constructing a
341 * per-table condition that specifies the rows to replicate.
343 * A condition is a disjunction of clauses. The condition is true, and thus a
344 * row is replicated, if any of the clauses evaluates to true for a given row.
345 * (Thus, a condition with no clauses is always false.)
348 struct ovsdb_idl_condition
{
349 struct hmap clauses
; /* Contains "struct ovsdb_idl_clause"s. */
350 bool is_true
; /* Is the condition unconditionally true? */
352 #define OVSDB_IDL_CONDITION_INIT(CONDITION) \
353 { HMAP_INITIALIZER(&(CONDITION)->clauses), false }
355 void ovsdb_idl_condition_init(struct ovsdb_idl_condition
*);
356 void ovsdb_idl_condition_clear(struct ovsdb_idl_condition
*);
357 void ovsdb_idl_condition_destroy(struct ovsdb_idl_condition
*);
358 void ovsdb_idl_condition_add_clause(struct ovsdb_idl_condition
*,
359 enum ovsdb_function function
,
360 const struct ovsdb_idl_column
*column
,
361 const struct ovsdb_datum
*arg
);
362 void ovsdb_idl_condition_add_clause_true(struct ovsdb_idl_condition
*);
363 bool ovsdb_idl_condition_is_true(const struct ovsdb_idl_condition
*);
365 unsigned int ovsdb_idl_set_condition(struct ovsdb_idl
*,
366 const struct ovsdb_idl_table_class
*,
367 const struct ovsdb_idl_condition
*);
369 unsigned int ovsdb_idl_get_condition_seqno(const struct ovsdb_idl
*);
371 /* Indexes over one or more columns in the IDL, to retrieve rows matching
372 * particular search criteria and to iterate over a subset of rows in a defined
375 enum ovsdb_index_order
{
376 OVSDB_INDEX_ASC
, /* 0, 1, 2, ... */
377 OVSDB_INDEX_DESC
/* 2, 1, 0, ... */
380 typedef int column_comparator_func(const void *a
, const void *b
);
382 struct ovsdb_idl_index_column
{
383 const struct ovsdb_idl_column
*column
;
384 column_comparator_func
*comparer
;
385 enum ovsdb_index_order order
;
388 /* Creating an index. */
389 struct ovsdb_idl_index
*ovsdb_idl_index_create(
390 struct ovsdb_idl
*, const struct ovsdb_idl_index_column
*, size_t n
);
391 struct ovsdb_idl_index
*ovsdb_idl_index_create1(
392 struct ovsdb_idl
*, const struct ovsdb_idl_column
*);
393 struct ovsdb_idl_index
*ovsdb_idl_index_create2(
394 struct ovsdb_idl
*, const struct ovsdb_idl_column
*,
395 const struct ovsdb_idl_column
*);
397 /* Searching an index. */
398 struct ovsdb_idl_row
*ovsdb_idl_index_find(struct ovsdb_idl_index
*,
399 const struct ovsdb_idl_row
*);
401 /* Iteration over an index.
403 * Usually these would be invoked through table-specific wrappers generated
406 struct ovsdb_idl_cursor
{
407 struct ovsdb_idl_index
*index
; /* Index being iterated. */
408 struct skiplist_node
*position
; /* Current position in 'index'. */
411 struct ovsdb_idl_cursor
ovsdb_idl_cursor_first(struct ovsdb_idl_index
*);
412 struct ovsdb_idl_cursor
ovsdb_idl_cursor_first_eq(
413 struct ovsdb_idl_index
*, const struct ovsdb_idl_row
*);
414 struct ovsdb_idl_cursor
ovsdb_idl_cursor_first_ge(
415 struct ovsdb_idl_index
*, const struct ovsdb_idl_row
*);
417 void ovsdb_idl_cursor_next(struct ovsdb_idl_cursor
*);
418 void ovsdb_idl_cursor_next_eq(struct ovsdb_idl_cursor
*);
420 struct ovsdb_idl_row
*ovsdb_idl_cursor_data(struct ovsdb_idl_cursor
*);
426 #endif /* ovsdb-idl.h */