This repository has submodules; after cloning it you should run git submodule update --init --recursive.
- Judy
Based on the command-line flags you intend on providing to configure, you need
to install different dependencies.
| Configure flag | Default (yes / no) | Dependencies | Remarks |
|---|---|---|---|
--with-bmv2 |
no | bmv2 and its deps | Implies --with-fe-cpp |
--with-proto |
no | Protobuf, gRPC, libboost-thread-dev | - |
--with-fe-cpp |
no | - | - |
--with-internal-rpc |
no | nanomsg | - |
--with-cli |
no | readline | - |
--with-sysrepo |
no | same as --with-proto + sysrepo and its deps |
- |
- libtool binary; we use libtool as part of the build system, libtool binary is required to run some of the generated binaries uner valgrind
- valgrind, as some tests use it to check for memory errors
- Boost library, for some of the C++ tests: we currently require
boost/optional.hppandboost/functional/hash.hpp
| Dependency | Name of Debian package |
|---|---|
| Judy | libjudy-dev |
| readline | libreadline-dev |
| valgrind | valgrind |
| libtool binary | libtool-bin |
| Boost library | libboost-dev libboost-system-dev libboost-thread-dev |
Some dependencies are not available as Debian packages or the available version is not the right one.
- bmv2 and all its dependencies: follow instructions in the bmv2 README
- nanomsg 1.0.0
- Protobuf v3.6.1:
git clone https://github.com/google/protobuf.git
cd protobuf/
git checkout tags/v3.6.1
./autogen.sh
./configure
make
[sudo] make install
[sudo] ldconfig
git clone https://github.com/google/grpc.git
cd grpc/
git checkout tags/v1.17.2
git submodule update --init --recursive
make
[sudo] make install
[sudo] ldconfig
- sysrepo and all its dependencies: see instructions in proto/README.md
You may be able to use different versions of Protobuf / gRPC, or a more recent
version of nanomsg. However, the versions above are the ones we use for
development and CI testing. When running configure with --with-proto, the
script will verify that Protobuf >= 3.0.0 and gRPC >= 1.3.0 are installed.
To include p4runtime.proto in the build, please run configure with
--with-proto.
./autogen.sh
./configure --with-proto
make
make check
[sudo] make install
We include tentative support for the Bazel build system. This should enable other Bazel projects to easily import this repository. For the great majority of users who wish to build and install PI, we recommend using the autotools-based build system.
The Bazel version we have tested is 0.23.2. This is the version used to run CI.
To build the P4Runtime PI frontend and run the tests:
bazel build //proto/frontend:pifeproto
bazel test //proto/tests:pi_proto_tests
To use PI in another Bazel project, do the following in your WORKSPACE file:
- Import this project, for example using
git_repository. - Import dependencies:
load("@com_github_p4lang_PI//bazel:deps.bzl", "PI_deps")
PI_deps()
load("@com_github_p4lang_p4runtime//bazel:deps.bzl", "p4runtime_deps")
p4runtime_deps()
load("@com_github_p4lang_p4runtime//bazel:rules.bzl", "p4runtime_proto_repositories")
p4runtime_proto_repositories()
For now the PI CLI supports an experimental version of table_add and
table_delete. Because these two functions have been implemented in the bmv2 PI
implementation, you can test the PI CLI with the bmv2 simple_switch. Assuming
bmv2 is installed on your system, build the PI and the CLI with ./configure --with-bmv2 --with-cli && make. You can then experiment with the following
commands:
simple_switch tests/testdata/simple_router.json // to start the switch
./CLI/pi_CLI_bmv2 -c tests/testdata/simple_router.json // to start the CLI
PI CLI> assign_device 0 0 -- port=9090 // 0 0 : device id + config id
PI CLI> table_add ipv4_lpm 10.0.0.1/24 => set_nhop 10.0.0.1 1
PI CLI> table_dump ipv4_lpm
PI CLI> table_delete ipv4_lpm <handle returned by table_add>
See CONTRIBUTING.md.