xref: /illumos-gate/usr/src/uts/common/sys/cyclic.h (revision d0a94a58)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  *
25  * Copyright 2017 RackTop Systems.
26  * Copyright 2018 Joyent, Inc.
27  */
28 
29 #ifndef _SYS_CYCLIC_H
30 #define	_SYS_CYCLIC_H
31 
32 #ifdef	__cplusplus
33 extern "C" {
34 #endif
35 
36 #ifndef _ASM
37 #include <sys/time.h>
38 #include <sys/cpuvar.h>
39 #include <sys/cpupart.h>
40 #endif /* !_ASM */
41 
42 #define	CY_LOW_LEVEL		0
43 #define	CY_LOCK_LEVEL		1
44 #define	CY_HIGH_LEVEL		2
45 #define	CY_SOFT_LEVELS		2
46 #define	CY_LEVELS		3
47 
48 #ifndef _ASM
49 
50 typedef uintptr_t cyclic_id_t;
51 typedef int cyc_index_t;
52 typedef int cyc_cookie_t;
53 typedef uint16_t cyc_level_t;
54 typedef void (*cyc_func_t)(void *);
55 typedef void *cyb_arg_t;
56 
57 #define	CYCLIC_NONE		((cyclic_id_t)0)
58 
59 typedef struct cyc_handler {
60 	cyc_func_t cyh_func;
61 	void *cyh_arg;
62 	cyc_level_t cyh_level;
63 } cyc_handler_t;
64 
65 typedef struct cyc_time {
66 	hrtime_t cyt_when;
67 	hrtime_t cyt_interval;
68 } cyc_time_t;
69 
70 typedef struct cyc_omni_handler {
71 	void (*cyo_online)(void *, cpu_t *, cyc_handler_t *, cyc_time_t *);
72 	void (*cyo_offline)(void *, cpu_t *, void *);
73 	void *cyo_arg;
74 } cyc_omni_handler_t;
75 
76 #define	CY_INFINITY	INT64_MAX
77 
78 #if defined(_KERNEL) || defined(_FAKE_KERNEL)
79 
80 extern cyclic_id_t cyclic_add(cyc_handler_t *, cyc_time_t *);
81 extern cyclic_id_t cyclic_add_omni(cyc_omni_handler_t *);
82 extern void cyclic_remove(cyclic_id_t);
83 extern void cyclic_bind(cyclic_id_t, cpu_t *, cpupart_t *);
84 extern int cyclic_reprogram(cyclic_id_t, hrtime_t);
85 extern void cyclic_move_here(cyclic_id_t);
86 extern hrtime_t cyclic_getres();
87 
88 extern int cyclic_offline(cpu_t *cpu);
89 extern void cyclic_online(cpu_t *cpu);
90 extern int cyclic_juggle(cpu_t *cpu);
91 extern void cyclic_move_in(cpu_t *);
92 extern int cyclic_move_out(cpu_t *);
93 extern void cyclic_suspend();
94 extern void cyclic_resume();
95 
96 extern void cyclic_fire(cpu_t *cpu);
97 extern void cyclic_softint(cpu_t *cpu, cyc_level_t level);
98 
99 #endif /* _KERNEL || _FAKE_KERNEL */
100 
101 #endif /* !_ASM */
102 
103 #ifdef	__cplusplus
104 }
105 #endif
106 
107 #endif /* _SYS_CYCLIC_H */
108