xref: /illumos-gate/usr/src/lib/fm/topo/libtopo/common/topo_subr.h (revision 89a7715a55deca73d03076f5c24463717f0aaa91)
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 (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _TOPO_SUBR_H
28 #define	_TOPO_SUBR_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <fm/libtopo.h>
33 #include <topo_list.h>
34 
35 #include <pthread.h>
36 #include <stdarg.h>
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 typedef struct topo_debug_mode {
43 	char *tdm_name;		/* mode name */
44 	char *tdm_desc;		/* mode description */
45 	int tdm_mode;		/* mode: See below */
46 } topo_debug_mode_t;
47 
48 #define	TOPO_DBOUT_STDERR	0	/* Debug messages to stderr */
49 #define	TOPO_DBOUT_SYSLOG	1	/* Debug messages to syslog */
50 
51 #define	TOPO_DBG_ERR	0x0001	/* enable error handling debug messages */
52 #define	TOPO_DBG_MOD	0x0002	/* enable module debug messages */
53 #define	TOPO_DBG_MODSVC	0x0004	/* enable module services debug messages */
54 #define	TOPO_DBG_WALK	0x0008	/* enable walker debug messages */
55 #define	TOPO_DBG_XML	0x0010	/* enable xml parsing debug messages */
56 #define	TOPO_DBG_ALL	0xffff	/* enable all debug modes */
57 
58 #define	TOPO_STABSTR_INTERNAL	"Internal"	/* private to libtopo */
59 #define	TOPO_STABSTR_PRIVATE	"Private"	/* private to Sun */
60 #define	TOPO_STABSTR_OBSOLETE	"Obsolete"	/* scheduled for removal */
61 #define	TOPO_STABSTR_EXTERNAL	"External"	/* not controlled by Sun */
62 #define	TOPO_STABSTR_UNSTABLE	"Unstable"	/* new or rapidly changing */
63 #define	TOPO_STABSTR_EVOLVING	"Evolving"	/* less rapidly changing */
64 #define	TOPO_STABSTR_STABLE	"Stable"	/* mature interface from Sun */
65 #define	TOPO_STABSTR_STANDARD	"Standard"	/* industry standard */
66 #define	TOPO_STABSTR_UNKNOWN	"Unknown"	/* stability unknown */
67 
68 
69 extern int topo_rw_read_held(pthread_rwlock_t *);
70 extern int topo_rw_write_held(pthread_rwlock_t *);
71 extern int topo_mutex_held(pthread_mutex_t *);
72 
73 extern void topo_hdl_lock(topo_hdl_t *);
74 extern void topo_hdl_unlock(topo_hdl_t *);
75 
76 extern const char *topo_stability_name(topo_stability_t);
77 extern char *topo_version_num2str(topo_version_t, char *, size_t);
78 extern int topo_version_str2num(const char *, topo_version_t);
79 extern int topo_version_defined(topo_version_t);
80 
81 extern void topo_dprintf(topo_hdl_t *, int, const char *, ...);
82 extern void topo_vdprintf(topo_hdl_t *, int, const char *, const char *,
83     va_list);
84 
85 extern tnode_t *topo_hdl_root(topo_hdl_t *, const char *);
86 extern char *topo_search_path(topo_mod_t *, const char *, const char *);
87 
88 extern void topo_fmristr_build(ssize_t *, char *, size_t, char *, char *,
89     char *);
90 
91 extern int topo_walk_byid(topo_walk_t *wp, const char *name, topo_instance_t);
92 
93 extern char *topo_cleanup_auth_str(topo_hdl_t *, char *);
94 
95 #ifdef __cplusplus
96 }
97 #endif
98 
99 #endif	/* _TOPO_SUBR_H */
100