xref: /freebsd/sys/sys/vdso.h (revision a0ee8cc6)
1 /*-
2  * Copyright 2012 Konstantin Belousov <kib@FreeBSD.ORG>.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #ifndef _SYS_VDSO_H
29 #define	_SYS_VDSO_H
30 
31 #include <sys/types.h>
32 #include <machine/vdso.h>
33 
34 struct vdso_timehands {
35 	uint32_t	th_algo;
36 	uint32_t	th_gen;
37 	uint64_t	th_scale;
38 	uint32_t 	th_offset_count;
39 	uint32_t	th_counter_mask;
40 	struct bintime	th_offset;
41 	struct bintime	th_boottime;
42 	VDSO_TIMEHANDS_MD
43 };
44 
45 struct vdso_timekeep {
46 	uint32_t	tk_ver;
47 	uint32_t	tk_enabled;
48 	uint32_t	tk_current;
49 	struct vdso_timehands	tk_th[];
50 };
51 
52 #define	VDSO_TK_CURRENT_BUSY	0xffffffff
53 #define	VDSO_TK_VER_1		0x1
54 #define	VDSO_TK_VER_CURR	VDSO_TK_VER_1
55 #define	VDSO_TH_ALGO_1		0x1
56 
57 #ifndef _KERNEL
58 
59 struct timespec;
60 struct timeval;
61 struct timezone;
62 
63 int __vdso_clock_gettime(clockid_t clock_id, struct timespec *ts);
64 int __vdso_gettimeofday(struct timeval *tv, struct timezone *tz);
65 u_int __vdso_gettc(const struct vdso_timehands *vdso_th);
66 int __vdso_gettimekeep(struct vdso_timekeep **tk);
67 
68 #endif
69 
70 #ifdef _KERNEL
71 
72 struct timecounter;
73 
74 struct vdso_sv_tk {
75 	int		sv_timekeep_off;
76 	int		sv_timekeep_curr;
77 	uint32_t	sv_timekeep_gen;
78 };
79 
80 void timekeep_push_vdso(void);
81 
82 uint32_t tc_fill_vdso_timehands(struct vdso_timehands *vdso_th);
83 
84 /*
85  * The cpu_fill_vdso_timehands() function should fill MD-part of the
86  * struct vdso_timehands, which is both machine- and
87  * timecounter-depended. The return value should be 1 if fast
88  * userspace timecounter is enabled by hardware, and 0 otherwise. The
89  * global sysctl enable override is handled by machine-independed code
90  * after cpu_fill_vdso_timehands() call is made.
91  */
92 uint32_t cpu_fill_vdso_timehands(struct vdso_timehands *vdso_th,
93     struct timecounter *tc);
94 
95 struct vdso_sv_tk *alloc_sv_tk(void);
96 
97 #define	VDSO_TH_NUM	4
98 
99 #ifdef COMPAT_FREEBSD32
100 struct bintime32 {
101 	uint32_t	sec;
102 	uint32_t	frac[2];
103 };
104 
105 struct vdso_timehands32 {
106 	uint32_t	th_algo;
107 	uint32_t	th_gen;
108 	uint32_t	th_scale[2];
109 	uint32_t 	th_offset_count;
110 	uint32_t	th_counter_mask;
111 	struct bintime32	th_offset;
112 	struct bintime32	th_boottime;
113 	VDSO_TIMEHANDS_MD32
114 };
115 
116 struct vdso_timekeep32 {
117 	uint32_t	tk_ver;
118 	uint32_t	tk_enabled;
119 	uint32_t	tk_current;
120 	struct vdso_timehands32	tk_th[];
121 };
122 
123 uint32_t tc_fill_vdso_timehands32(struct vdso_timehands32 *vdso_th32);
124 uint32_t cpu_fill_vdso_timehands32(struct vdso_timehands32 *vdso_th32,
125     struct timecounter *tc);
126 struct vdso_sv_tk *alloc_sv_tk_compat32(void);
127 
128 #endif
129 #endif
130 
131 #endif
132