libdwfl/find-debuginfo.c

   1 /* Standard find_debuginfo callback for libdwfl.
   2    Copyright (C) 2005 Red Hat, Inc.
   3    This file is part of Red Hat elfutils.
   4
   5    Red Hat elfutils is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by the
   7    Free Software Foundation; version 2 of the License.
   8
   9    Red Hat elfutils is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License along
  15    with Red Hat elfutils; if not, write to the Free Software Foundation,
  16    Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA.
  17
  18    In addition, as a special exception, Red Hat, Inc. gives You the
  19    additional right to link the code of Red Hat elfutils with code licensed
  20    under any Open Source Initiative certified open source license
  21    (http://www.opensource.org/licenses/index.php) which requires the
  22    distribution of source code with any binary distribution and to
  23    distribute linked combinations of the two.  Non-GPL Code permitted under
  24    this exception must only link to the code of Red Hat elfutils through
  25    those well defined interfaces identified in the file named EXCEPTION
  26    found in the source code files (the "Approved Interfaces").  The files
  27    of Non-GPL Code may instantiate templates or use macros or inline
  28    functions from the Approved Interfaces without causing the resulting
  29    work to be covered by the GNU General Public License.  Only Red Hat,
  30    Inc. may make changes or additions to the list of Approved Interfaces.
  31    Red Hat's grant of this exception is conditioned upon your not adding
  32    any new exceptions.  If you wish to add a new Approved Interface or
  33    exception, please contact Red Hat.  You must obey the GNU General Public
  34    License in all respects for all of the Red Hat elfutils code and other
  35    code used in conjunction with Red Hat elfutils except the Non-GPL Code
  36    covered by this exception.  If you modify this file, you may extend this
  37    exception to your version of the file, but you are not obligated to do
  38    so.  If you do not wish to provide this exception without modification,
  39    you must delete this exception statement from your version and license
  40    this file solely under the GPL without exception.
  41
  42    Red Hat elfutils is an included package of the Open Invention Network.
  43    An included package of the Open Invention Network is a package for which
  44    Open Invention Network licensees cross-license their patents.  No patent
  45    license is granted, either expressly or impliedly, by designation as an
  46    included package.  Should you wish to participate in the Open Invention
  47    Network licensing program, please visit www.openinventionnetwork.com
  48    <http://www.openinventionnetwork.com>.  */
  49
  50 #include "libdwflP.h"
  51 #include <stdio.h>
  52 #include <fcntl.h>
  53 #include <unistd.h>
  54 #include "system.h"
  55
  56
  57 #define DEFAULT_DEBUGINFO_PATH ":.debug:/usr/lib/debug"
  58
  59
  60 /* Try to open64 [DIR/][SUBDIR/]DEBUGLINK, return file descriptor or -1.
  61    On success, *DEBUGINFO_FILE_NAME has the malloc'd name of the open file.  */
  62 static int
  63 try_open (const char *dir, const char *subdir, const char *debuglink,
  64           char **debuginfo_file_name)
  65 {
  66   char *fname = NULL;
  67   if (dir == NULL && subdir == NULL)
  68     fname = strdup (debuglink);
  69   else if (subdir == NULL)
  70     asprintf (&fname, "%s/%s", dir, debuglink);
  71   else if (dir == NULL)
  72     asprintf (&fname, "%s/%s", subdir, debuglink);
  73   else
  74     asprintf (&fname, "%s/%s/%s", dir, subdir, debuglink);
  75
  76   if (fname == NULL)
  77     return -1;
  78
  79   int fd = TEMP_FAILURE_RETRY (open64 (fname, O_RDONLY));
  80   if (fd < 0)
  81     free (fname);
  82   else
  83     *debuginfo_file_name = fname;
  84
  85   return fd;
  86 }
  87
  88 /* Return true iff the FD's contents CRC matches DEBUGLINK_CRC.  */
  89 static inline bool
  90 check_crc (int fd, GElf_Word debuglink_crc)
  91 {
  92   uint32_t file_crc;
  93   return (__libdwfl_crc32_file (fd, &file_crc) == 0
  94           && file_crc == debuglink_crc);
  95 }
  96
  97 int
  98 dwfl_standard_find_debuginfo (Dwfl_Module *mod,
  99                               void **userdata __attribute__ ((unused)),
 100                               const char *modname __attribute__ ((unused)),
 101                               GElf_Addr base __attribute__ ((unused)),
 102                               const char *file_name,
 103                               const char *debuglink_file,
 104                               GElf_Word debuglink_crc,
 105                               char **debuginfo_file_name)
 106 {
 107   bool cancheck = debuglink_crc != (GElf_Word) 0;
 108
 109   const char *file_basename = file_name == NULL ? NULL : basename (file_name);
 110   if (debuglink_file == NULL)
 111     {
 112       if (file_basename == NULL)
 113         {
 114           errno = 0;
 115           return -1;
 116         }
 117
 118       size_t len = strlen (file_basename);
 119       char *localname = alloca (len + sizeof ".debug");
 120       memcpy (localname, file_basename, len);
 121       memcpy (&localname[len], ".debug", sizeof ".debug");
 122       debuglink_file = localname;
 123       cancheck = false;
 124     }
 125
 126   /* Look for a file named DEBUGLINK_FILE in the directories
 127      indicated by the debug directory path setting.  */
 128
 129   const Dwfl_Callbacks *const cb = mod->dwfl->callbacks;
 130   char *path = strdupa ((cb->debuginfo_path ? *cb->debuginfo_path : NULL)
 131                         ?: DEFAULT_DEBUGINFO_PATH);
 132
 133   /* A leading - or + in the whole path sets whether to check file CRCs.  */
 134   bool defcheck = true;
 135   if (path[0] == '-' || path[0] == '+')
 136     {
 137       defcheck = path[0] == '+';
 138       ++path;
 139     }
 140
 141   char *file_dirname = (file_basename == file_name ? NULL
 142                         : strndupa (file_name, file_basename - 1 - file_name));
 143   char *p;
 144   while ((p = strsep (&path, ":")) != NULL)
 145     {
 146       /* A leading - or + says whether to check file CRCs for this element.  */
 147       bool check = defcheck;
 148       if (*p == '+' || *p == '-')
 149         check = *p++ == '+';
 150       check = check && cancheck;
 151
 152       const char *dir, *subdir;
 153       switch (p[0])
 154         {
 155         case '\0':
 156           /* An empty entry says to try the main file's directory.  */
 157           dir = file_dirname;
 158           subdir = NULL;
 159           break;
 160         case '/':
 161           /* An absolute path says to look there for a subdirectory
 162              named by the main file's absolute directory.
 163              This cannot be applied to a relative file name.  */
 164           if (file_dirname == NULL || file_dirname[0] != '/')
 165             continue;
 166           dir = p;
 167           subdir = file_dirname + 1;
 168           break;
 169         default:
 170           /* A relative path says to try a subdirectory of that name
 171              in the main file's directory.  */
 172           dir = file_dirname;
 173           subdir = p;
 174           break;
 175         }
 176
 177       char *fname;
 178       int fd = try_open (dir, subdir, debuglink_file, &fname);
 179       if (fd < 0)
 180         switch (errno)
 181           {
 182           case ENOENT:
 183           case ENOTDIR:
 184             continue;
 185           default:
 186             return -1;
 187           }
 188       if (!check || check_crc (fd, debuglink_crc))
 189         {
 190           *debuginfo_file_name = fname;
 191           return fd;
 192         }
 193       free (fname);
 194       close (fd);
 195     }
 196
 197   /* No dice.  */
 198   errno = 0;
 199   return -1;
 200 }
 201 INTDEF (dwfl_standard_find_debuginfo)