/*

  Copyright (C) 2000,2002,2004 Silicon Graphics, Inc.  All Rights Reserved.

  Portions Copyright (C) 2007 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.

*/

#include "config.h"

#include "dwarf_incl.h"

#include <stdio.h>

#include "dwarf_arange.h"

#include "dwarf_global.h"	/* for _dwarf_fixup_* */

/*

    This function returns the count of the number of

    aranges in the .debug_aranges section.  It sets

    aranges to point to a block of Dwarf_Arange's 

    describing the arange's.  It returns DW_DLV_ERROR

    on error.

    Must be identical in most aspects to

	dwarf_get_aranges_addr_offsets!

*/

int

dwarf_get_aranges(Dwarf_Debug dbg,

		  Dwarf_Arange ** aranges,

		  Dwarf_Signed * returned_count, Dwarf_Error * error)

{

    /* Sweeps the .debug_aranges section. */

    Dwarf_Small *arange_ptr = 0;

    /* 

       Start of arange header.  Used for rounding offset of arange_ptr

       to twice the tuple size.  Libdwarf requirement. */

    Dwarf_Small *header_ptr = 0;

    /* Version of .debug_aranges header. */

    Dwarf_Half version = 0;

    /* Offset of current set of aranges into .debug_info. */

    Dwarf_Off info_offset = 0;

    /* Size in bytes of addresses in target. */

    Dwarf_Small address_size = 0;

    /* Size in bytes of segment offsets in target. */

    Dwarf_Small segment_size = 0;

    Dwarf_Small remainder = 0;

    /* Count of total number of aranges. */

    Dwarf_Unsigned arange_count = 0;

    /* Start address of arange. */

    Dwarf_Addr range_address = 0;

    /* Length of arange. */

    Dwarf_Unsigned range_length = 0;

    Dwarf_Arange arange, *arange_block = 0;

    Dwarf_Unsigned i = 0;

    /* Used to chain Dwarf_Aranges structs. */

    Dwarf_Chain curr_chain = NULL;

    Dwarf_Chain prev_chain = NULL;

    Dwarf_Chain head_chain = NULL;

    int res = 0;

    /* ***** BEGIN CODE ***** */

    if (dbg == NULL) {

	_dwarf_error(NULL, error, DW_DLE_DBG_NULL);

	return (DW_DLV_ERROR);

    }

    res =

	_dwarf_load_section(dbg,

			    dbg->de_debug_aranges_index,

			    &dbg->de_debug_aranges, error);

    if (res != DW_DLV_OK) {

	return res;

    }

    arange_ptr = dbg->de_debug_aranges;

    do {

	/* Length of current set of aranges. */

	Dwarf_Unsigned length;

	Dwarf_Small *arange_ptr_past_end = 0;

	int local_length_size;

	 /*REFERENCED*/		/* Not used in this instance of the

				   macro */

	int local_extension_size;

	header_ptr = arange_ptr;

	/* READ_AREA_LENGTH updates arange_ptr for consumed bytes */

	READ_AREA_LENGTH(dbg, length, Dwarf_Unsigned,

			 arange_ptr, local_length_size,

			 local_extension_size);

	arange_ptr_past_end = arange_ptr + length;

	READ_UNALIGNED(dbg, version, Dwarf_Half,

		       arange_ptr, sizeof(Dwarf_Half));

	arange_ptr += sizeof(Dwarf_Half);

	length = length - sizeof(Dwarf_Half);

	if (version != CURRENT_VERSION_STAMP) {

	    _dwarf_error(dbg, error, DW_DLE_VERSION_STAMP_ERROR);

	    return (DW_DLV_ERROR);

	}

	READ_UNALIGNED(dbg, info_offset, Dwarf_Off,

		       arange_ptr, local_length_size);

	arange_ptr += local_length_size;

	length = length - local_length_size;

	if (info_offset >= dbg->de_debug_info_size) {

	    FIX_UP_OFFSET_IRIX_BUG(dbg, info_offset,

				   "arange info offset.a");

	    if (info_offset >= dbg->de_debug_info_size) {

		_dwarf_error(dbg, error, DW_DLE_ARANGE_OFFSET_BAD);

		return (DW_DLV_ERROR);

	    }

	}

	address_size = *(Dwarf_Small *) arange_ptr;

	if (address_size != dbg->de_pointer_size) {

	    /* Internal error of some kind */

	    _dwarf_error(dbg, error, DW_DLE_BADBITC);

	    return (DW_DLV_ERROR);

	}

	arange_ptr = arange_ptr + sizeof(Dwarf_Small);

	length = length - sizeof(Dwarf_Small);

	segment_size = *(Dwarf_Small *) arange_ptr;

	arange_ptr = arange_ptr + sizeof(Dwarf_Small);

	length = length - sizeof(Dwarf_Small);

	if (segment_size != 0) {

	    _dwarf_error(dbg, error, DW_DLE_SEGMENT_SIZE_BAD);

	    return (DW_DLV_ERROR);

	}

	/* Round arange_ptr offset to next multiple of address_size. */

	remainder = (Dwarf_Unsigned) (arange_ptr - header_ptr) %

	    (2 * address_size);

	if (remainder != 0) {

	    arange_ptr = arange_ptr + (2 * address_size) - remainder;

	    length = length - ((2 * address_size) - remainder);

	}

	do {

	    READ_UNALIGNED(dbg, range_address, Dwarf_Addr,

			   arange_ptr, address_size);

	    arange_ptr += address_size;

	    length = length - address_size;

	    READ_UNALIGNED(dbg, range_length, Dwarf_Unsigned,

			   arange_ptr, address_size);

	    arange_ptr += address_size;

	    length = length - address_size;

	    if (range_address != 0 || range_length != 0) {

		arange = (Dwarf_Arange)

		    _dwarf_get_alloc(dbg, DW_DLA_ARANGE, 1);

		if (arange == NULL) {

		    _dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);

		    return (DW_DLV_ERROR);

		}

		arange->ar_address = range_address;

		arange->ar_length = range_length;

		arange->ar_info_offset = info_offset;

		arange->ar_dbg = dbg;

		arange_count++;

		curr_chain = (Dwarf_Chain)

		    _dwarf_get_alloc(dbg, DW_DLA_CHAIN, 1);

		if (curr_chain == NULL) {

		    _dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);

		    return (DW_DLV_ERROR);

		}

		curr_chain->ch_item = arange;

		if (head_chain == NULL)

		    head_chain = prev_chain = curr_chain;

		else {

		    prev_chain->ch_next = curr_chain;

		    prev_chain = curr_chain;

		}

	    }

	} while (range_address != 0 || range_length != 0);

	/* A compiler could emit some padding bytes here. dwarf2/3

	   (dwarf3 draft8 sec 7.20) does not clearly make extra padding 

	   bytes illegal. */

	if (arange_ptr_past_end < arange_ptr) {

	    _dwarf_error(dbg, error, DW_DLE_ARANGE_LENGTH_BAD);

	    return (DW_DLV_ERROR);

	}

	/* For most compilers, arange_ptr == arange_ptr_past_end at

	   this point. But not if there were padding bytes */

	arange_ptr = arange_ptr_past_end;

    } while (arange_ptr <

	     dbg->de_debug_aranges + dbg->de_debug_aranges_size);

    if (arange_ptr !=

	dbg->de_debug_aranges + dbg->de_debug_aranges_size) {

	_dwarf_error(dbg, error, DW_DLE_ARANGE_DECODE_ERROR);

	return (DW_DLV_ERROR);

    }

    arange_block = (Dwarf_Arange *)

	_dwarf_get_alloc(dbg, DW_DLA_LIST, arange_count);

    if (arange_block == NULL) {

	_dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);

	return (DW_DLV_ERROR);

    }

    curr_chain = head_chain;

    for (i = 0; i < arange_count; i++) {

	*(arange_block + i) = curr_chain->ch_item;

	prev_chain = curr_chain;

	curr_chain = curr_chain->ch_next;

	dwarf_dealloc(dbg, prev_chain, DW_DLA_CHAIN);

    }

    *aranges = arange_block;

    *returned_count = (arange_count);

    return DW_DLV_OK;

}

/*

    This function returns DW_DLV_OK if it succeeds

    and DW_DLV_ERR or DW_DLV_OK otherwise.

    count is set to the number of addresses in the

    .debug_aranges section. 

    For each address, the corresponding element in

    an array is set to the address itself(aranges) and

    the section offset (offsets).

    Must be identical in most aspects to

	dwarf_get_aranges!

*/

int

_dwarf_get_aranges_addr_offsets(Dwarf_Debug dbg,

				Dwarf_Addr ** addrs,

				Dwarf_Off ** offsets,

				Dwarf_Signed * count,

				Dwarf_Error * error)

{

    /* Sweeps the .debug_aranges section. */

    Dwarf_Small *arange_ptr = 0;

    Dwarf_Small *arange_start_ptr = 0;

    /* 

       Start of arange header.  Used for rounding offset of arange_ptr

       to twice the tuple size.  Libdwarf requirement. */

    Dwarf_Small *header_ptr = 0;

    /* Length of current set of aranges. */

    Dwarf_Unsigned length = 0;

    /* Version of .debug_aranges header. */

    Dwarf_Half version = 0;

    /* Offset of current set of aranges into .debug_info. */

    Dwarf_Off info_offset = 0;

    /* Size in bytes of addresses in target. */

    Dwarf_Small address_size = 0;

    /* Size in bytes of segment offsets in target. */

    Dwarf_Small segment_size = 0;

    Dwarf_Small remainder = 0;

    /* Count of total number of aranges. */

    Dwarf_Unsigned arange_count = 0;

    /* Start address of arange. */

    Dwarf_Addr range_address = 0;

    /* Length of arange. */

    Dwarf_Unsigned range_length = 0;

    Dwarf_Arange arange = 0;

    Dwarf_Unsigned i = 0;

    /* Used to chain Dwarf_Aranges structs. */

    Dwarf_Chain curr_chain = NULL;

    Dwarf_Chain prev_chain = NULL;

    Dwarf_Chain head_chain = NULL;

    Dwarf_Addr *arange_addrs = 0;

    Dwarf_Off *arange_offsets = 0;

    int res = 0;

    /* ***** BEGIN CODE ***** */

    if (error != NULL)

	*error = NULL;

    if (dbg == NULL) {

	_dwarf_error(NULL, error, DW_DLE_DBG_NULL);

	return (DW_DLV_ERROR);

    }

    res =

	_dwarf_load_section(dbg,

			    dbg->de_debug_aranges_index,

			    &dbg->de_debug_aranges, error);

    if (res != DW_DLV_OK) {

	return res;

    }

    arange_ptr = dbg->de_debug_aranges;

    do {

	int local_length_size;

	 /*REFERENCED*/		/* not used in this instance of the

				   macro */

	int local_extension_size;

	header_ptr = arange_ptr;

	/* READ_AREA_LENGTH updates arange_ptr for consumed bytes */

	READ_AREA_LENGTH(dbg, length, Dwarf_Unsigned,

			 arange_ptr, local_length_size,

			 local_extension_size);

	READ_UNALIGNED(dbg, version, Dwarf_Half,

		       arange_ptr, sizeof(Dwarf_Half));

	arange_ptr += sizeof(Dwarf_Half);

	length = length - sizeof(Dwarf_Half);

	if (version != CURRENT_VERSION_STAMP) {

	    _dwarf_error(dbg, error, DW_DLE_VERSION_STAMP_ERROR);

	    return (DW_DLV_ERROR);

	}

	READ_UNALIGNED(dbg, info_offset, Dwarf_Off,

		       arange_ptr, local_length_size);

	arange_ptr += local_length_size;

	length = length - local_length_size;

	if (info_offset >= dbg->de_debug_info_size) {

	    FIX_UP_OFFSET_IRIX_BUG(dbg, info_offset,

				   "arange info offset.b");

	    if (info_offset >= dbg->de_debug_info_size) {

		_dwarf_error(dbg, error, DW_DLE_ARANGE_OFFSET_BAD);

		return (DW_DLV_ERROR);

	    }

	}

	address_size = *(Dwarf_Small *) arange_ptr;

	arange_ptr = arange_ptr + sizeof(Dwarf_Small);

	length = length - sizeof(Dwarf_Small);

	segment_size = *(Dwarf_Small *) arange_ptr;

	arange_ptr = arange_ptr + sizeof(Dwarf_Small);

	length = length - sizeof(Dwarf_Small);

	if (segment_size != 0) {

	    _dwarf_error(dbg, error, DW_DLE_SEGMENT_SIZE_BAD);

	    return (DW_DLV_ERROR);

	}

	/* Round arange_ptr offset to next multiple of address_size. */

	remainder = (Dwarf_Unsigned) (arange_ptr - header_ptr) %

	    (2 * address_size);

	if (remainder != 0) {

	    arange_ptr = arange_ptr + (2 * address_size) - remainder;

	    length = length - ((2 * address_size) - remainder);

	}

	do {

	    arange_start_ptr = arange_ptr;

	    READ_UNALIGNED(dbg, range_address, Dwarf_Addr,

			   arange_ptr, dbg->de_pointer_size);

	    arange_ptr += dbg->de_pointer_size;

	    length = length - dbg->de_pointer_size;

	    READ_UNALIGNED(dbg, range_length, Dwarf_Unsigned,

			   arange_ptr, local_length_size);

	    arange_ptr += local_length_size;

	    length = length - local_length_size;

	    if (range_address != 0 || range_length != 0) {

		arange = (Dwarf_Arange)

		    _dwarf_get_alloc(dbg, DW_DLA_ARANGE, 1);

		if (arange == NULL) {

		    _dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);

		    return (DW_DLV_ERROR);

		}

		arange->ar_address = range_address;

		arange->ar_length = range_length;

		arange->ar_info_offset =

		    arange_start_ptr - dbg->de_debug_aranges;

		arange->ar_dbg = dbg;

		arange_count++;

		curr_chain = (Dwarf_Chain)

		    _dwarf_get_alloc(dbg, DW_DLA_CHAIN, 1);

		if (curr_chain == NULL) {

		    _dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);

		    return (DW_DLV_ERROR);

		}

		curr_chain->ch_item = arange;

		if (head_chain == NULL)

		    head_chain = prev_chain = curr_chain;

		else {

		    prev_chain->ch_next = curr_chain;

		    prev_chain = curr_chain;

		}

	    }

	} while (range_address != 0 || range_length != 0);

	if (length != 0) {

	    _dwarf_error(dbg, error, DW_DLE_ARANGE_LENGTH_BAD);

	    return (DW_DLV_ERROR);

	}

    } while (arange_ptr <

	     dbg->de_debug_aranges + dbg->de_debug_aranges_size);

    if (arange_ptr !=

	dbg->de_debug_aranges + dbg->de_debug_aranges_size) {

	_dwarf_error(dbg, error, DW_DLE_ARANGE_DECODE_ERROR);

	return (DW_DLV_ERROR);

    }

    arange_addrs = (Dwarf_Addr *)

	_dwarf_get_alloc(dbg, DW_DLA_ADDR, arange_count);

    if (arange_addrs == NULL) {

	_dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);

	return (DW_DLV_ERROR);

    }

    arange_offsets = (Dwarf_Off *)

	_dwarf_get_alloc(dbg, DW_DLA_ADDR, arange_count);

    if (arange_offsets == NULL) {

	_dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);

	return (DW_DLV_ERROR);

    }

    curr_chain = head_chain;

    for (i = 0; i < arange_count; i++) {

	Dwarf_Arange ar = curr_chain->ch_item;

	arange_addrs[i] = ar->ar_address;

	arange_offsets[i] = ar->ar_info_offset;

	prev_chain = curr_chain;

	curr_chain = curr_chain->ch_next;

	dwarf_dealloc(dbg, ar, DW_DLA_ARANGE);

	dwarf_dealloc(dbg, prev_chain, DW_DLA_CHAIN);

    }

    *count = arange_count;

    *offsets = arange_offsets;

    *addrs = arange_addrs;

    return (DW_DLV_OK);

}

/*

    This function takes a pointer to a block

    of Dwarf_Arange's, and a count of the

    length of the block.  It checks if the

    given address is within the range of an

    address range in the block.  If yes, it

    returns the appropriate Dwarf_Arange.

    Otherwise, it returns DW_DLV_ERROR.

*/

int

dwarf_get_arange(Dwarf_Arange * aranges,

		 Dwarf_Unsigned arange_count,

		 Dwarf_Addr address,

		 Dwarf_Arange * returned_arange, Dwarf_Error * error)

{

    Dwarf_Arange curr_arange;

    Dwarf_Unsigned i;