bsd/sys/resourcevar.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
  31 /*
  32  * Copyright (c) 1991, 1993
  33  *      The Regents of the University of California.  All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. All advertising materials mentioning features or use of this software
  44  *    must display the following acknowledgement:
  45  *      This product includes software developed by the University of
  46  *      California, Berkeley and its contributors.
  47  * 4. Neither the name of the University nor the names of its contributors
  48  *    may be used to endorse or promote products derived from this software
  49  *    without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61  * SUCH DAMAGE.
  62  *
  63  *      @(#)resourcevar.h       8.4 (Berkeley) 1/9/95
  64  */
  65
  66 #ifndef _SYS_RESOURCEVAR_H_
  67 #define _SYS_RESOURCEVAR_H_
  68
  69 #include <sys/appleapiopts.h>
  70
  71 #ifdef __APPLE_API_PRIVATE
  72 /*
  73  * Kernel per-process accounting / statistics
  74  * (not necessarily resident except when running).
  75  */
  76 struct pstats {
  77 #define pstat_startzero p_ru
  78         struct  rusage p_ru;            /* stats for this proc */
  79         struct  rusage p_cru;           /* sum of stats for reaped children */
  80
  81         struct uprof {                  /* profile arguments */
  82                 struct uprof *pr_next;  /* multiple prof buffers allowed */
  83                 caddr_t pr_base;        /* buffer base */
  84                 u_long  pr_size;        /* buffer size */
  85                 u_long  pr_off;         /* pc offset */
  86                 u_long  pr_scale;       /* pc scaling */
  87                 u_long  pr_addr;        /* temp storage for addr until AST */
  88                 u_long  pr_ticks;       /* temp storage for ticks until AST */
  89         } p_prof;
  90 #define pstat_endzero   pstat_startcopy
  91
  92 #define pstat_startcopy p_timer
  93         struct  itimerval p_timer[3];   /* virtual-time timers */
  94 #define pstat_endcopy   p_start
  95         struct  timeval p_start;        /* starting time */
  96 #ifdef KERNEL
  97         struct user_uprof {                         /* profile arguments */
  98                 struct user_uprof *pr_next;  /* multiple prof buffers allowed */
  99                 user_addr_t         pr_base;    /* buffer base */
 100                 user_size_t         pr_size;    /* buffer size */
 101                 user_ulong_t    pr_off;         /* pc offset */
 102                 user_ulong_t    pr_scale;       /* pc scaling */
 103                 user_ulong_t    pr_addr;        /* temp storage for addr until AST */
 104                 user_ulong_t    pr_ticks;       /* temp storage for ticks until AST */
 105         } user_p_prof;
 106 #endif // KERNEL
 107 };
 108
 109 /*
 110  * Kernel shareable process resource limits.  Because this structure
 111  * is moderately large but changes infrequently, it is normally
 112  * shared copy-on-write after forks.  If a group of processes
 113  * ("threads") share modifications, the PL_SHAREMOD flag is set,
 114  * and a copy must be made for the child of a new fork that isn't
 115  * sharing modifications to the limits.
 116  */
 117 struct plimit {
 118         struct  rlimit pl_rlimit[RLIM_NLIMITS];
 119 #define PL_SHAREMOD     0x01            /* modifications are shared */
 120         int     p_lflags;
 121         int     p_refcnt;               /* number of references */
 122 };
 123
 124 #ifdef KERNEL
 125 /* add user profiling from AST */
 126 #define ADDUPROF(p)                                                     \
 127     addupc_task(p,                                                      \
 128                 (proc_is64bit((p)) ? (p)->p_stats->user_p_prof.pr_addr \
 129                                    : CAST_USER_ADDR_T((p)->p_stats->p_prof.pr_addr)), \
 130                 (proc_is64bit((p)) ? (p)->p_stats->user_p_prof.pr_ticks \
 131                                    : (p)->p_stats->p_prof.pr_ticks))
 132
 133 void     addupc_intr(struct proc *p, u_long pc, u_int ticks);
 134 void     addupc_task(struct proc *p, user_addr_t pc, u_int ticks);
 135 void     calcru(struct proc *p, struct timeval *up, struct timeval *sp,
 136             struct timeval *ip);
 137 void     ruadd(struct rusage *ru, struct rusage *ru2);
 138 struct plimit *limcopy(struct plimit *lim);
 139 #endif /* KERNEL */
 140
 141 #endif /* __APPLE_API_PRIVATE */
 142
 143 #endif  /* !_SYS_RESOURCEVAR_H_ */