Hi,
On Tue, Dec 12, 2023 at 9:11 AM Akihiko Odaki akihiko.odaki@daynix.com wrote:
Hi,
It is said eBPF is a safe way to extend kernels and that is very attarctive, but we need to use kfuncs to add new usage of eBPF and kfuncs are said as unstable as EXPORT_SYMBOL_GPL. So now I'd like to ask some questions:
- Which should I choose, BPF kfuncs or ioctl, when adding a new feature
for userspace apps? 2) How should I use BPF kfuncs from userspace apps if I add them?
Here, a "userspace app" means something not like a system-wide daemon like systemd (particularly, I have QEMU in mind). I'll describe the context more below:
I'm probably not the best person in the world to answer your questions, Alexei and others from the BPF core group are, but given that you pointed at a thread I was involved in, I feel I can give you a few pointers.
But first and foremost, I encourage you to schedule an agenda item in the BPF office hour[4]. Being able to talk with the core people directly was tremendously helpful to me to understand their point.
I'm working on a new feature that aids virtio-net implementations using tuntap virtual network device. You can see [1] for details, but basically it's to extend BPF_PROG_TYPE_SOCKET_FILTER to report four more bytes.
However, with long discussions we have confirmed extending BPF_PROG_TYPE_SOCKET_FILTER is not going to happen, and adding kfuncs is the way forward. So I decided how to add kfuncs to the kernel and how to use it. There are rich documentations for the kernel side, but I found little about the userspace. The best I could find is a systemd change proposal that is based on WIP kernel changes[2].
Yes, as Alexei already replied, BPF is not adding new stable APIs, only kfuncs. The reason being that once it's marked as stable, you can't really remove it, even if you think it's badly designed and useless.
Kfuncs, OTOH are "unstable" by default meaning that the constraints around it are more relaxed.
However, "unstable" doesn't mean "unusable". It just means that the kernel might or might not have the function when you load your program in userspace. So you have to take that fact into account from day one, both from the kernel side and the userspace side. The kernel docs have a nice paragraph explaining that situation and makes the distinction between relatively unused kfuncs, and well known established ones.
Regarding the systemd discussion you are mentioning ([2]), this is something that I have on my plate for a long time. I think I even mentioned it to Alexei at Kernel Recipes this year, and he frowned his eyebrows when I mentioned it. And looking at the systemd code and the benefits over a plain ioctl, it is clearer that in that case, a plain ioctl is better, mostly because we already know the API and the semantic.
A kfunc would be interesting in cases where you are not sure about the overall design, and so you can give a shot at various API solutions without having to keep your bad v1 design forever.
So now I'm wondering how I should use BPF kfuncs from userspace apps if I add them. In the systemd discussion, it is told that Linus said it's fine to use BPF kfuncs in a private infrastructure big companies own, or in systemd as those users know well about the system[3]. Indeed, those users should be able to make more assumptions on the kernel than "normal" userspace applications can.
Returning to my proposal, I'm proposing a new feature to be used by QEMU or other VMM applications. QEMU is more like a normal userspace application, and usually does not make much assumptions on the kernel it runs on. For example, it's generally safe to run a Debian container including QEMU installed with apt on Fedora. BPF kfuncs may work even in such a situation thanks to CO-RE, but it sounds like *accidentally* creating UAPIs.
Considering all above, how can I integrate BPF kfuncs to the application?
FWIW, I'm not sure you can rely on BPF calls from a container. There is a high chance the syscall gets disabled by the runtime.
If BPF kfuncs are like EXPORT_SYMBOL_GPL, the natural way to handle them is to think of BPF programs as some sort of kernel modules and incorporate logic that behaves like modprobe. More concretely, I can put eBPF binaries to a directory like: /usr/local/share/qemu/ebpf/$KERNEL_RELEASE
I would advise against that (one program per kernel release). Simply because your kfunc may or may not have been backported to kernel release v6.X.Y+1 while it was not there when v6.X.Y was out. So relying on the kernel number is just going to be a headache.
As I understand it, the way forward is to rely on the kernel, libbpf and CO-RE: if the function is not available, the program will simply not load, and you'll know that this version of the code is not available (or has changed API).
So what I would do if some kfunc API is becoming deprecated, is embedding both code paths in the same BPF unit, but marking them as not loaded by libppf. Then I can load the compilation unit, try v2 of the API, and if it's not available, try v1, and if not, then mention that I can not rely on BPF. Of course, this can also be done with separate compilation units.
Then, QEMU can uname() and get the path to the binary. It will give an error if it can't find the binary for the current kernel so that it won't create accidental UAPIs.
The obvious downside of this is that it complicates packaging a lot; it requires packaging QEMU eBPF binaries each time a new kernel comes up. This complexity is centrally managed by modprobe for kernel modules, but apparently each application needs to take care of it for BPF programs.
For my primary use case: HID-BPF, I put kfuncs in kernel v6.3 and given that I haven't touch this part of the API, the same compilation unit compiled in the v6.3 era still works on a v6.7-rcx, so no, IMO it's not complex and doesn't require to follow the kernel releases (which is the whole point of HID-BPF FWIW).
In conclusion, I see too much complexity to use BPF in a userspace application, which we didn't have to care for BPF_PROG_TYPE_SOCKET_FILTER. Isn't there a better way? Or shouldn't I use BPF in my case in the first place?
Given that I'm not a network person, I'm not sure about your use case, but I would make my decision based on: - do I know exactly what I want to achieve and I'm confident that I'll write the proper kernel API from day one? (if not then kfuncs is appealing because it's less workload in the long run, but userspace needs to be slightly smarter) - are all of my use cases covered by using BPF? (what happens if I run QEMU in a container?) -> BPF might or might not be a solution
But the nice thing about using BPF kfuncs is that it allows you to have a testing (not-)UAPI kernel interface. You can then implement the userspace changes and see how it behaves. And then, once you got the right design, you can decide to promote it to a proper syscall or ioctl if you want.
Cheers, Benjamin
Thanks, Akihiko Odaki
[1] https://lore.kernel.org/all/20231015141644.260646-1-akihiko.odaki@daynix.com... [2] https://github.com/systemd/systemd/pull/29797 [3] https://github.com/systemd/systemd/pull/29797#discussion_r1384637939
[4] https://docs.google.com/spreadsheets/d/1LfrDXZ9-fdhvPEp_LHkxAMYyxxpwBXjywWa0...