2 This file is part of systemd.
4 Copyright 2012 Kay Sievers <kay@vrfy.org>
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 #include "conf-files.h"
34 #include "hwdb-internal.h"
35 #include "hwdb-util.h"
38 * Generic udev properties, key/value database based on modalias strings.
39 * Uses a Patricia/radix trie to index all matches for efficient lookup.
42 static const char *arg_hwdb_bin_dir = "/etc/udev";
43 static const char *arg_root = "";
45 static const char * const conf_file_dirs[] = {
47 UDEVLIBEXECDIR "/hwdb.d",
51 /* in-memory trie objects */
53 struct trie_node *root;
54 struct strbuf *strings;
57 size_t children_count;
62 /* prefix, common part for all children of this node */
65 /* sorted array of pointers to children nodes */
66 struct trie_child_entry *children;
67 uint8_t children_count;
69 /* sorted array of key/value pairs */
70 struct trie_value_entry *values;
74 /* children array item with char (0-255) index */
75 struct trie_child_entry {
77 struct trie_node *child;
80 /* value array item with key/value pairs */
81 struct trie_value_entry {
86 static int trie_children_cmp(const void *v1, const void *v2) {
87 const struct trie_child_entry *n1 = v1;
88 const struct trie_child_entry *n2 = v2;
93 static int node_add_child(struct trie *trie, struct trie_node *node, struct trie_node *node_child, uint8_t c) {
94 struct trie_child_entry *child;
96 /* extend array, add new entry, sort for bisection */
97 child = realloc(node->children, (node->children_count + 1) * sizeof(struct trie_child_entry));
101 node->children = child;
102 trie->children_count++;
103 node->children[node->children_count].c = c;
104 node->children[node->children_count].child = node_child;
105 node->children_count++;
106 qsort(node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
112 static struct trie_node *node_lookup(const struct trie_node *node, uint8_t c) {
113 struct trie_child_entry *child;
114 struct trie_child_entry search;
117 child = bsearch(&search, node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
123 static void trie_node_cleanup(struct trie_node *node) {
126 for (i = 0; i < node->children_count; i++)
127 trie_node_cleanup(node->children[i].child);
128 free(node->children);
133 static void trie_free(struct trie *trie) {
138 trie_node_cleanup(trie->root);
140 strbuf_cleanup(trie->strings);
144 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie*, trie_free);
146 static int trie_values_cmp(const void *v1, const void *v2, void *arg) {
147 const struct trie_value_entry *val1 = v1;
148 const struct trie_value_entry *val2 = v2;
149 struct trie *trie = arg;
151 return strcmp(trie->strings->buf + val1->key_off,
152 trie->strings->buf + val2->key_off);
155 static int trie_node_add_value(struct trie *trie, struct trie_node *node,
156 const char *key, const char *value) {
158 struct trie_value_entry *val;
160 k = strbuf_add_string(trie->strings, key, strlen(key));
163 v = strbuf_add_string(trie->strings, value, strlen(value));
167 if (node->values_count) {
168 struct trie_value_entry search = {
173 val = xbsearch_r(&search, node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
175 /* replace existing earlier key with new value */
181 /* extend array, add new entry, sort for bisection */
182 val = realloc(node->values, (node->values_count + 1) * sizeof(struct trie_value_entry));
185 trie->values_count++;
187 node->values[node->values_count].key_off = k;
188 node->values[node->values_count].value_off = v;
189 node->values_count++;
190 qsort_r(node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
194 static int trie_insert(struct trie *trie, struct trie_node *node, const char *search,
195 const char *key, const char *value) {
202 struct trie_node *child;
204 for (p = 0; (c = trie->strings->buf[node->prefix_off + p]); p++) {
205 _cleanup_free_ char *s = NULL;
207 _cleanup_free_ struct trie_node *new_child = NULL;
209 if (c == search[i + p])
213 new_child = new0(struct trie_node, 1);
217 /* move values from parent to child */
218 new_child->prefix_off = node->prefix_off + p+1;
219 new_child->children = node->children;
220 new_child->children_count = node->children_count;
221 new_child->values = node->values;
222 new_child->values_count = node->values_count;
224 /* update parent; use strdup() because the source gets realloc()d */
225 s = strndup(trie->strings->buf + node->prefix_off, p);
229 off = strbuf_add_string(trie->strings, s, p);
233 node->prefix_off = off;
234 node->children = NULL;
235 node->children_count = 0;
237 node->values_count = 0;
238 err = node_add_child(trie, node, new_child, c);
242 new_child = NULL; /* avoid cleanup */
249 return trie_node_add_value(trie, node, key, value);
251 child = node_lookup(node, c);
256 child = new0(struct trie_node, 1);
260 off = strbuf_add_string(trie->strings, search + i+1, strlen(search + i+1));
266 child->prefix_off = off;
267 err = node_add_child(trie, node, child, c);
273 return trie_node_add_value(trie, child, key, value);
284 uint64_t strings_off;
286 uint64_t nodes_count;
287 uint64_t children_count;
288 uint64_t values_count;
291 /* calculate the storage space for the nodes, children arrays, value arrays */
292 static void trie_store_nodes_size(struct trie_f *trie, struct trie_node *node) {
295 for (i = 0; i < node->children_count; i++)
296 trie_store_nodes_size(trie, node->children[i].child);
298 trie->strings_off += sizeof(struct trie_node_f);
299 for (i = 0; i < node->children_count; i++)
300 trie->strings_off += sizeof(struct trie_child_entry_f);
301 for (i = 0; i < node->values_count; i++)
302 trie->strings_off += sizeof(struct trie_value_entry_f);
305 static int64_t trie_store_nodes(struct trie_f *trie, struct trie_node *node) {
307 struct trie_node_f n = {
308 .prefix_off = htole64(trie->strings_off + node->prefix_off),
309 .children_count = node->children_count,
310 .values_count = htole64(node->values_count),
312 struct trie_child_entry_f *children = NULL;
315 if (node->children_count) {
316 children = new0(struct trie_child_entry_f, node->children_count);
321 /* post-order recursion */
322 for (i = 0; i < node->children_count; i++) {
325 child_off = trie_store_nodes(trie, node->children[i].child);
330 children[i].c = node->children[i].c;
331 children[i].child_off = htole64(child_off);
335 node_off = ftello(trie->f);
336 fwrite(&n, sizeof(struct trie_node_f), 1, trie->f);
339 /* append children array */
340 if (node->children_count) {
341 fwrite(children, sizeof(struct trie_child_entry_f), node->children_count, trie->f);
342 trie->children_count += node->children_count;
346 /* append values array */
347 for (i = 0; i < node->values_count; i++) {
348 struct trie_value_entry_f v = {
349 .key_off = htole64(trie->strings_off + node->values[i].key_off),
350 .value_off = htole64(trie->strings_off + node->values[i].value_off),
353 fwrite(&v, sizeof(struct trie_value_entry_f), 1, trie->f);
354 trie->values_count++;
360 static int trie_store(struct trie *trie, const char *filename) {
364 _cleanup_free_ char *filename_tmp = NULL;
368 struct trie_header_f h = {
369 .signature = HWDB_SIG,
370 .tool_version = htole64(atoi(VERSION)),
371 .header_size = htole64(sizeof(struct trie_header_f)),
372 .node_size = htole64(sizeof(struct trie_node_f)),
373 .child_entry_size = htole64(sizeof(struct trie_child_entry_f)),
374 .value_entry_size = htole64(sizeof(struct trie_value_entry_f)),
378 /* calculate size of header, nodes, children entries, value entries */
379 t.strings_off = sizeof(struct trie_header_f);
380 trie_store_nodes_size(&t, trie->root);
382 err = fopen_temporary(filename , &t.f, &filename_tmp);
385 fchmod(fileno(t.f), 0444);
388 err = fseeko(t.f, sizeof(struct trie_header_f), SEEK_SET);
391 unlink_noerrno(filename_tmp);
394 root_off = trie_store_nodes(&t, trie->root);
395 h.nodes_root_off = htole64(root_off);
397 h.nodes_len = htole64(pos - sizeof(struct trie_header_f));
399 /* write string buffer */
400 fwrite(trie->strings->buf, trie->strings->len, 1, t.f);
401 h.strings_len = htole64(trie->strings->len);
405 h.file_size = htole64(size);
406 err = fseeko(t.f, 0, SEEK_SET);
409 unlink_noerrno(filename_tmp);
412 fwrite(&h, sizeof(struct trie_header_f), 1, t.f);
417 if (err < 0 || rename(filename_tmp, filename) < 0) {
418 unlink_noerrno(filename_tmp);
419 return err < 0 ? err : -errno;
422 log_debug("=== trie on-disk ===");
423 log_debug("size: %8"PRIu64" bytes", size);
424 log_debug("header: %8zu bytes", sizeof(struct trie_header_f));
425 log_debug("nodes: %8"PRIu64" bytes (%8"PRIu64")",
426 t.nodes_count * sizeof(struct trie_node_f), t.nodes_count);
427 log_debug("child pointers: %8"PRIu64" bytes (%8"PRIu64")",
428 t.children_count * sizeof(struct trie_child_entry_f), t.children_count);
429 log_debug("value pointers: %8"PRIu64" bytes (%8"PRIu64")",
430 t.values_count * sizeof(struct trie_value_entry_f), t.values_count);
431 log_debug("string store: %8zu bytes", trie->strings->len);
432 log_debug("strings start: %8"PRIu64, t.strings_off);
437 static int insert_data(struct trie *trie, char **match_list, char *line, const char *filename) {
438 char *value, **entry;
440 value = strchr(line, '=');
442 log_error("Error, key/value pair expected but got '%s' in '%s':", line, filename);
449 /* libudev requires properties to start with a space */
450 while (isblank(line[0]) && isblank(line[1]))
453 if (line[0] == '\0' || value[0] == '\0') {
454 log_error("Error, empty key or value '%s' in '%s':", line, filename);
458 STRV_FOREACH(entry, match_list)
459 trie_insert(trie, trie->root, *entry, line, value);
464 static int import_file(struct trie *trie, const char *filename) {
470 _cleanup_fclose_ FILE *f = NULL;
472 _cleanup_strv_free_ char **match_list = NULL;
476 f = fopen(filename, "re");
480 while (fgets(line, sizeof(line), f)) {
488 /* strip trailing comment */
489 pos = strchr(line, '#');
493 /* strip trailing whitespace */
495 while (len > 0 && isspace(line[len-1]))
504 if (line[0] == ' ') {
505 log_error("Error, MATCH expected but got '%s' in '%s':", line, filename);
509 /* start of record, first match */
512 match = strdup(line);
516 r = strv_consume(&match_list, match);
524 log_error("Error, DATA expected but got empty line in '%s':", filename);
526 strv_clear(match_list);
531 if (line[0] != ' ') {
532 match = strdup(line);
536 r = strv_consume(&match_list, match);
545 insert_data(trie, match_list, line, filename);
552 strv_clear(match_list);
556 if (line[0] != ' ') {
557 log_error("Error, DATA expected but got '%s' in '%s':", line, filename);
559 strv_clear(match_list);
563 insert_data(trie, match_list, line, filename);
571 static int hwdb_query(int argc, char *argv[], void *userdata) {
572 _cleanup_hwdb_unref_ sd_hwdb *hwdb = NULL;
573 const char *key, *value;
574 const char *modalias;
582 r = sd_hwdb_new(&hwdb);
586 SD_HWDB_FOREACH_PROPERTY(hwdb, modalias, key, value)
587 printf("%s=%s\n", key, value);
592 static int hwdb_update(int argc, char *argv[], void *userdata) {
593 _cleanup_free_ char *hwdb_bin = NULL;
594 _cleanup_(trie_freep) struct trie *trie = NULL;
598 trie = new0(struct trie, 1);
603 trie->strings = strbuf_new();
608 trie->root = new0(struct trie_node, 1);
614 r = conf_files_list_strv(&files, ".hwdb", arg_root, conf_file_dirs);
616 return log_error_errno(r, "failed to enumerate hwdb files: %m");
618 STRV_FOREACH(f, files) {
619 log_debug("reading file '%s'", *f);
620 import_file(trie, *f);
624 strbuf_complete(trie->strings);
626 log_debug("=== trie in-memory ===");
627 log_debug("nodes: %8zu bytes (%8zu)",
628 trie->nodes_count * sizeof(struct trie_node), trie->nodes_count);
629 log_debug("children arrays: %8zu bytes (%8zu)",
630 trie->children_count * sizeof(struct trie_child_entry), trie->children_count);
631 log_debug("values arrays: %8zu bytes (%8zu)",
632 trie->values_count * sizeof(struct trie_value_entry), trie->values_count);
633 log_debug("strings: %8zu bytes",
635 log_debug("strings incoming: %8zu bytes (%8zu)",
636 trie->strings->in_len, trie->strings->in_count);
637 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
638 trie->strings->dedup_len, trie->strings->dedup_count);
640 hwdb_bin = strjoin(arg_root, "/", arg_hwdb_bin_dir, "/hwdb.bin", NULL);
644 mkdir_parents(hwdb_bin, 0755);
645 r = trie_store(trie, hwdb_bin);
647 return log_error_errno(r, "Failure writing database %s: %m", hwdb_bin);
652 static void help(void) {
653 printf("Usage: %s OPTIONS COMMAND\n\n"
655 " --usr generate in " UDEVLIBEXECDIR " instead of /etc/udev\n"
656 " -r,--root=PATH alternative root path in the filesystem\n"
659 " update update the hwdb database\n"
660 " query MODALIAS query database and print result\n\n",
661 program_invocation_short_name);
664 static int parse_argv(int argc, char *argv[]) {
669 static const struct option options[] = {
670 { "usr", no_argument, NULL, ARG_USR },
671 { "root", required_argument, NULL, 'r' },
672 { "help", no_argument, NULL, 'h' },
681 while ((c = getopt_long(argc, argv, "ut:r:h", options, NULL)) >= 0) {
684 arg_hwdb_bin_dir = UDEVLIBEXECDIR;
695 assert_not_reached("Unknown option");
702 static int hwdb_main(int argc, char *argv[]) {
703 const Verb verbs[] = {
704 { "update", 1, 1, 0, hwdb_update },
705 { "query", 2, 2, 0, hwdb_query },
709 return dispatch_verb(argc, argv, verbs, NULL);
712 int main (int argc, char *argv[]) {
715 log_parse_environment();
718 r = parse_argv(argc, argv);
722 r = hwdb_main(argc, argv);
725 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;