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"
31 #include "libudev-hwdb-def.h"
34 * Generic udev properties, key/value database based on modalias strings.
35 * Uses a Patricia/radix trie to index all matches for efficient lookup.
38 static const char * const conf_file_dirs[] = {
40 UDEVLIBEXECDIR "/hwdb.d",
44 /* in-memory trie objects */
46 struct trie_node *root;
47 struct strbuf *strings;
50 size_t children_count;
55 /* prefix, common part for all children of this node */
58 /* sorted array of pointers to children nodes */
59 struct trie_child_entry *children;
60 uint8_t children_count;
62 /* sorted array of key/value pairs */
63 struct trie_value_entry *values;
67 /* children array item with char (0-255) index */
68 struct trie_child_entry {
70 struct trie_node *child;
73 /* value array item with key/value pairs */
74 struct trie_value_entry {
79 static int trie_children_cmp(const void *v1, const void *v2) {
80 const struct trie_child_entry *n1 = v1;
81 const struct trie_child_entry *n2 = v2;
86 static int node_add_child(struct trie *trie, struct trie_node *node, struct trie_node *node_child, uint8_t c) {
87 struct trie_child_entry *child;
89 /* extend array, add new entry, sort for bisection */
90 child = realloc(node->children, (node->children_count + 1) * sizeof(struct trie_child_entry));
94 node->children = child;
95 trie->children_count++;
96 node->children[node->children_count].c = c;
97 node->children[node->children_count].child = node_child;
98 node->children_count++;
99 qsort(node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
105 static struct trie_node *node_lookup(const struct trie_node *node, uint8_t c) {
106 struct trie_child_entry *child;
107 struct trie_child_entry search;
110 child = bsearch(&search, node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
116 static void trie_node_cleanup(struct trie_node *node) {
119 for (i = 0; i < node->children_count; i++)
120 trie_node_cleanup(node->children[i].child);
121 free(node->children);
126 static int trie_values_cmp(const void *v1, const void *v2, void *arg) {
127 const struct trie_value_entry *val1 = v1;
128 const struct trie_value_entry *val2 = v2;
129 struct trie *trie = arg;
131 return strcmp(trie->strings->buf + val1->key_off,
132 trie->strings->buf + val2->key_off);
135 static int trie_node_add_value(struct trie *trie, struct trie_node *node,
136 const char *key, const char *value) {
138 struct trie_value_entry *val;
140 k = strbuf_add_string(trie->strings, key, strlen(key));
143 v = strbuf_add_string(trie->strings, value, strlen(value));
147 if (node->values_count) {
148 struct trie_value_entry search = {
153 val = xbsearch_r(&search, node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
155 /* replace existing earlier key with new value */
161 /* extend array, add new entry, sort for bisection */
162 val = realloc(node->values, (node->values_count + 1) * sizeof(struct trie_value_entry));
165 trie->values_count++;
167 node->values[node->values_count].key_off = k;
168 node->values[node->values_count].value_off = v;
169 node->values_count++;
170 qsort_r(node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
174 static int trie_insert(struct trie *trie, struct trie_node *node, const char *search,
175 const char *key, const char *value) {
182 struct trie_node *child;
184 for (p = 0; (c = trie->strings->buf[node->prefix_off + p]); p++) {
185 _cleanup_free_ char *s = NULL;
187 _cleanup_free_ struct trie_node *new_child = NULL;
189 if (c == search[i + p])
193 new_child = calloc(sizeof(struct trie_node), 1);
197 /* move values from parent to child */
198 new_child->prefix_off = node->prefix_off + p+1;
199 new_child->children = node->children;
200 new_child->children_count = node->children_count;
201 new_child->values = node->values;
202 new_child->values_count = node->values_count;
204 /* update parent; use strdup() because the source gets realloc()d */
205 s = strndup(trie->strings->buf + node->prefix_off, p);
209 off = strbuf_add_string(trie->strings, s, p);
213 node->prefix_off = off;
214 node->children = NULL;
215 node->children_count = 0;
217 node->values_count = 0;
218 err = node_add_child(trie, node, new_child, c);
222 new_child = NULL; /* avoid cleanup */
229 return trie_node_add_value(trie, node, key, value);
231 child = node_lookup(node, c);
236 child = calloc(sizeof(struct trie_node), 1);
240 off = strbuf_add_string(trie->strings, search + i+1, strlen(search + i+1));
246 child->prefix_off = off;
247 err = node_add_child(trie, node, child, c);
253 return trie_node_add_value(trie, child, key, value);
264 uint64_t strings_off;
266 uint64_t nodes_count;
267 uint64_t children_count;
268 uint64_t values_count;
271 /* calculate the storage space for the nodes, children arrays, value arrays */
272 static void trie_store_nodes_size(struct trie_f *trie, struct trie_node *node) {
275 for (i = 0; i < node->children_count; i++)
276 trie_store_nodes_size(trie, node->children[i].child);
278 trie->strings_off += sizeof(struct trie_node_f);
279 for (i = 0; i < node->children_count; i++)
280 trie->strings_off += sizeof(struct trie_child_entry_f);
281 for (i = 0; i < node->values_count; i++)
282 trie->strings_off += sizeof(struct trie_value_entry_f);
285 static int64_t trie_store_nodes(struct trie_f *trie, struct trie_node *node) {
287 struct trie_node_f n = {
288 .prefix_off = htole64(trie->strings_off + node->prefix_off),
289 .children_count = node->children_count,
290 .values_count = htole64(node->values_count),
292 struct trie_child_entry_f *children = NULL;
295 if (node->children_count) {
296 children = new0(struct trie_child_entry_f, node->children_count);
301 /* post-order recursion */
302 for (i = 0; i < node->children_count; i++) {
305 child_off = trie_store_nodes(trie, node->children[i].child);
308 children[i].c = node->children[i].c;
309 children[i].child_off = htole64(child_off);
313 node_off = ftello(trie->f);
314 fwrite(&n, sizeof(struct trie_node_f), 1, trie->f);
317 /* append children array */
318 if (node->children_count) {
319 fwrite(children, sizeof(struct trie_child_entry_f), node->children_count, trie->f);
320 trie->children_count += node->children_count;
324 /* append values array */
325 for (i = 0; i < node->values_count; i++) {
326 struct trie_value_entry_f v = {
327 .key_off = htole64(trie->strings_off + node->values[i].key_off),
328 .value_off = htole64(trie->strings_off + node->values[i].value_off),
331 fwrite(&v, sizeof(struct trie_value_entry_f), 1, trie->f);
332 trie->values_count++;
338 static int trie_store(struct trie *trie, const char *filename) {
346 struct trie_header_f h = {
347 .signature = HWDB_SIG,
348 .tool_version = htole64(atoi(VERSION)),
349 .header_size = htole64(sizeof(struct trie_header_f)),
350 .node_size = htole64(sizeof(struct trie_node_f)),
351 .child_entry_size = htole64(sizeof(struct trie_child_entry_f)),
352 .value_entry_size = htole64(sizeof(struct trie_value_entry_f)),
356 /* calculate size of header, nodes, children entries, value entries */
357 t.strings_off = sizeof(struct trie_header_f);
358 trie_store_nodes_size(&t, trie->root);
360 err = fopen_temporary(filename , &t.f, &filename_tmp);
363 fchmod(fileno(t.f), 0444);
366 fseeko(t.f, sizeof(struct trie_header_f), SEEK_SET);
367 root_off = trie_store_nodes(&t, trie->root);
368 h.nodes_root_off = htole64(root_off);
370 h.nodes_len = htole64(pos - sizeof(struct trie_header_f));
372 /* write string buffer */
373 fwrite(trie->strings->buf, trie->strings->len, 1, t.f);
374 h.strings_len = htole64(trie->strings->len);
378 h.file_size = htole64(size);
379 fseeko(t.f, 0, SEEK_SET);
380 fwrite(&h, sizeof(struct trie_header_f), 1, t.f);
385 if (err < 0 || rename(filename_tmp, filename) < 0) {
386 unlink(filename_tmp);
390 log_debug("=== trie on-disk ===\n");
391 log_debug("size: %8llu bytes\n", (unsigned long long)size);
392 log_debug("header: %8zu bytes\n", sizeof(struct trie_header_f));
393 log_debug("nodes: %8llu bytes (%8llu)\n",
394 (unsigned long long)t.nodes_count * sizeof(struct trie_node_f), (unsigned long long)t.nodes_count);
395 log_debug("child pointers: %8llu bytes (%8llu)\n",
396 (unsigned long long)t.children_count * sizeof(struct trie_child_entry_f), (unsigned long long)t.children_count);
397 log_debug("value pointers: %8llu bytes (%8llu)\n",
398 (unsigned long long)t.values_count * sizeof(struct trie_value_entry_f), (unsigned long long)t.values_count);
399 log_debug("string store: %8llu bytes\n", (unsigned long long)trie->strings->len);
400 log_debug("strings start: %8llu\n", (unsigned long long) t.strings_off);
406 static int insert_data(struct trie *trie, struct udev_list *match_list,
407 char *line, const char *filename) {
409 struct udev_list_entry *entry;
411 value = strchr(line, '=');
413 log_error("Error, key/value pair expected but got '%s' in '%s':\n", line, filename);
420 if (line[0] == '\0' || value[0] == '\0') {
421 log_error("Error, empty key or value '%s' in '%s':\n", line, filename);
425 udev_list_entry_foreach(entry, udev_list_get_entry(match_list))
426 trie_insert(trie, trie->root, udev_list_entry_get_name(entry), line, value);
431 static int import_file(struct udev *udev, struct trie *trie, const char *filename) {
439 struct udev_list match_list;
441 udev_list_init(udev, &match_list, false);
443 f = fopen(filename, "re");
447 while (fgets(line, sizeof(line), f)) {
455 /* strip trailing comment */
456 pos = strchr(line, '#');
460 /* strip trailing whitespace */
462 while (len > 0 && isspace(line[len-1]))
471 if (line[0] == ' ') {
472 log_error("Error, MATCH expected but got '%s' in '%s':\n", line, filename);
476 /* start of record, first match */
478 udev_list_entry_add(&match_list, line, NULL);
483 log_error("Error, DATA expected but got empty line in '%s':\n", filename);
485 udev_list_cleanup(&match_list);
490 if (line[0] != ' ') {
491 udev_list_entry_add(&match_list, line, NULL);
497 insert_data(trie, &match_list, line, filename);
504 udev_list_cleanup(&match_list);
508 if (line[0] != ' ') {
509 log_error("Error, DATA expected but got '%s' in '%s':\n", line, filename);
511 udev_list_cleanup(&match_list);
515 insert_data(trie, &match_list, line, filename);
521 udev_list_cleanup(&match_list);
525 static void help(void) {
526 printf("Usage: udevadm hwdb OPTIONS\n"
527 " --update update the hardware database\n"
528 " --test=<modalias> query database and print result\n"
529 " --root=<path> alternative root path in the filesystem\n"
533 static int adm_hwdb(struct udev *udev, int argc, char *argv[]) {
534 static const struct option options[] = {
535 { "update", no_argument, NULL, 'u' },
536 { "root", required_argument, NULL, 'r' },
537 { "test", required_argument, NULL, 't' },
538 { "help", no_argument, NULL, 'h' },
541 const char *test = NULL;
542 const char *root = "";
544 struct trie *trie = NULL;
546 int rc = EXIT_SUCCESS;
551 option = getopt_long(argc, argv, "ut:r:h", options, NULL);
571 if (!update && !test) {
578 _cleanup_free_ char *hwdb_bin = NULL;
580 trie = calloc(sizeof(struct trie), 1);
587 trie->strings = strbuf_new();
588 if (!trie->strings) {
594 trie->root = calloc(sizeof(struct trie_node), 1);
601 err = conf_files_list_strv(&files, ".hwdb", root, conf_file_dirs);
603 log_error("failed to enumerate hwdb files: %s\n", strerror(-err));
607 STRV_FOREACH(f, files) {
608 log_debug("reading file '%s'", *f);
609 import_file(udev, trie, *f);
613 strbuf_complete(trie->strings);
615 log_debug("=== trie in-memory ===\n");
616 log_debug("nodes: %8zu bytes (%8zu)\n",
617 trie->nodes_count * sizeof(struct trie_node), trie->nodes_count);
618 log_debug("children arrays: %8zu bytes (%8zu)\n",
619 trie->children_count * sizeof(struct trie_child_entry), trie->children_count);
620 log_debug("values arrays: %8zu bytes (%8zu)\n",
621 trie->values_count * sizeof(struct trie_value_entry), trie->values_count);
622 log_debug("strings: %8zu bytes\n",
624 log_debug("strings incoming: %8zu bytes (%8zu)\n",
625 trie->strings->in_len, trie->strings->in_count);
626 log_debug("strings dedup'ed: %8zu bytes (%8zu)\n",
627 trie->strings->dedup_len, trie->strings->dedup_count);
629 if (asprintf(&hwdb_bin, "%s/etc/udev/hwdb.bin", root) < 0) {
633 mkdir_parents(hwdb_bin, 0755);
634 err = trie_store(trie, hwdb_bin);
636 log_error("Failure writing database %s: %s", hwdb_bin, strerror(-err));
642 struct udev_hwdb *hwdb = udev_hwdb_new(udev);
645 struct udev_list_entry *entry;
647 udev_list_entry_foreach(entry, udev_hwdb_get_properties_list_entry(hwdb, test, 0))
648 printf("%s=%s\n", udev_list_entry_get_name(entry), udev_list_entry_get_value(entry));
649 hwdb = udev_hwdb_unref(hwdb);
655 trie_node_cleanup(trie->root);
656 strbuf_cleanup(trie->strings);
662 const struct udevadm_cmd udevadm_hwdb = {
665 .help = "maintain the hardware database index",