[PATCH 0/5] Handle error events on UDP sockets
Add handling of the error queue for UDP sockets. We certainly need this for the flow table: this is the cause of the epoll loop that Stefano noticed. Even without the flow table it should improve robustness and debugability. Along the way we make a few other clean ups. David Gibson (5): conf: Don't configure port forwarding for a disabled protocol udp: Make udp_sock_recv static udp, tcp: Tweak handling of no_udp and no_tcp flags util: Add AF_UNSPEC support to sockaddr_ntop() udp: Handle errors on UDP sockets conf.c | 5 ++++ tcp.c | 14 ++++++++--- udp.c | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++++---- util.c | 33 +++++++++++++++++++++++++ util.h | 3 +++ 5 files changed, 124 insertions(+), 7 deletions(-) -- 2.45.2
UDP and/or TCP can be disabled with the --no-udp and --no-tcp options.
However, when this is specified, it's still possible to configure forwarded
ports for the disabled protocol. In some cases this will open sockets and
perform other actions, which might not be safe since the entire protocol
won't be initialised.
Check for this case, and explicitly forbid it.
Signed-off-by: David Gibson
Through an oversight this was previously declared as a public function
although it's only used in udp.c and there is no prototype in any header.
Signed-off-by: David Gibson
We abort the UDP socket handler if the no_udp flag is set. But if UDP
was disabled we should never have had a UDP socket to trigger the handler
in the first place. If we somehow did, ignoring it here isn't really going
to help because aborting without doing anything is likely to lead to an
epoll loop. The same is the case for the TCP socket and timer handlers and
the no_tcp flag.
Change these checks on the flag to ASSERT()s. Similarly add ASSERT()s to
several other entry points to the protocol specific code which should never
be called if the protocol is disabled.
Signed-off-by: David Gibson
Allow sockaddr_ntop() to format AF_UNSPEC socket addresses. There do exist
a few cases where we might legitimately have either an AF_UNSPEC or a real
address, such as the origin address from MSG_ERRQUEUE. Even in cases where
we shouldn't get an AF_UNSPEC address, formatting it is likely to make
things easier to debug if we ever somehow do.
Signed-off-by: David Gibson
Currently we ignore all events other than EPOLLIN on UDP sockets. This
means that if we ever receive an EPOLLERR event, we'll enter an infinite
loop on epoll, because we'll never do anything to clear the error.
Luckily that doesn't seem to have happened in practice, but it's certainly
fragile. Furthermore changes in how we handle UDP sockets with the flow
table mean we will start receiving error events.
Add handling of EPOLLERR events. For now we just read the error from the
error queue (thereby clearing the error state) and print a debug message.
We can add more substantial handling of specific events in future if we
want to.
Signed-off-by: David Gibson
Nits only (the rest of the series looks good to me):
On Tue, 16 Jul 2024 15:29:36 +1000
David Gibson
Currently we ignore all events other than EPOLLIN on UDP sockets. This means that if we ever receive an EPOLLERR event, we'll enter an infinite loop on epoll, because we'll never do anything to clear the error.
Luckily that doesn't seem to have happened in practice, but it's certainly fragile. Furthermore changes in how we handle UDP sockets with the flow table mean we will start receiving error events.
Add handling of EPOLLERR events. For now we just read the error from the error queue (thereby clearing the error state) and print a debug message. We can add more substantial handling of specific events in future if we want to.
Signed-off-by: David Gibson
--- udp.c | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ util.c | 29 +++++++++++++++++++++++++++++ util.h | 3 +++ 3 files changed, 91 insertions(+) diff --git a/udp.c b/udp.c index fbf3ce73..d761717a 100644 --- a/udp.c +++ b/udp.c @@ -110,6 +110,7 @@ #include
#include #include +#include #include "checksum.h" #include "util.h" @@ -728,6 +729,59 @@ static void udp_tap_prepare(const struct ctx *c, const struct mmsghdr *mmh, (*tap_iov)[UDP_IOV_PAYLOAD].iov_len = l4len; }
+/** + * udp_sock_recverr() - Receive and clear an error from a socket + * @s: Socket to receive from + * + * Return: true if an error received and processed, false if no more errors
It took me a while to realise there's an implied "was" between "error" and "received". Maybe: * Return: true: errors received and processed, false: no more errors ?
+ * + * #syscalls recvmsg + */ +static bool udp_sock_recverr(int s) +{ + const struct sock_extended_err *ee; + const struct cmsghdr *hdr; + char buf[CMSG_SPACE(sizeof(*ee))]; + struct msghdr mh = { + .msg_name = NULL, + .msg_namelen = 0, + .msg_iov = NULL, + .msg_iovlen = 0, + .msg_control = buf, + .msg_controllen = sizeof(buf), + }; + ssize_t rc; + + rc = recvmsg(s, &mh, MSG_ERRQUEUE); + if (rc < 0) { + if (errno != EAGAIN)
There are some existing cases where we forgot about this, but EAGAIN and EWOULDBLOCK are not guaranteed to be the same value, and as recvmsg(2) says: POSIX.1 allows either error to be returned for this case, and does not require these constants to have the same value, so a portable application should check for both possibilities.
+ err_perror("Failed to read error queue"); + return false; + } + + if (!(mh.msg_flags & MSG_ERRQUEUE)) { + err("Missing MSG_ERRQUEUE flag reading error queue"); + return false; + } + + hdr = CMSG_FIRSTHDR(&mh); + if (!((hdr->cmsg_level == IPPROTO_IP && + hdr->cmsg_type == IP_RECVERR) || + (hdr->cmsg_level == IPPROTO_IPV6 && + hdr->cmsg_type == IPV6_RECVERR))) { + err("Unexpected cmsg reading error queue"); + return false; + } + + ee = (const struct sock_extended_err *)CMSG_DATA(hdr); + + /* TODO: When possible propagate and otherwise handle errors */ + debug("%s error on UDP socket %i: %s", + str_ee_origin(ee), s, strerror(ee->ee_errno)); + + return true; +} + /** * udp_sock_recv() - Receive datagrams from a socket * @c: Execution context @@ -751,6 +805,11 @@ static int udp_sock_recv(const struct ctx *c, int s, uint32_t events,
ASSERT(!c->no_udp);
+ /* Clear any errors first */ + if (events & EPOLLERR)
For consistency: curly brackets around multi-line block (or simply change that to "while (udp_sock_recverr(s));"? No preference from me).
+ while (udp_sock_recverr(s)) + ; + if (!(events & EPOLLIN)) return 0;
diff --git a/util.c b/util.c index 428847d2..70de1e16 100644 --- a/util.c +++ b/util.c @@ -25,6 +25,7 @@ #include
#include #include +#include #include "util.h" #include "iov.h" @@ -97,6 +98,14 @@ static int sock_l4_sa(const struct ctx *c, enum epoll_type type, if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &y, sizeof(y))) debug("Failed to set SO_REUSEADDR on socket %i", fd);
+ if (proto == IPPROTO_UDP) { + int level = af == AF_INET ? IPPROTO_IP : IPPROTO_IPV6; + int opt = af == AF_INET ? IP_RECVERR : IPV6_RECVERR; + + if (setsockopt(fd, level, opt, &y, sizeof(y))) + die("Failed to set RECVERR on socket %i", fd);
There's also a die_perror() which would be practical here.
+ } + if (ifname && *ifname) { /* Supported since kernel version 5.7, commit c427bfec18f2 * ("net: core: enable SO_BINDTODEVICE for non-root users"). If @@ -654,3 +663,23 @@ const char *sockaddr_ntop(const void *sa, char *dst, socklen_t size)
return dst; } + +/** str_ee_origin() - Convert socket extended error origin to a string + * @ee: Socket extended error structure + * + * Return: Static string describing error origin + */ +const char *str_ee_origin(const struct sock_extended_err *ee) +{ + const char *const desc[] = { + [SO_EE_ORIGIN_NONE] = "<no origin>", + [SO_EE_ORIGIN_LOCAL] = "Local", + [SO_EE_ORIGIN_ICMP] = "ICMP", + [SO_EE_ORIGIN_ICMP6] = "ICMPv6", + }; + + if (ee->ee_origin < ARRAY_SIZE(desc)) + return desc[ee->ee_origin]; + + return "<invalid>"; +} diff --git a/util.h b/util.h index d0150396..1d479ddf 100644 --- a/util.h +++ b/util.h @@ -194,7 +194,10 @@ static inline const char *af_name(sa_family_t af)
#define SOCKADDR_STRLEN MAX(SOCKADDR_INET_STRLEN, SOCKADDR_INET6_STRLEN)
+struct sock_extended_err; + const char *sockaddr_ntop(const void *sa, char *dst, socklen_t size); +const char *str_ee_origin(const struct sock_extended_err *ee);
/** * mod_sub() - Modular arithmetic subtraction
-- Stefano
On Tue, Jul 16, 2024 at 09:25:56AM +0200, Stefano Brivio wrote:
Nits only (the rest of the series looks good to me):
On Tue, 16 Jul 2024 15:29:36 +1000 David Gibson
wrote: Currently we ignore all events other than EPOLLIN on UDP sockets. This means that if we ever receive an EPOLLERR event, we'll enter an infinite loop on epoll, because we'll never do anything to clear the error.
Luckily that doesn't seem to have happened in practice, but it's certainly fragile. Furthermore changes in how we handle UDP sockets with the flow table mean we will start receiving error events.
Add handling of EPOLLERR events. For now we just read the error from the error queue (thereby clearing the error state) and print a debug message. We can add more substantial handling of specific events in future if we want to.
Signed-off-by: David Gibson
--- udp.c | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ util.c | 29 +++++++++++++++++++++++++++++ util.h | 3 +++ 3 files changed, 91 insertions(+) diff --git a/udp.c b/udp.c index fbf3ce73..d761717a 100644 --- a/udp.c +++ b/udp.c @@ -110,6 +110,7 @@ #include
#include #include +#include #include "checksum.h" #include "util.h" @@ -728,6 +729,59 @@ static void udp_tap_prepare(const struct ctx *c, const struct mmsghdr *mmh, (*tap_iov)[UDP_IOV_PAYLOAD].iov_len = l4len; }
+/** + * udp_sock_recverr() - Receive and clear an error from a socket + * @s: Socket to receive from + * + * Return: true if an error received and processed, false if no more errors
It took me a while to realise there's an implied "was" between "error" and "received". Maybe:
* Return: true: errors received and processed, false: no more errors
?
Adjusted.
+ * + * #syscalls recvmsg + */ +static bool udp_sock_recverr(int s) +{ + const struct sock_extended_err *ee; + const struct cmsghdr *hdr; + char buf[CMSG_SPACE(sizeof(*ee))]; + struct msghdr mh = { + .msg_name = NULL, + .msg_namelen = 0, + .msg_iov = NULL, + .msg_iovlen = 0, + .msg_control = buf, + .msg_controllen = sizeof(buf), + }; + ssize_t rc; + + rc = recvmsg(s, &mh, MSG_ERRQUEUE); + if (rc < 0) { + if (errno != EAGAIN)
There are some existing cases where we forgot about this, but EAGAIN and EWOULDBLOCK are not guaranteed to be the same value, and as recvmsg(2) says:
POSIX.1 allows either error to be returned for this case, and does not require these constants to have the same value, so a portable application should check for both possibilities.
Fair point. We're Linux only for now where they certainly do have the same value, but no reason not to be robust against portability in future.
+ err_perror("Failed to read error queue"); + return false; + } + + if (!(mh.msg_flags & MSG_ERRQUEUE)) { + err("Missing MSG_ERRQUEUE flag reading error queue"); + return false; + } + + hdr = CMSG_FIRSTHDR(&mh); + if (!((hdr->cmsg_level == IPPROTO_IP && + hdr->cmsg_type == IP_RECVERR) || + (hdr->cmsg_level == IPPROTO_IPV6 && + hdr->cmsg_type == IPV6_RECVERR))) { + err("Unexpected cmsg reading error queue"); + return false; + } + + ee = (const struct sock_extended_err *)CMSG_DATA(hdr); + + /* TODO: When possible propagate and otherwise handle errors */ + debug("%s error on UDP socket %i: %s", + str_ee_origin(ee), s, strerror(ee->ee_errno)); + + return true; +} + /** * udp_sock_recv() - Receive datagrams from a socket * @c: Execution context @@ -751,6 +805,11 @@ static int udp_sock_recv(const struct ctx *c, int s, uint32_t events,
ASSERT(!c->no_udp);
+ /* Clear any errors first */ + if (events & EPOLLERR)
For consistency: curly brackets around multi-line block (or simply change that to "while (udp_sock_recverr(s));"? No preference from me).
Done.
+ while (udp_sock_recverr(s)) + ; + if (!(events & EPOLLIN)) return 0;
diff --git a/util.c b/util.c index 428847d2..70de1e16 100644 --- a/util.c +++ b/util.c @@ -25,6 +25,7 @@ #include
#include #include +#include #include "util.h" #include "iov.h" @@ -97,6 +98,14 @@ static int sock_l4_sa(const struct ctx *c, enum epoll_type type, if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &y, sizeof(y))) debug("Failed to set SO_REUSEADDR on socket %i", fd);
+ if (proto == IPPROTO_UDP) { + int level = af == AF_INET ? IPPROTO_IP : IPPROTO_IPV6; + int opt = af == AF_INET ? IP_RECVERR : IPV6_RECVERR; + + if (setsockopt(fd, level, opt, &y, sizeof(y))) + die("Failed to set RECVERR on socket %i", fd);
There's also a die_perror() which would be practical here.
Oops, I think I meant to use that. Done.
+ } + if (ifname && *ifname) { /* Supported since kernel version 5.7, commit c427bfec18f2 * ("net: core: enable SO_BINDTODEVICE for non-root users"). If @@ -654,3 +663,23 @@ const char *sockaddr_ntop(const void *sa, char *dst, socklen_t size)
return dst; } + +/** str_ee_origin() - Convert socket extended error origin to a string + * @ee: Socket extended error structure + * + * Return: Static string describing error origin + */ +const char *str_ee_origin(const struct sock_extended_err *ee) +{ + const char *const desc[] = { + [SO_EE_ORIGIN_NONE] = "<no origin>", + [SO_EE_ORIGIN_LOCAL] = "Local", + [SO_EE_ORIGIN_ICMP] = "ICMP", + [SO_EE_ORIGIN_ICMP6] = "ICMPv6", + }; + + if (ee->ee_origin < ARRAY_SIZE(desc)) + return desc[ee->ee_origin]; + + return "<invalid>"; +} diff --git a/util.h b/util.h index d0150396..1d479ddf 100644 --- a/util.h +++ b/util.h @@ -194,7 +194,10 @@ static inline const char *af_name(sa_family_t af)
#define SOCKADDR_STRLEN MAX(SOCKADDR_INET_STRLEN, SOCKADDR_INET6_STRLEN)
+struct sock_extended_err; + const char *sockaddr_ntop(const void *sa, char *dst, socklen_t size); +const char *str_ee_origin(const struct sock_extended_err *ee);
/** * mod_sub() - Modular arithmetic subtraction
-- David Gibson (he or they) | I'll have my music baroque, and my code david AT gibson.dropbear.id.au | minimalist, thank you, not the other way | around. http://www.ozlabs.org/~dgibson
participants (2)
-
David Gibson
-
Stefano Brivio