suricata
source-netmap.c
Go to the documentation of this file.
1 /* Copyright (C) 2011-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 * \defgroup netmap Netmap running mode
20 *
21 * @{
22 */
23 
24 /**
25  * \file
26  *
27  * \author Aleksey Katargin <gureedo@gmail.com>
28  * \author Victor Julien <victor@inliniac.net>
29  * \author Bill Meeks <billmeeks8@gmail.com>
30  *
31  * Netmap socket acquisition support
32  *
33  * Many thanks to Luigi Rizzo for guidance and support.
34  *
35  */
36 
37 #include "suricata.h"
38 #include "suricata-common.h"
39 #include "tm-threads.h"
40 #include "packet.h"
41 #include "util-bpf.h"
42 #include "util-privs.h"
43 #include "util-validate.h"
44 #include "util-datalink.h"
45 
46 #include "source-netmap.h"
47 
48 #ifdef HAVE_NETMAP
49 
50 #define NETMAP_WITH_LIBS
51 #ifdef DEBUG
52 #define DEBUG_NETMAP_USER
53 #endif
54 
55 #include <net/netmap_user.h>
56 #include <libnetmap.h>
57 
58 #endif /* HAVE_NETMAP */
59 
60 #include "util-ioctl.h"
61 
62 #ifndef HAVE_NETMAP
63 
64 /**
65 * \brief this function prints an error message and exits.
66 */
67 static TmEcode NoNetmapSupportExit(ThreadVars *tv, const void *initdata, void **data)
68 {
69  FatalError("Error creating thread %s: Netmap is not enabled. "
70  "Make sure to pass --enable-netmap to configure when building.",
71  tv->name);
72 }
73 
75 {
76  tmm_modules[TMM_RECEIVENETMAP].name = "ReceiveNetmap";
77  tmm_modules[TMM_RECEIVENETMAP].ThreadInit = NoNetmapSupportExit;
79 }
80 
81 /**
82 * \brief Registration Function for DecodeNetmap.
83 */
85 {
86  tmm_modules[TMM_DECODENETMAP].name = "DecodeNetmap";
87  tmm_modules[TMM_DECODENETMAP].ThreadInit = NoNetmapSupportExit;
89 }
90 
91 #else /* We have NETMAP support */
92 
93 #include "action-globals.h"
94 
95 #define POLL_TIMEOUT 100
96 
97 #if defined(__linux__)
98 #define POLL_EVENTS (POLLHUP|POLLRDHUP|POLLERR|POLLNVAL)
99 
100 #ifndef IFF_PPROMISC
101 #define IFF_PPROMISC IFF_PROMISC
102 #endif
103 
104 #else
105 #define POLL_EVENTS (POLLHUP|POLLERR|POLLNVAL)
106 #endif
107 
108 enum { NETMAP_FLAG_ZERO_COPY = 1, NETMAP_FLAG_EXCL_RING_ACCESS = 2 };
109 
110 /**
111  * \brief Netmap device instance. Each ring for each device gets its own
112  * device.
113  */
114 typedef struct NetmapDevice_
115 {
116  struct nmport_d *nmd;
117  unsigned int ref;
118  SC_ATOMIC_DECLARE(unsigned int, threads_run);
119  TAILQ_ENTRY(NetmapDevice_) next;
120  // actual ifname can only be 16, but we store a bit more,
121  // like the options string and a 'netmap:' prefix.
122  char ifname[32];
123  int ring;
124  int direction; // 0 rx, 1 tx
125 
126  // autofp: Used to lock a destination ring while we are sending data.
127  SCMutex netmap_dev_lock;
128 } NetmapDevice;
129 
130 /**
131  * \brief Module thread local variables.
132  */
133 typedef struct NetmapThreadVars_
134 {
135  /* receive interface */
136  NetmapDevice *ifsrc;
137  /* dst interface for IPS mode */
138  NetmapDevice *ifdst;
139 
140  int flags;
141  struct bpf_program bpf_prog;
142 
143  /* suricata internals */
144  TmSlot *slot;
145  ThreadVars *tv;
146  LiveDevice *livedev;
147 
148  /* copy from config */
149  int copy_mode;
150  ChecksumValidationMode checksum_mode;
151 
152  /* counters */
153  uint64_t pkts;
154  uint64_t bytes;
155  uint64_t drops;
156  uint16_t capture_kernel_packets;
157  uint16_t capture_kernel_drops;
158 } NetmapThreadVars;
159 
160 typedef TAILQ_HEAD(NetmapDeviceList_, NetmapDevice_) NetmapDeviceList;
161 
162 static NetmapDeviceList netmap_devlist = TAILQ_HEAD_INITIALIZER(netmap_devlist);
163 static SCMutex netmap_devlist_lock = SCMUTEX_INITIALIZER;
164 
165 /** \brief get RSS RX-queue count
166  * \retval rx_rings RSS RX queue count or 0 on error
167  */
168 int NetmapGetRSSCount(const char *ifname)
169 {
170  struct nmreq_port_info_get req;
171  struct nmreq_header hdr;
172  int rx_rings = 0;
173 
174  /* we need the base interface name to query queues */
175  char base_name[IFNAMSIZ];
176  strlcpy(base_name, ifname, sizeof(base_name));
177  if (strlen(base_name) > 0 &&
178  (base_name[strlen(base_name) - 1] == '^' || base_name[strlen(base_name) - 1] == '*')) {
179  base_name[strlen(base_name) - 1] = '\0';
180  }
181 
182  SCMutexLock(&netmap_devlist_lock);
183 
184  /* open netmap device */
185  int fd = open("/dev/netmap", O_RDWR);
186  if (fd == -1) {
187  SCLogError("%s: open netmap device failed: %s", ifname, strerror(errno));
188  goto error_open;
189  }
190 
191  /* query netmap interface info */
192  memset(&req, 0, sizeof(req));
193  memset(&hdr, 0, sizeof(hdr));
194  hdr.nr_version = NETMAP_API;
195  hdr.nr_reqtype = NETMAP_REQ_PORT_INFO_GET;
196  hdr.nr_body = (uintptr_t)&req;
197  strlcpy(hdr.nr_name, base_name, sizeof(hdr.nr_name));
198 
199  if (ioctl(fd, NIOCCTRL, &hdr) != 0) {
200  SCLogError("%s: failed to query netmap for device info: %s", ifname, strerror(errno));
201  goto error_fd;
202  };
203 
204  /* return RX rings count if it equals TX rings count */
205  if (req.nr_rx_rings == req.nr_tx_rings) {
206  rx_rings = req.nr_rx_rings;
207  }
208 
209 error_fd:
210  close(fd);
211 error_open:
212  SCMutexUnlock(&netmap_devlist_lock);
213  return rx_rings;
214 }
215 
216 static void NetmapDestroyDevice(NetmapDevice *pdev)
217 {
218  nmport_close(pdev->nmd);
219  SCMutexDestroy(&pdev->netmap_dev_lock);
220  SCFree(pdev);
221 }
222 
223 /**
224  * \brief Close or dereference netmap device instance.
225  * \param dev Netmap device instance.
226  * \return Zero on success.
227  */
228 static int NetmapClose(NetmapDevice *dev)
229 {
230  NetmapDevice *pdev, *tmp;
231 
232  SCMutexLock(&netmap_devlist_lock);
233 
234  TAILQ_FOREACH_SAFE (pdev, &netmap_devlist, next, tmp) {
235  if (pdev == dev) {
236  pdev->ref--;
237  if (!pdev->ref) {
238  NetmapDestroyDevice(pdev);
239  }
240  SCMutexUnlock(&netmap_devlist_lock);
241  return 0;
242  }
243  }
244 
245  SCMutexUnlock(&netmap_devlist_lock);
246  return -1;
247 }
248 
249 /**
250  * \brief Close all open netmap device instances.
251  */
252 static void NetmapCloseAll(void)
253 {
254  NetmapDevice *pdev, *tmp;
255 
256  SCMutexLock(&netmap_devlist_lock);
257 
258  TAILQ_FOREACH_SAFE (pdev, &netmap_devlist, next, tmp) {
259  NetmapDestroyDevice(pdev);
260  }
261 
262  SCMutexUnlock(&netmap_devlist_lock);
263 }
264 
265 /**
266  * \brief Open interface in netmap mode.
267  * \param ifname Interface name.
268  * \param promisc Enable promiscuous mode.
269  * \param dev Pointer to requested netmap device instance.
270  * \param verbose Verbose error logging.
271  * \param read Indicates direction: RX or TX
272  * \param zerocopy 1 if zerocopy access requested
273  * \param soft Use Host stack (software) interface
274  * \return Zero on success.
275  */
276 static int NetmapOpen(NetmapIfaceSettings *ns, NetmapDevice **pdevice, int verbose, int read,
277  bool zerocopy, bool soft)
278 {
279  SCEnter();
280  SCLogDebug("ifname %s", ns->iface);
281 
282  char base_name[IFNAMSIZ];
283  strlcpy(base_name, ns->iface, sizeof(base_name));
284  if (strlen(base_name) > 0 &&
285  (base_name[strlen(base_name)-1] == '^' ||
286  base_name[strlen(base_name)-1] == '*'))
287  {
288  base_name[strlen(base_name)-1] = '\0';
289  }
290 
291  if (ns->real) {
292  /* check interface is up */
293  int if_flags = GetIfaceFlags(base_name);
294  if (if_flags == -1) {
295  if (verbose) {
296  SCLogError("%s: cannot access network interface: %s", base_name, ns->iface);
297  }
298  goto error;
299  }
300 
301  /* bring iface up if it is down */
302  if ((if_flags & IFF_UP) == 0) {
303  SCLogError("%s: interface is down", base_name);
304  goto error;
305  }
306  /* if needed, try to set iface in promisc mode */
307  if (ns->promisc && (if_flags & (IFF_PROMISC|IFF_PPROMISC)) == 0) {
308  if_flags |= IFF_PPROMISC;
309  SetIfaceFlags(base_name, if_flags); // TODO reset at exit
310  // TODO move to parse config?
311  }
312  }
313  NetmapDevice *pdev = NULL, *spdev = NULL;
314  pdev = SCCalloc(1, sizeof(*pdev));
315  if (unlikely(pdev == NULL)) {
316  SCLogError("%s: memory allocation failed", base_name);
317  goto error;
318  }
319  SC_ATOMIC_INIT(pdev->threads_run);
320 
321  SCMutexLock(&netmap_devlist_lock);
322 
323  const int direction = (read != 1);
324  int ring = 0;
325  /* Search for interface in our already opened list. */
326  /* We will find it when opening multiple rings on */
327  /* the device when it exposes multiple RSS queues. */
328  TAILQ_FOREACH(spdev, &netmap_devlist, next) {
329  SCLogDebug("spdev %s", spdev->ifname);
330  if (direction == spdev->direction && strcmp(ns->iface, spdev->ifname) == 0) {
331  ring = spdev->ring + 1;
332  }
333  }
334  SCLogDebug("netmap/%s: using ring %d", ns->iface, ring);
335 
336  const char *opt_R = "R";
337  const char *opt_T = "T";
338  const char *opt_x = "x"; // not for IPS
339  const char *opt_z = "z"; // zero copy, not for IPS
340 
341  /* assemble options string */
342  char optstr[16];
343  if (ns->ips)
344  opt_x = "";
345  // z seems to not play well with multiple opens of a real dev on linux
346  opt_z = "";
347 
348  /*
349  * How netmap endpoint names are selected:
350  *
351  * The following logic within the "retry" loop builds endpoint names.
352  *
353  * IPS Mode:
354  * There are two endpoints: one hardware NIC and either a hardware NIC or host stack "NIC".
355  *
356  * IDS Mode:
357  * One endpoint -- usually a hardware NIC.
358  *
359  * IPS mode -- with one endpoint a host stack "NIC":
360  * When using multiple rings/threads, then the open of the initial Ring 0 MUST
361  * instruct netmap to open multiple Host Stack rings (as the default is to open only a single
362  * pair). This is also critical for the HW NIC endpoint. This is done by adding
363  * “@conf:host-rings=x” suffix option (where “x” is the number of host rings desired)
364  * to BOTH endpoint nmport_open_desc() calls for ring 0 (hardware and host stack).
365  * For subsequent additional ring open calls, omit the suffix option specifying host ring count.
366  *
367  * IPS mode -- both endpoints are hardware NICs:
368  * Do NOT pass any suffix option (even for Ring 0). You do not need to tell netmap how many
369  * rings, because it already knows the correct value from the NIC driver itself. Specifying a
370  * desired ring count when both ends are Hardware NICs confuses netmap, and it seems to default
371  * to using only a single hardware ring. In this scenario, specify only the specific ring number
372  * being opened.
373  */
374 
375  // loop to retry opening if unsupported options are used
376 retry:
377  snprintf(optstr, sizeof(optstr), "%s%s%s", opt_z, opt_x, direction == 0 ? opt_R : opt_T);
378 
379  char devname[128];
380  if (strncmp(ns->iface, "netmap:", 7) == 0) {
381  snprintf(devname, sizeof(devname), "%s}%d%s%s",
382  ns->iface, ring, strlen(optstr) ? "/" : "", optstr);
383  } else if (strlen(ns->iface) > 5 && strncmp(ns->iface, "vale", 4) == 0 && isdigit(ns->iface[4])) {
384  snprintf(devname, sizeof(devname), "%s", ns->iface);
385  } else if (ring == 0 && ns->threads == 1) {
386  /* just a single thread and ring, so don't use ring param */
387  snprintf(devname, sizeof(devname), "netmap:%s%s%s",
388  ns->iface, strlen(optstr) ? "/" : "", optstr);
389  SCLogDebug("device with %s-ring enabled (devname): %s", soft ? "SW" : "HW", devname);
390  } else {
391  /* Going to be using multiple threads and rings */
392  if (ns->sw_ring) {
393  /* Opening a host stack interface */
394  if (ring == 0) {
395  /* Ring 0, so tell netmap how many host rings we want created */
396  snprintf(devname, sizeof(devname), "netmap:%s%d%s%s@conf:host-rings=%d", ns->iface,
397  ring, strlen(optstr) ? "/" : "", optstr, ns->threads);
398  } else {
399  /* Software (host) ring, but not initial open of ring 0 */
400  snprintf(devname, sizeof(devname), "netmap:%s%d%s%s", ns->iface, ring,
401  strlen(optstr) ? "/" : "", optstr);
402  }
403  SCLogDebug("device with SW-ring enabled (devname): %s", devname);
404  } else if (ring == 0 && soft) {
405  /* Ring 0 of HW endpoint, and other endpoint is SW stack,
406  * so request SW host stack rings to match HW rings count.
407  */
408  snprintf(devname, sizeof(devname), "netmap:%s-%d%s%s@conf:host-rings=%d", ns->iface,
409  ring, strlen(optstr) ? "/" : "", optstr, ns->threads);
410  SCLogDebug("device with HW-ring enabled (devname): %s", devname);
411  } else {
412  /* Hardware ring other than ring 0, or both endpoints are HW
413  * and there is no host stack (SW) endpoint */
414  snprintf(devname, sizeof(devname), "netmap:%s-%d%s%s", ns->iface, ring,
415  strlen(optstr) ? "/" : "", optstr);
416  SCLogDebug("device with HW-ring enabled (devname): %s", devname);
417  }
418  }
419 
420  strlcpy(pdev->ifname, ns->iface, sizeof(pdev->ifname));
421 
422  /* have the netmap API parse device name and prepare the port descriptor for us */
423  pdev->nmd = nmport_prepare(devname);
424 
425  if (pdev->nmd != NULL) {
426  /* For RX devices, set the nr_mode flag we need on the netmap port TX rings prior to opening
427  */
428  if (read) {
429  pdev->nmd->reg.nr_flags |= NR_NO_TX_POLL;
430  }
431 
432  /* Now attempt to actually open the netmap port descriptor */
433  if (nmport_open_desc(pdev->nmd) < 0) {
434  /* the open failed, so clean-up the descriptor and fall through to error handler */
435  nmport_close(pdev->nmd);
436  pdev->nmd = NULL;
437  }
438  }
439 
440  if (pdev->nmd == NULL) {
441  if (errno == EINVAL) {
442  if (opt_z[0] == 'z') {
443  SCLogNotice(
444  "%s: dev '%s' got EINVAL: going to retry without 'z'", base_name, devname);
445  opt_z = "";
446  goto retry;
447  } else if (opt_x[0] == 'x') {
448  SCLogNotice(
449  "%s: dev '%s' got EINVAL: going to retry without 'x'", base_name, devname);
450  opt_x = "";
451  goto retry;
452  }
453  }
454 
455  NetmapCloseAll();
456  FatalError("opening devname %s failed: %s", devname, strerror(errno));
457  }
458 
459  /* Work around bug in libnetmap library where "cur_{r,t}x_ring" values not initialized */
460  SCLogDebug("%s -- cur rings: [%d, %d] first rings: [%d, %d]", devname, pdev->nmd->cur_rx_ring,
461  pdev->nmd->cur_tx_ring, pdev->nmd->first_rx_ring, pdev->nmd->first_tx_ring);
462  pdev->nmd->cur_rx_ring = pdev->nmd->first_rx_ring;
463  pdev->nmd->cur_tx_ring = pdev->nmd->first_tx_ring;
464 
465  SCLogInfo("%s: %s opened [fd: %d]", devname, ns->iface, pdev->nmd->fd);
466 
467  pdev->direction = direction;
468  pdev->ring = ring;
469  SCMutexInit(&pdev->netmap_dev_lock, NULL);
470  TAILQ_INSERT_TAIL(&netmap_devlist, pdev, next);
471 
472  SCMutexUnlock(&netmap_devlist_lock);
473  *pdevice = pdev;
474 
475  return 0;
476 error:
477  return -1;
478 }
479 
480 /**
481  * \brief PcapDumpCounters
482  * \param ntv
483  */
484 static inline void NetmapDumpCounters(NetmapThreadVars *ntv)
485 {
486  StatsAddUI64(ntv->tv, ntv->capture_kernel_packets, ntv->pkts);
487  StatsAddUI64(ntv->tv, ntv->capture_kernel_drops, ntv->drops);
488  (void) SC_ATOMIC_ADD(ntv->livedev->drop, ntv->drops);
489  (void) SC_ATOMIC_ADD(ntv->livedev->pkts, ntv->pkts);
490  ntv->drops = 0;
491  ntv->pkts = 0;
492 }
493 
494 /**
495  * \brief Init function for ReceiveNetmap.
496  * \param tv pointer to ThreadVars
497  * \param initdata pointer to the interface passed from the user
498  * \param data pointer gets populated with NetmapThreadVars
499  */
500 static TmEcode ReceiveNetmapThreadInit(ThreadVars *tv, const void *initdata, void **data)
501 {
502  SCEnter();
503 
504  NetmapIfaceConfig *aconf = (NetmapIfaceConfig *)initdata;
505  if (initdata == NULL) {
506  SCLogError("initdata == NULL");
508  }
509 
510  NetmapThreadVars *ntv = SCCalloc(1, sizeof(*ntv));
511  if (unlikely(ntv == NULL)) {
512  SCLogError("Memory allocation failed");
513  goto error;
514  }
515 
516  ntv->livedev = LiveGetDevice(aconf->iface_name);
517  if (ntv->livedev == NULL) {
518  SCLogError("Unable to find Live device");
519  goto error_ntv;
520  }
521 
522  ntv->tv = tv;
523  ntv->checksum_mode = aconf->in.checksum_mode;
524  ntv->copy_mode = aconf->in.copy_mode;
525 
526  /* enable zero-copy mode for workers runmode */
527  char const *active_runmode = RunmodeGetActive();
528  if (strcmp("workers", active_runmode) == 0) {
529  ntv->flags |= NETMAP_FLAG_ZERO_COPY;
530  SCLogDebug("Enabling zero copy mode for %s", aconf->in.iface);
531  } else if (strcmp("autofp", active_runmode) == 0) {
532  ntv->flags |= NETMAP_FLAG_EXCL_RING_ACCESS;
533  }
534 
535  /* Need to insure open of ring 0 conveys requested ring count for open */
536  bool soft = aconf->in.sw_ring || aconf->out.sw_ring;
537  if (NetmapOpen(&aconf->in, &ntv->ifsrc, 1, 1, (ntv->flags & NETMAP_FLAG_ZERO_COPY) != 0,
538  soft) != 0) {
539  goto error_ntv;
540  }
541 
542  if (aconf->in.copy_mode != NETMAP_COPY_MODE_NONE) {
543  if (NetmapOpen(&aconf->out, &ntv->ifdst, 1, 0, (ntv->flags & NETMAP_FLAG_ZERO_COPY) != 0,
544  soft) != 0) {
545  goto error_src;
546  }
547  }
548 
549  /* basic counters */
550  ntv->capture_kernel_packets = StatsRegisterCounter("capture.kernel_packets",
551  ntv->tv);
552  ntv->capture_kernel_drops = StatsRegisterCounter("capture.kernel_drops",
553  ntv->tv);
554 
555  if (aconf->in.bpf_filter) {
556  SCLogConfig("%s: using BPF '%s'", ntv->ifsrc->ifname, aconf->in.bpf_filter);
557  char errbuf[PCAP_ERRBUF_SIZE];
558  if (SCBPFCompile(default_packet_size, /* snaplen_arg */
559  LINKTYPE_ETHERNET, /* linktype_arg */
560  &ntv->bpf_prog, /* program */
561  aconf->in.bpf_filter, /* const char *buf */
562  1, /* optimize */
563  PCAP_NETMASK_UNKNOWN, /* mask */
564  errbuf,
565  sizeof(errbuf)) == -1)
566  {
567  SCLogError("%s: failed to compile BPF \"%s\": %s", ntv->ifsrc->ifname,
568  aconf->in.bpf_filter, errbuf);
569  goto error_dst;
570  }
571  }
572 
573  SCLogDebug("thread: %s polling on fd: %d", tv->name, ntv->ifsrc->nmd->fd);
574 
576 
577  *data = (void *)ntv;
578  aconf->DerefFunc(aconf);
580 
581 error_dst:
582  if (aconf->in.copy_mode != NETMAP_COPY_MODE_NONE) {
583  NetmapClose(ntv->ifdst);
584  }
585 
586 error_src:
587  NetmapClose(ntv->ifsrc);
588 
589 error_ntv:
590  SCFree(ntv);
591 
592 error:
593  aconf->DerefFunc(aconf);
595 }
596 
597 /**
598  * \brief Output packet to destination interface or drop.
599  * \param ntv Thread local variables.
600  * \param p Source packet.
601  */
602 static TmEcode NetmapWritePacket(NetmapThreadVars *ntv, Packet *p)
603 {
604  if (ntv->copy_mode == NETMAP_COPY_MODE_IPS) {
605  if (PacketCheckAction(p, ACTION_DROP)) {
606  return TM_ECODE_OK;
607  }
608  }
609  DEBUG_VALIDATE_BUG_ON(ntv->ifdst == NULL);
610 
611  /* Lock the destination netmap ring while writing to it */
612  if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
613  SCMutexLock(&ntv->ifdst->netmap_dev_lock);
614  }
615 
616  /* attempt to write the packet into the netmap ring buffer(s) */
617  if (nmport_inject(ntv->ifdst->nmd, GET_PKT_DATA(p), GET_PKT_LEN(p)) == 0) {
618  if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
619  SCMutexUnlock(&ntv->ifdst->netmap_dev_lock);
620  }
621  SCLogDebug("failed to send %s -> %s", ntv->ifsrc->ifname, ntv->ifdst->ifname);
622  ntv->drops++;
623  return TM_ECODE_FAILED;
624  }
625 
626  SCLogDebug("sent successfully: %s(%d)->%s(%d) (%u)", ntv->ifsrc->ifname, ntv->ifsrc->ring,
627  ntv->ifdst->ifname, ntv->ifdst->ring, GET_PKT_LEN(p));
628 
629  /* Instruct netmap to push the data on the TX ring on the destination port */
630  ioctl(ntv->ifdst->nmd->fd, NIOCTXSYNC, 0);
631  if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
632  SCMutexUnlock(&ntv->ifdst->netmap_dev_lock);
633  }
634  return TM_ECODE_OK;
635 }
636 
637 /**
638  * \brief Packet release routine.
639  * \param p Packet.
640  */
641 static void NetmapReleasePacket(Packet *p)
642 {
643  NetmapThreadVars *ntv = (NetmapThreadVars *)p->netmap_v.ntv;
644 
645  if ((ntv->copy_mode != NETMAP_COPY_MODE_NONE) && !PKT_IS_PSEUDOPKT(p)) {
646  NetmapWritePacket(ntv, p);
647  }
648 
650 }
651 
652 static void NetmapProcessPacket(NetmapThreadVars *ntv, const struct nm_pkthdr *ph)
653 {
654  if (ntv->bpf_prog.bf_len) {
655  struct pcap_pkthdr pkthdr = { {0, 0}, ph->len, ph->len };
656  if (pcap_offline_filter(&ntv->bpf_prog, &pkthdr, ph->buf) == 0) {
657  return;
658  }
659  }
660 
662  if (unlikely(p == NULL)) {
663  return;
664  }
665 
667  p->livedev = ntv->livedev;
669  p->ts = SCTIME_FROM_TIMEVAL(&ph->ts);
670  ntv->pkts++;
671  ntv->bytes += ph->len;
672 
673  if (ntv->flags & NETMAP_FLAG_ZERO_COPY) {
674  if (PacketSetData(p, (uint8_t *)ph->buf, ph->len) == -1) {
675  TmqhOutputPacketpool(ntv->tv, p);
676  return;
677  }
678  } else {
679  if (PacketCopyData(p, (uint8_t *)ph->buf, ph->len) == -1) {
680  TmqhOutputPacketpool(ntv->tv, p);
681  return;
682  }
683  }
684 
685  p->ReleasePacket = NetmapReleasePacket;
686  p->netmap_v.ntv = ntv;
687 
688  SCLogDebug("pktlen: %" PRIu32 " (pkt %p, pkt data %p)",
689  GET_PKT_LEN(p), p, GET_PKT_DATA(p));
690 
691  (void)TmThreadsSlotProcessPkt(ntv->tv, ntv->slot, p);
692 }
693 
694 /**
695  * \brief Copy netmap rings data into Packet structures.
696  * \param *d nmport_d (or nm_desc) netmap if structure.
697  * \param cnt int count of packets to read (-1 = all).
698  * \param *ntv NetmapThreadVars.
699  */
700 static TmEcode NetmapReadPackets(struct nmport_d *d, int cnt, NetmapThreadVars *ntv)
701 {
702  struct nm_pkthdr hdr;
703  int last_ring = d->last_rx_ring - d->first_rx_ring + 1;
704  int cur_ring, got = 0, cur_rx_ring = d->cur_rx_ring;
705 
706  memset(&hdr, 0, sizeof(hdr));
707  hdr.flags = NM_MORE_PKTS;
708 
709  if (cnt == 0)
710  cnt = -1;
711 
712  for (cur_ring = 0; cur_ring < last_ring && cnt != got; cur_ring++, cur_rx_ring++) {
713  struct netmap_ring *ring;
714 
715  if (cur_rx_ring > d->last_rx_ring)
716  cur_rx_ring = d->first_rx_ring;
717 
718  ring = NETMAP_RXRING(d->nifp, cur_rx_ring);
719 
720  /* cycle through the non-empty ring slots to fetch their data */
721  for (; !nm_ring_empty(ring) && cnt != got; got++) {
722  u_int idx, i;
723  u_char *oldbuf;
724  struct netmap_slot *slot;
725 
726  if (hdr.buf) { /* from previous round */
727  NetmapProcessPacket(ntv, &hdr);
728  }
729 
730  i = ring->cur;
731  slot = &ring->slot[i];
732  idx = slot->buf_idx;
733  d->cur_rx_ring = cur_rx_ring;
734  hdr.slot = slot;
735  oldbuf = hdr.buf = (u_char *)NETMAP_BUF(ring, idx);
736  hdr.len = hdr.caplen = slot->len;
737 
738  /* loop through the ring slots to get packet data */
739  while (slot->flags & NS_MOREFRAG) {
740  /* packet can be fragmented across multiple slots, */
741  /* so loop until we find the slot with the flag */
742  /* cleared, signalling the end of the packet data. */
743  u_char *nbuf;
744  u_int oldlen = slot->len;
745  i = nm_ring_next(ring, i);
746  slot = &ring->slot[i];
747  hdr.len += slot->len;
748  nbuf = (u_char *)NETMAP_BUF(ring, slot->buf_idx);
749 
750  if (oldbuf != NULL && nbuf - oldbuf == ring->nr_buf_size &&
751  oldlen == ring->nr_buf_size) {
752  hdr.caplen += slot->len;
753  oldbuf = nbuf;
754  } else {
755  oldbuf = NULL;
756  }
757  }
758 
759  hdr.ts = ring->ts;
760  ring->head = ring->cur = nm_ring_next(ring, i);
761  }
762  }
763 
764  if (hdr.buf) { /* from previous round */
765  hdr.flags = 0;
766  NetmapProcessPacket(ntv, &hdr);
767  }
768  return got;
769 }
770 
771 /**
772  * \brief Main netmap reading loop function
773  */
774 static TmEcode ReceiveNetmapLoop(ThreadVars *tv, void *data, void *slot)
775 {
776  SCEnter();
777 
778  TmSlot *s = (TmSlot *)slot;
779  NetmapThreadVars *ntv = (NetmapThreadVars *)data;
780  struct pollfd fds;
781 
782  ntv->slot = s->slot_next;
783  fds.fd = ntv->ifsrc->nmd->fd;
784  fds.events = POLLIN;
785 
786  SCLogDebug("thread %s polling on %d", tv->name, fds.fd);
787 
788  // Indicate that the thread is actually running its application level code (i.e., it can poll
789  // packets)
791 
792  for(;;) {
793  if (unlikely(suricata_ctl_flags != 0)) {
794  break;
795  }
796 
797  /* make sure we have at least one packet in the packet pool,
798  * to prevent us from alloc'ing packets at line rate */
799  PacketPoolWait();
800 
801  int r = poll(&fds, 1, POLL_TIMEOUT);
802  if (r < 0) {
803  /* error */
804  if (errno != EINTR)
805  SCLogError("%s: error polling netmap: %s", ntv->ifsrc->ifname, strerror(errno));
806  continue;
807 
808  } else if (r == 0) {
809  /* no events, timeout */
810  /* sync counters */
811  NetmapDumpCounters(ntv);
813 
814  /* poll timed out, lets handle the timeout */
815  TmThreadsCaptureHandleTimeout(tv, NULL);
816  continue;
817  }
818 
819  if (unlikely(fds.revents & POLL_EVENTS)) {
820  if (fds.revents & POLLERR) {
821  SCLogError("%s: error reading netmap data via polling: %s", ntv->ifsrc->ifname,
822  strerror(errno));
823  } else if (fds.revents & POLLNVAL) {
824  SCLogError("%s: invalid polling request", ntv->ifsrc->ifname);
825  }
826  continue;
827  }
828 
829  if (likely(fds.revents & POLLIN)) {
830  /* have data on RX ring, so copy to Packet for processing */
831  NetmapReadPackets(ntv->ifsrc->nmd, -1, ntv);
832  }
833 
834  NetmapDumpCounters(ntv);
836  }
837 
838  NetmapDumpCounters(ntv);
841 }
842 
843 /**
844  * \brief This function prints stats to the screen at exit.
845  * \param tv pointer to ThreadVars
846  * \param data pointer that gets cast into NetmapThreadVars for ntv
847  */
848 static void ReceiveNetmapThreadExitStats(ThreadVars *tv, void *data)
849 {
850  SCEnter();
851  NetmapThreadVars *ntv = (NetmapThreadVars *)data;
852 
853  NetmapDumpCounters(ntv);
854  SCLogPerf("%s: (%s) packets %" PRIu64 ", dropped %" PRIu64 ", bytes %" PRIu64 "",
855  ntv->ifsrc->ifname, tv->name,
856  StatsGetLocalCounterValue(tv, ntv->capture_kernel_packets),
857  StatsGetLocalCounterValue(tv, ntv->capture_kernel_drops), ntv->bytes);
858 }
859 
860 /**
861  * \brief
862  * \param tv
863  * \param data Pointer to NetmapThreadVars.
864  */
865 static TmEcode ReceiveNetmapThreadDeinit(ThreadVars *tv, void *data)
866 {
867  SCEnter();
868 
869  NetmapThreadVars *ntv = (NetmapThreadVars *)data;
870 
871  if (ntv->ifsrc) {
872  NetmapClose(ntv->ifsrc);
873  ntv->ifsrc = NULL;
874  }
875  if (ntv->ifdst) {
876  NetmapClose(ntv->ifdst);
877  ntv->ifdst = NULL;
878  }
879  if (ntv->bpf_prog.bf_insns) {
880  SCBPFFree(&ntv->bpf_prog);
881  }
882 
883  SCFree(ntv);
884 
886 }
887 
888 /**
889  * \brief Prepare netmap decode thread.
890  * \param tv Thread local variables.
891  * \param initdata Thread config.
892  * \param data Pointer to DecodeThreadVars placed here.
893  */
894 static TmEcode DecodeNetmapThreadInit(ThreadVars *tv, const void *initdata, void **data)
895 {
896  SCEnter();
897 
899  if (dtv == NULL)
901 
903 
904  *data = (void *)dtv;
905 
907 }
908 
909 /**
910  * \brief This function passes off to link type decoders.
911  *
912  * \param t pointer to ThreadVars
913  * \param p pointer to the current packet
914  * \param data pointer that gets cast into NetmapThreadVars for ntv
915  */
916 static TmEcode DecodeNetmap(ThreadVars *tv, Packet *p, void *data)
917 {
918  SCEnter();
919 
921 
923 
924  /* update counters */
926 
928 
930 
932 }
933 
934 /**
935  * \brief
936  * \param tv
937  * \param data Pointer to DecodeThreadVars.
938  */
939 static TmEcode DecodeNetmapThreadDeinit(ThreadVars *tv, void *data)
940 {
941  SCEnter();
942 
943  if (data != NULL)
944  DecodeThreadVarsFree(tv, data);
945 
947 }
948 
949 /**
950  * \brief Registration Function for ReceiveNetmap.
951  */
953 {
954  tmm_modules[TMM_RECEIVENETMAP].name = "ReceiveNetmap";
955  tmm_modules[TMM_RECEIVENETMAP].ThreadInit = ReceiveNetmapThreadInit;
956  tmm_modules[TMM_RECEIVENETMAP].PktAcqLoop = ReceiveNetmapLoop;
957  tmm_modules[TMM_RECEIVENETMAP].ThreadExitPrintStats = ReceiveNetmapThreadExitStats;
958  tmm_modules[TMM_RECEIVENETMAP].ThreadDeinit = ReceiveNetmapThreadDeinit;
961 }
962 
963 /**
964  * \brief Registration Function for DecodeNetmap.
965  */
967 {
968  tmm_modules[TMM_DECODENETMAP].name = "DecodeNetmap";
969  tmm_modules[TMM_DECODENETMAP].ThreadInit = DecodeNetmapThreadInit;
970  tmm_modules[TMM_DECODENETMAP].Func = DecodeNetmap;
971  tmm_modules[TMM_DECODENETMAP].ThreadDeinit = DecodeNetmapThreadDeinit;
974 }
975 
976 #endif /* HAVE_NETMAP */
977 
978 /**
979 * @}
980 */
TmModule_::cap_flags
uint8_t cap_flags
Definition: tm-modules.h:67
PacketCheckAction
bool PacketCheckAction(const Packet *p, const uint8_t a)
Definition: packet.c:48
tm-threads.h
ThreadVars_::name
char name[16]
Definition: threadvars.h:64
PacketFreeOrRelease
void PacketFreeOrRelease(Packet *p)
Return a packet to where it was allocated.
Definition: decode.c:191
SC_ATOMIC_INIT
#define SC_ATOMIC_INIT(name)
wrapper for initializing an atomic variable.
Definition: util-atomic.h:315
PacketCopyData
int PacketCopyData(Packet *p, const uint8_t *pktdata, uint32_t pktlen)
Copy data to Packet payload and set packet length.
Definition: decode.c:292
PKT_IS_PSEUDOPKT
#define PKT_IS_PSEUDOPKT(p)
return 1 if the packet is a pseudo packet
Definition: decode.h:1059
util-bpf.h
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
NetmapIfaceSettings_::checksum_mode
ChecksumValidationMode checksum_mode
Definition: source-netmap.h:51
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
TmThreadsSetFlag
void TmThreadsSetFlag(ThreadVars *tv, uint32_t flag)
Set a thread flag.
Definition: tm-threads.c:99
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
action-globals.h
LiveDevice_
Definition: util-device.h:39
SC_ATOMIC_ADD
#define SC_ATOMIC_ADD(name, val)
add a value to our atomic variable
Definition: util-atomic.h:333
THV_RUNNING
#define THV_RUNNING
Definition: threadvars.h:54
TAILQ_FOREACH
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:252
SCMutexLock
#define SCMutexLock(mut)
Definition: threads-debug.h:117
NetmapIfaceConfig_::out
NetmapIfaceSettings out
Definition: source-netmap.h:64
util-privs.h
StatsSyncCountersIfSignalled
#define StatsSyncCountersIfSignalled(tv)
Definition: counters.h:140
SCMUTEX_INITIALIZER
#define SCMUTEX_INITIALIZER
Definition: threads-debug.h:121
TAILQ_INSERT_TAIL
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:294
PacketDecodeFinalize
void PacketDecodeFinalize(ThreadVars *tv, DecodeThreadVars *dtv, Packet *p)
Finalize decoding of a packet.
Definition: decode.c:147
RunmodeGetActive
char * RunmodeGetActive(void)
Definition: runmodes.c:217
TmModuleReceiveNetmapRegister
void TmModuleReceiveNetmapRegister(void)
Definition: source-netmap.c:74
TmqhOutputPacketpool
void TmqhOutputPacketpool(ThreadVars *t, Packet *p)
Definition: tmqh-packetpool.c:356
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:85
NetmapIfaceSettings_::iface
char iface[NETMAP_IFACE_NAME_LENGTH]
Definition: source-netmap.h:40
NetmapIfaceSettings_::ips
bool ips
Definition: source-netmap.h:46
NETMAP_COPY_MODE_NONE
@ NETMAP_COPY_MODE_NONE
Definition: source-netmap.h:30
TmModule_::PktAcqLoop
TmEcode(* PktAcqLoop)(ThreadVars *, void *, void *)
Definition: tm-modules.h:54
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:84
strlcpy
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: util-strlcpyu.c:43
TmModule_::ThreadDeinit
TmEcode(* ThreadDeinit)(ThreadVars *, void *)
Definition: tm-modules.h:49
TAILQ_ENTRY
#define TAILQ_ENTRY(type)
Definition: queue.h:239
Packet_::datalink
int datalink
Definition: decode.h:607
NetmapGetRSSCount
int NetmapGetRSSCount(const char *ifname)
PKT_SET_SRC
#define PKT_SET_SRC(p, src_val)
Definition: decode.h:1062
DecodeRegisterPerfCounters
void DecodeRegisterPerfCounters(DecodeThreadVars *dtv, ThreadVars *tv)
Definition: decode.c:526
TAILQ_HEAD_INITIALIZER
#define TAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:236
TmModuleDecodeNetmapRegister
void TmModuleDecodeNetmapRegister(void)
Registration Function for DecodeNetmap.
Definition: source-netmap.c:84
NetmapIfaceConfig_::DerefFunc
void(* DerefFunc)(void *)
Definition: source-netmap.h:67
PKT_SRC_WIRE
@ PKT_SRC_WIRE
Definition: decode.h:54
NetmapIfaceSettings_::real
bool real
Definition: source-netmap.h:45
Packet_::ts
SCTime_t ts
Definition: decode.h:471
SCMutexUnlock
#define SCMutexUnlock(mut)
Definition: threads-debug.h:119
NetmapIfaceSettings_::sw_ring
bool sw_ring
Definition: source-netmap.h:43
LiveGetDevice
LiveDevice * LiveGetDevice(const char *name)
Get a pointer to the device at idx.
Definition: util-device.c:242
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
GET_PKT_DATA
#define GET_PKT_DATA(p)
Definition: decode.h:219
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
SCTIME_FROM_TIMEVAL
#define SCTIME_FROM_TIMEVAL(tv)
Definition: util-time.h:65
TmModule_::Func
TmEcode(* Func)(ThreadVars *, Packet *, void *)
Definition: tm-modules.h:52
NetmapIfaceSettings_
Definition: source-netmap.h:38
TMM_DECODENETMAP
@ TMM_DECODENETMAP
Definition: tm-threads-common.h:61
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:289
NetmapIfaceSettings_::threads
uint16_t threads
Definition: source-netmap.h:49
StatsGetLocalCounterValue
uint64_t StatsGetLocalCounterValue(ThreadVars *tv, uint16_t id)
Get the value of the local copy of the counter that hold this id.
Definition: counters.c:1256
SC_ATOMIC_DECLARE
#define SC_ATOMIC_DECLARE(type, name)
wrapper for declaring atomic variables.
Definition: util-atomic.h:281
PacketPoolWait
void PacketPoolWait(void)
Definition: tmqh-packetpool.c:69
Packet_
Definition: decode.h:428
TM_FLAG_DECODE_TM
#define TM_FLAG_DECODE_TM
Definition: tm-modules.h:32
tmm_modules
TmModule tmm_modules[TMM_SIZE]
Definition: tm-modules.c:33
GET_PKT_LEN
#define GET_PKT_LEN(p)
Definition: decode.h:218
source-netmap.h
TmSlot_
Definition: tm-threads.h:53
Packet_::livedev
struct LiveDevice_ * livedev
Definition: decode.h:586
TmEcode
TmEcode
Definition: tm-threads-common.h:83
NetmapIfaceSettings_::promisc
bool promisc
Definition: source-netmap.h:44
TmModule_::name
const char * name
Definition: tm-modules.h:44
SCLogInfo
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
Definition: util-debug.h:224
TAILQ_FOREACH_SAFE
#define TAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:329
SCMutexInit
#define SCMutexInit(mut, mutattrs)
Definition: threads-debug.h:116
TM_FLAG_RECEIVE_TM
#define TM_FLAG_RECEIVE_TM
Definition: tm-modules.h:31
dtv
DecodeThreadVars * dtv
Definition: fuzz_decodepcapfile.c:33
default_packet_size
uint32_t default_packet_size
Definition: decode.c:72
Packet_::ReleasePacket
void(* ReleasePacket)(struct Packet_ *)
Definition: decode.h:515
NetmapIfaceSettings_::bpf_filter
const char * bpf_filter
Definition: source-netmap.h:52
flags
uint8_t flags
Definition: decode-gre.h:0
DecodeThreadVarsFree
void DecodeThreadVarsFree(ThreadVars *tv, DecodeThreadVars *dtv)
Definition: decode.c:708
NetmapIfaceConfig_
Definition: source-netmap.h:56
ChecksumValidationMode
ChecksumValidationMode
Definition: decode.h:44
suricata-common.h
packet.h
ACTION_DROP
#define ACTION_DROP
Definition: action-globals.h:30
SCLogPerf
#define SCLogPerf(...)
Definition: util-debug.h:230
SCBPFFree
void SCBPFFree(struct bpf_program *program)
Definition: util-bpf.c:33
TmModule_::ThreadInit
TmEcode(* ThreadInit)(ThreadVars *, const void *, void **)
Definition: tm-modules.h:47
FatalError
#define FatalError(...)
Definition: util-debug.h:502
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
TmModule_::ThreadExitPrintStats
void(* ThreadExitPrintStats)(ThreadVars *, void *)
Definition: tm-modules.h:48
NETMAP_COPY_MODE_IPS
@ NETMAP_COPY_MODE_IPS
Definition: source-netmap.h:32
util-validate.h
TMM_RECEIVENETMAP
@ TMM_RECEIVENETMAP
Definition: tm-threads-common.h:60
StatsAddUI64
void StatsAddUI64(ThreadVars *tv, uint16_t id, uint64_t x)
Adds a value of type uint64_t to the local counter.
Definition: counters.c:146
SCLogConfig
struct SCLogConfig_ SCLogConfig
Holds the config state used by the logging api.
POLL_TIMEOUT
#define POLL_TIMEOUT
Definition: source-af-packet.c:174
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
SCFree
#define SCFree(p)
Definition: util-mem.h:61
NetmapIfaceConfig_::iface_name
char iface_name[NETMAP_IFACE_NAME_LENGTH]
Definition: source-netmap.h:58
DecodeThreadVars_
Structure to hold thread specific data for all decode modules.
Definition: decode.h:664
NetmapIfaceSettings_::copy_mode
int copy_mode
Definition: source-netmap.h:50
bpf_program
Definition: source-af-packet.c:80
util-ioctl.h
DecodeThreadVarsAlloc
DecodeThreadVars * DecodeThreadVarsAlloc(ThreadVars *tv)
Alloc and setup DecodeThreadVars.
Definition: decode.c:689
TAILQ_HEAD
#define TAILQ_HEAD(name, type)
Definition: queue.h:230
PacketSetData
int PacketSetData(Packet *p, const uint8_t *pktdata, uint32_t pktlen)
Set data for Packet and set length when zero copy is used.
Definition: decode.c:728
PacketPoolGetPacket
Packet * PacketPoolGetPacket(void)
Get a new packet from the packet pool.
Definition: tmqh-packetpool.c:167
SCBPFCompile
int SCBPFCompile(int snaplen_arg, int linktype_arg, struct bpf_program *program, const char *buf, int optimize, uint32_t mask, char *errbuf, size_t errbuf_len)
Definition: util-bpf.c:39
NetmapIfaceConfig_::in
NetmapIfaceSettings in
Definition: source-netmap.h:61
suricata.h
likely
#define likely(expr)
Definition: util-optimize.h:32
TmSlot_::slot_next
struct TmSlot_ * slot_next
Definition: tm-threads.h:62
SCLogNotice
#define SCLogNotice(...)
Macro used to log NOTICE messages.
Definition: util-debug.h:237
StatsRegisterCounter
uint16_t StatsRegisterCounter(const char *name, struct ThreadVars_ *tv)
Registers a normal, unqualified counter.
Definition: counters.c:955
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:275
SCMutexDestroy
#define SCMutexDestroy
Definition: threads-debug.h:120
SCMutex
#define SCMutex
Definition: threads-debug.h:114
SC_CAP_NET_RAW
#define SC_CAP_NET_RAW
Definition: util-privs.h:32
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:111
DecodeEthernet
int DecodeEthernet(ThreadVars *tv, DecodeThreadVars *dtv, Packet *p, const uint8_t *pkt, uint32_t len)
Definition: decode-ethernet.c:42
TmModule_::flags
uint8_t flags
Definition: tm-modules.h:70
DecodeUpdatePacketCounters
void DecodeUpdatePacketCounters(ThreadVars *tv, const DecodeThreadVars *dtv, const Packet *p)
Definition: decode.c:655
LINKTYPE_ETHERNET
#define LINKTYPE_ETHERNET
Definition: decode.h:972
suricata_ctl_flags
volatile uint8_t suricata_ctl_flags
Definition: suricata.c:164