50 #define NETMAP_WITH_LIBS
52 #define DEBUG_NETMAP_USER
55 #include <net/netmap_user.h>
56 #include <libnetmap.h>
69 FatalError(
"Error creating thread %s: Netmap is not enabled. "
70 "Make sure to pass --enable-netmap to configure when building.",
95 #define POLL_TIMEOUT 100
97 #if defined(__linux__)
98 #define POLL_EVENTS (POLLHUP|POLLRDHUP|POLLERR|POLLNVAL)
101 #define IFF_PPROMISC IFF_PROMISC
105 #define POLL_EVENTS (POLLHUP|POLLERR|POLLNVAL)
108 enum { NETMAP_FLAG_ZERO_COPY = 1, NETMAP_FLAG_EXCL_RING_ACCESS = 2 };
114 typedef struct NetmapDevice_
116 struct nmport_d *nmd;
133 typedef struct NetmapThreadVars_
156 uint16_t capture_kernel_packets;
157 uint16_t capture_kernel_drops;
160 typedef TAILQ_HEAD(NetmapDeviceList_, NetmapDevice_) NetmapDeviceList;
170 struct nmreq_port_info_get req;
171 struct nmreq_header hdr;
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';
185 int fd = open(
"/dev/netmap", O_RDWR);
187 SCLogError(
"%s: open netmap device failed: %s", ifname, strerror(errno));
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));
199 if (ioctl(fd, NIOCCTRL, &hdr) != 0) {
201 "Query of netmap HW rings count on %s failed; error: %s", ifname, strerror(errno));
206 if (req.nr_rx_rings == req.nr_tx_rings) {
207 rx_rings = req.nr_rx_rings;
217 static void NetmapDestroyDevice(NetmapDevice *pdev)
219 nmport_close(pdev->nmd);
229 static int NetmapClose(NetmapDevice *dev)
231 NetmapDevice *pdev, *tmp;
239 NetmapDestroyDevice(pdev);
253 static void NetmapCloseAll(
void)
255 NetmapDevice *pdev, *tmp;
260 NetmapDestroyDevice(pdev);
277 static int NetmapOpen(
NetmapIfaceSettings *ns, NetmapDevice **pdevice,
int verbose,
int read,
278 bool zerocopy,
bool soft)
283 char base_name[IFNAMSIZ];
285 if (strlen(base_name) > 0 &&
286 (base_name[strlen(base_name)-1] ==
'^' ||
287 base_name[strlen(base_name)-1] ==
'*'))
289 base_name[strlen(base_name)-1] =
'\0';
294 int if_flags = GetIfaceFlags(base_name);
295 if (if_flags == -1) {
297 SCLogError(
"%s: cannot access network interface: %s", base_name, ns->
iface);
303 if ((if_flags & IFF_UP) == 0) {
304 SCLogError(
"%s: interface is down", base_name);
308 if (ns->
promisc && (if_flags & (IFF_PROMISC|IFF_PPROMISC)) == 0) {
309 if_flags |= IFF_PPROMISC;
310 SetIfaceFlags(base_name, if_flags);
314 NetmapDevice *pdev = NULL, *spdev = NULL;
317 SCLogError(
"%s: memory allocation failed", base_name);
324 const int direction = (read != 1);
331 if (direction == spdev->direction && strcmp(ns->
iface, spdev->ifname) == 0) {
332 ring = spdev->ring + 1;
337 const char *opt_R =
"R";
338 const char *opt_T =
"T";
339 const char *opt_x =
"x";
340 const char *opt_z =
"z";
378 snprintf(optstr,
sizeof(optstr),
"%s%s%s", opt_z, opt_x, direction == 0 ? opt_R : opt_T);
381 if (strncmp(ns->
iface,
"netmap:", 7) == 0) {
382 snprintf(devname,
sizeof(devname),
"%s}%d%s%s",
383 ns->
iface, ring, strlen(optstr) ?
"/" :
"", optstr);
384 }
else if (strlen(ns->
iface) > 5 && strncmp(ns->
iface,
"vale", 4) == 0 && isdigit(ns->
iface[4])) {
385 snprintf(devname,
sizeof(devname),
"%s", ns->
iface);
386 }
else if (ring == 0 && ns->
threads == 1) {
388 snprintf(devname,
sizeof(devname),
"netmap:%s%s%s",
389 ns->
iface, strlen(optstr) ?
"/" :
"", optstr);
390 SCLogDebug(
"device with %s-ring enabled (devname): %s", soft ?
"SW" :
"HW", devname);
397 snprintf(devname,
sizeof(devname),
"netmap:%s%d%s%s@conf:host-rings=%d", ns->
iface,
398 ring, strlen(optstr) ?
"/" :
"", optstr, ns->
threads);
401 snprintf(devname,
sizeof(devname),
"netmap:%s%d%s%s", ns->
iface, ring,
402 strlen(optstr) ?
"/" :
"", optstr);
404 SCLogDebug(
"device with SW-ring enabled (devname): %s", devname);
405 }
else if (ring == 0 && soft) {
409 snprintf(devname,
sizeof(devname),
"netmap:%s-%d%s%s@conf:host-rings=%d", ns->
iface,
410 ring, strlen(optstr) ?
"/" :
"", optstr, ns->
threads);
411 SCLogDebug(
"device with HW-ring enabled (devname): %s", devname);
415 snprintf(devname,
sizeof(devname),
"netmap:%s-%d%s%s", ns->
iface, ring,
416 strlen(optstr) ?
"/" :
"", optstr);
417 SCLogDebug(
"device with HW-ring enabled (devname): %s", devname);
424 pdev->nmd = nmport_prepare(devname);
426 if (pdev->nmd != NULL) {
430 pdev->nmd->reg.nr_flags |= NR_NO_TX_POLL;
434 if (nmport_open_desc(pdev->nmd) < 0) {
436 nmport_close(pdev->nmd);
441 if (pdev->nmd == NULL) {
442 if (errno == EINVAL) {
443 if (opt_z[0] ==
'z') {
445 "%s: dev '%s' got EINVAL: going to retry without 'z'", base_name, devname);
448 }
else if (opt_x[0] ==
'x') {
450 "%s: dev '%s' got EINVAL: going to retry without 'x'", base_name, devname);
457 FatalError(
"opening devname %s failed: %s", devname, strerror(errno));
461 SCLogDebug(
"%s -- cur rings: [%d, %d] first rings: [%d, %d]", devname, pdev->nmd->cur_rx_ring,
462 pdev->nmd->cur_tx_ring, pdev->nmd->first_rx_ring, pdev->nmd->first_tx_ring);
463 pdev->nmd->cur_rx_ring = pdev->nmd->first_rx_ring;
464 pdev->nmd->cur_tx_ring = pdev->nmd->first_tx_ring;
466 SCLogInfo(
"%s: %s opened [fd: %d]", devname, ns->
iface, pdev->nmd->fd);
468 pdev->direction = direction;
485 static inline void NetmapDumpCounters(NetmapThreadVars *ntv)
487 StatsAddUI64(ntv->tv, ntv->capture_kernel_packets, ntv->pkts);
488 StatsAddUI64(ntv->tv, ntv->capture_kernel_drops, ntv->drops);
506 if (initdata == NULL) {
511 NetmapThreadVars *ntv =
SCCalloc(1,
sizeof(*ntv));
518 if (ntv->livedev == NULL) {
529 if (strcmp(
"workers", active_runmode) == 0) {
530 ntv->flags |= NETMAP_FLAG_ZERO_COPY;
532 }
else if (strcmp(
"autofp", active_runmode) == 0) {
533 ntv->flags |= NETMAP_FLAG_EXCL_RING_ACCESS;
538 if (NetmapOpen(&aconf->
in, &ntv->ifsrc, 1, 1, (ntv->flags & NETMAP_FLAG_ZERO_COPY) != 0,
544 if (NetmapOpen(&aconf->
out, &ntv->ifdst, 1, 0, (ntv->flags & NETMAP_FLAG_ZERO_COPY) != 0,
558 char errbuf[PCAP_ERRBUF_SIZE];
564 PCAP_NETMASK_UNKNOWN,
566 sizeof(errbuf)) == -1)
568 SCLogError(
"%s: failed to compile BPF \"%s\": %s", ntv->ifsrc->ifname,
584 NetmapClose(ntv->ifdst);
588 NetmapClose(ntv->ifsrc);
603 static TmEcode NetmapWritePacket(NetmapThreadVars *ntv,
Packet *p)
613 if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
624 (void)ioctl(ntv->ifdst->nmd->fd, NIOCTXSYNC, 0);
627 if (write_tries < 3) {
632 if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
635 SCLogDebug(
"failed to send %s -> %s", ntv->ifsrc->ifname, ntv->ifdst->ifname);
640 SCLogDebug(
"sent successfully: %s(%d)->%s(%d) (%u)", ntv->ifsrc->ifname, ntv->ifsrc->ring,
641 ntv->ifdst->ifname, ntv->ifdst->ring,
GET_PKT_LEN(p));
644 (void)ioctl(ntv->ifdst->nmd->fd, NIOCTXSYNC, 0);
645 if (ntv->flags & NETMAP_FLAG_EXCL_RING_ACCESS) {
655 static void NetmapReleasePacket(
Packet *p)
657 NetmapThreadVars *ntv = (NetmapThreadVars *)p->netmap_v.ntv;
660 NetmapWritePacket(ntv, p);
666 static void NetmapProcessPacket(NetmapThreadVars *ntv,
const struct nm_pkthdr *ph)
668 if (ntv->bpf_prog.bf_len) {
669 struct pcap_pkthdr pkthdr = { {0, 0}, ph->len, ph->len };
670 if (pcap_offline_filter(&ntv->bpf_prog, &pkthdr, ph->buf) == 0) {
685 ntv->bytes += ph->len;
687 if (ntv->flags & NETMAP_FLAG_ZERO_COPY) {
700 p->netmap_v.ntv = ntv;
702 SCLogDebug(
"pktlen: %" PRIu32
" (pkt %p, pkt data %p)",
705 (void)TmThreadsSlotProcessPkt(ntv->tv, ntv->slot, p);
714 static TmEcode NetmapReadPackets(
struct nmport_d *d,
int cnt, NetmapThreadVars *ntv)
716 struct nm_pkthdr hdr;
717 int last_ring = d->last_rx_ring - d->first_rx_ring + 1;
718 int cur_ring, got = 0, cur_rx_ring = d->cur_rx_ring;
720 memset(&hdr, 0,
sizeof(hdr));
721 hdr.flags = NM_MORE_PKTS;
726 for (cur_ring = 0; cur_ring < last_ring && cnt != got; cur_ring++, cur_rx_ring++) {
727 struct netmap_ring *ring;
729 if (cur_rx_ring > d->last_rx_ring)
730 cur_rx_ring = d->first_rx_ring;
732 ring = NETMAP_RXRING(d->nifp, cur_rx_ring);
735 for (; !nm_ring_empty(ring) && cnt != got; got++) {
738 struct netmap_slot *slot;
741 NetmapProcessPacket(ntv, &hdr);
745 slot = &ring->slot[i];
747 d->cur_rx_ring = cur_rx_ring;
749 oldbuf = hdr.buf = (u_char *)NETMAP_BUF(ring, idx);
750 hdr.len = hdr.caplen = slot->len;
753 while (slot->flags & NS_MOREFRAG) {
758 u_int oldlen = slot->len;
759 i = nm_ring_next(ring, i);
760 slot = &ring->slot[i];
761 hdr.len += slot->len;
762 nbuf = (u_char *)NETMAP_BUF(ring, slot->buf_idx);
764 if (oldbuf != NULL && nbuf - oldbuf == ring->nr_buf_size &&
765 oldlen == ring->nr_buf_size) {
766 hdr.caplen += slot->len;
774 ring->head = ring->cur = nm_ring_next(ring, i);
780 NetmapProcessPacket(ntv, &hdr);
793 NetmapThreadVars *ntv = (NetmapThreadVars *)data;
797 fds.fd = ntv->ifsrc->nmd->fd;
819 SCLogError(
"%s: error polling netmap: %s", ntv->ifsrc->ifname, strerror(errno));
825 NetmapDumpCounters(ntv);
829 TmThreadsCaptureHandleTimeout(
tv, NULL);
833 if (
unlikely(fds.revents & POLL_EVENTS)) {
834 if (fds.revents & POLLERR) {
835 SCLogError(
"%s: error reading netmap data via polling: %s", ntv->ifsrc->ifname,
837 }
else if (fds.revents & POLLNVAL) {
838 SCLogError(
"%s: invalid polling request", ntv->ifsrc->ifname);
843 if (
likely(fds.revents & POLLIN)) {
845 NetmapReadPackets(ntv->ifsrc->nmd, -1, ntv);
848 NetmapDumpCounters(ntv);
852 NetmapDumpCounters(ntv);
862 static void ReceiveNetmapThreadExitStats(
ThreadVars *
tv,
void *data)
865 NetmapThreadVars *ntv = (NetmapThreadVars *)data;
867 NetmapDumpCounters(ntv);
868 SCLogPerf(
"%s: (%s) packets %" PRIu64
", dropped %" PRIu64
", bytes %" PRIu64
"",
869 ntv->ifsrc->ifname,
tv->
name,
883 NetmapThreadVars *ntv = (NetmapThreadVars *)data;
886 NetmapClose(ntv->ifsrc);
890 NetmapClose(ntv->ifdst);
893 if (ntv->bpf_prog.bf_insns) {