varun-r-mallya/python-bpf
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/Python-BPF.git synced 2026-02-07 13:40:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix decorators page in user-guide

Browse Source
This commit is contained in:
Pragyansh Chaturvedi
2026-01-27 02:16:03 +05:30
parent 06c81ae55e
commit 217e760e98
1 changed files with 5 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/user-guide/decorators.md
View File

@ -181,7 +181,7 @@ def count_clones(ctx: c_void_p) -> c_int64:
process_count.update(process_id, count + 1) process_count.update(process_id, count + 1)
else: else:
process_count.update(process_id, c_uint64(1)) process_count.update(process_id, c_uint64(1))
return c_int64(0) return 0
``` ```
See {doc}`maps` for more details on available map types. See {doc}`maps` for more details on available map types.
@ -208,7 +208,7 @@ class Event:
Structs allow you to define custom data types for use in BPF programs. They can be used: Structs allow you to define custom data types for use in BPF programs. They can be used:
* As map values * As map keys and values
* For perf event output * For perf event output
* In ring buffer submissions * In ring buffer submissions
* As local variables * As local variables
@ -248,11 +248,10 @@ def track_processes(ctx: c_void_p) -> c_int64:
event = ProcessEvent() event = ProcessEvent()
event.timestamp = ktime() event.timestamp = ktime()
event.pid = pid() event.pid = pid()
# Note: comm() requires a buffer parameter comm(event.comm) # Fills event.comm with process name
# comm(event.comm) # Fills event.comm with process name
events.output(event) events.output(event)
return c_int64(0) return 0
``` ```
See {doc}`structs` for more details on working with structs. See {doc}`structs` for more details on working with structs.
@ -392,9 +391,7 @@ def LICENSE() -> str:
1. **Always use @bpf first** - It must be the outermost decorator 1. **Always use @bpf first** - It must be the outermost decorator
2. **Provide type hints** - Required for proper code generation 2. **Provide type hints** - Required for proper code generation
3. **Use descriptive names** - Makes code easier to understand and debug 3. **Test incrementally** - Verify each component works before combining
4. **Keep functions simple** - BPF has restrictions on complexity
5. **Test incrementally** - Verify each component works before combining
## Common Errors ## Common Errors