From 1cb6f9e11af16830da8c0abe59fad24aee468957 Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Tue, 9 Aug 2022 15:07:23 +0200 Subject: [PATCH 1/2] sys/net/gnrc/netif: provide support for confirm_send() This adds support for netdevs implementing the new API that provides `netdev_driver_t::confirm_send()`. This allows implementing netdevs in an event based non-blocking fashion, making live of driver developers a bit easier. In addition, `gnrc_tx_sync` will now throttle users of `sock_udp_send()` so that they can only send datagrams as fast as the network stack and hardware is able to send out. Finally, this lays the groundwork to fetch TX statistics (such as TX timestamps, reception of layer 2 ACKs/NACKs, etc.) from the network devices. --- sys/include/net/gnrc/netif.h | 18 ++- sys/include/net/gnrc/netif/flags.h | 6 + sys/net/gnrc/netif/gnrc_netif.c | 186 +++++++++++++++++++++-------- 3 files changed, 156 insertions(+), 54 deletions(-) diff --git a/sys/include/net/gnrc/netif.h b/sys/include/net/gnrc/netif.h index 9247e00f45..8b84afd8c8 100644 --- a/sys/include/net/gnrc/netif.h +++ b/sys/include/net/gnrc/netif.h @@ -118,7 +118,7 @@ typedef struct { const gnrc_netif_ops_t *ops; /**< Operations of the network interface */ netdev_t *dev; /**< Network device of the network interface */ rmutex_t mutex; /**< Mutex of the interface */ -#ifdef MODULE_NETSTATS_L2 +#if IS_USED(MODULE_NETSTATS_L2) || defined(DOXYGEN) netstats_t stats; /**< transceiver's statistics */ #endif #if IS_USED(MODULE_GNRC_NETIF_LORAWAN) || defined(DOXYGEN) @@ -147,6 +147,22 @@ typedef struct { * @brief ISR event for the network device */ event_t event_isr; +#if IS_USED(MODULE_NETDEV_NEW_API) || defined(DOXYGEN) + /** + * @brief TX done event for the network device + * + * @details Only provided with module `netdev_new_api` + */ + event_t event_tx_done; + /** + * @brief Outgoing frame that is currently transmitted + * + * @details Only provided with module `netdev_new_api` + * + * This needs to be freed by gnrc_netif once TX is done + */ + gnrc_pktsnip_t *tx_pkt; +#endif #if (GNRC_NETIF_L2ADDR_MAXLEN > 0) || DOXYGEN /** * @brief The link-layer address currently used as the source address diff --git a/sys/include/net/gnrc/netif/flags.h b/sys/include/net/gnrc/netif/flags.h index 2d02e80cc3..32d41c11e6 100644 --- a/sys/include/net/gnrc/netif/flags.h +++ b/sys/include/net/gnrc/netif/flags.h @@ -90,6 +90,12 @@ enum { */ #define GNRC_NETIF_FLAGS_IPV6_ADV_O_FLAG (0x00000080U) +/** + * @brief Used when module gnrc_netif_pktq is used to indicate that + * @ref gnrc_netif_t::tx_pkt is from the packet queue. + */ +#define GNRC_NETIF_FLAGS_TX_FROM_PKTQUEUE (0x00000100U) + /** * @brief This interface uses 6Lo header compression * diff --git a/sys/net/gnrc/netif/gnrc_netif.c b/sys/net/gnrc/netif/gnrc_netif.c index 408417c23d..ea293ddc08 100644 --- a/sys/net/gnrc/netif/gnrc_netif.c +++ b/sys/net/gnrc/netif/gnrc_netif.c @@ -1728,53 +1728,14 @@ static void _send_queued_pkt(gnrc_netif_t *netif) #endif /* IS_USED(MODULE_GNRC_NETIF_PKTQ) */ } -static void _send(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt, bool push_back) +static void _tx_done(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt, + gnrc_pktsnip_t *tx_sync , int res, bool push_back) { (void)push_back; /* only used with IS_USED(MODULE_GNRC_NETIF_PKTQ) */ - int res; -#if IS_USED(MODULE_GNRC_NETIF_PKTQ) - /* send queued packets first to keep order */ - if (!push_back && !gnrc_netif_pktq_empty(netif)) { - int put_res; + uint32_t err = (res < 0) ? -res : GNRC_NETERR_SUCCESS; - put_res = gnrc_netif_pktq_put(netif, pkt); - if (put_res == 0) { - DEBUG("gnrc_netif: (re-)queued pkt %p\n", (void *)pkt); - _send_queued_pkt(netif); - return; - } - else { - LOG_WARNING("gnrc_netif: can't queue packet for sending\n"); - /* try to send anyway */ - } - } - /* hold in case device was busy to not having to rewrite *all* the link - * layer implementations in case `gnrc_netif_pktq` is included */ - gnrc_pktbuf_hold(pkt, 1); -#endif /* IS_USED(MODULE_GNRC_NETIF_PKTQ) */ - - /* Record send in neighbor statistics if destination is unicast */ - if (IS_USED(MODULE_NETSTATS_NEIGHBOR)) { - gnrc_netif_hdr_t *netif_hdr = pkt->data; - if (netif_hdr->flags & - (GNRC_NETIF_HDR_FLAGS_BROADCAST | GNRC_NETIF_HDR_FLAGS_MULTICAST)) { - DEBUG("l2 stats: Destination is multicast or unicast, NULL recorded\n"); - netstats_nb_record(&netif->netif, NULL, 0); - } else { - DEBUG("l2 stats: recording transmission\n"); - netstats_nb_record(&netif->netif, - gnrc_netif_hdr_get_dst_addr(netif_hdr), - netif_hdr->dst_l2addr_len); - } - } - - /* Split off the TX sync snip */ - gnrc_pktsnip_t *tx_sync = IS_USED(MODULE_GNRC_TX_SYNC) - ? gnrc_tx_sync_split(pkt) : NULL; - res = netif->ops->send(netif, pkt); if (tx_sync != NULL) { - uint32_t err = (res < 0) ? -res : GNRC_NETERR_SUCCESS; gnrc_pktbuf_release_error(tx_sync, err); } @@ -1826,6 +1787,114 @@ static void _send(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt, bool push_back) gnrc_pktbuf_release(pkt); } #endif /* IS_USED(MODULE_GNRC_NETIF_PKTQ) */ + + if (gnrc_netif_netdev_new_api(netif)) { + /* with new netdev (with confirm_send), the netif remains owner of the + * pkt and is in charge of releasing it once TX is completed */ + gnrc_pktbuf_release_error(pkt, err); + } +} + +#if IS_USED(MODULE_NETDEV_NEW_API) +/** + * @brief Call the confirm_send handler from an event + * + * @param[in] evp pointer to the event + */ +static void _event_handler_tx_done(event_t *evp) +{ + gnrc_netif_t *netif = container_of(evp, gnrc_netif_t, event_tx_done); + int res = netif->dev->driver->confirm_send(netif->dev, NULL); + /* after confirm_send() is called, the device is ready to send the next + * frame. So clear netif->tx_pkt to signal readiness */ + gnrc_pktsnip_t *pkt = netif->tx_pkt; + netif->tx_pkt = NULL; + bool push_back = netif->flags & GNRC_NETIF_FLAGS_TX_FROM_PKTQUEUE; + netif->flags &= ~GNRC_NETIF_FLAGS_TX_FROM_PKTQUEUE; + _tx_done(netif, pkt, NULL, res, push_back); +} +#endif + +static void _send(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt, bool push_back) +{ +#if IS_USED(MODULE_NETDEV_NEW_API) + if (netif->tx_pkt != NULL) { + /* Upper layer is handing out frames faster than hardware can transmit. + * Note that not only doesn't it make sense to bother the driver if it + * is still busy, but overwriting netif->tx_pkt would leak the memory + * of the current sent frame. + * + * Also note: If gnrc_netif_pktq is used, it will (try to) queue the + * outgoing frame to send it later on. + * */ + _tx_done(netif, pkt, NULL, -EBUSY, push_back); + return; + } +#endif + +#if IS_USED(MODULE_GNRC_NETIF_PKTQ) + /* send queued packets first to keep order */ + if (!push_back && !gnrc_netif_pktq_empty(netif)) { + int put_res; + + /* try to send pkt from queue first. At least with the legacy blocking + * API, this may make room in the pktqueue */ + _send_queued_pkt(netif); + + put_res = gnrc_netif_pktq_put(netif, pkt); + if (put_res == 0) { + DEBUG("gnrc_netif: (re-)queued pkt %p\n", (void *)pkt); + return; + } + else { + LOG_WARNING("gnrc_netif: can't queue packet for sending\n"); + /* try to send anyway */ + } + } + /* hold in case device was busy to not having to rewrite *all* the link + * layer implementations in case `gnrc_netif_pktq` is included */ + gnrc_pktbuf_hold(pkt, 1); +#endif /* IS_USED(MODULE_GNRC_NETIF_PKTQ) */ + + /* Record send in neighbor statistics if destination is unicast */ + if (IS_USED(MODULE_NETSTATS_NEIGHBOR)) { + gnrc_netif_hdr_t *netif_hdr = pkt->data; + if (netif_hdr->flags & + (GNRC_NETIF_HDR_FLAGS_BROADCAST | GNRC_NETIF_HDR_FLAGS_MULTICAST)) { + DEBUG("l2 stats: Destination is multicast or unicast, NULL recorded\n"); + netstats_nb_record(&netif->netif, NULL, 0); + } else { + DEBUG("l2 stats: recording transmission\n"); + netstats_nb_record(&netif->netif, + gnrc_netif_hdr_get_dst_addr(netif_hdr), + netif_hdr->dst_l2addr_len); + } + } + + /* Split off the TX sync snip */ + gnrc_pktsnip_t *tx_sync = IS_USED(MODULE_GNRC_TX_SYNC) + ? gnrc_tx_sync_split(pkt) : NULL; + int res = netif->ops->send(netif, pkt); + + /* For legacy netdevs (no confirm_send) TX is blocking, thus it is always + * completed. For new netdevs (with confirm_send), TX is async. It is only + * done if TX failed right away (res < 0). + */ + if (gnrc_netif_netdev_legacy_api(netif) || (res < 0)) { + _tx_done(netif, pkt, tx_sync, res, push_back); + } +#if IS_USED(MODULE_NETDEV_NEW_API) + else { + /* new API *and* send() was a success --> block netif and memorize + * frame to free memory later */ + netif->tx_pkt = pkt; + } + + gnrc_pkt_append(pkt, tx_sync); + if (IS_USED(MODULE_GNRC_NETIF_PKTQ) && push_back) { + netif->flags |= GNRC_NETIF_FLAGS_TX_FROM_PKTQUEUE; + } +#endif } static void *_gnrc_netif_thread(void *args) @@ -1842,7 +1911,10 @@ static void *_gnrc_netif_thread(void *args) gnrc_netif_acquire(netif); netif->pid = thread_getpid(); - netif->event_isr.handler = _event_handler_isr, + netif->event_isr.handler = _event_handler_isr; +#if IS_USED(MODULE_NETDEV_NEW_API) + netif->event_tx_done.handler = _event_handler_tx_done; +#endif /* set up the event queue */ event_queue_init(&netif->evq); @@ -1954,11 +2026,17 @@ static void _pass_on_packet(gnrc_pktsnip_t *pkt) static void _event_cb(netdev_t *dev, netdev_event_t event) { - gnrc_netif_t *netif = (gnrc_netif_t *) dev->context; + gnrc_netif_t *netif = (gnrc_netif_t *)dev->context; if (event == NETDEV_EVENT_ISR) { event_post(&netif->evq, &netif->event_isr); } +#if IS_USED(MODULE_NETDEV_NEW_API) + else if (gnrc_netif_netdev_new_api(netif) + && (event == NETDEV_EVENT_TX_COMPLETE)) { + event_post(&netif->evq, &netif->event_tx_done); + } +#endif else { DEBUG("gnrc_netif: event triggered -> %i\n", event); gnrc_pktsnip_t *pkt = NULL; @@ -1974,7 +2052,8 @@ static void _event_cb(netdev_t *dev, netdev_event_t event) _pass_on_packet(pkt); } break; -#if IS_USED(MODULE_NETSTATS_L2) || IS_USED(MODULE_GNRC_NETIF_PKTQ) +#if IS_USED(MODULE_NETDEV_LEGACY_API) +# if IS_USED(MODULE_NETSTATS_L2) || IS_USED(MODULE_GNRC_NETIF_PKTQ) case NETDEV_EVENT_TX_COMPLETE: case NETDEV_EVENT_TX_COMPLETE_DATA_PENDING: /* send packet previously queued within netif due to the lower @@ -1982,20 +2061,20 @@ static void _event_cb(netdev_t *dev, netdev_event_t event) * Further packets will be sent on later TX_COMPLETE or * TX_MEDIUM_BUSY */ _send_queued_pkt(netif); -#if IS_USED(MODULE_NETSTATS_L2) +# if IS_USED(MODULE_NETSTATS_L2) /* we are the only ones supposed to touch this variable, * so no acquire necessary */ netif->stats.tx_success++; -#endif /* IS_USED(MODULE_NETSTATS_L2) */ +# endif /* IS_USED(MODULE_NETSTATS_L2) */ if (IS_USED(MODULE_NETSTATS_NEIGHBOR)) { int8_t retries = -1; dev->driver->get(dev, NETOPT_TX_RETRIES_NEEDED, &retries, sizeof(retries)); netstats_nb_update_tx(&netif->netif, NETSTATS_NB_SUCCESS, retries + 1); } break; -#endif /* IS_USED(MODULE_NETSTATS_L2) || IS_USED(MODULE_GNRC_NETIF_PKTQ) */ -#if IS_USED(MODULE_NETSTATS_L2) || IS_USED(MODULE_GNRC_NETIF_PKTQ) || \ - IS_USED(MODULE_NETSTATS_NEIGHBOR) +# endif /* IS_USED(MODULE_NETSTATS_L2) || IS_USED(MODULE_GNRC_NETIF_PKTQ) */ +# if IS_USED(MODULE_NETSTATS_L2) || IS_USED(MODULE_GNRC_NETIF_PKTQ) || \ + IS_USED(MODULE_NETSTATS_NEIGHBOR) case NETDEV_EVENT_TX_MEDIUM_BUSY: case NETDEV_EVENT_TX_NOACK: /* update neighbor statistics */ @@ -2015,13 +2094,14 @@ static void _event_cb(netdev_t *dev, netdev_event_t event) * Further packets will be sent on later TX_COMPLETE or * TX_MEDIUM_BUSY */ _send_queued_pkt(netif); -#if IS_USED(MODULE_NETSTATS_L2) +# if IS_USED(MODULE_NETSTATS_L2) /* we are the only ones supposed to touch this variable, * so no acquire necessary */ netif->stats.tx_failed++; -#endif /* IS_USED(MODULE_NETSTATS_L2) */ +# endif /* IS_USED(MODULE_NETSTATS_L2) */ break; -#endif /* IS_USED(MODULE_NETSTATS_L2) || IS_USED(MODULE_GNRC_NETIF_PKTQ) */ +# endif /* IS_USED(MODULE_NETSTATS_L2) || IS_USED(MODULE_GNRC_NETIF_PKTQ) */ +#endif /* IS_USED(MODULE_NETDEV_LEGACY_API) */ default: DEBUG("gnrc_netif: warning: unhandled event %u.\n", event); } From 581f35e577f3bda8ca2a55a1d27011b3e7e79513 Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Thu, 14 Jan 2021 22:16:30 +0100 Subject: [PATCH 2/2] sys/net/gnrc/netif: adapt to new API For Ethernet, raw netifs, and IEEE 802.15.4 netifs only release outgoing frame with legacy drivers, as gnrc_netif does so with new non-blocking API. --- sys/net/gnrc/netif/ethernet/gnrc_netif_ethernet.c | 5 ++++- sys/net/gnrc/netif/gnrc_netif_raw.c | 6 ++++-- sys/net/gnrc/netif/ieee802154/gnrc_netif_ieee802154.c | 6 ++++-- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/sys/net/gnrc/netif/ethernet/gnrc_netif_ethernet.c b/sys/net/gnrc/netif/ethernet/gnrc_netif_ethernet.c index bc159a8549..5f78c086b8 100644 --- a/sys/net/gnrc/netif/ethernet/gnrc_netif_ethernet.c +++ b/sys/net/gnrc/netif/ethernet/gnrc_netif_ethernet.c @@ -162,7 +162,10 @@ static int _send(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt) #endif res = dev->driver->send(dev, &iolist); - gnrc_pktbuf_release(pkt); + if (gnrc_netif_netdev_legacy_api(netif)) { + /* only for legacy drivers we need to release pkt here */ + gnrc_pktbuf_release(pkt); + } return res; } diff --git a/sys/net/gnrc/netif/gnrc_netif_raw.c b/sys/net/gnrc/netif/gnrc_netif_raw.c index bf6dbeaf02..0ba358fd17 100644 --- a/sys/net/gnrc/netif/gnrc_netif_raw.c +++ b/sys/net/gnrc/netif/gnrc_netif_raw.c @@ -120,8 +120,10 @@ static int _send(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt) #endif res = dev->driver->send(dev, (iolist_t *)pkt); - /* release old data */ - gnrc_pktbuf_release(pkt); + if (gnrc_netif_netdev_legacy_api(netif)) { + /* only for legacy drivers we need to release pkt here */ + gnrc_pktbuf_release(pkt); + } return res; } diff --git a/sys/net/gnrc/netif/ieee802154/gnrc_netif_ieee802154.c b/sys/net/gnrc/netif/ieee802154/gnrc_netif_ieee802154.c index 8ac465145d..806f94fb6d 100644 --- a/sys/net/gnrc/netif/ieee802154/gnrc_netif_ieee802154.c +++ b/sys/net/gnrc/netif/ieee802154/gnrc_netif_ieee802154.c @@ -398,8 +398,10 @@ static int _send(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt) res = dev->driver->send(dev, &iolist_header); #endif - /* release old data */ - gnrc_pktbuf_release(pkt); + if (gnrc_netif_netdev_legacy_api(netif)) { + /* only for legacy drivers we need to release pkt here */ + gnrc_pktbuf_release(pkt); + } return res; } /** @} */