systemd-hwdb: introduce new tool

This pulls out the hwdb managment from udevadm into an independent tool.

The old code is left in place for backwards compatibility, and easy of
testing, but all documentation is dropped to encourage use of the new
tool instead.
This commit is contained in:
Tom Gundersen
2014-12-16 00:48:24 +01:00
parent b98b483bac
commit 65eb4378c3
12 changed files with 1022 additions and 118 deletions

1
.gitignore vendored
View File

@@ -81,6 +81,7 @@
/systemd-hibernate-resume
/systemd-hibernate-resume-generator
/systemd-hostnamed
/systemd-hwdb
/systemd-inhibit
/systemd-initctl
/systemd-journal-gatewayd

View File

@@ -14,6 +14,7 @@ MANPAGES += \
man/file-hierarchy.7 \
man/halt.8 \
man/hostname.5 \
man/hwdb.7 \
man/journalctl.1 \
man/journald.conf.5 \
man/kernel-command-line.7 \
@@ -72,6 +73,7 @@ MANPAGES += \
man/systemd-halt.service.8 \
man/systemd-hibernate-resume-generator.8 \
man/systemd-hibernate-resume@.service.8 \
man/systemd-hwdb.8 \
man/systemd-inhibit.1 \
man/systemd-initctl.service.8 \
man/systemd-journald.service.8 \
@@ -1593,6 +1595,7 @@ EXTRA_DIST += \
man/halt.xml \
man/hostname.xml \
man/hostnamectl.xml \
man/hwdb.xml \
man/journalctl.xml \
man/journald.conf.xml \
man/kernel-command-line.xml \
@@ -1702,6 +1705,7 @@ EXTRA_DIST += \
man/systemd-hibernate-resume-generator.xml \
man/systemd-hibernate-resume@.service.xml \
man/systemd-hostnamed.service.xml \
man/systemd-hwdb.xml \
man/systemd-inhibit.xml \
man/systemd-initctl.service.xml \
man/systemd-journal-gatewayd.service.xml \

View File

@@ -542,7 +542,7 @@ nodist_systemunit_DATA = \
units/systemd-udevd.service \
units/systemd-udev-trigger.service \
units/systemd-udev-settle.service \
units/systemd-udev-hwdb-update.service \
units/systemd-hwdb-update.service \
units/debug-shell.service \
units/initrd-parse-etc.service \
units/initrd-cleanup.service \
@@ -3400,8 +3400,7 @@ libudev_internal_la_CFLAGS = \
# ------------------------------------------------------------------------------
INSTALL_DIRS += \
$(sysconfdir)/udev/rules.d \
$(sysconfdir)/udev/hwdb.d
$(sysconfdir)/udev/rules.d
dist_network_DATA = \
network/99-default.link \
@@ -3429,20 +3428,6 @@ dist_udevrules_DATA += \
nodist_udevrules_DATA += \
rules/99-systemd.rules
dist_udevhwdb_DATA = \
hwdb/20-pci-vendor-model.hwdb \
hwdb/20-pci-classes.hwdb \
hwdb/20-usb-vendor-model.hwdb \
hwdb/20-usb-classes.hwdb \
hwdb/20-sdio-vendor-model.hwdb \
hwdb/20-sdio-classes.hwdb \
hwdb/20-bluetooth-vendor-product.hwdb \
hwdb/20-acpi-vendor.hwdb \
hwdb/20-OUI.hwdb \
hwdb/20-net-ifname.hwdb \
hwdb/60-keyboard.hwdb \
hwdb/70-mouse.hwdb
udevconfdir = $(sysconfdir)/udev
dist_udevconf_DATA = \
src/udev/udev.conf
@@ -3462,14 +3447,12 @@ CLEANFILES += \
EXTRA_DIST += \
units/systemd-udevd.service.in \
units/systemd-udev-trigger.service.in \
units/systemd-udev-settle.service.in \
units/systemd-udev-hwdb-update.service.in
units/systemd-udev-settle.service.in
CLEANFILES += \
units/systemd-udevd.service \
units/systemd-udev-trigger.service \
units/systemd-udev-settle.service \
units/systemd-udev-hwdb-update.service
units/systemd-udev-settle.service
SOCKETS_TARGET_WANTS += \
systemd-udevd-control.socket \
@@ -3477,8 +3460,7 @@ SOCKETS_TARGET_WANTS += \
SYSINIT_TARGET_WANTS += \
systemd-udevd.service \
systemd-udev-trigger.service \
systemd-udev-hwdb-update.service
systemd-udev-trigger.service
rootbin_PROGRAMS += \
udevadm
@@ -3599,10 +3581,49 @@ udevadm_SOURCES = \
udevadm_LDADD = \
libudev-core.la
# ------------------------------------------------------------------------------
INSTALL_DIRS += \
$(sysconfdir)/udev/hwdb.d
systemd_hwdb_SOURCES = \
src/libsystemd/sd-hwdb/hwdb-internal.h \
src/hwdb/hwdb.c
systemd_hwdb_LDADD = \
libsystemd-shared.la \
libsystemd-internal.la \
libudev-internal.la
rootbin_PROGRAMS += \
systemd-hwdb
dist_udevhwdb_DATA = \
hwdb/20-pci-vendor-model.hwdb \
hwdb/20-pci-classes.hwdb \
hwdb/20-usb-vendor-model.hwdb \
hwdb/20-usb-classes.hwdb \
hwdb/20-sdio-vendor-model.hwdb \
hwdb/20-sdio-classes.hwdb \
hwdb/20-bluetooth-vendor-product.hwdb \
hwdb/20-acpi-vendor.hwdb \
hwdb/20-OUI.hwdb \
hwdb/20-net-ifname.hwdb \
hwdb/60-keyboard.hwdb \
hwdb/70-mouse.hwdb
EXTRA_DIST += \
units/systemd-hwdb-update.service.in
CLEANFILES += \
units/systemd-hwdb-update.service
SYSINIT_TARGET_WANTS += \
systemd-hwdb-update.service
# Update hwdb on installation. Do not bother if installing
# in DESTDIR, since this is likely for packaging purposes.
hwdb-update-hook:
-test -n "$(DESTDIR)" || $(rootbindir)/udevadm hwdb --update
-test -n "$(DESTDIR)" || $(rootbindir)/systemd-hwdb update
INSTALL_DATA_HOOKS += \
hwdb-update-hook

87
man/hwdb.xml Normal file
View File

@@ -0,0 +1,87 @@
<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="hwdb">
<refentryinfo>
<title>hwdb</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Kay</firstname>
<surname>Sievers</surname>
<email>kay@vrfy.org</email>
</author>
<author>
<contrib>Developer</contrib>
<firstname>Tom</firstname>
<surname>Gundersen</surname>
<email>teg@jklm.no</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>hwdb</refentrytitle>
<manvolnum>7</manvolnum>
</refmeta>
<refnamediv>
<refname>hwdb</refname>
<refpurpose>Hardware Database</refpurpose>
</refnamediv>
<refsect1><title>Description</title>
<para>The hardware database is a key-value store for associating modalias-like keys to
udev-properties-like values. It is used primarily by udev to add the relevant properties
to matching devices, but it can also be queried directly.</para>
</refsect1>
<refsect1><title>Hardware Database Files</title>
<para>The hwdb files are read from the files located in the
system hwdb directory <filename>/usr/lib/udev/hwdb.d</filename>,
the volatile runtime directory <filename>/run/udev/hwdb.d</filename>
and the local administration directory <filename>/etc/udev/hwdb.d</filename>.
All hwdb files are collectively sorted and processed in lexical order,
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in <filename>/etc</filename>
have the highest priority, files in <filename>/run</filename> take precedence
over files with the same name in <filename>/usr/lib</filename>. This can be
used to override a system-supplied hwdb file with a local file if needed;
a symlink in <filename>/etc</filename> with the same name as a hwdb file in
<filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
disables the hwdb file entirely. hwdb files must have the extension
<filename>.hwdb</filename>; other extensions are ignored.</para>
<para>The hwdb file contains data records consisting of matches and
associated key-value pairs. Every record in the hwdb starts with one or
more match string, specifying a shell glob to compare the database
lookup string against. Multiple match lines are specified in additional
consecutive lines. Every match line is compared indivdually, they are
combined by OR. Every match line must start at the first character of
the line.</para>
<para>The match lines are followed by one or more key-value pair lines, which
are recognized by a leading space character. The key name and value are separated
by <literal>=</literal>. An empty line signifies the end
of a record. Lines beginning with <literal>#</literal> are ignored.</para>
<para>The content of all hwdb files is read by
<citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum></citerefentry>
and compiled to a binary database located at <filename>/etc/udev/hwdb.bin</filename>,
or alternatively <filename>/usr/lib/udev/hwdb.bin</filename> if you want ship the compiled
database in an immutable image.
During runtime only the binary database is used.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry>
<refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>

94
man/systemd-hwdb.xml Normal file
View File

@@ -0,0 +1,94 @@
<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="systemd-hwdb">
<refentryinfo>
<title>systemd-hwdb</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Kay</firstname>
<surname>Sievers</surname>
<email>kay@vrfy.org</email>
</author>
<author>
<contrib>Developer</contrib>
<firstname>Tom</firstname>
<surname>Gundersen</surname>
<email>teg@jklm.no</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-hwdb</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-hwdb</refname><refpurpose>hardware database management tool</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemd-hwdb <optional>options</optional> update</command>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-hwdb <optional>options</optional> query <replaceable>modalias</replaceable></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para><command>systemd-hwdb</command> expects a command and command
specific arguments. It manages the binary hardware database.</para>
</refsect1>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--usr</option></term>
<listitem>
<para>Generate in /usr/lib/udev instead of /etc/udev.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option></term>
<term><option>--root=<replaceable>PATH</replaceable></option></term>
<listitem>
<para>Alternative root path in the filesystem.</para>
</listitem>
</varlistentry>
</variablelist>
<refsect2><title>systemd-hwdb
<arg choice="opt"><replaceable>options</replaceable></arg>
update</title>
<para>Update the binary database.</para>
</refsect2>
<refsect2><title>systemd-hwdb
<arg choice="opt"><replaceable>options</replaceable></arg>
query
<arg><replaceable>MODALIAS</replaceable></arg>
</title>
<para>Query database and print result.</para>
</refsect2>
</refsect1>
<refsect1>
<title>See Also</title>
<para><citerefentry>
<refentrytitle>hwdb</refentrytitle><manvolnum>7</manvolnum>
</citerefentry></para>
</refsect1>
</refentry>

View File

@@ -735,43 +735,6 @@
</variablelist>
</refsect1>
<refsect1><title>Hardware Database Files</title>
<para>The hwdb files are read from the files located in the
system hwdb directory <filename>/usr/lib/udev/hwdb.d</filename>,
the volatile runtime directory <filename>/run/udev/hwdb.d</filename>
and the local administration directory <filename>/etc/udev/hwdb.d</filename>.
All hwdb files are collectively sorted and processed in lexical order,
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in <filename>/etc</filename>
have the highest priority, files in <filename>/run</filename> take precedence
over files with the same name in <filename>/usr/lib</filename>. This can be
used to override a system-supplied hwdb file with a local file if needed;
a symlink in <filename>/etc</filename> with the same name as a hwdb file in
<filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
disables the hwdb file entirely. hwdb files must have the extension
<filename>.hwdb</filename>; other extensions are ignored.</para>
<para>The hwdb file contains data records consisting of matches and
associated key-value pairs. Every record in the hwdb starts with one or
more match string, specifying a shell glob to compare the database
lookup string against. Multiple match lines are specified in additional
consecutive lines. Every match line is compared indivdually, they are
combined by OR. Every match line must start at the first character of
the line.</para>
<para>The match lines are followed by one or more key-value pair lines, which
are recognized by a leading space character. The key name and value are separated
by <literal>=</literal>. An empty line signifies the end
of a record. Lines beginning with <literal>#</literal> are ignored.</para>
<para>The content of all hwdb files is read by
<citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>
and compiled to a binary database located at <filename>/etc/udev/hwdb.bin</filename>,
or alternatively <filename>/usr/lib/udev/hwdb.bin</filename> if you want ship the compiled
database in an immutable image.
During runtime only the binary database is used.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>

View File

@@ -48,9 +48,6 @@
<cmdsynopsis>
<command>udevadm monitor <optional>options</optional></command>
</cmdsynopsis>
<cmdsynopsis>
<command>udevadm hwdb <optional>options</optional></command>
</cmdsynopsis>
<cmdsynopsis>
<command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command>
</cmdsynopsis>
@@ -512,56 +509,6 @@
</variablelist>
</refsect2>
<refsect2><title>udevadm hwdb
<arg choice="opt"><replaceable>options</replaceable></arg>
</title>
<para>Maintain the hardware database index in <filename>/etc/udev/hwdb.bin</filename>.</para>
<variablelist>
<varlistentry>
<term><option>-u</option></term>
<term><option>--update</option></term>
<listitem>
<para>Compile the hardware database information located in /usr/lib/udev/hwdb.d/,
/etc/udev/hwdb.d/ and store it in <filename>/etc/udev/hwdb.bin</filename>. This should be done after
any update to the source files; it will not be called automatically. The running
udev daemon will detect a new database on its own and does not need to be
notified about it.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--usr</option></term>
<listitem>
<para>Put the compiled database into <filename>/usr/lib/udev/hwdb.bin</filename> instead.
Use this if you want to ship a pre-compiled database in immutable system images, or
don't use <filename>/etc/udev/hwdb.d</filename> and want to avoid large binary files in
<filename>/etc</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option></term>
<term><option>--test=<replaceable>string</replaceable></option></term>
<listitem>
<para>Query the database with a modalias string, and print the
retrieved properties.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option></term>
<term><option>--root=<replaceable>string</replaceable></option></term>
<listitem>
<para>Alternative root path in the file system for reading and writing files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2><title>udevadm test
<arg choice="opt"><replaceable>options</replaceable></arg>
<arg><replaceable>devpath</replaceable></arg>

1
src/hwdb/Makefile Symbolic link
View File

@@ -0,0 +1 @@
../Makefile

787
src/hwdb/hwdb.c Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -687,5 +687,4 @@ out:
const struct udevadm_cmd udevadm_hwdb = {
.name = "hwdb",
.cmd = adm_hwdb,
.help = "maintain the hardware database index",
};

2
units/.gitignore vendored
View File

@@ -66,7 +66,7 @@
/systemd-tmpfiles-setup-dev.service
/systemd-tmpfiles-setup.service
/systemd-tmpfiles.service
/systemd-udev-hwdb-update.service
/systemd-hwdb-update.service
/systemd-udev-settle.service
/systemd-udev-trigger.service
/systemd-udevd.service

View File

@@ -7,7 +7,7 @@
[Unit]
Description=Rebuild Hardware Database
Documentation=man:udev(7) man:systemd-udevd.service(8)
Documentation=man:hwdb(7) man:systemd-hwdb(8)
DefaultDependencies=no
Conflicts=shutdown.target
After=systemd-remount-fs.service
@@ -20,4 +20,4 @@ ConditionDirectoryNotEmpty=|/etc/udev/hwdb.d/
[Service]
Type=oneshot
RemainAfterExit=yes
ExecStart=@rootbindir@/udevadm hwdb --update
ExecStart=@rootbindir@/systemd-hwdb update