Update ChangeLog and bump version for v1.4.2 release

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

ChangeLog.md

@@ -4,6 +4,30 @@ Change Log
 All notable changes to the project are documented in this file.
 
 
+[v1.4.2][] - 2016-06-25
+-----------------------
+
+### Changes
+- Add range checks for `period` and `timeout` to `uev_timer_init()` and
+  `uev_timer_set()`.  If either on is `< 0` libuEv now return `ERANGE`.
+
+
+[v1.4.1][] - 2016-04-22
+-----------------------
+
+### Changes
+- Add some `pkg-config` integration tips for developers using libuEv
+  with GNU autotools in their projects.
+
+### Fixes
+- Add missing `SFD_CLOEXEC` and `TFD_CLOEXEC` to signal and timer file
+  descriptors.  This prevents these file descriptors from "leaking" into
+  sub-processes of the parent thread.  The kernel will atomically close
+  these descriptors for forked-off children calling the exec*() family
+  of syscalls.
+- Minor coding style fixes and simplification of build scripts.
+
+
 [v1.4.0][] - 2016-03-22
 -----------------------
 
@@ -11,12 +35,11 @@ This release changes the header file namespace, which was silently
 introduced in [v1.2.1][].  Apologies for any problems this may cause!
 
 ### Changes
-
 - Change namespace for header files: `libuev/` to `uev/`, e.g. using
   `pkg-config` your C program must now `#include <uev/uev.h>`
-- Support for EPOLLPRI events for I/O watchers, thanks to Markus Svilans
+- Support for `EPOLLPRI` events for I/O watchers, thanks to Markus Svilans
 - Simplified joystick example
-- Updated README slightly
+- Updated `README` slightly
 
 
 [v1.3.1][] - 2016-02-02
@@ -218,7 +241,9 @@ v0.0.1 - 2012-03-17
 Lua users mailing list.
 
 
-[UNRELEASED]: https://github.com/troglobit/libuev/compare/v1.4.0...HEAD
+[UNRELEASED]: https://github.com/troglobit/libuev/compare/v1.4.2...HEAD
+[v1.4.2]: https://github.com/troglobit/libuev/compare/v1.4.1...v1.4.2
+[v1.4.1]: https://github.com/troglobit/libuev/compare/v1.4.0...v1.4.1
 [v1.4.0]: https://github.com/troglobit/libuev/compare/v1.3.1...v1.4.0
 [v1.3.1]: https://github.com/troglobit/libuev/compare/v1.3.0...v1.3.1
 [v1.3.0]: https://github.com/troglobit/libuev/compare/v1.2.3...v1.3.0

LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2012       Flemming Madsen <flemming!madsen()madsensoft!dk>
-Copyright (c) 2013-2015  Joachim Nilsson <troglobit()gmail!com>
+Copyright (c) 2013-2016  Joachim Nilsson <troglobit()gmail!com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile.am

@@ -11,7 +11,7 @@ bench_LDADD         = $(top_srcdir)/libuev.la
 
 libuev_la_CPPFLAGS  = -D_GNU_SOURCE
 libuev_la_CFLAGS    = -W -Wall -Wextra
-libuev_la_LDFLAGS   = $(AM_LDFLAGS) -version-info 1:0:0
+libuev_la_LDFLAGS   = $(AM_LDFLAGS) -version-info 1:1:0
 
 pkgconfigdir        = $(libdir)/pkgconfig
 pkgconfig_DATA      = libuev.pc

README.md

@@ -3,9 +3,6 @@ libuEv | Simple event loop for Linux
 [![Travis Status][]][Travis] [![Coverity Status][]][Coverity Scan]
 
 
-Table of Contents
------------------
-
 * [Introduction](#introduction)
 * [API](#api)
   * [Create an Event Context](#create-an-event-context)
@@ -15,50 +12,22 @@ Table of Contents
 * [Using -luev](#using--luev)
 * [Joystick Example](#joystick-example)
 * [Build & Install](#build--install)
+* [Background](#background)
 * [Origin & References](#origin--references)
 
 
 Introduction
 ------------
 
-> “Why an event loop, why not use threads?”
-
-With the advent of light-weight processes (threads) programmers these
-days have a [golden hammer](http://c2.com/cgi/wiki?GoldenHammer) they
-often swing without consideration.  Event loops and non-blocking I/O is
-often a far easier approach, as well as less error prone.
-
-The purpose of many applications is, with a little logic sprinkled on
-top, to act on network packets entering an interface, timeouts expiring,
-mouse clicks, or other types of events.  Such applications are often
-very well suited to use an event loop.
-
-Applications that need to churn massively parallel algorithms are more
-suitable for running multiple (independent) threads on several CPU
-cores.  However, threaded applications must deal with the side effects
-of concurrency, like race conditions, deadlocks, live locks, etc.
-Writing error free threaded applications is hard, debugging them can be
-even harder.
-
-Sometimes the combination of multiple threads *and* an event loop per
-thread can be the best approach, but each application of course needs to
-be broken down individually to find the most optimal approach.  Do keep
-in mind, however, that not all systems your application will run on have
-multiple CPU cores -- some small embedded systems still use a single CPU
-core, even though they run Linux, with multiple threads a program may
-actually run slower!  Always profile your program, and if possible, test
-it on different architectures.
-
 [libuEv][] is a simple event loop in the style of the more established
 [libevent][1], [libev][2] and the venerable [Xt(3)][3] event loop.  The
 *u* (micro) in the name refers to both the small feature set and the
-small size overhead impact of the library.  The primary target of
-[libuEv][] is a modern Linux system.
+small size overhead impact of the library.
 
 Experienced developers may appreciate that [libuEv][] is built on top of
-modern Linux APIs: epoll, timerfd and signalfd.  Note, a certain amount
-of care is needed when dealing with APIs that employ signalfd.  For
-details, see [this article][4] at [lwn.net](http://lwn.net).
+modern Linux APIs: epoll, timerfd and signalfd.  Note however, a certain
+amount of care is needed when dealing with APIs that employ signalfd.
+For details, see [this article][4] at [lwn.net](http://lwn.net).
 
 > “Event driven software improves concurrency” -- [Dave Zarzycki, Apple][]
 
@@ -216,6 +185,16 @@ The output from the `pkg-config` tool holds no surprises:
 The prefix path `/usr/local/` shown here is only the default.  Use the
 `configure` script to select a different prefix when installing libuEv.
 
+For GNU autotools based projects, use the following in `configure.ac`:
+
+    # Check for required libraries
+    PKG_CHECK_MODULES([uev], [libuev >= 1.4.0])
+
+and in your `Makefile.am`:
+
+    proggy_CFLAGS = $(uev_CFLAGS)
+    proggy_LDADD  = $(uev_LIBS)
+
 
 Joystick Example
 ----------------
@@ -296,7 +275,7 @@ Build & Install
 ---------------
 
 The library is built for and developed on GNU/Linux systems, patches to
-support *BSD and its kqueue interface are most welcome.
+support *BSD and its [kqueue][] interface are most welcome.
 
 libuEv use the GNU configure and build system.  To try out the bundled
 examples, use the `--enable-examples` switch to the `configure` script.
@@ -309,6 +288,38 @@ examples, use the `--enable-examples` switch to the `configure` script.
 The resulting .so file is ~14 kiB (<kbd>make install-strip</kbd>).
 
 
+Background
+----------
+
+> “Why an event loop, why not use threads?”
+
+With the advent of light-weight processes (threads) programmers these
+days have a [golden hammer](http://c2.com/cgi/wiki?GoldenHammer) they
+often swing without consideration.  Event loops and non-blocking I/O is
+often a far easier approach, as well as less error prone.
+
+The purpose of many applications is, with a little logic sprinkled on
+top, to act on network packets entering an interface, timeouts expiring,
+mouse clicks, or other types of events.  Such applications are often
+very well suited to use an event loop.
+
+Applications that need to churn massively parallel algorithms are more
+suitable for running multiple (independent) threads on several CPU
+cores.  However, threaded applications must deal with the side effects
+of concurrency, like race conditions, deadlocks, live locks, etc.
+Writing error free threaded applications is hard, debugging them can be
+even harder.
+
+Sometimes the combination of multiple threads *and* an event loop per
+thread can be the best approach, but each application of course needs to
+be broken down individually to find the most optimal approach.  Do keep
+in mind, however, that not all systems your application will run on have
+multiple CPU cores -- some small embedded systems still use a single CPU
+core, even though they run Linux, with multiple threads a program may
+actually run slower!  Always profile your program, and if possible, test
+it on different architectures.
+
+
 Origin & References
 -------------------
 
@@ -334,6 +345,7 @@ event library used for inspiration is the very small [Picoev][9] by
 [Coverity Scan]:   https://scan.coverity.com/projects/3846
 [Coverity Status]: https://scan.coverity.com/projects/3846/badge.svg
 [LibuEv]:          https://github.com/troglobit/libuev
+[kqueue]:          https://github.com/mheily/libkqueue
 [Oku Kazuho]:      https://github.com/kazuho
 [Mark Lehmann]:    http://software.schmorp.de
 [Joachim Nilsson]: http://troglobit.com

TODO.md

@@ -1,5 +1,7 @@
 LibuEv TODO
 ===========
 
-* Make port to *BSD kqueue API, http://en.wikipedia.org/wiki/Kqueue
+* Port to *BSD kqueue API, http://en.wikipedia.org/wiki/Kqueue
+  Also in UNIX Network Progamming, by W. Richard Stevens 3rd ed.
+* Restore Lua bindings now that libuEv itself has stabilized
 

bench.c

@@ -229,7 +229,6 @@ int main(int argc, char **argv)
 
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

configure.ac

@@ -1,6 +1,4 @@
-# Use v2.61 for backwards compat with Ubuntu 12.04 LTS
-AC_PREREQ([2.61])
-AC_INIT(libuEv, 1.4.0, https://github.com/troglobit/libuev/issues, libuev)
+AC_INIT(libuev, 1.4.2, https://github.com/troglobit/libuev/issues)
 AM_INIT_AUTOMAKE([1.11 foreign no-dist-gzip dist-xz])
 AM_SILENT_RULES([yes])
 
@@ -18,7 +16,4 @@ AC_ARG_ENABLE([examples],
 	[enable_examples=yes], [])
 AM_CONDITIONAL([ENABLE_EXAMPLES], [test "$enable_examples" = yes])
 
-AC_HEADER_STDC
-AC_C_CONST
-
 AC_OUTPUT

examples/joystick.c

@@ -74,7 +74,6 @@ int main(void)
 /**
  * Local Variables:
  *  compile-command: "make joystick"
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

examples/signal.c

@@ -134,7 +134,6 @@ int main(void)
 
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

examples/test.c

@@ -146,7 +146,6 @@ int main(void)
 
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

io.c

@@ -1,7 +1,7 @@
 /* libuEv - Micro event loop library
  *
  * Copyright (c) 2012       Flemming Madsen <flemming!madsen()madsensoft!dk>
- * Copyright (c) 2013-2015  Joachim Nilsson <troglobit()gmail!com>
+ * Copyright (c) 2013-2016  Joachim Nilsson <troglobit()gmail!com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -23,7 +23,6 @@
  */
 
 #include <errno.h>
-
 #include "uev.h"
 
 
@@ -91,7 +90,6 @@ int uev_io_stop(uev_t *w)
 
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

private.h

@@ -82,7 +82,6 @@ int uev_watcher_stop (struct uev *w);
 
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

signal.c

@@ -1,7 +1,7 @@
 /* libuEv - Micro event loop library
  *
  * Copyright (c) 2012       Flemming Madsen <flemming!madsen()madsensoft!dk>
- * Copyright (c) 2013-2015  Joachim Nilsson <troglobit()gmail!com>
+ * Copyright (c) 2013-2016  Joachim Nilsson <troglobit()gmail!com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -52,7 +52,7 @@ int uev_signal_init(uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int signo
 	w->fd = -1;
 
 	sigemptyset(&mask);
-	fd = signalfd(-1, &mask, SFD_NONBLOCK);
+	fd = signalfd(-1, &mask, SFD_NONBLOCK | SFD_CLOEXEC);
 	if (fd < 0)
 		return -1;
 
@@ -151,7 +151,6 @@ int uev_signal_stop(uev_t *w)
 
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

timer.c

@@ -1,7 +1,7 @@
 /* libuEv - Micro event loop library
  *
  * Copyright (c) 2012       Flemming Madsen <flemming!madsen()madsensoft!dk>
- * Copyright (c) 2013-2015  Joachim Nilsson <troglobit()gmail!com>
+ * Copyright (c) 2013-2016  Joachim Nilsson <troglobit()gmail!com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -67,7 +67,12 @@ int uev_timer_init(uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int timeou
 {
 	int fd;
 
-	fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK);
+	if (timeout < 0 || period < 0) {
+		errno = ERANGE;
+		return -1;
+	}
+
+	fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK | TFD_CLOEXEC);
 	if (fd < 0)
 		return -1;
 
@@ -100,6 +105,11 @@ int uev_timer_set(uev_t *w, int timeout, int period)
 		return -1;
 	}
 
+	if (timeout < 0 || period < 0) {
+		errno = ERANGE;
+		return -1;
+	}
+
 	/* Handle stopped timers */
 	if (w->fd < 0) {
 		/* Timer already stopped */
@@ -169,7 +179,6 @@ int uev_timer_stop(uev_t *w)
 
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

uev.c

@@ -1,7 +1,7 @@
 /* libuEv - Micro event loop library
  *
  * Copyright (c) 2012       Flemming Madsen <flemming!madsen()madsensoft!dk>
- * Copyright (c) 2013-2015  Joachim Nilsson <troglobit()gmail!com>
+ * Copyright (c) 2013-2016  Joachim Nilsson <troglobit()gmail!com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -36,8 +36,9 @@
 
 static int _init(uev_ctx_t *ctx, int close_old)
 {
-	int fd = epoll_create1(EPOLL_CLOEXEC);
+	int fd;
 
+	fd = epoll_create1(EPOLL_CLOEXEC);
 	if (fd < 0)
 		return -1;
 
@@ -311,10 +312,8 @@ int uev_run(uev_ctx_t *ctx, int flags)
 	return result;
 }
 
-
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End:

uev.h

@@ -77,7 +77,6 @@ int uev_signal_stop    (uev_t *w);
 
 /**
  * Local Variables:
- *  version-control: t
  *  indent-tabs-mode: t
  *  c-file-style: "linux"
  * End: