Update 20191109

.cirrus.yml

@@ -6,10 +6,18 @@ task:
   freebsd_instance:
     matrix:
       image: freebsd-12-0-release-amd64
-      image: freebsd-11-2-release-amd64
+      image: freebsd-11-3-stable-amd64-v20190808
   install_script:
     - sed -i.bak -e 's,pkg+http://pkg.FreeBSD.org/\${ABI}/quarterly,pkg+http://pkg.FreeBSD.org/\${ABI}/latest,' /etc/pkg/FreeBSD.conf
     - pkg upgrade -y
-
-  script: |
-    make -j 4
+    - pkg install -y cmake
+  build_script:
+    - pwd
+    - mkdir build
+    - cd build
+    - cmake .. -DCMAKE_BUILD_TYPE=Release
+    - cmake --build . -- -j4
+  test_script:
+    - pwd
+    - cd build
+    - ctest -VV --output-on-failure

.gitignore

@@ -0,0 +1,2 @@
+build*/
+.vscode

CMakeLists.txt

@@ -1,8 +1,76 @@
-cmake_minimum_required(VERSION 3.9)
-project(epoll-shim C)
+cmake_minimum_required(VERSION 3.14)
+project(epoll-shim LANGUAGES C)
 
-set(CMAKE_C_STANDARD 99)
+option(BUILD_SHARED_LIBS "build libepoll-shim as shared lib" ON)
+option(ENABLE_COMPILER_WARNINGS "enable compiler warnings" OFF)
+
+if(ENABLE_COMPILER_WARNINGS)
+  add_compile_options("-Wall"
+                      "-Wextra"
+                      "-Wconversion"
+                      "-Wsign-conversion"
+                      "-Wmissing-prototypes"
+                      "-pedantic"
+                      "-Werror=implicit-function-declaration"
+                      "-Werror=return-type"
+                      "-Werror=incompatible-pointer-types")
+endif()
+
+include(CTest)
+
+set(CMAKE_C_STANDARD 11)
 set(CMAKE_C_EXTENSIONS ON)
 
 add_subdirectory(src)
-add_subdirectory(test)
+
+if(PROJECT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+  set(_namespace "${PROJECT_NAME}")
+
+  if(BUILD_TESTING)
+    file(WRITE "${PROJECT_BINARY_DIR}/${PROJECT_NAME}-config.cmake"
+         "add_library(${_namespace}::epoll-shim ALIAS epoll-shim)\n")
+    set(${PROJECT_NAME}_DIR "${PROJECT_BINARY_DIR}")
+    if(ENABLE_COMPILER_WARNINGS)
+      add_compile_options("-w")
+    endif()
+    add_subdirectory(test)
+  endif()
+
+  include(GNUInstallDirs)
+
+  set(CMAKE_INSTALL_PKGCONFIGDIR
+      "libdata/pkgconfig"
+      CACHE PATH "Installation directory for pkgconfig (.pc) files")
+  mark_as_advanced(CMAKE_INSTALL_PKGCONFIGDIR)
+  set(CMAKE_INSTALL_CMAKEBASEDIR
+      "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+      CACHE PATH "Installation directory for CMake config (.cmake) files")
+  mark_as_advanced(CMAKE_INSTALL_CMAKEBASEDIR)
+
+  configure_file("${PROJECT_SOURCE_DIR}/${PROJECT_NAME}.pc.cmakein"
+                 "${PROJECT_BINARY_DIR}/${PROJECT_NAME}.pc" @ONLY)
+  install(FILES "${PROJECT_BINARY_DIR}/${PROJECT_NAME}.pc"
+          DESTINATION "${CMAKE_INSTALL_PKGCONFIGDIR}")
+
+  set(CMAKE_INSTALL_INCLUDEDIR "${CMAKE_INSTALL_INCLUDEDIR}/libepoll-shim")
+  install(TARGETS epoll-shim
+          EXPORT ${PROJECT_NAME}-targets
+          LIBRARY
+          INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
+  install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/" TYPE INCLUDE)
+
+  install(EXPORT ${PROJECT_NAME}-targets
+          NAMESPACE "${_namespace}::"
+          DESTINATION "${CMAKE_INSTALL_CMAKEBASEDIR}")
+  if(NOT BUILD_SHARED_LIBS)
+    set(_deps "include(CMakeFindDependencyMacro)\n"
+              "set(THREADS_PREFER_PTHREAD_FLAG ON)\n"
+              "find_dependency(Threads)\n")
+  endif()
+  file(
+    WRITE "${PROJECT_BINARY_DIR}/${PROJECT_NAME}-config.cmake"
+    ${_deps}
+    "include(\"\${CMAKE_CURRENT_LIST_DIR}/${PROJECT_NAME}-targets.cmake\")\n")
+  install(FILES "${PROJECT_BINARY_DIR}/${PROJECT_NAME}-config.cmake"
+          DESTINATION "${CMAKE_INSTALL_CMAKEBASEDIR}")
+endif()

README.md

@@ -1,4 +1,44 @@
-# epoll-shim
-Small epoll implementation using kqueue; includes all features needed for libinput/libevdev  
-
-This repo is used by the port `devel/libepoll-shim`
+epoll-shim
+==========
+
+This is a small library that implements epoll on top of kqueue.
+It has been successfully used to port libinput, libevdev, Wayland and more
+software to FreeBSD: https://www.freshports.org/devel/libepoll-shim/
+
+It may be useful for porting other software that uses epoll as well.
+
+There are some tests inside `test/`. They should also compile under Linux and
+can be used to verify proper epoll behavior.
+
+However, this library contains some very ugly hacks and workarounds. For
+example:
+ - When using timerfd, signalfd or eventfd, `read`, `write` and `close` are
+   redefined as macros to internal helper functions. This is needed as there
+   is some internal context that has to be free'd properly. This means that
+   you shouldn't create a timerfd/signalfd in one part of a program and close
+   it in a different part where `sys/timerfd.h` isn't included. The context
+   would leak. Luckily, software such as `libinput` behaves very nicely and
+   puts all timerfd related code in a single source file.
+ - There is exactly one static int reserved for fds that can be polled but are
+   not supported by kqueue under FreeBSD. This includes graphics or sound
+   devices under `/dev`. You can only have one of them throughout all epoll
+   instances in your process!
+
+
+Installation
+------------
+
+Run the following commands to build libepoll-shim:
+
+    $ mkdir build
+    $ cd build
+    $ cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo
+    $ cmake --build .
+
+To run the tests:
+
+    $ ctest --output-on-failure
+
+To install (as root):
+
+    # cmake --build . --target install

Version.map

@@ -2,12 +2,16 @@
   global:
     epoll_shim_close;
     epoll_shim_read;
+    epoll_shim_write;
     epoll_create;
     epoll_create1;
     epoll_ctl;
     epoll_wait;
     signalfd;
     timerfd_create;
     timerfd_settime;
+    eventfd;
+    eventfd_read;
+    eventfd_write;
   local: *;
 };

src/epoll-shim.pc.in → epoll-shim.pc.cmakein

@@ -1,12 +1,12 @@
 prefix=@CMAKE_INSTALL_PREFIX@
 exec_prefix=${prefix}
-libdir=${exec_prefix}/lib
-includedir=${prefix}/include
+libdir=${exec_prefix}/@CMAKE_INSTALL_LIBDIR@
+includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@
 
 Name: epoll-shim
-URL: https://github.com/FreeBSDDesktop/epoll-shim
+URL: https://github.com/jiixyj/epoll-shim
 Description: Small epoll implementation using kqueue
-Version: @PROJECT_VERSION@
+Version: 
 Libs: -L${libdir} -lepoll-shim
 Libs.private: -pthread -lrt
 Cflags: -I${includedir}/libepoll-shim

include/sys/epoll.h

@@ -5,11 +5,9 @@
 extern "C" {
 #endif
 
-/* include the same file as musl */
-#include <sys/types.h> /* IWYU pragma: keep */
-
-#include <fcntl.h>
 #include <stdint.h>
+#include <sys/types.h>
+#include <fcntl.h>
 
 #if 0
 #define __NEED_sigset_t
@@ -25,13 +23,15 @@ enum EPOLL_EVENTS { __EPOLL_DUMMY };
 #define EPOLLPRI 0x002
 #define EPOLLOUT 0x004
 #define EPOLLRDNORM 0x040
+#define EPOLLNVAL 0x020
 #define EPOLLRDBAND 0x080
 #define EPOLLWRNORM 0x100
 #define EPOLLWRBAND 0x200
 #define EPOLLMSG 0x400
 #define EPOLLERR 0x008
 #define EPOLLHUP 0x010
 #define EPOLLRDHUP 0x2000
+#define EPOLLEXCLUSIVE (1U<<28)
 #define EPOLLWAKEUP (1U<<29)
 #define EPOLLONESHOT (1U<<30)
 #define EPOLLET (1U<<31)
@@ -51,22 +51,30 @@ struct epoll_event {
 	uint32_t events;
 	epoll_data_t data;
 }
-#if defined(__amd64__)
-__attribute__((packed))
+#ifdef __x86_64__
+__attribute__ ((__packed__))
 #endif
 ;
 
-int epoll_create(int /*size*/);
-int epoll_create1(int /*flags*/);
-int epoll_ctl(
-    int /*fd*/, int /*op*/, int /*fd2*/, struct epoll_event * /*ev*/);
-int epoll_wait(
-    int /*fd*/, struct epoll_event * /*ev*/, int /*cnt*/, int /*to*/);
+
+int epoll_create(int);
+int epoll_create1(int);
+int epoll_ctl(int, int, int, struct epoll_event *);
+int epoll_wait(int, struct epoll_event *, int, int);
 #if 0
 int epoll_pwait(int, struct epoll_event *, int, int, const sigset_t *);
 #endif
 
 
+#ifndef SHIM_SYS_SHIM_HELPERS
+#define SHIM_SYS_SHIM_HELPERS
+#include <unistd.h> /* IWYU pragma: keep */
+
+extern int epoll_shim_close(int);
+#define close epoll_shim_close
+#endif
+
+
 #ifdef __cplusplus
 }
 #endif

include/sys/eventfd.h

@@ -0,0 +1,47 @@
+#ifndef SHIM_SYS_EVENTFD_H
+#define SHIM_SYS_EVENTFD_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdint.h>
+#include <fcntl.h>
+
+typedef uint64_t eventfd_t;
+
+#define EFD_SEMAPHORE 1
+#define EFD_CLOEXEC O_CLOEXEC
+#define EFD_NONBLOCK O_NONBLOCK
+
+int eventfd(unsigned int, int);
+int eventfd_read(int, eventfd_t *);
+int eventfd_write(int, eventfd_t);
+
+
+#ifndef SHIM_SYS_SHIM_HELPERS
+#define SHIM_SYS_SHIM_HELPERS
+#include <unistd.h> /* IWYU pragma: keep */
+
+extern int epoll_shim_close(int);
+#define close epoll_shim_close
+#endif
+
+#ifndef SHIM_SYS_SHIM_HELPERS_READ
+#define SHIM_SYS_SHIM_HELPERS_READ
+extern ssize_t epoll_shim_read(int, void *, size_t);
+#define read epoll_shim_read
+#endif
+
+#ifndef SHIM_SYS_SHIM_HELPERS_WRITE
+#define SHIM_SYS_SHIM_HELPERS_WRITE
+extern ssize_t epoll_shim_write(int, void const*, size_t);
+#define write epoll_shim_write
+#endif
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* sys/eventfd.h */

include/sys/signalfd.h

@@ -45,16 +45,22 @@ struct signalfd_siginfo {
 	uint8_t   pad[128-12*4-4*8-2];
 };
 
+
 #ifndef SHIM_SYS_SHIM_HELPERS
 #define SHIM_SYS_SHIM_HELPERS
 #include <unistd.h> /* IWYU pragma: keep */
 
-extern int epoll_shim_close(int /*fd*/);
-extern ssize_t epoll_shim_read(int /*fd*/, void * /*buf*/, size_t /*nbytes*/);
-#define read epoll_shim_read
+extern int epoll_shim_close(int);
 #define close epoll_shim_close
 #endif
 
+#ifndef SHIM_SYS_SHIM_HELPERS_READ
+#define SHIM_SYS_SHIM_HELPERS_READ
+extern ssize_t epoll_shim_read(int, void *, size_t);
+#define read epoll_shim_read
+#endif
+
+
 #ifdef __cplusplus
 }
 #endif

include/sys/timerfd.h

@@ -22,16 +22,22 @@ int timerfd_settime(int /*fd*/, int /*flags*/,
 int timerfd_gettime(int, struct itimerspec *);
 #endif
 
+
 #ifndef SHIM_SYS_SHIM_HELPERS
 #define SHIM_SYS_SHIM_HELPERS
 #include <unistd.h> /* IWYU pragma: keep */
 
-extern int epoll_shim_close(int /*fd*/);
-extern ssize_t epoll_shim_read(int /*fd*/, void * /*buf*/, size_t /*nbytes*/);
-#define read epoll_shim_read
+extern int epoll_shim_close(int);
 #define close epoll_shim_close
 #endif
 
+#ifndef SHIM_SYS_SHIM_HELPERS_READ
+#define SHIM_SYS_SHIM_HELPERS_READ
+extern ssize_t epoll_shim_read(int, void *, size_t);
+#define read epoll_shim_read
+#endif
+
+
 #ifdef __cplusplus
 }
 #endif