[draft] lib: example usage and "lib" runmode - v4 #11711
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add library source and runmode modules. Reorganized library example to create a worker thread and replay a pcap file using the library mode. No API layer is added at this stage. Edits by Jason Ish: - fix guard - add copyright/license headers
To keep the simple example simple, move the lib based capture method example to its own example.
- the generated binaries for lib examples - LSP files - man pages
Worker threads not created by Suricata, but instead a library user should not be joined, as Suricata does not have access to their thread handle, and it may in-fact be an unjoinable thread, such as the main process. When the thread ID is 0, assume the thread is "externally" managed, but still mark is as dead to satisfy Suricata's view of the thread.
Use the more conventional "--" command line handling to separate the arguments. The first set will be passed to Suricata, and the args after "--" will be handled by the example. Currently this is a single PCAP filename, but will be extended to a list of PCAP filenames.
Also use a proper return type (ThreadVars *).
Update ThreadVars creation in lib mode to have the worker_id provided by the user.
In the library capture example, show how the packet counter can be updated.
The variable run is not needed, we can just run an infinite loop and break when needed.
Refactor TmThreadsSlotPktAcqLoop for user provided thread by breaking out the init and finish code into their own functions. For user provided threads, Suricata should not "drive" the thread, but the setup and finish code is the same. The finish function is exported so it can be called by the user application when its receive loop or equivalent is done.
And add SC prefix.
Also remove function to set the library mode. This is easy enough to do with SCRunmodeSet, and we don't want to add a specific setter for each and every runmode.
This was referenced Sep 3, 2024
Closed
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #11711 +/- ##
==========================================
- Coverage 82.63% 82.60% -0.03%
==========================================
Files 919 921 +2
Lines 248925 249051 +126
==========================================
+ Hits 205703 205740 +37
- Misses 43222 43311 +89
Flags with carried forward coverage won't be shown. Click here to find out more. |
jasonish
commented
Sep 3, 2024
Comment on lines
+59
to
+62
| if (TmModuleLibHandlePacket(tv, device, packet, datalink, pkthdr.ts, pkthdr.len, 0, 0) != | ||
| 0) { | ||
| pthread_exit(NULL); | ||
| } |
There was a problem hiding this comment.
I'm now thinking that TmModuleLibHandlePacket and the call to it should be changed to something like:
- Some helper function to get a packet and perhaps some initial setup. But allow the user to to do some setup as well, like a "release" function.
- User then calls a
TmThreadsSlotProcessPktor some wrapper around it.
This removes one function fromsource-lib.cmaking it more functional, as well as allows post-inspection of the packet (which would make sense in workers mode, but not autofp)
@amirabell Any thoughts here?
There was a problem hiding this comment.
Yes not a bad idea.
Will there be an equivalent TmThreadFastProcessPkt to TmThreadSlowProcessPkt? And what would the difference be?
There was a problem hiding this comment.
Oops, typo.. Meant TmThreadsSlotProcessPkt.
|
Information: QA ran without warnings. Pipeline 22392 |
|
Replaced by #11921. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For review, and QA purposes and to restart some conversation.
Previous PRs:
Outstanding comments:
Ticket: https://redmine.openinfosecfoundation.org/issues/7240