posix/sched.h

   1 /* Definitions for POSIX 1003.1b-1993 (aka POSIX.4) scheduling interface.
   2    Copyright (C) 1996,1997,1999,2001-2004,2007,2010,2012
   3    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    <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef _SCHED_H
  21 #define _SCHED_H        1
  22
  23 #include <features.h>
  24
  25 /* Get type definitions.  */
  26 #include <bits/types.h>
  27
  28 #define __need_size_t
  29 #include <stddef.h>
  30
  31 #define __need_time_t
  32 #define __need_timespec
  33 #include <time.h>
  34
  35 #ifndef __pid_t_defined
  36 typedef __pid_t pid_t;
  37 # define __pid_t_defined
  38 #endif
  39
  40
  41 /* Get system specific constant and data structure definitions.  */
  42 #include <bits/sched.h>
  43 /* Define the real names for the elements of `struct sched_param'.  */
  44 #define sched_priority  __sched_priority
  45
  46
  47 __BEGIN_DECLS
  48
  49 /* Set scheduling parameters for a process.  */
  50 extern int sched_setparam (__pid_t __pid, const struct sched_param *__param)
  51      __THROW;
  52
  53 /* Retrieve scheduling parameters for a particular process.  */
  54 extern int sched_getparam (__pid_t __pid, struct sched_param *__param) __THROW;
  55
  56 /* Set scheduling algorithm and/or parameters for a process.  */
  57 extern int sched_setscheduler (__pid_t __pid, int __policy,
  58                                const struct sched_param *__param) __THROW;
  59
  60 /* Retrieve scheduling algorithm for a particular purpose.  */
  61 extern int sched_getscheduler (__pid_t __pid) __THROW;
  62
  63 /* Yield the processor.  */
  64 extern int sched_yield (void) __THROW;
  65
  66 /* Get maximum priority value for a scheduler.  */
  67 extern int sched_get_priority_max (int __algorithm) __THROW;
  68
  69 /* Get minimum priority value for a scheduler.  */
  70 extern int sched_get_priority_min (int __algorithm) __THROW;
  71
  72 /* Get the SCHED_RR interval for the named process.  */
  73 extern int sched_rr_get_interval (__pid_t __pid, struct timespec *__t) __THROW;
  74
  75
  76 #ifdef __USE_GNU
  77 /* Access macros for `cpu_set'.  */
  78 # define CPU_SETSIZE __CPU_SETSIZE
  79 # define CPU_SET(cpu, cpusetp)   __CPU_SET_S (cpu, sizeof (cpu_set_t), cpusetp)
  80 # define CPU_CLR(cpu, cpusetp)   __CPU_CLR_S (cpu, sizeof (cpu_set_t), cpusetp)
  81 # define CPU_ISSET(cpu, cpusetp) __CPU_ISSET_S (cpu, sizeof (cpu_set_t), \
  82                                                 cpusetp)
  83 # define CPU_ZERO(cpusetp)       __CPU_ZERO_S (sizeof (cpu_set_t), cpusetp)
  84 # define CPU_COUNT(cpusetp)      __CPU_COUNT_S (sizeof (cpu_set_t), cpusetp)
  85
  86 # define CPU_SET_S(cpu, setsize, cpusetp)   __CPU_SET_S (cpu, setsize, cpusetp)
  87 # define CPU_CLR_S(cpu, setsize, cpusetp)   __CPU_CLR_S (cpu, setsize, cpusetp)
  88 # define CPU_ISSET_S(cpu, setsize, cpusetp) __CPU_ISSET_S (cpu, setsize, \
  89                                                            cpusetp)
  90 # define CPU_ZERO_S(setsize, cpusetp)       __CPU_ZERO_S (setsize, cpusetp)
  91 # define CPU_COUNT_S(setsize, cpusetp)      __CPU_COUNT_S (setsize, cpusetp)
  92
  93 # define CPU_EQUAL(cpusetp1, cpusetp2) \
  94   __CPU_EQUAL_S (sizeof (cpu_set_t), cpusetp1, cpusetp2)
  95 # define CPU_EQUAL_S(setsize, cpusetp1, cpusetp2) \
  96   __CPU_EQUAL_S (setsize, cpusetp1, cpusetp2)
  97
  98 # define CPU_AND(destset, srcset1, srcset2) \
  99   __CPU_OP_S (sizeof (cpu_set_t), destset, srcset1, srcset2, &)
 100 # define CPU_OR(destset, srcset1, srcset2) \
 101   __CPU_OP_S (sizeof (cpu_set_t), destset, srcset1, srcset2, |)
 102 # define CPU_XOR(destset, srcset1, srcset2) \
 103   __CPU_OP_S (sizeof (cpu_set_t), destset, srcset1, srcset2, ^)
 104 # define CPU_AND_S(setsize, destset, srcset1, srcset2) \
 105   __CPU_OP_S (setsize, destset, srcset1, srcset2, &)
 106 # define CPU_OR_S(setsize, destset, srcset1, srcset2) \
 107   __CPU_OP_S (setsize, destset, srcset1, srcset2, |)
 108 # define CPU_XOR_S(setsize, destset, srcset1, srcset2) \
 109   __CPU_OP_S (setsize, destset, srcset1, srcset2, ^)
 110
 111 # define CPU_ALLOC_SIZE(count) __CPU_ALLOC_SIZE (count)
 112 # define CPU_ALLOC(count) __CPU_ALLOC (count)
 113 # define CPU_FREE(cpuset) __CPU_FREE (cpuset)
 114
 115
 116 /* Set the CPU affinity for a task */
 117 extern int sched_setaffinity (__pid_t __pid, size_t __cpusetsize,
 118                               const cpu_set_t *__cpuset) __THROW;
 119
 120 /* Get the CPU affinity for a task */
 121 extern int sched_getaffinity (__pid_t __pid, size_t __cpusetsize,
 122                               cpu_set_t *__cpuset) __THROW;
 123 #endif
 124
 125 __END_DECLS
 126
 127 #endif /* sched.h */