_map.h revision 1007fd6fd24227460e77ce89f5ca85641a85a576
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
*/
/*
* Local include file for libld mapfile subsystem.
*/
#ifndef _MAP_DOT_H
#define _MAP_DOT_H
#ifdef __cplusplus
extern "C" {
#endif
/*
* Macro used to size name buffer corresponding to a NULL terminated array
* of structures each of which contains a name string. Macro is used per-name.
* 2 extra characters are allowed per item to allow for a ', ' delimiter
* or NULL termination.
*/
/*
* Variant of isspace() that excludes newline characters. Requires <ctype.h>.
*/
/*
* Type used to insert NULL characters in the mapfile text and later
* back them out and restore the original character. The mapfile text
* is held in a single string, so when we want to access sub-strings,
* it is necessary to temporarily insert NULLs to prevent the entire
* mapfile from that point forward being output.
*/
typedef struct {
char *np_ptr; /* Address patched with NULL character */
char np_ch; /* Character originally found at *np_ptr */
/*
* ld_map_gettoken() uses a table of 128 bytes to determine how to
* process a token starting with any 7-bit ASCII value. The table is
* indexed by the character code, and returns one of the TK_* token values.
*/
typedef const char mf_tokdisp_t[128];
/*
* The definition of an unquoted identifier differs based on the mapfile
* version. Rather than write a separate function to locate identifiers
* for each version, we use a single function that relies on a per-character
* table that encodes which characters can start an identifier, and which
* can continue one, for each supported mapfile version.
*
* Two bits are used for each version, one for the start attribute, and the
* other for continuation. The first two bits are not used (version 0), the
* next 2 are used for version 1, the following 2 for version 2, and so on.
*/
#define TKID_ATTR_B_START 1
#define TKID_ATTR_B_CONT 2
/* Convenience macros for chars that both start and continue an identifier */
/*
* State for a mapfile held in memory.
*/
typedef struct {
char *mf_name; /* Mapfile name */
/* descriptor from ld_map_ifl() */
char *mf_text; /* Text of mapfile */
char *mf_next; /* Next char in mapfile to examine */
const char *mf_tokdisp; /* mf_tokdisp_t dispatch table to use */
int mf_version; /* Mapfile syntax version */
int mf_tkid_start; /* TKID bitvalue for characters that */
/* start an unquoted identifier */
int mf_tkid_cont; /* TKID bitvalue for characters that */
/* continue an unquoted ident. */
int mf_next_ch; /* 0, or character read from *mf_next */
/* prior to inserting NULL */
/* Each mapfile starts at the */
/* top, inserting each ec in the */
/* file in the order seen. */
} Mapfile;
/*
* A very large percentage of mapfile errors start with the
* calling sequence:
* ld_eprintf(ofl, ERR_XXX, format, mf->mf_name, mf->mf_lineno...)
* The mf_fatal() and mf_warn() varadic macros are used to supply all
* of boilerplate, resulting in visually simpler code.
*
* mf_fatal0()/mf_warn0() are used when the format does not require any
* additional arguments and the varargs list is empty. The GNU cpp has a
* syntax for eliminating the extra comma (, ##__VA_ARGS__), but this isn't
* supported by the Sun compilers yet.
*/
/* Possible return values from ld_map_gettoken */
typedef enum {
TK_EOF = 0, /* End of file: Requires TK_F_EOFOK to be set */
/* or EOF results in TK_ERROR */
/*
* Items below this point are for the use of ld_map_gettoken().
* They indicate a character that requires the lexical analyzer
* to carry out some additional computation (OPeration), resulting
* in one of the simple token types above, which is returned to
* the caller. The TK_OP_ tokens are implementation details that are
* never returned to a caller of ld_map_gettoken().
*/
TK_OP_EOF, /* end of file */
TK_OP_ILLCHR, /* unprintable illegal character */
TK_OP_BADCHR, /* printable but unexpected character */
TK_OP_WS, /* whitespace */
TK_OP_NL, /* newline */
TK_OP_SIMQUOTE, /* simple quoting */
TK_OP_CQUOTE, /* quoting with C string literal escapes */
TK_OP_CMT, /* Comment */
TK_OP_CDIR, /* Control directive */
TK_OP_NUM, /* Decimial, hex, or octal value */
TK_OP_ID, /* unquoted identifier using syntax rules */
/* appropriate for mapfile version */
TK_OP_CEQUAL, /* One of += or -= */
} Token;
/*
* Type used by ld_map_gettoken() to return values for token types that
* have them.
*/
typedef union {
char *tkv_str; /* TK_STRING */
struct { /* TK_INT */
char *tkvi_str; /* String making up integer */
} tkv_int;
/*
* Values for gettoken() flags argument. These flags are used to
* alter gettoken() default behavior under certain conditions.
*/
/* TK_ERROR "premature EOF" error */
/* quoted TK_STRING tokens */
/*
* Possible return values from ld_map_strtoxword()
*/
typedef enum {
STRTOXWORD_OK, /* Operation successful */
STRTOXWORD_TOOBIG, /* Otherwise valid value is too large */
STRTOXWORD_BAD /* String not recognized as an integer */
/*
* Possible return values from ld_map_seg_insert()
*/
typedef enum {
SEG_INS_OK = 0, /* Segment was inserted */
/*
* Enumeration of different symbol scope possible in a mapfile
*/
typedef enum {
FLG_SCOPE_HIDD, /* symbol defined hidden/local */
FLG_SCOPE_DFLT, /* symbol defined default/global */
FLG_SCOPE_PROT, /* symbol defined protected/symbolic */
FLG_SCOPE_EXPT, /* symbol defined exported */
FLG_SCOPE_SNGL, /* symbol defined singleton */
FLG_SCOPE_ELIM /* symbol defined eliminate */
/* State of a mapfile symbol version */
typedef struct {
const char *mv_name; /* NULL, or version name */
} ld_map_ver_t;
/* State of a mapfile symbol definition */
typedef struct {
const char *ms_name; /* symbol name */
const char *ms_filtee; /* NULL or filtee name */
} ld_map_sym_t;
#if defined(_ELF64)
#define ld_map_dv ld64_map_dv
#define ld_map_dv_entry ld64_map_dv_entry
#define ld_map_gettoken ld64_map_gettoken
#define ld_map_ifl ld64_map_ifl
#define ld_map_parse_v1 ld64_map_parse_v1
#define ld_map_parse_v2 ld64_map_parse_v2
#define ld_map_seg_alloc ld64_map_seg_alloc
#define ld_map_seg_index ld64_map_seg_index
#define ld_map_seg_insert ld64_map_seg_insert
#define ld_map_seg_lookup ld64_map_seg_lookup
#define ld_map_seg_stack ld64_map_seg_stack
#define ld_map_strtoxword ld64_map_strtoxword
#define ld_map_sym_enter ld64_map_sym_enter
#define ld_map_sym_filtee ld64_map_sym_filtee
#define ld_map_sym_scope ld64_map_sym_scope
#define ld_map_tokenstr ld64_map_tokenstr
#else
#define ld_map_dv ld32_map_dv
#define ld_map_dv_entry ld32_map_dv_entry
#define ld_map_gettoken ld32_map_gettoken
#define ld_map_ifl ld32_map_ifl
#define ld_map_parse_v1 ld32_map_parse_v1
#define ld_map_parse_v2 ld32_map_parse_v2
#define ld_map_seg_alloc ld32_map_seg_alloc
#define ld_map_seg_index ld32_map_seg_index
#define ld_map_seg_insert ld32_map_seg_insert
#define ld_map_seg_lookup ld32_map_seg_lookup
#define ld_map_seg_stack ld32_map_seg_stack
#define ld_map_strtoxword ld32_map_strtoxword
#define ld_map_sym_enter ld32_map_sym_enter
#define ld_map_sym_filtee ld32_map_sym_filtee
#define ld_map_sym_scope ld32_map_sym_scope
#define ld_map_tokenstr ld32_map_tokenstr
#endif
/*
* Core functions used to parse mapfiles
*/
extern void ld_map_lowercase(char *);
extern ld_map_strtoxword_t ld_map_strtoxword(const char *restrict,
char **restrict, Xword *);
Conv_inv_buf_t *);
/*
* Support code shared between the different mapfile parsing code, used to
* provide a common implementation manipulating link-editor state.
*/
const char *);
Word, const char *);
const char *);
const char *symname);
ld_map_sym_t *);
ld_map_sym_t *, Word, const char *);
extern void ld_map_sym_scope(Mapfile *, const char *,
ld_map_ver_t *);
#ifdef __cplusplus
}
#endif
#endif /* _MAP_DOT_H */