ovsdb/ovsdb.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_OVSDB_H
  17 #define OVSDB_OVSDB_H 1
  18
  19 #include "compiler.h"
  20 #include "hmap.h"
  21 #include "list.h"
  22 #include "shash.h"
  23
  24 struct json;
  25 struct ovsdb_log;
  26 struct ovsdb_txn;
  27 struct uuid;
  28
  29 /* Database schema. */
  30 struct ovsdb_schema {
  31     char *name;
  32     char *comment;
  33     struct shash tables;        /* Contains "struct ovsdb_table_schema *"s. */
  34 };
  35
  36 struct ovsdb_schema *ovsdb_schema_create(const char *name,
  37                                          const char *comment);
  38 struct ovsdb_schema *ovsdb_schema_clone(const struct ovsdb_schema *);
  39 void ovsdb_schema_destroy(struct ovsdb_schema *);
  40
  41 struct ovsdb_error *ovsdb_schema_from_file(const char *file_name,
  42                                            struct ovsdb_schema **)
  43     WARN_UNUSED_RESULT;
  44 struct ovsdb_error *ovsdb_schema_from_json(struct json *,
  45                                            struct ovsdb_schema **)
  46     WARN_UNUSED_RESULT;
  47 struct json *ovsdb_schema_to_json(const struct ovsdb_schema *);
  48 \f
  49 /* Database. */
  50 struct ovsdb {
  51     struct ovsdb_schema *schema;
  52     struct list replicas;       /* Contains "struct ovsdb_replica"s. */
  53     struct shash tables;        /* Contains "struct ovsdb_table *"s. */
  54
  55     /* Triggers. */
  56     struct list triggers;       /* Contains "struct ovsdb_trigger"s. */
  57     bool run_triggers;
  58 };
  59
  60 struct ovsdb *ovsdb_create(struct ovsdb_schema *);
  61 void ovsdb_destroy(struct ovsdb *);
  62
  63 struct ovsdb_error *ovsdb_from_json(const struct json *, struct ovsdb **)
  64     WARN_UNUSED_RESULT;
  65 struct json *ovsdb_to_json(const struct ovsdb *);
  66
  67 struct ovsdb_table *ovsdb_get_table(const struct ovsdb *, const char *);
  68
  69 struct json *ovsdb_execute(struct ovsdb *, const struct json *params,
  70                            long long int elapsed_msec,
  71                            long long int *timeout_msec);
  72 \f
  73 /* Database replication. */
  74
  75 struct ovsdb_replica {
  76     struct list node;           /* Element in "struct ovsdb" replicas list. */
  77     const struct ovsdb_replica_class *class;
  78 };
  79
  80 struct ovsdb_replica_class {
  81     struct ovsdb_error *(*commit)(struct ovsdb_replica *,
  82                                   const struct ovsdb_txn *, bool durable);
  83     void (*destroy)(struct ovsdb_replica *);
  84 };
  85
  86 void ovsdb_replica_init(struct ovsdb_replica *,
  87                         const struct ovsdb_replica_class *);
  88
  89 void ovsdb_add_replica(struct ovsdb *, struct ovsdb_replica *);
  90 void ovsdb_remove_replica(struct ovsdb *, struct ovsdb_replica *);
  91
  92 #endif /* ovsdb/ovsdb.h */