Skip to content

Commit 9db8d5b

Browse files
committed
Update ISA documentation
* Add section numbers * Add glossary formatting for fields * Use consistent field names * Add appendix with opcode table * Add ISA version information * Add text about underflow, overflow, and division by zero * Add other text based on info in other documents Signed-off-by: Dave Thaler <[email protected]>
1 parent bbbe6c0 commit 9db8d5b

File tree

3 files changed

+587
-207
lines changed

3 files changed

+587
-207
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# eBPF Standard Documentation
2+
3+
This repository is a working draft of standard eBPF documentation
4+
to be published by the eBPF Foundation in PDF format.
5+
6+
The authoritative source from which it is built is expected to be
7+
in the Linux kernel.org repository, but not be Linux specific.
8+
9+
A GitHub mirror should be used, as is presently done for libbpf and
10+
bpftool, so that other platforms and tools can easily use it.
11+
As such, the documentation uses the subset of RST that GitHub
12+
renders correctly.
13+
14+
The documentation can be IETF RFC style MUST/SHOULD/MAY language
15+
if desired. It does not currently do so.
16+
17+
## Questions
18+
19+
1. Any objections to the github mirror approach?
20+
21+
2. Should we include or exclude Linux implementation notes
22+
and Clang implementation notes?
23+
24+
3. How do we handle the legacy packet instructions?
25+
26+
4. How do we handle the wide instructions that reference
27+
map fd, map indices, BTF ids, and BPF callbacks?

isa/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Some documentation links include:
88
* https://www.kernel.org/doc/Documentation/networking/filter.txt
99
* https://pchaigno.github.io/bpf/2021/10/20/ebpf-instruction-sets.html
1010
* https://www.kernel.org/doc/html/latest/bpf/bpf_design_QA.html#instruction-level-questions
11+
* https://lore.kernel.org/bpf/[email protected]/
12+
* https://github.com/iovisor/bpf-docs/pull/26/files
1113

1214
Some implementation links include:
1315

0 commit comments

Comments
 (0)