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 "path-util.h"
35 #include "selinux-util.h"
37 #include "string-util.h"
43 * Generic udev properties, key-value database based on modalias strings.
44 * Uses a Patricia/radix trie to index all matches for efficient lookup.
47 static const char *arg_hwdb_bin_dir
= "/etc/udev";
48 static const char *arg_root
= "";
50 static const char * const conf_file_dirs
[] = {
52 UDEVLIBEXECDIR
"/hwdb.d",
56 /* in-memory trie objects */
58 struct trie_node
*root
;
59 struct strbuf
*strings
;
62 size_t children_count
;
67 /* prefix, common part for all children of this node */
70 /* sorted array of pointers to children nodes */
71 struct trie_child_entry
*children
;
72 uint8_t children_count
;
74 /* sorted array of key-value pairs */
75 struct trie_value_entry
*values
;
79 /* children array item with char (0-255) index */
80 struct trie_child_entry
{
82 struct trie_node
*child
;
85 /* value array item with key-value pairs */
86 struct trie_value_entry
{
91 uint16_t file_priority
;
94 static int trie_children_cmp(const void *v1
, const void *v2
) {
95 const struct trie_child_entry
*n1
= v1
;
96 const struct trie_child_entry
*n2
= v2
;
101 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
102 struct trie_child_entry
*child
;
104 /* extend array, add new entry, sort for bisection */
105 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
109 node
->children
= child
;
110 trie
->children_count
++;
111 node
->children
[node
->children_count
].c
= c
;
112 node
->children
[node
->children_count
].child
= node_child
;
113 node
->children_count
++;
114 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
120 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
121 struct trie_child_entry
*child
;
122 struct trie_child_entry search
;
125 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
131 static void trie_node_cleanup(struct trie_node
*node
) {
134 for (i
= 0; i
< node
->children_count
; i
++)
135 trie_node_cleanup(node
->children
[i
].child
);
136 free(node
->children
);
141 static void trie_free(struct trie
*trie
) {
146 trie_node_cleanup(trie
->root
);
148 strbuf_cleanup(trie
->strings
);
152 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
154 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
155 const struct trie_value_entry
*val1
= v1
;
156 const struct trie_value_entry
*val2
= v2
;
157 struct trie
*trie
= arg
;
159 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
160 trie
->strings
->buf
+ val2
->key_off
);
163 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
164 const char *key
, const char *value
,
165 const char *filename
, uint16_t file_priority
, uint32_t line_number
) {
167 struct trie_value_entry
*val
;
169 k
= strbuf_add_string(trie
->strings
, key
, strlen(key
));
172 v
= strbuf_add_string(trie
->strings
, value
, strlen(value
));
175 fn
= strbuf_add_string(trie
->strings
, filename
, strlen(filename
));
179 if (node
->values_count
) {
180 struct trie_value_entry search
= {
185 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.
188 * Since we process files in order, we just replace the previous value.
191 val
->filename_off
= fn
;
192 val
->file_priority
= file_priority
;
193 val
->line_number
= line_number
;
198 /* extend array, add new entry, sort for bisection */
199 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
202 trie
->values_count
++;
204 node
->values
[node
->values_count
].key_off
= k
;
205 node
->values
[node
->values_count
].value_off
= v
;
206 node
->values
[node
->values_count
].filename_off
= fn
;
207 node
->values
[node
->values_count
].file_priority
= file_priority
;
208 node
->values
[node
->values_count
].line_number
= line_number
;
209 node
->values_count
++;
210 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
214 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
215 const char *key
, const char *value
,
216 const char *filename
, uint16_t file_priority
, uint32_t line_number
) {
223 struct trie_node
*child
;
225 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
226 _cleanup_free_
char *s
= NULL
;
228 _cleanup_free_
struct trie_node
*new_child
= NULL
;
230 if (c
== search
[i
+ p
])
234 new_child
= new0(struct trie_node
, 1);
238 /* move values from parent to child */
239 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
240 new_child
->children
= node
->children
;
241 new_child
->children_count
= node
->children_count
;
242 new_child
->values
= node
->values
;
243 new_child
->values_count
= node
->values_count
;
245 /* update parent; use strdup() because the source gets realloc()d */
246 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
250 off
= strbuf_add_string(trie
->strings
, s
, p
);
254 node
->prefix_off
= off
;
255 node
->children
= NULL
;
256 node
->children_count
= 0;
258 node
->values_count
= 0;
259 r
= node_add_child(trie
, node
, new_child
, c
);
263 new_child
= NULL
; /* avoid cleanup */
270 return trie_node_add_value(trie
, node
, key
, value
, filename
, file_priority
, line_number
);
272 child
= node_lookup(node
, c
);
277 child
= new0(struct trie_node
, 1);
281 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
287 child
->prefix_off
= off
;
288 r
= node_add_child(trie
, node
, child
, c
);
294 return trie_node_add_value(trie
, child
, key
, value
, filename
, file_priority
, line_number
);
305 uint64_t strings_off
;
307 uint64_t nodes_count
;
308 uint64_t children_count
;
309 uint64_t values_count
;
312 /* calculate the storage space for the nodes, children arrays, value arrays */
313 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
316 for (i
= 0; i
< node
->children_count
; i
++)
317 trie_store_nodes_size(trie
, node
->children
[i
].child
);
319 trie
->strings_off
+= sizeof(struct trie_node_f
);
320 for (i
= 0; i
< node
->children_count
; i
++)
321 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
322 for (i
= 0; i
< node
->values_count
; i
++)
323 trie
->strings_off
+= sizeof(struct trie_value_entry2_f
);
326 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
328 struct trie_node_f n
= {
329 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
330 .children_count
= node
->children_count
,
331 .values_count
= htole64(node
->values_count
),
333 _cleanup_free_
struct trie_child_entry_f
*children
= NULL
;
336 if (node
->children_count
) {
337 children
= new(struct trie_child_entry_f
, node
->children_count
);
342 /* post-order recursion */
343 for (i
= 0; i
< node
->children_count
; i
++) {
346 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
350 children
[i
] = (struct trie_child_entry_f
) {
351 .c
= node
->children
[i
].c
,
352 .child_off
= htole64(child_off
),
357 node_off
= ftello(trie
->f
);
358 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
361 /* append children array */
362 if (node
->children_count
) {
363 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
364 trie
->children_count
+= node
->children_count
;
367 /* append values array */
368 for (i
= 0; i
< node
->values_count
; i
++) {
369 struct trie_value_entry2_f v
= {
370 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
371 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
372 .filename_off
= htole64(trie
->strings_off
+ node
->values
[i
].filename_off
),
373 .line_number
= htole32(node
->values
[i
].line_number
),
374 .file_priority
= htole16(node
->values
[i
].file_priority
),
377 fwrite(&v
, sizeof(struct trie_value_entry2_f
), 1, trie
->f
);
379 trie
->values_count
+= node
->values_count
;
384 static int trie_store(struct trie
*trie
, const char *filename
) {
388 _cleanup_free_
char *filename_tmp
= NULL
;
392 struct trie_header_f h
= {
393 .signature
= HWDB_SIG
,
394 .tool_version
= htole64(atoi(PACKAGE_VERSION
)),
395 .header_size
= htole64(sizeof(struct trie_header_f
)),
396 .node_size
= htole64(sizeof(struct trie_node_f
)),
397 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
398 .value_entry_size
= htole64(sizeof(struct trie_value_entry2_f
)),
402 /* calculate size of header, nodes, children entries, value entries */
403 t
.strings_off
= sizeof(struct trie_header_f
);
404 trie_store_nodes_size(&t
, trie
->root
);
406 r
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
409 fchmod(fileno(t
.f
), 0444);
412 if (fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
) < 0)
415 root_off
= trie_store_nodes(&t
, trie
->root
);
416 h
.nodes_root_off
= htole64(root_off
);
418 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
420 /* write string buffer */
421 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
422 h
.strings_len
= htole64(trie
->strings
->len
);
426 h
.file_size
= htole64(size
);
427 if (fseeko(t
.f
, 0, SEEK_SET
) < 0)
429 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
435 if (fsync(fileno(t
.f
)) < 0)
437 if (rename(filename_tmp
, filename
) < 0)
440 /* write succeeded */
443 log_debug("=== trie on-disk ===");
444 log_debug("size: %8"PRIi64
" bytes", size
);
445 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
446 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
447 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
448 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
449 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
450 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
451 t
.values_count
* sizeof(struct trie_value_entry2_f
), t
.values_count
);
452 log_debug("string store: %8zu bytes", trie
->strings
->len
);
453 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
459 unlink(filename_tmp
);
463 static int insert_data(struct trie
*trie
, char **match_list
, char *line
,
464 const char *filename
, uint16_t file_priority
, uint32_t line_number
) {
465 char *value
, **entry
;
467 assert(line
[0] == ' ');
469 value
= strchr(line
, '=');
471 return log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
472 "Key-value pair expected but got \"%s\", ignoring", line
);
477 /* Replace multiple leading spaces by a single space */
478 while (isblank(line
[0]) && isblank(line
[1]))
481 if (isempty(line
+ 1) || isempty(value
))
482 return log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
483 "Empty %s in \"%s=%s\", ignoring",
484 isempty(line
+ 1) ? "key" : "value",
487 STRV_FOREACH(entry
, match_list
)
488 trie_insert(trie
, trie
->root
, *entry
, line
, value
, filename
, file_priority
, line_number
);
493 static int import_file(struct trie
*trie
, const char *filename
, uint16_t file_priority
) {
499 _cleanup_fclose_
FILE *f
= NULL
;
501 _cleanup_strv_free_
char **match_list
= NULL
;
502 uint32_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_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
538 "Match expected but got indented property \"%s\", ignoring line", line
);
542 /* start of record, first match */
545 match
= strdup(line
);
549 r
= strv_consume(&match_list
, match
);
557 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
558 "Property expected, ignoring record with no properties");
561 strv_clear(match_list
);
565 if (line
[0] != ' ') {
567 match
= strdup(line
);
571 r
= strv_consume(&match_list
, match
);
580 insert_data(trie
, match_list
, line
, filename
, file_priority
, line_number
);
587 strv_clear(match_list
);
591 if (line
[0] != ' ') {
592 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
593 "Property or empty line expected, got \"%s\", ignoring record", line
);
595 strv_clear(match_list
);
599 insert_data(trie
, match_list
, line
, filename
, file_priority
, line_number
);
604 if (state
== HW_MATCH
)
605 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
606 "Property expected, ignoring record with no properties");
611 static int hwdb_query(int argc
, char *argv
[], void *userdata
) {
612 _cleanup_(sd_hwdb_unrefp
) sd_hwdb
*hwdb
= NULL
;
613 const char *key
, *value
;
614 const char *modalias
;
622 r
= sd_hwdb_new(&hwdb
);
626 SD_HWDB_FOREACH_PROPERTY(hwdb
, modalias
, key
, value
)
627 printf("%s=%s\n", key
, value
);
632 static int hwdb_update(int argc
, char *argv
[], void *userdata
) {
633 _cleanup_free_
char *hwdb_bin
= NULL
;
634 _cleanup_(trie_freep
) struct trie
*trie
= NULL
;
635 _cleanup_strv_free_
char **files
= NULL
;
637 uint16_t file_priority
= 1;
640 trie
= new0(struct trie
, 1);
645 trie
->strings
= strbuf_new();
650 trie
->root
= new0(struct trie_node
, 1);
656 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, 0, conf_file_dirs
);
658 return log_error_errno(r
, "Failed to enumerate hwdb files: %m");
660 STRV_FOREACH(f
, files
) {
661 log_debug("Reading file \"%s\"", *f
);
662 import_file(trie
, *f
, file_priority
++);
665 strbuf_complete(trie
->strings
);
667 log_debug("=== trie in-memory ===");
668 log_debug("nodes: %8zu bytes (%8zu)",
669 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
670 log_debug("children arrays: %8zu bytes (%8zu)",
671 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
672 log_debug("values arrays: %8zu bytes (%8zu)",
673 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
674 log_debug("strings: %8zu bytes",
676 log_debug("strings incoming: %8zu bytes (%8zu)",
677 trie
->strings
->in_len
, trie
->strings
->in_count
);
678 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
679 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
681 hwdb_bin
= path_join(arg_root
, arg_hwdb_bin_dir
, "hwdb.bin");
685 mkdir_parents_label(hwdb_bin
, 0755);
686 r
= trie_store(trie
, hwdb_bin
);
688 return log_error_errno(r
, "Failure writing database %s: %m", hwdb_bin
);
690 return label_fix(hwdb_bin
, false, false);
693 static void help(void) {
694 printf("Usage: %s OPTIONS COMMAND\n\n"
695 "Update or query the hardware database.\n\n"
696 " -h --help Show this help\n"
697 " --version Show package version\n"
698 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
699 " -r --root=PATH Alternative root path in the filesystem\n\n"
701 " update Update the hwdb database\n"
702 " query MODALIAS Query database and print result\n",
703 program_invocation_short_name
);
706 static int parse_argv(int argc
, char *argv
[]) {
712 static const struct option options
[] = {
713 { "help", no_argument
, NULL
, 'h' },
714 { "version", no_argument
, NULL
, ARG_VERSION
},
715 { "usr", no_argument
, NULL
, ARG_USR
},
716 { "root", required_argument
, NULL
, 'r' },
725 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0) {
736 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
747 assert_not_reached("Unknown option");
754 static int hwdb_main(int argc
, char *argv
[]) {
755 const Verb verbs
[] = {
756 { "update", 1, 1, 0, hwdb_update
},
757 { "query", 2, 2, 0, hwdb_query
},
761 return dispatch_verb(argc
, argv
, verbs
, NULL
);
764 int main (int argc
, char *argv
[]) {
767 log_parse_environment();
770 r
= parse_argv(argc
, argv
);
776 r
= hwdb_main(argc
, argv
);
779 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;