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