125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Find an ELF file for a module from its build ID. 225b3c049e70834cf33790a28643ab058b507b35cBen Cheng Copyright (C) 2007-2010 Red Hat, Inc. 325b3c049e70834cf33790a28643ab058b507b35cBen Cheng This file is part of Red Hat elfutils. 425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 525b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is free software; you can redistribute it and/or modify 625b3c049e70834cf33790a28643ab058b507b35cBen Cheng it under the terms of the GNU General Public License as published by the 725b3c049e70834cf33790a28643ab058b507b35cBen Cheng Free Software Foundation; version 2 of the License. 825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 925b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is distributed in the hope that it will be useful, but 1025b3c049e70834cf33790a28643ab058b507b35cBen Cheng WITHOUT ANY WARRANTY; without even the implied warranty of 1125b3c049e70834cf33790a28643ab058b507b35cBen Cheng MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 1225b3c049e70834cf33790a28643ab058b507b35cBen Cheng General Public License for more details. 1325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1425b3c049e70834cf33790a28643ab058b507b35cBen Cheng You should have received a copy of the GNU General Public License along 1525b3c049e70834cf33790a28643ab058b507b35cBen Cheng with Red Hat elfutils; if not, write to the Free Software Foundation, 1625b3c049e70834cf33790a28643ab058b507b35cBen Cheng Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA. 1725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1825b3c049e70834cf33790a28643ab058b507b35cBen Cheng In addition, as a special exception, Red Hat, Inc. gives You the 1925b3c049e70834cf33790a28643ab058b507b35cBen Cheng additional right to link the code of Red Hat elfutils with code licensed 2025b3c049e70834cf33790a28643ab058b507b35cBen Cheng under any Open Source Initiative certified open source license 2125b3c049e70834cf33790a28643ab058b507b35cBen Cheng (http://www.opensource.org/licenses/index.php) which requires the 2225b3c049e70834cf33790a28643ab058b507b35cBen Cheng distribution of source code with any binary distribution and to 2325b3c049e70834cf33790a28643ab058b507b35cBen Cheng distribute linked combinations of the two. Non-GPL Code permitted under 2425b3c049e70834cf33790a28643ab058b507b35cBen Cheng this exception must only link to the code of Red Hat elfutils through 2525b3c049e70834cf33790a28643ab058b507b35cBen Cheng those well defined interfaces identified in the file named EXCEPTION 2625b3c049e70834cf33790a28643ab058b507b35cBen Cheng found in the source code files (the "Approved Interfaces"). The files 2725b3c049e70834cf33790a28643ab058b507b35cBen Cheng of Non-GPL Code may instantiate templates or use macros or inline 2825b3c049e70834cf33790a28643ab058b507b35cBen Cheng functions from the Approved Interfaces without causing the resulting 2925b3c049e70834cf33790a28643ab058b507b35cBen Cheng work to be covered by the GNU General Public License. Only Red Hat, 3025b3c049e70834cf33790a28643ab058b507b35cBen Cheng Inc. may make changes or additions to the list of Approved Interfaces. 3125b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat's grant of this exception is conditioned upon your not adding 3225b3c049e70834cf33790a28643ab058b507b35cBen Cheng any new exceptions. If you wish to add a new Approved Interface or 3325b3c049e70834cf33790a28643ab058b507b35cBen Cheng exception, please contact Red Hat. You must obey the GNU General Public 3425b3c049e70834cf33790a28643ab058b507b35cBen Cheng License in all respects for all of the Red Hat elfutils code and other 3525b3c049e70834cf33790a28643ab058b507b35cBen Cheng code used in conjunction with Red Hat elfutils except the Non-GPL Code 3625b3c049e70834cf33790a28643ab058b507b35cBen Cheng covered by this exception. If you modify this file, you may extend this 3725b3c049e70834cf33790a28643ab058b507b35cBen Cheng exception to your version of the file, but you are not obligated to do 3825b3c049e70834cf33790a28643ab058b507b35cBen Cheng so. If you do not wish to provide this exception without modification, 3925b3c049e70834cf33790a28643ab058b507b35cBen Cheng you must delete this exception statement from your version and license 4025b3c049e70834cf33790a28643ab058b507b35cBen Cheng this file solely under the GPL without exception. 4125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 4225b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is an included package of the Open Invention Network. 4325b3c049e70834cf33790a28643ab058b507b35cBen Cheng An included package of the Open Invention Network is a package for which 4425b3c049e70834cf33790a28643ab058b507b35cBen Cheng Open Invention Network licensees cross-license their patents. No patent 4525b3c049e70834cf33790a28643ab058b507b35cBen Cheng license is granted, either expressly or impliedly, by designation as an 4625b3c049e70834cf33790a28643ab058b507b35cBen Cheng included package. Should you wish to participate in the Open Invention 4725b3c049e70834cf33790a28643ab058b507b35cBen Cheng Network licensing program, please visit www.openinventionnetwork.com 4825b3c049e70834cf33790a28643ab058b507b35cBen Cheng <http://www.openinventionnetwork.com>. */ 4925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5025b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include "libdwflP.h" 5125b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <inttypes.h> 5225b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <fcntl.h> 5325b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <unistd.h> 5425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5625b3c049e70834cf33790a28643ab058b507b35cBen Chengint 5725b3c049e70834cf33790a28643ab058b507b35cBen Chenginternal_function 5825b3c049e70834cf33790a28643ab058b507b35cBen Cheng__libdwfl_open_by_build_id (Dwfl_Module *mod, bool debug, char **file_name) 5925b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 6025b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* If *FILE_NAME was primed into the module, leave it there 6125b3c049e70834cf33790a28643ab058b507b35cBen Cheng as the fallback when we have nothing to offer. */ 6225b3c049e70834cf33790a28643ab058b507b35cBen Cheng errno = 0; 6325b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (mod->build_id_len <= 0) 6425b3c049e70834cf33790a28643ab058b507b35cBen Cheng return -1; 6525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6625b3c049e70834cf33790a28643ab058b507b35cBen Cheng const size_t id_len = mod->build_id_len; 6725b3c049e70834cf33790a28643ab058b507b35cBen Cheng const uint8_t *id = mod->build_id_bits; 6825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6925b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Search debuginfo_path directories' .build-id/ subdirectories. */ 7025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 7125b3c049e70834cf33790a28643ab058b507b35cBen Cheng char id_name[sizeof "/.build-id/" + 1 + id_len * 2 + sizeof ".debug" - 1]; 7225b3c049e70834cf33790a28643ab058b507b35cBen Cheng strcpy (id_name, "/.build-id/"); 7325b3c049e70834cf33790a28643ab058b507b35cBen Cheng int n = snprintf (&id_name[sizeof "/.build-id/" - 1], 7425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 4, "%02" PRIx8 "/", (uint8_t) id[0]); 7525b3c049e70834cf33790a28643ab058b507b35cBen Cheng assert (n == 3); 7625b3c049e70834cf33790a28643ab058b507b35cBen Cheng for (size_t i = 1; i < id_len; ++i) 7725b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 7825b3c049e70834cf33790a28643ab058b507b35cBen Cheng n = snprintf (&id_name[sizeof "/.build-id/" - 1 + 3 + (i - 1) * 2], 7925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 3, "%02" PRIx8, (uint8_t) id[i]); 8025b3c049e70834cf33790a28643ab058b507b35cBen Cheng assert (n == 2); 8125b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 8225b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (debug) 8325b3c049e70834cf33790a28643ab058b507b35cBen Cheng strcpy (&id_name[sizeof "/.build-id/" - 1 + 3 + (id_len - 1) * 2], 8425b3c049e70834cf33790a28643ab058b507b35cBen Cheng ".debug"); 8525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8625b3c049e70834cf33790a28643ab058b507b35cBen Cheng const Dwfl_Callbacks *const cb = mod->dwfl->callbacks; 8765b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng#if defined(__BIONIC__) || defined(__APPLE__) 8865b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng char *path = strdup ((cb->debuginfo_path ? *cb->debuginfo_path : NULL) 8965b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng ?: DEFAULT_DEBUGINFO_PATH); 9065b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng#else 9125b3c049e70834cf33790a28643ab058b507b35cBen Cheng char *path = strdupa ((cb->debuginfo_path ? *cb->debuginfo_path : NULL) 9225b3c049e70834cf33790a28643ab058b507b35cBen Cheng ?: DEFAULT_DEBUGINFO_PATH); 9365b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng#endif 9425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 9525b3c049e70834cf33790a28643ab058b507b35cBen Cheng int fd = -1; 9625b3c049e70834cf33790a28643ab058b507b35cBen Cheng char *dir; 9725b3c049e70834cf33790a28643ab058b507b35cBen Cheng while (fd < 0 && (dir = strsep (&path, ":")) != NULL) 9825b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 9925b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (dir[0] == '+' || dir[0] == '-') 10025b3c049e70834cf33790a28643ab058b507b35cBen Cheng ++dir; 10125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 10225b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Only absolute directory names are useful to us. */ 10325b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (dir[0] != '/') 10425b3c049e70834cf33790a28643ab058b507b35cBen Cheng continue; 10525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 10625b3c049e70834cf33790a28643ab058b507b35cBen Cheng size_t dirlen = strlen (dir); 10725b3c049e70834cf33790a28643ab058b507b35cBen Cheng char *name = malloc (dirlen + sizeof id_name); 10825b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (unlikely (name == NULL)) 10925b3c049e70834cf33790a28643ab058b507b35cBen Cheng break; 11025b3c049e70834cf33790a28643ab058b507b35cBen Cheng memcpy (mempcpy (name, dir, dirlen), id_name, sizeof id_name); 11125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11225b3c049e70834cf33790a28643ab058b507b35cBen Cheng fd = TEMP_FAILURE_RETRY (open64 (name, O_RDONLY)); 11325b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (fd >= 0) 11425b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 11525b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (*file_name != NULL) 11625b3c049e70834cf33790a28643ab058b507b35cBen Cheng free (*file_name); 11725b3c049e70834cf33790a28643ab058b507b35cBen Cheng *file_name = canonicalize_file_name (name); 11825b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (*file_name == NULL) 11925b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 12025b3c049e70834cf33790a28643ab058b507b35cBen Cheng *file_name = name; 12125b3c049e70834cf33790a28643ab058b507b35cBen Cheng name = NULL; 12225b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 12325b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 12425b3c049e70834cf33790a28643ab058b507b35cBen Cheng free (name); 12525b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 12625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12765b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng#if defined(__BIONIC__) || defined(__APPLE__) 12865b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng free(path); 12965b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng#endif 13065b3819bcdc2ecbfec9e718d121af9f5fe614069Ben Cheng 13125b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* If we simply found nothing, clear errno. If we had some other error 13225b3c049e70834cf33790a28643ab058b507b35cBen Cheng with the file, report that. Possibly this should treat other errors 13325b3c049e70834cf33790a28643ab058b507b35cBen Cheng like ENOENT too. But ignoring all errors could mask some that should 13425b3c049e70834cf33790a28643ab058b507b35cBen Cheng be reported. */ 13525b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (fd < 0 && errno == ENOENT) 13625b3c049e70834cf33790a28643ab058b507b35cBen Cheng errno = 0; 13725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 13825b3c049e70834cf33790a28643ab058b507b35cBen Cheng return fd; 13925b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 14025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 14125b3c049e70834cf33790a28643ab058b507b35cBen Chengint 14225b3c049e70834cf33790a28643ab058b507b35cBen Chengdwfl_build_id_find_elf (Dwfl_Module *mod, 14325b3c049e70834cf33790a28643ab058b507b35cBen Cheng void **userdata __attribute__ ((unused)), 14425b3c049e70834cf33790a28643ab058b507b35cBen Cheng const char *modname __attribute__ ((unused)), 14525b3c049e70834cf33790a28643ab058b507b35cBen Cheng Dwarf_Addr base __attribute__ ((unused)), 14625b3c049e70834cf33790a28643ab058b507b35cBen Cheng char **file_name, Elf **elfp) 14725b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 14825b3c049e70834cf33790a28643ab058b507b35cBen Cheng *elfp = NULL; 14925b3c049e70834cf33790a28643ab058b507b35cBen Cheng int fd = __libdwfl_open_by_build_id (mod, false, file_name); 15025b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (fd >= 0) 15125b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 15225b3c049e70834cf33790a28643ab058b507b35cBen Cheng Dwfl_Error error = __libdw_open_file (&fd, elfp, true, false); 15325b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (error != DWFL_E_NOERROR) 15425b3c049e70834cf33790a28643ab058b507b35cBen Cheng __libdwfl_seterrno (error); 15525b3c049e70834cf33790a28643ab058b507b35cBen Cheng else if (__libdwfl_find_build_id (mod, false, *elfp) == 2) 15625b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 15725b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* This is a backdoor signal to short-circuit the ID refresh. */ 15825b3c049e70834cf33790a28643ab058b507b35cBen Cheng mod->main.valid = true; 15925b3c049e70834cf33790a28643ab058b507b35cBen Cheng return fd; 16025b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 16125b3c049e70834cf33790a28643ab058b507b35cBen Cheng else 16225b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 16325b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* This file does not contain the ID it should! */ 16425b3c049e70834cf33790a28643ab058b507b35cBen Cheng elf_end (*elfp); 16525b3c049e70834cf33790a28643ab058b507b35cBen Cheng *elfp = NULL; 16625b3c049e70834cf33790a28643ab058b507b35cBen Cheng close (fd); 16725b3c049e70834cf33790a28643ab058b507b35cBen Cheng fd = -1; 16825b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 16925b3c049e70834cf33790a28643ab058b507b35cBen Cheng free (*file_name); 17025b3c049e70834cf33790a28643ab058b507b35cBen Cheng *file_name = NULL; 17125b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 17225b3c049e70834cf33790a28643ab058b507b35cBen Cheng else if (errno == 0 && mod->build_id_len > 0) 17325b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Setting this with no file yet loaded is a marker that 17425b3c049e70834cf33790a28643ab058b507b35cBen Cheng the build ID is authoritative even if we also know a 17525b3c049e70834cf33790a28643ab058b507b35cBen Cheng putative *FILE_NAME. */ 17625b3c049e70834cf33790a28643ab058b507b35cBen Cheng mod->main.valid = true; 17725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 17825b3c049e70834cf33790a28643ab058b507b35cBen Cheng return fd; 17925b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 18025b3c049e70834cf33790a28643ab058b507b35cBen ChengINTDEF (dwfl_build_id_find_elf) 181