xref: /freebsd/sys/sys/rtprio.h (revision 3daa43b1bb2cf68f32993e342f59eb146afb7c24)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 1994, Henrik Vestergaard Draboel
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Henrik Vestergaard Draboel.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #ifndef _SYS_RTPRIO_H_
35 #define _SYS_RTPRIO_H_
36 
37 #include <sys/_types.h>
38 #include <sys/priority.h>
39 
40 /*
41  * Process realtime-priority specifications to rtprio.
42  */
43 
44 /* priority types.  Start at 1 to catch uninitialized fields. */
45 
46 #define RTP_PRIO_ITHD		PRI_ITHD	/* Interrupt thread. */
47 #define RTP_PRIO_REALTIME	PRI_REALTIME	/* real time process */
48 #define RTP_PRIO_NORMAL		PRI_TIMESHARE	/* time sharing process */
49 #define RTP_PRIO_IDLE		PRI_IDLE	/* idle process */
50 
51 /* RTP_PRIO_FIFO is POSIX.1B SCHED_FIFO.
52  */
53 
54 #define RTP_PRIO_FIFO_BIT	PRI_FIFO_BIT
55 #define RTP_PRIO_FIFO		PRI_FIFO
56 #define RTP_PRIO_BASE(P)	PRI_BASE(P)
57 #define RTP_PRIO_IS_REALTIME(P) PRI_IS_REALTIME(P)
58 #define RTP_PRIO_NEED_RR(P)	PRI_NEED_RR(P)
59 
60 /* priority range */
61 #define RTP_PRIO_MIN		0	/* Highest priority */
62 #define RTP_PRIO_MAX		31	/* Lowest priority */
63 
64 /*
65  * rtprio() syscall functions
66  */
67 #define RTP_LOOKUP		0
68 #define RTP_SET			1
69 
70 #ifndef LOCORE
71 /*
72  * Scheduling class information.
73  */
74 struct rtprio {
75 	unsigned short type;	/* scheduling class */
76 	unsigned short prio;
77 };
78 
79 #ifdef _KERNEL
80 struct thread;
81 int	rtp_to_pri(struct rtprio *, struct thread *);
82 void	pri_to_rtp(struct thread *, struct rtprio *);
83 #endif
84 #endif
85 
86 #ifndef _KERNEL
87 #include <sys/cdefs.h>
88 
89 __BEGIN_DECLS
90 int	rtprio(int, __pid_t, struct rtprio *);
91 int	rtprio_thread(int, __lwpid_t, struct rtprio *);
92 __END_DECLS
93 #endif	/* !_KERNEL */
94 #endif	/* !_SYS_RTPRIO_H_ */
95