xref: /titanic_50/usr/src/cmd/sgs/include/conv.h (revision 3c112a2b34403220c06c3e2fcac403358cfba168)
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 (c) 1988 AT&T
24  *	  All Rights Reserved
25  *
26  * Copyright (c) 1992, 2010, Oracle and/or its affiliates. All rights reserved.
27  */
28 
29 #ifndef	_CONV_H
30 #define	_CONV_H
31 
32 /*
33  * Global include file for conversion library.
34  */
35 
36 #include <stdlib.h>
37 #include <libelf.h>
38 #include <dlfcn.h>
39 #include <libld.h>
40 #include <sgs.h>
41 #include <sgsmsg.h>
42 
43 #ifdef	__cplusplus
44 extern "C" {
45 #endif
46 
47 /*
48  * Configuration features available - maintained here (instead of debug.h)
49  * to save libconv from having to include debug.h which results in numerous
50  * "declared but not used or defined" lint errors.
51  */
52 #define	CONF_EDLIBPATH	0x000100	/* ELF default library path */
53 #define	CONF_ESLIBPATH	0x000200	/* ELF secure library path */
54 #define	CONF_ADLIBPATH	0x000400	/* AOUT default library path */
55 #define	CONF_ASLIBPATH	0x000800	/* AOUT secure library path */
56 #define	CONF_DIRCFG	0x001000	/* directory configuration available */
57 #define	CONF_OBJALT	0x002000	/* object alternatives available */
58 #define	CONF_MEMRESV	0x004000	/* memory reservation required */
59 #define	CONF_ENVS	0x008000	/* environment variables available */
60 #define	CONF_FLTR	0x010000	/* filter information available */
61 #define	CONF_FEATMSK	0xffff00
62 
63 
64 /*
65  * Valid flags for conv_strproc_extract_value().
66  */
67 #define	CONV_SPEXV_F_NOTRIM	0x0001	/* Do not trim whitespace around '=' */
68 #define	CONV_SPEXV_F_UCASE	0x0002	/* Convert value to uppercase */
69 #define	CONV_SPEXV_F_NULLOK	0x0004	 /* Empty ("") value is OK */
70 
71 /*
72  * Buffer types:
73  *
74  * Many of the routines in this module require the user to supply a
75  * buffer into which the desired strings may be written. These are
76  * all arrays of characters, and might be defined as simple arrays
77  * of char. The problem with that approach is that when such an array
78  * is passed to a function, the C language considers it to have the
79  * type (char *), without any regard to its length. Not all of our
80  * buffers have the same length, and we want to ensure that the compiler
81  * will refuse to compile code that passes the wrong type of buffer to
82  * a given routine. The solution is to define the buffers as unions
83  * that contain the needed array, and then to pass the given union
84  * by address. The compiler will catch attempts to pass the wrong type
85  * of pointer, and the size of a structure/union is implicit in its type.
86  *
87  * A nice side effect of this approach is that we can use a union with
88  * multiple buffers to handle the cases where a given routine needs
89  * more than one type of buffer. The end result is a single buffer large
90  * enough to handle any of the subcases, but no larger.
91  */
92 
93 /*
94  * Size of buffer used by conv_invalid_val():
95  *
96  * Various values that can't be matched to a symbolic definition are converted
97  * to a numeric string.
98  *
99  * The buffer size reflects the maximum number of digits needed to
100  * display an integer as text, plus a trailing null, and with room for
101  * a leading "0x" if hexidecimal display is selected.
102  *
103  * The 32-bit version of this requires 12 characters, and the 64-bit version
104  * needs 22. By using the larger value for both, we can have a single
105  * definition, which is necessary for code that is ELFCLASS independent. A
106  * nice side benefit is that it lets us dispense with a large number of 32/64
107  * buffer size definitions that build off CONV_INV_BUFSIZE, and the macros
108  * that would then be needed.
109  */
110 #define	CONV_INV_BUFSIZE		22
111 typedef union {
112 	char				buf[CONV_INV_BUFSIZE];
113 } Conv_inv_buf_t;
114 
115 /* conv_ehdr_flags() */
116 #define	CONV_EHDR_FLAGS_BUFSIZE		91
117 typedef union {
118 	Conv_inv_buf_t			inv_buf;
119 	char				buf[CONV_EHDR_FLAGS_BUFSIZE];
120 } Conv_ehdr_flags_buf_t;
121 
122 /* conv_reject_desc() */
123 typedef union {
124 	Conv_inv_buf_t			inv_buf;
125 	Conv_ehdr_flags_buf_t		flags_buf;
126 } Conv_reject_desc_buf_t;
127 
128 /*
129  * conv_cap_val_hw/sf()
130  *
131  * These sizes are based on the maximum number of capabilities that exist.
132  * See common/elfcap.
133  */
134 #define	CONV_CAP_VAL_HW1_BUFSIZE	195
135 typedef union {
136 	Conv_inv_buf_t			inv_buf;
137 	char				buf[CONV_CAP_VAL_HW1_BUFSIZE];
138 } Conv_cap_val_hw1_buf_t;
139 
140 #define	CONV_CAP_VAL_HW2_BUFSIZE	CONV_INV_BUFSIZE	/* for now */
141 typedef union {
142 	Conv_inv_buf_t			inv_buf;
143 	char				buf[CONV_CAP_VAL_HW2_BUFSIZE];
144 } Conv_cap_val_hw2_buf_t;
145 
146 #define	CONV_CAP_VAL_SF1_BUFSIZE	45
147 typedef union {
148 	Conv_inv_buf_t			inv_buf;
149 	char				buf[CONV_CAP_VAL_SF1_BUFSIZE];
150 } Conv_cap_val_sf1_buf_t;
151 
152 /* conv_cap_val_buf() */
153 typedef union {
154 	Conv_inv_buf_t			inv_buf;
155 	Conv_cap_val_hw1_buf_t		cap_val_hw1_buf;
156 	Conv_cap_val_sf1_buf_t		cap_val_sf1_buf;
157 	Conv_cap_val_hw2_buf_t		cap_val_hw2_buf;
158 } Conv_cap_val_buf_t;
159 
160 /* conv_config_feat() */
161 #define	CONV_CONFIG_FEAT_BUFSIZE	204
162 typedef union {
163 	Conv_inv_buf_t			inv_buf;
164 	char				buf[CONV_CONFIG_FEAT_BUFSIZE];
165 } Conv_config_feat_buf_t;
166 
167 /* conv_config_obj() */
168 #define	CONV_CONFIG_OBJ_BUFSIZE		164
169 typedef union {
170 	Conv_inv_buf_t			inv_buf;
171 	char				buf[CONV_CONFIG_OBJ_BUFSIZE];
172 } Conv_config_obj_buf_t;
173 
174 /* conv_dl_mode() */
175 #define	CONV_DL_MODE_BUFSIZE		132
176 typedef union {
177 	Conv_inv_buf_t			inv_buf;
178 	char				buf[CONV_DL_MODE_BUFSIZE];
179 } Conv_dl_mode_buf_t;
180 
181 /* conv_dl_flag() */
182 #define	CONV_DL_FLAG_BUFSIZE		185
183 typedef union {
184 	Conv_inv_buf_t			inv_buf;
185 	char				buf[CONV_DL_FLAG_BUFSIZE];
186 } Conv_dl_flag_buf_t;
187 
188 /* conv_grphdl_flags() */
189 #define	CONV_GRPHDL_FLAGS_BUFSIZE	78
190 typedef union {
191 	Conv_inv_buf_t			inv_buf;
192 	char				buf[CONV_GRPHDL_FLAGS_BUFSIZE];
193 } Conv_grphdl_flags_buf_t;
194 
195 /* conv_grpdesc_flags() */
196 #define	CONV_GRPDESC_FLAGS_BUFSIZE	91
197 typedef union {
198 	Conv_inv_buf_t			inv_buf;
199 	char				buf[CONV_GRPDESC_FLAGS_BUFSIZE];
200 } Conv_grpdesc_flags_buf_t;
201 
202 /* conv_seg_flags() */
203 #define	CONV_SEG_FLAGS_BUFSIZE		241
204 typedef union {
205 	Conv_inv_buf_t			inv_buf;
206 	char				buf[CONV_SEG_FLAGS_BUFSIZE];
207 } Conv_seg_flags_buf_t;
208 
209 /* conv_dyn_posflag1() */
210 #define	CONV_DYN_POSFLAG1_BUFSIZE	72
211 typedef union {
212 	Conv_inv_buf_t			inv_buf;
213 	char				buf[CONV_DYN_POSFLAG1_BUFSIZE];
214 } Conv_dyn_posflag1_buf_t;
215 
216 /* conv_dyn_flag() */
217 #define	CONV_DYN_FLAG_BUFSIZE		85
218 typedef union {
219 	Conv_inv_buf_t			inv_buf;
220 	char				buf[CONV_DYN_FLAG_BUFSIZE];
221 } Conv_dyn_flag_buf_t;
222 
223 /* conv_dyn_flag1() */
224 #define	CONV_DYN_FLAG1_BUFSIZE		361
225 typedef union {
226 	Conv_inv_buf_t			inv_buf;
227 	char				buf[CONV_DYN_FLAG1_BUFSIZE];
228 } Conv_dyn_flag1_buf_t;
229 
230 /* conv_dyn_feature1() */
231 #define	CONV_DYN_FEATURE1_BUFSIZE	54
232 typedef union {
233 	Conv_inv_buf_t			inv_buf;
234 	char				buf[CONV_DYN_FEATURE1_BUFSIZE];
235 } Conv_dyn_feature1_buf_t;
236 
237 /* conv_bnd_type() */
238 #define	CONV_BND_TYPE_BUFSIZE		51
239 typedef union {
240 	Conv_inv_buf_t			inv_buf;
241 	char				buf[CONV_BND_TYPE_BUFSIZE];
242 } Conv_bnd_type_buf_t;
243 
244 /* conv_bnd_obj() */
245 #define	CONV_BND_OBJ_BUFSIZE		60
246 typedef union {
247 	Conv_inv_buf_t			inv_buf;
248 	char				buf[CONV_BND_OBJ_BUFSIZE];
249 } Conv_bnd_obj_buf_t;
250 
251 /* conv_phdr_flags() */
252 #define	CONV_PHDR_FLAGS_BUFSIZE		57
253 typedef union {
254 	Conv_inv_buf_t			inv_buf;
255 	char				buf[CONV_PHDR_FLAGS_BUFSIZE];
256 } Conv_phdr_flags_buf_t;
257 
258 /* conv_sec_flags() */
259 #define	CONV_SEC_FLAGS_BUFSIZE		190
260 typedef union {
261 	Conv_inv_buf_t			inv_buf;
262 	char				buf[CONV_SEC_FLAGS_BUFSIZE];
263 } Conv_sec_flags_buf_t;
264 
265 /* conv_dwarf_ehe() */
266 #define	CONV_DWARF_EHE_BUFSIZE		43
267 typedef union {
268 	Conv_inv_buf_t			inv_buf;
269 	char				buf[CONV_DWARF_EHE_BUFSIZE];
270 } Conv_dwarf_ehe_buf_t;
271 
272 /* conv_syminfo_flags() */
273 #define	CONV_SYMINFO_FLAGS_BUFSIZE	230
274 typedef union {
275 	Conv_inv_buf_t			inv_buf;
276 	char				buf[CONV_SYMINFO_FLAGS_BUFSIZE];
277 } Conv_syminfo_flags_buf_t;
278 
279 /* conv_cnote_pr_flags() */
280 #define	CONV_CNOTE_PR_FLAGS_BUFSIZE	254
281 typedef union {
282 	Conv_inv_buf_t			inv_buf;
283 	char				buf[CONV_CNOTE_PR_FLAGS_BUFSIZE];
284 } Conv_cnote_pr_flags_buf_t;
285 
286 /* conv_cnote_old_pr_flags() */
287 #define	CONV_CNOTE_OLD_PR_FLAGS_BUFSIZE	174
288 typedef union {
289 	Conv_inv_buf_t			inv_buf;
290 	char				buf[CONV_CNOTE_OLD_PR_FLAGS_BUFSIZE];
291 } Conv_cnote_old_pr_flags_buf_t;
292 
293 /* conv_cnote_proc_flag() */
294 #define	CONV_CNOTE_PROC_FLAG_BUFSIZE	39
295 typedef union {
296 	Conv_inv_buf_t			inv_buf;
297 	char				buf[CONV_CNOTE_PROC_FLAG_BUFSIZE];
298 } Conv_cnote_proc_flag_buf_t;
299 
300 
301 /* conv_cnote_sigset() */
302 #define	CONV_CNOTE_SIGSET_BUFSIZE	639
303 typedef union {
304 	Conv_inv_buf_t			inv_buf;
305 	char				buf[CONV_CNOTE_SIGSET_BUFSIZE];
306 } Conv_cnote_sigset_buf_t;
307 
308 /* conv_cnote_fltset() */
309 #define	CONV_CNOTE_FLTSET_BUFSIZE	511
310 typedef union {
311 	Conv_inv_buf_t			inv_buf;
312 	char				buf[CONV_CNOTE_FLTSET_BUFSIZE];
313 } Conv_cnote_fltset_buf_t;
314 
315 /* conv_cnote_sysset() */
316 #define	CONV_CNOTE_SYSSET_BUFSIZE	3195
317 typedef union {
318 	Conv_inv_buf_t			inv_buf;
319 	char				buf[CONV_CNOTE_SYSSET_BUFSIZE];
320 } Conv_cnote_sysset_buf_t;
321 
322 /* conv_cnote_sa_flags() */
323 #define	CONV_CNOTE_SA_FLAGS_BUFSIZE	109
324 typedef union {
325 	Conv_inv_buf_t			inv_buf;
326 	char				buf[CONV_CNOTE_SA_FLAGS_BUFSIZE];
327 } Conv_cnote_sa_flags_buf_t;
328 
329 /* conv_cnote_ss_flags() */
330 #define	CONV_CNOTE_SS_FLAGS_BUFSIZE	48
331 typedef union {
332 	Conv_inv_buf_t			inv_buf;
333 	char				buf[CONV_CNOTE_SS_FLAGS_BUFSIZE];
334 } Conv_cnote_ss_flags_buf_t;
335 
336 /* conv_cnote_cc_content() */
337 #define	CONV_CNOTE_CC_CONTENT_BUFSIZE	97
338 typedef union {
339 	Conv_inv_buf_t			inv_buf;
340 	char				buf[CONV_CNOTE_CC_CONTENT_BUFSIZE];
341 } Conv_cnote_cc_content_buf_t;
342 
343 /* conv_cnote_auxv_af() */
344 #define	CONV_CNOTE_AUXV_AF_BUFSIZE	73
345 typedef union {
346 	Conv_inv_buf_t			inv_buf;
347 	char				buf[CONV_CNOTE_AUXV_AF_BUFSIZE];
348 } Conv_cnote_auxv_af_buf_t;
349 
350 /* conv_ver_flags() */
351 #define	CONV_VER_FLAGS_BUFSIZE		41
352 typedef union {
353 	Conv_inv_buf_t			inv_buf;
354 	char				buf[CONV_VER_FLAGS_BUFSIZE];
355 } Conv_ver_flags_buf_t;
356 
357 /* conv_ent_flags() */
358 #define	CONV_ENT_FLAGS_BUFSIZE		69
359 typedef union {
360 	Conv_inv_buf_t			inv_buf;
361 	char				buf[CONV_ENT_FLAGS_BUFSIZE];
362 } Conv_ent_flags_buf_t;
363 
364 /* conv_ent_files_flags() */
365 #define	CONV_ENT_FILES_FLAGS_BUFSIZE	89
366 typedef union {
367 	Conv_inv_buf_t			inv_buf;
368 	char				buf[CONV_ENT_FILES_FLAGS_BUFSIZE];
369 } Conv_ent_files_flags_buf_t;
370 
371 /*
372  * conv_time()
373  *
374  * This size is based on the maximum "hour.min.sec.fraction: " time that
375  * would be expected of ld().
376  */
377 #define	CONV_TIME_BUFSIZE		18
378 typedef union {
379 	char				buf[CONV_TIME_BUFSIZE];
380 } Conv_time_buf_t;
381 
382 /*
383  * Many conversion routines accept a fmt_flags argument of this type
384  * to allow the caller to modify the output. There are two parts to
385  * this value:
386  *
387  *	(1) Format requests (decimal vs hex, etc...)
388  *	(2) The low order bits specified by CONV_MASK_FMT_ALT
389  *		and retrieved by CONV_TYPE_FMT_ALT are integer
390  *		values that specify that an alternate set of
391  *		strings should be used.
392  *
393  * The fmt_flags value is designed such that a caller can always
394  * supply a 0 in order to receive default behavior.
395  */
396 typedef int Conv_fmt_flags_t;
397 
398 /*
399  * Type used to represent ELF constants within libconv. This relies on
400  * the fact that there are no ELF constants that need more than 32-bits,
401  * nor are there any signed values.
402  */
403 typedef uint32_t Conv_elfvalue_t;
404 
405 /*
406  * Most conversion routines are able to provide strings in one of
407  * several alternative styles. The bottom 8 bits of Conv_fmt_flags_t
408  * are used to specify which strings should be used for a given call
409  * to a conversion routine:
410  *
411  *   DEFAULT
412  *	The default string style used by a given conversion routine is
413  *	an independent choice made by that routine. Different routines
414  *	make different choices, based largely on historical usage and
415  *	the perceived common case. It may be an alias for one of the
416  *	specific styles listed below, or it may be unique.
417  *
418  *   DUMP
419  *	Style of strings used by dump(1).
420  *
421  *   FILE
422  *	Style of strings used by file(1).
423  *
424  *   CRLE
425  *	Style of strings used by crle(1).
426  *
427  *   CF
428  *	Canonical Form: The string is exactly the same as the name
429  *	of the #define macro that defines it in the public header files.
430  *	(e.g. STB_LOCAL, not LOCL, LOCAL, LOC, or any other variation).
431  *
432  *   CFNP
433  *	No Prefix Canonical Form: The same strings supplied by CF,
434  *	but without their standard prefix. (e.g. LOCAL, instead of STT_LOCAL).
435  *
436  *   NF
437  *	Natural Form: The form of the strings that might typically be entered
438  *	via a keyboard by an interactive user. These are usually the strings
439  *	from CFNP, converted to lowercase, although in some cases they may
440  *	take some other "natural" form. In command completion applications,
441  *	lowercase strings appear less formal, and are easier on the eye.
442  *
443  * Every routine is required to have a default style. The others are optional,
444  * and may not be provided if not needed. If a given conversion routine does
445  * not support alternative strings for a given CONV_FMT_ALT type, it silently
446  * ignores the request and supplies the default set. This means that a utility
447  * like dump(1) is free to specify a style like DUMP to every conversion
448  * routine. It will receive its special strings if there are any, and
449  * the defaults otherwise.
450  */
451 #define	CONV_MASK_FMT_ALT		0xff
452 #define	CONV_TYPE_FMT_ALT(fmt_flags)	(fmt_flags & CONV_MASK_FMT_ALT)
453 
454 #define	CONV_FMT_ALT_DEFAULT	0	/* "Standard" strings */
455 #define	CONV_FMT_ALT_DUMP	1	/* dump(1) */
456 #define	CONV_FMT_ALT_FILE	2	/* file(1) */
457 #define	CONV_FMT_ALT_CRLE	3	/* crle(1) */
458 #define	CONV_FMT_ALT_CF		4	/* Canonical Form */
459 #define	CONV_FMT_ALT_CFNP	5	/* No Prefix Canonical Form */
460 #define	CONV_FMT_ALT_NF		6	/* Natural Form */
461 
462 /*
463  * Flags that alter standard formatting for conversion routines.
464  * These bits start after the range occupied by CONV_MASK_FMT_ALT.
465  */
466 #define	CONV_FMT_DECIMAL	0x0100	/* conv_invalid_val() should print */
467 					/*    integer print as decimal */
468 					/*    (default is hex) */
469 #define	CONV_FMT_SPACE		0x0200	/* conv_invalid_val() should append */
470 					/*    a space after the number.  */
471 #define	CONV_FMT_NOBKT		0x0400	/* conv_expn_field() should omit */
472 					/*    prefix and suffix strings */
473 
474 /*
475  * A Val_desc structure is used to associate an ELF constant and
476  * the message code (Msg) for the string that corresponds to it.
477  *
478  * Val_desc2 adds v_osabi and v_mach fields to Val_desc, which allows
479  * for non-generic mappings that apply only to a specific OSABI/machine.
480  * Setting v_osabi to 0 (ELFOSABI_NONE) specifies that any OSABI matches.
481  * Similarly, setting v_mach to 0 (EM_MACH) matches any machine. Hence,
482  * setting v_osabi and v_mach to 0 in a Val_desc2 results in a generic item,
483  * and is equivalent to simply using a Val_desc.
484  *
485  * These structs are used in two different contexts:
486  *
487  * 1)	To expand bit-field data items, using conv_expn_field() to
488  *	process a NULL terminated array of Val_desc, or conv_expn_field2()
489  *	to process a null terminated array of Val_desc2.
490  *
491  * 2)	To represent sparse ranges of non-bitfield values, referenced via
492  *	conv_ds_vd_t or conv_ds_vd2_t descriptors, as described below.
493  */
494 typedef struct {
495 	Conv_elfvalue_t	v_val;		/* expansion value */
496 	Msg		v_msg;		/* associated message string code */
497 } Val_desc;
498 typedef struct {
499 	Conv_elfvalue_t	v_val;		/* expansion value */
500 	uchar_t		v_osabi;	/* OSABI to which entry applies */
501 	Half		v_mach;		/* Machine to which entry applies */
502 	Msg		v_msg;		/* associated message string code */
503 } Val_desc2;
504 
505 /*
506  * The conv_ds_XXX_t structs are used to pull together the information used
507  * to map non-bitfield values to strings. They are a variant family, sharing
508  * the same initial fields, with a generic "header" definition that can be
509  * used to read those common fields and determine which subcase is being
510  * seen. We do this instead of using a single struct containing a type code
511  * and a union in order to allow for static compile-time initialization.
512  *
513  * conv_ds_t is the base type, containing the initial fields common to all
514  * the variants. Variables of type conv_ds_t are never instantiated. This
515  * type exists only to provide a common pointer type that can reference
516  * any of the variants safely. In C++, it would be a virtual base class.
517  * The fields common to all the variants are:
518  *
519  *	ds_type: Identifies the variant
520  *	ds_baseval/ds_topval: The lower and upper bound of the range
521  *		of values represented by this conv_ds_XXX_t descriptor.
522  *
523  * There are three different variants:
524  *    conv_ds_msg_t (ds_type == CONV_DS_MSGARR)
525  *	This structure references an array of message codes corresponding
526  *	to consecutive ELF values. The first item in the array is the Msg
527  *	code for the value given by ds_baseval. Consecutive strings follow
528  *	in consecutive order. The final item corresponds to the value given
529  *	by ds_topval. Zero (0) Msg values can be used to represent missing
530  *	values. Entries with a 0 are quietly ignored.
531  *
532  *    conv_ds_vd_t (ds_type == CONV_DS_VD)
533  *	This structure employs a NULL terminated array of Val_desc structs.
534  *	Each Val_desc supplies a mapping from a value in the range
535  *	(ds_baseval <= value <= ds_topval). The values described need not
536  *	be consecutive, and can be sparse. ds_baseval does not need to
537  *	correspond to the first item, and ds_topval need not correspond to
538  *	the final item.
539  *
540  *    conv_ds_vd2_t (ds_type == CONV_DS_VD2)
541  *	This structure employs a NULL terminated array of Val_desc2 structs,
542  *	rather than Val_desc, adding the ability to specify OSABI and machine
543  *	as part of the value/string mapping. It is otherwise the same thing
544  *	as CONV_DS_VD.
545  */
546 typedef enum {
547 	CONV_DS_MSGARR = 0,		/* Array of Msg */
548 	CONV_DS_VD = 1,			/* Null terminated array of Val_desc */
549 	CONV_DS_VD2 = 2,		/* Null terminated array of Val_desc2 */
550 } conv_ds_type_t;
551 
552 #define	CONV_DS_COMMON_FIELDS \
553 	conv_ds_type_t	ds_type;   	/* Type of data structure used */ \
554 	uint32_t	ds_baseval;	/* Value of first item */	\
555 	uint32_t	ds_topval	/* Value of last item */
556 
557 typedef struct {		/* Virtual base type --- do not instantiate */
558 	CONV_DS_COMMON_FIELDS;
559 } conv_ds_t;
560 typedef struct {
561 	CONV_DS_COMMON_FIELDS;
562 	const Msg		*ds_msg;
563 } conv_ds_msg_t;
564 typedef struct {
565 	CONV_DS_COMMON_FIELDS;
566 	const Val_desc		*ds_vd;
567 } conv_ds_vd_t;
568 typedef struct {
569 	CONV_DS_COMMON_FIELDS;
570 	const Val_desc2		*ds_vd2;
571 } conv_ds_vd2_t;
572 
573 /*
574  * The initialization of conv_ds_msg_t can be completely derived from
575  * its base value and the array of Msg codes. CONV_DS_MSG_INIT() is used
576  * to do that.
577  */
578 #define	CONV_DS_MSG_INIT(_baseval, _arr) \
579 	CONV_DS_MSGARR, _baseval, \
580 	_baseval + (sizeof (_arr) / sizeof (_arr[0])) - 1, _arr
581 
582 /*
583  * Null terminated arrays of pointers to conv_ds_XXX_t structs are processed
584  * by conv_map_ds() to convert ELF constants to their symbolic names, and by
585  * conv_iter_ds() to iterate over all the available value/name combinations.
586  *
587  * These pointers are formed by casting the address of the specific
588  * variant types (described above) to generic base type pointer.
589  * CONV_DS_ADDR() is a convenience macro to take the address of
590  * one of these variants and turn it into a generic pointer.
591  */
592 #define	CONV_DS_ADDR(_item) ((conv_ds_t *)&(_item))
593 
594 /*
595  * Type used by libconv to represent osabi values passed to iteration
596  * functions. The type in the ELF header is uchar_t. However, every possible
597  * value 0-255 has a valid meaning, leaving us no extra value to assign
598  * to mean "ALL". Using Half for osabi leaves us the top byte to use for
599  * out of bound values.
600  *
601  * Non-iteration functions, and any code that does not need to use
602  * CONV_OSABI_ALL, should use uchar_t for osabi.
603  */
604 typedef Half conv_iter_osabi_t;
605 
606 /*
607  * Many of the iteration functions accept an osabi or mach argument,
608  * used to specify the type of object being processed. The following
609  * values can be used to specify a wildcard that matches any item. Their
610  * values are carefully chosen to ensure that they cannot be interpreted
611  * as an otherwise valid osabi or machine.
612  */
613 #define	CONV_OSABI_ALL	1024	/* Larger than can be represented by uchar_t */
614 #define	CONV_MACH_ALL	EM_NUM	/* Never a valid machine type */
615 
616 /*
617  * We compare Val_Desc2 descriptors with a specified osabi and machine
618  * to determine whether to use it or not. This macro encapsulates that logic.
619  *
620  * We consider an osabi to match when any of the following things hold:
621  *
622  * -	The descriptor osabi is ELFOSABI_NONE.
623  * -	The supplied osabi and the descriptor osabi match
624  * -	The supplied osabi is ELFOSABI_NONE, and the descriptor osabi is
625  *	ELFOSABI_SOLARIS. Many operating systems, Solaris included,
626  *	produce or have produced ELFOSABI_NONE native objects, if only
627  *	because OSABI ranges are not an original ELF feature. We
628  *	give our own objects the home field advantage.
629  * -	Iteration Only: An osabi value of CONV_OSABI_ALL is specified.
630  *
631  * We consider a machine to match when any of the following things hold:
632  *
633  * -	The descriptor mach is EM_NONE.
634  * -	The supplied mach and the descriptor mach match
635  * -	Iteration Only: A mach value of CONV_MACH_ALL is specified.
636  *
637  * The special extra _ALL case for iteration is handled by defining a separate
638  * macro with the extra CONV_xxx_ALL tests.
639  */
640 #define	CONV_VD2_SKIP_OSABI(_osabi, _vdp) \
641 	((_vdp->v_osabi != ELFOSABI_NONE) && (_vdp->v_osabi != osabi) && \
642 	((_osabi != ELFOSABI_NONE) || (_vdp->v_osabi != ELFOSABI_SOLARIS)))
643 
644 #define	CONV_VD2_SKIP_MACH(_mach, _vdp) \
645 	((_vdp->v_mach != EM_NONE) && (_vdp->v_mach != _mach))
646 
647 #define	CONV_VD2_SKIP(_osabi, _mach, _vdp) \
648 	(CONV_VD2_SKIP_OSABI(_osabi, _vdp) || CONV_VD2_SKIP_MACH(_mach, _vdp))
649 
650 #define	CONV_ITER_VD2_SKIP(_osabi, _mach, _vdp)			      \
651 	((CONV_VD2_SKIP_OSABI(_osabi, _vdp) && (_osabi != CONV_OSABI_ALL)) || \
652 	(CONV_VD2_SKIP_MACH(_mach, _vdp) && (_mach != CONV_MACH_ALL)))
653 
654 
655 /*
656  * Possible return values from iteration functions.
657  */
658 typedef enum {
659 	CONV_ITER_DONE,		/* Stop: No more iterations are desired */
660 	CONV_ITER_CONT		/* Continue with following iterations */
661 } conv_iter_ret_t;
662 
663 /*
664  * Prototype for caller supplied callback function to iteration functions.
665  */
666 typedef conv_iter_ret_t (* conv_iter_cb_t)(const char *str,
667     Conv_elfvalue_t value, void *uvalue);
668 
669 /*
670  * User value block employed by conv_iter_strtol()
671  */
672 typedef struct {
673 	const char	*csl_str;	/* String to search for */
674 	size_t		csl_strlen;	/* # chars in csl_str to examine */
675 	int		csl_found;	/* Init to 0, set to 1 if item found */
676 	Conv_elfvalue_t	csl_value;	/* If csl_found, resulting value */
677 } conv_strtol_uvalue_t;
678 
679 /*
680  * conv_expn_field() is willing to supply default strings for the
681  * prefix, separator, and suffix arguments, if they are passed as NULL.
682  * The caller needs to know how much room to allow for these items.
683  * These values supply those sizes.
684  */
685 #define	CONV_EXPN_FIELD_DEF_PREFIX_SIZE	2	/* Default is "[ " */
686 #define	CONV_EXPN_FIELD_DEF_SEP_SIZE	1	/* Default is " " */
687 #define	CONV_EXPN_FIELD_DEF_SUFFIX_SIZE	2	/* Default is " ]" */
688 
689 /*
690  * conv_expn_field() requires a large number of inputs, many of which
691  * can be NULL to accept default behavior. An argument of the following
692  * type is used to supply them.
693  */
694 typedef struct {
695 	char *buf;		/* Buffer to receive generated string */
696 	size_t bufsize;		/* sizeof(buf) */
697 	const char **lead_str;	/* NULL, or array of pointers to strings to */
698 				/*	be output at the head of the list. */
699 				/*	Last entry must be NULL. */
700 	Xword oflags;		/* Bits for which output strings are desired */
701 	Xword rflags;		/* Bits for which a numeric value should be */
702 				/*	output if vdp does not provide str. */
703 				/*	Must be a proper subset of oflags */
704 	const char *prefix;	/* NULL, or string to prefix output with */
705 				/*	If NULL, "[ " is used. */
706 	const char *sep;	/* NULL, or string to separate output items */
707 				/*	with. If NULL, " " is used. */
708 	const char *suffix;	/* NULL, or string to suffix output with */
709 				/*	If NULL, " ]" is used. */
710 } CONV_EXPN_FIELD_ARG;
711 
712 /*
713  * Callback function for conv_str_to_c_literal(). A user supplied function
714  * of this type is called by conv_str_to_c_literal() in order to dispatch
715  * the translated output characters.
716  *
717  *	buf - Pointer to output text
718  *	n - # of characters to output
719  *	uvalue - User value argument to conv_str_to_c_literal(),
720  *		passed through without interpretation.
721  */
722 typedef	void		Conv_str_to_c_literal_func_t(const void *ptr,
723 			    size_t size, void *uvalue);
724 
725 /*
726  * Generic miscellaneous interfaces
727  */
728 extern	uchar_t		conv_check_native(char **, char **);
729 extern	const char	*conv_lddstub(int);
730 extern	int		conv_strproc_isspace(int);
731 extern	char		*conv_strproc_trim(char *);
732 extern	Boolean		conv_strproc_extract_value(char *, size_t, int,
733 			    const char **);
734 extern	int		conv_sys_eclass(void);
735 extern	int		conv_translate_c_esc(char **);
736 
737 /*
738  * Generic core formatting and iteration functionality
739  */
740 extern	conv_iter_ret_t	_conv_iter_ds(conv_iter_osabi_t, Half,
741 			    const conv_ds_t **, conv_iter_cb_t, void *,
742 			    const char *);
743 extern	conv_iter_ret_t	_conv_iter_ds_msg(const conv_ds_msg_t *,
744 			    conv_iter_cb_t, void *, const char *);
745 extern	conv_iter_ret_t	_conv_iter_vd(const Val_desc *, conv_iter_cb_t,
746 			    void *, const char *);
747 extern	conv_iter_ret_t	_conv_iter_vd2(conv_iter_osabi_t, Half,
748 			    const Val_desc2 *, conv_iter_cb_t, void *,
749 			    const char *);
750 extern	int		conv_iter_strtol_init(const char *,
751 			    conv_strtol_uvalue_t *);
752 extern	conv_iter_ret_t	conv_iter_strtol(const char *, Conv_elfvalue_t, void *);
753 extern	const char	*_conv_map_ds(uchar_t, Half, Conv_elfvalue_t,
754 			    const conv_ds_t **, Conv_fmt_flags_t,
755 			    Conv_inv_buf_t *, const char *);
756 
757 
758 /*
759  * Generic formatting interfaces.
760  */
761 extern	const char	*conv_bnd_obj(uint_t, Conv_bnd_obj_buf_t *);
762 extern	const char	*conv_bnd_type(uint_t, Conv_bnd_type_buf_t *);
763 extern	const char	*conv_config_feat(int, Conv_config_feat_buf_t *);
764 extern	const char	*conv_config_obj(ushort_t, Conv_config_obj_buf_t *);
765 extern	const char	*conv_config_upm(const char *, const char *,
766 			    const char *, size_t);
767 extern	const char	*conv_cnote_auxv_af(Word, Conv_fmt_flags_t,
768 			    Conv_cnote_auxv_af_buf_t *);
769 extern	const char	*conv_cnote_auxv_type(Word, Conv_fmt_flags_t,
770 			    Conv_inv_buf_t *);
771 extern	const char	*conv_cnote_cc_content(Lword, Conv_fmt_flags_t,
772 			    Conv_cnote_cc_content_buf_t *);
773 extern	const char	*conv_cnote_errno(int, Conv_fmt_flags_t,
774 			    Conv_inv_buf_t *);
775 extern	const char	*conv_cnote_fault(Word, Conv_fmt_flags_t,
776 			    Conv_inv_buf_t *);
777 extern	const char	*conv_cnote_fltset(uint32_t *, int,
778 			    Conv_fmt_flags_t, Conv_cnote_fltset_buf_t *);
779 extern	const char	*conv_cnote_old_pr_flags(int, Conv_fmt_flags_t,
780 			    Conv_cnote_old_pr_flags_buf_t *);
781 extern	const char	*conv_cnote_pr_dmodel(Word, Conv_fmt_flags_t,
782 			    Conv_inv_buf_t *);
783 extern	const char	*conv_cnote_pr_flags(int, Conv_fmt_flags_t,
784 			    Conv_cnote_pr_flags_buf_t *);
785 extern	const char	*conv_cnote_proc_flag(int, Conv_fmt_flags_t,
786 			    Conv_cnote_proc_flag_buf_t *);
787 extern	const char	*conv_cnote_pr_regname(Half, int, Conv_fmt_flags_t,
788 			    Conv_inv_buf_t *inv_buf);
789 extern	const char	*conv_cnote_pr_stype(Word, Conv_fmt_flags_t,
790 			    Conv_inv_buf_t *);
791 extern	const char	*conv_cnote_pr_what(short, short, Conv_fmt_flags_t,
792 			    Conv_inv_buf_t *);
793 extern	const char	*conv_cnote_pr_why(short, Conv_fmt_flags_t,
794 			    Conv_inv_buf_t *);
795 extern	const char	*conv_cnote_priv(int, Conv_fmt_flags_t,
796 			    Conv_inv_buf_t *);
797 extern	const char	*conv_cnote_psetid(int, Conv_fmt_flags_t,
798 			    Conv_inv_buf_t *);
799 extern	const char	*conv_cnote_sa_flags(int, Conv_fmt_flags_t,
800 			    Conv_cnote_sa_flags_buf_t *);
801 extern	const char	*conv_cnote_signal(Word, Conv_fmt_flags_t,
802 			    Conv_inv_buf_t *);
803 extern	const char	*conv_cnote_si_code(Half, int, int, Conv_fmt_flags_t,
804 			    Conv_inv_buf_t *);
805 extern	const char	*conv_cnote_sigset(uint32_t *, int,
806 			    Conv_fmt_flags_t, Conv_cnote_sigset_buf_t *);
807 extern	const char	*conv_cnote_ss_flags(int, Conv_fmt_flags_t,
808 			    Conv_cnote_ss_flags_buf_t *);
809 extern	const char	*conv_cnote_syscall(Word, Conv_fmt_flags_t,
810 			    Conv_inv_buf_t *);
811 extern	const char	*conv_cnote_sysset(uint32_t *, int,
812 			    Conv_fmt_flags_t, Conv_cnote_sysset_buf_t *);
813 extern	const char	*conv_cnote_type(Word, Conv_fmt_flags_t,
814 			    Conv_inv_buf_t *);
815 extern	const char	*conv_def_tag(Symref, Conv_inv_buf_t *);
816 extern	const char	*conv_demangle_name(const char *);
817 extern	const char	*conv_dl_flag(int, Conv_fmt_flags_t,
818 			    Conv_dl_flag_buf_t *);
819 extern	const char	*conv_dl_info(int);
820 extern	const char	*conv_dl_mode(int, int, Conv_dl_mode_buf_t *);
821 extern	const char	*conv_dwarf_cfa(uchar_t, Conv_fmt_flags_t,
822 			    Conv_inv_buf_t *);
823 extern	const char	*conv_dwarf_ehe(uint_t, Conv_dwarf_ehe_buf_t *);
824 extern	const char	*conv_dwarf_regname(Half, Word, Conv_fmt_flags_t,
825 			    int *, Conv_inv_buf_t *);
826 extern	const char	*conv_ehdr_abivers(uchar_t, Word, Conv_fmt_flags_t,
827 			    Conv_inv_buf_t *);
828 extern	const char	*conv_ehdr_class(uchar_t, Conv_fmt_flags_t,
829 			    Conv_inv_buf_t *);
830 extern	const char	*conv_ehdr_data(uchar_t, Conv_fmt_flags_t,
831 			    Conv_inv_buf_t *);
832 extern	const char	*conv_ehdr_flags(Half, Word, Conv_fmt_flags_t,
833 			    Conv_ehdr_flags_buf_t *);
834 extern	const char	*conv_ehdr_mach(Half, Conv_fmt_flags_t,
835 			    Conv_inv_buf_t *);
836 extern	const char	*conv_ehdr_osabi(uchar_t, Conv_fmt_flags_t,
837 			    Conv_inv_buf_t *);
838 extern	const char	*conv_ehdr_type(uchar_t, Half, Conv_fmt_flags_t,
839 			    Conv_inv_buf_t *);
840 extern	const char	*conv_ehdr_vers(Word, Conv_fmt_flags_t,
841 			    Conv_inv_buf_t *);
842 extern	const char	*conv_elfdata_type(Elf_Type, Conv_inv_buf_t *);
843 extern	const char	*conv_ent_flags(ec_flags_t, Conv_ent_flags_buf_t *);
844 extern	const char	*conv_ent_files_flags(Word,  Conv_fmt_flags_t fmt_flags,
845 			    Conv_ent_files_flags_buf_t *);
846 extern	const char	*conv_grphdl_flags(uint_t, Conv_grphdl_flags_buf_t *);
847 extern	const char	*conv_grpdesc_flags(uint_t, Conv_grpdesc_flags_buf_t *);
848 extern	Isa_desc	*conv_isalist(void);
849 extern	const char	*conv_mapfile_version(Word, Conv_fmt_flags_t,
850 			    Conv_inv_buf_t *);
851 extern	const char	*conv_phdr_flags(uchar_t, Word, Conv_fmt_flags_t,
852 			    Conv_phdr_flags_buf_t *);
853 extern	const char	*conv_phdr_type(uchar_t, Half, Word, Conv_fmt_flags_t,
854 			    Conv_inv_buf_t *);
855 extern	const char	*conv_reject_desc(Rej_desc *, Conv_reject_desc_buf_t *,
856 			    Half mach);
857 extern	const char	*conv_reloc_type(Half, Word, Conv_fmt_flags_t,
858 			    Conv_inv_buf_t *);
859 extern	const char	*conv_reloc_type_static(Half, Word, Conv_fmt_flags_t);
860 extern	const char	*conv_reloc_386_type(Word, Conv_fmt_flags_t,
861 			    Conv_inv_buf_t *);
862 extern	const char	*conv_reloc_amd64_type(Word, Conv_fmt_flags_t,
863 			    Conv_inv_buf_t *);
864 extern	const char	*conv_reloc_SPARC_type(Word, Conv_fmt_flags_t,
865 			    Conv_inv_buf_t *);
866 extern	const char	*conv_sec_type(uchar_t, Half, Word, Conv_fmt_flags_t,
867 			    Conv_inv_buf_t *);
868 extern	const char	*conv_seg_flags(sg_flags_t, Conv_seg_flags_buf_t *);
869 extern	void		conv_str_to_c_literal(const char *buf, size_t n,
870 			    Conv_str_to_c_literal_func_t *cb_func,
871 			    void *uvalue);
872 extern	const char	*conv_sym_info_bind(uchar_t, Conv_fmt_flags_t,
873 			    Conv_inv_buf_t *);
874 extern	const char	*conv_sym_info_type(Half, uchar_t, Conv_fmt_flags_t,
875 			    Conv_inv_buf_t *);
876 extern	const char	*conv_sym_shndx(uchar_t, Half, Half, Conv_fmt_flags_t,
877 			    Conv_inv_buf_t *);
878 extern	const char	*conv_sym_other(uchar_t, Conv_inv_buf_t *);
879 extern	const char	*conv_sym_other_vis(uchar_t, Conv_fmt_flags_t,
880 			    Conv_inv_buf_t *);
881 extern	const char	*conv_syminfo_boundto(Half, Conv_fmt_flags_t,
882 			    Conv_inv_buf_t *);
883 extern	const char	*conv_syminfo_flags(Half, Conv_fmt_flags_t,
884 			    Conv_syminfo_flags_buf_t *);
885 extern	const char	*conv_time(struct timeval *, struct timeval *,
886 			    Conv_time_buf_t *);
887 extern	Uts_desc	*conv_uts(void);
888 extern	const char	*conv_ver_flags(Half, Conv_fmt_flags_t,
889 			    Conv_ver_flags_buf_t *);
890 extern	const char	*conv_ver_index(Versym, int, Conv_inv_buf_t *);
891 
892 
893 /*
894  * Generic iteration interfaces.
895  */
896 extern	conv_iter_ret_t	conv_iter_cap_tags(Conv_fmt_flags_t, conv_iter_cb_t,
897 			    void *);
898 extern	conv_iter_ret_t	conv_iter_cap_val_hw1(Half, Conv_fmt_flags_t,
899 			    conv_iter_cb_t, void *);
900 extern	conv_iter_ret_t	conv_iter_cap_val_hw2(Half, Conv_fmt_flags_t,
901 			    conv_iter_cb_t, void *);
902 extern	conv_iter_ret_t	conv_iter_cap_val_sf1(Conv_fmt_flags_t, conv_iter_cb_t,
903 			    void *);
904 
905 extern	conv_iter_ret_t	conv_iter_dyn_feature1(Conv_fmt_flags_t, conv_iter_cb_t,
906 			    void *);
907 extern	conv_iter_ret_t	conv_iter_dyn_flag(Conv_fmt_flags_t, conv_iter_cb_t,
908 			    void *);
909 extern	conv_iter_ret_t	conv_iter_dyn_flag1(Conv_fmt_flags_t, conv_iter_cb_t,
910 			    void *);
911 extern	conv_iter_ret_t	conv_iter_dyn_posflag1(Conv_fmt_flags_t, conv_iter_cb_t,
912 			    void *);
913 extern	conv_iter_ret_t	conv_iter_dyn_tag(conv_iter_osabi_t, Half,
914 			    Conv_fmt_flags_t, conv_iter_cb_t, void *);
915 
916 extern	conv_iter_ret_t	conv_iter_ehdr_abivers(conv_iter_osabi_t,
917 			    Conv_fmt_flags_t, conv_iter_cb_t, void *);
918 extern	conv_iter_ret_t	conv_iter_ehdr_class(Conv_fmt_flags_t, conv_iter_cb_t,
919 			    void *);
920 extern	conv_iter_ret_t	conv_iter_ehdr_data(Conv_fmt_flags_t, conv_iter_cb_t,
921 			    void *);
922 extern	conv_iter_ret_t	conv_iter_ehdr_eident(Conv_fmt_flags_t, conv_iter_cb_t,
923 			    void *);
924 extern	conv_iter_ret_t	conv_iter_ehdr_flags(Half, Conv_fmt_flags_t,
925 			    conv_iter_cb_t, void *);
926 extern	conv_iter_ret_t	conv_iter_ehdr_mach(Conv_fmt_flags_t, conv_iter_cb_t,
927 			    void *);
928 extern	conv_iter_ret_t	conv_iter_ehdr_osabi(Conv_fmt_flags_t, conv_iter_cb_t,
929 			    void *);
930 extern	conv_iter_ret_t	conv_iter_ehdr_type(conv_iter_osabi_t, Conv_fmt_flags_t,
931 			    conv_iter_cb_t, void *);
932 extern	conv_iter_ret_t	conv_iter_ehdr_vers(Conv_fmt_flags_t, conv_iter_cb_t,
933 			    void *);
934 
935 extern	conv_iter_ret_t	conv_iter_phdr_flags(conv_iter_osabi_t,
936 			    Conv_fmt_flags_t, conv_iter_cb_t, void *);
937 extern	conv_iter_ret_t	conv_iter_phdr_type(conv_iter_osabi_t, Conv_fmt_flags_t,
938 			    conv_iter_cb_t, void *);
939 
940 extern	conv_iter_ret_t	conv_iter_sec_flags(conv_iter_osabi_t, Half,
941 			    Conv_fmt_flags_t, conv_iter_cb_t, void *);
942 extern	conv_iter_ret_t	conv_iter_sec_symtab(conv_iter_osabi_t,
943 			    Conv_fmt_flags_t, conv_iter_cb_t, void *);
944 extern	conv_iter_ret_t	conv_iter_sec_type(conv_iter_osabi_t, Half,
945 			    Conv_fmt_flags_t, conv_iter_cb_t, void *);
946 
947 extern	conv_iter_ret_t	conv_iter_sym_info_bind(Conv_fmt_flags_t,
948 			    conv_iter_cb_t, void *);
949 extern	conv_iter_ret_t	conv_iter_sym_other_vis(Conv_fmt_flags_t,
950 			    conv_iter_cb_t, void *);
951 extern	conv_iter_ret_t	conv_iter_sym_shndx(conv_iter_osabi_t, Half,
952 			    Conv_fmt_flags_t, conv_iter_cb_t, void *);
953 extern	conv_iter_ret_t	conv_iter_sym_info_type(Half, Conv_fmt_flags_t,
954 			    conv_iter_cb_t, void *);
955 
956 extern	conv_iter_ret_t	conv_iter_syminfo_boundto(Conv_fmt_flags_t,
957 			    conv_iter_cb_t, void *);
958 extern	conv_iter_ret_t	conv_iter_syminfo_flags(Conv_fmt_flags_t,
959 			    conv_iter_cb_t, void *);
960 
961 /*
962  * Define all class specific routines.
963  */
964 #if	defined(_ELF64)
965 #define	conv_cap_tag		conv64_cap_tag
966 #define	conv_cap_val		conv64_cap_val
967 #define	conv_cap_val_hw1	conv64_cap_val_hw1
968 #define	conv_cap_val_hw2	conv64_cap_val_hw2
969 #define	conv_cap_val_sf1	conv64_cap_val_sf1
970 #define	conv_dyn_feature1	conv64_dyn_feature1
971 #define	conv_dyn_flag1		conv64_dyn_flag1
972 #define	conv_dyn_flag		conv64_dyn_flag
973 #define	conv_dyn_posflag1	conv64_dyn_posflag1
974 #define	conv_dyn_tag		conv64_dyn_tag
975 #define	_conv_expn_field	_conv64_expn_field
976 #define	_conv_expn_field2	_conv64_expn_field2
977 #define	conv_invalid_val	conv64_invalid_val
978 #define	conv_sec_flags		conv64_sec_flags
979 #define	conv_sec_linkinfo	conv64_sec_linkinfo
980 #define	conv_sym_value		conv64_sym_value
981 #define	conv_sym_SPARC_value	conv64_sym_SPARC_value
982 #else
983 #define	conv_cap_tag		conv32_cap_tag
984 #define	conv_cap_val		conv32_cap_val
985 #define	conv_cap_val_hw1	conv32_cap_val_hw1
986 #define	conv_cap_val_hw2	conv32_cap_val_hw2
987 #define	conv_cap_val_sf1	conv32_cap_val_sf1
988 #define	conv_dyn_feature1	conv32_dyn_feature1
989 #define	conv_dyn_flag1		conv32_dyn_flag1
990 #define	conv_dyn_flag		conv32_dyn_flag
991 #define	conv_dyn_posflag1	conv32_dyn_posflag1
992 #define	conv_dyn_tag		conv32_dyn_tag
993 #define	_conv_expn_field	_conv32_expn_field
994 #define	_conv_expn_field2	_conv32_expn_field2
995 #define	conv_invalid_val	conv32_invalid_val
996 #define	conv_sec_flags		conv32_sec_flags
997 #define	conv_sec_linkinfo	conv32_sec_linkinfo
998 #define	conv_sym_value		conv32_sym_value
999 #define	conv_sym_SPARC_value	conv32_sym_SPARC_value
1000 #endif
1001 
1002 /*
1003  * ELFCLASS-specific core formatting functionality
1004  */
1005 extern	int		_conv_expn_field(CONV_EXPN_FIELD_ARG *,
1006 			    const Val_desc *, Conv_fmt_flags_t, const char *);
1007 extern	int		_conv_expn_field2(CONV_EXPN_FIELD_ARG *, uchar_t,
1008 			    Half, const Val_desc2 *, Conv_fmt_flags_t,
1009 			    const char *);
1010 extern	const char	*conv_invalid_val(Conv_inv_buf_t *, Xword,
1011 			    Conv_fmt_flags_t);
1012 
1013 /*
1014  * ELFCLASS-specific formatting interfaces.
1015  */
1016 extern	const char	*conv_cap_tag(Xword, Conv_fmt_flags_t,
1017 			    Conv_inv_buf_t *);
1018 extern	const char	*conv_cap_val(Xword, Xword, Half, Conv_fmt_flags_t,
1019 			    Conv_cap_val_buf_t *);
1020 extern	const char	*conv_cap_val_hw1(Xword, Half, Conv_fmt_flags_t,
1021 			    Conv_cap_val_hw1_buf_t *);
1022 extern	const char	*conv_cap_val_hw2(Xword, Half, Conv_fmt_flags_t,
1023 			    Conv_cap_val_hw2_buf_t *);
1024 extern	const char	*conv_cap_val_sf1(Xword, Half, Conv_fmt_flags_t,
1025 			    Conv_cap_val_sf1_buf_t *);
1026 extern	const char	*conv_dyn_flag1(Xword, Conv_fmt_flags_t,
1027 			    Conv_dyn_flag1_buf_t *);
1028 extern	const char	*conv_dyn_flag(Xword, Conv_fmt_flags_t,
1029 			    Conv_dyn_flag_buf_t *);
1030 extern	const char	*conv_dyn_posflag1(Xword, Conv_fmt_flags_t,
1031 			    Conv_dyn_posflag1_buf_t *);
1032 extern	const char	*conv_dyn_tag(Xword, uchar_t, Half, Conv_fmt_flags_t,
1033 			    Conv_inv_buf_t *);
1034 extern	const char	*conv_dyn_feature1(Xword, Conv_fmt_flags_t,
1035 			    Conv_dyn_feature1_buf_t *);
1036 extern	const char	*conv_sec_flags(uchar_t osabi, Half mach, Xword,
1037 			    Conv_fmt_flags_t, Conv_sec_flags_buf_t *);
1038 extern	const char	*conv_sec_linkinfo(Word, Xword, Conv_inv_buf_t *);
1039 extern	const char	*conv_sym_value(Half, uchar_t, Addr, Conv_inv_buf_t *);
1040 extern	const char	*conv_sym_SPARC_value(Addr, Conv_fmt_flags_t,
1041 			    Conv_inv_buf_t *);
1042 
1043 /*
1044  * Define macros for _conv_XXX() routines that accept local_sgs_msg as the
1045  * final argument. The macros hide that argument from the caller's view and
1046  * supply the SGS message array for the file from which the macro is used
1047  * in its place. This trick is used to allow these functions to access the
1048  * message strings from any source file they are called from.
1049  */
1050 #define	conv_expn_field(_arg, _vdp, _fmt_flags) \
1051     _conv_expn_field(_arg, _vdp, _fmt_flags, MSG_SGS_LOCAL_ARRAY)
1052 
1053 #define	conv_expn_field2(_arg, _osabi, _mach, _vdp, _fmt_flags) \
1054     _conv_expn_field2(_arg, _osabi, _mach, _vdp, _fmt_flags, \
1055     MSG_SGS_LOCAL_ARRAY)
1056 
1057 #define	conv_iter_ds(_osabi, _mach, _dsp, _func, _uvalue) \
1058     _conv_iter_ds(_osabi, _mach, _dsp, _func, _uvalue, MSG_SGS_LOCAL_ARRAY)
1059 
1060 #define	conv_iter_vd(_vdp, _func, _uvalue)	\
1061     _conv_iter_vd(_vdp, _func, _uvalue, MSG_SGS_LOCAL_ARRAY)
1062 
1063 #define	conv_iter_vd2(_osabi, _mach, _vdp, _func, _uvalue)		\
1064     _conv_iter_vd2(_osabi, _mach, _vdp, _func, _uvalue, MSG_SGS_LOCAL_ARRAY)
1065 
1066 #define	conv_map_ds(_osabi, _mach, _value, _dsp, _fmt_flags, _inv_buf) \
1067     _conv_map_ds(_osabi, _mach, _value, _dsp, _fmt_flags, _inv_buf, \
1068     MSG_SGS_LOCAL_ARRAY)
1069 
1070 
1071 #ifdef	__cplusplus
1072 }
1073 #endif
1074 
1075 #endif /* _CONV_H */
1076