]>
git.proxmox.com Git - systemd.git/blob - src/udev/udevadm-hwdb.c
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/>.
25 #include "alloc-util.h"
26 #include "conf-files.h"
29 #include "hwdb-internal.h"
30 #include "hwdb-util.h"
32 #include "string-util.h"
37 * Generic udev properties, key/value database based on modalias strings.
38 * Uses a Patricia/radix trie to index all matches for efficient lookup.
41 static const char * const conf_file_dirs
[] = {
43 UDEVLIBEXECDIR
"/hwdb.d",
47 /* in-memory trie objects */
49 struct trie_node
*root
;
50 struct strbuf
*strings
;
53 size_t children_count
;
58 /* prefix, common part for all children of this node */
61 /* sorted array of pointers to children nodes */
62 struct trie_child_entry
*children
;
63 uint8_t children_count
;
65 /* sorted array of key/value pairs */
66 struct trie_value_entry
*values
;
70 /* children array item with char (0-255) index */
71 struct trie_child_entry
{
73 struct trie_node
*child
;
76 /* value array item with key/value pairs */
77 struct trie_value_entry
{
82 static int trie_children_cmp(const void *v1
, const void *v2
) {
83 const struct trie_child_entry
*n1
= v1
;
84 const struct trie_child_entry
*n2
= v2
;
89 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
90 struct trie_child_entry
*child
;
92 /* extend array, add new entry, sort for bisection */
93 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
97 node
->children
= child
;
98 trie
->children_count
++;
99 node
->children
[node
->children_count
].c
= c
;
100 node
->children
[node
->children_count
].child
= node_child
;
101 node
->children_count
++;
102 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
108 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
109 struct trie_child_entry
*child
;
110 struct trie_child_entry search
;
113 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
119 static void trie_node_cleanup(struct trie_node
*node
) {
122 for (i
= 0; i
< node
->children_count
; i
++)
123 trie_node_cleanup(node
->children
[i
].child
);
124 free(node
->children
);
129 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
130 const struct trie_value_entry
*val1
= v1
;
131 const struct trie_value_entry
*val2
= v2
;
132 struct trie
*trie
= arg
;
134 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
135 trie
->strings
->buf
+ val2
->key_off
);
138 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
139 const char *key
, const char *value
) {
141 struct trie_value_entry
*val
;
143 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
146 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
150 if (node
->values_count
) {
151 struct trie_value_entry search
= {
156 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
158 /* replace existing earlier key with new value */
164 /* extend array, add new entry, sort for bisection */
165 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
168 trie
->values_count
++;
170 node
->values
[node
->values_count
].key_off
= k
;
171 node
->values
[node
->values_count
].value_off
= v
;
172 node
->values_count
++;
173 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
177 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
178 const char *key
, const char *value
) {
185 struct trie_node
*child
;
187 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
188 _cleanup_free_
char *s
= NULL
;
190 _cleanup_free_
struct trie_node
*new_child
= NULL
;
192 if (c
== search
[i
+ p
])
196 new_child
= new0(struct trie_node
, 1);
200 /* move values from parent to child */
201 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
202 new_child
->children
= node
->children
;
203 new_child
->children_count
= node
->children_count
;
204 new_child
->values
= node
->values
;
205 new_child
->values_count
= node
->values_count
;
207 /* update parent; use strdup() because the source gets realloc()d */
208 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
212 off
= strbuf_add_string(trie
->strings
, s
, p
);
216 node
->prefix_off
= off
;
217 node
->children
= NULL
;
218 node
->children_count
= 0;
220 node
->values_count
= 0;
221 err
= node_add_child(trie
, node
, new_child
, c
);
225 new_child
= NULL
; /* avoid cleanup */
232 return trie_node_add_value(trie
, node
, key
, value
);
234 child
= node_lookup(node
, c
);
239 child
= new0(struct trie_node
, 1);
243 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
249 child
->prefix_off
= off
;
250 err
= node_add_child(trie
, node
, child
, c
);
256 return trie_node_add_value(trie
, child
, key
, value
);
267 uint64_t strings_off
;
269 uint64_t nodes_count
;
270 uint64_t children_count
;
271 uint64_t values_count
;
274 /* calculate the storage space for the nodes, children arrays, value arrays */
275 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
278 for (i
= 0; i
< node
->children_count
; i
++)
279 trie_store_nodes_size(trie
, node
->children
[i
].child
);
281 trie
->strings_off
+= sizeof(struct trie_node_f
);
282 for (i
= 0; i
< node
->children_count
; i
++)
283 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
284 for (i
= 0; i
< node
->values_count
; i
++)
285 trie
->strings_off
+= sizeof(struct trie_value_entry_f
);
288 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
290 struct trie_node_f n
= {
291 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
292 .children_count
= node
->children_count
,
293 .values_count
= htole64(node
->values_count
),
295 struct trie_child_entry_f
*children
= NULL
;
298 if (node
->children_count
) {
299 children
= new0(struct trie_child_entry_f
, node
->children_count
);
304 /* post-order recursion */
305 for (i
= 0; i
< node
->children_count
; i
++) {
308 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
313 children
[i
].c
= node
->children
[i
].c
;
314 children
[i
].child_off
= htole64(child_off
);
318 node_off
= ftello(trie
->f
);
319 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
322 /* append children array */
323 if (node
->children_count
) {
324 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
325 trie
->children_count
+= node
->children_count
;
329 /* append values array */
330 for (i
= 0; i
< node
->values_count
; i
++) {
331 struct trie_value_entry_f v
= {
332 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
333 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
336 fwrite(&v
, sizeof(struct trie_value_entry_f
), 1, trie
->f
);
337 trie
->values_count
++;
343 static int trie_store(struct trie
*trie
, const char *filename
) {
347 _cleanup_free_
char *filename_tmp
= NULL
;
351 struct trie_header_f h
= {
352 .signature
= HWDB_SIG
,
353 .tool_version
= htole64(atoi(VERSION
)),
354 .header_size
= htole64(sizeof(struct trie_header_f
)),
355 .node_size
= htole64(sizeof(struct trie_node_f
)),
356 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
357 .value_entry_size
= htole64(sizeof(struct trie_value_entry_f
)),
361 /* calculate size of header, nodes, children entries, value entries */
362 t
.strings_off
= sizeof(struct trie_header_f
);
363 trie_store_nodes_size(&t
, trie
->root
);
365 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
368 fchmod(fileno(t
.f
), 0444);
371 err
= fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
);
374 unlink_noerrno(filename_tmp
);
377 root_off
= trie_store_nodes(&t
, trie
->root
);
378 h
.nodes_root_off
= htole64(root_off
);
380 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
382 /* write string buffer */
383 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
384 h
.strings_len
= htole64(trie
->strings
->len
);
388 h
.file_size
= htole64(size
);
389 err
= fseeko(t
.f
, 0, SEEK_SET
);
392 unlink_noerrno(filename_tmp
);
395 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
400 if (err
< 0 || rename(filename_tmp
, filename
) < 0) {
401 unlink_noerrno(filename_tmp
);
402 return err
< 0 ? err
: -errno
;
405 log_debug("=== trie on-disk ===");
406 log_debug("size: %8"PRIi64
" bytes", size
);
407 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
408 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
409 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
410 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
411 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
412 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
413 t
.values_count
* sizeof(struct trie_value_entry_f
), t
.values_count
);
414 log_debug("string store: %8zu bytes", trie
->strings
->len
);
415 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
420 static int insert_data(struct trie
*trie
, struct udev_list
*match_list
,
421 char *line
, const char *filename
) {
423 struct udev_list_entry
*entry
;
425 value
= strchr(line
, '=');
427 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
434 /* libudev requires properties to start with a space */
435 while (isblank(line
[0]) && isblank(line
[1]))
438 if (line
[0] == '\0' || value
[0] == '\0') {
439 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
443 udev_list_entry_foreach(entry
, udev_list_get_entry(match_list
))
444 trie_insert(trie
, trie
->root
, udev_list_entry_get_name(entry
), line
, value
);
449 static int import_file(struct udev
*udev
, struct trie
*trie
, const char *filename
) {
457 struct udev_list match_list
;
459 udev_list_init(udev
, &match_list
, false);
461 f
= fopen(filename
, "re");
465 while (fgets(line
, sizeof(line
), f
)) {
473 /* strip trailing comment */
474 pos
= strchr(line
, '#');
478 /* strip trailing whitespace */
480 while (len
> 0 && isspace(line
[len
-1]))
489 if (line
[0] == ' ') {
490 log_error("Error, MATCH expected but got '%s' in '%s':", line
, filename
);
494 /* start of record, first match */
496 udev_list_entry_add(&match_list
, line
, NULL
);
501 log_error("Error, DATA expected but got empty line in '%s':", filename
);
503 udev_list_cleanup(&match_list
);
508 if (line
[0] != ' ') {
509 udev_list_entry_add(&match_list
, line
, NULL
);
515 insert_data(trie
, &match_list
, line
, filename
);
522 udev_list_cleanup(&match_list
);
526 if (line
[0] != ' ') {
527 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
529 udev_list_cleanup(&match_list
);
533 insert_data(trie
, &match_list
, line
, filename
);
539 udev_list_cleanup(&match_list
);
543 static void help(void) {
544 printf("Usage: udevadm hwdb OPTIONS\n"
545 " -u,--update update the hardware database\n"
546 " --usr generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
547 " -t,--test=MODALIAS query database and print result\n"
548 " -r,--root=PATH alternative root path in the filesystem\n"
552 static int adm_hwdb(struct udev
*udev
, int argc
, char *argv
[]) {
557 static const struct option options
[] = {
558 { "update", no_argument
, NULL
, 'u' },
559 { "usr", no_argument
, NULL
, ARG_USR
},
560 { "test", required_argument
, NULL
, 't' },
561 { "root", required_argument
, NULL
, 'r' },
562 { "help", no_argument
, NULL
, 'h' },
565 const char *test
= NULL
;
566 const char *root
= "";
567 const char *hwdb_bin_dir
= "/etc/udev";
569 struct trie
*trie
= NULL
;
571 int rc
= EXIT_SUCCESS
;
573 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0)
579 hwdb_bin_dir
= UDEVLIBEXECDIR
;
593 assert_not_reached("Unknown option");
596 if (!update
&& !test
) {
597 log_error("Either --update or --test must be used");
603 _cleanup_free_
char *hwdb_bin
= NULL
;
605 trie
= new0(struct trie
, 1);
612 trie
->strings
= strbuf_new();
613 if (!trie
->strings
) {
619 trie
->root
= new0(struct trie_node
, 1);
626 err
= conf_files_list_strv(&files
, ".hwdb", root
, conf_file_dirs
);
628 log_error_errno(err
, "failed to enumerate hwdb files: %m");
632 STRV_FOREACH(f
, files
) {
633 log_debug("reading file '%s'", *f
);
634 import_file(udev
, trie
, *f
);
638 strbuf_complete(trie
->strings
);
640 log_debug("=== trie in-memory ===");
641 log_debug("nodes: %8zu bytes (%8zu)",
642 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
643 log_debug("children arrays: %8zu bytes (%8zu)",
644 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
645 log_debug("values arrays: %8zu bytes (%8zu)",
646 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
647 log_debug("strings: %8zu bytes",
649 log_debug("strings incoming: %8zu bytes (%8zu)",
650 trie
->strings
->in_len
, trie
->strings
->in_count
);
651 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
652 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
654 hwdb_bin
= strjoin(root
, "/", hwdb_bin_dir
, "/hwdb.bin", NULL
);
659 mkdir_parents(hwdb_bin
, 0755);
660 err
= trie_store(trie
, hwdb_bin
);
662 log_error_errno(err
, "Failure writing database %s: %m", hwdb_bin
);
668 _cleanup_(sd_hwdb_unrefp
) sd_hwdb
*hwdb
= NULL
;
671 r
= sd_hwdb_new(&hwdb
);
673 const char *key
, *value
;
675 SD_HWDB_FOREACH_PROPERTY(hwdb
, test
, key
, value
)
676 printf("%s=%s\n", key
, value
);
682 trie_node_cleanup(trie
->root
);
683 strbuf_cleanup(trie
->strings
);
689 const struct udevadm_cmd udevadm_hwdb
= {