patch 2/2 debuginfod server etc.
Wed Nov 13 23:19:00 GMT 2019
On Mon, 2019-10-28 at 15:07 -0400, Frank Ch. Eigler wrote:
> Add the server to the debuginfod/ subdirectory. This is a highly
> multithreaded c++11 program (still buildable on rhel7's gcc 4.8,
> which is only partly c++11 compliant). Includes an initial suite
> of tests, man pages, and a sample systemd service.
OK, some comments about the debuginfod dir additions.
Except the actual code...
> diff --git a/debuginfod/ChangeLog b/debuginfod/ChangeLog
> index 1a31cf6f4e27..b5679a2f9d16 100644
> --- a/debuginfod/ChangeLog
> +++ b/debuginfod/ChangeLog
> @@ -1,3 +1,9 @@
> +2019-10-28 Frank Ch. Eigler <firstname.lastname@example.org>
> + * debuginfod.cxx: New file: debuginfod server.
> + * debuginfod.8: New file: man page.
> + * Makefile.am: Build it.
Like with the client manpages, I think they should go into the doc/ dir
just because all manpages are there at the moment.
> * debuginfod-client.c: New file: debuginfod client library.
> diff --git a/debuginfod/Makefile.am b/debuginfod/Makefile.am
> index 3a4e94da2ad0..6e5c7290e68d 100644
> --- a/debuginfod/Makefile.am
> +++ b/debuginfod/Makefile.am
> @@ -55,9 +55,14 @@ libeu = ../lib/libeu.a
> AM_LDFLAGS = -Wl,-rpath-link,../libelf:../libdw:.
> -bin_PROGRAMS = debuginfod-find
> +bin_PROGRAMS = debuginfod debuginfod-find
> +debuginfod_SOURCES = debuginfod.cxx
> +debuginfod_cxx_CXXFLAGS = -Wno-unused-functions
Should that be debuginfod_CXXFLAGS?
Why are there unused functions are there?
> +# g++ 4.8 on rhel7 otherwise errors gthr-default.h / __gthrw2(__gthrw_(__pthread_key_create) undefs
Could you explain this comment a bit more?
> +dist_man8_MANS = debuginfod.8
As stated above, I think this should be moved to doc/
> dist_man3_MANS = debuginfod_find_debuginfo.3 debuginfod_find_source.3 debuginfod_find_executable.3
> dist_man1_MANS = debuginfod-find.1
> +debuginfod_LDADD = $(libdw) $(libelf) $(libeu) $(libdebuginfod) $(libmicrohttpd_LIBS) $(libcurl_LIBS) $(sqlite3_LIBS) $(libarchive_LIBS) -lpthread -ldl
> debuginfod_find_SOURCES = debuginfod-find.c
> debuginfod_find_LDADD = $(libeu) $(libdebuginfod)
> diff --git a/debuginfod/debuginfod.8 b/debuginfod/debuginfod.8
> new file mode 100644
> index 000000000000..02059a115430
> --- /dev/null
> +++ b/debuginfod/debuginfod.8
> @@ -0,0 +1,332 @@
> +'\"! tbl | nroff \-man
> +'\" t macro stdmacro
> +.de SAMPLE
> +.RS 0
> +.de ESAMPLE
> +.TH DEBUGINFOD 8
> +.SH NAME
> +debuginfod \- debuginfo-related http file-server daemon
Right. section 8 because it is system administration command.
> +.SH SYNOPSIS
> +.B debuginfod
> +[\fIOPTION\fP]... [\fIPATH\fP]...
> +.SH DESCRIPTION
> +\fBdebuginfod\fP serves debuginfo-related artifacts over HTTP. It
> +periodically scans a set of directories for ELF/DWARF files and their
> +associated source code, as well as RPM files containing the above, to
> +build an index by their buildid. This index is used when remote
> +clients use the HTTP webapi, to fetch these files by the same buildid.
> +If a debuginfod cannot service a given buildid artifact request
> +itself, and it is configured with information about upstream
> +debuginfod servers, it queries them for the same information, just as
> +\fBdebuginfod-find\fP would. If successful, it locally caches then
> +relays the file content to the original requester.
> +Each listed PATH creates a thread to scan for matching
> +ELF/DWARF/source files under the given directory. Source files are
> +matched with DWARF files based on the AT_comp_dir (compilation
> +directory) attributes inside it. Duplicate directories are ignored.
> +You may use a file name for a PATH, but source code indexing may be
> +incomplete; prefer using a directory that contains the binaries.
So you give it directories with executables and directories with debug
files. They are indexed if they have a build-id. You never provide a
sources dir, but if something is indexed as a debug file then any
source file referenced from it can be requested.
In theory you only need to provide the executable dirs, from that you
can normally get the separate .debug files.
Why didn't you do that (only providing executable dirs)?
And why do you allow sources to be found indirectly?
Would it make sense to restrict the sources (prefix) dir?
The questions above are simply because it makes me nervous that some,
but not all, files that can be requested can indirectly be found
anywhere. If you have an explicit debug dir, then it might make sense
to also have an explicit sources dir.
In general I think it would be good to think about a selinux security
context for debuginfod. This is not urgent, but I think we should see
if we can get someone to do a security audit.
One concern I have is that if a process is run in a restricted security
context in which it might not be able to access certain files, but it
might have access to a local socket to debuginfod, then it can get
access to files it normally wouldn't. And if it could somehow write
into any directory that debuginfod reads then it could construct a
.debug file that points to any file on the system by adding it to the
DWARF debug_lines file list. All this might be unlikely because this is
all locally running processes. But it would be good to have someone who
is a bit paranoid take a look if we aren't accidentally "leaking"
> +Each listed PATH also creates a thread to scan for ELF/DWARF/source
> +files contained in matching RPMs under the given directory. Duplicate
> +directories are ignored. You may use a file name for a PATH, but
> +source code indexing may be incomplete; prefer using a directory that
> +contains normal RPMs alongside debuginfo/debugsource RPMs. Because of
> +complications such as DWZ-compressed debuginfo, may require \fItwo\fP
> +scan passes to identify all source code.
Again, this is convenient. But wouldn't it make sense to just have
explicit paths for things like debuginfo/sources RPM containers?
> +If no PATH is listed, then \fBdebuginfod\fP will simply serve content
> +that it scanned into its index in previous runs.
Please add a sentence explaining how to reset the index.
Also this means that if you change PATHs the contents from the old
PATHS is still accessible? If so, do mention this explicitily.
> +File names must match extended regular expressions given by the \-I
> +option and not the \-X option (if any) in order to be considered.
These are global and cannot be set per PATH?
> +.SH OPTIONS
> +.B "\-d FILE" "\-\-database=FILE"
> +Set the path of the SQLITE database used to store the index. This
> +file is disposable in the sense that a later rescan will repopulate
> +data. It will contain absolute file path names, so it may not be
> +portable across machines. It will be frequently read/written, so it
> +may perform well while sharing across machines or users either, due
> +to SQLITE locking performance. The default database file is
It performs well because it is frequently read/written?
Is that missing a not?
> +.B "\-D SQL" "\-\-ddl=SQL"
> +Execute given SQLITE statement after the database is opened and
> +initialized as extra DDL. This may be useful to tune
> +performance-related pragmas or indexes. May be repeated. The default
> +is nothing extra.
You might want to explain what DDL stands for.
> +.B "\-p NUM" "\-\-port=NUM"
> +Set the TCP port number on which debuginfod should listen, to service
> +HTTP requests. Both IPv4 and IPV6 sockets are opened, if possible.
> +The webapi is documented below. The default port number is 8002.
> +.B "\-I REGEX" "\-\-include=REGEX" "\-X REGEX" "\-\-exclude=REGEX"
> +Govern the inclusion and exclusion of file names under the search
> +paths. The regular expressions are interpreted as unanchored POSIX
> +extended REs, thus may include alternation. They are evaluated
> +against the full path of each file, based on its \fBrealpath(3)\fP
> +canonicalization. By default, all files are included and none are
> +excluded. A file that matches both include and exclude REGEX is
> +excluded. (The \fIcontents\fP of RPM files are not subject to
> +inclusion or exclusion filtering: they are all processed.)
Could/Should this default to -I/all/paths/given/* so only files from
under those paths are included and no files from outside the search
> +.B "\-t SECONDS" "\-\-rescan\-time=SECONDS"
> +Set the rescan time for the file and RPM directories. This is the
> +amount of time the scanning threads will wait after finishing a scan,
> +before doing it again. A rescan for unchanged files is fast (because
> +the index also stores the file mtimes). A time of zero is acceptable,
> +and means that only one initial scan should performed. The default
> +rescan time is 300 seconds. Receiving a SIGUSR1 signal triggers a new
> +scan, independent of the rescan time (including if it was zero).
300 seconds seem somewhat arbitrary. But I don't have a better number
> +.B "\-g SECONDS" "\-\-groom\-time=SECONDS"
> +Set the groom time for the index database. This is the amount of time
> +the grooming thread will wait after finishing a grooming pass before
> +doing it again. A groom operation quickly rescans all previously
> +scanned files, only to see if they are still present and current, so
> +it can deindex obsolete files. See also the \fIDATA MANAGEMENT\fP
> +section. The default groom time is 86400 seconds (1 day). A time of
> +zero is acceptable, and means that only one initial groom should be
> +performed. Receiving a SIGUSR2 signal triggers a new grooming pass,
> +independent of the groom time (including if it was zero).
So the rescan only adds new files to the index and doesn't purge old
> +.B "\-G"
> +Run an extraordinary maximal-grooming pass at debuginfod startup.
> +This pass can take considerable time, because it tries to remove any
> +debuginfo-unrelated content from the RPM-related parts of the index.
> +It should not be run if any recent RPM-related indexing operations
> +were aborted early. It can take considerable space, because it
> +finishes up with an sqlite "vacuum" operation, which repacks the
> +database file by triplicating it temporarily. The default is not to
> +do maximal-grooming. See also the \fIDATA MANAGEMENT\fP section.
So basically never, ever use this? :)
Can you add a hint when you should use it?
> +.B "\-c NUM" "\-\-concurrency=NUM"
> +Set the concurrency limit for all the scanning threads. While many
> +threads may be spawned to cover all the given PATHs, only NUM may
> +concurrently do CPU-intensive operations like parsing an ELF file
> +or an RPM. The default is the number of processors on the system;
> +the minimum is 1.
> +.B "\-v"
> +Increase verbosity of logging to the standard error file descriptor.
> +May be repeated to increase details. The default verbosity is 0.
> +.SH WEBAPI
> +.\" Much of the following text is duplicated with debuginfod-find.1
> +The debuginfod's webapi resembles ordinary file service, where a GET
> +request with a path containing a known buildid results in a file.
> +Unknown buildid / request combinations result in HTTP error codes.
> +This file service resemblance is intentional, so that an installation
> +can take advantage of standard HTTP management infrastructure.
> +There are three requests. In each case, the buildid is encoded as a
> +lowercase hexadecimal string. 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:
> +.SS /buildid/\fIBUILDID\fP/debuginfo
> +If the given buildid is known to the server, this request will result
> +in a binary object that contains the customary \fB.*debug_*\fP
> +sections. This may be a split debuginfo file as created by
> +\fBstrip\fP, or it may be an original unstripped executable.
> +.SS /buildid/\fIBUILDID\fP/executable
> +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 \fBstrip\fP, or it may be an original
> +unstripped executable. \fBET_DYN\fP shared libraries are considered
> +to be a type of executable.
> +.SS /buildid/\fIBUILDID\fP/source\fI/SOURCE/FILE\fP
> +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
Note a subtlety with DWARF4 vs DWARF5. In both cases debug line index
zero refers to the compile unit directory. But in DWARF5 that directory
should actually be in the line table (so you don't have to look it up
through the associated CU in the debug_info DIE tree).
> +Note: contrary to RFC 3986, the client should not elide \fB../\fP or
> +\fB/./\fP sorts of relative 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:
> +l l.
> +#include <stdio.h> /buildid/BUILDID/source/usr/include/stdio.h
> +/path/to/foo.c /buildid/BUILDID/source/path/to/foo.c
> +\../bar/foo.c AT_comp_dir=/zoo /buildid/BUILDID/source/zoo/../bar/foo.c
I agree this is needed because it is how the data/paths are represented
in DWARF. But it does concern me there is no /../ processing done to
make sure something isn't requested outside the source paths.
> +.SH DATA MANAGEMENT
> +debuginfod stores its index in an sqlite database in a densely packed
> +set of interlinked tables. While the representation is as efficient
> +as we have been able to make it, it still takes a considerable amount
> +of data to record all debuginfo-related data of potentially a great
> +many files. This section offers some advice about the implications.
> +As a general explanation for size, consider that debuginfod indexes
> +ELF/DWARF files, it stores their names and referenced source file
> +names, and buildids will be stored. When indexing RPMs, it stores
> +every file name \fIof or in\fP an RPM, every buildid, plus every
> +source file name referenced from a DWARF file. (Indexing RPMs takes
> +more space because the source files often reside in separate
> +subpackages that may not be indexed at the same pass, so extra
> +metadata has to be kept.)
> +Getting down to numbers, in the case of Fedora RPMs (essentially,
> +gzip-compressed cpio files), the sqlite index database tends to be
> +from 0.5% to 3% of their size. It's larger for binaries that are
> +assembled out of a great many source files, or packages that carry
> +much debuginfo-unrelated content. It may be even larger during the
> +indexing phase due to temporary sqlite write-ahead-logging files;
> +these are checkpointed (cleaned out and removed) at shutdown. It may
> +be helpful to apply tight \-I or \-X regular-expression constraints to
> +exclude files from scanning that you know have no debuginfo-relevant
> +As debuginfod runs, it periodically rescans its target directories,
> +and any new content found is added to the database. Old content, such
> +as data for files that have disappeared or that have been replaced
> +with newer versions is removed at a periodic \fIgrooming\fP pass.
> +This means that the sqlite files grow fast during initial indexing,
> +slowly during index rescans, and periodically shrink during grooming.
> +There is also an optional one-shot \fImaximal grooming\fP pass is
> +available. It removes information debuginfo-unrelated data from the
> +RPM content index, but it is slow and temporarily requires up to twice
> +the database size as free space. Worse: it may result in missing
> +source-code info if the RPM traversals were interrupted. Use it
> +rarely to polish a complete index.
> +You should ensure that ample disk space remains available. (The flood
> +of error messages on -ENOSPC is ugly and nagging. But, like for most
> +other errors, debuginfod will resume when resources permit.) If
> +necessary, debuginfod can be stopped, the database file moved or
> +removed, and debuginfod restarted.
Do we need and/or can we add some option to limit the disk space used?
> +sqlite offers several performance-related options in the form of
> +pragmas. Some may be useful to fine-tune the defaults plus the
> +debuginfod extras. The \-D option may be useful to tell debuginfod to
> +execute the given bits of SQL after the basic schema creation
> +commands. For example, the "synchronous", "cache_size",
> +"auto_vacuum", "threads", "journal_mode" pragmas may be fun to tweak
> +via \-D, if you're searching for peak performance. The "optimize",
> +"wal_checkpoint" pragmas may be useful to run periodically, outside
> +As debuginfod changes in the future, we may have no choice but to
> +change the database schema in an incompatible manner. If this
> +happens, new versions of debuginfod will issue SQL statements to
> +\fIdrop\fP all prior schema & data, and start over. So, disk space
> +will not be wasted for retaining a no-longer-useable dataset.
> +In summary, if your system can bear a 0.5%-3% index-to-RPM-dataset
> +size ratio, and slow growth afterwards, you should not need to
> +worry about any of this.
> +.SH SECURITY
> +debuginfod \fBdoes not\fP include any particular security features.
> +While it is robust with respect to inputs, some abuse is possible. It
> +forks a new thread for each incoming HTTP request, which could lead to
> +a denial-of-service in terms of RAM, CPU, disk I/O, or network I/O.
> +If this is a problem, users are advised to install debuginfod with a
> +HTTPS reverse-proxy front-end that enforces site policies for
> +firewalling, authentication, integrity, authorization, and load
> +When relaying queries to upstream debuginfods, debuginfod \fBdoes not\fP
> +include any particular security features. It trusts that the binaries
> +returned by the debuginfods are accurate. Therefore, the list of
> +servers should include only trustworthy ones. If accessed across HTTP
> +rather than HTTPS, the network should be trustworthy.
Same question as with the client. Does it use the standard trust
database for certificate verification with HTTPS?
> +.SH "ENVIRONMENT VARIABLES"
> +.TP 21
> +.B DEBUGINFOD_URLS
> +This environment variable contains a list of URL prefixes for trusted
> +debuginfod instances. Alternate URL prefixes are separated by space.
> +Avoid referential loops that cause a server to contact itself, directly
> +or indirectly - the results would be hilarious.
> +.TP 21
> +.B DEBUGINFOD_TIMEOUT
> +This environment variable governs the timeout for each debuginfod HTTP
> +connection. A server that fails to respond within this many seconds
> +is skipped. The default is 5.
> +.TP 21
> +.B 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. The default is $HOME/.debuginfod_client_cache.
> +.\" XXX describe cache eviction policy
In this case that is downloaded files from other, remote, debuginfod
> +.SH FILES
> +.PD .1v
> +.TP 20
> +.B $HOME/.debuginfod.sqlite
> +Default database file.
> +.TP 20
> +.B $HOME/.debuginfod_client_cache
> +Default cache directory for content from upstream debuginfods.
> +.SH "SEE ALSO"
> +.I "debuginfod-find(1)"
> +.I "sqlite3(1)"
Thanks so much for writing so much documentation!
I haven't had time to read all the code yet. But I already feel pretty
good about it because the documentation is so extensive.
More information about the Elfutils-devel