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 "conf-files.h"
26 #include "hwdb-internal.h"
27 #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 *arg_hwdb_bin_dir
= "/etc/udev";
40 static const char *arg_root
= "";
42 static const char * const conf_file_dirs
[] = {
44 UDEVLIBEXECDIR
"/hwdb.d",
48 /* in-memory trie objects */
50 struct trie_node
*root
;
51 struct strbuf
*strings
;
54 size_t children_count
;
59 /* prefix, common part for all children of this node */
62 /* sorted array of pointers to children nodes */
63 struct trie_child_entry
*children
;
64 uint8_t children_count
;
66 /* sorted array of key/value pairs */
67 struct trie_value_entry
*values
;
71 /* children array item with char (0-255) index */
72 struct trie_child_entry
{
74 struct trie_node
*child
;
77 /* value array item with key/value pairs */
78 struct trie_value_entry
{
83 static int trie_children_cmp(const void *v1
, const void *v2
) {
84 const struct trie_child_entry
*n1
= v1
;
85 const struct trie_child_entry
*n2
= v2
;
90 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
91 struct trie_child_entry
*child
;
93 /* extend array, add new entry, sort for bisection */
94 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
98 node
->children
= child
;
99 trie
->children_count
++;
100 node
->children
[node
->children_count
].c
= c
;
101 node
->children
[node
->children_count
].child
= node_child
;
102 node
->children_count
++;
103 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
109 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
110 struct trie_child_entry
*child
;
111 struct trie_child_entry search
;
114 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
120 static void trie_node_cleanup(struct trie_node
*node
) {
123 for (i
= 0; i
< node
->children_count
; i
++)
124 trie_node_cleanup(node
->children
[i
].child
);
125 free(node
->children
);
130 static void trie_free(struct trie
*trie
) {
135 trie_node_cleanup(trie
->root
);
137 strbuf_cleanup(trie
->strings
);
141 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
143 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
144 const struct trie_value_entry
*val1
= v1
;
145 const struct trie_value_entry
*val2
= v2
;
146 struct trie
*trie
= arg
;
148 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
149 trie
->strings
->buf
+ val2
->key_off
);
152 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
153 const char *key
, const char *value
) {
155 struct trie_value_entry
*val
;
157 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
160 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
164 if (node
->values_count
) {
165 struct trie_value_entry search
= {
170 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
172 /* replace existing earlier key with new value */
178 /* extend array, add new entry, sort for bisection */
179 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
182 trie
->values_count
++;
184 node
->values
[node
->values_count
].key_off
= k
;
185 node
->values
[node
->values_count
].value_off
= v
;
186 node
->values_count
++;
187 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
191 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
192 const char *key
, const char *value
) {
199 struct trie_node
*child
;
201 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
202 _cleanup_free_
char *s
= NULL
;
204 _cleanup_free_
struct trie_node
*new_child
= NULL
;
206 if (c
== search
[i
+ p
])
210 new_child
= new0(struct trie_node
, 1);
214 /* move values from parent to child */
215 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
216 new_child
->children
= node
->children
;
217 new_child
->children_count
= node
->children_count
;
218 new_child
->values
= node
->values
;
219 new_child
->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
->prefix_off
= off
;
231 node
->children
= NULL
;
232 node
->children_count
= 0;
234 node
->values_count
= 0;
235 err
= node_add_child(trie
, node
, new_child
, c
);
239 new_child
= NULL
; /* avoid cleanup */
246 return trie_node_add_value(trie
, node
, key
, value
);
248 child
= node_lookup(node
, c
);
253 child
= new0(struct trie_node
, 1);
257 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
263 child
->prefix_off
= off
;
264 err
= node_add_child(trie
, node
, child
, c
);
270 return trie_node_add_value(trie
, child
, key
, value
);
281 uint64_t strings_off
;
283 uint64_t nodes_count
;
284 uint64_t children_count
;
285 uint64_t values_count
;
288 /* calculate the storage space for the nodes, children arrays, value arrays */
289 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
292 for (i
= 0; i
< node
->children_count
; i
++)
293 trie_store_nodes_size(trie
, node
->children
[i
].child
);
295 trie
->strings_off
+= sizeof(struct trie_node_f
);
296 for (i
= 0; i
< node
->children_count
; i
++)
297 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
298 for (i
= 0; i
< node
->values_count
; i
++)
299 trie
->strings_off
+= sizeof(struct trie_value_entry_f
);
302 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
304 struct trie_node_f n
= {
305 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
306 .children_count
= node
->children_count
,
307 .values_count
= htole64(node
->values_count
),
309 struct trie_child_entry_f
*children
= NULL
;
312 if (node
->children_count
) {
313 children
= new0(struct trie_child_entry_f
, node
->children_count
);
318 /* post-order recursion */
319 for (i
= 0; i
< node
->children_count
; i
++) {
322 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
327 children
[i
].c
= node
->children
[i
].c
;
328 children
[i
].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
;
343 /* append values array */
344 for (i
= 0; i
< node
->values_count
; i
++) {
345 struct trie_value_entry_f v
= {
346 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
347 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
350 fwrite(&v
, sizeof(struct trie_value_entry_f
), 1, trie
->f
);
351 trie
->values_count
++;
357 static int trie_store(struct trie
*trie
, const char *filename
) {
361 _cleanup_free_
char *filename_tmp
= NULL
;
365 struct trie_header_f h
= {
366 .signature
= HWDB_SIG
,
367 .tool_version
= htole64(atoi(VERSION
)),
368 .header_size
= htole64(sizeof(struct trie_header_f
)),
369 .node_size
= htole64(sizeof(struct trie_node_f
)),
370 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
371 .value_entry_size
= htole64(sizeof(struct trie_value_entry_f
)),
375 /* calculate size of header, nodes, children entries, value entries */
376 t
.strings_off
= sizeof(struct trie_header_f
);
377 trie_store_nodes_size(&t
, trie
->root
);
379 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
382 fchmod(fileno(t
.f
), 0444);
385 err
= fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
);
388 unlink_noerrno(filename_tmp
);
391 root_off
= trie_store_nodes(&t
, trie
->root
);
392 h
.nodes_root_off
= htole64(root_off
);
394 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
396 /* write string buffer */
397 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
398 h
.strings_len
= htole64(trie
->strings
->len
);
402 h
.file_size
= htole64(size
);
403 err
= fseeko(t
.f
, 0, SEEK_SET
);
406 unlink_noerrno(filename_tmp
);
409 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
414 if (err
< 0 || rename(filename_tmp
, filename
) < 0) {
415 unlink_noerrno(filename_tmp
);
416 return err
< 0 ? err
: -errno
;
419 log_debug("=== trie on-disk ===");
420 log_debug("size: %8"PRIi64
" bytes", size
);
421 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
422 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
423 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
424 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
425 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
426 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
427 t
.values_count
* sizeof(struct trie_value_entry_f
), t
.values_count
);
428 log_debug("string store: %8zu bytes", trie
->strings
->len
);
429 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
434 static int insert_data(struct trie
*trie
, char **match_list
, char *line
, const char *filename
) {
435 char *value
, **entry
;
437 value
= strchr(line
, '=');
439 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
446 /* libudev requires properties to start with a space */
447 while (isblank(line
[0]) && isblank(line
[1]))
450 if (line
[0] == '\0' || value
[0] == '\0') {
451 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
455 STRV_FOREACH(entry
, match_list
)
456 trie_insert(trie
, trie
->root
, *entry
, line
, value
);
461 static int import_file(struct trie
*trie
, const char *filename
) {
467 _cleanup_fclose_
FILE *f
= NULL
;
469 _cleanup_strv_free_
char **match_list
= NULL
;
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
);
506 /* start of record, first match */
509 match
= strdup(line
);
513 r
= strv_consume(&match_list
, match
);
521 log_error("Error, DATA expected but got empty line in '%s':", filename
);
523 strv_clear(match_list
);
528 if (line
[0] != ' ') {
529 match
= strdup(line
);
533 r
= strv_consume(&match_list
, match
);
542 insert_data(trie
, match_list
, line
, filename
);
549 strv_clear(match_list
);
553 if (line
[0] != ' ') {
554 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
556 strv_clear(match_list
);
560 insert_data(trie
, match_list
, line
, filename
);
568 static int hwdb_query(int argc
, char *argv
[], void *userdata
) {
569 _cleanup_hwdb_unref_ sd_hwdb
*hwdb
= NULL
;
570 const char *key
, *value
;
571 const char *modalias
;
579 r
= sd_hwdb_new(&hwdb
);
583 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
584 printf("%s=%s\n", key
, value
);
589 static int hwdb_update(int argc
, char *argv
[], void *userdata
) {
590 _cleanup_free_
char *hwdb_bin
= NULL
;
591 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
595 trie
= new0(struct trie
, 1);
600 trie
->strings
= strbuf_new();
605 trie
->root
= new0(struct trie_node
, 1);
611 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, conf_file_dirs
);
613 return log_error_errno(r
, "failed to enumerate hwdb files: %m");
615 STRV_FOREACH(f
, files
) {
616 log_debug("reading file '%s'", *f
);
617 import_file(trie
, *f
);
621 strbuf_complete(trie
->strings
);
623 log_debug("=== trie in-memory ===");
624 log_debug("nodes: %8zu bytes (%8zu)",
625 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
626 log_debug("children arrays: %8zu bytes (%8zu)",
627 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
628 log_debug("values arrays: %8zu bytes (%8zu)",
629 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
630 log_debug("strings: %8zu bytes",
632 log_debug("strings incoming: %8zu bytes (%8zu)",
633 trie
->strings
->in_len
, trie
->strings
->in_count
);
634 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
635 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
637 hwdb_bin
= strjoin(arg_root
, "/", arg_hwdb_bin_dir
, "/hwdb.bin", NULL
);
641 mkdir_parents(hwdb_bin
, 0755);
642 r
= trie_store(trie
, hwdb_bin
);
644 return log_error_errno(r
, "Failure writing database %s: %m", hwdb_bin
);
649 static void help(void) {
650 printf("Usage: %s OPTIONS COMMAND\n\n"
651 "Update or query the hardware database.\n\n"
652 " -h --help Show this help\n"
653 " --version Show package version\n"
654 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
655 " -r --root=PATH Alternative root path in the filesystem\n\n"
657 " update Update the hwdb database\n"
658 " query MODALIAS Query database and print result\n",
659 program_invocation_short_name
);
662 static int parse_argv(int argc
, char *argv
[]) {
668 static const struct option options
[] = {
669 { "help", no_argument
, NULL
, 'h' },
670 { "version", no_argument
, NULL
, ARG_VERSION
},
671 { "usr", no_argument
, NULL
, ARG_USR
},
672 { "root", required_argument
, NULL
, 'r' },
681 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0) {
692 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
703 assert_not_reached("Unknown option");
710 static int hwdb_main(int argc
, char *argv
[]) {
711 const Verb verbs
[] = {
712 { "update", 1, 1, 0, hwdb_update
},
713 { "query", 2, 2, 0, hwdb_query
},
717 return dispatch_verb(argc
, argv
, verbs
, NULL
);
720 int main (int argc
, char *argv
[]) {
723 log_parse_environment();
726 r
= parse_argv(argc
, argv
);
730 r
= hwdb_main(argc
, argv
);
733 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;