Kqueue

Kqueue is a scalable event notification interface introduced in FreeBSD 4.1 in July 2000,^[1][2] also supported in NetBSD, OpenBSD, DragonFly BSD, and macOS. Kqueue was originally authored in 2000 by Jonathan Lemon,^[1][2] then involved with the FreeBSD Core Team. Kqueue makes it possible for software like nginx to solve the c10k problem.^[3][4] The term "kqueue" refers to its function as a "kernel event queue"^[1][2]

Kqueue provides efficient input and output event pipelines between the kernel and userland. Thus, it is possible to modify event filters as well as receive pending events while using only a single system call to kevent(2) per main event loop iteration. This contrasts with older traditional polling system calls such as poll(2) and select(2) which are less efficient, especially when polling for events on numerous file descriptors.

Kqueue not only handles file descriptor events but is also used for various other notifications such as file modification monitoring, signals, asynchronous I/O events (AIO), child process state change monitoring, and timers which support nanosecond resolution, furthermore kqueue provides a way to use user-defined events in addition to the ones provided by the kernel.

Some other operating systems which traditionally only supported select(2) and poll(2) also currently provide more efficient polling alternatives, such as epoll on Linux and I/O completion ports on Windows and Solaris.

libkqueue is a user space implementation of kqueue(2), which translates calls to an operating system's native backend event mechanism.^[5]

API

The function prototypes and types are found in sys/event.h.^[6]

int kqueue(void);

Creates a new kernel event queue and returns a descriptor.

int kevent(int kq, const struct kevent *changelist, int nchanges, struct kevent *eventlist, int nevents, const struct timespec *timeout);

Used to register events with the queue, then wait for and return any pending events to the user. In contrast to epoll, kqueue uses the same function to register and wait for events, and multiple event sources may be registered and modified using a single call. The changelist array can be used to pass modifications (changing the type of events to wait for, register new event sources, etc.) to the event queue, which are applied before waiting for events begins. nevents is the size of the user supplied eventlist array that is used to receive events from the event queue.

EV_SET(kev, ident, filter, flags, fflags, data, udata);

A macro that is used for convenient initialization of a struct kevent object.

See also

OS-independent libraries with support for kqueue:

• libevent
• libuv

Kqueue equivalent for other platforms:

• on Solaris, Windows and AIX: I/O completion ports. Note that completion ports notify when a requested operation has completed, whereas kqueue can also notify when a file descriptor is ready to perform an I/O operation.
• on Linux:
  • epoll system call has similar but not identical semantics.
  • inotify is a Linux kernel subsystem that notices changes to the filesystem and reports those to applications.

References

1. Jonathan Lemon (2000). "kqueue, kevent — kernel event notification mechanism". BSD Cross Reference. FreeBSD, OpenBSD, NetBSD, DragonFly BSD.
   • "kqueue, kevent -- kernel event notification mechanism". FreeBSD Manual Pages.
   • "kqueue, kevent, EV_SET — kernel event notification mechanism". OpenBSD manual page server.
   • "kqueue, kevent -- kernel event notification mechanism". DragonFly On-Line Manual Pages.
2. Jonathan Lemon (2001-05-01). Kqueue: A generic and scalable event notification facility (PDF). Proceedings of the FREENIX Track: 2001 USENIX Annual Technical Conference. USENIX (published June 25–30, 2001).
   • "KQueue–A Generic and Scalable Event Notification Facility". Usenix.
3. "Connection processing methods". nginx.org.
4. Andrew Alexeev (2012). "§14. nginx". In Amy Brown; Greg Wilson (eds.). The Architecture of Open Source Applications, Volume II: Structure, Scale and a Few More Fearless Hacks. Lulu.com. ISBN 9781105571817.
5. libkqueue on GitHub
6. kqueue(2) – FreeBSD System Calls Manual

External links

• kqueue(2) – FreeBSD System Calls Manual
• libbrb_core implements an abstraction for an event-oriented base, using kqueue() system call
• FreeBSD source code of the kqueue() system call
• OpenBSD source code of the kqueue() system call
• NetBSD source code of the kqueue() system call
• DragonFly BSD source code of the kqueue() system call