timerfd_create(2)

โœจ timerfd_create(2) โœจ

okay so this is the System Calls Manual page for timerfd_create(2), and bestie, it's genuinely one of the good ones. timers that ping you through a file descriptor?? it's giving main character energy fr fr ๐Ÿ’…


๐ŸŽ€ NAME ๐ŸŽ€

timerfd_create, timerfd_settime, timerfd_gettime โ€” timers that notify via file descriptors โœจ

๐Ÿ“š LIBRARY ๐Ÿ“š

Standard C library (libc, -lc)

๐ŸŒธ SYNOPSIS ๐ŸŒธ

#include <sys/timerfd.h>

int timerfd_create(int clockid, int flags);

int timerfd_settime(int fd, int flags,
                    const struct itimerspec *new_value,
                    struct itimerspec *_Nullable old_value);
int timerfd_gettime(int fd, struct itimerspec *curr_value);

๐Ÿ’– DESCRIPTION ๐Ÿ’–

So these system calls create and operate on a timer that delivers timer expiration notifications via a file descriptor. They're basically the glow-up alternative to setitimer(2) or timer_create(2) โ€” the whole selling point is that the file descriptor can be watched by select(2), poll(2), and epoll(7). so you just... slip it into your event loop like it was always meant to be there. iconic behavior.

The way these three system calls work is analogous to timer_create(2), timer_settime(2), and timer_gettime(2). (no cap: there is no analog of timer_getoverrun(2), because read(2) already hands you that functionality โ€” more on that below ๐Ÿ‘‡)


๐Ÿฆ‹ timerfd_create() ๐Ÿฆ‹

timerfd_create() creates a brand new timer object and returns a file descriptor that refers to that timer. the clockid argument says which clock marks the progress of the timer, and it has to be one of these:

  • CLOCK_REALTIME โ€” a settable, system-wide real-time clock.
  • CLOCK_MONOTONIC โ€” a nonsettable, monotonically increasing clock that measures time from some unspecified point in the past, and that doesn't change after system startup.
  • CLOCK_BOOTTIME (Since Linux 3.15) โ€” like CLOCK_MONOTONIC, this one is monotonically increasing. but here's the tea ๐Ÿต: whereas CLOCK_MONOTONIC does not measure time while the system is suspended, CLOCK_BOOTTIME does include the time the system is suspended. so it's useful for applications that need to be suspend-aware. CLOCK_REALTIME is not suitable for such applications, because that clock gets affected by discontinuous changes to the system clock. ๐Ÿ™ˆ
  • CLOCK_REALTIME_ALARM (since Linux 3.11) โ€” like CLOCK_REALTIME, but it will wake the system if it's suspended. the caller must have the CAP_WAKE_ALARM capability in order to set a timer against this clock.
  • CLOCK_BOOTTIME_ALARM (since Linux 3.11) โ€” like CLOCK_BOOTTIME, but it will also wake the system if it's suspended. same deal: the caller must have the CAP_WAKE_ALARM capability to set a timer against this clock.

See clock_getres(2) for some further details on the clocks above. and if you wanna know the current value of each of these clocks, clock_gettime(2) is right there bestie ๐Ÿ’œ

Starting with Linux 2.6.27, these values may be bitwise ORed in flags to change the behavior of timerfd_create():

  • TFD_NONBLOCK โ€” sets the O_NONBLOCK file status flag on the open file description (see open(2)) referred to by the new file descriptor. using this flag saves you extra calls to fcntl(2) to get the same result. efficiency slay.
  • TFD_CLOEXEC โ€” sets the close-on-exec (FD_CLOEXEC) flag on the new file descriptor. see the description of the O_CLOEXEC flag in open(2) for the reasons why this might be useful.
โš ๏ธ In Linux versions up to and including 2.6.26, flags must be specified as zero. no options for you, old kernel bestie, sorry ๐Ÿ˜ญ

๐Ÿ’… timerfd_settime() ๐Ÿ’…

timerfd_settime() arms (starts) or disarms (stops) the timer referred to by the file descriptor fd.

The new_value argument specifies the initial expiration and interval for the timer. the itimerspec structure used for this argument is described in itimerspec(3type).

new_value.it_value specifies the initial expiration of the timer, in seconds and nanoseconds:

  • setting either field of new_value.it_value to a nonzero value arms the timer โฐ
  • setting both fields of new_value.it_value to zero disarms the timer ๐Ÿ˜ด

Setting one or both fields of new_value.it_interval to nonzero values specifies the period, in seconds and nanoseconds, for repeated timer expirations after the initial expiration. If both fields of new_value.it_interval are zero, the timer expires just once, at the time specified by new_value.it_value.

By default, the initial expiration time specified in new_value is interpreted relative to the current time on the timer's clock at the time of the call โ€” i.e., new_value.it_value specifies a time relative to the current value of the clock specified by clockid. an absolute timeout can be selected via the flags argument instead.

The flags argument is a bit mask that can include the following values:

  • TFD_TIMER_ABSTIME โ€” interpret new_value.it_value as an absolute value on the timer's clock. the timer will expire when the value of the timer's clock reaches the value specified in new_value.it_value.
  • TFD_TIMER_CANCEL_ON_SET โ€” if this flag is specified along with TFD_TIMER_ABSTIME, and the clock for this timer is CLOCK_REALTIME or CLOCK_REALTIME_ALARM, then mark this timer as cancelable if the real-time clock undergoes a discontinuous change (settimeofday(2), clock_settime(2), or similar). when such changes occur, a current or future read(2) from the file descriptor will fail with the error ECANCELED. ๐Ÿ’€

If the old_value argument is not NULL, then the itimerspec structure it points to is used to return the setting of the timer that was current at the time of the call โ€” see the description of timerfd_gettime() right below ๐Ÿ‘‡


๐Ÿงš timerfd_gettime() ๐Ÿงš

timerfd_gettime() returns, in curr_value, an itimerspec structure containing the current setting of the timer referred to by the file descriptor fd.

The it_value field returns the amount of time until the timer will next expire. If both fields of this structure are zero, then the timer is currently disarmed. and listen: this field always contains a relative value, regardless of whether the TFD_TIMER_ABSTIME flag was specified when setting the timer. no exceptions bestie.

The it_interval field returns the interval of the timer. If both fields of this structure are zero, then the timer is set to expire just once, at the time specified by curr_value.it_value.


๐ŸŒˆ Operating on a timer file descriptor ๐ŸŒˆ

The file descriptor returned by timerfd_create() supports these additional operations:

  • read(2) โ€” if the timer has already expired one or more times since its settings were last modified using timerfd_settime(), or since the last successful read(2), then the buffer given to read(2) returns an unsigned 8-byte integer (uint64_t) containing the number of expirations that have occurred. (the returned value is in host byte order โ€” that is, the native byte order for integers on the host machine.)
    • If no timer expirations have occurred at the time of the read(2), then the call either blocks until the next timer expiration, or fails with the error EAGAIN if the file descriptor has been made nonblocking (via the use of the fcntl(2) F_SETFL operation to set the O_NONBLOCK flag).
    • A read(2) fails with the error EINVAL if the size of the supplied buffer is less than 8 bytes.
    • If the associated clock is either CLOCK_REALTIME or CLOCK_REALTIME_ALARM, the timer is absolute (TFD_TIMER_ABSTIME), and the flag TFD_TIMER_CANCEL_ON_SET was specified when calling timerfd_settime(), then read(2) fails with the error ECANCELED if the real-time clock undergoes a discontinuous change. (this is how the reading application gets to discover such discontinuous changes to the clock ๐Ÿ‘€)
    • If the associated clock is either CLOCK_REALTIME or CLOCK_REALTIME_ALARM, the timer is absolute (TFD_TIMER_ABSTIME), and the flag TFD_TIMER_CANCEL_ON_SET was not specified when calling timerfd_settime(), then a discontinuous negative change to the clock (e.g., clock_settime(2)) may cause read(2) to unblock, but return a value of 0 (i.e., no bytes read), if the clock change occurs after the time expired, but before the read(2) on the file descriptor. sneaky little edge case, noted fr fr.
  • poll(2), select(2) (and similar) โ€” the file descriptor is readable (the select(2) readfds argument; the poll(2) POLLIN flag) if one or more timer expirations have occurred. the file descriptor also supports the other file-descriptor multiplexing APIs: pselect(2), ppoll(2), and epoll(7). so many options ๐Ÿ˜Œ
  • ioctl(2) โ€” the following timerfd-specific command is supported:
    • TFD_IOC_SET_TICKS (since Linux 3.17) โ€” adjust the number of timer expirations that have occurred. the argument is a pointer to a nonzero 8-byte integer (uint64_t*) containing the new number of expirations. once the number is set, any waiter on the timer is woken up. the only purpose of this command is to restore the expirations for the purpose of checkpoint/restore. this operation is available only if the kernel was configured with the CONFIG_CHECKPOINT_RESTORE option.
  • close(2) โ€” when the file descriptor is no longer required it should be closed. when all file descriptors associated with the same timer object have been closed, the timer is disarmed and its resources are freed by the kernel. bye bestie ๐Ÿซถ

๐Ÿ‘‘ fork(2) semantics ๐Ÿ‘‘

After a fork(2), the child inherits a copy of the file descriptor created by timerfd_create(). That file descriptor refers to the same underlying timer object as the corresponding file descriptor in the parent, and read(2)s in the child will return information about expirations of the timer. shared custody, but for timers ๐Ÿ’–

โญ execve(2) semantics โญ

A file descriptor created by timerfd_create() is preserved across execve(2), and continues to generate timer expirations if the timer was armed. it survived the exec, queen ๐Ÿ’…


๐Ÿ’€ RETURN VALUE ๐Ÿ’€

On success, timerfd_create() returns a new file descriptor. On error, -1 is returned and errno is set to indicate the error.

timerfd_settime() and timerfd_gettime() return 0 on success; on error they return -1, and set errno to indicate the error.


to be continued bestie โ€” part 2 is on its way, do not go anywhere ๐ŸŒธ

๐Ÿ’€ ERRORS ๐Ÿ’€

okay bestie so things can go wrong, and here's exactly how they go wrong. no surprises, we list them all:

timerfd_create() can be a lil dramatic and fail with these:

  • EINVAL โ€” the clockid you passed? not valid. not a vibe.
  • EINVAL โ€” flags is invalid; OR, on Linux 2.6.26 or earlier, flags was nonzero. (yes, on ancient kernels you literally couldn't pass flags at all ๐Ÿ˜ญ)
  • EMFILE โ€” you hit the per-process limit on open file descriptors. too many fds open, queen, close some ๐Ÿ’…
  • ENFILE โ€” the system-wide limit on the total number of open files has been reached. it's not you, it's the whole system.
  • ENODEV โ€” couldn't mount the (internal) anonymous inode device.
  • ENOMEM โ€” the kernel did not have enough memory to create the timer. she's broke ๐Ÿ’€
  • EPERM โ€” clockid was CLOCK_REALTIME_ALARM or CLOCK_BOOTTIME_ALARM but the caller didn't have the CAP_WAKE_ALARM capability. you need the โœจpermissionโœจ for alarm clocks.

timerfd_settime() and timerfd_gettime() can also fail with:

  • EBADF โ€” fd is not a valid file descriptor.
  • EFAULT โ€” new_value, old_value, or curr_value is not a valid pointer.
  • EINVAL โ€” fd is not a valid timerfd file descriptor (like, right type of fd, wrong flavor).

and timerfd_settime() alone can ALSO fail with:

  • ECANCELED โ€” see NOTES, bestie, there's a whole story ๐ŸŒธ
  • EINVAL โ€” new_value is not properly initialized (one of the tv_nsec falls outside the range zero to 999,999,999). nanoseconds have BOUNDARIES.
  • EINVAL โ€” flags is invalid.

๐Ÿ“œ STANDARDS ๐Ÿ“œ

Linux. that's it, that's the standard ๐Ÿซถ


๐Ÿ•ฐ๏ธ HISTORY ๐Ÿ•ฐ๏ธ

Linux 2.6.25, glibc 2.8. vintage, but still serving looks โœจ


๐Ÿ“ NOTES ๐Ÿ“

okay so picture this scenario, it's giving chaos, for a CLOCK_REALTIME or CLOCK_REALTIME_ALARM timer that was created with timerfd_create():

  1. The timer has been started (timerfd_settime()) with the TFD_TIMER_ABSTIME and TFD_TIMER_CANCEL_ON_SET flags;
  2. A discontinuous change (e.g., settimeofday(2)) is subsequently made to the CLOCK_REALTIME clock; and
  3. the caller once more calls timerfd_settime() to rearm the timer (without first doing a read(2) on the file descriptor).

so in this case, here's what goes down:

  • The timerfd_settime() returns -1 with errno set to ECANCELED. (This enables the caller to know that the previous timer was affected by a discontinuous change to the clock.) so like, a heads up, bestie ๐Ÿ“ฃ
  • The timer is successfully rearmed with the settings provided in the second timerfd_settime() call. (This was probably an implementation accident, but won't be fixed now, in case there are applications that depend on this behavior.) so it's a happy little accident we're all contractually obligated to keep, no cap ๐Ÿค

๐Ÿ› BUGS ๐Ÿ›

Currently, timerfd_create() supports fewer types of clock IDs than timer_create(2). that's the whole bug report, she's just not as versatile as her cousin ๐Ÿ’…


โœจ EXAMPLES โœจ

The following program creates a timer and then monitors its progress. The program accepts up to three command-line arguments. The first argument specifies the number of seconds for the initial expiration of the timer. The second argument specifies the interval for the timer, in seconds. The third argument specifies the number of times the program should allow the timer to expire before terminating. The second and third command-line arguments are optional.

so first arg is mandatory (the initial boom ๐Ÿ’ฅ), args two and three are optional besties you can skip.

The following shell session demonstrates the use of the program:

$ a.out 3 1 100
0.000:    timer started
3.000:    read: 1; total=1
4.000:    read: 1; total=2
^Z                  # type control-Z to suspend the program
[1]+  Stopped                 ./timerfd3_demo 3 1 100
$ fg                # Resume execution after a few seconds
a.out 3 1 100
9.660:    read: 5; total=7
10.000:   read: 1; total=8
11.000:   read: 1; total=9
^C                  # type control-C to suspend the program

look at that โœจ the cute lil elapsed timestamps, the ^Z to suspend with Ctrl+Z, the fg to bring her back after a few seconds, the ^C at the end with Ctrl+C. it's giving a whole journey ๐Ÿฆ‹

๐Ÿ“‚ Program source ๐Ÿ“‚

here's the actual source, verbatim, no edits, don't @ me:

#include <err.h>
#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/timerfd.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>

static void
print_elapsed_time(void)
{
    int                     secs, nsecs;
    static int              first_call = 1;
    struct timespec         curr;
    static struct timespec  start;

    if (first_call) {
        first_call = 0;
        if (clock_gettime(CLOCK_MONOTONIC, &start) == -1)
            err(EXIT_FAILURE, "clock_gettime");
    }

    if (clock_gettime(CLOCK_MONOTONIC, &curr) == -1)
        err(EXIT_FAILURE, "clock_gettime");

    secs = curr.tv_sec - start.tv_sec;
    nsecs = curr.tv_nsec - start.tv_nsec;
    if (nsecs < 0) {
        secs--;
        nsecs += 1000000000;
    }
    printf("%d.%03d:\t", secs, (nsecs + 500000) / 1000000);
}

int
main(int argc, char *argv[])
{
    int                fd;
    ssize_t            s;
    uint64_t           expir, tot_expir, max_expir;
    struct timespec    now;
    struct itimerspec  new_value;

    if (argc != 2 && argc != 4) {
        fprintf(stderr, "%s init-secs [interval-secs max-num-expir]\n",
                argv[0]);
        exit(EXIT_FAILURE);
    }

    if (clock_gettime(CLOCK_REALTIME, &now) == -1)
        err(EXIT_FAILURE, "clock_gettime");

    /* Create a CLOCK_REALTIME absolute timer with initial
       expiration and interval as specified in command line.  */

    new_value.it_value.tv_sec = now.tv_sec + atoi(argv[1]);
    new_value.it_value.tv_nsec = now.tv_nsec;
    if (argc == 2) {
        new_value.it_interval.tv_sec = 0;
        max_expir = 1;
    } else {
        new_value.it_interval.tv_sec = atoi(argv[2]);
        max_expir = atoi(argv[3]);
    }
    new_value.it_interval.tv_nsec = 0;

    fd = timerfd_create(CLOCK_REALTIME, 0);
    if (fd == -1)
        err(EXIT_FAILURE, "timerfd_create");

    if (timerfd_settime(fd, TFD_TIMER_ABSTIME, &new_value, NULL) == -1)
        err(EXIT_FAILURE, "timerfd_settime");

    print_elapsed_time();
    printf("timer started\n");

    for (tot_expir = 0; tot_expir < max_expir;) {
        s = read(fd, &expir, sizeof(uint64_t));
        if (s != sizeof(uint64_t))
            err(EXIT_FAILURE, "read");

        tot_expir += expir;
        print_elapsed_time();
        printf("read: %w64u; total=%w64u\n", expir, tot_expir);
    }

    exit(EXIT_SUCCESS);
}

note the static int first_call = 1; doing the "only record start ONCE" trick, the if (nsecs < 0) borrow handling, and that argc != 2 && argc != 4 check up top โ€” so it's either one arg or three, no in-between bestie ๐ŸŽ€


๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

eventfd(2), poll(2), read(2), select(2), setitimer(2), signalfd(2), timer_create(2), timer_gettime(2), timer_settime(2), timespec(3), epoll(7), time(7)


and that's the whole page babes ๐Ÿ’– this one came out of Linux man-pages 6.20, dated 2026-02-16, and it's filed under timerfd_create(2). go forth, set timers, read from fds, slay ๐Ÿ‘‘โœจ

๐Ÿ“ฆ where this page comes from
  • arch rolling: man-pages 6.20-1 ยท BSD-2-Clause AND BSD-3-Clause AND BSD-4.3TAHOE AND BSD-4-Clause-UC AND GPL-1.0-or-later AND GPL-2.0-only AND GPL-2.0-or-later AND GPL-3.0-or-later AND LGPL-3.0-linking-exception AND LGPL-3.0-or-later AND LicenseRef-Public-Domain AND LicenseRef-UltraPermissive AND Linux-man-pages-1-para AND Linux-man-pages-copyleft AND Linux-man-pages-copyleft-2-para AND Linux-man-pages-copyleft-var AND MIT AND Spencer-94
  • nixpkgs unstable: man-pages 6.20
  • ๐Ÿ“œ the page's license: GPL-2.0-or-later
  • ๐Ÿ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms