From 440be4c866f6935ac069db79a414304507a664c2 Mon Sep 17 00:00:00 2001
From: Michael Graff <mgraff@isc.org>
Date: Thu, 16 Dec 1999 22:24:22 +0000
Subject: [PATCH] move util.h to <isc/util.h>

---
 bin/named/client.c               | 3 +--
 bin/named/query.c                | 3 +--
 bin/named/server.c               | 3 +--
 bin/tests/tkey_test.c            | 3 +--
 lib/dns/adb.c                    | 3 +--
 lib/dns/dbtable.c                | 4 ++--
 lib/dns/dispatch.c               | 3 +--
 lib/dns/rbtdb.c                  | 4 +---
 lib/dns/resolver.c               | 4 +---
 lib/dns/tcpmsg.c                 | 3 +--
 lib/dns/view.c                   | 3 +--
 lib/dns/zone.c                   | 4 ++--
 lib/dns/zt.c                     | 3 +--
 lib/isc/include/isc/Makefile.in  | 4 ++++
 lib/isc/{ => include/isc}/util.h | 0
 lib/isc/lex.c                    | 3 +--
 lib/isc/mem.c                    | 2 +-
 lib/isc/random.c                 | 3 +--
 lib/isc/ratelimiter.c            | 3 +--
 lib/isc/result.c                 | 3 +--
 lib/isc/rwlock.c                 | 3 +--
 lib/isc/symtab.c                 | 3 +--
 lib/isc/task.c                   | 3 +--
 lib/isc/timer.c                  | 3 +--
 lib/isc/unix/app.c               | 3 +--
 lib/isc/unix/socket.c            | 3 +--
 26 files changed, 30 insertions(+), 49 deletions(-)
 rename lib/isc/{ => include/isc}/util.h (100%)

diff --git a/bin/named/client.c b/bin/named/client.c
index b028e05835..4438b3c520 100644
--- a/bin/named/client.c
+++ b/bin/named/client.c
@@ -23,6 +23,7 @@
 #include <isc/result.h>
 #include <isc/task.h>
 #include <isc/timer.h>
+#include <isc/util.h>
 
 #include <dns/aml.h>
 #include <dns/dispatch.h>
@@ -41,8 +42,6 @@
 #include <named/update.h>
 #include <named/notify.h>
 
-#include "../../isc/util.h"		/* XXX */
-
 #define NS_CLIENT_TRACE
 #ifdef NS_CLIENT_TRACE
 #define CTRACE(m)	isc_log_write(ns_g_lctx, \
diff --git a/bin/named/query.c b/bin/named/query.c
index d19966ff41..d48568f748 100644
--- a/bin/named/query.c
+++ b/bin/named/query.c
@@ -26,6 +26,7 @@
 #include <isc/timer.h>
 #include <isc/event.h>
 #include <isc/log.h>
+#include <isc/util.h>
 
 #include <dns/a6.h>
 #include <dns/aml.h>
@@ -52,8 +53,6 @@
 #include <named/xfrout.h>
 #include <named/log.h>
 
-#include "../../isc/util.h"		/* XXX */
-
 #define PARTIALANSWER(c)	(((c)->query.attributes & \
 				  NS_QUERYATTR_PARTIALANSWER) != 0)
 #define USECACHE(c)		(((c)->query.attributes & \
diff --git a/bin/named/server.c b/bin/named/server.c
index 862e6888e4..4f0acdcaeb 100644
--- a/bin/named/server.c
+++ b/bin/named/server.c
@@ -34,6 +34,7 @@
 #include <isc/timer.h>
 #include <isc/app.h>
 #include <isc/dir.h>
+#include <isc/util.h>
 
 #include <dns/cache.h>
 #include <dns/confparser.h>
@@ -62,8 +63,6 @@
 #include <named/rootns.h>
 #include <named/server.h>
 
-#include "../../isc/util.h"		/* XXXRTH */
-
 typedef struct {
 	isc_mem_t *		mctx;
 	dns_viewlist_t		viewlist;
diff --git a/bin/tests/tkey_test.c b/bin/tests/tkey_test.c
index 5a509645bf..ba1c2d79bb 100644
--- a/bin/tests/tkey_test.c
+++ b/bin/tests/tkey_test.c
@@ -36,8 +36,7 @@
 #include <isc/net.h>
 #include <isc/socket.h>
 #include <isc/log.h>
-
-#include "../../isc/util.h"		/* XXX Naughty. */
+#include <isc/util.h>
 
 #include <dns/types.h>
 #include <dns/result.h>
diff --git a/lib/dns/adb.c b/lib/dns/adb.c
index 63d60e0732..376ca6732a 100644
--- a/lib/dns/adb.c
+++ b/lib/dns/adb.c
@@ -44,6 +44,7 @@
 #include <isc/mutexblock.h>
 #include <isc/random.h>
 #include <isc/timer.h>
+#include <isc/util.h>
 
 #include <dns/a6.h>
 #include <dns/adb.h>
@@ -58,8 +59,6 @@
 #include <dns/types.h>
 #include <dns/view.h>
 
-#include "../isc/util.h"
-
 #define DNS_ADB_MAGIC		  0x44616462	/* Dadb. */
 #define DNS_ADB_VALID(x)	  ISC_MAGIC_VALID(x, DNS_ADB_MAGIC)
 #define DNS_ADBNAME_MAGIC	  0x6164624e	/* adbN. */
diff --git a/lib/dns/dbtable.c b/lib/dns/dbtable.c
index 114f0a8bfc..3ee531527b 100644
--- a/lib/dns/dbtable.c
+++ b/lib/dns/dbtable.c
@@ -16,7 +16,7 @@
  */
 
 /*
- * $Id: dbtable.c,v 1.10 1999/10/09 02:49:16 halley Exp $
+ * $Id: dbtable.c,v 1.11 1999/12/16 22:24:17 explorer Exp $
  */
 
 /*
@@ -27,7 +27,7 @@
 
 #include <isc/assertions.h>
 #include <isc/rwlock.h>
-#include "../isc/util.h"
+#include <isc/util.h>
 
 #include <dns/dbtable.h>
 #include <dns/db.h>
diff --git a/lib/dns/dispatch.c b/lib/dns/dispatch.c
index 30dc737774..9a6861c3fc 100644
--- a/lib/dns/dispatch.c
+++ b/lib/dns/dispatch.c
@@ -28,6 +28,7 @@
 #include <isc/mem.h>
 #include <isc/mutex.h>
 #include <isc/socket.h>
+#include <isc/util.h>
 
 #include <dns/events.h>
 #include <dns/types.h>
@@ -36,8 +37,6 @@
 #include <dns/message.h>
 #include <dns/tcpmsg.h>
 
-#include "../isc/util.h"
-
 #ifdef DISPATCH_DEBUG
 #define XDEBUG(x) printf x
 #else
diff --git a/lib/dns/rbtdb.c b/lib/dns/rbtdb.c
index ff2770665e..920bd35f16 100644
--- a/lib/dns/rbtdb.c
+++ b/lib/dns/rbtdb.c
@@ -29,6 +29,7 @@
 #include <isc/error.h>
 #include <isc/mutex.h>
 #include <isc/rwlock.h>
+#include <isc/util.h>
 
 #include <dns/types.h>
 #include <dns/name.h>
@@ -49,9 +50,6 @@
 #include "rbtdb.h"
 #endif
 
-/* Lame.  Move util.h to <isc/util.h> */
-#include "../isc/util.h"
-
 #ifdef DNS_RBTDB_VERSION64
 #define RBTDB_MAGIC			0x52424438U	/* RBD8. */
 #else
diff --git a/lib/dns/resolver.c b/lib/dns/resolver.c
index bd026819d9..c064d25b4e 100644
--- a/lib/dns/resolver.c
+++ b/lib/dns/resolver.c
@@ -26,6 +26,7 @@
 #include <isc/event.h>
 #include <isc/task.h>
 #include <isc/stdtime.h>
+#include <isc/util.h>
 
 #include <dns/types.h>
 #include <dns/adb.h>
@@ -43,11 +44,8 @@
 #include <dns/tsig.h>
 #include <dns/view.h>
 #include <dns/log.h>
-
 #include <dst/dst.h>
 
-#include "../isc/util.h"		/* XXX */
-
 #define DNS_RESOLVER_TRACE
 #ifdef DNS_RESOLVER_TRACE
 #define RTRACE(m)	isc_log_write(dns_lctx, \
diff --git a/lib/dns/tcpmsg.c b/lib/dns/tcpmsg.c
index fb498bb8df..65c9f17a66 100644
--- a/lib/dns/tcpmsg.c
+++ b/lib/dns/tcpmsg.c
@@ -27,14 +27,13 @@
 #include <isc/error.h>
 #include <isc/mem.h>
 #include <isc/socket.h>
+#include <isc/util.h>
 
 #include <dns/events.h>
 #include <dns/types.h>
 #include <dns/result.h>
 #include <dns/tcpmsg.h>
 
-#include "../isc/util.h"
-
 #ifdef TCPMSG_DEBUG
 #define XDEBUG(x) printf x
 #else
diff --git a/lib/dns/view.c b/lib/dns/view.c
index 5f636e157c..792ec90af4 100644
--- a/lib/dns/view.c
+++ b/lib/dns/view.c
@@ -24,6 +24,7 @@
 #include <isc/mem.h>
 #include <isc/assertions.h>
 #include <isc/error.h>
+#include <isc/util.h>
 
 #include <dns/types.h>
 #include <dns/adb.h>
@@ -37,8 +38,6 @@
 #include <dns/resolver.h>
 #include <dns/view.h>
 
-#include "../isc/util.h"		/* XXXRTH */
-
 #define RESSHUTDOWN(v)	(((v)->attributes & DNS_VIEWATTR_RESSHUTDOWN) != 0)
 #define ADBSHUTDOWN(v)	(((v)->attributes & DNS_VIEWATTR_ADBSHUTDOWN) != 0)
 
diff --git a/lib/dns/zone.c b/lib/dns/zone.c
index bb3c9fa9f4..82659b4159 100644
--- a/lib/dns/zone.c
+++ b/lib/dns/zone.c
@@ -15,13 +15,12 @@
  * SOFTWARE.
  */
 
- /* $Id: zone.c,v 1.46 1999/12/16 01:23:15 marka Exp $ */
+ /* $Id: zone.c,v 1.47 1999/12/16 22:24:19 explorer Exp $ */
 
 #include <config.h>
 
 #include <string.h>
 
-#include <../isc/util.h> /* XXX MPA */
 #include <isc/assertions.h>
 #include <isc/error.h>
 #include <isc/magic.h>
@@ -30,6 +29,7 @@
 #include <isc/serial.h>
 #include <isc/taskpool.h>
 #include <isc/timer.h>
+#include <isc/util.h>
 
 #include <dns/confparser.h>
 #include <dns/db.h>
diff --git a/lib/dns/zt.c b/lib/dns/zt.c
index e61addd345..3f6a139593 100644
--- a/lib/dns/zt.c
+++ b/lib/dns/zt.c
@@ -21,11 +21,10 @@
 #include <isc/magic.h>
 #include <isc/rwlock.h>
 #include <isc/result.h>
+#include <isc/util.h>
 
 #include <dns/zt.h>
 
-#include "../isc/util.h"	/* XXXRTH */
-
 struct dns_zt {
 	/* Unlocked. */
         unsigned int		magic;
diff --git a/lib/isc/include/isc/Makefile.in b/lib/isc/include/isc/Makefile.in
index 383aaec70b..3258a70c6f 100644
--- a/lib/isc/include/isc/Makefile.in
+++ b/lib/isc/include/isc/Makefile.in
@@ -19,6 +19,10 @@ top_srcdir =	@top_srcdir@
 
 @BIND9_VERSION@
 
+#
+# Only list headers that are to be installed!  Things like util.h, which
+# consists purely of private helper macros, should not be here.
+#
 HEADERS =	assertions.h base64.h boolean.h buffer.h bufferlist.h \
 		commandline.h error.h event.h eventclass.h \
 		heap.h int.h interfaceiter.h lang.h lex.h lfsr.h lib.h \
diff --git a/lib/isc/util.h b/lib/isc/include/isc/util.h
similarity index 100%
rename from lib/isc/util.h
rename to lib/isc/include/isc/util.h
diff --git a/lib/isc/lex.c b/lib/isc/lex.c
index 298f2887dd..adf0423004 100644
--- a/lib/isc/lex.c
+++ b/lib/isc/lex.c
@@ -28,8 +28,7 @@
 #include <isc/boolean.h>
 #include <isc/error.h>
 #include <isc/lex.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 typedef struct inputsource {
 	isc_result_t			result;
diff --git a/lib/isc/mem.c b/lib/isc/mem.c
index 521bf8a826..29da706215 100644
--- a/lib/isc/mem.c
+++ b/lib/isc/mem.c
@@ -30,7 +30,7 @@
 
 #ifndef ISC_SINGLETHREADED
 #include <isc/mutex.h>
-#include "util.h"
+#include <isc/util.h>
 #else
 #define LOCK(l)
 #define UNLOCK(l)
diff --git a/lib/isc/random.c b/lib/isc/random.c
index 0782e178bc..2ec979ad64 100644
--- a/lib/isc/random.c
+++ b/lib/isc/random.c
@@ -24,8 +24,7 @@
 #include <isc/mutex.h>
 #include <isc/once.h>
 #include <isc/random.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 static isc_once_t once = ISC_ONCE_INIT;
 static isc_mutex_t rand_lock;
diff --git a/lib/isc/ratelimiter.c b/lib/isc/ratelimiter.c
index 5890f74e3d..bfca408b7d 100644
--- a/lib/isc/ratelimiter.c
+++ b/lib/isc/ratelimiter.c
@@ -21,8 +21,7 @@
 #include <isc/boolean.h>
 #include <isc/error.h>
 #include <isc/ratelimiter.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 struct isc_ratelimiter {
 	isc_mem_t *		mctx;
diff --git a/lib/isc/result.c b/lib/isc/result.c
index 8dedab78f7..e9cd56aa0e 100644
--- a/lib/isc/result.c
+++ b/lib/isc/result.c
@@ -28,8 +28,7 @@
 #include <isc/once.h>
 #include <isc/msgcat.h>
 #include <isc/lib.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 typedef struct resulttable {
 	unsigned int				base;
diff --git a/lib/isc/rwlock.c b/lib/isc/rwlock.c
index aba71b9592..9075556c22 100644
--- a/lib/isc/rwlock.c
+++ b/lib/isc/rwlock.c
@@ -23,8 +23,7 @@
 #include <isc/error.h>
 #include <isc/boolean.h>
 #include <isc/rwlock.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 #define RWLOCK_MAGIC			0x52574C6BU	/* RWLk. */
 #define VALID_RWLOCK(rwl)		((rwl) != NULL && \
diff --git a/lib/isc/symtab.c b/lib/isc/symtab.c
index b010a45c8c..9a8cb19d99 100644
--- a/lib/isc/symtab.c
+++ b/lib/isc/symtab.c
@@ -24,8 +24,7 @@
 #include <isc/assertions.h>
 #include <isc/list.h>
 #include <isc/symtab.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 typedef struct elt {
 	char *				key;
diff --git a/lib/isc/task.c b/lib/isc/task.c
index 02ab1bc4d7..c8c4ed4bc3 100644
--- a/lib/isc/task.c
+++ b/lib/isc/task.c
@@ -34,8 +34,7 @@
 #include <isc/error.h>
 #include <isc/event.h>
 #include <isc/task.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 #ifdef ISC_TASK_TRACE
 #define XTRACE(m)		printf("task %p thread %lu: %s\n", \
diff --git a/lib/isc/timer.c b/lib/isc/timer.c
index 7e1323a27c..dccf3f605b 100644
--- a/lib/isc/timer.c
+++ b/lib/isc/timer.c
@@ -27,8 +27,7 @@
 #include <isc/condition.h>
 #include <isc/heap.h>
 #include <isc/timer.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 #ifdef ISC_TIMER_TRACE
 #define XTRACE(s)			printf("%s\n", (s))
diff --git a/lib/isc/unix/app.c b/lib/isc/unix/app.c
index baeb01ed24..93277e7c44 100644
--- a/lib/isc/unix/app.c
+++ b/lib/isc/unix/app.c
@@ -33,8 +33,7 @@
 #include <isc/boolean.h>
 #include <isc/mutex.h>
 #include <isc/event.h>
-
-#include "../util.h"	/* XXX */
+#include <isc/util.h>
 
 static isc_eventlist_t		on_run;
 static isc_mutex_t		lock;
diff --git a/lib/isc/unix/socket.c b/lib/isc/unix/socket.c
index 9251030071..0a68f1518a 100644
--- a/lib/isc/unix/socket.c
+++ b/lib/isc/unix/socket.c
@@ -39,8 +39,7 @@
 #include <isc/region.h>
 #include <isc/socket.h>
 #include <isc/thread.h>
-
-#include "util.h"
+#include <isc/util.h>
 
 /*
  * Some systems define the socket length argument as an int, some as size_t,