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/>.
27 #include "conf-files.h"
33 #include "hwdb-internal.h"
34 #include "hwdb-util.h"
37 * Generic udev properties, key/value database based on modalias strings.
38 * Uses a Patricia/radix trie to index all matches for efficient lookup.
41 static const char *arg_hwdb_bin_dir = "/etc/udev";
42 static const char *arg_root = "";
44 static const char * const conf_file_dirs[] = {
46 UDEVLIBEXECDIR "/hwdb.d",
50 /* in-memory trie objects */
52 struct trie_node *root;
53 struct strbuf *strings;
56 size_t children_count;
61 /* prefix, common part for all children of this node */
64 /* sorted array of pointers to children nodes */
65 struct trie_child_entry *children;
66 uint8_t children_count;
68 /* sorted array of key/value pairs */
69 struct trie_value_entry *values;
73 /* children array item with char (0-255) index */
74 struct trie_child_entry {
76 struct trie_node *child;
79 /* value array item with key/value pairs */
80 struct trie_value_entry {
85 static int trie_children_cmp(const void *v1, const void *v2) {
86 const struct trie_child_entry *n1 = v1;
87 const struct trie_child_entry *n2 = v2;
92 static int node_add_child(struct trie *trie, struct trie_node *node, struct trie_node *node_child, uint8_t c) {
93 struct trie_child_entry *child;
95 /* extend array, add new entry, sort for bisection */
96 child = realloc(node->children, (node->children_count + 1) * sizeof(struct trie_child_entry));
100 node->children = child;
101 trie->children_count++;
102 node->children[node->children_count].c = c;
103 node->children[node->children_count].child = node_child;
104 node->children_count++;
105 qsort(node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
111 static struct trie_node *node_lookup(const struct trie_node *node, uint8_t c) {
112 struct trie_child_entry *child;
113 struct trie_child_entry search;
116 child = bsearch(&search, node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
122 static void trie_node_cleanup(struct trie_node *node) {
125 for (i = 0; i < node->children_count; i++)
126 trie_node_cleanup(node->children[i].child);
127 free(node->children);
132 static void trie_free(struct trie *trie) {
137 trie_node_cleanup(trie->root);
139 strbuf_cleanup(trie->strings);
143 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie*, trie_free);
145 static int trie_values_cmp(const void *v1, const void *v2, void *arg) {
146 const struct trie_value_entry *val1 = v1;
147 const struct trie_value_entry *val2 = v2;
148 struct trie *trie = arg;
150 return strcmp(trie->strings->buf + val1->key_off,
151 trie->strings->buf + val2->key_off);
154 static int trie_node_add_value(struct trie *trie, struct trie_node *node,
155 const char *key, const char *value) {
157 struct trie_value_entry *val;
159 k = strbuf_add_string(trie->strings, key, strlen(key));
162 v = strbuf_add_string(trie->strings, value, strlen(value));
166 if (node->values_count) {
167 struct trie_value_entry search = {
172 val = xbsearch_r(&search, node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
174 /* replace existing earlier key with new value */
180 /* extend array, add new entry, sort for bisection */
181 val = realloc(node->values, (node->values_count + 1) * sizeof(struct trie_value_entry));
184 trie->values_count++;
186 node->values[node->values_count].key_off = k;
187 node->values[node->values_count].value_off = v;
188 node->values_count++;
189 qsort_r(node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
193 static int trie_insert(struct trie *trie, struct trie_node *node, const char *search,
194 const char *key, const char *value) {
201 struct trie_node *child;
203 for (p = 0; (c = trie->strings->buf[node->prefix_off + p]); p++) {
204 _cleanup_free_ char *s = NULL;
206 _cleanup_free_ struct trie_node *new_child = NULL;
208 if (c == search[i + p])
212 new_child = new0(struct trie_node, 1);
216 /* move values from parent to child */
217 new_child->prefix_off = node->prefix_off + p+1;
218 new_child->children = node->children;
219 new_child->children_count = node->children_count;
220 new_child->values = node->values;
221 new_child->values_count = node->values_count;
223 /* update parent; use strdup() because the source gets realloc()d */
224 s = strndup(trie->strings->buf + node->prefix_off, p);
228 off = strbuf_add_string(trie->strings, s, p);
232 node->prefix_off = off;
233 node->children = NULL;
234 node->children_count = 0;
236 node->values_count = 0;
237 err = node_add_child(trie, node, new_child, c);
241 new_child = NULL; /* avoid cleanup */
248 return trie_node_add_value(trie, node, key, value);
250 child = node_lookup(node, c);
255 child = new0(struct trie_node, 1);
259 off = strbuf_add_string(trie->strings, search + i+1, strlen(search + i+1));
265 child->prefix_off = off;
266 err = node_add_child(trie, node, child, c);
272 return trie_node_add_value(trie, child, key, value);
283 uint64_t strings_off;
285 uint64_t nodes_count;
286 uint64_t children_count;
287 uint64_t values_count;
290 /* calculate the storage space for the nodes, children arrays, value arrays */
291 static void trie_store_nodes_size(struct trie_f *trie, struct trie_node *node) {
294 for (i = 0; i < node->children_count; i++)
295 trie_store_nodes_size(trie, node->children[i].child);
297 trie->strings_off += sizeof(struct trie_node_f);
298 for (i = 0; i < node->children_count; i++)
299 trie->strings_off += sizeof(struct trie_child_entry_f);
300 for (i = 0; i < node->values_count; i++)
301 trie->strings_off += sizeof(struct trie_value_entry_f);
304 static int64_t trie_store_nodes(struct trie_f *trie, struct trie_node *node) {
306 struct trie_node_f n = {
307 .prefix_off = htole64(trie->strings_off + node->prefix_off),
308 .children_count = node->children_count,
309 .values_count = htole64(node->values_count),
311 struct trie_child_entry_f *children = NULL;
314 if (node->children_count) {
315 children = new0(struct trie_child_entry_f, node->children_count);
320 /* post-order recursion */
321 for (i = 0; i < node->children_count; i++) {
324 child_off = trie_store_nodes(trie, node->children[i].child);
329 children[i].c = node->children[i].c;
330 children[i].child_off = htole64(child_off);
334 node_off = ftello(trie->f);
335 fwrite(&n, sizeof(struct trie_node_f), 1, trie->f);
338 /* append children array */
339 if (node->children_count) {
340 fwrite(children, sizeof(struct trie_child_entry_f), node->children_count, trie->f);
341 trie->children_count += node->children_count;
345 /* append values array */
346 for (i = 0; i < node->values_count; i++) {
347 struct trie_value_entry_f v = {
348 .key_off = htole64(trie->strings_off + node->values[i].key_off),
349 .value_off = htole64(trie->strings_off + node->values[i].value_off),
352 fwrite(&v, sizeof(struct trie_value_entry_f), 1, trie->f);
353 trie->values_count++;
359 static int trie_store(struct trie *trie, const char *filename) {
363 _cleanup_free_ char *filename_tmp = NULL;
367 struct trie_header_f h = {
368 .signature = HWDB_SIG,
369 .tool_version = htole64(atoi(VERSION)),
370 .header_size = htole64(sizeof(struct trie_header_f)),
371 .node_size = htole64(sizeof(struct trie_node_f)),
372 .child_entry_size = htole64(sizeof(struct trie_child_entry_f)),
373 .value_entry_size = htole64(sizeof(struct trie_value_entry_f)),
377 /* calculate size of header, nodes, children entries, value entries */
378 t.strings_off = sizeof(struct trie_header_f);
379 trie_store_nodes_size(&t, trie->root);
381 err = fopen_temporary(filename , &t.f, &filename_tmp);
384 fchmod(fileno(t.f), 0444);
387 err = fseeko(t.f, sizeof(struct trie_header_f), SEEK_SET);
390 unlink_noerrno(filename_tmp);
393 root_off = trie_store_nodes(&t, trie->root);
394 h.nodes_root_off = htole64(root_off);
396 h.nodes_len = htole64(pos - sizeof(struct trie_header_f));
398 /* write string buffer */
399 fwrite(trie->strings->buf, trie->strings->len, 1, t.f);
400 h.strings_len = htole64(trie->strings->len);
404 h.file_size = htole64(size);
405 err = fseeko(t.f, 0, SEEK_SET);
408 unlink_noerrno(filename_tmp);
411 fwrite(&h, sizeof(struct trie_header_f), 1, t.f);
416 if (err < 0 || rename(filename_tmp, filename) < 0) {
417 unlink_noerrno(filename_tmp);
418 return err < 0 ? err : -errno;
421 log_debug("=== trie on-disk ===");
422 log_debug("size: %8"PRIi64" bytes", size);
423 log_debug("header: %8zu bytes", sizeof(struct trie_header_f));
424 log_debug("nodes: %8"PRIu64" bytes (%8"PRIu64")",
425 t.nodes_count * sizeof(struct trie_node_f), t.nodes_count);
426 log_debug("child pointers: %8"PRIu64" bytes (%8"PRIu64")",
427 t.children_count * sizeof(struct trie_child_entry_f), t.children_count);
428 log_debug("value pointers: %8"PRIu64" bytes (%8"PRIu64")",
429 t.values_count * sizeof(struct trie_value_entry_f), t.values_count);
430 log_debug("string store: %8zu bytes", trie->strings->len);
431 log_debug("strings start: %8"PRIu64, t.strings_off);
436 static int insert_data(struct trie *trie, char **match_list, char *line, const char *filename) {
437 char *value, **entry;
439 value = strchr(line, '=');
441 log_error("Error, key/value pair expected but got '%s' in '%s':", line, filename);
448 /* libudev requires properties to start with a space */
449 while (isblank(line[0]) && isblank(line[1]))
452 if (line[0] == '\0' || value[0] == '\0') {
453 log_error("Error, empty key or value '%s' in '%s':", line, filename);
457 STRV_FOREACH(entry, match_list)
458 trie_insert(trie, trie->root, *entry, line, value);
463 static int import_file(struct trie *trie, const char *filename) {
469 _cleanup_fclose_ FILE *f = NULL;
471 _cleanup_strv_free_ char **match_list = NULL;
475 f = fopen(filename, "re");
479 while (fgets(line, sizeof(line), f)) {
487 /* strip trailing comment */
488 pos = strchr(line, '#');
492 /* strip trailing whitespace */
494 while (len > 0 && isspace(line[len-1]))
503 if (line[0] == ' ') {
504 log_error("Error, MATCH expected but got '%s' in '%s':", line, filename);
508 /* start of record, first match */
511 match = strdup(line);
515 r = strv_consume(&match_list, match);
523 log_error("Error, DATA expected but got empty line in '%s':", filename);
525 strv_clear(match_list);
530 if (line[0] != ' ') {
531 match = strdup(line);
535 r = strv_consume(&match_list, match);
544 insert_data(trie, match_list, line, filename);
551 strv_clear(match_list);
555 if (line[0] != ' ') {
556 log_error("Error, DATA expected but got '%s' in '%s':", line, filename);
558 strv_clear(match_list);
562 insert_data(trie, match_list, line, filename);
570 static int hwdb_query(int argc, char *argv[], void *userdata) {
571 _cleanup_hwdb_unref_ sd_hwdb *hwdb = NULL;
572 const char *key, *value;
573 const char *modalias;
581 r = sd_hwdb_new(&hwdb);
585 SD_HWDB_FOREACH_PROPERTY(hwdb, modalias, key, value)
586 printf("%s=%s\n", key, value);
591 static int hwdb_update(int argc, char *argv[], void *userdata) {
592 _cleanup_free_ char *hwdb_bin = NULL;
593 _cleanup_(trie_freep) struct trie *trie = NULL;
597 trie = new0(struct trie, 1);
602 trie->strings = strbuf_new();
607 trie->root = new0(struct trie_node, 1);
613 r = conf_files_list_strv(&files, ".hwdb", arg_root, conf_file_dirs);
615 return log_error_errno(r, "failed to enumerate hwdb files: %m");
617 STRV_FOREACH(f, files) {
618 log_debug("reading file '%s'", *f);
619 import_file(trie, *f);
623 strbuf_complete(trie->strings);
625 log_debug("=== trie in-memory ===");
626 log_debug("nodes: %8zu bytes (%8zu)",
627 trie->nodes_count * sizeof(struct trie_node), trie->nodes_count);
628 log_debug("children arrays: %8zu bytes (%8zu)",
629 trie->children_count * sizeof(struct trie_child_entry), trie->children_count);
630 log_debug("values arrays: %8zu bytes (%8zu)",
631 trie->values_count * sizeof(struct trie_value_entry), trie->values_count);
632 log_debug("strings: %8zu bytes",
634 log_debug("strings incoming: %8zu bytes (%8zu)",
635 trie->strings->in_len, trie->strings->in_count);
636 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
637 trie->strings->dedup_len, trie->strings->dedup_count);
639 hwdb_bin = strjoin(arg_root, "/", arg_hwdb_bin_dir, "/hwdb.bin", NULL);
643 mkdir_parents(hwdb_bin, 0755);
644 r = trie_store(trie, hwdb_bin);
646 return log_error_errno(r, "Failure writing database %s: %m", hwdb_bin);
651 static void help(void) {
652 printf("Usage: %s OPTIONS COMMAND\n\n"
653 "Update or query the hardware database.\n\n"
654 " -h --help Show this help\n"
655 " --version Show package version\n"
656 " --usr Generate in " UDEVLIBEXECDIR " instead of /etc/udev\n"
657 " -r --root=PATH Alternative root path in the filesystem\n\n"
659 " update Update the hwdb database\n"
660 " query MODALIAS Query database and print result\n",
661 program_invocation_short_name);
664 static int parse_argv(int argc, char *argv[]) {
670 static const struct option options[] = {
671 { "help", no_argument, NULL, 'h' },
672 { "version", no_argument, NULL, ARG_VERSION },
673 { "usr", no_argument, NULL, ARG_USR },
674 { "root", required_argument, NULL, 'r' },
683 while ((c = getopt_long(argc, argv, "ut:r:h", options, NULL)) >= 0) {
691 puts(PACKAGE_STRING);
692 puts(SYSTEMD_FEATURES);
696 arg_hwdb_bin_dir = UDEVLIBEXECDIR;
707 assert_not_reached("Unknown option");
714 static int hwdb_main(int argc, char *argv[]) {
715 const Verb verbs[] = {
716 { "update", 1, 1, 0, hwdb_update },
717 { "query", 2, 2, 0, hwdb_query },
721 return dispatch_verb(argc, argv, verbs, NULL);
724 int main (int argc, char *argv[]) {
727 log_parse_environment();
730 r = parse_argv(argc, argv);
734 r = hwdb_main(argc, argv);
737 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;