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

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_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	/*
91447636	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	23	/*
91447636 A	24	* Copyright (c) 1982, 1986, 1993, 1994
91447636 A	25	* The Regents of the University of California. All rights reserved.
1c79356b A	26	*
	27	* Redistribution and use in source and binary forms, with or without
	28	* modification, are permitted provided that the following conditions
	29	* are met:
	30	* 1. Redistributions of source code must retain the above copyright
	31	* notice, this list of conditions and the following disclaimer.
	32	* 2. Redistributions in binary form must reproduce the above copyright
	33	* notice, this list of conditions and the following disclaimer in the
	34	* documentation and/or other materials provided with the distribution.
	35	* 3. All advertising materials mentioning features or use of this software
	36	* must display the following acknowledgement:
91447636 A	37	* This product includes software developed by the University of
91447636 A	38	* California, Berkeley and its contributors.
1c79356b A	39	* 4. Neither the name of the University nor the names of its contributors
	40	* may be used to endorse or promote products derived from this software
	41	* without specific prior written permission.
	42	*
	43	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	44	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	45	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	46	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	47	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	48	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	49	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	50	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	51	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	52	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	53	* SUCH DAMAGE.
	54	*
91447636	55	* @(#)uio.h 8.5 (Berkeley) 2/22/94
1c79356b	56	*/
91447636 A	57
	58	#ifndef _SYS_PTRACE_INTERNAL_H_
	59	#define _SYS_PTRACE_INTERNAL_H_
	60
9bccf70c	61	#include <sys/appleapiopts.h>
1c79356b	62
91447636 A	63	#ifdef KERNEL_PRIVATE
	64	#include <sys/ptrace.h>
	65
1c79356b	66	/*
91447636 A	67	* Additional request flags used by shipping 3rd party products that have been
	68	* patching ptrace. We should be able to remove these additional requests once
	69	* the 3rd party products move to the KPis introduced in Tiger.
1c79356b A	70	*/
1c79356b A	71
91447636 A	72	#define PT_VENDOR_REQUEST1 5561 /* reserved for 3rd party vendor */
	73
	74
	75	__BEGIN_DECLS
	76
1c79356b	77	/*
91447636 A	78	* WARNING - these are temporary KPI that allow binary compatibility with
	79	* shipping product that must patch ptrace. These KPI will be removed in the
	80	* next system release that follows Tiger. radar - 3928003
	81	*
	82	* temp_patch_ptrace - patch ptrace using new_ptrace as current implementation.
	83	* Returns the address of the original ptrace implementation.
	84	*
	85	* temp_unpatch_ptrace - restore ptrace to the original implementation. Caller
	86	* must insure all inflight ptrace requests have drained before their kext
	87	* is unloaded.
1c79356b	88	*/
91447636 A	89	uintptr_t temp_patch_ptrace(uintptr_t new_ptrace);
91447636 A	90	void temp_unpatch_ptrace(void);
1c79356b	91
91447636	92	__END_DECLS
1c79356b	93
1c79356b	94
1c79356b	95
91447636 A	96	#endif /* KERNEL */
91447636 A	97	#endif /* !_SYS_PTRACE_INTERNAL_H_ */