78 Commits
Author SHA1 Message Date
Joachim Nilsson 5e24736652 Bump version for v1.6.0 release
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-22 08:01:04 +02:00
Joachim Nilsson c8c84d12cd Add standard README.debian
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-21 21:29:56 +02:00
Joachim Nilsson 0bc466d112 Minor, reorder build vars a bit
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-21 21:29:21 +02:00
Joachim Nilsson 199e38c8dc debian/rules: Don't compress README.md and API.md in -dev package
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-21 21:28:54 +02:00
Joachim Nilsson f70693fd87 debian/docs: Also install new API.md docs
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-21 21:28:32 +02:00
Joachim Nilsson 777810cc83 Spellcheck ChangeLog(s)
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-21 07:55:06 +02:00
Joachim Nilsson e0b0924135 Add src/* to distribution archive files
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-21 07:53:30 +02:00
Joachim Nilsson 31fabccf7f README: Fix obvious error in example
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 13:38:39 +02:00
Joachim Nilsson f2d5192aa2 Reword note on time_t and GLIBC and add URL after user feedback
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 09:24:45 +02:00
Joachim Nilsson 891e641abe Sectionalize API docs better and update README ToC
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 09:04:54 +02:00
Joachim Nilsson b67c62045f Improve documentation for event flags on init and callback
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:59:39 +02:00
Joachim Nilsson 649f40e5d3 Reduce indentation in all code + shell examples
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:41:47 +02:00
Joachim Nilsson d92b4ce2ae Reduce indentation for very wide API desc.
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:39:25 +02:00
Joachim Nilsson 653f605c25 Update doc string for possible I/O watcher events
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:38:21 +02:00
Joachim Nilsson fd6a2b02d8 Simplify comment
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:38:05 +02:00
Joachim Nilsson 310e8a7607 Try quoute at top of text
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:18:48 +02:00
Joachim Nilsson f7f14a4a64 Reduce indentation and remove '$' in shell build example
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:18:05 +02:00
Joachim Nilsson a6e185d4e9 Minor refactor of layout
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:15:31 +02:00
Joachim Nilsson 2f96d2fcd4 Move quote back to README
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:15:11 +02:00
Joachim Nilsson 25701b4fc4 API.md: We handle Y2038 on GLIBC systems, but use relative timers
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:14:12 +02:00
Joachim Nilsson cc7fdc747a Simplify and correct project name
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:05:29 +02:00
Joachim Nilsson 16892b0673 Move caveat about using signalfd from README to API doc
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-20 08:05:01 +02:00
Joachim Nilsson b6b4afc11b Update copyright years
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 09:09:29 +02:00
Joachim Nilsson 8f6a0a6847 README: Move around text a bit to get a better flow
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 09:06:44 +02:00
Joachim Nilsson 36599097d5 README: Add a simple example
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 09:05:08 +02:00
Joachim Nilsson ca7a99aba3 README: Simplify origin a bit
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 09:04:46 +02:00
Joachim Nilsson 4e0bb82899 Remove MOTIVATION.md, wrote another blog post about it instead
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:59:15 +02:00
Joachim Nilsson 77738130e3 Relocate API.md, again, and add to distribution archive and doc/
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:59:15 +02:00
Joachim Nilsson 7a316468b5 Rename src/README.md --> src/API.md, add README symlink for GitHub
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:32:25 +02:00
Joachim Nilsson 10d69fdee7 Fix URLs in API document
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:30:47 +02:00
Joachim Nilsson 03ea12a41c Move background to a separate motivation document
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:29:43 +02:00
Joachim Nilsson 543b49fb08 Fix src/README.md URL
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:19:59 +02:00
Joachim Nilsson 17fd42fa87 Update and add ToC
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:18:29 +02:00
Joachim Nilsson 7d6a37e4c5 Move API documentation to src/README.md
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:16:20 +02:00
Joachim Nilsson ed5c9bb06c Relocate source fiiles to src/ subdirectory
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-19 08:12:21 +02:00
Joachim Nilsson aae505fb33 Bump version, v1.6.0-rc1
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-18 07:53:20 +02:00
Joachim Nilsson b290451eb0 Update ChangeLog(s) for upcoming v1.6.0 release
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-18 07:52:49 +02:00
Joachim Nilsson 1282e2e716 Fix #9: Y2038 fix for 32 bit GLIBC systems
This patch enables 64 bit time_t support on GLIBC based 32 bit systems.
See https://sourceware.org/glibc/wiki/Y2038ProofnessDesign for more on
this problem.

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-09-18 07:51:59 +02:00
Joachim Nilsson 1d415cfd50 Refactor, further additions of syntax highlighting
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-05-27 17:52:41 +02:00
Joachim Nilsson 6ca04123e2 Try shell script highlighting
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-05-27 17:43:03 +02:00
Joachim Nilsson 0f5842e6fe Prettify verbatim text
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-05-27 17:42:01 +02:00
Joachim Nilsson 1450e7e48a Whitesapce fixes
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-05-27 17:39:02 +02:00
Joachim Nilsson ee74602502 Clarify 32 bit time_t limitations in libuEv
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-05-07 20:36:38 +02:00
Joachim Nilsson 37453b821a Minor, remove unnecessary braces for one-liner conditional
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-05-06 18:07:01 +02:00
Joachim Nilsson 00afc27e46 Merge pull request #10 from Martijn81/master
Add edgetrigger and oneshot event types
2017-05-06 18:03:46 +02:00
martijn81 48fc8a38bc indentation problem fixed. 2017-05-06 18:00:07 +02:00
martijn81 6354b33316 UEV_EVENT_MASK change 2017-05-06 17:48:05 +02:00
martijn81 e18d980606 Added some spaces. 2017-05-06 17:41:28 +02:00
martijn81 92cfe557ca Minor changes 2017-05-06 17:37:36 +02:00
martijn81 047cc44c83 Add edgetrigger and oneshot event types 2017-05-06 13:53:38 +02:00
Joachim Nilsson 2c675519a3 TODO: Generic UNIX backend
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-05-01 12:29:37 +02:00
Joachim Nilsson c136d199f4 Bump Debian revision
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-03-12 17:49:47 +01:00
Joachim Nilsson 4c648d23d6 Add make package to build .deb files
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-03-12 17:49:33 +01:00
Joachim Nilsson 163d7e06f7 debian/source/format: Change to native mode to allow building from GIT
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2017-03-12 17:49:17 +01:00
Joachim Nilsson f630ed7d4b bench.c: Include signal.h, not non-std sys/signal.h
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-12-15 23:34:45 +01:00
Joachim Nilsson 59542e3672 debian/: Update .gitignore file
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-29 08:32:19 +01:00
Joachim Nilsson d19cd6fd32 debian/: Support for building .deb packages
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-28 23:28:01 +01:00
Joachim Nilsson 2e6fac00bb Update ChangeLog and bump version for v1.5.2 release
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-27 20:33:01 +01:00
Joachim Nilsson 8a3ab17435 Fix make distcheck and missing tests/Makefile.in
This patch fixes the build regressions in libuev v1.5.1, which are due
to the new unit test framework.

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-27 20:30:52 +01:00
Joachim Nilsson aa62e60137 Ensure check.h is included for all unit tests
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-27 20:30:19 +01:00
Joachim Nilsson 69c5b7f538 Update ChangeLog and bump version for v1.5.1 release
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-27 18:07:37 +01:00
Joachim Nilsson e765e42eb9 Verify that a timer can be stopped *before* uev_run()
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-25 17:28:15 +01:00
Joachim Nilsson 56a2e7ff30 Unit test for new active API
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-23 23:20:48 +01:00
Joachim Nilsson b6f92e2b15 New uev_*_active() API: check if watcher is active
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-23 23:18:33 +01:00
Joachim Nilsson 604afc6cec Travis-CI: Run new unit tests
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:33:17 +01:00
Joachim Nilsson 73ae8ba098 complete: Update test for unit test framework
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:30:40 +01:00
Joachim Nilsson 6a19fa7e93 cronrun: Update cron test to verify interval as well
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:27:49 +01:00
Joachim Nilsson 737ceb4398 Travis-CI: Minor cleanup
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:19:45 +01:00
Joachim Nilsson a8798ea6a7 configure: Remove --enable-examples option
Now unit tests and examples are separate things.  Unit tests build on
"make check" and examples must be built separately by the user.

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:18:45 +01:00
Joachim Nilsson d976171a14 Minor cleanup
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:18:07 +01:00
Joachim Nilsson 398251ade6 Make bench a noinst program
Must now be run separately, but will be built along with the library.

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:17:26 +01:00
Joachim Nilsson 628565b746 bench.c: Uncomment Xcount log message
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:13:03 +01:00
Joachim Nilsson de4d969ca0 Move complete test from examples/ --> tests/
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:12:47 +01:00
Joachim Nilsson 389c3b27ab Move cronrun test from examples/ --> tests/
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:09:38 +01:00
Joachim Nilsson 03a29440ef Move signal test from examples/ --> tests/
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 01:06:48 +01:00
Joachim Nilsson 9b3af80082 Add .gitignore for unit tests
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 00:37:39 +01:00
Joachim Nilsson 8f2c9f7f0e Add timer.c unit test
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 00:36:21 +01:00
Joachim Nilsson 6a21b7a90b Add unit testing framework from libite (-lite)
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
2016-11-22 00:35:19 +01:00
45 changed files with 790 additions and 406 deletions

No files matched your search

+1
View File
@@ -27,3 +27,4 @@ bench
libuev*.tar.*
libuev.pc
!libuev.pc.in
test-driver
+4 -5
View File
@@ -2,7 +2,7 @@
# Defaults to GNU GCC and autotools: ./configure && make && make test
language: c
# We don't need to install packages, use dockerized build, quicker
# Use docker for quicker builds, it now allows https://docs.travis-ci.com/user/apt/
sudo: false
env:
@@ -17,14 +17,13 @@ addons:
name: "troglobit/libuev"
description: "libuEv | Simple event loop for Linux"
notification_email: troglobit@gmail.com
build_command_prepend: "./autogen && ./configure --enable-examples"
build_command_prepend: "./autogen && ./configure"
build_command: "make clean all"
branch_pattern: dev
# We don't use configure, so we must define our own build script.
script:
- ./autogen.sh
- ./configure --disable-silent-rules --enable-examples
- ./configure --disable-silent-rules
- make clean
- make -j5
- make test
- make check
+283
View File
@@ -0,0 +1,283 @@
API Documentation
=================
* [Introduction](#introduction)
* [Overview](#overview)
* [Create an Event Context](#create-an-event-context)
* [Register an Event Watcher](#register-an-event-watcher)
* [Start Event Loop](#start-event-loop)
* [Summary](#summary)
* [Using -luev](#using--luev)
* [Joystick Example](#joystick-example)
Introduction
------------
The C API to [libuEv][], listed in `uev/uev.h`, handles three different
types of events: I/O (files, sockets, message queues, etc.), timers, and
signals. The [Summary](#summary) details a slight caveat on signals.
Timers can be either relative, timeout in milliseconds, or absolute with
a time given in `time_t`, see `mktime()` et al. Absolute timers are
called cron timers and their callbacks get an `UEV_HUP` error event if
the wall clock changes, either via NTP or user input.
**NOTE:** On some systems, embedded in particular, `time_t` is a 32-bit
integer that wraps around in the year 2038. A [GLIBC workaround][]
(`-D_TIME_BITS=64`) protects those systems, but users of other C
libraries have no known workarounds. It is strongly recommended to
use relative timers as often as possible.
Overview
--------
```C
/*
* Callback example, arg comes from the watcher's *_init() function,
* w->fd holds the file descriptor or socket, and events is set by
* libuEv to indicate status: UEV_READ and/or UEV_WRITE with any of
* the optional UEV_HUP, UEV_RDHUP, or UEV_PRI for urgent read data.
*/
void callback (uev_t *w, void *arg, int events);
/* Event loop: Notice the use of flags! */
int uev_init (uev_ctx_t *ctx);
int uev_exit (uev_ctx_t *ctx);
int uev_run (uev_ctx_t *ctx, int flags); /* UEV_NONE, UEV_ONCE, and/or UEV_NONBLOCK */
/* I/O watcher: fd *MUST* be non-blocking!
* events combination of the main flags: UEV_READ, UEV_WRITE,
* UEV_EDGE, UEV_ONESHOT
*/
int uev_io_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int fd, int events);
int uev_io_set (uev_t *w, int fd, int events);
int uev_io_start (uev_t *w);
int uev_io_stop (uev_t *w);
/* Timer watcher: schedule a relative timer, timeout and period in milliseconds */
int uev_timer_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int timeout, int period);
int uev_timer_set (uev_t *w, int timeout, int period); /* Change timeout or period */
int uev_timer_start (uev_t *w); /* Restart a stopped timer */
int uev_timer_stop (uev_t *w); /* Stop a timer */
/* Cron watcher: schedule an absolute timer, when and period in time_t seconds */
int uev_cron_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, time_t when, time_t period);
int uev_cron_set (uev_t *w, int when, time_t period); /* Change when or period */
int uev_cron_start (uev_t *w); /* Restart a stopped cron */
int uev_cron_stop (uev_t *w); /* Stop a cron */
/* Signal watcher: signo is the signal to wait for, e.g., SIGTERM */
int uev_signal_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int signo);
int uev_signal_set (uev_t *w, int signo); /* Change signal to wait for */
int uev_signal_start(uev_t *w); /* Restart a stopped signal watcher */
int uev_signal_stop (uev_t *w); /* Stop signal watcher */
```
### Create an Event Context
To monitor events the developer first creates an *event context*, this
is achieved by calling `uev_init()` with a pointer to a (thread) local
`uev_ctx_t` variable.
```C
uev_ctx_t ctx;
uev_init(&ctx);
```
### Register an Event Watcher
For each event to monitor, be it a signal, timer or file descriptor, a
*watcher* must be registered with the event context. The watcher, an
`uev_t`, is registered by calling the event type's `_init()` function
with the `uev_ctx_t` context, the callback, and an optional argument.
Here is a signal example:
```C
void cleanup_exit(uev_t *w, void *arg, int events)
{
/* Graceful exit, with optional cleanup ... */
uev_exit(w->ctx);
}
int main(void)
{
uev_t sigterm_watcher;
.
.
uev_signal_init(&ctx, &sigterm_watcher, cleanup_exit, NULL, SIGTERM);
.
.
}
```
### Start Event Loop
When all watchers are registered, call the *event loop* with `uev_run()`
and the argument to the event context. The `flags` parameter can be
used to integrate [libuEv][] into another event loop.
In this example we set `flags` to none:
```C
uev_run(&ctx, UEV_NONE);
```
With `flags` set to `UEV_ONCE` the event loop returns as soon as it has
served the first event. If `flags` is set to `UEV_ONCE | UEV_NONBLOCK`
the event loop returns immediately if no event is available.
**Note:** libuEv handles many types of errors, stream close, or peer
shutdowns internally, but also lets the callback run. This is useful
for stateful connections to be able to detect EOF.
### Summary
1. Set up an event context with `uev_init()`
2. Register event callbacks with the event context using
`uev_io_init()`, `uev_signal_init()` or `uev_timer_init()`
3. Start the event loop with `uev_run()`
4. Exit the event loop with `uev_exit()`, possibly from a callback
**Note 1:** Make sure to use non-blocking stream I/O! Most hard to find
bugs in event driven applications are due to sockets and files being
opened in blocking mode. Be careful out there!
**Note 2:** When closing a descriptor or socket, make sure to first stop
your watcher, if possible. This will help prevent any nasty side
effects on your program.
**Note 3:** a certain amount of care is needed when dealing with APIs
that employ signalfd. If your application use `system()` you replace
that with `fork()`, and then in the child, unblock all signals blocked
by your parent process, before you run `exec()`. This because Linux
does not unblock signals for your children, and neither does most
(all?) C-libraries. See the [finit][6] project's implementation of
`run()` for an example of this. For more details on this issue, see
[this article][4] at [lwn.net](http://lwn.net).
Using -luev
-----------
LibuEv is by default installed as a library with a few header files, you
should only ever need to include one:
```C
#include <uev/uev.h>
```
The output from the `pkg-config` tool holds no surprises:
```sh
$ pkg-config --libs --static --cflags libuev
-I/usr/local/include -L/usr/local/lib -luev
```
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`:
```sh
# Check for required libraries
PKG_CHECK_MODULES([uev], [libuev >= 1.4.0])
```
and in your `Makefile.am`:
```sh
proggy_CFLAGS = $(uev_CFLAGS)
proggy_LDADD = $(uev_LIBS)
```
Joystick Example
----------------
Here follows a very brief example to illustrate how one can use libuEv
to act upon joystick input.
```C
#include <err.h>
#include <errno.h>
#include <stdio.h>
#include <stdint.h>
#include <fcntl.h>
#include <unistd.h>
#include <uev/uev.h>
struct js_event {
uint32_t time; /* event timestamp in milliseconds */
int16_t value; /* value */
uint8_t type; /* event type */
uint8_t number; /* axis/button number */
} e;
static void joystick_cb(uev_t *w, void *arg, int events)
{
read(w->fd, &e, sizeof(e));
switch (e.type) {
case 1:
printf("Button %d %s\n", e.number, e.value ? "pressed" : "released");
break;
case 2:
printf("Joystick axis %d moved, value %d!\n", e.number, e.value);
break;
}
}
int main(void)
{
int fd;
uev_t watcher;
uev_ctx_t ctx;
fd = open("/dev/input/js1", O_RDONLY, O_NONBLOCK);
if (fd < 0)
errx(errno, "Cannot find a joystick attached.");
uev_init(&ctx);
uev_io_init(&ctx, &watcher, joystick_cb, NULL, fd, UEV_READ);
puts("Starting, press Ctrl-C to exit.");
return uev_run(&ctx, 0);
}
```
To build the example, follow installation instructions below, then save
the code as `joystick.c` and call GCC
```sh
$ gcc `pkg-config --libs --static --cflags libuev` -o joystick joystick.c
```
Alternatively, call the `Makefile` with <kbd>make joystick</kbd> from
the unpacked [libuEv][] distribution.
More complete and relevant example uses of [libuEv][] is the FTP/TFTP
server [uftpd][5], and the Linux `/sbin/init` replacement [finit][6].
Both successfully employ [libuEv][].
Also see the `bench.c` program (<kbd>make bench</kbd> from within the
library) for [reference benchmarks][7] against [libevent][1] and
[libev][2].
[1]: http://libevent.org
[2]: http://software.schmorp.de/pkg/libev.html
[4]: http://lwn.net/Articles/415684/
[5]: https://github.com/troglobit/uftpd
[6]: https://github.com/troglobit/finit
[7]: http://libev.schmorp.de/bench.html
[LibuEv]: https://github.com/troglobit/libuev
[GLIBC workaround]: https://sourceware.org/glibc/wiki/Y2038ProofnessDesign
+27
View File
@@ -4,6 +4,33 @@ Change Log
All notable changes to the project are documented in this file.
[v1.6.0][] - 2017-09-18
-----------------------
### Changes
- Support for edge triggered and oneshot event types
- Add `make package` build target to trigger a `.deb` package build
- Support 64 bit `time_t` on 32 bit GLIBC systems
### Fixes
- `bench.c`: Use `signal.h`, not non-standard `sys/signal.h`
[v1.5.2][] - 2016-11-27
-----------------------
### Fixes
- Fix build regression in v1.5.1
[v1.5.1][] - 2016-11-27
-----------------------
### Changes
- Add support for checking if a watcher is active.
- Refactor unit testing framework
[v1.5.0][] - 2016-10-30
-----------------------
+1 -1
View File
@@ -1,5 +1,5 @@
Copyright (c) 2012 Flemming Madsen <flemming!madsen()madsensoft!dk>
Copyright (c) 2013-2016 Joachim Nilsson <troglobit()gmail!com>
Copyright (c) 2013-2017 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
+7 -34
View File
@@ -1,39 +1,12 @@
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = src tests
DIST_SUBDIRS = src examples tests
doc_DATA = API.md README.md LICENSE
EXTRA_DIST = API.md README.md LICENSE AUTHORS ChangeLog.md
lib_LTLIBRARIES = libuev.la
pkgincludedir = $(includedir)/uev
pkginclude_HEADERS = uev.h private.h queue.h
libuev_la_SOURCES = uev.c io.c timer.c signal.c cron.c
check_PROGRAMS = bench
bench_CPPFLAGS = -D_GNU_SOURCE
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:2:0
pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = libuev.pc
doc_DATA = README.md LICENSE
EXTRA_DIST = README.md LICENSE AUTHORS ChangeLog.md
DIST_SUBDIRS = examples
SUBDIRS = .
if ENABLE_EXAMPLES
SUBDIRS += examples
endif
test joystick: all-recursive
./examples/$@
check-local:
@echo " BENCH $(PACKAGE)"
@./bench
if ENABLE_EXAMPLES
@echo " TEST $(PACKAGE)"
@./examples/test
endif
## Generate .deb package
package:
@dpkg-buildpackage -uc -us -B
## Generate MD5 checksum file
MD5 = md5sum
+46 -313
View File
@@ -4,18 +4,19 @@ libuEv | Simple event loop for Linux
* [Introduction](#introduction)
* [API](#api)
* [Create an Event Context](#create-an-event-context)
* [Register an Event Watcher](#register-an-event-watcher)
* [Start Event Loop](#start-event-loop)
* [Summary](#summary)
* [Using -luev](#using--luev)
* [Joystick Example](#joystick-example)
* [API](API.md#overview)
* [Create an Event Context](API.md#create-an-event-context)
* [Register an Event Watcher](API.md#register-an-event-watcher)
* [Start Event Loop](API.md#start-event-loop)
* [Summary](API.md#summary)
* [Using -luev](API.md#using--luev)
* [Joystick Example](API.md#joystick-example)
* [Build & Install](#build--install)
* [Background](#background)
* [Origin & References](#origin--references)
> “Event driven software improves concurrency” -- [Dave Zarzycki, Apple][]
Introduction
------------
@@ -25,334 +26,72 @@ Introduction
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 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][]
modern Linux APIs: epoll, timerfd and signalfd.
API
---
Example
-------
The C API to [libuEv][], listed in `uev/uev.h`, handles three different
types of events: I/O (files, sockets, message queues, etc.), timers, and
signals. The [Summary](#summary) details a slight caveat on signals.
Timers can be either relative, timeout in milliseconds, or absolute with
a time given in `time_t`, see `mktime()` et al. Absolute timers are
called cron timers and their callbacks get an `UEV_HUP` error event if
the wall clock changes, either via NTP or user input.
**NOTE:** On some systems, embedded systems in particular, `time_t` is a
32-bit integer that wraps around in the year 2038. [libuEv][] cannot
protect you against this problem, unfortunately.
The library documentation is available as a [separate document](API.md).
```C
#include <stdio.h>
#include <uev/uev.h>
/*
* Callback example, arg comes from the watcher's *_init() function,
* w->fd holds the file descriptor or socket, and events is set by
* libuEv to indicate status: UEV_HUP, UEV_READ and/or UEV_WRITE
*/
void callback (uev_t *w, void *arg, int events);
static void cb(uev_t *w, void *arg, int events)
{
puts("Every other second");
}
/* Event loop: Notice the use of flags! */
int uev_init (uev_ctx_t *ctx);
int uev_exit (uev_ctx_t *ctx);
int uev_run (uev_ctx_t *ctx, int flags); /* UEV_NONE, UEV_ONCE, and/or UEV_NONBLOCK */
/* I/O watcher: fd is non-blocking, events is UEV_READ and/or UEV_WRITE */
int uev_io_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int fd, int events);
int uev_io_set (uev_t *w, int fd, int events);
int uev_io_start (uev_t *w);
int uev_io_stop (uev_t *w);
/* Timer watcher: schedule a relative timer, timeout and period in milliseconds */
int uev_timer_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int timeout, int period);
int uev_timer_set (uev_t *w, int timeout, int period); /* Change timeout or period */
int uev_timer_start (uev_t *w); /* Restart a stopped timer */
int uev_timer_stop (uev_t *w); /* Stop a timer */
/* Cron watcher: schedule an absolute timer, when and period in time_t seconds */
int uev_cron_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, time_t when, time_t period);
int uev_cron_set (uev_t *w, int when, time_t period); /* Change when or period */
int uev_cron_start (uev_t *w); /* Restart a stopped cron */
int uev_cron_stop (uev_t *w); /* Stop a cron */
/* Signal watcher: signo is the signal to wait for, e.g., SIGTERM */
int uev_signal_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int signo);
int uev_signal_set (uev_t *w, int signo); /* Change signal to wait for */
int uev_signal_start(uev_t *w); /* Restart a stopped signal watcher */
int uev_signal_stop (uev_t *w); /* Stop signal watcher */
int main(void)
{
uev_t timer;
uev_ctx_t ctx;
uev_init(&ctx);
uev_timer_init(&ctx, &timer, cb, NULL, 2 * 1000, 0);
return uev_run(&ctx, 0);
}
```
### Create an Event Context
To monitor events the developer first creates an *event context*, this
is achieved by calling `uev_init()` with a pointer to a (thread) local
`uev_ctx_t` variable.
```C
uev_ctx_t ctx;
uev_init(&ctx);
```
### Register an Event Watcher
For each event to monitor, be it a signal, timer or file descriptor, a
*watcher* must be registered with the event context. The watcher, an
`uev_t`, is registered by calling the event type's `_init()` function
with the `uev_ctx_t` context, the callback, and an optional argument.
Here is a signal example:
```C
void cleanup_exit(uev_t *w, void *arg, int events)
{
/* Graceful exit, with optional cleanup ... */
uev_exit(w->ctx);
}
int main(void)
{
uev_t sigterm_watcher;
.
.
.
uev_signal_init(&ctx, &sigterm_watcher, cleanup_exit, NULL, SIGTERM);
.
.
.
}
```
### Start Event Loop
When all watchers are registered, call the *event loop* with `uev_run()`
and the argument to the event context. The `flags` parameter can be
used to integrate [libuEv][] into another event loop.
In this example we set `flags` to none:
```C
uev_run(&ctx, UEV_NONE);
```
With `flags` set to `UEV_ONCE` the event loop returns as soon as it has
served the first event. If `flags` is set to `UEV_ONCE | UEV_NONBLOCK`
the event loop returns immediately if no event is available.
**Note:** libuEv handles many types of errors, stream close, or peer
shutdowns internally, but also lets the callback run. This is useful
for stateful connections to be able to detect EOF.
### Summary
1. Set up an event context with `uev_init()`
2. Register event callbacks with the event context using
`uev_io_init()`, `uev_signal_init()` or `uev_timer_init()`
3. Start the event loop with `uev_run()`
4. Exit the event loop with `uev_exit()`, possibly from a callback
**Note 1:** Make sure to use non-blocking stream I/O! Most hard to find
bugs in event driven applications are due to sockets and files being
opened in blocking mode. Be careful out there!
**Note 2:** When closing a descriptor or socket, make sure to first stop
your watcher, if possible. This will help prevent any nasty side
effects on your program.
**Note 3:** As mentioned above, a certain amount of care is needed when
dealing with signalfd. If your application use `system()` you replace
that with `fork()`, and then in the child, unblock all signals blocked
by your parent process, before you run `exec()`. This because Linux
does not unblock signals for your children, and neither does most (all?)
C-libraries. See the [finit][6] project's implementation of `run()` for
an example of this.
Using -luev
-----------
LibuEv is by default installed as a library with a few header files, you
should only ever need to include one:
#include <uev/uev.h>
The output from the `pkg-config` tool holds no surprises:
$ pkg-config --libs --static --cflags libuev
-I/usr/local/include -L/usr/local/lib -luev
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
----------------
Here follows a very brief example to illustrate how one can use libuEv
to act upon joystick input.
```C
#include <err.h>
#include <errno.h>
#include <stdio.h>
#include <stdint.h>
#include <fcntl.h>
#include <unistd.h>
#include <uev/uev.h>
struct js_event {
uint32_t time; /* event timestamp in milliseconds */
int16_t value; /* value */
uint8_t type; /* event type */
uint8_t number; /* axis/button number */
} e;
static void joystick_cb(uev_t *w, void *arg, int events)
{
read(w->fd, &e, sizeof(e));
switch (e.type) {
case 1:
printf("Button %d %s\n", e.number, e.value ? "pressed" : "released");
break;
case 2:
printf("Joystick axis %d moved, value %d!\n", e.number, e.value);
break;
}
}
int main(void)
{
int fd;
uev_t watcher;
uev_ctx_t ctx;
fd = open("/dev/input/js1", O_RDONLY, O_NONBLOCK);
if (fd < 0)
errx(errno, "Cannot find a joystick attached.");
uev_init(&ctx);
uev_io_init(&ctx, &watcher, joystick_cb, NULL, fd, UEV_READ);
puts("Starting, press Ctrl-C to exit.");
return uev_run(&ctx, 0);
}
```
To build the example, follow installation instructions below, then save
the code as `joystick.c` and call GCC
gcc `pkg-config --libs --static --cflags libuev` -o joystick joystick.c
Alternatively, call the `Makefile` with <kbd>make joystick</kbd> from
the unpacked [libuEv][] distribution.
More complete and relevant example uses of [libuEv][] is the FTP/TFTP
server [uftpd][5], and the Linux `/sbin/init` replacement [finit][6].
Both successfully employ [libuEv][].
Also see the `bench.c` program (<kbd>make bench</kbd> from within the
library) for [reference benchmarks][7] against [libevent][1] and
[libev][2].
Build & Install
---------------
The library is built for and developed on GNU/Linux systems, patches to
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.
There is also a limited unit test suite that can be useful to learn how
the library works.
./configure
make -j5
make test
sudo make install-strip
sudo ldconfig
```sh
./configure
make -j5
make test
sudo make install-strip
sudo ldconfig
```
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.
The resulting .so file is ~14 kiB.
Origin & References
-------------------
[libuEv][] was originally based on [LibUEvent][8] by [Flemming Madsen][]
but has been completely rewritten with a much clearer API. Now more
similar to the famous [libev][2] by [Mark Lehmann][]. Another small
event library used for inspiration is the very small [Picoev][9] by
[Oku Kazuho][].
but has been completely rewritten to provide a cleaner API. It is now
more similar to the famous [libev][2] by [Mark Lehmann][]. Another
small event library used for inspiration is the very small [picoev][9]
by [Oku Kazuho][].
[libuEv][] is developed and maintained by [Joachim Nilsson][]. It is
built for and developed on GNU/Linux systems, patches to support *BSD
and its [kqueue][] interface are most welcome.
[libuEv][] is developed and maintained by [Joachim Nilsson][].
[1]: http://libevent.org
[2]: http://software.schmorp.de/pkg/libev.html
[3]: http://unix.com/man-page/All/3x/XtDispatchEvent
[4]: http://lwn.net/Articles/415684/
[5]: https://github.com/troglobit/uftpd
[6]: https://github.com/troglobit/finit
[7]: http://libev.schmorp.de/bench.html
[8]: http://code.google.com/p/libuevent/
[9]: https://github.com/kazuho/picoev
[Travis]: https://travis-ci.org/troglobit/libuev
@@ -366,9 +105,3 @@ event library used for inspiration is the very small [Picoev][9] by
[Joachim Nilsson]: http://troglobit.com
[Flemming Madsen]: http://www.madsensoft.dk
[Dave Zarzycki, Apple]: http://www.youtube.com/watch?v=cD_s6Fjdri8
<!--
-- Local Variables:
-- mode: markdown
-- End:
-->
+2
View File
@@ -1,6 +1,8 @@
LibuEv TODO
===========
* Add standard UNIX backend with select() and timer_create()
See SMCRoute and toolbox for examples.
* 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
+3 -8
View File
@@ -1,19 +1,14 @@
AC_INIT(libuev, 1.5.0, https://github.com/troglobit/libuev/issues)
AC_INIT(libuev, 1.6.0, https://github.com/troglobit/libuev/issues)
AM_INIT_AUTOMAKE([1.11 foreign no-dist-gzip dist-xz])
AM_SILENT_RULES([yes])
AC_CONFIG_SRCDIR(uev.c)
AC_CONFIG_SRCDIR(src/uev.c)
AM_CONFIG_HEADER(config.h)
AC_CONFIG_FILES([Makefile libuev.pc examples/Makefile])
AC_CONFIG_FILES([Makefile src/libuev.pc src/Makefile examples/Makefile tests/Makefile])
AC_CONFIG_MACRO_DIR([m4])
AC_PROG_CC
AM_PROG_AR
LT_INIT
AC_ARG_ENABLE([examples],
[AS_HELP_STRING([--enable-examples], [build examples])],
[enable_examples=yes], [])
AM_CONDITIONAL([ENABLE_EXAMPLES], [test "$enable_examples" = yes])
AC_OUTPUT
+8
View File
@@ -0,0 +1,8 @@
tmp/*
libuev/*
libuev*
autoreconf*
debhelper*
files
!*.dirs
!*.install
+14
View File
@@ -0,0 +1,14 @@
libuEv for Debian
-----------------
This is the upstream pre-packaged version of libuEv. It consists of two
.deb packages: one with only the .so library and one -dev package with
headers and the .a library for static linking. It builds on any Debian
based operating system, e.g. Debian, Ubuntu, Linux Mint, etc.
Recommended reading is the upstream README and API docs.
less /usr/share/doc/libuev-dev/README.md
zless /usr/share/doc/libuev-dev/API.md.gz
-- Joachim Nilsson <troglobit@gmail.com> Thu, 21 Sep 18:10, 2017
+18
View File
@@ -0,0 +1,18 @@
libuev (1.6.0-1) unstable; urgency=medium
* Support for edge triggered and oneshot event types
* Support for 64 bit time_t on 32 bit GLIBC systems
-- Joachim Nilsson <troglobit@gmail.com> Mon, 18 Sep 2017 07:49:23 +0200
libuev (1.5.2-2) unstable; urgency=low
* Minor packaging fixes.
-- Joachim Nilsson <troglobit@gmail.com> Sun, 12 Mar 2017 17:48:00 +0100
libuev (1.5.2-1) unstable; urgency=low
* Initial release.
-- Joachim Nilsson <troglobit@gmail.com> Mon, 28 Nov 2016 22:53:35 +0100
+1
View File
@@ -0,0 +1 @@
config.log
+1
View File
@@ -0,0 +1 @@
9
+39
View File
@@ -0,0 +1,39 @@
Source: libuev
Priority: optional
Maintainer: Joachim Nilsson <troglobit@gmail.com>
Build-Depends: dpkg-dev (>= 1.14.9), debhelper (>= 9), dh-autoreconf
Standards-Version: 3.9.6
Section: libs
Homepage: https://github.com/troglobit/libuev/
Vcs-Git: https://github.com/troglobit/libuev.git
Vcs-Browser: https://github.com/troglobit/libuev/
Package: libuev-dev
Priority: extra
Section: libdevel
Architecture: any
Depends: ${misc:Depends}, libuev (= ${binary:Version})
Description: static library, header files, and docs for libuev
Static library, header files, and documentation for libuev.
.
libuEv is a simple event loop in the style of the more established
libevent, libev and the venerable Xt(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.
.
Experienced developers may appreciate that libuEv is built on top of
modern Linux APIs: epoll, timerfd and signalfd. Note however, a certain
amount of care is needed when dealing with APIs that employ signalfd.
Package: libuev
Architecture: any
Depends: ${misc:Depends}, ${shlibs:Depends}
Description: Lightweight event loop library
libuEv is a simple event loop in the style of the more established
libevent, libev and the venerable Xt(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.
.
Experienced developers may appreciate that libuEv is built on top of
modern Linux APIs: epoll, timerfd and signalfd. Note however, a certain
amount of care is needed when dealing with APIs that employ signalfd.
+26
View File
@@ -0,0 +1,26 @@
Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Source: https.//github.com/troglobit/libuev/
Files: *
Copyright: 2013-2017 Joachim Nilsson <troglobit@gmail.com>
License: MIT
Copyright (c) 2012 Flemming Madsen <flemming!madsen()madsensoft!dk>
Copyright (c) 2013-2017 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
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Vendored
+2
View File
@@ -0,0 +1,2 @@
API.md
README.md
+2
View File
@@ -0,0 +1,2 @@
usr/lib
usr/include
+6
View File
@@ -0,0 +1,6 @@
usr/include/uev/uev.h
usr/include/uev/private.h
usr/include/uev/queue.h
usr/lib/*/lib*.a
usr/lib/*/lib*.so
usr/lib/*/pkgconfig/lib*.pc
+1
View File
@@ -0,0 +1 @@
usr/lib
+1
View File
@@ -0,0 +1 @@
usr/lib/*/lib*.so.*
Vendored Executable
+10
View File
@@ -0,0 +1,10 @@
#!/usr/bin/make -f
# Uncomment this to turn on verbose mode.
#export DH_VERBOSE=1
%:
dh $@ --with autoreconf
override_dh_compress:
dh_compress -A -X.md
+1
View File
@@ -0,0 +1 @@
3.0 (native)
+1 -1
View File
@@ -1,4 +1,4 @@
noinst_PROGRAMS = signal test joystick cronrun
noinst_PROGRAMS = joystick
AM_CPPFLAGS = -I$(top_srcdir)
AM_LDFLAGS = -L$(top_srcdir)
LIBS = $(LTLIBINTL)
+1 -1
View File
@@ -1,6 +1,6 @@
/* Simple example of how to use libuEv with Linux joystick API
*
* Copyright (c) 2014-2016 Joachim Nilsson <troglobit()gmail!com>
* Copyright (c) 2014-2017 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
+14
View File
@@ -0,0 +1,14 @@
lib_LTLIBRARIES = libuev.la
libuev_la_SOURCES = uev.c io.c timer.c signal.c cron.c
libuev_la_CPPFLAGS = -D_GNU_SOURCE -D_TIME_BITS=64
libuev_la_CFLAGS = -W -Wall -Wextra
libuev_la_LDFLAGS = $(AM_LDFLAGS) -version-info 1:2:0
noinst_PROGRAMS = bench
bench_CPPFLAGS = -D_GNU_SOURCE
bench_LDADD = libuev.la
pkgconfigdir = $(libdir)/pkgconfig
pkgincludedir = $(includedir)/uev
pkgconfig_DATA = libuev.pc
pkginclude_HEADERS = uev.h private.h queue.h
+1
View File
@@ -0,0 +1 @@
../API.md
+3 -2
View File
@@ -44,11 +44,11 @@
#include <errno.h>
#include <fcntl.h>
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/resource.h>
#include <sys/signal.h>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/time.h>
@@ -140,7 +140,8 @@ static struct timeval *run_once(uev_ctx_t *ctx)
gettimeofday(&te, NULL);
// if (xcount != count) fprintf(stderr, "Xcount: %d, Rcount: %d\n", xcount, count);
if (xcount != count)
fprintf(stderr, "Xcount: %d, Rcount: %d\n", xcount, count);
}
timersub(&te, &ta, &ta);
+1 -1
View File
@@ -1,7 +1,7 @@
/* libuEv - Micro event loop library
*
* Copyright (c) 2012 Flemming Madsen <flemming!madsen()madsensoft!dk>
* Copyright (c) 2013-2016 Joachim Nilsson <troglobit()gmail!com>
* Copyright (c) 2013-2017 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
+6 -2
View File
@@ -1,7 +1,7 @@
/* libuEv - Micro event loop library
*
* Copyright (c) 2012 Flemming Madsen <flemming!madsen()madsensoft!dk>
* Copyright (c) 2013-2016 Joachim Nilsson <troglobit()gmail!com>
* Copyright (c) 2013-2017 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
@@ -33,7 +33,7 @@
* @param cb I/O callback
* @param arg Optional callback argument
* @param fd File descriptor to watch, or -1 to register an empty watcher
* @param events Requested events to watch for, a mask of %UEV_READ, %UEV_WRITE and %UEV_PRI
* @param events Events to watch for: %UEV_READ, %UEV_WRITE, %UEV_EDGE, %UEV_ONESHOW
*
* @return POSIX OK(0) or non-zero with @param errno set on error.
*/
@@ -60,6 +60,10 @@ int uev_io_init(uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int fd, int e
*/
int uev_io_set(uev_t *w, int fd, int events)
{
if ((events & UEV_ONESHOT) && w->active)
return uev_watcher_rearm(w);
/* Ignore any errors, only to clean up anything lingering ... */
uev_io_stop(w);
View File
File renamed without changes.
+8 -6
View File
@@ -38,7 +38,7 @@ typedef enum {
} uev_type_t;
/* Event mask, used internally only. */
#define UEV_EVENT_MASK (UEV_READ | UEV_WRITE | UEV_PRI | UEV_HUP)
#define UEV_EVENT_MASK (UEV_READ | UEV_WRITE | UEV_PRI | UEV_HUP | UEV_RDHUP | UEV_EDGE | UEV_ONESHOT)
/* Main libuEv context type */
typedef struct {
@@ -81,11 +81,13 @@ struct uev;
uev_type_t
/* Internal API for dealing with generic watchers */
int uev_watcher_init (uev_ctx_t *ctx, struct uev *w, uev_type_t type,
void (*cb)(struct uev *, void *, int), void *arg,
int fd, int events);
int uev_watcher_start(struct uev *w);
int uev_watcher_stop (struct uev *w);
int uev_watcher_init (uev_ctx_t *ctx, struct uev *w, uev_type_t type,
void (*cb)(struct uev *, void *, int), void *arg,
int fd, int events);
int uev_watcher_start (struct uev *w);
int uev_watcher_stop (struct uev *w);
int uev_watcher_active(struct uev *w);
int uev_watcher_rearm (struct uev *w);
#endif /* LIBUEV_PRIVATE_H_ */
View File
File renamed without changes.
+1 -1
View File
@@ -1,7 +1,7 @@
/* libuEv - Micro event loop library
*
* Copyright (c) 2012 Flemming Madsen <flemming!madsen()madsensoft!dk>
* Copyright (c) 2013-2016 Joachim Nilsson <troglobit()gmail!com>
* Copyright (c) 2013-2017 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
+1 -1
View File
@@ -1,7 +1,7 @@
/* libuEv - Micro event loop library
*
* Copyright (c) 2012 Flemming Madsen <flemming!madsen()madsensoft!dk>
* Copyright (c) 2013-2016 Joachim Nilsson <troglobit()gmail!com>
* Copyright (c) 2013-2017 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
+28 -1
View File
@@ -1,7 +1,7 @@
/* libuEv - Micro event loop library
*
* Copyright (c) 2012 Flemming Madsen <flemming!madsen()madsensoft!dk>
* Copyright (c) 2013-2016 Joachim Nilsson <troglobit()gmail!com>
* Copyright (c) 2013-2017 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
@@ -124,6 +124,33 @@ int uev_watcher_stop(uev_t *w)
return 0;
}
/* Private to libuEv, do not use directly! */
int uev_watcher_active(uev_t *w)
{
if (!w)
return 0;
return w->active;
}
/* Private to libuEv, do not use directly! */
int uev_watcher_rearm(uev_t *w)
{
struct epoll_event ev;
if (!w || w->fd < 0) {
errno = EINVAL;
return -1;
}
ev.events = w->events | EPOLLRDHUP;
ev.data.ptr = w;
if (epoll_ctl(w->ctx->fd, EPOLL_CTL_MOD, w->fd, &ev) < 0)
return -1;
return 0;
}
/**
* Create an event loop context
* @param ctx Pointer to an uev_ctx_t context to be initialized
+15 -2
View File
@@ -30,17 +30,26 @@
/* Max. number of simulateneous events */
#define UEV_MAX_EVENTS 10
/* I/O events, for signals and timers revents will always be UEV_READ */
/* I/O events, signal and timer revents are always UEV_READ */
#define UEV_NONE 0
#define UEV_READ EPOLLIN
#define UEV_WRITE EPOLLOUT
#define UEV_PRI EPOLLPRI
#define UEV_HUP EPOLLHUP
#define UEV_RDHUP EPOLLRDHUP
#define UEV_EDGE EPOLLET
#define UEV_ONESHOT EPOLLONESHOT
/* Run flags */
#define UEV_ONCE 1
#define UEV_NONBLOCK 2
/* Macros */
#define uev_io_active(w) uev_watcher_active(w)
#define uev_timer_active(w) uev_watcher_active(w)
#define uev_cron_active(w) uev_watcher_active(w)
#define uev_signal_active(w) uev_watcher_active(w)
/* Event watcher */
typedef struct uev {
/* Private data for libuEv internal engine */
@@ -52,7 +61,11 @@ typedef struct uev {
uev_ctx_t *ctx;
} uev_t;
/* Generic callback for watchers */
/*
* Generic callback for watchers, @events holds %UEV_READ and/or %UEV_WRITE
* with optional %UEV_PRI (priority data available to read) and any of the
* %UEV_HUP and/or %UEV_RDHUP, which may be used to signal hang-up events.
*/
typedef void (uev_cb_t)(uev_t *w, void *arg, int events);
/* Public interface */
+7
View File
@@ -0,0 +1,7 @@
*.trs
*.log
active
complete
cronrun
signal
timer
+16
View File
@@ -0,0 +1,16 @@
EXTRA_DIST = check.h
CLEANFILES = *~ *.trs *.log
TESTS =
TESTS += active
TESTS += complete
TESTS += cronrun
TESTS += signal
TESTS += timer
check_PROGRAMS = $(TESTS)
# Ignore warnings about unused result, in e.g. write()
CFLAGS = -W -Wall -Wextra -Wno-unused-result
CPPFLAGS = -D_GNU_SOURCE
LDADD = -L../src ../src/libuev.la
+51
View File
@@ -0,0 +1,51 @@
#include "check.h"
#include <time.h>
#include <sys/time.h>
#define TIMEOUT1 2 /* 2 sec */
#define TIMEOUT2 4 /* 4 sec */
#define DAYLY (24 * 60 * 60) /* Seconds in one day */
uev_t timer1;
uev_t timer2;
uev_t timer3;
uev_t cron1;
uev_t cron2;
static void cb(uev_t *w, void *UNUSED(arg), int UNUSED(events))
{
fail_unless(w == &timer1);
fail_unless(uev_timer_active(&timer2));
fail_unless(!uev_timer_active(&timer3));
fail_unless(uev_cron_active(&cron1));
fail_unless(uev_cron_active(&cron2));
uev_timer_stop(&timer2);
uev_timer_stop(&cron2);
fail_unless(!uev_timer_active(&timer2));
fail_unless(!uev_cron_active(&cron2));
uev_exit(w->ctx);
}
int main(void)
{
uev_ctx_t ctx;
struct timeval tomorrow;
gettimeofday(&tomorrow, NULL);
tomorrow.tv_sec += 24 * 60 * 60;
uev_init(&ctx);
uev_timer_init(&ctx, &timer1, cb, NULL, TIMEOUT1 * 1000, 0);
uev_timer_init(&ctx, &timer2, cb, NULL, TIMEOUT2 * 1000, 0);
uev_timer_init(&ctx, &timer3, cb, NULL, TIMEOUT2 * 1000, 0);
uev_timer_stop(&timer3);
uev_cron_init(&ctx, &cron1, cb, NULL, tomorrow.tv_sec, 24 * 60 * 60);
uev_cron_init(&ctx, &cron2, cb, NULL, tomorrow.tv_sec, 24 * 60 * 60);
return uev_run(&ctx, 0);
}
+81
View File
@@ -0,0 +1,81 @@
#ifndef UEV_TESTS_CHECK_H_
#define UEV_TESTS_CHECK_H_
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include "../src/uev.h"
#define UNUSED(arg) arg __attribute__ ((unused))
#define fail_unless(test) \
do { \
if (!(test)) { \
fprintf(stderr, \
"----------------------------------------------\n" \
"%s:%d: test FAILED:\nFailed test: %s\n" \
"----------------------------------------------\n", \
__FILE__, __LINE__, #test); \
exit(1); \
} \
} while (0)
static inline int test(int result, const char *fmt, ...)
{
char buf[80];
size_t len;
va_list ap;
const char success[] = " \033[1m[ OK ]\033[0m\n";
const char failure[] = " \033[7m[FAIL]\033[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;
}
static inline 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;
}
#endif /* UEV_TESTS_CHECK_H_ */
+2 -9
View File
@@ -22,14 +22,8 @@
* THE SOFTWARE.
*/
#include "check.h"
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h> /* intptr_t */
#include "uev.h"
#define UNUSED(arg) arg __attribute__ ((unused))
typedef struct {
int counter;
@@ -138,8 +132,7 @@ int main(void)
uev_run(&ctx, 0);
fprintf(stderr, "Period is %d must be 10: %s\n", period, 10 == period ? "OK" : "ERROR!");
if (10 != period)
return 1;
fail_unless(10 == period);
return 0;
}
+20 -15
View File
@@ -21,20 +21,29 @@
* THE SOFTWARE.
*/
#include <stdio.h>
#include "check.h"
#include <time.h>
#include <sys/time.h>
#include "uev.h"
#define UNUSED(arg) arg __attribute__ ((unused))
#define TIMEOUT 2
#define INTERVAL 2
struct timeval tv;
static void cron_job(uev_t *w, void *arg, int events)
static void cron_job(uev_t *w, void *UNUSED(arg), int UNUSED(events))
{
struct timeval tv;
static int laps = 3;
struct timeval now;
gettimeofday(&tv, NULL);
printf("Cron job HELO %s", ctime(&tv.tv_sec));
/* Update timer every lap */
tv.tv_sec += TIMEOUT;
gettimeofday(&now, NULL);
printf("Cron job HELO %s", ctime(&now.tv_sec));
fail_unless(now.tv_sec == tv.tv_sec);
if (!laps--)
uev_exit(w->ctx);
}
int main(void)
@@ -42,20 +51,16 @@ int main(void)
uev_t cron_watcher;
uev_ctx_t ctx;
time_t when, interval;
struct timeval tv;
/* Initialize libuEv */
uev_init(&ctx);
/* Cron job */
gettimeofday(&tv, NULL);
when = tv.tv_sec + 30;
interval = 30;
uev_cron_init(&ctx, &cron_watcher, cron_job, NULL, when, interval);
/* Start event loop */
printf("Start of test %s", ctime(&tv.tv_sec));
printf("Expected cron %s", ctime(&when));
when = tv.tv_sec + TIMEOUT;
interval = INTERVAL;
uev_cron_init(&ctx, &cron_watcher, cron_job, NULL, when, interval);
return uev_run(&ctx, 0);
}
+1 -3
View File
@@ -21,7 +21,7 @@
* THE SOFTWARE.
*/
#define _GNU_SOURCE
#include "check.h"
#include <err.h>
#include <sched.h>
#include <signal.h>
@@ -33,8 +33,6 @@
#include <sys/wait.h>
#include <unistd.h>
#include "uev.h"
#define UNUSED(arg) arg __attribute__ ((unused))
#define DO_SEGFAULT 1
+28
View File
@@ -0,0 +1,28 @@
#include "check.h"
#include <time.h>
#include <sys/time.h>
#define TIMEOUT 2 /* 2 sec */
struct timeval start;
static void cb(uev_t *w, void *UNUSED(arg), int UNUSED(events))
{
struct timeval now;
gettimeofday(&now, NULL);
fail_unless(now.tv_sec == start.tv_sec + TIMEOUT);
uev_exit(w->ctx);
}
int main(void)
{
uev_t w;
uev_ctx_t ctx;
uev_init(&ctx);
uev_timer_init(&ctx, &w, cb, NULL, TIMEOUT * 1000, 0);
gettimeofday(&start, NULL);
return uev_run(&ctx, 0);
}