forked from openvswitch/ovs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathovsdb-idlc.in
executable file
·1591 lines (1436 loc) · 61.1 KB
/
ovsdb-idlc.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#! @PYTHON3@
from __future__ import print_function
import getopt
import os
import re
import sys
import ovs.json
import ovs.db.error
import ovs.db.schema
from ovs.db.types import StringType, IntegerType, RealType
argv0 = sys.argv[0]
def parseSchema(filename):
return ovs.db.schema.IdlSchema.from_json(ovs.json.from_file(filename))
def annotateSchema(schemaFile, annotationFile):
schemaJson = ovs.json.from_file(schemaFile)
exec(compile(open(annotationFile, "rb").read(), annotationFile, 'exec'), globals(), {"s": schemaJson})
ovs.json.to_stream(schemaJson, sys.stdout)
sys.stdout.write('\n')
def constify(cType, const):
if (const
and cType.endswith('*') and
(cType == 'char **' or not cType.endswith('**'))):
return 'const %s' % cType
else:
return cType
def cMembers(prefix, tableName, columnName, column, const, refTable=True):
comment = ""
type = column.type
if type.is_smap():
comment = """
/* Sets the "%(c)s" column's value from the "%(t)s" table in 'row'
* to '%(c)s'.
*
* The caller retains ownership of '%(c)s' and everything in it. */""" \
% {'c': columnName,
't': tableName}
return (comment, [{'name': columnName,
'type': 'struct smap ',
'comment': ''}])
comment = """\n/* Sets the "%s" column from the "%s" table in """\
"""'row' to\n""" % (columnName, tableName)
if type.n_min == 1 and type.n_max == 1:
singleton = True
pointer = ''
else:
singleton = False
if type.is_optional_pointer():
pointer = ''
else:
pointer = '*'
if type.value:
keyName = "key_%s" % columnName
valueName = "value_%s" % columnName
key = {'name': keyName,
'type': constify(type.key.toCType(prefix, refTable) + pointer, const),
'comment': ''}
value = {'name': valueName,
'type': constify(type.value.toCType(prefix, refTable) + pointer, const),
'comment': ''}
if singleton:
comment += " * the map with key '%s' and value '%s'\n *" \
% (keyName, valueName)
else:
comment += " * the map with keys '%s' and values '%s'\n *" \
% (keyName, valueName)
members = [key, value]
else:
m = {'name': columnName,
'type': constify(type.key.toCType(prefix, refTable) + pointer, const),
'comment': type.cDeclComment()}
if singleton:
comment += " * '%s'" % columnName
else:
comment += " * the '%s' set" % columnName
members = [m]
if not singleton and not type.is_optional_pointer():
sizeName = "n_%s" % columnName
comment += " with '%s' entries" % sizeName
members.append({'name': sizeName,
'type': 'size_t ',
'comment': ''})
comment += ".\n"
if type.is_optional() and not type.is_optional_pointer():
comment += """ *
* '%s' may be 0 or 1; if it is 0, then '%s'
* may be NULL.\n""" \
% ("n_%s" % columnName, columnName)
if type.is_optional_pointer():
comment += """ *
* If "%s" is null, the column will be the empty set,
* otherwise it will contain the specified value.\n""" % columnName
if type.constraintsToEnglish():
comment += """ *
* Argument constraints: %s\n""" \
% type.constraintsToEnglish(lambda s : '"%s"' % s)
comment += " *\n * The caller retains ownership of the arguments. */"
return (comment, members)
# This is equivalent to sorted(table.columns.items()), except that the
# sorting includes a topological component: if column B has a
# dependency on column A, then A will be sorted before B.
def sorted_columns(table):
input = []
for name, column in table.columns.items():
dependencies = column.extensions.get('dependencies', [])
for d in dependencies:
if d not in table.columns:
sys.stderr.write("Table %s column %s depends on column %s "
"but there is no such column\n"
% (table.name, name, d))
sys.exit(1)
input += [(name, column, set(dependencies))]
output = []
satisfied_dependencies = set()
while input:
done = []
next = []
for name, column, dependencies in input:
if dependencies <= satisfied_dependencies:
done += [(name, column)]
else:
next += [(name, column, dependencies)]
if not done:
sys.stderr.write("Table %s columns have circular dependencies\n"
% table.name)
sys.exit(1)
for name, column in done:
satisfied_dependencies.add(name)
output += sorted(done)
input = next
return output
# If a column name in the schema is a C or C++ keyword, append an underscore
# to the column name.
def replace_cplusplus_keyword(schema):
keywords = {'alignas', 'alignof', 'and', 'and_eq', 'asm', 'auto', 'bitand',
'bitor', 'bool', 'break', 'case', 'catch', 'char', 'char16_t',
'char32_t', 'class', 'compl', 'concept', 'const', 'const_cast',
'constexpr', 'continue', 'decltype', 'default', 'delete', 'do',
'double', 'dynamic_cast', 'else', 'enum', 'explicit', 'export',
'extern', 'false', 'float', 'for', 'friend', 'goto', 'if',
'inline', 'int', 'long', 'mutable', 'namespace', 'new',
'noexcept', 'not', 'not_eq', 'nullptr', 'operator', 'or',
'or_eq', 'private', 'protected', 'public', 'register',
'reinterpret_cast', 'requires', 'restrict', 'return', 'short',
'signed', 'sizeof', 'static', 'static_assert', 'static_cast',
'struct', 'switch', 'template', 'this', 'thread_local',
'throw', 'true', 'try', 'typedef', 'typeid', 'typename',
'union', 'unsigned', 'using', 'virtual', 'void', 'volatile',
'wchar_t', 'while', 'xor', 'xor_eq'}
for tableName, table in schema.tables.items():
for columnName in list(table.columns):
if columnName in keywords:
table.columns[columnName + '_'] = table.columns.pop(columnName)
def printCIDLHeader(schemaFile):
schema = parseSchema(schemaFile)
replace_cplusplus_keyword(schema)
prefix = schema.idlPrefix
print('''\
/* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
#ifndef %(prefix)sIDL_HEADER
#define %(prefix)sIDL_HEADER 1
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "ovsdb-data.h"
#include "ovsdb-idl-provider.h"
#include "smap.h"
#include "uuid.h"
#ifdef __cplusplus
extern "C" {
#endif
%(hDecls)s''' % {'prefix': prefix.upper(),
'hDecls': schema.hDecls})
for tableName, table in sorted(schema.tables.items()):
structName = "%s%s" % (prefix, tableName.lower())
print(" ")
print("/* %s table. */" % tableName)
print("struct %s {" % structName)
print("\tstruct ovsdb_idl_row header_;")
for columnName, column in sorted_columns(table):
print("\n\t/* %s column. */" % columnName)
if column.extensions.get("members"):
print("\t%s" % column.extensions["members"])
continue
comment, members = cMembers(prefix, tableName,
columnName, column, False)
for member in members:
print("\t%(type)s%(name)s;%(comment)s" % member)
print("};")
# Column indexes.
printEnum("%s_column_id" % structName.lower(), ["%s_COL_%s" % (structName.upper(), columnName.upper())
for columnName, column in sorted_columns(table)]
+ ["%s_N_COLUMNS" % structName.upper()])
print("")
for columnName in table.columns:
print("#define %(s)s_col_%(c)s (%(s)s_columns[%(S)s_COL_%(C)s])" % {
's': structName,
'S': structName.upper(),
'c': columnName,
'C': columnName.upper()})
print("\nextern struct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (structName, structName.upper()))
print('''
const struct %(s)s_table *%(s)s_table_get(const struct ovsdb_idl *);
const struct %(s)s *%(s)s_table_first(const struct %(s)s_table *);
#define %(S)s_TABLE_FOR_EACH(ROW, TABLE) \\
for ((ROW) = %(s)s_table_first(TABLE); \\
(ROW); \\
(ROW) = %(s)s_next(ROW))
#define %(S)s_TABLE_FOR_EACH_SAFE(ROW, NEXT, TABLE) \\
for ((ROW) = %(s)s_table_first(TABLE); \\
(ROW) ? ((NEXT) = %(s)s_next(ROW), 1) : 0; \\
(ROW) = (NEXT))
const struct %(s)s *%(s)s_get_for_uuid(const struct ovsdb_idl *, const struct uuid *);
const struct %(s)s *%(s)s_table_get_for_uuid(const struct %(s)s_table *, const struct uuid *);
const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
const struct %(s)s *%(s)s_next(const struct %(s)s *);
#define %(S)s_FOR_EACH(ROW, IDL) \\
for ((ROW) = %(s)s_first(IDL); \\
(ROW); \\
(ROW) = %(s)s_next(ROW))
#define %(S)s_FOR_EACH_SAFE(ROW, NEXT, IDL) \\
for ((ROW) = %(s)s_first(IDL); \\
(ROW) ? ((NEXT) = %(s)s_next(ROW), 1) : 0; \\
(ROW) = (NEXT))
unsigned int %(s)s_get_seqno(const struct ovsdb_idl *);
unsigned int %(s)s_row_get_seqno(const struct %(s)s *row, enum ovsdb_idl_change change);
const struct %(s)s *%(s)s_track_get_first(const struct ovsdb_idl *);
const struct %(s)s *%(s)s_track_get_next(const struct %(s)s *);
#define %(S)s_FOR_EACH_TRACKED(ROW, IDL) \\
for ((ROW) = %(s)s_track_get_first(IDL); \\
(ROW); \\
(ROW) = %(s)s_track_get_next(ROW))
const struct %(s)s *%(s)s_table_track_get_first(const struct %(s)s_table *);
#define %(S)s_TABLE_FOR_EACH_TRACKED(ROW, TABLE) \\
for ((ROW) = %(s)s_table_track_get_first(TABLE); \\
(ROW); \\
(ROW) = %(s)s_track_get_next(ROW))
/* Returns true if 'row' was inserted since the last change tracking reset. */
static inline bool %(s)s_is_new(const struct %(s)s *row)
{
return %(s)s_row_get_seqno(row, OVSDB_IDL_CHANGE_MODIFY) == 0;
}
/* Returns true if 'row' was deleted since the last change tracking reset. */
static inline bool %(s)s_is_deleted(const struct %(s)s *row)
{
return %(s)s_row_get_seqno(row, OVSDB_IDL_CHANGE_DELETE) > 0;
}
void %(s)s_index_destroy_row(const struct %(s)s *);
struct %(s)s *%(s)s_index_find(struct ovsdb_idl_index *, const struct %(s)s *);
int %(s)s_index_compare(
struct ovsdb_idl_index *,
const struct %(s)s *,
const struct %(s)s *);
struct ovsdb_idl_cursor %(s)s_cursor_first(struct ovsdb_idl_index *);
struct ovsdb_idl_cursor %(s)s_cursor_first_eq(
struct ovsdb_idl_index *, const struct %(s)s *);
struct ovsdb_idl_cursor %(s)s_cursor_first_ge(
struct ovsdb_idl_index *, const struct %(s)s *);
struct %(s)s *%(s)s_cursor_data(struct ovsdb_idl_cursor *);
#define %(S)s_FOR_EACH_RANGE(ROW, FROM, TO, INDEX) \\
for (struct ovsdb_idl_cursor cursor__ = %(s)s_cursor_first_ge(INDEX, FROM); \\
(cursor__.position \\
&& ((ROW) = %(s)s_cursor_data(&cursor__), \\
!(TO) || %(s)s_index_compare(INDEX, ROW, TO) <= 0)); \\
ovsdb_idl_cursor_next(&cursor__))
#define %(S)s_FOR_EACH_EQUAL(ROW, KEY, INDEX) \\
for (struct ovsdb_idl_cursor cursor__ = %(s)s_cursor_first_eq(INDEX, KEY); \\
(cursor__.position \\
? ((ROW) = %(s)s_cursor_data(&cursor__), \\
ovsdb_idl_cursor_next_eq(&cursor__), \\
true) \\
: false); \\
)
#define %(S)s_FOR_EACH_BYINDEX(ROW, INDEX) \\
for (struct ovsdb_idl_cursor cursor__ = %(s)s_cursor_first(INDEX); \\
(cursor__.position \\
? ((ROW) = %(s)s_cursor_data(&cursor__), \\
ovsdb_idl_cursor_next(&cursor__), \\
true) \\
: false); \\
)
void %(s)s_init(struct %(s)s *);
void %(s)s_delete(const struct %(s)s *);
struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *);
bool %(s)s_is_updated(const struct %(s)s *, enum %(s)s_column_id);
''' % {'s': structName, 'S': structName.upper()})
for columnName, column in sorted_columns(table):
if column.extensions.get('synthetic'):
continue
print('void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName})
print("")
for columnName, column in sorted_columns(table):
if column.extensions.get('synthetic'):
continue
if column.type.value:
valueParam = ', enum ovsdb_atomic_type value_type'
else:
valueParam = ''
print('const struct ovsdb_datum *%(s)s_get_%(c)s(const struct %(s)s *, enum ovsdb_atomic_type key_type%(v)s);' % {
's': structName, 'c': columnName, 'v': valueParam})
print("")
for columnName, column in sorted_columns(table):
if column.extensions.get('synthetic'):
continue
print('void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName}, end=' ')
if column.type.is_smap():
args = ['const struct smap *']
else:
comment, members = cMembers(prefix, tableName, columnName,
column, True)
args = ['%(type)s%(name)s' % member for member in members]
print('%s);' % ', '.join(args))
print("")
for columnName, column in sorted_columns(table):
if column.extensions.get('synthetic'):
continue
if column.type.is_map():
print('void %(s)s_update_%(c)s_setkey(const struct %(s)s *, ' % {'s': structName, 'c': columnName}, end=' ')
print('%(coltype)s, %(valtype)s);' % {'coltype':column.type.key.to_const_c_type(prefix), 'valtype':column.type.value.to_const_c_type(prefix)})
print('void %(s)s_update_%(c)s_delkey(const struct %(s)s *, ' % {'s': structName, 'c': columnName}, end=' ')
print('%(coltype)s);' % {'coltype':column.type.key.to_const_c_type(prefix)})
if column.type.is_set():
print('void %(s)s_update_%(c)s_addvalue(const struct %(s)s *, ' % {'s': structName, 'c': columnName}, end=' ')
print('%(valtype)s);' % {'valtype':column.type.key.to_const_c_type(prefix)})
print('void %(s)s_update_%(c)s_delvalue(const struct %(s)s *, ' % {'s': structName, 'c': columnName}, end=' ')
print('%(valtype)s);' % {'valtype':column.type.key.to_const_c_type(prefix)})
print('void %(s)s_add_clause_%(c)s(struct ovsdb_idl_condition *, enum ovsdb_function function,' % {'s': structName, 'c': columnName}, end=' ')
if column.type.is_smap():
args = ['const struct smap *']
else:
comment, members = cMembers(prefix, tableName, columnName,
column, True, refTable=False)
args = ['%(type)s%(name)s' % member for member in members]
print('%s);' % ', '.join(args))
print('void %(s)s_set_condition(struct ovsdb_idl *, struct ovsdb_idl_condition *);' % {'s': structName})
print("")
# Table indexes.
print("struct %(s)s *%(s)s_index_init_row(struct ovsdb_idl_index *);" % {'s': structName})
print
for columnName, column in sorted(table.columns.items()):
print('void %(s)s_index_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName})
if column.type.is_smap():
args = ['const struct smap *']
else:
comment, members = cMembers(prefix, tableName, columnName,
column, True)
args = ['%(type)s%(name)s' % member for member in members]
print('%s);' % ', '.join(args))
print
printEnum("%stable_id" % prefix.lower(), ["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in sorted(schema.tables)] + ["%sN_TABLES" % prefix.upper()])
print("")
for tableName in schema.tables:
print("#define %(p)stable_%(t)s (%(p)stable_classes[%(P)sTABLE_%(T)s])" % {
'p': prefix,
'P': prefix.upper(),
't': tableName.lower(),
'T': tableName.upper()})
print("\nextern struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper()))
print("\nextern struct ovsdb_idl_class %sidl_class;" % prefix)
print("\nconst char * %sget_db_version(void);" % prefix)
print('''
#ifdef __cplusplus
}
#endif''')
print("\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()})
def printEnum(type, members):
if len(members) == 0:
return
print("\nenum %s {" % type)
for member in members[:-1]:
print(" %s," % member)
print(" %s" % members[-1])
print("};")
def printCIDLSource(schemaFile):
schema = parseSchema(schemaFile)
replace_cplusplus_keyword(schema)
prefix = schema.idlPrefix
print('''\
/* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
#include <config.h>
#include %(header)s
#include <limits.h>
#include "ovs-thread.h"
#include "ovsdb-data.h"
#include "ovsdb-error.h"
#include "util.h"
%(cDecls)s
''' % {'header': schema.idlHeader,
'cDecls': schema.cDecls})
# Cast functions.
for tableName, table in sorted(schema.tables.items()):
structName = "%s%s" % (prefix, tableName.lower())
print('''
static struct %(s)s *
%(s)s_cast(const struct ovsdb_idl_row *row)
{
return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
}\
''' % {'s': structName})
for tableName, table in sorted(schema.tables.items()):
structName = "%s%s" % (prefix, tableName.lower())
print(" ")
print("/* %s table. */" % (tableName))
print('''
const struct %(s)s_table *
%(s)s_table_get(const struct ovsdb_idl *idl)
{
return (const struct %(s)s_table *) idl;
}
const struct %(s)s *
%(s)s_table_first(const struct %(s)s_table *table)
{
const struct ovsdb_idl *idl = (const struct ovsdb_idl *) table;
return %(s)s_first(idl);
}
const struct %(s)s *
%(s)s_table_track_get_first(const struct %(s)s_table *table)
{
const struct ovsdb_idl *idl = (const struct ovsdb_idl *) table;
return %(s)s_track_get_first(idl);
}
''' % {'s': structName})
# Parse functions.
for columnName, column in sorted_columns(table):
if 'parse' in column.extensions:
print('''
static void
%(s)s_parse_%(c)s(struct ovsdb_idl_row *row_, const struct ovsdb_datum *datum OVS_UNUSED)
{
struct %(s)s *row = %(s)s_cast(row_);\
''' % {'s': structName, 'c': columnName})
print(column.extensions["parse"])
print("}")
continue
if column.extensions.get('synthetic'):
# Synthetic columns aren't parsed from a datum.
unused = " OVS_UNUSED"
else:
unused = ""
print('''
static void
%(s)s_parse_%(c)s(struct ovsdb_idl_row *row_, const struct ovsdb_datum *datum)
{
struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName,
'c': columnName})
type = column.type
if 'parse' in column.extensions:
print(column.extensions["parse"])
print("}")
continue
if type.value:
keyVar = "row->key_%s" % columnName
valueVar = "row->value_%s" % columnName
else:
keyVar = "row->%s" % columnName
valueVar = None
if type.is_smap():
print(" smap_init(&row->%s);" % columnName)
print(" for (size_t i = 0; i < datum->n; i++) {")
print(" smap_add(&row->%s," % columnName)
print(" datum->keys[i].string,")
print(" datum->values[i].string);")
print(" }")
elif (type.n_min == 1 and type.n_max == 1) or type.is_optional_pointer():
print("")
print(" if (datum->n >= 1) {")
if not type.key.ref_table:
print(" %s = datum->keys[0].%s;" % (keyVar, type.key.type.to_string()))
else:
print(" %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_%s, &datum->keys[0].uuid));" % (keyVar, prefix, type.key.ref_table.name.lower(), prefix, type.key.ref_table.name.lower()))
if valueVar:
if not type.value.ref_table:
print(" %s = datum->values[0].%s;" % (valueVar, type.value.type.to_string()))
else:
print(" %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_%s, &datum->values[0].uuid));" % (valueVar, prefix, type.value.ref_table.name.lower(), prefix, type.value.ref_table.name.lower()))
print(" } else {")
print(" %s" % type.key.initCDefault(keyVar, type.n_min == 0))
if valueVar:
print(" %s" % type.value.initCDefault(valueVar, type.n_min == 0))
print(" }")
else:
if type.n_max != sys.maxsize:
print(" size_t n = MIN(%d, datum->n);" % type.n_max)
nMax = "n"
else:
nMax = "datum->n"
print(" %s = NULL;" % keyVar)
if valueVar:
print(" %s = NULL;" % valueVar)
print(" row->n_%s = 0;" % columnName)
print(" for (size_t i = 0; i < %s; i++) {" % nMax)
if type.key.ref_table:
print("""\
struct %s%s *keyRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_%s, &datum->keys[i].uuid));
if (!keyRow) {
continue;
}\
""" % (prefix, type.key.ref_table.name.lower(), prefix, type.key.ref_table.name.lower(), prefix, type.key.ref_table.name.lower()))
keySrc = "keyRow"
else:
keySrc = "datum->keys[i].%s" % type.key.type.to_string()
if type.value and type.value.ref_table:
print("""\
struct %s%s *valueRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_%s, &datum->values[i].uuid));
if (!valueRow) {
continue;
}\
""" % (prefix, type.value.ref_table.name.lower(), prefix, type.value.ref_table.name.lower(), prefix, type.value.ref_table.name.lower()))
valueSrc = "valueRow"
elif valueVar:
valueSrc = "datum->values[i].%s" % type.value.type.to_string()
print(" if (!row->n_%s) {" % (columnName))
print(" %s = xmalloc(%s * sizeof *%s);" % (
keyVar, nMax, keyVar))
if valueVar:
print(" %s = xmalloc(%s * sizeof *%s);" % (
valueVar, nMax, valueVar))
print(" }")
print(" %s[row->n_%s] = %s;" % (keyVar, columnName, keySrc))
if valueVar:
print(" %s[row->n_%s] = %s;" % (valueVar, columnName, valueSrc))
print(" row->n_%s++;" % columnName)
print(" }")
print("}")
# Unparse functions.
for columnName, column in sorted_columns(table):
type = column.type
if (type.is_smap() or (type.n_min != 1 or type.n_max != 1) and not type.is_optional_pointer()) or 'unparse' in column.extensions:
print('''
static void
%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_)
{
struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName,
'c': columnName})
if 'unparse' in column.extensions:
print(column.extensions["unparse"])
elif type.is_smap():
print(" smap_destroy(&row->%s);" % columnName)
else:
if type.value:
keyVar = "row->key_%s" % columnName
valueVar = "row->value_%s" % columnName
else:
keyVar = "row->%s" % columnName
valueVar = None
print(" free(%s);" % keyVar)
if valueVar:
print(" free(%s);" % valueVar)
print('}')
else:
print('''
static void
%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED)
{
/* Nothing to do. */
}''' % {'s': structName, 'c': columnName})
# Generic Row Initialization function.
print("""
static void
%(s)s_init__(struct ovsdb_idl_row *row)
{
%(s)s_init(%(s)s_cast(row));
}""" % {'s': structName})
# Row Initialization function.
print("""
/* Clears the contents of 'row' in table "%(t)s". */
void
%(s)s_init(struct %(s)s *row)
{
memset(row, 0, sizeof *row); """ % {'s': structName, 't': tableName})
for columnName, column in sorted_columns(table):
if column.type.is_smap():
print(" smap_init(&row->%s);" % columnName)
elif (column.type.n_min == 1 and
column.type.n_max == 1 and
column.type.key.type == ovs.db.types.StringType and
not column.type.value):
print(" row->%s = \"\";" % columnName)
print("}")
# First, next functions.
print('''
/* Searches table "%(t)s" in 'idl' for a row with UUID 'uuid'. Returns
* a pointer to the row if there is one, otherwise a null pointer. */
const struct %(s)s *
%(s)s_get_for_uuid(const struct ovsdb_idl *idl, const struct uuid *uuid)
{
return %(s)s_cast(ovsdb_idl_get_row_for_uuid(idl, &%(p)stable_%(tl)s, uuid));
}
/* Searches table "%(t)s" for a row with UUID 'uuid'. Returns
* a pointer to the row if there is one, otherwise a null pointer. */
const struct %(s)s *
%(s)s_table_get_for_uuid(const struct %(s)s_table *table, const struct uuid *uuid)
{
const struct ovsdb_idl *idl = (const struct ovsdb_idl *) table;
return %(s)s_get_for_uuid(idl, uuid);
}
/* Returns a row in table "%(t)s" in 'idl', or a null pointer if that
* table is empty.
*
* Database tables are internally maintained as hash tables, so adding or
* removing rows while traversing the same table can cause some rows to be
* visited twice or not at apply. */
const struct %(s)s *
%(s)s_first(const struct ovsdb_idl *idl)
{
return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_%(tl)s));
}
/* Returns a row following 'row' within its table, or a null pointer if 'row'
* is the last row in its table. */
const struct %(s)s *
%(s)s_next(const struct %(s)s *row)
{
return %(s)s_cast(ovsdb_idl_next_row(&row->header_));
}
unsigned int %(s)s_get_seqno(const struct ovsdb_idl *idl)
{
return ovsdb_idl_table_get_seqno(idl, &%(p)stable_%(tl)s);
}
unsigned int %(s)s_row_get_seqno(const struct %(s)s *row, enum ovsdb_idl_change change)
{
return ovsdb_idl_row_get_seqno(&row->header_, change);
}
const struct %(s)s *
%(s)s_track_get_first(const struct ovsdb_idl *idl)
{
return %(s)s_cast(ovsdb_idl_track_get_first(idl, &%(p)stable_%(tl)s));
}
const struct %(s)s
*%(s)s_track_get_next(const struct %(s)s *row)
{
return %(s)s_cast(ovsdb_idl_track_get_next(&row->header_));
}''' % {'s': structName,
'p': prefix,
'P': prefix.upper(),
't': tableName,
'tl': tableName.lower(),
'T': tableName.upper()})
print('''
/* Deletes 'row' from table "%(t)s". 'row' may be freed, so it must not be
* accessed afterward.
*
* The caller must have started a transaction with ovsdb_idl_txn_create(). */
void
%(s)s_delete(const struct %(s)s *row)
{
ovsdb_idl_txn_delete(&row->header_);
}
/* Inserts and returns a new row in the table "%(t)s" in the database
* with open transaction 'txn'.
*
* The new row is assigned a randomly generated provisional UUID.
* ovsdb-server will assign a different UUID when 'txn' is committed,
* but the IDL will replace any uses of the provisional UUID in the
* data to be to be committed by the UUID assigned by ovsdb-server. */
struct %(s)s *
%(s)s_insert(struct ovsdb_idl_txn *txn)
{
return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_%(tl)s, NULL));
}
bool
%(s)s_is_updated(const struct %(s)s *row, enum %(s)s_column_id column)
{
return ovsdb_idl_track_is_updated(&row->header_, &%(s)s_columns[column]);
}''' % {'s': structName,
'p': prefix,
'P': prefix.upper(),
't': tableName,
'tl': tableName.lower(),
'T': tableName.upper()})
# Verify functions.
for columnName, column in sorted_columns(table):
if column.extensions.get('synthetic'):
continue
print('''
/* Causes the original contents of column "%(c)s" in 'row' to be
* verified as a prerequisite to completing the transaction. That is, if
* "%(c)s" in 'row' changed (or if 'row' was deleted) between the
* time that the IDL originally read its contents and the time that the
* transaction aborts and ovsdb_idl_txn_commit() returns TXN_TRY_AGAIN.
*
* The intention is that, to ensure that no transaction commits based on dirty
* reads, an application should call this function any time "%(c)s" is
* read as part of a read-modify-write operation.
*
* In some cases this function reduces to a no-op, because the current value
* of "%(c)s" is already known:
*
* - If 'row' is a row created by the current transaction (returned by
* %(s)s_insert()).
*
* - If "%(c)s" has already been modified (with
* %(s)s_set_%(c)s()) within the current transaction.
*
* Because of the latter property, always call this function *before*
* %(s)s_set_%(c)s() for a given read-modify-write.
*
* The caller must have started a transaction with ovsdb_idl_txn_create(). */
void
%(s)s_verify_%(c)s(const struct %(s)s *row)
{
ovsdb_idl_txn_verify(&row->header_, &%(s)s_col_%(c)s);
}''' % {'s': structName,
'S': structName.upper(),
'c': columnName,
'C': columnName.upper()})
# Get functions.
for columnName, column in sorted_columns(table):
if column.extensions.get('synthetic'):
continue
if column.type.value:
valueParam = ',\n\tenum ovsdb_atomic_type value_type OVS_UNUSED'
valueType = '\n ovs_assert(value_type == %s);' % column.type.value.toAtomicType()
valueComment = "\n * 'value_type' must be %s." % column.type.value.toAtomicType()
else:
valueParam = ''
valueType = ''
valueComment = ''
print("""
/* Returns the "%(c)s" column's value from the "%(t)s" table in 'row'
* as a struct ovsdb_datum. This is useful occasionally: for example,
* ovsdb_datum_find_key() is an easier and more efficient way to search
* for a given key than implementing the same operation on the "cooked"
* form in 'row'.
*
* 'key_type' must be %(kt)s.%(vc)s
* (This helps to avoid silent bugs if someone changes %(c)s's
* type without updating the caller.)
*
* The caller must not modify or free the returned value.
*
* Various kinds of changes can invalidate the returned value: modifying
* 'column' within 'row', deleting 'row', or completing an ongoing transaction.
* If the returned value is needed for a long time, it is best to make a copy
* of it with ovsdb_datum_clone().
*
* This function is rarely useful, since it is easier to access the value
* directly through the "%(c)s" member in %(s)s. */
const struct ovsdb_datum *
%(s)s_get_%(c)s(const struct %(s)s *row,
\tenum ovsdb_atomic_type key_type OVS_UNUSED%(v)s)
{
ovs_assert(key_type == %(kt)s);%(vt)s
return ovsdb_idl_read(&row->header_, &%(s)s_col_%(c)s);
}""" % {'t': tableName, 's': structName, 'c': columnName,
'kt': column.type.key.toAtomicType(),
'v': valueParam, 'vt': valueType, 'vc': valueComment})
# Set functions.
for columnName, column in sorted_columns(table):
if column.extensions.get('synthetic'):
continue
type = column.type
comment, members = cMembers(prefix, tableName, columnName,
column, True)
if type.is_smap():
print(comment)
print("""void
%(s)s_set_%(c)s(const struct %(s)s *row, const struct smap *%(c)s)
{
struct ovsdb_datum datum;
if (%(c)s) {
ovsdb_datum_from_smap(&datum, %(c)s);
} else {
ovsdb_datum_init_empty(&datum);
}
ovsdb_idl_txn_write(&row->header_,
&%(s)s_col_%(c)s,
&datum);
}
""" % {'t': tableName,
's': structName,
'S': structName.upper(),
'c': columnName,
'C': columnName.upper()})
continue
keyVar = members[0]['name']
nVar = None
valueVar = None
if type.value:
valueVar = members[1]['name']
if len(members) > 2:
nVar = members[2]['name']
else:
if len(members) > 1:
nVar = members[1]['name']
print(comment)
print("""\
void
%(s)s_set_%(c)s(const struct %(s)s *row, %(args)s)
{
struct ovsdb_datum datum;""" % {'s': structName,
'c': columnName,
'args': ', '.join(['%(type)s%(name)s'
% m for m in members])})
if type.n_min == 1 and type.n_max == 1:
print(" union ovsdb_atom key;")
if type.value:
print(" union ovsdb_atom value;")
print("")
print(" datum.n = 1;")
print(" datum.keys = &key;")
print(" " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), keyVar))
if type.value:
print(" datum.values = &value;")
print(" "+ type.value.assign_c_value_casting_away_const("value.%s" % type.value.type.to_string(), valueVar))
else:
print(" datum.values = NULL;")
txn_write_func = "ovsdb_idl_txn_write_clone"
elif type.is_optional_pointer():
print(" union ovsdb_atom key;")
print("")
print(" if (%s) {" % keyVar)
print(" datum.n = 1;")
print(" datum.keys = &key;")
print(" " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), keyVar))
print(" } else {")
print(" datum.n = 0;")
print(" datum.keys = NULL;")
print(" }")
print(" datum.values = NULL;")
txn_write_func = "ovsdb_idl_txn_write_clone"
elif type.n_max == 1:
print(" union ovsdb_atom key;")
print("")
print(" if (%s) {" % nVar)
print(" datum.n = 1;")
print(" datum.keys = &key;")
print(" " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), "*" + keyVar))
print(" } else {")
print(" datum.n = 0;")
print(" datum.keys = NULL;")
print(" }")
print(" datum.values = NULL;")
txn_write_func = "ovsdb_idl_txn_write_clone"
else:
print("")
print(" datum.n = %s;" % nVar)
print(" datum.keys = %s ? xmalloc(%s * sizeof *datum.keys) : NULL;" % (nVar, nVar))
if type.value:
print(" datum.values = xmalloc(%s * sizeof *datum.values);" % nVar)
else:
print(" datum.values = NULL;")
print(" for (size_t i = 0; i < %s; i++) {" % nVar)
print(" " + type.key.copyCValue("datum.keys[i].%s" % type.key.type.to_string(), "%s[i]" % keyVar))
if type.value:
print(" " + type.value.copyCValue("datum.values[i].%s" % type.value.type.to_string(), "%s[i]" % valueVar))
print(" }")
if type.value:
valueType = type.value.toAtomicType()
else:
valueType = "OVSDB_TYPE_VOID"
txn_write_func = "ovsdb_idl_txn_write"
print(" %(f)s(&row->header_, &%(s)s_col_%(c)s, &datum);" \
% {'f': txn_write_func,
's': structName,
'S': structName.upper(),
'c': columnName})
print("}")
# Update/Delete of partial map column functions
for columnName, column in sorted_columns(table):
if column.extensions.get('synthetic'):
continue
type = column.type
if type.is_map():
print('''
/* Sets an element of the "%(c)s" map column from the "%(t)s" table in 'row'
* to 'new_value' given the key value 'new_key'.
*
*/
void
%(s)s_update_%(c)s_setkey(const struct %(s)s *row, %(coltype)snew_key, %(valtype)snew_value)
{
struct ovsdb_datum *datum;
datum = xmalloc(sizeof *datum);
datum->n = 1;
datum->keys = xmalloc(datum->n * sizeof *datum->keys);
datum->values = xmalloc(datum->n * sizeof *datum->values);
''' % {'s': structName, 'c': columnName,'coltype':column.type.key.to_const_c_type(prefix),
'valtype':column.type.value.to_const_c_type(prefix), 'S': structName.upper(),
'C': columnName.upper(), 't': tableName})
print(" "+ type.key.copyCValue("datum->keys[0].%s" % type.key.type.to_string(), "new_key"))
print(" "+ type.value.copyCValue("datum->values[0].%s" % type.value.type.to_string(), "new_value"))
print('''
ovsdb_idl_txn_write_partial_map(&row->header_,
&%(s)s_col_%(c)s,
datum);
}''' % {'s': structName, 'c': columnName,'coltype':column.type.key.toCType(prefix),
'valtype':column.type.value.to_const_c_type(prefix), 'S': structName.upper()})
print('''
/* Deletes an element of the "%(c)s" map column from the "%(t)s" table in 'row'
* given the key value 'delete_key'.
*
*/
void
%(s)s_update_%(c)s_delkey(const struct %(s)s *row, %(coltype)sdelete_key)
{