Improve fabric.p4 to reduce pipeline resources and refactor pipeconf impl

This patch affects both the P4 pipeline implementation and the
Java pipeconf.

- Less tables and smarter use of metadata to reduce inter-tables
dependencies and favor parallel execution of tables.
- Removed unused actions / renamed existing ones to make forwarding
behavior clearer (e.g. ingress_port_vlan table)
- Remove co-existence of simple and hansed table. Hashed should be the
default one, but implementations that do not support action profiles
might compile fabric.p4 to use the simple one.
- Use @name annotations for match fields to make control plane
independent of table implementation.
- Use @hidden to avoid showing actions and table on the p4info that
cannot be controlled at runtime.
- First attempt to support double VLAN cross-connect (xconnect table).
- New design has been tested with "fabric-refactoring" branch of

This patch brings a major refactoring that reflects the experience
gathered in the past months of working on fabric.p4 and reasoning on its
pipeconf implementation. Indeed, the FlowObjective API is
under-specified and sometimes ambiguous which makes the process of
creating and maintaining a pipeliner implementation tedious. This
refactoring brings a simplified implementation by removing unused/
unnecessary functionalities and by recognizing commonality when possible
(e.g. by means of abstract and utility classes). It also makes design
patterns more explicit and consistent. Overall, the goal is to reduce
technical debt and to make it easier to support new features as we
evolve fabric.p4

Changes include:
- Changes in pipeliner/interpreter to reflect new pipeline design.
- By default translate objective treatment to PiAction. This favors
debuggability of flow rules in ONOS.
- Support new NextObjective’s NextTreatment class.
- Remove lots of unused/unnecessary code (e.g. async callback handling
for pending objective install status in pipeliner as current
implementation was always returning success)
- Gather commonality in abstract classes and simplify implementation
for objective translator (filtering, forwarding, next)
- New implementation of ForwardingFunctionTypes (FFT) that looks at
criterion instance values along with their types (to avoid relying on
case-specific if-else conditions to recognize variants of an FFT)
- Adaptive translation of NextObjective based on presence of simple or
hashed table.
- Support DENY FilteringObjective

- Fix onos-p4-gen-constants to avoid generating conflicting
PiMatchFieldId variable names.
- Install Graphviz tools in p4vm to generate p4c graphs
- Generate p4c graphs by default when compiling fabric.p4
- Use more compact Hex string when printing PI values

Change-Id: Ife79e44054dc5bc48833f95d0551a7370150eac5
68 files changed
tree: 1d779fe118898fa814d22b56fe734f19083e940a
  1. .bazelrc
  2. .dockerignore
  3. .github/
  4. .gitignore
  5. .gitreview
  6. BUILD
  7. Dockerfile
  8. LICENSE.txt
  11. apps/
  12. cli/
  13. core/
  14. docs/
  15. drivers/
  16. graveyard/
  17. lib/
  18. models/
  19. pipelines/
  20. protocols/
  21. providers/
  22. tools/
  23. utils/
  24. web/

ONOS : Open Network Operating System

What is ONOS?

ONOS is the only SDN controller platform that supports the transition from legacy “brown field” networks to SDN “green field” networks. This enables exciting new capabilities, and disruptive deployment and operational cost points for network operators.

Top-Level Features

  • High availability through clustering and distributed state management.
  • Scalability through clustering and sharding of network device control.
  • Performance that is good for a first release, and which has an architecture that will continue to support improvements.
  • Northbound abstractions for a global network view, network graph, and application intents.
  • Pluggable southbound for support of OpenFlow and new or legacy protocols.
  • Graphical user interface to view multi-layer topologies and inspect elements of the topology.
  • REST API for access to Northbound abstractions as well as CLI commands.
  • CLI for debugging.
  • Support for both proactive and reactive flow setup.
  • SDN-IP application to support interworking with traditional IP networks controlled by distributed routing protocols such as BGP.
  • IP-Optical use case demonstration.

Getting started


The following packages are reuqired:

  • git
  • zip
  • curl
  • unzip
  • python2.7
  • Oracle JDK8

To install Oracle JDK8, use following commands (Ubuntu):

$ sudo apt-get install software-properties-common -y && \
  sudo add-apt-repository ppa:webupd8team/java -y && \
  sudo apt-get update && \
  echo "oracle-java8-installer shared/accepted-oracle-license-v1-1 select true" | sudo debconf-set-selections && \
  sudo apt-get install oracle-java8-installer oracle-java8-set-default -y

Build ONOS from source

ONOS is built with Bazel, an open-source build tool developed by Google. ONOS supports Bazel 0.17 You can download it from official website or package manager (e.g. apt, brew...)

  1. Clone the code from ONOS gerrit repository
$ git clone
  1. Add ONOS developer environment to your bash profile, no need to do this step again if you had done this before
$ cd onos
$ cat << EOF >> ~/.bash_profile
export ONOS_ROOT="`pwd`"
source $ONOS_ROOT/tools/dev/bash_profile
$ . ~/.bash_profile
  1. Build ONOS with Bazel
$ bazel build onos

Start ONOS on local machine

To run ONOS locally on the development machine, simply run the following command:

$ bazel run onos-local [-- [clean] [debug]]

or simpler one:

$ ok [clean] [debug]

The above command will create a local installation from the onos.tar.gz file (re-building it if necessary) and will start the ONOS server in the background. In the foreground, it will display a continuous view of the ONOS (Apache Karaf) log file. Options following the double-dash (–) are passed through to the ONOS Apache Karaf and can be omitted. Here, the clean option forces a clean installation of ONOS and the debug option means that the default debug port 5005 will be available for attaching a remote debugger.

Interacting with ONOS

To access ONOS UI, use browser to open http://localhost:8181/onos/ui or use onos-gui localhost command

The default username and password is onos/rocks

To attach to the ONOS CLI console, run:

$ onos localhost

Unit Tests

To run ONOS unit tests, including code Checkstyle validation, run the following command:

$ bazel query 'tests(//...)' | xargs bazel test

Or better yet, to run code Checkstyle and all unit tests use the following convenience alias:

$ ot


ONOS code is hosted and maintained using Gerrit.

Code on GitHub is only a mirror. The ONOS project does NOT accept code through pull requests on GitHub.

To contribute to ONOS, please refer to Sample Gerrit Workflow. It should includes most of the things you'll need to get your contribution started!

More information

For more information, please check out our wiki page or mailing lists:


ONOS (Open Network Operating System) is published under Apache License 2.0