sysdeps/unix/sysv/linux/bits/sched.h

   1 /* Definitions of constants and data structure for POSIX 1003.1b-1993
   2    scheduling interface.
   3    Copyright (C) 1996-1999,2001-2003,2005,2006,2007,2008,2009,2011,2012
   4    Free Software Foundation, Inc.
   5    This file is part of the GNU C Library.
   6
   7    The GNU C Library is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU Lesser General Public
   9    License as published by the Free Software Foundation; either
  10    version 2.1 of the License, or (at your option) any later version.
  11
  12    The GNU C Library is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    Lesser General Public License for more details.
  16
  17    You should have received a copy of the GNU Lesser General Public
  18    License along with the GNU C Library; if not, see
  19    <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef __need_schedparam
  22
  23 #ifndef _SCHED_H
  24 # error "Never include <bits/sched.h> directly; use <sched.h> instead."
  25 #endif
  26
  27
  28 /* Scheduling algorithms.  */
  29 #define SCHED_OTHER             0
  30 #define SCHED_FIFO              1
  31 #define SCHED_RR                2
  32 #ifdef __USE_GNU
  33 # define SCHED_BATCH            3
  34 # define SCHED_IDLE             5
  35
  36 # define SCHED_RESET_ON_FORK    0x40000000
  37 #endif
  38
  39 #ifdef __USE_GNU
  40 /* Cloning flags.  */
  41 # define CSIGNAL       0x000000ff /* Signal mask to be sent at exit.  */
  42 # define CLONE_VM      0x00000100 /* Set if VM shared between processes.  */
  43 # define CLONE_FS      0x00000200 /* Set if fs info shared between processes.  */
  44 # define CLONE_FILES   0x00000400 /* Set if open files shared between processes.  */
  45 # define CLONE_SIGHAND 0x00000800 /* Set if signal handlers shared.  */
  46 # define CLONE_PTRACE  0x00002000 /* Set if tracing continues on the child.  */
  47 # define CLONE_VFORK   0x00004000 /* Set if the parent wants the child to
  48                                      wake it up on mm_release.  */
  49 # define CLONE_PARENT  0x00008000 /* Set if we want to have the same
  50                                      parent as the cloner.  */
  51 # define CLONE_THREAD  0x00010000 /* Set to add to same thread group.  */
  52 # define CLONE_NEWNS   0x00020000 /* Set to create new namespace.  */
  53 # define CLONE_SYSVSEM 0x00040000 /* Set to shared SVID SEM_UNDO semantics.  */
  54 # define CLONE_SETTLS  0x00080000 /* Set TLS info.  */
  55 # define CLONE_PARENT_SETTID 0x00100000 /* Store TID in userlevel buffer
  56                                            before MM copy.  */
  57 # define CLONE_CHILD_CLEARTID 0x00200000 /* Register exit futex and memory
  58                                             location to clear.  */
  59 # define CLONE_DETACHED 0x00400000 /* Create clone detached.  */
  60 # define CLONE_UNTRACED 0x00800000 /* Set if the tracing process can't
  61                                       force CLONE_PTRACE on this clone.  */
  62 # define CLONE_CHILD_SETTID 0x01000000 /* Store TID in userlevel buffer in
  63                                           the child.  */
  64 # define CLONE_NEWUTS   0x04000000      /* New utsname group.  */
  65 # define CLONE_NEWIPC   0x08000000      /* New ipcs.  */
  66 # define CLONE_NEWUSER  0x10000000      /* New user namespace.  */
  67 # define CLONE_NEWPID   0x20000000      /* New pid namespace.  */
  68 # define CLONE_NEWNET   0x40000000      /* New network namespace.  */
  69 # define CLONE_IO       0x80000000      /* Clone I/O context.  */
  70 #endif
  71
  72 /* The official definition.  */
  73 struct sched_param
  74   {
  75     int __sched_priority;
  76   };
  77
  78 __BEGIN_DECLS
  79
  80 #ifdef __USE_GNU
  81 /* Clone current process.  */
  82 extern int clone (int (*__fn) (void *__arg), void *__child_stack,
  83                   int __flags, void *__arg, ...) __THROW;
  84
  85 /* Unshare the specified resources.  */
  86 extern int unshare (int __flags) __THROW;
  87
  88 /* Get index of currently used CPU.  */
  89 extern int sched_getcpu (void) __THROW;
  90
  91 /* Switch process to namespace of type NSTYPE indicated by FD.  */
  92 extern int setns (int __fd, int __nstype) __THROW;
  93 #endif
  94
  95
  96 __END_DECLS
  97
  98 #endif  /* need schedparam */
  99
 100 #if !defined __defined_schedparam \
 101     && (defined __need_schedparam || defined _SCHED_H)
 102 # define __defined_schedparam   1
 103 /* Data structure to describe a process' schedulability.  */
 104 struct __sched_param
 105   {
 106     int __sched_priority;
 107   };
 108 # undef __need_schedparam
 109 #endif
 110
 111
 112 #if defined _SCHED_H && !defined __cpu_set_t_defined
 113 # define __cpu_set_t_defined
 114 /* Size definition for CPU sets.  */
 115 # define __CPU_SETSIZE  1024
 116 # define __NCPUBITS     (8 * sizeof (__cpu_mask))
 117
 118 /* Type for array elements in 'cpu_set_t'.  */
 119 typedef unsigned long int __cpu_mask;
 120
 121 /* Basic access functions.  */
 122 # define __CPUELT(cpu)  ((cpu) / __NCPUBITS)
 123 # define __CPUMASK(cpu) ((__cpu_mask) 1 << ((cpu) % __NCPUBITS))
 124
 125 /* Data structure to describe CPU mask.  */
 126 typedef struct
 127 {
 128   __cpu_mask __bits[__CPU_SETSIZE / __NCPUBITS];
 129 } cpu_set_t;
 130
 131 /* Access functions for CPU masks.  */
 132 # if __GNUC_PREREQ (2, 91)
 133 #  define __CPU_ZERO_S(setsize, cpusetp) \
 134   do __builtin_memset (cpusetp, '\0', setsize); while (0)
 135 # else
 136 #  define __CPU_ZERO_S(setsize, cpusetp) \
 137   do {                                                                        \
 138     size_t __i;                                                               \
 139     size_t __imax = (setsize) / sizeof (__cpu_mask);                          \
 140     __cpu_mask *__bits = (cpusetp)->__bits;                                   \
 141     for (__i = 0; __i < __imax; ++__i)                                        \
 142       __bits[__i] = 0;                                                        \
 143   } while (0)
 144 # endif
 145 # define __CPU_SET_S(cpu, setsize, cpusetp) \
 146   (__extension__                                                              \
 147    ({ size_t __cpu = (cpu);                                                   \
 148       __cpu < 8 * (setsize)                                                   \
 149       ? (((__cpu_mask *) ((cpusetp)->__bits))[__CPUELT (__cpu)]               \
 150          |= __CPUMASK (__cpu))                                                \
 151       : 0; }))
 152 # define __CPU_CLR_S(cpu, setsize, cpusetp) \
 153   (__extension__                                                              \
 154    ({ size_t __cpu = (cpu);                                                   \
 155       __cpu < 8 * (setsize)                                                   \
 156       ? (((__cpu_mask *) ((cpusetp)->__bits))[__CPUELT (__cpu)]               \
 157          &= ~__CPUMASK (__cpu))                                               \
 158       : 0; }))
 159 # define __CPU_ISSET_S(cpu, setsize, cpusetp) \
 160   (__extension__                                                              \
 161    ({ size_t __cpu = (cpu);                                                   \
 162       __cpu < 8 * (setsize)                                                   \
 163       ? ((((const __cpu_mask *) ((cpusetp)->__bits))[__CPUELT (__cpu)]        \
 164           & __CPUMASK (__cpu))) != 0                                          \
 165       : 0; }))
 166
 167 # define __CPU_COUNT_S(setsize, cpusetp) \
 168   __sched_cpucount (setsize, cpusetp)
 169
 170 # if __GNUC_PREREQ (2, 91)
 171 #  define __CPU_EQUAL_S(setsize, cpusetp1, cpusetp2) \
 172   (__builtin_memcmp (cpusetp1, cpusetp2, setsize) == 0)
 173 # else
 174 #  define __CPU_EQUAL_S(setsize, cpusetp1, cpusetp2) \
 175   (__extension__                                                              \
 176    ({ const __cpu_mask *__arr1 = (cpusetp1)->__bits;                          \
 177       const __cpu_mask *__arr2 = (cpusetp2)->__bits;                          \
 178       size_t __imax = (setsize) / sizeof (__cpu_mask);                        \
 179       size_t __i;                                                             \
 180       for (__i = 0; __i < __imax; ++__i)                                      \
 181         if (__arr1[__i] != __arr2[__i])                                       \
 182           break;                                                              \
 183       __i == __imax; }))
 184 # endif
 185
 186 # define __CPU_OP_S(setsize, destset, srcset1, srcset2, op) \
 187   (__extension__                                                              \
 188    ({ cpu_set_t *__dest = (destset);                                          \
 189       const __cpu_mask *__arr1 = (srcset1)->__bits;                           \
 190       const __cpu_mask *__arr2 = (srcset2)->__bits;                           \
 191       size_t __imax = (setsize) / sizeof (__cpu_mask);                        \
 192       size_t __i;                                                             \
 193       for (__i = 0; __i < __imax; ++__i)                                      \
 194         ((__cpu_mask *) __dest->__bits)[__i] = __arr1[__i] op __arr2[__i];    \
 195       __dest; }))
 196
 197 # define __CPU_ALLOC_SIZE(count) \
 198   ((((count) + __NCPUBITS - 1) / __NCPUBITS) * sizeof (__cpu_mask))
 199 # define __CPU_ALLOC(count) __sched_cpualloc (count)
 200 # define __CPU_FREE(cpuset) __sched_cpufree (cpuset)
 201
 202 __BEGIN_DECLS
 203
 204 extern int __sched_cpucount (size_t __setsize, const cpu_set_t *__setp)
 205   __THROW;
 206 extern cpu_set_t *__sched_cpualloc (size_t __count) __THROW __wur;
 207 extern void __sched_cpufree (cpu_set_t *__set) __THROW;
 208
 209 __END_DECLS
 210
 211 #endif