-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Add fentry/fexit aliases for kfunc/kretfunc #2844
Conversation
Not sure how to handle the listing of kfuncs e.g. |
docs/reference_guide.md
Outdated
- [17. `kfunc`/`kretfunc` (alias: `fentry`/`fexit`): Kernel Functions Tracing](#17-kfunckretfunc-kernel-functions-tracing) | ||
- [18. `kfunc`/`kretfunc` (alias: `fentry`/`fexit`): Kernel Functions Tracing Arguments](#18-kfunckretfunc-kernel-functions-tracing-arguments) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe leave the alias out of the section titles. Cuz we don't do that for the u:
and k:
stuff either. Also the link seems to be broken
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted to make them easier to find but I guess people can always search/find.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I'm hoping to keep the headers terse. Grep will find it anyways
docs/reference_guide.md
Outdated
kfunc[:module]:function | ||
kretfunc[:module]:function | ||
fentry[:module]:function | ||
fexit[:module]:function |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super nit: interleave?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mean like kfunc/fentry[:module]:function
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh sorry, I meant like:
kfunc[:module]:function
fentry[:module]:function
kretfunc[:module]:function
fexit[:module]:function
a192eb6
to
9091ce0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changelog entry would be appropriate I think
The 'kfunc' name was in bpftrace first and was "borrowed" by the kernel to now mean something completely different (yet related to bpf). New users going to look for fentry/fexit equivalents in bpftrace are going to be confused that they are called kfunc and kretfunc here. This change just adds fentry/fexit as aliases for kfunc/kretfunc.
9091ce0
to
78c43ac
Compare
The 'kfunc' name was in bpftrace first and was "borrowed" by the kernel to now mean something completely different (yet related to bpf). New users going to look for fentry/fexit equivalents in bpftrace are going to be confused that they are called kfunc and kretfunc here. This change just adds fentry/fexit as aliases for kfunc/kretfunc.
Checklist
man/adoc/bpftrace.adoc
and if needed indocs/reference_guide.md
CHANGELOG.md