AUTHORS: Add Valient Gough.
[openvswitch] / lib / ovsdb-idl-provider.h
1 /* Copyright (c) 2009, 2010 Nicira Networks.
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_PROVIDER_H
17 #define OVSDB_IDL_PROVIDER_H 1
18
19 #include "hmap.h"
20 #include "list.h"
21 #include "ovsdb-idl.h"
22 #include "ovsdb-types.h"
23 #include "shash.h"
24 #include "uuid.h"
25
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 list src_arcs;       /* Forward arcs (ovsdb_idl_arc.src_node). */
30     struct 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). */
33
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. */
39 };
40
41 struct ovsdb_idl_column {
42     char *name;
43     struct ovsdb_type type;
44     void (*parse)(struct ovsdb_idl_row *, const struct ovsdb_datum *);
45     void (*unparse)(struct ovsdb_idl_row *);
46 };
47
48 struct ovsdb_idl_table_class {
49     char *name;
50     const struct ovsdb_idl_column *columns;
51     size_t n_columns;
52     size_t allocation_size;
53 };
54
55 struct ovsdb_idl_table {
56     const struct ovsdb_idl_table_class *class;
57     unsigned char *modes;    /* OVSDB_IDL_* bitmasks, indexed by column. */
58     bool need_table;         /* Monitor table even if no columns? */
59     struct shash columns;    /* Contains "const struct ovsdb_idl_column *"s. */
60     struct hmap rows;        /* Contains "struct ovsdb_idl_row"s. */
61     struct ovsdb_idl *idl;   /* Containing idl. */
62 };
63
64 struct ovsdb_idl_class {
65     const char *database;       /* <db-name> for this database. */
66     const struct ovsdb_idl_table_class *tables;
67     size_t n_tables;
68 };
69
70 struct ovsdb_idl_row *ovsdb_idl_get_row_arc(
71     struct ovsdb_idl_row *src,
72     struct ovsdb_idl_table_class *dst_table,
73     const struct uuid *dst_uuid);
74
75 void ovsdb_idl_txn_verify(const struct ovsdb_idl_row *,
76                           const struct ovsdb_idl_column *);
77
78 struct ovsdb_idl_txn *ovsdb_idl_txn_get(const struct ovsdb_idl_row *);
79
80 #endif /* ovsdb-idl-provider.h */