Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add Backend to directory structure #4503

Merged
merged 9 commits into from
Mar 12, 2024
19 changes: 12 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,26 @@ The code and documentation are hosted in the following repository: https://githu
```
p4c
├── build -- recommended place to build binary
├── backends
│ ├── p4test -- "fake" back-end for testing
│ ├── ebpf -- extended Berkeley Packet Filters back-end
├── backends
│ ├── bmv2 -- behavioral model version 2 (switch simulator) back end
│ ├── common -- code shared by multiple back ends
│ ├── dpdk -- translates P4 code to DPDK instructions
│ ├── ebpf -- extended Berkeley Packet Filters back end
│ ├── graphs -- backend that can draw graphiz graphs of P4 programs
│ └── bmv2 -- behavioral model version 2 (switch simulator) back-end
│ ├── p4test -- "fake" back end for testing
│ ├── p4tools -- testing library for different static analysis tools
│ ├── tc -- translates P4 code to Linux TC rules
│ └── ubpf -- translates P4 programs to uBPF code
├── control-plane -- control plane API
├── docs -- documentation
│ └── doxygen -- documentation generation support
├── extensions
│ └── XXXX -- symlinks to custom back-ends
├── frontends
│ ├── common -- common front-end code
│ ├── common -- common front end code
│ ├── parsers -- parser and lexer code for P4_14 and P4_16
│ ├── p4-14 -- P4_14 front-end
│ └── p4 -- P4_16 front-end
│ ├── p4-14 -- P4_14 front end
│ └── p4 -- P4_16 front end
├── ir -- core internal representation
├── lib -- common utilities (libp4toolkit.a)
├── midend -- code that may be useful for writing mid-ends
Expand Down
Loading