Investigate issue #3302 driver behavior when upsd aborts

.gitignore

@@ -52,6 +52,7 @@ tags
 /VERSION_FORCED
 /VERSION_FORCED_SEMVER
 /install-sh
+/.libs-dev-PATH
 /libtool
 /ltmain.sh
 /missing

AUTHORS

@@ -4,8 +4,9 @@
 # Everyone deserves credit, including those who haven't added any code.
 # Ideas, clues, and helping out on the mailing lists all count too.
 #
-# This is a blatant ripoff of the fields found in the Linux kernel's CREDITS
-# file.  If we need more data, those fields can always be added later.
+# This is a blatant ripoff of the fields found in the CREDITS file of
+# the Linux kernel. If we need more data, those fields can always be
+# added later.
 #
 # N = name, E = email, W = web address, D = description, P = PGP info,
 # S = snailmail address, etc.

Makefile.am

@@ -162,8 +162,8 @@ SUBDIR_MAKE_VERBOSE = default
 
 # Run the standard build if going sequential (or with unknown MAKEFLAGS),
 # or fanout if parallel (presuming GNU/BSD/Sun make at least):
-CLEANFILES += include/.all.nut_version-generated.timestamp clients/.all.libupsclient_version-generated.timestamp
-all-fanout-maybe: @dotMAKE@
+CLEANFILES += .libs-dev-PATH include/.all.nut_version-generated.timestamp clients/.all.libupsclient_version-generated.timestamp
+all-fanout-maybe: .libs-dev-PATH @dotMAKE@
 	@rm -f include/.all.nut_version-generated.timestamp \
 	       clients/.all.libupsclient_version-generated.timestamp
 	+@if [ x"$(NUT_MAKE_SKIP_FANOUT)" = xtrue ] ; then \
@@ -190,6 +190,27 @@ all-fanout-maybe: @dotMAKE@
 			;; \
 	  esac
 
+.libs-dev-PATH: Makefile
+	echo '# Sourcable script for developers to run built progs with their shared libs:' > '$@'
+	echo 'for D in common clients drivers tools/nut-scanner ; do \
+	    for S in "" "/.libs" ; do \
+	        DN="$(abs_top_builddir)/$${D}$${S}" ; \
+	        case "$${PATH}" in \
+	            "$${DN}"|*:"$${DN}}"|"$${DN}":*|*:"$${DN}":*) ;; \
+	            "") PATH="$${DN}" ;; \
+	            *)  PATH="$${DN}:$${PATH}" ;; \
+	        esac ; \
+	        case "$${LD_LIBRARY_PATH}" in \
+	            "$${DN}"|*:"$${DN}}"|"$${DN}":*|*:"$${DN}":*) ;; \
+	            "") LD_LIBRARY_PATH="$${DN}" ;; \
+	            *)  LD_LIBRARY_PATH="$${DN}:$${LD_LIBRARY_PATH}" ;; \
+	        esac ; \
+	    done ; \
+	done ; \
+	export PATH ; \
+	export LD_LIBRARY_PATH ; \
+	' >> '$@'
+
 # We start with a pass to `make all` in `common` dir because our wild recipes
 # (with other subdirs ensuring the libraries they need have been built) can
 # sometimes cause parallel compilation and library generation for same files
@@ -208,7 +229,7 @@ all-fanout-staged: @dotMAKE@
 
 all-fanout-subdirs: $(SUBDIRS_ALL_RECURSIVE)
 
-all-fanout-libs all-libs-local: $(SUBDIRS_ALL_LIBS_LOCAL)
+all-fanout-libs all-libs-local: $(SUBDIRS_ALL_LIBS_LOCAL) .libs-dev-PATH
 
 #all all-am-local all-local: @dotMAKE@
 #	+@cd common && $(MAKE) $(AM_MAKEFLAGS) all
@@ -855,9 +876,21 @@ SET_PARMAKES_OPT = \
 		;; \
 	esac
 
+all-quick: @dotMAKE@
+	+@$(SET_PARMAKES_OPT); \
+	  $(MAKE) $(AM_MAKEFLAGS) -k -s $${PARMAKES_OPT} all
+
+install-quick: @dotMAKE@
+	+@$(SET_PARMAKES_OPT); \
+	  $(MAKE) $(AM_MAKEFLAGS) -k -s $${PARMAKES_OPT} install
+
+check-quick: @dotMAKE@
+	+@$(SET_PARMAKES_OPT); \
+	  $(MAKE) $(AM_MAKEFLAGS) -k -s $${PARMAKES_OPT} check
+
 spellcheck-quick: @dotMAKE@
 	+@$(SET_PARMAKES_OPT); \
-	  $(MAKE) $(AM_MAKEFLAGS) -k -s ${PARMAKES_OPT} spellcheck
+	  $(MAKE) $(AM_MAKEFLAGS) -k -s $${PARMAKES_OPT} spellcheck
 
 # Run auto-parallel recipe, and if something fails - re-run interactively:
 spellcheck-interactive-quick: @dotMAKE@

NEWS.adoc

@@ -137,6 +137,14 @@ but the `nutshutdown` script would bail out quickly and quietly. [PR #3008]
    * Ported C client library `libupsclient` support logic for SSL connections
      into C++ client library `libnutclient` and added tests for it. [issues
      #1599, #1711, PR #3353]
+   * Added support for command-line debugging with `-D` option into `upsc`,
+     `upscmd` and `upsrw` command-line clients, and the `nutconf` tool.
+     Revised handling of `-D` and/or `NUT_DEBUG_LEVEL` environment variable
+     in other programs. Extended public API of libupsclient and libnutscan
+     to diligently arrange debug-logging when at run-time those libraries
+     actually have different copies of the methods and data involved. [#3378]
+   * Revised 'dstate' machinery to track socket connections closed mid-way
+     through a call, to avoid access after `free()`. [#3302]
 
  - NUT for Windows specific updates:
    * Revised detection of (relative) paths to program and configuration files
@@ -395,7 +403,8 @@ several `FSD` notifications into one executed action. [PR #3097]
 
  - `upsc` has now optional JSON output [issue #3172, PR #3178]
 
- - `upsset` should now recognize `RANGE NUMBER` and `NUMBER` types. [#3164]
+ - `upsset` CGI tool should now recognize `RANGE NUMBER` and `NUMBER` types.
+   [#3164]
 
  - `upsstats` CGI tool updates:
    * Now has JSON output mode via `?json` (or `&json`) CGI query parameter.
@@ -540,6 +549,9 @@ several `FSD` notifications into one executed action. [PR #3097]
      which should now not re-check source texts that were okay with the previous
      dictionary contents, in case some new terms have to be added. [PRs #3186,
      #2871]
+   * Added `make .libs-dev-PATH` recipe to generate a file which developers
+     or CI scripts can source to prefer freshly built NUT libraries and some
+     tools in their `LD_LIBRARY_PATH` and `PATH`. [#3379]
    * Introduced `make distcheck-completeness` goal to verify that our
      distribution archives can exactly reproduce themselves. [#2829]
    * Added a GitHub Actions CI job to generate, upload and recycle `make dist`
@@ -698,8 +710,8 @@ Release notes for NUT 2.8.4 - what's new since 2.8.3
 
  - `upsdrvquery` API updates [#2969]:
    * Added `upsdrvquery_oneshot_conn()` for issuing one-shot queries using an
-     existing `udq_pipe_conn_t *` connection. The caller manages the
-     connection's lifecycle, and the function includes a best-effort call to
+     existing `udq_pipe_conn_t *` connection. The caller manages the lifecycle
+     of the socket connection, and the function includes a best-effort call to
      restore broadcast mode after the query to return the connection as it was.
    * Added `upsdrvquery_oneshot_sockfn()` for initiating one-shot queries using
      a socket filename. Shares internal logic with the existing

clients/Makefile.am

@@ -219,7 +219,7 @@ endif WITH_SSL
 # for the run-time dynamic linker resolution? For now the shared-library
 # builds are "exotic", but it makes sense to deprecate this export in a
 # future release.
-libupsclient_la_LDFLAGS = -version-info 7:0:0
+libupsclient_la_LDFLAGS = -version-info 8:0:1
 libupsclient_la_LDFLAGS += -export-symbols-regex '^(upscli_|nut_debug_level)'
 #|s_upsdebug|fatalx|fatal_with_errno|xcalloc|xbasename|print_banner_once)'
 if HAVE_WINDOWS

clients/nutclient.cpp

@@ -332,14 +332,60 @@ SSL_CTX* Socket::_ssl_ctx = nullptr;
 # endif	/* WITH_OPENSSL */
 
 # ifdef WITH_NSS
-static void nss_error(const char* funcname)
-{
-	char buffer[256];
-	PRInt32 length = PR_GetErrorText(buffer);
-	if (length > 0 && length < 256) {
-		std::cerr << "nss_error " << static_cast<long>(PR_GetError()) << " in " << funcname << " : " << buffer << std::endl;
+/** Detail the currently raised NSS error code if possible, and debug-log
+ *  it with caller-provided text (typically the calling function name). */
+static void nss_error(const char* text)
+{
+	std::string	err_name_buf;
+	PRErrorCode	err_num = PR_GetError();
+	const char	*err_name = PR_ErrorToName(err_num);
+	PRInt32	err_len = PR_GetErrorTextLength();
+
+	if (err_name) {
+		err_name_buf << " (" << err_name << ")";
+	}
+
+	if (err_len > 0) {
+		char	*buffer = calloc(err_len + 1, sizeof(char));
+		if (buffer) {
+			PR_GetErrorText(buffer);
+			std::cerr << "nss_error "
+				<< static_cast<long>(err_num)
+				<< err_name_buf
+				<< " in " << text
+				<< " : "
+				<< buffer
+				<< std::endl;
+			free(buffer);
+		} else {
+			std::cerr << "nss_error "
+				<< static_cast<long>(err_num)
+				<< err_name_buf
+				<< " in " << text
+				<< " : "
+				<< "Failed to allocate internal error buffer "
+				<< "for detailed error text, needs "
+				<< static_cast<long>(err_len) << " bytes"
+				<< std::endl;
+		}
 	} else {
-		std::cerr << "nss_error " << static_cast<long>(PR_GetError()) << " in " << funcname << std::endl;
+		/* The code above may be obsolete or not ubiquitous, try another way */
+		const char	*err_text = PR_ErrorToString(err_num, PR_LANGUAGE_I_DEFAULT);
+		if (err_text && *err_text) {
+			std::cerr << "nss_error "
+				<< static_cast<long>(err_num)
+				<< err_name_buf
+				<< " in " << text
+				<< " : "
+				<< err_text
+				<< std::endl;
+		} else {
+			std::cerr << "nss_error "
+				<< static_cast<long>(err_num)
+				<< err_name_buf
+				<< " in " << text
+				<< std::endl;
+		}
 	}
 }