ovsdb/ovsdb.h

   1 /* Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
   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_session;
  27 struct ovsdb_txn;
  28 struct simap;
  29 struct uuid;
  30
  31 /* Database schema. */
  32 struct ovsdb_schema {
  33     char *name;
  34     char *version;
  35     char *cksum;
  36     struct shash tables;        /* Contains "struct ovsdb_table_schema *"s. */
  37 };
  38
  39 struct ovsdb_schema *ovsdb_schema_create(const char *name,
  40                                          const char *version,
  41                                          const char *cksum);
  42 struct ovsdb_schema *ovsdb_schema_clone(const struct ovsdb_schema *);
  43 void ovsdb_schema_destroy(struct ovsdb_schema *);
  44
  45 struct ovsdb_error *ovsdb_schema_from_file(const char *file_name,
  46                                            struct ovsdb_schema **)
  47     WARN_UNUSED_RESULT;
  48 struct ovsdb_error *ovsdb_schema_from_json(struct json *,
  49                                            struct ovsdb_schema **)
  50     WARN_UNUSED_RESULT;
  51 struct json *ovsdb_schema_to_json(const struct ovsdb_schema *);
  52
  53 bool ovsdb_schema_equal(const struct ovsdb_schema *,
  54                         const struct ovsdb_schema *);
  55 \f
  56 /* Database. */
  57 struct ovsdb {
  58     struct ovsdb_schema *schema;
  59     struct list replicas;       /* Contains "struct ovsdb_replica"s. */
  60     struct shash tables;        /* Contains "struct ovsdb_table *"s. */
  61
  62     /* Triggers. */
  63     struct list triggers;       /* Contains "struct ovsdb_trigger"s. */
  64     bool run_triggers;
  65 };
  66
  67 struct ovsdb *ovsdb_create(struct ovsdb_schema *);
  68 void ovsdb_destroy(struct ovsdb *);
  69
  70 void ovsdb_get_memory_usage(const struct ovsdb *, struct simap *usage);
  71
  72 struct ovsdb_error *ovsdb_from_json(const struct json *, struct ovsdb **)
  73     WARN_UNUSED_RESULT;
  74 struct json *ovsdb_to_json(const struct ovsdb *);
  75
  76 struct ovsdb_table *ovsdb_get_table(const struct ovsdb *, const char *);
  77
  78 struct json *ovsdb_execute(struct ovsdb *, const struct ovsdb_session *,
  79                            const struct json *params,
  80                            long long int elapsed_msec,
  81                            long long int *timeout_msec);
  82 \f
  83 /* Database replication. */
  84
  85 struct ovsdb_replica {
  86     struct list node;           /* Element in "struct ovsdb" replicas list. */
  87     const struct ovsdb_replica_class *class;
  88 };
  89
  90 struct ovsdb_replica_class {
  91     struct ovsdb_error *(*commit)(struct ovsdb_replica *,
  92                                   const struct ovsdb_txn *, bool durable);
  93     void (*destroy)(struct ovsdb_replica *);
  94 };
  95
  96 void ovsdb_replica_init(struct ovsdb_replica *,
  97                         const struct ovsdb_replica_class *);
  98
  99 void ovsdb_add_replica(struct ovsdb *, struct ovsdb_replica *);
 100 void ovsdb_remove_replica(struct ovsdb *, struct ovsdb_replica *);
 101
 102 #endif /* ovsdb/ovsdb.h */