Recipe updates for NetBSD 11 support; fix nut-scanner builds --without-threading

.gitignore

@@ -14,6 +14,7 @@
 /_install_pkgprotodir/
 Makefile
 Makefile.in
+tags
 
 ## Parent directory only
 /aclocal.m4

NEWS.adoc

@@ -97,6 +97,12 @@ https://github.com/networkupstools/nut/milestone/12
      not normally get into those code paths with the `x*()` methods which
      should bail out and abort the program with a common error message when
      an allocation fails. [#3293]
+   * We have long abstracted `(s)size_t` value printing in debug logs etc.
+     using `PRIuSIZE` and similar macros. They fell back to `"%zu"` when not
+     provided otherwise, but not all platforms actually deliver these format
+     characters. Now it is evaluated at `configure` time (to check that the
+     characters may be used), and if not -- during `nut_stdint.h` parsing to
+     fit known `int`/`long`/`long long` types. [#3300]
 
  - NUT for Windows specific updates:
    * Revised detection of (relative) paths to program and configuration files
@@ -426,11 +432,22 @@ several `FSD` notifications into one executed action. [PR #3097]
    * Fixed `m4/ax_realpath_lib.m4` up with more ways to try and gauge the
      build-time library name from linker/compiler, to improve the chances
      that `nut-scanner` would find them. [#3293]
+   * Added an option to (primarily) `--disable-threading` for systems with
+     detected but broken `libpthread` support, or to test alternate code
+     paths during development or in CI. [#3300]
 
  - Recipes, CI and helper script updates not classified above:
    * Fixed CI recipes for PyPI publication of PyNUT(Client) module to also
      include the source distribution (was posted for NUT v2.8.1 and v2.8.2
      tagged releases, but absent for v2.8.3 and v2.8.4). [#3056]
+   * A new version of BSD `make` in NetBSD 11 (Beta) aka `bmake` in some other
+     operating systems, complains about some of our sub-`$(MAKE)` calls despite
+     the explicit `+` prefix in corresponding lines, possibly because that call
+     happens not directly in a rule definition, but in a substituted shell code
+     snippet. The recommended workaround was to add a "Special Source" called
+     `.MAKE` to let the tool know that we expect sub-makes in that recipe.
+     However, *other* `make` implementations do not know about this token,
+     so its support is tried and detected at `configure` time. [PR #3300]
    * Updated `make spellcheck` to help avoid asciidoc admonition blocks with
      visually invalid sentences (after rendering as a box in HTML or PDF).
      [#3077]

UPGRADING.adoc

@@ -125,6 +125,10 @@ Changes from 2.8.4 to 2.8.5
   updated, either to explicitly package the binding for several versions,
   or to not-deliver files no longer installed into the prototype area. [#1792]
 
+- Added a `configure` script option to (primarily) `--disable-threading`
+  for systems with detected but broken `libpthread` support, which can
+  cause `nut-scanner` to crash while loading system libraries. [#3300]
+
 - Introduced a new driver category for interaction with OS-reported UPS
   devices via D-Bus, with the `nut-upower` driver as the first implementation.
   This driver requires `glib-2.0` and `gio-2.0` development libraries to be

clients/Makefile.am

@@ -23,7 +23,7 @@ $(top_builddir)/common/libcommon.la \
 $(top_builddir)/common/libcommonclient.la \
 $(top_builddir)/common/libcommonversion.la \
 $(top_builddir)/common/libcommonstrjson.la \
-$(top_builddir)/common/libparseconf.la: dummy
+$(top_builddir)/common/libparseconf.la: dummy @dotMAKE@
 	+@cd $(@D) && $(MAKE) $(AM_MAKEFLAGS) $(@F)
 
 # Builds from root dir arrange stuff decently. Make sure parallel builds
@@ -39,7 +39,7 @@ LDADD_CLIENT =
 if ENABLE_SHARED_PRIVATE_LIBS
 $(top_builddir)/common/libcommonversion-private.la \
 $(top_builddir)/common/libnutprivate-@NUT_SOURCE_GITREV_SEMVER_UNDERSCORES@-common-all.la \
-$(top_builddir)/common/libnutprivate-@NUT_SOURCE_GITREV_SEMVER_UNDERSCORES@-common-client.la: dummy
+$(top_builddir)/common/libnutprivate-@NUT_SOURCE_GITREV_SEMVER_UNDERSCORES@-common-client.la: dummy @dotMAKE@
 	+@cd $(@D) && $(MAKE) $(AM_MAKEFLAGS) $(@F)
 
 $(top_builddir)/common/libcommonversion-private.la: $(top_builddir)/include/nut_version.h

common/Makefile.am

@@ -92,7 +92,7 @@ else !BUILDING_IN_TREE
   BUILT_SOURCES = common-nut_version.c
 endif !BUILDING_IN_TREE
 
-$(top_builddir)/include/nut_version.h:
+$(top_builddir)/include/nut_version.h: @dotMAKE@
 	+@if [ -s '$@' ] && ( [ x"$(NUT_VERSION_H_GENERATED)" = xtrue ] || [ x"$${NUT_VERSION_H_GENERATED}" = xtrue ] ) ; then \
 	    if [ x"$(MAINTAINER_GENERATE_HEADER_DEBUG)" = xyes ] ; then \
 	        echo "=== SKIP (common) $@ (NUT_VERSION_H_GENERATED makevar=$(NUT_VERSION_H_GENERATED) shellvar=$${NUT_VERSION_H_GENERATED})" >&2; \

common/common.c

@@ -3767,7 +3767,13 @@ char * mkstr_dynamic(const char *fmt_dynamic, const char *fmt_reference, ...)
 static void vupslog(int priority, const char *fmt, va_list va, int use_strerror)
 {
 	int	ret, errno_orig = errno;
+#ifdef HAVE_VA_COPY_VARIANT
+	size_t	bufsize = 128;
+#else
+	/* err on the safe(r) side, as re-runs can truncate
+	 * the output when varargs are re-used */
 	size_t	bufsize = LARGEBUF;
+#endif
 	char	*buf = (char *)xcalloc(bufsize, sizeof(char));
 
 	/* Be pedantic about our limitations */
@@ -3827,7 +3833,7 @@ static void vupslog(int priority, const char *fmt, va_list va, int use_strerror)
 			 * Based on https://stackoverflow.com/a/72981237/4715872
 			 */
 			if (bufsize < SIZE_MAX/2) {
-				size_t	newbufsize = bufsize*2;
+				size_t	newbufsize = bufsize < LARGEBUF ? LARGEBUF : bufsize*2;
 				if (ret > 0) {
 					/* Be generous, we snprintfcat() some
 					 * suffixes, prefix a timestamp, etc. */
@@ -4819,10 +4825,17 @@ void nut_prepare_search_paths(void) {
 	size_t	count_builtin = 0, count_filtered = 0, i, j, index = 0;
 	const char ** filtered_search_paths;
 	DIR *dp;
+#if HAVE_DECL_REALPATH
+	/* Per docs, buffer must be at least PATH_MAX bytes */
+	char	realpath_buf[NUT_PATH_MAX + 1] = {0}, *realpath_dirname = NULL;
+#endif
 
 	/* As a starting point, allow at least as many items as before */
 	/* TODO: somehow extend (xrealloc?) if we mix other paths later */
-	for (i = 0; search_paths_builtin[i] != NULL; i++) {}
+	for (i = 0; search_paths_builtin[i] != NULL; i++) {
+		/* Different way of printing with minimal crash-ability on older systems */
+		upsdebugx(7, "counting search_paths_builtin[%d] : %s", (int)i, NUT_STRARG(search_paths_builtin[i]));
+	}
 	count_builtin = i + 1;	/* +1 for the NULL */
 
 	/* Bytes inside should all be zeroed... */
@@ -4834,22 +4847,35 @@ void nut_prepare_search_paths(void) {
 		int dupe = 0;
 		const char *dirname = search_paths_builtin[i];
 
+		upsdebugx(7, "%s: checking search_paths_builtin[%" PRIuSIZE " of %" PRIuSIZE "] : %s",
+			__func__, i, count_builtin - 1, NUT_STRARG(dirname));
 		if ((dp = opendir(dirname)) == NULL) {
 			upsdebugx(5, "%s: SKIP "
 				"unreachable directory #%" PRIuSIZE " : %s",
-				__func__, index++, dirname);
+				__func__, index, NUT_STRARG(dirname));
+                        index++;
 			continue;
 		}
 		index++;
 
 #if HAVE_DECL_REALPATH
 		/* allocates the buffer we free() later */
-		dirname = (const char *)realpath(dirname, NULL);
+		upsdebugx(7, "%s: call realpath()", __func__);
+		errno = 0;
+		realpath_dirname = realpath(dirname, realpath_buf);
+		if (errno || !realpath_dirname)
+			upsdebug_with_errno(7, "%s: realpath() failed and returned: %s", __func__, NUT_STRARG(realpath_dirname));
+		else
+			upsdebugx(7, "%s: realpath() returned: %s", __func__, NUT_STRARG(realpath_dirname));
+		if (realpath_dirname)
+			dirname = (const char *)realpath_dirname;
 #endif
 
 		/* Revise for duplicates */
 		/* Note: (count_filtered == 0) means first existing dir seen, no hassle */
 		for (j = 0; j < count_filtered; j++) {
+			upsdebugx(7, "%s: check for duplicates filtered_search_paths[%" PRIuSIZE " of %" PRIuSIZE "] : %s",
+				__func__, j, count_filtered, NUT_STRARG(filtered_search_paths[j]));
 			if (!strcmp(filtered_search_paths[j], dirname)) {
 #if HAVE_DECL_REALPATH
 				if (strcmp(search_paths_builtin[i], dirname)) {
@@ -4984,7 +5010,7 @@ static char * get_libname_in_dir(const char* base_libname, size_t base_libname_l
 	char current_test_path[NUT_PATH_MAX + 1];
 
 	upsdebugx(3, "%s('%s', %" PRIuSIZE ", '%s', %i): Entering method...",
-		__func__, base_libname, base_libname_length, dirname, index);
+		__func__, NUT_STRARG(base_libname), base_libname_length, NUT_STRARG(dirname), index);
 
 	memset(current_test_path, 0, sizeof(current_test_path));
 
@@ -5117,7 +5143,7 @@ static char * get_libname_in_pathset(const char* base_libname, size_t base_libna
 	/* First call to tokenization passes the string, others pass NULL */
 	pathset_tmp = xstrdup(pathset);
 	upsdebugx(4, "%s: Looking for lib %s in a colon-separated path set",
-		__func__, base_libname);
+		__func__, NUT_STRARG(base_libname));
 	while (NULL != (onedir = strtok( (onedir ? NULL : pathset_tmp), ":" ))) {
 		libname_path = get_libname_in_dir(base_libname, base_libname_length, onedir, (*counter)++);
 		if (libname_path != NULL)
@@ -5153,7 +5179,7 @@ char * get_libname(const char* base_libname)
 	size_t base_libname_length = strlen(base_libname);
 	struct stat	st;
 
-	upsdebugx(3, "%s('%s'): Entering method...", __func__, base_libname);
+	upsdebugx(3, "%s('%s'): Entering method...", __func__, NUT_STRARG(base_libname));
 
 	/* First, check for an exact hit by absolute/relative path
 	 * if `base_libname` includes path separator character(s) */

conf/Makefile.am

@@ -37,20 +37,20 @@ SPELLCHECK_SRC = $(dist_sysconf_DATA) \
 # We also have to export some variables that may be tainted by relative
 # paths when parsing the other makefile (e.g. MKDIR_P that may be defined
 # via expanded $(top_builddir)/install-sh):
-#%-spellchecked: % Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT)
+#%-spellchecked: % Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT) @dotMAKE@
 #	+$(MAKE) -s -f $(top_builddir)/docs/Makefile $(AM_MAKEFLAGS) MKDIR_P="$(MKDIR_P)" builddir="$(builddir)" srcdir="$(srcdir)" top_builddir="$(top_builddir)" top_srcdir="$(top_srcdir)" SPELLCHECK_SRC_ONE="$<" SPELLCHECK_SRCDIR="$(srcdir)" SPELLCHECK_BUILDDIR="$(builddir)" $@
 
 # NOTE: Portable suffix rules do not allow prerequisites, so we shim them here
 # by a wildcard target in case the make implementation can put the two together.
 *-spellchecked: Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT)
 
-.sample.sample-spellchecked:
+.sample.sample-spellchecked: @dotMAKE@
 	+$(MAKE) -s -f $(top_builddir)/docs/Makefile $(AM_MAKEFLAGS) MKDIR_P="$(MKDIR_P)" builddir="$(builddir)" srcdir="$(srcdir)" top_builddir="$(top_builddir)" top_srcdir="$(top_srcdir)" SPELLCHECK_SRC_ONE="$<" SPELLCHECK_SRCDIR="$(srcdir)" SPELLCHECK_BUILDDIR="$(builddir)" $@
 
-.in.in-spellchecked:
+.in.in-spellchecked: @dotMAKE@
 	+$(MAKE) -s -f $(top_builddir)/docs/Makefile $(AM_MAKEFLAGS) MKDIR_P="$(MKDIR_P)" builddir="$(builddir)" srcdir="$(srcdir)" top_builddir="$(top_builddir)" top_srcdir="$(top_srcdir)" SPELLCHECK_SRC_ONE="$<" SPELLCHECK_SRCDIR="$(srcdir)" SPELLCHECK_BUILDDIR="$(builddir)" $@
 
-spellcheck spellcheck-interactive spellcheck-sortdict:
+spellcheck spellcheck-interactive spellcheck-sortdict: @dotMAKE@
 	+$(MAKE) -f $(top_builddir)/docs/Makefile $(AM_MAKEFLAGS) MKDIR_P="$(MKDIR_P)" builddir="$(builddir)" srcdir="$(srcdir)" top_builddir="$(top_builddir)" top_srcdir="$(top_srcdir)" SPELLCHECK_SRC="$(SPELLCHECK_SRC)" SPELLCHECK_SRCDIR="$(srcdir)" SPELLCHECK_BUILDDIR="$(builddir)" $@
 
 

configure.ac

@@ -317,7 +317,7 @@ NUT_ARG_WITH_EXPAND_DEFAULT_HELP_SINGLEQUOTE([confdir-examples], [DIRPATH], [Com
 
 dnl ---------------------------------------------------------------------
 dnl GNU and BSD make are okay with the syntax, but Sun make/dmake are not:
-AC_MSG_CHECKING([whether this make implementation supports export VAR=VAL syntax])
+AC_MSG_CHECKING([whether this make implementation supports 'export VAR=VAL' syntax])
 dnl # using printf formatting for some funniner shells out there
 nut_am_output="`printf 'export VAR=VAL\ntest:\n\t@echo \"VAR=%s%sVAR%s\"\n' '\$' '(' ')' | ${MAKE-make} -f - test`"
 nut_am_result="$?"
@@ -330,6 +330,24 @@ AS_IF([test x"${nut_am_result}" = x0 -a x"${nut_am_output}" = x"VAR=VAL"], [
 ])
 AC_SUBST(NUT_AM_MAKE_CAN_EXPORT)
 
+dnl ---------------------------------------------------------------------
+dnl Some versions of BSD make (e.g. in NetBSD 11) may require this syntax
+dnl in lieu of the more standard "+" prefix, but at least GNU make exploded
+dnl with it, so we can not use it everywhere:
+AC_MSG_CHECKING([whether this make implementation supports a .MAKE special source (pseudo-goal for sub-makes)])
+dnl # using printf formatting for some funniner shells out there
+nut_am_output="`printf 'sub: .MAKE\n\t@printf \\\"test:\\\\n\\\\t@echo %s\\\\n\\\" | $(MAKE) -f - test\n' '\\\\\\\"Hello world\\\\\\\"' | ${MAKE-make} -f - sub`"
+nut_am_result="$?"
+AS_IF([test x"${nut_am_result}" = x0 -a x"${nut_am_output}" = x"Hello world"], [
+	dotMAKE=".MAKE"
+	AC_MSG_RESULT(yes)
+], [
+	dotMAKE=""
+	AC_MSG_RESULT(no: got '${nut_am_output}')
+])
+AC_SUBST(dotMAKE)
+
+dnl ---------------------------------------------------------------------
 dnl Some systems have older autotools without direct macro support for PKG_CONF*
 NUT_CHECK_PKGCONFIG
 
@@ -393,8 +411,8 @@ test "${prefix}" = "NONE" && prefix="${ac_default_prefix}"
 test "${exec_prefix}" = "NONE" && exec_prefix='${prefix}'
 
 AS_CASE([x"${nut_with_confdir}"],
-	[yes], [AC_MSG_ERROR([--with-confdir should specify a path name or expansible expression])],
-	[/*|?:\*|?:/*|*/*|*'\'*], [
+	[xyes], [AC_MSG_ERROR([--with-confdir should specify a path name or expansible expression])],
+	[x/*|x?":\\"*|x?:/*|x*/*|x*'\'*], [
 		AC_MSG_NOTICE([A non-trivial --with-confdir path was specified (${nut_with_confdir}); any --with-confdir-suffix (${nut_with_confdir_suffix}) or --sysconfdir (${sysconfdir}) values are disregarded])
 	], [
 		RESULT_COMMENT=""
@@ -1373,6 +1391,25 @@ if (semaphore != SEM_FAILED)
 )
 AM_CONDITIONAL(HAVE_SEMAPHORE_LIBS, test -n "${SEMLIBS}")
 
+dnl ----------------------------------------------------------------------
+dnl Check for --with-threading request
+
+NUT_ARG_WITH([threading],
+    [If it is possible to parallelize some tools (e.g. nut-scanner), do so?],
+    [auto])
+
+AC_MSG_CHECKING([Whether to enable support for parallelization of some tools])
+AS_CASE(["${nut_with_threading}"],
+    [""|yes], [AM_COND_IF([HAVE_SEMAPHORE_LIBS], [], [AC_MSG_ERROR([pthread support was required but libraries not detected])])],
+    [auto],[AM_COND_IF([HAVE_SEMAPHORE_LIBS], [nut_with_threading=yes], [nut_with_threading=no])],
+    [no], [],
+        [AC_MSG_ERROR([Unsupported value for --with-threading option: "${nut_with_threading}"])]
+)
+AC_MSG_RESULT([${nut_with_threading}])
+NUT_REPORT_FEATURE([Enable support for parallelization of some tools], [${nut_with_threading}], [${SEMLIBS}],
+					[WITH_THREADING], [Define to enable build with threading support])
+
+dnl ----------------------------------------------------------------------
 AC_CHECK_FUNCS(cfsetispeed tcsendbreak)
 AC_CHECK_FUNCS(seteuid setsid getpassphrase)
 AC_CHECK_FUNCS(on_exit setlogmask)
@@ -1618,6 +1655,24 @@ AS_IF([test x"${ac_cv_func_strdup}" = xyes],
     [AC_MSG_WARN([Required C library routine strdup not found; try adding -D_POSIX_C_SOURCE=200112L])]
     )
 
+AC_CACHE_CHECK([for %zu as PRIuSIZE],
+    [ac_cv_printfmt_zu],
+    [AX_RUN_OR_LINK_IFELSE(
+        [AC_LANG_PROGRAM([$CODE_STRINGINCL
+#include <stdlib.h>
+],
+            [[size_t n = 123;
+char buf[64];
+snprintf(buf, sizeof(buf), "%zu", n);
+return !strcmp(buf, "123");
+]])],
+        [ac_cv_printfmt_zu=yes], [ac_cv_printfmt_zu=no]
+    )])
+AS_IF([test x"${ac_cv_printfmt_zu}" = xyes],
+    [AC_DEFINE([HAVE_PRINTF_ZU], 1, [defined if standard library has, and C standard allows, the printf("%zu", size_t) support])],
+    [AC_MSG_WARN([Desired C library support for printf("%zu", size_t) not found; try adding -D_POSIX_C_SOURCE=200112L])]
+    )
+
 AC_CACHE_CHECK([for va_copy(dest,src)],
   [ac_cv_have_va_copy],
   [
@@ -3122,8 +3177,14 @@ if test "${nut_with_gpio}" != "no"; then
 fi
 
 dnl NOTE: m4 scriptlet also defines WITH_LIBGPIO_VERSION like 0x00020000 in config.h
-NUT_REPORT_DRIVER([build GPIO driver (library v${GPIO_VERSION})], [${nut_with_gpio}], [${nut_gpio_lib}],
+AS_IF([test x"${GPIO_VERSION}" = xnone], [
+	REPORT_GPIO_VERSION="library version not detected"
+],[
+	REPORT_GPIO_VERSION="library v${GPIO_VERSION}"
+])
+NUT_REPORT_DRIVER([build GPIO driver (${REPORT_GPIO_VERSION})], [${nut_with_gpio}], [${nut_gpio_lib}],
 					[WITH_GPIO], [Define to enable GPIO support])
+unset REPORT_GPIO_VERSION
 
 dnl ----------------------------------------------------------------------
 dnl The Mac OS X meta-driver looks at IOKit Power Sources keys managed by
@@ -7204,4 +7265,7 @@ AS_IF([test x"${theMAKE}" = x], [theMAKE="make"])
 AC_MSG_NOTICE([==========================================================])
 AC_MSG_NOTICE([Configuration complete: Run '$theMAKE' to build ${NUT_SOURCE_VERSION_REPORT} now.])
 AC_MSG_NOTICE([You may use parallelism if supported by your hardware and 'make' implementation, e.g. '$theMAKE -j 8'])
+AS_IF([test x"${dotMAKE}" = x.MAKE], [
+AC_MSG_NOTICE([WARNING: do not use (parallel) GNU make with this build configuration!])
+])
 AC_MSG_NOTICE([==========================================================])

data/Makefile.am

@@ -18,13 +18,13 @@ check-local:
 # We also have to export some variables that may be tainted by relative
 # paths when parsing the other makefile (e.g. MKDIR_P that may be defined
 # via expanded $(top_builddir)/install-sh):
-#%-spellchecked: % Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT)
+#%-spellchecked: % Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT) @dotMAKE@
 #	+$(MAKE) -s -f $(top_builddir)/docs/Makefile $(AM_MAKEFLAGS) MKDIR_P="$(MKDIR_P)" builddir="$(builddir)" srcdir="$(srcdir)" top_builddir="$(top_builddir)" top_srcdir="$(top_srcdir)" SPELLCHECK_SRC_ONE="$<" SPELLCHECK_SRCDIR="$(srcdir)" SPELLCHECK_BUILDDIR="$(builddir)" $@
 
-cmdvartab-spellchecked: cmdvartab Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT)
+cmdvartab-spellchecked: cmdvartab Makefile.am $(top_srcdir)/docs/Makefile.am $(abs_srcdir)/$(NUT_SPELL_DICT) @dotMAKE@
 	+$(MAKE) -s -f $(top_builddir)/docs/Makefile $(AM_MAKEFLAGS) MKDIR_P="$(MKDIR_P)" builddir="$(builddir)" srcdir="$(srcdir)" top_builddir="$(top_builddir)" top_srcdir="$(top_srcdir)" SPELLCHECK_SRC_ONE="$<" SPELLCHECK_SRCDIR="$(srcdir)" SPELLCHECK_BUILDDIR="$(builddir)" $@
 
-spellcheck spellcheck-interactive spellcheck-sortdict:
+spellcheck spellcheck-interactive spellcheck-sortdict: @dotMAKE@
 	+$(MAKE) -f $(top_builddir)/docs/Makefile $(AM_MAKEFLAGS) MKDIR_P="$(MKDIR_P)" builddir="$(builddir)" srcdir="$(srcdir)" top_builddir="$(top_builddir)" top_srcdir="$(top_srcdir)" SPELLCHECK_SRC="cmdvartab" SPELLCHECK_SRCDIR="$(srcdir)" SPELLCHECK_BUILDDIR="$(builddir)" $@
 
 MAINTAINERCLEANFILES = Makefile.in .dirstamp