Skip to content

Commit 5890dbe

Browse files
committed
doc(seccomp): mention that debug builds don't have a default seccomp
Following the previous commit, this patch mentions in the docs that debug builds don't have a default seccomp policy and which different syscalls are present in debug builds versus release. Signed-off-by: Riccardo Mancini <[email protected]>
1 parent 0ec23ad commit 5890dbe

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/seccomp.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ follows:
1111
- API - right before launching the HTTP server;
1212
- VCPUs - right before executing guest code.
1313

14-
**Note**: On experimental GNU targets, there are no default seccomp filters
15-
installed, since they are not intended for production use.
14+
> [!WARNING]
15+
>
16+
> On debug binaries and experimental GNU targets, there are no default seccomp
17+
> filters installed, since they are not intended for production use.
1618
1719
Firecracker uses JSON files for expressing the filter rules and relies on the
1820
[seccompiler](seccompiler.md) tool for all the seccomp functionality.
@@ -58,6 +60,12 @@ Potential use cases:
5860
- Users of experimentally-supported targets (like GNU libc builds) may be able
5961
to use this feature to implement seccomp filters without needing to have a
6062
custom build of Firecracker.
63+
- Users of debug binaries who need to use a seccomp filter for any reason will
64+
be able to use this feature to implement seccomp filters without needing to
65+
have a custom build of Firecracker. Note: there may be some differences in
66+
syscalls between `debug` and `release` builds. A non-comprehensive list is:
67+
- `fcntl(F_GETFD)` is used by debug assertions to verify a dropped `fd` is
68+
valid.
6169
- Faced with a _theoretical_ production issue, due to a syscall that was issued
6270
by the Firecracker process, but not allowed by the seccomp policy, one may use
6371
a custom filter in order to quickly mitigate the issue. This can speed up the

0 commit comments

Comments
 (0)