lib/libc/sys/execve.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)execve.2    8.5 (Berkeley) 6/1/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 1, 1994
  32 .Dt EXECVE 2
  33 .Os
  34 .Sh NAME
  35 .Nm execve
  36 .Nd execute a file
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In unistd.h
  41 .Ft int
  42 .Fn execve "const char *path" "char *const argv[]" "char *const envp[]"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn execve
  46 system call
  47 transforms the calling process into a new process.
  48 The new process is constructed from an ordinary file,
  49 whose name is pointed to by
  50 .Fa path ,
  51 called the
  52 .Em new process file .
  53 This file is either an executable object file,
  54 or a file of data for an interpreter.
  55 An executable object file consists of an identifying header,
  56 followed by pages of data representing the initial program (text)
  57 and initialized data pages.
  58 Additional pages may be specified
  59 by the header to be initialized with zero data; see
  60 .Xr elf 5
  61 and
  62 .Xr a.out 5 .
  63 .Pp
  64 An interpreter file begins with a line of the form:
  65 .Pp
  66 .Bd -ragged -offset indent -compact
  67 .Sy \&#!
  68 .Em interpreter
  69 .Bq Em arg
  70 .Ed
  71 .Pp
  72 When an interpreter file is
  73 .Sy execve Ap d ,
  74 the system actually
  75 .Sy execve Ap s
  76 the specified
  77 .Em interpreter .
  78 If the optional
  79 .Em arg
  80 is specified, it becomes the first argument to the
  81 .Em interpreter ,
  82 and the name of the originally
  83 .Sy execve Ap d
  84 file becomes the second argument;
  85 otherwise, the name of the originally
  86 .Sy execve Ap d
  87 file becomes the first argument.
  88 The original arguments are shifted over to
  89 become the subsequent arguments.
  90 The zeroth argument is set to the specified
  91 .Em interpreter .
  92 .Pp
  93 The argument
  94 .Fa argv
  95 is a pointer to a null-terminated array of
  96 character pointers to null-terminated character strings.
  97 These strings construct the argument list to be made available to the new
  98 process.
  99 At least one argument must be present in
 100 the array; by custom, the first element should be
 101 the name of the executed program (for example, the last component of
 102 .Fa path ) .
 103 .Pp
 104 The argument
 105 .Fa envp
 106 is also a pointer to a null-terminated array of
 107 character pointers to null-terminated strings.
 108 A pointer to this array is normally stored in the global variable
 109 .Va environ .
 110 These strings pass information to the
 111 new process that is not directly an argument to the command (see
 112 .Xr environ 7 ) .
 113 .Pp
 114 File descriptors open in the calling process image remain open in
 115 the new process image, except for those for which the close-on-exec
 116 flag is set (see
 117 .Xr close 2
 118 and
 119 .Xr fcntl 2 ) .
 120 Descriptors that remain open are unaffected by
 121 .Fn execve .
 122 If any of the standard descriptors (0, 1, and/or 2) are closed at the
 123 time
 124 .Fn execve
 125 is called, and the process will gain privilege as a result of set-id
 126 semantics, those descriptors will be re-opened automatically.
 127 No programs, whether privileged or not, should assume that these descriptors
 128 will remain closed across a call to
 129 .Fn execve .
 130 .Pp
 131 Signals set to be ignored in the calling process are set to be ignored in
 132 the
 133 new process.
 134 Signals which are set to be caught in the calling process image
 135 are set to default action in the new process image.
 136 Blocked signals remain blocked regardless of changes to the signal action.
 137 The signal stack is reset to be undefined (see
 138 .Xr sigaction 2
 139 for more information).
 140 .Pp
 141 If the set-user-ID mode bit of the new process image file is set
 142 (see
 143 .Xr chmod 2 ) ,
 144 the effective user ID of the new process image is set to the owner ID
 145 of the new process image file.
 146 If the set-group-ID mode bit of the new process image file is set,
 147 the effective group ID of the new process image is set to the group ID
 148 of the new process image file.
 149 (The effective group ID is the first element of the group list.)
 150 The real user ID, real group ID and
 151 other group IDs of the new process image remain the same as the calling
 152 process image.
 153 After any set-user-ID and set-group-ID processing,
 154 the effective user ID is recorded as the saved set-user-ID,
 155 and the effective group ID is recorded as the saved set-group-ID.
 156 These values may be used in changing the effective IDs later (see
 157 .Xr setuid 2 ) .
 158 .Pp
 159 The set-ID bits are not honored if the respective file system has the
 160 .Cm nosuid
 161 option enabled or if the new process file is an interpreter file.
 162 Syscall
 163 tracing is disabled if effective IDs are changed.
 164 .Pp
 165 The new process also inherits the following attributes from
 166 the calling process:
 167 .Pp
 168 .Bl -column parent_process_ID -offset indent -compact
 169 .It process ID Ta see Xr getpid 2
 170 .It parent process ID Ta see Xr getppid 2
 171 .It process group ID Ta see Xr getpgrp 2
 172 .It access groups Ta see Xr getgroups 2
 173 .It working directory Ta see Xr chdir 2
 174 .It root directory Ta see Xr chroot 2
 175 .It control terminal Ta see Xr termios 4
 176 .It resource usages Ta see Xr getrusage 2
 177 .It interval timers Ta see Xr getitimer 2
 178 .It resource limits Ta see Xr getrlimit 2
 179 .It file mode mask Ta see Xr umask 2
 180 .It signal mask Ta see Xr sigvec 2 ,
 181 .Xr sigsetmask 2
 182 .El
 183 .Pp
 184 When a program is executed as a result of an
 185 .Fn execve
 186 system call, it is entered as follows:
 187 .Bd -literal -offset indent
 188 main(argc, argv, envp)
 189 int argc;
 190 char **argv, **envp;
 191 .Ed
 192 .Pp
 193 where
 194 .Fa argc
 195 is the number of elements in
 196 .Fa argv
 197 (the ``arg count'')
 198 and
 199 .Fa argv
 200 points to the array of character pointers
 201 to the arguments themselves.
 202 .Sh RETURN VALUES
 203 As the
 204 .Fn execve
 205 system call overlays the current process image
 206 with a new process image the successful call
 207 has no process to return to.
 208 If
 209 .Fn execve
 210 does return to the calling process an error has occurred; the
 211 return value will be -1 and the global variable
 212 .Va errno
 213 is set to indicate the error.
 214 .Sh ERRORS
 215 The
 216 .Fn execve
 217 system call
 218 will fail and return to the calling process if:
 219 .Bl -tag -width Er
 220 .It Bq Er ENOTDIR
 221 A component of the path prefix is not a directory.
 222 .It Bq Er ENAMETOOLONG
 223 A component of a pathname exceeded 255 characters,
 224 or an entire path name exceeded 1023 characters.
 225 .It Bq Er ENAMETOOLONG
 226 When invoking an interpreted script, the interpreter name
 227 exceeds
 228 .Dv MAXSHELLCMDLEN
 229 characters.
 230 .It Bq Er ENOENT
 231 The new process file does not exist.
 232 .It Bq Er ELOOP
 233 Too many symbolic links were encountered in translating the pathname.
 234 .It Bq Er EACCES
 235 Search permission is denied for a component of the path prefix.
 236 .It Bq Er EACCES
 237 The new process file is not an ordinary file.
 238 .It Bq Er EACCES
 239 The new process file mode denies execute permission.
 240 .It Bq Er ENOEXEC
 241 The new process file has the appropriate access
 242 permission, but has an invalid magic number in its header.
 243 .It Bq Er ETXTBSY
 244 The new process file is a pure procedure (shared text)
 245 file that is currently open for writing or reading by some process.
 246 .It Bq Er ENOMEM
 247 The new process requires more virtual memory than
 248 is allowed by the imposed maximum
 249 .Pq Xr getrlimit 2 .
 250 .It Bq Er E2BIG
 251 The number of bytes in the new process' argument list
 252 is larger than the system-imposed limit.
 253 This limit is specified by the
 254 .Xr sysctl 3
 255 MIB variable
 256 .Dv KERN_ARGMAX .
 257 .It Bq Er EFAULT
 258 The new process file is not as long as indicated by
 259 the size values in its header.
 260 .It Bq Er EFAULT
 261 The
 262 .Fa path ,
 263 .Fa argv ,
 264 or
 265 .Fa envp
 266 arguments
 267 point
 268 to an illegal address.
 269 .It Bq Er EIO
 270 An I/O error occurred while reading from the file system.
 271 .El
 272 .Sh CAVEAT
 273 If a program is
 274 .Em setuid
 275 to a non-super-user, but is executed when
 276 the real
 277 .Em uid
 278 is ``root'', then the program has some of the powers
 279 of a super-user as well.
 280 .Sh SEE ALSO
 281 .Xr ktrace 1 ,
 282 .Xr _exit 2 ,
 283 .Xr fork 2 ,
 284 .Xr execl 3 ,
 285 .Xr exit 3 ,
 286 .Xr sysctl 3 ,
 287 .Xr a.out 5 ,
 288 .Xr elf 5 ,
 289 .Xr environ 7 ,
 290 .Xr mount 8
 291 .Sh STANDARDS
 292 The
 293 .Fn execve
 294 system call conforms to
 295 .St -p1003.1-2001 ,
 296 with the exception of reopening descriptors 0, 1, and/or 2 in certain
 297 circumstances.
 298 A future update of the Standard is expected to require this behavior,
 299 and it may become the default for non-privileged processes as well.
 300 .\" NB: update this caveat when TC1 is blessed.
 301 The support for executing interpreted programs is an extension.
 302 .Sh HISTORY
 303 The
 304 .Fn execve
 305 system call appeared in
 306 .Bx 4.2 .