version 1.5.8

Although the header files included in the official Windows SDK have
mixed case file names, MinGW opted to ship headers with entirely lower
case names.

Since the MinGW headers are often used when cross compiling Windows
binaries on Linux hosts, and Linux treats paths as case sensitive by
default, following the 'official' spelling breaks many cross build
setups.

Non-cross builds do not seem to be affected by using lower case file
names, and Microsoft also does not seem particularly consistent in the
way it spells header file names in e.g. documentation and sample code.

Therefore, this patch makes wepoll use lower case file names when
including Windows headers, regardless of whether MinGW or the official
SDK is used.

See also https://github.com/libevent/libevent/pull/1039
and https://github.com/stjepang/smol/issues/138.

Closes: https://github.com/piscisaureus/wepoll/pull/19

LICENSE

@@ -0,0 +1,28 @@
+wepoll - epoll for Windows
+https://github.com/piscisaureus/wepoll
+
+Copyright 2012-2020, Bert Belder <bertbelder@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -38,21 +38,23 @@ to run on Linux.
 ## How to use
 
 The library is [distributed][dist] as a single source file
-([wepoll.c][wepoll.c]) and a single header file ([wepoll.h][wepoll.h]).
-Compile the .c file as part of your project, and include the header
-wherever needed.
+([wepoll.c][wepoll.c]) and a single header file ([wepoll.h][wepoll.h]).<br>
+Compile the .c file as part of your project, and include the header wherever
+needed.
 
 ## Compatibility
 
 * Requires Windows Vista or higher.
 * Can be compiled with recent versions of MSVC, Clang, and GCC.
 
-## API notes
+## API
 
-### General
+### General remarks
 
 * The epoll port is a `HANDLE`, not a file descriptor.
 * All functions set both `errno` and `GetLastError()` on failure.
+* For more extensive documentation, see the [epoll(7) man page][man epoll],
+  and the per-function man pages that are linked below.
 
 ### epoll_create/epoll_create1
 
@@ -65,7 +67,7 @@ HANDLE epoll_create1(int flags);
 * `size` is ignored but most be greater than zero.
 * `flags` must be zero as there are no supported flags.
 * Returns `NULL` on failure.
-* [man page][man epoll_create]
+* [Linux man page][man epoll_create]
 
 ### epoll_close
 
@@ -87,15 +89,22 @@ int epoll_ctl(HANDLE ephnd,
 ```
 
 * Control which socket events are monitored by an epoll port.
-* `ephnd` must be a HANDLE created by `epoll_create` or `epoll_create1`.
+* `ephnd` must be a HANDLE created by
+  [`epoll_create()`](#epoll_createepoll_create1) or
+  [`epoll_create1()`](#epoll_createepoll_create1).
 * `op` must be one of `EPOLL_CTL_ADD`, `EPOLL_CTL_MOD`, `EPOLL_CTL_DEL`.
+* `sock` must be a valid socket created by [`socket()`][msdn socket],
+  [`WSASocket()`][msdn wsasocket], or [`accept()`][msdn accept].
+* `event` should be a pointer to a [`struct epoll_event`](#struct-epoll_event).<br>
+  If `op` is `EPOLL_CTL_DEL` then the `event` parameter is ignored, and it
+  may be `NULL`.
+* Returns 0 on success, -1 on failure.
 * It is recommended to always explicitly remove a socket from its epoll
-  set using `EPOLL_CTL_DEL` *before* closing it. As on Linux, sockets
-  are automatically removed from the epoll set when they are closed, but
-  wepoll may not be able to detect this until the next call to
-  `epoll_wait()`.
-* TODO: expand
-* [man page][man epoll_ctl]
+  set using `EPOLL_CTL_DEL` *before* closing it.<br>
+  As on Linux, closed sockets are automatically removed from the epoll set, but
+  wepoll may not be able to detect that a socket was closed until the next call
+  to [`epoll_wait()`](#epoll_wait).
+* [Linux man page][man epoll_ctl]
 
 ### epoll_wait
 
@@ -107,12 +116,74 @@ int epoll_wait(HANDLE ephnd,
 ```
 
 * Receive socket events from an epoll port.
-* Returns
-  - -1 on failure
-  -  0 when a timeout occurs
-  - ≥1 the number of evens received
-* TODO: expand
-* [man page][man epoll_wait]
+* `events` should point to a caller-allocated array of
+  [`epoll_event`](#struct-epoll_event) structs, which will receive the
+  reported events.
+* `maxevents` is the maximum number of events that will be written to the
+  `events` array, and must be greater than zero.
+* `timeout` specifies whether to block when no events are immediately available.
+  - `<0` block indefinitely
+  - `0`  report any events that are already waiting, but don't block
+  - `≥1` block for at most N milliseconds
+* Return value:
+  - `-1` an error occurred
+  - `0`  timed out without any events to report
+  - `≥1` the number of events stored in the `events` buffer
+* [Linux man page][man epoll_wait]
+
+### struct epoll_event
+
+```c
+typedef union epoll_data {
+  void* ptr;
+  int fd;
+  uint32_t u32;
+  uint64_t u64;
+  SOCKET sock;        /* Windows specific */
+  HANDLE hnd;         /* Windows specific */
+} epoll_data_t;
+```
+
+```c
+struct epoll_event {
+  uint32_t events;    /* Epoll events and flags */
+  epoll_data_t data;  /* User data variable */
+};
+```
+
+* The `events` field is a bit mask containing the events being
+  monitored/reported, and optional flags.<br>
+  Flags are accepted by [`epoll_ctl()`](#epoll_ctl), but they are not reported
+  back by [`epoll_wait()`](#epoll_wait).
+* The `data` field can be used to associate application-specific information
+  with a socket; its value will be returned unmodified by
+  [`epoll_wait()`](#epoll_wait).
+* [Linux man page][man epoll_ctl]
+
+| Event         | Description                                                          |
+|---------------|----------------------------------------------------------------------|
+| `EPOLLIN`     | incoming data available, or incoming connection ready to be accepted |
+| `EPOLLOUT`    | ready to send data, or outgoing connection successfully established  |
+| `EPOLLRDHUP`  | remote peer initiated graceful socket shutdown                       |
+| `EPOLLPRI`    | out-of-band data available for reading                               |
+| `EPOLLERR`    | socket error<sup>1</sup>                                             |
+| `EPOLLHUP`    | socket hang-up<sup>1</sup>                                           |
+| `EPOLLRDNORM` | same as `EPOLLIN`                                                    |
+| `EPOLLRDBAND` | same as `EPOLLPRI`                                                   |
+| `EPOLLWRNORM` | same as `EPOLLOUT`                                                   |
+| `EPOLLWRBAND` | same as `EPOLLOUT`                                                   |
+| `EPOLLMSG`    | never reported                                                       |
+
+| Flag             | Description               |
+|------------------|---------------------------|
+| `EPOLLONESHOT`   | report event(s) only once |
+| `EPOLLET`        | not supported by wepoll   |
+| `EPOLLEXCLUSIVE` | not supported by wepoll   |
+| `EPOLLWAKEUP`    | not supported by wepoll   |
+
+<sup>1</sup>: the `EPOLLERR` and `EPOLLHUP` events may always be reported by
+[`epoll_wait()`](#epoll_wait), regardless of the event mask that was passed to
+[`epoll_ctl()`](#epoll_ctl).
 
 
 [ci status badge]:  https://ci.appveyor.com/api/projects/status/github/piscisaureus/wepoll?branch=master&svg=true
@@ -122,6 +193,9 @@ int epoll_wait(HANDLE ephnd,
 [man epoll_create]: http://man7.org/linux/man-pages/man2/epoll_create.2.html
 [man epoll_ctl]:    http://man7.org/linux/man-pages/man2/epoll_ctl.2.html
 [man epoll_wait]:   http://man7.org/linux/man-pages/man2/epoll_wait.2.html
+[msdn accept]:      https://msdn.microsoft.com/en-us/library/windows/desktop/ms737526(v=vs.85).aspx
+[msdn socket]:      https://msdn.microsoft.com/en-us/library/windows/desktop/ms740506(v=vs.85).aspx
+[msdn wsasocket]:   https://msdn.microsoft.com/en-us/library/windows/desktop/ms742212(v=vs.85).aspx
 [select scale]:     https://daniel.haxx.se/docs/poll-vs-select.html
 [wsapoll broken]:   https://daniel.haxx.se/blog/2012/10/10/wsapoll-is-broken/
 [wepoll.c]:         https://github.com/piscisaureus/wepoll/blob/dist/wepoll.c

wepoll.h

@@ -1,9 +1,9 @@
 /*
  * wepoll - epoll for Windows
- * Copyright 2012-2017, Bert Belder. All rights reserved.
+ * https://github.com/piscisaureus/wepoll
  *
- * The red-black tree implementation:
- * Copyright 2002 Niels Provos <provos@citi.umich.edu> All rights reserved.
+ * Copyright 2012-2020, Bert Belder <bertbelder@gmail.com>
+ * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
@@ -38,42 +38,38 @@
 
 #include <stdint.h>
 
-/* clang-format off */
-
 enum EPOLL_EVENTS {
-  EPOLLIN      = 1 <<  0,
-  EPOLLPRI     = 1 <<  1,
-  EPOLLOUT     = 1 <<  2,
-  EPOLLERR     = 1 <<  3,
-  EPOLLHUP     = 1 <<  4,
-  EPOLLRDNORM  = 1 <<  6,
-  EPOLLRDBAND  = 1 <<  7,
-  EPOLLWRNORM  = 1 <<  8,
-  EPOLLWRBAND  = 1 <<  9,
-  EPOLLMSG     = 1 << 10, /* Never reported. */
-  EPOLLRDHUP   = 1 << 13,
-  EPOLLONESHOT = 1 << 31
+  EPOLLIN      = (int) (1U <<  0),
+  EPOLLPRI     = (int) (1U <<  1),
+  EPOLLOUT     = (int) (1U <<  2),
+  EPOLLERR     = (int) (1U <<  3),
+  EPOLLHUP     = (int) (1U <<  4),
+  EPOLLRDNORM  = (int) (1U <<  6),
+  EPOLLRDBAND  = (int) (1U <<  7),
+  EPOLLWRNORM  = (int) (1U <<  8),
+  EPOLLWRBAND  = (int) (1U <<  9),
+  EPOLLMSG     = (int) (1U << 10), /* Never reported. */
+  EPOLLRDHUP   = (int) (1U << 13),
+  EPOLLONESHOT = (int) (1U << 31)
 };
 
-#define EPOLLIN      ((uint32_t) EPOLLIN)
-#define EPOLLPRI     ((uint32_t) EPOLLPRI)
-#define EPOLLOUT     ((uint32_t) EPOLLOUT)
-#define EPOLLERR     ((uint32_t) EPOLLERR)
-#define EPOLLHUP     ((uint32_t) EPOLLHUP)
-#define EPOLLRDNORM  ((uint32_t) EPOLLRDNORM)
-#define EPOLLRDBAND  ((uint32_t) EPOLLRDBAND)
-#define EPOLLWRNORM  ((uint32_t) EPOLLWRNORM)
-#define EPOLLWRBAND  ((uint32_t) EPOLLWRBAND)
-#define EPOLLMSG     ((uint32_t) EPOLLMSG)
-#define EPOLLRDHUP   ((uint32_t) EPOLLRDHUP)
-#define EPOLLONESHOT ((uint32_t) EPOLLONESHOT)
+#define EPOLLIN      (1U <<  0)
+#define EPOLLPRI     (1U <<  1)
+#define EPOLLOUT     (1U <<  2)
+#define EPOLLERR     (1U <<  3)
+#define EPOLLHUP     (1U <<  4)
+#define EPOLLRDNORM  (1U <<  6)
+#define EPOLLRDBAND  (1U <<  7)
+#define EPOLLWRNORM  (1U <<  8)
+#define EPOLLWRBAND  (1U <<  9)
+#define EPOLLMSG     (1U << 10)
+#define EPOLLRDHUP   (1U << 13)
+#define EPOLLONESHOT (1U << 31)
 
 #define EPOLL_CTL_ADD 1
 #define EPOLL_CTL_MOD 2
 #define EPOLL_CTL_DEL 3
 
-/* clang-format on */
-
 typedef void* HANDLE;
 typedef uintptr_t SOCKET;
 
@@ -87,7 +83,7 @@ typedef union epoll_data {
 } epoll_data_t;
 
 struct epoll_event {
-  uint32_t events;   /* Epoll events */
+  uint32_t events;   /* Epoll events and flags */
   epoll_data_t data; /* User data variable */
 };