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
{
92 static int trie_children_cmp(const void *v1
, const void *v2
) {
93 const struct trie_child_entry
*n1
= v1
;
94 const struct trie_child_entry
*n2
= v2
;
99 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
100 struct trie_child_entry
*child
;
102 /* extend array, add new entry, sort for bisection */
103 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
107 node
->children
= child
;
108 trie
->children_count
++;
109 node
->children
[node
->children_count
].c
= c
;
110 node
->children
[node
->children_count
].child
= node_child
;
111 node
->children_count
++;
112 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
118 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
119 struct trie_child_entry
*child
;
120 struct trie_child_entry search
;
123 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
129 static void trie_node_cleanup(struct trie_node
*node
) {
132 for (i
= 0; i
< node
->children_count
; i
++)
133 trie_node_cleanup(node
->children
[i
].child
);
134 free(node
->children
);
139 static void trie_free(struct trie
*trie
) {
144 trie_node_cleanup(trie
->root
);
146 strbuf_cleanup(trie
->strings
);
150 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
152 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
153 const struct trie_value_entry
*val1
= v1
;
154 const struct trie_value_entry
*val2
= v2
;
155 struct trie
*trie
= arg
;
157 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
158 trie
->strings
->buf
+ val2
->key_off
);
161 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
162 const char *key
, const char *value
,
163 const char *filename
, size_t line_number
) {
165 struct trie_value_entry
*val
;
168 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
171 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
174 fn
= strbuf_add_string(trie
->strings
, filename
, strlen(filename
));
178 if (node
->values_count
) {
179 struct trie_value_entry search
= {
184 val
= xbsearch_r(&search
, node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
187 * At this point we have 2 identical properties on the same match-string. We
188 * strictly order them by filename+line-number, since we know the dynamic
189 * runtime lookup does the same for multiple matching nodes.
191 r
= strcmp(filename
, trie
->strings
->buf
+ val
->filename_off
);
193 (r
== 0 && line_number
< val
->line_number
))
196 /* replace existing earlier key with new value */
198 val
->filename_off
= fn
;
199 val
->line_number
= line_number
;
204 /* extend array, add new entry, sort for bisection */
205 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
208 trie
->values_count
++;
210 node
->values
[node
->values_count
].key_off
= k
;
211 node
->values
[node
->values_count
].value_off
= v
;
212 node
->values
[node
->values_count
].filename_off
= fn
;
213 node
->values
[node
->values_count
].line_number
= line_number
;
214 node
->values_count
++;
215 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
219 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
220 const char *key
, const char *value
,
221 const char *filename
, uint64_t line_number
) {
228 struct trie_node
*child
;
230 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
231 _cleanup_free_
char *s
= NULL
;
233 _cleanup_free_
struct trie_node
*new_child
= NULL
;
235 if (c
== search
[i
+ p
])
239 new_child
= new0(struct trie_node
, 1);
243 /* move values from parent to child */
244 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
245 new_child
->children
= node
->children
;
246 new_child
->children_count
= node
->children_count
;
247 new_child
->values
= node
->values
;
248 new_child
->values_count
= node
->values_count
;
250 /* update parent; use strdup() because the source gets realloc()d */
251 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
255 off
= strbuf_add_string(trie
->strings
, s
, p
);
259 node
->prefix_off
= off
;
260 node
->children
= NULL
;
261 node
->children_count
= 0;
263 node
->values_count
= 0;
264 err
= node_add_child(trie
, node
, new_child
, c
);
268 new_child
= NULL
; /* avoid cleanup */
275 return trie_node_add_value(trie
, node
, key
, value
, filename
, line_number
);
277 child
= node_lookup(node
, c
);
282 child
= new0(struct trie_node
, 1);
286 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
292 child
->prefix_off
= off
;
293 err
= node_add_child(trie
, node
, child
, c
);
299 return trie_node_add_value(trie
, child
, key
, value
, filename
, line_number
);
310 uint64_t strings_off
;
312 uint64_t nodes_count
;
313 uint64_t children_count
;
314 uint64_t values_count
;
317 /* calculate the storage space for the nodes, children arrays, value arrays */
318 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
321 for (i
= 0; i
< node
->children_count
; i
++)
322 trie_store_nodes_size(trie
, node
->children
[i
].child
);
324 trie
->strings_off
+= sizeof(struct trie_node_f
);
325 for (i
= 0; i
< node
->children_count
; i
++)
326 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
327 for (i
= 0; i
< node
->values_count
; i
++)
328 trie
->strings_off
+= sizeof(struct trie_value_entry2_f
);
331 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
333 struct trie_node_f n
= {
334 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
335 .children_count
= node
->children_count
,
336 .values_count
= htole64(node
->values_count
),
338 struct trie_child_entry_f
*children
= NULL
;
341 if (node
->children_count
) {
342 children
= new0(struct trie_child_entry_f
, node
->children_count
);
347 /* post-order recursion */
348 for (i
= 0; i
< node
->children_count
; i
++) {
351 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
356 children
[i
].c
= node
->children
[i
].c
;
357 children
[i
].child_off
= htole64(child_off
);
361 node_off
= ftello(trie
->f
);
362 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
365 /* append children array */
366 if (node
->children_count
) {
367 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
368 trie
->children_count
+= node
->children_count
;
372 /* append values array */
373 for (i
= 0; i
< node
->values_count
; i
++) {
374 struct trie_value_entry2_f v
= {
375 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
376 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
377 .filename_off
= htole64(trie
->strings_off
+ node
->values
[i
].filename_off
),
378 .line_number
= htole64(node
->values
[i
].line_number
),
381 fwrite(&v
, sizeof(struct trie_value_entry2_f
), 1, trie
->f
);
382 trie
->values_count
++;
388 static int trie_store(struct trie
*trie
, const char *filename
) {
392 _cleanup_free_
char *filename_tmp
= NULL
;
396 struct trie_header_f h
= {
397 .signature
= HWDB_SIG
,
398 .tool_version
= htole64(atoi(VERSION
)),
399 .header_size
= htole64(sizeof(struct trie_header_f
)),
400 .node_size
= htole64(sizeof(struct trie_node_f
)),
401 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
402 .value_entry_size
= htole64(sizeof(struct trie_value_entry2_f
)),
406 /* calculate size of header, nodes, children entries, value entries */
407 t
.strings_off
= sizeof(struct trie_header_f
);
408 trie_store_nodes_size(&t
, trie
->root
);
410 err
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
413 fchmod(fileno(t
.f
), 0444);
416 err
= fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
);
419 unlink_noerrno(filename_tmp
);
422 root_off
= trie_store_nodes(&t
, trie
->root
);
423 h
.nodes_root_off
= htole64(root_off
);
425 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
427 /* write string buffer */
428 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
429 h
.strings_len
= htole64(trie
->strings
->len
);
433 h
.file_size
= htole64(size
);
434 err
= fseeko(t
.f
, 0, SEEK_SET
);
437 unlink_noerrno(filename_tmp
);
440 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
445 if (err
< 0 || rename(filename_tmp
, filename
) < 0) {
446 unlink_noerrno(filename_tmp
);
447 return err
< 0 ? err
: -errno
;
450 log_debug("=== trie on-disk ===");
451 log_debug("size: %8"PRIi64
" bytes", size
);
452 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
453 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
454 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
455 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
456 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
457 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
458 t
.values_count
* sizeof(struct trie_value_entry2_f
), t
.values_count
);
459 log_debug("string store: %8zu bytes", trie
->strings
->len
);
460 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
465 static int insert_data(struct trie
*trie
, char **match_list
, char *line
,
466 const char *filename
, size_t line_number
) {
467 char *value
, **entry
;
469 value
= strchr(line
, '=');
471 log_error("Error, key/value pair expected but got '%s' in '%s':", line
, filename
);
478 /* libudev requires properties to start with a space */
479 while (isblank(line
[0]) && isblank(line
[1]))
482 if (line
[0] == '\0' || value
[0] == '\0') {
483 log_error("Error, empty key or value '%s' in '%s':", line
, filename
);
487 STRV_FOREACH(entry
, match_list
)
488 trie_insert(trie
, trie
->root
, *entry
, line
, value
, filename
, line_number
);
493 static int import_file(struct trie
*trie
, const char *filename
) {
499 _cleanup_fclose_
FILE *f
= NULL
;
501 _cleanup_strv_free_
char **match_list
= NULL
;
502 size_t line_number
= 0;
506 f
= fopen(filename
, "re");
510 while (fgets(line
, sizeof(line
), f
)) {
520 /* strip trailing comment */
521 pos
= strchr(line
, '#');
525 /* strip trailing whitespace */
527 while (len
> 0 && isspace(line
[len
-1]))
536 if (line
[0] == ' ') {
537 log_error("Error, MATCH expected but got '%s' in '%s':", line
, filename
);
541 /* start of record, first match */
544 match
= strdup(line
);
548 r
= strv_consume(&match_list
, match
);
556 log_error("Error, DATA expected but got empty line in '%s':", filename
);
558 strv_clear(match_list
);
563 if (line
[0] != ' ') {
564 match
= strdup(line
);
568 r
= strv_consume(&match_list
, match
);
577 insert_data(trie
, match_list
, line
, filename
, line_number
);
584 strv_clear(match_list
);
588 if (line
[0] != ' ') {
589 log_error("Error, DATA expected but got '%s' in '%s':", line
, filename
);
591 strv_clear(match_list
);
595 insert_data(trie
, match_list
, line
, filename
, line_number
);
603 static int hwdb_query(int argc
, char *argv
[], void *userdata
) {
604 _cleanup_(sd_hwdb_unrefp
) sd_hwdb
*hwdb
= NULL
;
605 const char *key
, *value
;
606 const char *modalias
;
614 r
= sd_hwdb_new(&hwdb
);
618 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
619 printf("%s=%s\n", key
, value
);
624 static int hwdb_update(int argc
, char *argv
[], void *userdata
) {
625 _cleanup_free_
char *hwdb_bin
= NULL
;
626 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
630 trie
= new0(struct trie
, 1);
635 trie
->strings
= strbuf_new();
640 trie
->root
= new0(struct trie_node
, 1);
646 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, conf_file_dirs
);
648 return log_error_errno(r
, "failed to enumerate hwdb files: %m");
650 STRV_FOREACH(f
, files
) {
651 log_debug("reading file '%s'", *f
);
652 import_file(trie
, *f
);
656 strbuf_complete(trie
->strings
);
658 log_debug("=== trie in-memory ===");
659 log_debug("nodes: %8zu bytes (%8zu)",
660 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
661 log_debug("children arrays: %8zu bytes (%8zu)",
662 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
663 log_debug("values arrays: %8zu bytes (%8zu)",
664 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
665 log_debug("strings: %8zu bytes",
667 log_debug("strings incoming: %8zu bytes (%8zu)",
668 trie
->strings
->in_len
, trie
->strings
->in_count
);
669 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
670 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
672 hwdb_bin
= strjoin(arg_root
, "/", arg_hwdb_bin_dir
, "/hwdb.bin", NULL
);
676 mkdir_parents_label(hwdb_bin
, 0755);
677 r
= trie_store(trie
, hwdb_bin
);
679 return log_error_errno(r
, "Failure writing database %s: %m", hwdb_bin
);
681 return label_fix(hwdb_bin
, false, false);
684 static void help(void) {
685 printf("Usage: %s OPTIONS COMMAND\n\n"
686 "Update or query the hardware database.\n\n"
687 " -h --help Show this help\n"
688 " --version Show package version\n"
689 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
690 " -r --root=PATH Alternative root path in the filesystem\n\n"
692 " update Update the hwdb database\n"
693 " query MODALIAS Query database and print result\n",
694 program_invocation_short_name
);
697 static int parse_argv(int argc
, char *argv
[]) {
703 static const struct option options
[] = {
704 { "help", no_argument
, NULL
, 'h' },
705 { "version", no_argument
, NULL
, ARG_VERSION
},
706 { "usr", no_argument
, NULL
, ARG_USR
},
707 { "root", required_argument
, NULL
, 'r' },
716 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0) {
727 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
738 assert_not_reached("Unknown option");
745 static int hwdb_main(int argc
, char *argv
[]) {
746 const Verb verbs
[] = {
747 { "update", 1, 1, 0, hwdb_update
},
748 { "query", 2, 2, 0, hwdb_query
},
752 return dispatch_verb(argc
, argv
, verbs
, NULL
);
755 int main (int argc
, char *argv
[]) {
758 log_parse_environment();
761 r
= parse_argv(argc
, argv
);
767 r
= hwdb_main(argc
, argv
);
770 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;