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 uint16_t file_priority
;
93 static int trie_children_cmp(const void *v1
, const void *v2
) {
94 const struct trie_child_entry
*n1
= v1
;
95 const struct trie_child_entry
*n2
= v2
;
100 static int node_add_child(struct trie
*trie
, struct trie_node
*node
, struct trie_node
*node_child
, uint8_t c
) {
101 struct trie_child_entry
*child
;
103 /* extend array, add new entry, sort for bisection */
104 child
= realloc(node
->children
, (node
->children_count
+ 1) * sizeof(struct trie_child_entry
));
108 node
->children
= child
;
109 trie
->children_count
++;
110 node
->children
[node
->children_count
].c
= c
;
111 node
->children
[node
->children_count
].child
= node_child
;
112 node
->children_count
++;
113 qsort(node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
119 static struct trie_node
*node_lookup(const struct trie_node
*node
, uint8_t c
) {
120 struct trie_child_entry
*child
;
121 struct trie_child_entry search
;
124 child
= bsearch(&search
, node
->children
, node
->children_count
, sizeof(struct trie_child_entry
), trie_children_cmp
);
130 static void trie_node_cleanup(struct trie_node
*node
) {
133 for (i
= 0; i
< node
->children_count
; i
++)
134 trie_node_cleanup(node
->children
[i
].child
);
135 free(node
->children
);
140 static void trie_free(struct trie
*trie
) {
145 trie_node_cleanup(trie
->root
);
147 strbuf_cleanup(trie
->strings
);
151 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie
*, trie_free
);
153 static int trie_values_cmp(const void *v1
, const void *v2
, void *arg
) {
154 const struct trie_value_entry
*val1
= v1
;
155 const struct trie_value_entry
*val2
= v2
;
156 struct trie
*trie
= arg
;
158 return strcmp(trie
->strings
->buf
+ val1
->key_off
,
159 trie
->strings
->buf
+ val2
->key_off
);
162 static int trie_node_add_value(struct trie
*trie
, struct trie_node
*node
,
163 const char *key
, const char *value
,
164 const char *filename
, uint16_t file_priority
, uint32_t line_number
) {
166 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
);
186 /* At this point we have 2 identical properties on the same match-string.
187 * Since we process files in order, we just replace the previous value.
190 val
->filename_off
= fn
;
191 val
->file_priority
= file_priority
;
192 val
->line_number
= line_number
;
197 /* extend array, add new entry, sort for bisection */
198 val
= realloc(node
->values
, (node
->values_count
+ 1) * sizeof(struct trie_value_entry
));
201 trie
->values_count
++;
203 node
->values
[node
->values_count
].key_off
= k
;
204 node
->values
[node
->values_count
].value_off
= v
;
205 node
->values
[node
->values_count
].filename_off
= fn
;
206 node
->values
[node
->values_count
].file_priority
= file_priority
;
207 node
->values
[node
->values_count
].line_number
= line_number
;
208 node
->values_count
++;
209 qsort_r(node
->values
, node
->values_count
, sizeof(struct trie_value_entry
), trie_values_cmp
, trie
);
213 static int trie_insert(struct trie
*trie
, struct trie_node
*node
, const char *search
,
214 const char *key
, const char *value
,
215 const char *filename
, uint16_t file_priority
, uint32_t line_number
) {
222 struct trie_node
*child
;
224 for (p
= 0; (c
= trie
->strings
->buf
[node
->prefix_off
+ p
]); p
++) {
225 _cleanup_free_
char *s
= NULL
;
227 _cleanup_free_
struct trie_node
*new_child
= NULL
;
229 if (c
== search
[i
+ p
])
233 new_child
= new0(struct trie_node
, 1);
237 /* move values from parent to child */
238 new_child
->prefix_off
= node
->prefix_off
+ p
+1;
239 new_child
->children
= node
->children
;
240 new_child
->children_count
= node
->children_count
;
241 new_child
->values
= node
->values
;
242 new_child
->values_count
= node
->values_count
;
244 /* update parent; use strdup() because the source gets realloc()d */
245 s
= strndup(trie
->strings
->buf
+ node
->prefix_off
, p
);
249 off
= strbuf_add_string(trie
->strings
, s
, p
);
253 node
->prefix_off
= off
;
254 node
->children
= NULL
;
255 node
->children_count
= 0;
257 node
->values_count
= 0;
258 r
= node_add_child(trie
, node
, new_child
, c
);
262 new_child
= NULL
; /* avoid cleanup */
269 return trie_node_add_value(trie
, node
, key
, value
, filename
, file_priority
, line_number
);
271 child
= node_lookup(node
, c
);
276 child
= new0(struct trie_node
, 1);
280 off
= strbuf_add_string(trie
->strings
, search
+ i
+1, strlen(search
+ i
+1));
286 child
->prefix_off
= off
;
287 r
= node_add_child(trie
, node
, child
, c
);
293 return trie_node_add_value(trie
, child
, key
, value
, filename
, file_priority
, line_number
);
304 uint64_t strings_off
;
306 uint64_t nodes_count
;
307 uint64_t children_count
;
308 uint64_t values_count
;
311 /* calculate the storage space for the nodes, children arrays, value arrays */
312 static void trie_store_nodes_size(struct trie_f
*trie
, struct trie_node
*node
) {
315 for (i
= 0; i
< node
->children_count
; i
++)
316 trie_store_nodes_size(trie
, node
->children
[i
].child
);
318 trie
->strings_off
+= sizeof(struct trie_node_f
);
319 for (i
= 0; i
< node
->children_count
; i
++)
320 trie
->strings_off
+= sizeof(struct trie_child_entry_f
);
321 for (i
= 0; i
< node
->values_count
; i
++)
322 trie
->strings_off
+= sizeof(struct trie_value_entry2_f
);
325 static int64_t trie_store_nodes(struct trie_f
*trie
, struct trie_node
*node
) {
327 struct trie_node_f n
= {
328 .prefix_off
= htole64(trie
->strings_off
+ node
->prefix_off
),
329 .children_count
= node
->children_count
,
330 .values_count
= htole64(node
->values_count
),
332 _cleanup_free_
struct trie_child_entry_f
*children
= NULL
;
335 if (node
->children_count
) {
336 children
= new(struct trie_child_entry_f
, node
->children_count
);
341 /* post-order recursion */
342 for (i
= 0; i
< node
->children_count
; i
++) {
345 child_off
= trie_store_nodes(trie
, node
->children
[i
].child
);
349 children
[i
] = (struct trie_child_entry_f
) {
350 .c
= node
->children
[i
].c
,
351 .child_off
= htole64(child_off
),
356 node_off
= ftello(trie
->f
);
357 fwrite(&n
, sizeof(struct trie_node_f
), 1, trie
->f
);
360 /* append children array */
361 if (node
->children_count
) {
362 fwrite(children
, sizeof(struct trie_child_entry_f
), node
->children_count
, trie
->f
);
363 trie
->children_count
+= node
->children_count
;
366 /* append values array */
367 for (i
= 0; i
< node
->values_count
; i
++) {
368 struct trie_value_entry2_f v
= {
369 .key_off
= htole64(trie
->strings_off
+ node
->values
[i
].key_off
),
370 .value_off
= htole64(trie
->strings_off
+ node
->values
[i
].value_off
),
371 .filename_off
= htole64(trie
->strings_off
+ node
->values
[i
].filename_off
),
372 .line_number
= htole32(node
->values
[i
].line_number
),
373 .file_priority
= htole16(node
->values
[i
].file_priority
),
376 fwrite(&v
, sizeof(struct trie_value_entry2_f
), 1, trie
->f
);
378 trie
->values_count
+= node
->values_count
;
383 static int trie_store(struct trie
*trie
, const char *filename
) {
387 _cleanup_free_
char *filename_tmp
= NULL
;
391 struct trie_header_f h
= {
392 .signature
= HWDB_SIG
,
393 .tool_version
= htole64(atoi(VERSION
)),
394 .header_size
= htole64(sizeof(struct trie_header_f
)),
395 .node_size
= htole64(sizeof(struct trie_node_f
)),
396 .child_entry_size
= htole64(sizeof(struct trie_child_entry_f
)),
397 .value_entry_size
= htole64(sizeof(struct trie_value_entry2_f
)),
401 /* calculate size of header, nodes, children entries, value entries */
402 t
.strings_off
= sizeof(struct trie_header_f
);
403 trie_store_nodes_size(&t
, trie
->root
);
405 r
= fopen_temporary(filename
, &t
.f
, &filename_tmp
);
408 fchmod(fileno(t
.f
), 0444);
411 if (fseeko(t
.f
, sizeof(struct trie_header_f
), SEEK_SET
) < 0)
414 root_off
= trie_store_nodes(&t
, trie
->root
);
415 h
.nodes_root_off
= htole64(root_off
);
417 h
.nodes_len
= htole64(pos
- sizeof(struct trie_header_f
));
419 /* write string buffer */
420 fwrite(trie
->strings
->buf
, trie
->strings
->len
, 1, t
.f
);
421 h
.strings_len
= htole64(trie
->strings
->len
);
425 h
.file_size
= htole64(size
);
426 if (fseeko(t
.f
, 0, SEEK_SET
) < 0)
429 fwrite(&h
, sizeof(struct trie_header_f
), 1, t
.f
);
430 if (fclose(t
.f
) < 0 || rename(filename_tmp
, filename
) < 0) {
431 unlink_noerrno(filename_tmp
);
435 log_debug("=== trie on-disk ===");
436 log_debug("size: %8"PRIi64
" bytes", size
);
437 log_debug("header: %8zu bytes", sizeof(struct trie_header_f
));
438 log_debug("nodes: %8"PRIu64
" bytes (%8"PRIu64
")",
439 t
.nodes_count
* sizeof(struct trie_node_f
), t
.nodes_count
);
440 log_debug("child pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
441 t
.children_count
* sizeof(struct trie_child_entry_f
), t
.children_count
);
442 log_debug("value pointers: %8"PRIu64
" bytes (%8"PRIu64
")",
443 t
.values_count
* sizeof(struct trie_value_entry2_f
), t
.values_count
);
444 log_debug("string store: %8zu bytes", trie
->strings
->len
);
445 log_debug("strings start: %8"PRIu64
, t
.strings_off
);
451 unlink(filename_tmp
);
455 static int insert_data(struct trie
*trie
, char **match_list
, char *line
,
456 const char *filename
, uint16_t file_priority
, uint32_t line_number
) {
457 char *value
, **entry
;
459 assert(line
[0] == ' ');
461 value
= strchr(line
, '=');
463 return log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
464 "Key-value pair expected but got \"%s\", ignoring", line
);
469 /* Replace multiple leading spaces by a single space */
470 while (isblank(line
[0]) && isblank(line
[1]))
473 if (isempty(line
+ 1) || isempty(value
))
474 return log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
475 "Empty %s in \"%s=%s\", ignoring",
476 isempty(line
+ 1) ? "key" : "value",
479 STRV_FOREACH(entry
, match_list
)
480 trie_insert(trie
, trie
->root
, *entry
, line
, value
, filename
, file_priority
, line_number
);
485 static int import_file(struct trie
*trie
, const char *filename
, uint16_t file_priority
) {
491 _cleanup_fclose_
FILE *f
= NULL
;
493 _cleanup_strv_free_
char **match_list
= NULL
;
494 uint32_t line_number
= 0;
498 f
= fopen(filename
, "re");
502 while (fgets(line
, sizeof(line
), f
)) {
512 /* strip trailing comment */
513 pos
= strchr(line
, '#');
517 /* strip trailing whitespace */
519 while (len
> 0 && isspace(line
[len
-1]))
528 if (line
[0] == ' ') {
529 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
530 "Match expected but got indented property \"%s\", ignoring line", line
);
534 /* start of record, first match */
537 match
= strdup(line
);
541 r
= strv_consume(&match_list
, match
);
549 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
550 "Property expected, ignoring record with no properties");
553 strv_clear(match_list
);
557 if (line
[0] != ' ') {
559 match
= strdup(line
);
563 r
= strv_consume(&match_list
, match
);
572 insert_data(trie
, match_list
, line
, filename
, file_priority
, line_number
);
579 strv_clear(match_list
);
583 if (line
[0] != ' ') {
584 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
585 "Property or empty line expected, got \"%s\", ignoring record", line
);
587 strv_clear(match_list
);
591 insert_data(trie
, match_list
, line
, filename
, file_priority
, line_number
);
596 if (state
== HW_MATCH
)
597 log_syntax(NULL
, LOG_WARNING
, filename
, line_number
, EINVAL
,
598 "Property expected, ignoring record with no properties");
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
;
627 _cleanup_strv_free_
char **files
= NULL
;
629 uint16_t file_priority
= 1;
632 trie
= new0(struct trie
, 1);
637 trie
->strings
= strbuf_new();
642 trie
->root
= new0(struct trie_node
, 1);
648 r
= conf_files_list_strv(&files
, ".hwdb", arg_root
, conf_file_dirs
);
650 return log_error_errno(r
, "Failed to enumerate hwdb files: %m");
652 STRV_FOREACH(f
, files
) {
653 log_debug("Reading file \"%s\"", *f
);
654 import_file(trie
, *f
, file_priority
++);
657 strbuf_complete(trie
->strings
);
659 log_debug("=== trie in-memory ===");
660 log_debug("nodes: %8zu bytes (%8zu)",
661 trie
->nodes_count
* sizeof(struct trie_node
), trie
->nodes_count
);
662 log_debug("children arrays: %8zu bytes (%8zu)",
663 trie
->children_count
* sizeof(struct trie_child_entry
), trie
->children_count
);
664 log_debug("values arrays: %8zu bytes (%8zu)",
665 trie
->values_count
* sizeof(struct trie_value_entry
), trie
->values_count
);
666 log_debug("strings: %8zu bytes",
668 log_debug("strings incoming: %8zu bytes (%8zu)",
669 trie
->strings
->in_len
, trie
->strings
->in_count
);
670 log_debug("strings dedup'ed: %8zu bytes (%8zu)",
671 trie
->strings
->dedup_len
, trie
->strings
->dedup_count
);
673 hwdb_bin
= strjoin(arg_root
, "/", arg_hwdb_bin_dir
, "/hwdb.bin");
677 mkdir_parents_label(hwdb_bin
, 0755);
678 r
= trie_store(trie
, hwdb_bin
);
680 return log_error_errno(r
, "Failure writing database %s: %m", hwdb_bin
);
682 return label_fix(hwdb_bin
, false, false);
685 static void help(void) {
686 printf("Usage: %s OPTIONS COMMAND\n\n"
687 "Update or query the hardware database.\n\n"
688 " -h --help Show this help\n"
689 " --version Show package version\n"
690 " --usr Generate in " UDEVLIBEXECDIR
" instead of /etc/udev\n"
691 " -r --root=PATH Alternative root path in the filesystem\n\n"
693 " update Update the hwdb database\n"
694 " query MODALIAS Query database and print result\n",
695 program_invocation_short_name
);
698 static int parse_argv(int argc
, char *argv
[]) {
704 static const struct option options
[] = {
705 { "help", no_argument
, NULL
, 'h' },
706 { "version", no_argument
, NULL
, ARG_VERSION
},
707 { "usr", no_argument
, NULL
, ARG_USR
},
708 { "root", required_argument
, NULL
, 'r' },
717 while ((c
= getopt_long(argc
, argv
, "ut:r:h", options
, NULL
)) >= 0) {
728 arg_hwdb_bin_dir
= UDEVLIBEXECDIR
;
739 assert_not_reached("Unknown option");
746 static int hwdb_main(int argc
, char *argv
[]) {
747 const Verb verbs
[] = {
748 { "update", 1, 1, 0, hwdb_update
},
749 { "query", 2, 2, 0, hwdb_query
},
753 return dispatch_verb(argc
, argv
, verbs
, NULL
);
756 int main (int argc
, char *argv
[]) {
759 log_parse_environment();
762 r
= parse_argv(argc
, argv
);
768 r
= hwdb_main(argc
, argv
);
771 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;