blob: 07530d6e81ba1d39d91711640790ceef3fac045d [file] [log] [blame]
Yi Tseng43ee7e82018-04-12 16:37:34 +08001#!/usr/bin/env python2.7
2# -*- utf-8 -*-
3import argparse
Yi Tseng43ee7e82018-04-12 16:37:34 +08004import google.protobuf.text_format as tf
Carmelo Casconeb5324e72018-11-25 02:26:32 -08005import re
Yi Tseng13c27f12018-06-23 01:08:55 +08006from p4.config.v1 import p4info_pb2
Yi Tseng43ee7e82018-04-12 16:37:34 +08007
Yi Tseng43ee7e82018-04-12 16:37:34 +08008copyright = '''/*
9 * Copyright 2017-present Open Networking Foundation
10 *
11 * Licensed under the Apache License, Version 2.0 (the "License");
12 * you may not use this file except in compliance with the License.
13 * You may obtain a copy of the License at
14 *
15 * http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing, software
18 * distributed under the License is distributed on an "AS IS" BASIS,
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 * See the License for the specific language governing permissions and
21 * limitations under the License.
22 */
23'''
24
25imports = '''
26import org.onosproject.net.pi.model.PiActionId;
27import org.onosproject.net.pi.model.PiActionParamId;
28import org.onosproject.net.pi.model.PiActionProfileId;
Daniele Moro1edc0bd2019-08-21 17:22:50 -070029import org.onosproject.net.pi.model.PiMeterId;
Carmelo Cascone4c289b72019-01-22 15:30:45 -080030import org.onosproject.net.pi.model.PiPacketMetadataId;
Yi Tseng43ee7e82018-04-12 16:37:34 +080031import org.onosproject.net.pi.model.PiCounterId;
32import org.onosproject.net.pi.model.PiMatchFieldId;
33import org.onosproject.net.pi.model.PiTableId;'''
34
CyberHasH2713bb62019-11-12 21:03:54 +080035PKG_FMT = 'package %s;'
36DEFAULT_PKG_PATH = 'org.onosproject.pipelines.%s'
Yi Tseng43ee7e82018-04-12 16:37:34 +080037
38CLASS_OPEN = 'public final class %s {'
39CLASS_CLOSE = '}'
40
41DEFAULT_CONSTRUCTOR = '''
42 // hide default constructor
43 private %s() {
44 }
45'''
46
47CONST_FMT = ' public static final %s %s = %s;'
48SHORT_CONST_FMT =''' public static final %s %s =
49 %s;'''
50JAVA_STR = 'String'
51EMPTY_STR = ''
52JAVA_DOC_FMT = '''/**
53 * Constants for %s pipeline.
54 */'''
55
56
57PI_HF_FIELD_ID = 'PiMatchFieldId'
58PI_HF_FIELD_ID_CST = 'PiMatchFieldId.of("%s")'
59
60PI_TBL_ID = 'PiTableId'
61PI_TBL_ID_CST = 'PiTableId.of("%s")'
62
63PI_CTR_ID = 'PiCounterId'
64PI_CTR_ID_CST = 'PiCounterId.of("%s")'
65
66PI_ACT_ID = 'PiActionId'
67PI_ACT_ID_CST = 'PiActionId.of("%s")'
68
69PI_ACT_PRM_ID = 'PiActionParamId'
70PI_ACT_PRM_ID_CST = 'PiActionParamId.of("%s")'
71
72PI_ACT_PROF_ID = 'PiActionProfileId'
73PI_ACT_PROF_ID_CST = 'PiActionProfileId.of("%s")'
74
Carmelo Cascone4c289b72019-01-22 15:30:45 -080075PI_PKT_META_ID = 'PiPacketMetadataId'
76PI_PKT_META_ID_CST = 'PiPacketMetadataId.of("%s")'
Yi Tseng43ee7e82018-04-12 16:37:34 +080077
Daniele Moro1edc0bd2019-08-21 17:22:50 -070078PI_METER_ID = 'PiMeterId'
79PI_METER_ID_CST = 'PiMeterId.of("%s")'
80
Carmelo Casconeb5324e72018-11-25 02:26:32 -080081HF_VAR_PREFIX = 'HDR_'
82
83
Yi Tseng43ee7e82018-04-12 16:37:34 +080084class ConstantClassGenerator(object):
85 headers = set()
86 header_fields = set()
87 tables = set()
88 counters = set()
89 direct_counters = set()
90 actions = set()
91 action_params = set()
92 action_profiles = set()
93 packet_metadata = set()
Daniele Moro1edc0bd2019-08-21 17:22:50 -070094 meters = set()
Yi Tseng43ee7e82018-04-12 16:37:34 +080095
96 # https://stackoverflow.com/questions/1175208/elegant-python-function-to-convert-camelcase-to-snake-case
97 def convert_camel_to_all_caps(self, name):
98 s1 = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', name)
99 s1 = re.sub('([a-z0-9])([A-Z])', r'\1_\2', s1).upper()
100 return s1.replace('.', '_')
101
CyberHasH2713bb62019-11-12 21:03:54 +0800102 def __init__(self, base_name, pkg_path):
Yi Tseng43ee7e82018-04-12 16:37:34 +0800103
104 self.class_name = base_name.title() + 'Constants'
CyberHasH2713bb62019-11-12 21:03:54 +0800105 self.package_name = PKG_FMT % (pkg_path, )
Yi Tseng43ee7e82018-04-12 16:37:34 +0800106 self.java_doc = JAVA_DOC_FMT % (base_name, )
107
108 def parse(self, p4info):
109 for tbl in p4info.tables:
110 for mf in tbl.match_fields:
111 self.header_fields.add(mf.name)
112
113 self.tables.add(tbl.preamble.name)
114
115 for ctr in p4info.counters:
116 self.counters.add(ctr.preamble.name)
117
118 for dir_ctr in p4info.direct_counters:
119 self.direct_counters.add(dir_ctr.preamble.name)
120
121 for act in p4info.actions:
122 self.actions.add(act.preamble.name)
123
124 for param in act.params:
125 self.action_params.add(param.name)
126
127 for act_prof in p4info.action_profiles:
128 self.action_profiles.add(act_prof.preamble.name)
129
130 for cpm in p4info.controller_packet_metadata:
131 for mta in cpm.metadata:
132 self.packet_metadata.add(mta.name)
Daniele Moro1edc0bd2019-08-21 17:22:50 -0700133 for mtr in p4info.meters:
134 self.meters.add(mtr.preamble.name)
Yi Tseng43ee7e82018-04-12 16:37:34 +0800135
136 def const_line(self, name, type, constructor):
137 var_name = self.convert_camel_to_all_caps(name)
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800138 if type == PI_HF_FIELD_ID:
139 var_name = HF_VAR_PREFIX + var_name
Yi Tseng43ee7e82018-04-12 16:37:34 +0800140 val = constructor % (name, )
141
142 line = CONST_FMT % (type, var_name, val)
143 if len(line) > 80:
144 line = SHORT_CONST_FMT % (type, var_name, val)
145 return line
146
147 def generate_java(self):
148 lines = list()
149 lines.append(copyright)
150 lines.append(self.package_name)
151 lines.append(imports)
152 lines.append(self.java_doc)
153 # generate the class
154 lines.append(CLASS_OPEN % (self.class_name, ))
155 lines.append(DEFAULT_CONSTRUCTOR % (self.class_name, ))
156
157 if len(self.header_fields) is not 0:
158 lines.append(' // Header field IDs')
159 for hf in self.header_fields:
160 lines.append(self.const_line(hf, PI_HF_FIELD_ID, PI_HF_FIELD_ID_CST))
161
162 if len(self.tables) is not 0:
163 lines.append(' // Table IDs')
164 for tbl in self.tables:
165 lines.append(self.const_line(tbl, PI_TBL_ID, PI_TBL_ID_CST))
166
167 if len(self.counters) is not 0:
168 lines.append(' // Indirect Counter IDs')
169 for ctr in self.counters:
170 lines.append(self.const_line(ctr, PI_CTR_ID, PI_CTR_ID_CST))
171
172 if len(self.direct_counters) is not 0:
173 lines.append(' // Direct Counter IDs')
174 for dctr in self.direct_counters:
175 lines.append(self.const_line(dctr, PI_CTR_ID, PI_CTR_ID_CST))
176
177 if len(self.actions) is not 0:
178 lines.append(' // Action IDs')
179 for act in self.actions:
180 lines.append(self.const_line(act, PI_ACT_ID, PI_ACT_ID_CST))
181
182 if len(self.action_params) is not 0:
183 lines.append(' // Action Param IDs')
184 for act_prm in self.action_params:
185 lines.append(self.const_line(act_prm, PI_ACT_PRM_ID, PI_ACT_PRM_ID_CST))
186
187 if len(self.action_profiles) is not 0:
188 lines.append(' // Action Profile IDs')
189 for act_prof in self.action_profiles:
190 lines.append(self.const_line(act_prof, PI_ACT_PROF_ID, PI_ACT_PROF_ID_CST))
191
192 if len(self.packet_metadata) is not 0:
193 lines.append(' // Packet Metadata IDs')
194 for pmeta in self.packet_metadata:
Daniele Moro1edc0bd2019-08-21 17:22:50 -0700195 if not pmeta.startswith("_"):
196 lines.append(self.const_line(pmeta, PI_PKT_META_ID, PI_PKT_META_ID_CST))
197
198 if len(self.meters) is not 0:
199 lines.append(' // Meter IDs')
200 for mtr in self.meters:
201 lines.append(self.const_line(mtr, PI_METER_ID, PI_METER_ID_CST))
Yi Tseng43ee7e82018-04-12 16:37:34 +0800202 lines.append(CLASS_CLOSE)
203 # end of class
204
205 return '\n'.join(lines)
206
CyberHasH2713bb62019-11-12 21:03:54 +0800207def gen_pkg_path(output, base_name):
208 if output is not None:
209 i = output.find('java/')
210 if i != -1:
211 pkg_path = output[i+5:]
212 last_slash = pkg_path.rfind('/')
213 pkg_path = pkg_path[:last_slash].replace('/','.')
214 return pkg_path
215 return DEFAULT_PKG_PATH % (base_name, )
Yi Tseng43ee7e82018-04-12 16:37:34 +0800216def main():
217 parser = argparse.ArgumentParser(prog='onos-gen-p4-constants',
218 description='ONOS P4Info to Java constant generator.')
219 parser.add_argument('name', help='Name of the constant, will be used as class name')
220 parser.add_argument('p4info', help='P4Info file')
221 parser.add_argument('-o', '--output', help='output path', default='-')
CyberHasH2713bb62019-11-12 21:03:54 +0800222 parser.add_argument('--with-package-path', help='Specify the java package path', dest='pkg_path')
Yi Tseng43ee7e82018-04-12 16:37:34 +0800223 args = parser.parse_args()
224
225 base_name = args.name
226 file_name = args.p4info
CyberHasH2713bb62019-11-12 21:03:54 +0800227 output = args.output
228 pkg_path = args.pkg_path
229 if pkg_path is None:
230 pkg_path = gen_pkg_path(output, base_name)
Yi Tseng43ee7e82018-04-12 16:37:34 +0800231 p4info = p4info_pb2.P4Info()
232 with open(file_name, 'r') as intput_file:
233 s = intput_file.read()
234 tf.Merge(s, p4info)
235
CyberHasH2713bb62019-11-12 21:03:54 +0800236 gen = ConstantClassGenerator(base_name, pkg_path)
Yi Tseng43ee7e82018-04-12 16:37:34 +0800237 gen.parse(p4info)
238
239 java_code = gen.generate_java()
240
CyberHasH2713bb62019-11-12 21:03:54 +0800241 if output == '-':
Yi Tseng43ee7e82018-04-12 16:37:34 +0800242 # std output
243 print java_code
244 else:
CyberHasH2713bb62019-11-12 21:03:54 +0800245 with open(output, 'w') as output_file:
Yi Tseng43ee7e82018-04-12 16:37:34 +0800246 output_file.write(java_code)
247
248
249if __name__ == '__main__':
250 main()