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 April 10, 2008
  32 .Dt EXECVE 2
  33 .Os
  34 .Sh NAME
  35 .Nm execve ,
  36 .Nm fexecve
  37 .Nd execute a file
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft int
  43 .Fn execve "const char *path" "char *const argv[]" "char *const envp[]"
  44 .Ft int
  45 .Fn fexecve "int fd" "char *const argv[]" "char *const envp[]"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn execve
  49 system call
  50 transforms the calling process into a new process.
  51 The new process is constructed from an ordinary file,
  52 whose name is pointed to by
  53 .Fa path ,
  54 called the
  55 .Em new process file .
  56 The
  57 .Fn fexecve
  58 system call is equivalent to
  59 .Fn execve
  60 except that the file to be executed is determined by the file
  61 descriptor
  62 .Fa fd
  63 instead of a
  64 .Fa path .
  65 This file is either an executable object file,
  66 or a file of data for an interpreter.
  67 An executable object file consists of an identifying header,
  68 followed by pages of data representing the initial program (text)
  69 and initialized data pages.
  70 Additional pages may be specified
  71 by the header to be initialized with zero data; see
  72 .Xr elf 5
  73 and
  74 .Xr a.out 5 .
  75 .Pp
  76 An interpreter file begins with a line of the form:
  77 .Pp
  78 .Bd -ragged -offset indent -compact
  79 .Sy \&#!
  80 .Em interpreter
  81 .Bq Em arg
  82 .Ed
  83 .Pp
  84 When an interpreter file is
  85 .Sy execve Ap d ,
  86 the system actually
  87 .Sy execve Ap s
  88 the specified
  89 .Em interpreter .
  90 If the optional
  91 .Em arg
  92 is specified, it becomes the first argument to the
  93 .Em interpreter ,
  94 and the name of the originally
  95 .Sy execve Ap d
  96 file becomes the second argument;
  97 otherwise, the name of the originally
  98 .Sy execve Ap d
  99 file becomes the first argument.
 100 The original arguments are shifted over to
 101 become the subsequent arguments.
 102 The zeroth argument is set to the specified
 103 .Em interpreter .
 104 .Pp
 105 The argument
 106 .Fa argv
 107 is a pointer to a null-terminated array of
 108 character pointers to null-terminated character strings.
 109 These strings construct the argument list to be made available to the new
 110 process.
 111 At least one argument must be present in
 112 the array; by custom, the first element should be
 113 the name of the executed program (for example, the last component of
 114 .Fa path ) .
 115 .Pp
 116 The argument
 117 .Fa envp
 118 is also a pointer to a null-terminated array of
 119 character pointers to null-terminated strings.
 120 A pointer to this array is normally stored in the global variable
 121 .Va environ .
 122 These strings pass information to the
 123 new process that is not directly an argument to the command (see
 124 .Xr environ 7 ) .
 125 .Pp
 126 File descriptors open in the calling process image remain open in
 127 the new process image, except for those for which the close-on-exec
 128 flag is set (see
 129 .Xr close 2
 130 and
 131 .Xr fcntl 2 ) .
 132 Descriptors that remain open are unaffected by
 133 .Fn execve .
 134 If any of the standard descriptors (0, 1, and/or 2) are closed at the
 135 time
 136 .Fn execve
 137 is called, and the process will gain privilege as a result of set-id
 138 semantics, those descriptors will be re-opened automatically.
 139 No programs, whether privileged or not, should assume that these descriptors
 140 will remain closed across a call to
 141 .Fn execve .
 142 .Pp
 143 Signals set to be ignored in the calling process are set to be ignored in
 144 the
 145 new process.
 146 Signals which are set to be caught in the calling process image
 147 are set to default action in the new process image.
 148 Blocked signals remain blocked regardless of changes to the signal action.
 149 The signal stack is reset to be undefined (see
 150 .Xr sigaction 2
 151 for more information).
 152 .Pp
 153 If the set-user-ID mode bit of the new process image file is set
 154 (see
 155 .Xr chmod 2 ) ,
 156 the effective user ID of the new process image is set to the owner ID
 157 of the new process image file.
 158 If the set-group-ID mode bit of the new process image file is set,
 159 the effective group ID of the new process image is set to the group ID
 160 of the new process image file.
 161 (The effective group ID is the first element of the group list.)
 162 The real user ID, real group ID and
 163 other group IDs of the new process image remain the same as the calling
 164 process image.
 165 After any set-user-ID and set-group-ID processing,
 166 the effective user ID is recorded as the saved set-user-ID,
 167 and the effective group ID is recorded as the saved set-group-ID.
 168 These values may be used in changing the effective IDs later (see
 169 .Xr setuid 2 ) .
 170 .Pp
 171 The set-ID bits are not honored if the respective file system has the
 172 .Cm nosuid
 173 option enabled or if the new process file is an interpreter file.
 174 Syscall
 175 tracing is disabled if effective IDs are changed.
 176 .Pp
 177 The new process also inherits the following attributes from
 178 the calling process:
 179 .Pp
 180 .Bl -column parent_process_ID -offset indent -compact
 181 .It process ID Ta see Xr getpid 2
 182 .It parent process ID Ta see Xr getppid 2
 183 .It process group ID Ta see Xr getpgrp 2
 184 .It access groups Ta see Xr getgroups 2
 185 .It working directory Ta see Xr chdir 2
 186 .It root directory Ta see Xr chroot 2
 187 .It control terminal Ta see Xr termios 4
 188 .It resource usages Ta see Xr getrusage 2
 189 .It interval timers Ta see Xr getitimer 2
 190 .It resource limits Ta see Xr getrlimit 2
 191 .It file mode mask Ta see Xr umask 2
 192 .It signal mask Ta see Xr sigvec 2 ,
 193 .Xr sigsetmask 2
 194 .El
 195 .Pp
 196 When a program is executed as a result of an
 197 .Fn execve
 198 system call, it is entered as follows:
 199 .Bd -literal -offset indent
 200 main(argc, argv, envp)
 201 int argc;
 202 char **argv, **envp;
 203 .Ed
 204 .Pp
 205 where
 206 .Fa argc
 207 is the number of elements in
 208 .Fa argv
 209 (the ``arg count'')
 210 and
 211 .Fa argv
 212 points to the array of character pointers
 213 to the arguments themselves.
 214 .Pp
 215 The
 216 .Fn fexecve
 217 ignores the file offset of
 218 .Fa fd .
 219 Since execute permission is checked by
 220 .Fn fexecve ,
 221 the file descriptor
 222 .Fa fd
 223 need not have been opened with the
 224 .Dv O_EXEC
 225 flag.
 226 However, if the file to be executed denies read permission for the process
 227 preparing to do the exec, the only way to provide the
 228 .Fa fd
 229 to
 230 .Fn fexecve
 231 is to use the
 232 .Dv O_EXEC
 233 flag when opening
 234 .Fa fd .
 235 Note that the file to be executed can not be open for writing.
 236 .Sh RETURN VALUES
 237 As the
 238 .Fn execve
 239 system call overlays the current process image
 240 with a new process image the successful call
 241 has no process to return to.
 242 If
 243 .Fn execve
 244 does return to the calling process an error has occurred; the
 245 return value will be -1 and the global variable
 246 .Va errno
 247 is set to indicate the error.
 248 .Sh ERRORS
 249 The
 250 .Fn execve
 251 system call
 252 will fail and return to the calling process if:
 253 .Bl -tag -width Er
 254 .It Bq Er ENOTDIR
 255 A component of the path prefix is not a directory.
 256 .It Bq Er ENAMETOOLONG
 257 A component of a pathname exceeded 255 characters,
 258 or an entire path name exceeded 1023 characters.
 259 .It Bq Er ENAMETOOLONG
 260 When invoking an interpreted script, the interpreter name
 261 exceeds
 262 .Dv MAXSHELLCMDLEN
 263 characters.
 264 .It Bq Er ENOENT
 265 The new process file does not exist.
 266 .It Bq Er ELOOP
 267 Too many symbolic links were encountered in translating the pathname.
 268 .It Bq Er EACCES
 269 Search permission is denied for a component of the path prefix.
 270 .It Bq Er EACCES
 271 The new process file is not an ordinary file.
 272 .It Bq Er EACCES
 273 The new process file mode denies execute permission.
 274 .It Bq Er ENOEXEC
 275 The new process file has the appropriate access
 276 permission, but has an invalid magic number in its header.
 277 .It Bq Er ETXTBSY
 278 The new process file is a pure procedure (shared text)
 279 file that is currently open for writing by some process.
 280 .It Bq Er ENOMEM
 281 The new process requires more virtual memory than
 282 is allowed by the imposed maximum
 283 .Pq Xr getrlimit 2 .
 284 .It Bq Er E2BIG
 285 The number of bytes in the new process' argument list
 286 is larger than the system-imposed limit.
 287 This limit is specified by the
 288 .Xr sysctl 3
 289 MIB variable
 290 .Dv KERN_ARGMAX .
 291 .It Bq Er EFAULT
 292 The new process file is not as long as indicated by
 293 the size values in its header.
 294 .It Bq Er EFAULT
 295 The
 296 .Fa path ,
 297 .Fa argv ,
 298 or
 299 .Fa envp
 300 arguments
 301 point
 302 to an illegal address.
 303 .It Bq Er EIO
 304 An I/O error occurred while reading from the file system.
 305 .El
 306 .Pp
 307 In addition, the
 308 .Fn fexecve
 309 will fail and return to the calling process if:
 310 .Bl -tag -width Er
 311 .It Bq Er EBADF
 312 The
 313 .Fa fd
 314 argument is not a valid file descriptor open for executing.
 315 .El
 316 .Sh CAVEATS
 317 If a program is
 318 .Em setuid
 319 to a non-super-user, but is executed when
 320 the real
 321 .Em uid
 322 is ``root'', then the program has some of the powers
 323 of a super-user as well.
 324 .Pp
 325 When executing an interpreted program through
 326 .Fn fexecve ,
 327 kernel supplies
 328 .Pa /dev/fd/n
 329 as a second argument to the interpreter,
 330 where
 331 .Ar n
 332 is the file descriptor passed in the
 333 .Fa fd
 334 argument to
 335 .Fn fexecve .
 336 For this construction to work correctly, the
 337 .Xr fdescfs 5
 338 filesystem shall be mounted on
 339 .Pa /dev/fd .
 340 .Sh SEE ALSO
 341 .Xr ktrace 1 ,
 342 .Xr _exit 2 ,
 343 .Xr fork 2 ,
 344 .Xr open 2 ,
 345 .Xr execl 3 ,
 346 .Xr exit 3 ,
 347 .Xr sysctl 3 ,
 348 .Xr a.out 5 ,
 349 .Xr elf 5 ,
 350 .Xr fdescfs 5 ,
 351 .Xr environ 7 ,
 352 .Xr mount 8
 353 .Sh STANDARDS
 354 The
 355 .Fn execve
 356 system call conforms to
 357 .St -p1003.1-2001 ,
 358 with the exception of reopening descriptors 0, 1, and/or 2 in certain
 359 circumstances.
 360 A future update of the Standard is expected to require this behavior,
 361 and it may become the default for non-privileged processes as well.
 362 .\" NB: update this caveat when TC1 is blessed.
 363 The support for executing interpreted programs is an extension.
 364 The
 365 .Fn fexecve
 366 system call conforms to The Open Group Extended API Set 2 specification.
 367 .Sh HISTORY
 368 The
 369 .Fn execve
 370 system call appeared in
 371 .Bx 4.2 .
 372 The
 373 .Fn fexecve
 374 system call appeared in
 375 .Fx 8.0 .