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