suricata
runmode-pcap-file.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2010 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 #include "suricata-common.h"
19 #include "tm-threads.h"
20 #include "conf.h"
21 #include "runmodes.h"
22 #include "runmode-pcap-file.h"
23 #include "output.h"
24 
25 #include "detect-engine.h"
26 #include "source-pcap-file.h"
27 
28 #include "util-debug.h"
29 #include "util-time.h"
30 #include "util-cpu.h"
31 #include "util-affinity.h"
32 
33 #include "util-runmodes.h"
34 
36 {
37  return "autofp";
38 }
39 
41 {
42  RunModeRegisterNewRunMode(RUNMODE_PCAP_FILE, "single", "Single threaded pcap file mode",
43  RunModeFilePcapSingle, NULL);
45  "Multi threaded pcap file mode. Packets from "
46  "each flow are assigned to a single detect thread, "
47  "unlike \"pcap-file-auto\" where packets from "
48  "the same flow can be processed by any detect "
49  "thread",
50  RunModeFilePcapAutoFp, NULL);
51 
52  return;
53 }
54 
55 /**
56  * \brief Single thread version of the Pcap file processing.
57  */
59 {
60  const char *file = NULL;
61  char tname[TM_THREAD_NAME_MAX];
62 
63  if (ConfGet("pcap-file.file", &file) == 0) {
64  FatalError("Failed retrieving pcap-file from Conf");
65  }
66 
68 
70 
71  snprintf(tname, sizeof(tname), "%s#01", thread_name_single);
72 
73  /* create the threads */
75  "packetpool", "packetpool",
76  "packetpool", "packetpool",
77  "pktacqloop");
78  if (tv == NULL) {
79  FatalError("threading setup failed");
80  }
81 
82  TmModule *tm_module = TmModuleGetByName("ReceivePcapFile");
83  if (tm_module == NULL) {
84  FatalError("TmModuleGetByName failed for ReceivePcap");
85  }
86  TmSlotSetFuncAppend(tv, tm_module, file);
87 
88  tm_module = TmModuleGetByName("DecodePcapFile");
89  if (tm_module == NULL) {
90  FatalError("TmModuleGetByName DecodePcap failed");
91  }
92  TmSlotSetFuncAppend(tv, tm_module, NULL);
93 
94  tm_module = TmModuleGetByName("FlowWorker");
95  if (tm_module == NULL) {
96  FatalError("TmModuleGetByName for FlowWorker failed");
97  }
98  TmSlotSetFuncAppend(tv, tm_module, NULL);
99 
101 
102  if (TmThreadSpawn(tv) != TM_ECODE_OK) {
103  FatalError("TmThreadSpawn failed");
104  }
105  return 0;
106 }
107 
108 /**
109  * \brief RunModeFilePcapAutoFp set up the following thread packet handlers:
110  * - Receive thread (from pcap file)
111  * - Decode thread
112  * - Stream thread
113  * - Detect: If we have only 1 cpu, it will setup one Detect thread
114  * If we have more than one, it will setup num_cpus - 1
115  * starting from the second cpu available.
116  * - Outputs thread
117  * By default the threads will use the first cpu available
118  * except the Detection threads if we have more than one cpu.
119  *
120  * \retval 0 If all goes well. (If any problem is detected the engine will
121  * exit()).
122  */
124 {
125  SCEnter();
126  char tname[TM_THREAD_NAME_MAX];
127  char qname[TM_QUEUE_NAME_MAX];
128  uint16_t cpu = 0;
129  char *queues = NULL;
130  uint16_t thread;
131 
132  const char *file = NULL;
133  if (ConfGet("pcap-file.file", &file) == 0) {
134  FatalError("Failed retrieving pcap-file from Conf");
135  }
136  SCLogDebug("file %s", file);
137 
139 
141 
142  /* Available cpus */
143  uint16_t ncpus = UtilCpuGetNumProcessorsOnline();
144 
145  /* start with cpu 1 so that if we're creating an odd number of detect
146  * threads we're not creating the most on CPU0. */
147  if (ncpus > 0)
148  cpu = 1;
149 
150  /* always create at least one thread */
151  int thread_max = TmThreadGetNbThreads(WORKER_CPU_SET);
152  if (thread_max == 0)
153  thread_max = ncpus * threading_detect_ratio;
154  if (thread_max < 1)
155  thread_max = 1;
156  if (thread_max > 1024)
157  thread_max = 1024;
158 
159  queues = RunmodeAutoFpCreatePickupQueuesString(thread_max);
160  if (queues == NULL) {
161  FatalError("RunmodeAutoFpCreatePickupQueuesString failed");
162  }
163 
164  snprintf(tname, sizeof(tname), "%s#01", thread_name_autofp);
165 
166  /* create the threads */
167  ThreadVars *tv_receivepcap =
169  "packetpool", "packetpool",
170  queues, "flow",
171  "pktacqloop");
172  SCFree(queues);
173 
174  if (tv_receivepcap == NULL) {
175  FatalError("threading setup failed");
176  }
177  TmModule *tm_module = TmModuleGetByName("ReceivePcapFile");
178  if (tm_module == NULL) {
179  FatalError("TmModuleGetByName failed for ReceivePcap");
180  }
181  TmSlotSetFuncAppend(tv_receivepcap, tm_module, file);
182 
183  tm_module = TmModuleGetByName("DecodePcapFile");
184  if (tm_module == NULL) {
185  FatalError("TmModuleGetByName DecodePcap failed");
186  }
187  TmSlotSetFuncAppend(tv_receivepcap, tm_module, NULL);
188 
189  TmThreadSetCPU(tv_receivepcap, RECEIVE_CPU_SET);
190 
191  if (TmThreadSpawn(tv_receivepcap) != TM_ECODE_OK) {
192  FatalError("TmThreadSpawn failed");
193  }
194 
195  for (thread = 0; thread < (uint16_t)thread_max; thread++) {
196  snprintf(tname, sizeof(tname), "%s#%02d", thread_name_workers, thread + 1);
197  snprintf(qname, sizeof(qname), "pickup%d", thread + 1);
198 
199  SCLogDebug("tname %s, qname %s", tname, qname);
200  SCLogDebug("Assigning %s affinity to cpu %u", tname, cpu);
201 
202  ThreadVars *tv_detect_ncpu =
204  qname, "flow",
205  "packetpool", "packetpool",
206  "varslot");
207  if (tv_detect_ncpu == NULL) {
208  FatalError("TmThreadsCreate failed");
209  }
210 
211  tm_module = TmModuleGetByName("FlowWorker");
212  if (tm_module == NULL) {
213  FatalError("TmModuleGetByName for FlowWorker failed");
214  }
215  TmSlotSetFuncAppend(tv_detect_ncpu, tm_module, NULL);
216 
217  TmThreadSetGroupName(tv_detect_ncpu, "Detect");
218 
219  TmThreadSetCPU(tv_detect_ncpu, WORKER_CPU_SET);
220 
221  if (TmThreadSpawn(tv_detect_ncpu) != TM_ECODE_OK) {
222  FatalError("TmThreadSpawn failed");
223  }
224 
225  if ((cpu + 1) == ncpus)
226  cpu = 0;
227  else
228  cpu++;
229  }
230 
231  return 0;
232 }
thread_name_workers
const char * thread_name_workers
Definition: runmodes.c:81
tm-threads.h
TmThreadSpawn
TmEcode TmThreadSpawn(ThreadVars *tv)
Spawns a thread associated with the ThreadVars instance tv.
Definition: tm-threads.c:1651
detect-engine.h
source-pcap-file.h
TmThreadCreatePacketHandler
ThreadVars * TmThreadCreatePacketHandler(const char *name, const char *inq_name, const char *inqh_name, const char *outq_name, const char *outqh_name, const char *slots)
Creates and returns a TV instance for a Packet Processing Thread. This function doesn't support custo...
Definition: tm-threads.c:1035
TmThreadSetGroupName
void TmThreadSetGroupName(ThreadVars *tv, const char *name)
Definition: tm-threads.c:1608
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
RunModeFilePcapGetDefaultMode
const char * RunModeFilePcapGetDefaultMode(void)
Definition: runmode-pcap-file.c:35
util-runmodes.h
thread_name_autofp
const char * thread_name_autofp
Definition: runmodes.c:79
RunModeRegisterNewRunMode
void RunModeRegisterNewRunMode(enum RunModes runmode, const char *name, const char *description, int(*RunModeFunc)(void), void(*RunModeIsIPSEnabled)(void))
Registers a new runmode.
Definition: runmodes.c:491
thread_name_single
const char * thread_name_single
Definition: runmodes.c:80
WORKER_CPU_SET
@ WORKER_CPU_SET
Definition: util-affinity.h:53
TM_THREAD_NAME_MAX
#define TM_THREAD_NAME_MAX
Definition: tm-threads.h:49
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:84
TmModuleGetByName
TmModule * TmModuleGetByName(const char *name)
get a tm module ptr by name
Definition: tm-modules.c:53
ConfGet
int ConfGet(const char *name, const char **vptr)
Retrieve the value of a configuration node.
Definition: conf.c:335
util-debug.h
RunmodeAutoFpCreatePickupQueuesString
char * RunmodeAutoFpCreatePickupQueuesString(int n)
create a queue string for autofp to pass to the flow queue handler.
Definition: util-runmodes.c:56
util-cpu.h
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
util-affinity.h
util-time.h
TM_QUEUE_NAME_MAX
#define TM_QUEUE_NAME_MAX
Definition: tm-threads.h:48
conf.h
runmode-pcap-file.h
runmodes.h
TmModule_
Definition: tm-modules.h:43
RECEIVE_CPU_SET
@ RECEIVE_CPU_SET
Definition: util-affinity.h:52
TmSlotSetFuncAppend
void TmSlotSetFuncAppend(ThreadVars *tv, TmModule *tm, const void *data)
Appends a new entry to the slots.
Definition: tm-threads.c:640
TimeModeSetOffline
void TimeModeSetOffline(void)
Definition: util-time.c:105
suricata-common.h
TmThreadSetCPU
TmEcode TmThreadSetCPU(ThreadVars *tv, uint8_t type)
Definition: tm-threads.c:814
TmThreadGetNbThreads
int TmThreadGetNbThreads(uint8_t type)
Definition: tm-threads.c:830
RunModeFilePcapSingle
int RunModeFilePcapSingle(void)
Single thread version of the Pcap file processing.
Definition: runmode-pcap-file.c:58
RunModeFilePcapRegister
void RunModeFilePcapRegister(void)
Definition: runmode-pcap-file.c:40
FatalError
#define FatalError(...)
Definition: util-debug.h:502
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
SCFree
#define SCFree(p)
Definition: util-mem.h:61
PcapFileGlobalInit
void PcapFileGlobalInit(void)
Definition: source-pcap-file.c:138
UtilCpuGetNumProcessorsOnline
uint16_t UtilCpuGetNumProcessorsOnline(void)
Get the number of cpus online in the system.
Definition: util-cpu.c:108
RUNMODE_PCAP_FILE
@ RUNMODE_PCAP_FILE
Definition: runmodes.h:30
threading_detect_ratio
float threading_detect_ratio
Definition: runmodes.c:978
output.h
RunModeFilePcapAutoFp
int RunModeFilePcapAutoFp(void)
RunModeFilePcapAutoFp set up the following thread packet handlers:
Definition: runmode-pcap-file.c:123