]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/hwdb/hwdb.c
util-lib: split our string related calls from util.[ch] into its own file string...
[thirdparty/systemd.git] / src / hwdb / hwdb.c
1 /***
2 This file is part of systemd.
3
4 Copyright 2012 Kay Sievers <kay@vrfy.org>
5
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.
10
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.
15
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/>.
18 ***/
19
20 #include <ctype.h>
21 #include <getopt.h>
22 #include <stdlib.h>
23 #include <string.h>
24
25 #include "conf-files.h"
26 #include "hwdb-internal.h"
27 #include "hwdb-util.h"
28 #include "mkdir.h"
29 #include "strbuf.h"
30 #include "string-util.h"
31 #include "strv.h"
32 #include "util.h"
33 #include "verbs.h"
34
35 /*
36 * Generic udev properties, key/value database based on modalias strings.
37 * Uses a Patricia/radix trie to index all matches for efficient lookup.
38 */
39
40 static const char *arg_hwdb_bin_dir = "/etc/udev";
41 static const char *arg_root = "";
42
43 static const char * const conf_file_dirs[] = {
44 "/etc/udev/hwdb.d",
45 UDEVLIBEXECDIR "/hwdb.d",
46 NULL
47 };
48
49 /* in-memory trie objects */
50 struct trie {
51 struct trie_node *root;
52 struct strbuf *strings;
53
54 size_t nodes_count;
55 size_t children_count;
56 size_t values_count;
57 };
58
59 struct trie_node {
60 /* prefix, common part for all children of this node */
61 size_t prefix_off;
62
63 /* sorted array of pointers to children nodes */
64 struct trie_child_entry *children;
65 uint8_t children_count;
66
67 /* sorted array of key/value pairs */
68 struct trie_value_entry *values;
69 size_t values_count;
70 };
71
72 /* children array item with char (0-255) index */
73 struct trie_child_entry {
74 uint8_t c;
75 struct trie_node *child;
76 };
77
78 /* value array item with key/value pairs */
79 struct trie_value_entry {
80 size_t key_off;
81 size_t value_off;
82 };
83
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;
87
88 return n1->c - n2->c;
89 }
90
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;
93
94 /* extend array, add new entry, sort for bisection */
95 child = realloc(node->children, (node->children_count + 1) * sizeof(struct trie_child_entry));
96 if (!child)
97 return -ENOMEM;
98
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);
105 trie->nodes_count++;
106
107 return 0;
108 }
109
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;
113
114 search.c = c;
115 child = bsearch(&search, node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
116 if (child)
117 return child->child;
118 return NULL;
119 }
120
121 static void trie_node_cleanup(struct trie_node *node) {
122 size_t i;
123
124 for (i = 0; i < node->children_count; i++)
125 trie_node_cleanup(node->children[i].child);
126 free(node->children);
127 free(node->values);
128 free(node);
129 }
130
131 static void trie_free(struct trie *trie) {
132 if (!trie)
133 return;
134
135 if (trie->root)
136 trie_node_cleanup(trie->root);
137
138 strbuf_cleanup(trie->strings);
139 free(trie);
140 }
141
142 DEFINE_TRIVIAL_CLEANUP_FUNC(struct trie*, trie_free);
143
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;
148
149 return strcmp(trie->strings->buf + val1->key_off,
150 trie->strings->buf + val2->key_off);
151 }
152
153 static int trie_node_add_value(struct trie *trie, struct trie_node *node,
154 const char *key, const char *value) {
155 ssize_t k, v;
156 struct trie_value_entry *val;
157
158 k = strbuf_add_string(trie->strings, key, strlen(key));
159 if (k < 0)
160 return k;
161 v = strbuf_add_string(trie->strings, value, strlen(value));
162 if (v < 0)
163 return v;
164
165 if (node->values_count) {
166 struct trie_value_entry search = {
167 .key_off = k,
168 .value_off = v,
169 };
170
171 val = xbsearch_r(&search, node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
172 if (val) {
173 /* replace existing earlier key with new value */
174 val->value_off = v;
175 return 0;
176 }
177 }
178
179 /* extend array, add new entry, sort for bisection */
180 val = realloc(node->values, (node->values_count + 1) * sizeof(struct trie_value_entry));
181 if (!val)
182 return -ENOMEM;
183 trie->values_count++;
184 node->values = val;
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);
189 return 0;
190 }
191
192 static int trie_insert(struct trie *trie, struct trie_node *node, const char *search,
193 const char *key, const char *value) {
194 size_t i = 0;
195 int err = 0;
196
197 for (;;) {
198 size_t p;
199 uint8_t c;
200 struct trie_node *child;
201
202 for (p = 0; (c = trie->strings->buf[node->prefix_off + p]); p++) {
203 _cleanup_free_ char *s = NULL;
204 ssize_t off;
205 _cleanup_free_ struct trie_node *new_child = NULL;
206
207 if (c == search[i + p])
208 continue;
209
210 /* split node */
211 new_child = new0(struct trie_node, 1);
212 if (!new_child)
213 return -ENOMEM;
214
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;
221
222 /* update parent; use strdup() because the source gets realloc()d */
223 s = strndup(trie->strings->buf + node->prefix_off, p);
224 if (!s)
225 return -ENOMEM;
226
227 off = strbuf_add_string(trie->strings, s, p);
228 if (off < 0)
229 return off;
230
231 node->prefix_off = off;
232 node->children = NULL;
233 node->children_count = 0;
234 node->values = NULL;
235 node->values_count = 0;
236 err = node_add_child(trie, node, new_child, c);
237 if (err < 0)
238 return err;
239
240 new_child = NULL; /* avoid cleanup */
241 break;
242 }
243 i += p;
244
245 c = search[i];
246 if (c == '\0')
247 return trie_node_add_value(trie, node, key, value);
248
249 child = node_lookup(node, c);
250 if (!child) {
251 ssize_t off;
252
253 /* new child */
254 child = new0(struct trie_node, 1);
255 if (!child)
256 return -ENOMEM;
257
258 off = strbuf_add_string(trie->strings, search + i+1, strlen(search + i+1));
259 if (off < 0) {
260 free(child);
261 return off;
262 }
263
264 child->prefix_off = off;
265 err = node_add_child(trie, node, child, c);
266 if (err < 0) {
267 free(child);
268 return err;
269 }
270
271 return trie_node_add_value(trie, child, key, value);
272 }
273
274 node = child;
275 i++;
276 }
277 }
278
279 struct trie_f {
280 FILE *f;
281 struct trie *trie;
282 uint64_t strings_off;
283
284 uint64_t nodes_count;
285 uint64_t children_count;
286 uint64_t values_count;
287 };
288
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) {
291 uint64_t i;
292
293 for (i = 0; i < node->children_count; i++)
294 trie_store_nodes_size(trie, node->children[i].child);
295
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);
301 }
302
303 static int64_t trie_store_nodes(struct trie_f *trie, struct trie_node *node) {
304 uint64_t i;
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),
309 };
310 struct trie_child_entry_f *children = NULL;
311 int64_t node_off;
312
313 if (node->children_count) {
314 children = new0(struct trie_child_entry_f, node->children_count);
315 if (!children)
316 return -ENOMEM;
317 }
318
319 /* post-order recursion */
320 for (i = 0; i < node->children_count; i++) {
321 int64_t child_off;
322
323 child_off = trie_store_nodes(trie, node->children[i].child);
324 if (child_off < 0) {
325 free(children);
326 return child_off;
327 }
328 children[i].c = node->children[i].c;
329 children[i].child_off = htole64(child_off);
330 }
331
332 /* write node */
333 node_off = ftello(trie->f);
334 fwrite(&n, sizeof(struct trie_node_f), 1, trie->f);
335 trie->nodes_count++;
336
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;
341 free(children);
342 }
343
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),
349 };
350
351 fwrite(&v, sizeof(struct trie_value_entry_f), 1, trie->f);
352 trie->values_count++;
353 }
354
355 return node_off;
356 }
357
358 static int trie_store(struct trie *trie, const char *filename) {
359 struct trie_f t = {
360 .trie = trie,
361 };
362 _cleanup_free_ char *filename_tmp = NULL;
363 int64_t pos;
364 int64_t root_off;
365 int64_t size;
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)),
373 };
374 int err;
375
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);
379
380 err = fopen_temporary(filename , &t.f, &filename_tmp);
381 if (err < 0)
382 return err;
383 fchmod(fileno(t.f), 0444);
384
385 /* write nodes */
386 err = fseeko(t.f, sizeof(struct trie_header_f), SEEK_SET);
387 if (err < 0) {
388 fclose(t.f);
389 unlink_noerrno(filename_tmp);
390 return -errno;
391 }
392 root_off = trie_store_nodes(&t, trie->root);
393 h.nodes_root_off = htole64(root_off);
394 pos = ftello(t.f);
395 h.nodes_len = htole64(pos - sizeof(struct trie_header_f));
396
397 /* write string buffer */
398 fwrite(trie->strings->buf, trie->strings->len, 1, t.f);
399 h.strings_len = htole64(trie->strings->len);
400
401 /* write header */
402 size = ftello(t.f);
403 h.file_size = htole64(size);
404 err = fseeko(t.f, 0, SEEK_SET);
405 if (err < 0) {
406 fclose(t.f);
407 unlink_noerrno(filename_tmp);
408 return -errno;
409 }
410 fwrite(&h, sizeof(struct trie_header_f), 1, t.f);
411 err = ferror(t.f);
412 if (err)
413 err = -errno;
414 fclose(t.f);
415 if (err < 0 || rename(filename_tmp, filename) < 0) {
416 unlink_noerrno(filename_tmp);
417 return err < 0 ? err : -errno;
418 }
419
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);
431
432 return 0;
433 }
434
435 static int insert_data(struct trie *trie, char **match_list, char *line, const char *filename) {
436 char *value, **entry;
437
438 value = strchr(line, '=');
439 if (!value) {
440 log_error("Error, key/value pair expected but got '%s' in '%s':", line, filename);
441 return -EINVAL;
442 }
443
444 value[0] = '\0';
445 value++;
446
447 /* libudev requires properties to start with a space */
448 while (isblank(line[0]) && isblank(line[1]))
449 line++;
450
451 if (line[0] == '\0' || value[0] == '\0') {
452 log_error("Error, empty key or value '%s' in '%s':", line, filename);
453 return -EINVAL;
454 }
455
456 STRV_FOREACH(entry, match_list)
457 trie_insert(trie, trie->root, *entry, line, value);
458
459 return 0;
460 }
461
462 static int import_file(struct trie *trie, const char *filename) {
463 enum {
464 HW_NONE,
465 HW_MATCH,
466 HW_DATA,
467 } state = HW_NONE;
468 _cleanup_fclose_ FILE *f = NULL;
469 char line[LINE_MAX];
470 _cleanup_strv_free_ char **match_list = NULL;
471 char *match = NULL;
472 int r;
473
474 f = fopen(filename, "re");
475 if (!f)
476 return -errno;
477
478 while (fgets(line, sizeof(line), f)) {
479 size_t len;
480 char *pos;
481
482 /* comment line */
483 if (line[0] == '#')
484 continue;
485
486 /* strip trailing comment */
487 pos = strchr(line, '#');
488 if (pos)
489 pos[0] = '\0';
490
491 /* strip trailing whitespace */
492 len = strlen(line);
493 while (len > 0 && isspace(line[len-1]))
494 len--;
495 line[len] = '\0';
496
497 switch (state) {
498 case HW_NONE:
499 if (len == 0)
500 break;
501
502 if (line[0] == ' ') {
503 log_error("Error, MATCH expected but got '%s' in '%s':", line, filename);
504 break;
505 }
506
507 /* start of record, first match */
508 state = HW_MATCH;
509
510 match = strdup(line);
511 if (!match)
512 return -ENOMEM;
513
514 r = strv_consume(&match_list, match);
515 if (r < 0)
516 return r;
517
518 break;
519
520 case HW_MATCH:
521 if (len == 0) {
522 log_error("Error, DATA expected but got empty line in '%s':", filename);
523 state = HW_NONE;
524 strv_clear(match_list);
525 break;
526 }
527
528 /* another match */
529 if (line[0] != ' ') {
530 match = strdup(line);
531 if (!match)
532 return -ENOMEM;
533
534 r = strv_consume(&match_list, match);
535 if (r < 0)
536 return r;
537
538 break;
539 }
540
541 /* first data */
542 state = HW_DATA;
543 insert_data(trie, match_list, line, filename);
544 break;
545
546 case HW_DATA:
547 /* end of record */
548 if (len == 0) {
549 state = HW_NONE;
550 strv_clear(match_list);
551 break;
552 }
553
554 if (line[0] != ' ') {
555 log_error("Error, DATA expected but got '%s' in '%s':", line, filename);
556 state = HW_NONE;
557 strv_clear(match_list);
558 break;
559 }
560
561 insert_data(trie, match_list, line, filename);
562 break;
563 };
564 }
565
566 return 0;
567 }
568
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;
573 int r;
574
575 assert(argc >= 2);
576 assert(argv);
577
578 modalias = argv[1];
579
580 r = sd_hwdb_new(&hwdb);
581 if (r < 0)
582 return r;
583
584 SD_HWDB_FOREACH_PROPERTY(hwdb, modalias, key, value)
585 printf("%s=%s\n", key, value);
586
587 return 0;
588 }
589
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;
593 char **files, **f;
594 int r;
595
596 trie = new0(struct trie, 1);
597 if (!trie)
598 return -ENOMEM;
599
600 /* string store */
601 trie->strings = strbuf_new();
602 if (!trie->strings)
603 return -ENOMEM;
604
605 /* index */
606 trie->root = new0(struct trie_node, 1);
607 if (!trie->root)
608 return -ENOMEM;
609
610 trie->nodes_count++;
611
612 r = conf_files_list_strv(&files, ".hwdb", arg_root, conf_file_dirs);
613 if (r < 0)
614 return log_error_errno(r, "failed to enumerate hwdb files: %m");
615
616 STRV_FOREACH(f, files) {
617 log_debug("reading file '%s'", *f);
618 import_file(trie, *f);
619 }
620 strv_free(files);
621
622 strbuf_complete(trie->strings);
623
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",
632 trie->strings->len);
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);
637
638 hwdb_bin = strjoin(arg_root, "/", arg_hwdb_bin_dir, "/hwdb.bin", NULL);
639 if (!hwdb_bin)
640 return -ENOMEM;
641
642 mkdir_parents(hwdb_bin, 0755);
643 r = trie_store(trie, hwdb_bin);
644 if (r < 0)
645 return log_error_errno(r, "Failure writing database %s: %m", hwdb_bin);
646
647 return 0;
648 }
649
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"
657 "Commands:\n"
658 " update Update the hwdb database\n"
659 " query MODALIAS Query database and print result\n",
660 program_invocation_short_name);
661 }
662
663 static int parse_argv(int argc, char *argv[]) {
664 enum {
665 ARG_VERSION = 0x100,
666 ARG_USR,
667 };
668
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' },
674 {}
675 };
676
677 int c;
678
679 assert(argc >= 0);
680 assert(argv);
681
682 while ((c = getopt_long(argc, argv, "ut:r:h", options, NULL)) >= 0) {
683 switch(c) {
684
685 case 'h':
686 help();
687 return 0;
688
689 case ARG_VERSION:
690 return version();
691
692 case ARG_USR:
693 arg_hwdb_bin_dir = UDEVLIBEXECDIR;
694 break;
695
696 case 'r':
697 arg_root = optarg;
698 break;
699
700 case '?':
701 return -EINVAL;
702
703 default:
704 assert_not_reached("Unknown option");
705 }
706 }
707
708 return 1;
709 }
710
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 },
715 {},
716 };
717
718 return dispatch_verb(argc, argv, verbs, NULL);
719 }
720
721 int main (int argc, char *argv[]) {
722 int r;
723
724 log_parse_environment();
725 log_open();
726
727 r = parse_argv(argc, argv);
728 if (r <= 0)
729 goto finish;
730
731 r = hwdb_main(argc, argv);
732
733 finish:
734 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
735 }