Manpages

NOM

timerfd_create, timerfd_settime, timerfd_gettime - Minuteries qui informent par l’intermédiaire de descripteurs de fichier

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 *old_value);

int timerfd_gettime(int fd, struct itimerspec *curr_value);

DESCRIPTION

Ces appels système créent et opèrent sur une minuterie qui fournit des notifications d’expiration par un descripteur de fichier. Ils fournissent une alternative à setitimer(2) ou timer_create(2) avec l’avantage que le descripteur de fichier peut être surveillé avec select(2), poll(2) ou epoll(7).

L’utilisation de ces trois appels système est analogue à l’utilisation de timer_create(2), timer_settime(2) et timer_gettime(2). (Il n’y a pas d’équivalent à timer_getoverrun(2) puisque cette fonctionnalité est fournie par read(2), comme décrit ci-dessous)

timerfd_create()
timerfd_create() creates a new timer object, and returns a file descriptor that refers to that timer. The clockid argument specifies the clock that is used to mark the progress of the timer, and must be one of the following:
CLOCK_REALTIME

Une horloge temps réel configurable à l’échelle du système.

CLOCK_MONOTONIC

Une horloge non configurable, toujours croissante qui mesure le temps depuis un instant non spécifié dans le passé et qui ne change pas après le démarrage du système.

CLOCK_BOOTTIME (Since Linux 3.15)

Like CLOCK_MONOTONIC, this is a monotonically increasing clock. However, whereas the CLOCK_MONOTONIC clock does not measure the time while a system is suspended, the CLOCK_BOOTTIME clock does include the time during which the system is suspended. This is useful for applications that need to be suspend-aware. CLOCK_REALTIME is not suitable for such applications, since that clock is affected by discontinuous changes to the system clock.

CLOCK_REALTIME_ALARM (since Linux 3.11)

This clock is like CLOCK_REALTIME, but will wake the system if it is 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)

This clock is like CLOCK_BOOTTIME, but will wake the system if it is suspended. The caller must have the CAP_WAKE_ALARM capability in order to set a timer against this clock.

The current value of each of these clocks can be retrieved using clock_gettime(2).

À partir de Linux 2.6.27, les valeurs suivantes peuvent être incluses avec un OU binaire dans flags pour changer le comportement de timerfd_create() :

Dans les versions de Linux jusqu’à la version 2.6.26 incluse, flags doit être nul.

timerfd_settime()
timerfd_settime() arme (démarre) ou désarme (stoppe) la minuterie à laquelle se réfère le descripteur de fichier fd.

The new_value argument specifies the initial expiration and interval for the timer. The itimerspec structure used for this argument contains two fields, each of which is in turn a structure of type timespec:

struct timespec {
 time_t tv_sec; /* Secondes */
 long tv_nsec; /* Nanosecondes */
};
struct itimerspec {
 struct timespec it_interval; /* Intervalle pour les
 minuteries périodiques */
 struct timespec it_value; /* Expiration initiale */
};

new_value.it_value spécifie l’expiration initiale de la minuterie, en secondes et nanosecondes. Une valeur non nulle dans un des champs de new_value.it_value arme la minuterie. La minuterie est désarmée si les deux champs de new_value.it_value sont mis à zéro.

Une valeur non nulle dans un des champs de new_value.it_interval configure la période, en secondes et nanosecondes, pour une expiration répétitive après l’expiration initiale. Si les deux champs de new_value.it_interval sont nuls, la minuterie expirera qu’une seule fois, dont l’heure est spécifiée dans 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.

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.

Si le paramètre old_value n’est pas égal à NULL. la structure itimerspec vers laquelle il pointe est utilisée pour renvoyer la configuration de la minuterie au moment de l’appel ; consultez la description de timerfd_gettime() ci-dessous.

timerfd_gettime()
timerfd_gettime() renvoie, dans curr_value, une structure itimerspec qui contient les paramètres actuels de la minuterie auquel le descripteur de fichier fd fait référence.

Le champ it_value renvoie la durée jusqu’à la prochaine expiration. Si les deux champs de cette structure sont nuls, alors la minuterie est actuellement désactivée. Ce champ contient toujours une valeur relative, sans tenir compte d’un attribut TFD_TIMER_ABSTIME qui aurait été spécifié quand la minuterie a été configurée.

Le champ it_interval renvoie la période de la minuterie. Si les deux champs de cette structure sont nuls, alors la minuteries est configurée pour n’expirer qu’une seule fois, à l’heure spécifiée par curr_value.it_value.

Opérations sur un descripteur de fichier de minuterie
Le descripteur de fichier renvoyé par timerfd_create() gère les opérations suivante :
read(2)

Si la minuterie a déjà expirée une fois ou plus depuis que sa configuration a été modifiée la dernière fois à l’aide de timerfd_settime() ou depuis la dernière lecture avec read(2) qui a réussi, alors le tampon fourni à read(2) renvoie un entier non signé sur 8 octets (uint64_t) qui contient le nombre d’expirations qui se sont produites. (La valeur renvoyée utilise l’ordre des octets de l’hôte, c’est-à-dire l’ordre des octets natif pour les entiers sur la machine hôte)

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

#include <sys/timerfd.h>
#include <time.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h> /* Définition de uint64_t */
#define handle_error(msg) \
 do { perror(msg); exit(EXIT_FAILURE); } while (0)
static void
print_elapsed_time(void)
{
 static struct timespec start;
 struct timespec curr;
 static int first_call = 1;
 int secs, nsecs;
 if (first_call) {
 first_call = 0;
 if (clock_gettime(CLOCK_MONOTONIC, &start) == -1)
 handle_error("clock_gettime");
 }
 if (clock_gettime(CLOCK_MONOTONIC, &curr) == -1)
 handle_error("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: ", secs, (nsecs + 500000) / 1000000);
}
int
main(int argc, char *argv[])
{
 struct itimerspec new_value;
 int max_exp, fd;
 struct timespec now;
 uint64_t exp, tot_exp;
 ssize_t s;
 if ((argc != 2) && (argc != 4)) {
 fprintf(stderr, "%s init-secs [interval-secs max-exp]\n",
 argv[0]);
 exit(EXIT_FAILURE);
 }
 if (clock_gettime(CLOCK_REALTIME, &now) == -1)
 handle_error("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_exp = 1;
 } else {
 new_value.it_interval.tv_sec = atoi(argv[2]);
 max_exp = atoi(argv[3]);
 }
 new_value.it_interval.tv_nsec = 0;
 fd = timerfd_create(CLOCK_REALTIME, 0);
 if (fd == -1)
 handle_error("timerfd_create");
 if (timerfd_settime(fd, TFD_TIMER_ABSTIME, &new_value, NULL) == -1)
 handle_error("timerfd_settime");
 print_elapsed_time();
 printf("timer started\n");
 for (tot_exp = 0; tot_exp < max_exp;) {
 s = read(fd, &exp, sizeof(uint64_t));
 if (s != sizeof(uint64_t))
 handle_error("read");
 tot_exp += exp;
 print_elapsed_time();
 printf("read: %llu; total=%llu\n",
 (unsigned long long) exp,
 (unsigned long long) tot_exp);
 }
 exit(EXIT_SUCCESS);
}