From 6a34639e76b8b59233a97533b13836d5a44e8d4a Mon Sep 17 00:00:00 2001 From: Yu Watanabe Date: Tue, 18 Sep 2018 22:57:45 +0900 Subject: hwdb: unify duplicated code and move it to hwdb-util.c Both 'systemd-hwdb update' and 'udevadm hwdb --update' creates hwdb database. The database created by systemd-hwdb containes additional information such that priority, line number, and source filename. The unified function 'hwdb_update()' can take a flag 'compat' which controls the format version of created database. --- src/hwdb/hwdb.c | 661 +------------------------------------------------------- 1 file changed, 11 insertions(+), 650 deletions(-) (limited to 'src/hwdb') diff --git a/src/hwdb/hwdb.c b/src/hwdb/hwdb.c index bdd0ba3c2a..eb1e88fe1c 100644 --- a/src/hwdb/hwdb.c +++ b/src/hwdb/hwdb.c @@ -1,597 +1,22 @@ /* SPDX-License-Identifier: LGPL-2.1+ */ -#include #include -#include -#include + +#include "sd-hwdb.h" #include "alloc-util.h" -#include "conf-files.h" -#include "fd-util.h" -#include "fileio.h" -#include "fs-util.h" -#include "hwdb-internal.h" #include "hwdb-util.h" -#include "label.h" -#include "mkdir.h" -#include "path-util.h" #include "selinux-util.h" -#include "strbuf.h" #include "string-util.h" -#include "strv.h" #include "terminal-util.h" #include "util.h" #include "verbs.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 bool arg_strict; - -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; - size_t filename_off; - uint32_t line_number; - uint16_t file_priority; -}; - -static int trie_children_cmp(const struct trie_child_entry *a, const struct trie_child_entry *b) { - return CMP(a->c, b->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 = reallocarray(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++; - typesafe_qsort(node->children, node->children_count, 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 = typesafe_bsearch(&search, node->children, node->children_count, trie_children_cmp); - if (child) - return child->child; - return NULL; -} - -static void trie_node_cleanup(struct trie_node *node) { - size_t i; - - if (!node) - return; - - 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; - - 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 struct trie_value_entry *a, const struct trie_value_entry *b, struct trie *trie) { - return strcmp(trie->strings->buf + a->key_off, - trie->strings->buf + b->key_off); -} - -static int trie_node_add_value(struct trie *trie, struct trie_node *node, - const char *key, const char *value, - const char *filename, uint16_t file_priority, uint32_t line_number) { - ssize_t k, v, fn; - 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; - fn = strbuf_add_string(trie->strings, filename, strlen(filename)); - if (fn < 0) - return fn; - - if (node->values_count) { - struct trie_value_entry search = { - .key_off = k, - .value_off = v, - }; - - val = typesafe_bsearch_r(&search, node->values, node->values_count, trie_values_cmp, trie); - if (val) { - /* At this point we have 2 identical properties on the same match-string. - * Since we process files in order, we just replace the previous value. - */ - val->value_off = v; - val->filename_off = fn; - val->file_priority = file_priority; - val->line_number = line_number; - return 0; - } - } - - /* extend array, add new entry, sort for bisection */ - val = reallocarray(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[node->values_count].filename_off = fn; - node->values[node->values_count].file_priority = file_priority; - node->values[node->values_count].line_number = line_number; - node->values_count++; - typesafe_qsort_r(node->values, node->values_count, 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, - const char *filename, uint16_t file_priority, uint32_t line_number) { - size_t i = 0; - int r = 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_ struct trie_node *new_child = NULL; - _cleanup_free_ char *s = NULL; - ssize_t off; - - 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; - r = node_add_child(trie, node, new_child, c); - if (r < 0) - return r; - - new_child = NULL; /* avoid cleanup */ - break; - } - i += p; - - c = search[i]; - if (c == '\0') - return trie_node_add_value(trie, node, key, value, filename, file_priority, line_number); - - child = node_lookup(node, c); - if (!child) { - _cleanup_free_ struct trie_node *new_child = NULL; - ssize_t off; - - /* new child */ - new_child = new0(struct trie_node, 1); - if (!new_child) - return -ENOMEM; - - off = strbuf_add_string(trie->strings, search + i+1, strlen(search + i+1)); - if (off < 0) - return off; - - new_child->prefix_off = off; - r = node_add_child(trie, node, new_child, c); - if (r < 0) - return r; - - child = TAKE_PTR(new_child); - return trie_node_add_value(trie, child, key, value, filename, file_priority, line_number); - } - - 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_entry2_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), - }; - _cleanup_free_ struct trie_child_entry_f *children = NULL; - int64_t node_off; - - if (node->children_count) { - children = new(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) - return child_off; - - children[i] = (struct trie_child_entry_f) { - .c = node->children[i].c, - .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; - } - - /* append values array */ - for (i = 0; i < node->values_count; i++) { - struct trie_value_entry2_f v = { - .key_off = htole64(trie->strings_off + node->values[i].key_off), - .value_off = htole64(trie->strings_off + node->values[i].value_off), - .filename_off = htole64(trie->strings_off + node->values[i].filename_off), - .line_number = htole32(node->values[i].line_number), - .file_priority = htole16(node->values[i].file_priority), - }; - - fwrite(&v, sizeof(struct trie_value_entry2_f), 1, trie->f); - } - trie->values_count += node->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(PACKAGE_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_entry2_f)), - }; - int r; - - /* calculate size of header, nodes, children entries, value entries */ - t.strings_off = sizeof(struct trie_header_f); - trie_store_nodes_size(&t, trie->root); - - r = fopen_temporary(filename, &t.f, &filename_tmp); - if (r < 0) - return r; - fchmod(fileno(t.f), 0444); - - /* write nodes */ - if (fseeko(t.f, sizeof(struct trie_header_f), SEEK_SET) < 0) - goto error_fclose; - - 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); - if (fseeko(t.f, 0, SEEK_SET) < 0) - goto error_fclose; - fwrite(&h, sizeof(struct trie_header_f), 1, t.f); - - if (ferror(t.f)) - goto error_fclose; - if (fflush(t.f) < 0) - goto error_fclose; - if (fsync(fileno(t.f)) < 0) - goto error_fclose; - if (rename(filename_tmp, filename) < 0) - goto error_fclose; - - /* write succeeded */ - fclose(t.f); - - log_debug("=== trie on-disk ==="); - log_debug("size: %8"PRIi64" 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_entry2_f), t.values_count); - log_debug("string store: %8zu bytes", trie->strings->len); - log_debug("strings start: %8"PRIu64, t.strings_off); - return 0; - - error_fclose: - r = -errno; - fclose(t.f); - unlink(filename_tmp); - return r; -} - -static int insert_data(struct trie *trie, char **match_list, char *line, - const char *filename, uint16_t file_priority, uint32_t line_number) { - char *value, **entry; - - assert(line[0] == ' '); - - value = strchr(line, '='); - if (!value) - return log_syntax(NULL, LOG_WARNING, filename, line_number, EINVAL, - "Key-value pair expected but got \"%s\", ignoring", line); - - value[0] = '\0'; - value++; - - /* Replace multiple leading spaces by a single space */ - while (isblank(line[0]) && isblank(line[1])) - line++; - - if (isempty(line + 1) || isempty(value)) - return log_syntax(NULL, LOG_WARNING, filename, line_number, EINVAL, - "Empty %s in \"%s=%s\", ignoring", - isempty(line + 1) ? "key" : "value", - line, value); - - STRV_FOREACH(entry, match_list) - trie_insert(trie, trie->root, *entry, line, value, filename, file_priority, line_number); - - return 0; -} - -static int import_file(struct trie *trie, const char *filename, uint16_t file_priority) { - 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; - uint32_t line_number = 0; - char *match = NULL; - int r = 0, err; - - f = fopen(filename, "re"); - if (!f) - return -errno; - - while (fgets(line, sizeof(line), f)) { - size_t len; - char *pos; - - ++line_number; - - /* 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_syntax(NULL, LOG_WARNING, filename, line_number, EINVAL, - "Match expected but got indented property \"%s\", ignoring line", line); - r = -EINVAL; - break; - } - - /* start of record, first match */ - state = HW_MATCH; - - match = strdup(line); - if (!match) - return -ENOMEM; - - err = strv_consume(&match_list, match); - if (err < 0) - return err; - - break; - - case HW_MATCH: - if (len == 0) { - log_syntax(NULL, LOG_WARNING, filename, line_number, EINVAL, - "Property expected, ignoring record with no properties"); - r = -EINVAL; - state = HW_NONE; - strv_clear(match_list); - break; - } - - if (line[0] != ' ') { - /* another match */ - match = strdup(line); - if (!match) - return -ENOMEM; - - err = strv_consume(&match_list, match); - if (err < 0) - return err; - - break; - } - - /* first data */ - state = HW_DATA; - err = insert_data(trie, match_list, line, filename, file_priority, line_number); - if (err < 0) - r = err; - break; - - case HW_DATA: - if (len == 0) { - /* end of record */ - state = HW_NONE; - strv_clear(match_list); - break; - } - - if (line[0] != ' ') { - log_syntax(NULL, LOG_WARNING, filename, line_number, EINVAL, - "Property or empty line expected, got \"%s\", ignoring record", line); - r = -EINVAL; - state = HW_NONE; - strv_clear(match_list); - break; - } - - err = insert_data(trie, match_list, line, filename, file_priority, line_number); - if (err < 0) - r = err; - break; - }; - } - - if (state == HW_MATCH) - log_syntax(NULL, LOG_WARNING, filename, line_number, EINVAL, - "Property expected, ignoring record with no properties"); - - return r; -} +static const char *arg_hwdb_bin_dir = NULL; +static const char *arg_root = NULL; +static bool arg_strict = false; -static int hwdb_query(int argc, char *argv[], void *userdata) { +static int verb_query(int argc, char *argv[], void *userdata) { _cleanup_(sd_hwdb_unrefp) sd_hwdb *hwdb = NULL; const char *key, *value; const char *modalias; @@ -612,71 +37,8 @@ static int hwdb_query(int argc, char *argv[], void *userdata) { return 0; } -static int hwdb_update(int argc, char *argv[], void *userdata) { - _cleanup_free_ char *hwdb_bin = NULL; - _cleanup_(trie_freep) struct trie *trie = NULL; - _cleanup_strv_free_ char **files = NULL; - char **f; - uint16_t file_priority = 1; - int r = 0, err; - - 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++; - - err = conf_files_list_strv(&files, ".hwdb", arg_root, 0, conf_file_dirs); - if (err < 0) - return log_error_errno(err, "Failed to enumerate hwdb files: %m"); - - STRV_FOREACH(f, files) { - log_debug("Reading file \"%s\"", *f); - err = import_file(trie, *f, file_priority++); - if (err < 0 && arg_strict) - r = err; - } - - 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 = path_join(arg_root, arg_hwdb_bin_dir, "hwdb.bin"); - if (!hwdb_bin) - return -ENOMEM; - - mkdir_parents_label(hwdb_bin, 0755); - err = trie_store(trie, hwdb_bin); - if (err < 0) - return log_error_errno(err, "Failure writing database %s: %m", hwdb_bin); - - err = label_fix(hwdb_bin, 0); - if (err < 0) - return err; - - return r; +static int verb_update(int argc, char *argv[], void *userdata) { + return hwdb_update(arg_root, arg_hwdb_bin_dir, arg_strict, false); } static int help(void) { @@ -725,7 +87,7 @@ static int parse_argv(int argc, char *argv[]) { assert(argc >= 0); assert(argv); - while ((c = getopt_long(argc, argv, "ust:r:h", options, NULL)) >= 0) { + while ((c = getopt_long(argc, argv, "ust:r:h", options, NULL)) >= 0) switch(c) { case 'h': @@ -752,15 +114,14 @@ static int parse_argv(int argc, char *argv[]) { default: assert_not_reached("Unknown option"); } - } return 1; } static int hwdb_main(int argc, char *argv[]) { static const Verb verbs[] = { - { "update", 1, 1, 0, hwdb_update }, - { "query", 2, 2, 0, hwdb_query }, + { "update", 1, 1, 0, verb_update }, + { "query", 2, 2, 0, verb_query }, {}, }; -- cgit v1.2.1