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