Files
libdwarf-code/libdwarf/dwarf_alloc.c
David Anderson affafa89fb Removed trailing (and useless) whitespace from all the lines
containing it.  Many many files had such.
2014-01-29 15:02:07 -08:00

631 lines
20 KiB
C

/*
Copyright (C) 2000-2005 Silicon Graphics, Inc. All Rights Reserved.
Portions Copyright (C) 2007-2011 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
*/
/* The address of the Free Software Foundation is
Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
Boston, MA 02110-1301, USA.
SGI has moved from the Crittenden Lane address.
*/
#undef DEBUG
#include "config.h"
#include "dwarf_incl.h"
#include <sys/types.h>
#include <stdlib.h>
#include <stdio.h>
/* These files are included to get the sizes
of structs for malloc.
*/
#include "dwarf_line.h"
#include "dwarf_global.h"
#include "dwarf_arange.h"
#include "dwarf_abbrev.h"
#include "dwarf_die_deliv.h"
#include "dwarf_frame.h"
#include "dwarf_loc.h"
#include "dwarf_funcs.h"
#include "dwarf_types.h"
#include "dwarf_vars.h"
#include "dwarf_weaks.h"
#include "dwarf_harmless.h"
#include "dwarf_tsearch.h"
/* Some allocations are simple some not. These reduce
the issue of determining which sort of thing to a simple
test. See ia_multiply_count
Usually when MULTIPLY_NO is set the count
is 1, so MULTIPY_CT would work as well. */
#define MULTIPLY_NO 0
#define MULTIPLY_CT 1
#define MULTIPLY_SP 2
/* This translates into de_alloc_hdr into a per-instance size
and allows room for a constructor/destructor pointer.
Rearranging the DW_DLA values would break binary compatibility
so that is not an option.
*/
struct ial_s {
/* In bytes, one struct instance. */
short ia_struct_size;
/* Not a count, but a MULTIPLY{_NO,_CT,_SP} value. */
short ia_multiply_count;
/* When we really need a constructor/destructor
these make applying such quite simple. */
int (*specialconstructor) (Dwarf_Debug, void *);
void (*specialdestructor) (void *);
};
/* To do destructors we need some extra data in every
_dwarf_get_alloc situation. */
/* Here is the extra we malloc for a prefix. */
struct reserve_size_s {
void *dummy_rsv1;
void *dummy_rsv2;
};
/* Here is how we use the extra prefix area. */
struct reserve_data_s {
void *rd_dbg;
unsigned short rd_type;
};
#define DW_RESERVE sizeof(struct reserve_size_s)
static const
struct ial_s alloc_instance_basics[ALLOC_AREA_INDEX_TABLE_MAX] = {
{ 1,MULTIPLY_NO, 0, 0}, /* 0 none */
{ 1,MULTIPLY_CT, 0, 0}, /* 1 DW_DLA_STRING */
{ sizeof(Dwarf_Loc),MULTIPLY_NO, 0, 0} ,/* 2 DW_DLA_LOC */
{ sizeof(Dwarf_Locdesc),MULTIPLY_NO, 0, 0} , /* 3 DW_DLA_LOCDESC */
{ 1,MULTIPLY_NO, 0, 0} , /* not used *//* 4 DW_DLA_ELLIST */
{ 1,MULTIPLY_NO, 0, 0} , /* not used *//* 5 DW_DLA_BOUNDS */
{ sizeof(Dwarf_Block),MULTIPLY_NO, 0, 0} , /* 6 DW_DLA_BLOCK */
/* the actual dwarf_debug structure */ /* 7 DW_DLA_DEBUG */
{ 1,MULTIPLY_NO, 0, 0} ,
{sizeof(struct Dwarf_Die_s),MULTIPLY_NO, 0, 0},/* 8 DW_DLA_DIE */
{sizeof(struct Dwarf_Line_s),MULTIPLY_NO, 0, 0},/* 9 DW_DLA_LINE */
/* 10 DW_DLA_ATTR */
{sizeof(struct Dwarf_Attribute_s),MULTIPLY_NO, 0, 0},
{1,MULTIPLY_NO, 0, 0}, /* not used */ /* 11 DW_DLA_TYPE */
{1,MULTIPLY_NO, 0, 0}, /* not used */ /* 12 DW_DLA_SUBSCR */
/* 13 DW_DLA_GLOBAL */
{sizeof(struct Dwarf_Global_s),MULTIPLY_NO, 0, 0},
/* 14 DW_DLA_ERROR */
{sizeof(struct Dwarf_Error_s),MULTIPLY_NO, 0, 0},
{sizeof(Dwarf_Ptr),MULTIPLY_CT, 0, 0}, /* 15 DW_DLA_LIST */
{1,MULTIPLY_NO, 0, 0}, /* not used *//* 16 DW_DLA_LINEBUF */
/* 17 DW_DLA_ARANGE */
{sizeof(struct Dwarf_Arange_s),MULTIPLY_NO, 0, 0},
/* 18 DW_DLA_ABBREV */
{sizeof(struct Dwarf_Abbrev_s),MULTIPLY_NO, 0, 0},
/* 19 DW_DLA_FRAME_OP */
{sizeof(Dwarf_Frame_Op),MULTIPLY_NO, 0, 0} ,
/* 20 DW_DLA_CIE */
{sizeof(struct Dwarf_Cie_s),MULTIPLY_NO, 0, 0},
{sizeof(struct Dwarf_Fde_s),MULTIPLY_NO, 0, 0},/* 21 DW_DLA_FDE */
{sizeof(Dwarf_Loc),MULTIPLY_CT, 0, 0}, /* 22 DW_DLA_LOC_BLOCK */
{sizeof(Dwarf_Frame_Op),MULTIPLY_CT, 0, 0}, /* 23 DW_DLA_FRAME_BLOCK */
/* 24 DW_DLA_FUNC UNUSED */
{sizeof(struct Dwarf_Global_s),MULTIPLY_NO, 0, 0},
/* 25 DW_DLA_TYPENAME UNUSED */
{sizeof(struct Dwarf_Global_s),MULTIPLY_NO, 0, 0},
/* 26 DW_DLA_VAR UNUSED */
{sizeof(struct Dwarf_Global_s),MULTIPLY_NO, 0, 0},
/* 27 DW_DLA_WEAK UNUSED */
{sizeof(struct Dwarf_Global_s),MULTIPLY_NO, 0, 0},
{1,MULTIPLY_SP, 0, 0}, /* 28 DW_DLA_ADDR */
{sizeof(Dwarf_Ranges),MULTIPLY_CT, 0,0 }, /* 29 DW_DLA_RANGES */
/* The following DW_DLA data types
are known only inside libdwarf. */
/* 30 DW_DLA_ABBREV_LIST */
{ sizeof(struct Dwarf_Abbrev_List_s),MULTIPLY_NO, 0, 0},
/* 31 DW_DLA_CHAIN */
{sizeof(struct Dwarf_Chain_s),MULTIPLY_NO, 0, 0},
/* 32 DW_DLA_CU_CONTEXT */
{sizeof(struct Dwarf_CU_Context_s),MULTIPLY_NO, 0, 0},
{sizeof(struct Dwarf_Frame_s),MULTIPLY_NO,
_dwarf_frame_constructor,
_dwarf_frame_destructor}, /* 33 DW_DLA_FRAME */
/* 34 DW_DLA_GLOBAL_CONTEXT */
{sizeof(struct Dwarf_Global_Context_s),MULTIPLY_NO, 0, 0},
/* 35 DW_DLA_FILE_ENTRY */
{sizeof(struct Dwarf_File_Entry_s),MULTIPLY_NO, 0, 0},
/* 36 DW_DLA_LINE_CONTEXT */
{sizeof(struct Dwarf_Line_Context_s),MULTIPLY_NO, 0, 0},
/* 37 DW_DLA_LOC_CHAIN */
{sizeof(struct Dwarf_Loc_Chain_s),MULTIPLY_NO, 0, 0},
/* 38 DW_DLA_HASH_TABLE */
{sizeof(struct Dwarf_Hash_Table_s),MULTIPLY_NO, 0, 0},
/* The following really use Global struct: used to be unique struct
per type, but now merged (11/99). The opaque types
are visible in the interface. The types for
DW_DLA_FUNC, DW_DLA_TYPENAME, DW_DLA_VAR, DW_DLA_WEAK also use
the global types. */
/* 39 DW_DLA_FUNC_CONTEXT */
{sizeof(struct Dwarf_Global_Context_s),MULTIPLY_NO, 0, 0},
/* 40 DW_DLA_TYPENAME_CONTEXT */
{sizeof(struct Dwarf_Global_Context_s),MULTIPLY_NO, 0, 0},
/* 41 DW_DLA_VAR_CONTEXT */
{sizeof(struct Dwarf_Global_Context_s),MULTIPLY_NO, 0, 0},
/* 42 DW_DLA_WEAK_CONTEXT */
{sizeof(struct Dwarf_Global_Context_s),MULTIPLY_NO, 0, 0},
/* 43 DW_DLA_PUBTYPES_CONTEXT DWARF3 */
{sizeof(struct Dwarf_Global_Context_s),MULTIPLY_NO, 0, 0},
{sizeof(struct Dwarf_Hash_Table_Entry_s),MULTIPLY_CT,0,0 }, /* 44 DW_DLA_HASH_TABLE_ENTRY */
};
/* We are simply using the incoming pointer as the key-pointer.
*/
typedef unsigned long VALTYPE;
static unsigned long
simple_value_hashfunc(const void *keyp)
{
VALTYPE up = (VALTYPE )keyp;
return up;
}
/* We did alloc something but not a fixed-length thing.
Instead, it starts with some special data we noted. */
static void
simple_free_node(void *nodep)
{
Dwarf_Ptr m = (Dwarf_Ptr)nodep;
Dwarf_Ptr data = m + DW_RESERVE;
struct reserve_data_s * reserve =(struct reserve_data_s *)m;
unsigned type = reserve->rd_type;
if (type >= ALLOC_AREA_INDEX_TABLE_MAX) {
/* Internal error, corrupted data. */
return;
}
if (alloc_instance_basics[type].specialdestructor) {
alloc_instance_basics[type].specialdestructor(data);
}
free(m);
}
/* The sort of hash table entries result in very simple helper functions. */
static int
simple_compare_function(const void *l, const void *r)
{
VALTYPE lp = (VALTYPE)l;
VALTYPE rp = (VALTYPE)r;
if(lp < rp) {
return -1;
}
if(lp > rp) {
return 1;
}
return 0;
}
/* This function returns a pointer to a region
of memory. For alloc_types that are not
strings or lists of pointers, only 1 struct
can be requested at a time. This is indicated
by an input count of 1. For strings, count
equals the length of the string it will
contain, i.e it the length of the string
plus 1 for the terminating null. For lists
of pointers, count is equal to the number of
pointers. For DW_DLA_FRAME_BLOCK, DW_DLA_RANGES, and
DW_DLA_LOC_BLOCK allocation types also, count
is the count of the number of structs needed.
This function cannot be used to allocate a
Dwarf_Debug_s struct. */
Dwarf_Ptr
_dwarf_get_alloc(Dwarf_Debug dbg,
Dwarf_Small alloc_type, Dwarf_Unsigned count)
{
Dwarf_Ptr alloc_mem = 0;
Dwarf_Signed basesize = 0;
Dwarf_Signed size = 0;
unsigned int type = alloc_type;
short action = 0;
if (dbg == NULL) {
return (NULL);
}
if (type >= ALLOC_AREA_INDEX_TABLE_MAX) {
/* internal error */
return NULL;
}
basesize = alloc_instance_basics[alloc_type].ia_struct_size;
action = alloc_instance_basics[alloc_type].ia_multiply_count;
if(action == MULTIPLY_NO) {
/* Usually count is 1, but do not assume it. */
size = basesize;
} else if (action == MULTIPLY_CT) {
size = basesize * count;
} else {
/* MULTIPLY_SP */
/* DW_DLA_ADDR.. count * largest size */
size = count *
(sizeof(Dwarf_Addr) > sizeof(Dwarf_Off) ?
sizeof(Dwarf_Addr) : sizeof(Dwarf_Off));
}
size += DW_RESERVE;
alloc_mem = malloc(size);
if (!alloc_mem) {
return NULL;
}
{
void *key = alloc_mem;
Dwarf_Ptr ret_mem = alloc_mem + DW_RESERVE;
struct reserve_data_s *r = (struct reserve_data_s*)alloc_mem;
void *result = 0;
memset(alloc_mem, 0, size);
/* We are not actually using rd_dbg, we are using rd_type. */
r->rd_dbg = dbg;
r->rd_type = alloc_type;
if (alloc_instance_basics[type].specialconstructor) {
int res =
alloc_instance_basics[type].specialconstructor(dbg, ret_mem);
if (res != DW_DLV_OK) {
/* We leak what we allocated in _dwarf_find_memory when
constructor fails. */
return NULL;
}
}
result = dwarf_tsearch((void *)key,&dbg->de_alloc_tree,simple_compare_function);
if(!result) {
/* Something badly wrong. Out of memory.
pretend all is well. */
}
return (ret_mem);
}
}
/*
This function is used to deallocate a region of memory
that was obtained by a call to _dwarf_get_alloc. Note
that though dwarf_dealloc() is a public function,
_dwarf_get_alloc() isn't.
For lists, typically arrays of pointers, it is assumed
that the space was allocated by a direct call to malloc,
and so a straight free() is done. This is also the case
for variable length blocks such as DW_DLA_FRAME_BLOCK
and DW_DLA_LOC_BLOCK and DW_DLA_RANGES.
For strings, the pointer might point to a string in
.debug_info or .debug_string. After this is checked,
and if found not to be the case, a free() is done,
again on the assumption that a malloc was used to
obtain the space.
This function does not return anything.
*/
void
dwarf_dealloc(Dwarf_Debug dbg,
Dwarf_Ptr space, Dwarf_Unsigned alloc_type)
{
unsigned int type = alloc_type;
if (space == NULL) {
return;
}
if (dbg == NULL) {
/* App error, or an app that failed to succeed in a
dwarf_init() call. */
return;
}
if (type >= ALLOC_AREA_INDEX_TABLE_MAX) {
/* internal or user app error */
return;
}
/* A string pointer may point into .debug_info or .debug_string.
Otherwise, they are directly malloc'ed and must be freed.
*/
if (type == DW_DLA_STRING) {
/* See dwarf_line.c dwarf_srcfilse()
for an example of the odd way we wind up with
a string that is in debug_info or the like, not mallocd
by _dwarf_get_alloc(). */
if ((Dwarf_Small *) space >= dbg->de_debug_info.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_info.dss_data + dbg->de_debug_info.dss_size)
return;
if ((Dwarf_Small *) space >= dbg->de_debug_types.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_types.dss_data + dbg->de_debug_types.dss_size)
return;
if (dbg->de_debug_line.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_line.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_line.dss_data + dbg->de_debug_line.dss_size)
return;
if (dbg->de_debug_pubnames.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_pubnames.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_pubnames.dss_data +
dbg->de_debug_pubnames.dss_size)
return;
if (dbg->de_debug_frame.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_frame.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_frame.dss_data + dbg->de_debug_frame.dss_size)
return;
if (dbg->de_debug_str.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_str.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_str.dss_data + dbg->de_debug_str.dss_size)
return;
if (dbg->de_debug_funcnames.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_funcnames.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_funcnames.dss_data +
dbg->de_debug_funcnames.dss_size)
return;
if (dbg->de_debug_typenames.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_typenames.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_typenames.dss_data +
dbg->de_debug_typenames.dss_size)
return;
if (dbg->de_debug_pubtypes.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_pubtypes.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_pubtypes.dss_data +
dbg->de_debug_pubtypes.dss_size)
return;
if (dbg->de_debug_varnames.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_varnames.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_varnames.dss_data +
dbg->de_debug_varnames.dss_size)
return;
if (dbg->de_debug_weaknames.dss_data != NULL &&
(Dwarf_Small *) space >= dbg->de_debug_weaknames.dss_data &&
(Dwarf_Small *) space <
dbg->de_debug_weaknames.dss_data +
dbg->de_debug_weaknames.dss_size)
return;
}
if (alloc_instance_basics[type].specialdestructor) {
alloc_instance_basics[type].specialdestructor(space);
}
{
/* The 'space' pointer we get points after the reserve space.
The key and address to free are just a few bytes before
'space'. */
void *key = space - DW_RESERVE;
dwarf_tdelete(key,&dbg->de_alloc_tree,simple_compare_function);
/* If dwarf_tdelete returns NULL it might mean
a) tree is empty.
b) If hashsearch, then a single chain might now be empty,
so we do not know of a 'parent node'.
c) We did not find that key, we did nothing.
In any case, we simply don't worry about it.
Not Supposed To Happen. */
free(key);
return;
}
}
/*
Allocates space for a Dwarf_Debug_s struct,
since one does not exist.
*/
Dwarf_Debug
_dwarf_get_debug(void)
{
Dwarf_Debug dbg;
dbg = (Dwarf_Debug) malloc(sizeof(struct Dwarf_Debug_s));
if (dbg == NULL) {
return (NULL);
}
memset(dbg, 0, sizeof(struct Dwarf_Debug_s));
/* Set up for a dwarf_tsearch hash table */
dwarf_initialize_search_hash(&dbg->de_alloc_tree,simple_value_hashfunc,0);
return (dbg);
}
/*
This function prints out the statistics
collected on allocation of memory chunks.
No longer used.
*/
void
dwarf_print_memory_stats(Dwarf_Debug dbg)
{
}
/* In the 'rela' relocation case we might have malloc'd
space to ensure it is read-write. In that case, free the space. */
static void
rela_free(struct Dwarf_Section_s * sec)
{
if (sec->dss_data_was_malloc) {
free(sec->dss_data);
}
sec->dss_data = 0;
sec->dss_data_was_malloc = 0;
}
static void
freecontextlist(Dwarf_Debug dbg, Dwarf_Debug_InfoTypes dis)
{
Dwarf_CU_Context context = 0;
Dwarf_CU_Context nextcontext = 0;
for (context = dis->de_cu_context_list;
context; context = nextcontext) {
Dwarf_Hash_Table hash_table = context->cc_abbrev_hash_table;
_dwarf_free_abbrev_hash_table_contents(dbg,hash_table);
nextcontext = context->cc_next;
dwarf_dealloc(dbg, hash_table, DW_DLA_HASH_TABLE);
dwarf_dealloc(dbg, context, DW_DLA_CU_CONTEXT);
}
}
/*
Used to free all space allocated for this Dwarf_Debug.
The caller should assume that the Dwarf_Debug pointer
itself is no longer valid upon return from this function.
In case of difficulty, this function simply returns quietly.
*/
int
_dwarf_free_all_of_one_debug(Dwarf_Debug dbg)
{
if (dbg == NULL) {
return (DW_DLV_ERROR);
}
/* To do complete validation that we have no surprising missing or
erroneous deallocs it is advisable to do the dwarf_deallocs here
that are not things the user can otherwise request.
Housecleaning. */
freecontextlist(dbg,&dbg->de_info_reading);
freecontextlist(dbg,&dbg->de_types_reading);
/* Housecleaning done. Now really free all the space. */
rela_free(&dbg->de_debug_info);
rela_free(&dbg->de_debug_types);
rela_free(&dbg->de_debug_abbrev);
rela_free(&dbg->de_debug_line);
rela_free(&dbg->de_debug_loc);
rela_free(&dbg->de_debug_aranges);
rela_free(&dbg->de_debug_macinfo);
rela_free(&dbg->de_debug_pubnames);
rela_free(&dbg->de_debug_str);
rela_free(&dbg->de_debug_frame);
rela_free(&dbg->de_debug_frame_eh_gnu);
rela_free(&dbg->de_debug_pubtypes);
rela_free(&dbg->de_debug_funcnames);
rela_free(&dbg->de_debug_typenames);
rela_free(&dbg->de_debug_varnames);
rela_free(&dbg->de_debug_weaknames);
rela_free(&dbg->de_debug_ranges);
dwarf_harmless_cleanout(&dbg->de_harmless_errors);
if (dbg->de_printf_callback.dp_buffer &&
!dbg->de_printf_callback.dp_buffer_user_provided ) {
free(dbg->de_printf_callback.dp_buffer);
}
dwarf_tdestroy(dbg->de_alloc_tree,simple_free_node);
memset(dbg, 0, sizeof(*dbg)); /* Prevent accidental use later. */
free(dbg);
return (DW_DLV_OK);
}
/* A special case: we have no dbg, no alloc header etc.
So create something out of thin air that we can recognize
in dwarf_dealloc.
Something with the prefix (prefix space hidden from caller).
Only applies to DW_DLA_ERROR, and making up an error record.
The allocated space simply leaks.
*/
struct Dwarf_Error_s *
_dwarf_special_no_dbg_error_malloc(void)
{
/* The union unused things are to guarantee proper alignment */
char *mem = malloc(sizeof(struct Dwarf_Error_s));
if (mem == 0) {
return 0;
}
memset(mem, 0, sizeof(struct Dwarf_Error_s));
return (struct Dwarf_Error_s *) mem;
}