ovsdb/ovsdb-idlc.in

   1 #! @PYTHON@
   2
   3 import getopt
   4 import os
   5 import re
   6 import sys
   7
   8 import ovs.json
   9 import ovs.db.error
  10 import ovs.db.schema
  11
  12 argv0 = sys.argv[0]
  13
  14 def parseSchema(filename):
  15     return ovs.db.schema.IdlSchema.from_json(ovs.json.from_file(filename))
  16
  17 def annotateSchema(schemaFile, annotationFile):
  18     schemaJson = ovs.json.from_file(schemaFile)
  19     execfile(annotationFile, globals(), {"s": schemaJson})
  20     ovs.json.to_stream(schemaJson, sys.stdout)
  21     sys.stdout.write('\n')
  22
  23 def constify(cType, const):
  24     if (const
  25         and cType.endswith('*') and
  26         (cType == 'char **' or not cType.endswith('**'))):
  27         return 'const %s' % cType
  28     else:
  29         return cType
  30
  31 def cMembers(prefix, columnName, column, const):
  32     type = column.type
  33
  34     if type.is_smap():
  35         return [{'name': columnName,
  36                  'type': 'struct smap ',
  37                  'comment': ''}]
  38
  39     if type.n_min == 1 and type.n_max == 1:
  40         singleton = True
  41         pointer = ''
  42     else:
  43         singleton = False
  44         if type.is_optional_pointer():
  45             pointer = ''
  46         else:
  47             pointer = '*'
  48
  49     if type.value:
  50         key = {'name': "key_%s" % columnName,
  51                'type': constify(type.key.toCType(prefix) + pointer, const),
  52                'comment': ''}
  53         value = {'name': "value_%s" % columnName,
  54                  'type': constify(type.value.toCType(prefix) + pointer, const),
  55                  'comment': ''}
  56         members = [key, value]
  57     else:
  58         m = {'name': columnName,
  59              'type': constify(type.key.toCType(prefix) + pointer, const),
  60              'comment': type.cDeclComment()}
  61         members = [m]
  62
  63     if not singleton and not type.is_optional_pointer():
  64         members.append({'name': 'n_%s' % columnName,
  65                         'type': 'size_t ',
  66                         'comment': ''})
  67     return members
  68
  69 def printCIDLHeader(schemaFile):
  70     schema = parseSchema(schemaFile)
  71     prefix = schema.idlPrefix
  72     print '''\
  73 /* Generated automatically -- do not modify!    -*- buffer-read-only: t -*- */
  74
  75 #ifndef %(prefix)sIDL_HEADER
  76 #define %(prefix)sIDL_HEADER 1
  77
  78 #include <stdbool.h>
  79 #include <stddef.h>
  80 #include <stdint.h>
  81 #include "ovsdb-data.h"
  82 #include "ovsdb-idl-provider.h"
  83 #include "smap.h"
  84 #include "uuid.h"''' % {'prefix': prefix.upper()}
  85
  86     for tableName, table in sorted(schema.tables.iteritems()):
  87         structName = "%s%s" % (prefix, tableName.lower())
  88
  89         print "\f"
  90         print "/* %s table. */" % tableName
  91         print "struct %s {" % structName
  92         print "\tstruct ovsdb_idl_row header_;"
  93         for columnName, column in sorted(table.columns.iteritems()):
  94             print "\n\t/* %s column. */" % columnName
  95             for member in cMembers(prefix, columnName, column, False):
  96                 print "\t%(type)s%(name)s;%(comment)s" % member
  97         print "};"
  98
  99         # Column indexes.
 100         printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper())
 101                    for columnName in sorted(table.columns)]
 102                   + ["%s_N_COLUMNS" % structName.upper()])
 103
 104         print
 105         for columnName in table.columns:
 106             print "#define %(s)s_col_%(c)s (%(s)s_columns[%(S)s_COL_%(C)s])" % {
 107                 's': structName,
 108                 'S': structName.upper(),
 109                 'c': columnName,
 110                 'C': columnName.upper()}
 111
 112         print "\nextern struct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (structName, structName.upper())
 113
 114         print '''
 115 const struct %(s)s *%(s)s_get_for_uuid(const struct ovsdb_idl *, const struct uuid *);
 116 const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
 117 const struct %(s)s *%(s)s_next(const struct %(s)s *);
 118 #define %(S)s_FOR_EACH(ROW, IDL) \\
 119         for ((ROW) = %(s)s_first(IDL); \\
 120              (ROW); \\
 121              (ROW) = %(s)s_next(ROW))
 122 #define %(S)s_FOR_EACH_SAFE(ROW, NEXT, IDL) \\
 123         for ((ROW) = %(s)s_first(IDL); \\
 124              (ROW) ? ((NEXT) = %(s)s_next(ROW), 1) : 0; \\
 125              (ROW) = (NEXT))
 126
 127 void %(s)s_init(struct %(s)s *);
 128 void %(s)s_delete(const struct %(s)s *);
 129 struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *);
 130 ''' % {'s': structName, 'S': structName.upper()}
 131
 132         for columnName, column in sorted(table.columns.iteritems()):
 133             print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName}
 134
 135         print """
 136 /* Functions for fetching columns as \"struct ovsdb_datum\"s.  (This is
 137    rarely useful.  More often, it is easier to access columns by using
 138    the members of %(s)s directly.) */""" % {'s': structName}
 139         for columnName, column in sorted(table.columns.iteritems()):
 140             if column.type.value:
 141                 valueParam = ', enum ovsdb_atomic_type value_type'
 142             else:
 143                 valueParam = ''
 144             print 'const struct ovsdb_datum *%(s)s_get_%(c)s(const struct %(s)s *, enum ovsdb_atomic_type key_type%(v)s);' % {
 145                 's': structName, 'c': columnName, 'v': valueParam}
 146
 147         print
 148         for columnName, column in sorted(table.columns.iteritems()):
 149             print 'void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName},
 150             if column.type.is_smap():
 151                 args = ['const struct smap *']
 152             else:
 153                 args = ['%(type)s%(name)s' % member for member
 154                         in cMembers(prefix, columnName, column, True)]
 155             print '%s);' % ', '.join(args)
 156
 157         print
 158
 159     # Table indexes.
 160     printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in sorted(schema.tables)] + ["%sN_TABLES" % prefix.upper()])
 161     print
 162     for tableName in schema.tables:
 163         print "#define %(p)stable_%(t)s (%(p)stable_classes[%(P)sTABLE_%(T)s])" % {
 164             'p': prefix,
 165             'P': prefix.upper(),
 166             't': tableName.lower(),
 167             'T': tableName.upper()}
 168     print "\nextern struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper())
 169
 170     print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
 171     print "\nvoid %sinit(void);" % prefix
 172
 173     print "\nconst char * %sget_db_version(void);" % prefix
 174     print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
 175
 176 def printEnum(members):
 177     if len(members) == 0:
 178         return
 179
 180     print "\nenum {";
 181     for member in members[:-1]:
 182         print "    %s," % member
 183     print "    %s" % members[-1]
 184     print "};"
 185
 186 def printCIDLSource(schemaFile):
 187     schema = parseSchema(schemaFile)
 188     prefix = schema.idlPrefix
 189     print '''\
 190 /* Generated automatically -- do not modify!    -*- buffer-read-only: t -*- */
 191
 192 #include <config.h>
 193 #include %s
 194 #include <limits.h>
 195 #include "ovs-thread.h"
 196 #include "ovsdb-data.h"
 197 #include "ovsdb-error.h"
 198 #include "util.h"
 199
 200 #ifdef __CHECKER__
 201 /* Sparse dislikes sizeof(bool) ("warning: expression using sizeof bool"). */
 202 enum { sizeof_bool = 1 };
 203 #else
 204 enum { sizeof_bool = sizeof(bool) };
 205 #endif
 206
 207 static bool inited;
 208 ''' % schema.idlHeader
 209
 210     # Cast functions.
 211     for tableName, table in sorted(schema.tables.iteritems()):
 212         structName = "%s%s" % (prefix, tableName.lower())
 213         print '''
 214 static struct %(s)s *
 215 %(s)s_cast(const struct ovsdb_idl_row *row)
 216 {
 217     return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
 218 }\
 219 ''' % {'s': structName}
 220
 221
 222     for tableName, table in sorted(schema.tables.iteritems()):
 223         structName = "%s%s" % (prefix, tableName.lower())
 224         print "\f"
 225         print "/* %s table. */" % (tableName)
 226
 227         # Parse functions.
 228         for columnName, column in sorted(table.columns.iteritems()):
 229             print '''
 230 static void
 231 %(s)s_parse_%(c)s(struct ovsdb_idl_row *row_, const struct ovsdb_datum *datum)
 232 {
 233     struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName,
 234                                                 'c': columnName}
 235             type = column.type
 236             if type.value:
 237                 keyVar = "row->key_%s" % columnName
 238                 valueVar = "row->value_%s" % columnName
 239             else:
 240                 keyVar = "row->%s" % columnName
 241                 valueVar = None
 242
 243             if type.is_smap():
 244                 print "    size_t i;"
 245                 print
 246                 print "    ovs_assert(inited);"
 247                 print "    smap_init(&row->%s);" % columnName
 248                 print "    for (i = 0; i < datum->n; i++) {"
 249                 print "        smap_add(&row->%s," % columnName
 250                 print "                 datum->keys[i].string,"
 251                 print "                 datum->values[i].string);"
 252                 print "    }"
 253             elif (type.n_min == 1 and type.n_max == 1) or type.is_optional_pointer():
 254                 print
 255                 print "    ovs_assert(inited);"
 256                 print "    if (datum->n >= 1) {"
 257                 if not type.key.ref_table:
 258                     print "        %s = datum->keys[0].%s;" % (keyVar, type.key.type.to_string())
 259                 else:
 260                     print "        %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[0].uuid));" % (keyVar, prefix, type.key.ref_table.name.lower(), prefix, prefix.upper(), type.key.ref_table.name.upper())
 261
 262                 if valueVar:
 263                     if type.value.ref_table:
 264                         print "        %s = datum->values[0].%s;" % (valueVar, type.value.type.to_string())
 265                     else:
 266                         print "        %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[0].uuid));" % (valueVar, prefix, type.value.ref_table.name.lower(), prefix, prefix.upper(), type.value.ref_table.name.upper())
 267                 print "    } else {"
 268                 print "        %s" % type.key.initCDefault(keyVar, type.n_min == 0)
 269                 if valueVar:
 270                     print "        %s" % type.value.initCDefault(valueVar, type.n_min == 0)
 271                 print "    }"
 272             else:
 273                 if type.n_max != sys.maxint:
 274                     print "    size_t n = MIN(%d, datum->n);" % type.n_max
 275                     nMax = "n"
 276                 else:
 277                     nMax = "datum->n"
 278                 print "    size_t i;"
 279                 print
 280                 print "    ovs_assert(inited);"
 281                 print "    %s = NULL;" % keyVar
 282                 if valueVar:
 283                     print "    %s = NULL;" % valueVar
 284                 print "    row->n_%s = 0;" % columnName
 285                 print "    for (i = 0; i < %s; i++) {" % nMax
 286                 refs = []
 287                 if type.key.ref_table:
 288                     print "        struct %s%s *keyRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[i].uuid));" % (prefix, type.key.ref_table.name.lower(), prefix, type.key.ref_table.name.lower(), prefix, prefix.upper(), type.key.ref_table.name.upper())
 289                     keySrc = "keyRow"
 290                     refs.append('keyRow')
 291                 else:
 292                     keySrc = "datum->keys[i].%s" % type.key.type.to_string()
 293                 if type.value and type.value.ref_table:
 294                     print "        struct %s%s *valueRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[i].uuid));" % (prefix, type.value.ref_table.name.lower(), prefix, type.value.ref_table.name.lower(), prefix, prefix.upper(), type.value.ref_table.name.upper())
 295                     valueSrc = "valueRow"
 296                     refs.append('valueRow')
 297                 elif valueVar:
 298                     valueSrc = "datum->values[i].%s" % type.value.type.to_string()
 299                 if refs:
 300                     print "        if (%s) {" % ' && '.join(refs)
 301                     indent = "            "
 302                 else:
 303                     indent = "        "
 304                 print "%sif (!row->n_%s) {" % (indent, columnName)
 305
 306                 # Special case for boolean types.  This is only here because
 307                 # sparse does not like the "normal" case ("warning: expression
 308                 # using sizeof bool").
 309                 if type.key.type == ovs.db.types.BooleanType:
 310                     sizeof = "sizeof_bool"
 311                 else:
 312                     sizeof = "sizeof *%s" % keyVar
 313                 print "%s    %s = xmalloc(%s * %s);" % (indent, keyVar, nMax,
 314                                                         sizeof)
 315                 if valueVar:
 316                     # Special case for boolean types (see above).
 317                     if type.value.type == ovs.db.types.BooleanType:
 318                         sizeof = " * sizeof_bool"
 319                     else:
 320                         sizeof = "sizeof *%s" % valueVar
 321                     print "%s    %s = xmalloc(%s * %s);" % (indent, valueVar,
 322                                                             nMax, sizeof)
 323                 print "%s}" % indent
 324                 print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc)
 325                 if valueVar:
 326                     print "%s%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc)
 327                 print "%srow->n_%s++;" % (indent, columnName)
 328                 if refs:
 329                     print "        }"
 330                 print "    }"
 331             print "}"
 332
 333         # Unparse functions.
 334         for columnName, column in sorted(table.columns.iteritems()):
 335             type = column.type
 336             if type.is_smap() or (type.n_min != 1 or type.n_max != 1) and not type.is_optional_pointer():
 337                 print '''
 338 static void
 339 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_)
 340 {
 341     struct %(s)s *row = %(s)s_cast(row_);
 342
 343     ovs_assert(inited);''' % {'s': structName, 'c': columnName}
 344
 345                 if type.is_smap():
 346                     print "    smap_destroy(&row->%s);" % columnName
 347                 else:
 348                     if type.value:
 349                         keyVar = "row->key_%s" % columnName
 350                         valueVar = "row->value_%s" % columnName
 351                     else:
 352                         keyVar = "row->%s" % columnName
 353                         valueVar = None
 354                     print "    free(%s);" % keyVar
 355                     if valueVar:
 356                         print "    free(%s);" % valueVar
 357                 print '}'
 358             else:
 359                 print '''
 360 static void
 361 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED)
 362 {
 363     /* Nothing to do. */
 364 }''' % {'s': structName, 'c': columnName}
 365
 366         # Generic Row Initialization function.
 367         print """
 368 static void
 369 %(s)s_init__(struct ovsdb_idl_row *row)
 370 {
 371     %(s)s_init(%(s)s_cast(row));
 372 }""" % {'s': structName}
 373
 374         # Row Initialization function.
 375         print """
 376 void
 377 %(s)s_init(struct %(s)s *row)
 378 {
 379     memset(row, 0, sizeof *row); """ % {'s': structName}
 380         for columnName, column in sorted(table.columns.iteritems()):
 381             if column.type.is_smap():
 382                 print "    smap_init(&row->%s);" % columnName
 383         print "}"
 384
 385         # First, next functions.
 386         print '''
 387 const struct %(s)s *
 388 %(s)s_get_for_uuid(const struct ovsdb_idl *idl, const struct uuid *uuid)
 389 {
 390     return %(s)s_cast(ovsdb_idl_get_row_for_uuid(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s], uuid));
 391 }
 392
 393 const struct %(s)s *
 394 %(s)s_first(const struct ovsdb_idl *idl)
 395 {
 396     return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
 397 }
 398
 399 const struct %(s)s *
 400 %(s)s_next(const struct %(s)s *row)
 401 {
 402     return %(s)s_cast(ovsdb_idl_next_row(&row->header_));
 403 }''' % {'s': structName,
 404         'p': prefix,
 405         'P': prefix.upper(),
 406         'T': tableName.upper()}
 407
 408         print '''
 409 void
 410 %(s)s_delete(const struct %(s)s *row)
 411 {
 412     ovsdb_idl_txn_delete(&row->header_);
 413 }
 414
 415 struct %(s)s *
 416 %(s)s_insert(struct ovsdb_idl_txn *txn)
 417 {
 418     return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_classes[%(P)sTABLE_%(T)s], NULL));
 419 }
 420 ''' % {'s': structName,
 421        'p': prefix,
 422        'P': prefix.upper(),
 423        'T': tableName.upper()}
 424
 425         # Verify functions.
 426         for columnName, column in sorted(table.columns.iteritems()):
 427             print '''
 428 void
 429 %(s)s_verify_%(c)s(const struct %(s)s *row)
 430 {
 431     ovs_assert(inited);
 432     ovsdb_idl_txn_verify(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s]);
 433 }''' % {'s': structName,
 434         'S': structName.upper(),
 435         'c': columnName,
 436         'C': columnName.upper()}
 437
 438         # Get functions.
 439         for columnName, column in sorted(table.columns.iteritems()):
 440             if column.type.value:
 441                 valueParam = ',\n\tenum ovsdb_atomic_type value_type OVS_UNUSED'
 442                 valueType = '\n    ovs_assert(value_type == %s);' % column.type.value.toAtomicType()
 443                 valueComment = "\n * 'value_type' must be %s." % column.type.value.toAtomicType()
 444             else:
 445                 valueParam = ''
 446                 valueType = ''
 447                 valueComment = ''
 448             print """
 449 /* Returns the %(c)s column's value in 'row' as a struct ovsdb_datum.
 450  * This is useful occasionally: for example, ovsdb_datum_find_key() is an
 451  * easier and more efficient way to search for a given key than implementing
 452  * the same operation on the "cooked" form in 'row'.
 453  *
 454  * 'key_type' must be %(kt)s.%(vc)s
 455  * (This helps to avoid silent bugs if someone changes %(c)s's
 456  * type without updating the caller.)
 457  *
 458  * The caller must not modify or free the returned value.
 459  *
 460  * Various kinds of changes can invalidate the returned value: modifying
 461  * 'column' within 'row', deleting 'row', or completing an ongoing transaction.
 462  * If the returned value is needed for a long time, it is best to make a copy
 463  * of it with ovsdb_datum_clone(). */
 464 const struct ovsdb_datum *
 465 %(s)s_get_%(c)s(const struct %(s)s *row,
 466 \tenum ovsdb_atomic_type key_type OVS_UNUSED%(v)s)
 467 {
 468     ovs_assert(key_type == %(kt)s);%(vt)s
 469     return ovsdb_idl_read(&row->header_, &%(s)s_col_%(c)s);
 470 }""" % {'s': structName, 'c': columnName,
 471        'kt': column.type.key.toAtomicType(),
 472        'v': valueParam, 'vt': valueType, 'vc': valueComment}
 473
 474         # Set functions.
 475         for columnName, column in sorted(table.columns.iteritems()):
 476             type = column.type
 477
 478             if type.is_smap():
 479                 print """
 480 void
 481 %(s)s_set_%(c)s(const struct %(s)s *row, const struct smap *smap)
 482 {
 483     struct ovsdb_datum datum;
 484
 485     ovs_assert(inited);
 486     if (smap) {
 487         struct smap_node *node;
 488         size_t i;
 489
 490         datum.n = smap_count(smap);
 491         datum.keys = xmalloc(datum.n * sizeof *datum.keys);
 492         datum.values = xmalloc(datum.n * sizeof *datum.values);
 493
 494         i = 0;
 495         SMAP_FOR_EACH (node, smap) {
 496             datum.keys[i].string = xstrdup(node->key);
 497             datum.values[i].string = xstrdup(node->value);
 498             i++;
 499         }
 500         ovsdb_datum_sort_unique(&datum, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING);
 501     } else {
 502         ovsdb_datum_init_empty(&datum);
 503     }
 504     ovsdb_idl_txn_write(&row->header_,
 505                         &%(s)s_columns[%(S)s_COL_%(C)s],
 506                         &datum);
 507 }
 508 """ % {'s': structName,
 509        'S': structName.upper(),
 510        'c': columnName,
 511        'C': columnName.upper()}
 512                 continue
 513
 514
 515             print '\nvoid'
 516             members = cMembers(prefix, columnName, column, True)
 517             keyVar = members[0]['name']
 518             nVar = None
 519             valueVar = None
 520             if type.value:
 521                 valueVar = members[1]['name']
 522                 if len(members) > 2:
 523                     nVar = members[2]['name']
 524             else:
 525                 if len(members) > 1:
 526                     nVar = members[1]['name']
 527             print '%(s)s_set_%(c)s(const struct %(s)s *row, %(args)s)' % \
 528                 {'s': structName, 'c': columnName,
 529                  'args': ', '.join(['%(type)s%(name)s' % m for m in members])}
 530             print "{"
 531             print "    struct ovsdb_datum datum;"
 532             if type.n_min == 1 and type.n_max == 1:
 533                 print "    union ovsdb_atom key;"
 534                 if type.value:
 535                     print "    union ovsdb_atom value;"
 536                 print
 537                 print "    ovs_assert(inited);"
 538                 print "    datum.n = 1;"
 539                 print "    datum.keys = &key;"
 540                 print "    " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), keyVar)
 541                 if type.value:
 542                     print "    datum.values = &value;"
 543                     print "    "+ type.value.assign_c_value_casting_away_const("value.%s" % type.value.type.to_string(), valueVar)
 544                 else:
 545                     print "    datum.values = NULL;"
 546                 txn_write_func = "ovsdb_idl_txn_write_clone"
 547             elif type.is_optional_pointer():
 548                 print "    union ovsdb_atom key;"
 549                 print
 550                 print "    ovs_assert(inited);"
 551                 print "    if (%s) {" % keyVar
 552                 print "        datum.n = 1;"
 553                 print "        datum.keys = &key;"
 554                 print "        " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), keyVar)
 555                 print "    } else {"
 556                 print "        datum.n = 0;"
 557                 print "        datum.keys = NULL;"
 558                 print "    }"
 559                 print "    datum.values = NULL;"
 560                 txn_write_func = "ovsdb_idl_txn_write_clone"
 561             elif type.n_max == 1:
 562                 print "    union ovsdb_atom key;"
 563                 print
 564                 print "    ovs_assert(inited);"
 565                 print "    if (%s) {" % nVar
 566                 print "        datum.n = 1;"
 567                 print "        datum.keys = &key;"
 568                 print "        " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), "*" + keyVar)
 569                 print "    } else {"
 570                 print "        datum.n = 0;"
 571                 print "        datum.keys = NULL;"
 572                 print "    }"
 573                 print "    datum.values = NULL;"
 574                 txn_write_func = "ovsdb_idl_txn_write_clone"
 575             else:
 576                 print "    size_t i;"
 577                 print
 578                 print "    ovs_assert(inited);"
 579                 print "    datum.n = %s;" % nVar
 580                 print "    datum.keys = %s ? xmalloc(%s * sizeof *datum.keys) : NULL;" % (nVar, nVar)
 581                 if type.value:
 582                     print "    datum.values = xmalloc(%s * sizeof *datum.values);" % nVar
 583                 else:
 584                     print "    datum.values = NULL;"
 585                 print "    for (i = 0; i < %s; i++) {" % nVar
 586                 print "        " + type.key.copyCValue("datum.keys[i].%s" % type.key.type.to_string(), "%s[i]" % keyVar)
 587                 if type.value:
 588                     print "        " + type.value.copyCValue("datum.values[i].%s" % type.value.type.to_string(), "%s[i]" % valueVar)
 589                 print "    }"
 590                 if type.value:
 591                     valueType = type.value.toAtomicType()
 592                 else:
 593                     valueType = "OVSDB_TYPE_VOID"
 594                 print "    ovsdb_datum_sort_unique(&datum, %s, %s);" % (
 595                     type.key.toAtomicType(), valueType)
 596                 txn_write_func = "ovsdb_idl_txn_write"
 597             print "    %(f)s(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
 598                 % {'f': txn_write_func,
 599                    's': structName,
 600                    'S': structName.upper(),
 601                    'C': columnName.upper()}
 602             print "}"
 603
 604         # Table columns.
 605         print "\nstruct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (
 606             structName, structName.upper())
 607         print """
 608 static void\n%s_columns_init(void)
 609 {
 610     struct ovsdb_idl_column *c;\
 611 """ % structName
 612         for columnName, column in sorted(table.columns.iteritems()):
 613             cs = "%s_col_%s" % (structName, columnName)
 614             d = {'cs': cs, 'c': columnName, 's': structName}
 615             if column.mutable:
 616                 mutable = "true"
 617             else:
 618                 mutable = "false"
 619             print
 620             print "    /* Initialize %(cs)s. */" % d
 621             print "    c = &%(cs)s;" % d
 622             print "    c->name = \"%(c)s\";" % d
 623             print column.type.cInitType("    ", "c->type")
 624             print "    c->mutable = %s;" % mutable
 625             print "    c->parse = %(s)s_parse_%(c)s;" % d
 626             print "    c->unparse = %(s)s_unparse_%(c)s;" % d
 627         print "}"
 628
 629     # Table classes.
 630     print "\f"
 631     print "struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper())
 632     for tableName, table in sorted(schema.tables.iteritems()):
 633         structName = "%s%s" % (prefix, tableName.lower())
 634         if table.is_root:
 635             is_root = "true"
 636         else:
 637             is_root = "false"
 638         print "    {\"%s\", %s," % (tableName, is_root)
 639         print "     %s_columns, ARRAY_SIZE(%s_columns)," % (
 640             structName, structName)
 641         print "     sizeof(struct %s), %s_init__}," % (structName, structName)
 642     print "};"
 643
 644     # IDL class.
 645     print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix
 646     print "    \"%s\", %stable_classes, ARRAY_SIZE(%stable_classes)" % (
 647         schema.name, prefix, prefix)
 648     print "};"
 649
 650     # global init function
 651     print """
 652 void
 653 %sinit(void)
 654 {
 655     if (inited) {
 656         return;
 657     }
 658     assert_single_threaded();
 659     inited = true;
 660 """ % prefix
 661     for tableName, table in sorted(schema.tables.iteritems()):
 662         structName = "%s%s" % (prefix, tableName.lower())
 663         print "    %s_columns_init();" % structName
 664     print "}"
 665
 666     print """
 667 /* Return the schema version.  The caller must not free the returned value. */
 668 const char *
 669 %sget_db_version(void)
 670 {
 671     return "%s";
 672 }
 673 """ % (prefix, schema.version)
 674
 675
 676
 677 def ovsdb_escape(string):
 678     def escape(match):
 679         c = match.group(0)
 680         if c == '\0':
 681             raise ovs.db.error.Error("strings may not contain null bytes")
 682         elif c == '\\':
 683             return '\\\\'
 684         elif c == '\n':
 685             return '\\n'
 686         elif c == '\r':
 687             return '\\r'
 688         elif c == '\t':
 689             return '\\t'
 690         elif c == '\b':
 691             return '\\b'
 692         elif c == '\a':
 693             return '\\a'
 694         else:
 695             return '\\x%02x' % ord(c)
 696     return re.sub(r'["\\\000-\037]', escape, string)
 697
 698 def usage():
 699     print """\
 700 %(argv0)s: ovsdb schema compiler
 701 usage: %(argv0)s [OPTIONS] COMMAND ARG...
 702
 703 The following commands are supported:
 704   annotate SCHEMA ANNOTATIONS print SCHEMA combined with ANNOTATIONS
 705   c-idl-header IDL            print C header file for IDL
 706   c-idl-source IDL            print C source file for IDL implementation
 707   nroff IDL                   print schema documentation in nroff format
 708
 709 The following options are also available:
 710   -h, --help                  display this help message
 711   -V, --version               display version information\
 712 """ % {'argv0': argv0}
 713     sys.exit(0)
 714
 715 if __name__ == "__main__":
 716     try:
 717         try:
 718             options, args = getopt.gnu_getopt(sys.argv[1:], 'C:hV',
 719                                               ['directory',
 720                                                'help',
 721                                                'version'])
 722         except getopt.GetoptError, geo:
 723             sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
 724             sys.exit(1)
 725
 726         for key, value in options:
 727             if key in ['-h', '--help']:
 728                 usage()
 729             elif key in ['-V', '--version']:
 730                 print "ovsdb-idlc (Open vSwitch) @VERSION@"
 731             elif key in ['-C', '--directory']:
 732                 os.chdir(value)
 733             else:
 734                 sys.exit(0)
 735
 736         optKeys = [key for key, value in options]
 737
 738         if not args:
 739             sys.stderr.write("%s: missing command argument "
 740                              "(use --help for help)\n" % argv0)
 741             sys.exit(1)
 742
 743         commands = {"annotate": (annotateSchema, 2),
 744                     "c-idl-header": (printCIDLHeader, 1),
 745                     "c-idl-source": (printCIDLSource, 1)}
 746
 747         if not args[0] in commands:
 748             sys.stderr.write("%s: unknown command \"%s\" "
 749                              "(use --help for help)\n" % (argv0, args[0]))
 750             sys.exit(1)
 751
 752         func, n_args = commands[args[0]]
 753         if len(args) - 1 != n_args:
 754             sys.stderr.write("%s: \"%s\" requires %d arguments but %d "
 755                              "provided\n"
 756                              % (argv0, args[0], n_args, len(args) - 1))
 757             sys.exit(1)
 758
 759         func(*args[1:])
 760     except ovs.db.error.Error, e:
 761         sys.stderr.write("%s: %s\n" % (argv0, e))
 762         sys.exit(1)
 763
 764 # Local variables:
 765 # mode: python
 766 # End: