mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00
0040111955
This reflects the `spicy-plugin` code as of `d8c296b81cc2a11`. In addition to moving the code into Zeek's source tree, this comes with a couple small functional changes: - `spicyz` no longer tries to infer if it's running from the build directory. Instead `ZEEK_SPICY_LIBRARY` can be set to a custom location. `zeek-set-path.sh` does that now. - ZEEK_CONFIG can be set to change what `spicyz -z` print out. This is primarily for backwards compatibility. Some further notes on specifics: - We raise the minimum Spicy version to 1.8 (i.e., current `main` branch). - Renamed the `compiler/` subdirectory to `spicyz` to avoid include-path conflicts with the Spicy headers. - In `cmake/`, the corresponding PR brings a new/extended version of `FindZeek`, which Spicy analyzer packages need. We also now install some of the files that the Spicy plugin used to bring for testing, so that existing packages keep working. - For now, this all remains backwards compatible with the current `zkg` analyzer templates so that they work with both external and integrated Spicy support. Later, once we don't need to support any external Spicy plugin versions anymore, we can clean up the templates as well. - All the plugin's tests have moved into the standard test suite. They are skipped if configure with `--disable-spicy`. This holds off on adapting the new code further to Zeek's coding conventions, so that it remains easier to maintain it in parallel to the (now legacy) external plugin. We'll make a pass over the formatting for (presumable) Zeek 6.1.
37 lines
1.3 KiB
Text
37 lines
1.3 KiB
Text
|
|
module Spicy;
|
|
|
|
export {
|
|
# doc-options-start
|
|
## Constant for testing if Spicy is available.
|
|
const available = T;
|
|
|
|
## Show output of Spicy print statements.
|
|
const enable_print = F &redef;
|
|
|
|
# Record and display profiling information, if compiled into analyzer.
|
|
const enable_profiling = F &redef;
|
|
|
|
## abort() instead of throwing HILTI exceptions.
|
|
const abort_on_exceptions = F &redef;
|
|
|
|
## Include backtraces when reporting unhandled exceptions.
|
|
const show_backtraces = F &redef;
|
|
|
|
## Maximum depth of recursive file analysis (Spicy analyzers only)
|
|
const max_file_depth: count = 5 &redef;
|
|
# doc-options-end
|
|
|
|
# doc-types-start
|
|
## Result type for `Spicy::resource_usage()`.
|
|
type ResourceUsage: record {
|
|
user_time : interval; ##< user CPU time of the Zeek process
|
|
system_time :interval; ##< system CPU time of the Zeek process
|
|
memory_heap : count; ##< memory allocated on the heap by the Zeek process
|
|
num_fibers : count; ##< number of fibers currently in use
|
|
max_fibers: count; ##< maximum number of fibers ever in use
|
|
max_fiber_stack_size: count; ##< maximum fiber stack size ever in use
|
|
cached_fibers: count; ##< number of fibers currently cached
|
|
};
|
|
# doc-types-end
|
|
}
|