]>
Commit | Line | Data |
---|---|---|
cfea354b | 1 | /* Copyright (c) 2009, 2010, 2011 Nicira Networks. |
c3bb4bd7 BP |
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 | ||
2ce42c88 BP |
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 also assists with issuing database transactions. The client creates | |
27 | * a transaction, manipulates the IDL data structures, and commits or aborts | |
28 | * the transaction. The IDL then composes and issues the necessary JSON-RPC | |
29 | * requests and reports to the client whether the transaction completed | |
30 | * successfully. | |
31 | */ | |
32 | ||
f3d64521 | 33 | #include <stdbool.h> |
b54e22e9 | 34 | #include <stdint.h> |
e1c0e2d1 | 35 | #include "compiler.h" |
8c3c2f30 | 36 | #include "ovsdb-types.h" |
b54e22e9 BP |
37 | |
38 | struct json; | |
979821c0 | 39 | struct ovsdb_datum; |
c3bb4bd7 | 40 | struct ovsdb_idl_class; |
979821c0 BP |
41 | struct ovsdb_idl_column; |
42 | struct ovsdb_idl_table_class; | |
43 | struct uuid; | |
c3bb4bd7 BP |
44 | |
45 | struct ovsdb_idl *ovsdb_idl_create(const char *remote, | |
ef73f86c BP |
46 | const struct ovsdb_idl_class *, |
47 | bool monitor_everything_by_default); | |
c3bb4bd7 BP |
48 | void ovsdb_idl_destroy(struct ovsdb_idl *); |
49 | ||
4ea21243 | 50 | bool ovsdb_idl_run(struct ovsdb_idl *); |
c3bb4bd7 BP |
51 | void ovsdb_idl_wait(struct ovsdb_idl *); |
52 | ||
06b6d651 BP |
53 | void ovsdb_idl_set_lock(struct ovsdb_idl *, const char *lock_name); |
54 | bool ovsdb_idl_has_lock(const struct ovsdb_idl *); | |
55 | bool ovsdb_idl_is_lock_contended(const struct ovsdb_idl *); | |
56 | ||
c3bb4bd7 | 57 | unsigned int ovsdb_idl_get_seqno(const struct ovsdb_idl *); |
f3d64521 | 58 | bool ovsdb_idl_has_ever_connected(const struct ovsdb_idl *); |
c3bb4bd7 | 59 | void ovsdb_idl_force_reconnect(struct ovsdb_idl *); |
ef73f86c BP |
60 | \f |
61 | /* Choosing columns and tables to replicate. */ | |
62 | ||
63 | /* Modes with which the IDL can monitor a column. | |
64 | * | |
65 | * If no bits are set, the column is not monitored at all. Its value will | |
66 | * always appear to the client to be the default value for its type. | |
67 | * | |
68 | * If OVSDB_IDL_MONITOR is set, then the column is replicated. Its value will | |
69 | * reflect the value in the database. If OVSDB_IDL_ALERT is also set, then | |
70 | * ovsdb_idl_run() will return "true", and the value returned by | |
71 | * ovsdb_idl_get_seqno() will change, when the column's value changes. | |
72 | * | |
73 | * The possible mode combinations are: | |
74 | * | |
75 | * - 0, for a column that a client doesn't care about. | |
76 | * | |
77 | * - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT), for a column that a client wants | |
78 | * to track and possibly update. | |
79 | * | |
80 | * - OVSDB_IDL_MONITOR, for columns that a client treats as "write-only", | |
81 | * that is, it updates them but doesn't want to get alerted about its own | |
82 | * updates. It also won't be alerted about other clients' updates, so this | |
83 | * is suitable only for use by a client that "owns" a particular column. | |
84 | * | |
85 | * - OVDSB_IDL_ALERT without OVSDB_IDL_MONITOR is not valid. | |
86 | */ | |
87 | #define OVSDB_IDL_MONITOR (1 << 0) /* Monitor this column? */ | |
88 | #define OVSDB_IDL_ALERT (1 << 1) /* Alert client when column updated? */ | |
89 | ||
90 | void ovsdb_idl_add_column(struct ovsdb_idl *, const struct ovsdb_idl_column *); | |
91 | void ovsdb_idl_add_table(struct ovsdb_idl *, | |
92 | const struct ovsdb_idl_table_class *); | |
c3bb4bd7 | 93 | |
c547535a | 94 | void ovsdb_idl_omit(struct ovsdb_idl *, const struct ovsdb_idl_column *); |
ef73f86c BP |
95 | void ovsdb_idl_omit_alert(struct ovsdb_idl *, const struct ovsdb_idl_column *); |
96 | \f | |
97 | /* Reading the database replica. */ | |
c547535a | 98 | |
979821c0 BP |
99 | const struct ovsdb_idl_row *ovsdb_idl_get_row_for_uuid( |
100 | const struct ovsdb_idl *, const struct ovsdb_idl_table_class *, | |
101 | const struct uuid *); | |
102 | const struct ovsdb_idl_row *ovsdb_idl_first_row( | |
103 | const struct ovsdb_idl *, const struct ovsdb_idl_table_class *); | |
104 | const struct ovsdb_idl_row *ovsdb_idl_next_row(const struct ovsdb_idl_row *); | |
105 | ||
8c3c2f30 BP |
106 | const struct ovsdb_datum *ovsdb_idl_read(const struct ovsdb_idl_row *, |
107 | const struct ovsdb_idl_column *); | |
108 | const struct ovsdb_datum *ovsdb_idl_get(const struct ovsdb_idl_row *, | |
109 | const struct ovsdb_idl_column *, | |
110 | enum ovsdb_atomic_type key_type, | |
111 | enum ovsdb_atomic_type value_type); | |
cfea354b BP |
112 | |
113 | bool ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *); | |
ef73f86c BP |
114 | \f |
115 | /* Transactions. */ | |
8c3c2f30 | 116 | |
475281c0 | 117 | enum ovsdb_idl_txn_status { |
2096903b | 118 | TXN_UNCOMMITTED, /* Not yet committed or aborted. */ |
b54e22e9 | 119 | TXN_UNCHANGED, /* Transaction didn't include any changes. */ |
475281c0 BP |
120 | TXN_INCOMPLETE, /* Commit in progress, please wait. */ |
121 | TXN_ABORTED, /* ovsdb_idl_txn_abort() called. */ | |
122 | TXN_SUCCESS, /* Commit successful. */ | |
123 | TXN_TRY_AGAIN, /* Commit failed because a "verify" operation | |
124 | * reported an inconsistency, due to a network | |
125 | * problem, or other transient failure. */ | |
06b6d651 | 126 | TXN_NOT_LOCKED, /* Server hasn't given us the lock yet. */ |
475281c0 BP |
127 | TXN_ERROR /* Commit failed due to a hard error. */ |
128 | }; | |
129 | ||
130 | const char *ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status); | |
131 | ||
132 | struct ovsdb_idl_txn *ovsdb_idl_txn_create(struct ovsdb_idl *); | |
e1c0e2d1 BP |
133 | void ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *, const char *, ...) |
134 | PRINTF_FORMAT (2, 3); | |
577aebdf | 135 | void ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *); |
b54e22e9 BP |
136 | void ovsdb_idl_txn_increment(struct ovsdb_idl_txn *, const char *table, |
137 | const char *column, const struct json *where); | |
475281c0 | 138 | void ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *); |
586bb84a | 139 | void ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *); |
475281c0 | 140 | enum ovsdb_idl_txn_status ovsdb_idl_txn_commit(struct ovsdb_idl_txn *); |
af96ccd2 | 141 | enum ovsdb_idl_txn_status ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *); |
475281c0 BP |
142 | void ovsdb_idl_txn_abort(struct ovsdb_idl_txn *); |
143 | ||
91e310a5 BP |
144 | const char *ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *); |
145 | ||
69490970 BP |
146 | int64_t ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *); |
147 | const struct uuid *ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *, | |
148 | const struct uuid *); | |
149 | ||
979821c0 BP |
150 | void ovsdb_idl_txn_write(const struct ovsdb_idl_row *, |
151 | const struct ovsdb_idl_column *, | |
152 | struct ovsdb_datum *); | |
9e336f49 BP |
153 | void ovsdb_idl_txn_delete(const struct ovsdb_idl_row *); |
154 | const struct ovsdb_idl_row *ovsdb_idl_txn_insert( | |
ce5a3e38 BP |
155 | struct ovsdb_idl_txn *, const struct ovsdb_idl_table_class *, |
156 | const struct uuid *); | |
979821c0 | 157 | |
1e86ae6f BP |
158 | struct ovsdb_idl *ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *); |
159 | ||
c3bb4bd7 | 160 | #endif /* ovsdb-idl.h */ |