Emil Velikov [Sat, 7 Sep 2024 00:15:04 +0000 (01:15 +0100)]
libkmod: introduce and use _nonnull_() decoration
Introduce a new attribute macro and use it, placing it on the left hand
side of the function return value. This aligns with the attributes style
used in C23.
Emil Velikov [Sat, 7 Sep 2024 00:15:04 +0000 (01:15 +0100)]
shared: use _nonnull_all_ decoration
Use the recently introduced attribute macro.
Note that functions such as memdup() and path_ends_with_kmod_ext() take
the (non-zero) length of their non-null string, thus can be annotated
with this _all_ variant.
Emil Velikov [Sat, 7 Sep 2024 00:15:04 +0000 (01:15 +0100)]
libkmod: introduce and use _nonnull_all_ decoration
Introduce a new attribute macro and use it, placing it on the left hand
side of the function return value. This aligns with the attributes style
used in C23.
Lucas De Marchi [Sat, 7 Sep 2024 00:15:04 +0000 (01:15 +0100)]
Drop empty statements
The double ';;' were clearly a mistake and clang-format only makes it
worse if we try running it. Remove the mistake before mass-converting
the source code.
If fstatat fails, st is not set, which leads to undefined results of
subsequent S_ISDIR call.
Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org> Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com> Link: https://github.com/kmod-project/kmod/pull/103 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Lucas De Marchi [Fri, 6 Sep 2024 19:46:28 +0000 (14:46 -0500)]
meson: normalize s/check/test/
The testsuite is executed by calling the 'test' target in meson, as
opposed to 'check' with autotools. Let's normalize it aligned to the new
build system.
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Fri, 6 Sep 2024 16:45:21 +0000 (11:45 -0500)]
ci: build: add docs in ci/developer builds
To make it a little bit more obvious that those should be updated as
well...
On Alpine it fails (as below), so we've disabled it for now.
When gtkdoc-mkhtml calls xsltproc, the latter throws dozens of errors and
fails to produce the libkmod.devhelp2 file. Which meson tries to move
and fails.
Emil Velikov [Mon, 2 Sep 2024 22:20:19 +0000 (23:20 +0100)]
libkmod/docs: s/Linux [Kk]ernel/the kernel/
The project is Linux specific, let's little point in repeating it.
More so, when we predominantly use "kernel" already. Adjust, while also
adding the definite article to adjust the grammar.
Emil Velikov [Mon, 2 Sep 2024 22:20:19 +0000 (23:20 +0100)]
libkmod/docs: add a trailing colon
Namely the doc for kmod_module_apply_filter is missing the trailing
colon. It seems that gtk-doc is smart enough to not needed, but we might
as well stay consistent.
This tripped me as I was grepping for "\* kmod_foo.*:$", while checking
the header against the gtk-doc sections file.
Emil Velikov [Mon, 2 Sep 2024 22:20:18 +0000 (23:20 +0100)]
libkmod/docs: move libkmod-loaded section to the header
In part to ease my life as I'm going through (shortly) and updating the
log. In part so that developers how don't install the gtk-doc html
pages, still have the information at hand.
While here, sort the API akin to the HTML documentation.
Emil Velikov [Mon, 2 Sep 2024 22:20:18 +0000 (23:20 +0100)]
libkmod/docs: move libkmod(-core) section to the header
In part to ease my life as I'm going through (shortly) and updating the
log. In part so that developers how don't install the gtk-doc html
pages, still have the information at hand.
While here, sort the API akin to the HTML documentation.
Emil Velikov [Mon, 2 Sep 2024 22:20:18 +0000 (23:20 +0100)]
libkmod/docs: move libkmod-module section to the header
In part to ease my life as I'm going through (shortly) and updating the
log. In part so that developers how don't install the gtk-doc html
pages, still have the information at hand.
While here, sort the API akin to the HTML documentation.
Emil Velikov [Mon, 2 Sep 2024 22:20:18 +0000 (23:20 +0100)]
libkmod/docs: move libkmod-list section to the header
In part to ease my life as I'm going through (shortly) and updating the
log. In part so that developers how don't install the gtk-doc html
pages, still have the information at hand.
While here, sort the API akin to the HTML documentation.
Emil Velikov [Mon, 2 Sep 2024 22:20:18 +0000 (23:20 +0100)]
libkmod/docs: move libkmod-config section to the header
In part to ease my life as I'm going through (shortly) and updating the
log. In part so that developers how don't install the gtk-doc html
pages, still have the information at hand.
Emil Velikov [Mon, 2 Sep 2024 22:20:18 +0000 (23:20 +0100)]
libkmod/docs: ignore libkmod-internal-file.h
Recently we introduced another internal header, yet forgot to add it to
the ignore headers list.
Fixes: 929ca4c ("libkmod: Move xz-related functions to separate file") Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Link: https://github.com/kmod-project/kmod/pull/94 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Mon, 2 Sep 2024 22:20:18 +0000 (23:20 +0100)]
libkmod/docs: remove non-applicable __must_check
Drop the __must_check from ignore-decorations, since it's nowhere to be
found. The correct name is _must_check_, although amongst others the
decoration is only for the internal API.
Emil Velikov [Tue, 3 Sep 2024 21:31:04 +0000 (22:31 +0100)]
testsuite/path: wrap 64 variants for _GLIBC_
Since musl v1.2.4 and Alpine 3.18, circa May 2023, the LFS64 variants
are no longer exported by libc.so.
In addition musl headers provide relevant "#define foo64 foo" macros,
when _LARGEFILE64_SOURCE is defined and symbol resolution is deferred to
the runtime linker. See musl commit 246f1c811448 ("remove LFS64 symbol
aliases; replace with dynamic linker remapping") more details.
Earlier versions of musl had the symbols exposed by libc, although the
^^ macros were also available when _GNU_SOURCE is set, as our build
does.
Most importantly, we do not explicitly use the 64 variants and musl
doesn't implicitly pull them either. So in practise building with musl,
the binaries do not have any 64 references, thus there is no need to
wrap them.
AFAICT there is no obvious way of detecting musl, apart from the lack of
of __GLIBC__, so pull features.h (which defines it) and check on that.
There is a small chance the __GLIBC__ check will miss-fire on other
implementations like bionic, dietlibc or ulibc(-ng). We don't run the
tests on those platforms (although we could) so it should be fine.
With that we can install tar (for make distcheck) and enable the tests
in CI \o/
Closes: https://github.com/kmod-project/kmod/issues/65 Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Link: https://github.com/kmod-project/kmod/pull/97 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
The other KMOD_EXPORT'ed functions protect against ctx being NULL.
Add this to kmod_get_dirname purely for consistency reasons.
Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org> Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com> Link: https://github.com/kmod-project/kmod/pull/102 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
During signature parser validation it is not enough to cast the end
result to 64 bit, because on 32 bit systems size_t is an unsigned 32 bit
integer, which implies that this will be the data type used to evaluate
the expression BEFORE casting it due to C standard.
Since the unsigned 32 bit calculation can overflow, cast the size_t
to int64_t, which makes the whole calculation safe.
This has no negative impact on 64 bit systems because the size_t
value is read as an unsigned 32 bit value from module.
Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org> Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com> Link: https://github.com/kmod-project/kmod/pull/95 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Mon, 2 Sep 2024 17:58:35 +0000 (18:58 +0100)]
ci: add meson build permutation
Note that we cannot use conditionals within the run actions, because
coreutils (for [ and test) are not installed on Debian/Ubuntu. Even
after doing so, the script consistently fails.
For meson dist to work, we need a full git repo, git and safe
directories setup, otherwise it fails as below. Meson issue was
reported ~2 years ago and we're about to get a fix soon (tm).
Dist currently only works with Git or Mercurial repos
v2:
- split git/checkout to separate patch
- use build-dev.ini instead of meson.sh
v3:
- use matrix for setting 'test' variable
Emil Velikov [Mon, 2 Sep 2024 17:58:35 +0000 (18:58 +0100)]
ci: install git and checkout using it
Atm the checkout action pulls the whole repo as tarball, since git is
missing. Since we install packages via local actions, we need to first
do an initial sparse checkout, install the packages (git including) and
do a proper second checkout.
At which point, the second checkout action claims to set safe.directory
(it's the default) although in practise we need to do it again. Perhaps
it's getting tripped by our initial sparse checkout?
Either way, explicitly set the option so that git just works.
Emil Velikov [Mon, 2 Sep 2024 17:58:35 +0000 (18:58 +0100)]
ci: remove no longer set matrix.configure
... and it doesn't seem like we'll need it in the future.
Fixes: fdcb656 ("testsuite: remove cached modules and --disable-test-modules") Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Mon, 2 Sep 2024 17:58:35 +0000 (18:58 +0100)]
meson: add support for the testsuite
Currently the stale tracking of modules/rootfs is non-existent and I
cannot quite find a way to fix that.
In addition, there is a long standing meson bug where the tests and by
extension their dependencies are always build even when annotated as
`build_by_default : false`. To workaround that, a new option is
introduced `build-tests`, defaulting to false.
Apart from that, all tests run and pass \o/
v2:
- split from top-level meson.build to subdir one
- add to EXTRA_DIST
- scripts are in scripts/
- add option to enable building tests
- error out if building without tools
Emil Velikov [Mon, 2 Sep 2024 17:58:35 +0000 (18:58 +0100)]
meson: add support for the tools
Nothing too spectacular, apart from a few meson quirks:
- one can use both_libraries() alas, "install: true" will also install
the static library, which we do not want
- need to workaround kmod.pc empty variables, introduced in 1.4.0
- wrapper script is needed for the symlink creation - see wrapper
script for details
- resulting binary exports optarg/optind/stderr/stdout and more
Emil Velikov [Mon, 2 Sep 2024 17:58:35 +0000 (18:58 +0100)]
meson: introduce meson, covering libkmod.so
The meson build system has been getting popularity, but for us that
means coverage and sanitisers OOTB et al.
The current patch, handles only libkmod.so and libkmod.pc. The rest will
follow-up.
Notable changes comparing against the autoconf:
- more consistent dirnames
- omit printing bash completion dir and compiler flags from summary
- debug toggle is renamed to debug-messages
- a few [C,LD]FLAGS were omitted - they're provided by meson itself
- libkmod.pc has the more complete Requires.private over Libs.private
- use the symver for libkmod.so, omit the version-info magic
Note: The minimal meson version is 0.60.0 akin to systemd and mesa.
v2:
- use gnu11, list both LGPL and GPL licenses
- add meson files to EXTRA_DIST
- add temporary stdndupa workaround
- move kmod bash-completion to later patch
v3:
- switch to meson 0.60.0
- remove stdndupa workaround
Loosely based on the work by: Dave Reisner <dreisner@archlinux.org>
Emil Velikov [Mon, 2 Sep 2024 17:58:35 +0000 (18:58 +0100)]
testsuite: split-out Kbuild from Makefile
The former is used by the kernel build system, while the latter is our
convenience wrapper. Split the two to indicate the distinction and make
things easier to parse.
Emil Velikov [Mon, 2 Sep 2024 17:58:35 +0000 (18:58 +0100)]
testsuite: temporary drop cross compilation test, remove binaries
The idea behind the test is that modinfo should work with foreign
modules - be that CPU architecture, endianess, bit width or otherwise.
On the other hand, having binary modules baked into the repo isn't great
since they can may be outdated wrt their in-tree source code, may
trigger warnings by various tools (the Debian linter flags them as
"source-not-available") and in general it's better if they're actually
generated via the in-tree Makefile.arch file.
Remove the binaries and temporarily drop the tests. We'll add proper
cross-compilation and re-enable them at a later stage.
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
shared: use memdup over stdndupa
The stdndupa has a couple of gotchas:
- allocates memory on stack via alloca(3)... where we pass it a
user-provided string in at least one instance
- it's a GNU extension missing on musl and bionic
The mkdir_p() function is not a hot path, so using heap allocation is
perfectly fine. Swap the stdndupa for our local helper memdup.
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
testsuite: use bash strict mode for setup-rootfs.sh
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
build: swap ABS_TOP_BUILDDIR for TOOLS_DIR
All the remaining instances are used to track the tools directory (aka
the local symlinks to kmod). Rename accordingly and include the tools
sub-directory.
Similar to the OVERRIDE_LIBDIR change earlier, this is build system
specific layout, which shouldn't be in the tests.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
testsuite/path: match the full rootpath
Our expectation is that the (full) rootpath is present, otherwise we
prepend it ourselves. Drop the ABS_TOP_BUILDDIR instance.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
build: set OVERRIDE_LIBDIR in the build system
The path is build-system specific, so set it there. Shortly we'll be
adding a meson build, where the value will be different.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
build: pass MODULE_DIRECTORY as arg to setup-rootfs.sh
... just like the other 5 args passed to the script.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
build: fixup testsuite LDFLAGS
Add the leading '-' for avoid-version, otherwise the module gets
versioned.
Drop the -export-dynamic, since the modules are built with
-fvisibility=hidden everything but the explicitly exported symbol is not
exported.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
build: alphabetically sort tests
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
build: alphabetically sort sources
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
build: remove linux/module.h check
We include the header for the UAPI MODULE_INIT_* constants, while we
also provide them locally.
At a glance, at least Arch and Alpine build kmod without the uapi
header, so just drop the check and ifndef guards all together.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
build: remove finit_module() check
For over 10 years, init_module(2) has been pretty clear - glibc does not
provide a wrapper for the function. AFAICT musl never provided one
either.
Remove the always failing check.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
missing.h: remove be32toh wrapper
As the inline comment says, it is applicable for older distributions
like RHEL 5. The extended support for RHEL 5 ended in 2020 (4 years ago)
so we're safe to drop this.
According to the Alpine build logs - the symbol has been present in musl
for years.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:21 +0000 (17:04 +0100)]
missing.h: warn on missing __NR_finit_module
Complain (somewhat) loudly if we don't have the syscall number, as the
default cannot work.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:20 +0000 (17:04 +0100)]
testsuite: set-but-unused variable KVER
As far as I can see, nothing ever used the variable - be that within
kmod itself, or the Kbuild itself.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:20 +0000 (17:04 +0100)]
testsuite: remove cached modules and --disable-test-modules
The option was added for distributions/maintainers lacking the linux
headers, while running the test-suite. It also aimed to resolve
licensing and "source-not-included" issues around the cached modules.
At a glance, it seems like only Debian is using the option these days,
Arch is using "any" linux headers available, while Fedora and Gentoo do
not run `make check` all together.
Debian's linter is complaining about "source-is-missing" and
"source-contains-prebuilt-binary", where the maintainer had to disable
those.
Removing the cache will make ^^ obsolete, while also simplifying the
check target. A nice side effect is making the (compressed) release
tarball 20% smaller.
Distributions are welcome to do something like Arch or not run the
target all together.
We are already running it in CI for Arch, Debian, Fedora and Ubuntu,
where more can be added as needed.
Cc: Marco d'Itri <md@linux.it> Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86
[ Fixup flag being passed in CI ] Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Emil Velikov [Thu, 22 Aug 2024 16:04:20 +0000 (17:04 +0100)]
build: remove --with-rootlibdir toggle
At a glance this option was introduced with distributions migrating from
/lib to /usr/lib.
Checking with Debian, Arch, Alpine, Fedora and Gentoo - only Debian and
Alpine set it. In the former - it's explicitly set to the default
(libdir), while the latter uses /lib and /usr/lib respectively.
Looking at the implementation itself, we don't adjust the libkmod.pc
which lists libdir, while libkmod.so is installed in rootlibdir.
Considering the negligible user base and somewhat broken state, drop the
option.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <lucas.de.marchi@gmail.com> Link: https://github.com/kmod-project/kmod/pull/86 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
The file modules.builtin.modinfo is supposed to consist of NUL
terminated strings. If the file contains a string which is not
properly NUL terminated, treat it as error.
Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org> Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com> Link: https://github.com/kmod-project/kmod/pull/83 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Make sure that errors never end up with errno being 0. These code paths
negate the errno value to get a negative value to propagate the fact
that an error occurred. -0 would be 0 again so errors are not detected.
Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org> Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com> Link: https://github.com/kmod-project/kmod/pull/83 Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
projects / thirdparty / kmod.git / log
