blob: f4d79457c38577c18fc5a447a160b92211156009 [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@brief Show function generation
30
31Generates show function files.
32
33"""
34
35import sys
Andreas Wundsam76db0062013-11-15 13:34:41 -080036import c_gen.of_g_legacy as of_g
Andreas Wundsam542a13c2013-11-15 13:28:55 -080037import c_gen.match as match
38import c_gen.flags as flags
Rich Lanea06d0c32013-03-25 08:52:03 -070039from generic_utils import *
Andreas Wundsam542a13c2013-11-15 13:28:55 -080040import c_gen.type_maps as type_maps
Rich Lanea06d0c32013-03-25 08:52:03 -070041import loxi_utils.loxi_utils as loxi_utils
Andreas Wundsam542a13c2013-11-15 13:28:55 -080042import c_gen.loxi_utils_legacy as loxi_utils
43import c_gen.identifiers as identifiers
Rich Lanea06d0c32013-03-25 08:52:03 -070044from c_test_gen import var_name_map
45
Rich Laneb8330b22014-10-13 21:13:19 -070046show_override = {
47 ('uint32_t', 'arp_tpa'): 'ipv4',
48 ('uint32_t', 'arp_spa'): 'ipv4',
49 ('uint32_t', 'nw_addr'): 'ipv4',
50 ('uint32_t', 'dst'): 'ipv4',
51}
52
53show_hex = set([
54 ('uint8_t', 'icmpv6_code'),
55 ('uint8_t', 'mpls_tc'),
56 ('uint16_t', 'eth_type'),
57 ('uint8_t', 'ip_dscp'),
58 ('uint64_t', 'metadata'),
59 ('uint16_t', 'ingress_tpid'),
60 ('uint16_t', 'egress_tpid'),
61 ('uint32_t', 'xid'),
62 ('uint16_t', 'flags'),
63 ('uint32_t', 'experimenter'),
64 ('uint32_t', 'mask'),
65 ('uint8_t', 'report_mirror_ports'),
66 ('uint64_t', 'datapath_id'),
67 ('uint32_t', 'capabilities'),
68 ('uint32_t', 'actions'),
69 ('uint64_t', 'cookie'),
70 ('uint8_t', 'reason'),
71 ('uint32_t', 'role'),
72 ('uint32_t', 'config'),
73 ('uint32_t', 'advertise'),
74 ('uint32_t', 'advertised'),
75 ('uint32_t', 'supported'),
76 ('uint32_t', 'peer'),
77 ('uint64_t', 'cookie_mask'),
78 ('uint32_t', 'reserved'),
79 ('uint16_t', 'ethertype'),
80 ('uint64_t', 'metadata_mask'),
81 ('uint32_t', 'instructions'),
82 ('uint32_t', 'write_actions'),
83 ('uint32_t', 'apply_actions'),
84 ('uint32_t', 'types'),
85 ('uint32_t', 'actions_all'),
86 ('uint32_t', 'actions_select'),
87 ('uint32_t', 'actions_indirect'),
88 ('uint32_t', 'actions_ff'),
89 ('uint64_t', 'generation_id'),
90 ('uint16_t', 'value_mask'),
91 ('uint32_t', 'value_mask'),
92 ('uint32_t', 'oxm_header'),
93 ('uint8_t', 'value_mask'),
94 ('uint64_t', 'value_mask'),
95 ('uint64_t', 'write_setfields'),
96 ('uint64_t', 'apply_setfields'),
97 ('uint64_t', 'metadata_match'),
98 ('uint64_t', 'metadata_write'),
99 ('uint32_t', 'packet_in_mask_equal_master'),
100 ('uint32_t', 'packet_in_mask_slave'),
101 ('uint32_t', 'port_status_mask_equal_master'),
102 ('uint32_t', 'port_status_mask_slave'),
103 ('uint32_t', 'flow_removed_mask_equal_master'),
104 ('uint32_t', 'flow_removed_mask_slave'),
105 ('uint32_t', 'band_types'),
106 ('uint16_t', 'bsn_tcp_flags'),
107])
108
109def gen_emitter(cls, m_name, m_type):
110 if (m_type, m_name) in show_override:
111 short_type = show_override[(m_type, m_name)]
112 elif (m_type, m_name) in show_hex:
113 short_type = loxi_utils.type_to_short_name(m_type).replace('u', 'x')
114 else:
115 short_type = loxi_utils.type_to_short_name(m_type)
116 return "LOCI_SHOW_" + short_type;
117
Rich Lanea06d0c32013-03-25 08:52:03 -0700118def gen_obj_show_h(out, name):
119 loxi_utils.gen_c_copy_license(out)
120 out.write("""
121/**
122 *
123 * AUTOMATICALLY GENERATED FILE. Edits will be lost on regen.
124 *
Andreas Wundsam53256162013-05-02 14:05:53 -0700125 * Header file for object showing.
Rich Lanea06d0c32013-03-25 08:52:03 -0700126 */
127
128/**
129 * Show object declarations
130 *
131 * Routines that emit a human-readable dump of each object.
132 *
133 */
134
135#if !defined(_LOCI_OBJ_SHOW_H_)
136#define _LOCI_OBJ_SHOW_H_
137
138#include <loci/loci.h>
139#include <stdio.h>
140
141/* g++ requires this to pick up PRI, etc.
142 * See http://gcc.gnu.org/ml/gcc-help/2006-10/msg00223.html
143 */
144#if !defined(__STDC_FORMAT_MACROS)
145#define __STDC_FORMAT_MACROS
146#endif
147#include <inttypes.h>
148
149
150/**
Andreas Wundsam53256162013-05-02 14:05:53 -0700151 * Show any OF object.
Rich Lanea06d0c32013-03-25 08:52:03 -0700152 */
Andreas Wundsam53256162013-05-02 14:05:53 -0700153int of_object_show(loci_writer_f writer, void* cookie, of_object_t* obj);
Rich Lanea06d0c32013-03-25 08:52:03 -0700154
155
156
157
158
159
160""")
161
Rich Lanea06d0c32013-03-25 08:52:03 -0700162 for version in of_g.of_version_range:
163 for cls in of_g.standard_class_order:
164 if not loxi_utils.class_in_version(cls, version):
165 continue
Rich Lane8841f352014-10-12 19:18:36 -0700166 if type_maps.class_is_inheritance_root(cls):
Rich Lanea06d0c32013-03-25 08:52:03 -0700167 continue
168 out.write("""\
169int %(cls)s_%(ver_name)s_show(loci_writer_f writer, void* cookie, %(cls)s_t *obj);
170""" % dict(cls=cls, ver_name=loxi_utils.version_to_name(version)))
171
172 out.write("""
173#endif /* _LOCI_OBJ_SHOW_H_ */
174""")
175
176def gen_obj_show_c(out, name):
177 loxi_utils.gen_c_copy_license(out)
178 out.write("""
179/**
180 *
181 * AUTOMATICALLY GENERATED FILE. Edits will be lost on regen.
182 *
Andreas Wundsam53256162013-05-02 14:05:53 -0700183 * Source file for object showing.
184 *
Rich Lanea06d0c32013-03-25 08:52:03 -0700185 */
186
187#define DISABLE_WARN_UNUSED_RESULT
188#include <loci/loci.h>
189#include <loci/loci_show.h>
190#include <loci/loci_obj_show.h>
191
192static int
193unknown_show(loci_writer_f writer, void* cookie, of_object_t *obj)
194{
Andreas Wundsam53256162013-05-02 14:05:53 -0700195 return writer(cookie, "Unable to print object of type %d, version %d\\n",
Rich Lanea06d0c32013-03-25 08:52:03 -0700196 obj->object_id, obj->version);
Andreas Wundsam53256162013-05-02 14:05:53 -0700197}
Rich Lanea06d0c32013-03-25 08:52:03 -0700198""")
199
200 for version in of_g.of_version_range:
201 ver_name = loxi_utils.version_to_name(version)
202 for cls in of_g.standard_class_order:
203 if not loxi_utils.class_in_version(cls, version):
204 continue
Rich Lane8841f352014-10-12 19:18:36 -0700205 if type_maps.class_is_inheritance_root(cls):
Rich Lanea06d0c32013-03-25 08:52:03 -0700206 continue
207 out.write("""
208int
209%(cls)s_%(ver_name)s_show(loci_writer_f writer, void* cookie, %(cls)s_t *obj)
210{
211 int out = 0;
212""" % dict(cls=cls, ver_name=ver_name))
213
214 members, member_types = loxi_utils.all_member_types_get(cls, version)
215 for m_type in member_types:
216 if loxi_utils.type_is_scalar(m_type) or m_type in \
217 ["of_match_t", "of_octets_t"]:
218 # Declare instance of these
219 out.write(" %s %s;\n" % (m_type, var_name_map(m_type)))
220 else:
221 out.write("""
222 %(m_type)s %(v_name)s;
223""" % dict(m_type=m_type, v_name=var_name_map(m_type)))
224 if loxi_utils.class_is_list(m_type):
225 base_type = loxi_utils.list_to_entry_type(m_type)
226 out.write(" %s elt;\n int rv;\n" % base_type)
227 for member in members:
228 m_type = member["m_type"]
229 m_name = member["name"]
Rich Laneb8330b22014-10-13 21:13:19 -0700230 emitter = gen_emitter(cls, m_name, m_type)
Rich Lanea06d0c32013-03-25 08:52:03 -0700231 if loxi_utils.skip_member_name(m_name):
232 continue
233 if (loxi_utils.type_is_scalar(m_type) or
234 m_type in ["of_match_t", "of_octets_t"]):
235 out.write("""
236 %(cls)s_%(m_name)s_get(obj, &%(v_name)s);
237 out += writer(cookie, "%(m_name)s=");
238 out += %(emitter)s(writer, cookie, %(v_name)s);
Andreas Wundsam53256162013-05-02 14:05:53 -0700239 out += writer(cookie, " ");
Rich Lanea06d0c32013-03-25 08:52:03 -0700240""" % dict(cls=cls, m_name=m_name, m_type=m_type,
241 v_name=var_name_map(m_type), emitter=emitter))
242 elif loxi_utils.class_is_list(m_type):
243 sub_cls = m_type[:-2] # Trim _t
244 elt_type = loxi_utils.list_to_entry_type(m_type)
245 out.write("""
246 out += writer(cookie, "%(elt_type)s={ ");
247 %(cls)s_%(m_name)s_bind(obj, &%(v_name)s);
248 %(u_type)s_ITER(&%(v_name)s, &elt, rv) {
249 of_object_show(writer, cookie, (of_object_t *)&elt);
250 }
Andreas Wundsam53256162013-05-02 14:05:53 -0700251 out += writer(cookie, "} ");
Rich Lanea06d0c32013-03-25 08:52:03 -0700252""" % dict(sub_cls=sub_cls, u_type=sub_cls.upper(), v_name=var_name_map(m_type),
253 elt_type=elt_type, cls=cls, m_name=m_name, m_type=m_type))
254 else:
255 sub_cls = m_type[:-2] # Trim _t
256 out.write("""
257 %(cls)s_%(m_name)s_bind(obj, &%(v_name)s);
258 out += %(sub_cls)s_%(ver_name)s_show(writer, cookie, &%(v_name)s);
Andreas Wundsam53256162013-05-02 14:05:53 -0700259""" % dict(cls=cls, sub_cls=sub_cls, m_name=m_name,
Rich Lanea06d0c32013-03-25 08:52:03 -0700260 v_name=var_name_map(m_type), ver_name=ver_name))
261
262 out.write("""
263 return out;
264}
265""")
266 out.write("""
267/**
268 * Log a match entry
269 */
270int
271loci_show_match(loci_writer_f writer, void* cookie, of_match_t *match)
272{
273 int out = 0;
274""")
275
276 for key, entry in match.of_match_members.items():
277 m_type = entry["m_type"]
Rich Laneb8330b22014-10-13 21:13:19 -0700278 emitter = gen_emitter('of_match', key, m_type)
Rich Lanea06d0c32013-03-25 08:52:03 -0700279 out.write("""
280 if (OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(match)) {
Andreas Wundsam53256162013-05-02 14:05:53 -0700281 out += writer(cookie, "%(key)s active=");
Rich Lanea06d0c32013-03-25 08:52:03 -0700282 out += %(emitter)s(writer, cookie, match->fields.%(key)s);
Andreas Wundsam53256162013-05-02 14:05:53 -0700283 out += writer(cookie, "/");
Rich Lanea06d0c32013-03-25 08:52:03 -0700284 out += %(emitter)s(writer, cookie, match->masks.%(key)s);
285 out += writer(cookie, " ");
286 }
287""" % dict(key=key, ku=key.upper(), emitter=emitter, m_type=m_type))
288
289 out.write("""
290 return out;
291}
292""")
293
294 # Generate big table indexed by version and object
295 for version in of_g.of_version_range:
296 out.write("""
Rich Laneb157b0f2013-03-27 13:55:28 -0700297static const loci_obj_show_f show_funs_v%(version)s[OF_OBJECT_COUNT] = {
Rich Lanea06d0c32013-03-25 08:52:03 -0700298""" % dict(version=version))
299 out.write(" unknown_show, /* of_object, not a valid specific type */\n")
300 for j, cls in enumerate(of_g.all_class_order):
301 comma = ""
302 if j < len(of_g.all_class_order) - 1: # Avoid ultimate comma
303 comma = ","
304
Andreas Wundsam53256162013-05-02 14:05:53 -0700305 if (not loxi_utils.class_in_version(cls, version) or
Rich Lane8841f352014-10-12 19:18:36 -0700306 type_maps.class_is_inheritance_root(cls)):
Rich Lanea06d0c32013-03-25 08:52:03 -0700307 out.write(" unknown_show%s\n" % comma);
308 else:
Andreas Wundsam53256162013-05-02 14:05:53 -0700309 out.write(" %s_%s_show%s\n" %
Rich Lanea06d0c32013-03-25 08:52:03 -0700310 (cls, loxi_utils.version_to_name(version), comma))
311 out.write("};\n\n")
312
313 out.write("""
Rich Laneb157b0f2013-03-27 13:55:28 -0700314static const loci_obj_show_f *const show_funs[5] = {
Rich Lanea06d0c32013-03-25 08:52:03 -0700315 NULL,
316 show_funs_v1,
317 show_funs_v2,
318 show_funs_v3,
319 show_funs_v4
320};
321
322int
323of_object_show(loci_writer_f writer, void* cookie, of_object_t *obj)
324{
325 if ((obj->object_id > 0) && (obj->object_id < OF_OBJECT_COUNT)) {
326 if (((obj)->version > 0) && ((obj)->version <= OF_VERSION_1_2)) {
327 /* @fixme VERSION */
328 return show_funs[obj->version][obj->object_id](writer, cookie, (of_object_t *)obj);
329 } else {
330 return writer(cookie, "Bad version %d\\n", obj->version);
331 }
332 }
333 return writer(cookie, "Bad object id %d\\n", obj->object_id);
334}
335""")
336