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

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1988, 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.
 *
 *	@(#)ktrace.h	8.1 (Berkeley) 6/2/93
 * $FreeBSD: src/sys/sys/ktrace.h,v 1.19.2.3 2001/01/06 09:58:23 alfred Exp $
 */

#ifndef _SYS_KTRACE_H_
#define	_SYS_KTRACE_H_

#include <sys/appleapiopts.h>

#if defined(MACH_KERNEL_PRIVATE)

#ifdef __APPLE_API_PRIVATE
void ktrsyscall(void *, int, int, void *, int);
void ktrsysret(void *, int, int, int, int);
#endif /* __APPLE_API_PRIVATE */

#else

#ifdef __APPLE_API_UNSTABLE
/*
 * operations to ktrace system call  (KTROP(op))
 */
#define KTROP_SET		0	/* set trace points */
#define KTROP_CLEAR		1	/* clear trace points */
#define KTROP_CLEARFILE		2	/* stop all tracing to file */
#define	KTROP(o)		((o)&3)	/* macro to extract operation */
/*
 * flags (ORed in with operation)
 */
#define KTRFLAG_DESCEND		4	/* perform op on all children too */

/*
 * ktrace record header
 */
struct ktr_header {
	int	ktr_len;		/* length of buf */
	short	ktr_type;		/* trace record type */
	pid_t	ktr_pid;		/* process id */
	char	ktr_comm[MAXCOMLEN+1];	/* command name */
	struct	timeval ktr_time;	/* timestamp */
	caddr_t	ktr_buf;
};

/*
 * Test for kernel trace point
 */
#define KTRPOINT(p, type)	\
	(((p)->p_traceflag & ((1<<(type))|KTRFAC_ACTIVE)) == (1<<(type)))

/*
 * ktrace record types
 */

/*
 * KTR_SYSCALL - system call record
 */
#define KTR_SYSCALL	1
struct ktr_syscall {
	short	ktr_code;		/* syscall number */
	short	ktr_narg;		/* number of arguments */
	/*
	 * followed by ktr_narg register_t
	 */
	register_t	ktr_args[1];
};

/*
 * KTR_SYSRET - return from system call record
 */
#define KTR_SYSRET	2
struct ktr_sysret {
	short	ktr_code;
	short	ktr_eosys;
	int	ktr_error;
	register_t	ktr_retval;
};

/*
 * KTR_NAMEI - namei record
 */
#define KTR_NAMEI	3
	/* record contains pathname */

/*
 * KTR_GENIO - trace generic process i/o
 */
#define KTR_GENIO	4
struct ktr_genio {
	int	ktr_fd;
	enum	uio_rw ktr_rw;
	/*
	 * followed by data successfully read/written
	 */
};

/*
 * KTR_PSIG - trace processed signal
 */
#define	KTR_PSIG	5
struct ktr_psig {
	int	signo;
	sig_t	action;
	int	code;
	sigset_t mask;
};

/*
 * KTR_CSW - trace context switches
 */
#define KTR_CSW		6
struct ktr_csw {
	int	out;	/* 1 if switch out, 0 if switch in */
	int	user;	/* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
};

/*
 * KTR_USER - data comming from userland
 */
#define	KTR_USER_MAXLEN	2048	/* maximum length of passed data */
#define KTR_USER	7

/*
 * kernel trace points (in p_traceflag)
 */
#define KTRFAC_MASK	0x00ffffff
#define KTRFAC_SYSCALL	(1<<KTR_SYSCALL)
#define KTRFAC_SYSRET	(1<<KTR_SYSRET)
#define KTRFAC_NAMEI	(1<<KTR_NAMEI)
#define KTRFAC_GENIO	(1<<KTR_GENIO)
#define	KTRFAC_PSIG	(1<<KTR_PSIG)
#define KTRFAC_CSW	(1<<KTR_CSW)
#define KTRFAC_USER	(1<<KTR_USER)
/*
 * trace flags (also in p_traceflags)
 */
#define KTRFAC_ROOT	0x80000000	/* root set this trace */
#define KTRFAC_INHERIT	0x40000000	/* pass trace flags to children */
#define KTRFAC_ACTIVE	0x20000000	/* ktrace logging in progress, ignore */


#ifdef	KERNEL
#ifdef __APPLE_API_PRIVATE
void	ktrnamei __P((struct vnode *,char *));
void	ktrcsw __P((struct vnode *, int, int, int));
void	ktrpsig __P((struct vnode *, int, sig_t, sigset_t *, int, int));
void	ktrgenio __P((struct vnode *, int, enum uio_rw,
	    struct uio *, int, int));
void	ktrsyscall __P((struct proc *, int, int, register_t args[], int));
void	ktrsysret __P((struct proc *, int, int, register_t, int));
#endif /* __APPLE_API_PRIVATE */
#else

#include <sys/cdefs.h>

__BEGIN_DECLS
int	ktrace __P((const char *, int, int, pid_t));
int	utrace __P((const void *, size_t));
__END_DECLS

#endif	/* !KERNEL */

#endif /* __APPLE_API_UNSTABLE */
#endif /* !MACH_KERNEL_PRIVATE */
#endif /* !_SYS_KTRACE_H_ */
Commit	Line	Data
1c79356b	1	/*
9bccf70c	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	26	/*
	27	* Copyright (c) 1988, 1993
	28	* The Regents of the University of California. All rights reserved.
	29	*
	30	* Redistribution and use in source and binary forms, with or without
	31	* modification, are permitted provided that the following conditions
	32	* are met:
	33	* 1. Redistributions of source code must retain the above copyright
	34	* notice, this list of conditions and the following disclaimer.
	35	* 2. Redistributions in binary form must reproduce the above copyright
	36	* notice, this list of conditions and the following disclaimer in the
	37	* documentation and/or other materials provided with the distribution.
	38	* 3. All advertising materials mentioning features or use of this software
	39	* must display the following acknowledgement:
	40	* This product includes software developed by the University of
	41	* California, Berkeley and its contributors.
	42	* 4. Neither the name of the University nor the names of its contributors
	43	* may be used to endorse or promote products derived from this software
	44	* without specific prior written permission.
	45	*
	46	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	47	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	48	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	49	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	50	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	51	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	52	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	53	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	54	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	55	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	56	* SUCH DAMAGE.
	57	*
	58	* @(#)ktrace.h 8.1 (Berkeley) 6/2/93
9bccf70c	59	* $FreeBSD: src/sys/sys/ktrace.h,v 1.19.2.3 2001/01/06 09:58:23 alfred Exp $
1c79356b A	60	*/
	61
	62	#ifndef _SYS_KTRACE_H_
	63	#define _SYS_KTRACE_H_
	64
9bccf70c A	65	#include <sys/appleapiopts.h>
	66
	67	#if defined(MACH_KERNEL_PRIVATE)
	68
	69	#ifdef __APPLE_API_PRIVATE
	70	void ktrsyscall(void , int, int, void , int);
	71	void ktrsysret(void *, int, int, int, int);
	72	#endif /* __APPLE_API_PRIVATE */
	73
	74	#else
	75
	76	#ifdef __APPLE_API_UNSTABLE
1c79356b A	77	/*
	78	* operations to ktrace system call (KTROP(op))
	79	*/
	80	#define KTROP_SET 0 /* set trace points */
	81	#define KTROP_CLEAR 1 /* clear trace points */
	82	#define KTROP_CLEARFILE 2 /* stop all tracing to file */
	83	#define KTROP(o) ((o)&3) /* macro to extract operation */
	84	/*
	85	* flags (ORed in with operation)
	86	*/
	87	#define KTRFLAG_DESCEND 4 /* perform op on all children too */
	88
	89	/*
	90	* ktrace record header
	91	*/
	92	struct ktr_header {
	93	int ktr_len; /* length of buf */
	94	short ktr_type; /* trace record type */
	95	pid_t ktr_pid; /* process id */
	96	char ktr_comm[MAXCOMLEN+1]; /* command name */
	97	struct timeval ktr_time; /* timestamp */
	98	caddr_t ktr_buf;
	99	};
	100
	101	/*
	102	* Test for kernel trace point
	103	*/
	104	#define KTRPOINT(p, type) \
	105	(((p)->p_traceflag & ((1<<(type))\|KTRFAC_ACTIVE)) == (1<<(type)))
	106
	107	/*
	108	* ktrace record types
	109	*/
	110
	111	/*
	112	* KTR_SYSCALL - system call record
	113	*/
	114	#define KTR_SYSCALL 1
	115	struct ktr_syscall {
9bccf70c A	116	short ktr_code; /* syscall number */
9bccf70c A	117	short ktr_narg; /* number of arguments */
1c79356b	118	/*
9bccf70c	119	* followed by ktr_narg register_t
1c79356b	120	*/
9bccf70c	121	register_t ktr_args[1];
1c79356b A	122	};
	123
	124	/*
	125	* KTR_SYSRET - return from system call record
	126	*/
	127	#define KTR_SYSRET 2
	128	struct ktr_sysret {
	129	short ktr_code;
	130	short ktr_eosys;
	131	int ktr_error;
9bccf70c	132	register_t ktr_retval;
1c79356b A	133	};
	134
	135	/*
	136	* KTR_NAMEI - namei record
	137	*/
	138	#define KTR_NAMEI 3
	139	/* record contains pathname */
	140
	141	/*
	142	* KTR_GENIO - trace generic process i/o
	143	*/
	144	#define KTR_GENIO 4
	145	struct ktr_genio {
	146	int ktr_fd;
	147	enum uio_rw ktr_rw;
	148	/*
	149	* followed by data successfully read/written
	150	*/
	151	};
	152
	153	/*
	154	* KTR_PSIG - trace processed signal
	155	*/
	156	#define KTR_PSIG 5
	157	struct ktr_psig {
	158	int signo;
	159	sig_t action;
1c79356b	160	int code;
9bccf70c	161	sigset_t mask;
1c79356b A	162	};
	163
	164	/*
	165	* KTR_CSW - trace context switches
	166	*/
	167	#define KTR_CSW 6
	168	struct ktr_csw {
	169	int out; /* 1 if switch out, 0 if switch in */
	170	int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
	171	};
	172
9bccf70c A	173	/*
	174	* KTR_USER - data comming from userland
	175	*/
	176	#define KTR_USER_MAXLEN 2048 /* maximum length of passed data */
	177	#define KTR_USER 7
	178
1c79356b A	179	/*
	180	* kernel trace points (in p_traceflag)
	181	*/
	182	#define KTRFAC_MASK 0x00ffffff
	183	#define KTRFAC_SYSCALL (1<<KTR_SYSCALL)
	184	#define KTRFAC_SYSRET (1<<KTR_SYSRET)
	185	#define KTRFAC_NAMEI (1<<KTR_NAMEI)
	186	#define KTRFAC_GENIO (1<<KTR_GENIO)
	187	#define KTRFAC_PSIG (1<<KTR_PSIG)
	188	#define KTRFAC_CSW (1<<KTR_CSW)
9bccf70c	189	#define KTRFAC_USER (1<<KTR_USER)
1c79356b A	190	/*
	191	* trace flags (also in p_traceflags)
	192	*/
	193	#define KTRFAC_ROOT 0x80000000 /* root set this trace */
	194	#define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */
	195	#define KTRFAC_ACTIVE 0x20000000 /* ktrace logging in progress, ignore */
	196
9bccf70c A	197
	198	#ifdef KERNEL
	199	#ifdef __APPLE_API_PRIVATE
	200	void ktrnamei __P((struct vnode ,char ));
	201	void ktrcsw __P((struct vnode *, int, int, int));
	202	void ktrpsig __P((struct vnode , int, sig_t, sigset_t , int, int));
	203	void ktrgenio __P((struct vnode *, int, enum uio_rw,
	204	struct uio *, int, int));
	205	void ktrsyscall __P((struct proc *, int, int, register_t args[], int));
	206	void ktrsysret __P((struct proc *, int, int, register_t, int));
	207	#endif /* __APPLE_API_PRIVATE */
	208	#else
1c79356b A	209
	210	#include <sys/cdefs.h>
	211
	212	__BEGIN_DECLS
	213	int ktrace __P((const char *, int, int, pid_t));
9bccf70c	214	int utrace __P((const void *, size_t));
1c79356b A	215	__END_DECLS
	216
	217	#endif /* !KERNEL */
9bccf70c A	218
	219	#endif /* __APPLE_API_UNSTABLE */
	220	#endif /* !MACH_KERNEL_PRIVATE */
1c79356b A	221	#endif /* !_SYS_KTRACE_H_ */
1c79356b A	222