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"
30 #include "string-util.h"
36 * Generic udev properties, key/value database based on modalias strings.
37 * Uses a Patricia/radix trie to index all matches for efficient lookup.
40 static const char *arg_hwdb_bin_dir
= "/etc/udev";
41 static const char *arg_root
= "";
43 static const char * const conf_file_dirs
[] = {
45 UDEVLIBEXECDIR
"/hwdb.d",
49 /* in-memory trie objects */
51 struct trie_node
*root
;
52 struct strbuf
*strings
;
55 size_t children_count
;
60 /* prefix, common part for all children of this node */
63 /* sorted array of pointers to children nodes */
64 struct trie_child_entry
*children
;
65 uint8_t children_count
;
67 /* sorted array of key/value pairs */
68 struct trie_value_entry
*values
;
72 /* children array item with char (0-255) index */
73 struct trie_child_entry
{
75 struct trie_node
*child
;
78 /* value array item with key/value pairs */
79 struct trie_value_entry
{
84 static int trie_children_cmp(const void *v1
, const void *v2
) {
85 const struct trie_child_entry
*n1
= v1
;
86 const struct trie_child_entry
*n2
= v2
;
91 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
92 struct trie_child_entry
*child
;
94 /* extend array, add new entry, sort for bisection */
95 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
99 node
->children
= child
;
100 trie
->children_count
++;
101 node
->children
[node
->children_count
].c
= c
;
102 node
->children
[node
->children_count
].child
= node_child
;
103 node
->children_count
++;
104 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
110 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
111 struct trie_child_entry
*child
;
112 struct trie_child_entry search
;
115 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
121 static void trie_node_cleanup(struct trie_node
*node
) {
124 for (i
= 0; i
< node
->children_count
; i
++)
125 trie_node_cleanup(node
->children
[i
].child
);
126 free(node
->children
);
131 static void trie_free(struct trie
*trie
) {
136 trie_node_cleanup(trie
->root
);
138 strbuf_cleanup(trie
->strings
);
142 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
144 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
145 const struct trie_value_entry
*val1
= v1
;
146 const struct trie_value_entry
*val2
= v2
;
147 struct trie
*trie
= arg
;
149 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
150 trie
->strings
->buf
+ val2
->key_off
);
153 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
154 const char *key
, const char *value
) {
156 struct trie_value_entry
*val
;
158 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
161 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
165 if (node
->values_count
) {
166 struct trie_value_entry search
= {
171 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
173 /* replace existing earlier key with new value */
179 /* extend array, add new entry, sort for bisection */
180 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
183 trie
->values_count
++;
185 node
->values
[node
->values_count
].key_off
= k
;
186 node
->values
[node
->values_count
].value_off
= v
;
187 node
->values_count
++;
188 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
192 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
193 const char *key
, const char *value
) {
200 struct trie_node
*child
;
202 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
203 _cleanup_free_
char *s
= NULL
;
205 _cleanup_free_
struct trie_node
*new_child
= NULL
;
207 if (c
== search
[i
+ p
])
211 new_child
= new0(struct trie_node
, 1);
215 /* move values from parent to child */
216 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
217 new_child
->children
= node
->children
;
218 new_child
->children_count
= node
->children_count
;
219 new_child
->values
= node
->values
;
220 new_child
->values_count
= node
->values_count
;
222 /* update parent; use strdup() because the source gets realloc()d */
223 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
227 off
= strbuf_add_string(trie
->strings
, s
, p
);
231 node
->prefix_off
= off
;
232 node
->children
= NULL
;
233 node
->children_count
= 0;
235 node
->values_count
= 0;
236 err
= node_add_child(trie
, node
, new_child
, c
);
240 new_child
= NULL
; /* avoid cleanup */
247 return trie_node_add_value(trie
, node
, key
, value
);
249 child
= node_lookup(node
, c
);
254 child
= new0(struct trie_node
, 1);
258 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
264 child
->prefix_off
= off
;
265 err
= node_add_child(trie
, node
, child
, c
);
271 return trie_node_add_value(trie
, child
, key
, value
);
282 uint64_t strings_off
;
284 uint64_t nodes_count
;
285 uint64_t children_count
;
286 uint64_t values_count
;
289 /* calculate the storage space for the nodes, children arrays, value arrays */
290 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
293 for (i
= 0; i
< node
->children_count
; i
++)
294 trie_store_nodes_size(trie
, node
->children
[i
].child
);
296 trie
->strings_off
+= sizeof(struct trie_node_f
);
297 for (i
= 0; i
< node
->children_count
; i
++)
298 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
299 for (i
= 0; i
< node
->values_count
; i
++)
300 trie
->strings_off
+= sizeof(struct trie_value_entry_f
);
303 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
305 struct trie_node_f n
= {
306 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
307 .children_count
= node
->children_count
,
308 .values_count
= htole64(node
->values_count
),
310 struct trie_child_entry_f
*children
= NULL
;
313 if (node
->children_count
) {
314 children
= new0(struct trie_child_entry_f
, node
->children_count
);
319 /* post-order recursion */
320 for (i
= 0; i
< node
->children_count
; i
++) {
323 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
328 children
[i
].c
= node
->children
[i
].c
;
329 children
[i
].child_off
= htole64(child_off
);
333 node_off
= ftello(trie
->f
);
334 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
337 /* append children array */
338 if (node
->children_count
) {
339 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
340 trie
->children_count
+= node
->children_count
;
344 /* append values array */
345 for (i
= 0; i
< node
->values_count
; i
++) {
346 struct trie_value_entry_f v
= {
347 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
348 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
351 fwrite(&v
, sizeof(struct trie_value_entry_f
), 1, trie
->f
);
352 trie
->values_count
++;
358 static int trie_store(struct trie
*trie
, const char *filename
) {
362 _cleanup_free_
char *filename_tmp
= NULL
;
366 struct trie_header_f h
= {
367 .signature
= HWDB_SIG
,
368 .tool_version
= htole64(atoi(VERSION
)),
369 .header_size
= htole64(sizeof(struct trie_header_f
)),
370 .node_size
= htole64(sizeof(struct trie_node_f
)),
371 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
372 .value_entry_size
= htole64(sizeof(struct trie_value_entry_f
)),
376 /* calculate size of header, nodes, children entries, value entries */
377 t
.strings_off
= sizeof(struct trie_header_f
);
378 trie_store_nodes_size(&t
, trie
->root
);
380 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
383 fchmod(fileno(t
.f
), 0444);
386 err
= fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
);
389 unlink_noerrno(filename_tmp
);
392 root_off
= trie_store_nodes(&t
, trie
->root
);
393 h
.nodes_root_off
= htole64(root_off
);
395 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
397 /* write string buffer */
398 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
399 h
.strings_len
= htole64(trie
->strings
->len
);
403 h
.file_size
= htole64(size
);
404 err
= fseeko(t
.f
, 0, SEEK_SET
);
407 unlink_noerrno(filename_tmp
);
410 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
415 if (err
< 0 || rename(filename_tmp
, filename
) < 0) {
416 unlink_noerrno(filename_tmp
);
417 return err
< 0 ? err
: -errno
;
420 log_debug("=== trie on-disk ===");
421 log_debug("size: %8"PRIi64
" bytes", size
);
422 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
423 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
424 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
425 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
426 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
427 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
428 t
.values_count
* sizeof(struct trie_value_entry_f
), t
.values_count
);
429 log_debug("string store: %8zu bytes", trie
->strings
->len
);
430 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
435 static int insert_data(struct trie
*trie
, char **match_list
, char *line
, const char *filename
) {
436 char *value
, **entry
;
438 value
= strchr(line
, '=');
440 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
447 /* libudev requires properties to start with a space */
448 while (isblank(line
[0]) && isblank(line
[1]))
451 if (line
[0] == '\0' || value
[0] == '\0') {
452 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
456 STRV_FOREACH(entry
, match_list
)
457 trie_insert(trie
, trie
->root
, *entry
, line
, value
);
462 static int import_file(struct trie
*trie
, const char *filename
) {
468 _cleanup_fclose_
FILE *f
= NULL
;
470 _cleanup_strv_free_
char **match_list
= NULL
;
474 f
= fopen(filename
, "re");
478 while (fgets(line
, sizeof(line
), f
)) {
486 /* strip trailing comment */
487 pos
= strchr(line
, '#');
491 /* strip trailing whitespace */
493 while (len
> 0 && isspace(line
[len
-1]))
502 if (line
[0] == ' ') {
503 log_error("Error, MATCH expected but got '%s' in '%s':", line
, filename
);
507 /* start of record, first match */
510 match
= strdup(line
);
514 r
= strv_consume(&match_list
, match
);
522 log_error("Error, DATA expected but got empty line in '%s':", filename
);
524 strv_clear(match_list
);
529 if (line
[0] != ' ') {
530 match
= strdup(line
);
534 r
= strv_consume(&match_list
, match
);
543 insert_data(trie
, match_list
, line
, filename
);
550 strv_clear(match_list
);
554 if (line
[0] != ' ') {
555 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
557 strv_clear(match_list
);
561 insert_data(trie
, match_list
, line
, filename
);
569 static int hwdb_query(int argc
, char *argv
[], void *userdata
) {
570 _cleanup_hwdb_unref_ sd_hwdb
*hwdb
= NULL
;
571 const char *key
, *value
;
572 const char *modalias
;
580 r
= sd_hwdb_new(&hwdb
);
584 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
585 printf("%s=%s\n", key
, value
);
590 static int hwdb_update(int argc
, char *argv
[], void *userdata
) {
591 _cleanup_free_
char *hwdb_bin
= NULL
;
592 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
596 trie
= new0(struct trie
, 1);
601 trie
->strings
= strbuf_new();
606 trie
->root
= new0(struct trie_node
, 1);
612 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, conf_file_dirs
);
614 return log_error_errno(r
, "failed to enumerate hwdb files: %m");
616 STRV_FOREACH(f
, files
) {
617 log_debug("reading file '%s'", *f
);
618 import_file(trie
, *f
);
622 strbuf_complete(trie
->strings
);
624 log_debug("=== trie in-memory ===");
625 log_debug("nodes: %8zu bytes (%8zu)",
626 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
627 log_debug("children arrays: %8zu bytes (%8zu)",
628 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
629 log_debug("values arrays: %8zu bytes (%8zu)",
630 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
631 log_debug("strings: %8zu bytes",
633 log_debug("strings incoming: %8zu bytes (%8zu)",
634 trie
->strings
->in_len
, trie
->strings
->in_count
);
635 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
636 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
638 hwdb_bin
= strjoin(arg_root
, "/", arg_hwdb_bin_dir
, "/hwdb.bin", NULL
);
642 mkdir_parents(hwdb_bin
, 0755);
643 r
= trie_store(trie
, hwdb_bin
);
645 return log_error_errno(r
, "Failure writing database %s: %m", hwdb_bin
);
650 static void help(void) {
651 printf("Usage: %s OPTIONS COMMAND\n\n"
652 "Update or query the hardware database.\n\n"
653 " -h --help Show this help\n"
654 " --version Show package version\n"
655 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
656 " -r --root=PATH Alternative root path in the filesystem\n\n"
658 " update Update the hwdb database\n"
659 " query MODALIAS Query database and print result\n",
660 program_invocation_short_name
);
663 static int parse_argv(int argc
, char *argv
[]) {
669 static const struct option options
[] = {
670 { "help", no_argument
, NULL
, 'h' },
671 { "version", no_argument
, NULL
, ARG_VERSION
},
672 { "usr", no_argument
, NULL
, ARG_USR
},
673 { "root", required_argument
, NULL
, 'r' },
682 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0) {
693 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
704 assert_not_reached("Unknown option");
711 static int hwdb_main(int argc
, char *argv
[]) {
712 const Verb verbs
[] = {
713 { "update", 1, 1, 0, hwdb_update
},
714 { "query", 2, 2, 0, hwdb_query
},
718 return dispatch_verb(argc
, argv
, verbs
, NULL
);
721 int main (int argc
, char *argv
[]) {
724 log_parse_environment();
727 r
= parse_argv(argc
, argv
);
731 r
= hwdb_main(argc
, argv
);
734 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;