xref: /opensolaris-onvv-gate/usr/src/cmd/sgs/libconv/common/phdr.c

/*
 * 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
 * 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 2007 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#pragma ident	"%Z%%M%	%I%	%E% SMI"

/*
 * String conversion routines for program header attributes.
 */
#include	<string.h>
#include	<_conv.h>
#include	<phdr_msg.h>

/* Instantiate a local copy of conv_map2str() from _conv.h */
DEFINE_conv_map2str

const char *
conv_phdr_type(Half mach, Word type, int fmt_flags, Conv_inv_buf_t *inv_buf)
{
	static const Msg	phdrs[] = {
		MSG_PT_NULL,		MSG_PT_LOAD,
		MSG_PT_DYNAMIC,		MSG_PT_INTERP,
		MSG_PT_NOTE,		MSG_PT_SHLIB,
		MSG_PT_PHDR,		MSG_PT_TLS
	};
	static const Msg	phdrs_alt[] = {
		MSG_PT_NULL_ALT,	MSG_PT_LOAD_ALT,
		MSG_PT_DYNAMIC_ALT,	MSG_PT_INTERP_ALT,
		MSG_PT_NOTE_ALT,	MSG_PT_SHLIB_ALT,
		MSG_PT_PHDR_ALT,	MSG_PT_TLS_ALT
	};
#if PT_NUM != (PT_TLS + 1)
error "PT_NUM has grown. Update phdrs[]"
#endif
	static const Msg uphdrs[] = {
		MSG_PT_SUNWBSS,		MSG_PT_SUNWSTACK,
		MSG_PT_SUNWDTRACE,	MSG_PT_SUNWCAP
	};
	static const Msg uphdrs_alt[] = {
		MSG_PT_SUNWBSS_ALT,	MSG_PT_SUNWSTACK_ALT,
		MSG_PT_SUNWDTRACE_ALT,	MSG_PT_SUNWCAP_ALT
	};
#if PT_LOSUNW != PT_SUNWBSS
#error "PT_LOSUNW has grown. Update uphdrs[]"
#endif

	if (type < PT_NUM) {
		return (conv_map2str(inv_buf, type, fmt_flags,
		    ARRAY_NELTS(phdrs), phdrs, phdrs_alt, phdrs_alt));
	} else if ((type >= PT_SUNWBSS) && (type <= PT_HISUNW)) {
		return (conv_map2str(inv_buf, (type - PT_SUNWBSS), fmt_flags,
		    ARRAY_NELTS(uphdrs), uphdrs, uphdrs_alt, uphdrs_alt));
	} else if ((type == PT_SUNW_UNWIND) && (mach == EM_AMD64)) {
		return ((fmt_flags & CONV_FMTALTMASK) ?
		    MSG_ORIG(MSG_PT_SUNW_UNWIND_ALT) :
		    MSG_ORIG(MSG_PT_SUNW_UNWIND));
	} else
		return (conv_invalid_val(inv_buf, type, 0));
}

#define	PHDRSZ	CONV_EXPN_FIELD_DEF_PREFIX_SIZE + \
		MSG_PF_X_SIZE	+ CONV_EXPN_FIELD_DEF_SEP_SIZE + \
		MSG_PF_W_SIZE	+ CONV_EXPN_FIELD_DEF_SEP_SIZE + \
		MSG_PF_R_SIZE	+ CONV_EXPN_FIELD_DEF_SEP_SIZE + \
		MSG_PF_SUNW_FAILURE_SIZE + CONV_EXPN_FIELD_DEF_SEP_SIZE + \
		CONV_INV_BUFSIZE + CONV_EXPN_FIELD_DEF_SUFFIX_SIZE

/*
 * Ensure that Conv_phdr_flags_buf_t is large enough:
 *
 * PHDRSZ is the real minimum size of the buffer required by conv_phdr_flags().
 * However, Conv_phdr_flags_buf_t uses CONV_PHDR_FLAGS_BUFSIZE to set the
 * buffer size. We do things this way because the definition of PHDRSZ uses
 * information that is not available in the environment of other programs
 * that include the conv.h header file.
 */
#if CONV_PHDR_FLAGS_BUFSIZE < PHDRSZ
#error "CONV_PHDR_FLAGS_BUFSIZE is not large enough"
#endif

const char *
conv_phdr_flags(Word flags, Conv_phdr_flags_buf_t *phdr_flags_buf)
{
	static Val_desc vda[] = {
		{ PF_X,			MSG_ORIG(MSG_PF_X) },
		{ PF_W,			MSG_ORIG(MSG_PF_W) },
		{ PF_R,			MSG_ORIG(MSG_PF_R) },
		{ PF_SUNW_FAILURE,	MSG_ORIG(MSG_PF_SUNW_FAILURE) },
		{ 0,			0 }
	};
	static CONV_EXPN_FIELD_ARG conv_arg = {
	    NULL, sizeof (phdr_flags_buf->buf), vda };

	if (flags == 0)
		return (MSG_ORIG(MSG_GBL_ZERO));

	conv_arg.buf = phdr_flags_buf->buf;
	conv_arg.oflags = conv_arg.rflags = flags;
	(void) conv_expn_field(&conv_arg);

	return ((const char *)phdr_flags_buf->buf);
}