GitLab

Signed-off-by: Simon McVittie <smcv@collabora.com>

If we have the CAPTURE_FLAG_IF_EXISTS option flag, we should not
propagate an error if we are not able to find some dependencies of a
library. Instead we should just skip it.

This fixes an error that some users reported because they had some
leftovers unused libraries in their system and libcapsule reported an
error while trying to capture their (missing) dependencies.
Signed-off-by: Ludovico de Nittis <ludovico.denittis@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

If we `make dist` with gtk-doc-tools 1.28 from Debian 10 'buster' (the
current stable release), it generates a libcapsule-docs.xml in which
generation of tree_index.sgml is mandatory. This is incompatible with
building this non-GObject library with gtk-doc-tools >= 1.30, in which
tree_index.sgml is only generated if the library contains at least one
GObject type.

Most projects treat the libcapsule-docs.xml generated by gtk-doc as
a template and commit it to git, but in this project we don't
particularly want to maintain it and would prefer to keep regenerating
it during build.
Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Ludovico de Nittis <ludovico.denittis@collabora.com>

We are now able to list the symbol versions and/or symbols that are
known to be public/private.

This is especially useful for comparing libraries that removed symbol
versions, or symbols, from one release to another. As this already
happened multiple times in the past, like for example with
`libdrm_nouveau.so.2` or `libedit.so.2`.
Signed-off-by: Ludovico de Nittis <ludovico.denittis@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

This is mainly to give me a version number I can use in other packages'
dependencies.
Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

This gives capsule-capture-libs a source of library-specific knowledge.
For example, if we know that:

  * libgcc_s.so.1 is installed with an unhelpful name, but it uses
    versioned symbols the way you'd hope;
  * libdbus-1.so.3 is installed with a helpful libtool-style name,
    but has private symbols that defeat our current simplistic
    comparisons

then we can express that as:

    [Library libgcc_s.so.1]
    CompareBy=versions;symbols;

    [Library libdbus-1.so.3]
    CompareBy=name;

A runtime that contains a known set of libraries would be a good place
to put library-specific knowledge about those libraries. For example,
the maintainers of the Steam Runtime know what libraries it contains,
and are well-placed to compare those libraries with their counterparts
in mainstream distributions.
Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

This will let us select the comparator to use for individual libraries.
Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

Instead of asserting that the default behaviour is as desired, we now
assert that --compare-by=versions,name,symbols behaves the way it ought
to, and that the default behaviour is unchanged. It looks as though
applying --compare-by=versions,name,symbols indiscriminately could break
more than it fixes.
Signed-off-by: Simon McVittie <smcv@collabora.com>

This is primarily useful for testing and experimenting. Using versions
by default in preference to filenames (--compare-by="versions,name")
looks like it might be viable, but is a destabilising change that we
should test more before considering a change of defaults.

Meanwhile, counting symbols as a fallback (--compare-by="...,symbols")
does not look as safe as we had hoped, because if a library maintainer
has cleaned up their ABI by hiding private symbols without adding any
new symbols, we will sort libraries in exactly the wrong order - and
in reality, that seems to be what has happened in several libraries,
for example libX11.so.6 and libXfixes.so.3.
Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

This is a piece of necessary infrastructure for exposing this as a
command-line option, or even as per-library metadata. We were originally
going to do the equivalent of "versions,name,symbols" unconditionally,
but it looks as though that could break more than it fixes, so let's
be a bit more cautious.
Signed-off-by: Simon McVittie <smcv@collabora.com>

We can pass other state through this, such as the comparators to be
used to compare libraries.
Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

When two libraries have the same numeric tail we were not able to reliably
determine which one was the newer. In particular, many distributions
install libgcc_s.so.1 as a regular file, rather than a symlink to a
versioned name, so library_cmp_by_name() can't work.

These functions let us also check the library's version-definitions and
the individual symbols, to make a more nuanced decision.

Implementation originally by Ludovico de Nittis, adapted by Simon
McVittie to fit the same signature as library_cmp_by_name() so that
we can call the comparison functions via function pointers, to set up
different comparison weights for each library if necessary. This version
also includes Simon's changes to ignore uninteresting symbols for the
purposes of library comparison, with a list of uninteresting symbols
that are part of various architectures' ABIs, taken from dpkg-gensymbols.
Co-authored-by: Ludovico de Nittis <ludovico.denittis@collabora.com>
Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

This will let us unit-test it more easily. While I'm moving it,
re-indent it in libcapsule's coding style (4 rather than 2 space
indents).
Signed-off-by: Simon McVittie <smcv@collabora.com>

Inspired by g_ptr_array_free(., FALSE) and g_bytes_unref_to_array(),
this lets us convert a ptr_list into a raw array suitable for use
with qsort() and bsearch().
Signed-off-by: Simon McVittie <smcv@collabora.com>

This assumes either a C11 compiler, or as a fallback, a tolerably new
version of gcc.
Signed-off-by: Simon McVittie <smcv@collabora.com>

See https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=964457

Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

When building with things like AddressSanitizer, we want to apply
instrumentation to the libcapsule library itself, the libcapsule
tools, and the unit tests. However, we do not want to instrument the
tiny libraries that are used as test fixtures, because giving them a
dependency on libasan.so.5 would confuse libcapsule when testing them.
Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

Signed-off-by: Simon McVittie <smcv@collabora.com>

This is what was documented to happen.

Previously, we did not clear the entry if we failed to open the
library fd, or if we succeeded but the library was "unacceptable"
(wrong ELF class or machine tag). Normally this results in a minor
memory leak, and a fd leak if the library is "unacceptable".

However, when called from search_ldcache_cb(), it's particularly
important that we do this, because search_ldcache() uses the state
of the fd field - valid fd or not - to check whether ld_lib_open()
succeeded.

One practical symptom is that if your container has an x86_64
libfoo.so.0 that compares newer than the provider's libfoo.so.0,
and does not have an i386 libfoo.so.0, then capsule-capture-libs
would unexpectedly not capture the i386 libfoo.so.0 from the provider
either.
Signed-off-by: Simon McVittie <smcv@collabora.com>

The pressure-vessel tool used in the Steam Runtime has an increasingly
long list of graphics libraries which might be better as a file
than on the command-line.
Signed-off-by: Simon McVittie <smcv@collabora.com>

The file descriptor pointing to the jobserver is not passed through
the test script, so passing through a MAKEFLAGS environment variable
that refers to it is just going to confuse us.
Signed-off-by: Simon McVittie <smcv@collabora.com>

The linker used in Steam Runtime 1 'scout', which is from several years
ago, doesn't seem to like a symbol being made an alias for a versioned
symbol of the same name. Rename the symbol so that only the versioned
aliases get the same basename.
Signed-off-by: Simon McVittie <smcv@collabora.com>

Some libcapsule users and contributors are using Arch Linux or Manjaro
rather than a Debian derivative.

Many of the tests will be skipped on Gitlab-CI because they need a
working bubblewrap, which isn't allowed inside unprivileged Docker;
but this provides "executable documentation" for how to do a build
and test.
Signed-off-by: Simon McVittie <smcv@collabora.com>

This demonstrates the behaviour we want from !23.
Signed-off-by: Simon McVittie <smcv@collabora.com>