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