src/udev/udevadm-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 <unistd.h>
  22 #include <getopt.h>
  23 #include <string.h>
  24
  25 #include "util.h"
  26 #include "strbuf.h"
  27 #include "conf-files.h"
  28
  29 #include "udev.h"
  30 #include "libudev-hwdb-def.h"
  31
  32 /*
  33  * Generic udev properties, key/value database based on modalias strings.
  34  * Uses a Patricia/radix trie to index all matches for efficient lookup.
  35  */
  36
  37 static const char * const conf_file_dirs[] = {
  38         "/etc/udev/hwdb.d",
  39         UDEVLIBEXECDIR "/hwdb.d",
  40         NULL
  41 };
  42
  43 /* in-memory trie objects */
  44 struct trie {
  45         struct trie_node *root;
  46         struct strbuf *strings;
  47
  48         size_t nodes_count;
  49         size_t children_count;
  50         size_t values_count;
  51 };
  52
  53 struct trie_node {
  54         /* prefix, common part for all children of this node */
  55         size_t prefix_off;
  56
  57         /* sorted array of pointers to children nodes */
  58         struct trie_child_entry *children;
  59         uint8_t children_count;
  60
  61         /* sorted array of key/value pairs */
  62         struct trie_value_entry *values;
  63         size_t values_count;
  64 };
  65
  66 /* children array item with char (0-255) index */
  67 struct trie_child_entry {
  68         uint8_t c;
  69         struct trie_node *child;
  70 };
  71
  72 /* value array item with key/value pairs */
  73 struct trie_value_entry {
  74         size_t key_off;
  75         size_t value_off;
  76 };
  77
  78 static int trie_children_cmp(const void *v1, const void *v2) {
  79         const struct trie_child_entry *n1 = v1;
  80         const struct trie_child_entry *n2 = v2;
  81
  82         return n1->c - n2->c;
  83 }
  84
  85 static int node_add_child(struct trie *trie, struct trie_node *node, struct trie_node *node_child, uint8_t c) {
  86         struct trie_child_entry *child;
  87         int err = 0;
  88
  89         /* extend array, add new entry, sort for bisection */
  90         child = realloc(node->children, (node->children_count + 1) * sizeof(struct trie_child_entry));
  91         if (!child) {
  92                 err = -ENOMEM;
  93                 goto out;
  94         }
  95         node->children = child;
  96         trie->children_count++;
  97         node->children[node->children_count].c = c;
  98         node->children[node->children_count].child = node_child;
  99         node->children_count++;
 100         qsort(node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
 101         trie->nodes_count++;
 102 out:
 103         return err;
 104 }
 105
 106 static struct trie_node *node_lookup(const struct trie_node *node, uint8_t c) {
 107         struct trie_child_entry *child;
 108         struct trie_child_entry search;
 109
 110         search.c = c;
 111         child = bsearch(&search, node->children, node->children_count, sizeof(struct trie_child_entry), trie_children_cmp);
 112         if (child)
 113                 return child->child;
 114         return NULL;
 115 }
 116
 117 static void trie_node_cleanup(struct trie_node *node) {
 118         size_t i;
 119
 120         for (i = 0; i < node->children_count; i++)
 121                 trie_node_cleanup(node->children[i].child);
 122         free(node->children);
 123         free(node->values);
 124         free(node);
 125 }
 126
 127 static int trie_values_cmp(const void *v1, const void *v2, void *arg) {
 128         const struct trie_value_entry *val1 = v1;
 129         const struct trie_value_entry *val2 = v2;
 130         struct trie *trie = arg;
 131
 132         return strcmp(trie->strings->buf + val1->key_off,
 133                       trie->strings->buf + val2->key_off);
 134 }
 135
 136 static int trie_node_add_value(struct trie *trie, struct trie_node *node,
 137                           const char *key, const char *value) {
 138         ssize_t k, v;
 139         struct trie_value_entry *val;
 140
 141         k = strbuf_add_string(trie->strings, key, strlen(key));
 142         if (k < 0)
 143                 return k;
 144         v = strbuf_add_string(trie->strings, value, strlen(value));
 145         if (v < 0)
 146                 return v;
 147
 148         if (node->values_count) {
 149                 struct trie_value_entry search = {
 150                         .key_off = k,
 151                         .value_off = v,
 152                 };
 153
 154                 val = xbsearch_r(&search, node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
 155                 if (val) {
 156                         /* replace existing earlier key with new value */
 157                         val->value_off = v;
 158                         return 0;
 159                 }
 160         }
 161
 162         /* extend array, add new entry, sort for bisection */
 163         val = realloc(node->values, (node->values_count + 1) * sizeof(struct trie_value_entry));
 164         if (!val)
 165                 return -ENOMEM;
 166         trie->values_count++;
 167         node->values = val;
 168         node->values[node->values_count].key_off = k;
 169         node->values[node->values_count].value_off = v;
 170         node->values_count++;
 171         qsort_r(node->values, node->values_count, sizeof(struct trie_value_entry), trie_values_cmp, trie);
 172         return 0;
 173 }
 174
 175 static int trie_insert(struct trie *trie, struct trie_node *node, const char *search,
 176                        const char *key, const char *value) {
 177         size_t i = 0;
 178         int err = 0;
 179         struct trie_node _cleanup_free_ *child = NULL;
 180
 181         for (;;) {
 182                 size_t p;
 183                 uint8_t c;
 184
 185                 for (p = 0; (c = trie->strings->buf[node->prefix_off + p]); p++) {
 186                         char *s;
 187                         ssize_t off;
 188
 189                         if (c == search[i + p])
 190                                 continue;
 191
 192                         /* split node */
 193                         child = calloc(sizeof(struct trie_node), 1);
 194                         if (!child) {
 195                                 err = -ENOMEM;
 196                                 goto out;
 197                         }
 198
 199                         /* move values from parent to child */
 200                         child->prefix_off = node->prefix_off + p+1;
 201                         child->children = node->children;
 202                         child->children_count = node->children_count;
 203                         child->values = node->values;
 204                         child->values_count = node->values_count;
 205
 206                         /* update parent; use strdup() because the source gets realloc()d */
 207                         s = strndup(trie->strings->buf + node->prefix_off, p);
 208                         if (!s) {
 209                                 err = -ENOMEM;
 210                                 goto out;
 211                         }
 212                         off = strbuf_add_string(trie->strings, s, p);
 213                         free(s);
 214                         if (off < 0) {
 215                                 err = off;
 216                                 goto out;
 217                         }
 218                         node->prefix_off = off;
 219                         node->children = NULL;
 220                         node->children_count = 0;
 221                         node->values = NULL;
 222                         node->values_count = 0;
 223                         err = node_add_child(trie, node, child, c);
 224                         if (err)
 225                                 goto out;
 226                         break;
 227                 }
 228                 i += p;
 229
 230                 c = search[i];
 231                 if (c == '\0')
 232                         return trie_node_add_value(trie, node, key, value);
 233
 234                 child = node_lookup(node, c);
 235                 if (!child) {
 236                         ssize_t off;
 237
 238                         /* new child */
 239                         child = calloc(sizeof(struct trie_node), 1);
 240                         if (!child) {
 241                                 err = -ENOMEM;
 242                                 goto out;
 243                         }
 244                         off = strbuf_add_string(trie->strings, search + i+1, strlen(search + i+1));
 245                         if (off < 0) {
 246                                 err = off;
 247                                 goto out;
 248                         }
 249                         child->prefix_off = off;
 250                         err = node_add_child(trie, node, child, c);
 251                         if (err)
 252                                 goto out;
 253                         return trie_node_add_value(trie, child, key, value);
 254                 }
 255
 256                 node = child;
 257                 child = NULL; /* avoid cleanup */
 258                 i++;
 259         }
 260 out:
 261         return err;
 262 }
 263
 264 struct trie_f {
 265         FILE *f;
 266         struct trie *trie;
 267         uint64_t strings_off;
 268
 269         uint64_t nodes_count;
 270         uint64_t children_count;
 271         uint64_t values_count;
 272 };
 273
 274 /* calculate the storage space for the nodes, children arrays, value arrays */
 275 static void trie_store_nodes_size(struct trie_f *trie, struct trie_node *node) {
 276         uint64_t i;
 277
 278         for (i = 0; i < node->children_count; i++)
 279                 trie_store_nodes_size(trie, node->children[i].child);
 280
 281         trie->strings_off += sizeof(struct trie_node_f);
 282         for (i = 0; i < node->children_count; i++)
 283                 trie->strings_off += sizeof(struct trie_child_entry_f);
 284         for (i = 0; i < node->values_count; i++)
 285                 trie->strings_off += sizeof(struct trie_value_entry_f);
 286 }
 287
 288 static int64_t trie_store_nodes(struct trie_f *trie, struct trie_node *node) {
 289         uint64_t i;
 290         struct trie_node_f n = {
 291                 .prefix_off = htole64(trie->strings_off + node->prefix_off),
 292                 .children_count = node->children_count,
 293                 .values_count = htole64(node->values_count),
 294         };
 295         struct trie_child_entry_f *children = NULL;
 296         int64_t node_off;
 297
 298         if (node->children_count) {
 299                 children = new0(struct trie_child_entry_f, node->children_count);
 300                 if (!children)
 301                         return -ENOMEM;
 302         }
 303
 304         /* post-order recursion */
 305         for (i = 0; i < node->children_count; i++) {
 306                 int64_t child_off;
 307
 308                 child_off = trie_store_nodes(trie, node->children[i].child);
 309                 if (child_off < 0)
 310                         return child_off;
 311                 children[i].c = node->children[i].c;
 312                 children[i].child_off = htole64(child_off);
 313         }
 314
 315         /* write node */
 316         node_off = ftello(trie->f);
 317         fwrite(&n, sizeof(struct trie_node_f), 1, trie->f);
 318         trie->nodes_count++;
 319
 320         /* append children array */
 321         if (node->children_count) {
 322                 fwrite(children, sizeof(struct trie_child_entry_f), node->children_count, trie->f);
 323                 trie->children_count += node->children_count;
 324                 free(children);
 325         }
 326
 327         /* append values array */
 328         for (i = 0; i < node->values_count; i++) {
 329                 struct trie_value_entry_f v = {
 330                         .key_off = htole64(trie->strings_off + node->values[i].key_off),
 331                         .value_off = htole64(trie->strings_off + node->values[i].value_off),
 332                 };
 333
 334                 fwrite(&v, sizeof(struct trie_value_entry_f), 1, trie->f);
 335                 trie->values_count++;
 336         }
 337
 338         return node_off;
 339 }
 340
 341 static int trie_store(struct trie *trie, const char *filename) {
 342         struct trie_f t = {
 343                 .trie = trie,
 344         };
 345         char *filename_tmp;
 346         int64_t pos;
 347         int64_t root_off;
 348         int64_t size;
 349         struct trie_header_f h = {
 350                 .signature = HWDB_SIG,
 351                 .tool_version = htole64(atoi(VERSION)),
 352                 .header_size = htole64(sizeof(struct trie_header_f)),
 353                 .node_size = htole64(sizeof(struct trie_node_f)),
 354                 .child_entry_size = htole64(sizeof(struct trie_child_entry_f)),
 355                 .value_entry_size = htole64(sizeof(struct trie_value_entry_f)),
 356         };
 357         int err;
 358
 359         /* calculate size of header, nodes, children entries, value entries */
 360         t.strings_off = sizeof(struct trie_header_f);
 361         trie_store_nodes_size(&t, trie->root);
 362
 363         err = fopen_temporary(filename , &t.f, &filename_tmp);
 364         if (err < 0)
 365                 return err;
 366         fchmod(fileno(t.f), 0444);
 367
 368         /* write nodes */
 369         fseeko(t.f, sizeof(struct trie_header_f), SEEK_SET);
 370         root_off = trie_store_nodes(&t, trie->root);
 371         h.nodes_root_off = htole64(root_off);
 372         pos = ftello(t.f);
 373         h.nodes_len = htole64(pos - sizeof(struct trie_header_f));
 374
 375         /* write string buffer */
 376         fwrite(trie->strings->buf, trie->strings->len, 1, t.f);
 377         h.strings_len = htole64(trie->strings->len);
 378
 379         /* write header */
 380         size = ftello(t.f);
 381         h.file_size = htole64(size);
 382         fseeko(t.f, 0, SEEK_SET);
 383         fwrite(&h, sizeof(struct trie_header_f), 1, t.f);
 384         err = ferror(t.f);
 385         if (err)
 386                 err = -errno;
 387         fclose(t.f);
 388         if (err < 0 || rename(filename_tmp, filename) < 0) {
 389                 unlink(filename_tmp);
 390                 goto out;
 391         }
 392
 393         log_debug("=== trie on-disk ===\n");
 394         log_debug("size:             %8llu bytes\n", (unsigned long long)size);
 395         log_debug("header:           %8zu bytes\n", sizeof(struct trie_header_f));
 396         log_debug("nodes:            %8llu bytes (%8llu)\n",
 397                   (unsigned long long)t.nodes_count * sizeof(struct trie_node_f), (unsigned long long)t.nodes_count);
 398         log_debug("child pointers:   %8llu bytes (%8llu)\n",
 399                   (unsigned long long)t.children_count * sizeof(struct trie_child_entry_f), (unsigned long long)t.children_count);
 400         log_debug("value pointers:   %8llu bytes (%8llu)\n",
 401                   (unsigned long long)t.values_count * sizeof(struct trie_value_entry_f), (unsigned long long)t.values_count);
 402         log_debug("string store:     %8llu bytes\n", (unsigned long long)trie->strings->len);
 403         log_debug("strings start:    %8llu\n", (unsigned long long) t.strings_off);
 404 out:
 405         free(filename_tmp);
 406         return err;
 407 }
 408
 409 static int import_file(struct trie *trie, const char *filename) {
 410         FILE *f;
 411         char line[LINE_MAX];
 412         char match[LINE_MAX];
 413         char cond[LINE_MAX];
 414
 415         f = fopen(filename, "re");
 416         if (f == NULL)
 417                 return -errno;
 418
 419         match[0] = '\0';
 420         cond[0] = '\0';
 421         while (fgets(line, sizeof(line), f)) {
 422                 size_t len;
 423
 424                 if (line[0] == '#')
 425                         continue;
 426
 427                 /* new line, new record */
 428                 if (line[0] == '\n') {
 429                         match[0] = '\0';
 430                         cond[0] = '\0';
 431                         continue;
 432                 }
 433
 434                 /* remove newline */
 435                 len = strlen(line);
 436                 if (len < 2)
 437                         continue;
 438                 line[len-1] = '\0';
 439
 440                 /* start of new record */
 441                 if (match[0] == '\0') {
 442                         strcpy(match, line);
 443                         cond[0] = '\0';
 444                         continue;
 445                 }
 446
 447                 if (line[0] == '+') {
 448                         strcpy(cond, line);
 449                         continue;
 450                 }
 451
 452                 /* TODO: support +; skip the entire record until we support it */
 453                 if (cond[0] != '\0')
 454                         continue;
 455
 456                 /* value lines */
 457                 if (line[0] == ' ') {
 458                         char *value;
 459
 460                         value = strchr(line, '=');
 461                         if (!value)
 462                                 continue;
 463                         value[0] = '\0';
 464                         value++;
 465                         trie_insert(trie, trie->root, match, line, value);
 466                 }
 467         }
 468         fclose(f);
 469         return 0;
 470 }
 471
 472 static void help(void) {
 473         printf("Usage: udevadm hwdb OPTIONS\n"
 474                "  --update            update the hardware database\n"
 475                "  --test=<modalias>   query database and print result\n"
 476                "  --root=<path>       alternative root path in the filesystem\n"
 477                "  --help\n\n");
 478 }
 479
 480 static int adm_hwdb(struct udev *udev, int argc, char *argv[]) {
 481         static const struct option options[] = {
 482                 { "update", no_argument, NULL, 'u' },
 483                 { "root", required_argument, NULL, 'r' },
 484                 { "test", required_argument, NULL, 't' },
 485                 { "help", no_argument, NULL, 'h' },
 486                 {}
 487         };
 488         const char *test = NULL;
 489         const char *root = "";
 490         bool update = false;
 491         struct trie *trie = NULL;
 492         int err;
 493         int rc = EXIT_SUCCESS;
 494
 495         for (;;) {
 496                 int option;
 497
 498                 option = getopt_long(argc, argv, "ut:r:h", options, NULL);
 499                 if (option == -1)
 500                         break;
 501
 502                 switch (option) {
 503                 case 'u':
 504                         update = true;
 505                         break;
 506                 case 't':
 507                         test = optarg;
 508                         break;
 509                 case 'r':
 510                         root = optarg;
 511                         break;
 512                 case 'h':
 513                         help();
 514                         return EXIT_SUCCESS;
 515                 }
 516         }
 517
 518         if (!update && !test) {
 519                 help();
 520                 return EXIT_SUCCESS;
 521         }
 522
 523         if (update) {
 524                 char **files, **f;
 525                 _cleanup_free_ char *hwdb_bin = NULL;
 526
 527                 trie = calloc(sizeof(struct trie), 1);
 528                 if (!trie) {
 529                         rc = EXIT_FAILURE;
 530                         goto out;
 531                 }
 532
 533                 /* string store */
 534                 trie->strings = strbuf_new();
 535                 if (!trie->strings) {
 536                         rc = EXIT_FAILURE;
 537                         goto out;
 538                 }
 539
 540                 /* index */
 541                 trie->root = calloc(sizeof(struct trie_node), 1);
 542                 if (!trie->root) {
 543                         rc = EXIT_FAILURE;
 544                         goto out;
 545                 }
 546                 trie->nodes_count++;
 547
 548                 err = conf_files_list_strv(&files, ".hwdb", root, conf_file_dirs);
 549                 if (err < 0) {
 550                         log_error("failed to enumerate hwdb files: %s\n", strerror(-err));
 551                         rc = EXIT_FAILURE;
 552                         goto out;
 553                 }
 554                 STRV_FOREACH(f, files) {
 555                         log_debug("reading file '%s'", *f);
 556                         import_file(trie, *f);
 557                 }
 558                 strv_free(files);
 559
 560                 strbuf_complete(trie->strings);
 561
 562                 log_debug("=== trie in-memory ===\n");
 563                 log_debug("nodes:            %8zu bytes (%8zu)\n",
 564                           trie->nodes_count * sizeof(struct trie_node), trie->nodes_count);
 565                 log_debug("children arrays:  %8zu bytes (%8zu)\n",
 566                           trie->children_count * sizeof(struct trie_child_entry), trie->children_count);
 567                 log_debug("values arrays:    %8zu bytes (%8zu)\n",
 568                           trie->values_count * sizeof(struct trie_value_entry), trie->values_count);
 569                 log_debug("strings:          %8zu bytes\n",
 570                           trie->strings->len);
 571                 log_debug("strings incoming: %8zu bytes (%8zu)\n",
 572                           trie->strings->in_len, trie->strings->in_count);
 573                 log_debug("strings dedup'ed: %8zu bytes (%8zu)\n",
 574                           trie->strings->dedup_len, trie->strings->dedup_count);
 575
 576                 if (asprintf(&hwdb_bin, "%s/etc/udev/hwdb.bin", root) < 0) {
 577                         rc = EXIT_FAILURE;
 578                         goto out;
 579                 }
 580                 mkdir_parents(hwdb_bin, 0755);
 581                 err = trie_store(trie, hwdb_bin);
 582                 if (err < 0) {
 583                         log_error("Failure writing database %s: %s", hwdb_bin, strerror(-err));
 584                         rc = EXIT_FAILURE;
 585                 }
 586         }
 587
 588         if (test) {
 589                 struct udev_hwdb *hwdb = udev_hwdb_new(udev);
 590
 591                 if (hwdb) {
 592                         struct udev_list_entry *entry;
 593
 594                         udev_list_entry_foreach(entry, udev_hwdb_get_properties_list_entry(hwdb, test, 0))
 595                                 printf("%s=%s\n", udev_list_entry_get_name(entry), udev_list_entry_get_value(entry));
 596                         hwdb = udev_hwdb_unref(hwdb);
 597                 }
 598         }
 599 out:
 600         if (trie) {
 601                 if (trie->root)
 602                         trie_node_cleanup(trie->root);
 603                 strbuf_cleanup(trie->strings);
 604                 free(trie);
 605         }
 606         return rc;
 607 }
 608
 609 const struct udevadm_cmd udevadm_hwdb = {
 610         .name = "hwdb",
 611         .cmd = adm_hwdb,
 612         .help = "maintain the hardware database index",
 613 };