suricata
runmode-af-xdp.c
Go to the documentation of this file.
1 /* Copyright (C) 2022 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 afxdppacket
20  *
21  * @{
22  */
23 
24 /**
25  * \file
26  *
27  * \author Richard McConnell <richard_mcconnell@rapid7.com>
28  *
29  * AF_XDP socket runmode
30  *
31  */
32 #define SC_PCAP_DONT_INCLUDE_PCAP_H 1
34 #include "tm-threads.h"
35 #include "conf.h"
36 #include "runmodes.h"
37 #include "runmode-af-xdp.h"
38 #include "output.h"
39 #include "log-httplog.h"
40 #include "detect-engine-mpm.h"
41 
42 #include "alert-fastlog.h"
43 #include "alert-debuglog.h"
44 
45 #include "flow-bypass.h"
46 
47 #include "util-conf.h"
48 #include "util-debug.h"
49 #include "util-time.h"
50 #include "util-cpu.h"
51 #include "util-affinity.h"
52 #include "util-device.h"
53 #include "util-runmodes.h"
54 #include "util-ioctl.h"
55 #include "util-ebpf.h"
56 #include "util-byte.h"
57 
58 #include "source-af-xdp.h"
59 
60 #ifdef HAVE_AF_XDP
61 #include <linux/if_xdp.h>
62 #include <linux/if_link.h>
63 #include <xdp/xsk.h>
64 #endif
65 
66 const char *RunModeAFXDPGetDefaultMode(void)
67 {
68  return "workers";
69 }
70 
72 {
73  RunModeRegisterNewRunMode(RUNMODE_AFXDP_DEV, "single", "Single threaded af-xdp mode",
74  RunModeIdsAFXDPSingle, NULL);
76  "Workers af-xdp mode, each thread does all"
77  " tasks from acquisition to logging",
79 }
80 
81 #ifdef HAVE_AF_XDP
82 
83 #define DEFAULT_BUSY_POLL_TIME 20
84 #define DEFAULT_BUSY_POLL_BUDGET 64
85 #define DEFAULT_GRO_FLUSH_TIMEOUT 2000000
86 #define DEFAULT_NAPI_HARD_IRQS 2
87 
88 static void AFXDPDerefConfig(void *conf)
89 {
90  AFXDPIfaceConfig *pfp = (AFXDPIfaceConfig *)conf;
91  /* Pcap config is used only once but cost of this low. */
92  if (SC_ATOMIC_SUB(pfp->ref, 1) <= 1) {
93  SCFree(pfp);
94  }
95 }
96 
97 static TmEcode ConfigSetThreads(AFXDPIfaceConfig *aconf, const char *entry_str)
98 {
99  SCEnter();
100  const char *active_runmode = RunmodeGetActive();
101 
102  if (active_runmode && !strcmp("single", active_runmode)) {
103  aconf->threads = 1;
104  SCReturnInt(0);
105  }
106 
107  if (entry_str == NULL) {
108  SCLogError("Number of threads for interface \"%s\" not specified", aconf->iface);
110  }
111 
112  const int nr_queues = GetIfaceRSSQueuesNum(aconf->iface);
113 
114  if (strcmp(entry_str, "auto") == 0) {
115 
116  const int nr_cores = (int)UtilCpuGetNumProcessorsOnline();
117 
118  /* Threads limited to MIN(cores vs queues) */
119  aconf->threads = (nr_cores <= nr_queues) ? nr_cores : nr_queues;
120  const char *sys_type = nr_cores <= nr_queues ? "cores" : "queues";
121 
122  SCLogPerf("%u %s, so using %u threads", aconf->threads, sys_type, aconf->threads);
124  }
125 
126  if (StringParseInt32(&aconf->threads, 10, 0, entry_str) < 0) {
127  SCLogError("Threads entry for interface %s contain non-numerical characters - \"%s\"",
128  aconf->iface, entry_str);
130  }
131 
132  if (aconf->threads < 0) {
133  SCLogError("Interface %s has a negative number of threads", aconf->iface);
135  }
136 
137  if (aconf->threads > nr_queues) {
138  SCLogWarning(
139  "Selected threads greater than configured queues, using: %d thread(s)", nr_queues);
140  aconf->threads = nr_queues;
141  }
142 
144 }
145 
146 /**
147  * \brief extract information from config file
148  *
149  * The returned structure will be freed by the thread init function.
150  * This is thus necessary to copy the structure before giving it
151  * to thread or to reparse the file for each thread (and thus have
152  * new structure.
153  *
154  * \return a AFXDPIfaceConfig corresponding to the interface name
155  */
156 static void *ParseAFXDPConfig(const char *iface)
157 {
158  const char *confstr = NULL;
159  ConfNode *if_root;
160  ConfNode *if_default = NULL;
161  ConfNode *af_xdp_node = NULL;
162  int conf_val = 0;
163  intmax_t conf_val_int = 0;
164  bool boolval = false;
165 
166  if (iface == NULL) {
167  return NULL;
168  }
169 
170  AFXDPIfaceConfig *aconf = SCCalloc(1, sizeof(*aconf));
171  if (unlikely(aconf == NULL)) {
172  return NULL;
173  }
174 
175  /* default/basic config setup */
176  strlcpy(aconf->iface, iface, sizeof(aconf->iface));
177  aconf->DerefFunc = AFXDPDerefConfig;
178  aconf->threads = 1;
179  aconf->promisc = 1;
180  aconf->enable_busy_poll = true;
181  aconf->busy_poll_time = DEFAULT_BUSY_POLL_TIME;
182  aconf->busy_poll_budget = DEFAULT_BUSY_POLL_BUDGET;
183  aconf->mode = XDP_FLAGS_UPDATE_IF_NOEXIST;
184  aconf->gro_flush_timeout = DEFAULT_GRO_FLUSH_TIMEOUT;
185  aconf->napi_defer_hard_irqs = DEFAULT_NAPI_HARD_IRQS;
186  aconf->mem_alignment = XSK_UMEM__DEFAULT_FLAGS;
187 
188  /* Find initial node */
189  af_xdp_node = ConfGetNode("af-xdp");
190  if (af_xdp_node == NULL) {
191  SCLogInfo("unable to find af-xdp config using default values");
192  goto finalize;
193  }
194 
195  if_root = ConfFindDeviceConfig(af_xdp_node, iface);
196  if_default = ConfFindDeviceConfig(af_xdp_node, "default");
197 
198  if (if_root == NULL && if_default == NULL) {
199  SCLogInfo("unable to find af-xdp config for "
200  "interface \"%s\" or \"default\", using default values",
201  iface);
202  goto finalize;
203  }
204 
205  /* If there is no setting for current interface use default one as main iface */
206  if (if_root == NULL) {
207  if_root = if_default;
208  if_default = NULL;
209  }
210 
211  /* Threading */
212  confstr = "auto";
213  (void)ConfGetChildValueWithDefault(if_root, if_default, "threads", &confstr);
214  if (ConfigSetThreads(aconf, confstr) != TM_ECODE_OK) {
215  aconf->DerefFunc(aconf);
216  return NULL;
217  }
218 
219  SC_ATOMIC_RESET(aconf->ref);
220  (void)SC_ATOMIC_ADD(aconf->ref, aconf->threads);
221 
222  /* Promisc Mode */
223  (void)ConfGetChildValueBoolWithDefault(if_root, if_default, "disable-promisc", (int *)&boolval);
224  if (boolval) {
225  SCLogConfig("Disabling promiscuous mode on iface %s", aconf->iface);
226  aconf->promisc = 0;
227  }
228 
229 #ifdef HAVE_AF_XDP
230  /* AF_XDP socket mode options */
231  if (ConfGetChildValueWithDefault(if_root, if_default, "force-xdp-mode", &confstr) == 1) {
232  if (strncasecmp(confstr, "drv", 3) == 0) {
233  aconf->mode |= XDP_FLAGS_DRV_MODE;
234  } else if (strncasecmp(confstr, "skb", 3) == 0) {
235  aconf->mode |= XDP_FLAGS_SKB_MODE;
236  } else if (strncasecmp(confstr, "none", 4) == 0) {
237  } else {
238  SCLogWarning("Incorrect af-xdp xdp-mode setting, default (none) shall be applied");
239  }
240  }
241 
242  /* copy and zerocopy binding options */
243  if (ConfGetChildValueWithDefault(if_root, if_default, "force-bind-mode", &confstr) == 1) {
244  if (strncasecmp(confstr, "zero", 4) == 0) {
245  aconf->bind_flags |= XDP_ZEROCOPY;
246  } else if (strncasecmp(confstr, "copy", 4) == 0) {
247  aconf->bind_flags |= XDP_COPY;
248  } else if (strncasecmp(confstr, "none", 4) == 0) {
249  } else {
250  SCLogWarning("Incorrect af-xdp copy-mode setting, default (none) shall be applied");
251  }
252  }
253 
254  /* memory alignment mode selection */
255  if (ConfGetChildValueWithDefault(if_root, if_default, "mem-unaligned", &confstr) == 1) {
256  if (strncasecmp(confstr, "yes", 3) == 0) {
257  aconf->mem_alignment = XDP_UMEM_UNALIGNED_CHUNK_FLAG;
258  }
259  }
260 
261  /* Busy polling options */
262  if (ConfGetChildValueBoolWithDefault(if_root, if_default, "enable-busy-poll", &conf_val) == 1) {
263  if (conf_val == 0) {
264  aconf->enable_busy_poll = false;
265  }
266  }
267 
268  if (aconf->enable_busy_poll) {
269  if (ConfGetChildValueIntWithDefault(if_root, if_default, "busy-poll-time", &conf_val_int) ==
270  1) {
271  if (conf_val_int) {
272  aconf->busy_poll_time = conf_val_int;
273  }
274  }
275 
277  if_root, if_default, "busy-poll-budget", &conf_val_int) == 1) {
278  if (conf_val_int) {
279  aconf->busy_poll_budget = conf_val_int;
280  }
281  }
282 
283  /* 0 value is valid for these Linux tunable's */
285  if_root, if_default, "gro-flush-timeout", &conf_val_int) == 1) {
286  aconf->gro_flush_timeout = conf_val_int;
287  }
288 
290  if_root, if_default, "napi-defer-hard-irq", &conf_val_int) == 1) {
291  aconf->napi_defer_hard_irqs = conf_val_int;
292  }
293  }
294 #endif
295 
296 finalize:
297  if (LiveGetOffload() == 0) {
298  if (GetIfaceOffloading(iface, 0, 1) == 1) {
299  SCLogWarning("Using AF_XDP with offloading activated leads to capture problems");
300  }
301  } else {
303  }
304 
305  return aconf;
306 }
307 
308 static int AFXDPConfigGetThreadsCount(void *conf)
309 {
310  if (conf == NULL)
311  FatalError("Configuration file is NULL");
312 
313  AFXDPIfaceConfig *afxdp_conf = (AFXDPIfaceConfig *)conf;
314  return afxdp_conf->threads;
315 }
316 
317 #endif /* HAVE_AF_XDP */
318 
319 /**
320  * \brief Single thread version of the AF_XDP processing.
321  */
323 {
324  SCEnter();
325 
326 #ifdef HAVE_AF_XDP
327  int ret;
328  const char *live_dev = NULL;
329 
330  TimeModeSetLive();
331 
332  (void)ConfGet("af-xdp.live-interface", &live_dev);
333 
335  FatalError("Unable to init AF_XDP queue protection.");
336  }
337 
338  ret = RunModeSetLiveCaptureSingle(ParseAFXDPConfig, AFXDPConfigGetThreadsCount, "ReceiveAFXDP",
339  "DecodeAFXDP", thread_name_single, live_dev);
340  if (ret != 0) {
341  FatalError("Unable to start runmode");
342  }
343 
344  SCLogDebug("RunModeIdsAFXDPSingle initialised");
345 
346 #endif /* HAVE_AF_XDP */
347  SCReturnInt(0);
348 }
349 
350 /**
351  * \brief Workers version of the AF_XDP processing.
352  *
353  * Start N threads with each thread doing all the work.
354  *
355  */
357 {
358  SCEnter();
359 
360 #ifdef HAVE_AF_XDP
361  int ret;
362  const char *live_dev = NULL;
363 
364  TimeModeSetLive();
365 
366  (void)ConfGet("af-xdp.live-interface", &live_dev);
367 
369  FatalError("Unable to init AF_XDP queue protection.");
370  }
371 
372  ret = RunModeSetLiveCaptureWorkers(ParseAFXDPConfig, AFXDPConfigGetThreadsCount, "ReceiveAFXDP",
373  "DecodeAFXDP", thread_name_workers, live_dev);
374  if (ret != 0) {
375  FatalError("Unable to start runmode");
376  }
377 
378  SCLogDebug("RunModeIdsAFXDPWorkers initialised");
379 
380 #endif /* HAVE_AF_XDP */
381  SCReturnInt(0);
382 }
383 /**
384  * @}
385  */
thread_name_workers
const char * thread_name_workers
Definition: runmodes.c:70
RUNMODE_AFXDP_DEV
@ RUNMODE_AFXDP_DEV
Definition: runmodes.h:38
util-byte.h
tm-threads.h
flow-bypass.h
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
AFXDPIfaceConfig::mode
uint32_t mode
Definition: source-af-xdp.h:36
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
AFXDPIfaceConfig::iface
char iface[AFXDP_IFACE_NAME_LENGTH]
Definition: source-af-xdp.h:30
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
AFXDPIfaceConfig::mem_alignment
int mem_alignment
Definition: source-af-xdp.h:38
AFXDPIfaceConfig::gro_flush_timeout
uint32_t gro_flush_timeout
Definition: source-af-xdp.h:42
AFXDPIfaceConfig::DerefFunc
void(* DerefFunc)(void *)
Definition: source-af-xdp.h:46
ConfGetNode
ConfNode * ConfGetNode(const char *name)
Get a ConfNode by name.
Definition: conf.c:181
SC_ATOMIC_ADD
#define SC_ATOMIC_ADD(name, val)
add a value to our atomic variable
Definition: util-atomic.h:332
util-runmodes.h
RunmodeGetActive
char * RunmodeGetActive(void)
Definition: runmodes.c:206
StringParseInt32
int StringParseInt32(int32_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:622
ConfGetChildValueIntWithDefault
int ConfGetChildValueIntWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name, intmax_t *val)
Definition: conf.c:461
RunModeAFXDPGetDefaultMode
const char * RunModeAFXDPGetDefaultMode(void)
Definition: runmode-af-xdp.c:66
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:85
thread_name_single
const char * thread_name_single
Definition: runmodes.c:69
AFXDPIfaceConfig::napi_defer_hard_irqs
uint32_t napi_defer_hard_irqs
Definition: source-af-xdp.h:43
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:84
AFXDPQueueProtectionInit
TmEcode AFXDPQueueProtectionInit(void)
strlcpy
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: util-strlcpyu.c:43
ConfGet
int ConfGet(const char *name, const char **vptr)
Retrieve the value of a configuration node.
Definition: conf.c:335
util-device.h
util-debug.h
AFXDPIfaceConfig::enable_busy_poll
bool enable_busy_poll
Definition: source-af-xdp.h:39
util-cpu.h
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:487
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
AFXDPIfaceConfig::busy_poll_budget
uint32_t busy_poll_budget
Definition: source-af-xdp.h:41
util-affinity.h
AFXDPIfaceConfig::promisc
int promisc
Definition: source-af-xdp.h:33
ConfGetChildValueWithDefault
int ConfGetChildValueWithDefault(const ConfNode *base, const ConfNode *dflt, const char *name, const char **vptr)
Definition: conf.c:378
util-time.h
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
AFXDPIfaceConfig::bind_flags
uint32_t bind_flags
Definition: source-af-xdp.h:37
SC_ATOMIC_SUB
#define SC_ATOMIC_SUB(name, val)
sub a value from our atomic variable
Definition: util-atomic.h:341
AFXDPIfaceConfig::threads
int threads
Definition: source-af-xdp.h:32
AFXDPIfaceConfig::busy_poll_time
uint32_t busy_poll_time
Definition: source-af-xdp.h:40
conf.h
TmEcode
TmEcode
Definition: tm-threads-common.h:83
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
TimeModeSetLive
void TimeModeSetLive(void)
Definition: util-time.c:99
alert-fastlog.h
RunModeIdsAFXDPRegister
void RunModeIdsAFXDPRegister(void)
Definition: runmode-af-xdp.c:71
util-conf.h
suricata-common.h
source-af-xdp.h
SCLogPerf
#define SCLogPerf(...)
Definition: util-debug.h:230
FatalError
#define FatalError(...)
Definition: util-debug.h:502
RunModeIdsAFXDPWorkers
int RunModeIdsAFXDPWorkers(void)
Workers version of the AF_XDP processing.
Definition: runmode-af-xdp.c:356
log-httplog.h
SC_ATOMIC_RESET
#define SC_ATOMIC_RESET(name)
wrapper for reinitializing an atomic variable.
Definition: util-atomic.h:323
SCLogConfig
struct SCLogConfig_ SCLogConfig
Holds the config state used by the logging api.
AFXDPIfaceConfig
Definition: source-af-xdp.h:29
runmode-af-xdp.h
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
SCFree
#define SCFree(p)
Definition: util-mem.h:61
ConfNode_
Definition: conf.h:32
util-ioctl.h
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
RunModeIdsAFXDPSingle
int RunModeIdsAFXDPSingle(void)
Single thread version of the AF_XDP processing.
Definition: runmode-af-xdp.c:322
UtilCpuGetNumProcessorsOnline
uint16_t UtilCpuGetNumProcessorsOnline(void)
Get the number of cpus online in the system.
Definition: util-cpu.c:108
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:275
output.h