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