125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Common definitions for handling files in memory or only on disk. 225b3c049e70834cf33790a28643ab058b507b35cBen Cheng Copyright (C) 1998, 1999, 2000, 2002, 2005, 2008 Red Hat, Inc. 325b3c049e70834cf33790a28643ab058b507b35cBen Cheng This file is part of Red Hat elfutils. 425b3c049e70834cf33790a28643ab058b507b35cBen Cheng Written by Ulrich Drepper <drepper@redhat.com>, 1998. 525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 625b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is free software; you can redistribute it and/or modify 725b3c049e70834cf33790a28643ab058b507b35cBen Cheng it under the terms of the GNU General Public License as published by the 825b3c049e70834cf33790a28643ab058b507b35cBen Cheng Free Software Foundation; version 2 of the License. 925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1025b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is distributed in the hope that it will be useful, but 1125b3c049e70834cf33790a28643ab058b507b35cBen Cheng WITHOUT ANY WARRANTY; without even the implied warranty of 1225b3c049e70834cf33790a28643ab058b507b35cBen Cheng MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 1325b3c049e70834cf33790a28643ab058b507b35cBen Cheng General Public License for more details. 1425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1525b3c049e70834cf33790a28643ab058b507b35cBen Cheng You should have received a copy of the GNU General Public License along 1625b3c049e70834cf33790a28643ab058b507b35cBen Cheng with Red Hat elfutils; if not, write to the Free Software Foundation, 1725b3c049e70834cf33790a28643ab058b507b35cBen Cheng Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA. 1825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1925b3c049e70834cf33790a28643ab058b507b35cBen Cheng In addition, as a special exception, Red Hat, Inc. gives You the 2025b3c049e70834cf33790a28643ab058b507b35cBen Cheng additional right to link the code of Red Hat elfutils with code licensed 2125b3c049e70834cf33790a28643ab058b507b35cBen Cheng under any Open Source Initiative certified open source license 2225b3c049e70834cf33790a28643ab058b507b35cBen Cheng (http://www.opensource.org/licenses/index.php) which requires the 2325b3c049e70834cf33790a28643ab058b507b35cBen Cheng distribution of source code with any binary distribution and to 2425b3c049e70834cf33790a28643ab058b507b35cBen Cheng distribute linked combinations of the two. Non-GPL Code permitted under 2525b3c049e70834cf33790a28643ab058b507b35cBen Cheng this exception must only link to the code of Red Hat elfutils through 2625b3c049e70834cf33790a28643ab058b507b35cBen Cheng those well defined interfaces identified in the file named EXCEPTION 2725b3c049e70834cf33790a28643ab058b507b35cBen Cheng found in the source code files (the "Approved Interfaces"). The files 2825b3c049e70834cf33790a28643ab058b507b35cBen Cheng of Non-GPL Code may instantiate templates or use macros or inline 2925b3c049e70834cf33790a28643ab058b507b35cBen Cheng functions from the Approved Interfaces without causing the resulting 3025b3c049e70834cf33790a28643ab058b507b35cBen Cheng work to be covered by the GNU General Public License. Only Red Hat, 3125b3c049e70834cf33790a28643ab058b507b35cBen Cheng Inc. may make changes or additions to the list of Approved Interfaces. 3225b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat's grant of this exception is conditioned upon your not adding 3325b3c049e70834cf33790a28643ab058b507b35cBen Cheng any new exceptions. If you wish to add a new Approved Interface or 3425b3c049e70834cf33790a28643ab058b507b35cBen Cheng exception, please contact Red Hat. You must obey the GNU General Public 3525b3c049e70834cf33790a28643ab058b507b35cBen Cheng License in all respects for all of the Red Hat elfutils code and other 3625b3c049e70834cf33790a28643ab058b507b35cBen Cheng code used in conjunction with Red Hat elfutils except the Non-GPL Code 3725b3c049e70834cf33790a28643ab058b507b35cBen Cheng covered by this exception. If you modify this file, you may extend this 3825b3c049e70834cf33790a28643ab058b507b35cBen Cheng exception to your version of the file, but you are not obligated to do 3925b3c049e70834cf33790a28643ab058b507b35cBen Cheng so. If you do not wish to provide this exception without modification, 4025b3c049e70834cf33790a28643ab058b507b35cBen Cheng you must delete this exception statement from your version and license 4125b3c049e70834cf33790a28643ab058b507b35cBen Cheng this file solely under the GPL without exception. 4225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 4325b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is an included package of the Open Invention Network. 4425b3c049e70834cf33790a28643ab058b507b35cBen Cheng An included package of the Open Invention Network is a package for which 4525b3c049e70834cf33790a28643ab058b507b35cBen Cheng Open Invention Network licensees cross-license their patents. No patent 4625b3c049e70834cf33790a28643ab058b507b35cBen Cheng license is granted, either expressly or impliedly, by designation as an 4725b3c049e70834cf33790a28643ab058b507b35cBen Cheng included package. Should you wish to participate in the Open Invention 4825b3c049e70834cf33790a28643ab058b507b35cBen Cheng Network licensing program, please visit www.openinventionnetwork.com 4925b3c049e70834cf33790a28643ab058b507b35cBen Cheng <http://www.openinventionnetwork.com>. */ 5025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5125b3c049e70834cf33790a28643ab058b507b35cBen Cheng#ifndef _COMMON_H 5225b3c049e70834cf33790a28643ab058b507b35cBen Cheng#define _COMMON_H 1 5325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5425b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <ar.h> 5525b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <byteswap.h> 5625b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <endian.h> 5725b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <stdlib.h> 5825b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <string.h> 5925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6025b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include "libelfP.h" 6125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6225b3c049e70834cf33790a28643ab058b507b35cBen Chengstatic inline Elf_Kind 6325b3c049e70834cf33790a28643ab058b507b35cBen Cheng__attribute__ ((unused)) 6425b3c049e70834cf33790a28643ab058b507b35cBen Chengdetermine_kind (void *buf, size_t len) 6525b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 6625b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* First test for an archive. */ 6725b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (len >= SARMAG && memcmp (buf, ARMAG, SARMAG) == 0) 6825b3c049e70834cf33790a28643ab058b507b35cBen Cheng return ELF_K_AR; 6925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 7025b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Next try ELF files. */ 7125b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (len >= EI_NIDENT && memcmp (buf, ELFMAG, SELFMAG) == 0) 7225b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 7325b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Could be an ELF file. */ 7425b3c049e70834cf33790a28643ab058b507b35cBen Cheng int eclass = (int) ((unsigned char *) buf)[EI_CLASS]; 7525b3c049e70834cf33790a28643ab058b507b35cBen Cheng int data = (int) ((unsigned char *) buf)[EI_DATA]; 7625b3c049e70834cf33790a28643ab058b507b35cBen Cheng int version = (int) ((unsigned char *) buf)[EI_VERSION]; 7725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 7825b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (eclass > ELFCLASSNONE && eclass < ELFCLASSNUM 7925b3c049e70834cf33790a28643ab058b507b35cBen Cheng && data > ELFDATANONE && data < ELFDATANUM 8025b3c049e70834cf33790a28643ab058b507b35cBen Cheng && version > EV_NONE && version < EV_NUM) 8125b3c049e70834cf33790a28643ab058b507b35cBen Cheng return ELF_K_ELF; 8225b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 8325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8425b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* We do not know this file type. */ 8525b3c049e70834cf33790a28643ab058b507b35cBen Cheng return ELF_K_NONE; 8625b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 8725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8925b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Allocate an Elf descriptor and fill in the generic information. */ 9025b3c049e70834cf33790a28643ab058b507b35cBen Chengstatic inline Elf * 9125b3c049e70834cf33790a28643ab058b507b35cBen Cheng__attribute__ ((unused)) 9225b3c049e70834cf33790a28643ab058b507b35cBen Chengallocate_elf (int fildes, void *map_address, off_t offset, size_t maxsize, 9325b3c049e70834cf33790a28643ab058b507b35cBen Cheng Elf_Cmd cmd, Elf *parent, Elf_Kind kind, size_t extra) 9425b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 9525b3c049e70834cf33790a28643ab058b507b35cBen Cheng Elf *result = (Elf *) calloc (1, sizeof (Elf) + extra); 9625b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (result == NULL) 9725b3c049e70834cf33790a28643ab058b507b35cBen Cheng __libelf_seterrno (ELF_E_NOMEM); 9825b3c049e70834cf33790a28643ab058b507b35cBen Cheng else 9925b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 10025b3c049e70834cf33790a28643ab058b507b35cBen Cheng result->kind = kind; 10125b3c049e70834cf33790a28643ab058b507b35cBen Cheng result->ref_count = 1; 10225b3c049e70834cf33790a28643ab058b507b35cBen Cheng result->cmd = cmd; 10325b3c049e70834cf33790a28643ab058b507b35cBen Cheng result->fildes = fildes; 10425b3c049e70834cf33790a28643ab058b507b35cBen Cheng result->start_offset = offset; 10525b3c049e70834cf33790a28643ab058b507b35cBen Cheng result->maximum_size = maxsize; 10625b3c049e70834cf33790a28643ab058b507b35cBen Cheng result->map_address = map_address; 10725b3c049e70834cf33790a28643ab058b507b35cBen Cheng result->parent = parent; 10825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 10925b3c049e70834cf33790a28643ab058b507b35cBen Cheng rwlock_init (result->lock); 11025b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 11125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11225b3c049e70834cf33790a28643ab058b507b35cBen Cheng return result; 11325b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 11425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11625b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Acquire lock for the descriptor and all children. */ 11725b3c049e70834cf33790a28643ab058b507b35cBen Chengstatic void 11825b3c049e70834cf33790a28643ab058b507b35cBen Cheng__attribute__ ((unused)) 11925b3c049e70834cf33790a28643ab058b507b35cBen Chenglibelf_acquire_all (Elf *elf) 12025b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 12125b3c049e70834cf33790a28643ab058b507b35cBen Cheng rwlock_wrlock (elf->lock); 12225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12325b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (elf->kind == ELF_K_AR) 12425b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 12525b3c049e70834cf33790a28643ab058b507b35cBen Cheng Elf *child = elf->state.ar.children; 12625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12725b3c049e70834cf33790a28643ab058b507b35cBen Cheng while (child != NULL) 12825b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 12925b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (child->ref_count != 0) 13025b3c049e70834cf33790a28643ab058b507b35cBen Cheng libelf_acquire_all (child); 13125b3c049e70834cf33790a28643ab058b507b35cBen Cheng child = child->next; 13225b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 13325b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 13425b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 13525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 13625b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Release own lock and those of the children. */ 13725b3c049e70834cf33790a28643ab058b507b35cBen Chengstatic void 13825b3c049e70834cf33790a28643ab058b507b35cBen Cheng__attribute__ ((unused)) 13925b3c049e70834cf33790a28643ab058b507b35cBen Chenglibelf_release_all (Elf *elf) 14025b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 14125b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (elf->kind == ELF_K_AR) 14225b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 14325b3c049e70834cf33790a28643ab058b507b35cBen Cheng Elf *child = elf->state.ar.children; 14425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 14525b3c049e70834cf33790a28643ab058b507b35cBen Cheng while (child != NULL) 14625b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 14725b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (child->ref_count != 0) 14825b3c049e70834cf33790a28643ab058b507b35cBen Cheng libelf_release_all (child); 14925b3c049e70834cf33790a28643ab058b507b35cBen Cheng child = child->next; 15025b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 15125b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 15225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 15325b3c049e70834cf33790a28643ab058b507b35cBen Cheng rwlock_unlock (elf->lock); 15425b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 15525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 15625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 15725b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Macro to convert endianess in place. It determines the function it 15825b3c049e70834cf33790a28643ab058b507b35cBen Cheng has to use itself. */ 15925b3c049e70834cf33790a28643ab058b507b35cBen Cheng#define CONVERT(Var) \ 16025b3c049e70834cf33790a28643ab058b507b35cBen Cheng (Var) = (sizeof (Var) == 1 \ 16125b3c049e70834cf33790a28643ab058b507b35cBen Cheng ? (unsigned char) (Var) \ 16225b3c049e70834cf33790a28643ab058b507b35cBen Cheng : (sizeof (Var) == 2 \ 16325b3c049e70834cf33790a28643ab058b507b35cBen Cheng ? bswap_16 (Var) \ 16425b3c049e70834cf33790a28643ab058b507b35cBen Cheng : (sizeof (Var) == 4 \ 16525b3c049e70834cf33790a28643ab058b507b35cBen Cheng ? bswap_32 (Var) \ 16625b3c049e70834cf33790a28643ab058b507b35cBen Cheng : bswap_64 (Var)))) 16725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 16825b3c049e70834cf33790a28643ab058b507b35cBen Cheng#define CONVERT_TO(Dst, Var) \ 16925b3c049e70834cf33790a28643ab058b507b35cBen Cheng (Dst) = (sizeof (Var) == 1 \ 17025b3c049e70834cf33790a28643ab058b507b35cBen Cheng ? (unsigned char) (Var) \ 17125b3c049e70834cf33790a28643ab058b507b35cBen Cheng : (sizeof (Var) == 2 \ 17225b3c049e70834cf33790a28643ab058b507b35cBen Cheng ? bswap_16 (Var) \ 17325b3c049e70834cf33790a28643ab058b507b35cBen Cheng : (sizeof (Var) == 4 \ 17425b3c049e70834cf33790a28643ab058b507b35cBen Cheng ? bswap_32 (Var) \ 17525b3c049e70834cf33790a28643ab058b507b35cBen Cheng : bswap_64 (Var)))) 17625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 17725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 17825b3c049e70834cf33790a28643ab058b507b35cBen Cheng#if __BYTE_ORDER == __LITTLE_ENDIAN 17925b3c049e70834cf33790a28643ab058b507b35cBen Cheng# define MY_ELFDATA ELFDATA2LSB 18025b3c049e70834cf33790a28643ab058b507b35cBen Cheng#else 18125b3c049e70834cf33790a28643ab058b507b35cBen Cheng# define MY_ELFDATA ELFDATA2MSB 18225b3c049e70834cf33790a28643ab058b507b35cBen Cheng#endif 18325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 18425b3c049e70834cf33790a28643ab058b507b35cBen Cheng#endif /* common.h */ 185