Skip to content

Commit

Permalink
[docs] Add Backend to directory structure (#4503)
Browse files Browse the repository at this point in the history
* [docs] Add Backend to directory structure

* [docs] Update description of "common" directory

[docs] Update description of "common" directory in  "Compiler source code organization" Section

Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com>

* [docs] Update description of "dpdk" backend

[docs] Update description of "dpdk" backend in  "Compiler source code organization" Section

Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com>

* [docs] Update description of backends

Update description of "p4tools" , "tc" and "ubpf" directory in  "Compiler source code organization" Section

Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com>

* Renamed Back-end to Back end

* Renamed front-end to front end

---------

Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com>
  • Loading branch information
AdarshRawat1 and fruffy committed Mar 12, 2024
1 parent b2c29a5 commit 2463725
Showing 1 changed file with 12 additions and 7 deletions.
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

0 comments on commit 2463725

Please sign in to comment.