lib/ovsdb-idl-provider.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_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 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). */
  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     /* Tracking data */
  41     unsigned int change_seqno[OVSDB_IDL_CHANGE_MAX];
  42     struct ovs_list track_node; /* Rows modified/added/deleted by IDL */
  43     unsigned long int *updated; /* Bitmap of columns updated by IDL */
  44 };
  45
  46 struct ovsdb_idl_column {
  47     char *name;
  48     struct ovsdb_type type;
  49     bool mutable;
  50     void (*parse)(struct ovsdb_idl_row *, const struct ovsdb_datum *);
  51     void (*unparse)(struct ovsdb_idl_row *);
  52 };
  53
  54 struct ovsdb_idl_table_class {
  55     char *name;
  56     bool is_root;
  57     const struct ovsdb_idl_column *columns;
  58     size_t n_columns;
  59     size_t allocation_size;
  60     void (*row_init)(struct ovsdb_idl_row *);
  61 };
  62
  63 struct ovsdb_idl_table {
  64     const struct ovsdb_idl_table_class *class;
  65     unsigned char *modes;    /* OVSDB_IDL_* bitmasks, indexed by column. */
  66     bool need_table;         /* Monitor table even if no columns are selected
  67                               * for replication. */
  68     struct shash columns;    /* Contains "const struct ovsdb_idl_column *"s. */
  69     struct hmap rows;        /* Contains "struct ovsdb_idl_row"s. */
  70     struct ovsdb_idl *idl;   /* Containing idl. */
  71     unsigned int change_seqno[OVSDB_IDL_CHANGE_MAX];
  72     struct ovs_list track_list; /* Tracked rows (ovsdb_idl_row.track_node). */
  73 };
  74
  75 struct ovsdb_idl_class {
  76     const char *database;       /* <db-name> for this database. */
  77     const struct ovsdb_idl_table_class *tables;
  78     size_t n_tables;
  79 };
  80
  81 struct ovsdb_idl_row *ovsdb_idl_get_row_arc(
  82     struct ovsdb_idl_row *src,
  83     struct ovsdb_idl_table_class *dst_table,
  84     const struct uuid *dst_uuid);
  85
  86 void ovsdb_idl_txn_verify(const struct ovsdb_idl_row *,
  87                           const struct ovsdb_idl_column *);
  88
  89 struct ovsdb_idl_txn *ovsdb_idl_txn_get(const struct ovsdb_idl_row *);
  90
  91 #endif /* ovsdb-idl-provider.h */