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

/*
 * Copyright (c) 2000-2005 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 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 1993, 1994
 *	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.
 *
 *	@(#)uio.h	8.5 (Berkeley) 2/22/94
 */

#ifndef _SYS_PTRACE_INTERNAL_H_
#define	_SYS_PTRACE_INTERNAL_H_

#include <sys/appleapiopts.h>

#ifdef KERNEL_PRIVATE
#include <sys/ptrace.h>

/*
 * Additional request flags used by shipping 3rd party products that have been
 * patching ptrace.  We should be able to remove these additional requests once
 * the 3rd party products move to the KPis introduced in Tiger.
 */

#define	PT_VENDOR_REQUEST1	5561	/* reserved for 3rd party vendor */


__BEGIN_DECLS

/*
 * WARNING - these are temporary KPI that allow binary compatibility with
 * shipping product that must patch ptrace.  These KPI will be removed in the
 * next system release that follows Tiger.  radar - 3928003
 *
 * temp_patch_ptrace - patch ptrace using new_ptrace as current implementation.  
 *		Returns the address of the original ptrace implementation.
 *
 * temp_unpatch_ptrace - restore ptrace to the original implementation.  Caller
 * 		must insure all inflight ptrace requests have drained before their kext
 *		is unloaded.
 */
uintptr_t temp_patch_ptrace(uintptr_t new_ptrace);
void temp_unpatch_ptrace(void);

__END_DECLS


#endif /* KERNEL */
#endif /* !_SYS_PTRACE_INTERNAL_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 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.
	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
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	29	/*
91447636 A	30	* Copyright (c) 1982, 1986, 1993, 1994
91447636 A	31	* The Regents of the University of California. All rights reserved.
1c79356b A	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:
91447636 A	43	* This product includes software developed by the University of
91447636 A	44	* California, Berkeley and its contributors.
1c79356b A	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	*
91447636	61	* @(#)uio.h 8.5 (Berkeley) 2/22/94
1c79356b	62	*/
91447636 A	63
	64	#ifndef _SYS_PTRACE_INTERNAL_H_
	65	#define _SYS_PTRACE_INTERNAL_H_
	66
9bccf70c	67	#include <sys/appleapiopts.h>
1c79356b	68
91447636 A	69	#ifdef KERNEL_PRIVATE
	70	#include <sys/ptrace.h>
	71
1c79356b	72	/*
91447636 A	73	* Additional request flags used by shipping 3rd party products that have been
	74	* patching ptrace. We should be able to remove these additional requests once
	75	* the 3rd party products move to the KPis introduced in Tiger.
1c79356b A	76	*/
1c79356b A	77
91447636 A	78	#define PT_VENDOR_REQUEST1 5561 /* reserved for 3rd party vendor */
	79
	80
	81	__BEGIN_DECLS
	82
1c79356b	83	/*
91447636 A	84	* WARNING - these are temporary KPI that allow binary compatibility with
	85	* shipping product that must patch ptrace. These KPI will be removed in the
	86	* next system release that follows Tiger. radar - 3928003
	87	*
	88	* temp_patch_ptrace - patch ptrace using new_ptrace as current implementation.
	89	* Returns the address of the original ptrace implementation.
	90	*
	91	* temp_unpatch_ptrace - restore ptrace to the original implementation. Caller
	92	* must insure all inflight ptrace requests have drained before their kext
	93	* is unloaded.
1c79356b	94	*/
91447636 A	95	uintptr_t temp_patch_ptrace(uintptr_t new_ptrace);
91447636 A	96	void temp_unpatch_ptrace(void);
1c79356b	97
91447636	98	__END_DECLS
1c79356b	99
1c79356b	100
1c79356b	101
91447636 A	102	#endif /* KERNEL */
91447636 A	103	#endif /* !_SYS_PTRACE_INTERNAL_H_ */