Go to the documentation of this file.
69 static int AFPRunModeIsIPS(
void)
81 if (af_packet_node == NULL) {
87 for (ldev = 0; ldev < nlive; ldev++) {
89 if (live_dev == NULL) {
93 const char *copymodestr = NULL;
96 if (if_root == NULL) {
97 if (if_default == NULL) {
101 if_root = if_default;
105 if (strcmp(copymodestr,
"ips") == 0) {
115 if (has_ids && has_ips) {
116 SCLogWarning(
"AF_PACKET using both IPS and TAP/IDS mode, this will not "
117 "be allowed in Suricata 8 due to undefined behavior. See ticket #5588.");
118 for (ldev = 0; ldev < nlive; ldev++) {
120 if (live_dev == NULL) {
125 const char *copymodestr = NULL;
127 if (if_root == NULL) {
128 if (if_default == NULL) {
132 if_root = if_default;
137 (strcmp(copymodestr,
"ips") == 0))) {
138 SCLogError(
"AF_PACKET IPS mode used and interface '%s' is in IDS or TAP mode. "
139 "Sniffing '%s' but expect bad result as stream-inline is activated.",
148 static void AFPRunModeEnableIPS(
void)
150 if (AFPRunModeIsIPS()) {
161 "Workers af-packet mode, each thread does all"
162 " tasks from acquisition to logging",
165 "Multi socket AF_PACKET mode. Packets from "
166 "each flow are assigned to a single detect "
173 #ifdef HAVE_AF_PACKET
175 static void AFPDerefConfig(
void *conf)
186 static int cluster_id_auto = 1;
198 static void *ParseAFPConfig(
const char *iface)
200 const char *threadsstr = NULL;
204 const char *tmpclusterid;
205 const char *tmpctype;
206 const char *copymodestr;
209 const char *out_iface = NULL;
211 const char *ebpf_file = NULL;
243 #ifdef HAVE_PACKET_EBPF
249 if (af_packet_node == NULL) {
250 SCLogInfo(
"%s: unable to find af-packet config using default values", iface);
257 if (if_root == NULL && if_default == NULL) {
258 SCLogInfo(
"%s: unable to find af-packet config for "
259 "interface \"%s\" or \"default\", using default values",
265 if (if_root == NULL) {
266 if_root = if_default;
270 if (active_runmode && !strcmp(
"single", active_runmode)) {
275 if (threadsstr != NULL) {
276 if (strcmp(threadsstr,
"auto") == 0) {
281 "threads, resetting to default",
290 if (out_iface != NULL) {
291 if (strlen(out_iface) > 0) {
293 if (strcmp(iface, out_iface) == 0) {
295 "Invalid config: interface (%s) and copy-iface (%s) can't be the same",
300 SCLogWarning(
"copy-iface corresponding to %s interface cannot be NULL", iface);
307 "%s: \"use-mmap\" option is obsolete: mmap is always enabled", aconf->
iface);
320 #ifdef HAVE_TPACKET_V3
324 SCLogWarning(
"%s: system too old for tpacket v3 switching to v2", iface);
328 SCLogWarning(
"%s: tpacket v3 is only implemented for 'workers' runmode."
329 " Switching to tpacket v2.",
339 if_root, if_default,
"use-emergency-flush", (
int *)&boolval);
347 SCLogWarning(
"%s: copy mode activated but no destination"
348 " iface. Disabling feature",
350 }
else if (strlen(copymodestr) <= 0) {
352 }
else if (strcmp(copymodestr,
"ips") == 0) {
356 SCLogWarning(
"%s: using tpacket_v3 in IPS mode will result in high latency", iface);
358 }
else if (strcmp(copymodestr,
"tap") == 0) {
362 SCLogWarning(
"%s: using tpacket_v3 in TAP mode will result in high latency", iface);
370 aconf->
cluster_id = (uint16_t)(cluster_id_auto++);
373 SCLogWarning(
"%s: invalid cluster_id, resetting to 0", iface);
383 }
else if (strcmp(tmpctype,
"cluster_round_robin") == 0) {
384 SCLogConfig(
"%s: using round-robin cluster mode for AF_PACKET", aconf->
iface);
387 }
else if (strcmp(tmpctype,
"cluster_flow") == 0 || strcmp(tmpctype,
"cluster_rollover") == 0) {
388 if (strcmp(tmpctype,
"cluster_rollover") == 0) {
389 SCLogWarning(
"%s: cluster_rollover deprecated; using \"cluster_flow\" instead. See "
400 SCLogConfig(
"%s: using defrag kernel functionality for AF_PACKET", aconf->
iface);
405 }
else if (strcmp(tmpctype,
"cluster_cpu") == 0) {
409 }
else if (strcmp(tmpctype,
"cluster_qm") == 0) {
410 SCLogConfig(
"%s: using queue based cluster mode for AF_PACKET", aconf->
iface);
413 }
else if (strcmp(tmpctype,
"cluster_random") == 0) {
414 SCLogConfig(
"%s: using random based cluster mode for AF_PACKET", aconf->
iface);
417 #ifdef HAVE_PACKET_EBPF
418 }
else if (strcmp(tmpctype,
"cluster_ebpf") == 0) {
419 SCLogInfo(
"%s: using ebpf based cluster mode for AF_PACKET", aconf->
iface);
421 cluster_type = PACKET_FANOUT_EBPF;
430 SCLogConfig(
"%s: Rollover requested for AF_PACKET but ignored -- see ticket #6128.",
432 SCLogWarning(
"%s: rollover option has been deprecated and will be ignored as it can cause "
434 "tracking issues; see ticket #6128.",
443 #ifdef HAVE_PACKET_EBPF
444 SCLogConfig(
"%s: af-packet will use '%s' as eBPF load balancing file", iface, ebpf_file);
446 aconf->ebpf_t_config.
flags |= EBPF_SOCKET_FILTER;
450 #ifdef HAVE_PACKET_EBPF
455 aconf->ebpf_t_config.
flags |= EBPF_PINNED_MAPS;
457 const char *pinned_maps_name = NULL;
460 &pinned_maps_name) != 1) {
461 aconf->ebpf_t_config.pinned_maps_name = pinned_maps_name;
463 aconf->ebpf_t_config.pinned_maps_name = NULL;
466 aconf->ebpf_t_config.pinned_maps_name = NULL;
470 #ifdef HAVE_PACKET_EBPF
472 if (aconf->
ebpf_lb_file && cluster_type == PACKET_FANOUT_EBPF) {
475 &aconf->ebpf_t_config);
482 SCLogError(
"%s: eBPF support is not built-in", iface);
489 #ifdef HAVE_PACKET_EBPF
490 SCLogConfig(
"%s: af-packet will use '%s' as eBPF filter file", iface, ebpf_file);
492 aconf->ebpf_t_config.mode = AFP_MODE_EBPF_BYPASS;
493 aconf->ebpf_t_config.
flags |= EBPF_SOCKET_FILTER;
497 #ifdef HAVE_PACKET_EBPF
498 SCLogConfig(
"%s: using bypass kernel functionality for AF_PACKET", aconf->
iface);
502 SCLogError(
"%s: bypass set but eBPF support is not built-in", iface);
509 #ifdef HAVE_PACKET_EBPF
512 &aconf->ebpf_t_config);
514 SCLogWarning(
"%s: failed to load eBPF filter file", iface);
517 SCLogError(
"%s: eBPF support is not built-in", iface);
524 #ifdef HAVE_PACKET_XDP
525 aconf->ebpf_t_config.mode = AFP_MODE_XDP_BYPASS;
526 aconf->ebpf_t_config.
flags |= EBPF_XDP_CODE;
530 SCLogConfig(
"%s: using bypass kernel functionality for AF_PACKET", aconf->
iface);
533 if (aconf->ebpf_t_config.
flags & EBPF_PINNED_MAPS) {
535 struct ebpf_timeout_config *ebt =
SCCalloc(1,
sizeof(
struct ebpf_timeout_config));
537 SCLogError(
"%s: flow bypass alloc error", iface);
539 memcpy(ebt, &(aconf->ebpf_t_config),
sizeof(
struct ebpf_timeout_config));
541 EBPFCheckBypassedFlowCreate,
548 SCLogWarning(
"%s: XDP filter set but XDP support is not built-in", iface);
550 #ifdef HAVE_PACKET_XDP
551 const char *xdp_mode;
553 aconf->
xdp_mode = XDP_FLAGS_SKB_MODE;
555 if (!strcmp(xdp_mode,
"soft")) {
556 aconf->
xdp_mode = XDP_FLAGS_SKB_MODE;
557 }
else if (!strcmp(xdp_mode,
"driver")) {
558 aconf->
xdp_mode = XDP_FLAGS_DRV_MODE;
559 }
else if (!strcmp(xdp_mode,
"hw")) {
560 aconf->
xdp_mode = XDP_FLAGS_HW_MODE;
561 aconf->ebpf_t_config.
flags |= EBPF_XDP_HW_MODE;
569 if (boolval ==
false) {
571 aconf->ebpf_t_config.cpus_count = 1;
579 #ifdef HAVE_PACKET_XDP
582 &aconf->ebpf_t_config);
585 SCLogInfo(
"%s: loaded pinned maps from sysfs", iface);
588 SCLogWarning(
"%s: failed to load XDP filter file", iface);
598 "xdp-cpu-redirect", &cpuset) == 1) {
602 SCLogError(
"Previously found node has disappeared");
604 EBPFBuildCPUSet(node, aconf->
iface);
608 EBPFBuildCPUSet(NULL, aconf->
iface);
617 SCLogError(
"%s: XDP support is not built-in", iface);
631 if (value % getpagesize()) {
632 SCLogWarning(
"%s: block-size %" PRIuMAX
" must be a multiple of pagesize (%u).", iface,
633 value, getpagesize());
652 if (strcmp(tmpctype,
"auto") == 0) {
658 }
else if (strcmp(tmpctype,
"kernel") == 0) {
672 SCLogNotice(
"%s: fanout not supported on this system, falling "
673 "back to 1 capture thread",
685 SCLogPerf(
"%s: cluster_flow: %u cores, using %u threads", iface, aconf->
threads,
691 if (rss_queues > 0) {
693 SCLogPerf(
"%s: cluster_qm: %d RSS queues, using %u threads", iface, rss_queues,
711 SCLogWarning(
"%s: inefficient setup: ring-size < max_pending_packets. "
712 "Resetting to decent value %d.",
731 "%s: using AF_PACKET with offloads enabled leads to capture problems",
743 if (active_runmode == NULL || strcmp(
"workers", active_runmode) != 0) {
751 static int AFPConfigGeThreadsCount(
void *conf)
764 #ifdef HAVE_AF_PACKET
766 const char *live_dev = NULL;
770 (void)
ConfGet(
"af-packet.live-interface", &live_dev);
786 FatalError(
"Some IPS capture threads did not peer.");
789 SCLogDebug(
"RunModeIdsAFPAutoFp initialised");
801 #ifdef HAVE_AF_PACKET
803 const char *live_dev = NULL;
807 (void)
ConfGet(
"af-packet.live-interface", &live_dev);
814 AFPConfigGeThreadsCount,
824 FatalError(
"Some IPS capture threads did not peer.");
827 SCLogDebug(
"RunModeIdsAFPSingle initialised");
842 #ifdef HAVE_AF_PACKET
844 const char *live_dev = NULL;
848 (void)
ConfGet(
"af-packet.live-interface", &live_dev);
862 FatalError(
"Some IPS capture threads did not peer.");
865 SCLogDebug(
"RunModeIdsAFPWorkers initialised");
const char * thread_name_workers
ChecksumValidationMode checksum_mode
#define PACKET_FANOUT_FLAG_DEFRAG
int RunModeIdsAFPWorkers(void)
Workers version of the AF_PACKET processing.
int RunModeSetLiveCaptureWorkers(ConfigIfaceParserFunc ConfigParser, ConfigIfaceThreadsCountFunc ModThreadsCount, const char *recv_mod_name, const char *decode_mod_name, const char *thread_name, const char *live_dev)
#define SC_ATOMIC_INIT(name)
wrapper for initializing an atomic variable.
#define AFP_COPY_MODE_NONE
int RunModeIdsAFPSingle(void)
Single thread version of the AF_PACKET processing.
void RunModeIdsAFPRegister(void)
int ConfGetChildValueBoolWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name, int *val)
ConfNode * ConfGetNode(const char *name)
Get a ConfNode by name.
#define PACKET_FANOUT_RND
uint16_t UtilCpuGetNumProcessorsConfigured(void)
Get the number of cpus configured in the system.
#define PACKET_FANOUT_HASH
TmEcode AFPPeersListInit(void)
Init the global list of AFPPeer.
#define SC_ATOMIC_ADD(name, val)
add a value to our atomic variable
const char * RunModeAFPGetDefaultMode(void)
int StringParseUint16(uint16_t *res, int base, size_t len, const char *str)
const char * thread_name_autofp
void RunModeRegisterNewRunMode(enum RunModes runmode, const char *name, const char *description, int(*RunModeFunc)(void), void(*RunModeIsIPSEnabled)(void))
Registers a new runmode.
ConfNode * ConfNodeLookupKeyValue(const ConfNode *base, const char *key, const char *value)
Lookup for a key value under a specific node.
@ CHECKSUM_VALIDATION_DISABLE
@ CHECKSUM_VALIDATION_KERNEL
char * RunmodeGetActive(void)
int StringParseInt32(int32_t *res, int base, size_t len, const char *str)
int ConfGetChildValueIntWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name, intmax_t *val)
const char * thread_name_single
ConfNode * ConfGetChildWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name)
int AFPGetLinkType(const char *ifname)
TmEcode AFPPeersListCheck(void)
Check that all AFPPeer got a peer.
int ConfValIsTrue(const char *val)
Check if a value is true.
#define AFP_BLOCK_SIZE_DEFAULT_ORDER
size_t strlcpy(char *dst, const char *src, size_t siz)
int RunModeSetLiveCaptureAutoFp(ConfigIfaceParserFunc ConfigParser, ConfigIfaceThreadsCountFunc ModThreadsCount, const char *recv_mod_name, const char *decode_mod_name, const char *thread_name, const char *live_dev)
@ CHECKSUM_VALIDATION_ENABLE
int ConfGet(const char *name, const char **vptr)
Retrieve the value of a configuration node.
@ CHECKSUM_VALIDATION_AUTO
const char * ebpf_filter_file
void RunModeEnablesBypassManager(void)
LiveDevice * LiveGetDevice(const char *name)
Get a pointer to the device at idx.
int GetIfaceRSSQueuesNum(const char *dev)
ConfNode * ConfFindDeviceConfig(ConfNode *node, const char *iface)
Find the configuration node for a specific device.
#define PACKET_FANOUT_CPU
void EngineModeSetIPS(void)
int ConfGetChildValueWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name, const char **vptr)
void(* DerefFunc)(void *)
#define SCLogWarning(...)
Macro used to log WARNING messages.
#define AFP_COPY_MODE_TAP
#define SC_ATOMIC_SUB(name, val)
sub a value from our atomic variable
int GetIfaceOffloading(const char *dev, int csum, int other)
output offloading status of the link
uint16_t max_pending_packets
int DisableIfaceOffloading(LiveDevice *dev, int csum, int other)
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
void TimeModeSetLive(void)
void ConfSetBPFFilter(ConfNode *if_root, ConfNode *if_default, const char *iface, const char **bpf_filter)
const char * LiveGetDeviceName(int number)
Get a pointer to the device name at idx.
const char * xdp_filter_file
int RunModeIdsAFPAutoFp(void)
#define SC_ATOMIC_RESET(name)
wrapper for reinitializing an atomic variable.
int BypassedFlowManagerRegisterUpdateFunc(BypassedUpdateFunc UpdateFunc, void *data)
struct SCLogConfig_ SCLogConfig
Holds the config state used by the logging api.
#define SCLogError(...)
Macro used to log ERROR messages.
#define AFP_COPY_MODE_IPS
int ConfValIsFalse(const char *val)
Check if a value is false.
int RunModeSetLiveCaptureSingle(ConfigIfaceParserFunc ConfigParser, ConfigIfaceThreadsCountFunc ModThreadsCount, const char *recv_mod_name, const char *decode_mod_name, const char *thread_name, const char *live_dev)
char iface[AFP_IFACE_NAME_LENGTH]
int LiveGetDeviceCount(void)
Get the number of registered devices.
uint16_t UtilCpuGetNumProcessorsOnline(void)
Get the number of cpus online in the system.
const char * ebpf_lb_file
#define SCLogNotice(...)
Macro used to log NOTICE messages.
int BypassedFlowManagerRegisterCheckFunc(BypassedCheckFunc CheckFunc, BypassedCheckFuncInit CheckFuncInit, void *data)
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...
#define LINKTYPE_ETHERNET
#define AFP_EMERGENCY_MODE