1 .\" Copyright (c) 1992 Drew Eckhardt (drew@cs.colorado.edu), March 28, 1992
2 .\" and Copyright (c) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
4 .\" %%%LICENSE_START(VERBATIM)
5 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date. The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein. The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
26 .\" Modified by Michael Haardt <michael@moria.de>
27 .\" Modified 1993-07-21 by Rik Faith <faith@cs.unc.edu>
28 .\" Modified 1994-08-21 by Michael Chastain <mec@shell.portal.com>:
29 .\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
30 .\" Modified 1999-11-12 by Urs Thuermann <urs@isnogud.escape.de>
31 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
32 .\" 2006-09-04 Michael Kerrisk <mtk.manpages@gmail.com>
33 .\" Added list of process attributes that are not preserved on exec().
34 .\" 2007-09-14 Ollie Wild <aaw@google.com>, mtk
35 .\" Add text describing limits on command-line arguments + environment
37 .TH EXECVE 2 2018-04-30 "Linux" "Linux Programmer's Manual"
39 execve \- execute program
41 .B #include <unistd.h>
43 .BI "int execve(const char *" filename ", char *const " argv "[], "
45 .BI " char *const " envp []);
48 executes the program pointed to by \fIfilename\fP.
49 This causes the program that is currently being run by the calling process
50 to be replaced with a new program, with newly initialized stack, heap,
51 and (initialized and uninitialized) data segments.
53 \fIfilename\fP must be either a binary executable, or a script
54 starting with a line of the form:
58 \fB#!\fP \fIinterpreter \fP[optional-arg]
62 For details of the latter case, see "Interpreter scripts" below.
64 \fIargv\fP is an array of argument strings passed to the new program.
65 By convention, the first of these strings (i.e.,
67 should contain the filename associated with the file being executed.
68 \fIenvp\fP is an array of strings, conventionally of the form
69 \fBkey=value\fP, which are passed as environment to the new program.
70 The \fIargv\fP and \fIenvp\fP arrays must each include a null pointer
71 at the end of the array.
73 The argument vector and environment can be accessed by the
74 called program's main function, when it is defined as:
78 int main(int argc, char *argv[], char *envp[])
82 Note, however, that the use of a third argument to the main function
83 is not specified in POSIX.1;
85 the environment should be accessed via the external variable
89 does not return on success, and the text, initialized data,
90 uninitialized data (bss), and stack of the calling process are overwritten
91 according to the contents of the newly loaded program.
93 If the current program is being ptraced, a \fBSIGTRAP\fP signal is sent to it
97 If the set-user-ID bit is set on the program file pointed to by
99 then the effective user ID of the calling process is changed
100 to that of the owner of the program file.
101 Similarly, when the set-group-ID
102 bit of the program file is set the effective group ID of the calling
103 process is set to the group of the program file.
105 The aforementioned transformations of the effective IDs are
107 performed (i.e., the set-user-ID and set-group-ID bits are ignored)
108 if any of the following is true:
112 attribute is set for the calling thread (see
115 the underlying filesystem is mounted
123 the calling process is being ptraced.
125 The capabilities of the program file (see
126 .BR capabilities (7))
127 are also ignored if any of the above are true.
129 The effective user ID of the process is copied to the saved set-user-ID;
130 similarly, the effective group ID is copied to the saved set-group-ID.
131 This copying takes place after any effective ID changes that occur
132 because of the set-user-ID and set-group-ID mode bits.
134 The process's real UID and real GID, as well its supplementary group IDs,
135 are unchanged by a call to
138 If the executable is an a.out dynamically linked
139 binary executable containing
140 shared-library stubs, the Linux dynamic linker
142 is called at the start of execution to bring
143 needed shared objects into memory
144 and link the executable with them.
146 If the executable is a dynamically linked ELF executable, the
147 interpreter named in the PT_INTERP segment is used to load the needed
149 This interpreter is typically
150 .I /lib/ld-linux.so.2
151 for binaries linked with glibc (see
152 .BR ld-linux.so (8)).
154 All process attributes are preserved during an
156 except the following:
158 The dispositions of any signals that are being caught are
162 Any alternate signal stack is not preserved
163 .RB ( sigaltstack (2)).
165 Memory mappings are not preserved
168 Attached System\ V shared memory segments are detached
171 POSIX shared memory regions are unmapped
174 Open POSIX message queue descriptors are closed
175 .RB ( mq_overview (7)).
177 Any open POSIX named semaphores are closed
178 .RB ( sem_overview (7)).
180 POSIX timers are not preserved
181 .RB ( timer_create (2)).
183 Any open directory streams are closed
186 Memory locks are not preserved
190 Exit handlers are not preserved
194 The floating-point environment is reset to the default (see
197 The process attributes in the preceding list are all specified
199 The following Linux-specific process attributes are also
200 not preserved during an
207 unless a set-user-ID or set-group ID program is being executed,
208 in which case it is cleared.
215 (Since Linux 2.4.36 / 2.6.23)
216 If a set-user-ID or set-group-ID program is being executed,
217 then the parent death signal set by
222 The process name, as set by
226 .IR "ps\ \-o comm" ),
227 is reset to the name of the new executable file.
234 .BR capabilities (7).
236 The termination signal is reset to
241 The file descriptor table is unshared, undoing the effect of the
246 Note the following further points:
248 All threads other than the calling thread are destroyed during an
250 Mutexes, condition variables, and other pthreads objects are not preserved.
252 The equivalent of \fIsetlocale(LC_ALL, "C")\fP
253 is executed at program start-up.
255 POSIX.1 specifies that the dispositions of any signals that
256 are ignored or set to the default are left unchanged.
257 POSIX.1 specifies one exception: if
260 then an implementation may leave the disposition unchanged or
261 reset it to the default; Linux does the former.
263 Any outstanding asynchronous I/O operations are canceled
267 For the handling of capabilities during
270 .BR capabilities (7).
272 By default, file descriptors remain open across an
274 File descriptors that are marked close-on-exec are closed;
275 see the description of
279 (If a file descriptor is closed, this will cause the release
280 of all record locks obtained on the underlying file by this process.
284 POSIX.1 says that if file descriptors 0, 1, and 2 would
285 otherwise be closed after a successful
287 and the process would gain privilege because the set-user-ID or
288 set-group_ID mode bit was set on the executed file,
289 then the system may open an unspecified file for each of these
291 As a general principle, no portable program, whether privileged or not,
292 can assume that these three file descriptors will remain
295 .\" On Linux it appears that these file descriptors are
296 .\" always open after an execve(), and it looks like
297 .\" Solaris 8 and FreeBSD 6.1 are the same. -- mtk, 30 Apr 2007
298 .SS Interpreter scripts
299 An interpreter script is a text file that has execute
300 permission enabled and whose first line is of the form:
304 \fB#!\fP \fIinterpreter \fP[optional-arg]
310 must be a valid pathname for an executable file.
315 specifies an interpreter script, then
317 will be invoked with the following arguments:
321 \fIinterpreter\fP [optional-arg] \fIfilename\fP arg...
327 is the series of words pointed to by the
336 should either be absent, or be specified as a single word (i.e., it
337 should not contain white space); see NOTES below.
340 .\" commit bf2a9a39639b8b51377905397a5005f444e9a892
341 the kernel permits the interpreter of a script to itself be a script.
342 This permission is recursive, up to a limit of four recursions,
343 so that the interpreter may be a script which is interpreted by a script,
345 .SS Limits on size of arguments and environment
346 Most UNIX implementations impose some limit on the total size
347 of the command-line argument
351 strings that may be passed to a new program.
352 POSIX.1 allows an implementation to advertise this limit using the
354 constant (either defined in
356 or available at run time using the call
357 .IR "sysconf(_SC_ARG_MAX)" ).
359 On Linux prior to kernel 2.6.23, the memory used to store the
360 environment and argument strings was limited to 32 pages
361 (defined by the kernel constant
363 On architectures with a 4-kB page size,
364 this yields a maximum size of 128\ kB.
366 On kernel 2.6.23 and later, most architectures support a size limit
367 derived from the soft
371 that is in force at the time of the
374 (Architectures with no memory management unit are excepted:
375 they maintain the limit that was in effect before kernel 2.6.23.)
376 This change allows programs to have a much larger
377 argument and/or environment list.
378 .\" For some background on the changes to ARG_MAX in kernels 2.6.23 and
380 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=5786
381 .\" http://bugzilla.kernel.org/show_bug.cgi?id=10095
382 .\" http://thread.gmane.org/gmane.linux.kernel/646709/focus=648101,
383 .\" checked into 2.6.25 as commit a64e715fc74b1a7dcc5944f848acc38b2c4d4ee2.
384 For these architectures, the total size is limited to 1/4 of the allowed
386 (Imposing the 1/4-limit
387 ensures that the new program always has some stack space.)
388 .\" Ollie: That doesn't include the lists of pointers, though,
389 .\" so the actual usage is a bit higher (1 pointer per argument).
391 the kernel places a floor of 32 pages on this size limit,
395 applications are guaranteed to have at least as much argument and
396 environment space as was provided by Linux 2.6.23 and earlier.
397 (This guarantee was not provided in Linux 2.6.23 and 2.6.24.)
398 Additionally, the limit per string is 32 pages (the kernel constant
399 .BR MAX_ARG_STRLEN ),
400 and the maximum number of strings is 0x7FFFFFFF.
404 does not return, on error \-1 is returned, and
406 is set appropriately.
410 The total number of bytes in the environment
417 Search permission is denied on a component of the path prefix of
419 or the name of a script interpreter.
421 .BR path_resolution (7).)
424 The file or a script interpreter is not a regular file.
427 Execute permission is denied for the file or a script or ELF interpreter.
430 The filesystem is mounted
433 .BR EAGAIN " (since Linux 3.1)"
434 .\" commit 72fa59970f8698023045ab0713d66f3f4f96945c
435 Having changed its real UID using one of the
437 calls, the caller was\(emand is now still\(emabove its
441 For a more detailed explanation of this error, see NOTES.
445 or one of the pointers in the vectors
449 points outside your accessible address space.
452 An ELF executable had more than one PT_INTERP segment (i.e., tried to
453 name more than one interpreter).
456 An I/O error occurred.
459 An ELF interpreter was a directory.
462 An ELF interpreter was not in a recognized format.
465 Too many symbolic links were encountered in resolving
467 or the name of a script or ELF interpreter.
470 The maximum recursion limit was reached during recursive script
471 interpretation (see "Interpreter scripts", above).
473 .\" commit d740269867021faf4ce38a449353d2b986c34a67
474 the error produced for this case was
478 The per-process limit on the number of open file descriptors has been reached.
485 The system-wide limit on the total number of open files has been reached.
490 or a script or ELF interpreter does not exist, or a shared library
491 .\" FIXME but see http://sourceware.org/bugzilla/show_bug.cgi?id=12241
492 needed for the file or interpreter cannot be found.
495 An executable is not in a recognized format, is for the wrong
496 architecture, or has some other format error that means it cannot be
500 Insufficient kernel memory was available.
503 A component of the path prefix of
505 or a script or ELF interpreter is not a directory.
508 The filesystem is mounted
510 the user is not the superuser,
511 and the file has the set-user-ID or set-group-ID bit set.
514 The process is being traced, the user is not the superuser and the
515 file has the set-user-ID or set-group-ID bit set.
518 A "capability-dumb" applications would not obtain the full set of
519 permitted capabilities granted by the executable file.
521 .BR capabilities (7).
524 The specified executable was open for writing by one or more processes.
526 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
527 POSIX does not document the #! behavior, but it exists
528 (with some variations) on other UNIX systems.
529 .\" SVr4 documents additional error
530 .\" conditions EAGAIN, EINTR, ELIBACC, ENOLINK, EMULTIHOP; POSIX does not
531 .\" document ETXTBSY, EPERM, EFAULT, ELOOP, EIO, ENFILE, EMFILE, EINVAL,
532 .\" EISDIR or ELIBBAD error conditions.
536 (and the related functions described in
538 described as "executing a
540 process" (or similar).
541 This is a highly misleading description:
542 there is no new process;
543 many attributes of the calling process remain unchanged
544 (in particular, its PID).
547 does is arrange for an existing process (the calling process)
548 to execute a new program.
550 Set-user-ID and set-group-ID processes can not be
553 The result of mounting a filesystem
555 varies across Linux kernel versions:
556 some will refuse execution of set-user-ID and set-group-ID
557 executables when this would
558 give the user powers she did not have already (and return
560 some will just ignore the set-user-ID and set-group-ID bits and
568 can be specified as NULL.
569 In both cases, this has the same effect as specifying the argument
570 as a pointer to a list containing a single null pointer.
571 .B "Do not take advantage of this nonstandard and nonportable misfeature!"
572 On many other UNIX systems, specifying
574 as NULL will result in an error
577 other UNIX systems treat the
579 case the same as Linux.
580 .\" e.g., EFAULT on Solaris 8 and FreeBSD 6.1; but
581 .\" HP-UX 11 is like Linux -- mtk, Apr 2007
582 .\" Bug filed 30 Apr 2007: http://bugzilla.kernel.org/show_bug.cgi?id=8408
583 .\" Bug rejected (because fix would constitute an ABI change).
586 POSIX.1 says that values returned by
588 should be invariant over the lifetime of a process.
589 However, since Linux 2.6.23, if the
591 resource limit changes, then the value reported by
594 to reflect the fact that the limit on space for holding
595 command-line arguments and environment variables has changed.
599 fails, control returns to the original executable image,
602 can then handle the error.
603 However, in (rare) cases (typically caused by resource exhaustion),
604 failure may occur past the point of no return:
605 the original executable image has been torn down,
606 but the new image could not be completely built.
607 In such cases, the kernel kills the process with a
611 .SS Interpreter scripts
612 A maximum line length of 127 characters is allowed for the first line in
613 an interpreter script.
617 argument of an interpreter script vary across implementations.
618 On Linux, the entire string following the
620 name is passed as a single argument to the interpreter,
621 and this string can include white space.
622 However, behavior differs on some other systems.
625 use the first white space to terminate
628 .\" e.g., FreeBSD before 6.0, but not FreeBSD 6.0 onward
629 an interpreter script can have multiple arguments,
632 are used to delimit the arguments.
634 Linux ignores the set-user-ID and set-group-ID bits on scripts.
637 .\" Some Linux versions have failed to check permissions on ELF
638 .\" interpreters. This is a security hole, because it allows users to
639 .\" open any file, such as a rewinding tape device, for reading. Some
640 .\" Linux versions have also had other security holes in
642 .\" that could be exploited for denial of service by a suitably crafted
643 .\" ELF binary. There are no known problems with 2.0.34 or 2.2.15.
644 .SS execve() and EAGAIN
645 A more detailed explanation of the
647 error that can occur (since Linux 3.1) when calling
653 error can occur when a
660 caused the real user ID of the process to change,
661 and that change caused the process to exceed its
663 resource limit (i.e., the number of processes belonging
664 to the new real UID exceeds the resource limit).
665 From Linux 2.6.0 to 3.0, this caused the
669 .\" commit 909cc4ae86f3380152a18e2a3c44523893ee11c4
670 the resource limit was not imposed on processes that
671 changed their user IDs.)
673 Since Linux 3.1, the scenario just described no longer causes the
676 because it too often led to security holes where buggy applications
677 didn't check the return status and assumed
678 that\(emif the caller had root privileges\(emthe call would always succeed.
681 calls now successfully change the real UID,
682 but the kernel sets an internal flag, named
683 .BR PF_NPROC_EXCEEDED ,
686 resource limit has been exceeded.
688 .BR PF_NPROC_EXCEEDED
689 flag is set and the resource limit is still
690 exceeded at the time of a subsequent
692 call, that call fails with the error
694 This kernel logic ensures that the
696 resource limit is still enforced for the
697 common privileged daemon workflow\(emnamely,
704 If the resource limit was not still exceeded at the time of the
707 (because other processes belonging to this real UID terminated between the
713 call succeeds and the kernel clears the
714 .BR PF_NPROC_EXCEEDED
716 The flag is also cleared if a subsequent call to
718 by this process succeeds.
720 With UNIX\ V6, the argument list of an
723 while the argument list of
726 Thus, this argument list was not directly usable in a further
729 Since UNIX\ V7, both are NULL.
732 .\" Some Linux versions have failed to check permissions on ELF
733 .\" interpreters. This is a security hole, because it allows users to
734 .\" open any file, such as a rewinding tape device, for reading. Some
735 .\" Linux versions have also had other security holes in
737 .\" that could be exploited for denial of service by a suitably crafted
738 .\" ELF binary. There are no known problems with 2.0.34 or 2.2.15.
740 The following program is designed to be execed by the second program below.
741 It just echoes its command-line arguments, one per line.
751 main(int argc, char *argv[])
755 for (j = 0; j < argc; j++)
756 printf("argv[%d]: %s\en", j, argv[j]);
763 This program can be used to exec the program named in its command-line
775 main(int argc, char *argv[])
777 char *newargv[] = { NULL, "hello", "world", NULL };
778 char *newenviron[] = { NULL };
781 fprintf(stderr, "Usage: %s <file\-to\-exec>\en", argv[0]);
785 newargv[0] = argv[1];
787 execve(argv[1], newargv, newenviron);
788 perror("execve"); /* execve() returns only on error */
794 We can use the second program to exec the first as follows:
798 .RB "$" " cc myecho.c \-o myecho"
799 .RB "$" " cc execve.c \-o execve"
800 .RB "$" " ./execve ./myecho"
807 We can also use these programs to demonstrate the use of a script
809 To do this we create a script whose "interpreter" is our
815 .RB "$" " cat > script"
816 .B #!./myecho script-arg
818 .RB "$" " chmod +x script"
822 We can then use our program to exec the script:
826 .RB "$" " ./execve ./script"
838 .BR get_robust_list (2),
846 .BR path_resolution (7),