suricata
runmode-af-packet.c
Go to the documentation of this file.
1 /* Copyright (C) 2011-2024 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 /**
19  * \ingroup afppacket
20  *
21  * @{
22  */
23 
24 /**
25  * \file
26  *
27  * \author Eric Leblond <eric@regit.org>
28  *
29  * AF_PACKET socket runmode
30  *
31  */
32 
33 #include "suricata-common.h"
34 #include "suricata.h"
35 #include "tm-threads.h"
36 #include "conf.h"
37 #include "runmodes.h"
38 #include "runmode-af-packet.h"
39 #include "output.h"
40 #include "log-httplog.h"
41 #include "detect-engine-mpm.h"
42 
43 #include "alert-fastlog.h"
44 #include "alert-debuglog.h"
45 
46 #include "flow-bypass.h"
47 
48 #include "util-conf.h"
49 #include "util-debug.h"
50 #include "util-time.h"
51 #include "util-cpu.h"
52 #include "util-affinity.h"
53 #include "util-device.h"
54 #include "util-runmodes.h"
55 #include "util-ioctl.h"
56 #include "util-ebpf.h"
57 #include "util-byte.h"
58 
59 #include "source-af-packet.h"
60 #include "util-bpf.h"
61 
62 extern uint32_t max_pending_packets;
63 
64 const char *RunModeAFPGetDefaultMode(void)
65 {
66  return "workers";
67 }
68 
69 static bool AFPRunModeIsIPS(void)
70 {
71  int nlive = LiveGetDeviceCount();
72  bool has_ips = false;
73  bool has_ids = false;
74 
75  ConfNode *af_packet_node = ConfGetNode("af-packet");
76  if (af_packet_node == NULL) {
77  SCLogConfig("no 'af-packet' section in the yaml, default to IDS");
78  return false;
79  }
80 
81  ConfNode *if_default = ConfNodeLookupKeyValue(af_packet_node, "interface", "default");
82 
83  for (int ldev = 0; ldev < nlive; ldev++) {
84  const char *live_dev = LiveGetDeviceName(ldev);
85  if (live_dev == NULL) {
86  SCLogConfig("invalid livedev at index %d, default to IDS", ldev);
87  return false;
88  }
89  ConfNode *if_root = ConfFindDeviceConfig(af_packet_node, live_dev);
90  if (if_root == NULL) {
91  if (if_default == NULL) {
93  "no 'af-packet' section for '%s' or 'default' in the yaml, default to IDS",
94  live_dev);
95  return false;
96  }
97  if_root = if_default;
98  }
99 
100  const char *copymodestr = NULL;
101  const char *copyifacestr = NULL;
102  if (ConfGetChildValueWithDefault(if_root, if_default, "copy-mode", &copymodestr) == 1 &&
103  ConfGetChildValue(if_root, "copy-iface", &copyifacestr) == 1) {
104  if (strcmp(copymodestr, "ips") == 0) {
105  has_ips = true;
106  } else {
107  has_ids = true;
108  }
109  } else {
110  has_ids = true;
111  }
112  }
113 
114  if (has_ids && has_ips) {
115  SCLogError("using both IPS and TAP/IDS mode is not allowed due to undefined behavior. See "
116  "ticket #5588.");
117  return false;
118  }
119 
120  return has_ips;
121 }
122 
123 static int AFPRunModeEnableIPS(void)
124 {
125  bool r = AFPRunModeIsIPS();
126  if (r) {
127  SCLogInfo("Setting IPS mode");
129  }
130  return r;
131 }
132 
134 {
135  RunModeRegisterNewRunMode(RUNMODE_AFP_DEV, "single", "Single threaded af-packet mode",
136  RunModeIdsAFPSingle, AFPRunModeEnableIPS);
138  "Workers af-packet mode, each thread does all"
139  " tasks from acquisition to logging",
140  RunModeIdsAFPWorkers, AFPRunModeEnableIPS);
142  "Multi socket AF_PACKET mode. Packets from "
143  "each flow are assigned to a single detect "
144  "thread.",
145  RunModeIdsAFPAutoFp, AFPRunModeEnableIPS);
146 }
147 
148 
149 #ifdef HAVE_AF_PACKET
150 
151 static void AFPDerefConfig(void *conf)
152 {
153  AFPIfaceConfig *pfp = (AFPIfaceConfig *)conf;
154  /* Pcap config is used only once but cost of this low. */
155  if (SC_ATOMIC_SUB(pfp->ref, 1) == 1) {
156  SCFree(pfp);
157  }
158 }
159 
160 /* if cluster id is not set, assign it automagically, uniq value per
161  * interface. */
162 static int cluster_id_auto = 1;
163 
164 /**
165  * \brief extract information from config file
166  *
167  * The returned structure will be freed by the thread init function.
168  * This is thus necessary to or copy the structure before giving it
169  * to thread or to reparse the file for each thread (and thus have
170  * new structure.
171  *
172  * \return a AFPIfaceConfig corresponding to the interface name
173  */
174 static void *ParseAFPConfig(const char *iface)
175 {
176  const char *threadsstr = NULL;
177  ConfNode *if_root;
178  ConfNode *if_default = NULL;
179  ConfNode *af_packet_node;
180  const char *tmpclusterid;
181  const char *tmpctype;
182  const char *copymodestr;
183  intmax_t value;
184  int boolval;
185  const char *out_iface = NULL;
186  int cluster_type = PACKET_FANOUT_HASH;
187  const char *ebpf_file = NULL;
188  const char *active_runmode = RunmodeGetActive();
189 
190  if (iface == NULL) {
191  return NULL;
192  }
193 
194  AFPIfaceConfig *aconf = SCCalloc(1, sizeof(*aconf));
195  if (unlikely(aconf == NULL)) {
196  return NULL;
197  }
198 
199  strlcpy(aconf->iface, iface, sizeof(aconf->iface));
200  aconf->threads = 0;
201  SC_ATOMIC_INIT(aconf->ref);
202  (void) SC_ATOMIC_ADD(aconf->ref, 1);
203  aconf->buffer_size = 0;
204  aconf->cluster_id = 1;
205  aconf->cluster_type = cluster_type | PACKET_FANOUT_FLAG_DEFRAG;
206  aconf->promisc = 1;
208  aconf->DerefFunc = AFPDerefConfig;
209  aconf->flags = 0;
210  aconf->bpf_filter = NULL;
211  aconf->ebpf_lb_file = NULL;
212  aconf->ebpf_lb_fd = -1;
213  aconf->ebpf_filter_file = NULL;
214  aconf->ebpf_filter_fd = -1;
215  aconf->out_iface = NULL;
216  aconf->copy_mode = AFP_COPY_MODE_NONE;
217  aconf->block_timeout = 10;
218  aconf->block_size = getpagesize() << AFP_BLOCK_SIZE_DEFAULT_ORDER;
219 #ifdef HAVE_PACKET_EBPF
220  aconf->ebpf_t_config.cpus_count = UtilCpuGetNumProcessorsConfigured();
221 #endif
222 
223  /* Find initial node */
224  af_packet_node = ConfGetNode("af-packet");
225  if (af_packet_node == NULL) {
226  SCLogInfo("%s: unable to find af-packet config using default values", iface);
227  goto finalize;
228  }
229 
230  if_root = ConfFindDeviceConfig(af_packet_node, iface);
231  if_default = ConfFindDeviceConfig(af_packet_node, "default");
232 
233  if (if_root == NULL && if_default == NULL) {
234  SCLogInfo("%s: unable to find af-packet config for "
235  "interface \"%s\" or \"default\", using default values",
236  iface, iface);
237  goto finalize;
238  }
239 
240  /* If there is no setting for current interface use default one as main iface */
241  if (if_root == NULL) {
242  if_root = if_default;
243  if_default = NULL;
244  }
245 
246  if (active_runmode && !strcmp("single", active_runmode)) {
247  aconf->threads = 1;
248  } else if (ConfGetChildValueWithDefault(if_root, if_default, "threads", &threadsstr) != 1) {
249  aconf->threads = 0;
250  } else {
251  if (threadsstr != NULL) {
252  if (strcmp(threadsstr, "auto") == 0) {
253  aconf->threads = 0;
254  } else {
255  if (StringParseInt32(&aconf->threads, 10, 0, (const char *)threadsstr) < 0) {
256  SCLogWarning("%s: invalid number of "
257  "threads, resetting to default",
258  iface);
259  aconf->threads = 0;
260  }
261  }
262  }
263  }
264 
265  if (ConfGetChildValueWithDefault(if_root, if_default, "copy-iface", &out_iface) == 1) {
266  if (out_iface != NULL) {
267  if (strlen(out_iface) > 0) {
268  aconf->out_iface = out_iface;
269  if (strcmp(iface, out_iface) == 0) {
270  FatalError(
271  "Invalid config: interface (%s) and copy-iface (%s) can't be the same",
272  iface, out_iface);
273  }
274  }
275  } else {
276  SCLogWarning("copy-iface corresponding to %s interface cannot be NULL", iface);
277  }
278  }
279 
280  if (ConfGetChildValueBoolWithDefault(if_root, if_default, "use-mmap", &boolval) == 1) {
281  if (!boolval) {
282  SCLogWarning(
283  "%s: \"use-mmap\" option is obsolete: mmap is always enabled", aconf->iface);
284  }
285  }
286 
287  (void)ConfGetChildValueBoolWithDefault(if_root, if_default, "mmap-locked", &boolval);
288  if (boolval) {
289  SCLogConfig("%s: enabling locked memory for mmap", aconf->iface);
290  aconf->flags |= AFP_MMAP_LOCKED;
291  }
292 
293  if (ConfGetChildValueBoolWithDefault(if_root, if_default, "tpacket-v3", &boolval) == 1) {
294  if (boolval) {
295  if (strcasecmp(RunmodeGetActive(), "workers") == 0) {
296 #ifdef HAVE_TPACKET_V3
297  SCLogConfig("%s: enabling tpacket v3", aconf->iface);
298  aconf->flags |= AFP_TPACKET_V3;
299 #else
300  SCLogWarning("%s: system too old for tpacket v3 switching to v2", iface);
301  aconf->flags &= ~AFP_TPACKET_V3;
302 #endif
303  } else {
304  SCLogWarning("%s: tpacket v3 is only implemented for 'workers' runmode."
305  " Switching to tpacket v2.",
306  iface);
307  aconf->flags &= ~AFP_TPACKET_V3;
308  }
309  } else {
310  aconf->flags &= ~AFP_TPACKET_V3;
311  }
312  }
313 
314  (void)ConfGetChildValueBoolWithDefault(if_root, if_default, "use-emergency-flush", &boolval);
315  if (boolval) {
316  SCLogConfig("%s: using emergency ring flush", aconf->iface);
317  aconf->flags |= AFP_EMERGENCY_MODE;
318  }
319 
320  if (ConfGetChildValueWithDefault(if_root, if_default, "copy-mode", &copymodestr) == 1) {
321  if (aconf->out_iface == NULL) {
322  SCLogWarning("%s: copy mode activated but no destination"
323  " iface. Disabling feature",
324  iface);
325  } else if (strlen(copymodestr) <= 0) {
326  aconf->out_iface = NULL;
327  } else if (strcmp(copymodestr, "ips") == 0) {
328  SCLogInfo("%s: AF_PACKET IPS mode activated %s->%s", iface, iface, aconf->out_iface);
329  aconf->copy_mode = AFP_COPY_MODE_IPS;
330  if (aconf->flags & AFP_TPACKET_V3) {
331  SCLogWarning("%s: using tpacket_v3 in IPS mode will result in high latency", iface);
332  }
333  } else if (strcmp(copymodestr, "tap") == 0) {
334  SCLogInfo("%s: AF_PACKET TAP mode activated %s->%s", iface, iface, aconf->out_iface);
335  aconf->copy_mode = AFP_COPY_MODE_TAP;
336  if (aconf->flags & AFP_TPACKET_V3) {
337  SCLogWarning("%s: using tpacket_v3 in TAP mode will result in high latency", iface);
338  }
339  } else {
340  SCLogWarning("Invalid 'copy-mode' (not in tap, ips)");
341  }
342  }
343 
344  if (ConfGetChildValueWithDefault(if_root, if_default, "cluster-id", &tmpclusterid) != 1) {
345  aconf->cluster_id = (uint16_t)(cluster_id_auto++);
346  } else {
347  if (StringParseUint16(&aconf->cluster_id, 10, 0, (const char *)tmpclusterid) < 0) {
348  SCLogWarning("%s: invalid cluster_id, resetting to 0", iface);
349  aconf->cluster_id = 0;
350  }
351  SCLogDebug("Going to use cluster-id %" PRIu16, aconf->cluster_id);
352  }
353 
354  if (ConfGetChildValueWithDefault(if_root, if_default, "cluster-type", &tmpctype) != 1) {
355  /* default to our safest choice: flow hashing + defrag enabled */
357  cluster_type = PACKET_FANOUT_HASH;
358  } else if (strcmp(tmpctype, "cluster_round_robin") == 0) {
359  SCLogConfig("%s: using round-robin cluster mode for AF_PACKET", aconf->iface);
361  cluster_type = PACKET_FANOUT_LB;
362  } else if (strcmp(tmpctype, "cluster_flow") == 0 || strcmp(tmpctype, "cluster_rollover") == 0) {
363  if (strcmp(tmpctype, "cluster_rollover") == 0) {
364  SCLogWarning("%s: cluster_rollover deprecated; using \"cluster_flow\" instead. See "
365  "ticket #6128",
366  aconf->iface);
367  }
368  /* In hash mode, we also ask for defragmentation needed to
369  * compute the hash */
370  uint16_t defrag = 0;
371  int conf_val = 0;
372  SCLogConfig("%s: using flow cluster mode for AF_PACKET", aconf->iface);
373  ConfGetChildValueBoolWithDefault(if_root, if_default, "defrag", &conf_val);
374  if (conf_val) {
375  SCLogConfig("%s: using defrag kernel functionality for AF_PACKET", aconf->iface);
376  defrag = PACKET_FANOUT_FLAG_DEFRAG;
377  }
378  aconf->cluster_type = PACKET_FANOUT_HASH | defrag;
379  cluster_type = PACKET_FANOUT_HASH;
380  } else if (strcmp(tmpctype, "cluster_cpu") == 0) {
381  SCLogConfig("%s: using cpu cluster mode for AF_PACKET", aconf->iface);
383  cluster_type = PACKET_FANOUT_CPU;
384  } else if (strcmp(tmpctype, "cluster_qm") == 0) {
385  SCLogConfig("%s: using queue based cluster mode for AF_PACKET", aconf->iface);
387  cluster_type = PACKET_FANOUT_QM;
388  } else if (strcmp(tmpctype, "cluster_random") == 0) {
389  SCLogConfig("%s: using random based cluster mode for AF_PACKET", aconf->iface);
391  cluster_type = PACKET_FANOUT_RND;
392 #ifdef HAVE_PACKET_EBPF
393  } else if (strcmp(tmpctype, "cluster_ebpf") == 0) {
394  SCLogInfo("%s: using ebpf based cluster mode for AF_PACKET", aconf->iface);
395  aconf->cluster_type = PACKET_FANOUT_EBPF;
396  cluster_type = PACKET_FANOUT_EBPF;
397 #endif
398  } else {
399  SCLogWarning("invalid cluster-type %s", tmpctype);
400  }
401 
402  int conf_val = 0;
403  ConfGetChildValueBoolWithDefault(if_root, if_default, "rollover", &conf_val);
404  if (conf_val) {
405  SCLogConfig("%s: Rollover requested for AF_PACKET but ignored -- see ticket #6128.",
406  aconf->iface);
407  SCLogWarning("%s: rollover option has been deprecated and will be ignored as it can cause "
408  "severe flow "
409  "tracking issues; see ticket #6128.",
410  iface);
411  }
412 
413  ConfSetBPFFilter(if_root, if_default, iface, &aconf->bpf_filter);
414 
415  if (ConfGetChildValueWithDefault(if_root, if_default, "ebpf-lb-file", &ebpf_file) != 1) {
416  aconf->ebpf_lb_file = NULL;
417  } else {
418 #ifdef HAVE_PACKET_EBPF
419  SCLogConfig("%s: af-packet will use '%s' as eBPF load balancing file", iface, ebpf_file);
420  aconf->ebpf_lb_file = ebpf_file;
421  aconf->ebpf_t_config.flags |= EBPF_SOCKET_FILTER;
422 #endif
423  }
424 
425 #ifdef HAVE_PACKET_EBPF
426  boolval = false;
427  if (ConfGetChildValueBoolWithDefault(if_root, if_default, "pinned-maps", &boolval) == 1) {
428  if (boolval) {
429  SCLogConfig("%s: using pinned maps", aconf->iface);
430  aconf->ebpf_t_config.flags |= EBPF_PINNED_MAPS;
431  }
432  const char *pinned_maps_name = NULL;
433  if (ConfGetChildValueWithDefault(if_root, if_default,
434  "pinned-maps-name",
435  &pinned_maps_name) != 1) {
436  aconf->ebpf_t_config.pinned_maps_name = pinned_maps_name;
437  } else {
438  aconf->ebpf_t_config.pinned_maps_name = NULL;
439  }
440  } else {
441  aconf->ebpf_t_config.pinned_maps_name = NULL;
442  }
443 #endif
444 
445 #ifdef HAVE_PACKET_EBPF
446  /* One shot loading of the eBPF file */
447  if (aconf->ebpf_lb_file && cluster_type == PACKET_FANOUT_EBPF) {
448  int ret = EBPFLoadFile(aconf->iface, aconf->ebpf_lb_file, "loadbalancer",
449  &aconf->ebpf_lb_fd,
450  &aconf->ebpf_t_config);
451  if (ret != 0) {
452  SCLogWarning("%s: failed to load eBPF lb file", iface);
453  }
454  }
455 #else
456  if (aconf->ebpf_lb_file) {
457  SCLogError("%s: eBPF support is not built-in", iface);
458  }
459 #endif
460 
461  if (ConfGetChildValueWithDefault(if_root, if_default, "ebpf-filter-file", &ebpf_file) != 1) {
462  aconf->ebpf_filter_file = NULL;
463  } else {
464 #ifdef HAVE_PACKET_EBPF
465  SCLogConfig("%s: af-packet will use '%s' as eBPF filter file", iface, ebpf_file);
466  aconf->ebpf_filter_file = ebpf_file;
467  aconf->ebpf_t_config.mode = AFP_MODE_EBPF_BYPASS;
468  aconf->ebpf_t_config.flags |= EBPF_SOCKET_FILTER;
469 #endif
470  ConfGetChildValueBoolWithDefault(if_root, if_default, "bypass", &conf_val);
471  if (conf_val) {
472 #ifdef HAVE_PACKET_EBPF
473  SCLogConfig("%s: using bypass kernel functionality for AF_PACKET", aconf->iface);
474  aconf->flags |= AFP_BYPASS;
475  BypassedFlowManagerRegisterUpdateFunc(EBPFUpdateFlow, NULL);
476 #else
477  SCLogError("%s: bypass set but eBPF support is not built-in", iface);
478 #endif
479  }
480  }
481 
482  /* One shot loading of the eBPF file */
483  if (aconf->ebpf_filter_file) {
484 #ifdef HAVE_PACKET_EBPF
485  int ret = EBPFLoadFile(aconf->iface, aconf->ebpf_filter_file, "filter",
486  &aconf->ebpf_filter_fd,
487  &aconf->ebpf_t_config);
488  if (ret != 0) {
489  SCLogWarning("%s: failed to load eBPF filter file", iface);
490  }
491 #else
492  SCLogError("%s: eBPF support is not built-in", iface);
493 #endif
494  }
495 
496  if (ConfGetChildValueWithDefault(if_root, if_default, "xdp-filter-file", &ebpf_file) != 1) {
497  aconf->xdp_filter_file = NULL;
498  } else {
499 #ifdef HAVE_PACKET_XDP
500  aconf->ebpf_t_config.mode = AFP_MODE_XDP_BYPASS;
501  aconf->ebpf_t_config.flags |= EBPF_XDP_CODE;
502  aconf->xdp_filter_file = ebpf_file;
503  ConfGetChildValueBoolWithDefault(if_root, if_default, "bypass", &conf_val);
504  if (conf_val) {
505  SCLogConfig("%s: using bypass kernel functionality for AF_PACKET", aconf->iface);
506  aconf->flags |= AFP_XDPBYPASS;
507  /* if maps are pinned we need to read them at start */
508  if (aconf->ebpf_t_config.flags & EBPF_PINNED_MAPS) {
510  struct ebpf_timeout_config *ebt = SCCalloc(1, sizeof(struct ebpf_timeout_config));
511  if (ebt == NULL) {
512  SCLogError("%s: flow bypass alloc error", iface);
513  } else {
514  memcpy(ebt, &(aconf->ebpf_t_config), sizeof(struct ebpf_timeout_config));
516  EBPFCheckBypassedFlowCreate,
517  (void *)ebt);
518  }
519  }
520  BypassedFlowManagerRegisterUpdateFunc(EBPFUpdateFlow, NULL);
521  }
522 #else
523  SCLogWarning("%s: XDP filter set but XDP support is not built-in", iface);
524 #endif
525 #ifdef HAVE_PACKET_XDP
526  const char *xdp_mode;
527  if (ConfGetChildValueWithDefault(if_root, if_default, "xdp-mode", &xdp_mode) != 1) {
528  aconf->xdp_mode = XDP_FLAGS_SKB_MODE;
529  } else {
530  if (!strcmp(xdp_mode, "soft")) {
531  aconf->xdp_mode = XDP_FLAGS_SKB_MODE;
532  } else if (!strcmp(xdp_mode, "driver")) {
533  aconf->xdp_mode = XDP_FLAGS_DRV_MODE;
534  } else if (!strcmp(xdp_mode, "hw")) {
535  aconf->xdp_mode = XDP_FLAGS_HW_MODE;
536  aconf->ebpf_t_config.flags |= EBPF_XDP_HW_MODE;
537  } else {
538  SCLogWarning("Invalid xdp-mode value: '%s'", xdp_mode);
539  }
540  }
541 
542  boolval = true;
543  if (ConfGetChildValueBoolWithDefault(if_root, if_default, "use-percpu-hash", &boolval) ==
544  1) {
545  if (!boolval) {
546  SCLogConfig("%s: not using percpu hash", aconf->iface);
547  aconf->ebpf_t_config.cpus_count = 1;
548  }
549  }
550 #endif
551  }
552 
553  /* One shot loading of the eBPF file */
554  if (aconf->xdp_filter_file) {
555 #ifdef HAVE_PACKET_XDP
556  int ret = EBPFLoadFile(aconf->iface, aconf->xdp_filter_file, "xdp",
557  &aconf->xdp_filter_fd,
558  &aconf->ebpf_t_config);
559  switch (ret) {
560  case 1:
561  SCLogInfo("%s: loaded pinned maps from sysfs", iface);
562  break;
563  case -1:
564  SCLogWarning("%s: failed to load XDP filter file", iface);
565  break;
566  case 0:
567  ret = EBPFSetupXDP(aconf->iface, aconf->xdp_filter_fd, aconf->xdp_mode);
568  if (ret != 0) {
569  SCLogWarning("%s: failed to set up XDP", iface);
570  } else {
571  /* Try to get the xdp-cpu-redirect key */
572  const char *cpuset;
573  if (ConfGetChildValueWithDefault(if_root, if_default,
574  "xdp-cpu-redirect", &cpuset) == 1) {
575  SCLogConfig("%s: Setting up CPU map XDP", iface);
576  ConfNode *node = ConfGetChildWithDefault(if_root, if_default, "xdp-cpu-redirect");
577  if (node == NULL) {
578  SCLogError("Previously found node has disappeared");
579  } else {
580  EBPFBuildCPUSet(node, aconf->iface);
581  }
582  } else {
583  /* It will just set CPU count to 0 */
584  EBPFBuildCPUSet(NULL, aconf->iface);
585  }
586  }
587  /* we have a peer and we use bypass so we can set up XDP iface redirect */
588  if (aconf->out_iface) {
589  EBPFSetPeerIface(aconf->iface, aconf->out_iface);
590  }
591  }
592 #else
593  SCLogError("%s: XDP support is not built-in", iface);
594 #endif
595  }
596 
597  if ((ConfGetChildValueIntWithDefault(if_root, if_default, "buffer-size", &value)) == 1) {
598  aconf->buffer_size = value;
599  } else {
600  aconf->buffer_size = 0;
601  }
602  if ((ConfGetChildValueIntWithDefault(if_root, if_default, "ring-size", &value)) == 1) {
603  aconf->ring_size = value;
604  }
605 
606  if ((ConfGetChildValueIntWithDefault(if_root, if_default, "block-size", &value)) == 1) {
607  if (value % getpagesize()) {
608  SCLogWarning("%s: block-size %" PRIuMAX " must be a multiple of pagesize (%u).", iface,
609  value, getpagesize());
610  } else {
611  aconf->block_size = value;
612  }
613  }
614 
615  if ((ConfGetChildValueIntWithDefault(if_root, if_default, "block-timeout", &value)) == 1) {
616  aconf->block_timeout = value;
617  } else {
618  aconf->block_timeout = 10;
619  }
620 
621  (void)ConfGetChildValueBoolWithDefault(if_root, if_default, "disable-promisc", &boolval);
622  if (boolval) {
623  SCLogConfig("%s: disabling promiscuous mode", aconf->iface);
624  aconf->promisc = 0;
625  }
626 
627  if (ConfGetChildValueWithDefault(if_root, if_default, "checksum-checks", &tmpctype) == 1) {
628  if (strcmp(tmpctype, "auto") == 0) {
630  } else if (ConfValIsTrue(tmpctype)) {
632  } else if (ConfValIsFalse(tmpctype)) {
634  } else if (strcmp(tmpctype, "kernel") == 0) {
636  } else {
637  SCLogWarning("%s: invalid value for checksum-checks", aconf->iface);
638  }
639  }
640 
641 finalize:
642 
643  /* if the number of threads is not 1, we need to first check if fanout
644  * functions on this system. */
645  if (aconf->threads != 1) {
646  if (AFPIsFanoutSupported(aconf->cluster_id) == 0) {
647  if (aconf->threads != 0) {
648  SCLogNotice("%s: fanout not supported on this system, falling "
649  "back to 1 capture thread",
650  iface);
651  }
652  aconf->threads = 1;
653  }
654  }
655 
656  /* try to automagically set the proper number of threads */
657  if (aconf->threads == 0) {
658  /* for cluster_flow use core count */
659  if (cluster_type == PACKET_FANOUT_HASH) {
660  aconf->threads = (int)UtilCpuGetNumProcessorsOnline();
661  SCLogPerf("%s: cluster_flow: %u cores, using %u threads", iface, aconf->threads,
662  aconf->threads);
663 
664  /* for cluster_qm use RSS queue count */
665  } else if (cluster_type == PACKET_FANOUT_QM) {
666  int rss_queues = GetIfaceRSSQueuesNum(iface);
667  if (rss_queues > 0) {
668  aconf->threads = rss_queues;
669  SCLogPerf("%s: cluster_qm: %d RSS queues, using %u threads", iface, rss_queues,
670  aconf->threads);
671  }
672  }
673 
674  if (aconf->threads) {
675  SCLogDebug("using %d threads for interface %s", aconf->threads, iface);
676  }
677  }
678  if (aconf->threads <= 0) {
679  aconf->threads = 1;
680  }
681  SC_ATOMIC_RESET(aconf->ref);
682  (void) SC_ATOMIC_ADD(aconf->ref, aconf->threads);
683 
684  if (aconf->ring_size != 0) {
685  if (aconf->ring_size * aconf->threads < (int)max_pending_packets) {
686  aconf->ring_size = max_pending_packets / aconf->threads + 1;
687  SCLogWarning("%s: inefficient setup: ring-size < max_pending_packets. "
688  "Resetting to decent value %d.",
689  iface, aconf->ring_size);
690  /* We want at least that max_pending_packets packets can be handled by the
691  * interface. This is generous if we have multiple interfaces listening. */
692  }
693  } else {
694  /* We want that max_pending_packets packets can be handled by suricata
695  * for this interface. To take burst into account we multiply the obtained
696  * size by 2. */
697  aconf->ring_size = max_pending_packets * 2 / aconf->threads;
698  }
699 
700  int ltype = AFPGetLinkType(iface);
701  switch (ltype) {
702  case LINKTYPE_ETHERNET:
703  /* af-packet can handle csum offloading */
704  if (LiveGetOffload() == 0) {
705  if (GetIfaceOffloading(iface, 0, 1) == 1) {
706  SCLogWarning(
707  "%s: using AF_PACKET with offloads enabled leads to capture problems",
708  iface);
709  }
710  } else {
712  }
713  break;
714  case -1:
715  default:
716  break;
717  }
718 
719  if (active_runmode == NULL || strcmp("workers", active_runmode) != 0) {
720  /* If we are using copy mode we need a lock */
721  aconf->flags |= AFP_SOCK_PROTECT;
722  aconf->flags |= AFP_NEED_PEER;
723  }
724  return aconf;
725 }
726 
727 static int AFPConfigGeThreadsCount(void *conf)
728 {
729  AFPIfaceConfig *afp = (AFPIfaceConfig *)conf;
730  return afp->threads;
731 }
732 
733 #endif /* HAVE_AF_PACKET */
734 
736 {
737  SCEnter();
738 
739 /* We include only if AF_PACKET is enabled */
740 #ifdef HAVE_AF_PACKET
741  int ret;
742  const char *live_dev = NULL;
743 
744  TimeModeSetLive();
745 
746  (void)ConfGet("af-packet.live-interface", &live_dev);
747 
748  SCLogDebug("live_dev %s", live_dev);
749 
750  if (AFPPeersListInit() != TM_ECODE_OK) {
751  FatalError("Unable to init peers list.");
752  }
753 
754  ret = RunModeSetLiveCaptureAutoFp(ParseAFPConfig, AFPConfigGeThreadsCount, "ReceiveAFP",
755  "DecodeAFP", thread_name_autofp, live_dev);
756  if (ret != 0) {
757  FatalError("Unable to start runmode");
758  }
759 
760  /* In IPS mode each threads must have a peer */
761  if (AFPPeersListCheck() != TM_ECODE_OK) {
762  FatalError("Some IPS capture threads did not peer.");
763  }
764 
765  SCLogDebug("RunModeIdsAFPAutoFp initialised");
766 #endif /* HAVE_AF_PACKET */
767 
768  SCReturnInt(0);
769 }
770 
771 /**
772  * \brief Single thread version of the AF_PACKET processing.
773  */
775 {
776  SCEnter();
777 #ifdef HAVE_AF_PACKET
778  int ret;
779  const char *live_dev = NULL;
780 
781  TimeModeSetLive();
782 
783  (void)ConfGet("af-packet.live-interface", &live_dev);
784 
785  if (AFPPeersListInit() != TM_ECODE_OK) {
786  FatalError("Unable to init peers list.");
787  }
788 
789  ret = RunModeSetLiveCaptureSingle(ParseAFPConfig,
790  AFPConfigGeThreadsCount,
791  "ReceiveAFP",
792  "DecodeAFP", thread_name_single,
793  live_dev);
794  if (ret != 0) {
795  FatalError("Unable to start runmode");
796  }
797 
798  /* In IPS mode each threads must have a peer */
799  if (AFPPeersListCheck() != TM_ECODE_OK) {
800  FatalError("Some IPS capture threads did not peer.");
801  }
802 
803  SCLogDebug("RunModeIdsAFPSingle initialised");
804 
805 #endif /* HAVE_AF_PACKET */
806  SCReturnInt(0);
807 }
808 
809 /**
810  * \brief Workers version of the AF_PACKET processing.
811  *
812  * Start N threads with each thread doing all the work.
813  *
814  */
816 {
817  SCEnter();
818 #ifdef HAVE_AF_PACKET
819  int ret;
820  const char *live_dev = NULL;
821 
822  TimeModeSetLive();
823 
824  (void)ConfGet("af-packet.live-interface", &live_dev);
825 
826  if (AFPPeersListInit() != TM_ECODE_OK) {
827  FatalError("Unable to init peers list.");
828  }
829 
830  ret = RunModeSetLiveCaptureWorkers(ParseAFPConfig, AFPConfigGeThreadsCount, "ReceiveAFP",
831  "DecodeAFP", thread_name_workers, live_dev);
832  if (ret != 0) {
833  FatalError("Unable to start runmode");
834  }
835 
836  /* In IPS mode each threads must have a peer */
837  if (AFPPeersListCheck() != TM_ECODE_OK) {
838  FatalError("Some IPS capture threads did not peer.");
839  }
840 
841  SCLogDebug("RunModeIdsAFPWorkers initialised");
842 
843 #endif /* HAVE_AF_PACKET */
844  SCReturnInt(0);
845 }
846 
847 /**
848  * @}
849  */
thread_name_workers
const char * thread_name_workers
Definition: runmodes.c:66
AFPIfaceConfig_::promisc
int promisc
Definition: source-af-packet.h:97
util-byte.h
tm-threads.h
AFPIfaceConfig_::checksum_mode
ChecksumValidationMode checksum_mode
Definition: source-af-packet.h:101
PACKET_FANOUT_FLAG_DEFRAG
#define PACKET_FANOUT_FLAG_DEFRAG
Definition: source-af-packet.h:40
RunModeIdsAFPWorkers
int RunModeIdsAFPWorkers(void)
Workers version of the AF_PACKET processing.
Definition: runmode-af-packet.c:815
flow-bypass.h
AFPIfaceConfig_::xdp_mode
uint8_t xdp_mode
Definition: source-af-packet.h:109
AFP_BYPASS
#define AFP_BYPASS
Definition: source-af-packet.h:65
RunModeSetLiveCaptureWorkers
int RunModeSetLiveCaptureWorkers(ConfigIfaceParserFunc ConfigParser, ConfigIfaceThreadsCountFunc ModThreadsCount, const char *recv_mod_name, const char *decode_mod_name, const char *thread_name, const char *live_dev)
Definition: util-runmodes.c:321
alert-debuglog.h
SC_ATOMIC_INIT
#define SC_ATOMIC_INIT(name)
wrapper for initializing an atomic variable.
Definition: util-atomic.h:314
AFP_COPY_MODE_NONE
#define AFP_COPY_MODE_NONE
Definition: source-af-packet.h:68
RunModeIdsAFPSingle
int RunModeIdsAFPSingle(void)
Single thread version of the AF_PACKET processing.
Definition: runmode-af-packet.c:774
runmode-af-packet.h
util-bpf.h
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
RunModeIdsAFPRegister
void RunModeIdsAFPRegister(void)
Definition: runmode-af-packet.c:133
ConfGetChildValueBoolWithDefault
int ConfGetChildValueBoolWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name, int *val)
Definition: conf.c:513
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
LiveGetOffload
int LiveGetOffload(void)
Definition: util-device.c:81
AFPIfaceConfig_::ebpf_filter_fd
int ebpf_filter_fd
Definition: source-af-packet.h:106
ConfGetNode
ConfNode * ConfGetNode(const char *name)
Get a ConfNode by name.
Definition: conf.c:181
PACKET_FANOUT_RND
#define PACKET_FANOUT_RND
Definition: source-af-packet.h:36
UtilCpuGetNumProcessorsConfigured
uint16_t UtilCpuGetNumProcessorsConfigured(void)
Get the number of cpus configured in the system.
Definition: util-cpu.c:59
AFP_SOCK_PROTECT
#define AFP_SOCK_PROTECT
Definition: source-af-packet.h:60
PACKET_FANOUT_HASH
#define PACKET_FANOUT_HASH
Definition: source-af-packet.h:32
AFPPeersListInit
TmEcode AFPPeersListInit(void)
Init the global list of AFPPeer.
Definition: source-af-packet.c:451
SC_ATOMIC_ADD
#define SC_ATOMIC_ADD(name, val)
add a value to our atomic variable
Definition: util-atomic.h:332
RunModeAFPGetDefaultMode
const char * RunModeAFPGetDefaultMode(void)
Definition: runmode-af-packet.c:64
StringParseUint16
int StringParseUint16(uint16_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:337
PACKET_FANOUT_QM
#define PACKET_FANOUT_QM
Definition: source-af-packet.h:37
AFPIfaceConfig_::threads
int threads
Definition: source-af-packet.h:84
util-runmodes.h
AFPIfaceConfig_::ring_size
int ring_size
Definition: source-af-packet.h:88
thread_name_autofp
const char * thread_name_autofp
Definition: runmodes.c:64
AFPIfaceConfig_::block_timeout
int block_timeout
Definition: source-af-packet.h:92
ConfNodeLookupKeyValue
ConfNode * ConfNodeLookupKeyValue(const ConfNode *base, const char *key, const char *value)
Lookup for a key value under a specific node.
Definition: conf.c:826
CHECKSUM_VALIDATION_DISABLE
@ CHECKSUM_VALIDATION_DISABLE
Definition: decode.h:42
AFPIfaceConfig_::out_iface
const char * out_iface
Definition: source-af-packet.h:110
CHECKSUM_VALIDATION_KERNEL
@ CHECKSUM_VALIDATION_KERNEL
Definition: decode.h:46
AFP_XDPBYPASS
#define AFP_XDPBYPASS
Definition: source-af-packet.h:66
RunmodeGetActive
char * RunmodeGetActive(void)
Definition: runmodes.c:194
AFPIfaceConfig_::flags
unsigned int flags
Definition: source-af-packet.h:99
StringParseInt32
int StringParseInt32(int32_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:622
AFPIfaceConfig_::xdp_filter_fd
int xdp_filter_fd
Definition: source-af-packet.h:108
ConfGetChildValueIntWithDefault
int ConfGetChildValueIntWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name, intmax_t *val)
Definition: conf.c:461
thread_name_single
const char * thread_name_single
Definition: runmodes.c:65
ConfGetChildWithDefault
ConfNode * ConfGetChildWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name)
Definition: conf.c:364
AFPGetLinkType
int AFPGetLinkType(const char *ifname)
Definition: source-af-packet.c:1530
AFPPeersListCheck
TmEcode AFPPeersListCheck(void)
Check that all AFPPeer got a peer.
Definition: source-af-packet.c:468
ConfValIsTrue
int ConfValIsTrue(const char *val)
Check if a value is true.
Definition: conf.c:536
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:80
AFP_BLOCK_SIZE_DEFAULT_ORDER
#define AFP_BLOCK_SIZE_DEFAULT_ORDER
Definition: source-af-packet.h:78
AFPIfaceConfig_::cluster_type
int cluster_type
Definition: source-af-packet.h:95
AFPIfaceConfig_::cluster_id
uint16_t cluster_id
Definition: source-af-packet.h:94
strlcpy
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: util-strlcpyu.c:43
RunModeSetLiveCaptureAutoFp
int RunModeSetLiveCaptureAutoFp(ConfigIfaceParserFunc ConfigParser, ConfigIfaceThreadsCountFunc ModThreadsCount, const char *recv_mod_name, const char *decode_mod_name, const char *thread_name, const char *live_dev)
Definition: util-runmodes.c:85
AFPIfaceConfig_::block_size
int block_size
Definition: source-af-packet.h:90
CHECKSUM_VALIDATION_ENABLE
@ CHECKSUM_VALIDATION_ENABLE
Definition: decode.h:43
ConfGet
int ConfGet(const char *name, const char **vptr)
Retrieve the value of a configuration node.
Definition: conf.c:335
CHECKSUM_VALIDATION_AUTO
@ CHECKSUM_VALIDATION_AUTO
Definition: decode.h:44
util-device.h
util-debug.h
AFPIfaceConfig_::ebpf_lb_fd
int ebpf_lb_fd
Definition: source-af-packet.h:104
AFP_MMAP_LOCKED
#define AFP_MMAP_LOCKED
Definition: source-af-packet.h:64
util-cpu.h
AFPIfaceConfig_::ebpf_filter_file
const char * ebpf_filter_file
Definition: source-af-packet.h:105
RunModeRegisterNewRunMode
void RunModeRegisterNewRunMode(enum RunModes runmode, const char *name, const char *description, int(*RunModeFunc)(void), int(*RunModeIsIPSEnabled)(void))
Registers a new runmode.
Definition: runmodes.c:466
PACKET_FANOUT_LB
#define PACKET_FANOUT_LB
Definition: source-af-packet.h:33
RunModeEnablesBypassManager
void RunModeEnablesBypassManager(void)
Definition: runmodes.c:445
LiveGetDevice
LiveDevice * LiveGetDevice(const char *name)
Get a pointer to the device at idx.
Definition: util-device.c:248
GetIfaceRSSQueuesNum
int GetIfaceRSSQueuesNum(const char *dev)
Definition: util-ioctl.c:709
ConfFindDeviceConfig
ConfNode * ConfFindDeviceConfig(ConfNode *node, const char *iface)
Find the configuration node for a specific device.
Definition: util-conf.c:121
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect-engine-mpm.h
util-ebpf.h
util-affinity.h
PACKET_FANOUT_CPU
#define PACKET_FANOUT_CPU
Definition: source-af-packet.h:34
EngineModeSetIPS
void EngineModeSetIPS(void)
Definition: suricata.c:244
ConfGetChildValueWithDefault
int ConfGetChildValueWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name, const char **vptr)
Definition: conf.c:378
util-time.h
AFPIfaceConfig_::DerefFunc
void(* DerefFunc)(void *)
Definition: source-af-packet.h:115
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
AFP_COPY_MODE_TAP
#define AFP_COPY_MODE_TAP
Definition: source-af-packet.h:69
SC_ATOMIC_SUB
#define SC_ATOMIC_SUB(name, val)
sub a value from our atomic variable
Definition: util-atomic.h:341
conf.h
GetIfaceOffloading
int GetIfaceOffloading(const char *dev, int csum, int other)
output offloading status of the link
Definition: util-ioctl.c:666
DisableIfaceOffloading
int DisableIfaceOffloading(LiveDevice *dev, int csum, int other)
Definition: util-ioctl.c:679
runmodes.h
SCLogInfo
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
Definition: util-debug.h:224
AFP_NEED_PEER
#define AFP_NEED_PEER
Definition: source-af-packet.h:58
max_pending_packets
uint32_t max_pending_packets
Definition: suricata.c:180
ConfGetChildValue
int ConfGetChildValue(const ConfNode *base, const char *name, const char **vptr)
Definition: conf.c:348
TimeModeSetLive
void TimeModeSetLive(void)
Definition: util-time.c:99
alert-fastlog.h
util-conf.h
suricata-common.h
ConfSetBPFFilter
void ConfSetBPFFilter(ConfNode *if_root, ConfNode *if_default, const char *iface, const char **bpf_filter)
Definition: util-bpf.c:30
LiveGetDeviceName
const char * LiveGetDeviceName(int number)
Get a pointer to the device name at idx.
Definition: util-device.c:184
SCLogPerf
#define SCLogPerf(...)
Definition: util-debug.h:230
AFPIfaceConfig_::xdp_filter_file
const char * xdp_filter_file
Definition: source-af-packet.h:107
AFP_TPACKET_V3
#define AFP_TPACKET_V3
Definition: source-af-packet.h:62
FatalError
#define FatalError(...)
Definition: util-debug.h:502
log-httplog.h
RunModeIdsAFPAutoFp
int RunModeIdsAFPAutoFp(void)
Definition: runmode-af-packet.c:735
SC_ATOMIC_RESET
#define SC_ATOMIC_RESET(name)
wrapper for reinitializing an atomic variable.
Definition: util-atomic.h:323
BypassedFlowManagerRegisterUpdateFunc
int BypassedFlowManagerRegisterUpdateFunc(BypassedUpdateFunc UpdateFunc, void *data)
source-af-packet.h
SCLogConfig
struct SCLogConfig_ SCLogConfig
Holds the config state used by the logging api.
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
SCFree
#define SCFree(p)
Definition: util-mem.h:61
AFP_COPY_MODE_IPS
#define AFP_COPY_MODE_IPS
Definition: source-af-packet.h:70
ConfNode_
Definition: conf.h:32
AFPIfaceConfig_::buffer_size
int buffer_size
Definition: source-af-packet.h:86
util-ioctl.h
ConfValIsFalse
int ConfValIsFalse(const char *val)
Check if a value is false.
Definition: conf.c:561
RunModeSetLiveCaptureSingle
int RunModeSetLiveCaptureSingle(ConfigIfaceParserFunc ConfigParser, ConfigIfaceThreadsCountFunc ModThreadsCount, const char *recv_mod_name, const char *decode_mod_name, const char *thread_name, const char *live_dev)
Definition: util-runmodes.c:350
AFPIfaceConfig_::iface
char iface[AFP_IFACE_NAME_LENGTH]
Definition: source-af-packet.h:82
suricata.h
AFPIfaceConfig_::copy_mode
uint8_t copy_mode
Definition: source-af-packet.h:100
AFPIfaceConfig_
Definition: source-af-packet.h:81
AFPIfaceConfig_::bpf_filter
const char * bpf_filter
Definition: source-af-packet.h:102
LiveGetDeviceCount
int LiveGetDeviceCount(void)
Get the number of registered devices.
Definition: util-device.c:164
UtilCpuGetNumProcessorsOnline
uint16_t UtilCpuGetNumProcessorsOnline(void)
Get the number of cpus online in the system.
Definition: util-cpu.c:108
AFPIfaceConfig_::ebpf_lb_file
const char * ebpf_lb_file
Definition: source-af-packet.h:103
SCLogNotice
#define SCLogNotice(...)
Macro used to log NOTICE messages.
Definition: util-debug.h:237
BypassedFlowManagerRegisterCheckFunc
int BypassedFlowManagerRegisterCheckFunc(BypassedCheckFunc CheckFunc, BypassedCheckFuncInit CheckFuncInit, void *data)
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
RUNMODE_AFP_DEV
@ RUNMODE_AFP_DEV
Definition: runmodes.h:36
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:275
AFPIsFanoutSupported
int AFPIsFanoutSupported(uint16_t cluster_id)
test if we can use FANOUT. Older kernels like those in CentOS6 have HAVE_PACKET_FANOUT defined but fa...
Definition: source-af-packet.c:1809
output.h
LINKTYPE_ETHERNET
#define LINKTYPE_ETHERNET
Definition: decode.h:1233
AFP_EMERGENCY_MODE
#define AFP_EMERGENCY_MODE
Definition: source-af-packet.h:61