diff --git a/.gitignore b/.gitignore index bd9125d79c..c849c4dc9b 100644 --- a/.gitignore +++ b/.gitignore @@ -81,6 +81,7 @@ /systemd-hibernate-resume /systemd-hibernate-resume-generator /systemd-hostnamed +/systemd-hwdb /systemd-inhibit /systemd-initctl /systemd-journal-gatewayd diff --git a/Makefile-man.am b/Makefile-man.am index 6a40b76804..45b8238adc 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -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 \ diff --git a/Makefile.am b/Makefile.am index 6896c4be52..2c9c5e3041 100644 --- a/Makefile.am +++ b/Makefile.am @@ -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 diff --git a/man/hwdb.xml b/man/hwdb.xml new file mode 100644 index 0000000000..9f2aff3261 --- /dev/null +++ b/man/hwdb.xml @@ -0,0 +1,87 @@ + + + + + + + hwdb + systemd + + + Developer + Kay + Sievers + kay@vrfy.org + + + Developer + Tom + Gundersen + teg@jklm.no + + + + + + hwdb + 7 + + + + hwdb + Hardware Database + + + Description + 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. + + + Hardware Database Files + The hwdb files are read from the files located in the + system hwdb directory /usr/lib/udev/hwdb.d, + the volatile runtime directory /run/udev/hwdb.d + and the local administration directory /etc/udev/hwdb.d. + 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 /etc + have the highest priority, files in /run take precedence + over files with the same name in /usr/lib. This can be + used to override a system-supplied hwdb file with a local file if needed; + a symlink in /etc with the same name as a hwdb file in + /usr/lib, pointing to /dev/null, + disables the hwdb file entirely. hwdb files must have the extension + .hwdb; other extensions are ignored. + + 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. + + 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 =. An empty line signifies the end + of a record. Lines beginning with # are ignored. + + The content of all hwdb files is read by + systemd-hwdb8 + and compiled to a binary database located at /etc/udev/hwdb.bin, + or alternatively /usr/lib/udev/hwdb.bin if you want ship the compiled + database in an immutable image. + During runtime only the binary database is used. + + + + See Also + + + systemd-hwdb8 + + + + diff --git a/man/systemd-hwdb.xml b/man/systemd-hwdb.xml new file mode 100644 index 0000000000..09f4d551a9 --- /dev/null +++ b/man/systemd-hwdb.xml @@ -0,0 +1,94 @@ + + + + + + + systemd-hwdb + systemd + + + Developer + Kay + Sievers + kay@vrfy.org + + + Developer + Tom + Gundersen + teg@jklm.no + + + + + + systemd-hwdb + 8 + + + + systemd-hwdbhardware database management tool + + + + + systemd-hwdb options update + + + systemd-hwdb options query modalias + + + + Description + systemd-hwdb expects a command and command + specific arguments. It manages the binary hardware database. + + + Options + + + + + + Print help text. + + + + + + Generate in /usr/lib/udev instead of /etc/udev. + + + + + + + Alternative root path in the filesystem. + + + + + systemd-hwdb + <arg choice="opt"><replaceable>options</replaceable></arg> + update + Update the binary database. + + + systemd-hwdb + <arg choice="opt"><replaceable>options</replaceable></arg> + query + <arg><replaceable>MODALIAS</replaceable></arg> + + Query database and print result. + + + + + See Also + + hwdb7 + + + diff --git a/man/udev.xml b/man/udev.xml index 1113a66a2a..34b2e12f78 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -735,43 +735,6 @@ - Hardware Database Files - The hwdb files are read from the files located in the - system hwdb directory /usr/lib/udev/hwdb.d, - the volatile runtime directory /run/udev/hwdb.d - and the local administration directory /etc/udev/hwdb.d. - 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 /etc - have the highest priority, files in /run take precedence - over files with the same name in /usr/lib. This can be - used to override a system-supplied hwdb file with a local file if needed; - a symlink in /etc with the same name as a hwdb file in - /usr/lib, pointing to /dev/null, - disables the hwdb file entirely. hwdb files must have the extension - .hwdb; other extensions are ignored. - - 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. - - 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 =. An empty line signifies the end - of a record. Lines beginning with # are ignored. - - The content of all hwdb files is read by - udevadm8 - and compiled to a binary database located at /etc/udev/hwdb.bin, - or alternatively /usr/lib/udev/hwdb.bin if you want ship the compiled - database in an immutable image. - During runtime only the binary database is used. - - See Also diff --git a/man/udevadm.xml b/man/udevadm.xml index 38c1935fa8..4aa89646db 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -48,9 +48,6 @@ udevadm monitor options - - udevadm hwdb options - udevadm test options devpath @@ -512,56 +509,6 @@ - udevadm hwdb - <arg choice="opt"><replaceable>options</replaceable></arg> - - Maintain the hardware database index in /etc/udev/hwdb.bin. - - - - - - Compile the hardware database information located in /usr/lib/udev/hwdb.d/, - /etc/udev/hwdb.d/ and store it in /etc/udev/hwdb.bin. 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. - - - - - - Put the compiled database into /usr/lib/udev/hwdb.bin instead. - Use this if you want to ship a pre-compiled database in immutable system images, or - don't use /etc/udev/hwdb.d and want to avoid large binary files in - /etc. - - - - - - - Query the database with a modalias string, and print the - retrieved properties. - - - - - - - Alternative root path in the file system for reading and writing files. - - - - - - - Print help text. - - - - - udevadm test <arg choice="opt"><replaceable>options</replaceable></arg> <arg><replaceable>devpath</replaceable></arg> diff --git a/src/hwdb/Makefile b/src/hwdb/Makefile new file mode 120000 index 0000000000..d0b0e8e008 --- /dev/null +++ b/src/hwdb/Makefile @@ -0,0 +1 @@ +../Makefile \ No newline at end of file diff --git a/src/hwdb/hwdb.c b/src/hwdb/hwdb.c new file mode 100644 index 0000000000..9f8cbf6c79 --- /dev/null +++ b/src/hwdb/hwdb.c @@ -0,0 +1,787 @@ +/*** + This file is part of systemd. + + Copyright 2012 Kay Sievers <kay@vrfy.org> + + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. + + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. +***/ + +#include <stdlib.h> +#include <unistd.h> +#include <getopt.h> +#include <string.h> +#include <ctype.h> + +#include "util.h" +#include "strbuf.h" +#include "conf-files.h" +#include "strv.h" +#include "mkdir.h" +#include "fileio.h" + +#include "hwdb-internal.h" +#include "hwdb-util.h" + +/* + * Generic udev properties, key/value database based on modalias strings. + * Uses a Patricia/radix trie to index all matches for efficient lookup. + */ + +static const char *arg_hwdb_bin_dir = "/etc/udev"; +static const char *arg_root = ""; + +static const char * const conf_file_dirs[] = { + "/etc/udev/hwdb.d", + UDEVLIBEXECDIR "/hwdb.d", + NULL +}; + +/* in-memory trie objects */ +struct trie { + struct trie_node *root; + struct strbuf *strings; + + size_t nodes_count; + size_t children_count; + size_t values_count; +}; + +struct trie_node { + /* prefix, common part for all children of this node */ + size_t prefix_off; + + /* sorted array of pointers to children nodes */ + struct trie_child_entry *children; + uint8_t children_count; + + /* sorted array of key/value pairs */ + struct trie_value_entry *values; + size_t values_count; +}; + +/* children array item with char (0-255) index */ +struct trie_child_entry { + uint8_t c; + struct trie_node *child; +}; + +/* value array item with key/value pairs */ +struct trie_value_entry { + size_t key_off; + size_t value_off; +}; + +static int trie_children_cmp(const void *v1, const void *v2) { + const struct trie_child_entry *n1 = v1; + const struct trie_child_entry *n2 = v2; + + return n1->c - n2->c; +} + +static int node_add_child(struct trie *trie, struct trie_node *node, struct trie_node *node_child, uint8_t c) { + struct trie_child_entry *child; + + /* extend array, add new entry, sort for bisection */ + child = realloc(node->children, (node->children_count + 1) * sizeof(struct trie_child_entry)); + if (!child) + return -ENOMEM; + + node->children = child; + trie->children_count++; + node->children[node->children_count].c = c; + node->children[node->children_count].child = node_child; + node->children_count++; + qsort(node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp); + trie->nodes_count++; + + return 0; +} + +static struct trie_node *node_lookup(const struct trie_node *node, uint8_t c) { + struct trie_child_entry *child; + struct trie_child_entry search; + + search.c = c; + child = bsearch(&search, node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp); + if (child) + return child->child; + return NULL; +} + +static void trie_node_cleanup(struct trie_node *node) { + size_t i; + + for (i = 0; i < node->children_count; i++) + trie_node_cleanup(node->children[i].child); + free(node->children); + free(node->values); + free(node); +} + +static void trie_free(struct trie *trie) { + if (!trie) + return; + + if (trie->root) + trie_node_cleanup(trie->root); + + strbuf_cleanup(trie->strings); + free(trie); +} + +DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie*, trie_free); + +static int trie_values_cmp(const void *v1, const void *v2, void *arg) { + const struct trie_value_entry *val1 = v1; + const struct trie_value_entry *val2 = v2; + struct trie *trie = arg; + + return strcmp(trie->strings->buf + val1->key_off, + trie->strings->buf + val2->key_off); +} + +static int trie_node_add_value(struct trie *trie, struct trie_node *node, + const char *key, const char *value) { + ssize_t k, v; + struct trie_value_entry *val; + + k = strbuf_add_string(trie->strings, key, strlen(key)); + if (k < 0) + return k; + v = strbuf_add_string(trie->strings, value, strlen(value)); + if (v < 0) + return v; + + if (node->values_count) { + struct trie_value_entry search = { + .key_off = k, + .value_off = v, + }; + + val = xbsearch_r(&search, node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie); + if (val) { + /* replace existing earlier key with new value */ + val->value_off = v; + return 0; + } + } + + /* extend array, add new entry, sort for bisection */ + val = realloc(node->values, (node->values_count + 1) * sizeof(struct trie_value_entry)); + if (!val) + return -ENOMEM; + trie->values_count++; + node->values = val; + node->values[node->values_count].key_off = k; + node->values[node->values_count].value_off = v; + node->values_count++; + qsort_r(node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie); + return 0; +} + +static int trie_insert(struct trie *trie, struct trie_node *node, const char *search, + const char *key, const char *value) { + size_t i = 0; + int err = 0; + + for (;;) { + size_t p; + uint8_t c; + struct trie_node *child; + + for (p = 0; (c = trie->strings->buf[node->prefix_off + p]); p++) { + _cleanup_free_ char *s = NULL; + ssize_t off; + _cleanup_free_ struct trie_node *new_child = NULL; + + if (c == search[i + p]) + continue; + + /* split node */ + new_child = new0(struct trie_node, 1); + if (!new_child) + return -ENOMEM; + + /* move values from parent to child */ + new_child->prefix_off = node->prefix_off + p+1; + new_child->children = node->children; + new_child->children_count = node->children_count; + new_child->values = node->values; + new_child->values_count = node->values_count; + + /* update parent; use strdup() because the source gets realloc()d */ + s = strndup(trie->strings->buf + node->prefix_off, p); + if (!s) + return -ENOMEM; + + off = strbuf_add_string(trie->strings, s, p); + if (off < 0) + return off; + + node->prefix_off = off; + node->children = NULL; + node->children_count = 0; + node->values = NULL; + node->values_count = 0; + err = node_add_child(trie, node, new_child, c); + if (err < 0) + return err; + + new_child = NULL; /* avoid cleanup */ + break; + } + i += p; + + c = search[i]; + if (c == '\0') + return trie_node_add_value(trie, node, key, value); + + child = node_lookup(node, c); + if (!child) { + ssize_t off; + + /* new child */ + child = new0(struct trie_node, 1); + if (!child) + return -ENOMEM; + + off = strbuf_add_string(trie->strings, search + i+1, strlen(search + i+1)); + if (off < 0) { + free(child); + return off; + } + + child->prefix_off = off; + err = node_add_child(trie, node, child, c); + if (err < 0) { + free(child); + return err; + } + + return trie_node_add_value(trie, child, key, value); + } + + node = child; + i++; + } +} + +struct trie_f { + FILE *f; + struct trie *trie; + uint64_t strings_off; + + uint64_t nodes_count; + uint64_t children_count; + uint64_t values_count; +}; + +/* calculate the storage space for the nodes, children arrays, value arrays */ +static void trie_store_nodes_size(struct trie_f *trie, struct trie_node *node) { + uint64_t i; + + for (i = 0; i < node->children_count; i++) + trie_store_nodes_size(trie, node->children[i].child); + + trie->strings_off += sizeof(struct trie_node_f); + for (i = 0; i < node->children_count; i++) + trie->strings_off += sizeof(struct trie_child_entry_f); + for (i = 0; i < node->values_count; i++) + trie->strings_off += sizeof(struct trie_value_entry_f); +} + +static int64_t trie_store_nodes(struct trie_f *trie, struct trie_node *node) { + uint64_t i; + struct trie_node_f n = { + .prefix_off = htole64(trie->strings_off + node->prefix_off), + .children_count = node->children_count, + .values_count = htole64(node->values_count), + }; + struct trie_child_entry_f *children = NULL; + int64_t node_off; + + if (node->children_count) { + children = new0(struct trie_child_entry_f, node->children_count); + if (!children) + return -ENOMEM; + } + + /* post-order recursion */ + for (i = 0; i < node->children_count; i++) { + int64_t child_off; + + child_off = trie_store_nodes(trie, node->children[i].child); + if (child_off < 0) { + free(children); + return child_off; + } + children[i].c = node->children[i].c; + children[i].child_off = htole64(child_off); + } + + /* write node */ + node_off = ftello(trie->f); + fwrite(&n, sizeof(struct trie_node_f), 1, trie->f); + trie->nodes_count++; + + /* append children array */ + if (node->children_count) { + fwrite(children, sizeof(struct trie_child_entry_f), node->children_count, trie->f); + trie->children_count += node->children_count; + free(children); + } + + /* append values array */ + for (i = 0; i < node->values_count; i++) { + struct trie_value_entry_f v = { + .key_off = htole64(trie->strings_off + node->values[i].key_off), + .value_off = htole64(trie->strings_off + node->values[i].value_off), + }; + + fwrite(&v, sizeof(struct trie_value_entry_f), 1, trie->f); + trie->values_count++; + } + + return node_off; +} + +static int trie_store(struct trie *trie, const char *filename) { + struct trie_f t = { + .trie = trie, + }; + _cleanup_free_ char *filename_tmp = NULL; + int64_t pos; + int64_t root_off; + int64_t size; + struct trie_header_f h = { + .signature = HWDB_SIG, + .tool_version = htole64(atoi(VERSION)), + .header_size = htole64(sizeof(struct trie_header_f)), + .node_size = htole64(sizeof(struct trie_node_f)), + .child_entry_size = htole64(sizeof(struct trie_child_entry_f)), + .value_entry_size = htole64(sizeof(struct trie_value_entry_f)), + }; + int err; + + /* calculate size of header, nodes, children entries, value entries */ + t.strings_off = sizeof(struct trie_header_f); + trie_store_nodes_size(&t, trie->root); + + err = fopen_temporary(filename , &t.f, &filename_tmp); + if (err < 0) + return err; + fchmod(fileno(t.f), 0444); + + /* write nodes */ + err = fseeko(t.f, sizeof(struct trie_header_f), SEEK_SET); + if (err < 0) { + fclose(t.f); + unlink_noerrno(filename_tmp); + return -errno; + } + root_off = trie_store_nodes(&t, trie->root); + h.nodes_root_off = htole64(root_off); + pos = ftello(t.f); + h.nodes_len = htole64(pos - sizeof(struct trie_header_f)); + + /* write string buffer */ + fwrite(trie->strings->buf, trie->strings->len, 1, t.f); + h.strings_len = htole64(trie->strings->len); + + /* write header */ + size = ftello(t.f); + h.file_size = htole64(size); + err = fseeko(t.f, 0, SEEK_SET); + if (err < 0) { + fclose(t.f); + unlink_noerrno(filename_tmp); + return -errno; + } + fwrite(&h, sizeof(struct trie_header_f), 1, t.f); + err = ferror(t.f); + if (err) + err = -errno; + fclose(t.f); + if (err < 0 || rename(filename_tmp, filename) < 0) { + unlink_noerrno(filename_tmp); + return err < 0 ? err : -errno; + } + + log_debug("=== trie on-disk ==="); + log_debug("size: %8"PRIu64" bytes", size); + log_debug("header: %8zu bytes", sizeof(struct trie_header_f)); + log_debug("nodes: %8"PRIu64" bytes (%8"PRIu64")", + t.nodes_count * sizeof(struct trie_node_f), t.nodes_count); + log_debug("child pointers: %8"PRIu64" bytes (%8"PRIu64")", + t.children_count * sizeof(struct trie_child_entry_f), t.children_count); + log_debug("value pointers: %8"PRIu64" bytes (%8"PRIu64")", + t.values_count * sizeof(struct trie_value_entry_f), t.values_count); + log_debug("string store: %8zu bytes", trie->strings->len); + log_debug("strings start: %8"PRIu64, t.strings_off); + + return 0; +} + +static int insert_data(struct trie *trie, char **match_list, char *line, const char *filename) { + char *value, **entry; + + value = strchr(line, '='); + if (!value) { + log_error("Error, key/value pair expected but got '%s' in '%s':", line, filename); + return -EINVAL; + } + + value[0] = '\0'; + value++; + + /* libudev requires properties to start with a space */ + while (isblank(line[0]) && isblank(line[1])) + line++; + + if (line[0] == '\0' || value[0] == '\0') { + log_error("Error, empty key or value '%s' in '%s':", line, filename); + return -EINVAL; + } + + STRV_FOREACH(entry, match_list) + trie_insert(trie, trie->root, *entry, line, value); + + return 0; +} + +static int import_file(struct trie *trie, const char *filename) { + enum { + HW_NONE, + HW_MATCH, + HW_DATA, + } state = HW_NONE; + _cleanup_fclose_ FILE *f = NULL; + char line[LINE_MAX]; + _cleanup_strv_free_ char **match_list = NULL; + char *match = NULL; + int r; + + f = fopen(filename, "re"); + if (!f) + return -errno; + + while (fgets(line, sizeof(line), f)) { + size_t len; + char *pos; + + /* comment line */ + if (line[0] == '#') + continue; + + /* strip trailing comment */ + pos = strchr(line, '#'); + if (pos) + pos[0] = '\0'; + + /* strip trailing whitespace */ + len = strlen(line); + while (len > 0 && isspace(line[len-1])) + len--; + line[len] = '\0'; + + switch (state) { + case HW_NONE: + if (len == 0) + break; + + if (line[0] == ' ') { + log_error("Error, MATCH expected but got '%s' in '%s':", line, filename); + break; + } + + /* start of record, first match */ + state = HW_MATCH; + + match = strdup(line); + if (!match) + return -ENOMEM; + + r = strv_consume(&match_list, match); + if (r < 0) + return r; + + break; + + case HW_MATCH: + if (len == 0) { + log_error("Error, DATA expected but got empty line in '%s':", filename); + state = HW_NONE; + strv_clear(match_list); + break; + } + + /* another match */ + if (line[0] != ' ') { + match = strdup(line); + if (!match) + return -ENOMEM; + + r = strv_consume(&match_list, match); + if (r < 0) + return r; + + break; + } + + /* first data */ + state = HW_DATA; + insert_data(trie, match_list, line, filename); + break; + + case HW_DATA: + /* end of record */ + if (len == 0) { + state = HW_NONE; + strv_clear(match_list); + break; + } + + if (line[0] != ' ') { + log_error("Error, DATA expected but got '%s' in '%s':", line, filename); + state = HW_NONE; + strv_clear(match_list); + break; + } + + insert_data(trie, match_list, line, filename); + break; + }; + } + + return 0; +} + +static int hwdb_query(char **args, unsigned n) { + _cleanup_hwdb_unref_ sd_hwdb *hwdb = NULL; + const char *key, *value; + const char *modalias; + int r; + + assert(args); + assert(n == 2); + + modalias = args[1]; + + r = sd_hwdb_new(&hwdb); + if (r < 0) + return r; + + SD_HWDB_FOREACH_PROPERTY(hwdb, modalias, key, value) + printf("%s=%s\n", key, value); + + return 0; +} + +static int hwdb_update(char **args, unsigned n) { + _cleanup_free_ char *hwdb_bin = NULL; + _cleanup_(trie_freep) struct trie *trie = NULL; + char **files, **f; + int r; + + trie = new0(struct trie, 1); + if (!trie) + return -ENOMEM; + + /* string store */ + trie->strings = strbuf_new(); + if (!trie->strings) + return -ENOMEM; + + /* index */ + trie->root = new0(struct trie_node, 1); + if (!trie->root) + return -ENOMEM; + + trie->nodes_count++; + + r = conf_files_list_strv(&files, ".hwdb", arg_root, conf_file_dirs); + if (r < 0) + return log_error_errno(r, "failed to enumerate hwdb files: %m"); + + STRV_FOREACH(f, files) { + log_debug("reading file '%s'", *f); + import_file(trie, *f); + } + strv_free(files); + + strbuf_complete(trie->strings); + + log_debug("=== trie in-memory ==="); + log_debug("nodes: %8zu bytes (%8zu)", + trie->nodes_count * sizeof(struct trie_node), trie->nodes_count); + log_debug("children arrays: %8zu bytes (%8zu)", + trie->children_count * sizeof(struct trie_child_entry), trie->children_count); + log_debug("values arrays: %8zu bytes (%8zu)", + trie->values_count * sizeof(struct trie_value_entry), trie->values_count); + log_debug("strings: %8zu bytes", + trie->strings->len); + log_debug("strings incoming: %8zu bytes (%8zu)", + trie->strings->in_len, trie->strings->in_count); + log_debug("strings dedup'ed: %8zu bytes (%8zu)", + trie->strings->dedup_len, trie->strings->dedup_count); + + hwdb_bin = strjoin(arg_root, "/", arg_hwdb_bin_dir, "/hwdb.bin", NULL); + if (!hwdb_bin) + return -ENOMEM; + + mkdir_parents(hwdb_bin, 0755); + r = trie_store(trie, hwdb_bin); + if (r < 0) + return log_error_errno(r, "Failure writing database %s: %m", hwdb_bin); + + return 0; +} + +static void help(void) { + printf("Usage: %s OPTIONS COMMAND\n\n" + "Options:\n" + " --usr generate in " UDEVLIBEXECDIR " instead of /etc/udev\n" + " -r,--root=PATH alternative root path in the filesystem\n" + " -h,--help\n\n" + "Commands:\n" + " update update the hwdb database\n" + " query MODALIAS query database and print result\n\n", + program_invocation_short_name); +} + +static int parse_argv(int argc, char *argv[]) { + enum { + ARG_USR = 0x100, + }; + + static const struct option options[] = { + { "usr", no_argument, NULL, ARG_USR }, + { "root", required_argument, NULL, 'r' }, + { "help", no_argument, NULL, 'h' }, + {} + }; + + int c; + + assert(argc >= 0); + assert(argv); + + while ((c = getopt_long(argc, argv, "ut:r:h", options, NULL)) >= 0) { + switch(c) { + case ARG_USR: + arg_hwdb_bin_dir = UDEVLIBEXECDIR; + break; + case 'r': + arg_root = optarg; + break; + case 'h': + help(); + return 0; + case '?': + return -EINVAL; + default: + assert_not_reached("Unknown option"); + } + } + + return 1; +} + +static int hwdb_main(int argc, char *argv[]) { + static const struct { + const char *verb; + const enum { + MORE, + LESS, + EQUAL, + } argc_cmp; + const int argc; + int (*const dispatch)(char **args, unsigned n); + } verbs[] = { + { "update", EQUAL, 1, hwdb_update }, + { "query", EQUAL, 2, hwdb_query }, + }; + + int left; + unsigned i; + + assert(argc >= 0); + assert(argv); + + left = argc - optind; + + if (left <= 0) { + log_error("Missing command."); + help(); + return -EINVAL; + } + + for (i = 0; i < ELEMENTSOF(verbs); i++) + if (streq(argv[optind], verbs[i].verb)) + break; + + if (i >= ELEMENTSOF(verbs)) { + log_error("Unknown command %s.", argv[optind]); + help(); + return -EINVAL; + } + + switch (verbs[i].argc_cmp) { + case EQUAL: + if (left != verbs[i].argc) { + log_error("Invalid number of arguments."); + help(); + return -EINVAL; + } + + break; + + case MORE: + if (left < verbs[i].argc) { + log_error("Too few arguments."); + help(); + return -EINVAL; + } + + break; + case LESS: + if (left > verbs[i].argc) { + log_error("Too many arguments."); + help(); + return -EINVAL; + } + + break; + default: + assert_not_reached("Unknown comparison operator."); + } + + return verbs[i].dispatch(argv + optind, left); +} + +int main (int argc, char *argv[]) { + int r; + + log_parse_environment(); + log_open(); + + r = parse_argv(argc, argv); + if (r <= 0) + goto finish; + + r = hwdb_main(argc, argv); + +finish: + return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS; +} diff --git a/src/udev/udevadm-hwdb.c b/src/udev/udevadm-hwdb.c index eb300fff6a..7a2114a3a1 100644 --- a/src/udev/udevadm-hwdb.c +++ b/src/udev/udevadm-hwdb.c @@ -687,5 +687,4 @@ out: const struct udevadm_cmd udevadm_hwdb = { .name = "hwdb", .cmd = adm_hwdb, - .help = "maintain the hardware database index", }; diff --git a/units/.gitignore b/units/.gitignore index b8d6247b40..e44ccfefbe 100644 --- a/units/.gitignore +++ b/units/.gitignore @@ -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 diff --git a/units/systemd-udev-hwdb-update.service.in b/units/systemd-hwdb-update.service.in similarity index 87% rename from units/systemd-udev-hwdb-update.service.in rename to units/systemd-hwdb-update.service.in index 5b1f75d250..791528e2b2 100644 --- a/units/systemd-udev-hwdb-update.service.in +++ b/units/systemd-hwdb-update.service.in @@ -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