From: Witold Kręcicki <wpk@isc.org>
Date: Mon, 2 Dec 2019 10:19:55 +0000 (+0100)
Subject: Add uv_handle_{get,set}_data functions that's absent in pre-1.19 libuv to make code... 
X-Git-Tag: v9.15.7~20^2~15
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5a65ec0affbebbdc63726de97960eaa898c7852a;p=thirdparty%2Fbind9.git

Add uv_handle_{get,set}_data functions that's absent in pre-1.19 libuv to make code clearer.
This might be removed when we stop supporting older libuv versions.
---

diff --git a/config.h.in b/config.h.in
index 88f46849b8d..1b0a2a6a629 100644
--- a/config.h.in
+++ b/config.h.in
@@ -465,6 +465,12 @@
 /* Define to 1 if you have the `usleep' function. */
 #undef HAVE_USLEEP
 
+/* Define to 1 if you have the `uv_handle_get_data' function. */
+#undef HAVE_UV_HANDLE_GET_DATA
+
+/* Define to 1 if you have the `uv_handle_set_data' function. */
+#undef HAVE_UV_HANDLE_SET_DATA
+
 /* Use zlib library */
 #undef HAVE_ZLIB
 
diff --git a/configure b/configure
index 7d1629af0e9..a3eb8aa1d20 100755
--- a/configure
+++ b/configure
@@ -15943,6 +15943,21 @@ fi
 CFLAGS="$CFLAGS $LIBUV_CFLAGS"
 LIBS="$LIBS $LIBUV_LIBS"
 
+# Those functions are only provided in newer versions of libuv, we'll be emulating them
+# for now
+for ac_func in uv_handle_get_data uv_handle_set_data
+do :
+  as_ac_var=`$as_echo "ac_cv_func_$ac_func" | $as_tr_sh`
+ac_fn_c_check_func "$LINENO" "$ac_func" "$as_ac_var"
+if eval test \"x\$"$as_ac_var"\" = x"yes"; then :
+  cat >>confdefs.h <<_ACEOF
+#define `$as_echo "HAVE_$ac_func" | $as_tr_cpp` 1
+_ACEOF
+
+fi
+done
+
+
 #
 # flockfile is usually provided by pthreads
 #
diff --git a/configure.ac b/configure.ac
index 25b0ce89591..19b4816540c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -663,6 +663,10 @@ AX_SAVE_FLAGS([libuv])
 CFLAGS="$CFLAGS $LIBUV_CFLAGS"
 LIBS="$LIBS $LIBUV_LIBS"
 
+# Those functions are only provided in newer versions of libuv, we'll be emulating them
+# for now
+AC_CHECK_FUNCS([uv_handle_get_data uv_handle_set_data])
+
 #
 # flockfile is usually provided by pthreads
 #
diff --git a/lib/isc/netmgr/netmgr.c b/lib/isc/netmgr/netmgr.c
index 479d327469b..9ef847bf2b8 100644
--- a/lib/isc/netmgr/netmgr.c
+++ b/lib/isc/netmgr/netmgr.c
@@ -29,6 +29,7 @@
 #include <isc/thread.h>
 #include <isc/util.h>
 
+#include "uv-compat.h"
 #include "netmgr-int.h"
 
 /*
@@ -827,7 +828,7 @@ isc__nmsocket_init(isc_nmsocket_t *sock, isc_nm_t *mgr,
 
 void
 isc__nm_alloc_cb(uv_handle_t *handle, size_t size, uv_buf_t *buf) {
-	isc_nmsocket_t *sock = (isc_nmsocket_t *) handle->data;
+	isc_nmsocket_t *sock = uv_handle_get_data(handle);
 	isc__networker_t *worker = NULL;
 
 	REQUIRE(VALID_NMSOCK(sock));
@@ -1208,7 +1209,7 @@ shutdown_walk_cb(uv_handle_t *handle, void *arg) {
 
 	switch(handle->type) {
 	case UV_TCP:
-		isc__nm_tcp_shutdown((isc_nmsocket_t *) handle->data);
+		isc__nm_tcp_shutdown(uv_handle_get_data(handle));
 		break;
 	default:
 		break;
diff --git a/lib/isc/netmgr/tcp.c b/lib/isc/netmgr/tcp.c
index c30db8fe995..9a4746cc40a 100644
--- a/lib/isc/netmgr/tcp.c
+++ b/lib/isc/netmgr/tcp.c
@@ -28,6 +28,7 @@
 #include <isc/thread.h>
 #include <isc/util.h>
 
+#include "uv-compat.h"
 #include "netmgr-int.h"
 
 static int
@@ -86,7 +87,7 @@ tcp_connect_direct(isc_nmsocket_t *sock, isc__nm_uvreq_t *req) {
 			return (r);
 		}
 	}
-	sock->uv_handle.tcp.data = sock;
+	uv_handle_set_data(&sock->uv_handle.handle, sock);
 	r = uv_tcp_connect(&req->uv_req.connect, &sock->uv_handle.tcp,
 			   &req->peer.type.sa, tcp_connect_cb);
 	return (r);
@@ -113,7 +114,8 @@ isc__nm_async_tcpconnect(isc__networker_t *worker, isc__netievent_t *ievent0) {
 static void
 tcp_connect_cb(uv_connect_t *uvreq, int status) {
 	isc__nm_uvreq_t *req = (isc__nm_uvreq_t *) uvreq->data;
-	isc_nmsocket_t *sock = uvreq->handle->data;
+	isc_nmsocket_t *sock;
+	sock = uv_handle_get_data((uv_handle_t *) uvreq->handle);
 
 	REQUIRE(VALID_UVREQ(req));
 
@@ -211,8 +213,11 @@ isc__nm_async_tcplisten(isc__networker_t *worker, isc__netievent_t *ievent0) {
 		return;
 	}
 
-	uv_tcp_bind(&sock->uv_handle.tcp, &sock->iface->addr.type.sa, 0);
-	sock->uv_handle.tcp.data = sock;
+	r = uv_tcp_bind(&sock->uv_handle.tcp, &sock->iface->addr.type.sa, 0);
+	if (r != 0) {
+		return;
+	}
+	uv_handle_set_data(&sock->uv_handle.handle, sock);
 	/*
 	 * This is not properly documented in libuv, and the example
 	 * (benchmark-multi-accept) is wrong:
@@ -223,7 +228,7 @@ isc__nm_async_tcplisten(isc__networker_t *worker, isc__netievent_t *ievent0) {
 	 */
 	r = uv_pipe_init(&worker->loop, &sock->ipc, 0);
 	INSIST(r == 0);
-	sock->ipc.data = sock;
+	uv_handle_set_data((uv_handle_t *)&sock->ipc, sock);
 	r = uv_pipe_bind(&sock->ipc, sock->ipc_pipe_name);
 	INSIST(r == 0);
 	r = uv_listen((uv_stream_t *) &sock->ipc, sock->nchildren,
@@ -274,7 +279,7 @@ static void
 ipc_connection_cb(uv_stream_t *stream, int status) {
 	int r;
 	REQUIRE(status == 0);
-	isc_nmsocket_t *sock = stream->data;
+	isc_nmsocket_t *sock = uv_handle_get_data((uv_handle_t *) stream);
 	isc__networker_t *worker = &sock->mgr->workers[isc_nm_tid()];
 	isc__nm_uvreq_t *nreq = isc__nm_uvreq_get(sock->mgr, sock);
 	/*
@@ -283,7 +288,7 @@ ipc_connection_cb(uv_stream_t *stream, int status) {
 	 */
 	nreq->uvbuf = uv_buf_init((char *)nreq, 1);
 	uv_pipe_init(&worker->loop, &nreq->pipe, 1);
-	nreq->pipe.data = nreq;
+	uv_handle_set_data((uv_handle_t *)&nreq->pipe, nreq);
 
 	/* Failure here is critical */
 	r = uv_accept((uv_stream_t *) &sock->ipc,
@@ -315,7 +320,7 @@ ipc_write_cb(uv_write_t* uvreq, int status) {
 
 static void
 parent_pipe_close_cb(uv_handle_t *handle) {
-	isc__nm_uvreq_t *req = handle->data;
+	isc__nm_uvreq_t *req = uv_handle_get_data(handle);
 	isc__nm_uvreq_put(&req, req->sock);
 }
 
@@ -331,7 +336,7 @@ isc__nm_async_tcpchildlisten(isc__networker_t *worker, isc__netievent_t *ievent0
 
 	r = uv_pipe_init(&worker->loop, &sock->ipc, 1);
 	INSIST(r == 0);
-	sock->ipc.data = sock;
+	uv_handle_set_data((uv_handle_t *) &sock->ipc, sock);
 	isc__nm_uvreq_t * req = isc__nm_uvreq_get(sock->mgr, sock);
 
 	uv_pipe_connect(&req->uv_req.connect,
@@ -358,7 +363,7 @@ static void
 childlisten_read_cb(uv_stream_t *stream, ssize_t nread, const uv_buf_t *buf) {
 	UNUSED(nread);
 	int r;
-	isc_nmsocket_t *sock = stream->data;
+	isc_nmsocket_t *sock = uv_handle_get_data((uv_handle_t *) stream);
 
 	REQUIRE(VALID_NMSOCK(sock));
 	REQUIRE(buf != NULL);
@@ -368,7 +373,7 @@ childlisten_read_cb(uv_stream_t *stream, ssize_t nread, const uv_buf_t *buf) {
 	isc__nm_free_uvbuf(sock, buf);
 	isc__networker_t * worker = &sock->mgr->workers[isc_nm_tid()];
 	uv_tcp_init(&worker->loop, (uv_tcp_t*) &sock->uv_handle.tcp);
-	sock->uv_handle.tcp.data = sock;
+	uv_handle_set_data(&sock->uv_handle.handle, sock);
 	uv_accept(stream, &sock->uv_handle.stream);
 	r = uv_listen((uv_stream_t *) &sock->uv_handle.tcp, sock->backlog,
 		      tcp_connection_cb);
@@ -489,7 +494,7 @@ isc__nm_async_tcpstopchildlisten(isc__networker_t *worker,
  */
 static void
 tcp_listenclose_cb(uv_handle_t *handle) {
-	isc_nmsocket_t *sock = handle->data;
+	isc_nmsocket_t *sock = uv_handle_get_data(handle);
 	isc_mutex_t * lock = (sock->parent != NULL) ?
 			      &sock->parent->lock : &sock->lock;
 	LOCK(lock);
@@ -502,7 +507,7 @@ tcp_listenclose_cb(uv_handle_t *handle) {
 
 static void
 readtimeout_cb(uv_timer_t *handle) {
-	isc_nmsocket_t *sock = (isc_nmsocket_t *) handle->data;
+	isc_nmsocket_t *sock = uv_handle_get_data((uv_handle_t *)handle);
 
 	REQUIRE(VALID_NMSOCK(sock));
 	REQUIRE(sock->tid == isc_nm_tid());
@@ -563,7 +568,7 @@ isc__nm_async_startread(isc__networker_t *worker, isc__netievent_t *ievent0) {
 	if (sock->read_timeout != 0) {
 		if (!sock->timer_initialized) {
 			uv_timer_init(&worker->loop, &sock->timer);
-			sock->timer.data = sock;
+			uv_handle_set_data((uv_handle_t *)&sock->timer, sock);
 			sock->timer_initialized = true;
 		}
 		uv_timer_start(&sock->timer, readtimeout_cb,
@@ -644,7 +649,7 @@ isc_nm_resumeread(isc_nmsocket_t *sock) {
 
 static void
 read_cb(uv_stream_t *stream, ssize_t nread, const uv_buf_t *buf) {
-	isc_nmsocket_t *sock = stream->data;
+	isc_nmsocket_t *sock = uv_handle_get_data((uv_handle_t*) stream);
 
 	REQUIRE(VALID_NMSOCK(sock));
 	REQUIRE(buf != NULL);
@@ -759,7 +764,7 @@ accept_connection(isc_nmsocket_t *ssock) {
 
 static void
 tcp_connection_cb(uv_stream_t *server, int status) {
-	isc_nmsocket_t *ssock = server->data;
+	isc_nmsocket_t *ssock = uv_handle_get_data((uv_handle_t*) server);
 	isc_result_t result;
 
 	UNUSED(status);
@@ -875,7 +880,7 @@ tcp_send_direct(isc_nmsocket_t *sock, isc__nm_uvreq_t *req) {
 
 static void
 tcp_close_cb(uv_handle_t *uvhandle) {
-	isc_nmsocket_t *sock = uvhandle->data;
+	isc_nmsocket_t *sock = uv_handle_get_data(uvhandle);
 
 	REQUIRE(VALID_NMSOCK(sock));
 
@@ -885,7 +890,7 @@ tcp_close_cb(uv_handle_t *uvhandle) {
 
 static void
 timer_close_cb(uv_handle_t *uvhandle) {
-	isc_nmsocket_t *sock = uvhandle->data;
+	isc_nmsocket_t *sock = uv_handle_get_data(uvhandle);
 
 	REQUIRE(VALID_NMSOCK(sock));
 
diff --git a/lib/isc/netmgr/tcpdns.c b/lib/isc/netmgr/tcpdns.c
index d75fdda9439..def3993800c 100644
--- a/lib/isc/netmgr/tcpdns.c
+++ b/lib/isc/netmgr/tcpdns.c
@@ -26,6 +26,7 @@
 #include <isc/thread.h>
 #include <isc/util.h>
 
+#include "uv-compat.h"
 #include "netmgr-int.h"
 
 #define TCPDNS_CLIENTS_PER_CONN 23
@@ -76,7 +77,7 @@ alloc_dnsbuf(isc_nmsocket_t *sock, size_t len) {
 
 static void
 timer_close_cb(uv_handle_t *handle) {
-	isc_nmsocket_t *sock = (isc_nmsocket_t *) handle->data;
+	isc_nmsocket_t *sock = (isc_nmsocket_t *) uv_handle_get_data(handle);
 	INSIST(VALID_NMSOCK(sock));
 	sock->timer_initialized = false;
 	atomic_store(&sock->closed, true);
@@ -85,7 +86,8 @@ timer_close_cb(uv_handle_t *handle) {
 
 static void
 dnstcp_readtimeout(uv_timer_t *timer) {
-	isc_nmsocket_t *sock = (isc_nmsocket_t *) timer->data;
+	isc_nmsocket_t *sock;
+	sock = (isc_nmsocket_t *) uv_handle_get_data((uv_handle_t *)timer);
 
 	REQUIRE(VALID_NMSOCK(sock));
 
diff --git a/lib/isc/netmgr/udp.c b/lib/isc/netmgr/udp.c
index 8abdd0c46f9..97df0ef9ecf 100644
--- a/lib/isc/netmgr/udp.c
+++ b/lib/isc/netmgr/udp.c
@@ -25,6 +25,8 @@
 #include <isc/sockaddr.h>
 #include <isc/thread.h>
 #include <isc/util.h>
+
+#include "uv-compat.h"
 #include "netmgr-int.h"
 
 static isc_result_t
@@ -123,7 +125,7 @@ isc__nm_async_udplisten(isc__networker_t *worker, isc__netievent_t *ievent0) {
 	REQUIRE(sock->parent != NULL);
 
 	uv_udp_init(&worker->loop, &sock->uv_handle.udp);
-	sock->uv_handle.udp.data = NULL;
+	uv_handle_set_data(&sock->uv_handle.handle, NULL);
 	isc_nmsocket_attach(sock,
 			    (isc_nmsocket_t **)&sock->uv_handle.udp.data);
 
@@ -140,7 +142,7 @@ isc__nm_async_udplisten(isc__networker_t *worker, isc__netievent_t *ievent0) {
 
 static void
 udp_close_cb(uv_handle_t *handle) {
-	isc_nmsocket_t *sock = handle->data;
+	isc_nmsocket_t *sock = uv_handle_get_data(handle);
 	atomic_store(&sock->closed, true);
 
 	isc_nmsocket_detach((isc_nmsocket_t **)&sock->uv_handle.udp.data);
@@ -271,7 +273,7 @@ udp_recv_cb(uv_udp_t *handle, ssize_t nrecv, const uv_buf_t *buf,
 	isc_sockaddr_t sockaddr;
 	isc_sockaddr_t localaddr;
 	struct sockaddr_storage laddr;
-	isc_nmsocket_t *sock = (isc_nmsocket_t *) handle->data;
+	isc_nmsocket_t *sock = uv_handle_get_data((uv_handle_t *)handle);
 	isc_region_t region;
 	uint32_t maxudp;
 
diff --git a/lib/isc/netmgr/uv-compat.h b/lib/isc/netmgr/uv-compat.h
new file mode 100644
index 00000000000..6ec2f3237b7
--- /dev/null
+++ b/lib/isc/netmgr/uv-compat.h
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * See the COPYRIGHT file distributed with this work for additional
+ * information regarding copyright ownership.
+ */
+
+#pragma once
+#include <uv.h>
+
+/*
+ * Those functions were introduced in newer libuv, we still
+ * want BIND9 compile on older ones so we emulate them.
+ * They're inline to avoid conflicts when running with a newer
+ * library version.
+ */
+
+#ifndef HAVE_UV_HANDLE_GET_DATA
+static inline void*
+uv_handle_get_data(const uv_handle_t* handle) {
+    return (handle->data);
+}
+#endif
+
+#ifndef HAVE_UV_HANDLE_SET_DATA
+static inline void
+uv_handle_set_data(uv_handle_t* handle, void* data) {
+    handle->data = data;
+};
+#endif
diff --git a/util/copyrights b/util/copyrights
index d4f81051623..a14a28c1249 100644
--- a/util/copyrights
+++ b/util/copyrights
@@ -2258,6 +2258,7 @@
 ./lib/isc/netmgr/tcp.c				C	2019
 ./lib/isc/netmgr/tcpdns.c			C	2019
 ./lib/isc/netmgr/udp.c				C	2019
+./lib/isc/netmgr/uv-compat.h			C	2019
 ./lib/isc/netmgr/uverr2result.c			C	2019
 ./lib/isc/netscope.c				C	2002,2004,2005,2006,2007,2016,2018,2019
 ./lib/isc/nonce.c				C	2018,2019