aboutsummaryrefslogtreecommitdiffstats
path: root/docs/kfuzztest.md
diff options
context:
space:
mode:
authorEthan Graham <ethan.w.s.graham@gmail.com>2025-09-26 16:39:13 +0200
committerTaras Madan <tarasmadan@google.com>2025-09-29 07:52:47 +0000
commit86341da6b45d602116fb0c60fac1641c24aedbe9 (patch)
tree165143dd9819eaae7388e6795f26da0616ecba27 /docs/kfuzztest.md
parent001c90610fb2f2ac7cbbc9cd6af3f547b821a8ad (diff)
docs: update kfuzztest.md
Update kfuzztest.md to reflect some recent changes. In particular: - Point to the newest kernel pull request (PR v2) instead of the outdated RFC v1 patch series. - Change example description, as commit 0ac7291ca introduced a new input parameter for syz_kfuzztest_run.
Diffstat (limited to 'docs/kfuzztest.md')
-rw-r--r--docs/kfuzztest.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/kfuzztest.md b/docs/kfuzztest.md
index 7a1cda534..922c0ca55 100644
--- a/docs/kfuzztest.md
+++ b/docs/kfuzztest.md
@@ -20,8 +20,8 @@ This document introduces how syzkaller integrates with KFuzzTest.
Firstly, ensure that the KFuzzTest patch series has been applied to your Linux
tree.
-As of the 22nd of August 2025, the most up-to-date version can be found in
-[this Linux Kernel RFC](https://lore.kernel.org/all/20250813133812.926145-1-ethan.w.s.graham@gmail.com/).
+As of the 26th of Semptember 2025, the most up-to-date version can be found in
+[this Linux Kernel patch series](https://lore.kernel.org/all/20250919145750.3448393-1-ethan.w.s.graham@gmail.com/).
Once this is done, KFuzzTest targets can be defined on arbitrary kernel
functions using the `FUZZ_TEST` macro as described in the kernel docs in
@@ -66,7 +66,7 @@ some_buffer {
buflen len[buf, int64]
}
-kfuzztest_underflow_on_buffer(name ptr[in, string["test_underflow_on_buffer"]], data ptr[in, some_buffer], len bytesize[data]) (kfuzz_test)
+kfuzztest_underflow_on_buffer(name ptr[in, string["test_underflow_on_buffer"]], data ptr[in, some_buffer], len bytesize[data], buf ptr[in, array[int8, 65536]]) (kfuzz_test)
```
Where:
@@ -78,6 +78,11 @@ Where:
- The third should be the size in bytes of the input argument.
- The call is annotated with attribute `kfuzz_test`.
+The final `buf` argument is a buffer of size
+`KFUZZTEST_MAX_INPUT_SIZE = 16 * PAGE_SIZE` and is used internally to ensure
+that enough space is available in a program for the entire flattened input that
+is sent into a KFuzzTest target.
+
For more information on writing syzkaller descriptions attributes, consult the
[syscall description](syscall_descriptions.md) and [syscall description syntax](syscall_descriptions_syntax.md)
documentation files.