update build docs of probe_check (#35)

eunomia-bpf · Dec 23, 2024 · 4347db3 · 4347db3
1 parent eb0eb5b
commit 4347db3
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/bpftime/documents/build-and-test.md b/docs/bpftime/documents/build-and-test.md
@@ -110,6 +110,8 @@ You may be interested in the following cmake options:
 - `BUILD_BPFTIME_DAEMON`: Build with the daemon for load the eBPF program into hkernel and se kernel verifier.
 - `BPFTIME_BUILD_WITH_LIBBPF` :Build bpftime without libbpf. It can only be run in userspace with this enabled, but it can be easily port into other platform, e.g. macOS.
 - `BPFTIME_BUILD_STATIC_LIB`: Build bpftime runtime into a whole static libraries. It can be easily linked into other programs.
+- `ENABLE_PROBE_WRITE_CHECK`: Enable the probe write check. It will check the bpf_probe_write_user operation and report the error if the probe write address is invalid.
+- `ENABLE_PROBE_READ_CHECK`: Enable the probe read check. It will check the bpf_probe_write operation and report the error if the probe read address is invalid.
 
 Please see <https://github.com/eunomia-bpf/bpftime/blob/master/cmake/StandardSettings.cmake> forall the build options.