]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/libsystemd/sd-hwdb/hwdb-util.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
6 #include "alloc-util.h"
7 #include "conf-files.h"
11 #include "hwdb-internal.h"
12 #include "hwdb-util.h"
15 #include "path-util.h"
17 #include "string-util.h"
20 static const char *default_hwdb_bin_dir
= "/etc/udev";
21 static const char * const conf_file_dirs
[] = {
23 UDEVLIBEXECDIR
"/hwdb.d",
28 * Generic udev properties, key-value database based on modalias strings.
29 * Uses a Patricia/radix trie to index all matches for efficient lookup.
32 /* in-memory trie objects */
34 struct trie_node
*root
;
35 struct strbuf
*strings
;
38 size_t children_count
;
43 /* prefix, common part for all children of this node */
46 /* sorted array of pointers to children nodes */
47 struct trie_child_entry
*children
;
48 uint8_t children_count
;
50 /* sorted array of key-value pairs */
51 struct trie_value_entry
*values
;
55 /* children array item with char (0-255) index */
56 struct trie_child_entry
{
58 struct trie_node
*child
;
61 /* value array item with key-value pairs */
62 struct trie_value_entry
{
67 uint16_t file_priority
;
70 static int trie_children_cmp(const struct trie_child_entry
*a
, const struct trie_child_entry
*b
) {
71 return CMP(a
->c
, b
->c
);
74 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
75 struct trie_child_entry
*child
;
77 /* extend array, add new entry, sort for bisection */
78 child
= reallocarray(node
->children
, node
->children_count
+ 1, sizeof(struct trie_child_entry
));
82 node
->children
= child
;
83 trie
->children_count
++;
84 node
->children
[node
->children_count
].c
= c
;
85 node
->children
[node
->children_count
].child
= node_child
;
86 node
->children_count
++;
87 typesafe_qsort(node
->children
, node
->children_count
, trie_children_cmp
);
93 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
94 struct trie_child_entry
*child
;
95 struct trie_child_entry search
;
98 child
= typesafe_bsearch(&search
, node
->children
, node
->children_count
, trie_children_cmp
);
104 static void trie_node_cleanup(struct trie_node
*node
) {
110 for (i
= 0; i
< node
->children_count
; i
++)
111 trie_node_cleanup(node
->children
[i
].child
);
112 free(node
->children
);
117 static void trie_free(struct trie
*trie
) {
121 trie_node_cleanup(trie
->root
);
122 strbuf_cleanup(trie
->strings
);
126 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
128 static int trie_values_cmp(const struct trie_value_entry
*a
, const struct trie_value_entry
*b
, struct trie
*trie
) {
129 return strcmp(trie
->strings
->buf
+ a
->key_off
,
130 trie
->strings
->buf
+ b
->key_off
);
133 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
134 const char *key
, const char *value
,
135 const char *filename
, uint16_t file_priority
, uint32_t line_number
, bool compat
) {
136 ssize_t k
, v
, fn
= 0;
137 struct trie_value_entry
*val
;
139 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
142 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
147 fn
= strbuf_add_string(trie
->strings
, filename
, strlen(filename
));
152 if (node
->values_count
) {
153 struct trie_value_entry search
= {
158 val
= typesafe_bsearch_r(&search
, node
->values
, node
->values_count
, trie_values_cmp
, trie
);
160 /* At this point we have 2 identical properties on the same match-string.
161 * Since we process files in order, we just replace the previous value. */
163 val
->filename_off
= fn
;
164 val
->file_priority
= file_priority
;
165 val
->line_number
= line_number
;
170 /* extend array, add new entry, sort for bisection */
171 val
= reallocarray(node
->values
, node
->values_count
+ 1, sizeof(struct trie_value_entry
));
174 trie
->values_count
++;
176 node
->values
[node
->values_count
] = (struct trie_value_entry
) {
180 .file_priority
= file_priority
,
181 .line_number
= line_number
,
183 node
->values_count
++;
184 typesafe_qsort_r(node
->values
, node
->values_count
, trie_values_cmp
, trie
);
188 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
189 const char *key
, const char *value
,
190 const char *filename
, uint16_t file_priority
, uint32_t line_number
, bool compat
) {
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
);
280 uint64_t strings_off
;
282 uint64_t nodes_count
;
283 uint64_t children_count
;
284 uint64_t values_count
;
287 /* calculate the storage space for the nodes, children arrays, value arrays */
288 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
, bool compat
) {
291 for (i
= 0; i
< node
->children_count
; i
++)
292 trie_store_nodes_size(trie
, node
->children
[i
].child
, compat
);
294 trie
->strings_off
+= sizeof(struct trie_node_f
);
295 for (i
= 0; i
< node
->children_count
; i
++)
296 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
297 for (i
= 0; i
< node
->values_count
; i
++)
298 trie
->strings_off
+= compat
? sizeof(struct trie_value_entry_f
) : sizeof(struct trie_value_entry2_f
);
301 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
, bool compat
) {
303 struct trie_node_f n
= {
304 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
305 .children_count
= node
->children_count
,
306 .values_count
= htole64(node
->values_count
),
308 _cleanup_free_
struct trie_child_entry_f
*children
= NULL
;
311 if (node
->children_count
) {
312 children
= new(struct trie_child_entry_f
, node
->children_count
);
317 /* post-order recursion */
318 for (i
= 0; i
< node
->children_count
; i
++) {
321 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
, compat
);
325 children
[i
] = (struct trie_child_entry_f
) {
326 .c
= node
->children
[i
].c
,
327 .child_off
= htole64(child_off
),
332 node_off
= ftello(trie
->f
);
333 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
336 /* append children array */
337 if (node
->children_count
) {
338 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
339 trie
->children_count
+= node
->children_count
;
342 /* append values array */
343 for (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, trie
->f
);
354 trie
->values_count
+= node
->values_count
;
359 static int trie_store(struct trie
*trie
, const char *filename
, bool compat
) {
363 _cleanup_free_
char *filename_tmp
= NULL
;
367 struct trie_header_f h
= {
368 .signature
= HWDB_SIG
,
369 .tool_version
= htole64(atoi(PACKAGE_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(compat
? sizeof(struct trie_value_entry_f
) : sizeof(struct trie_value_entry2_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
, compat
);
381 r
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
384 fchmod(fileno(t
.f
), 0444);
387 if (fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
) < 0)
390 root_off
= trie_store_nodes(&t
, trie
->root
, compat
);
391 h
.nodes_root_off
= htole64(root_off
);
393 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
395 /* write string buffer */
396 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
397 h
.strings_len
= htole64(trie
->strings
->len
);
401 h
.file_size
= htole64(size
);
402 if (fseeko(t
.f
, 0, SEEK_SET
) < 0)
404 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
410 if (fsync(fileno(t
.f
)) < 0)
412 if (rename(filename_tmp
, filename
) < 0)
415 /* write succeeded */
418 log_debug("=== trie on-disk ===");
419 log_debug("size: %8"PRIi64
" bytes", size
);
420 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
421 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
422 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
423 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
424 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
425 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
426 t
.values_count
* (compat
? sizeof(struct trie_value_entry_f
) : sizeof(struct trie_value_entry2_f
)), t
.values_count
);
427 log_debug("string store: %8zu bytes", trie
->strings
->len
);
428 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
434 unlink(filename_tmp
);
438 static int insert_data(struct trie
*trie
, char **match_list
, char *line
, const char *filename
,
439 uint16_t file_priority
, uint32_t line_number
, bool compat
) {
440 char *value
, **entry
;
442 assert(line
[0] == ' ');
444 value
= strchr(line
, '=');
446 return log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
447 "Key-value pair expected but got \"%s\", ignoring", line
);
452 /* Replace multiple leading spaces by a single space */
453 while (isblank(line
[0]) && isblank(line
[1]))
456 if (isempty(line
+ 1) || isempty(value
))
457 return log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
458 "Empty %s in \"%s=%s\", ignoring",
459 isempty(line
+ 1) ? "key" : "value",
462 STRV_FOREACH(entry
, match_list
)
463 trie_insert(trie
, trie
->root
, *entry
, line
, value
, filename
, file_priority
, line_number
, compat
);
468 static int import_file(struct trie
*trie
, const char *filename
, uint16_t file_priority
, bool compat
) {
474 _cleanup_fclose_
FILE *f
= NULL
;
476 _cleanup_strv_free_
char **match_list
= NULL
;
477 uint32_t line_number
= 0;
481 f
= fopen(filename
, "re");
485 while (fgets(line
, sizeof(line
), f
)) {
495 /* strip trailing comment */
496 pos
= strchr(line
, '#');
500 /* strip trailing whitespace */
502 while (len
> 0 && isspace(line
[len
-1]))
511 if (line
[0] == ' ') {
512 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
513 "Match expected but got indented property \"%s\", ignoring line", line
);
518 /* start of record, first match */
521 match
= strdup(line
);
525 err
= strv_consume(&match_list
, match
);
533 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
534 "Property expected, ignoring record with no properties");
537 strv_clear(match_list
);
541 if (line
[0] != ' ') {
543 match
= strdup(line
);
547 err
= strv_consume(&match_list
, match
);
556 err
= insert_data(trie
, match_list
, line
, filename
, file_priority
, line_number
, compat
);
565 strv_clear(match_list
);
569 if (line
[0] != ' ') {
570 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
571 "Property or empty line expected, got \"%s\", ignoring record", line
);
574 strv_clear(match_list
);
578 err
= insert_data(trie
, match_list
, line
, filename
, file_priority
, line_number
, compat
);
585 if (state
== HW_MATCH
)
586 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
587 "Property expected, ignoring record with no properties");
592 int hwdb_update(const char *root
, const char *hwdb_bin_dir
, bool strict
, bool compat
) {
593 _cleanup_free_
char *hwdb_bin
= NULL
;
594 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
595 _cleanup_strv_free_
char **files
= NULL
;
597 uint16_t file_priority
= 1;
600 /* The argument 'compat' controls the format version of database. If false, then hwdb.bin will be created with
601 * additional information such that priority, line number, and filename of database source. If true, then hwdb.bin
602 * will be created without the information. systemd-hwdb command should set the argument false, and 'udevadm hwdb'
603 * command should set it true. */
605 trie
= new0(struct trie
, 1);
610 trie
->strings
= strbuf_new();
615 trie
->root
= new0(struct trie_node
, 1);
621 err
= conf_files_list_strv(&files
, ".hwdb", root
, 0, conf_file_dirs
);
623 return log_error_errno(err
, "Failed to enumerate hwdb files: %m");
625 STRV_FOREACH(f
, files
) {
626 log_debug("Reading file \"%s\"", *f
);
627 err
= import_file(trie
, *f
, file_priority
++, compat
);
628 if (err
< 0 && strict
)
632 strbuf_complete(trie
->strings
);
634 log_debug("=== trie in-memory ===");
635 log_debug("nodes: %8zu bytes (%8zu)",
636 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
637 log_debug("children arrays: %8zu bytes (%8zu)",
638 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
639 log_debug("values arrays: %8zu bytes (%8zu)",
640 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
641 log_debug("strings: %8zu bytes",
643 log_debug("strings incoming: %8zu bytes (%8zu)",
644 trie
->strings
->in_len
, trie
->strings
->in_count
);
645 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
646 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
648 hwdb_bin
= path_join(root
, hwdb_bin_dir
?: default_hwdb_bin_dir
, "hwdb.bin");
652 mkdir_parents_label(hwdb_bin
, 0755);
653 err
= trie_store(trie
, hwdb_bin
, compat
);
655 return log_error_errno(err
, "Failed to write database %s: %m", hwdb_bin
);
657 err
= label_fix(hwdb_bin
, 0);
664 int hwdb_query(const char *modalias
) {
665 _cleanup_(sd_hwdb_unrefp
) sd_hwdb
*hwdb
= NULL
;
666 const char *key
, *value
;
671 r
= sd_hwdb_new(&hwdb
);
675 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
676 printf("%s=%s\n", key
, value
);