github/falco
1
0
Fork 0
mirror of https://github.com/falcosecurity/falco.git synced 2025-08-12 11:32:39 +00:00
Code Issues Projects Releases Wiki Activity

docs: fix some docs

Browse Source 
Signed-off-by: Andrea Terzolo <andreaterzolo3@gmail.com>
This commit is contained in:
Andrea Terzolo 2023-11-18 23:46:52 +01:00 committed by poiana
parent 1b14fed380
commit 335022076f
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
falco.yaml
View File

@ -290,8 +290,8 @@ rules_file:
# BUFFERs 0 0 0 0 0 0 0 # BUFFERs 0 0 0 0 0 0 0
# #
# Moreover, you have the option to combine this parameter with # Moreover, you have the option to combine this parameter with
# `syscall_buf_size_preset` index. For instance, you can create a large shared # `buf_size_preset` index. For instance, you can create a large shared
# syscall buffer of 512 MB (using syscall_buf_size_preset=10) that is # syscall buffer of 512 MB (using buf_size_preset=10) that is
# allocated among all the online CPUs. # allocated among all the online CPUs.
# #
# --- [Suggestions] # --- [Suggestions]
@ -302,7 +302,7 @@ rules_file:
# the flexibility to experiment and find the optimal configuration for your # the flexibility to experiment and find the optimal configuration for your
# system. # system.
# #
# When considering a fixed syscall_buf_size_preset and a fixed buffer dimension: # When considering a fixed buf_size_preset and a fixed buffer dimension:
# - Increasing this configs value results in lower number of buffers and you can # - Increasing this configs value results in lower number of buffers and you can
# speed up your system and reduce memory usage # speed up your system and reduce memory usage
# - However, using too few buffers may increase contention in the kernel, # - However, using too few buffers may increase contention in the kernel,

6
userspace/falco/app/actions/configure_syscall_buffer_size.cpp
View File

@ -36,7 +36,7 @@ falco::app::run_result falco::app::actions::configure_syscall_buffer_size(falco:
} }
if(index < MIN_INDEX || index > MAX_INDEX) if(index < MIN_INDEX || index > MAX_INDEX)
{ {
return run_result::fatal("The 'syscall_buf_size_preset' value must be between '" + std::to_string(MIN_INDEX) + "' and '" + std::to_string(MAX_INDEX) + "'\n"); return run_result::fatal("The 'buf_size_preset' value must be between '" + std::to_string(MIN_INDEX) + "' and '" + std::to_string(MAX_INDEX) + "'\n");
} }
/* Sizes from `1 MB` to `512 MB`. The index `0` is reserved, users cannot use it! */ /* Sizes from `1 MB` to `512 MB`. The index `0` is reserved, users cannot use it! */
@ -56,13 +56,13 @@ falco::app::run_result falco::app::actions::configure_syscall_buffer_size(falco:
/* Check if the chosen size is a multiple of the page size. */ /* Check if the chosen size is a multiple of the page size. */
if(chosen_size % page_size != 0) if(chosen_size % page_size != 0)
{ {
return run_result::fatal("The chosen syscall buffer size '" + std::to_string(chosen_size) + "' is not a multiple of your system page size '" + std::to_string(page_size) + "'. Please configure a greater 'syscall_buf_size_preset' value in the Falco configuration file\n"); return run_result::fatal("The chosen syscall buffer size '" + std::to_string(chosen_size) + "' is not a multiple of your system page size '" + std::to_string(page_size) + "'. Please configure a greater 'buf_size_preset' value in the Falco configuration file\n");
} }
/* Check if the chosen size is greater than `2 * page_size`. */ /* Check if the chosen size is greater than `2 * page_size`. */
if((chosen_size / page_size) <= 2) if((chosen_size / page_size) <= 2)
{ {
return run_result::fatal("The chosen syscall buffer size '" + std::to_string(chosen_size) + "' is not greater than '2 * " + std::to_string(page_size) + "' where '" + std::to_string(page_size) + "' is your system page size. Please configure a greater 'syscall_buf_size_preset' value in the Falco configuration file\n"); return run_result::fatal("The chosen syscall buffer size '" + std::to_string(chosen_size) + "' is not greater than '2 * " + std::to_string(page_size) + "' where '" + std::to_string(page_size) + "' is your system page size. Please configure a greater 'buf_size_preset' value in the Falco configuration file\n");
} }
s.syscall_buffer_bytes_size = chosen_size; s.syscall_buffer_bytes_size = chosen_size;