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