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