misc-utils/blkid.c

   1 /*
   2  * blkid.c - User command-line interface for libblkid
   3  *
   4  * Copyright (C) 2001 Andreas Dilger
   5  *
   6  * %Begin-Header%
   7  * This file may be redistributed under the terms of the
   8  * GNU Lesser General Public License.
   9  * %End-Header%
  10  */
  11
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <unistd.h>
  15 #include <string.h>
  16 #include <sys/types.h>
  17 #include <sys/stat.h>
  18 #include <fcntl.h>
  19 #include <errno.h>
  20 #include <getopt.h>
  21
  22 #define OUTPUT_FULL             (1 << 0)
  23 #define OUTPUT_VALUE_ONLY       (1 << 1)
  24 #define OUTPUT_DEVICE_ONLY      (1 << 2)
  25 #define OUTPUT_PRETTY_LIST      (1 << 3)                /* deprecated */
  26 #define OUTPUT_UDEV_LIST        (1 << 4)                /* deprecated */
  27 #define OUTPUT_EXPORT_LIST      (1 << 5)
  28
  29 #define BLKID_EXIT_NOTFOUND     2       /* token or device not found */
  30 #define BLKID_EXIT_OTHER        4       /* bad usage or other error */
  31 #define BLKID_EXIT_AMBIVAL      8       /* ambivalent low-level probing detected */
  32
  33 #include <blkid.h>
  34
  35 #include "ismounted.h"
  36
  37 #include "strutils.h"
  38 #define OPTUTILS_EXIT_CODE      BLKID_EXIT_OTHER        /* exclusive_option() */
  39 #include "optutils.h"
  40 #define CLOSE_EXIT_CODE         BLKID_EXIT_OTHER        /* close_stdout() */
  41 #include "closestream.h"
  42
  43 #include "nls.h"
  44 #include "ttyutils.h"
  45
  46 #define XALLOC_EXIT_CODE    BLKID_EXIT_OTHER    /* x.*alloc(), xstrndup() */
  47 #include "xalloc.h"
  48
  49 struct blkid_control {
  50         int output;
  51         uintmax_t offset;
  52         uintmax_t size;
  53         char *show[128];
  54         unsigned int
  55                 eval:1,
  56                 gc:1,
  57                 lookup:1,
  58                 lowprobe:1,
  59                 lowprobe_superblocks:1,
  60                 lowprobe_topology:1,
  61                 raw_chars:1;
  62 };
  63
  64 static void print_version(FILE *out)
  65 {
  66         fprintf(out, _("%s from %s  (libblkid %s, %s)\n"),
  67                 program_invocation_short_name, PACKAGE_STRING,
  68                 LIBBLKID_VERSION, LIBBLKID_DATE);
  69 }
  70
  71 static void usage(int error)
  72 {
  73         FILE *out = error ? stderr : stdout;
  74
  75         fputs(USAGE_HEADER, out);
  76         fprintf(out, _( " %s --label <label> | --uuid <uuid>\n\n"), program_invocation_short_name);
  77         fprintf(out, _( " %s [--cache-file <file>] [-ghlLv] [--output <format>] [--match-tag <tag>] \n"
  78                         "       [--match-token <token>] [<dev> ...]\n\n"), program_invocation_short_name);
  79         fprintf(out, _( " %s -p [--match-tag <tag>] [--offset <offset>] [--size <size>] \n"
  80                         "       [--output <format>] <dev> ...\n\n"), program_invocation_short_name);
  81         fprintf(out, _( " %s -i [--match-tag <tag>] [--output <format>] <dev> ...\n"), program_invocation_short_name);
  82         fputs(USAGE_OPTIONS, out);
  83         fputs(_(        " -c, --cache-file <file>    read from <file> instead of reading from the default\n"
  84                         "                              cache file (-c /dev/null means no cache)\n"), out);
  85         fputs(_(        " -d, --no-encoding          don't encode non-printing characters\n"), out);
  86         fputs(_(        " -g, --garbage-collect      garbage collect the blkid cache\n"), out);
  87         fputs(_(        " -o, --output <format>      output format; can be one of:\n"
  88                         "                              value, device, export or full; (default: full)\n"), out);
  89         fputs(_(        " -k, --list-filesystems     list all known filesystems/RAIDs and exit\n"), out);
  90         fputs(_(        " -s, --match-tag <tag>      show specified tag(s) (default show all tags)\n"), out);
  91         fputs(_(        " -t, --match-token <token>  find device with a specific token (NAME=value pair)\n"), out);
  92         fputs(_(        " -l, --list-one             look up only first device with token specified by -t\n"), out);
  93         fputs(_(        " -L, --label <label>        convert LABEL to device name\n"), out);
  94         fputs(_(        " -U, --uuid <uuid>          convert UUID to device name\n"), out);
  95         fputs(_(        " <dev>                      specify device(s) to probe (default: all devices)\n"), out);
  96         fputs(          "\n", out);
  97         fputs(_(        "Low-level probing options:\n"), out);
  98         fputs(_(        " -p, --probe                low-level superblocks probing (bypass cache)\n"), out);
  99         fputs(_(        " -i, --info                 gather information about I/O limits\n"), out);
 100         fputs(_(        " -S, --size <size>          overwrite device size\n"), out);
 101         fputs(_(        " -O, --offset <offset>      probe at the given offset\n"), out);
 102         fputs(_(        " -u, --usages <list>        filter by \"usage\" (e.g. -u filesystem,raid)\n"), out);
 103         fputs(_(        " -n, --match-types <list>   filter by filesystem type (e.g. -n vfat,ext3)\n"), out);
 104
 105         fputs(USAGE_SEPARATOR, out);
 106         fputs(USAGE_HELP, out);
 107         fputs(USAGE_VERSION, out);
 108         fprintf(out, USAGE_MAN_TAIL("blkid(8)"));
 109         exit(error);
 110 }
 111
 112 /*
 113  * This function does "safe" printing.  It will convert non-printable
 114  * ASCII characters using '^' and M- notation.
 115  *
 116  * If 'esc' is defined then escape all chars from esc by \.
 117  */
 118 static void safe_print(const struct blkid_control *ctl, const char *cp, int len,
 119                        const char *esc)
 120 {
 121         unsigned char   ch;
 122
 123         if (len < 0)
 124                 len = strlen(cp);
 125
 126         while (len--) {
 127                 ch = *cp++;
 128                 if (!ctl->raw_chars) {
 129                         if (ch >= 128) {
 130                                 fputs("M-", stdout);
 131                                 ch -= 128;
 132                         }
 133                         if ((ch < 32) || (ch == 0x7f)) {
 134                                 fputc('^', stdout);
 135                                 ch ^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
 136
 137                         } else if (esc && strchr(esc, ch))
 138                                 fputc('\\', stdout);
 139                 }
 140                 fputc(ch, stdout);
 141         }
 142 }
 143
 144 static int pretty_print_word(const char *str, int max_len,
 145                              int left_len, int overflow_nl)
 146 {
 147         int len = strlen(str) + left_len;
 148         int ret = 0;
 149
 150         fputs(str, stdout);
 151         if (overflow_nl && len > max_len) {
 152                 fputc('\n', stdout);
 153                 len = 0;
 154         } else if (len > max_len)
 155                 ret = len - max_len;
 156         do {
 157                 fputc(' ', stdout);
 158         } while (len++ < max_len);
 159         return ret;
 160 }
 161
 162 static void pretty_print_line(const char *device, const char *fs_type,
 163                               const char *label, const char *mtpt,
 164                               const char *uuid)
 165 {
 166         static int device_len = 10, fs_type_len = 7;
 167         static int label_len = 8, mtpt_len = 14;
 168         static int term_width = -1;
 169         int len, w;
 170
 171         if (term_width < 0) {
 172                 term_width = get_terminal_width(80);
 173         }
 174         if (term_width > 80) {
 175                 term_width -= 80;
 176                 w = term_width / 10;
 177                 if (w > 8)
 178                         w = 8;
 179                 term_width -= 2*w;
 180                 label_len += w;
 181                 fs_type_len += w;
 182                 w = term_width/2;
 183                 device_len += w;
 184                 mtpt_len +=w;
 185         }
 186
 187         len = pretty_print_word(device, device_len, 0, 1);
 188         len = pretty_print_word(fs_type, fs_type_len, len, 0);
 189         len = pretty_print_word(label, label_len, len, 0);
 190         pretty_print_word(mtpt, mtpt_len, len, 0);
 191
 192         fputs(uuid, stdout);
 193         fputc('\n', stdout);
 194 }
 195
 196 static void pretty_print_dev(blkid_dev dev)
 197 {
 198         blkid_tag_iterate       iter;
 199         const char              *type, *value, *devname;
 200         const char              *uuid = "", *fs_type = "", *label = "";
 201         int                     len, mount_flags;
 202         char                    mtpt[80];
 203         int                     retval;
 204
 205         if (dev == NULL) {
 206                 pretty_print_line("device", "fs_type", "label",
 207                                   "mount point", "UUID");
 208                 for (len=get_terminal_width(0)-1; len > 0; len--)
 209                         fputc('-', stdout);
 210                 fputc('\n', stdout);
 211                 return;
 212         }
 213
 214         devname = blkid_dev_devname(dev);
 215         if (access(devname, F_OK))
 216                 return;
 217
 218         /* Get the uuid, label, type */
 219         iter = blkid_tag_iterate_begin(dev);
 220         while (blkid_tag_next(iter, &type, &value) == 0) {
 221                 if (!strcmp(type, "UUID"))
 222                         uuid = value;
 223                 if (!strcmp(type, "TYPE"))
 224                         fs_type = value;
 225                 if (!strcmp(type, "LABEL"))
 226                         label = value;
 227         }
 228         blkid_tag_iterate_end(iter);
 229
 230         /* Get the mount point */
 231         mtpt[0] = 0;
 232         retval = check_mount_point(devname, &mount_flags, mtpt, sizeof(mtpt));
 233         if (retval == 0) {
 234                 if (mount_flags & MF_MOUNTED) {
 235                         if (!mtpt[0])
 236                                 strcpy(mtpt, _("(mounted, mtpt unknown)"));
 237                 } else if (mount_flags & MF_BUSY)
 238                         strcpy(mtpt, _("(in use)"));
 239                 else
 240                         strcpy(mtpt, _("(not mounted)"));
 241         }
 242
 243         pretty_print_line(devname, fs_type, label, mtpt, uuid);
 244 }
 245
 246 static void print_udev_format(const char *name, const char *value)
 247 {
 248         char enc[265], safe[256];
 249         size_t namelen = strlen(name);
 250
 251         *safe = *enc = '\0';
 252
 253         if (!strcmp(name, "TYPE") || !strcmp(name, "VERSION")) {
 254                 blkid_encode_string(value, enc, sizeof(enc));
 255                 printf("ID_FS_%s=%s\n", name, enc);
 256
 257         } else if (!strcmp(name, "UUID") ||
 258                  !strcmp(name, "LABEL") ||
 259                  !strcmp(name, "UUID_SUB")) {
 260
 261                 blkid_safe_string(value, safe, sizeof(safe));
 262                 printf("ID_FS_%s=%s\n", name, safe);
 263
 264                 blkid_encode_string(value, enc, sizeof(enc));
 265                 printf("ID_FS_%s_ENC=%s\n", name, enc);
 266
 267         } else if (!strcmp(name, "PTUUID")) {
 268                 printf("ID_PART_TABLE_UUID=%s\n", value);
 269
 270         } else if (!strcmp(name, "PTTYPE")) {
 271                 printf("ID_PART_TABLE_TYPE=%s\n", value);
 272
 273         } else if (!strcmp(name, "PART_ENTRY_NAME") ||
 274                   !strcmp(name, "PART_ENTRY_TYPE")) {
 275
 276                 blkid_encode_string(value, enc, sizeof(enc));
 277                 printf("ID_%s=%s\n", name, enc);
 278
 279         } else if (!strncmp(name, "PART_ENTRY_", 11))
 280                 printf("ID_%s=%s\n", name, value);
 281
 282         else if (namelen >= 15 && (
 283                    !strcmp(name + (namelen - 12), "_SECTOR_SIZE") ||
 284                    !strcmp(name + (namelen - 8), "_IO_SIZE") ||
 285                    !strcmp(name, "ALIGNMENT_OFFSET")))
 286                         printf("ID_IOLIMIT_%s=%s\n", name, value);
 287         else
 288                 printf("ID_FS_%s=%s\n", name, value);
 289 }
 290
 291 static int has_item(const struct blkid_control *ctl, const char *item)
 292 {
 293         char * const *p;
 294
 295         for (p = ctl->show; *p != NULL; p++)
 296                 if (!strcmp(item, *p))
 297                         return 1;
 298         return 0;
 299 }
 300
 301 static void print_value(const struct blkid_control *ctl, int num,
 302                         const char *devname, const char *value,
 303                         const char *name, size_t valsz)
 304 {
 305         if (ctl->output & OUTPUT_VALUE_ONLY) {
 306                 fputs(value, stdout);
 307                 fputc('\n', stdout);
 308
 309         } else if (ctl->output & OUTPUT_UDEV_LIST) {
 310                 print_udev_format(name, value);
 311
 312         } else if (ctl->output & OUTPUT_EXPORT_LIST) {
 313                 if (num == 1 && devname)
 314                         printf("DEVNAME=%s\n", devname);
 315                 fputs(name, stdout);
 316                 fputs("=", stdout);
 317                 safe_print(ctl, value, valsz, " \\\"'$`<>");
 318                 fputs("\n", stdout);
 319
 320         } else {
 321                 if (num == 1 && devname)
 322                         printf("%s:", devname);
 323                 fputs(" ", stdout);
 324                 fputs(name, stdout);
 325                 fputs("=\"", stdout);
 326                 safe_print(ctl, value, valsz, "\"\\");
 327                 fputs("\"", stdout);
 328         }
 329 }
 330
 331 static void print_tags(const struct blkid_control *ctl, blkid_dev dev)
 332 {
 333         blkid_tag_iterate       iter;
 334         const char              *type, *value, *devname;
 335         int                     num = 1;
 336         static int              first = 1;
 337
 338         if (!dev)
 339                 return;
 340
 341         if (ctl->output & OUTPUT_PRETTY_LIST) {
 342                 pretty_print_dev(dev);
 343                 return;
 344         }
 345
 346         devname = blkid_dev_devname(dev);
 347
 348         if (ctl->output & OUTPUT_DEVICE_ONLY) {
 349                 printf("%s\n", devname);
 350                 return;
 351         }
 352
 353         iter = blkid_tag_iterate_begin(dev);
 354         while (blkid_tag_next(iter, &type, &value) == 0) {
 355                 if (ctl->show[0] && !has_item(ctl, type))
 356                         continue;
 357
 358                 if (num == 1 && !first &&
 359                     (ctl->output & (OUTPUT_UDEV_LIST | OUTPUT_EXPORT_LIST)))
 360                         /* add extra line between output from more devices */
 361                         fputc('\n', stdout);
 362
 363                 print_value(ctl, num++, devname, value, type, strlen(value));
 364         }
 365         blkid_tag_iterate_end(iter);
 366
 367         if (num > 1) {
 368                 if (!(ctl->output & (OUTPUT_VALUE_ONLY | OUTPUT_UDEV_LIST |
 369                                                 OUTPUT_EXPORT_LIST)))
 370                         printf("\n");
 371                 first = 0;
 372         }
 373 }
 374
 375
 376 static int append_str(char **res, size_t *sz, const char *a, const char *b)
 377 {
 378         char *str = *res;
 379         size_t asz = a ? strlen(a) : 0;
 380         size_t bsz = b ? strlen(b) : 0;
 381         size_t len = *sz + asz + bsz;
 382
 383         if (!len)
 384                 return -1;
 385
 386         *res = str = xrealloc(str, len + 1);
 387         str += *sz;
 388
 389         if (a) {
 390                 memcpy(str, a, asz);
 391                 str += asz;
 392         }
 393         if (b) {
 394                 memcpy(str, b, bsz);
 395                 str += bsz;
 396         }
 397         *str = '\0';
 398         *sz = len;
 399         return 0;
 400 }
 401
 402 /*
 403  * Compose and print ID_FS_AMBIVALENT for udev
 404  */
 405 static int print_udev_ambivalent(blkid_probe pr)
 406 {
 407         char *val = NULL;
 408         size_t valsz = 0;
 409         int count = 0, rc = -1;
 410
 411         while (!blkid_do_probe(pr)) {
 412                 const char *usage_txt = NULL, *type = NULL, *version = NULL;
 413                 char enc[256];
 414
 415                 blkid_probe_lookup_value(pr, "USAGE", &usage_txt, NULL);
 416                 blkid_probe_lookup_value(pr, "TYPE", &type, NULL);
 417                 blkid_probe_lookup_value(pr, "VERSION", &version, NULL);
 418
 419                 if (!usage_txt || !type)
 420                         continue;
 421
 422                 blkid_encode_string(usage_txt, enc, sizeof(enc));
 423                 if (append_str(&val, &valsz, enc, ":"))
 424                         goto done;
 425
 426                 blkid_encode_string(type, enc, sizeof(enc));
 427                 if (append_str(&val, &valsz, enc, version ? ":" : " "))
 428                         goto done;
 429
 430                 if (version) {
 431                         blkid_encode_string(version, enc, sizeof(enc));
 432                         if (append_str(&val, &valsz, enc, " "))
 433                                 goto done;
 434                 }
 435                 count++;
 436         }
 437
 438         if (count > 1) {
 439                 *(val + valsz - 1) = '\0';              /* rem tailing whitespace */
 440                 printf("ID_FS_AMBIVALENT=%s\n", val);
 441                 rc = 0;
 442         }
 443 done:
 444         free(val);
 445         return rc;
 446 }
 447
 448 static int lowprobe_superblocks(blkid_probe pr)
 449 {
 450         struct stat st;
 451         int rc, fd = blkid_probe_get_fd(pr);
 452
 453         if (fd < 0 || fstat(fd, &st))
 454                 return -1;
 455
 456         blkid_probe_enable_partitions(pr, 1);
 457
 458         if (!S_ISCHR(st.st_mode) && blkid_probe_get_size(pr) <= 1024 * 1440 &&
 459             blkid_probe_is_wholedisk(pr)) {
 460                 /*
 461                  * check if the small disk is partitioned, if yes then
 462                  * don't probe for filesystems.
 463                  */
 464                 blkid_probe_enable_superblocks(pr, 0);
 465
 466                 rc = blkid_do_fullprobe(pr);
 467                 if (rc < 0)
 468                         return rc;      /* -1 = error, 1 = nothing, 0 = success */
 469
 470                 if (blkid_probe_lookup_value(pr, "PTTYPE", NULL, NULL) == 0)
 471                         return 0;       /* partition table detected */
 472         }
 473
 474         blkid_probe_set_partitions_flags(pr, BLKID_PARTS_ENTRY_DETAILS);
 475         blkid_probe_enable_superblocks(pr, 1);
 476
 477         return blkid_do_safeprobe(pr);
 478 }
 479
 480 static int lowprobe_topology(blkid_probe pr)
 481 {
 482         /* enable topology probing only */
 483         blkid_probe_enable_topology(pr, 1);
 484
 485         blkid_probe_enable_superblocks(pr, 0);
 486         blkid_probe_enable_partitions(pr, 0);
 487
 488         return blkid_do_fullprobe(pr);
 489 }
 490
 491 static int lowprobe_device(blkid_probe pr, const char *devname,
 492                            struct blkid_control *ctl)
 493 {
 494         const char *data;
 495         const char *name;
 496         int nvals = 0, n, num = 1;
 497         size_t len;
 498         int fd;
 499         int rc = 0;
 500         static int first = 1;
 501
 502         fd = open(devname, O_RDONLY|O_CLOEXEC);
 503         if (fd < 0) {
 504                 warn(_("error: %s"), devname);
 505                 return BLKID_EXIT_NOTFOUND;
 506         }
 507         if (blkid_probe_set_device(pr, fd, ctl->offset, ctl->size))
 508                 goto done;
 509
 510         if (ctl->lowprobe_topology)
 511                 rc = lowprobe_topology(pr);
 512         if (rc >= 0 && ctl->lowprobe_superblocks)
 513                 rc = lowprobe_superblocks(pr);
 514         if (rc < 0)
 515                 goto done;
 516
 517         if (!rc)
 518                 nvals = blkid_probe_numof_values(pr);
 519
 520         if (nvals && !first && ctl->output & (OUTPUT_UDEV_LIST | OUTPUT_EXPORT_LIST))
 521                 /* add extra line between output from devices */
 522                 fputc('\n', stdout);
 523
 524         if (nvals && (ctl->output & OUTPUT_DEVICE_ONLY)) {
 525                 printf("%s\n", devname);
 526                 goto done;
 527         }
 528
 529         for (n = 0; n < nvals; n++) {
 530                 if (blkid_probe_get_value(pr, n, &name, &data, &len))
 531                         continue;
 532                 if (ctl->show[0] && !has_item(ctl, name))
 533                         continue;
 534                 len = strnlen((char *) data, len);
 535                 print_value(ctl, num++, devname, (char *) data, name, len);
 536         }
 537
 538         if (first)
 539                 first = 0;
 540
 541         if (nvals >= 1 && !(ctl->output & (OUTPUT_VALUE_ONLY |
 542                                         OUTPUT_UDEV_LIST | OUTPUT_EXPORT_LIST)))
 543                 printf("\n");
 544 done:
 545         if (rc == -2) {
 546                 if (ctl->output & OUTPUT_UDEV_LIST)
 547                         print_udev_ambivalent(pr);
 548                 else
 549                         warnx(_("%s: ambivalent result (probably more "
 550                                 "filesystems on the device, use wipefs(8) "
 551                                 "to see more details)"),
 552                                 devname);
 553         }
 554         close(fd);
 555
 556         if (rc == -2)
 557                 return BLKID_EXIT_AMBIVAL;      /* ambivalent probing result */
 558         if (!nvals)
 559                 return BLKID_EXIT_NOTFOUND;     /* nothing detected */
 560
 561         return 0;               /* success */
 562 }
 563
 564 /* converts comma separated list to BLKID_USAGE_* mask */
 565 static int list_to_usage(const char *list, int *flag)
 566 {
 567         int mask = 0;
 568         const char *word = NULL, *p = list;
 569
 570         if (p && strncmp(p, "no", 2) == 0) {
 571                 *flag = BLKID_FLTR_NOTIN;
 572                 p += 2;
 573         }
 574         if (!p || !*p)
 575                 goto err;
 576         while(p) {
 577                 word = p;
 578                 p = strchr(p, ',');
 579                 if (p)
 580                         p++;
 581                 if (!strncmp(word, "filesystem", 10))
 582                         mask |= BLKID_USAGE_FILESYSTEM;
 583                 else if (!strncmp(word, "raid", 4))
 584                         mask |= BLKID_USAGE_RAID;
 585                 else if (!strncmp(word, "crypto", 6))
 586                         mask |= BLKID_USAGE_CRYPTO;
 587                 else if (!strncmp(word, "other", 5))
 588                         mask |= BLKID_USAGE_OTHER;
 589                 else
 590                         goto err;
 591         }
 592         return mask;
 593 err:
 594         *flag = 0;
 595         warnx(_("unknown keyword in -u <list> argument: '%s'"),
 596                         word ? word : list);
 597         exit(BLKID_EXIT_OTHER);
 598 }
 599
 600 /* converts comma separated list to types[] */
 601 static char **list_to_types(const char *list, int *flag)
 602 {
 603         int i;
 604         const char *p = list;
 605         char **res = NULL;
 606
 607         if (p && strncmp(p, "no", 2) == 0) {
 608                 *flag = BLKID_FLTR_NOTIN;
 609                 p += 2;
 610         }
 611         if (!p || !*p) {
 612                 warnx(_("error: -u <list> argument is empty"));
 613                 goto err;
 614         }
 615         for (i = 1; p && (p = strchr(p, ',')); i++, p++);
 616
 617         res = xcalloc(i + 1, sizeof(char *));
 618         p = *flag & BLKID_FLTR_NOTIN ? list + 2 : list;
 619         i = 0;
 620
 621         while(p) {
 622                 const char *word = p;
 623                 p = strchr(p, ',');
 624                 res[i++] = p ? xstrndup(word, p - word) : xstrdup(word);
 625                 if (p)
 626                         p++;
 627         }
 628         res[i] = NULL;
 629         return res;
 630 err:
 631         *flag = 0;
 632         free(res);
 633         exit(BLKID_EXIT_OTHER);
 634 }
 635
 636 static void free_types_list(char *list[])
 637 {
 638         char **n;
 639
 640         if (!list)
 641                 return;
 642         for (n = list; *n; n++)
 643                 free(*n);
 644         free(list);
 645 }
 646
 647 int main(int argc, char **argv)
 648 {
 649         struct blkid_control ctl = { .output = OUTPUT_FULL, 0 };
 650         blkid_cache cache = NULL;
 651         char **devices = NULL;
 652         char *search_type = NULL, *search_value = NULL;
 653         char *read = NULL;
 654         int fltr_usage = 0;
 655         char **fltr_type = NULL;
 656         int fltr_flag = BLKID_FLTR_ONLYIN;
 657         unsigned int numdev = 0, numtag = 0;
 658         int err = BLKID_EXIT_OTHER;
 659         unsigned int i;
 660         int c;
 661
 662         static const struct option longopts[] = {
 663                 { "cache-file",       required_argument, NULL, 'c' },
 664                 { "no-encoding",      no_argument,       NULL, 'd' },
 665                 { "garbage-collect",  no_argument,       NULL, 'g' },
 666                 { "output",           required_argument, NULL, 'o' },
 667                 { "list-filesystems", no_argument,       NULL, 'k' },
 668                 { "match-tag",        required_argument, NULL, 's' },
 669                 { "match-token",      required_argument, NULL, 't' },
 670                 { "list-one",         no_argument,       NULL, 'l' },
 671                 { "label",            required_argument, NULL, 'L' },
 672                 { "uuid",             required_argument, NULL, 'U' },
 673                 { "probe",            no_argument,       NULL, 'p' },
 674                 { "info",             no_argument,       NULL, 'i' },
 675                 { "size",             required_argument, NULL, 'S' },
 676                 { "offset",           required_argument, NULL, 'O' },
 677                 { "usages",           required_argument, NULL, 'u' },
 678                 { "match-types",      required_argument, NULL, 'n' },
 679                 { "version",          no_argument,       NULL, 'V' },
 680                 { "help",             no_argument,       NULL, 'h' },
 681                 { NULL, 0, NULL, 0 }
 682         };
 683
 684         static const ul_excl_t excl[] = {       /* rows and cols in ASCII order */
 685                 { 'n','u' },
 686                 { 0 }
 687         };
 688         int excl_st[ARRAY_SIZE(excl)] = UL_EXCL_STATUS_INIT;
 689
 690         setlocale(LC_ALL, "");
 691         bindtextdomain(PACKAGE, LOCALEDIR);
 692         textdomain(PACKAGE);
 693         atexit(close_stdout);
 694
 695         strutils_set_exitcode(BLKID_EXIT_OTHER);
 696
 697         while ((c = getopt_long (argc, argv,
 698                             "c:dghilL:n:ko:O:ps:S:t:u:U:w:Vv", longopts, NULL)) != -1) {
 699
 700                 err_exclusive_options(c, NULL, excl, excl_st);
 701
 702                 switch (c) {
 703                 case 'c':
 704                         read = optarg;
 705                         break;
 706                 case 'd':
 707                         ctl.raw_chars = 1;
 708                         break;
 709                 case 'L':
 710                         ctl.eval = 1;
 711                         search_value = xstrdup(optarg);
 712                         search_type = xstrdup("LABEL");
 713                         break;
 714                 case 'n':
 715                         fltr_type = list_to_types(optarg, &fltr_flag);
 716                         break;
 717                 case 'u':
 718                         fltr_usage = list_to_usage(optarg, &fltr_flag);
 719                         break;
 720                 case 'U':
 721                         ctl.eval = 1;
 722                         search_value = xstrdup(optarg);
 723                         search_type = xstrdup("UUID");
 724                         break;
 725                 case 'i':
 726                         ctl.lowprobe_topology = 1;
 727                         break;
 728                 case 'l':
 729                         ctl.lookup = 1;
 730                         break;
 731                 case 'g':
 732                         ctl.gc = 1;
 733                         break;
 734                 case 'k':
 735                 {
 736                         size_t idx = 0;
 737                         const char *name = NULL;
 738
 739                         while (blkid_superblocks_get_name(idx++, &name, NULL) == 0)
 740                                 printf("%s\n", name);
 741                         exit(EXIT_SUCCESS);
 742                 }
 743                 case 'o':
 744                         if (!strcmp(optarg, "value"))
 745                                 ctl.output = OUTPUT_VALUE_ONLY;
 746                         else if (!strcmp(optarg, "device"))
 747                                 ctl.output = OUTPUT_DEVICE_ONLY;
 748                         else if (!strcmp(optarg, "list"))
 749                                 ctl.output = OUTPUT_PRETTY_LIST;        /* deprecated */
 750                         else if (!strcmp(optarg, "udev"))
 751                                 ctl.output = OUTPUT_UDEV_LIST;
 752                         else if (!strcmp(optarg, "export"))
 753                                 ctl.output = OUTPUT_EXPORT_LIST;
 754                         else if (!strcmp(optarg, "full"))
 755                                 ctl.output = 0;
 756                         else
 757                                 errx(BLKID_EXIT_OTHER, _("unsupported output format %s"), optarg);
 758                         break;
 759                 case 'O':
 760                         ctl.offset = strtosize_or_err(optarg, _("invalid offset argument"));
 761                         break;
 762                 case 'p':
 763                         ctl.lowprobe_superblocks = 1;
 764                         break;
 765                 case 's':
 766                         if (numtag + 1 >= sizeof(ctl.show) / sizeof(*ctl.show)) {
 767                                 warnx(_("Too many tags specified"));
 768                                 errtryhelp(err);
 769                         }
 770                         ctl.show[numtag++] = optarg;
 771                         break;
 772                 case 'S':
 773                         ctl.size = strtosize_or_err(optarg, _("invalid size argument"));
 774                         break;
 775                 case 't':
 776                         if (search_type) {
 777                                 warnx(_("Can only search for "
 778                                         "one NAME=value pair"));
 779                                 errtryhelp(err);
 780                         }
 781                         if (blkid_parse_tag_string(optarg,
 782                                                    &search_type,
 783                                                    &search_value)) {
 784                                 warnx(_("-t needs NAME=value pair"));
 785                                 errtryhelp(err);
 786                         }
 787                         break;
 788                 case 'V':
 789                 case 'v':
 790                         print_version(stdout);
 791                         err = 0;
 792                         goto exit;
 793                 case 'w':
 794                         /* ignore - backward compatibility */
 795                         break;
 796                 case 'h':
 797                         usage(0);
 798                         break;
 799                 default:
 800                         errtryhelp(EXIT_FAILURE);
 801                 }
 802         }
 803
 804         if (ctl.lowprobe_topology || ctl.lowprobe_superblocks)
 805                 ctl.lowprobe = 1;
 806
 807         /* The rest of the args are device names */
 808         if (optind < argc) {
 809                 devices = xcalloc(argc - optind, sizeof(char *));
 810                 while (optind < argc)
 811                         devices[numdev++] = argv[optind++];
 812         }
 813
 814         /* convert LABEL/UUID lookup to evaluate request */
 815         if (ctl.lookup && ctl.output == OUTPUT_DEVICE_ONLY && search_type &&
 816             (!strcmp(search_type, "LABEL") || !strcmp(search_type, "UUID"))) {
 817                 ctl.eval = 1;
 818                 ctl.lookup = 0;
 819         }
 820
 821         if (!ctl.lowprobe && !ctl.eval && blkid_get_cache(&cache, read) < 0)
 822                 goto exit;
 823
 824         if (ctl.gc) {
 825                 blkid_gc_cache(cache);
 826                 err = 0;
 827                 goto exit;
 828         }
 829         err = BLKID_EXIT_NOTFOUND;
 830
 831         if (ctl.eval == 0 && (ctl.output & OUTPUT_PRETTY_LIST)) {
 832                 if (ctl.lowprobe)
 833                         errx(BLKID_EXIT_OTHER,
 834                              _("The low-level probing mode does not "
 835                                "support 'list' output format"));
 836                 pretty_print_dev(NULL);
 837         }
 838
 839         if (ctl.lowprobe) {
 840                 /*
 841                  * Low-level API
 842                  */
 843                 blkid_probe pr;
 844
 845                 if (!numdev)
 846                         errx(BLKID_EXIT_OTHER,
 847                              _("The low-level probing mode "
 848                                "requires a device"));
 849
 850                 /* automatically enable 'export' format for I/O Limits */
 851                 if (!ctl.output  && ctl.lowprobe_topology)
 852                         ctl.output = OUTPUT_EXPORT_LIST;
 853
 854                 pr = blkid_new_probe();
 855                 if (!pr)
 856                         goto exit;
 857
 858                 if (ctl.lowprobe_superblocks) {
 859                         blkid_probe_set_superblocks_flags(pr,
 860                                 BLKID_SUBLKS_LABEL | BLKID_SUBLKS_UUID |
 861                                 BLKID_SUBLKS_TYPE | BLKID_SUBLKS_SECTYPE |
 862                                 BLKID_SUBLKS_USAGE | BLKID_SUBLKS_VERSION);
 863
 864
 865                         if (fltr_usage &&
 866                             blkid_probe_filter_superblocks_usage(pr, fltr_flag, fltr_usage))
 867                                 goto exit;
 868
 869                         else if (fltr_type &&
 870                                  blkid_probe_filter_superblocks_type(pr, fltr_flag, fltr_type))
 871                                 goto exit;
 872                 }
 873
 874                 for (i = 0; i < numdev; i++) {
 875                         err = lowprobe_device(pr, devices[i], &ctl);
 876                         if (err)
 877                                 break;
 878                 }
 879                 blkid_free_probe(pr);
 880         } else if (ctl.eval) {
 881                 /*
 882                  * Evaluate API
 883                  */
 884                 char *res = blkid_evaluate_tag(search_type, search_value, NULL);
 885                 if (res) {
 886                         err = 0;
 887                         printf("%s\n", res);
 888                 }
 889         } else if (ctl.lookup) {
 890                 /*
 891                  * Classic (cache based) API
 892                  */
 893                 blkid_dev dev;
 894
 895                 if (!search_type)
 896                         errx(BLKID_EXIT_OTHER,
 897                              _("The lookup option requires a "
 898                                "search type specified using -t"));
 899                 /* Load any additional devices not in the cache */
 900                 for (i = 0; i < numdev; i++)
 901                         blkid_get_dev(cache, devices[i], BLKID_DEV_NORMAL);
 902
 903                 if ((dev = blkid_find_dev_with_tag(cache, search_type,
 904                                                    search_value))) {
 905                         print_tags(&ctl, dev);
 906                         err = 0;
 907                 }
 908         /* If we didn't specify a single device, show all available devices */
 909         } else if (!numdev) {
 910                 blkid_dev_iterate       iter;
 911                 blkid_dev               dev;
 912
 913                 blkid_probe_all(cache);
 914
 915                 iter = blkid_dev_iterate_begin(cache);
 916                 blkid_dev_set_search(iter, search_type, search_value);
 917                 while (blkid_dev_next(iter, &dev) == 0) {
 918                         dev = blkid_verify(cache, dev);
 919                         if (!dev)
 920                                 continue;
 921                         print_tags(&ctl, dev);
 922                         err = 0;
 923                 }
 924                 blkid_dev_iterate_end(iter);
 925         /* Add all specified devices to cache (optionally display tags) */
 926         } else for (i = 0; i < numdev; i++) {
 927                 blkid_dev dev = blkid_get_dev(cache, devices[i],
 928                                                   BLKID_DEV_NORMAL);
 929
 930                 if (dev) {
 931                         if (search_type &&
 932                             !blkid_dev_has_tag(dev, search_type,
 933                                                search_value))
 934                                 continue;
 935                         print_tags(&ctl, dev);
 936                         err = 0;
 937                 }
 938         }
 939
 940 exit:
 941         free(search_type);
 942         free(search_value);
 943         free_types_list(fltr_type);
 944         if (!ctl.lowprobe && !ctl.eval)
 945                 blkid_put_cache(cache);
 946         free(devices);
 947         return err;
 948 }