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