bsd/sys/proc.h

   1 /*
   2  * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
  29 /*-
  30  * Copyright (c) 1986, 1989, 1991, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  * (c) UNIX System Laboratories, Inc.
  33  * All or some portions of this file are derived from material licensed
  34  * to the University of California by American Telephone and Telegraph
  35  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  36  * the permission of UNIX System Laboratories, Inc.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by the University of
  49  *      California, Berkeley and its contributors.
  50  * 4. Neither the name of the University nor the names of its contributors
  51  *    may be used to endorse or promote products derived from this software
  52  *    without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  64  * SUCH DAMAGE.
  65  *
  66  *      @(#)proc.h      8.15 (Berkeley) 5/19/95
  67  */
  68
  69 #ifndef _SYS_PROC_H_
  70 #define _SYS_PROC_H_
  71
  72 #include <sys/appleapiopts.h>
  73 #include <sys/cdefs.h>
  74 #include <sys/select.h>                 /* For struct selinfo. */
  75 #include <sys/queue.h>
  76 #include <sys/lock.h>
  77 #include <sys/param.h>
  78 #include <sys/event.h>
  79 #ifdef KERNEL
  80 #include <sys/kernel_types.h>
  81 #include <uuid/uuid.h>
  82 #endif
  83 #include <mach/boolean.h>
  84
  85 #if defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL)
  86
  87 struct session;
  88 struct pgrp;
  89 struct proc;
  90
  91 /* Exported fields for kern sysctls */
  92 struct extern_proc {
  93         union {
  94                 struct {
  95                         struct  proc *__p_forw; /* Doubly-linked run/sleep queue. */
  96                         struct  proc *__p_back;
  97                 } p_st1;
  98                 struct timeval __p_starttime;   /* process start time */
  99         } p_un;
 100 #define p_forw p_un.p_st1.__p_forw
 101 #define p_back p_un.p_st1.__p_back
 102 #define p_starttime p_un.__p_starttime
 103         struct  vmspace *p_vmspace;     /* Address space. */
 104         struct  sigacts *p_sigacts;     /* Signal actions, state (PROC ONLY). */
 105         int     p_flag;                 /* P_* flags. */
 106         char    p_stat;                 /* S* process status. */
 107         pid_t   p_pid;                  /* Process identifier. */
 108         pid_t   p_oppid;         /* Save parent pid during ptrace. XXX */
 109         int     p_dupfd;         /* Sideways return value from fdopen. XXX */
 110         /* Mach related  */
 111         caddr_t user_stack;     /* where user stack was allocated */
 112         void    *exit_thread;   /* XXX Which thread is exiting? */
 113         int             p_debugger;             /* allow to debug */
 114         boolean_t       sigwait;        /* indication to suspend */
 115         /* scheduling */
 116         u_int   p_estcpu;        /* Time averaged value of p_cpticks. */
 117         int     p_cpticks;       /* Ticks of cpu time. */
 118         fixpt_t p_pctcpu;        /* %cpu for this process during p_swtime */
 119         void    *p_wchan;        /* Sleep address. */
 120         char    *p_wmesg;        /* Reason for sleep. */
 121         u_int   p_swtime;        /* Time swapped in or out. */
 122         u_int   p_slptime;       /* Time since last blocked. */
 123         struct  itimerval p_realtimer;  /* Alarm timer. */
 124         struct  timeval p_rtime;        /* Real time. */
 125         u_quad_t p_uticks;              /* Statclock hits in user mode. */
 126         u_quad_t p_sticks;              /* Statclock hits in system mode. */
 127         u_quad_t p_iticks;              /* Statclock hits processing intr. */
 128         int     p_traceflag;            /* Kernel trace points. */
 129         struct  vnode *p_tracep;        /* Trace to vnode. */
 130         int     p_siglist;              /* DEPRECATED. */
 131         struct  vnode *p_textvp;        /* Vnode of executable. */
 132         int     p_holdcnt;              /* If non-zero, don't swap. */
 133         sigset_t p_sigmask;     /* DEPRECATED. */
 134         sigset_t p_sigignore;   /* Signals being ignored. */
 135         sigset_t p_sigcatch;    /* Signals being caught by user. */
 136         u_char  p_priority;     /* Process priority. */
 137         u_char  p_usrpri;       /* User-priority based on p_cpu and p_nice. */
 138         char    p_nice;         /* Process "nice" value. */
 139         char    p_comm[MAXCOMLEN+1];
 140         struct  pgrp *p_pgrp;   /* Pointer to process group. */
 141         struct  user *p_addr;   /* Kernel virtual addr of u-area (PROC ONLY). */
 142         u_short p_xstat;        /* Exit status for wait; also stop signal. */
 143         u_short p_acflag;       /* Accounting flags. */
 144         struct  rusage *p_ru;   /* Exit information. XXX */
 145 };
 146
 147
 148 /* Status values. */
 149 #define SIDL    1               /* Process being created by fork. */
 150 #define SRUN    2               /* Currently runnable. */
 151 #define SSLEEP  3               /* Sleeping on an address. */
 152 #define SSTOP   4               /* Process debugging or suspension. */
 153 #define SZOMB   5               /* Awaiting collection by parent. */
 154
 155 /* These flags are kept in extern_proc.p_flag. */
 156 #define P_ADVLOCK       0x00000001      /* Process may hold POSIX adv. lock */
 157 #define P_CONTROLT      0x00000002      /* Has a controlling terminal */
 158 #define P_LP64          0x00000004      /* Process is LP64 */
 159 #define P_NOCLDSTOP     0x00000008      /* No SIGCHLD when children stop */
 160
 161 #define P_PPWAIT        0x00000010      /* Parent waiting for chld exec/exit */
 162 #define P_PROFIL        0x00000020      /* Has started profiling */
 163 #define P_SELECT        0x00000040      /* Selecting; wakeup/waiting danger */
 164 #define P_CONTINUED     0x00000080      /* Process was stopped and continued */
 165
 166 #define P_SUGID         0x00000100      /* Has set privileges since last exec */
 167 #define P_SYSTEM        0x00000200      /* Sys proc: no sigs, stats or swap */
 168 #define P_TIMEOUT       0x00000400      /* Timing out during sleep */
 169 #define P_TRACED        0x00000800      /* Debugged process being traced */
 170
 171 #define P_DISABLE_ASLR  0x00001000      /* Disable address space layout randomization */
 172 #define P_WEXIT         0x00002000      /* Working on exiting */
 173 #define P_EXEC          0x00004000      /* Process called exec. */
 174
 175 /* Should be moved to machine-dependent areas. */
 176 #define P_OWEUPC        0x00008000      /* Owe process an addupc() call at next ast. */
 177
 178 #define P_AFFINITY      0x00010000      /* xxx */
 179 #define P_TRANSLATED    0x00020000      /* xxx */
 180 #define P_CLASSIC       P_TRANSLATED    /* xxx */
 181 /*
 182 #define P_FSTRACE       0x10000 / * tracing via file system (elsewhere?) * /
 183 #define P_SSTEP         0x20000 / * process needs single-step fixup ??? * /
 184 */
 185
 186 #define P_DELAYIDLESLEEP 0x00040000     /* Process is marked to delay idle sleep on disk IO */
 187 #define P_CHECKOPENEVT  0x00080000      /* check if a vnode has the OPENEVT flag set on open */
 188
 189 #define P_DEPENDENCY_CAPABLE    0x00100000      /* process is ok to call vfs_markdependency() */
 190 #define P_REBOOT        0x00200000      /* Process called reboot() */
 191 #define P_RESV6         0x00400000      /* used to be P_TBE */
 192 #define P_RESV7         0x00800000      /* (P_SIGEXC)signal exceptions */
 193
 194 #define P_THCWD         0x01000000      /* process has thread cwd  */
 195 #define P_RESV9         0x02000000      /* (P_VFORK)process has vfork children */
 196 #define P_RESV10        0x04000000      /* used to be P_NOATTACH */
 197 #define P_RESV11        0x08000000      /* (P_INVFORK) proc in vfork */
 198
 199 #define P_NOSHLIB       0x10000000      /* no shared libs are in use for proc */
 200                                         /* flag set on exec */
 201 #define P_FORCEQUOTA    0x20000000      /* Force quota for root */
 202 #define P_NOCLDWAIT     0x40000000      /* No zombies when chil procs exit */
 203 #define P_NOREMOTEHANG  0x80000000      /* Don't hang on remote FS ops */
 204
 205 #define P_INMEM         0               /* Obsolete: retained for compilation */
 206 #define P_NOSWAP        0               /* Obsolete: retained for compilation */
 207 #define P_PHYSIO        0               /* Obsolete: retained for compilation */
 208 #define P_FSTRACE       0               /* Obsolete: retained for compilation */
 209 #define P_SSTEP         0               /* Obsolete: retained for compilation */
 210
 211 #define P_DIRTY_TRACK                           0x00000001      /* track dirty state */
 212 #define P_DIRTY_ALLOW_IDLE_EXIT                 0x00000002      /* process can be idle-exited when clean */
 213 #define P_DIRTY_DEFER                           0x00000004      /* defer initial opt-in to idle-exit */
 214 #define P_DIRTY                                 0x00000008      /* process is dirty */
 215 #define P_DIRTY_SHUTDOWN                        0x00000010      /* process is dirty during shutdown */
 216 #define P_DIRTY_TERMINATED                      0x00000020      /* process has been marked for termination */
 217 #define P_DIRTY_BUSY                            0x00000040      /* serialization flag */
 218 #define P_DIRTY_MARKED                          0x00000080      /* marked dirty previously */
 219 #define P_DIRTY_DEFER_IN_PROGRESS               0x00000100      /* deferral to idle-band in process */
 220 #define P_DIRTY_LAUNCH_IN_PROGRESS              0x00000200      /* launch is in progress */
 221
 222 #define P_DIRTY_IS_DIRTY                        (P_DIRTY | P_DIRTY_SHUTDOWN)
 223 #define P_DIRTY_IDLE_EXIT_ENABLED               (P_DIRTY_TRACK|P_DIRTY_ALLOW_IDLE_EXIT)
 224
 225 #endif /* XNU_KERNEL_PRIVATE || !KERNEL */
 226
 227 #ifdef KERNEL
 228 __BEGIN_DECLS
 229
 230 extern proc_t kernproc;
 231
 232 extern int proc_is_classic(proc_t p);
 233 proc_t current_proc_EXTERNAL(void);
 234
 235 extern int      msleep(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, struct timespec * ts );
 236 extern void     wakeup(void *chan);
 237 extern void wakeup_one(caddr_t chan);
 238
 239 /* proc kpis */
 240 /* this routine returns the pid of the current process */
 241 extern int proc_selfpid(void);
 242 /* this routine returns the pid of the parent of the current process */
 243 extern int proc_selfppid(void);
 244 /* this routine returns sends a signal signum to the process identified by the pid */
 245 extern void proc_signal(int pid, int signum);
 246 /* this routine checks whether any signal identified by the mask are pending in the  process identified by the pid. The check is  on all threads of the process. */
 247 extern int proc_issignal(int pid, sigset_t mask);
 248 /* this routine returns 1 if the pid1 is inferior of pid2 */
 249 extern int proc_isinferior(int pid1, int pid2);
 250 /* this routine copies the process's name of the executable to the passed in buffer. It
 251  * is always null terminated. The size of the buffer is to be passed in as well. This
 252  * routine is to be used typically for debugging
 253  */
 254 void proc_name(int pid, char * buf, int size);
 255 /* This routine is simillar to proc_name except it returns for current process */
 256 void proc_selfname(char * buf, int size);
 257
 258 /* find a process with a given pid. This comes with a reference which needs to be dropped by proc_rele */
 259 extern proc_t proc_find(int pid);
 260 /* returns a handle to current process which is referenced. The reference needs to be dropped with proc_rele */
 261 extern proc_t proc_self(void);
 262 /* releases the held reference on the process */
 263 extern int proc_rele(proc_t p);
 264 /* returns the pid of the given process */
 265 extern int proc_pid(proc_t);
 266 /* returns the pid of the parent of a given process */
 267 extern int proc_ppid(proc_t);
 268 /* returns 1 if the process is marked for no remote hangs */
 269 extern int proc_noremotehang(proc_t);
 270 /* returns 1 if the process is marked for force quota */
 271 extern int proc_forcequota(proc_t);
 272
 273 /* this routine returns 1 if the process is running with 64bit address space, else 0 */
 274 extern int proc_is64bit(proc_t);
 275 /* is this process exiting? */
 276 extern int proc_exiting(proc_t);
 277 /* this routine returns error if the process is not one with super user privileges */
 278 int proc_suser(proc_t p);
 279 /* returns the cred assicaited with the process; temporary api */
 280 kauth_cred_t proc_ucred(proc_t p);
 281
 282 extern int proc_tbe(proc_t);
 283
 284 /*!
 285  @function proc_selfpgrpid
 286  @abstract Get the process group id for the current process, as with proc_pgrpid().
 287  @return pgrpid of current process.
 288  */
 289 pid_t proc_selfpgrpid(void);
 290
 291 /*!
 292  @function proc_pgrpid
 293  @abstract Get the process group id for the passed-in process.
 294  @param p Process whose pgrpid to grab.
 295  @return pgrpid for "p".
 296  */
 297 pid_t proc_pgrpid(proc_t);
 298
 299 #ifdef KERNEL_PRIVATE
 300 // mark a process as being allowed to call vfs_markdependency()
 301 void bsd_set_dependency_capable(task_t task);
 302 extern int IS_64BIT_PROCESS(proc_t);
 303
 304 extern int      tsleep(void *chan, int pri, const char *wmesg, int timo);
 305 extern int      msleep1(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, u_int64_t timo);
 306
 307 task_t proc_task(proc_t);
 308 extern int proc_pidversion(proc_t);
 309 extern int proc_getcdhash(proc_t, unsigned char *);
 310
 311 /*!
 312  @function    proc_pidbackgrounded
 313  @abstract    KPI to determine if a process is currently backgrounded.
 314  @discussion  The process may move into or out of background state at any time,
 315               so be prepared for this value to be outdated immediately.
 316  @param pid   PID of the process to be queried.
 317  @param state Pointer to a value which will be set to 1 if the process
 318               is currently backgrounded, 0 otherwise.
 319  @return      ESRCH if pid cannot be found or has started exiting.
 320
 321               EINVAL if state is NULL.
 322  */
 323 extern int proc_pidbackgrounded(pid_t pid, uint32_t* state);
 324
 325 /*
 326  * This returns an unique 64bit id of a given process.
 327  * Caller needs to hold proper reference on the
 328  * passed in process strucutre.
 329  */
 330 extern uint64_t proc_uniqueid(proc_t);
 331
 332 #endif /* KERNEL_PRIVATE */
 333
 334 #ifdef XNU_KERNEL_PRIVATE
 335
 336 /* unique 64bit id for process's original parent */
 337 extern uint64_t proc_puniqueid(proc_t);
 338
 339 extern void proc_getexecutableuuid(proc_t, unsigned char *, unsigned long);
 340 extern int proc_get_originatorbgstate(uint32_t *is_backgrounded);
 341
 342 /* Kernel interface to get the uuid of the originator of the work.*/
 343 extern int proc_pidoriginatoruuid(uuid_t uuid_buf, uint32_t buffersize);
 344
 345 extern uint64_t proc_was_throttled(proc_t);
 346 extern uint64_t proc_did_throttle(proc_t);
 347
 348 extern uint64_t proc_coalitionid(proc_t);
 349
 350 #endif /* XNU_KERNEL_PRIVATE*/
 351
 352 #ifdef KERNEL_PRIVATE
 353 extern vnode_t proc_getexecutablevnode(proc_t); /* Returned with iocount, use vnode_put() to drop */
 354 #endif
 355
 356 __END_DECLS
 357
 358 #endif  /* KERNEL */
 359
 360 #ifdef PRIVATE
 361
 362 /* Values for pid_shutdown_sockets */
 363 #ifdef KERNEL
 364 #define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_INTERNAL       0x0
 365 #endif /* KERNEL */
 366 #define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_SVC            0x1
 367 #define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_ALL            0x2
 368
 369 #ifndef KERNEL
 370
 371 __BEGIN_DECLS
 372
 373 int pid_suspend(int pid);
 374 int pid_resume(int pid);
 375
 376
 377 __END_DECLS
 378
 379 #endif /* !KERNEL */
 380 #endif /* PRIVATE */
 381
 382 #endif  /* !_SYS_PROC_H_ */