blob: 9087b437c5d5c067a02476dce7b29d81e0599dd9 [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"""
29Python backend for LOXI
30
31This language specific file defines a dictionary 'targets' that
32defines the generated files and the functions used to generate them.
33
34For each generated file there is a generate_* function in py_gen.codegen
35and a Tenjin template under py_gen/templates.
36
37Target directory structure:
38 pyloxi:
39 loxi:
40 __init__.py
41 of10:
42 __init__.py
43 action.py # Action classes
44 common.py # Structs shared by multiple messages
45 const.py # OpenFlow constants
46 message.py # Message classes
47 util.py # Utility functions
Rich Lanea22233e2013-04-25 13:18:41 -070048 of11: ... # (code generation incomplete)
Rich Lanee02314c2013-05-02 16:42:04 -070049 instruction.py # Instruction classes
Rich Lanea22233e2013-04-25 13:18:41 -070050 of12: ... # (code generation incomplete)
Rich Laneea693752013-03-18 11:05:45 -070051 oxm.py # OXM classes
Rich Lanea22233e2013-04-25 13:18:41 -070052 of13: ... # (code generation incomplete)
Rich Lane2c9938e2013-12-09 17:20:12 -080053 action_id.py # Action ID classes
54 instruction_id.py # Instruction ID classes
Rich Laned82c0a62013-05-02 15:40:35 -070055 meter_band.py # Meter band classes
Rich Lanea06d0c32013-03-25 08:52:03 -070056
57The user will add the pyloxi directory to PYTHONPATH. Then they can
58"import loxi" or "import loxi.of10". The idiomatic import is
59"import loxi.of10 as ofp". The protocol modules (e.g. of10) import
60all of their submodules, so the user can access "ofp.message" without
61further imports. The protocol modules also import the constants from
62the const module directly into their namespace so the user can access
63"ofp.OFPP_NONE".
64"""
65
Rich Laneda5446f2013-11-10 17:21:48 -080066import os
Andreas Wundsam5630c422013-11-15 13:43:11 -080067from loxi_globals import OFVersions
68import loxi_globals
Rich Laneda5446f2013-11-10 17:21:48 -080069import loxi_utils.loxi_utils as loxi_utils
Rich Lanea06d0c32013-03-25 08:52:03 -070070import py_gen
71import py_gen.util
72import py_gen.codegen
Andreas Wundsam5420b952013-11-15 13:41:01 -080073import template_utils
Rich Lanea06d0c32013-03-25 08:52:03 -070074
75versions = {
76 1: "of10",
Jonathan Stout3edbac92013-04-05 11:30:49 -040077 2: "of11",
78 3: "of12",
Rich Lane3f075972013-03-15 22:56:29 -070079 4: "of13",
Rich Lanea06d0c32013-03-25 08:52:03 -070080}
81
82prefix = 'pyloxi/loxi'
83
Rich Laneea693752013-03-18 11:05:45 -070084modules = {
85 1: ["action", "common", "const", "message", "util"],
Rich Lanee02314c2013-05-02 16:42:04 -070086 2: ["action", "common", "const", "instruction", "message", "util"],
87 3: ["action", "common", "const", "instruction", "message", "oxm", "util"],
Rich Lane2c9938e2013-12-09 17:20:12 -080088 4: ["action", "action_id", "common", "const", "instruction", "instruction_id", "message", "meter_band", "oxm", "util"],
Rich Laneea693752013-03-18 11:05:45 -070089}
Rich Lanea06d0c32013-03-25 08:52:03 -070090
91def make_gen(name, version):
92 fn = getattr(py_gen.codegen, "generate_" + name)
93 return lambda out, name: fn(out, name, version)
94
95def static(template_name):
96 return lambda out, name: py_gen.util.render_template(out, template_name)
97
98targets = {
99 prefix+'/__init__.py': static('toplevel_init.py'),
100 prefix+'/pp.py': static('pp.py'),
Rich Lane15cbe842013-04-26 16:04:11 -0700101 prefix+'/generic_util.py': static('generic_util.py'),
Rich Lanea06d0c32013-03-25 08:52:03 -0700102}
103
104for version, subdir in versions.items():
105 targets['%s/%s/__init__.py' % (prefix, subdir)] = make_gen('init', version)
Rich Laneea693752013-03-18 11:05:45 -0700106 for module in modules[version]:
Rich Lanea06d0c32013-03-25 08:52:03 -0700107 filename = '%s/%s/%s.py' % (prefix, subdir, module)
Andreas Wundsam5630c422013-11-15 13:43:11 -0800108 targets[filename] = make_gen(module, OFVersions.from_wire(version))
Rich Laneda5446f2013-11-10 17:21:48 -0800109
Andreas Wundsam5420b952013-11-15 13:41:01 -0800110def generate(install_dir):
Rich Lanefa931272013-11-10 17:43:50 -0800111 py_gen.codegen.init()
Rich Laneda5446f2013-11-10 17:21:48 -0800112 for (name, fn) in targets.items():
Andreas Wundsam5420b952013-11-15 13:41:01 -0800113 with template_utils.open_output(install_dir, name) as outfile:
Rich Laneda5446f2013-11-10 17:21:48 -0800114 fn(outfile, os.path.basename(name))