1 /* Copyright (c) 2009, 2010, 2011 Nicira Networks
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.
24 #include "ovsdb-data.h"
26 struct ovsdb_column_set;
30 * When a column in row A contains a weak reference to UUID of a row B this
31 * constitutes a weak reference from A (the source) to B (the destination).
33 * Rows A and B may be in the same table or different tables.
35 * Weak references from a row to itself are allowed, but no "struct
36 * ovsdb_weak_ref" structures are created for them.
38 struct ovsdb_weak_ref {
39 struct list src_node; /* In src->src_refs list. */
40 struct list dst_node; /* In destination row's dst_refs list. */
41 struct ovsdb_row *src; /* Source row. */
44 /* A row in a database table. */
46 struct ovsdb_table *table; /* Table to which this belongs. */
47 struct hmap_node hmap_node; /* Element in ovsdb_table's 'rows' hmap. */
48 struct ovsdb_txn_row *txn_row; /* Transaction that row is in, if any. */
50 /* Weak references. */
51 struct list src_refs; /* Weak references from this row. */
52 struct list dst_refs; /* Weak references to this row. */
54 /* Number of strong refs to this row from other rows, in this table or
55 * other tables, through 'uuid' columns that have a 'refTable' constraint
56 * pointing to this table and a 'refType' of "strong". A row with nonzero
57 * 'n_refs' cannot be deleted. Updated and checked only at transaction
61 struct ovsdb_datum fields[];
64 struct ovsdb_row *ovsdb_row_create(const struct ovsdb_table *);
65 struct ovsdb_row *ovsdb_row_clone(const struct ovsdb_row *);
66 void ovsdb_row_destroy(struct ovsdb_row *);
68 uint32_t ovsdb_row_hash_columns(const struct ovsdb_row *,
69 const struct ovsdb_column_set *,
71 bool ovsdb_row_equal_columns(const struct ovsdb_row *,
72 const struct ovsdb_row *,
73 const struct ovsdb_column_set *);
74 int ovsdb_row_compare_columns_3way(const struct ovsdb_row *,
75 const struct ovsdb_row *,
76 const struct ovsdb_column_set *);
77 void ovsdb_row_update_columns(struct ovsdb_row *, const struct ovsdb_row *,
78 const struct ovsdb_column_set *);
79 void ovsdb_row_columns_to_string(const struct ovsdb_row *,
80 const struct ovsdb_column_set *, struct ds *);
81 struct ovsdb_error *ovsdb_row_from_json(struct ovsdb_row *,
83 struct ovsdb_symbol_table *,
84 struct ovsdb_column_set *included)
86 struct json *ovsdb_row_to_json(const struct ovsdb_row *,
87 const struct ovsdb_column_set *include);
89 static inline const struct uuid *
90 ovsdb_row_get_uuid(const struct ovsdb_row *row)
92 return &row->fields[OVSDB_COL_UUID].keys[0].uuid;
95 static inline struct uuid *
96 ovsdb_row_get_uuid_rw(struct ovsdb_row *row)
98 return &row->fields[OVSDB_COL_UUID].keys[0].uuid;
101 static inline const struct uuid *
102 ovsdb_row_get_version(const struct ovsdb_row *row)
104 return &row->fields[OVSDB_COL_VERSION].keys[0].uuid;
107 static inline struct uuid *
108 ovsdb_row_get_version_rw(struct ovsdb_row *row)
110 return &row->fields[OVSDB_COL_VERSION].keys[0].uuid;
113 static inline uint32_t
114 ovsdb_row_hash(const struct ovsdb_row *row)
116 return uuid_hash(ovsdb_row_get_uuid(row));
119 /* An unordered collection of rows. */
120 struct ovsdb_row_set {
121 const struct ovsdb_row **rows;
122 size_t n_rows, allocated_rows;
125 #define OVSDB_ROW_SET_INITIALIZER { NULL, 0, 0 }
127 void ovsdb_row_set_init(struct ovsdb_row_set *);
128 void ovsdb_row_set_destroy(struct ovsdb_row_set *);
129 void ovsdb_row_set_add_row(struct ovsdb_row_set *, const struct ovsdb_row *);
131 struct json *ovsdb_row_set_to_json(const struct ovsdb_row_set *,
132 const struct ovsdb_column_set *);
134 void ovsdb_row_set_sort(struct ovsdb_row_set *,
135 const struct ovsdb_column_set *);
137 /* A hash table of rows. A specified set of columns is used for hashing and
140 * The row hash doesn't necessarily own its rows. They may be owned by, for
141 * example, an ovsdb_table. */
142 struct ovsdb_row_hash {
144 struct ovsdb_column_set columns;
147 #define OVSDB_ROW_HASH_INITIALIZER(RH) \
148 { HMAP_INITIALIZER(&(RH).rows), OVSDB_COLUMN_SET_INITIALIZER }
150 struct ovsdb_row_hash_node {
151 struct hmap_node hmap_node;
152 const struct ovsdb_row *row;
155 void ovsdb_row_hash_init(struct ovsdb_row_hash *,
156 const struct ovsdb_column_set *);
157 void ovsdb_row_hash_destroy(struct ovsdb_row_hash *, bool destroy_rows);
158 size_t ovsdb_row_hash_count(const struct ovsdb_row_hash *);
159 bool ovsdb_row_hash_contains(const struct ovsdb_row_hash *,
160 const struct ovsdb_row *);
161 bool ovsdb_row_hash_contains_all(const struct ovsdb_row_hash *,
162 const struct ovsdb_row_hash *);
163 bool ovsdb_row_hash_insert(struct ovsdb_row_hash *, const struct ovsdb_row *);
164 bool ovsdb_row_hash_contains__(const struct ovsdb_row_hash *,
165 const struct ovsdb_row *, size_t hash);
166 bool ovsdb_row_hash_insert__(struct ovsdb_row_hash *,
167 const struct ovsdb_row *, size_t hash);
169 #endif /* ovsdb/row.h */