1EXECVE(2) Linux Programmer's Manual EXECVE(2)
2
6 execve - execute program
7
9 #include <unistd.h>
10 int execve(const char *pathname, char *const argv[],
12 char *const envp[]);
13
15 execve() executes the program referred to by pathname. This causes the
16 program that is currently being run by the calling process to be
17 replaced with a new program, with newly initialized stack, heap, and
18 (initialized and uninitialized) data segments.
19 pathname must be either a binary executable, or a script starting with
21 a line of the form:
22 #!interpreter [optional-arg]
24 For details of the latter case, see "Interpreter scripts" below.
26 argv is an array of pointers to strings passed to the new program as
28 its command-line arguments. By convention, the first of these strings
29 (i.e., argv[0]) should contain the filename associated with the file
30 being executed. The argv array must be terminated by a NULL pointer
31 (Thus, in the new program, argv[argc] will be NULL.)
32 envp is an array of pointers to strings, conventionally of the form
34 key=value, which are passed as the environment of the new program. The
35 envp array must be terminated by a NULL pointer
36 The argument vector and environment can be accessed by the new pro‐
38 gram's main function, when it is defined as:
39 int main(int argc, char *argv[], char *envp[])
41 Note, however, that the use of a third argument to the main function is
43 not specified in POSIX.1; according to POSIX.1, the environment should
44 be accessed via the external variable environ(7).
45 execve() does not return on success, and the text, initialized data,
47 uninitialized data (bss), and stack of the calling process are over‐
48 written according to the contents of the newly loaded program.
49 If the current program is being ptraced, a SIGTRAP signal is sent to it
51 after a successful execve().
52 If the set-user-ID bit is set on the program file referred to by path‐
54 name, then the effective user ID of the calling process is changed to
55 that of the owner of the program file. Similarly, if the set-group-ID
56 bit is set on the program file, then the effective group ID of the
57 calling process is set to the group of the program file.
58 The aforementioned transformations of the effective IDs are not per‐
60 formed (i.e., the set-user-ID and set-group-ID bits are ignored) if any
61 of the following is true:
62 * the no_new_privs attribute is set for the calling thread (see
64 prctl(2));
65 * the underlying filesystem is mounted nosuid (the MS_NOSUID flag for
67 mount(2)); or
68 * the calling process is being ptraced.
70 The capabilities of the program file (see capabilities(7)) are also
72 ignored if any of the above are true.
73 The effective user ID of the process is copied to the saved set-user-
75 ID; similarly, the effective group ID is copied to the saved set-group-
76 ID. This copying takes place after any effective ID changes that occur
77 because of the set-user-ID and set-group-ID mode bits.
78 The process's real UID and real GID, as well its supplementary group
80 IDs, are unchanged by a call to execve().
81 If the executable is an a.out dynamically linked binary executable con‐
83 taining shared-library stubs, the Linux dynamic linker ld.so(8) is
84 called at the start of execution to bring needed shared objects into
85 memory and link the executable with them.
86 If the executable is a dynamically linked ELF executable, the inter‐
88 preter named in the PT_INTERP segment is used to load the needed shared
89 objects. This interpreter is typically /lib/ld-linux.so.2 for binaries
90 linked with glibc (see ld-linux.so(8)).
91 Effect on process attributes
93 All process attributes are preserved during an execve(), except the
94 following:
95 * The dispositions of any signals that are being caught are reset to
97 the default (signal(7)).
98 * Any alternate signal stack is not preserved (sigaltstack(2)).
100 * Memory mappings are not preserved (mmap(2)).
102 * Attached System V shared memory segments are detached (shmat(2)).
104 * POSIX shared memory regions are unmapped (shm_open(3)).
106 * Open POSIX message queue descriptors are closed (mq_overview(7)).
108 * Any open POSIX named semaphores are closed (sem_overview(7)).
110 * POSIX timers are not preserved (timer_create(2)).
112 * Any open directory streams are closed (opendir(3)).
114 * Memory locks are not preserved (mlock(2), mlockall(2)).
116 * Exit handlers are not preserved (atexit(3), on_exit(3)).
118 * The floating-point environment is reset to the default (see
120 fenv(3)).
121 The process attributes in the preceding list are all specified in
123 POSIX.1. The following Linux-specific process attributes are also not
124 preserved during an execve():
125 * The process's "dumpable" attribute is set to the value 1, unless a
127 set-user-ID program, a set-group-ID program, or a program with capa‐
128 bilities is being executed, in which case the dumpable flag may
129 instead be reset to the value in /proc/sys/fs/suid_dumpable, in the
130 circumstances described under PR_SET_DUMPABLE in prctl(2). Note
131 that changes to the "dumpable" attribute may cause ownership of
132 files in the process's /proc/[pid] directory to change to root:root,
133 as described in proc(5).
134 * The prctl(2) PR_SET_KEEPCAPS flag is cleared.
136 * (Since Linux 2.4.36 / 2.6.23) If a set-user-ID or set-group-ID pro‐
138 gram is being executed, then the parent death signal set by prctl(2)
139 PR_SET_PDEATHSIG flag is cleared.
140 * The process name, as set by prctl(2) PR_SET_NAME (and displayed by
142 ps -o comm), is reset to the name of the new executable file.
143 * The SECBIT_KEEP_CAPS securebits flag is cleared. See capabili‐
145 ties(7).
146 * The termination signal is reset to SIGCHLD (see clone(2)).
148 * The file descriptor table is unshared, undoing the effect of the
150 CLONE_FILES flag of clone(2).
151 Note the following further points:
153 * All threads other than the calling thread are destroyed during an
155 execve(). Mutexes, condition variables, and other pthreads objects
156 are not preserved.
157 * The equivalent of setlocale(LC_ALL, "C") is executed at program
159 start-up.
160 * POSIX.1 specifies that the dispositions of any signals that are
162 ignored or set to the default are left unchanged. POSIX.1 specifies
163 one exception: if SIGCHLD is being ignored, then an implementation
164 may leave the disposition unchanged or reset it to the default;
165 Linux does the former.
166 * Any outstanding asynchronous I/O operations are canceled
168 (aio_read(3), aio_write(3)).
169 * For the handling of capabilities during execve(), see capabili‐
171 ties(7).
172 * By default, file descriptors remain open across an execve(). File
174 descriptors that are marked close-on-exec are closed; see the
175 description of FD_CLOEXEC in fcntl(2). (If a file descriptor is
176 closed, this will cause the release of all record locks obtained on
177 the underlying file by this process. See fcntl(2) for details.)
178 POSIX.1 says that if file descriptors 0, 1, and 2 would otherwise be
179 closed after a successful execve(), and the process would gain priv‐
180 ilege because the set-user-ID or set-group-ID mode bit was set on
181 the executed file, then the system may open an unspecified file for
182 each of these file descriptors. As a general principle, no portable
183 program, whether privileged or not, can assume that these three file
184 descriptors will remain closed across an execve().
185 Interpreter scripts
187 An interpreter script is a text file that has execute permission
188 enabled and whose first line is of the form:
189 #!interpreter [optional-arg]
191 The interpreter must be a valid pathname for an executable file.
193 If the pathname argument of execve() specifies an interpreter script,
195 then interpreter will be invoked with the following arguments:
196 interpreter [optional-arg] pathname arg...
198 where pathname is the absolute pathname of the file specified as the
200 first argument of execve(), and arg... is the series of words pointed
201 to by the argv argument of execve(), starting at argv[1]. Note that
202 there is no way to get the argv[0] that was passed to the execve()
203 call.
204 For portable use, optional-arg should either be absent, or be specified
206 as a single word (i.e., it should not contain white space); see NOTES
207 below.
208 Since Linux 2.6.28, the kernel permits the interpreter of a script to
210 itself be a script. This permission is recursive, up to a limit of
211 four recursions, so that the interpreter may be a script which is
212 interpreted by a script, and so on.
213 Limits on size of arguments and environment
215 Most UNIX implementations impose some limit on the total size of the
216 command-line argument (argv) and environment (envp) strings that may be
217 passed to a new program. POSIX.1 allows an implementation to advertise
218 this limit using the ARG_MAX constant (either defined in <limits.h> or
219 available at run time using the call sysconf(_SC_ARG_MAX)).
220 On Linux prior to kernel 2.6.23, the memory used to store the environ‐
222 ment and argument strings was limited to 32 pages (defined by the ker‐
223 nel constant MAX_ARG_PAGES). On architectures with a 4-kB page size,
224 this yields a maximum size of 128 kB.
225 On kernel 2.6.23 and later, most architectures support a size limit
227 derived from the soft RLIMIT_STACK resource limit (see getrlimit(2))
228 that is in force at the time of the execve() call. (Architectures with
229 no memory management unit are excepted: they maintain the limit that
230 was in effect before kernel 2.6.23.) This change allows programs to
231 have a much larger argument and/or environment list. For these archi‐
232 tectures, the total size is limited to 1/4 of the allowed stack size.
233 (Imposing the 1/4-limit ensures that the new program always has some
234 stack space.) Additionally, the total size is limited to 3/4 of the
235 value of the kernel constant _STK_LIM (8 Mibibytes). Since Linux
236 2.6.25, the kernel also places a floor of 32 pages on this size limit,
237 so that, even when RLIMIT_STACK is set very low, applications are guar‐
238 anteed to have at least as much argument and environment space as was
239 provided by Linux 2.6.23 and earlier. (This guarantee was not provided
240 in Linux 2.6.23 and 2.6.24.) Additionally, the limit per string is 32
241 pages (the kernel constant MAX_ARG_STRLEN), and the maximum number of
242 strings is 0x7FFFFFFF.
243
245 On success, execve() does not return, on error -1 is returned, and
246 errno is set appropriately.
247
249 E2BIG The total number of bytes in the environment (envp) and argument
250 list (argv) is too large.
251 EACCES Search permission is denied on a component of the path prefix of
253 pathname or the name of a script interpreter. (See also
254 path_resolution(7).)
255 EACCES The file or a script interpreter is not a regular file.
257 EACCES Execute permission is denied for the file or a script or ELF
259 interpreter.
260 EACCES The filesystem is mounted noexec.
262 EAGAIN (since Linux 3.1)
264 Having changed its real UID using one of the set*uid() calls,
265 the caller was—and is now still—above its RLIMIT_NPROC resource
266 limit (see setrlimit(2)). For a more detailed explanation of
267 this error, see NOTES.
268 EFAULT pathname or one of the pointers in the vectors argv or envp
270 points outside your accessible address space.
271 EINVAL An ELF executable had more than one PT_INTERP segment (i.e.,
273 tried to name more than one interpreter).
274 EIO An I/O error occurred.
276 EISDIR An ELF interpreter was a directory.
278 ELIBBAD
280 An ELF interpreter was not in a recognized format.
281 ELOOP Too many symbolic links were encountered in resolving pathname
283 or the name of a script or ELF interpreter.
284 ELOOP The maximum recursion limit was reached during recursive script
286 interpretation (see "Interpreter scripts", above). Before Linux
287 3.8, the error produced for this case was ENOEXEC.
288 EMFILE The per-process limit on the number of open file descriptors has
290 been reached.
291 ENAMETOOLONG
293 pathname is too long.
294 ENFILE The system-wide limit on the total number of open files has been
296 reached.
297 ENOENT The file pathname or a script or ELF interpreter does not exist.
299 ENOEXEC
301 An executable is not in a recognized format, is for the wrong
302 architecture, or has some other format error that means it can‐
303 not be executed.
304 ENOMEM Insufficient kernel memory was available.
306 ENOTDIR
308 A component of the path prefix of pathname or a script or ELF
309 interpreter is not a directory.
310 EPERM The filesystem is mounted nosuid, the user is not the superuser,
312 and the file has the set-user-ID or set-group-ID bit set.
313 EPERM The process is being traced, the user is not the superuser and
315 the file has the set-user-ID or set-group-ID bit set.
316 EPERM A "capability-dumb" applications would not obtain the full set
318 of permitted capabilities granted by the executable file. See
319 capabilities(7).
320 ETXTBSY
322 The specified executable was open for writing by one or more
323 processes.
324
326 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD. POSIX does not document the
327 #! behavior, but it exists (with some variations) on other UNIX sys‐
328 tems.
329
331 One sometimes sees execve() (and the related functions described in
332 exec(3)) described as "executing a new process" (or similar). This is
333 a highly misleading description: there is no new process; many
334 attributes of the calling process remain unchanged (in particular, its
335 PID). All that execve() does is arrange for an existing process (the
336 calling process) to execute a new program.
337 Set-user-ID and set-group-ID processes can not be ptrace(2)d.
339 The result of mounting a filesystem nosuid varies across Linux kernel
341 versions: some will refuse execution of set-user-ID and set-group-ID
342 executables when this would give the user powers they did not have
343 already (and return EPERM), some will just ignore the set-user-ID and
344 set-group-ID bits and exec() successfully.
345 On Linux, argv and envp can be specified as NULL. In both cases, this
347 has the same effect as specifying the argument as a pointer to a list
348 containing a single null pointer. Do not take advantage of this non‐
349 standard and nonportable misfeature! On many other UNIX systems, spec‐
350 ifying argv as NULL will result in an error (EFAULT). Some other UNIX
351 systems treat the envp==NULL case the same as Linux.
352 POSIX.1 says that values returned by sysconf(3) should be invariant
354 over the lifetime of a process. However, since Linux 2.6.23, if the
355 RLIMIT_STACK resource limit changes, then the value reported by
356 _SC_ARG_MAX will also change, to reflect the fact that the limit on
357 space for holding command-line arguments and environment variables has
358 changed.
359 In most cases where execve() fails, control returns to the original
361 executable image, and the caller of execve() can then handle the error.
362 However, in (rare) cases (typically caused by resource exhaustion),
363 failure may occur past the point of no return: the original executable
364 image has been torn down, but the new image could not be completely
365 built. In such cases, the kernel kills the process with a SIGSEGV
366 (SIGKILL until Linux 3.17) signal.
367 Interpreter scripts
369 The kernel imposes a maximum length on the text that follows the "#!"
370 characters at the start of a script; characters beyond the limit are
371 ignored. Before Linux 5.1, the limit is 127 characters. Since Linux
372 5.1, the limit is 255 characters.
373 The semantics of the optional-arg argument of an interpreter script
375 vary across implementations. On Linux, the entire string following the
376 interpreter name is passed as a single argument to the interpreter, and
377 this string can include white space. However, behavior differs on some
378 other systems. Some systems use the first white space to terminate
379 optional-arg. On some systems, an interpreter script can have multiple
380 arguments, and white spaces in optional-arg are used to delimit the
381 arguments.
382 Linux (like most other modern UNIX systems) ignores the set-user-ID and
384 set-group-ID bits on scripts.
385 execve() and EAGAIN
387 A more detailed explanation of the EAGAIN error that can occur (since
388 Linux 3.1) when calling execve() is as follows.
389 The EAGAIN error can occur when a preceding call to setuid(2),
391 setreuid(2), or setresuid(2) caused the real user ID of the process to
392 change, and that change caused the process to exceed its RLIMIT_NPROC
393 resource limit (i.e., the number of processes belonging to the new real
394 UID exceeds the resource limit). From Linux 2.6.0 to 3.0, this caused
395 the set*uid() call to fail. (Prior to 2.6, the resource limit was not
396 imposed on processes that changed their user IDs.)
397 Since Linux 3.1, the scenario just described no longer causes the
399 set*uid() call to fail, because it too often led to security holes
400 where buggy applications didn't check the return status and assumed
401 that—if the caller had root privileges—the call would always succeed.
402 Instead, the set*uid() calls now successfully change the real UID, but
403 the kernel sets an internal flag, named PF_NPROC_EXCEEDED, to note that
404 the RLIMIT_NPROC resource limit has been exceeded. If the
405 PF_NPROC_EXCEEDED flag is set and the resource limit is still exceeded
406 at the time of a subsequent execve() call, that call fails with the
407 error EAGAIN. This kernel logic ensures that the RLIMIT_NPROC resource
408 limit is still enforced for the common privileged daemon workflow—
409 namely, fork(2) + set*uid() + execve().
410 If the resource limit was not still exceeded at the time of the
412 execve() call (because other processes belonging to this real UID ter‐
413 minated between the set*uid() call and the execve() call), then the
414 execve() call succeeds and the kernel clears the PF_NPROC_EXCEEDED
415 process flag. The flag is also cleared if a subsequent call to fork(2)
416 by this process succeeds.
417 Historical
419 With UNIX V6, the argument list of an exec() call was ended by 0, while
420 the argument list of main was ended by -1. Thus, this argument list
421 was not directly usable in a further exec() call. Since UNIX V7, both
422 are NULL.
423
425 The following program is designed to be execed by the second program
426 below. It just echoes its command-line arguments, one per line.
427 /* myecho.c */
429 #include <stdio.h>
431 #include <stdlib.h>
432 int
434 main(int argc, char *argv[])
435 {
436 int j;
437 for (j = 0; j < argc; j++)
439 printf("argv[%d]: %s\n", j, argv[j]);
440 exit(EXIT_SUCCESS);
442 }
443 This program can be used to exec the program named in its command-line
445 argument:
446 /* execve.c */
448 #include <stdio.h>
450 #include <stdlib.h>
451 #include <unistd.h>
452 int
454 main(int argc, char *argv[])
455 {
456 char *newargv[] = { NULL, "hello", "world", NULL };
457 char *newenviron[] = { NULL };
458 if (argc != 2) {
460 fprintf(stderr, "Usage: %s <file-to-exec>\n", argv[0]);
461 exit(EXIT_FAILURE);
462 }
463 newargv[0] = argv[1];
465 execve(argv[1], newargv, newenviron);
467 perror("execve"); /* execve() returns only on error */
468 exit(EXIT_FAILURE);
469 }
470 We can use the second program to exec the first as follows:
472 $ cc myecho.c -o myecho
474 $ cc execve.c -o execve
475 $ ./execve ./myecho
476 argv[0]: ./myecho
477 argv[1]: hello
478 argv[2]: world
479 We can also use these programs to demonstrate the use of a script
481 interpreter. To do this we create a script whose "interpreter" is our
482 myecho program:
483 $ cat > script
485 #!./myecho script-arg
486 ^D
487 $ chmod +x script
488 We can then use our program to exec the script:
490 $ ./execve ./script
492 argv[0]: ./myecho
493 argv[1]: script-arg
494 argv[2]: ./script
495 argv[3]: hello
496 argv[4]: world
497
499 chmod(2), execveat(2), fork(2), get_robust_list(2), ptrace(2), exec(3),
500 fexecve(3), getopt(3), system(3), capabilities(7), credentials(7), env‐
501 iron(7), path_resolution(7), ld.so(8)
502
504 This page is part of release 5.07 of the Linux man-pages project. A
505 description of the project, information about reporting bugs, and the
506 latest version of this page, can be found at
507 https://www.kernel.org/doc/man-pages/.
508Linux 2020-04-11 EXECVE(2)