lib/ovsdb-idl-provider.h

   1 /* Copyright (c) 2009 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 };
  45
  46 struct ovsdb_idl_table_class {
  47     char *name;
  48     const struct ovsdb_idl_column *columns;
  49     size_t n_columns;
  50     size_t allocation_size;
  51     void (*parse)(struct ovsdb_idl_row *);
  52     void (*unparse)(struct ovsdb_idl_row *);
  53 };
  54
  55 struct ovsdb_idl_table {
  56     const struct ovsdb_idl_table_class *class;
  57     struct shash columns;    /* Contains "const struct ovsdb_idl_column *"s. */
  58     struct hmap rows;        /* Contains "struct ovsdb_idl_row"s. */
  59     struct ovsdb_idl *idl;   /* Containing idl. */
  60 };
  61
  62 struct ovsdb_idl_class {
  63     const struct ovsdb_idl_table_class *tables;
  64     size_t n_tables;
  65 };
  66
  67 struct ovsdb_idl_row *ovsdb_idl_get_row_arc(
  68     struct ovsdb_idl_row *src,
  69     struct ovsdb_idl_table_class *dst_table,
  70     const struct uuid *dst_uuid);
  71
  72 struct ovsdb_idl_row *ovsdb_idl_first_row(
  73     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *);
  74
  75 struct ovsdb_idl_row *ovsdb_idl_next_row(const struct ovsdb_idl_row *);
  76
  77 void ovsdb_idl_txn_write(struct ovsdb_idl_row *,
  78                          const struct ovsdb_idl_column *,
  79                          struct ovsdb_datum *);
  80 void ovsdb_idl_txn_verify(const struct ovsdb_idl_row *,
  81                           const struct ovsdb_idl_column *);
  82 void ovsdb_idl_txn_delete(struct ovsdb_idl_row *);
  83 struct ovsdb_idl_row *ovsdb_idl_txn_insert(
  84     struct ovsdb_idl_txn *,
  85     const struct ovsdb_idl_table_class *);
  86
  87 struct ovsdb_idl_txn *ovsdb_idl_txn_get(const struct ovsdb_idl_row *);
  88
  89 #endif /* ovsdb-idl-provider.h */