liblddbg/common/util.c

	util.c revision 5aefb6555731130ca4fd295960123d71f2d21fe8
/*
 * 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 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */
#pragma ident   "%Z%%M% %I% %E% SMI"

#include    "msg.h"
#include    "_debug.h"
#include    "libld.h"

/*
 * If any run-time linker debugging is being carried out always indicate the
 * fact and specify the point at which we transfer control to the main program.
 */
void
Dbg_util_call_main(Rt_map *lmp)
{
    Lm_list *lml = LIST(lmp);

    Dbg_util_nl(lml, DBG_NL_FRC);
    dbg_print(lml, MSG_INTL(MSG_UTL_TRANS), NAME(lmp));
    Dbg_util_nl(lml, DBG_NL_FRC);
}

void
Dbg_util_call_init(Rt_map *lmp, int flag)
{
    Lm_list     *lml = LIST(lmp);
    const char  *str;

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;

    if (flag == DBG_INIT_SORT)
        str = MSG_INTL(MSG_UTL_SORT);
    else if (flag == DBG_INIT_PEND)
        str = MSG_INTL(MSG_UTL_PEND);
    else if (flag == DBG_INIT_DYN)
        str = MSG_INTL(MSG_UTL_DYN);
    else
        str = MSG_INTL(MSG_UTL_DONE);

    Dbg_util_nl(lml, DBG_NL_STD);
    dbg_print(lml, MSG_INTL(MSG_UTL_INIT), str, NAME(lmp));
    Dbg_util_nl(lml, DBG_NL_STD);
}

void
Dbg_util_no_init(Rt_map *lmp)
{
    Lm_list *lml = LIST(lmp);

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;

    Dbg_util_nl(lml, DBG_NL_STD);
    dbg_print(lml, MSG_INTL(MSG_UTL_NOINIT), NAME(lmp));
    Dbg_util_nl(lml, DBG_NL_STD);
}

void
Dbg_util_intoolate(Rt_map *lmp)
{
    Lm_list *lml = LIST(lmp);

    Dbg_util_nl(lml, DBG_NL_STD);
    dbg_print(lml, MSG_INTL(MSG_UTL_INTOOLATE), NAME(lmp));
    Dbg_util_nl(lml, DBG_NL_STD);
}

void
Dbg_util_dbnotify(Lm_list *lml, rd_event_e event, r_state_e state)
{
    const char  *estr;
    const char  *sstr;

    if (DBG_NOTCLASS(DBG_C_FILES))
        return;
    if (DBG_NOTDETAIL())
        return;

    switch (event) {
    case RD_PREINIT:
        estr = MSG_ORIG(MSG_UTL_EVNT_PREINIT);
        sstr = MSG_INTL(MSG_STR_NULL);
        break;
    case RD_POSTINIT:
        estr = MSG_ORIG(MSG_UTL_EVNT_POSTINIT);
        sstr = MSG_INTL(MSG_STR_NULL);
        break;
    case RD_DLACTIVITY:
        estr = MSG_ORIG(MSG_UTL_EVNT_DLACT);
        switch (state) {
        case RT_CONSISTENT:
            sstr = MSG_ORIG(MSG_UTL_STA_CONSIST);
            break;
        case RT_ADD:
            sstr = MSG_ORIG(MSG_UTL_STA_ADD);
            break;
        case RT_DELETE:
            sstr = MSG_ORIG(MSG_UTL_STA_DELETE);
            break;
        default:
            sstr = MSG_INTL(MSG_STR_NULL);
            break;
        }
        break;
    default:
        sstr = MSG_INTL(MSG_STR_NULL);
        estr = MSG_INTL(MSG_STR_UNKNOWN);
        break;
    }

    Dbg_util_nl(lml, DBG_NL_STD);
    dbg_print(lml, MSG_INTL(MSG_UTL_DBNOTIFY), estr, sstr);
    Dbg_util_nl(lml, DBG_NL_STD);
}

void
Dbg_util_call_array(Rt_map *lmp, void *addr, int ndx, Word shtype)
{
    Lm_list     *lml = LIST(lmp);
    const char  *str;

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;

    if (shtype == SHT_INIT_ARRAY)
        str = MSG_ORIG(MSG_SCN_INITARRAY);
    else if (shtype == SHT_FINI_ARRAY)
        str = MSG_ORIG(MSG_SCN_FINIARRAY);
    else
        str = MSG_ORIG(MSG_SCN_PREINITARRAY);

    dbg_print(lml, MSG_INTL(MSG_UTL_ARRAY), str, ndx, EC_NATPTR(addr),
        NAME(lmp));
}

void
Dbg_util_call_fini(Rt_map *lmp)
{
    Lm_list *lml = LIST(lmp);

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;

    Dbg_util_nl(lml, DBG_NL_STD);
    dbg_print(lml, MSG_INTL(MSG_UTL_FINI), NAME(lmp));
    Dbg_util_nl(lml, DBG_NL_STD);
}

void
Dbg_util_str(Lm_list *lml, const char *str)
{
    Dbg_util_nl(lml, DBG_NL_STD);
    Dbg_util_nl(lml, DBG_NL_FRC);
    dbg_print(lml, MSG_ORIG(MSG_FMT_STR), str);
    Dbg_util_nl(lml, DBG_NL_FRC);
    Dbg_util_nl(lml, DBG_NL_STD);
}

void
Dbg_util_scc_title(Lm_list *lml, int sec)
{
    const char  *_sec;

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;
    if (DBG_NOTDETAIL())
        return;

    if (sec)
        _sec = MSG_INTL(MSG_UTL_SCC_SUBI);
    else
        _sec = MSG_INTL(MSG_UTL_SCC_SUBF);

    Dbg_util_nl(lml, DBG_NL_STD);
    dbg_print(lml, MSG_INTL(MSG_UTL_SCC_TITLE), _sec);
}

void
Dbg_util_scc_entry(Rt_map *lmp, uint_t idx)
{
    if (DBG_NOTCLASS(DBG_C_INIT))
        return;
    if (DBG_NOTDETAIL())
        return;

    dbg_print(LIST(lmp), MSG_ORIG(MSG_UTL_SCC_ENTRY), idx, NAME(lmp));
}

void
Dbg_util_broadcast(Rt_map *lmp)
{
    Lm_list *lml = LIST(lmp);

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;
    if (DBG_NOTDETAIL())
        return;

    Dbg_util_nl(lml, DBG_NL_STD);
    dbg_print(lml, MSG_INTL(MSG_UTL_BROAD), NAME(lmp));
    Dbg_util_nl(lml, DBG_NL_STD);
}

void
Dbg_util_wait(Rt_map *clmp, Rt_map *dlmp, int what)
{
    Lm_list     *lml = LIST(clmp);
    const char  *str;

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;
    if (DBG_NOTDETAIL())
        return;

    if (what == DBG_WAIT_INIT)
        str = MSG_ORIG(MSG_SCN_INIT);
    else if (what == DBG_WAIT_FINI)
        str = MSG_ORIG(MSG_SCN_FINI);
    else
        str = MSG_INTL(MSG_STR_SYMBOL);

    Dbg_util_nl(lml, DBG_NL_STD);
    dbg_print(lml, MSG_INTL(MSG_UTL_WAIT), str, NAME(clmp), NAME(dlmp));
    Dbg_util_nl(lml, DBG_NL_STD);
}

static  int ectoggle = 0;

void
Dbg_util_edge_in(Lm_list *lml, Rt_map *clmp, uint_t flags, Rt_map *dlmp,
    int ndx, int flag)
{
    const char  *str;

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;
    if (DBG_NOTDETAIL())
        return;

    if (flag & RT_SORT_REV)
        str = MSG_ORIG(MSG_SCN_INIT);
    else
        str = MSG_ORIG(MSG_SCN_FINI);

    if ((clmp == 0) || (ectoggle == 0))
        Dbg_util_nl(lml, DBG_NL_STD);
    if (clmp == 0) {
        dbg_print(lml, MSG_INTL(MSG_UTL_EDGE_TITLE), str);
        dbg_print(lml, MSG_INTL(MSG_UTL_EDGE_START), ndx, NAME(dlmp));
    } else
        dbg_print(lml, MSG_INTL(MSG_UTL_EDGE_IN), ndx, NAME(dlmp),
            NAME(clmp), conv_bnd_type(flags));

    ectoggle = 1;
}

void
Dbg_util_edge_out(Rt_map *clmp, Rt_map *dlmp)
{
    if (DBG_NOTCLASS(DBG_C_INIT))
        return;
    if (DBG_NOTDETAIL())
        return;

    dbg_print(LIST(clmp), MSG_INTL(MSG_UTL_EDGE_OUT), SORTVAL(clmp),
        NAME(clmp), NAME(dlmp));
}

void
Dbg_util_collect(Rt_map *lmp, int ndx, int flag)
{
    Lm_list     *lml = LIST(lmp);
    const char  *str;

    if (DBG_NOTCLASS(DBG_C_INIT))
        return;
    if (DBG_NOTDETAIL())
        return;

    if (flag & RT_SORT_REV)
        str = MSG_ORIG(MSG_SCN_INIT);
    else
        str = MSG_ORIG(MSG_SCN_FINI);

    if (ectoggle == 1) {
        Dbg_util_nl(lml, DBG_NL_STD);
        ectoggle = 0;
    }
    dbg_print(lml, MSG_INTL(MSG_UTL_COLLECT), ndx, NAME(lmp), str);
}

/*
 * Generic new line generator.  To prevent multiple newlines from being
 * generated, a flag is maintained in the global debug descriptor.  This flag
 * is cleared by the callers dbg_print() function to indicate that a newline
 * (actually, any line) has been printed.  Multiple newlines can be generated
 * using the DBG_NL_FRC flag.
 */
void
Dbg_util_nl(Lm_list *lml, int flag)
{
    if ((flag == DBG_NL_STD) && (dbg_desc->d_extra & DBG_E_STDNL))
        return;

    dbg_print(lml, MSG_ORIG(MSG_STR_EMPTY));

    if (flag == DBG_NL_STD)
        dbg_desc->d_extra |= DBG_E_STDNL;
}

/*
 * Define name demanglers.
 */
const char *
Dbg_demangle_name(const char *name)
{
    if (DBG_NOTCLASS(DBG_C_DEMANGLE))
        return (name);

    return (conv_demangle_name(name));
}

const char *
Elf_demangle_name(const char *name)
{
    if (DBG_ISDEMANGLE())
        return (conv_demangle_name(name));
    return (name);
}