manual: fix a typo in strtoul description [BZ #21161]
[glibc.git] / resource / sys / resource.h
blob423ac62a3495521017be6cd82da9870197d0e49f
1 /* Copyright (C) 1992-2017 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, see
16 <http://www.gnu.org/licenses/>. */
18 #ifndef _SYS_RESOURCE_H
19 #define _SYS_RESOURCE_H 1
21 #include <features.h>
23 /* Get the system-dependent definitions of structures and bit values. */
24 #include <bits/resource.h>
26 #ifndef __id_t_defined
27 typedef __id_t id_t;
28 # define __id_t_defined
29 #endif
31 __BEGIN_DECLS
33 /* The X/Open standard defines that all the functions below must use
34 `int' as the type for the first argument. When we are compiling with
35 GNU extensions we change this slightly to provide better error
36 checking. */
37 #if defined __USE_GNU && !defined __cplusplus
38 typedef enum __rlimit_resource __rlimit_resource_t;
39 typedef enum __rusage_who __rusage_who_t;
40 typedef enum __priority_which __priority_which_t;
41 #else
42 typedef int __rlimit_resource_t;
43 typedef int __rusage_who_t;
44 typedef int __priority_which_t;
45 #endif
47 /* Put the soft and hard limits for RESOURCE in *RLIMITS.
48 Returns 0 if successful, -1 if not (and sets errno). */
49 #ifndef __USE_FILE_OFFSET64
50 extern int getrlimit (__rlimit_resource_t __resource,
51 struct rlimit *__rlimits) __THROW;
52 #else
53 # ifdef __REDIRECT_NTH
54 extern int __REDIRECT_NTH (getrlimit, (__rlimit_resource_t __resource,
55 struct rlimit *__rlimits), getrlimit64);
56 # else
57 # define getrlimit getrlimit64
58 # endif
59 #endif
60 #ifdef __USE_LARGEFILE64
61 extern int getrlimit64 (__rlimit_resource_t __resource,
62 struct rlimit64 *__rlimits) __THROW;
63 #endif
65 /* Set the soft and hard limits for RESOURCE to *RLIMITS.
66 Only the super-user can increase hard limits.
67 Return 0 if successful, -1 if not (and sets errno). */
68 #ifndef __USE_FILE_OFFSET64
69 extern int setrlimit (__rlimit_resource_t __resource,
70 const struct rlimit *__rlimits) __THROW;
71 #else
72 # ifdef __REDIRECT_NTH
73 extern int __REDIRECT_NTH (setrlimit, (__rlimit_resource_t __resource,
74 const struct rlimit *__rlimits),
75 setrlimit64);
76 # else
77 # define setrlimit setrlimit64
78 # endif
79 #endif
80 #ifdef __USE_LARGEFILE64
81 extern int setrlimit64 (__rlimit_resource_t __resource,
82 const struct rlimit64 *__rlimits) __THROW;
83 #endif
85 /* Return resource usage information on process indicated by WHO
86 and put it in *USAGE. Returns 0 for success, -1 for failure. */
87 extern int getrusage (__rusage_who_t __who, struct rusage *__usage) __THROW;
89 /* Return the highest priority of any process specified by WHICH and WHO
90 (see above); if WHO is zero, the current process, process group, or user
91 (as specified by WHO) is used. A lower priority number means higher
92 priority. Priorities range from PRIO_MIN to PRIO_MAX (above). */
93 extern int getpriority (__priority_which_t __which, id_t __who) __THROW;
95 /* Set the priority of all processes specified by WHICH and WHO (see above)
96 to PRIO. Returns 0 on success, -1 on errors. */
97 extern int setpriority (__priority_which_t __which, id_t __who, int __prio)
98 __THROW;
100 __END_DECLS
102 #endif /* sys/resource.h */