xref: /freebsd/sys/sys/rtprio.h (revision 95ee2897)
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/priority.h>
38 
39 /*
40  * Process realtime-priority specifications to rtprio.
41  */
42 
43 /* priority types.  Start at 1 to catch uninitialized fields. */
44 
45 #define RTP_PRIO_ITHD		PRI_ITHD	/* Interrupt thread. */
46 #define RTP_PRIO_REALTIME	PRI_REALTIME	/* real time process */
47 #define RTP_PRIO_NORMAL		PRI_TIMESHARE	/* time sharing process */
48 #define RTP_PRIO_IDLE		PRI_IDLE	/* idle process */
49 
50 /* RTP_PRIO_FIFO is POSIX.1B SCHED_FIFO.
51  */
52 
53 #define RTP_PRIO_FIFO_BIT	PRI_FIFO_BIT
54 #define RTP_PRIO_FIFO		PRI_FIFO
55 #define RTP_PRIO_BASE(P)	PRI_BASE(P)
56 #define RTP_PRIO_IS_REALTIME(P) PRI_IS_REALTIME(P)
57 #define RTP_PRIO_NEED_RR(P)	PRI_NEED_RR(P)
58 
59 /* priority range */
60 #define RTP_PRIO_MIN		0	/* Highest priority */
61 #define RTP_PRIO_MAX		31	/* Lowest priority */
62 
63 /*
64  * rtprio() syscall functions
65  */
66 #define RTP_LOOKUP		0
67 #define RTP_SET			1
68 
69 #ifndef LOCORE
70 /*
71  * Scheduling class information.
72  */
73 struct rtprio {
74 	u_short type;			/* scheduling class */
75 	u_short prio;
76 };
77 
78 #ifdef _KERNEL
79 struct thread;
80 int	rtp_to_pri(struct rtprio *, struct thread *);
81 void	pri_to_rtp(struct thread *, struct rtprio *);
82 #endif
83 #endif
84 
85 #ifndef _KERNEL
86 #include <sys/cdefs.h>
87 
88 __BEGIN_DECLS
89 int	rtprio(int, pid_t, struct rtprio *);
90 int	rtprio_thread(int, lwpid_t, struct rtprio *);
91 __END_DECLS
92 #endif	/* !_KERNEL */
93 #endif	/* !_SYS_RTPRIO_H_ */
94