51 #define NETMAP_WITH_LIBS
53 #define DEBUG_NETMAP_USER
56 #include <net/netmap_user.h>
57 #include <libnetmap.h>
70 FatalError(
"Error creating thread %s: Netmap is not enabled. "
71 "Make sure to pass --enable-netmap to configure when building.",
96 #define POLL_TIMEOUT 100
98 #if defined(__linux__)
99 #define POLL_EVENTS (POLLHUP|POLLRDHUP|POLLERR|POLLNVAL)
102 #define IFF_PPROMISC IFF_PROMISC
106 #define POLL_EVENTS (POLLHUP|POLLERR|POLLNVAL)
109 enum { NETMAP_FLAG_ZERO_COPY = 1, NETMAP_FLAG_EXCL_RING_ACCESS = 2 };
115 typedef struct NetmapDevice_
117 struct nmport_d *nmd;
134 typedef struct NetmapThreadVars_
142 struct bpf_program bpf_prog;
157 uint16_t capture_kernel_packets;
158 uint16_t capture_kernel_drops;
161 typedef TAILQ_HEAD(NetmapDeviceList_, NetmapDevice_) NetmapDeviceList;
171 struct nmreq_port_info_get req;
172 struct nmreq_header hdr;
176 char base_name[IFNAMSIZ];
177 strlcpy(base_name, ifname,
sizeof(base_name));
178 if (strlen(base_name) > 0 &&
179 (base_name[strlen(base_name) - 1] ==
'^' || base_name[strlen(base_name) - 1] ==
'*')) {
180 base_name[strlen(base_name) - 1] =
'\0';
186 int fd = open(
"/dev/netmap", O_RDWR);
188 SCLogError(
"%s: open netmap device failed: %s", ifname, strerror(errno));
193 memset(&req, 0,
sizeof(req));
194 memset(&hdr, 0,
sizeof(hdr));
195 hdr.nr_version = NETMAP_API;
196 hdr.nr_reqtype = NETMAP_REQ_PORT_INFO_GET;
197 hdr.nr_body = (uintptr_t)&req;
198 strlcpy(hdr.nr_name, base_name,
sizeof(hdr.nr_name));
200 if (ioctl(fd, NIOCCTRL, &hdr) != 0) {
202 "Query of netmap HW rings count on %s failed; error: %s", ifname, strerror(errno));
207 if (req.nr_rx_rings == req.nr_tx_rings) {
208 rx_rings = req.nr_rx_rings;
218 static void NetmapDestroyDevice(NetmapDevice *pdev)
220 nmport_close(pdev->nmd);
230 static int NetmapClose(NetmapDevice *dev)
232 NetmapDevice *pdev, *tmp;
240 NetmapDestroyDevice(pdev);
254 static void NetmapCloseAll(
void)
256 NetmapDevice *pdev, *tmp;
261 NetmapDestroyDevice(pdev);
278 static int NetmapOpen(
NetmapIfaceSettings *ns, NetmapDevice **pdevice,
int verbose,
int read,
279 bool zerocopy,
bool soft)
284 char base_name[IFNAMSIZ];
286 if (strlen(base_name) > 0 &&
287 (base_name[strlen(base_name)-1] ==
'^' ||
288 base_name[strlen(base_name)-1] ==
'*'))
290 base_name[strlen(base_name)-1] =
'\0';
295 int if_flags = GetIfaceFlags(base_name);
296 if (if_flags == -1) {
298 SCLogError(
"%s: cannot access network interface: %s", base_name, ns->
iface);
304 if ((if_flags & IFF_UP) == 0) {
305 SCLogError(
"%s: interface is down", base_name);
309 if (ns->
promisc && (if_flags & (IFF_PROMISC|IFF_PPROMISC)) == 0) {
310 if_flags |= IFF_PPROMISC;
311 SetIfaceFlags(base_name, if_flags);
315 NetmapDevice *pdev = NULL, *spdev = NULL;
318 SCLogError(
"%s: memory allocation failed", base_name);
325 const int direction = (read != 1);
332 if (direction == spdev->direction && strcmp(ns->
iface, spdev->ifname) == 0) {
333 ring = spdev->ring + 1;
338 const char *opt_R =
"R";
339 const char *opt_T =
"T";
340 const char *opt_x =
"x";
341 const char *opt_z =
"z";
379 snprintf(optstr,
sizeof(optstr),
"%s%s%s", opt_z, opt_x, direction == 0 ? opt_R : opt_T);
382 if (strncmp(ns->
iface,
"netmap:", 7) == 0) {
383 snprintf(devname,
sizeof(devname),
"%s}%d%s%s",
384 ns->
iface, ring, strlen(optstr) ?
"/" :
"", optstr);
385 }
else if (strlen(ns->
iface) > 5 && strncmp(ns->
iface,
"vale", 4) == 0 && isdigit(ns->
iface[4])) {
386 snprintf(devname,
sizeof(devname),
"%s", ns->
iface);
387 }
else if (ring == 0 && ns->
threads == 1) {
389 snprintf(devname,
sizeof(devname),
"netmap:%s%s%s",
390 ns->
iface, strlen(optstr) ?
"/" :
"", optstr);
391 SCLogDebug(
"device with %s-ring enabled (devname): %s", soft ?
"SW" :
"HW", devname);
398 snprintf(devname,
sizeof(devname),
"netmap:%s%d%s%s@conf:host-rings=%d", ns->
iface,
399 ring, strlen(optstr) ?
"/" :
"", optstr, ns->
threads);
402 snprintf(devname,
sizeof(devname),
"netmap:%s%d%s%s", ns->
iface, ring,
403 strlen(optstr) ?
"/" :
"", optstr);
405 SCLogDebug(
"device with SW-ring enabled (devname): %s", devname);
406 }
else if (ring == 0 && soft) {
410 snprintf(devname,
sizeof(devname),
"netmap:%s-%d%s%s@conf:host-rings=%d", ns->
iface,
411 ring, strlen(optstr) ?
"/" :
"", optstr, ns->
threads);
412 SCLogDebug(
"device with HW-ring enabled (devname): %s", devname);
416 snprintf(devname,
sizeof(devname),
"netmap:%s-%d%s%s", ns->
iface, ring,
417 strlen(optstr) ?
"/" :
"", optstr);
418 SCLogDebug(
"device with HW-ring enabled (devname): %s", devname);
425 pdev->nmd = nmport_prepare(devname);
427 if (pdev->nmd != NULL) {
431 pdev->nmd->reg.nr_flags |= NR_NO_TX_POLL;
435 if (nmport_open_desc(pdev->nmd) < 0) {
437 nmport_close(pdev->nmd);
442 if (pdev->nmd == NULL) {
443 if (errno == EINVAL) {
444 if (opt_z[0] ==
'z') {
446 "%s: dev '%s' got EINVAL: going to retry without 'z'", base_name, devname);
449 }
else if (opt_x[0] ==
'x') {
451 "%s: dev '%s' got EINVAL: going to retry without 'x'", base_name, devname);
459 FatalError(
"opening devname %s failed: %s", devname, strerror(errno));
463 SCLogDebug(
"%s -- cur rings: [%d, %d] first rings: [%d, %d]", devname, pdev->nmd->cur_rx_ring,
464 pdev->nmd->cur_tx_ring, pdev->nmd->first_rx_ring, pdev->nmd->first_tx_ring);
465 pdev->nmd->cur_rx_ring = pdev->nmd->first_rx_ring;
466 pdev->nmd->cur_tx_ring = pdev->nmd->first_tx_ring;
468 SCLogInfo(
"%s: %s opened [fd: %d]", devname, ns->
iface, pdev->nmd->fd);
470 pdev->direction = direction;
487 static inline void NetmapDumpCounters(NetmapThreadVars *ntv)
489 StatsAddUI64(ntv->tv, ntv->capture_kernel_packets, ntv->pkts);
490 StatsAddUI64(ntv->tv, ntv->capture_kernel_drops, ntv->drops);
508 if (initdata == NULL) {
513 NetmapThreadVars *ntv =
SCCalloc(1,
sizeof(*ntv));
520 if (ntv->livedev == NULL) {
531 if (strcmp(
"workers", active_runmode) == 0) {
532 ntv->flags |= NETMAP_FLAG_ZERO_COPY;
534 }
else if (strcmp(
"autofp", active_runmode) == 0) {
535 ntv->flags |= NETMAP_FLAG_EXCL_RING_ACCESS;
540 if (NetmapOpen(&aconf->
in, &ntv->ifsrc, 1, 1, (ntv->flags & NETMAP_FLAG_ZERO_COPY) != 0,
546 if (NetmapOpen(&aconf->
out, &ntv->ifdst, 1, 0, (ntv->flags & NETMAP_FLAG_ZERO_COPY) != 0,
560 char errbuf[PCAP_ERRBUF_SIZE];
568 sizeof(errbuf)) == -1)
570 SCLogError(
"%s: failed to compile BPF \"%s\": %s", ntv->ifsrc->ifname,
586 NetmapClose(ntv->ifdst);
590 NetmapClose(ntv->ifsrc);
605 static TmEcode NetmapWritePacket(NetmapThreadVars *ntv,
Packet *p)
615 if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
626 (void)ioctl(ntv->ifdst->nmd->fd, NIOCTXSYNC, 0);
629 if (write_tries < 3) {
634 if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
637 SCLogDebug(
"failed to send %s -> %s", ntv->ifsrc->ifname, ntv->ifdst->ifname);
642 SCLogDebug(
"sent successfully: %s(%d)->%s(%d) (%u)", ntv->ifsrc->ifname, ntv->ifsrc->ring,
643 ntv->ifdst->ifname, ntv->ifdst->ring,
GET_PKT_LEN(p));
646 (void)ioctl(ntv->ifdst->nmd->fd, NIOCTXSYNC, 0);
647 if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
657 static void NetmapReleasePacket(
Packet *p)
659 NetmapThreadVars *ntv = (NetmapThreadVars *)p->netmap_v.ntv;
662 NetmapWritePacket(ntv, p);
668 static void NetmapProcessPacket(NetmapThreadVars *ntv,
const struct nm_pkthdr *ph)
670 if (ntv->bpf_prog.bf_len) {
671 struct pcap_pkthdr pkthdr = { {0, 0}, ph->len, ph->len };
672 if (pcap_offline_filter(&ntv->bpf_prog, &pkthdr, ph->buf) == 0) {
687 ntv->bytes += ph->len;
689 if (ntv->flags & NETMAP_FLAG_ZERO_COPY) {
702 p->netmap_v.ntv = ntv;
704 SCLogDebug(
"pktlen: %" PRIu32
" (pkt %p, pkt data %p)",
707 (void)TmThreadsSlotProcessPkt(ntv->tv, ntv->slot, p);
716 static TmEcode NetmapReadPackets(
struct nmport_d *d,
int cnt, NetmapThreadVars *ntv)
718 struct nm_pkthdr hdr;
719 int last_ring = d->last_rx_ring - d->first_rx_ring + 1;
720 int cur_ring, got = 0, cur_rx_ring = d->cur_rx_ring;
722 memset(&hdr, 0,
sizeof(hdr));
723 hdr.flags = NM_MORE_PKTS;
728 for (cur_ring = 0; cur_ring < last_ring &&
cnt != got; cur_ring++, cur_rx_ring++) {
729 struct netmap_ring *ring;
731 if (cur_rx_ring > d->last_rx_ring)
732 cur_rx_ring = d->first_rx_ring;
734 ring = NETMAP_RXRING(d->nifp, cur_rx_ring);
737 for (; !nm_ring_empty(ring) &&
cnt != got; got++) {
740 struct netmap_slot *slot;
743 NetmapProcessPacket(ntv, &hdr);
747 slot = &ring->slot[i];
749 d->cur_rx_ring = cur_rx_ring;
751 oldbuf = hdr.buf = (u_char *)NETMAP_BUF(ring, idx);
752 hdr.len = hdr.caplen = slot->len;
755 while (slot->flags & NS_MOREFRAG) {
760 u_int oldlen = slot->len;
761 i = nm_ring_next(ring, i);
762 slot = &ring->slot[i];
763 hdr.len += slot->len;
764 nbuf = (u_char *)NETMAP_BUF(ring, slot->buf_idx);
766 if (oldbuf != NULL && nbuf - oldbuf == ring->nr_buf_size &&
767 oldlen == ring->nr_buf_size) {
768 hdr.caplen += slot->len;
776 ring->head = ring->cur = nm_ring_next(ring, i);
782 NetmapProcessPacket(ntv, &hdr);
795 NetmapThreadVars *ntv = (NetmapThreadVars *)data;
799 fds.fd = ntv->ifsrc->nmd->fd;
821 SCLogError(
"%s: error polling netmap: %s", ntv->ifsrc->ifname, strerror(errno));
827 NetmapDumpCounters(ntv);
831 TmThreadsCaptureHandleTimeout(
tv, NULL);
835 if (
unlikely(fds.revents & POLL_EVENTS)) {
836 if (fds.revents & POLLERR) {
837 SCLogError(
"%s: error reading netmap data via polling: %s", ntv->ifsrc->ifname,
839 }
else if (fds.revents & POLLNVAL) {
840 SCLogError(
"%s: invalid polling request", ntv->ifsrc->ifname);
845 if (
likely(fds.revents & POLLIN)) {
847 NetmapReadPackets(ntv->ifsrc->nmd, -1, ntv);
850 NetmapDumpCounters(ntv);
854 NetmapDumpCounters(ntv);
864 static void ReceiveNetmapThreadExitStats(
ThreadVars *
tv,
void *data)
867 NetmapThreadVars *ntv = (NetmapThreadVars *)data;
869 NetmapDumpCounters(ntv);
870 SCLogPerf(
"%s: (%s) packets %" PRIu64
", dropped %" PRIu64
", bytes %" PRIu64
"",
871 ntv->ifsrc->ifname,
tv->
name,
885 NetmapThreadVars *ntv = (NetmapThreadVars *)data;
888 NetmapClose(ntv->ifsrc);
892 NetmapClose(ntv->ifdst);
895 if (ntv->bpf_prog.bf_insns) {