summaryrefslogtreecommitdiffstats
path: root/examples/bpf/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/bpf/README')
-rw-r--r--examples/bpf/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/examples/bpf/README b/examples/bpf/README
new file mode 100644
index 0000000..b726119
--- /dev/null
+++ b/examples/bpf/README
@@ -0,0 +1,18 @@
+eBPF toy code examples (running in kernel) to familiarize yourself
+with syntax and features:
+
+- BTF defined map examples
+ - bpf_graft.c -> Demo on altering runtime behaviour
+ - bpf_shared.c -> Ingress/egress map sharing example
+ - bpf_map_in_map.c -> Using map in map example
+
+- legacy struct bpf_elf_map defined map examples
+ - legacy/bpf_shared.c -> Ingress/egress map sharing example
+ - legacy/bpf_tailcall.c -> Using tail call chains
+ - legacy/bpf_cyclic.c -> Simple cycle as tail calls
+ - legacy/bpf_graft.c -> Demo on altering runtime behaviour
+ - legacy/bpf_map_in_map.c -> Using map in map example
+
+Note: Users should use new BTF way to defined the maps, the examples
+in legacy folder which is using struct bpf_elf_map defined maps is not
+recommanded.