[thirdparty/glibc.git] / sysdeps / unix / sysv / linux / bits / sched.h

/* Definitions of constants and data structure for POSIX 1003.1b-1993
   scheduling interface.
   Copyright (C) 1996-2013 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library; if not, see
   <http://www.gnu.org/licenses/>.  */

#ifndef __need_schedparam

#ifndef _SCHED_H
# error "Never include <bits/sched.h> directly; use <sched.h> instead."
#endif


/* Scheduling algorithms.  */
#define SCHED_OTHER		0
#define SCHED_FIFO		1
#define SCHED_RR		2
#ifdef __USE_GNU
# define SCHED_BATCH		3
# define SCHED_IDLE		5

# define SCHED_RESET_ON_FORK	0x40000000
#endif

#ifdef __USE_GNU
/* Cloning flags.  */
# define CSIGNAL       0x000000ff /* Signal mask to be sent at exit.  */
# define CLONE_VM      0x00000100 /* Set if VM shared between processes.  */
# define CLONE_FS      0x00000200 /* Set if fs info shared between processes.  */
# define CLONE_FILES   0x00000400 /* Set if open files shared between processes.  */
# define CLONE_SIGHAND 0x00000800 /* Set if signal handlers shared.  */
# define CLONE_PTRACE  0x00002000 /* Set if tracing continues on the child.  */
# define CLONE_VFORK   0x00004000 /* Set if the parent wants the child to
				     wake it up on mm_release.  */
# define CLONE_PARENT  0x00008000 /* Set if we want to have the same
				     parent as the cloner.  */
# define CLONE_THREAD  0x00010000 /* Set to add to same thread group.  */
# define CLONE_NEWNS   0x00020000 /* Set to create new namespace.  */
# define CLONE_SYSVSEM 0x00040000 /* Set to shared SVID SEM_UNDO semantics.  */
# define CLONE_SETTLS  0x00080000 /* Set TLS info.  */
# define CLONE_PARENT_SETTID 0x00100000 /* Store TID in userlevel buffer
					   before MM copy.  */
# define CLONE_CHILD_CLEARTID 0x00200000 /* Register exit futex and memory
					    location to clear.  */
# define CLONE_DETACHED 0x00400000 /* Create clone detached.  */
# define CLONE_UNTRACED 0x00800000 /* Set if the tracing process can't
				      force CLONE_PTRACE on this clone.  */
# define CLONE_CHILD_SETTID 0x01000000 /* Store TID in userlevel buffer in
					  the child.  */
# define CLONE_NEWUTS	0x04000000	/* New utsname group.  */
# define CLONE_NEWIPC	0x08000000	/* New ipcs.  */
# define CLONE_NEWUSER	0x10000000	/* New user namespace.  */
# define CLONE_NEWPID	0x20000000	/* New pid namespace.  */
# define CLONE_NEWNET	0x40000000	/* New network namespace.  */
# define CLONE_IO	0x80000000	/* Clone I/O context.  */
#endif

/* The official definition.  */
struct sched_param
  {
    int __sched_priority;
  };

__BEGIN_DECLS

#ifdef __USE_GNU
/* Clone current process.  */
extern int clone (int (*__fn) (void *__arg), void *__child_stack,
		  int __flags, void *__arg, ...) __THROW;

/* Unshare the specified resources.  */
extern int unshare (int __flags) __THROW;

/* Get index of currently used CPU.  */
extern int sched_getcpu (void) __THROW;

/* Switch process to namespace of type NSTYPE indicated by FD.  */
extern int setns (int __fd, int __nstype) __THROW;
#endif


__END_DECLS

#endif	/* need schedparam */

#if !defined __defined_schedparam \
    && (defined __need_schedparam || defined _SCHED_H)
# define __defined_schedparam	1
/* Data structure to describe a process' schedulability.  */
struct __sched_param
  {
    int __sched_priority;
  };
# undef __need_schedparam
#endif


#if defined _SCHED_H && !defined __cpu_set_t_defined
# define __cpu_set_t_defined
/* Size definition for CPU sets.  */
# define __CPU_SETSIZE	1024
# define __NCPUBITS	(8 * sizeof (__cpu_mask))

/* Type for array elements in 'cpu_set_t'.  */
typedef unsigned long int __cpu_mask;

/* Basic access functions.  */
# define __CPUELT(cpu)	((cpu) / __NCPUBITS)
# define __CPUMASK(cpu)	((__cpu_mask) 1 << ((cpu) % __NCPUBITS))

/* Data structure to describe CPU mask.  */
typedef struct
{
  __cpu_mask __bits[__CPU_SETSIZE / __NCPUBITS];
} cpu_set_t;

/* Access functions for CPU masks.  */
# if __GNUC_PREREQ (2, 91)
#  define __CPU_ZERO_S(setsize, cpusetp) \
  do __builtin_memset (cpusetp, '\0', setsize); while (0)
# else
#  define __CPU_ZERO_S(setsize, cpusetp) \
  do {									      \
    size_t __i;								      \
    size_t __imax = (setsize) / sizeof (__cpu_mask);			      \
    __cpu_mask *__bits = (cpusetp)->__bits;				      \
    for (__i = 0; __i < __imax; ++__i)					      \
      __bits[__i] = 0;							      \
  } while (0)
# endif
# define __CPU_SET_S(cpu, setsize, cpusetp) \
  (__extension__							      \
   ({ size_t __cpu = (cpu);						      \
      __cpu < 8 * (setsize)						      \
      ? (((__cpu_mask *) ((cpusetp)->__bits))[__CPUELT (__cpu)]		      \
	 |= __CPUMASK (__cpu))						      \
      : 0; }))
# define __CPU_CLR_S(cpu, setsize, cpusetp) \
  (__extension__							      \
   ({ size_t __cpu = (cpu);						      \
      __cpu < 8 * (setsize)						      \
      ? (((__cpu_mask *) ((cpusetp)->__bits))[__CPUELT (__cpu)]		      \
	 &= ~__CPUMASK (__cpu))						      \
      : 0; }))
# define __CPU_ISSET_S(cpu, setsize, cpusetp) \
  (__extension__							      \
   ({ size_t __cpu = (cpu);						      \
      __cpu < 8 * (setsize)						      \
      ? ((((const __cpu_mask *) ((cpusetp)->__bits))[__CPUELT (__cpu)]	      \
	  & __CPUMASK (__cpu))) != 0					      \
      : 0; }))

# define __CPU_COUNT_S(setsize, cpusetp) \
  __sched_cpucount (setsize, cpusetp)

# if __GNUC_PREREQ (2, 91)
#  define __CPU_EQUAL_S(setsize, cpusetp1, cpusetp2) \
  (__builtin_memcmp (cpusetp1, cpusetp2, setsize) == 0)
# else
#  define __CPU_EQUAL_S(setsize, cpusetp1, cpusetp2) \
  (__extension__							      \
   ({ const __cpu_mask *__arr1 = (cpusetp1)->__bits;			      \
      const __cpu_mask *__arr2 = (cpusetp2)->__bits;			      \
      size_t __imax = (setsize) / sizeof (__cpu_mask);			      \
      size_t __i;							      \
      for (__i = 0; __i < __imax; ++__i)				      \
	if (__arr1[__i] != __arr2[__i])					      \
	  break;							      \
      __i == __imax; }))
# endif

# define __CPU_OP_S(setsize, destset, srcset1, srcset2, op) \
  (__extension__							      \
   ({ cpu_set_t *__dest = (destset);					      \
      const __cpu_mask *__arr1 = (srcset1)->__bits;			      \
      const __cpu_mask *__arr2 = (srcset2)->__bits;			      \
      size_t __imax = (setsize) / sizeof (__cpu_mask);			      \
      size_t __i;							      \
      for (__i = 0; __i < __imax; ++__i)				      \
	((__cpu_mask *) __dest->__bits)[__i] = __arr1[__i] op __arr2[__i];    \
      __dest; }))

# define __CPU_ALLOC_SIZE(count) \
  ((((count) + __NCPUBITS - 1) / __NCPUBITS) * sizeof (__cpu_mask))
# define __CPU_ALLOC(count) __sched_cpualloc (count)
# define __CPU_FREE(cpuset) __sched_cpufree (cpuset)

__BEGIN_DECLS

extern int __sched_cpucount (size_t __setsize, const cpu_set_t *__setp)
  __THROW;
extern cpu_set_t *__sched_cpualloc (size_t __count) __THROW __wur;
extern void __sched_cpufree (cpu_set_t *__set) __THROW;

__END_DECLS

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