path: root/usr/src/lib/libdwarf/common/dwarf_init_finish.c

/*

  Copyright (C) 2000,2002,2003,2004,2005 Silicon Graphics, Inc. All Rights Reserved.
  Portions Copyright (C) 2008-2010 Arxan Technologies, Inc. All Rights Reserved.
  Portions Copyright (C) 2009-2010 David Anderson. All Rights Reserved.

  This program is free software; you can redistribute it and/or modify it
  under the terms of version 2.1 of the GNU Lesser General Public License 
  as published by the Free Software Foundation.

  This program is distributed in the hope that it would be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  

  Further, this software is distributed without any warranty that it is
  free of the rightful claim of any third person regarding infringement 
  or the like.  Any license provided herein, whether implied or 
  otherwise, applies only to this software file.  Patent licenses, if
  any, provided herein do not apply to combinations of this program with 
  other software, or any other product whatsoever.  

  You should have received a copy of the GNU Lesser General Public 
  License along with this program; if not, write the Free Software 
  Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston MA 02110-1301,
  USA.

  Contact information:  Silicon Graphics, Inc., 1500 Crittenden Lane,
  Mountain View, CA 94043, or:

  http://www.sgi.com

  For further information regarding this notice, see:

  http://oss.sgi.com/projects/GenInfo/NoticeExplan

*/

#include "config.h"
#include "dwarf_incl.h"

#include <stdio.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <string.h>
#include <stdlib.h>

#include "dwarf_incl.h"
#include "malloc_check.h"

#define DWARF_DBG_ERROR(dbg,errval,retval) \
     _dwarf_error(dbg, error, errval); return(retval);

#define FALSE 0
#define TRUE  1



/* This static is copied to the dbg on dbg init
   so that the static need not be referenced at
   run time, preserving better locality of
   reference.
   Value is 0 means do the string check.
   Value non-zero means do not do the check.
*/
static Dwarf_Small _dwarf_assume_string_bad;
static Dwarf_Small _dwarf_apply_relocs = 1;

/* Call this after calling dwarf_init but before doing anything else.
 * It applies to all objects, not just the current object.
 */
int
dwarf_set_reloc_application(int apply)
{
    int oldval = _dwarf_apply_relocs;
    _dwarf_apply_relocs = apply;
    return oldval;
}

int
dwarf_set_stringcheck(int newval)
{
    int oldval = _dwarf_assume_string_bad;

    _dwarf_assume_string_bad = newval;
    return oldval;
}

/* Unifies the basic duplicate/empty testing and section
 * data setting to one place. */
static int
get_basic_section_data(Dwarf_Debug dbg,
    struct Dwarf_Section_s *secdata,
    struct Dwarf_Obj_Access_Section_s *doas,
    Dwarf_Half section_index,
    Dwarf_Error* error,
    int duperr, int emptyerr )
{
    if (secdata->dss_index != 0) {
        DWARF_DBG_ERROR(dbg, duperr, DW_DLV_ERROR);
    }
    if (doas->size == 0) {
        if (emptyerr == 0 ) {
            /* Allow empty section. */
            return DW_DLV_OK;
        }
        /* Know no reason to allow section */
        DWARF_DBG_ERROR(dbg, emptyerr, DW_DLV_ERROR);
    }
    secdata->dss_index = section_index;
    secdata->dss_size = doas->size;
    secdata->dss_addr = doas->addr;
    secdata->dss_link = doas->link;
    return DW_DLV_OK;
}


static void
add_rela_data( struct Dwarf_Section_s *secdata,
    struct Dwarf_Obj_Access_Section_s *doas,
    Dwarf_Half section_index)
{
    secdata->dss_reloc_index = section_index;
    secdata->dss_reloc_size = doas->size;
    secdata->dss_reloc_addr = doas->addr;
    secdata->dss_reloc_symtab = doas->link;
    secdata->dss_reloc_link = doas->link;
}

/*
    Given an Elf ptr, set up dbg with pointers
    to all the Dwarf data sections.
    Return NULL on error.

    This function is also responsible for determining
    whether the given object contains Dwarf information
    or not.  The test currently used is that it contains
    either a .debug_info or a .debug_frame section.  If 
    not, it returns DW_DLV_NO_ENTRY causing dwarf_init() also to 
    return DW_DLV_NO_ENTRY.  Earlier, we had thought of using only 
    the presence/absence of .debug_info to test, but we 
    added .debug_frame since there could be stripped objects 
    that have only a .debug_frame section for exception 
    processing.
    DW_DLV_NO_ENTRY or DW_DLV_OK or DW_DLV_ERROR
*/
static int
_dwarf_setup(Dwarf_Debug dbg, Dwarf_Error * error)
{
    const char *scn_name = 0;
    int foundDwarf = 0;
    struct Dwarf_Obj_Access_Interface_s * obj = 0;

    Dwarf_Endianness endianness;

    Dwarf_Unsigned section_size = 0;
    Dwarf_Unsigned section_count = 0;
    Dwarf_Half section_index = 0;
    Dwarf_Addr section_addr = 0;

    foundDwarf = FALSE;

    dbg->de_assume_string_in_bounds = _dwarf_assume_string_bad;

    dbg->de_same_endian = 1;
    dbg->de_copy_word = memcpy;
    obj = dbg->de_obj_file;
    endianness = obj->methods->get_byte_order(obj->object);
#ifdef WORDS_BIGENDIAN
    dbg->de_big_endian_object = 1;
    if (endianness == DW_OBJECT_LSB ) {
        dbg->de_same_endian = 0;
        dbg->de_big_endian_object = 0;
        dbg->de_copy_word = _dwarf_memcpy_swap_bytes;
    }
#else /* little endian */
    dbg->de_big_endian_object = 0;
    if (endianness == DW_OBJECT_MSB ) {
        dbg->de_same_endian = 0;
        dbg->de_big_endian_object = 1;
        dbg->de_copy_word = _dwarf_memcpy_swap_bytes;
    }
#endif /* !WORDS_BIGENDIAN */


    /* The following de_length_size is Not Too Significant. Only used
       one calculation, and an approximate one at that. */
    dbg->de_length_size = obj->methods->get_length_size(obj->object);
    dbg->de_pointer_size = obj->methods->get_pointer_size(obj->object);

    section_count = obj->methods->get_section_count(obj->object);

    /* We can skip index 0 when considering ELF files, but not other
       object types. */
    for (section_index = 0; section_index < section_count;
         ++section_index) {
        
        struct Dwarf_Obj_Access_Section_s doas;
        int res = DW_DLV_ERROR;
        int err;

        res = obj->methods->get_section_info(obj->object, 
                                             section_index, 
                                             &doas, &err);
        if(res == DW_DLV_ERROR){
          DWARF_DBG_ERROR(dbg, err, DW_DLV_ERROR);
        }

        section_addr = doas.addr;
        section_size = doas.size;
        scn_name = doas.name;

        if (strncmp(scn_name, ".debug_", 7)
            && strcmp(scn_name, ".eh_frame")
            && strcmp(scn_name, ".symtab")
            && strcmp(scn_name, ".strtab")
            && strncmp(scn_name, ".rela.",6))  {
            continue;
        }
        else if (strcmp(scn_name, ".debug_info") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_info, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_INFO_DUPLICATE,DW_DLE_DEBUG_INFO_NULL);
            if(res != DW_DLV_OK) {
                  return res;
            }
            foundDwarf = TRUE;
        }
        else if (strcmp(scn_name, ".debug_abbrev") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_abbrev, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_ABBREV_DUPLICATE,DW_DLE_DEBUG_ABBREV_NULL);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".debug_aranges") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_aranges, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_ARANGES_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }

        else if (strcmp(scn_name, ".debug_line") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_line, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_LINE_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".debug_frame") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_frame, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_FRAME_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
            foundDwarf = TRUE;
        } else if (strcmp(scn_name, ".eh_frame") == 0) {
            /* gnu egcs-1.1.2 data */
            res = get_basic_section_data(dbg,&dbg->de_debug_frame_eh_gnu, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_FRAME_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
            foundDwarf = TRUE;
        }
        else if (strcmp(scn_name, ".debug_loc") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_loc, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_LOC_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".debug_pubnames") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_pubnames, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_PUBNAMES_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }

        else if (strcmp(scn_name, ".debug_str") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_str, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_STR_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".debug_funcnames") == 0) {
            /* SGI IRIX-only. */
            res = get_basic_section_data(dbg,&dbg->de_debug_funcnames, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_FUNCNAMES_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".debug_typenames") == 0) {
            /* SGI IRIX-only, created years before DWARF3. Content
               essentially identical to .debug_pubtypes.  */
            res = get_basic_section_data(dbg,&dbg->de_debug_typenames, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_TYPENAMES_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        } else if (strcmp(scn_name, ".debug_pubtypes") == 0) {
            /* Section new in DWARF3.  */
            res = get_basic_section_data(dbg,&dbg->de_debug_pubtypes, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_PUBTYPES_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".debug_varnames") == 0) {
            /* SGI IRIX-only.  */
            res = get_basic_section_data(dbg,&dbg->de_debug_varnames, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_VARNAMES_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".debug_weaknames") == 0) {
            /* SGI IRIX-only. */
            res = get_basic_section_data(dbg,&dbg->de_debug_weaknames, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_WEAKNAMES_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        } else if (strcmp(scn_name, ".debug_macinfo") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_macinfo, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_MACINFO_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".debug_ranges") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_debug_ranges, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_RANGES_DUPLICATE,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
            foundDwarf = TRUE;
        }
        else if (strcmp(scn_name, ".symtab") == 0) {
            res = get_basic_section_data(dbg,&dbg->de_elf_symtab, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_SYMTAB_ERR,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strcmp(scn_name, ".strtab")  == 0) {
            res = get_basic_section_data(dbg,&dbg->de_elf_strtab, &doas,
                  section_index,error,
                  DW_DLE_DEBUG_STRTAB_ERR,0);
            if(res != DW_DLV_OK) {
                  return res;
            }
        }
        else if (strncmp(scn_name, ".rela.debug_",12) == 0) {
            const char *rcn_name = scn_name + 5;
            if (strcmp(rcn_name, ".debug_info") == 0) {
                add_rela_data(&dbg->de_debug_info,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_abbrev") == 0) {
                add_rela_data(&dbg->de_debug_abbrev,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_aranges") == 0) {
                add_rela_data(&dbg->de_debug_aranges,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_line") == 0) {
                add_rela_data(&dbg->de_debug_line,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_frame") == 0) {
                add_rela_data(&dbg->de_debug_frame,&doas,section_index);
            } else if (strcmp(rcn_name, ".eh_frame") == 0) {
                add_rela_data(&dbg->de_debug_frame_eh_gnu,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_loc") == 0) {
                add_rela_data(&dbg->de_debug_loc,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_pubnames") == 0) {
                add_rela_data(&dbg->de_debug_pubnames,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_str") == 0) {
                add_rela_data(&dbg->de_debug_str,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_funcnames") == 0) {
                add_rela_data(&dbg->de_debug_funcnames,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_typenames") == 0) {
                add_rela_data(&dbg->de_debug_typenames,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_pubtypes") == 0) {
                add_rela_data(&dbg->de_debug_pubtypes,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_varnames") == 0) {
                add_rela_data(&dbg->de_debug_varnames,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_weaknames") == 0) {
                add_rela_data(&dbg->de_debug_weaknames,&doas,section_index);
            } else if (strcmp(rcn_name, ".debug_macinfo") == 0) {
                add_rela_data(&dbg->de_debug_macinfo,&doas,section_index);
            }
        }
    }
    if (foundDwarf) {
        return DW_DLV_OK;
    }
    return DW_DLV_NO_ENTRY;
}


/*
    Use a Dwarf_Obj_Access_Interface to kick things off. All other 
    init routines eventually use this one.
    The returned Dwarf_Debug contains a copy of *obj
    the callers copy of *obj may be freed whenever the caller
    wishes.
*/
int 
dwarf_object_init(Dwarf_Obj_Access_Interface* obj, Dwarf_Handler errhand,
               Dwarf_Ptr errarg, Dwarf_Debug* ret_dbg, 
               Dwarf_Error* error)
{
    Dwarf_Debug dbg = 0;
    int setup_result = DW_DLV_OK;

    dbg = _dwarf_get_debug();
    if (dbg == NULL) {
        DWARF_DBG_ERROR(dbg, DW_DLE_DBG_ALLOC, DW_DLV_ERROR);
    }
    dbg->de_errhand = errhand;
    dbg->de_errarg = errarg;
    dbg->de_frame_rule_initial_value = DW_FRAME_REG_INITIAL_VALUE;
    dbg->de_frame_reg_rules_entry_count = DW_FRAME_LAST_REG_NUM;
#ifdef HAVE_OLD_FRAME_CFA_COL
    /* DW_FRAME_CFA_COL is really only suitable for old libdwarf frame
       interfaces and its value of 0 there is only usable where
       (as in MIPS) register 0 has no value other than 0 so
       we can use the frame table column 0 for the CFA value
       (and rely on client software to know when 'register 0'
       is the cfa and when to just use a value 0 for register 0). 
    */
    dbg->de_frame_cfa_col_number = DW_FRAME_CFA_COL;
#else
    dbg->de_frame_cfa_col_number = DW_FRAME_CFA_COL3;
#endif
    dbg->de_frame_same_value_number = DW_FRAME_SAME_VAL;
    dbg->de_frame_undefined_value_number  = DW_FRAME_UNDEFINED_VAL;

    dbg->de_obj_file = obj;

    setup_result = _dwarf_setup(dbg, error);
    if (setup_result != DW_DLV_OK) {
        /* The status we want to return  here is of _dwarf_setup,
           not of the  _dwarf_free_all_of_one_debug(dbg) call. 
           So use a local status variable for the free.  */
        int freeresult = _dwarf_free_all_of_one_debug(dbg);
        if (freeresult == DW_DLV_ERROR) {
            DWARF_DBG_ERROR(dbg, DW_DLE_DBG_ALLOC, DW_DLV_ERROR);
        }
        dwarf_malloc_check_complete("After Final free");
        return setup_result;
    }

    dwarf_harmless_init(&dbg->de_harmless_errors,
        DW_HARMLESS_ERROR_CIRCULAR_LIST_DEFAULT_SIZE);

    /* This call cannot fail: allocates nothing, releases nothing */
    _dwarf_setup_debug(dbg);


    *ret_dbg = dbg;
    return DW_DLV_OK;    
}


/*
    A finish routine that is completely unaware of ELF.

    Frees all memory that was not previously freed by
    dwarf_dealloc.
    Aside frmo certain categories.
 */
int 
dwarf_object_finish(Dwarf_Debug dbg, Dwarf_Error * error)
{
    int res = DW_DLV_OK;

    res = _dwarf_free_all_of_one_debug(dbg);
    if (res == DW_DLV_ERROR) {
        DWARF_DBG_ERROR(dbg, DW_DLE_DBG_ALLOC, DW_DLV_ERROR);
    }
    dwarf_malloc_check_complete("After Final free");

    return res;  
}


/*
    Load the ELF section with the specified index and set the
    pointer pointed to by section_data to the memory where it
    was loaded.
 */
int
_dwarf_load_section(Dwarf_Debug dbg,
    struct Dwarf_Section_s *section,
    Dwarf_Error * error)
{
    int res  = DW_DLV_ERROR;
    int err = 0;
    struct Dwarf_Obj_Access_Interface_s *o = 0;

    /* check to see if the section is already loaded */
    if (section->dss_data !=  NULL) {
        return DW_DLV_OK;
    }
    o = dbg->de_obj_file; 
    res = o->methods->load_section(
        o->object, section->dss_index, 
        &section->dss_data, &err);
    if(res == DW_DLV_ERROR){
        DWARF_DBG_ERROR(dbg, err, DW_DLV_ERROR);
    }
    if(_dwarf_apply_relocs == 0) {
        return res;
    }
    if(section->dss_reloc_size == 0) {
        return res;
    }
    if(!o->methods->relocate_a_section) {
        return res;
    }
    /*apply relocations */
    res = o->methods->relocate_a_section( o->object, section->dss_index,
        dbg, &err);
    if(res == DW_DLV_ERROR) {
        DWARF_DBG_ERROR(dbg, err, DW_DLV_ERROR);
    }
    return res;
}

/* This is a hack so clients can verify offsets.
   Added April 2005 so that debugger can detect broken offsets
   (which happened in an IRIX  -64 executable larger than 2GB
    using MIPSpro 7.3.1.3 compilers. A couple .debug_pubnames
    offsets were wrong.).
*/
int
dwarf_get_section_max_offsets(Dwarf_Debug dbg,
    Dwarf_Unsigned * debug_info_size,
    Dwarf_Unsigned * debug_abbrev_size,
    Dwarf_Unsigned * debug_line_size,
    Dwarf_Unsigned * debug_loc_size,
    Dwarf_Unsigned * debug_aranges_size,
    Dwarf_Unsigned * debug_macinfo_size,
    Dwarf_Unsigned * debug_pubnames_size,
    Dwarf_Unsigned * debug_str_size,
    Dwarf_Unsigned * debug_frame_size,
    Dwarf_Unsigned * debug_ranges_size,
    Dwarf_Unsigned * debug_typenames_size)
{
    *debug_info_size = dbg->de_debug_info.dss_size;
    *debug_abbrev_size = dbg->de_debug_abbrev.dss_size;
    *debug_line_size = dbg->de_debug_line.dss_size;
    *debug_loc_size = dbg->de_debug_loc.dss_size;
    *debug_aranges_size = dbg->de_debug_aranges.dss_size;
    *debug_macinfo_size = dbg->de_debug_macinfo.dss_size;
    *debug_pubnames_size = dbg->de_debug_pubnames.dss_size;
    *debug_str_size = dbg->de_debug_str.dss_size;
    *debug_frame_size = dbg->de_debug_frame.dss_size;
    *debug_ranges_size = dbg->de_debug_ranges.dss_size;
    *debug_typenames_size = dbg->de_debug_typenames.dss_size;
    return DW_DLV_OK;
}