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