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