]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/hwdb-util.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
7 #include "alloc-util.h"
8 #include "conf-files.h"
12 #include "hwdb-internal.h"
13 #include "hwdb-util.h"
14 #include "label-util.h"
15 #include "mkdir-label.h"
16 #include "nulstr-util.h"
17 #include "path-util.h"
18 #include "sort-util.h"
20 #include "string-util.h"
22 #include "tmpfile-util.h"
24 static const char* const conf_file_dirs
[] = {
26 UDEVLIBEXECDIR
"/hwdb.d",
31 * Generic udev properties, key-value database based on modalias strings.
32 * Uses a Patricia/radix trie to index all matches for efficient lookup.
35 /* in-memory trie objects */
37 struct trie_node
*root
;
38 struct strbuf
*strings
;
41 size_t children_count
;
46 /* prefix, common part for all children of this node */
49 /* sorted array of pointers to children nodes */
50 struct trie_child_entry
*children
;
51 uint8_t children_count
;
53 /* sorted array of key-value pairs */
54 struct trie_value_entry
*values
;
58 /* children array item with char (0-255) index */
59 struct trie_child_entry
{
61 struct trie_node
*child
;
64 /* value array item with key-value pairs */
65 struct trie_value_entry
{
70 uint16_t file_priority
;
73 static int trie_children_cmp(const struct trie_child_entry
*a
, const struct trie_child_entry
*b
) {
74 return CMP(a
->c
, b
->c
);
77 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
78 struct trie_child_entry
*child
;
80 /* extend array, add new entry, sort for bisection */
81 child
= reallocarray(node
->children
, node
->children_count
+ 1, sizeof(struct trie_child_entry
));
85 node
->children
= child
;
86 trie
->children_count
++;
87 node
->children
[node
->children_count
].c
= c
;
88 node
->children
[node
->children_count
].child
= node_child
;
89 node
->children_count
++;
90 typesafe_qsort(node
->children
, node
->children_count
, trie_children_cmp
);
96 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
97 struct trie_child_entry
*child
;
98 struct trie_child_entry search
;
101 child
= typesafe_bsearch(&search
, node
->children
, node
->children_count
, trie_children_cmp
);
107 static void trie_node_cleanup(struct trie_node
*node
) {
111 for (size_t i
= 0; i
< node
->children_count
; i
++)
112 trie_node_cleanup(node
->children
[i
].child
);
113 free(node
->children
);
118 static struct trie
* trie_free(struct trie
*trie
) {
122 trie_node_cleanup(trie
->root
);
123 strbuf_free(trie
->strings
);
127 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
129 static int trie_values_cmp(const struct trie_value_entry
*a
, const struct trie_value_entry
*b
, struct trie
*trie
) {
130 return strcmp(trie
->strings
->buf
+ a
->key_off
,
131 trie
->strings
->buf
+ b
->key_off
);
134 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
135 const char *key
, const char *value
,
136 const char *filename
, uint16_t file_priority
, uint32_t line_number
, bool compat
) {
137 ssize_t k
, v
, fn
= 0;
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
));
148 fn
= strbuf_add_string(trie
->strings
, filename
, strlen(filename
));
153 if (node
->values_count
) {
154 struct trie_value_entry search
= {
159 val
= typesafe_bsearch_r(&search
, node
->values
, node
->values_count
, trie_values_cmp
, trie
);
161 /* At this point we have 2 identical properties on the same match-string.
162 * Since we process files in order, we just replace the previous value. */
164 val
->filename_off
= fn
;
165 val
->file_priority
= file_priority
;
166 val
->line_number
= line_number
;
171 /* extend array, add new entry, sort for bisection */
172 val
= reallocarray(node
->values
, node
->values_count
+ 1, sizeof(struct trie_value_entry
));
175 trie
->values_count
++;
177 node
->values
[node
->values_count
] = (struct trie_value_entry
) {
181 .file_priority
= file_priority
,
182 .line_number
= line_number
,
184 node
->values_count
++;
185 typesafe_qsort_r(node
->values
, node
->values_count
, trie_values_cmp
, trie
);
189 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
190 const char *key
, const char *value
,
191 const char *filename
, uint16_t file_priority
, uint32_t line_number
, bool compat
) {
194 for (size_t i
= 0;; i
++) {
197 struct trie_node
*child
;
199 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
200 _cleanup_free_
struct trie_node
*new_child
= NULL
;
201 _cleanup_free_
char *s
= NULL
;
204 if (c
== search
[i
+ p
])
208 new_child
= new(struct trie_node
, 1);
212 /* move values from parent to child */
213 *new_child
= (struct trie_node
) {
214 .prefix_off
= node
->prefix_off
+ p
+1,
215 .children
= node
->children
,
216 .children_count
= node
->children_count
,
217 .values
= node
->values
,
218 .values_count
= node
->values_count
,
221 /* update parent; use strdup() because the source gets realloc()d */
222 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
226 off
= strbuf_add_string(trie
->strings
, s
, p
);
230 *node
= (struct trie_node
) {
233 r
= node_add_child(trie
, node
, new_child
, c
);
237 new_child
= NULL
; /* avoid cleanup */
244 return trie_node_add_value(trie
, node
, key
, value
, filename
, file_priority
, line_number
, compat
);
246 child
= node_lookup(node
, c
);
248 _cleanup_free_
struct trie_node
*new_child
= NULL
;
252 new_child
= new(struct trie_node
, 1);
256 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
260 *new_child
= (struct trie_node
) {
264 r
= node_add_child(trie
, node
, new_child
, c
);
268 child
= TAKE_PTR(new_child
);
269 return trie_node_add_value(trie
, child
, key
, value
, filename
, file_priority
, line_number
, compat
);
278 uint64_t strings_off
;
280 uint64_t nodes_count
;
281 uint64_t children_count
;
282 uint64_t values_count
;
285 /* calculate the storage space for the nodes, children arrays, value arrays */
286 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
, bool compat
) {
287 for (uint64_t i
= 0; i
< node
->children_count
; i
++)
288 trie_store_nodes_size(trie
, node
->children
[i
].child
, compat
);
290 trie
->strings_off
+= sizeof(struct trie_node_f
);
291 for (uint64_t i
= 0; i
< node
->children_count
; i
++)
292 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
293 for (uint64_t i
= 0; i
< node
->values_count
; i
++)
294 trie
->strings_off
+= compat
? sizeof(struct trie_value_entry_f
) : sizeof(struct trie_value_entry2_f
);
297 static int64_t trie_store_nodes(struct trie_f
*trie
, FILE *f
, struct trie_node
*node
, bool compat
) {
298 _cleanup_free_
struct trie_child_entry_f
*children
= NULL
;
305 if (node
->children_count
) {
306 children
= new(struct trie_child_entry_f
, node
->children_count
);
311 /* post-order recursion */
312 for (uint64_t i
= 0; i
< node
->children_count
; i
++) {
315 child_off
= trie_store_nodes(trie
, f
, node
->children
[i
].child
, compat
);
319 children
[i
] = (struct trie_child_entry_f
) {
320 .c
= node
->children
[i
].c
,
321 .child_off
= htole64(child_off
),
325 struct trie_node_f n
= {
326 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
327 .children_count
= node
->children_count
,
328 .values_count
= htole64(node
->values_count
),
332 node_off
= ftello(f
);
333 fwrite(&n
, sizeof(struct trie_node_f
), 1, f
);
336 /* append children array */
337 if (node
->children_count
) {
338 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, f
);
339 trie
->children_count
+= node
->children_count
;
342 /* append values array */
343 for (uint64_t i
= 0; i
< node
->values_count
; i
++) {
344 struct trie_value_entry2_f v
= {
345 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
346 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
347 .filename_off
= htole64(trie
->strings_off
+ node
->values
[i
].filename_off
),
348 .line_number
= htole32(node
->values
[i
].line_number
),
349 .file_priority
= htole16(node
->values
[i
].file_priority
),
352 fwrite(&v
, compat
? sizeof(struct trie_value_entry_f
) : sizeof(struct trie_value_entry2_f
), 1, f
);
354 trie
->values_count
+= node
->values_count
;
359 static int trie_store(struct trie
*trie
, const char *filename
, bool compat
) {
362 .strings_off
= sizeof(struct trie_header_f
),
364 _cleanup_(unlink_and_freep
) char *filename_tmp
= NULL
;
365 _cleanup_fclose_
FILE *f
= NULL
;
366 int64_t pos
, root_off
, size
;
372 /* calculate size of header, nodes, children entries, value entries */
373 trie_store_nodes_size(&t
, trie
->root
, compat
);
375 r
= fopen_tmpfile_linkable(filename
, O_WRONLY
|O_CLOEXEC
, &filename_tmp
, &f
);
379 if (fchmod(fileno(f
), 0444) < 0)
382 struct trie_header_f h
= {
383 .signature
= HWDB_SIG
,
384 .tool_version
= htole64(PROJECT_VERSION
),
385 .header_size
= htole64(sizeof(struct trie_header_f
)),
386 .node_size
= htole64(sizeof(struct trie_node_f
)),
387 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
388 .value_entry_size
= htole64(compat
? sizeof(struct trie_value_entry_f
) : sizeof(struct trie_value_entry2_f
)),
392 if (fseeko(f
, sizeof(struct trie_header_f
), SEEK_SET
) < 0)
395 root_off
= trie_store_nodes(&t
, f
, trie
->root
, compat
);
396 h
.nodes_root_off
= htole64(root_off
);
398 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
400 /* write string buffer */
401 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, f
);
402 h
.strings_len
= htole64(trie
->strings
->len
);
406 h
.file_size
= htole64(size
);
407 if (fseeko(f
, 0, SEEK_SET
) < 0)
409 fwrite(&h
, sizeof(struct trie_header_f
), 1, f
);
411 r
= flink_tmpfile(f
, filename_tmp
, filename
, /* replace= */ true);
415 /* write succeeded */
417 log_debug("=== trie on-disk ===");
418 log_debug("size: %8"PRIi64
" bytes", size
);
419 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
420 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
421 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
422 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
423 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
424 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
425 t
.values_count
* (compat
? sizeof(struct trie_value_entry_f
) : sizeof(struct trie_value_entry2_f
)), t
.values_count
);
426 log_debug("string store: %8zu bytes", trie
->strings
->len
);
427 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
431 static int insert_data(struct trie
*trie
, char **match_list
, char *line
, const char *filename
,
432 uint16_t file_priority
, uint32_t line_number
, bool compat
) {
435 assert(line
[0] == ' ');
437 value
= strchr(line
, '=');
439 return log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, SYNTHETIC_ERRNO(EINVAL
),
440 "Key-value pair expected but got \"%s\", ignoring.", line
);
445 /* Replace multiple leading spaces by a single space */
446 while (isblank(line
[0]) && isblank(line
[1]))
449 if (isempty(line
+ 1))
450 return log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, SYNTHETIC_ERRNO(EINVAL
),
451 "Empty key in \"%s=%s\", ignoring.",
454 STRV_FOREACH(entry
, match_list
)
455 trie_insert(trie
, trie
->root
, *entry
, line
, value
, filename
, file_priority
, line_number
, compat
);
460 static int import_file(struct trie
*trie
, const char *filename
, uint16_t file_priority
, bool compat
) {
466 _cleanup_fclose_
FILE *f
= NULL
;
467 _cleanup_strv_free_
char **match_list
= NULL
;
468 uint32_t line_number
= 0;
471 f
= fopen(filename
, "re");
476 _cleanup_free_
char *line
= NULL
;
480 r
= read_line_full(f
, LONG_LINE_MAX
, READ_LINE_NOT_A_TTY
, &line
);
492 /* strip trailing comment */
493 pos
= strchr(line
, '#');
497 /* strip trailing whitespace */
499 while (len
> 0 && isspace(line
[len
-1]))
508 if (line
[0] == ' ') {
509 r
= log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, SYNTHETIC_ERRNO(EINVAL
),
510 "Match expected but got indented property \"%s\", ignoring line.", line
);
514 /* start of record, first match */
517 err
= strv_extend(&match_list
, line
);
525 r
= log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, SYNTHETIC_ERRNO(EINVAL
),
526 "Property expected, ignoring record with no properties.");
528 match_list
= strv_free(match_list
);
532 if (line
[0] != ' ') {
534 err
= strv_extend(&match_list
, line
);
543 err
= insert_data(trie
, match_list
, line
, filename
, file_priority
, line_number
, compat
);
552 match_list
= strv_free(match_list
);
556 if (line
[0] != ' ') {
557 r
= log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, SYNTHETIC_ERRNO(EINVAL
),
558 "Property or empty line expected, got \"%s\", ignoring record.", line
);
560 match_list
= strv_free(match_list
);
564 err
= insert_data(trie
, match_list
, line
, filename
, file_priority
, line_number
, compat
);
571 if (state
== HW_MATCH
)
572 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, 0,
573 "Property expected, ignoring record with no properties.");
578 int hwdb_update(const char *root
, const char *hwdb_bin_dir
, bool strict
, bool compat
) {
579 _cleanup_free_
char *hwdb_bin
= NULL
;
580 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
581 _cleanup_strv_free_
char **files
= NULL
;
582 uint16_t file_priority
= 1;
585 /* The argument 'compat' controls the format version of database. If false, then hwdb.bin will be
586 * created with additional information such that priority, line number, and filename of database
587 * source. If true, then hwdb.bin will be created without the information. systemd-hwdb command
588 * should set the argument false, and 'udevadm hwdb' command should set it true. */
590 trie
= new0(struct trie
, 1);
595 trie
->strings
= strbuf_new();
600 trie
->root
= new0(struct trie_node
, 1);
606 err
= conf_files_list_strv(&files
, ".hwdb", root
, 0, conf_file_dirs
);
608 return log_error_errno(err
, "Failed to enumerate hwdb files: %m");
610 STRV_FOREACH(f
, files
) {
611 log_debug("Reading file \"%s\"", *f
);
612 err
= import_file(trie
, *f
, file_priority
++, compat
);
613 if (err
< 0 && strict
)
617 strbuf_complete(trie
->strings
);
619 log_debug("=== trie in-memory ===");
620 log_debug("nodes: %8zu bytes (%8zu)",
621 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
622 log_debug("children arrays: %8zu bytes (%8zu)",
623 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
624 log_debug("values arrays: %8zu bytes (%8zu)",
625 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
626 log_debug("strings: %8zu bytes",
628 log_debug("strings incoming: %8zu bytes (%8zu)",
629 trie
->strings
->in_len
, trie
->strings
->in_count
);
630 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
631 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
633 hwdb_bin
= path_join(root
, hwdb_bin_dir
?: "/etc/udev", "hwdb.bin");
637 (void) mkdir_parents_label(hwdb_bin
, 0755);
638 err
= trie_store(trie
, hwdb_bin
, compat
);
640 return log_error_errno(err
, "Failed to write database %s: %m", hwdb_bin
);
642 err
= label_fix(hwdb_bin
, 0);
649 int hwdb_query(const char *modalias
, const char *root
) {
650 _cleanup_(sd_hwdb_unrefp
) sd_hwdb
*hwdb
= NULL
;
651 const char *key
, *value
;
657 NULSTR_FOREACH(p
, hwdb_bin_paths
) {
658 _cleanup_free_
char *hwdb_bin
= NULL
;
660 hwdb_bin
= path_join(root
, p
);
664 r
= sd_hwdb_new_from_path(hwdb_bin
, &hwdb
);
669 r
= sd_hwdb_new(&hwdb
);
673 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
674 printf("%s=%s\n", key
, value
);
679 bool hwdb_should_reload(sd_hwdb
*hwdb
) {
688 /* if hwdb.bin doesn't exist anywhere, we need to update */
689 NULSTR_FOREACH(p
, hwdb_bin_paths
)
690 if (stat(p
, &st
) >= 0) {
697 if (timespec_load(&hwdb
->st
.st_mtim
) != timespec_load(&st
.st_mtim
))