[apple/xnu.git] / bsd / sys / resourcevar.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)resourcevar.h	8.4 (Berkeley) 1/9/95
 */

#ifndef	_SYS_RESOURCEVAR_H_
#define	_SYS_RESOURCEVAR_H_

#include <sys/appleapiopts.h>

/*
 * Kernel per-process accounting / statistics
 * (not necessarily resident except when running).
 */
struct pstats {
	struct	rusage            p_ru;		/* stats for this proc */
	struct	rusage            p_cru;	/* (PL) sum of stats for reaped children */

	struct uprof {			/* profile arguments */
		struct uprof *pr_next;  /* multiple prof buffers allowed */
		caddr_t	pr_base;	/* buffer base */
		u_int32_t	pr_size;	/* buffer size */
		u_int32_t	pr_off;		/* pc offset */
		u_int32_t	pr_scale;	/* pc scaling */
		u_int32_t	pr_addr;	/* temp storage for addr until AST */
		u_int32_t	pr_ticks;	/* temp storage for ticks until AST */
	} p_prof;
	
	uint64_t ps_start;       	/* starting time ; compat only */
#ifdef KERNEL
	struct  rusage_info_child ri_child; 	/* (PL) sum of additional stats for reaped children (proc_pid_rusage) */
	struct user_uprof {			    /* profile arguments */
		struct user_uprof *pr_next;  /* multiple prof buffers allowed */
		user_addr_t	    pr_base;	/* buffer base */
		user_size_t	    pr_size;	/* buffer size */
		user_ulong_t	pr_off;		/* pc offset */
		user_ulong_t	pr_scale;	/* pc scaling */
		user_ulong_t	pr_addr;	/* temp storage for addr until AST */
		user_ulong_t	pr_ticks;	/* temp storage for ticks until AST */
	} user_p_prof;
#endif // KERNEL
};

/*
 * Kernel shareable process resource limits.  Because this structure
 * is moderately large but changes infrequently, it is normally
 * shared copy-on-write after forks.  If a group of processes
 * ("threads") share modifications, the PL_SHAREMOD flag is set,
 * and a copy must be made for the child of a new fork that isn't
 * sharing modifications to the limits.
 */
/* 
 * Modifications are done with the list lock held (p_limit as well)and access indv 
 * limits can be done without limit as we keep the old copy in p_olimit. Which is 
 * dropped in proc_exit. This way all access will have a valid kernel address
 */
struct plimit {
	struct	rlimit pl_rlimit[RLIM_NLIMITS];
	int	pl_refcnt;		/* number of references */
};

#ifdef KERNEL
/* add user profiling from AST */
#define	ADDUPROF(p)							\
    addupc_task(p,							\
                (proc_is64bit((p)) ? (p)->p_stats->user_p_prof.pr_addr \
                                   : CAST_USER_ADDR_T((p)->p_stats->p_prof.pr_addr)), \
                (proc_is64bit((p)) ? (p)->p_stats->user_p_prof.pr_ticks \
                                   : (p)->p_stats->p_prof.pr_ticks))

void	 addupc_intr(struct proc *p, uint32_t pc, u_int ticks);
void	 addupc_task(struct proc *p, user_addr_t pc, u_int ticks);
void	 calcru(struct proc *p, struct timeval *up, struct timeval *sp,
	    struct timeval *ip);
void	 ruadd(struct rusage *ru, struct rusage *ru2);
void	 update_rusage_info_child(struct rusage_info_child *ru, rusage_info_current *ru_current);
void proc_limitget(proc_t p, int whichi, struct rlimit * limp);
void proc_limitdrop(proc_t p, int exiting);
void proc_limitfork(proc_t parent, proc_t child);
int proc_limitreplace(proc_t p);
void proc_limitblock(proc_t);
void proc_limitunblock(proc_t);
#endif /* KERNEL */


#endif	/* !_SYS_RESOURCEVAR_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1991, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)resourcevar.h 8.4 (Berkeley) 1/9/95
	62	*/
	63
	64	#ifndef _SYS_RESOURCEVAR_H_
	65	#define _SYS_RESOURCEVAR_H_
	66
9bccf70c A	67	#include <sys/appleapiopts.h>
9bccf70c A	68
1c79356b A	69	/*
	70	* Kernel per-process accounting / statistics
	71	* (not necessarily resident except when running).
	72	*/
	73	struct pstats {
39236c6e A	74	struct rusage p_ru; /* stats for this proc */
39236c6e A	75	struct rusage p_cru; /* (PL) sum of stats for reaped children */
1c79356b A	76
	77	struct uprof { /* profile arguments */
	78	struct uprof pr_next; / multiple prof buffers allowed */
	79	caddr_t pr_base; /* buffer base */
b0d623f7 A	80	u_int32_t pr_size; /* buffer size */
	81	u_int32_t pr_off; /* pc offset */
	82	u_int32_t pr_scale; /* pc scaling */
	83	u_int32_t pr_addr; /* temp storage for addr until AST */
	84	u_int32_t pr_ticks; /* temp storage for ticks until AST */
1c79356b	85	} p_prof;
39236c6e A	86
39236c6e A	87	uint64_t ps_start; /* starting time ; compat only */
91447636	88	#ifdef KERNEL
39236c6e	89	struct rusage_info_child ri_child; /* (PL) sum of additional stats for reaped children (proc_pid_rusage) */
91447636 A	90	struct user_uprof { /* profile arguments */
	91	struct user_uprof pr_next; / multiple prof buffers allowed */
	92	user_addr_t pr_base; /* buffer base */
	93	user_size_t pr_size; /* buffer size */
	94	user_ulong_t pr_off; /* pc offset */
	95	user_ulong_t pr_scale; /* pc scaling */
	96	user_ulong_t pr_addr; /* temp storage for addr until AST */
	97	user_ulong_t pr_ticks; /* temp storage for ticks until AST */
	98	} user_p_prof;
	99	#endif // KERNEL
1c79356b A	100	};
	101
	102	/*
	103	* Kernel shareable process resource limits. Because this structure
	104	* is moderately large but changes infrequently, it is normally
	105	* shared copy-on-write after forks. If a group of processes
	106	* ("threads") share modifications, the PL_SHAREMOD flag is set,
	107	* and a copy must be made for the child of a new fork that isn't
	108	* sharing modifications to the limits.
	109	*/
2d21ac55 A	110	/*
	111	* Modifications are done with the list lock held (p_limit as well)and access indv
	112	* limits can be done without limit as we keep the old copy in p_olimit. Which is
	113	* dropped in proc_exit. This way all access will have a valid kernel address
	114	*/
1c79356b A	115	struct plimit {
1c79356b A	116	struct rlimit pl_rlimit[RLIM_NLIMITS];
2d21ac55	117	int pl_refcnt; /* number of references */
1c79356b A	118	};
1c79356b A	119
91447636	120	#ifdef KERNEL
1c79356b A	121	/* add user profiling from AST */
1c79356b A	122	#define ADDUPROF(p) \
91447636 A	123	addupc_task(p, \
	124	(proc_is64bit((p)) ? (p)->p_stats->user_p_prof.pr_addr \
	125	: CAST_USER_ADDR_T((p)->p_stats->p_prof.pr_addr)), \
	126	(proc_is64bit((p)) ? (p)->p_stats->user_p_prof.pr_ticks \
	127	: (p)->p_stats->p_prof.pr_ticks))
1c79356b	128
b0d623f7	129	void addupc_intr(struct proc *p, uint32_t pc, u_int ticks);
91447636 A	130	void addupc_task(struct proc *p, user_addr_t pc, u_int ticks);
	131	void calcru(struct proc p, struct timeval up, struct timeval *sp,
	132	struct timeval *ip);
	133	void ruadd(struct rusage ru, struct rusage ru2);
fe8ab488	134	void update_rusage_info_child(struct rusage_info_child ru, rusage_info_current ru_current);
2d21ac55 A	135	void proc_limitget(proc_t p, int whichi, struct rlimit * limp);
	136	void proc_limitdrop(proc_t p, int exiting);
	137	void proc_limitfork(proc_t parent, proc_t child);
	138	int proc_limitreplace(proc_t p);
	139	void proc_limitblock(proc_t);
	140	void proc_limitunblock(proc_t);
9bccf70c A	141	#endif /* KERNEL */
9bccf70c A	142
1c79356b A	143
1c79356b A	144	#endif /* !_SYS_RESOURCEVAR_H_ */