17c478bd9Sstevel@tonic-gate /* 27c478bd9Sstevel@tonic-gate * CDDL HEADER START 37c478bd9Sstevel@tonic-gate * 47c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5*99f63845Sab * Common Development and Distribution License (the "License"). 6*99f63845Sab * You may not use this file except in compliance with the License. 77c478bd9Sstevel@tonic-gate * 87c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 97c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 107c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 117c478bd9Sstevel@tonic-gate * and limitations under the License. 127c478bd9Sstevel@tonic-gate * 137c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 147c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 157c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 167c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 177c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 187c478bd9Sstevel@tonic-gate * 197c478bd9Sstevel@tonic-gate * CDDL HEADER END 207c478bd9Sstevel@tonic-gate */ 217c478bd9Sstevel@tonic-gate /* 22*99f63845Sab * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 237c478bd9Sstevel@tonic-gate * Use is subject to license terms. 247c478bd9Sstevel@tonic-gate */ 257c478bd9Sstevel@tonic-gate 267c478bd9Sstevel@tonic-gate #ifndef _ELFCAP_DOT_H 277c478bd9Sstevel@tonic-gate #define _ELFCAP_DOT_H 287c478bd9Sstevel@tonic-gate 297c478bd9Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI" 307c478bd9Sstevel@tonic-gate 317c478bd9Sstevel@tonic-gate #include <sys/types.h> 327c478bd9Sstevel@tonic-gate 337c478bd9Sstevel@tonic-gate #ifdef __cplusplus 347c478bd9Sstevel@tonic-gate extern "C" { 357c478bd9Sstevel@tonic-gate #endif 367c478bd9Sstevel@tonic-gate 377c478bd9Sstevel@tonic-gate /* 38*99f63845Sab * The elfcap code handles mappings to and from several string styles. 39*99f63845Sab * The caller uses elfcap_style_t to specify the style to use. 40*99f63845Sab */ 41*99f63845Sab typedef enum { 42*99f63845Sab ELFCAP_STYLE_FULL = 1, /* Full formal name (e.g. AV_386_SSE) */ 43*99f63845Sab ELFCAP_STYLE_UC = 2, /* Informal upper case (e.g. SSE) */ 44*99f63845Sab ELFCAP_STYLE_LC = 3 /* Informal lower case (e.g. sse) */ 45*99f63845Sab } elfcap_style_t; 46*99f63845Sab 47*99f63845Sab /* 48*99f63845Sab * String descriptor: Contains the string and strlen(string). elfcap can 49*99f63845Sab * be used in contexts (ld.so.1) where we do not want to make calls to 50*99f63845Sab * string processing functions, so the length is calculated at compile time. 517c478bd9Sstevel@tonic-gate */ 527c478bd9Sstevel@tonic-gate typedef struct { 53*99f63845Sab const char *s_str; 54*99f63845Sab size_t s_len; 55*99f63845Sab } elfcap_str_t; 56*99f63845Sab 57*99f63845Sab /* 58*99f63845Sab * Capabilities descriptor: This maps the integer bit value 59*99f63845Sab * (c_val) to/from the various strings that represent it. 60*99f63845Sab * 61*99f63845Sab * c_val is normally expected to be a non-zero power of 2 62*99f63845Sab * value (i.e. a single set bit). The value 0 is special, and 63*99f63845Sab * used to represent a "reserved" placeholder in an array of 64*99f63845Sab * capabilities. These reserved values have NULL string pointers, 65*99f63845Sab * and are intended to be ignored by the processing code. 66*99f63845Sab */ 67*99f63845Sab typedef struct { 68*99f63845Sab uint64_t c_val; /* Bit value */ 69*99f63845Sab elfcap_str_t c_full; /* ELFCAP_STYLE_FULL */ 70*99f63845Sab elfcap_str_t c_uc; /* ELFCAP_STYLE_UC */ 71*99f63845Sab elfcap_str_t c_lc; /* ELFCAP_STYLE_LC */ 72*99f63845Sab } elfcap_desc_t; 73*99f63845Sab 74*99f63845Sab /* 75*99f63845Sab * Valid format values: The various formats in which a generated 76*99f63845Sab * string representing bitmap values can be displayed. 77*99f63845Sab * 78*99f63845Sab * This must be kept in sync with the format[] array in elfcap.c. 79*99f63845Sab */ 80*99f63845Sab typedef enum { 81*99f63845Sab ELFCAP_FMT_SNGSPACE = 0, 82*99f63845Sab ELFCAP_FMT_DBLSPACE = 1, 83*99f63845Sab ELFCAP_FMT_PIPSPACE = 2 84*99f63845Sab } elfcap_fmt_t; 857c478bd9Sstevel@tonic-gate 867c478bd9Sstevel@tonic-gate /* 87*99f63845Sab * Error codes: 887c478bd9Sstevel@tonic-gate */ 89*99f63845Sab typedef enum { 90*99f63845Sab ELFCAP_ERR_NONE = 0, /* no error */ 91*99f63845Sab ELFCAP_ERR_BUFOVFL = 1, /* buffer overfow */ 92*99f63845Sab ELFCAP_ERR_INVFMT = 2, /* invalid format */ 93*99f63845Sab ELFCAP_ERR_UNKTAG = 3, /* unknown capabilities tag */ 94*99f63845Sab ELFCAP_ERR_UNKMACH = 4, /* unknown machine type */ 95*99f63845Sab ELFCAP_ERR_INVSTYLE = 5 /* unknown style */ 96*99f63845Sab } elfcap_err_t; 97*99f63845Sab 987c478bd9Sstevel@tonic-gate 997c478bd9Sstevel@tonic-gate /* 100*99f63845Sab * # of each type of capability known to the system. These values 101*99f63845Sab * must be kept in sync with the arrays found in elfcap.c 1027c478bd9Sstevel@tonic-gate */ 103*99f63845Sab #define ELFCAP_NUM_SF1 2 104*99f63845Sab #define ELFCAP_NUM_HW1_SPARC 16 105*99f63845Sab #define ELFCAP_NUM_HW1_386 25 106*99f63845Sab 1077c478bd9Sstevel@tonic-gate 108*99f63845Sab /* 109*99f63845Sab * Given a capability section tag and value, call the proper underlying 110*99f63845Sab * "to str" function to generate the string description. 111*99f63845Sab */ 112*99f63845Sab extern elfcap_err_t elfcap_tag_to_str(elfcap_style_t, uint64_t, 113*99f63845Sab uint64_t, char *, size_t, elfcap_fmt_t, ushort_t); 1147c478bd9Sstevel@tonic-gate 1157c478bd9Sstevel@tonic-gate /* 116*99f63845Sab * The functions that convert from a specific capability value to 117*99f63845Sab * a string representation all use the same common prototype. 1187c478bd9Sstevel@tonic-gate */ 119*99f63845Sab typedef elfcap_err_t elfcap_to_str_func_t(elfcap_style_t, uint64_t, char *, 120*99f63845Sab size_t, elfcap_fmt_t, ushort_t); 1217c478bd9Sstevel@tonic-gate 122*99f63845Sab extern elfcap_to_str_func_t elfcap_hw1_to_str; 123*99f63845Sab extern elfcap_to_str_func_t elfcap_sf1_to_str; 1247c478bd9Sstevel@tonic-gate 125*99f63845Sab /* 126*99f63845Sab * The reverse mapping: Given a string representation, turn it back into 127*99f63845Sab * integer form. 128*99f63845Sab */ 129*99f63845Sab typedef uint64_t elfcap_from_str_func_t(elfcap_style_t, 130*99f63845Sab const char *, ushort_t mach); 131*99f63845Sab 132*99f63845Sab extern elfcap_from_str_func_t elfcap_hw1_from_str; 133*99f63845Sab extern elfcap_from_str_func_t elfcap_sf1_from_str; 134*99f63845Sab 135*99f63845Sab /* 136*99f63845Sab * These functions give access to the individual descriptor arrays. 137*99f63845Sab * The caller is allowed to copy and use the string pointers contained 138*99f63845Sab * in the descriptors, but must not alter them. Functions are used instead 139*99f63845Sab * of making the arrays directly visible to preclude copy relocations in 140*99f63845Sab * non-pic code. 141*99f63845Sab */ 142*99f63845Sab extern const elfcap_desc_t *elfcap_getdesc_hw1_sparc(void); 143*99f63845Sab extern const elfcap_desc_t *elfcap_getdesc_hw1_386(void); 144*99f63845Sab extern const elfcap_desc_t *elfcap_getdesc_sf1(void); 1457c478bd9Sstevel@tonic-gate 1467c478bd9Sstevel@tonic-gate #ifdef __cplusplus 1477c478bd9Sstevel@tonic-gate } 1487c478bd9Sstevel@tonic-gate #endif 1497c478bd9Sstevel@tonic-gate 1507c478bd9Sstevel@tonic-gate #endif /* _ELFCAP_DOT_H */ 151