Merge pull request #11215 from mikeysklar/fix/socketpool-gaierror-real-code

socketpool: let ports raise gaierror with the real error code

Author: dhalbert

ports/zephyr-cp/common-hal/socketpool/Socket.c

@@ -27,6 +27,7 @@
 #include <string.h>
 
 #include <zephyr/kernel.h>
+#include <zephyr/net/dns_resolve.h>
 #include <zephyr/net/socket.h>
 
 #define SOCKETPOOL_IP_STR_LEN 48
@@ -82,7 +83,12 @@ static void socketpool_resolve_host_or_throw(int family, int type, const char *h
 
     int error = zsock_getaddrinfo(hostname, service_buf, &hints, &result_i);
     if (error != 0 || result_i == NULL) {
-        common_hal_socketpool_socketpool_raise_gaierror_noname();
+        // Report what the resolver said. A null result with no error is the
+        // one case that really is "not found".
+        if (error == 0) {
+            error = DNS_EAI_NONAME;
+        }
+        common_hal_socketpool_socketpool_raise_gaierror(error);
     }
 
     memcpy(addr, result_i->ai_addr, sizeof(struct sockaddr_storage));

ports/zephyr-cp/common-hal/socketpool/SocketPool.c

@@ -20,6 +20,7 @@
 #include <string.h>
 
 #include <zephyr/net/socket.h>
+#include <zephyr/net/dns_resolve.h>
 
 void common_hal_socketpool_socketpool_construct(socketpool_socketpool_obj_t *self, mp_obj_t radio) {
     bool is_wifi = false;
@@ -104,7 +105,10 @@ mp_obj_t common_hal_socketpool_getaddrinfo_raise(socketpool_socketpool_obj_t *se
     struct zsock_addrinfo *res = NULL;
     int err = socketpool_getaddrinfo_common(host, port, &hints, &res);
     if (err != 0 || res == NULL) {
-        common_hal_socketpool_socketpool_raise_gaierror_noname();
+        if (err == 0) {
+            err = DNS_EAI_NONAME;
+        }
+        common_hal_socketpool_socketpool_raise_gaierror(err);
     }
 
     nlr_buf_t nlr;

shared-bindings/socketpool/SocketPool.c

@@ -190,15 +190,27 @@ MP_DEFINE_CONST_OBJ_TYPE(
     );
 
 MP_WEAK MP_NORETURN
-void common_hal_socketpool_socketpool_raise_gaierror_noname(void) {
+void common_hal_socketpool_socketpool_raise_gaierror(int err) {
     vstr_t vstr;
     mp_print_t print;
     vstr_init_print(&vstr, 64, &print);
-    mp_printf(&print, "%S", MP_ERROR_TEXT("Name or service not known"));
+    // Only EAI_NONAME means the name was not found. Other codes cover
+    // unrelated failures, such as an unsupported family, so use the generic
+    // message for those rather than one that would be misleading.
+    if (err == SOCKETPOOL_EAI_NONAME) {
+        mp_printf(&print, "%S", MP_ERROR_TEXT("Name or service not known"));
+    } else {
+        mp_cprintf(&print, MP_ERROR_TEXT("%q failure: %d"), MP_QSTR_getaddrinfo, err);
+    }
 
     mp_obj_t exc_args[] = {
-        MP_OBJ_NEW_SMALL_INT(SOCKETPOOL_EAI_NONAME),
+        MP_OBJ_NEW_SMALL_INT(err),
         mp_obj_new_str_from_vstr(&vstr),
     };
     nlr_raise(mp_obj_new_exception_args(&mp_type_gaierror, MP_ARRAY_SIZE(exc_args), exc_args));
 }
+
+MP_WEAK MP_NORETURN
+void common_hal_socketpool_socketpool_raise_gaierror_noname(void) {
+    common_hal_socketpool_socketpool_raise_gaierror(SOCKETPOOL_EAI_NONAME);
+}

shared-bindings/socketpool/SocketPool.h

@@ -26,5 +26,6 @@ bool socketpool_socket(socketpool_socketpool_obj_t *self,
     int proto, socketpool_socket_obj_t *sock);
 
 MP_NORETURN void common_hal_socketpool_socketpool_raise_gaierror_noname(void);
+MP_NORETURN void common_hal_socketpool_socketpool_raise_gaierror(int err);
 
 mp_obj_t common_hal_socketpool_getaddrinfo_raise(socketpool_socketpool_obj_t *self, const char *host, int port, int family, int type, int proto, int flags);