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 "string-util.h"
40 * Generic udev properties, key/value database based on modalias strings.
41 * Uses a Patricia/radix trie to index all matches for efficient lookup.
44 static const char *arg_hwdb_bin_dir
= "/etc/udev";
45 static const char *arg_root
= "";
47 static const char * const conf_file_dirs
[] = {
49 UDEVLIBEXECDIR
"/hwdb.d",
53 /* in-memory trie objects */
55 struct trie_node
*root
;
56 struct strbuf
*strings
;
59 size_t children_count
;
64 /* prefix, common part for all children of this node */
67 /* sorted array of pointers to children nodes */
68 struct trie_child_entry
*children
;
69 uint8_t children_count
;
71 /* sorted array of key/value pairs */
72 struct trie_value_entry
*values
;
76 /* children array item with char (0-255) index */
77 struct trie_child_entry
{
79 struct trie_node
*child
;
82 /* value array item with key/value pairs */
83 struct trie_value_entry
{
88 static int trie_children_cmp(const void *v1
, const void *v2
) {
89 const struct trie_child_entry
*n1
= v1
;
90 const struct trie_child_entry
*n2
= v2
;
95 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
96 struct trie_child_entry
*child
;
98 /* extend array, add new entry, sort for bisection */
99 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
103 node
->children
= child
;
104 trie
->children_count
++;
105 node
->children
[node
->children_count
].c
= c
;
106 node
->children
[node
->children_count
].child
= node_child
;
107 node
->children_count
++;
108 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
114 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
115 struct trie_child_entry
*child
;
116 struct trie_child_entry search
;
119 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
125 static void trie_node_cleanup(struct trie_node
*node
) {
128 for (i
= 0; i
< node
->children_count
; i
++)
129 trie_node_cleanup(node
->children
[i
].child
);
130 free(node
->children
);
135 static void trie_free(struct trie
*trie
) {
140 trie_node_cleanup(trie
->root
);
142 strbuf_cleanup(trie
->strings
);
146 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
148 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
149 const struct trie_value_entry
*val1
= v1
;
150 const struct trie_value_entry
*val2
= v2
;
151 struct trie
*trie
= arg
;
153 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
154 trie
->strings
->buf
+ val2
->key_off
);
157 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
158 const char *key
, const char *value
) {
160 struct trie_value_entry
*val
;
162 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
165 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
169 if (node
->values_count
) {
170 struct trie_value_entry search
= {
175 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
177 /* replace existing earlier key with new value */
183 /* extend array, add new entry, sort for bisection */
184 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
187 trie
->values_count
++;
189 node
->values
[node
->values_count
].key_off
= k
;
190 node
->values
[node
->values_count
].value_off
= v
;
191 node
->values_count
++;
192 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
196 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
197 const char *key
, const char *value
) {
204 struct trie_node
*child
;
206 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
207 _cleanup_free_
char *s
= NULL
;
209 _cleanup_free_
struct trie_node
*new_child
= NULL
;
211 if (c
== search
[i
+ p
])
215 new_child
= new0(struct trie_node
, 1);
219 /* move values from parent to child */
220 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
221 new_child
->children
= node
->children
;
222 new_child
->children_count
= node
->children_count
;
223 new_child
->values
= node
->values
;
224 new_child
->values_count
= node
->values_count
;
226 /* update parent; use strdup() because the source gets realloc()d */
227 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
231 off
= strbuf_add_string(trie
->strings
, s
, p
);
235 node
->prefix_off
= off
;
236 node
->children
= NULL
;
237 node
->children_count
= 0;
239 node
->values_count
= 0;
240 err
= node_add_child(trie
, node
, new_child
, c
);
244 new_child
= NULL
; /* avoid cleanup */
251 return trie_node_add_value(trie
, node
, key
, value
);
253 child
= node_lookup(node
, c
);
258 child
= new0(struct trie_node
, 1);
262 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
268 child
->prefix_off
= off
;
269 err
= node_add_child(trie
, node
, child
, c
);
275 return trie_node_add_value(trie
, child
, key
, value
);
286 uint64_t strings_off
;
288 uint64_t nodes_count
;
289 uint64_t children_count
;
290 uint64_t values_count
;
293 /* calculate the storage space for the nodes, children arrays, value arrays */
294 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
297 for (i
= 0; i
< node
->children_count
; i
++)
298 trie_store_nodes_size(trie
, node
->children
[i
].child
);
300 trie
->strings_off
+= sizeof(struct trie_node_f
);
301 for (i
= 0; i
< node
->children_count
; i
++)
302 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
303 for (i
= 0; i
< node
->values_count
; i
++)
304 trie
->strings_off
+= sizeof(struct trie_value_entry_f
);
307 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
309 struct trie_node_f n
= {
310 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
311 .children_count
= node
->children_count
,
312 .values_count
= htole64(node
->values_count
),
314 struct trie_child_entry_f
*children
= NULL
;
317 if (node
->children_count
) {
318 children
= new0(struct trie_child_entry_f
, node
->children_count
);
323 /* post-order recursion */
324 for (i
= 0; i
< node
->children_count
; i
++) {
327 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
332 children
[i
].c
= node
->children
[i
].c
;
333 children
[i
].child_off
= htole64(child_off
);
337 node_off
= ftello(trie
->f
);
338 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
341 /* append children array */
342 if (node
->children_count
) {
343 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
344 trie
->children_count
+= node
->children_count
;
348 /* append values array */
349 for (i
= 0; i
< node
->values_count
; i
++) {
350 struct trie_value_entry_f v
= {
351 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
352 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
355 fwrite(&v
, sizeof(struct trie_value_entry_f
), 1, trie
->f
);
356 trie
->values_count
++;
362 static int trie_store(struct trie
*trie
, const char *filename
) {
366 _cleanup_free_
char *filename_tmp
= NULL
;
370 struct trie_header_f h
= {
371 .signature
= HWDB_SIG
,
372 .tool_version
= htole64(atoi(VERSION
)),
373 .header_size
= htole64(sizeof(struct trie_header_f
)),
374 .node_size
= htole64(sizeof(struct trie_node_f
)),
375 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
376 .value_entry_size
= htole64(sizeof(struct trie_value_entry_f
)),
380 /* calculate size of header, nodes, children entries, value entries */
381 t
.strings_off
= sizeof(struct trie_header_f
);
382 trie_store_nodes_size(&t
, trie
->root
);
384 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
387 fchmod(fileno(t
.f
), 0444);
390 err
= fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
);
393 unlink_noerrno(filename_tmp
);
396 root_off
= trie_store_nodes(&t
, trie
->root
);
397 h
.nodes_root_off
= htole64(root_off
);
399 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
401 /* write string buffer */
402 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
403 h
.strings_len
= htole64(trie
->strings
->len
);
407 h
.file_size
= htole64(size
);
408 err
= fseeko(t
.f
, 0, SEEK_SET
);
411 unlink_noerrno(filename_tmp
);
414 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
419 if (err
< 0 || rename(filename_tmp
, filename
) < 0) {
420 unlink_noerrno(filename_tmp
);
421 return err
< 0 ? err
: -errno
;
424 log_debug("=== trie on-disk ===");
425 log_debug("size: %8"PRIi64
" bytes", size
);
426 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
427 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
428 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
429 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
430 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
431 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
432 t
.values_count
* sizeof(struct trie_value_entry_f
), t
.values_count
);
433 log_debug("string store: %8zu bytes", trie
->strings
->len
);
434 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
439 static int insert_data(struct trie
*trie
, char **match_list
, char *line
, const char *filename
) {
440 char *value
, **entry
;
442 value
= strchr(line
, '=');
444 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
451 /* libudev requires properties to start with a space */
452 while (isblank(line
[0]) && isblank(line
[1]))
455 if (line
[0] == '\0' || value
[0] == '\0') {
456 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
460 STRV_FOREACH(entry
, match_list
)
461 trie_insert(trie
, trie
->root
, *entry
, line
, value
);
466 static int import_file(struct trie
*trie
, const char *filename
) {
472 _cleanup_fclose_
FILE *f
= NULL
;
474 _cleanup_strv_free_
char **match_list
= NULL
;
478 f
= fopen(filename
, "re");
482 while (fgets(line
, sizeof(line
), f
)) {
490 /* strip trailing comment */
491 pos
= strchr(line
, '#');
495 /* strip trailing whitespace */
497 while (len
> 0 && isspace(line
[len
-1]))
506 if (line
[0] == ' ') {
507 log_error("Error, MATCH expected but got '%s' in '%s':", line
, filename
);
511 /* start of record, first match */
514 match
= strdup(line
);
518 r
= strv_consume(&match_list
, match
);
526 log_error("Error, DATA expected but got empty line in '%s':", filename
);
528 strv_clear(match_list
);
533 if (line
[0] != ' ') {
534 match
= strdup(line
);
538 r
= strv_consume(&match_list
, match
);
547 insert_data(trie
, match_list
, line
, filename
);
554 strv_clear(match_list
);
558 if (line
[0] != ' ') {
559 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
561 strv_clear(match_list
);
565 insert_data(trie
, match_list
, line
, filename
);
573 static int hwdb_query(int argc
, char *argv
[], void *userdata
) {
574 _cleanup_hwdb_unref_ sd_hwdb
*hwdb
= NULL
;
575 const char *key
, *value
;
576 const char *modalias
;
584 r
= sd_hwdb_new(&hwdb
);
588 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
589 printf("%s=%s\n", key
, value
);
594 static int hwdb_update(int argc
, char *argv
[], void *userdata
) {
595 _cleanup_free_
char *hwdb_bin
= NULL
;
596 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
600 trie
= new0(struct trie
, 1);
605 trie
->strings
= strbuf_new();
610 trie
->root
= new0(struct trie_node
, 1);
616 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, conf_file_dirs
);
618 return log_error_errno(r
, "failed to enumerate hwdb files: %m");
620 STRV_FOREACH(f
, files
) {
621 log_debug("reading file '%s'", *f
);
622 import_file(trie
, *f
);
626 strbuf_complete(trie
->strings
);
628 log_debug("=== trie in-memory ===");
629 log_debug("nodes: %8zu bytes (%8zu)",
630 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
631 log_debug("children arrays: %8zu bytes (%8zu)",
632 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
633 log_debug("values arrays: %8zu bytes (%8zu)",
634 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
635 log_debug("strings: %8zu bytes",
637 log_debug("strings incoming: %8zu bytes (%8zu)",
638 trie
->strings
->in_len
, trie
->strings
->in_count
);
639 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
640 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
642 hwdb_bin
= strjoin(arg_root
, "/", arg_hwdb_bin_dir
, "/hwdb.bin", NULL
);
646 mkdir_parents(hwdb_bin
, 0755);
647 r
= trie_store(trie
, hwdb_bin
);
649 return log_error_errno(r
, "Failure writing database %s: %m", hwdb_bin
);
654 static void help(void) {
655 printf("Usage: %s OPTIONS COMMAND\n\n"
656 "Update or query the hardware database.\n\n"
657 " -h --help Show this help\n"
658 " --version Show package version\n"
659 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
660 " -r --root=PATH Alternative root path in the filesystem\n\n"
662 " update Update the hwdb database\n"
663 " query MODALIAS Query database and print result\n",
664 program_invocation_short_name
);
667 static int parse_argv(int argc
, char *argv
[]) {
673 static const struct option options
[] = {
674 { "help", no_argument
, NULL
, 'h' },
675 { "version", no_argument
, NULL
, ARG_VERSION
},
676 { "usr", no_argument
, NULL
, ARG_USR
},
677 { "root", required_argument
, NULL
, 'r' },
686 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0) {
697 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
708 assert_not_reached("Unknown option");
715 static int hwdb_main(int argc
, char *argv
[]) {
716 const Verb verbs
[] = {
717 { "update", 1, 1, 0, hwdb_update
},
718 { "query", 2, 2, 0, hwdb_query
},
722 return dispatch_verb(argc
, argv
, verbs
, NULL
);
725 int main (int argc
, char *argv
[]) {
728 log_parse_environment();
731 r
= parse_argv(argc
, argv
);
735 r
= hwdb_main(argc
, argv
);
738 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;