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"
29 #include "hwdb-internal.h"
30 #include "hwdb-util.h"
33 #include "string-util.h"
39 * Generic udev properties, key/value database based on modalias strings.
40 * Uses a Patricia/radix trie to index all matches for efficient lookup.
43 static const char *arg_hwdb_bin_dir
= "/etc/udev";
44 static const char *arg_root
= "";
46 static const char * const conf_file_dirs
[] = {
48 UDEVLIBEXECDIR
"/hwdb.d",
52 /* in-memory trie objects */
54 struct trie_node
*root
;
55 struct strbuf
*strings
;
58 size_t children_count
;
63 /* prefix, common part for all children of this node */
66 /* sorted array of pointers to children nodes */
67 struct trie_child_entry
*children
;
68 uint8_t children_count
;
70 /* sorted array of key/value pairs */
71 struct trie_value_entry
*values
;
75 /* children array item with char (0-255) index */
76 struct trie_child_entry
{
78 struct trie_node
*child
;
81 /* value array item with key/value pairs */
82 struct trie_value_entry
{
87 static int trie_children_cmp(const void *v1
, const void *v2
) {
88 const struct trie_child_entry
*n1
= v1
;
89 const struct trie_child_entry
*n2
= v2
;
94 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
95 struct trie_child_entry
*child
;
97 /* extend array, add new entry, sort for bisection */
98 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
102 node
->children
= child
;
103 trie
->children_count
++;
104 node
->children
[node
->children_count
].c
= c
;
105 node
->children
[node
->children_count
].child
= node_child
;
106 node
->children_count
++;
107 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
113 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
114 struct trie_child_entry
*child
;
115 struct trie_child_entry search
;
118 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
124 static void trie_node_cleanup(struct trie_node
*node
) {
127 for (i
= 0; i
< node
->children_count
; i
++)
128 trie_node_cleanup(node
->children
[i
].child
);
129 free(node
->children
);
134 static void trie_free(struct trie
*trie
) {
139 trie_node_cleanup(trie
->root
);
141 strbuf_cleanup(trie
->strings
);
145 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
147 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
148 const struct trie_value_entry
*val1
= v1
;
149 const struct trie_value_entry
*val2
= v2
;
150 struct trie
*trie
= arg
;
152 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
153 trie
->strings
->buf
+ val2
->key_off
);
156 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
157 const char *key
, const char *value
) {
159 struct trie_value_entry
*val
;
161 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
164 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
168 if (node
->values_count
) {
169 struct trie_value_entry search
= {
174 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
176 /* replace existing earlier key with new value */
182 /* extend array, add new entry, sort for bisection */
183 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
186 trie
->values_count
++;
188 node
->values
[node
->values_count
].key_off
= k
;
189 node
->values
[node
->values_count
].value_off
= v
;
190 node
->values_count
++;
191 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
195 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
196 const char *key
, const char *value
) {
203 struct trie_node
*child
;
205 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
206 _cleanup_free_
char *s
= NULL
;
208 _cleanup_free_
struct trie_node
*new_child
= NULL
;
210 if (c
== search
[i
+ p
])
214 new_child
= new0(struct trie_node
, 1);
218 /* move values from parent to child */
219 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
220 new_child
->children
= node
->children
;
221 new_child
->children_count
= node
->children_count
;
222 new_child
->values
= node
->values
;
223 new_child
->values_count
= node
->values_count
;
225 /* update parent; use strdup() because the source gets realloc()d */
226 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
230 off
= strbuf_add_string(trie
->strings
, s
, p
);
234 node
->prefix_off
= off
;
235 node
->children
= NULL
;
236 node
->children_count
= 0;
238 node
->values_count
= 0;
239 err
= node_add_child(trie
, node
, new_child
, c
);
243 new_child
= NULL
; /* avoid cleanup */
250 return trie_node_add_value(trie
, node
, key
, value
);
252 child
= node_lookup(node
, c
);
257 child
= new0(struct trie_node
, 1);
261 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
267 child
->prefix_off
= off
;
268 err
= node_add_child(trie
, node
, child
, c
);
274 return trie_node_add_value(trie
, child
, key
, value
);
285 uint64_t strings_off
;
287 uint64_t nodes_count
;
288 uint64_t children_count
;
289 uint64_t values_count
;
292 /* calculate the storage space for the nodes, children arrays, value arrays */
293 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
296 for (i
= 0; i
< node
->children_count
; i
++)
297 trie_store_nodes_size(trie
, node
->children
[i
].child
);
299 trie
->strings_off
+= sizeof(struct trie_node_f
);
300 for (i
= 0; i
< node
->children_count
; i
++)
301 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
302 for (i
= 0; i
< node
->values_count
; i
++)
303 trie
->strings_off
+= sizeof(struct trie_value_entry_f
);
306 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
308 struct trie_node_f n
= {
309 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
310 .children_count
= node
->children_count
,
311 .values_count
= htole64(node
->values_count
),
313 struct trie_child_entry_f
*children
= NULL
;
316 if (node
->children_count
) {
317 children
= new0(struct trie_child_entry_f
, node
->children_count
);
322 /* post-order recursion */
323 for (i
= 0; i
< node
->children_count
; i
++) {
326 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
331 children
[i
].c
= node
->children
[i
].c
;
332 children
[i
].child_off
= htole64(child_off
);
336 node_off
= ftello(trie
->f
);
337 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
340 /* append children array */
341 if (node
->children_count
) {
342 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
343 trie
->children_count
+= node
->children_count
;
347 /* append values array */
348 for (i
= 0; i
< node
->values_count
; i
++) {
349 struct trie_value_entry_f v
= {
350 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
351 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
354 fwrite(&v
, sizeof(struct trie_value_entry_f
), 1, trie
->f
);
355 trie
->values_count
++;
361 static int trie_store(struct trie
*trie
, const char *filename
) {
365 _cleanup_free_
char *filename_tmp
= NULL
;
369 struct trie_header_f h
= {
370 .signature
= HWDB_SIG
,
371 .tool_version
= htole64(atoi(VERSION
)),
372 .header_size
= htole64(sizeof(struct trie_header_f
)),
373 .node_size
= htole64(sizeof(struct trie_node_f
)),
374 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
375 .value_entry_size
= htole64(sizeof(struct trie_value_entry_f
)),
379 /* calculate size of header, nodes, children entries, value entries */
380 t
.strings_off
= sizeof(struct trie_header_f
);
381 trie_store_nodes_size(&t
, trie
->root
);
383 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
386 fchmod(fileno(t
.f
), 0444);
389 err
= fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
);
392 unlink_noerrno(filename_tmp
);
395 root_off
= trie_store_nodes(&t
, trie
->root
);
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, t
.f
);
402 h
.strings_len
= htole64(trie
->strings
->len
);
406 h
.file_size
= htole64(size
);
407 err
= fseeko(t
.f
, 0, SEEK_SET
);
410 unlink_noerrno(filename_tmp
);
413 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
418 if (err
< 0 || rename(filename_tmp
, filename
) < 0) {
419 unlink_noerrno(filename_tmp
);
420 return err
< 0 ? err
: -errno
;
423 log_debug("=== trie on-disk ===");
424 log_debug("size: %8"PRIi64
" bytes", size
);
425 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
426 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
427 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
428 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
429 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
430 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
431 t
.values_count
* sizeof(struct trie_value_entry_f
), t
.values_count
);
432 log_debug("string store: %8zu bytes", trie
->strings
->len
);
433 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
438 static int insert_data(struct trie
*trie
, char **match_list
, char *line
, const char *filename
) {
439 char *value
, **entry
;
441 value
= strchr(line
, '=');
443 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
450 /* libudev requires properties to start with a space */
451 while (isblank(line
[0]) && isblank(line
[1]))
454 if (line
[0] == '\0' || value
[0] == '\0') {
455 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
459 STRV_FOREACH(entry
, match_list
)
460 trie_insert(trie
, trie
->root
, *entry
, line
, value
);
465 static int import_file(struct trie
*trie
, const char *filename
) {
471 _cleanup_fclose_
FILE *f
= NULL
;
473 _cleanup_strv_free_
char **match_list
= NULL
;
477 f
= fopen(filename
, "re");
481 while (fgets(line
, sizeof(line
), f
)) {
489 /* strip trailing comment */
490 pos
= strchr(line
, '#');
494 /* strip trailing whitespace */
496 while (len
> 0 && isspace(line
[len
-1]))
505 if (line
[0] == ' ') {
506 log_error("Error, MATCH expected but got '%s' in '%s':", line
, filename
);
510 /* start of record, first match */
513 match
= strdup(line
);
517 r
= strv_consume(&match_list
, match
);
525 log_error("Error, DATA expected but got empty line in '%s':", filename
);
527 strv_clear(match_list
);
532 if (line
[0] != ' ') {
533 match
= strdup(line
);
537 r
= strv_consume(&match_list
, match
);
546 insert_data(trie
, match_list
, line
, filename
);
553 strv_clear(match_list
);
557 if (line
[0] != ' ') {
558 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
560 strv_clear(match_list
);
564 insert_data(trie
, match_list
, line
, filename
);
572 static int hwdb_query(int argc
, char *argv
[], void *userdata
) {
573 _cleanup_hwdb_unref_ sd_hwdb
*hwdb
= NULL
;
574 const char *key
, *value
;
575 const char *modalias
;
583 r
= sd_hwdb_new(&hwdb
);
587 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
588 printf("%s=%s\n", key
, value
);
593 static int hwdb_update(int argc
, char *argv
[], void *userdata
) {
594 _cleanup_free_
char *hwdb_bin
= NULL
;
595 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
599 trie
= new0(struct trie
, 1);
604 trie
->strings
= strbuf_new();
609 trie
->root
= new0(struct trie_node
, 1);
615 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, conf_file_dirs
);
617 return log_error_errno(r
, "failed to enumerate hwdb files: %m");
619 STRV_FOREACH(f
, files
) {
620 log_debug("reading file '%s'", *f
);
621 import_file(trie
, *f
);
625 strbuf_complete(trie
->strings
);
627 log_debug("=== trie in-memory ===");
628 log_debug("nodes: %8zu bytes (%8zu)",
629 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
630 log_debug("children arrays: %8zu bytes (%8zu)",
631 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
632 log_debug("values arrays: %8zu bytes (%8zu)",
633 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
634 log_debug("strings: %8zu bytes",
636 log_debug("strings incoming: %8zu bytes (%8zu)",
637 trie
->strings
->in_len
, trie
->strings
->in_count
);
638 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
639 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
641 hwdb_bin
= strjoin(arg_root
, "/", arg_hwdb_bin_dir
, "/hwdb.bin", NULL
);
645 mkdir_parents(hwdb_bin
, 0755);
646 r
= trie_store(trie
, hwdb_bin
);
648 return log_error_errno(r
, "Failure writing database %s: %m", hwdb_bin
);
653 static void help(void) {
654 printf("Usage: %s OPTIONS COMMAND\n\n"
655 "Update or query the hardware database.\n\n"
656 " -h --help Show this help\n"
657 " --version Show package version\n"
658 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
659 " -r --root=PATH Alternative root path in the filesystem\n\n"
661 " update Update the hwdb database\n"
662 " query MODALIAS Query database and print result\n",
663 program_invocation_short_name
);
666 static int parse_argv(int argc
, char *argv
[]) {
672 static const struct option options
[] = {
673 { "help", no_argument
, NULL
, 'h' },
674 { "version", no_argument
, NULL
, ARG_VERSION
},
675 { "usr", no_argument
, NULL
, ARG_USR
},
676 { "root", required_argument
, NULL
, 'r' },
685 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0) {
696 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
707 assert_not_reached("Unknown option");
714 static int hwdb_main(int argc
, char *argv
[]) {
715 const Verb verbs
[] = {
716 { "update", 1, 1, 0, hwdb_update
},
717 { "query", 2, 2, 0, hwdb_query
},
721 return dispatch_verb(argc
, argv
, verbs
, NULL
);
724 int main (int argc
, char *argv
[]) {
727 log_parse_environment();
730 r
= parse_argv(argc
, argv
);
734 r
= hwdb_main(argc
, argv
);
737 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;