1 /* Copyright (c) 2009, 2010, 2011, 2012 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.
16 #ifndef OVSDB_IDL_PROVIDER_H
17 #define OVSDB_IDL_PROVIDER_H 1
21 #include "ovsdb-idl.h"
22 #include "ovsdb-types.h"
26 struct ovsdb_idl_row {
27 struct hmap_node hmap_node; /* In struct ovsdb_idl_table's 'rows'. */
28 struct uuid uuid; /* Row "_uuid" field. */
29 struct ovs_list src_arcs; /* Forward arcs (ovsdb_idl_arc.src_node). */
30 struct ovs_list dst_arcs; /* Backward arcs (ovsdb_idl_arc.dst_node). */
31 struct ovsdb_idl_table *table; /* Containing table. */
32 struct ovsdb_datum *old; /* Committed data (null if orphaned). */
34 /* Transactional data. */
35 struct ovsdb_datum *new; /* Modified data (null to delete row). */
36 unsigned long int *prereqs; /* Bitmap of columns to verify in "old". */
37 unsigned long int *written; /* Bitmap of columns from "new" to write. */
38 struct hmap_node txn_node; /* Node in ovsdb_idl_txn's list. */
40 unsigned int change_seqno[OVSDB_IDL_CHANGE_MAX];
41 struct ovs_list track_node;
44 struct ovsdb_idl_column {
46 struct ovsdb_type type;
48 void (*parse)(struct ovsdb_idl_row *, const struct ovsdb_datum *);
49 void (*unparse)(struct ovsdb_idl_row *);
52 struct ovsdb_idl_table_class {
55 const struct ovsdb_idl_column *columns;
57 size_t allocation_size;
58 void (*row_init)(struct ovsdb_idl_row *);
61 struct ovsdb_idl_table {
62 const struct ovsdb_idl_table_class *class;
63 unsigned char *modes; /* OVSDB_IDL_* bitmasks, indexed by column. */
64 bool need_table; /* Monitor table even if no columns are selected
66 struct shash columns; /* Contains "const struct ovsdb_idl_column *"s. */
67 struct hmap rows; /* Contains "struct ovsdb_idl_row"s. */
68 struct ovsdb_idl *idl; /* Containing idl. */
69 unsigned int change_seqno[OVSDB_IDL_CHANGE_MAX];
70 struct ovs_list track_list; /* Tracked rows (ovsdb_idl_row.track_node). */
73 struct ovsdb_idl_class {
74 const char *database; /* <db-name> for this database. */
75 const struct ovsdb_idl_table_class *tables;
79 struct ovsdb_idl_row *ovsdb_idl_get_row_arc(
80 struct ovsdb_idl_row *src,
81 struct ovsdb_idl_table_class *dst_table,
82 const struct uuid *dst_uuid);
84 void ovsdb_idl_txn_verify(const struct ovsdb_idl_row *,
85 const struct ovsdb_idl_column *);
87 struct ovsdb_idl_txn *ovsdb_idl_txn_get(const struct ovsdb_idl_row *);
89 #endif /* ovsdb-idl-provider.h */