xref: /onnv-gate/usr/src/lib/libctf/common/libctf.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2001-2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate /*
28*0Sstevel@tonic-gate  * This header file defines the interfaces available from the CTF debugger
29*0Sstevel@tonic-gate  * library, libctf.  This library provides functions that a debugger can
30*0Sstevel@tonic-gate  * use to operate on data in the Compact ANSI-C Type Format (CTF).  This
31*0Sstevel@tonic-gate  * is NOT a public interface, although it may eventually become one in
32*0Sstevel@tonic-gate  * the fullness of time after we gain more experience with the interfaces.
33*0Sstevel@tonic-gate  *
34*0Sstevel@tonic-gate  * In the meantime, be aware that any program linked with libctf in this
35*0Sstevel@tonic-gate  * release of Solaris is almost guaranteed to break in the next release.
36*0Sstevel@tonic-gate  *
37*0Sstevel@tonic-gate  * In short, do not user this header file or libctf for any purpose.
38*0Sstevel@tonic-gate  */
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #ifndef	_LIBCTF_H
41*0Sstevel@tonic-gate #define	_LIBCTF_H
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate #include <sys/ctf_api.h>
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate #ifdef	__cplusplus
48*0Sstevel@tonic-gate extern "C" {
49*0Sstevel@tonic-gate #endif
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate /*
52*0Sstevel@tonic-gate  * This flag can be used to enable debug messages.
53*0Sstevel@tonic-gate  */
54*0Sstevel@tonic-gate extern int _libctf_debug;
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate #ifdef	__cplusplus
57*0Sstevel@tonic-gate }
58*0Sstevel@tonic-gate #endif
59*0Sstevel@tonic-gate 
60*0Sstevel@tonic-gate #endif	/* _LIBCTF_H */
61