Skip to content

Commit 99d2311

Browse files
committed
Update README and FILTER_LICENSES
1 parent 061752c commit 99d2311

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

FILTER_LICENSES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ following information to be misleading or incorrect, please file an issue/PR.
55
Because the Linux kernel exposes BPF helpers functions which are only
66
available to GPL-licensed programs, BPFnative provides the option to allow BPF
77
kernels to be generated under the GPL license, or whatever license is
8-
specified to the `bpfgen()` function. The subsequently generated kernel and
9-
source that generates would then be (probably) considered to be licensed as
8+
provided to `bpffunction()`. The subsequently generated kernel and
9+
source that generates it would then be considered to be licensed as
1010
specified. The default license is the empty string "", which may be construed
11-
to imply a lack of a license.
11+
to imply a lack of a license (proprietary).
1212

1313
BPFnative itself is of course just a compiler, so it may retain its MIT
1414
license. However, users should keep in mind that whatever license they specify
15-
to the `bpfgen()` function is the license that they must adhere to. This means
15+
to `bpffunction()` is the license that they must adhere to. This means
1616
that, for example, if a user were to generate a GPL-licensed BPF kernel with
1717
BPFnative's compiler, the user would be obligated to adhere to the terms of
1818
the GPL license, and specifically, would be required to provide the source

README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,9 @@
11
# BPFnative.jl
22

3-
## Instructions for use
4-
* Recompile Julia's LLVM with the appropriate line in deps/llvm.mk as such:
5-
`LLVM_TARGETS := host;NVPTX;AMDGPU;BPF`
6-
* `] build LLVM` to rebuild LLVM
7-
* Run `bpfgen(io, license, f, tt)` to generate a BPF kernel with license
8-
`license`, from function `f` with input types `tt`. The kernel's object file
9-
(ELF format) will be written to `io`.
10-
* If your kernel is an XDP filter, load it on the appropriate interface with:
11-
`ip link set dev myiface xdp obj mybpfkernel.o verbose`. `iproute2` will
12-
output some information on your kernel, which is useful for debugging when
13-
the Linux kernel refuses to load your kernel (this is common). When you're
14-
done with that kernel, unload it with `ip link set dev myiface xdp off`.
3+
BPFnative provides the ability to write eBPF filters in Julia. Additionally,
4+
wrappers to the [libbpf](https://github.com/libbpf/libbpf) library are provided
5+
to make it easy to load eBPF programs into the Linux kernel in for a variety of
6+
use cases.
157

168
## Acknowledgments
179
Thanks to @vchuravy for MCAnalyzer.jl, and @maleadt for CUDAnative.jl, both of

0 commit comments

Comments
 (0)