1441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project/* Common definitions for handling files in memory or only on disk. 2cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Copyright (C) 1998, 1999, 2000, 2002, 2005, 2008 Red Hat, Inc. 3cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng This file is part of Red Hat elfutils. 4441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project Written by Ulrich Drepper <drepper@redhat.com>, 1998. 5441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 6cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Red Hat elfutils is free software; you can redistribute it and/or modify 7cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng it under the terms of the GNU General Public License as published by the 8cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Free Software Foundation; version 2 of the License. 9cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 10cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Red Hat elfutils is distributed in the hope that it will be useful, but 11cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng WITHOUT ANY WARRANTY; without even the implied warranty of 12cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng General Public License for more details. 14cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 15cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng You should have received a copy of the GNU General Public License along 16cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng with Red Hat elfutils; if not, write to the Free Software Foundation, 17cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA. 18cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 19cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng In addition, as a special exception, Red Hat, Inc. gives You the 20cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng additional right to link the code of Red Hat elfutils with code licensed 21cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng under any Open Source Initiative certified open source license 22cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng (http://www.opensource.org/licenses/index.php) which requires the 23cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng distribution of source code with any binary distribution and to 24cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng distribute linked combinations of the two. Non-GPL Code permitted under 25cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng this exception must only link to the code of Red Hat elfutils through 26cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng those well defined interfaces identified in the file named EXCEPTION 27cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng found in the source code files (the "Approved Interfaces"). The files 28cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng of Non-GPL Code may instantiate templates or use macros or inline 29cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng functions from the Approved Interfaces without causing the resulting 30cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng work to be covered by the GNU General Public License. Only Red Hat, 31cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Inc. may make changes or additions to the list of Approved Interfaces. 32cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Red Hat's grant of this exception is conditioned upon your not adding 33cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng any new exceptions. If you wish to add a new Approved Interface or 34cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng exception, please contact Red Hat. You must obey the GNU General Public 35cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng License in all respects for all of the Red Hat elfutils code and other 36cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng code used in conjunction with Red Hat elfutils except the Non-GPL Code 37cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng covered by this exception. If you modify this file, you may extend this 38cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng exception to your version of the file, but you are not obligated to do 39cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng so. If you do not wish to provide this exception without modification, 40cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng you must delete this exception statement from your version and license 41cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng this file solely under the GPL without exception. 42cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 43cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Red Hat elfutils is an included package of the Open Invention Network. 44cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng An included package of the Open Invention Network is a package for which 45cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Open Invention Network licensees cross-license their patents. No patent 46cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng license is granted, either expressly or impliedly, by designation as an 47cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng included package. Should you wish to participate in the Open Invention 48cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Network licensing program, please visit www.openinventionnetwork.com 49cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng <http://www.openinventionnetwork.com>. */ 50441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 51441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#ifndef _COMMON_H 52441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#define _COMMON_H 1 53441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 54441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#include <ar.h> 55cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng#include <byteswap.h> 56cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng#include <endian.h> 57441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#include <stdlib.h> 58441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#include <string.h> 59441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 60cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng#include "libelfP.h" 61441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 62441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Projectstatic inline Elf_Kind 63cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng__attribute__ ((unused)) 64441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Projectdetermine_kind (void *buf, size_t len) 65441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project{ 66441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project /* First test for an archive. */ 67441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project if (len >= SARMAG && memcmp (buf, ARMAG, SARMAG) == 0) 68441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project return ELF_K_AR; 69441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 70441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project /* Next try ELF files. */ 71441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project if (len >= EI_NIDENT && memcmp (buf, ELFMAG, SELFMAG) == 0) 72441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project { 73441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project /* Could be an ELF file. */ 74441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project int eclass = (int) ((unsigned char *) buf)[EI_CLASS]; 75441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project int data = (int) ((unsigned char *) buf)[EI_DATA]; 76441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project int version = (int) ((unsigned char *) buf)[EI_VERSION]; 77441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 78441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project if (eclass > ELFCLASSNONE && eclass < ELFCLASSNUM 79441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project && data > ELFDATANONE && data < ELFDATANUM 80441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project && version > EV_NONE && version < EV_NUM) 81441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project return ELF_K_ELF; 82441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project } 83441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 84441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project /* We do not know this file type. */ 85441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project return ELF_K_NONE; 86441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project} 87441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 88441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 89441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project/* Allocate an Elf descriptor and fill in the generic information. */ 90441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Projectstatic inline Elf * 91cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng__attribute__ ((unused)) 92441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Projectallocate_elf (int fildes, void *map_address, off_t offset, size_t maxsize, 93441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project Elf_Cmd cmd, Elf *parent, Elf_Kind kind, size_t extra) 94441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project{ 95441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project Elf *result = (Elf *) calloc (1, sizeof (Elf) + extra); 96441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project if (result == NULL) 97441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project __libelf_seterrno (ELF_E_NOMEM); 98441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project else 99441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project { 100441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project result->kind = kind; 101441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project result->ref_count = 1; 102441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project result->cmd = cmd; 103441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project result->fildes = fildes; 104441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project result->start_offset = offset; 105441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project result->maximum_size = maxsize; 106441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project result->map_address = map_address; 107441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project result->parent = parent; 108441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 109441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project rwlock_init (result->lock); 110441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project } 111441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 112441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project return result; 113441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project} 114441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 115441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 116441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project/* Acquire lock for the descriptor and all children. */ 117441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Projectstatic void 118cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng__attribute__ ((unused)) 119441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Projectlibelf_acquire_all (Elf *elf) 120441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project{ 121441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project rwlock_wrlock (elf->lock); 122441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 123441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project if (elf->kind == ELF_K_AR) 124441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project { 125441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project Elf *child = elf->state.ar.children; 126441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 127441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project while (child != NULL) 128441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project { 129441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project if (child->ref_count != 0) 130441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project libelf_acquire_all (child); 131441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project child = child->next; 132441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project } 133441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project } 134441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project} 135441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 136441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project/* Release own lock and those of the children. */ 137441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Projectstatic void 138cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng__attribute__ ((unused)) 139441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Projectlibelf_release_all (Elf *elf) 140441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project{ 141441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project if (elf->kind == ELF_K_AR) 142441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project { 143441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project Elf *child = elf->state.ar.children; 144441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 145441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project while (child != NULL) 146441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project { 147441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project if (child->ref_count != 0) 148441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project libelf_release_all (child); 149441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project child = child->next; 150441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project } 151441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project } 152441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 153441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project rwlock_unlock (elf->lock); 154441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project} 155441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 156441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 157441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project/* Macro to convert endianess in place. It determines the function it 158441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project has to use itself. */ 159441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#define CONVERT(Var) \ 160441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project (Var) = (sizeof (Var) == 1 \ 161cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng ? (unsigned char) (Var) \ 162441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project : (sizeof (Var) == 2 \ 163441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project ? bswap_16 (Var) \ 164441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project : (sizeof (Var) == 4 \ 165441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project ? bswap_32 (Var) \ 166441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project : bswap_64 (Var)))) 167441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 168441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#define CONVERT_TO(Dst, Var) \ 169441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project (Dst) = (sizeof (Var) == 1 \ 170cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng ? (unsigned char) (Var) \ 171441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project : (sizeof (Var) == 2 \ 172441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project ? bswap_16 (Var) \ 173441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project : (sizeof (Var) == 4 \ 174441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project ? bswap_32 (Var) \ 175441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project : bswap_64 (Var)))) 176441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 177441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 178441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#if __BYTE_ORDER == __LITTLE_ENDIAN 179441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project# define MY_ELFDATA ELFDATA2LSB 180441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#else 181441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project# define MY_ELFDATA ELFDATA2MSB 182441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#endif 183441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project 184441f72d43a9b550baa779fc82f70816da5f74f0eThe Android Open Source Project#endif /* common.h */ 185