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"
30 #include "hwdb-internal.h"
31 #include "hwdb-util.h"
34 #include "selinux-util.h"
36 #include "string-util.h"
42 * Generic udev properties, key/value database based on modalias strings.
43 * Uses a Patricia/radix trie to index all matches for efficient lookup.
46 static const char *arg_hwdb_bin_dir
= "/etc/udev";
47 static const char *arg_root
= "";
49 static const char * const conf_file_dirs
[] = {
51 UDEVLIBEXECDIR
"/hwdb.d",
55 /* in-memory trie objects */
57 struct trie_node
*root
;
58 struct strbuf
*strings
;
61 size_t children_count
;
66 /* prefix, common part for all children of this node */
69 /* sorted array of pointers to children nodes */
70 struct trie_child_entry
*children
;
71 uint8_t children_count
;
73 /* sorted array of key/value pairs */
74 struct trie_value_entry
*values
;
78 /* children array item with char (0-255) index */
79 struct trie_child_entry
{
81 struct trie_node
*child
;
84 /* value array item with key/value pairs */
85 struct trie_value_entry
{
90 static int trie_children_cmp(const void *v1
, const void *v2
) {
91 const struct trie_child_entry
*n1
= v1
;
92 const struct trie_child_entry
*n2
= v2
;
97 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
98 struct trie_child_entry
*child
;
100 /* extend array, add new entry, sort for bisection */
101 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
105 node
->children
= child
;
106 trie
->children_count
++;
107 node
->children
[node
->children_count
].c
= c
;
108 node
->children
[node
->children_count
].child
= node_child
;
109 node
->children_count
++;
110 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
116 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
117 struct trie_child_entry
*child
;
118 struct trie_child_entry search
;
121 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
127 static void trie_node_cleanup(struct trie_node
*node
) {
130 for (i
= 0; i
< node
->children_count
; i
++)
131 trie_node_cleanup(node
->children
[i
].child
);
132 free(node
->children
);
137 static void trie_free(struct trie
*trie
) {
142 trie_node_cleanup(trie
->root
);
144 strbuf_cleanup(trie
->strings
);
148 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
150 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
151 const struct trie_value_entry
*val1
= v1
;
152 const struct trie_value_entry
*val2
= v2
;
153 struct trie
*trie
= arg
;
155 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
156 trie
->strings
->buf
+ val2
->key_off
);
159 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
160 const char *key
, const char *value
) {
162 struct trie_value_entry
*val
;
164 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
167 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
171 if (node
->values_count
) {
172 struct trie_value_entry search
= {
177 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
179 /* replace existing earlier key with new value */
185 /* extend array, add new entry, sort for bisection */
186 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
189 trie
->values_count
++;
191 node
->values
[node
->values_count
].key_off
= k
;
192 node
->values
[node
->values_count
].value_off
= v
;
193 node
->values_count
++;
194 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
198 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
199 const char *key
, const char *value
) {
206 struct trie_node
*child
;
208 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
209 _cleanup_free_
char *s
= NULL
;
211 _cleanup_free_
struct trie_node
*new_child
= NULL
;
213 if (c
== search
[i
+ p
])
217 new_child
= new0(struct trie_node
, 1);
221 /* move values from parent to child */
222 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
223 new_child
->children
= node
->children
;
224 new_child
->children_count
= node
->children_count
;
225 new_child
->values
= node
->values
;
226 new_child
->values_count
= node
->values_count
;
228 /* update parent; use strdup() because the source gets realloc()d */
229 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
233 off
= strbuf_add_string(trie
->strings
, s
, p
);
237 node
->prefix_off
= off
;
238 node
->children
= NULL
;
239 node
->children_count
= 0;
241 node
->values_count
= 0;
242 err
= node_add_child(trie
, node
, new_child
, c
);
246 new_child
= NULL
; /* avoid cleanup */
253 return trie_node_add_value(trie
, node
, key
, value
);
255 child
= node_lookup(node
, c
);
260 child
= new0(struct trie_node
, 1);
264 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
270 child
->prefix_off
= off
;
271 err
= node_add_child(trie
, node
, child
, c
);
277 return trie_node_add_value(trie
, child
, key
, value
);
288 uint64_t strings_off
;
290 uint64_t nodes_count
;
291 uint64_t children_count
;
292 uint64_t values_count
;
295 /* calculate the storage space for the nodes, children arrays, value arrays */
296 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
299 for (i
= 0; i
< node
->children_count
; i
++)
300 trie_store_nodes_size(trie
, node
->children
[i
].child
);
302 trie
->strings_off
+= sizeof(struct trie_node_f
);
303 for (i
= 0; i
< node
->children_count
; i
++)
304 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
305 for (i
= 0; i
< node
->values_count
; i
++)
306 trie
->strings_off
+= sizeof(struct trie_value_entry_f
);
309 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
311 struct trie_node_f n
= {
312 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
313 .children_count
= node
->children_count
,
314 .values_count
= htole64(node
->values_count
),
316 struct trie_child_entry_f
*children
= NULL
;
319 if (node
->children_count
) {
320 children
= new0(struct trie_child_entry_f
, node
->children_count
);
325 /* post-order recursion */
326 for (i
= 0; i
< node
->children_count
; i
++) {
329 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
334 children
[i
].c
= node
->children
[i
].c
;
335 children
[i
].child_off
= htole64(child_off
);
339 node_off
= ftello(trie
->f
);
340 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
343 /* append children array */
344 if (node
->children_count
) {
345 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
346 trie
->children_count
+= node
->children_count
;
350 /* append values array */
351 for (i
= 0; i
< node
->values_count
; i
++) {
352 struct trie_value_entry_f v
= {
353 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
354 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
357 fwrite(&v
, sizeof(struct trie_value_entry_f
), 1, trie
->f
);
358 trie
->values_count
++;
364 static int trie_store(struct trie
*trie
, const char *filename
) {
368 _cleanup_free_
char *filename_tmp
= NULL
;
372 struct trie_header_f h
= {
373 .signature
= HWDB_SIG
,
374 .tool_version
= htole64(atoi(VERSION
)),
375 .header_size
= htole64(sizeof(struct trie_header_f
)),
376 .node_size
= htole64(sizeof(struct trie_node_f
)),
377 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
378 .value_entry_size
= htole64(sizeof(struct trie_value_entry_f
)),
382 /* calculate size of header, nodes, children entries, value entries */
383 t
.strings_off
= sizeof(struct trie_header_f
);
384 trie_store_nodes_size(&t
, trie
->root
);
386 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
389 fchmod(fileno(t
.f
), 0444);
392 err
= fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
);
395 unlink_noerrno(filename_tmp
);
398 root_off
= trie_store_nodes(&t
, trie
->root
);
399 h
.nodes_root_off
= htole64(root_off
);
401 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
403 /* write string buffer */
404 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
405 h
.strings_len
= htole64(trie
->strings
->len
);
409 h
.file_size
= htole64(size
);
410 err
= fseeko(t
.f
, 0, SEEK_SET
);
413 unlink_noerrno(filename_tmp
);
416 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
421 if (err
< 0 || rename(filename_tmp
, filename
) < 0) {
422 unlink_noerrno(filename_tmp
);
423 return err
< 0 ? err
: -errno
;
426 log_debug("=== trie on-disk ===");
427 log_debug("size: %8"PRIi64
" bytes", size
);
428 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
429 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
430 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
431 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
432 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
433 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
434 t
.values_count
* sizeof(struct trie_value_entry_f
), t
.values_count
);
435 log_debug("string store: %8zu bytes", trie
->strings
->len
);
436 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
441 static int insert_data(struct trie
*trie
, char **match_list
, char *line
, const char *filename
) {
442 char *value
, **entry
;
444 value
= strchr(line
, '=');
446 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
453 /* libudev requires properties to start with a space */
454 while (isblank(line
[0]) && isblank(line
[1]))
457 if (line
[0] == '\0' || value
[0] == '\0') {
458 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
462 STRV_FOREACH(entry
, match_list
)
463 trie_insert(trie
, trie
->root
, *entry
, line
, value
);
468 static int import_file(struct trie
*trie
, const char *filename
) {
474 _cleanup_fclose_
FILE *f
= NULL
;
476 _cleanup_strv_free_
char **match_list
= NULL
;
480 f
= fopen(filename
, "re");
484 while (fgets(line
, sizeof(line
), f
)) {
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 log_error("Error, MATCH expected but got '%s' in '%s':", line
, filename
);
513 /* start of record, first match */
516 match
= strdup(line
);
520 r
= strv_consume(&match_list
, match
);
528 log_error("Error, DATA expected but got empty line in '%s':", filename
);
530 strv_clear(match_list
);
535 if (line
[0] != ' ') {
536 match
= strdup(line
);
540 r
= strv_consume(&match_list
, match
);
549 insert_data(trie
, match_list
, line
, filename
);
556 strv_clear(match_list
);
560 if (line
[0] != ' ') {
561 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
563 strv_clear(match_list
);
567 insert_data(trie
, match_list
, line
, filename
);
575 static int hwdb_query(int argc
, char *argv
[], void *userdata
) {
576 _cleanup_(sd_hwdb_unrefp
) sd_hwdb
*hwdb
= NULL
;
577 const char *key
, *value
;
578 const char *modalias
;
586 r
= sd_hwdb_new(&hwdb
);
590 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
591 printf("%s=%s\n", key
, value
);
596 static int hwdb_update(int argc
, char *argv
[], void *userdata
) {
597 _cleanup_free_
char *hwdb_bin
= NULL
;
598 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
602 trie
= new0(struct trie
, 1);
607 trie
->strings
= strbuf_new();
612 trie
->root
= new0(struct trie_node
, 1);
618 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, conf_file_dirs
);
620 return log_error_errno(r
, "failed to enumerate hwdb files: %m");
622 STRV_FOREACH(f
, files
) {
623 log_debug("reading file '%s'", *f
);
624 import_file(trie
, *f
);
628 strbuf_complete(trie
->strings
);
630 log_debug("=== trie in-memory ===");
631 log_debug("nodes: %8zu bytes (%8zu)",
632 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
633 log_debug("children arrays: %8zu bytes (%8zu)",
634 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
635 log_debug("values arrays: %8zu bytes (%8zu)",
636 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
637 log_debug("strings: %8zu bytes",
639 log_debug("strings incoming: %8zu bytes (%8zu)",
640 trie
->strings
->in_len
, trie
->strings
->in_count
);
641 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
642 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
644 hwdb_bin
= strjoin(arg_root
, "/", arg_hwdb_bin_dir
, "/hwdb.bin", NULL
);
648 mkdir_parents_label(hwdb_bin
, 0755);
649 r
= trie_store(trie
, hwdb_bin
);
651 return log_error_errno(r
, "Failure writing database %s: %m", hwdb_bin
);
653 return label_fix(hwdb_bin
, false, false);
656 static void help(void) {
657 printf("Usage: %s OPTIONS COMMAND\n\n"
658 "Update or query the hardware database.\n\n"
659 " -h --help Show this help\n"
660 " --version Show package version\n"
661 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
662 " -r --root=PATH Alternative root path in the filesystem\n\n"
664 " update Update the hwdb database\n"
665 " query MODALIAS Query database and print result\n",
666 program_invocation_short_name
);
669 static int parse_argv(int argc
, char *argv
[]) {
675 static const struct option options
[] = {
676 { "help", no_argument
, NULL
, 'h' },
677 { "version", no_argument
, NULL
, ARG_VERSION
},
678 { "usr", no_argument
, NULL
, ARG_USR
},
679 { "root", required_argument
, NULL
, 'r' },
688 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0) {
699 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
710 assert_not_reached("Unknown option");
717 static int hwdb_main(int argc
, char *argv
[]) {
718 const Verb verbs
[] = {
719 { "update", 1, 1, 0, hwdb_update
},
720 { "query", 2, 2, 0, hwdb_query
},
724 return dispatch_verb(argc
, argv
, verbs
, NULL
);
727 int main (int argc
, char *argv
[]) {
730 log_parse_environment();
733 r
= parse_argv(argc
, argv
);
739 r
= hwdb_main(argc
, argv
);
742 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;