DEBUGINFOD-FIND

Section: User Commands (1)
Page Index
 

NAME

debuginfod-find - request debuginfo-related data

 

SYNOPSIS

debuginfod-find [OPTION]... debuginfo BUILDID

debuginfod-find [OPTION]... executable BUILDID

debuginfod-find [OPTION]... source BUILDID /FILENAME

 

DESCRIPTION

debuginfod-find queries one or more debuginfod servers for debuginfo-related data. In case of a match, it saves the the requested file into a local cache, prints the file name to standard output, and exits with a success status of 0. In case of any error, it exits with a failure status and an error message to standard error.

The debuginfod system uses buildids to identify debuginfo-related data. These are stored as binary notes in ELF/DWARF files, and are represented as lowercase hexadecimal. For example, for a program /bin/ls, look at the ELF note GNU_BUILD_ID:


% readelf -n /bin/ls | grep -A4 build.id
Note section [ 4] '.note.gnu.buildid' of 36 bytes at offset 0x340:
Owner          Data size  Type
GNU                   20  GNU_BUILD_ID
Build ID: 8713b9c3fb8a720137a4a08b325905c7aaf8429d

Then the hexadecimal BUILDID is simply:


8713b9c3fb8a720137a4a08b325905c7aaf8429d

 

debuginfo BUILDID

If the given buildid is known to a server, this request will result in a binary object that contains the customary .*debug_* sections. This may be a split debuginfo file as created by strip, or it may be an original unstripped executable.

 

executable BUILDID

If the given buildid is known to the server, this request will result in a binary object that contains the normal executable segments. This may be a executable stripped by strip, or it may be an original unstripped executable. ET_DYN shared libraries are considered to be a type of executable.

 

source BUILDID /SOURCE/FILE

If the given buildid is known to the server, this request will result in a binary object that contains the source file mentioned. The path should be absolute. Relative path names commonly appear in the DWARF file's source directory, but these paths are relative to individual compilation unit AT_comp_dir paths, and yet an executable is made up of multiple CUs. Therefore, to disambiguate, debuginfod expects source queries to prefix relative path names with the CU compilation-directory, followed by a mandatory "/".

Note: the user should not elide ../ or /./ or extraneous /// sorts of path components in the directory names, because if this is how those names appear in the DWARF files, that is what debuginfod needs to see too.

For example:

#include <stdio.h>source BUILDID /usr/include/stdio.h
/path/to/foo.csource BUILDID /path/to/foo.c
../bar/foo.c AT_comp_dir=/zoo/source BUILDID /zoo//../bar/foo.c

 

OPTIONS

-v
Increase verbosity, including printing frequent download-progress messages.

 

SECURITY

debuginfod-find does not include any particular security features. It trusts that the binaries returned by the debuginfod(s) are accurate. Therefore, the list of servers should include only trustworthy ones. If accessed across HTTP rather than HTTPS, the network should be trustworthy. Authentication information through the internal libcurl library is not currently enabled, except for the basic plaintext http[s]://userid:password@hostname/ style. (The debuginfod server does not perform authentication, but a front-end proxy server could.)

 

ENVIRONMENT VARIABLES

DEBUGINFOD_URLS
This environment variable contains a list of URL prefixes for trusted debuginfod instances. Alternate URL prefixes are separated by space.

DEBUGINFOD_TIMEOUT
This environment variable governs the timeout for each debuginfod HTTP connection. A server that fails to provide at least 100K of data within this many seconds is skipped. The default is 90 seconds. (Zero or negative means "no timeout".)

DEBUGINFOD_CACHE_PATH
This environment variable governs the location of the cache where downloaded files are kept. It is cleaned periodically as this program is reexecuted. Cache management parameters may be set by files under this directory: see the debuginfod_find_debuginfo(3) man page for details. The default is $HOME/.debuginfod_client_cache.

 

FILES

$HOME/.debuginfod_client_cache
Default cache directory.

 

SEE ALSO

debuginfod(8) debuginfod_find_debuginfod(3)


 

Index

NAME
SYNOPSIS
DESCRIPTION
debuginfo BUILDID
executable BUILDID
source BUILDID /SOURCE/FILE
OPTIONS
SECURITY
ENVIRONMENT VARIABLES
FILES
SEE ALSO
LinuxReviews : manual page archive : man1