blob: 9add81b000ad85a03b487ec50db565143c2e6b02 [file] [log] [blame]
Rich Lanea06d0c32013-03-25 08:52:03 -07001# Copyright 2013, Big Switch Networks, Inc.
2#
3# LoxiGen is licensed under the Eclipse Public License, version 1.0 (EPL), with
4# the following special exception:
5#
6# LOXI Exception
7#
8# As a special exception to the terms of the EPL, you may distribute libraries
9# generated by LoxiGen (LoxiGen Libraries) under the terms of your choice, provided
10# that copyright and licensing notices generated by LoxiGen are not altered or removed
11# from the LoxiGen Libraries and the notice provided below is (i) included in
12# the LoxiGen Libraries, if distributed in source code form and (ii) included in any
13# documentation for the LoxiGen Libraries, if distributed in binary form.
14#
15# Notice: "Copyright 2013, Big Switch Networks, Inc. This library was generated by the LoxiGen Compiler."
16#
17# You may not use this file except in compliance with the EPL or LOXI Exception. You may obtain
18# a copy of the EPL at:
19#
20# http://www.eclipse.org/legal/epl-v10.html
21#
22# Unless required by applicable law or agreed to in writing, software
23# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
25# EPL for the specific language governing permissions and limitations
26# under the EPL.
27
28"""
29@file code_gen.py
30Code generation functions for LOCI
31"""
32
33import sys
Andreas Wundsam76db0062013-11-15 13:34:41 -080034import c_gen.of_g_legacy as of_g
Rich Lanea06d0c32013-03-25 08:52:03 -070035import c_match
36from generic_utils import *
Andreas Wundsam542a13c2013-11-15 13:28:55 -080037from c_gen import flags, type_maps, c_type_maps
38import c_gen.loxi_utils_legacy as loxi_utils
Rich Lane92feca82013-12-10 15:57:13 -080039import loxi_globals
Rich Lanea06d0c32013-03-25 08:52:03 -070040
Andreas Wundsam542a13c2013-11-15 13:28:55 -080041import c_gen.identifiers as identifiers
Rich Lanea06d0c32013-03-25 08:52:03 -070042
Andreas Wundsam76db0062013-11-15 13:34:41 -080043# 'property' is for queues. Could be trouble
Rich Lanea06d0c32013-03-25 08:52:03 -070044
45################################################################
46#
47# Misc helper functions
48#
49################################################################
50
51def h_file_to_define(name):
52 """
53 Convert a .h file name to the define used for the header
54 """
55 h_name = name[:-2].upper()
56 h_name = "_" + h_name + "_H_"
57 return h_name
58
59def enum_name(cls):
60 """
61 Return the name used for an enum identifier for the given class
62 @param cls The class name
63 """
64 return loxi_utils.enum_name(cls)
65
Rich Lanea06d0c32013-03-25 08:52:03 -070066# TODO serialize match outside accessor?
67def accessor_return_type(a_type, m_type):
68 if loxi_utils.accessor_returns_error(a_type, m_type):
69 return "int WARN_UNUSED_RESULT"
70 else:
71 return "void"
72
73def accessor_return_success(a_type, m_type):
74 if loxi_utils.accessor_returns_error(a_type, m_type):
75 return "OF_ERROR_NONE"
76 else:
77 return ""
78
79################################################################
80#
81# Per-file generators, mapped to jump table below
82#
83################################################################
84
85def base_h_gen(out, name):
86 """
87 Generate code for base header file
88 @param out The file handle to write to
89 @param name The name of the file
90 """
91 common_top_matter(out, name)
92 base_h_content(out)
93 gen_object_enum(out)
94 out.write("""
95/****************************************************************
96 *
97 * Experimenter IDs
98 *
99 ****************************************************************/
100
101""")
102 for name, val in of_g.experimenter_name_to_id.items():
103 out.write("#define OF_EXPERIMENTER_ID_%s 0x%08x\n" %
104 (name.upper(), val))
105
106 out.write("""
107/****************************************************************
108 *
109 * OpenFlow Match version specific and generic defines
110 *
111 ****************************************************************/
112""")
113 c_match.gen_v4_match_compat(out)
114 c_match.gen_match_macros(out)
115 c_match.gen_oxm_defines(out)
116 out.write("\n#endif /* Base header file */\n")
117
118def identifiers_gen(out, filename):
119 """
120 Generate the macros for LOCI identifiers
121 @param out The file handle to write to
122 @param filename The name of the file
123 """
124 common_top_matter(out, filename)
125 out.write("""
126/**
127 * For each identifier from an OpenFlow header file, a Loxi version
128 * of the identifier is generated. For example, ofp_port_flood becomes
Andreas Wundsam53256162013-05-02 14:05:53 -0700129 * OF_PORT_DEST_FLOOD. Loxi provides the following macros related to
Rich Lanea06d0c32013-03-25 08:52:03 -0700130 * OpenFlow identifiers (using OF_IDENT_ as an example below):
131 * OF_IDENT_BY_VERSION(version) Get the value for the specific version
132 * OF_IDENT_SUPPORTED(version) Boolean: Is OF_IDENT defined for version
133 * OF_IDENT The common value across all versions if defined
134 * OF_IDENT_GENERIC A unique value across all OF identifiers
135 *
136 * For identifiers marked as flags, the following are also defined
137 * OF_IDENT_SET(flags, version)
138 * OF_IDENT_CLEAR(flags, version)
139 * OF_IDENT_TEST(flags, version)
140 *
141 * Notes:
142 *
143 * OF_IDENT_BY_VERSION(version) returns an undefined value
144 * if the passed version does not define OF_IDENT. It does not generate an
145 * error, nor record anything to the log file. If the value is the same
146 * across all defined versions, the version is ignored.
147 *
148 * OF_IDENT is only defined if the value is the same across all
149 * target LOXI versions FOR WHICH IT IS DEFINED. No error checking is
150 * done. This allows code to be written without requiring the version
151 * to be known or referenced when it doesn't matter. It does mean
152 * that when porting to a new version of OpenFlow, compile errors may
153 * occur. However, this is an indication that the existing code must
154 * be updated to account for a change in the semantics with the newly
155 * supported OpenFlow version.
156 *
157 * @fixme Currently we do not handle multi-bit flags or field values; for
158 * example, OF_TABLE_CONFIG_TABLE_MISS_CONTROLLER is the meaning for
159 * a zero value in the bits indicated by OF_TABLE_CONFIG_TABLE_MISS_MASK.
160 *
161 * @fixme Need to decide (or make a code gen option) on the requirement
162 * for defining OF_IDENT: Is it that all target versions define it and
163 * the agree? Or only that the versions which define it agree?
164 */
165""")
166
167 # Build value-by-version parameters and c_code
168 if len(of_g.target_version_list) > 1: # Supporting more than one version
169 vbv_params = []
170 vbv_code = ""
171 first = True
172 for version in of_g.target_version_list:
173 vbv_params.append("value_%s" % of_g.short_version_names[version])
174 if not first:
175 vbv_code += "\\\n "
176 else:
177 first = False
178 last_value = "value_%s" % of_g.short_version_names[version]
179 vbv_code += "((version) == %s) ? (%s) : " % \
180 (of_g.of_version_wire2name[version], last_value)
181 # @todo Using last value, can optimize out last ?
182 vbv_code += "(%s)" % last_value
183
184 out.write("""
185/**
186 * @brief True for the special case of all versions supported
187 */
188#define OF_IDENT_IN_ALL_VERSIONS 1 /* Indicates identifier in all versions */
189
190/**
191 * @brief General macro to map version to value where values given as params
192 *
193 * If unknown version is passed, use the latest version's value
194 */
195#define OF_VALUE_BY_VERSION(version, %s) \\
196 (%s)
197
198/**
199 * @brief Generic set a flag
200 */
201#define OF_FLAG_SET(flags, mask) (flags) = (flags) | (mask)
202
203/**
204 * @brief Generic test if a flag is set
205 */
206#define OF_FLAG_CLEAR(flags, mask) (flags) = (flags) & ~(mask)
207
208/**
209 * @brief Generic test if a flag is set
210 */
211#define OF_FLAG_TEST(flags, mask) ((flags) & (mask) ? 1 : 0)
212
213/**
214 * @brief Set a flag where the value is an enum indication of bit shift
215 */
216#define OF_FLAG_ENUM_SET(flags, e_val) OF_FLAG_SET(flags, 1 << (e_val))
217
218/**
219 * @brief Clear a flag where the value is an enum indication of bit shift
220 */
221#define OF_FLAG_ENUM_CLEAR(flags, e_val) OF_FLAG_CLEAR(flags, 1 << (e_val))
222
223/**
224 * @brief Test a flag where the value is an enum indication of bit shift
225 */
226#define OF_FLAG_ENUM_TEST(flags, e_val) OF_FLAG_TEST(flags, 1 << (e_val))
227""" % (", ".join(vbv_params), vbv_code))
228
229 # For each group of identifiers, bunch ident defns
230 count = 1
231 keys = of_g.identifiers_by_group.keys()
232 keys.sort()
233 for group in keys:
234 idents = of_g.identifiers_by_group[group]
235 idents.sort()
236 out.write("""
237/****************************************************************
Andreas Wundsam53256162013-05-02 14:05:53 -0700238 * Identifiers from %s
Rich Lanea06d0c32013-03-25 08:52:03 -0700239 *****************************************************************/
240""" % group)
241 for ident in idents:
242 info = of_g.identifiers[ident]
243
244 keys = info["values_by_version"].keys()
245 keys.sort()
246
247 out.write("""
248/*
249 * Defines for %(ident)s
250 * Original name %(ofp_name)s
251 */
252""" % dict(ident=ident, ofp_name=info["ofp_name"]))
253
254 # Generate supported versions macro
255 if len(keys) == len(of_g.target_version_list): # Defined for all
256 out.write("""\
257#define %(ident)s_SUPPORTED(version) OF_IDENT_IN_ALL_VERSIONS
258""" % dict(ident=ident))
259 else: # Undefined for some version
260 sup_list = []
261 for version in keys:
262 sup_list.append("((version) == %s)" %
263 of_g.of_version_wire2name[version])
264 out.write("""\
265#define %(ident)s_SUPPORTED(version) \\
266 (%(sup_str)s)
267""" % dict(ident=ident, sup_str=" || \\\n ".join(sup_list)))
268
269 # Generate value macro
270 if identifiers.defined_versions_agree(of_g.identifiers,
271 of_g.target_version_list,
272 ident):
273 out.write("""\
Rich Lanef3dc3962013-05-10 16:16:48 -0700274#define %(ident)s (%(value)#x)
275#define %(ident)s_BY_VERSION(version) (%(value)#x)
Rich Lanea06d0c32013-03-25 08:52:03 -0700276""" % dict(ident=ident,value=info["common_value"]))
277 else: # Values differ between versions
278 # Generate version check and value by version
279 val_list = []
280 # Order of params matters
281 for version in of_g.target_version_list:
282 if version in info["values_by_version"]:
283 value = info["values_by_version"][version]
284 else:
285 value = identifiers.UNDEFINED_IDENT_VALUE
Rich Lanef3dc3962013-05-10 16:16:48 -0700286 val_list.append("%#x" % value)
Rich Lanea06d0c32013-03-25 08:52:03 -0700287 out.write("""\
288#define %(ident)s_BY_VERSION(version) \\
289 OF_VALUE_BY_VERSION(version, %(val_str)s)
290""" % dict(ident=ident, val_str=", ".join(val_list)))
291 if flags.ident_is_flag(ident):
292 log("Treating %s as a flag" % ident)
293 out.write("""
294#define %(ident)s_SET(flags, version) \\
295 OF_FLAG_SET(flags, %(ident)s_BY_VERSION(version))
296#define %(ident)s_TEST(flags, version) \\
297 OF_FLAG_TEST(flags, %(ident)s_BY_VERSION(version))
298#define %(ident)s_CLEAR(flags, version) \\
299 OF_FLAG_CLEAR(flags, %(ident)s_BY_VERSION(version))
300""" % dict(ident=ident))
301
302 out.write("#define %(ident)s_GENERIC %(count)d\n"
303 % dict(ident=ident, count=count))
304 count += 1 # This count should probably be promoted higher
305
306 log("Generated %d identifiers" % (count - 1))
307 out.write("\n#endif /* Loci identifiers header file */\n")
308
Rich Lanea06d0c32013-03-25 08:52:03 -0700309def match_h_gen(out, name):
310 """
311 Generate code for
312 @param out The file handle to write to
313 @param name The name of the file
314 """
315 c_match.match_h_top_matter(out, name)
Rich Lanea06d0c32013-03-25 08:52:03 -0700316 c_match.gen_match_struct(out)
317 c_match.gen_match_comp(out)
Rich Lanea06d0c32013-03-25 08:52:03 -0700318 out.write("\n#endif /* Match header file */\n")
319
320def top_h_gen(out, name):
321 """
322 Generate code for
323 @param out The file handle to write to
324 @param name The name of the file
325 """
326 external_h_top_matter(out, name)
327 out.write("""
328
329typedef enum loci_log_level {
330 LOCI_LOG_LEVEL_TRACE,
331 LOCI_LOG_LEVEL_VERBOSE,
332 LOCI_LOG_LEVEL_INFO,
333 LOCI_LOG_LEVEL_WARN,
334 LOCI_LOG_LEVEL_ERROR,
335 LOCI_LOG_LEVEL_MSG
336} loci_log_level_t;
337
338/**
339 * @brief Output a log message.
340 * @param level The log level.
341 * @param fname The function name.
342 * @param file The file name.
343 * @param line The line number.
344 * @param format The message format string.
345 */
346typedef int (*loci_logger_f)(loci_log_level_t level,
347 const char *fname, const char *file, int line,
348 const char *format, ...);
349
350/*
351 * This variable should be set by the user of the library to redirect logs to
352 * their log infrastructure. The default drops all logs.
353 */
354extern loci_logger_f loci_logger;
355
356/**
357 * Map a generic object to the underlying wire buffer
358 *
359 * Treat as private
360 */
361#define OF_OBJECT_TO_MESSAGE(obj) \\
Rich Lanecdd542d2014-04-03 16:13:12 -0700362 ((of_message_t)(WBUF_BUF((obj)->wbuf)))
Rich Lanea06d0c32013-03-25 08:52:03 -0700363
364/**
365 * Macro for the fixed length part of an object
366 *
367 * @param obj The object whose extended length is being calculated
368 * @returns length in bytes of non-variable part of the object
369 */
370#define OF_OBJECT_FIXED_LENGTH(obj) \\
371 (of_object_fixed_len[(obj)->version][(obj)->object_id])
372
373/**
374 * Return the length of the object beyond its fixed length
375 *
376 * @param obj The object whose extended length is being calculated
377 * @returns length in bytes of non-variable part of the object
378 *
379 * Most variable length fields are alone at the end of a structure.
380 * Their length is a simple calculation, just the total length of
381 * the parent minus the length of the non-variable part of the
382 * parent's class type.
383 */
384
385#define OF_OBJECT_VARIABLE_LENGTH(obj) \\
386 ((obj)->length - OF_OBJECT_FIXED_LENGTH(obj))
387
Rich Lanea06d0c32013-03-25 08:52:03 -0700388extern int of_wire_buffer_of_match_get(of_object_t *obj, int offset,
389 of_match_t *match);
390extern int of_wire_buffer_of_match_set(of_object_t *obj, int offset,
391 of_match_t *match, int cur_len);
Rich Lanea06d0c32013-03-25 08:52:03 -0700392""")
393
394 # gen_base_types(out)
395
Rich Lanea06d0c32013-03-25 08:52:03 -0700396 out.write("""
397/****************************************************************
398 *
399 * Declarations of maps between on-the-wire type values and LOCI identifiers
400 *
401 ****************************************************************/
Rich Lanec0e20ff2013-12-15 23:40:31 -0800402
Rich Lanec0e20ff2013-12-15 23:40:31 -0800403int of_object_wire_init(of_object_t *obj, of_object_id_t base_object_id, int max_len);
404
405extern const int *const of_object_fixed_len[OF_VERSION_ARRAY_MAX];
Rich Lanea06d0c32013-03-25 08:52:03 -0700406""")
Rich Lanea06d0c32013-03-25 08:52:03 -0700407 c_type_maps.gen_type_data_header(out)
408 c_match.gen_declarations(out)
409 # @fixme Move debug stuff to own fn
410 out.write("""
411/**
412 * Macro to check consistency of length for top level objects
413 *
414 * If the object has no parent then its length should match the
415 * underlying wire buffer's current bytes.
416 */
417#define OF_LENGTH_CHECK_ASSERT(obj) \\
Rich Lanee57f0432014-02-19 10:31:53 -0800418 LOCI_ASSERT(((obj)->parent != NULL) || \\
Rich Lanecdd542d2014-04-03 16:13:12 -0700419 ((obj)->wbuf == NULL) || \\
420 (WBUF_CURRENT_BYTES((obj)->wbuf) == (obj)->length))
Rich Lanea06d0c32013-03-25 08:52:03 -0700421
422#define OF_DEBUG_DUMP
423#if defined(OF_DEBUG_DUMP)
424extern void dump_match(of_match_t *match);
425#endif /* OF_DEBUG_DUMP */
426""")
427
Rich Lane1f03f672014-08-05 00:10:00 -0700428 out.write("""
429static inline const char *
430of_class_name(of_object_t *obj)
431{
432 return of_object_id_str[obj->object_id];
433}
434""")
435
Rich Lanea06d0c32013-03-25 08:52:03 -0700436 out.write("\n#endif /* Top header file */\n")
437
438def match_c_gen(out, name):
439 """
440 Generate code for
441 @param out The file handle to write to
442 @param name The name of the file
443 """
444 c_match.match_c_top_matter(out, name)
445 c_match.gen_match_conversions(out)
446 c_match.gen_serialize(out)
447 c_match.gen_deserialize(out)
448
Rich Lanea06d0c32013-03-25 08:52:03 -0700449################################################################
450# Top Matter
451################################################################
452
453def common_top_matter(out, name):
454 loxi_utils.gen_c_copy_license(out)
455 out.write("""\
Rich Laned983aa52013-06-13 11:48:37 -0700456
Rich Lanea06d0c32013-03-25 08:52:03 -0700457/****************************************************************
458 * File: %s
459 *
460 * DO NOT EDIT
461 *
462 * This file is automatically generated
463 *
464 ****************************************************************/
465
466""" % name)
467
468 if name[-2:] == ".h":
469 out.write("""
470#if !defined(%(h)s)
471#define %(h)s
472
473""" % dict(h=h_file_to_define(name)))
474
475def base_h_content(out):
476 """
477 Generate base header file content
478
479 @param out The output file object
480 """
481
482 # @fixme Supported version should be generated based on input to LoxiGen
483
484 out.write("""
485/*
486 * Base OpenFlow definitions. These depend only on standard C headers
487 */
488#include <string.h>
489#include <stdint.h>
490
491/* g++ requires this to pick up PRI, etc.
492 * See http://gcc.gnu.org/ml/gcc-help/2006-10/msg00223.html
493 */
494#if !defined(__STDC_FORMAT_MACROS)
495#define __STDC_FORMAT_MACROS
496#endif
497#include <inttypes.h>
498
499#include <stdlib.h>
500#include <assert.h>
501#include <loci/loci_idents.h>
502
503/**
504 * Macro to enable debugging for LOCI.
505 *
506 * This enables debug output to stdout.
507 */
508#define OF_DEBUG_ENABLE
509
510#if defined(OF_DEBUG_ENABLE)
511#include <stdio.h> /* Currently for debugging */
512#define FIXME(str) do { \\
513 fprintf(stderr, "%s\\n", str); \\
514 exit(1); \\
515 } while (0)
516#define debug printf
517#else
518#define FIXME(str)
519#define debug(str, ...)
520#endif /* OF_DEBUG_ENABLE */
521
522/**
523 * The type of a function used by the LOCI dump/show functions to
524 * output text. Essentially the same signature as fprintf. May
525 * be called many times per invocation of e.g. of_object_show().
526 */
527typedef int (*loci_writer_f)(void *cookie, const char *fmt, ...);
528
529/**
530 * Check if a version is supported
531 */
Rich Lane2b49df62014-10-14 11:41:28 -0700532#define OF_VERSION_OKAY(v) ((v) >= OF_VERSION_1_0 && (v) <= OF_VERSION_1_4)
Rich Lanea06d0c32013-03-25 08:52:03 -0700533
534""")
535 gen_version_enum(out)
536 out.write("\n")
537
538 # for c_name in of_g.ofp_constants:
539 # val = str(of_g.ofp_constants[c_name])
540 # out.write("#define %s %s\n" % (c_name, val))
541 # out.write("\n")
542
543 out.write("""
544typedef enum of_error_codes_e {
545 OF_ERROR_NONE = 0,
546 OF_ERROR_RESOURCE = -1, /* Could not allocate space */
547 OF_ERROR_PARAM = -2, /* Bad parameter */
548 OF_ERROR_VERSION = -3, /* Version not supported */
549 OF_ERROR_RANGE = -4, /* End of list indication */
550 OF_ERROR_COMPAT = -5, /* Incompatible assignment */
551 OF_ERROR_PARSE = -6, /* Error in parsing data */
552 OF_ERROR_INIT = -7, /* Uninitialized data */
553 OF_ERROR_UNKNOWN = -8 /* Unknown error */
554} of_error_codes_t;
555
556#define OF_ERROR_STRINGS "none", \\
557 "resource", \\
558 "parameter", \\
559 "version", \\
560 "range", \\
561 "incompatible", \\
562 "parse", \\
563 "init", \\
564 "unknown"
565
Rich Laneb157b0f2013-03-27 13:55:28 -0700566extern const char *const of_error_strings[];
Rich Lanea06d0c32013-03-25 08:52:03 -0700567
Rich Lanea8b54632014-02-19 11:17:47 -0800568#ifdef __GNUC__
569#define LOCI_NORETURN_ATTR __attribute__((__noreturn__))
570#else
571#define LOCI_NORETURN_ATTR
572#endif
573
574extern void loci_assert_fail(
575 const char *cond,
576 const char *file,
577 unsigned int line) LOCI_NORETURN_ATTR;
578
Rich Lane53757732013-02-23 17:00:10 -0800579#ifndef NDEBUG
Rich Lanea8b54632014-02-19 11:17:47 -0800580#define LOCI_ASSERT(val) ((val) ? (void)0 : loci_assert_fail(#val, __FILE__, __LINE__))
Rich Lane53757732013-02-23 17:00:10 -0800581#else
Rich Lanee57f0432014-02-19 10:31:53 -0800582#define LOCI_ASSERT(val)
Rich Lane53757732013-02-23 17:00:10 -0800583#endif
Rich Lanea06d0c32013-03-25 08:52:03 -0700584
585/*
586 * Some LOCI object accessors can fail, and it's easy to forget to check.
587 * On certain compilers we can trigger a warning if the error code
588 * is ignored.
589 */
590#ifndef DISABLE_WARN_UNUSED_RESULT
591#ifdef __GNUC__
592#define WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
593#else
594#define WARN_UNUSED_RESULT
595#endif
596#else
597#define WARN_UNUSED_RESULT
598#endif
599
600typedef union of_generic_u of_generic_t;
601typedef struct of_object_s of_object_t;
602
603/* Define ipv4 address as uint32 */
604typedef uint32_t of_ipv4_t;
605
606/* Table ID is the OF standard uint8 */
607typedef uint8_t of_table_id_t;
608
609#define OF_MAC_ADDR_BYTES 6
610typedef struct of_mac_addr_s {
611 uint8_t addr[OF_MAC_ADDR_BYTES];
612} of_mac_addr_t;
613
614#define OF_IPV6_BYTES 16
615typedef struct of_ipv6_s {
616 uint8_t addr[OF_IPV6_BYTES];
617} of_ipv6_t;
618
Rich Lane119289c2014-12-01 13:44:08 -0800619typedef struct of_bitmap_512_s {
620 uint64_t words[8];
621} of_bitmap_512_t;
622
Rich Lanea06d0c32013-03-25 08:52:03 -0700623extern const of_mac_addr_t of_mac_addr_all_ones;
Rich Lane80bb2b42015-01-09 13:58:54 -0800624extern const of_mac_addr_t of_mac_addr_all_zeros;
Rich Lanea06d0c32013-03-25 08:52:03 -0700625
626extern const of_ipv6_t of_ipv6_all_ones;
627extern const of_ipv6_t of_ipv6_all_zeros;
628
Rich Lane119289c2014-12-01 13:44:08 -0800629extern const of_bitmap_512_t of_bitmap_512_all_ones;
630extern const of_bitmap_512_t of_bitmap_512_all_zeroes;
631
Rich Lanea06d0c32013-03-25 08:52:03 -0700632/**
633 * Generic zero and all-ones values of size 16 bytes.
634 *
Rich Lane119289c2014-12-01 13:44:08 -0800635 * bitmap_512 is longest data type we worry about for comparisons
Rich Lanea06d0c32013-03-25 08:52:03 -0700636 */
Rich Lane119289c2014-12-01 13:44:08 -0800637#define of_all_zero_value of_bitmap_512_all_zeroes
638#define of_all_ones_value of_bitmap_512_all_ones
Rich Lanea06d0c32013-03-25 08:52:03 -0700639
640/**
641 * Non-zero/all ones check for arbitrary type of size <= 16 bytes
642 */
643#define OF_VARIABLE_IS_NON_ZERO(_ptr) \\
644 (MEMCMP(&of_all_zero_value, (_ptr), sizeof(*(_ptr))))
645#define OF_VARIABLE_IS_ALL_ONES(_ptr) \\
646 (!MEMCMP(&of_all_ones_value, (_ptr), sizeof(*(_ptr))))
647
648/* The octets object is a struct holding pointer and length */
649typedef struct of_octets_s {
650 uint8_t *data;
651 int bytes;
652} of_octets_t;
653
654/* Macro to convert an octet object to a pointer; currently trivial */
655#define OF_OCTETS_POINTER_GET(octet_ptr) ((octet_ptr)->data)
656#define OF_OCTETS_POINTER_SET(octet_ptr, ptr) (octet_ptr)->data = (ptr)
657#define OF_OCTETS_BYTES_GET(octet_ptr) ((octet_ptr)->bytes)
658#define OF_OCTETS_BYTES_SET(octet_ptr, bytes) (octet_ptr)->bytes = (bytes)
659
660/* Currently these are categorized as scalars */
661typedef char of_port_name_t[OF_MAX_PORT_NAME_LEN];
662typedef char of_table_name_t[OF_MAX_TABLE_NAME_LEN];
663typedef char of_desc_str_t[OF_DESC_STR_LEN];
664typedef char of_serial_num_t[OF_SERIAL_NUM_LEN];
Rich Lanef8a3d002014-03-19 13:33:52 -0700665typedef char of_str64_t[64];
Rich Lanea06d0c32013-03-25 08:52:03 -0700666
Rich Lane3b2fd832013-09-24 13:44:08 -0700667typedef struct of_bitmap_128_s {
668 uint64_t hi;
669 uint64_t lo;
670} of_bitmap_128_t;
671
Rich Lanefab0c822013-12-30 11:46:48 -0800672typedef struct of_checksum_128_s {
673 uint64_t hi;
674 uint64_t lo;
675} of_checksum_128_t;
676
Rich Lanea06d0c32013-03-25 08:52:03 -0700677/* These are types which change across versions. */
678typedef uint32_t of_port_no_t;
679typedef uint16_t of_fm_cmd_t;
680typedef uint64_t of_wc_bmap_t;
681typedef uint64_t of_match_bmap_t;
682
683#define MEMMOVE(dest, src, bytes) memmove(dest, src, bytes)
684#define MEMSET(dest, val, bytes) memset(dest, val, bytes)
685#define MEMCPY(dest, src, bytes) memcpy(dest, src, bytes)
686#define MEMCMP(a, b, bytes) memcmp(a, b, bytes)
687#define MALLOC(bytes) malloc(bytes)
688#define FREE(ptr) free(ptr)
689
690/** Try an operation and return on failure. */
691#define OF_TRY(op) do { \\
692 int _rv; \\
693 if ((_rv = (op)) < 0) { \\
694 LOCI_LOG_ERROR("ERROR %d at %s:%d\\n", _rv, __FILE__, __LINE__); \\
695 return _rv; \\
696 } \\
697 } while (0)
698
699/* The extent of an OF match object is determined by its length field, but
700 * aligned to 8 bytes
701 */
702
703#define OF_MATCH_BYTES(length) (((length) + 7) & 0xfff8)
704
Rich Lanedfcafae2014-03-06 16:56:49 -0800705#if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
Rich Lanea06d0c32013-03-25 08:52:03 -0700706#define U16_NTOH(val) (val)
707#define U32_NTOH(val) (val)
708#define U64_NTOH(val) (val)
709#define IPV6_NTOH(dst, src) /* NOTE different syntax; currently no-op */
710#define U16_HTON(val) (val)
711#define U32_HTON(val) (val)
712#define U64_HTON(val) (val)
713#define IPV6_HTON(dst, src) /* NOTE different syntax; currently no-op */
714#else /* Little Endian */
Rich Lane69e247e2014-03-05 10:27:22 -0800715#define U16_NTOH(val) (((val) >> 8) | (((val) & 0xff) << 8))
Rich Lanea06d0c32013-03-25 08:52:03 -0700716#define U32_NTOH(val) ((((val) & 0xff000000) >> 24) | \\
717 (((val) & 0x00ff0000) >> 8) | \\
718 (((val) & 0x0000ff00) << 8) | \\
719 (((val) & 0x000000ff) << 24))
720#define U64_NTOH(val) ((((val) & 0xff00000000000000LL) >> 56) | \\
721 (((val) & 0x00ff000000000000LL) >> 40) | \\
722 (((val) & 0x0000ff0000000000LL) >> 24) | \\
723 (((val) & 0x000000ff00000000LL) >> 8) | \\
724 (((val) & 0x00000000ff000000LL) << 8) | \\
725 (((val) & 0x0000000000ff0000LL) << 24) | \\
726 (((val) & 0x000000000000ff00LL) << 40) | \\
727 (((val) & 0x00000000000000ffLL) << 56))
728#define IPV6_NTOH(dst, src) /* NOTE different syntax; currently no-op */
729#define U16_HTON(val) U16_NTOH(val)
730#define U32_HTON(val) U32_NTOH(val)
731#define U64_HTON(val) U64_NTOH(val)
732#define IPV6_HTON(dst, src) /* NOTE different syntax; currently no-op */
733#endif
Rich Lanea06d0c32013-03-25 08:52:03 -0700734""")
735
736def external_h_top_matter(out, name):
737 """
738 Generate top matter for external header file
739
740 @param name The name of the output file
741 @param out The output file object
742 """
743 common_top_matter(out, name)
744 out.write("""
745#include <loci/loci_base.h>
746#include <loci/of_message.h>
747#include <loci/of_match.h>
748#include <loci/of_object.h>
Rich Lanedef2e512013-12-15 15:54:02 -0800749#include <loci/loci_classes.h>
Rich Lanedc46fe22014-04-03 15:10:38 -0700750#include <loci/loci_class_metadata.h>
Rich Lanea06d0c32013-03-25 08:52:03 -0700751
752/****************************************************************
753 *
754 * This file is divided into the following sections.
755 *
756 * A few object specific macros
757 * Class typedefs (no struct definitions)
758 * Per-data type accessor function typedefs
759 * Per-class new/delete function typedefs
760 * Per-class static delete functions
761 * Per-class, per-member accessor declarations
762 * Per-class structure definitions
Rich Lanea06d0c32013-03-25 08:52:03 -0700763 * Pointer set function declarations
764 * Some special case macros
765 *
766 ****************************************************************/
767""")
768
Rich Lanea06d0c32013-03-25 08:52:03 -0700769################################################################
770#
771################################################################
772
773def gen_version_enum(out):
774 """
775 Generate the enumerated type for versions in LoxiGen
776 @param out The file object to which to write the decs
777
778 This just uses the wire versions for now
779 """
780 out.write("""
781/**
782 * Enumeration of OpenFlow versions
783 *
784 * The wire protocol numbers are currently used for values of the corresponding
785 * version identifiers.
786 */
787typedef enum of_version_e {
788 OF_VERSION_UNKNOWN = 0,
789""")
790
791 is_first = True
792 max = 0
793 for v in of_g.wire_ver_map:
794 if is_first:
795 is_first = False
796 else:
797 out.write(",\n")
798 if v > max:
799 max = v
800 out.write(" %s = %d" % (of_g.wire_ver_map[v], v))
801
802 out.write("""
803} of_version_t;
804
805/**
806 * @brief Use this when declaring arrays indexed by wire version
807 */
808#define OF_VERSION_ARRAY_MAX %d
809""" % (max + 1))
Andreas Wundsam53256162013-05-02 14:05:53 -0700810
Rich Lanea06d0c32013-03-25 08:52:03 -0700811def gen_object_enum(out):
812 """
813 Generate the enumerated type for object identification in LoxiGen
814 @param out The file object to which to write the decs
815 """
816 out.write("""
817
818/**
819 * Enumeration of OpenFlow objects
820 *
821 * We enumerate the OpenFlow objects used internally. Note that some
822 * message types are determined both by an outer type (message type like
823 * stats_request) and an inner type (port stats). These are different
824 * messages in ofC.
825 *
826 * These values are for internal use only. They will change with
827 * different versions of ofC.
828 */
829
830typedef enum of_object_id_e {
831 /* Root object type */
832 OF_OBJECT_INVALID = -1, /* "invalid" return value for mappings */
833 OF_OBJECT = 0, /* Generic, untyped object */
834
835 /* OpenFlow message objects */
836""")
837 last = 0
838 msg_count = 0
839 for cls in of_g.ordered_messages:
840 out.write(" %s = %d,\n" % (enum_name(cls),
841 of_g.unified[cls]["object_id"]))
842 msg_count = of_g.unified[cls]["object_id"] + 1
843
844 out.write("\n /* Non-message objects */\n")
845 for cls in of_g.ordered_non_messages:
846 out.write(" %s = %d,\n" % (enum_name(cls),
847 of_g.unified[cls]["object_id"]))
848 last = of_g.unified[cls]["object_id"]
849 out.write("\n /* List objects */\n")
850 for cls in of_g.ordered_list_objects:
851 out.write(" %s = %d,\n" % (enum_name(cls),
852 of_g.unified[cls]["object_id"]))
853 last = of_g.unified[cls]["object_id"]
854
Rich Lanea06d0c32013-03-25 08:52:03 -0700855 out.write("""
856 OF_OBJECT_COUNT = %d
857} of_object_id_t;
858
Rich Laneb157b0f2013-03-27 13:55:28 -0700859extern const char *const of_object_id_str[];
Rich Lanea06d0c32013-03-25 08:52:03 -0700860
861#define OF_MESSAGE_OBJECT_COUNT %d
862""" % ((last + 1), msg_count))
863
Rich Lanea06d0c32013-03-25 08:52:03 -0700864################################################################
865#
866# Internal Utility Functions
867#
868################################################################
869
870
871def acc_name(cls, m_name):
872 """
873 Generate the root name of an accessor function for typedef
874 @param cls The class name
875 @param m_name The member name
876 """
877 (m_type, get_rv) = get_acc_rv(cls, m_name)
878 return "%s_%s" % (cls, m_type)
879
880def get_acc_rv(cls, m_name):
881 """
882 Determine the data type and return type for a get accessor.
883
884 The return type may be "void" or it may be the accessor type
885 depending on the system configuration and on the data type.
886
887 @param cls The class name
888 @param m_name The member name
889 @return A pair (m_type, rv) where m_type is the unified type of the
890 member and rv is the get_accessor return type
891 """
892 member = of_g.unified[cls]["union"][m_name]
893 m_type = member["m_type"]
894 rv = "int"
Rich Lanea06d0c32013-03-25 08:52:03 -0700895 if m_type[-2:] == "_t":
896 m_type = m_type[:-2]
897
898 return (m_type, rv)
899
900def param_list(cls, m_name, a_type):
901 """
902 Generate the parameter list (no parens) for an a_type accessor
903 @param cls The class name
904 @param m_name The member name
905 @param a_type One of "set" or "get" or TBD
906 """
907 member = of_g.unified[cls]["union"][m_name]
908 m_type = member["m_type"]
909 params = ["%s_t *obj" % cls]
910 if a_type == "set":
911 if loxi_utils.type_is_scalar(m_type):
912 params.append("%s %s" % (m_type, m_name))
913 else:
914 params.append("%s *%s" % (m_type, m_name))
915 elif a_type in ["get", "bind"]:
916 params.append("%s *%s" % (m_type, m_name))
917 else:
918 debug("Class %s, name %s Bad param list a_type: %s" %
919 (cls, m_name, a_type))
920 sys.exit(1)
921 return params
922
Rich Lanea06d0c32013-03-25 08:52:03 -0700923def field_ver_get(cls, m_name):
924 """
925 Generate a dict, indexed by wire version, giving a pair (type, offset)
926
927 @param cls The class name
928 @param m_name The name of the class member
929
930 If offset is not known for m_name, the type
931 A dict is used for more convenient indexing.
932 """
933 result = {}
934
935 for ver in of_g.unified[cls]:
936 if type(ver) == type(0): # It's a version
937 if "use_version" in of_g.unified[cls][ver]: # deref version ref
938 ref_ver = of_g.unified[cls][ver]["use_version"]
939 members = of_g.unified[cls][ref_ver]["members"]
940 else:
941 members = of_g.unified[cls][ver]["members"]
942 idx = loxi_utils.member_to_index(m_name, members)
943 if (idx < 0):
944 continue # Member not in this version
945 m_type = members[idx]["m_type"]
946 offset = members[idx]["offset"]
947
948 # If m_type is mixed, get wire version type from global data
949 if m_type in of_g.of_mixed_types and \
950 ver in of_g.of_mixed_types[m_type]:
951 m_type = of_g.of_mixed_types[m_type][ver]
952
953 # add version to result list
954 result[ver] = (m_type, offset)
955
956 return result
957
958def v3_match_offset_get(cls):
959 """
Andreas Wundsam53256162013-05-02 14:05:53 -0700960 Return the offset of an OF 1.2 match in an object if it has such;
Rich Lanea06d0c32013-03-25 08:52:03 -0700961 otherwise return -1
962 """
963 result = field_ver_get(cls, "match")
964 if of_g.VERSION_1_2 in result:
965 if result[of_g.VERSION_1_2][0] == "of_match_v3_t":
966 return result[of_g.VERSION_1_2][1]
967 return -1
968
969################################################################
970#
971# OpenFlow Object Definitions
972#
973################################################################
974
Rich Lanea06d0c32013-03-25 08:52:03 -0700975def gen_struct_typedefs(out):
976 """
977 Generate typedefs for all struct objects
978 @param out The file for output, already open
979 """
980
Rich Lanea06d0c32013-03-25 08:52:03 -0700981 out.write("\n/* LOCI object typedefs */\n")
982 for cls in of_g.standard_class_order:
Rich Lane85767872013-12-15 16:24:42 -0800983 template = "typedef of_object_t %(cls)s_t;\n"
984 out.write(template % dict(cls=cls))
Rich Lanea06d0c32013-03-25 08:52:03 -0700985
986 out.write("""
987/****************************************************************
988 *
989 * Additional of_object defines
990 * These are needed for some static inline ops, so we put them here.
991 *
992 ****************************************************************/
993
994/* Delete an OpenFlow object without reference to its type */
995extern void of_object_delete(of_object_t *obj);
996
997""")
998
Rich Lanea06d0c32013-03-25 08:52:03 -0700999################################################################
1000#
Rich Lanea06d0c32013-03-25 08:52:03 -07001001# Accessor Functions
1002#
1003################################################################
1004
Andreas Wundsam53256162013-05-02 14:05:53 -07001005
Rich Lanea06d0c32013-03-25 08:52:03 -07001006def gen_accessor_declarations(out):
1007 """
1008 Generate the declaration of each version independent accessor
1009
1010 @param out The file to which to write the decs
1011 """
1012
1013 out.write("""
1014/****************************************************************
1015 *
1016 * Unified, per-member accessor function declarations
1017 *
1018 ****************************************************************/
1019""")
1020 for cls in of_g.standard_class_order:
Rich Lane6171e632014-11-07 10:23:38 -08001021 if type_maps.class_is_virtual(cls) and not loxi_utils.class_is_list(cls):
Rich Lanea06d0c32013-03-25 08:52:03 -07001022 continue
1023 out.write("\n/* Unified accessor functions for %s */\n" % cls)
1024 for m_name in of_g.ordered_members[cls]:
1025 if m_name in of_g.skip_members:
1026 continue
1027 m_type = loxi_utils.member_base_type(cls, m_name)
1028 base_name = "%s_%s" % (cls, m_name)
1029 gparams = ",\n ".join(param_list(cls, m_name, "get"))
1030 get_ret_type = accessor_return_type("get", m_type)
1031 sparams = ",\n ".join(param_list(cls, m_name, "set"))
1032 set_ret_type = accessor_return_type("set", m_type)
1033 bparams = ",\n ".join(param_list(cls, m_name, "bind"))
1034 bind_ret_type = accessor_return_type("bind", m_type)
1035
1036 if loxi_utils.type_is_of_object(m_type):
1037 # Generate bind accessors, but not get accessor
1038 out.write("""
1039extern %(set_ret_type)s %(base_name)s_set(
1040 %(sparams)s);
1041extern %(bind_ret_type)s %(base_name)s_bind(
1042 %(bparams)s);
1043extern %(m_type)s *%(cls)s_%(m_name)s_get(
1044 %(cls)s_t *obj);
1045""" % dict(base_name=base_name, sparams=sparams, bparams=bparams,
1046 m_name=m_name, m_type=m_type, cls=cls,
1047 set_ret_type=set_ret_type, bind_ret_type=bind_ret_type))
1048 else:
1049 out.write("""
1050extern %(set_ret_type)s %(base_name)s_set(
1051 %(sparams)s);
1052extern %(get_ret_type)s %(base_name)s_get(
1053 %(gparams)s);
1054""" % dict(base_name=base_name, gparams=gparams, sparams=sparams,
1055 get_ret_type=get_ret_type, set_ret_type=set_ret_type))
Andreas Wundsam53256162013-05-02 14:05:53 -07001056
Rich Lanea06d0c32013-03-25 08:52:03 -07001057 if loxi_utils.class_is_list(cls):
1058 e_type = loxi_utils.list_to_entry_type(cls)
1059 out.write("""
1060extern int %(cls)s_first(
Rich Lane30943262014-11-07 09:04:13 -08001061 %(cls)s_t *list, of_object_t *iter);
Rich Lanea06d0c32013-03-25 08:52:03 -07001062extern int %(cls)s_next(
Rich Lane30943262014-11-07 09:04:13 -08001063 %(cls)s_t *list, of_object_t *iter);
Rich Lanea06d0c32013-03-25 08:52:03 -07001064extern int %(cls)s_append_bind(
Rich Lane30943262014-11-07 09:04:13 -08001065 %(cls)s_t *list, of_object_t *iter);
Rich Lanea06d0c32013-03-25 08:52:03 -07001066extern int %(cls)s_append(
Rich Lane30943262014-11-07 09:04:13 -08001067 %(cls)s_t *list, of_object_t *iter);
Rich Lanea06d0c32013-03-25 08:52:03 -07001068
1069/**
1070 * Iteration macro for list of type %(cls)s
1071 * @param list Pointer to the list being iterated over of
1072 * type %(cls)s
1073 * @param elt Pointer to an element of type %(e_type)s
1074 * @param rv On exiting the loop will have the value OF_ERROR_RANGE.
1075 */
1076#define %(u_cls)s_ITER(list, elt, rv) \\
1077 for ((rv) = %(cls)s_first((list), (elt)); \\
1078 (rv) == OF_ERROR_NONE; \\
1079 (rv) = %(cls)s_next((list), (elt)))
1080""" % dict(u_cls=cls.upper(), cls=cls, e_type=e_type))
1081
1082
1083def wire_accessor(m_type, a_type):
1084 """
1085 Returns the name of the a_type accessor for low level wire buff offset
1086 @param m_type The member type
1087 @param a_type The accessor type (set or get)
1088 """
1089 # Strip off _t if present
1090 if m_type in of_g.of_base_types:
1091 m_type = of_g.of_base_types[m_type]["short_name"]
1092 if m_type in of_g.of_mixed_types:
1093 m_type = of_g.of_mixed_types[m_type]["short_name"]
1094 if m_type[-2:] == "_t":
1095 m_type = m_type[:-2]
1096 if m_type == "octets":
1097 m_type = "octets_data"
1098 return "of_wire_buffer_%s_%s" % (m_type, a_type)
1099
Rich Lane713d9282013-12-30 15:21:35 -08001100def get_len_macro(cls, m_name, m_type, version):
Rich Lanea06d0c32013-03-25 08:52:03 -07001101 """
1102 Get the length macro for m_type in cls
1103 """
1104 if m_type.find("of_match") == 0:
1105 return "_WIRE_MATCH_PADDED_LEN(obj, offset)"
1106 if m_type.find("of_list_oxm") == 0:
1107 return "wire_match_len(obj, 0) - 4"
1108 if loxi_utils.class_is_tlv16(m_type):
1109 return "_TLV16_LEN(obj, offset)"
1110 if cls == "of_packet_out" and m_type == "of_list_action_t":
1111 return "_PACKET_OUT_ACTION_LEN(obj)"
Rich Lane713d9282013-12-30 15:21:35 -08001112 if cls == "of_bsn_gentable_entry_add" and m_name == "key":
1113 return "of_object_u16_get(obj, 18)"
1114 if cls == "of_bsn_gentable_entry_desc_stats_entry" and m_name == "key":
1115 return "of_object_u16_get(obj, 2)"
1116 if cls == "of_bsn_gentable_entry_stats_entry" and m_name == "key":
1117 return "of_object_u16_get(obj, 2)"
Rich Lanea06d0c32013-03-25 08:52:03 -07001118 # Default is everything to the end of the object
1119 return "_END_LEN(obj, offset)"
1120
1121def gen_accessor_offsets(out, cls, m_name, version, a_type, m_type, offset):
1122 """
1123 Generate the sub-object offset and length calculations for accessors
1124 @param out File being written
1125 @param m_name Name of member
1126 @param version Wire version being processed
1127 @param a_type The accessor type (set or get)
1128 @param m_type The original member type
1129 @param offset The offset of the object or -1 if not fixed
1130 """
1131 # determine offset
1132 o_str = "%d" % offset # Default is fixed length
1133 if offset == -1:
1134 # There are currently 4 special cases for this
1135 # In general, get offset and length of predecessor
1136 if (loxi_utils.cls_is_flow_mod(cls) and m_name == "instructions"):
1137 pass
1138 elif (cls == "of_flow_stats_entry" and m_name == "instructions"):
1139 pass
1140 elif (cls == "of_packet_in" and m_name == "data"):
1141 pass
1142 elif (cls == "of_packet_out" and m_name == "data"):
1143 pass
Rich Lane713d9282013-12-30 15:21:35 -08001144 elif (cls == "of_bsn_gentable_entry_add" and m_name == "value"):
1145 pass
1146 elif (cls == "of_bsn_gentable_entry_desc_stats_entry" and m_name == "value"):
1147 pass
1148 elif (cls == "of_bsn_gentable_entry_stats_entry" and m_name == "stats"):
1149 pass
Rich Lanea06d0c32013-03-25 08:52:03 -07001150 else:
1151 debug("Error: Unknown member with offset == -1")
1152 debug(" cls %s, m_name %s, version %d" % (cls, m_name, version))
1153 sys.exit(1)
1154 o_str = "_%s_%s_OFFSET(obj)" % (cls.upper()[3:], m_name.upper())
1155
1156 out.write("""\
1157 offset = %s;
1158""" % o_str);
1159
1160 # This could be moved to main body but for version check
1161 if not loxi_utils.type_is_scalar(m_type):
1162 if loxi_utils.class_is_var_len(m_type[:-2], version) or \
1163 m_type == "of_match_t":
Rich Lane713d9282013-12-30 15:21:35 -08001164 len_macro = get_len_macro(cls, m_name, m_type, version)
Rich Lanea06d0c32013-03-25 08:52:03 -07001165 else:
1166 len_macro = "%d" % of_g.base_length[(m_type[:-2], version)]
1167 out.write(" cur_len = %s;\n" % len_macro)
1168 out.write(" break;\n")
1169
1170def length_of(m_type, version):
1171 """
1172 Return the length of a type based on the version
1173 """
1174 if m_type in of_g.of_mixed_types:
1175 m_type = of_g.of_mixed_types[m_type][version]
1176 if m_type in of_g.of_base_types:
1177 return of_g.of_base_types[m_type]["bytes"]
1178 if (m_type[:-2], version) in of_g.base_length:
1179 return of_g.base_length[(m_type[:-2], version)]
1180 print "Unknown length request", m_type, version
1181 sys.exit(1)
Andreas Wundsam53256162013-05-02 14:05:53 -07001182
Rich Lanea06d0c32013-03-25 08:52:03 -07001183
1184def gen_get_accessor_body(out, cls, m_type, m_name):
1185 """
1186 Generate the common operations for a get accessor
1187 """
1188 if loxi_utils.type_is_scalar(m_type):
1189 ver = "" # See if version required for scalar update
1190 if m_type in of_g.of_mixed_types:
1191 ver = "ver, "
1192 out.write("""\
1193 %(wa)s(%(ver)swbuf, abs_offset, %(m_name)s);
1194""" % dict(wa=wire_accessor(m_type, "get"), ver=ver, m_name=m_name))
1195
1196 if m_type == "of_port_no_t":
1197 out.write(" OF_PORT_NO_VALUE_CHECK(*%s, ver);\n" % m_name)
1198 elif m_type == "of_octets_t":
1199 out.write("""\
Rich Lanee57f0432014-02-19 10:31:53 -08001200 LOCI_ASSERT(cur_len + abs_offset <= WBUF_CURRENT_BYTES(wbuf));
Rich Lanea06d0c32013-03-25 08:52:03 -07001201 %(m_name)s->bytes = cur_len;
1202 %(m_name)s->data = OF_WIRE_BUFFER_INDEX(wbuf, abs_offset);
1203""" % dict(m_name=m_name))
1204 elif m_type == "of_match_t":
1205 out.write("""
Rich Lanee57f0432014-02-19 10:31:53 -08001206 LOCI_ASSERT(cur_len + abs_offset <= WBUF_CURRENT_BYTES(wbuf));
Rich Lanee0b70cc2014-06-12 15:02:22 -07001207 OF_TRY(of_match_deserialize(ver, %(m_name)s, obj, offset, cur_len));
Rich Lanea06d0c32013-03-25 08:52:03 -07001208""" % dict(m_name=m_name))
Rich Lanec247ade2014-11-07 09:33:24 -08001209 elif m_type == "of_oxm_t":
Rich Lane90020b42014-04-07 12:05:45 -07001210 out.write("""
1211 /* Initialize child */
1212 %(m_type)s_init(%(m_name)s, obj->version, 0, 1);
1213 /* Attach to parent */
Rich Laned1fe6972014-06-12 14:53:24 -07001214 of_object_attach(obj, %(m_name)s, offset, cur_len);
Rich Lane90020b42014-04-07 12:05:45 -07001215 of_object_wire_init(%(m_name)s, OF_OXM, 0);
1216""" % dict(m_type=m_type[:-2], m_name=m_name))
Rich Lanec247ade2014-11-07 09:33:24 -08001217 elif m_type == "of_bsn_vport_t":
Wilson Ngd6181882014-04-14 16:28:35 -07001218 out.write("""
1219 /* Initialize child */
1220 %(m_type)s_init(%(m_name)s, obj->version, 0, 1);
1221 /* Attach to parent */
Rich Laned1fe6972014-06-12 14:53:24 -07001222 of_object_attach(obj, %(m_name)s, offset, cur_len);
Wilson Ngd6181882014-04-14 16:28:35 -07001223 of_object_wire_init(%(m_name)s, OF_BSN_VPORT, 0);
1224""" % dict(m_type=m_type[:-2], m_name=m_name))
Rich Lanea06d0c32013-03-25 08:52:03 -07001225 else:
1226 out.write("""
1227 /* Initialize child */
1228 %(m_type)s_init(%(m_name)s, obj->version, 0, 1);
1229 /* Attach to parent */
Rich Laned1fe6972014-06-12 14:53:24 -07001230 of_object_attach(obj, %(m_name)s, offset, cur_len);
Rich Lanea06d0c32013-03-25 08:52:03 -07001231""" % dict(m_type=m_type[:-2], m_name=m_name))
1232
1233
1234def gen_set_accessor_body(out, cls, m_type, m_name):
1235 """
1236 Generate the contents of a set accessor
1237 """
1238 if loxi_utils.type_is_scalar(m_type) or m_type == "of_octets_t":
1239 ver = "" # See if version required for scalar update
1240 if m_type in of_g.of_mixed_types:
1241 ver = "ver, "
1242 cur_len = "" # See if version required for scalar update
1243 if m_type == "of_octets_t":
1244 cur_len = ", cur_len"
1245 out.write("""\
1246 new_len = %(m_name)s->bytes;
1247 of_wire_buffer_grow(wbuf, abs_offset + (new_len - cur_len));
1248""" % dict(m_name=m_name))
1249 out.write("""\
1250 %(wa)s(%(ver)swbuf, abs_offset, %(m_name)s%(cur_len)s);
1251""" % dict(wa=wire_accessor(m_type, "set"), ver=ver, cur_len=cur_len,
1252 m_name=m_name))
1253
1254 elif m_type == "of_match_t":
1255 out.write("""
Rich Lanee0b70cc2014-06-12 15:02:22 -07001256 {
1257 /* Match object */
1258 of_octets_t match_octets;
1259 OF_TRY(of_match_serialize(ver, %(m_name)s, &match_octets));
1260 new_len = match_octets.bytes;
1261 of_wire_buffer_replace_data(wbuf, abs_offset, cur_len,
1262 match_octets.data, new_len);
1263 /* Free match serialized octets */
1264 FREE(match_octets.data);
1265 }
Rich Lanea06d0c32013-03-25 08:52:03 -07001266""" % dict(m_name=m_name))
1267
1268 else: # Other object type
1269 out.write("\n /* LOCI object type */")
1270 # Need to special case OXM list
1271 out.write("""
1272 new_len = %(m_name)s->length;
1273 /* If underlying buffer already shared; nothing to do */
Rich Lanecdd542d2014-04-03 16:13:12 -07001274 if (obj->wbuf == %(m_name)s->wbuf) {
Rich Lanea06d0c32013-03-25 08:52:03 -07001275 of_wire_buffer_grow(wbuf, abs_offset + new_len);
1276 /* Verify that the offsets are correct */
Rich Lanee57f0432014-02-19 10:31:53 -08001277 LOCI_ASSERT(abs_offset == OF_OBJECT_ABSOLUTE_OFFSET(%(m_name)s, 0));
1278 /* LOCI_ASSERT(new_len == cur_len); */ /* fixme: may fail for OXM lists */
Rich Lanea06d0c32013-03-25 08:52:03 -07001279 return %(ret_success)s;
1280 }
1281
1282 /* Otherwise, replace existing object in data buffer */
1283 of_wire_buffer_replace_data(wbuf, abs_offset, cur_len,
1284 OF_OBJECT_BUFFER_INDEX(%(m_name)s, 0), new_len);
1285""" % dict(m_name=m_name, ret_success=accessor_return_success("set", m_type)))
1286
1287 if not loxi_utils.type_is_scalar(m_type):
1288 if cls == "of_packet_out" and m_type == "of_list_action_t":
1289 out.write("""
1290 /* Special case for setting action lengths */
1291 _PACKET_OUT_ACTION_LEN_SET(obj, %(m_name)s->length);
1292""" % dict(m_name=m_name))
Rich Lane713d9282013-12-30 15:21:35 -08001293 elif cls == "of_bsn_gentable_entry_add" and m_name == "key":
1294 out.write("""
1295 /* Special case for setting key length */
1296 of_object_u16_set(obj, 18, %(m_name)s->length);
1297""" % dict(m_name=m_name))
1298 elif cls in ["of_bsn_gentable_entry_desc_stats_entry", "of_bsn_gentable_entry_stats_entry"] and m_name == "key":
1299 out.write("""
1300 /* Special case for setting key length */
1301 of_object_u16_set(obj, 2, %(m_name)s->length);
1302""" % dict(m_name=m_name))
Rich Lanea06d0c32013-03-25 08:52:03 -07001303 elif m_type not in ["of_match_t", "of_octets_t"]:
1304 out.write("""
1305 /* @fixme Shouldn't this precede copying value's data to buffer? */
Rich Lanedc46fe22014-04-03 15:10:38 -07001306 of_object_wire_length_set((of_object_t *)%(m_name)s, %(m_name)s->length);
Rich Lanea06d0c32013-03-25 08:52:03 -07001307""" % dict(m_name=m_name))
1308 out.write("""
1309 /* Not scalar, update lengths if needed */
1310 delta = new_len - cur_len;
1311 if (delta != 0) {
1312 /* Update parent(s) */
1313 of_object_parent_length_update((of_object_t *)obj, delta);
1314 }
1315""")
1316
1317def obj_assert_check(cls):
1318 """
1319 The body of the assert check for an accessor
1320 We allow all versions of add/delete/modify to use the same accessors
1321 """
1322 if cls in ["of_flow_modify", "of_flow_modify_strict",
1323 "of_flow_delete", "of_flow_delete_strict",
1324 "of_flow_add"]:
1325 return "IS_FLOW_MOD_SUBTYPE(obj->object_id)"
1326 else:
1327 return "obj->object_id == %s" % cls.upper()
1328
1329def gen_of_object_get(out, cls, m_name, m_type):
1330 sub_cls = m_type[:-2]
1331 out.write("""
1332/**
Andreas Wundsam53256162013-05-02 14:05:53 -07001333 * Create a copy of %(m_name)s into a new variable of type %(m_type)s from
Rich Lanea06d0c32013-03-25 08:52:03 -07001334 * a %(cls)s instance.
1335 *
1336 * @param obj Pointer to the source of type %(cls)s_t
1337 * @returns A pointer to a new instance of type %(m_type)s whose contents
1338 * match that of %(m_name)s from source
1339 * @returns NULL if an error occurs
1340 */
1341%(m_type)s *
1342%(cls)s_%(m_name)s_get(%(cls)s_t *obj) {
1343 %(m_type)s _%(m_name)s;
1344 %(m_type)s *_%(m_name)s_ptr;
1345
1346 %(cls)s_%(m_name)s_bind(obj, &_%(m_name)s);
1347 _%(m_name)s_ptr = (%(m_type)s *)of_object_dup(&_%(m_name)s);
1348 return _%(m_name)s_ptr;
1349}
1350""" % dict(m_name=m_name, m_type=m_type, cls=cls, sub_cls=sub_cls))
1351
1352def gen_unified_acc_body(out, cls, m_name, ver_type_map, a_type, m_type):
1353 """
1354 Generate the body of a set or get accessor function
1355
1356 @param out The file to which to write the decs
1357 @param cls The class name
1358 @param m_name The member name
1359 @param ver_type_map Maps (type, offset) pairs to a list of versions
1360 @param a_type The accessor type, set or get
1361 @param m_type The original member type
1362
1363 The type values in ver_type_map are now ignored as we've pushed down
1364 the type munging to the lower level.
1365
1366 This is unified because the version switch case processing is the
1367 same for both set and get
1368 """
1369 out.write("""{
1370 of_wire_buffer_t *wbuf;
1371 int offset = 0; /* Offset of value relative to the start obj */
1372 int abs_offset; /* Offset of value relative to start of wbuf */
1373 of_version_t ver;
1374""")
1375
1376 if not loxi_utils.type_is_scalar(m_type):
1377 out.write("""\
1378 int cur_len = 0; /* Current length of object data */
1379""")
1380 if a_type == "set":
1381 out.write("""\
1382 int new_len, delta; /* For set, need new length and delta */
1383""")
1384
Rich Lanea06d0c32013-03-25 08:52:03 -07001385 out.write("""
Rich Lanee57f0432014-02-19 10:31:53 -08001386 LOCI_ASSERT(%(assert_str)s);
Rich Lanea06d0c32013-03-25 08:52:03 -07001387 ver = obj->version;
1388 wbuf = OF_OBJECT_TO_WBUF(obj);
Rich Lanee57f0432014-02-19 10:31:53 -08001389 LOCI_ASSERT(wbuf != NULL);
Rich Lanea06d0c32013-03-25 08:52:03 -07001390
1391 /* By version, determine offset and current length (where needed) */
1392 switch (ver) {
1393""" % dict(assert_str=obj_assert_check(cls)))
1394
1395 for first in sorted(ver_type_map):
1396 (prev_t, prev_o) = ver_type_map[first]
1397 prev_len = length_of(prev_t, first)
1398 prev = first
1399 out.write(" case %s:\n" % of_g.wire_ver_map[first])
1400 break
1401
1402 for next in sorted(ver_type_map):
1403 if next == first:
1404 continue
1405
1406 (t, o) = ver_type_map[next]
1407 cur_len = length_of(t, next)
1408 if o == prev_o and cur_len == prev_len:
1409 out.write(" case %s:\n" % of_g.wire_ver_map[next])
1410 continue
1411 gen_accessor_offsets(out, cls, m_name, prev, a_type, m_type, prev_o)
1412 out.write(" case %s:\n" % of_g.wire_ver_map[next])
1413 (prev_t, prev_o, prev_len, prev) = (t, o, cur_len, next)
1414
1415 gen_accessor_offsets(out, cls, m_name, next, a_type, m_type, prev_o)
1416 out.write("""\
1417 default:
Rich Lanee57f0432014-02-19 10:31:53 -08001418 LOCI_ASSERT(0);
Rich Lanea06d0c32013-03-25 08:52:03 -07001419 }
1420
1421 abs_offset = OF_OBJECT_ABSOLUTE_OFFSET(obj, offset);
Rich Lanee57f0432014-02-19 10:31:53 -08001422 LOCI_ASSERT(abs_offset >= 0);
Rich Lanea06d0c32013-03-25 08:52:03 -07001423""")
1424 if not loxi_utils.type_is_scalar(m_type):
Rich Lanee57f0432014-02-19 10:31:53 -08001425 out.write(" LOCI_ASSERT(cur_len >= 0 && cur_len < 64 * 1024);\n")
Rich Lanea06d0c32013-03-25 08:52:03 -07001426
1427 # Now generate the common accessor code
1428 if a_type in ["get", "bind"]:
1429 gen_get_accessor_body(out, cls, m_type, m_name)
1430 else:
1431 gen_set_accessor_body(out, cls, m_type, m_name)
1432
1433 out.write("""
1434 OF_LENGTH_CHECK_ASSERT(obj);
1435
1436 return %s;
1437}
1438""" % accessor_return_success(a_type, m_type))
1439
1440def gen_of_obj_bind(out, cls, m_name, m_type, ver_type_map):
1441 """
1442 For generating the bind call for OF sub-objects
1443 """
1444
1445 params = ",\n ".join(param_list(cls, m_name, "bind"))
1446 out.write("""
1447/**
1448 * Bind an object of type %(m_type)s to the parent of type %(cls)s for
1449 * member %(m_name)s
1450 * @param obj Pointer to an object of type %(cls)s.
1451 * @param %(m_name)s Pointer to the child object of type
1452 * %(m_type)s to be filled out.
1453 * \ingroup %(cls)s
1454 *
1455 * The parameter %(m_name)s is filled out to point to the same underlying
1456 * wire buffer as its parent.
1457 *
1458 */
1459""" % dict(m_name=m_name, cls=cls, m_type=m_type))
1460
1461 ret_type = accessor_return_type("bind", m_type)
1462 out.write("%s\n%s_%s_bind(\n %s)\n" % (ret_type, cls, m_name, params))
1463 gen_unified_acc_body(out, cls, m_name, ver_type_map, "bind", m_type)
1464
1465def gen_get_accessor(out, cls, m_name, m_type, ver_type_map):
1466 """
1467 For generating the get call for non- OF sub-objects
1468 """
1469 params = ",\n ".join(param_list(cls, m_name, "get"))
1470 out.write("""
1471/**
1472 * Get %(m_name)s from an object of type %(cls)s.
1473 * @param obj Pointer to an object of type %(cls)s.
1474 * @param %(m_name)s Pointer to the child object of type
1475 * %(m_type)s to be filled out.
1476 *
1477 */
1478""" % dict(m_name=m_name, cls=cls, m_type=m_type))
1479
1480 ret_type = accessor_return_type("get", m_type)
1481 out.write("%s\n%s_%s_get(\n %s)\n" % (ret_type, cls, m_name, params))
1482 gen_unified_acc_body(out, cls, m_name, ver_type_map, "get", m_type)
1483
Rich Lanece2e4642013-12-15 12:05:45 -08001484def gen_accessor_definitions(out, cls):
Rich Lanea06d0c32013-03-25 08:52:03 -07001485 for m_name in of_g.ordered_members[cls]:
1486 if m_name in of_g.skip_members:
1487 continue
1488 m_type = loxi_utils.member_base_type(cls, m_name)
1489 ver_type_map = field_ver_get(cls, m_name)
1490
1491 # Generate get/bind pending on member type
1492 # FIXME: Does this do the right thing for match?
1493 if loxi_utils.type_is_of_object(m_type):
1494 gen_of_obj_bind(out, cls, m_name, m_type, ver_type_map)
1495 gen_of_object_get(out, cls, m_name, m_type)
1496 else:
1497 gen_get_accessor(out, cls, m_name, m_type, ver_type_map)
1498
1499 # Now generate set accessor for all objects
1500 params = ",\n ".join(param_list(cls, m_name, "set"))
1501 out.write("""
1502/**
1503 * Set %(m_name)s in an object of type %(cls)s.
1504 * @param obj Pointer to an object of type %(cls)s.
1505""" % dict(m_name=m_name, cls=cls, m_type=m_type))
1506 if loxi_utils.type_is_scalar(m_type) or m_type == "of_octets_t":
1507 out.write("""\
1508 * @param %(m_name)s The value to write into the object
1509 */
1510""" % dict(m_name=m_name, cls=cls, m_type=m_type))
1511 else:
1512 out.write("""\
1513 * @param %(m_name)s Pointer to the child of type %(m_type)s.
1514 *
1515 * If the child's wire buffer is the same as the parent's, then
1516 * nothing is done as the changes have already been registered in the
1517 * parent. Otherwise, the data in the child's wire buffer is inserted
1518 * into the parent's and the appropriate lengths are updated.
1519 */
1520""" % dict(m_name=m_name, cls=cls, m_type=m_type))
1521 ret_type = accessor_return_type("set", m_type)
1522 out.write("%s\n%s_%s_set(\n %s)\n" % (ret_type, cls, m_name, params))
1523 gen_unified_acc_body(out, cls, m_name, ver_type_map, "set", m_type)
1524
Rich Lanea06d0c32013-03-25 08:52:03 -07001525################################################################
1526#
1527# New/Delete Function Definitions
1528#
1529################################################################
1530
Rich Lanea06d0c32013-03-25 08:52:03 -07001531################################################################
1532# Routines to generate the body of new/delete functions
1533################################################################
1534
1535def gen_init_fn_body(cls, out):
1536 """
1537 Generate function body for init function
1538 @param cls The class name for the function
1539 @param out The file to which to write
1540 """
Rich Lanea06d0c32013-03-25 08:52:03 -07001541
1542 out.write("""
1543/**
1544 * Initialize an object of type %(cls)s.
1545 *
1546 * @param obj Pointer to the object to initialize
1547 * @param version The wire version to use for the object
1548 * @param bytes How many bytes in the object
1549 * @param clean_wire Boolean: If true, clear the wire object control struct
1550 *
1551 * If bytes < 0, then the default fixed length is used for the object
1552 *
1553 * This is a "coerce" function that sets up the pointers for the
Andreas Wundsam53256162013-05-02 14:05:53 -07001554 * accessors properly.
Rich Lanea06d0c32013-03-25 08:52:03 -07001555 *
1556 * If anything other than 0 is passed in for the buffer size, the underlying
1557 * wire buffer will have 'grow' called.
1558 */
1559
1560void
Rich Lane7fdaa5c2014-10-27 18:14:59 -07001561%(cls)s_init(of_object_t *obj,
Rich Lanea06d0c32013-03-25 08:52:03 -07001562 of_version_t version, int bytes, int clean_wire)
1563{
Rich Lanee57f0432014-02-19 10:31:53 -08001564 LOCI_ASSERT(of_object_fixed_len[version][%(enum)s] >= 0);
Rich Lanea06d0c32013-03-25 08:52:03 -07001565 if (clean_wire) {
1566 MEMSET(obj, 0, sizeof(*obj));
1567 }
1568 if (bytes < 0) {
Rich Lanee3d3fb52014-10-16 12:45:17 -07001569 bytes = of_object_fixed_len[version][%(enum)s];
Rich Lanea06d0c32013-03-25 08:52:03 -07001570 }
1571 obj->version = version;
1572 obj->length = bytes;
1573 obj->object_id = %(enum)s;
Rich Lanea06d0c32013-03-25 08:52:03 -07001574
Rich Lanea06d0c32013-03-25 08:52:03 -07001575 /* Grow the wire buffer */
Rich Lanecdd542d2014-04-03 16:13:12 -07001576 if (obj->wbuf != NULL) {
Rich Lanea06d0c32013-03-25 08:52:03 -07001577 int tot_bytes;
1578
Rich Lanecdd542d2014-04-03 16:13:12 -07001579 tot_bytes = bytes + obj->obj_offset;
1580 of_wire_buffer_grow(obj->wbuf, tot_bytes);
Rich Lanea06d0c32013-03-25 08:52:03 -07001581 }
1582}
Rich Lane7fdaa5c2014-10-27 18:14:59 -07001583""" % dict(cls=cls, enum=enum_name(cls)))
Rich Lanea06d0c32013-03-25 08:52:03 -07001584
Rich Lanea06d0c32013-03-25 08:52:03 -07001585def gen_new_fn_body(cls, out):
1586 """
1587 Generate function body for new function
1588 @param cls The class name for the function
1589 @param out The file to which to write
1590 """
1591
1592 out.write("""
1593/**
1594 * \\defgroup %(cls)s %(cls)s
1595 */
1596""" % dict(cls=cls))
1597
Rich Lane37911fd2014-04-01 22:11:22 -07001598 uclass = loxi_globals.unified.class_by_name(cls)
1599 is_fixed_length = uclass and uclass.is_fixed_length
1600 max_length = is_fixed_length and "bytes" or "OF_WIRE_BUFFER_MAX_LENGTH"
1601
Rich Lanea06d0c32013-03-25 08:52:03 -07001602 out.write("""
1603/**
1604 * Create a new %(cls)s object
1605 *
1606 * @param version The wire version to use for the object
1607 * @return Pointer to the newly create object or NULL on error
1608 *
1609 * Initializes the new object with it's default fixed length associating
1610 * a new underlying wire buffer.
1611 *
Rich Lanea06d0c32013-03-25 08:52:03 -07001612 * \\ingroup %(cls)s
1613 */
1614
Rich Lane7fdaa5c2014-10-27 18:14:59 -07001615of_object_t *
Rich Lanecd6ef152013-12-15 16:42:18 -08001616%(cls)s_new(of_version_t version)
Rich Lanea06d0c32013-03-25 08:52:03 -07001617{
Rich Lane7fdaa5c2014-10-27 18:14:59 -07001618 of_object_t *obj;
Rich Lanea06d0c32013-03-25 08:52:03 -07001619 int bytes;
1620
Rich Lanee3d3fb52014-10-16 12:45:17 -07001621 bytes = of_object_fixed_len[version][%(enum)s];
Rich Lanea06d0c32013-03-25 08:52:03 -07001622
Rich Lane7fdaa5c2014-10-27 18:14:59 -07001623 if ((obj = of_object_new(%(max_length)s)) == NULL) {
Rich Lanea06d0c32013-03-25 08:52:03 -07001624 return NULL;
1625 }
1626
1627 %(cls)s_init(obj, version, bytes, 0);
Rich Lane37911fd2014-04-01 22:11:22 -07001628""" % dict(cls=cls, enum=enum_name(cls), max_length=max_length))
Rich Lanea06d0c32013-03-25 08:52:03 -07001629 if not type_maps.class_is_virtual(cls):
Rich Lane7e003102014-10-14 10:40:48 -07001630 from codegen import class_metadata_dict
1631 metadata = class_metadata_dict[cls]
1632
1633 if metadata.wire_type_set != 'NULL':
1634 out.write("""\
1635 %s(obj);
1636""" % metadata.wire_type_set)
1637
1638 if metadata.wire_length_set != 'NULL':
1639 out.write("""\
1640 %s(obj, obj->length);
1641""" % metadata.wire_length_set)
Rich Lanea06d0c32013-03-25 08:52:03 -07001642
1643 match_offset = v3_match_offset_get(cls)
1644 if match_offset >= 0:
1645 # Init length field for match object
1646 out.write("""
1647 /* Initialize match TLV for 1.2 */
Rich Lanea926e312014-10-14 11:45:39 -07001648 if ((version >= OF_VERSION_1_2)) {
Rich Lanea06d0c32013-03-25 08:52:03 -07001649 of_object_u16_set((of_object_t *)obj, %(match_offset)d + 2, 4);
1650 }
1651""" % dict(match_offset=match_offset))
1652 out.write("""
1653 return obj;
1654}
Rich Lanea06d0c32013-03-25 08:52:03 -07001655""" % dict(cls=cls))
1656
1657
Rich Lanea06d0c32013-03-25 08:52:03 -07001658################################################################
1659# Now the top level generator functions
1660################################################################
1661
1662def gen_new_function_declarations(out):
1663 """
1664 Gerenate the header file declarations for new operators for all classes
1665 @param out The file to which to write the decs
1666 """
1667
1668 out.write("""
1669/****************************************************************
1670 *
1671 * New operator declarations
1672 *
1673 * _new: Create a new object for writing; includes init
Rich Lanea06d0c32013-03-25 08:52:03 -07001674 * _init: Initialize and optionally allocate buffer space for an
1675 * automatic instance
1676 *
Rich Lanebb8f17c2014-06-12 13:14:09 -07001677 * _new and requires a delete operation to be called on the object.
Rich Lanea06d0c32013-03-25 08:52:03 -07001678 *
1679 ****************************************************************/
1680""")
Rich Lanea06d0c32013-03-25 08:52:03 -07001681
1682 for cls in of_g.standard_class_order:
1683 out.write("""
Rich Lane7fdaa5c2014-10-27 18:14:59 -07001684extern of_object_t *
Rich Lanecd6ef152013-12-15 16:42:18 -08001685 %(cls)s_new(of_version_t version);
Rich Lanea06d0c32013-03-25 08:52:03 -07001686""" % dict(cls=cls))
Rich Lanea06d0c32013-03-25 08:52:03 -07001687 out.write("""extern void %(cls)s_init(
Rich Lane7fdaa5c2014-10-27 18:14:59 -07001688 of_object_t *obj, of_version_t version, int bytes, int clean_wire);
Rich Lanea06d0c32013-03-25 08:52:03 -07001689""" % dict(cls=cls))
1690
1691 out.write("""
1692/****************************************************************
1693 *
1694 * Delete operator static inline definitions.
1695 * These are here for type checking purposes only
1696 *
1697 ****************************************************************/
1698""")
1699 for cls in of_g.standard_class_order:
Rich Lanea06d0c32013-03-25 08:52:03 -07001700 out.write("""
1701/**
1702 * Delete an object of type %(cls)s_t
1703 * @param obj An instance of type %(cls)s_t
1704 *
1705 * \ingroup %(cls)s
1706 */
1707static inline void
Rich Lane7fdaa5c2014-10-27 18:14:59 -07001708%(cls)s_delete(of_object_t *obj) {
1709 of_object_delete(obj);
Rich Lanea06d0c32013-03-25 08:52:03 -07001710}
1711""" % dict(cls=cls))
1712
1713 out.write("""
1714typedef void (*of_object_init_f)(of_object_t *obj, of_version_t version,
1715 int bytes, int clean_wire);
Rich Laneb157b0f2013-03-27 13:55:28 -07001716extern const of_object_init_f of_object_init_map[];
Rich Lanea06d0c32013-03-25 08:52:03 -07001717""")
1718
1719 out.write("""
1720/****************************************************************
1721 *
1722 * Function pointer initialization functions
1723 * These are part of the "coerce" type casting for objects
1724 *
1725 ****************************************************************/
1726""")
1727
Rich Laneb604e332013-12-15 13:23:51 -08001728def gen_new_function_definitions(out, cls):
Rich Lanea06d0c32013-03-25 08:52:03 -07001729 """
1730 Generate the new operator for all classes
1731
1732 @param out The file to which to write the functions
1733 """
1734
Rich Laneb604e332013-12-15 13:23:51 -08001735 gen_new_fn_body(cls, out)
1736 gen_init_fn_body(cls, out)
Rich Lanea06d0c32013-03-25 08:52:03 -07001737
Rich Lanea06d0c32013-03-25 08:52:03 -07001738"""
1739Document generation functions
1740
1741The main reason this is here is to generate documentation per
1742accessor that indicates the versions that support the interface.
1743"""
1744
1745
1746def gen_accessor_doc(out, name):
1747 """
1748 Generate documentation for each accessor function that indicates
1749 the versions supporting the accessor.
1750 """
1751
1752 common_top_matter(out, name)
1753
1754 out.write("/* DOCUMENTATION ONLY */\n")
1755
1756 for cls in of_g.standard_class_order:
Rich Lane6171e632014-11-07 10:23:38 -08001757 if type_maps.class_is_virtual(cls):
1758 pass
Rich Lanea06d0c32013-03-25 08:52:03 -07001759
1760 out.write("""
1761/**
Andreas Wundsam53256162013-05-02 14:05:53 -07001762 * Structure for %(cls)s object. Get/set
Rich Lanea06d0c32013-03-25 08:52:03 -07001763 * accessors available in all versions unless noted otherwise
1764 *
1765""" % dict(cls=cls))
1766 if loxi_utils.class_is_list(cls):
1767 out.write("""\
1768 * @param first Function of type %(cls)s_first_f.
1769 * Setup a TBD class object to the first entry in the list
1770 * @param next Function of type %(cls)s_next_f.
1771 * Advance a TBD class object to the next entry in the list
1772 * @param append_bind Function of type %(cls)s_append_bind_f
1773 * Setup a TBD class object for append to the end of the current list
1774 * @param append Function of type @ref %(cls)s_append_f.
1775 * Copy an item to the end of a list
1776""" % dict(cls=cls))
1777
1778 for m_name in of_g.ordered_members[cls]:
1779 if m_name in of_g.skip_members:
1780 continue
1781 ver_type_map = field_ver_get(cls, m_name)
1782 (m_type, get_rv) = get_acc_rv(cls, m_name)
1783 if len(ver_type_map) == 3:
1784 # ver_string = "Available in all versions"
1785 ver_string = ""
1786 else:
1787 ver_string = "("
1788 for ver in sorted(ver_type_map):
1789 ver_string += " " + of_g.short_version_names[ver]
1790 ver_string += ")."
1791
1792 f_name = acc_name(cls, m_name)
1793 out.write("""\
1794 * @param %(m_name)s_get/set %(ver_string)s
1795 * Accessors for %(m_name)s, a variable of type %(m_type)s. Functions
1796 * are of type %(f_name)s_get_f and _set_f.
1797 *
1798""" % dict(f_name=f_name, m_name=m_name, ver_string=ver_string, m_type=m_type))
1799
1800 out.write("""\
1801 */
1802typedef struct %(cls)s_s %(cls)s_t;
1803""" % dict(cls=cls))
1804
1805 out.write("#endif /* _LOCI_DOC_H_ */\n")