Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1 | # 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 | Python backend for LOXI |
| 30 | |
| 31 | This language specific file defines a dictionary 'targets' that |
| 32 | defines the generated files and the functions used to generate them. |
| 33 | |
| 34 | For each generated file there is a generate_* function in py_gen.codegen |
| 35 | and a Tenjin template under py_gen/templates. |
| 36 | |
| 37 | Target 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 Lane | a22233e | 2013-04-25 13:18:41 -0700 | [diff] [blame] | 48 | of11: ... # (code generation incomplete) |
| 49 | of12: ... # (code generation incomplete) |
Rich Lane | ea69375 | 2013-03-18 11:05:45 -0700 | [diff] [blame] | 50 | oxm.py # OXM classes |
Rich Lane | a22233e | 2013-04-25 13:18:41 -0700 | [diff] [blame] | 51 | of13: ... # (code generation incomplete) |
Rich Lane | d82c0a6 | 2013-05-02 15:40:35 -0700 | [diff] [blame] | 52 | meter_band.py # Meter band classes |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 53 | |
| 54 | The user will add the pyloxi directory to PYTHONPATH. Then they can |
| 55 | "import loxi" or "import loxi.of10". The idiomatic import is |
| 56 | "import loxi.of10 as ofp". The protocol modules (e.g. of10) import |
| 57 | all of their submodules, so the user can access "ofp.message" without |
| 58 | further imports. The protocol modules also import the constants from |
| 59 | the const module directly into their namespace so the user can access |
| 60 | "ofp.OFPP_NONE". |
| 61 | """ |
| 62 | |
| 63 | import py_gen |
| 64 | import py_gen.util |
| 65 | import py_gen.codegen |
| 66 | |
| 67 | versions = { |
| 68 | 1: "of10", |
Jonathan Stout | 3edbac9 | 2013-04-05 11:30:49 -0400 | [diff] [blame] | 69 | 2: "of11", |
| 70 | 3: "of12", |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 71 | 4: "of13", |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 72 | } |
| 73 | |
| 74 | prefix = 'pyloxi/loxi' |
| 75 | |
Rich Lane | ea69375 | 2013-03-18 11:05:45 -0700 | [diff] [blame] | 76 | modules = { |
| 77 | 1: ["action", "common", "const", "message", "util"], |
| 78 | 2: ["action", "common", "const", "message", "util"], |
| 79 | 3: ["action", "common", "const", "message", "oxm", "util"], |
Rich Lane | d82c0a6 | 2013-05-02 15:40:35 -0700 | [diff] [blame] | 80 | 4: ["action", "common", "const", "message", "meter_band", "oxm", "util"], |
Rich Lane | ea69375 | 2013-03-18 11:05:45 -0700 | [diff] [blame] | 81 | } |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 82 | |
| 83 | def make_gen(name, version): |
| 84 | fn = getattr(py_gen.codegen, "generate_" + name) |
| 85 | return lambda out, name: fn(out, name, version) |
| 86 | |
| 87 | def static(template_name): |
| 88 | return lambda out, name: py_gen.util.render_template(out, template_name) |
| 89 | |
| 90 | targets = { |
| 91 | prefix+'/__init__.py': static('toplevel_init.py'), |
| 92 | prefix+'/pp.py': static('pp.py'), |
Rich Lane | 15cbe84 | 2013-04-26 16:04:11 -0700 | [diff] [blame] | 93 | prefix+'/generic_util.py': static('generic_util.py'), |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | for version, subdir in versions.items(): |
| 97 | targets['%s/%s/__init__.py' % (prefix, subdir)] = make_gen('init', version) |
Rich Lane | ea69375 | 2013-03-18 11:05:45 -0700 | [diff] [blame] | 98 | for module in modules[version]: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 99 | filename = '%s/%s/%s.py' % (prefix, subdir, module) |
| 100 | targets[filename] = make_gen(module, version) |