xref: /freebsd/sys/sys/timerfd.h (revision 315ee00f)
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 #include <sys/proc.h>
34 #include <sys/timespec.h>
35 
36 typedef	uint64_t	timerfd_t;
37 
38 /* Creation flags. */
39 #define TFD_NONBLOCK	O_NONBLOCK
40 #define TFD_CLOEXEC	O_CLOEXEC
41 
42 /* Timer flags. */
43 #define	TFD_TIMER_ABSTIME	0x01
44 #define	TFD_TIMER_CANCEL_ON_SET	0x02
45 
46 #ifndef _KERNEL
47 
48 __BEGIN_DECLS
49 int timerfd_create(int clockid, int flags);
50 int timerfd_gettime(int fd, struct itimerspec *curr_value);
51 int timerfd_settime(int fd, int flags, const struct itimerspec *new_value,
52     struct itimerspec *old_value);
53 __END_DECLS
54 
55 #else /* _KERNEL */
56 
57 int kern_timerfd_create(struct thread *td, int clockid, int flags);
58 int kern_timerfd_gettime(struct thread *td, int fd,
59     struct itimerspec *curr_value);
60 int kern_timerfd_settime(struct thread *td, int fd, int flags,
61     const struct itimerspec *new_value, struct itimerspec *old_value);
62 void timerfd_jumped(void);
63 
64 #endif /* !_KERNEL */
65 
66 #endif /* !_SYS_TIMERFD_H_ */
67