aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/suricata/src/tm-threads.h
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/suricata/src/tm-threads.h')
-rw-r--r--framework/src/suricata/src/tm-threads.h203
1 files changed, 203 insertions, 0 deletions
diff --git a/framework/src/suricata/src/tm-threads.h b/framework/src/suricata/src/tm-threads.h
new file mode 100644
index 00000000..9b9fd620
--- /dev/null
+++ b/framework/src/suricata/src/tm-threads.h
@@ -0,0 +1,203 @@
+/* Copyright (C) 2007-2011 Open Information Security Foundation
+ *
+ * You can copy, redistribute or modify this Program under the terms of
+ * the GNU General Public License version 2 as published by the Free
+ * Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 2 along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+/**
+ * \file
+ *
+ * \author Victor Julien <victor@inliniac.net>
+ * \author Anoop Saldanha <anoopsaldanha@gmail.com>
+ */
+
+#ifndef __TM_THREADS_H__
+#define __TM_THREADS_H__
+
+#include "tmqh-packetpool.h"
+#include "tm-threads-common.h"
+#include "tm-modules.h"
+
+#define TM_QUEUE_NAME_MAX 16
+#define TM_THREAD_NAME_MAX 16
+
+typedef TmEcode (*TmSlotFunc)(ThreadVars *, Packet *, void *, PacketQueue *,
+ PacketQueue *);
+
+typedef struct TmSlot_ {
+ /* the TV holding this slot */
+ ThreadVars *tv;
+
+ /* function pointers */
+ SC_ATOMIC_DECLARE(TmSlotFunc, SlotFunc);
+
+ TmEcode (*PktAcqLoop)(ThreadVars *, void *, void *);
+
+ TmEcode (*SlotThreadInit)(ThreadVars *, void *, void **);
+ void (*SlotThreadExitPrintStats)(ThreadVars *, void *);
+ TmEcode (*SlotThreadDeinit)(ThreadVars *, void *);
+
+ /* data storage */
+ void *slot_initdata;
+ SC_ATOMIC_DECLARE(void *, slot_data);
+
+ /* queue filled by the SlotFunc with packets that will
+ * be processed futher _before_ the current packet.
+ * The locks in the queue are NOT used */
+ PacketQueue slot_pre_pq;
+
+ /* queue filled by the SlotFunc with packets that will
+ * be processed futher _after_ the current packet. The
+ * locks in the queue are NOT used */
+ PacketQueue slot_post_pq;
+
+ /* store the thread module id */
+ int tm_id;
+
+ /* slot id, only used my TmVarSlot to know what the first slot is */
+ int id;
+
+ /* linked list, only used when you have multiple slots(used by TmVarSlot) */
+ struct TmSlot_ *slot_next;
+
+ /* just called once, so not perf critical */
+ TmEcode (*Management)(ThreadVars *, void *);
+
+} TmSlot;
+
+extern ThreadVars *tv_root[TVT_MAX];
+
+extern SCMutex tv_root_lock;
+
+void TmSlotSetFuncAppend(ThreadVars *, TmModule *, void *);
+void TmSlotSetFuncAppendDelayed(ThreadVars *, TmModule *, void *, int delayed);
+TmSlot *TmSlotGetSlotForTM(int);
+
+ThreadVars *TmThreadCreate(char *, char *, char *, char *, char *, char *,
+ void *(fn_p)(void *), int);
+ThreadVars *TmThreadCreatePacketHandler(char *, char *, char *, char *, char *,
+ char *);
+ThreadVars *TmThreadCreateMgmtThread(char *name, void *(fn_p)(void *), int);
+ThreadVars *TmThreadCreateMgmtThreadByName(char *name, char *module,
+ int mucond);
+ThreadVars *TmThreadCreateCmdThreadByName(char *name, char *module,
+ int mucond);
+TmEcode TmThreadSpawn(ThreadVars *);
+void TmThreadSetFlags(ThreadVars *, uint8_t);
+void TmThreadSetAOF(ThreadVars *, uint8_t);
+void TmThreadKillThread(ThreadVars *);
+void TmThreadKillThreadsFamily(int family);
+void TmThreadKillThreads(void);
+void TmThreadClearThreadsFamily(int family);
+void TmThreadAppend(ThreadVars *, int);
+void TmThreadRemove(ThreadVars *, int);
+
+TmEcode TmThreadSetCPUAffinity(ThreadVars *, uint16_t);
+TmEcode TmThreadSetThreadPriority(ThreadVars *, int);
+TmEcode TmThreadSetCPU(ThreadVars *, uint8_t);
+TmEcode TmThreadSetupOptions(ThreadVars *);
+void TmThreadSetPrio(ThreadVars *);
+int TmThreadGetNbThreads(uint8_t type);
+
+void TmThreadInitMC(ThreadVars *);
+void TmThreadTestThreadUnPaused(ThreadVars *);
+void TmThreadContinue(ThreadVars *);
+void TmThreadContinueThreads(void);
+void TmThreadPause(ThreadVars *);
+void TmThreadPauseThreads(void);
+void TmThreadCheckThreadState(void);
+TmEcode TmThreadWaitOnThreadInit(void);
+ThreadVars *TmThreadsGetCallingThread(void);
+
+int TmThreadsCheckFlag(ThreadVars *, uint16_t);
+void TmThreadsSetFlag(ThreadVars *, uint16_t);
+void TmThreadsUnsetFlag(ThreadVars *, uint16_t);
+void TmThreadWaitForFlag(ThreadVars *, uint16_t);
+
+TmEcode TmThreadsSlotVarRun (ThreadVars *tv, Packet *p, TmSlot *slot);
+
+ThreadVars *TmThreadsGetTVContainingSlot(TmSlot *);
+void TmThreadDisablePacketThreads(void);
+void TmThreadDisableReceiveThreads(void);
+TmSlot *TmThreadGetFirstTmSlotForPartialPattern(const char *);
+
+/**
+ * \brief Process the rest of the functions (if any) and queue.
+ */
+static inline TmEcode TmThreadsSlotProcessPkt(ThreadVars *tv, TmSlot *s, Packet *p)
+{
+ TmEcode r = TM_ECODE_OK;
+
+ if (s == NULL) {
+ tv->tmqh_out(tv, p);
+ return r;
+ }
+
+ if (TmThreadsSlotVarRun(tv, p, s) == TM_ECODE_FAILED) {
+ TmqhOutputPacketpool(tv, p);
+ TmSlot *slot = s;
+ while (slot != NULL) {
+ SCMutexLock(&slot->slot_post_pq.mutex_q);
+ TmqhReleasePacketsToPacketPool(&slot->slot_post_pq);
+ SCMutexUnlock(&slot->slot_post_pq.mutex_q);
+
+ slot = slot->slot_next;
+ }
+ TmThreadsSetFlag(tv, THV_FAILED);
+ r = TM_ECODE_FAILED;
+
+ } else {
+ tv->tmqh_out(tv, p);
+
+ /* post process pq */
+ TmSlot *slot = s;
+ while (slot != NULL) {
+ if (slot->slot_post_pq.top != NULL) {
+ while (1) {
+ SCMutexLock(&slot->slot_post_pq.mutex_q);
+ Packet *extra_p = PacketDequeue(&slot->slot_post_pq);
+ SCMutexUnlock(&slot->slot_post_pq.mutex_q);
+
+ if (extra_p == NULL)
+ break;
+
+ if (slot->slot_next != NULL) {
+ r = TmThreadsSlotVarRun(tv, extra_p, slot->slot_next);
+ if (r == TM_ECODE_FAILED) {
+ SCMutexLock(&slot->slot_post_pq.mutex_q);
+ TmqhReleasePacketsToPacketPool(&slot->slot_post_pq);
+ SCMutexUnlock(&slot->slot_post_pq.mutex_q);
+
+ TmqhOutputPacketpool(tv, extra_p);
+ TmThreadsSetFlag(tv, THV_FAILED);
+ break;
+ }
+ }
+ tv->tmqh_out(tv, extra_p);
+ }
+ } /* if (slot->slot_post_pq.top != NULL) */
+ slot = slot->slot_next;
+ } /* while (slot != NULL) */
+ }
+
+ return r;
+}
+
+
+void TmThreadsListThreads(void);
+int TmThreadsRegisterThread(ThreadVars *tv, const int type);
+void TmThreadsUnregisterThread(const int id);
+int TmThreadsInjectPacketsById(Packet **, int id);
+
+#endif /* __TM_THREADS_H__ */