Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-loxi / 4ee5146655b1a4ab706b46a46ab255f41aaefe26
commit4ee5146655b1a4ab706b46a46ab255f41aaefe26[log] [tgz]
authorAndreas Wundsam <andreas.wundsam@bigswitch.com>Tue Jul 30 11:00:37 2013 -0700
committerAndreas Wundsam <andreas.wundsam@bigswitch.com>Tue Jul 30 11:35:32 2013 -0700
tree1058b349a01d2895edf58b90e6832d356634f6e2
parent5204de2700592b91fa5eaabe393d8f7fe56b7384 [diff]
const_values: add enum, entry parameters

Currently defined parameters:
enum:
 - wire_type: type the values have on the wire (e.g., uint32_t)
 - bitmask: boolean flag if const is an enumeration (False)[Default], or
   a bitmask (True)
 - complete: whether the values listed are a complete enumeration of
   all possible values or not
entry:
 - virtual: whether the entry is a virtual, i.e., doesn't define
   a true enum value in its own right (true for _MASK_BIT values)
9 files changed
tree: 1058b349a01d2895edf58b90e6832d356634f6e2
  1. .abat-automerge
  2. .gitignore
  3. .hooks/
  4. AUTHORS
  5. INTERNALS
  6. LoxiGen.mk
  7. Makefile
  8. README.md
  9. TODO
  10. c_gen/
  11. generic_utils.py
  12. java_gen/
  13. lang_c.py
  14. lang_java.py
  15. lang_python.py
  16. loxi_front_end/
  17. loxi_ir.py
  18. loxi_utils/
  19. loxigen.py
  20. of_g.py
  21. openflow_input/
  22. py_gen/
  23. pyparsing.py
  24. tenjin.py
  25. test_data/
  26. utest/
README.md

Introduction

LoxiGen is a tool that generates OpenFlow protocol libraries for a number of languages. It is composed of a frontend that parses wire protocol descriptions and a backend for each supported language (currently C and Python, with Java on the way).

Usage

You can run LoxiGen directly from the repository. There's no need to install it, and it has no dependencies beyond Python 2.6+.

To generate the libraries for all languages:

make

To generate the library for a single language:

make c

The currently supported languages are c and python.

The generated libraries will be under the loxi_output directory. This can be changed with the LOXI_OUTPUT_DIR environment variable when using the Makefile.

Each generated library comes with its own set of documentation in the standard format for that language. Please see that documentation for more details on using the generated libraries.

Contributing

Please fork the repository on GitHub and send us a pull request. You might also be interested in the INTERNALS file which has notes about how LoxiGen works.