libld/common/groups.c

	groups.c revision 0e233487902b546a8949e2147ff8af45b1afc77c
/*
 * 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 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#include    <stdio.h>
#include    <string.h>
#include    <link.h>
#include    <debug.h>
#include    "msg.h"
#include    "_libld.h"

/*
 * Define an AVL node for maintain group names, together with a compare function
 * for the Grp_node AVL tree.
 */
typedef struct {
    const char  *gn_name;   /* group name */
    Is_desc     *gn_isc;    /* group input section */
    avl_node_t  gn_avl;     /* avl book-keeping (see SGSOFFSETOF) */
    uint_t      gn_hash;    /* group name hash value */
} Grp_node;

static int
gnavl_compare(const void *n1, const void *n2)
{
    uint_t      hash1, hash2;
    const char  *st1, *st2;
    int     rc;

    hash1 = ((Grp_node *)n1)->gn_hash;
    hash2 = ((Grp_node *)n2)->gn_hash;

    if (hash1 > hash2)
        return (1);
    if (hash1 < hash2)
        return (-1);

    st1 = ((Grp_node *)n1)->gn_name;
    st2 = ((Grp_node *)n2)->gn_name;

    rc = strcmp(st1, st2);
    if (rc > 0)
        return (1);
    if (rc < 0)
        return (-1);
    return (0);
}

/*
 * Determine whether a (COMDAT) group has already been encountered.  If so,
 * indicate that the group descriptor has an overriding group (gd_oisc).  This
 * indication triggers the ld_place_section() to discard this group, while the
 * gd_oisc information provides for complete diagnostics of the override.
 * Otherwise, this is the first occurrence of this group, therefore the group
 * descriptor is saved for future comparisons.
 */
static uintptr_t
gpavl_loaded(Ofl_desc *ofl, Group_desc *gdp)
{
    Grp_node    gpn, *gpnp;
    avl_tree_t  *avlt;
    avl_index_t where;

    /*
     * Create an avl tree if required.
     */
    if ((avlt = ofl->ofl_groups) == 0) {
        if ((avlt = calloc(sizeof (avl_tree_t), 1)) == NULL)
            return (S_ERROR);
        avl_create(avlt, gnavl_compare, sizeof (Grp_node),
            SGSOFFSETOF(Grp_node, gn_avl));
        ofl->ofl_groups = avlt;
    }

    gpn.gn_name = gdp->gd_name;
    gpn.gn_hash = sgs_str_hash(gdp->gd_name);

    if ((gpnp = avl_find(avlt, &gpn, &where)) != NULL) {
        gdp->gd_oisc = gpnp->gn_isc;
        return (1);
    }

    /*
     * This is a new group, save it.
     */
    if ((gpnp = calloc(sizeof (Grp_node), 1)) == NULL)
        return (S_ERROR);

    gpnp->gn_name = gpn.gn_name;
    gpnp->gn_hash = gpn.gn_hash;
    gpnp->gn_isc = gdp->gd_isc;

    avl_insert(avlt, gpnp, where);
    return (0);
}

Group_desc *
ld_get_group(Ofl_desc *ofl, Is_desc *isp)
{
    Ifl_desc    *ifl = isp->is_file;
    uint_t      scnndx = isp->is_scnndx;
    Group_desc  *gdp;
    Aliste      idx;

    /*
     * Scan the GROUP sections associated with this file to find the
     * matching group section.
     */
    for (ALIST_TRAVERSE(ifl->ifl_groups, idx, gdp)) {
        size_t  ndx;
        Word    *data;

        if (isp->is_shdr->sh_type == SHT_GROUP) {
            if (isp->is_scnndx == gdp->gd_isc->is_scnndx)
                return (gdp);
            continue;
        }

        data = gdp->gd_data;
        for (ndx = 1; ndx < gdp->gd_cnt; ndx++) {
            if (data[ndx] == scnndx)
                return (gdp);
        }
    }

    eprintf(ofl->ofl_lml, ERR_FATAL, MSG_INTL(MSG_ELF_NOGROUPSECT),
        ifl->ifl_name, isp->is_name);
    ofl->ofl_flags |= FLG_OF_FATAL;
    return (NULL);
}

uintptr_t
ld_group_process(Is_desc *gisc, Ofl_desc *ofl)
{
    Ifl_desc    *gifl = gisc->is_file;
    Shdr        *sshdr, *gshdr = gisc->is_shdr;
    Is_desc     *isc;
    Sym     *sym;
    char        *str;
    Group_desc  gd;
    size_t      ndx;

    /*
     * Confirm that the sh_link points to a valid section.
     */
    if ((gshdr->sh_link == SHN_UNDEF) ||
        (gshdr->sh_link >= gifl->ifl_shnum) ||
        ((isc = gifl->ifl_isdesc[gshdr->sh_link]) == NULL)) {
        eprintf(ofl->ofl_lml, ERR_FATAL, MSG_INTL(MSG_FIL_INVSHLINK),
            gifl->ifl_name, gisc->is_name, EC_XWORD(gshdr->sh_link));
        ofl->ofl_flags |= FLG_OF_FATAL;
        return (0);
    }
    if (gshdr->sh_entsize == 0) {
        eprintf(ofl->ofl_lml, ERR_FATAL, MSG_INTL(MSG_FIL_INVSHENTSIZE),
            gifl->ifl_name, gisc->is_name, EC_XWORD(gshdr->sh_entsize));
        ofl->ofl_flags |= FLG_OF_FATAL;
        return (0);
    }

    /*
     * Get the associated symbol table.  Sanity check the sh_info field
     * (which points to the signature symbol table entry) against the size
     * of the symbol table.
     */
    sshdr = isc->is_shdr;
    sym = (Sym *)isc->is_indata->d_buf;

    if ((sshdr->sh_info == SHN_UNDEF) ||
        (gshdr->sh_info >= (Word)(sshdr->sh_size / sshdr->sh_entsize)) ||
        ((isc = gifl->ifl_isdesc[sshdr->sh_link]) == NULL)) {
        eprintf(ofl->ofl_lml, ERR_FATAL, MSG_INTL(MSG_FIL_INVSHINFO),
            gifl->ifl_name, gisc->is_name, EC_XWORD(gshdr->sh_info));
        ofl->ofl_flags |= FLG_OF_FATAL;
        return (0);
    }

    sym += gshdr->sh_info;

    /*
     * Get the symbol name from the associated string table.
     */
    str = (char *)isc->is_indata->d_buf;
    str += sym->st_name;

    /*
     * Generate a group descriptor.
     */
    gd.gd_isc = gisc;
    gd.gd_oisc = NULL;
    gd.gd_name = str;
    gd.gd_data = gisc->is_indata->d_buf;
    gd.gd_cnt = gisc->is_indata->d_size / sizeof (Word);

    /*
     * If this group is a COMDAT group, validate the signature symbol.
     */
    if ((gd.gd_data[0] & GRP_COMDAT) &&
        ((ELF_ST_BIND(sym->st_info) == STB_LOCAL) ||
        (sym->st_shndx == SHN_UNDEF))) {
        /* FATAL or ignore? */
        eprintf(ofl->ofl_lml, ERR_FATAL, MSG_INTL(MSG_GRP_INVALSYM),
            gifl->ifl_name, gisc->is_name, str);
        ofl->ofl_flags |= FLG_OF_FATAL;
        return (0);
    }

    /*
     * Validate the section indices within the group.  If this is a COMDAT
     * group, mark each section as COMDAT.
     */
    for (ndx = 1; ndx < gd.gd_cnt; ndx++) {
        Word    gndx;

        if ((gndx = gd.gd_data[ndx]) >= gifl->ifl_shnum) {
            eprintf(ofl->ofl_lml, ERR_FATAL,
                MSG_INTL(MSG_GRP_INVALNDX), gifl->ifl_name,
                gisc->is_name, ndx, gndx);
            ofl->ofl_flags |= FLG_OF_FATAL;
            return (0);
        }

        if (gd.gd_data[0] & GRP_COMDAT)
            gifl->ifl_isdesc[gndx]->is_flags |= FLG_IS_COMDAT;
    }

    /*
     * If this is a COMDAT group, determine whether this group has already
     * been encountered, or whether this is the first instance of the group.
     */
    if ((gd.gd_data[0] & GRP_COMDAT) &&
        (gpavl_loaded(ofl, &gd) == S_ERROR))
        return (S_ERROR);

    /*
     * Associate the group descriptor with this input file.
     */
    if (alist_append(&(gifl->ifl_groups), &gd, sizeof (Group_desc),
        AL_CNT_IFL_GROUPS) == NULL)
        return (S_ERROR);

    return (1);
}