2 * prlimit - get/set process resource limits.
4 * Copyright (C) 2011 Davidlohr Bueso <dave@gnu.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program 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
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 #include <sys/resource.h>
30 #include <libsmartcols.h>
37 #include "closestream.h"
40 # define RLIMIT_RTTIME 15
62 /* basic output flags */
63 static int no_headings
;
73 static struct prlimit_desc prlimit_desc
[] =
75 [AS
] = { "AS", N_("address space limit"), N_("bytes"), RLIMIT_AS
},
76 [CORE
] = { "CORE", N_("max core file size"), N_("blocks"), RLIMIT_CORE
},
77 [CPU
] = { "CPU", N_("CPU time"), N_("seconds"), RLIMIT_CPU
},
78 [DATA
] = { "DATA", N_("max data size"), N_("bytes"), RLIMIT_DATA
},
79 [FSIZE
] = { "FSIZE", N_("max file size"), N_("blocks"), RLIMIT_FSIZE
},
80 [LOCKS
] = { "LOCKS", N_("max number of file locks held"), NULL
, RLIMIT_LOCKS
},
81 [MEMLOCK
] = { "MEMLOCK", N_("max locked-in-memory address space"), N_("bytes"), RLIMIT_MEMLOCK
},
82 [MSGQUEUE
] = { "MSGQUEUE", N_("max bytes in POSIX mqueues"), N_("bytes"), RLIMIT_MSGQUEUE
},
83 [NICE
] = { "NICE", N_("max nice prio allowed to raise"), NULL
, RLIMIT_NICE
},
84 [NOFILE
] = { "NOFILE", N_("max number of open files"), NULL
, RLIMIT_NOFILE
},
85 [NPROC
] = { "NPROC", N_("max number of processes"), NULL
, RLIMIT_NPROC
},
86 [RSS
] = { "RSS", N_("max resident set size"), N_("pages"), RLIMIT_RSS
},
87 [RTPRIO
] = { "RTPRIO", N_("max real-time priority"), NULL
, RLIMIT_RTPRIO
},
88 [RTTIME
] = { "RTTIME", N_("timeout for real-time tasks"), N_("microsecs"), RLIMIT_RTTIME
},
89 [SIGPENDING
] = { "SIGPENDING", N_("max number of pending signals"), NULL
, RLIMIT_SIGPENDING
},
90 [STACK
] = { "STACK", N_("max stack size"), N_("bytes"), RLIMIT_STACK
}
94 struct list_head lims
;
97 struct prlimit_desc
*desc
;
98 int modify
; /* PRLIMIT_{SOFT,HARD} mask */
101 #define PRLIMIT_EMPTY_LIMIT {{ 0, 0, }, NULL, 0 }
113 const char *name
; /* header */
114 double whint
; /* width hint (N < 1 is in percent of termwidth) */
115 int flags
; /* SCOLS_FL_* */
119 /* columns descriptions */
120 struct colinfo infos
[] = {
121 [COL_RES
] = { "RESOURCE", 0.25, SCOLS_FL_TRUNC
, N_("resource name") },
122 [COL_HELP
] = { "DESCRIPTION", 0.1, SCOLS_FL_TRUNC
, N_("resource description")},
123 [COL_SOFT
] = { "SOFT", 0.1, SCOLS_FL_RIGHT
, N_("soft limit")},
124 [COL_HARD
] = { "HARD", 1, SCOLS_FL_RIGHT
, N_("hard limit (ceiling)")},
125 [COL_UNITS
] = { "UNITS", 0.1, SCOLS_FL_TRUNC
, N_("units")},
128 #define NCOLS ARRAY_SIZE(infos)
129 #define MAX_RESOURCES ARRAY_SIZE(prlimit_desc)
131 #define INFINITY_STR "unlimited"
132 #define INFINITY_STRLEN (sizeof(INFINITY_STR) - 1)
134 #define PRLIMIT_SOFT (1 << 1)
135 #define PRLIMIT_HARD (1 << 2)
137 /* array with IDs of enabled columns */
138 static int columns
[NCOLS
], ncolumns
;
139 static pid_t pid
; /* calling process (default) */
143 # include <sys/syscall.h>
144 static int prlimit(pid_t p
, int resource
,
145 const struct rlimit
*new_limit
,
146 struct rlimit
*old_limit
)
148 return syscall(SYS_prlimit64
, p
, resource
, new_limit
, old_limit
);
152 static void __attribute__ ((__noreturn__
)) usage(FILE * out
)
156 fputs(USAGE_HEADER
, out
);
159 _(" %s [options] [-p PID]\n"), program_invocation_short_name
);
161 _(" %s [options] COMMAND\n"), program_invocation_short_name
);
163 fputs(_("\nGeneral Options:\n"), out
);
164 fputs(_(" -p, --pid <pid> process id\n"
165 " -o, --output <list> define which output columns to use\n"
166 " --noheadings don't print headings\n"
167 " --raw use the raw output format\n"
168 " --verbose verbose output\n"
169 " -h, --help display this help and exit\n"
170 " -V, --version output version information and exit\n"), out
);
172 fputs(_("\nResources Options:\n"), out
);
173 fputs(_(" -c, --core maximum size of core files created\n"
174 " -d, --data maximum size of a process's data segment\n"
175 " -e, --nice maximum nice priority allowed to raise\n"
176 " -f, --fsize maximum size of files written by the process\n"
177 " -i, --sigpending maximum number of pending signals\n"
178 " -l, --memlock maximum size a process may lock into memory\n"
179 " -m, --rss maximum resident set size\n"
180 " -n, --nofile maximum number of open files\n"
181 " -q, --msgqueue maximum bytes in POSIX message queues\n"
182 " -r, --rtprio maximum real-time scheduling priority\n"
183 " -s, --stack maximum stack size\n"
184 " -t, --cpu maximum amount of CPU time in seconds\n"
185 " -u, --nproc maximum number of user processes\n"
186 " -v, --as size of virtual memory\n"
187 " -x, --locks maximum number of file locks\n"
188 " -y, --rttime CPU time in microseconds a process scheduled\n"
189 " under real-time scheduling\n"), out
);
191 fputs(_("\nAvailable columns (for --output):\n"), out
);
193 for (i
= 0; i
< NCOLS
; i
++)
194 fprintf(out
, " %11s %s\n", infos
[i
].name
, _(infos
[i
].help
));
196 fprintf(out
, USAGE_MAN_TAIL("prlimit(1)"));
198 exit(out
== stderr
? EXIT_FAILURE
: EXIT_SUCCESS
);
201 static inline int get_column_id(int num
)
203 assert(ARRAY_SIZE(columns
) == NCOLS
);
204 assert(num
< ncolumns
);
205 assert(columns
[num
] < (int) NCOLS
);
210 static inline struct colinfo
*get_column_info(unsigned num
)
212 return &infos
[ get_column_id(num
) ];
215 static void add_scols_line(struct libscols_table
*table
, struct prlimit
*l
)
218 struct libscols_line
*line
;
223 line
= scols_table_new_line(table
, NULL
);
225 err(EXIT_FAILURE
, _("failed to initialize output line"));
227 for (i
= 0; i
< ncolumns
; i
++) {
230 switch (get_column_id(i
)) {
232 str
= xstrdup(l
->desc
->name
);
235 str
= xstrdup(l
->desc
->help
);
238 if (l
->rlim
.rlim_cur
== RLIM_INFINITY
)
239 str
= xstrdup(_("unlimited"));
241 xasprintf(&str
, "%llu", (unsigned long long) l
->rlim
.rlim_cur
);
244 if (l
->rlim
.rlim_max
== RLIM_INFINITY
)
245 str
= xstrdup(_("unlimited"));
247 xasprintf(&str
, "%llu", (unsigned long long) l
->rlim
.rlim_max
);
250 str
= l
->desc
->unit
? xstrdup(_(l
->desc
->unit
)) : NULL
;
257 scols_line_refer_data(line
, i
, str
);
261 static int column_name_to_id(const char *name
, size_t namesz
)
267 for (i
= 0; i
< NCOLS
; i
++) {
268 const char *cn
= infos
[i
].name
;
270 if (!strncasecmp(name
, cn
, namesz
) && !*(cn
+ namesz
))
273 warnx(_("unknown column: %s"), name
);
277 static void rem_prlim(struct prlimit
*lim
)
281 list_del(&lim
->lims
);
285 static int show_limits(struct list_head
*lims
)
288 struct list_head
*p
, *pnext
;
289 struct libscols_table
*table
;
291 table
= scols_new_table();
293 err(EXIT_FAILURE
, _("failed to initialize output table"));
295 scols_table_enable_raw(table
, raw
);
296 scols_table_enable_noheadings(table
, no_headings
);
298 for (i
= 0; i
< ncolumns
; i
++) {
299 struct colinfo
*col
= get_column_info(i
);
301 if (!scols_table_new_column(table
, col
->name
, col
->whint
, col
->flags
))
302 err(EXIT_FAILURE
, _("failed to initialize output column"));
306 list_for_each_safe(p
, pnext
, lims
) {
307 struct prlimit
*lim
= list_entry(p
, struct prlimit
, lims
);
309 add_scols_line(table
, lim
);
313 scols_print_table(table
);
314 scols_unref_table(table
);
319 * If one of the limits is unknown (default value for not being passed), we
320 * need to get the current limit and use it. I see no other way other than
323 static void get_unknown_hardsoft(struct prlimit
*lim
)
327 if (prlimit(pid
, lim
->desc
->resource
, NULL
, &old
) == -1)
328 err(EXIT_FAILURE
, _("failed to get old %s limit"),
331 if (!(lim
->modify
& PRLIMIT_SOFT
))
332 lim
->rlim
.rlim_cur
= old
.rlim_cur
;
333 else if (!(lim
->modify
& PRLIMIT_HARD
))
334 lim
->rlim
.rlim_max
= old
.rlim_max
;
337 static void do_prlimit(struct list_head
*lims
)
339 struct list_head
*p
, *pnext
;
341 list_for_each_safe(p
, pnext
, lims
) {
342 struct rlimit
*new = NULL
, *old
= NULL
;
343 struct prlimit
*lim
= list_entry(p
, struct prlimit
, lims
);
346 if (lim
->modify
!= (PRLIMIT_HARD
| PRLIMIT_SOFT
))
347 get_unknown_hardsoft(lim
);
349 if ((lim
->rlim
.rlim_cur
> lim
->rlim
.rlim_max
) &&
350 (lim
->rlim
.rlim_cur
!= RLIM_INFINITY
||
351 lim
->rlim
.rlim_max
!= RLIM_INFINITY
))
352 errx(EXIT_FAILURE
, _("the soft limit %s cannot exceed the hard limit"),
358 if (verbose
&& new) {
359 printf(_("New %s limit: "), lim
->desc
->name
);
360 if (new->rlim_cur
== RLIM_INFINITY
)
361 printf("<%s", _("unlimited"));
363 printf("<%ju", new->rlim_cur
);
365 if (new->rlim_max
== RLIM_INFINITY
)
366 printf(":%s>\n", _("unlimited"));
368 printf(":%ju>\n", new->rlim_max
);
371 if (prlimit(pid
, lim
->desc
->resource
, new, old
) == -1)
372 err(EXIT_FAILURE
, lim
->modify
?
373 _("failed to set the %s resource limit") :
374 _("failed to get the %s resource limit"),
378 rem_prlim(lim
); /* modify only; don't show */
382 static int get_range(char *str
, rlim_t
*soft
, rlim_t
*hard
, int *found
)
390 *soft
= *hard
= RLIM_INFINITY
;
392 if (!strcmp(str
, INFINITY_STR
)) { /* <unlimited> */
393 *found
|= PRLIMIT_SOFT
| PRLIMIT_HARD
;
396 } else if (*str
== ':') { /* <:hard> */
399 if (strcmp(str
, INFINITY_STR
) != 0) {
400 *hard
= strtoull(str
, &end
, 10);
402 if (errno
|| !end
|| *end
|| end
== str
)
405 *found
|= PRLIMIT_HARD
;
410 if (strncmp(str
, INFINITY_STR
, INFINITY_STRLEN
) == 0) {
411 /* <unlimited> or <unlimited:> */
412 end
= str
+ INFINITY_STRLEN
;
414 /* <value> or <soft:> */
415 *hard
= *soft
= strtoull(str
, &end
, 10);
416 if (errno
|| !end
|| end
== str
)
420 if (*end
== ':' && !*(end
+ 1)) /* <soft:> */
421 *found
|= PRLIMIT_SOFT
;
423 else if (*end
== ':') { /* <soft:hard> */
426 if (!strcmp(str
, INFINITY_STR
))
427 *hard
= RLIM_INFINITY
;
431 *hard
= strtoull(str
, &end
, 10);
433 if (errno
|| !end
|| *end
|| end
== str
)
436 *found
|= PRLIMIT_SOFT
| PRLIMIT_HARD
;
439 *found
|= PRLIMIT_SOFT
| PRLIMIT_HARD
;
445 static int parse_prlim(struct rlimit
*lim
, char *ops
, size_t id
)
450 if (get_range(ops
, &soft
, &hard
, &found
))
451 errx(EXIT_FAILURE
, _("failed to parse %s limit"),
452 prlimit_desc
[id
].name
);
454 lim
->rlim_cur
= soft
;
455 lim
->rlim_max
= hard
;
460 static int add_prlim(char *ops
, struct list_head
*lims
, size_t id
)
462 struct prlimit
*lim
= xcalloc(1, sizeof(*lim
));
464 INIT_LIST_HEAD(&lim
->lims
);
465 lim
->desc
= &prlimit_desc
[id
];
468 lim
->modify
= parse_prlim(&lim
->rlim
, ops
, id
);
470 list_add_tail(&lim
->lims
, lims
);
474 int main(int argc
, char **argv
)
477 struct list_head lims
;
480 VERBOSE_OPTION
= CHAR_MAX
+ 1,
485 static const struct option longopts
[] = {
486 { "pid", required_argument
, NULL
, 'p' },
487 { "output", required_argument
, NULL
, 'o' },
488 { "as", optional_argument
, NULL
, 'v' },
489 { "core", optional_argument
, NULL
, 'c' },
490 { "cpu", optional_argument
, NULL
, 't' },
491 { "data", optional_argument
, NULL
, 'd' },
492 { "fsize", optional_argument
, NULL
, 'f' },
493 { "locks", optional_argument
, NULL
, 'x' },
494 { "memlock", optional_argument
, NULL
, 'l' },
495 { "msgqueue", optional_argument
, NULL
, 'q' },
496 { "nice", optional_argument
, NULL
, 'e' },
497 { "nofile", optional_argument
, NULL
, 'n' },
498 { "nproc", optional_argument
, NULL
, 'u' },
499 { "rss", optional_argument
, NULL
, 'm' },
500 { "rtprio", optional_argument
, NULL
, 'r' },
501 { "rttime", optional_argument
, NULL
, 'y' },
502 { "sigpending", optional_argument
, NULL
, 'i' },
503 { "stack", optional_argument
, NULL
, 's' },
504 { "version", no_argument
, NULL
, 'V' },
505 { "help", no_argument
, NULL
, 'h' },
506 { "noheadings", no_argument
, NULL
, NOHEADINGS_OPTION
},
507 { "raw", no_argument
, NULL
, RAW_OPTION
},
508 { "verbose", no_argument
, NULL
, VERBOSE_OPTION
},
512 setlocale(LC_ALL
, "");
513 bindtextdomain(PACKAGE
, LOCALEDIR
);
515 atexit(close_stdout
);
517 INIT_LIST_HEAD(&lims
);
520 * Something is very wrong if this doesn't succeed,
521 * assuming STACK is the last resource, of course.
523 assert(MAX_RESOURCES
== STACK
+ 1);
525 while((opt
= getopt_long(argc
, argv
,
526 "+c::d::e::f::i::l::m::n::q::r::s::t::u::v::x::y::p:o:vVh",
527 longopts
, NULL
)) != -1) {
530 add_prlim(optarg
, &lims
, CORE
);
533 add_prlim(optarg
, &lims
, DATA
);
536 add_prlim(optarg
, &lims
, NICE
);
539 add_prlim(optarg
, &lims
, FSIZE
);
542 add_prlim(optarg
, &lims
, SIGPENDING
);
545 add_prlim(optarg
, &lims
, MEMLOCK
);
548 add_prlim(optarg
, &lims
, RSS
);
551 add_prlim(optarg
, &lims
, NOFILE
);
554 add_prlim(optarg
, &lims
, MSGQUEUE
);
557 add_prlim(optarg
, &lims
, RTPRIO
);
560 add_prlim(optarg
, &lims
, STACK
);
563 add_prlim(optarg
, &lims
, CPU
);
566 add_prlim(optarg
, &lims
, NPROC
);
569 add_prlim(optarg
, &lims
, AS
);
572 add_prlim(optarg
, &lims
, LOCKS
);
575 add_prlim(optarg
, &lims
, RTTIME
);
580 errx(EXIT_FAILURE
, _("option --pid may be specified only once"));
581 pid
= strtos32_or_err(optarg
, _("invalid PID argument"));
586 ncolumns
= string_to_idarray(optarg
,
587 columns
, ARRAY_SIZE(columns
),
593 printf(UTIL_LINUX_VERSION
);
596 case NOHEADINGS_OPTION
:
610 if (argc
> optind
&& pid
)
611 errx(EXIT_FAILURE
, _("options --pid and COMMAND are mutually exclusive"));
613 /* default columns */
614 columns
[ncolumns
++] = COL_RES
;
615 columns
[ncolumns
++] = COL_HELP
;
616 columns
[ncolumns
++] = COL_SOFT
;
617 columns
[ncolumns
++] = COL_HARD
;
618 columns
[ncolumns
++] = COL_UNITS
;
621 if (list_empty(&lims
)) {
622 /* default is to print all resources */
625 for (n
= 0; n
< MAX_RESOURCES
; n
++)
626 add_prlim(NULL
, &lims
, n
);
631 if (!list_empty(&lims
))
635 /* prlimit [options] COMMAND */
636 execvp(argv
[optind
], &argv
[optind
]);
637 err(EXIT_FAILURE
, _("failed to execute %s"), argv
[optind
]);