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