2 * blkid.c - User command-line interface for libblkid
4 * Copyright (C) 2001 Andreas Dilger
7 * This file may be redistributed under the terms of the
8 * GNU Lesser General Public License.
16 #include <sys/types.h>
22 #define OUTPUT_VALUE_ONLY (1 << 1)
23 #define OUTPUT_DEVICE_ONLY (1 << 2)
24 #define OUTPUT_PRETTY_LIST (1 << 3) /* deprecated */
25 #define OUTPUT_UDEV_LIST (1 << 4) /* deprecated */
26 #define OUTPUT_EXPORT_LIST (1 << 5)
28 #define LOWPROBE_TOPOLOGY (1 << 1)
29 #define LOWPROBE_SUPERBLOCKS (1 << 2)
31 #define BLKID_EXIT_NOTFOUND 2 /* token or device not found */
32 #define BLKID_EXIT_OTHER 4 /* bad usage or other error */
33 #define BLKID_EXIT_AMBIVAL 8 /* ambivalent low-level probing detected */
37 #include "ismounted.h"
39 #define STRTOXX_EXIT_CODE BLKID_EXIT_OTHER /* strtoxx_or_err() */
41 #define OPTUTILS_EXIT_CODE BLKID_EXIT_OTHER /* exclusive_option() */
44 #include "closestream.h"
50 static void print_version(FILE *out
)
52 fprintf(out
, "%s from %s (libblkid %s, %s)\n",
53 program_invocation_short_name
, PACKAGE_STRING
,
54 LIBBLKID_VERSION
, LIBBLKID_DATE
);
57 static void usage(int error
)
59 FILE *out
= error
? stderr
: stdout
;
64 " %1$s -L <label> | -U <uuid>\n\n"
65 " %1$s [-c <file>] [-ghlLv] [-o <format>] [-s <tag>] \n"
66 " [-t <token>] [<dev> ...]\n\n"
67 " %1$s -p [-s <tag>] [-O <offset>] [-S <size>] \n"
68 " [-o <format>] <dev> ...\n\n"
69 " %1$s -i [-s <tag>] [-o <format>] <dev> ...\n\n"
71 " -c <file> read from <file> instead of reading from the default\n"
72 " cache file (-c /dev/null means no cache)\n"
73 " -d don't encode non-printing characters\n"
74 " -h print this usage message and exit\n"
75 " -g garbage collect the blkid cache\n"
76 " -o <format> output format; can be one of:\n"
77 " value, device, export or full; (default: full)\n"
78 " -k list all known filesystems/RAIDs and exit\n"
79 " -s <tag> show specified tag(s) (default show all tags)\n"
80 " -t <token> find device with a specific token (NAME=value pair)\n"
81 " -l look up only first device with token specified by -t\n"
82 " -L <label> convert LABEL to device name\n"
83 " -U <uuid> convert UUID to device name\n"
84 " -V print version and exit\n"
85 " <dev> specify device(s) to probe (default: all devices)\n\n"
86 "Low-level probing options:\n"
87 " -p low-level superblocks probing (bypass cache)\n"
88 " -i gather information about I/O limits\n"
89 " -S <size> overwrite device size\n"
90 " -O <offset> probe at the given offset\n"
91 " -u <list> filter by \"usage\" (e.g. -u filesystem,raid)\n"
92 " -n <list> filter by filesystem type (e.g. -n vfat,ext3)\n"
93 "\n", program_invocation_short_name
);
99 * This function does "safe" printing. It will convert non-printable
100 * ASCII characters using '^' and M- notation.
102 * If 'esc' is defined then escape all chars from esc by \.
104 static void safe_print(const char *cp
, int len
, const char *esc
)
118 if ((ch
< 32) || (ch
== 0x7f)) {
120 ch
^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
122 } else if (esc
&& strchr(esc
, ch
))
129 static int pretty_print_word(const char *str
, int max_len
,
130 int left_len
, int overflow_nl
)
132 int len
= strlen(str
) + left_len
;
136 if (overflow_nl
&& len
> max_len
) {
139 } else if (len
> max_len
)
143 while (len
++ < max_len
);
147 static void pretty_print_line(const char *device
, const char *fs_type
,
148 const char *label
, const char *mtpt
,
151 static int device_len
= 10, fs_type_len
= 7;
152 static int label_len
= 8, mtpt_len
= 14;
153 static int term_width
= -1;
156 if (term_width
< 0) {
157 term_width
= get_terminal_width(80);
159 if (term_width
> 80) {
172 len
= pretty_print_word(device
, device_len
, 0, 1);
173 len
= pretty_print_word(fs_type
, fs_type_len
, len
, 0);
174 len
= pretty_print_word(label
, label_len
, len
, 0);
175 pretty_print_word(mtpt
, mtpt_len
, len
, 0);
181 static void pretty_print_dev(blkid_dev dev
)
183 blkid_tag_iterate iter
;
184 const char *type
, *value
, *devname
;
185 const char *uuid
= "", *fs_type
= "", *label
= "";
186 int len
, mount_flags
;
191 pretty_print_line("device", "fs_type", "label",
192 "mount point", "UUID");
193 for (len
=get_terminal_width(0)-1; len
> 0; len
--)
199 devname
= blkid_dev_devname(dev
);
200 if (access(devname
, F_OK
))
203 /* Get the uuid, label, type */
204 iter
= blkid_tag_iterate_begin(dev
);
205 while (blkid_tag_next(iter
, &type
, &value
) == 0) {
206 if (!strcmp(type
, "UUID"))
208 if (!strcmp(type
, "TYPE"))
210 if (!strcmp(type
, "LABEL"))
213 blkid_tag_iterate_end(iter
);
215 /* Get the mount point */
217 retval
= check_mount_point(devname
, &mount_flags
, mtpt
, sizeof(mtpt
));
219 if (mount_flags
& MF_MOUNTED
) {
221 strcpy(mtpt
, "(mounted, mtpt unknown)");
222 } else if (mount_flags
& MF_BUSY
)
223 strcpy(mtpt
, "(in use)");
225 strcpy(mtpt
, "(not mounted)");
228 pretty_print_line(devname
, fs_type
, label
, mtpt
, uuid
);
231 static void print_udev_format(const char *name
, const char *value
)
233 char enc
[265], safe
[256];
234 size_t namelen
= strlen(name
);
238 if (!strcmp(name
, "TYPE") || !strcmp(name
, "VERSION")) {
239 blkid_encode_string(value
, enc
, sizeof(enc
));
240 printf("ID_FS_%s=%s\n", name
, enc
);
242 } else if (!strcmp(name
, "UUID") ||
243 !strcmp(name
, "LABEL") ||
244 !strcmp(name
, "UUID_SUB")) {
246 blkid_safe_string(value
, safe
, sizeof(safe
));
247 printf("ID_FS_%s=%s\n", name
, safe
);
249 blkid_encode_string(value
, enc
, sizeof(enc
));
250 printf("ID_FS_%s_ENC=%s\n", name
, enc
);
252 } else if (!strcmp(name
, "PTUUID")) {
253 printf("ID_PART_TABLE_UUID=%s\n", value
);
255 } else if (!strcmp(name
, "PTTYPE")) {
256 printf("ID_PART_TABLE_TYPE=%s\n", value
);
258 } else if (!strcmp(name
, "PART_ENTRY_NAME") ||
259 !strcmp(name
, "PART_ENTRY_TYPE")) {
261 blkid_encode_string(value
, enc
, sizeof(enc
));
262 printf("ID_%s=%s\n", name
, enc
);
264 } else if (!strncmp(name
, "PART_ENTRY_", 11))
265 printf("ID_%s=%s\n", name
, value
);
267 else if (namelen
>= 15 && (
268 !strcmp(name
+ (namelen
- 12), "_SECTOR_SIZE") ||
269 !strcmp(name
+ (namelen
- 8), "_IO_SIZE") ||
270 !strcmp(name
, "ALIGNMENT_OFFSET")))
271 printf("ID_IOLIMIT_%s=%s\n", name
, value
);
273 printf("ID_FS_%s=%s\n", name
, value
);
276 static int has_item(char *ary
[], const char *item
)
280 for (p
= ary
; *p
!= NULL
; p
++)
281 if (!strcmp(item
, *p
))
286 static void print_value(int output
, int num
, const char *devname
,
287 const char *value
, const char *name
, size_t valsz
)
289 if (output
& OUTPUT_VALUE_ONLY
) {
290 fputs(value
, stdout
);
293 } else if (output
& OUTPUT_UDEV_LIST
) {
294 print_udev_format(name
, value
);
296 } else if (output
& OUTPUT_EXPORT_LIST
) {
297 if (num
== 1 && devname
)
298 printf("DEVNAME=%s\n", devname
);
301 safe_print(value
, valsz
, " \\\"'$`<>");
305 if (num
== 1 && devname
)
306 printf("%s:", devname
);
309 fputs("=\"", stdout
);
310 safe_print(value
, valsz
, "\"\\");
315 static void print_tags(blkid_dev dev
, char *show
[], int output
)
317 blkid_tag_iterate iter
;
318 const char *type
, *value
, *devname
;
320 static int first
= 1;
325 if (output
& OUTPUT_PRETTY_LIST
) {
326 pretty_print_dev(dev
);
330 devname
= blkid_dev_devname(dev
);
332 if (output
& OUTPUT_DEVICE_ONLY
) {
333 printf("%s\n", devname
);
337 iter
= blkid_tag_iterate_begin(dev
);
338 while (blkid_tag_next(iter
, &type
, &value
) == 0) {
339 if (show
[0] && !has_item(show
, type
))
342 if (num
== 1 && !first
&&
343 (output
& (OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
)))
344 /* add extra line between output from more devices */
347 print_value(output
, num
++, devname
, value
, type
, strlen(value
));
349 blkid_tag_iterate_end(iter
);
352 if (!(output
& (OUTPUT_VALUE_ONLY
| OUTPUT_UDEV_LIST
|
353 OUTPUT_EXPORT_LIST
)))
360 static int append_str(char **res
, size_t *sz
, const char *a
, const char *b
)
363 size_t asz
= a
? strlen(a
) : 0;
364 size_t bsz
= b
? strlen(b
) : 0;
365 size_t len
= *sz
+ asz
+ bsz
;
370 *res
= str
= xrealloc(str
, len
+ 1);
387 * Compose and print ID_FS_AMBIVALENT for udev
389 static int print_udev_ambivalent(blkid_probe pr
)
393 int count
= 0, rc
= -1;
395 while (!blkid_do_probe(pr
)) {
396 const char *usage_txt
= NULL
, *type
= NULL
, *version
= NULL
;
399 blkid_probe_lookup_value(pr
, "USAGE", &usage_txt
, NULL
);
400 blkid_probe_lookup_value(pr
, "TYPE", &type
, NULL
);
401 blkid_probe_lookup_value(pr
, "VERSION", &version
, NULL
);
403 if (!usage_txt
|| !type
)
406 blkid_encode_string(usage_txt
, enc
, sizeof(enc
));
407 if (append_str(&val
, &valsz
, enc
, ":"))
410 blkid_encode_string(type
, enc
, sizeof(enc
));
411 if (append_str(&val
, &valsz
, enc
, version
? ":" : " "))
415 blkid_encode_string(version
, enc
, sizeof(enc
));
416 if (append_str(&val
, &valsz
, enc
, " "))
423 *(val
+ valsz
- 1) = '\0'; /* rem tailing whitespace */
424 printf("ID_FS_AMBIVALENT=%s\n", val
);
432 static int lowprobe_superblocks(blkid_probe pr
)
435 int rc
, fd
= blkid_probe_get_fd(pr
);
437 if (fd
< 0 || fstat(fd
, &st
))
440 blkid_probe_enable_partitions(pr
, 1);
442 if (!S_ISCHR(st
.st_mode
) && blkid_probe_get_size(pr
) <= 1024 * 1440 &&
443 blkid_probe_is_wholedisk(pr
)) {
445 * check if the small disk is partitioned, if yes then
446 * don't probe for filesystems.
448 blkid_probe_enable_superblocks(pr
, 0);
450 rc
= blkid_do_fullprobe(pr
);
452 return rc
; /* -1 = error, 1 = nothing, 0 = succes */
454 if (blkid_probe_lookup_value(pr
, "PTTYPE", NULL
, NULL
) == 0)
455 return 0; /* partition table detected */
458 blkid_probe_set_partitions_flags(pr
, BLKID_PARTS_ENTRY_DETAILS
);
459 blkid_probe_enable_superblocks(pr
, 1);
461 return blkid_do_safeprobe(pr
);
464 static int lowprobe_topology(blkid_probe pr
)
466 /* enable topology probing only */
467 blkid_probe_enable_topology(pr
, 1);
469 blkid_probe_enable_superblocks(pr
, 0);
470 blkid_probe_enable_partitions(pr
, 0);
472 return blkid_do_fullprobe(pr
);
475 static int lowprobe_device(blkid_probe pr
, const char *devname
,
476 int chain
, char *show
[], int output
,
477 uint64_t offset
, uint64_t size
)
481 int nvals
= 0, n
, num
= 1;
485 static int first
= 1;
487 fd
= open(devname
, O_RDONLY
|O_CLOEXEC
);
489 fprintf(stderr
, "error: %s: %m\n", devname
);
490 return BLKID_EXIT_NOTFOUND
;
492 if (blkid_probe_set_device(pr
, fd
, offset
, size
))
495 if (chain
& LOWPROBE_TOPOLOGY
)
496 rc
= lowprobe_topology(pr
);
497 if (rc
>= 0 && (chain
& LOWPROBE_SUPERBLOCKS
))
498 rc
= lowprobe_superblocks(pr
);
503 nvals
= blkid_probe_numof_values(pr
);
505 if (nvals
&& !first
&& output
& (OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
))
506 /* add extra line between output from devices */
509 if (nvals
&& (output
& OUTPUT_DEVICE_ONLY
)) {
510 printf("%s\n", devname
);
514 for (n
= 0; n
< nvals
; n
++) {
515 if (blkid_probe_get_value(pr
, n
, &name
, &data
, &len
))
517 if (show
[0] && !has_item(show
, name
))
519 len
= strnlen((char *) data
, len
);
520 print_value(output
, num
++, devname
, (char *) data
, name
, len
);
525 if (nvals
>= 1 && !(output
& (OUTPUT_VALUE_ONLY
|
526 OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
)))
530 if (output
& OUTPUT_UDEV_LIST
)
531 print_udev_ambivalent(pr
);
534 "%s: ambivalent result (probably more "
535 "filesystems on the device, use wipefs(8) "
536 "to see more details)\n",
542 return BLKID_EXIT_AMBIVAL
; /* ambivalent probing result */
544 return BLKID_EXIT_NOTFOUND
; /* nothing detected */
546 return 0; /* success */
549 /* converts comma separated list to BLKID_USAGE_* mask */
550 static int list_to_usage(const char *list
, int *flag
)
553 const char *word
= NULL
, *p
= list
;
555 if (p
&& strncmp(p
, "no", 2) == 0) {
556 *flag
= BLKID_FLTR_NOTIN
;
566 if (!strncmp(word
, "filesystem", 10))
567 mask
|= BLKID_USAGE_FILESYSTEM
;
568 else if (!strncmp(word
, "raid", 4))
569 mask
|= BLKID_USAGE_RAID
;
570 else if (!strncmp(word
, "crypto", 6))
571 mask
|= BLKID_USAGE_CRYPTO
;
572 else if (!strncmp(word
, "other", 5))
573 mask
|= BLKID_USAGE_OTHER
;
580 fprintf(stderr
, "unknown keyword in -u <list> argument: '%s'\n",
582 exit(BLKID_EXIT_OTHER
);
585 /* converts comma separated list to types[] */
586 static char **list_to_types(const char *list
, int *flag
)
589 const char *p
= list
;
592 if (p
&& strncmp(p
, "no", 2) == 0) {
593 *flag
= BLKID_FLTR_NOTIN
;
597 fprintf(stderr
, "error: -u <list> argument is empty\n");
600 for (i
= 1; p
&& (p
= strchr(p
, ',')); i
++, p
++);
602 res
= xcalloc(i
+ 1, sizeof(char *));
603 p
= *flag
& BLKID_FLTR_NOTIN
? list
+ 2 : list
;
607 const char *word
= p
;
609 res
[i
++] = p
? xstrndup(word
, p
- word
) : xstrdup(word
);
618 exit(BLKID_EXIT_OTHER
);
621 static void free_types_list(char *list
[])
627 for (n
= list
; *n
; n
++)
632 int main(int argc
, char **argv
)
634 blkid_cache cache
= NULL
;
635 char **devices
= NULL
;
636 char *show
[128] = { NULL
, };
637 char *search_type
= NULL
, *search_value
= NULL
;
640 char **fltr_type
= NULL
;
641 int fltr_flag
= BLKID_FLTR_ONLYIN
;
642 unsigned int numdev
= 0, numtag
= 0;
644 int err
= BLKID_EXIT_OTHER
;
646 int output_format
= 0;
647 int lookup
= 0, gc
= 0, lowprobe
= 0, eval
= 0;
649 uintmax_t offset
= 0, size
= 0;
651 static const ul_excl_t excl
[] = { /* rows and cols in in ASCII order */
655 int excl_st
[ARRAY_SIZE(excl
)] = UL_EXCL_STATUS_INIT
;
658 atexit(close_stdout
);
660 while ((c
= getopt (argc
, argv
,
661 "c:df:ghilL:n:ko:O:ps:S:t:u:U:w:Vv")) != EOF
) {
663 err_exclusive_options(c
, NULL
, excl
, excl_st
);
667 if (optarg
&& !*optarg
)
677 search_value
= xstrdup(optarg
);
678 search_type
= xstrdup("LABEL");
681 fltr_type
= list_to_types(optarg
, &fltr_flag
);
684 fltr_usage
= list_to_usage(optarg
, &fltr_flag
);
688 search_value
= xstrdup(optarg
);
689 search_type
= xstrdup("UUID");
692 lowprobe
|= LOWPROBE_TOPOLOGY
;
703 const char *name
= NULL
;
705 while (blkid_superblocks_get_name(idx
++, &name
, NULL
) == 0)
706 printf("%s\n", name
);
710 if (!strcmp(optarg
, "value"))
711 output_format
= OUTPUT_VALUE_ONLY
;
712 else if (!strcmp(optarg
, "device"))
713 output_format
= OUTPUT_DEVICE_ONLY
;
714 else if (!strcmp(optarg
, "list"))
715 output_format
= OUTPUT_PRETTY_LIST
; /* deprecated */
716 else if (!strcmp(optarg
, "udev"))
717 output_format
= OUTPUT_UDEV_LIST
;
718 else if (!strcmp(optarg
, "export"))
719 output_format
= OUTPUT_EXPORT_LIST
;
720 else if (!strcmp(optarg
, "full"))
723 fprintf(stderr
, "Invalid output format %s. "
724 "Choose from value,\n\t"
725 "device, list, udev or full\n", optarg
);
726 exit(BLKID_EXIT_OTHER
);
730 offset
= strtosize_or_err(optarg
, "invalid offset argument");
733 lowprobe
|= LOWPROBE_SUPERBLOCKS
;
736 if (numtag
+ 1 >= sizeof(show
) / sizeof(*show
)) {
737 fprintf(stderr
, "Too many tags specified\n");
740 show
[numtag
++] = optarg
;
744 size
= strtosize_or_err(optarg
, "invalid size argument");
748 fprintf(stderr
, "Can only search for "
749 "one NAME=value pair\n");
752 if (blkid_parse_tag_string(optarg
,
755 fprintf(stderr
, "-t needs NAME=value pair\n");
764 /* ignore - backward compatibility */
775 /* The rest of the args are device names */
777 devices
= xcalloc(argc
- optind
, sizeof(char *));
778 while (optind
< argc
)
779 devices
[numdev
++] = argv
[optind
++];
783 print_version(stdout
);
787 /* convert LABEL/UUID lookup to evaluate request */
788 if (lookup
&& output_format
== OUTPUT_DEVICE_ONLY
&& search_type
&&
789 (!strcmp(search_type
, "LABEL") || !strcmp(search_type
, "UUID"))) {
794 if (!lowprobe
&& !eval
&& blkid_get_cache(&cache
, read
) < 0)
798 blkid_gc_cache(cache
);
802 err
= BLKID_EXIT_NOTFOUND
;
804 if (eval
== 0 && (output_format
& OUTPUT_PRETTY_LIST
)) {
806 fprintf(stderr
, "The low-level probing mode does not "
807 "support 'list' output format\n");
808 exit(BLKID_EXIT_OTHER
);
810 pretty_print_dev(NULL
);
820 fprintf(stderr
, "The low-level probing mode "
821 "requires a device\n");
822 exit(BLKID_EXIT_OTHER
);
825 /* automatically enable 'export' format for I/O Limits */
826 if (!output_format
&& (lowprobe
& LOWPROBE_TOPOLOGY
))
827 output_format
= OUTPUT_EXPORT_LIST
;
829 pr
= blkid_new_probe();
833 if (lowprobe
& LOWPROBE_SUPERBLOCKS
) {
834 blkid_probe_set_superblocks_flags(pr
,
835 BLKID_SUBLKS_LABEL
| BLKID_SUBLKS_UUID
|
836 BLKID_SUBLKS_TYPE
| BLKID_SUBLKS_SECTYPE
|
837 BLKID_SUBLKS_USAGE
| BLKID_SUBLKS_VERSION
);
839 if (fltr_usage
&& blkid_probe_filter_superblocks_usage(
840 pr
, fltr_flag
, fltr_usage
))
843 else if (fltr_type
&& blkid_probe_filter_superblocks_type(
844 pr
, fltr_flag
, fltr_type
))
848 for (i
= 0; i
< numdev
; i
++) {
849 err
= lowprobe_device(pr
, devices
[i
], lowprobe
, show
,
856 blkid_free_probe(pr
);
861 char *res
= blkid_evaluate_tag(search_type
, search_value
, NULL
);
868 * Classic (cache based) API
873 fprintf(stderr
, "The lookup option requires a "
874 "search type specified using -t\n");
875 exit(BLKID_EXIT_OTHER
);
877 /* Load any additional devices not in the cache */
878 for (i
= 0; i
< numdev
; i
++)
879 blkid_get_dev(cache
, devices
[i
], BLKID_DEV_NORMAL
);
881 if ((dev
= blkid_find_dev_with_tag(cache
, search_type
,
883 print_tags(dev
, show
, output_format
);
886 /* If we didn't specify a single device, show all available devices */
887 } else if (!numdev
) {
888 blkid_dev_iterate iter
;
891 blkid_probe_all(cache
);
893 iter
= blkid_dev_iterate_begin(cache
);
894 blkid_dev_set_search(iter
, search_type
, search_value
);
895 while (blkid_dev_next(iter
, &dev
) == 0) {
896 dev
= blkid_verify(cache
, dev
);
899 print_tags(dev
, show
, output_format
);
902 blkid_dev_iterate_end(iter
);
903 /* Add all specified devices to cache (optionally display tags) */
904 } else for (i
= 0; i
< numdev
; i
++) {
905 blkid_dev dev
= blkid_get_dev(cache
, devices
[i
],
910 !blkid_dev_has_tag(dev
, search_type
,
913 print_tags(dev
, show
, output_format
);
921 free_types_list(fltr_type
);
922 if (!lowprobe
&& !eval
)
923 blkid_put_cache(cache
);