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 "hwdb-internal.h"
32 #include "hwdb-util.h"
35 * Generic udev properties, key/value database based on modalias strings.
36 * Uses a Patricia/radix trie to index all matches for efficient lookup.
39 static const char * const conf_file_dirs
[] = {
41 UDEVLIBEXECDIR
"/hwdb.d",
45 /* in-memory trie objects */
47 struct trie_node
*root
;
48 struct strbuf
*strings
;
51 size_t children_count
;
56 /* prefix, common part for all children of this node */
59 /* sorted array of pointers to children nodes */
60 struct trie_child_entry
*children
;
61 uint8_t children_count
;
63 /* sorted array of key/value pairs */
64 struct trie_value_entry
*values
;
68 /* children array item with char (0-255) index */
69 struct trie_child_entry
{
71 struct trie_node
*child
;
74 /* value array item with key/value pairs */
75 struct trie_value_entry
{
80 static int trie_children_cmp(const void *v1
, const void *v2
) {
81 const struct trie_child_entry
*n1
= v1
;
82 const struct trie_child_entry
*n2
= v2
;
87 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
88 struct trie_child_entry
*child
;
90 /* extend array, add new entry, sort for bisection */
91 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
95 node
->children
= child
;
96 trie
->children_count
++;
97 node
->children
[node
->children_count
].c
= c
;
98 node
->children
[node
->children_count
].child
= node_child
;
99 node
->children_count
++;
100 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
106 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
107 struct trie_child_entry
*child
;
108 struct trie_child_entry search
;
111 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
117 static void trie_node_cleanup(struct trie_node
*node
) {
120 for (i
= 0; i
< node
->children_count
; i
++)
121 trie_node_cleanup(node
->children
[i
].child
);
122 free(node
->children
);
127 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
128 const struct trie_value_entry
*val1
= v1
;
129 const struct trie_value_entry
*val2
= v2
;
130 struct trie
*trie
= arg
;
132 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
133 trie
->strings
->buf
+ val2
->key_off
);
136 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
137 const char *key
, const char *value
) {
139 struct trie_value_entry
*val
;
141 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
144 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
148 if (node
->values_count
) {
149 struct trie_value_entry search
= {
154 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
156 /* replace existing earlier key with new value */
162 /* extend array, add new entry, sort for bisection */
163 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
166 trie
->values_count
++;
168 node
->values
[node
->values_count
].key_off
= k
;
169 node
->values
[node
->values_count
].value_off
= v
;
170 node
->values_count
++;
171 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
175 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
176 const char *key
, const char *value
) {
183 struct trie_node
*child
;
185 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
186 _cleanup_free_
char *s
= NULL
;
188 _cleanup_free_
struct trie_node
*new_child
= NULL
;
190 if (c
== search
[i
+ p
])
194 new_child
= new0(struct trie_node
, 1);
198 /* move values from parent to child */
199 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
200 new_child
->children
= node
->children
;
201 new_child
->children_count
= node
->children_count
;
202 new_child
->values
= node
->values
;
203 new_child
->values_count
= node
->values_count
;
205 /* update parent; use strdup() because the source gets realloc()d */
206 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
210 off
= strbuf_add_string(trie
->strings
, s
, p
);
214 node
->prefix_off
= off
;
215 node
->children
= NULL
;
216 node
->children_count
= 0;
218 node
->values_count
= 0;
219 err
= node_add_child(trie
, node
, new_child
, c
);
223 new_child
= NULL
; /* avoid cleanup */
230 return trie_node_add_value(trie
, node
, key
, value
);
232 child
= node_lookup(node
, c
);
237 child
= new0(struct trie_node
, 1);
241 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
247 child
->prefix_off
= off
;
248 err
= node_add_child(trie
, node
, child
, c
);
254 return trie_node_add_value(trie
, child
, key
, value
);
265 uint64_t strings_off
;
267 uint64_t nodes_count
;
268 uint64_t children_count
;
269 uint64_t values_count
;
272 /* calculate the storage space for the nodes, children arrays, value arrays */
273 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
276 for (i
= 0; i
< node
->children_count
; i
++)
277 trie_store_nodes_size(trie
, node
->children
[i
].child
);
279 trie
->strings_off
+= sizeof(struct trie_node_f
);
280 for (i
= 0; i
< node
->children_count
; i
++)
281 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
282 for (i
= 0; i
< node
->values_count
; i
++)
283 trie
->strings_off
+= sizeof(struct trie_value_entry_f
);
286 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
288 struct trie_node_f n
= {
289 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
290 .children_count
= node
->children_count
,
291 .values_count
= htole64(node
->values_count
),
293 struct trie_child_entry_f
*children
= NULL
;
296 if (node
->children_count
) {
297 children
= new0(struct trie_child_entry_f
, node
->children_count
);
302 /* post-order recursion */
303 for (i
= 0; i
< node
->children_count
; i
++) {
306 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
311 children
[i
].c
= node
->children
[i
].c
;
312 children
[i
].child_off
= htole64(child_off
);
316 node_off
= ftello(trie
->f
);
317 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
320 /* append children array */
321 if (node
->children_count
) {
322 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
323 trie
->children_count
+= node
->children_count
;
327 /* append values array */
328 for (i
= 0; i
< node
->values_count
; i
++) {
329 struct trie_value_entry_f v
= {
330 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
331 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
334 fwrite(&v
, sizeof(struct trie_value_entry_f
), 1, trie
->f
);
335 trie
->values_count
++;
341 static int trie_store(struct trie
*trie
, const char *filename
) {
345 _cleanup_free_
char *filename_tmp
= NULL
;
349 struct trie_header_f h
= {
350 .signature
= HWDB_SIG
,
351 .tool_version
= htole64(atoi(VERSION
)),
352 .header_size
= htole64(sizeof(struct trie_header_f
)),
353 .node_size
= htole64(sizeof(struct trie_node_f
)),
354 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
355 .value_entry_size
= htole64(sizeof(struct trie_value_entry_f
)),
359 /* calculate size of header, nodes, children entries, value entries */
360 t
.strings_off
= sizeof(struct trie_header_f
);
361 trie_store_nodes_size(&t
, trie
->root
);
363 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
366 fchmod(fileno(t
.f
), 0444);
369 err
= fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
);
372 unlink_noerrno(filename_tmp
);
375 root_off
= trie_store_nodes(&t
, trie
->root
);
376 h
.nodes_root_off
= htole64(root_off
);
378 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
380 /* write string buffer */
381 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
382 h
.strings_len
= htole64(trie
->strings
->len
);
386 h
.file_size
= htole64(size
);
387 err
= fseeko(t
.f
, 0, SEEK_SET
);
390 unlink_noerrno(filename_tmp
);
393 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
398 if (err
< 0 || rename(filename_tmp
, filename
) < 0) {
399 unlink_noerrno(filename_tmp
);
400 return err
< 0 ? err
: -errno
;
403 log_debug("=== trie on-disk ===");
404 log_debug("size: %8"PRIi64
" bytes", size
);
405 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
406 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
407 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
408 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
409 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
410 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
411 t
.values_count
* sizeof(struct trie_value_entry_f
), t
.values_count
);
412 log_debug("string store: %8zu bytes", trie
->strings
->len
);
413 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
418 static int insert_data(struct trie
*trie
, struct udev_list
*match_list
,
419 char *line
, const char *filename
) {
421 struct udev_list_entry
*entry
;
423 value
= strchr(line
, '=');
425 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
432 /* libudev requires properties to start with a space */
433 while (isblank(line
[0]) && isblank(line
[1]))
436 if (line
[0] == '\0' || value
[0] == '\0') {
437 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
441 udev_list_entry_foreach(entry
, udev_list_get_entry(match_list
))
442 trie_insert(trie
, trie
->root
, udev_list_entry_get_name(entry
), line
, value
);
447 static int import_file(struct udev
*udev
, struct trie
*trie
, const char *filename
) {
455 struct udev_list match_list
;
457 udev_list_init(udev
, &match_list
, false);
459 f
= fopen(filename
, "re");
463 while (fgets(line
, sizeof(line
), f
)) {
471 /* strip trailing comment */
472 pos
= strchr(line
, '#');
476 /* strip trailing whitespace */
478 while (len
> 0 && isspace(line
[len
-1]))
487 if (line
[0] == ' ') {
488 log_error("Error, MATCH expected but got '%s' in '%s':", line
, filename
);
492 /* start of record, first match */
494 udev_list_entry_add(&match_list
, line
, NULL
);
499 log_error("Error, DATA expected but got empty line in '%s':", filename
);
501 udev_list_cleanup(&match_list
);
506 if (line
[0] != ' ') {
507 udev_list_entry_add(&match_list
, line
, NULL
);
513 insert_data(trie
, &match_list
, line
, filename
);
520 udev_list_cleanup(&match_list
);
524 if (line
[0] != ' ') {
525 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
527 udev_list_cleanup(&match_list
);
531 insert_data(trie
, &match_list
, line
, filename
);
537 udev_list_cleanup(&match_list
);
541 static void help(void) {
542 printf("Usage: udevadm hwdb OPTIONS\n"
543 " -u,--update update the hardware database\n"
544 " --usr generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
545 " -t,--test=MODALIAS query database and print result\n"
546 " -r,--root=PATH alternative root path in the filesystem\n"
550 static int adm_hwdb(struct udev
*udev
, int argc
, char *argv
[]) {
555 static const struct option options
[] = {
556 { "update", no_argument
, NULL
, 'u' },
557 { "usr", no_argument
, NULL
, ARG_USR
},
558 { "test", required_argument
, NULL
, 't' },
559 { "root", required_argument
, NULL
, 'r' },
560 { "help", no_argument
, NULL
, 'h' },
563 const char *test
= NULL
;
564 const char *root
= "";
565 const char *hwdb_bin_dir
= "/etc/udev";
567 struct trie
*trie
= NULL
;
569 int rc
= EXIT_SUCCESS
;
571 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0)
577 hwdb_bin_dir
= UDEVLIBEXECDIR
;
591 assert_not_reached("Unknown option");
594 if (!update
&& !test
) {
595 log_error("Either --update or --test must be used");
601 _cleanup_free_
char *hwdb_bin
= NULL
;
603 trie
= new0(struct trie
, 1);
610 trie
->strings
= strbuf_new();
611 if (!trie
->strings
) {
617 trie
->root
= new0(struct trie_node
, 1);
624 err
= conf_files_list_strv(&files
, ".hwdb", root
, conf_file_dirs
);
626 log_error_errno(err
, "failed to enumerate hwdb files: %m");
630 STRV_FOREACH(f
, files
) {
631 log_debug("reading file '%s'", *f
);
632 import_file(udev
, trie
, *f
);
636 strbuf_complete(trie
->strings
);
638 log_debug("=== trie in-memory ===");
639 log_debug("nodes: %8zu bytes (%8zu)",
640 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
641 log_debug("children arrays: %8zu bytes (%8zu)",
642 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
643 log_debug("values arrays: %8zu bytes (%8zu)",
644 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
645 log_debug("strings: %8zu bytes",
647 log_debug("strings incoming: %8zu bytes (%8zu)",
648 trie
->strings
->in_len
, trie
->strings
->in_count
);
649 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
650 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
652 hwdb_bin
= strjoin(root
, "/", hwdb_bin_dir
, "/hwdb.bin", NULL
);
657 mkdir_parents(hwdb_bin
, 0755);
658 err
= trie_store(trie
, hwdb_bin
);
660 log_error_errno(err
, "Failure writing database %s: %m", hwdb_bin
);
666 _cleanup_hwdb_unref_ sd_hwdb
*hwdb
= NULL
;
669 r
= sd_hwdb_new(&hwdb
);
671 const char *key
, *value
;
673 SD_HWDB_FOREACH_PROPERTY(hwdb
, test
, key
, value
)
674 printf("%s=%s\n", key
, value
);
680 trie_node_cleanup(trie
->root
);
681 strbuf_cleanup(trie
->strings
);
687 const struct udevadm_cmd udevadm_hwdb
= {