workflow poller 理解

workflow poller 理解

char data[0] 柔性数组

struct __poller_message
{
	int (*append)(const void *, size_t *, poller_message_t *);
	char data[0];
};

char data[0]从语法逻辑上来看是完全没有意义的，但在结构体中却能完成变长度的作用，即结构体的长度是不定的，可以用来构造 缓冲区、数据包等等。对于编译器而言，长度为0的数组不占用空间，数组名本身不占用空间，只是一个偏移量。通过poll_message-> data可以定位到数据的开始。

#include <iostream>


struct buffer
{
    int32_t length;
    char data[0];
};

int main()
{
    buffer my_buffer = {
        .length = 10
    };
    
    // 输出地址
    std::cout << std::hex;
    std::cout << "&my_buffer.length : " << &my_buffer.length << std::endl;
    std::cout << "&my_buffer.data   : " << &my_buffer.data << std::endl;

    return 0;
}

&my_buffer.length : 0x7fffc83ade84
&my_buffer.data   : 0x7fffc83ade88

union

union 是一个用户定义类型，其中所有成员都共享同一个内存位置。 此定义意味着在任何给定时间，union 都不能包含来自其成员列表 的多个对象。 这还意味着，无论 union 具有多少成员，它始终仅使用足以存储最大成员的内存。

timerfd

名称(NAME)

timerfd_create, timerfd_setting, timerfd_gettime - 使用文件描述符来通知的定时器

概要(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)

这些系统调用通过文件描述符来传递定时器失效通知。这些可作为settimer(2)和timer_create(2)的替代，同时文件描述符可以被 select(2)，poll(2), epoll(2)监视。

这些系统调用和timer_create(2), timer_settime(2), timer_gettime(2)是相似的。(并不和timer_getoverrun(2)相似)

timerfd_create()

timerfd_create()创建一个全新的定时器实例并将和该定时器相关联的文件描述符作为返回值。clockid参数表示该程序使用的时钟 并且必须是下列值之一:

CLOCK_REALTIME: 一个可设定的系统级实时时钟。

CLOCK_MONOTONIC: 一个不可设置的单调递增时钟，用于测量过去某个未指定点的时间，该时间点在系统启动后不会改变。

CLOCK_BOOTTIME(Linux 3.15以后): 和CLOCK_MONOTONIC类似是一个单调递增时钟。CLOCK_MONOTONIC不能在系统挂起的时候使用， CLOCK_BOOTTIME却可以在系统挂起时使用。这在应用需要挂起唤醒时候是有用的。CLOCK_REALTIME在系统时钟是非实时计数是不可 用的。

CLOCK_REALTIME_ALARM(Linux 3.11以后): 类似于CLOCK_REALTIME，但是当它挂起时会通知系统，调用系统必须有CAP_WAKE_ALARM 能力去设置对应的定时器。

CLOCK_BOOTTIME_ALARM(Linux 3.11以后): 类似于CLOCK_BOOTTIME，但是当它挂起时会通知系统，调用系统必须有CAP_WAKE_ALARM 能力去设置对应的定时器。

可以查看clock_getres(2)去获得更多关于时钟的细节。

每个时钟的当前值都可以通过使用clock_gettime(2)去检索。

从Linux2.6.27版本开始，timerfd_create中用以改变行为的参数flags是位宽的下述值。

TFD_NONBLOCK 在新打开的文件描述符设置O_NONBLOCK文件描述标识，使用该标识将节省额外的fcntl(2)调用来达到相同结果。

TFD_CLOEXEC 在新的文件描述符设置close-on-exec(FD_CLOEXEC)文件描述标识，查询设置O_CLOEXEC标识的理由可以查看open(2 )。

Linux版本2.6.26以前(包括2.6.26)，flag必须被设置为0。

timerfd_settime()

timerfd_settime()通过文件描述符开始或停止定时器。

定时器中的new_value参数用来表示失效时间和间隔时间。itimer结构体包含使用timespec结构体两部分。

struct timespec {
    time_t  tv_sec;                 /* Seconds */
    long    tv_nsec;                /* Nanoseconds */
};

struct itimerspec {
    struct timespec it_interval;    /* Interval for periodic timer */
    struct timespec it_value;       /* Initial expiration */
};

new_value.it_value用秒和纳秒来表示定时器初始失效时间。new_value.it_value任意一部分不为0值开始定时器，两部分都为0值 停止定时器。

设置new_value.it_interval非0值用来表示自初始失效期后重复定时器的周期。如果该值为0，该定时器在new_value.it_value定时 的时间上仅失效一次。通常来讲，初始失效时间是和调用定时器时钟的当前时间相关联(即new_value.it_value表示的时间适合当前的 clockid的值相关联)。可以通过flags参数选择一个绝对超时时间。

flags是一个下述值的位掩码：

TFD_TIMER_ABSTIME 将new_value.it_value解释为一个在定时器上的绝对值。该定时器将在到达这个值设定的值上失效。

TFD_TIMER_CANCEL_ON_SET 如果该标识同时伴有TFD_TIMER_ABSTIME和时钟是CLOCK_REALTIME或者CLOCK_REALTIME_ALARM，标记 该定时器为可取消的如果实时时钟接口不连续的变化。当该变化产生，可用read(2)从文件描述符读出ECANCELED错误。

如果old_value参数非空，它itimerspec结构体返回之前定时器设置的失效值。后面timerfd_gettime()有描述。

timerfd_gettime()

timerfd_gettime()用curr_value参数返回和文件描述符fd相关的定时器设定的失效值。

it_value用来表示到下一次失效时的总时间。如果两项值都是0，则表明该定时器当前是停止的。这项永远包含一个相对时间，不论是 否TFD_TIMER_ABSTIME是否被设置。

it_interval项用来返回定时器的间隔。如果值为0，说明定时器仅在curr_value.it_value表示的时间上失效一次。

时间文件描述符上的操作

使用timerfd_create()返回的文件描述符支持下述操作：

read(2)

如果该定时器已经失效过一次或者多次自使用timerfd_settime()修改或者上次成功read(2)，那么read(2)返回的buffer返回8位 无符号整数表示发生失效的次数。

如果在使用read(2)没有定时器失效，将阻塞到下一个定时失效，或者返回错误EAGAIN当这些文件描述符被设置为非阻塞时。

如果提供的buffer小于8个字节，read(2)将返回EINVAL错误。

如果相关时钟是CLOCK_REALTIME或者CLOCK_REALTIME_ALARM，定时器是绝对的(TFD_TIMER_ABSTIME)并且标识是TFD_TIMER_CANCE L_ON_SET，read(2)将返回错误ECANCELED如果实时时钟接受不连续变化。如果标识不是TFD_TIMER_CANCEL_ON_SET，那么该始终 拒绝不连续变化(即clock_settime(2)可能导致read(2)非阻塞，返回0值，if the clock change occurs after the time expired, but before the read(2) on the file descriptor)。

poll(2), select(2)

当一个或多个该类型文件描述符发生失效时是可读的。该类型文件描述符也支持其他文件描述符的操作：pselect(2) ppoll(2) epoll(2)。

ioctl(2)

下述定时器指定命令是支持的：

TFD_TOC_SET_TICKS(从Linux3.17开始) 调整已经发生定时器失效次数。这个参数指向一个非零8字节整数包含新的失效次数。一旦这个数字被设 置，任何等待该定时器的将被唤醒。这个命令唯一的目的是还原过期以便完成还原点/还原的目的。这个操作应当内核被设置成CONFIG_CHECKPOINT_ RESTORE时才是生效的。

close(2)

当该文件描述符不再被需要的时候应当关闭。当定时器关联的所有文件描述符都已经关闭时，定时器会被停止并将资源还给内核。

fork(2)

在fork(2)后，子进程将拷贝timerfd_create()创建的文件描述符。该文件描述符和父进程指向相同的定时器，且子进程中read(2)将返回定 时器的失效信息。

execve(2)

由timerfd_create()产生的文件描述符将被保留在execve(2)，并且当定时器启动时将继续尝试失效。

返回值(RETURN VALUE)

成功的情况下将返回一个新的文件描述符，错误的情况下将返回-1并在erron中表明错误。

timerfd_settime()和timerfd_gettime()成功的情况下返回0，错误的情况下返回-1并在errno中表明错误。

错误(ERRORS)

timerfd_create()错误有以下情况：

EINVAL clockid参数既不是CLOCK_MONOTONIC也不是CLOCK_REALTIME；

EINVAL flags参数非法或者在早于Linux2.6.26版本前该参数非0；

EMFILE 到达预先设置的文件描述符数量上限；

ENFILE 到达系统设置的文件描述符数量上限；

ENODEV 不能挂载到匿名索引节点设备；

ENOMEM 没有合适的内核内存来创造定时器。

timerfd_settime()和timerfd_gettime()错误有以下情况：

EBADF fd是非法的文件描述符；

EFAULT new_value old_value或者curr_value非法指向；

EINVAL fd是非法定时器文件描述符；

timerfd_settime()也可以引发下列错误：

EINVAL new_value没有正确设置;

EINVAL flags非法。

版本(VERSION)

这些系统调用自Linux核心2.6.25。glibc支持自2.8。

问题(BUGS)

当前timerfd_create()支持的时钟种类少于timerfd_create(2)。

例子(EXAMPLE)

下面程序创建一个定事情并监视自身。该程序接受最多三个命令行参数。第一个参数表示初始失效的秒数。第二个参数表示间隔的秒数。第三个参数 表示程序允许定时器在停止前的失效次数。第二个和第三个参数是可选的。

下面是shell中调用程序的信息：

$ 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

源码

#include <sys/timerfd.h>
#include <time.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>        /* Definition of 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);
}