xref: /freebsd/sys/sys/timerfd.h (revision 5f757f3f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2023 Jake Freeland <jfree@FreeBSD.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _SYS_TIMERFD_H_
29 #define _SYS_TIMERFD_H_
30 
31 #include <sys/types.h>
32 #include <sys/fcntl.h>
33 /*
34  * We only need <sys/timespec.h>, but glibc pollutes the namespace
35  * with <time.h>. This pollution is expected by most programs, so
36  * reproduce it by including <sys/time.h> here.
37  */
38 #include <sys/time.h>
39 
40 typedef	uint64_t	timerfd_t;
41 
42 /* Creation flags. */
43 #define TFD_NONBLOCK	O_NONBLOCK
44 #define TFD_CLOEXEC	O_CLOEXEC
45 
46 /* Timer flags. */
47 #define	TFD_TIMER_ABSTIME	0x01
48 #define	TFD_TIMER_CANCEL_ON_SET	0x02
49 
50 #ifndef _KERNEL
51 
52 __BEGIN_DECLS
53 int timerfd_create(int clockid, int flags);
54 int timerfd_gettime(int fd, struct itimerspec *curr_value);
55 int timerfd_settime(int fd, int flags, const struct itimerspec *new_value,
56     struct itimerspec *old_value);
57 __END_DECLS
58 
59 #else /* _KERNEL */
60 
61 void timerfd_jumped(void);
62 
63 #endif /* !_KERNEL */
64 
65 #endif /* !_SYS_TIMERFD_H_ */
66