Update ChangeLog and bump version for v1.5.1 release

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>

ChangeLog.md

@@ -4,6 +4,36 @@ Change Log
 All notable changes to the project are documented in this file.
 
 
+[v1.5.1][] - 2016-04-17
+-----------------------
+
+Minor fix release.
+
+### Changes
+- Update README.md, add help when libite is used in autotools projects.
+  Spell checking and minor cleanup.
+
+### Fixes
+- Activate use of `utimensat()` when `pidfile()` is called multiple
+  times.  This reduces the overhead of calling open+write+close to
+  simply updating the mtime of the PID file.
+- Westermo fixes for `fcopyfile()`: nothing copied on embedded PPC
+  system when using `tmpfile()` as source.
+
+
+[v1.5.0][] - 2016-03-20
+-----------------------
+
+This release changes the header file namespace.  Apologies for any
+problems this may cause!
+
+### Changes
+- Change namespace for header files: `libite/` to `lite/`, e.g. using
+  `pkg-config` your C program must now `#include <lite/lite.h>`
+- Update `pidfile()` to use `utimensat()` to update atime+mtime instead
+  of opening and writing PID again.  Less overhead and nanonsecond res.
+
+
 [v1.4.4][] - 2016-02-23
 -----------------------
 
@@ -125,7 +155,9 @@ All notable changes to the project are documented in this file.
 Initial extraction of frog DNA from [Finit][].  See [README][] for API details.
 
 
-[UNRELEASED]: https://github.com/troglobit/libite/compare/v1.4.4...HEAD
+[UNRELEASED]: https://github.com/troglobit/libite/compare/v1.5.1...HEAD
+[v1.5.1]: https://github.com/troglobit/libite/compare/v1.5.0...v1.5.1
+[v1.5.0]: https://github.com/troglobit/libite/compare/v1.4.4...v1.5.0
 [v1.4.4]: https://github.com/troglobit/libite/compare/v1.4.3...v1.4.4
 [v1.4.3]: https://github.com/troglobit/libite/compare/v1.4.2...v1.4.3
 [v1.4.2]: https://github.com/troglobit/libite/compare/v1.4.1...v1.4.2

Makefile.am

@@ -1,6 +1,7 @@
 ACLOCAL_AMFLAGS     = -I m4
 
 lib_LTLIBRARIES     = libite.la
+pkgincludedir       = $(includedir)/lite
 pkginclude_HEADERS  = lite.h queue.h conio.h tree.h
 libite_la_SOURCES   = chomp.c copyfile.c dir.c fexist.c fisdir.c fmode.c fsendfile.c	\
 			ifconfig.c lfile.c makepath.c pidfile.c pidfilefn.c progress.c	\
@@ -8,7 +9,7 @@ libite_la_SOURCES   = chomp.c copyfile.c dir.c fexist.c fisdir.c fmode.c fsendfi
 
 libite_la_CPPFLAGS  = -D_GNU_SOURCE
 libite_la_CFLAGS    = -W -Wall -Wextra
-libite_la_LDFLAGS   = $(AM_LDFLAGS) -version-info 2:1:0
+libite_la_LDFLAGS   = $(AM_LDFLAGS) -version-info 2:2:0
 
 pkgconfigdir        = $(libdir)/pkgconfig
 pkgconfig_DATA      = libite.pc

README.md

@@ -2,6 +2,22 @@
 ===========================
 [![Travis Status][]][Travis]
 
+
+Table of Contents
+-----------------
+
+* [Introduction](#introduction)
+* [Using -lite](#using--lite)
+* [Helper Macros](#helper-macros)
+* [Generic Functions](#generic-functions)
+* [OpenBSD Functions](#openbsd-functions)
+* [Build & Install](#origin--references)
+* [TODO](#todo)
+
+
+Introduction
+------------
+
 Libite is a lightweight library of *frog DNA*.  It can be used to fill
 the gaps in any dinosaur project.  It holds useful functions and macros
 developed by both [Finit][1] and the [OpenBSD][2] project.  Most notably
@@ -10,7 +26,7 @@ useful *BSD [sys/queue.h][4] and [sys/tree.h][7] API's.
 
 Libite is the frog DNA missing in GNU libc.  However, -lite does not aim
 to become another [GLIB][5]!  One noticeable gap in GLIBC is the missing
-`_SAFE` macros in tje BSD `sys/queue.h` API — highly recommended
+`_SAFE` macros in the BSD `sys/queue.h` API — highly recommended
 when traversing lists to delete/free nodes.
 
 The code is open sourced under a mix of the [MIT/X11 license][MIT], the
@@ -26,19 +42,32 @@ Using -lite
 -----------
 
 Libite is by default installed as a library and a set of include files.
-To prevent clashing with include files of the same name -lite employs a
-include file namespace `lite/`, which is recommended to use in your
-applications:
+To prevent clashing with include files of the same name `-lite` employs
+an include file namespace `lite/`, which is strongly recommended to use
+in your applications:
 
     #include <lite/lite.h>
     #include <lite/conio.h>
     #include <lite/queue.h>
     #include <lite/tree.h>
 
-The output from the `pkg-config` tool holds no surprises:
+The output from the `pkg-config` tool holds no surprises in this regard:
 
     $ pkg-config --libs --static --cflags libite
-    -I/usr/local/include -L/usr/local/lib -lite @LTLIBINTL@
+    -I/usr/local/include -L/usr/local/lib -lite
+
+The prefix path `/usr/local/` shown here is only the default.  Use the
+`configure` script to select a different prefix when installing libite.
+
+For GNU autotools based projects, use the following in `configure.ac`:
+
+    # Check for required libraries
+    PKG_CHECK_MODULES([lite], [libite >= 1.5.0])
+
+and in your `Makefile.am`:
+
+    proggy_CFLAGS = $(lite_CFLAGS)
+    proggy_LDADD  = $(lite_LIBS)
 
 
 Helper Macros
@@ -59,15 +88,15 @@ Helper Macros
 
 - `erase(path)`
 
-  Erase file/directory with `remove()`.  Errors on stderr
+  Erase file/directory with `remove()`.  Errors on `stderr`
 
 - `makedir(path)`
 
-  Create directory, like `mkdir()`.  Errors on stderr
+  Create directory, like `mkdir()`.  Errors on `stderr`
 
 - `makefifo(path)`
 
-  Create a FIFO, like `mkfifo()`.  Errors on stderr
+  Create a FIFO, like `mkfifo()`.  Errors on `stderr`
 
 - `min(a,b)`/`max(a,b)`
 
@@ -75,7 +104,7 @@ Helper Macros
 
 - `touch(path)`
 
-  Create a file, or update mtime.  Errors on stderr
+  Create a file, or update mtime.  Errors on `stderr`
 
 - `S_ISEXEC(mode_t m)`
 
@@ -91,7 +120,7 @@ Helper Macros
 
 - `ISOTHER(word,bit)`
 
-  Is any other bits, except bit, in (integer) word set?
+  Are any other bits, except bit, in (integer) word set?
 
 - `SETBIT(word,bit)`
 
@@ -135,11 +164,11 @@ Generic Functions
 
 - `fexist(file)`
 
-  Check for the existance of a file, returns True(1) or False(0).
+  Check for the existence of a file, returns True(1) or False(0).
 
 - `fisdir(path)`
 
-  Check for the existance of a directory, returns True(1) or False(0).
+  Check for the existence of a directory, returns True(1) or False(0).
 
 - `fmode(file)`
 
@@ -154,7 +183,7 @@ Generic Functions
 - `ifconfig(ifname, addr, mask, up)`
 
   Basic ifconfig like operations on an interface.  Only supports IPv4
-  adresses.  Note that mask is not CIDR notation.
+  addresses.  Note that mask is not CIDR notation.
 
 - `lfopen(file, sep)`, `lfclose(lf)`
 
@@ -163,7 +192,7 @@ Generic Functions
 
 - `lftok(lf)`
 
-  Read tokens, delimeted by `sep`, from file opened with `lfopen()`.
+  Read tokens, delimited by `sep`, from file opened with `lfopen()`.
 
 - `lfgetkey(lf, key)`
 
@@ -206,7 +235,7 @@ Generic Functions
   existence of this file, so make sure to have your signal handlers
   properly setup before calling this function.
 
-  The pidfile is removed when the program exits, using an `atexit()`
+  The PID file is removed when the program exits, using an `atexit()`
   handler.  However, depending on how the program terminates the file
   may still exist even though the program is no longer running.  This
   is only a problem for clients.
@@ -298,8 +327,8 @@ weight utility library.  Libite (LITE) employs the de facto standard GNU
 configure and build system:
 
     ./configure
-    make all
-    make install
+    make -j5
+    make install-strip
 
 
 TODO

TODO.md

@@ -0,0 +1,7 @@
+TODO ... in no particular order
+===============================
+
+* Investigate adding FreeBSD pidfile_open() et al
+* Investigate FreeBSD libutil library, could be useful for porting between unices
+
+

configure.ac

@@ -1,6 +1,4 @@
-# Use v2.61 for backwards compat with Ubuntu 12.04 LTS
-AC_PREREQ([2.61])
-AC_INIT(libite, 1.4.4, https://github.com/troglobit/libite/issues)
+AC_INIT(libite, 1.5.1, https://github.com/troglobit/libite/issues)
 AM_INIT_AUTOMAKE([1.11 foreign no-dist-gzip dist-xz])
 AM_SILENT_RULES([yes])
 
@@ -13,7 +11,4 @@ AC_PROG_CC
 AM_PROG_AR
 LT_INIT
 
-AC_HEADER_STDC
-AC_C_CONST
-
 AC_OUTPUT

copyfile.c

@@ -237,27 +237,23 @@ int movefile(char *src, char *dst)
  */
 int fcopyfile(FILE *src, FILE *dst)
 {
-	int ret;
-	char *buffer;
+	char *buf;
 
 	if (!src || !dst) {
 		errno = EINVAL;
 		return -1;
 	}
 
-	buffer = malloc(BUFSIZ);
-	if (!buffer)
+	buf = malloc(BUFSIZ);
+	if (!buf)
 		return -1;
 
-	ret = do_copy(fileno(src), fileno(dst), BUFSIZ, buffer, BUFSIZ);
-	if (ret > 0)
-		ret = 0;
-	else if (errno)
-		ret = -1;
+	while (fgets(buf, BUFSIZ, src))
+		fputs(buf, dst);
+	
+	free(buf);
 
-	free(buffer);
-
-	return ret;
+	return 0;
 }
 
 #ifdef UNITTEST
@@ -267,7 +263,7 @@ int main(void)
 {
 	int i = 0;
 	char *files[] = {
-		"/etc/passwd", "/tmp/tok", "/tmp/tok",
+		"/etc/passwd", "/tmp/mypwd", "/tmp/mypwd",
 		"/etc/passwd", "/tmp/", "/tmp/passwd",
 		"/etc/passwd", "/tmp", "/tmp/passwd",
 		NULL

pidfile.c

@@ -1,3 +1,4 @@
+/*	Updated by troglobit for libite/finit/uftpd projects 2016/03/19 */
 /*	$OpenBSD: pidfile.c,v 1.11 2015/06/03 02:24:36 millert Exp $	*/
 /*	$NetBSD: pidfile.c,v 1.4 2001/02/19 22:43:42 cgd Exp $	*/
 
@@ -30,6 +31,7 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
+#include <sys/stat.h>		/* utimensat() */
 #include <sys/types.h>
 #include <errno.h>
 #include <paths.h>
@@ -50,16 +52,25 @@ int
 pidfile(const char *basename)
 {
 	int save_errno;
+	int atexit_already;
 	pid_t pid;
 	FILE *f;
 
 	if (basename == NULL)
 		basename = __progname;
 
+	pid = getpid();
+	atexit_already = 0;
+
 	if (pidfile_path != NULL) {
+		if (pid == pidfile_pid) {
+			utimensat(0, pidfile_path, NULL, 0);
+			return 0;
+		}
 		free(pidfile_path);
 		pidfile_path = NULL;
 		__pidfile_name = NULL;
+		atexit_already = 1;
 	}
 
 	/* _PATH_VARRUN includes trailing / */
@@ -74,7 +85,6 @@ pidfile(const char *basename)
 		return (-1);
 	}
 
-	pid = getpid();
 	if (fprintf(f, "%ld\n", (long)pid) <= 0 || fflush(f) != 0) {
 		save_errno = errno;
 		(void) fclose(f);
@@ -90,7 +100,7 @@ pidfile(const char *basename)
 	 * LITE extension, no need to set up another atexit() handler
 	 * if user only called us to update the mtime of the PID file
 	 */
-	if (pidfile_pid == pid)
+	if (atexit_already)
 		return (0);
 
 	pidfile_pid = pid;

pidfilefn.c

@@ -122,28 +122,110 @@ int pidfile_signal(const char *pidfile, int signal)
 /********************************* UNIT TESTS ************************************/
 #ifdef UNITTEST
 #include <paths.h>
+#include <stdarg.h>
+#include <time.h>
 #include "lite.h"
 
 extern char *__progname;
 static char PIDFILE[42];
+static int verbose = 0;
+static struct stat before, after;
+
+static int test(int result, const char *fmt, ...)
+{
+	char buf[80];
+	size_t len;
+	va_list ap;
+	const char success[] = " \e[1m[ OK ]\e[0m\n";
+	const char failure[] = " \e[7m[FAIL]\e[0m\n";
+	const char dots[] = " .....................................................................";
+
+	va_start(ap, fmt);
+	len = vsnprintf(buf, sizeof(buf), fmt, ap);
+	va_end(ap);
+
+	write(STDERR_FILENO, buf, len);
+	write(STDERR_FILENO, dots, 60 - len); /* pad with dots. */
+
+	if (!result)
+		write(STDERR_FILENO, success, strlen(success));
+	else
+		write(STDERR_FILENO, failure, strlen(failure));
+
+	return result;
+}
+
+static inline int timespec_newer(const struct timespec *a, const struct timespec *b)
+{
+	if (a->tv_sec != b->tv_sec)
+		return a->tv_sec > b->tv_sec;
+
+	return a->tv_nsec > b->tv_nsec;
+}
+
+char *timespec2str(struct timespec *ts, char *buf, size_t len)
+{
+	size_t ret, pos;
+	struct tm t;
+
+	memset(buf, 0, len);
+
+	tzset();
+	if (localtime_r(&(ts->tv_sec), &t) == NULL)
+		return buf;
+
+	ret = strftime(buf, len, "%F %T", &t);
+	if (ret == 0)
+		return buf;
+	len -= ret - 1;
+
+	pos  = strlen(buf);
+	len -= pos;
+	snprintf(&buf[pos], len, ".%09ld", ts->tv_nsec);
+
+	return buf;
+}
 
 static void sigterm_handler(int UNUSED(signo))
 {
-	printf("Exiting ...\n");
+	if (verbose)
+		printf("Exiting ...\n");
 }
 
 static void sigalrm_handler(int UNUSED(signo))
 {
-	printf("Testing pidfile() ...\n");
 	pidfile(NULL);
-
 	if (!fexist(PIDFILE))
-		err(1, "pidfile() failed creating %s", PIDFILE);
+		err(1, "failed creating %s", PIDFILE);
+	stat(PIDFILE, &before);
 }
 
-int main(void)
+static int mtime()
 {
-	char cmd[80];
+	int ret;
+	char buf[80];
+
+	/* Must sleep a while here otherwise we execute too fast => no mtime change :-( */
+	usleep(10000);
+
+	if (verbose)
+		printf("Calling pidfile() again to update mtime ...\n");
+	pidfile(NULL);
+	stat(PIDFILE, &after);
+
+	ret = timespec_newer(&after.st_mtim, &before.st_mtim);
+	if (verbose) {
+		printf("Before: %s\n", timespec2str(&before.st_mtim, buf, sizeof(buf)));
+		printf("After : %s\n", timespec2str(&after.st_mtim, buf, sizeof(buf)));
+	}
+
+	return !ret;
+}
+
+int main(int argc, char *argv[])
+{
+	if (argc > 1 && !strcmp(argv[1], "-v"))
+		verbose = 1;
 
 	snprintf(PIDFILE, sizeof(PIDFILE), "%s%s.pid", _PATH_VARRUN, __progname);
 
@@ -151,36 +233,19 @@ int main(void)
 	signal(SIGALRM, sigalrm_handler);
 	alarm(1);
 
-	printf("Testing pidfile_poll() ...\n");
-	if (!pidfile_poll(PIDFILE))
-		printf("Timed out!\n");
-	else
-		printf("We got signal!\n");
+	return     test(pidfile_poll(PIDFILE) != getpid(), "Testing pidfile_poll()")
+		|| test(strcmp(__pidfile_name, PIDFILE),   "Testing __pidfile_name vs guessed PID filename")
+		|| test(mtime(),                           "Testing mtime update of followup pidfile() call")
+		|| test(pidfile_signal(PIDFILE, SIGTERM),  "Testing signalling ourselves")
+		;
 
-	printf("Reading pid file, should be %d ...\n", getpid());
-        printf("=> %d\n", pidfile_read(PIDFILE));
-
-	printf("\nComparing __pidfile_name with our guessed PID filename ...\n");
-	printf("strcmp(\"%s\",\n       \"%s\") => %s\n\n", __pidfile_name, PIDFILE,
-	       !strcmp(__pidfile_name, PIDFILE) ? "OK" : "FAIL");
-
-	/* Occular verification that calling pidfile() again updates mtime */
-	snprintf(cmd, sizeof(cmd), "ls -l --full-time %s", PIDFILE);
-	system(cmd);
-	printf("Before ^^ pidfile() vv after ...\n");
-	pidfile(NULL);
-	system(cmd);
-	
-        printf("Signalling ourselves ...\n");
-
-	return pidfile_signal(PIDFILE, SIGTERM);
+	return 0;
 }
-#endif  /* UTEST_PIDFN */
+#endif /* UNITTEST */
 
 /**
  * Local Variables:
  *  compile-command: "make V=1 -f pidfilefn.mk"
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

rules.mk

@@ -8,7 +8,7 @@ AR         ?= $(CROSS)ar
 STRIP      ?= $(CROSS)strip
 INSTALL    := install --backup=off
 STRIPINST  := $(INSTALL) -s --strip-program=$(CROSS)strip -m 0755
-
+CFLAGS     += -g -O0
 CPPFLAGS   += -D_GNU_SOURCE
 ARFLAGS     = crus