xref: /onnv-gate/usr/src/cmd/sgs/libconv/common/symbols.c (revision 574)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (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
 * or http://www.opensolaris.org/os/licensing.
 * 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
 */
/*
 * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */
#pragma ident	"%Z%%M%	%I%	%E% SMI"

/*
 * String conversion routines for symbol attributes.
 */
#include	<stdio.h>
#include	<demangle.h>
#include	"_conv.h"
#include	"symbols_msg.h"
#include	<sys/elf_SPARC.h>
#include	<sys/elf_amd64.h>

static const char vis_types[4] = {
	'D',	/* STV_DEFAULT */
	'I',	/* STV_INTERNAL */
	'H',	/* STV_HIDDEN */
	'P'	/* STV_PROTECTED */
	};

const char *
conv_sym_stother(uchar_t stother)
{
	uint_t	vis = ELF_ST_VISIBILITY(stother);
	static char	string[STRSIZE];
	uint_t	ndx = 0;

	string[ndx++] = vis_types[vis];
	/*
	 * If unkown bits are present in stother - throw out a '?'
	 */
	if (stother & ~MSK_SYM_VISIBILITY)
		string[ndx++] = '?';

	string[ndx++] = '\0';

	return (string);
}

static const Msg types[] = {
	MSG_STT_NOTYPE,		MSG_STT_OBJECT,		MSG_STT_FUNC,
	MSG_STT_SECTION,	MSG_STT_FILE,		MSG_STT_COMMON,
	MSG_STT_TLS
};

const char *
conv_info_type_str(ushort_t mach, uchar_t type)
{
	static char	string[STRSIZE] = { '\0' };


	if (type < STT_NUM)
		return (MSG_ORIG(types[type]));
	else if (((mach == EM_SPARC) || (mach == EM_SPARC32PLUS) ||
	    (mach == EM_SPARCV9)) && (type == STT_SPARC_REGISTER))
		return (MSG_ORIG(MSG_STT_REGISTER));
	else
		return (conv_invalid_str(string, STRSIZE, type, 0));
}

static const Msg binds[] = {
	MSG_STB_LOCAL,		MSG_STB_GLOBAL,		MSG_STB_WEAK
};

const char *
conv_info_bind_str(uchar_t bind)
{
	static char	string[STRSIZE] = { '\0' };

	if (bind >= STB_NUM)
		return (conv_invalid_str(string, STRSIZE, bind, 0));
	else
		return (MSG_ORIG(binds[bind]));
}

const char *
conv_shndx_str(ushort_t shndx)
{
	static	char	string[STRSIZE] = { '\0' };

	if (shndx == SHN_UNDEF)
		return (MSG_ORIG(MSG_SHN_UNDEF));
	else if (shndx == SHN_SUNW_IGNORE)
		return (MSG_ORIG(MSG_SHN_SUNW_IGNORE));
	else if (shndx == SHN_ABS)
		return (MSG_ORIG(MSG_SHN_ABS));
	else if (shndx == SHN_COMMON)
		return (MSG_ORIG(MSG_SHN_COMMON));
	else if (shndx == SHN_X86_64_LCOMMON)
		return (MSG_ORIG(MSG_SHN_X86_64_LCOMMON));
	else if (shndx == SHN_AFTER)
		return (MSG_ORIG(MSG_SHN_AFTER));
	else if (shndx == SHN_BEFORE)
		return (MSG_ORIG(MSG_SHN_BEFORE));
	else if (shndx == SHN_XINDEX)
		return (MSG_ORIG(MSG_SHN_XINDEX));
	else
		return (conv_invalid_str(string, STRSIZE, shndx, 1));
}

const char *
conv_sym_value_str(ushort_t mach, uint_t type, uint64_t value)
{
	static char	string[STRSIZE64] = { '\0' };
	const char	*fmt;

	if (((mach == EM_SPARC) || (mach == EM_SPARC32PLUS) ||
	    (mach == EM_SPARCV9)) && (type == STT_SPARC_REGISTER))
		return (conv_sym_SPARC_value_str(value));

	/*
	 * Should obtain the elf class rather than relying on e_machine here...
	 */
	if (mach == EM_SPARCV9)
		fmt = MSG_ORIG(MSG_FMT_VAL_64);
	else
		fmt = MSG_ORIG(MSG_FMT_VAL);

	(void) sprintf(string, fmt, EC_XWORD(value));
	return (string);
}

/*
 * Demangle C++ symbols.
 *
 * This routine acts as a generic routine for use by liblddbg (and hence tools
 * like elfdump(1) and pvs(1)), ld(1) and ld.so.1(1).
 *
 * The C++ ABI-2 places no limits on symbol names, thus when demangling a name
 * it's possible the buffer won't be big enough (DEMANGLE_ESPACE) so here we
 * try to allocate bigger buffers.  However, we place a limit on this buffer
 * size for fear of a C++ error sending us into an infinit loop.
 *
 * NOTE. we create and use a common buffer for use by cplus_demangle(), thus
 * each call to this routine will override the contents of any existing call.
 * Normally this is sufficient for typical error diagnostics referencing one
 * symbol.  For those diagnostics using more than one symbol name, all but the
 * last name must be copied to a temporary buffer (regardless of whether
 * demangling occurred, as the process of attempting to demangle may damage the
 * buffer).  One model is:
 *
 *	if ((_name1 = demangle(name1)) != name1) {
 *		char *	__name1 = alloca(strlen(_name1) + 1);
 *		(void) strcpy(__name1, _name1);
 *		name1 = (const char *)__name1;
 *	}
 *	name2 = demangle(name2);
 *	eprintf(format, name1, name2);
 */
#define	SYM_MAX	1000

const char *
conv_sym_dem(const char *name)
{
	static char	_str[SYM_MAX], *str = _str;
	static size_t	size = SYM_MAX;
	static int	again = 1;
	static int	(*fptr)() = 0;
	int		error;

	if (str == 0)
		return (name);

	/*
	 * If we haven't located the demangler yet try now (we do this rather
	 * than maintain a static dependency on libdemangle as it's part of an
	 * optional package).  Null the str element out to reject any other
	 * callers until this operation is complete - under ld.so.1 we can get
	 * into serious recursion without this.
	 */
	if (fptr == 0) {
		void	*hdl;

		str = 0;
		if (!(hdl = dlopen(MSG_ORIG(MSG_DEM_LIB), RTLD_LAZY)) ||
		    !(fptr = (int (*)())dlsym(hdl, MSG_ORIG(MSG_DEM_SYM))))
			return (name);
		str = _str;
	}

	if ((error = (*fptr)(name, str, size)) == 0)
		return ((const char *)str);

	while ((error == DEMANGLE_ESPACE) && again) {
		char	*_str;
		size_t	_size = size;

		/*
		 * If we haven't allocated our maximum try incrementing the
		 * present buffer size. Use malloc() rather than realloc() so
		 * that we at least have the old buffer on failure.
		 */
		if (((_size += SYM_MAX) > (SYM_MAX * 4)) ||
		    ((_str = malloc(_size)) == 0)) {
			again = 0;
			break;
		}
		if (size != SYM_MAX) {
			free(str);
		}
		str = _str;
		size = _size;

		if ((error = (*fptr)(name, str, size)) == 0)
			return ((const char *)str);
	}
	return (name);
}