1 /* SPDX-License-Identifier: LGPL-2.1+ */
8 #include "alloc-util.h"
9 #include "conf-files.h"
12 #include "hwdb-internal.h"
13 #include "hwdb-util.h"
16 #include "path-util.h"
18 #include "string-util.h"
24 * Generic udev properties, key/value database based on modalias strings.
25 * Uses a Patricia/radix trie to index all matches for efficient lookup.
28 static const char *arg_test
= NULL
;
29 static const char *arg_root
= NULL
;
30 static const char *arg_hwdb_bin_dir
= "/etc/udev";
31 static bool arg_update
= false;
32 static bool arg_strict
= false;
34 static const char * const conf_file_dirs
[] = {
36 UDEVLIBEXECDIR
"/hwdb.d",
40 /* in-memory trie objects */
42 struct trie_node
*root
;
43 struct strbuf
*strings
;
46 size_t children_count
;
51 /* prefix, common part for all children of this node */
54 /* sorted array of pointers to children nodes */
55 struct trie_child_entry
*children
;
56 uint8_t children_count
;
58 /* sorted array of key/value pairs */
59 struct trie_value_entry
*values
;
63 /* children array item with char (0-255) index */
64 struct trie_child_entry
{
66 struct trie_node
*child
;
69 /* value array item with key/value pairs */
70 struct trie_value_entry
{
75 static int trie_children_cmp(const void *v1
, const void *v2
) {
76 const struct trie_child_entry
*n1
= v1
;
77 const struct trie_child_entry
*n2
= v2
;
82 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
83 struct trie_child_entry
*child
;
85 /* extend array, add new entry, sort for bisection */
86 child
= reallocarray(node
->children
, node
->children_count
+ 1, sizeof(struct trie_child_entry
));
90 node
->children
= child
;
91 trie
->children_count
++;
92 node
->children
[node
->children_count
].c
= c
;
93 node
->children
[node
->children_count
].child
= node_child
;
94 node
->children_count
++;
95 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
101 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
102 struct trie_child_entry
*child
;
103 struct trie_child_entry search
;
106 child
= bsearch_safe(&search
,
107 node
->children
, node
->children_count
, sizeof(struct trie_child_entry
),
114 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 void trie_free(struct trie
*trie
) {
131 trie_node_cleanup(trie
->root
);
132 strbuf_cleanup(trie
->strings
);
136 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
138 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
139 const struct trie_value_entry
*val1
= v1
;
140 const struct trie_value_entry
*val2
= v2
;
141 struct trie
*trie
= arg
;
143 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
144 trie
->strings
->buf
+ val2
->key_off
);
147 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
148 const char *key
, const char *value
) {
150 struct trie_value_entry
*val
;
152 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
155 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
159 if (node
->values_count
) {
160 struct trie_value_entry search
= {
165 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
167 /* replace existing earlier key with new value */
173 /* extend array, add new entry, sort for bisection */
174 val
= reallocarray(node
->values
, node
->values_count
+ 1, sizeof(struct trie_value_entry
));
177 trie
->values_count
++;
179 node
->values
[node
->values_count
].key_off
= k
;
180 node
->values
[node
->values_count
].value_off
= v
;
181 node
->values_count
++;
182 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
186 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
187 const char *key
, const char *value
) {
194 struct trie_node
*child
;
196 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
197 _cleanup_free_
char *s
= NULL
;
199 _cleanup_free_
struct trie_node
*new_child
= NULL
;
201 if (c
== search
[i
+ p
])
205 new_child
= new0(struct trie_node
, 1);
209 /* move values from parent to child */
210 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
211 new_child
->children
= node
->children
;
212 new_child
->children_count
= node
->children_count
;
213 new_child
->values
= node
->values
;
214 new_child
->values_count
= node
->values_count
;
216 /* update parent; use strdup() because the source gets realloc()d */
217 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
221 off
= strbuf_add_string(trie
->strings
, s
, p
);
225 node
->prefix_off
= off
;
226 node
->children
= NULL
;
227 node
->children_count
= 0;
229 node
->values_count
= 0;
230 err
= node_add_child(trie
, node
, new_child
, c
);
234 new_child
= NULL
; /* avoid cleanup */
241 return trie_node_add_value(trie
, node
, key
, value
);
243 child
= node_lookup(node
, c
);
248 child
= new0(struct trie_node
, 1);
252 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
258 child
->prefix_off
= off
;
259 err
= node_add_child(trie
, node
, child
, c
);
265 return trie_node_add_value(trie
, child
, key
, value
);
276 uint64_t strings_off
;
278 uint64_t nodes_count
;
279 uint64_t children_count
;
280 uint64_t values_count
;
283 /* calculate the storage space for the nodes, children arrays, value arrays */
284 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
287 for (i
= 0; i
< node
->children_count
; i
++)
288 trie_store_nodes_size(trie
, node
->children
[i
].child
);
290 trie
->strings_off
+= sizeof(struct trie_node_f
);
291 for (i
= 0; i
< node
->children_count
; i
++)
292 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
293 for (i
= 0; i
< node
->values_count
; i
++)
294 trie
->strings_off
+= sizeof(struct trie_value_entry_f
);
297 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
299 struct trie_node_f n
= {
300 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
301 .children_count
= node
->children_count
,
302 .values_count
= htole64(node
->values_count
),
304 struct trie_child_entry_f
*children
= NULL
;
307 if (node
->children_count
) {
308 children
= new0(struct trie_child_entry_f
, node
->children_count
);
313 /* post-order recursion */
314 for (i
= 0; i
< node
->children_count
; i
++) {
317 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
322 children
[i
].c
= node
->children
[i
].c
;
323 children
[i
].child_off
= htole64(child_off
);
327 node_off
= ftello(trie
->f
);
328 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
331 /* append children array */
332 if (node
->children_count
) {
333 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
334 trie
->children_count
+= node
->children_count
;
338 /* append values array */
339 for (i
= 0; i
< node
->values_count
; i
++) {
340 struct trie_value_entry_f v
= {
341 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
342 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
345 fwrite(&v
, sizeof(struct trie_value_entry_f
), 1, trie
->f
);
346 trie
->values_count
++;
352 static int trie_store(struct trie
*trie
, const char *filename
) {
356 _cleanup_free_
char *filename_tmp
= NULL
;
360 struct trie_header_f h
= {
361 .signature
= HWDB_SIG
,
362 .tool_version
= htole64(atoi(PACKAGE_VERSION
)),
363 .header_size
= htole64(sizeof(struct trie_header_f
)),
364 .node_size
= htole64(sizeof(struct trie_node_f
)),
365 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
366 .value_entry_size
= htole64(sizeof(struct trie_value_entry_f
)),
370 /* calculate size of header, nodes, children entries, value entries */
371 t
.strings_off
= sizeof(struct trie_header_f
);
372 trie_store_nodes_size(&t
, trie
->root
);
374 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
377 fchmod(fileno(t
.f
), 0444);
380 if (fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
) < 0)
382 root_off
= trie_store_nodes(&t
, trie
->root
);
383 h
.nodes_root_off
= htole64(root_off
);
385 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
387 /* write string buffer */
388 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
389 h
.strings_len
= htole64(trie
->strings
->len
);
393 h
.file_size
= htole64(size
);
394 if (fseeko(t
.f
, 0, SEEK_SET
< 0))
396 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
402 if (fsync(fileno(t
.f
)) < 0)
404 if (rename(filename_tmp
, filename
) < 0)
407 /* write succeeded */
410 log_debug("=== trie on-disk ===");
411 log_debug("size: %8"PRIi64
" bytes", size
);
412 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
413 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
414 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
415 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
416 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
417 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
418 t
.values_count
* sizeof(struct trie_value_entry_f
), t
.values_count
);
419 log_debug("string store: %8zu bytes", trie
->strings
->len
);
420 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
427 unlink(filename_tmp
);
431 static int insert_data(struct trie
*trie
, struct udev_list
*match_list
,
432 char *line
, const char *filename
) {
434 struct udev_list_entry
*entry
;
436 value
= strchr(line
, '=');
438 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
445 /* libudev requires properties to start with a space */
446 while (isblank(line
[0]) && isblank(line
[1]))
449 if (line
[0] == '\0' || value
[0] == '\0') {
450 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
454 udev_list_entry_foreach(entry
, udev_list_get_entry(match_list
))
455 trie_insert(trie
, trie
->root
, udev_list_entry_get_name(entry
), line
, value
);
460 static int import_file(struct trie
*trie
, const char *filename
) {
468 struct udev_list match_list
;
471 udev_list_init(NULL
, &match_list
, false);
473 f
= fopen(filename
, "re");
477 while (fgets(line
, sizeof(line
), f
)) {
485 /* strip trailing comment */
486 pos
= strchr(line
, '#');
490 /* strip trailing whitespace */
492 while (len
> 0 && isspace(line
[len
-1]))
501 if (line
[0] == ' ') {
502 log_error("Error, MATCH expected but got '%s' in '%s':", line
, filename
);
507 /* start of record, first match */
509 udev_list_entry_add(&match_list
, line
, NULL
);
514 log_error("Error, DATA expected but got empty line in '%s':", filename
);
517 udev_list_cleanup(&match_list
);
522 if (line
[0] != ' ') {
523 udev_list_entry_add(&match_list
, line
, NULL
);
529 err
= insert_data(trie
, &match_list
, line
, filename
);
538 udev_list_cleanup(&match_list
);
542 if (line
[0] != ' ') {
543 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
546 udev_list_cleanup(&match_list
);
550 err
= insert_data(trie
, &match_list
, line
, filename
);
558 udev_list_cleanup(&match_list
);
562 static int hwdb_update(void) {
563 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
564 _cleanup_strv_free_
char **files
= NULL
;
565 _cleanup_free_
char *hwdb_bin
= NULL
;
569 trie
= new0(struct trie
, 1);
574 trie
->strings
= strbuf_new();
579 trie
->root
= new0(struct trie_node
, 1);
585 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, 0, conf_file_dirs
);
587 return log_error_errno(r
, "failed to enumerate hwdb files: %m");
589 STRV_FOREACH(f
, files
) {
590 log_debug("Reading file '%s'", *f
);
591 r
= import_file(trie
, *f
);
592 if (r
< 0 && arg_strict
)
596 strbuf_complete(trie
->strings
);
598 log_debug("=== trie in-memory ===");
599 log_debug("nodes: %8zu bytes (%8zu)",
600 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
601 log_debug("children arrays: %8zu bytes (%8zu)",
602 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
603 log_debug("values arrays: %8zu bytes (%8zu)",
604 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
605 log_debug("strings: %8zu bytes",
607 log_debug("strings incoming: %8zu bytes (%8zu)",
608 trie
->strings
->in_len
, trie
->strings
->in_count
);
609 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
610 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
612 hwdb_bin
= path_join(arg_root
, arg_hwdb_bin_dir
, "/hwdb.bin");
616 mkdir_parents_label(hwdb_bin
, 0755);
618 r
= trie_store(trie
, hwdb_bin
);
620 log_error_errno(r
, "Failed to write database %s: %m", hwdb_bin
);
622 (void) label_fix(hwdb_bin
, 0);
627 static int hwdb_test(void) {
628 _cleanup_(sd_hwdb_unrefp
) sd_hwdb
*hwdb
= NULL
;
629 const char *key
, *value
;
632 r
= sd_hwdb_new(&hwdb
);
636 SD_HWDB_FOREACH_PROPERTY(hwdb
, arg_test
, key
, value
)
637 printf("%s=%s\n", key
, value
);
642 static int help(void) {
643 printf("%s hwdb [OPTIONS]\n\n"
644 " -h --help Print this message\n"
645 " -V --version Print version of the program\n"
646 " -u --update Update the hardware database\n"
647 " -s --strict When updating, return non-zero exit value on any parsing error\n"
648 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
649 " -t --test=MODALIAS Query database and print result\n"
650 " -r --root=PATH Alternative root path in the filesystem\n\n"
652 "The sub-command 'hwdb' is deprecated, and is left for backwards compatibility.\n"
653 "Please use systemd-hwdb instead.\n"
654 , program_invocation_short_name
);
659 static int parse_argv(int argc
, char *argv
[]) {
664 static const struct option options
[] = {
665 { "update", no_argument
, NULL
, 'u' },
666 { "usr", no_argument
, NULL
, ARG_USR
},
667 { "strict", no_argument
, NULL
, 's' },
668 { "test", required_argument
, NULL
, 't' },
669 { "root", required_argument
, NULL
, 'r' },
670 { "version", no_argument
, NULL
, 'V' },
671 { "help", no_argument
, NULL
, 'h' },
677 while ((c
= getopt_long(argc
, argv
, "ust:r:Vh", options
, NULL
)) >= 0)
683 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
701 assert_not_reached("Unknown option");
707 int hwdb_main(int argc
, char *argv
[], void *userdata
) {
710 r
= parse_argv(argc
, argv
);
714 if (!arg_update
&& !arg_test
) {
715 log_error("Either --update or --test must be used.");