bcc-python: support attach_func() and detach_func() #3479
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chenyuezhou
requested review from
4ast,
brendangregg,
drzaeus77,
goldshtn and
yonghong-song
as code owners
|
[buildbot, test this please] |
docs/reference_guide.md
Outdated
| @@ -1847,6 +1849,42 @@ Examples in situ: | |||
| [search /examples](https://github.com/iovisor/bcc/search?q=attach_xdp+path%3Aexamples+language%3Apython&type=Code), | |||
| [search /tools](https://github.com/iovisor/bcc/search?q=attach_xdp+path%3Atools+language%3Apython&type=Code) | |||
|
|
|||
| ### 10. attach_func() | |||
|
|
|||
| Syntax: ```BPF.attach_func(fn, attach_type [, attachable_fd [, flags)``` | |||
There was a problem hiding this comment.
I think we can have a signature like
BPF.attach_func(fn, attachable_fd, attach_type [, flags])
Basically make attachable_fd mandatory and flags optional for python APIs.
The only case that an attchable_fd is not needed (must be 0) is for net_namespace. I think it is okay to require it and this makes argument sequence consistent with C++ APIs.
docs/reference_guide.md
Outdated
|
|
||
| Syntax: ```BPF.attach_func(fn, attach_type [, attachable_fd [, flags)``` | ||
|
|
||
| Attaches a BPF function of the specified type. |
There was a problem hiding this comment.
Attaches a BPF function of the specified type to a particular attachable_fd. if the attach_type is BPF_FLOW_DISSECTOR, the function is expected to attach to current net namespace and attachable_fd must be 0.
There was a problem hiding this comment.
thanks, adjusted.
docs/reference_guide.md
Outdated
|
|
||
| ### 11. detach_func() | ||
|
|
||
| Syntax: ```BPF.detach_func(fn, detach_type [, target_fd)``` |
There was a problem hiding this comment.
Again, let us do BPF.detach_func(fn, attachable_fd, attach_type), similar to C++ APIs.
examples/networking/sockmap.py
Outdated
| func_sock_redir = bpf.load_func("bpf_redir", bpf.SK_MSG) | ||
| # raise if error | ||
| fd = os.open(args.cgroup, os.O_RDONLY) | ||
| map_fd = lib.bpf_table_fd(bpf.module, "sock_hash") |
There was a problem hiding this comment.
I got a failure like below with python3.6,
$ sudo python3.6 sockmap.py -c /sys/fs/cgroup/system.slice/tmp.service/
Traceback (most recent call last):
File "sockmap.py", line 115, in <module>
map_fd = lib.bpf_table_fd(bpf.module, "sock_hash")
ctypes.ArgumentError: argument 2: <class 'TypeError'>: wrong type
Changing "sock_hash" to b"sock_hash" fixed the issue. Probably some python byte array thing.
| if not isinstance(fn, BPF.Function): | ||
| raise Exception("arg 1 must be of type BPF.Function") | ||
|
|
||
| res = lib.bpf_prog_attach(fn.fd, attachable_fd, attach_type, flags) |
There was a problem hiding this comment.
Probably we should add bpf_prog_attach/detach2 to libbcc.py to make it explicit?
|
[buildbot, test this please] |
docs/reference_guide.md
Outdated
| @@ -1847,6 +1849,42 @@ Examples in situ: | |||
| [search /examples](https://github.com/iovisor/bcc/search?q=attach_xdp+path%3Aexamples+language%3Apython&type=Code), | |||
| [search /tools](https://github.com/iovisor/bcc/search?q=attach_xdp+path%3Atools+language%3Apython&type=Code) | |||
|
|
|||
| ### 10. attach_func() | |||
|
|
|||
| Syntax: ```BPF.attach_func(fn, attachable_fd, attach_type [, flags)``` | |||
There was a problem hiding this comment.
I prefer we add ']' after '[, flags', so change to [, flags]?
examples/networking/sockmap.py
Outdated
|
|
||
|
|
||
| examples = """examples: | ||
| ./sockmap.py /root/cgroup # attach to /root/cgroup |
There was a problem hiding this comment.
./sockmap.py -c /root/cgroup ?
examples/networking/sockmap.py
Outdated
|
|
||
| bpf_text = ''' | ||
| #include <net/sock.h> | ||
| #include <bcc/proto.h> |
There was a problem hiding this comment.
#include <bcc/proto.h> is not needed.
|
[buildbot, test this please] |
davemarchevsky
added a commit
to davemarchevsky/bcc
that referenced
this pull request
Jun 16, 2021
In iovisor#3479, the `bpf_attach_type` enum was pulled into the `BPF` class so that its members could be used in `attach_func` and `detach_func` functions introduced to the Python API. Unfortunately this caused a redefinition of BPF.XDP, which was similarly pulled in from `bpf_prog_type` enum, thus breaking program loading (iovisor#3489). Let's pull these enum- and flag-type class variables out into their own wrapper classes. For backwards compatibility, keep them all (except for `bpf_attach_type`, which was merged 2 days ago) defined in the BPF class, but add a comment to not continue doing this.
yonghong-song
pushed a commit
that referenced
this pull request
Jun 16, 2021
In #3479, the `bpf_attach_type` enum was pulled into the `BPF` class so that its members could be used in `attach_func` and `detach_func` functions introduced to the Python API. Unfortunately this caused a redefinition of BPF.XDP, which was similarly pulled in from `bpf_prog_type` enum, thus breaking program loading (#3489). Let's pull these enum- and flag-type class variables out into their own wrapper classes. For backwards compatibility, keep them all (except for `bpf_attach_type`, which was merged 2 days ago) defined in the BPF class, but add a comment to not continue doing this.
brho
pushed a commit
to brho/bcc
that referenced
this pull request
Nov 3, 2021
In iovisor#3479, the `bpf_attach_type` enum was pulled into the `BPF` class so that its members could be used in `attach_func` and `detach_func` functions introduced to the Python API. Unfortunately this caused a redefinition of BPF.XDP, which was similarly pulled in from `bpf_prog_type` enum, thus breaking program loading (iovisor#3489). Let's pull these enum- and flag-type class variables out into their own wrapper classes. For backwards compatibility, keep them all (except for `bpf_attach_type`, which was merged 2 days ago) defined in the BPF class, but add a comment to not continue doing this.
CrackerCat
pushed a commit
to CrackerCat/bcc
that referenced
this pull request
Jul 31, 2024
- support attach_func() and detach_func(). - add an sockmap issue to demonstrate using these two functions.
CrackerCat
pushed a commit
to CrackerCat/bcc
that referenced
this pull request
Jul 31, 2024
In iovisor#3479, the `bpf_attach_type` enum was pulled into the `BPF` class so that its members could be used in `attach_func` and `detach_func` functions introduced to the Python API. Unfortunately this caused a redefinition of BPF.XDP, which was similarly pulled in from `bpf_prog_type` enum, thus breaking program loading (iovisor#3489). Let's pull these enum- and flag-type class variables out into their own wrapper classes. For backwards compatibility, keep them all (except for `bpf_attach_type`, which was merged 2 days ago) defined in the BPF class, but add a comment to not continue doing this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
attach_func()anddetach_func().Add a usage sample.(
sockmap.py)