master
1/* Definitions of constants and data structure for POSIX 1003.1b-1993
2 scheduling interface.
3 Copyright (C) 1996-2025 Free Software Foundation, Inc.
4 This file is part of the GNU C Library.
5
6 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
10
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; if not, see
18 <https://www.gnu.org/licenses/>. */
19
20#ifndef _BITS_SCHED_H
21#define _BITS_SCHED_H 1
22
23#ifndef _SCHED_H
24# error "Never include <bits/sched.h> directly; use <sched.h> instead."
25#endif
26
27/* Scheduling algorithms. */
28#define SCHED_OTHER 0
29#define SCHED_FIFO 1
30#define SCHED_RR 2
31#ifdef __USE_GNU
32# define SCHED_NORMAL 0
33# define SCHED_BATCH 3
34# define SCHED_ISO 4
35# define SCHED_IDLE 5
36# define SCHED_DEADLINE 6
37# define SCHED_EXT 7
38
39/* Flags that can be used in policy values. */
40# define SCHED_RESET_ON_FORK 0x40000000
41
42/* Flags for the sched_flags field in struct sched_attr. */
43#define SCHED_FLAG_RESET_ON_FORK 0x01
44#define SCHED_FLAG_RECLAIM 0x02
45#define SCHED_FLAG_DL_OVERRUN 0x04
46#define SCHED_FLAG_KEEP_POLICY 0x08
47#define SCHED_FLAG_KEEP_PARAMS 0x10
48#define SCHED_FLAG_UTIL_CLAMP_MIN 0x20
49#define SCHED_FLAG_UTIL_CLAMP_MAX 0x40
50
51/* Combinations of sched_flags fields. */
52#define SCHED_FLAG_KEEP_ALL \
53 (SCHED_FLAG_KEEP_POLICY | SCHED_FLAG_KEEP_PARAMS)
54#define SCHED_FLAG_UTIL_CLAMP \
55 (SCHED_FLAG_UTIL_CLAMP_MIN | SCHED_FLAG_UTIL_CLAMP_MAX)
56
57/* Use "" to work around incorrect macro expansion of the
58 __has_include argument (GCC PR 80005). */
59# ifdef __has_include
60# if __has_include ("linux/sched/types.h")
61/* Some older Linux versions defined sched_param in <linux/sched/types.h>. */
62# define sched_param __glibc_mask_sched_param
63# include <linux/sched/types.h>
64# undef sched_param
65# endif
66# endif
67# ifndef SCHED_ATTR_SIZE_VER0
68# include <linux/types.h>
69# define SCHED_ATTR_SIZE_VER0 48
70# define SCHED_ATTR_SIZE_VER1 56
71struct sched_attr
72{
73 __u32 size;
74 __u32 sched_policy;
75 __u64 sched_flags;
76 __s32 sched_nice;
77 __u32 sched_priority;
78 __u64 sched_runtime;
79 __u64 sched_deadline;
80 __u64 sched_period;
81 __u32 sched_util_min;
82 __u32 sched_util_max;
83 /* Additional fields may be added at the end. */
84};
85# endif /* !SCHED_ATTR_SIZE_VER0 */
86
87/* Cloning flags. */
88# define CSIGNAL 0x000000ff /* Signal mask to be sent at exit. */
89# define CLONE_VM 0x00000100 /* Set if VM shared between processes. */
90# define CLONE_FS 0x00000200 /* Set if fs info shared between processes. */
91# define CLONE_FILES 0x00000400 /* Set if open files shared between processes. */
92# define CLONE_SIGHAND 0x00000800 /* Set if signal handlers shared. */
93# define CLONE_PIDFD 0x00001000 /* Set if a pidfd should be placed
94 in parent. */
95# define CLONE_PTRACE 0x00002000 /* Set if tracing continues on the child. */
96# define CLONE_VFORK 0x00004000 /* Set if the parent wants the child to
97 wake it up on mm_release. */
98# define CLONE_PARENT 0x00008000 /* Set if we want to have the same
99 parent as the cloner. */
100# define CLONE_THREAD 0x00010000 /* Set to add to same thread group. */
101# define CLONE_NEWNS 0x00020000 /* Set to create new namespace. */
102# define CLONE_SYSVSEM 0x00040000 /* Set to shared SVID SEM_UNDO semantics. */
103# define CLONE_SETTLS 0x00080000 /* Set TLS info. */
104# define CLONE_PARENT_SETTID 0x00100000 /* Store TID in userlevel buffer
105 before MM copy. */
106# define CLONE_CHILD_CLEARTID 0x00200000 /* Register exit futex and memory
107 location to clear. */
108# define CLONE_DETACHED 0x00400000 /* Create clone detached. */
109# define CLONE_UNTRACED 0x00800000 /* Set if the tracing process can't
110 force CLONE_PTRACE on this clone. */
111# define CLONE_CHILD_SETTID 0x01000000 /* Store TID in userlevel buffer in
112 the child. */
113# define CLONE_NEWCGROUP 0x02000000 /* New cgroup namespace. */
114# define CLONE_NEWUTS 0x04000000 /* New utsname group. */
115# define CLONE_NEWIPC 0x08000000 /* New ipcs. */
116# define CLONE_NEWUSER 0x10000000 /* New user namespace. */
117# define CLONE_NEWPID 0x20000000 /* New pid namespace. */
118# define CLONE_NEWNET 0x40000000 /* New network namespace. */
119# define CLONE_IO 0x80000000 /* Clone I/O context. */
120
121/* cloning flags intersect with CSIGNAL so can be used only with unshare and
122 clone3 syscalls. */
123#define CLONE_NEWTIME 0x00000080 /* New time namespace */
124#endif
125
126#include <bits/types/struct_sched_param.h>
127
128__BEGIN_DECLS
129
130#ifdef __USE_GNU
131/* Clone current process. */
132extern int clone (int (*__fn) (void *__arg), void *__child_stack,
133 int __flags, void *__arg, ...) __THROW;
134
135/* Unshare the specified resources. */
136extern int unshare (int __flags) __THROW;
137
138/* Get index of currently used CPU. */
139extern int sched_getcpu (void) __THROW;
140
141/* Get currently used CPU and NUMA node. */
142extern int getcpu (unsigned int *, unsigned int *) __THROW;
143
144/* Switch process to namespace of type NSTYPE indicated by FD. */
145extern int setns (int __fd, int __nstype) __THROW;
146
147/* Apply the scheduling attributes from *ATTR to the process or thread TID. */
148int sched_setattr (pid_t tid, struct sched_attr *attr, unsigned int flags)
149 __THROW __nonnull ((2));
150
151/* Obtain the scheduling attributes of the process or thread TID and
152 store it in *ATTR. */
153int sched_getattr (pid_t tid, struct sched_attr *attr, unsigned int size,
154 unsigned int flags)
155 __THROW __nonnull ((2));
156
157#endif
158
159__END_DECLS
160
161#endif /* bits/sched.h */