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>
23 extern int getopt(int argc
, char * const argv
[], const char *optstring
);
28 #define OUTPUT_VALUE_ONLY (1 << 1)
29 #define OUTPUT_DEVICE_ONLY (1 << 2)
30 #define OUTPUT_PRETTY_LIST (1 << 3) /* deprecated */
31 #define OUTPUT_UDEV_LIST (1 << 4) /* deprecated */
32 #define OUTPUT_EXPORT_LIST (1 << 5)
34 #define LOWPROBE_TOPOLOGY (1 << 1)
35 #define LOWPROBE_SUPERBLOCKS (1 << 2)
37 #define BLKID_EXIT_NOTFOUND 2 /* token or device not found */
38 #define BLKID_EXIT_OTHER 4 /* bad usage or other error */
39 #define BLKID_EXIT_AMBIVAL 8 /* ambivalent low-level probing detected */
43 #include "ismounted.h"
45 #define STRTOXX_EXIT_CODE BLKID_EXIT_OTHER /* strtoxx_or_err() */
47 #define OPTUTILS_EXIT_CODE BLKID_EXIT_OTHER /* exclusive_option() */
50 #include "closestream.h"
54 const char *progname
= "blkid";
58 static void print_version(FILE *out
)
60 fprintf(out
, "%s from %s (libblkid %s, %s)\n",
61 program_invocation_short_name
, PACKAGE_STRING
,
62 LIBBLKID_VERSION
, LIBBLKID_DATE
);
65 static void usage(int error
)
67 FILE *out
= error
? stderr
: stdout
;
72 " %1$s -L <label> | -U <uuid>\n\n"
73 " %1$s [-c <file>] [-ghlLv] [-o <format>] [-s <tag>] \n"
74 " [-t <token>] [<dev> ...]\n\n"
75 " %1$s -p [-s <tag>] [-O <offset>] [-S <size>] \n"
76 " [-o <format>] <dev> ...\n\n"
77 " %1$s -i [-s <tag>] [-o <format>] <dev> ...\n\n"
79 " -c <file> read from <file> instead of reading from the default\n"
80 " cache file (-c /dev/null means no cache)\n"
81 " -d don't encode non-printing characters\n"
82 " -h print this usage message and exit\n"
83 " -g garbage collect the blkid cache\n"
84 " -o <format> output format; can be one of:\n"
85 " value, device, export or full; (default: full)\n"
86 " -k list all known filesystems/RAIDs and exit\n"
87 " -s <tag> show specified tag(s) (default show all tags)\n"
88 " -t <token> find device with a specific token (NAME=value pair)\n"
89 " -l look up only first device with token specified by -t\n"
90 " -L <label> convert LABEL to device name\n"
91 " -U <uuid> convert UUID to device name\n"
92 " -V print version and exit\n"
93 " <dev> specify device(s) to probe (default: all devices)\n\n"
94 "Low-level probing options:\n"
95 " -p low-level superblocks probing (bypass cache)\n"
96 " -i gather information about I/O limits\n"
97 " -S <size> overwrite device size\n"
98 " -O <offset> probe at the given offset\n"
99 " -u <list> filter by \"usage\" (e.g. -u filesystem,raid)\n"
100 " -n <list> filter by filesystem type (e.g. -n vfat,ext3)\n"
107 * This function does "safe" printing. It will convert non-printable
108 * ASCII characters using '^' and M- notation.
110 static void safe_print(const char *cp
, int len
)
124 if ((ch
< 32) || (ch
== 0x7f)) {
126 ch
^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
133 static int pretty_print_word(const char *str
, int max_len
,
134 int left_len
, int overflow_nl
)
136 int len
= strlen(str
) + left_len
;
140 if (overflow_nl
&& len
> max_len
) {
143 } else if (len
> max_len
)
147 while (len
++ < max_len
);
151 static void pretty_print_line(const char *device
, const char *fs_type
,
152 const char *label
, const char *mtpt
,
155 static int device_len
= 10, fs_type_len
= 7;
156 static int label_len
= 8, mtpt_len
= 14;
157 static int term_width
= -1;
160 if (term_width
< 0) {
161 term_width
= get_terminal_width();
165 if (term_width
> 80) {
178 len
= pretty_print_word(device
, device_len
, 0, 1);
179 len
= pretty_print_word(fs_type
, fs_type_len
, len
, 0);
180 len
= pretty_print_word(label
, label_len
, len
, 0);
181 pretty_print_word(mtpt
, mtpt_len
, len
, 0);
187 static void pretty_print_dev(blkid_dev dev
)
189 blkid_tag_iterate iter
;
190 const char *type
, *value
, *devname
;
191 const char *uuid
= "", *fs_type
= "", *label
= "";
192 int len
, mount_flags
;
197 pretty_print_line("device", "fs_type", "label",
198 "mount point", "UUID");
199 for (len
=get_terminal_width()-1; len
> 0; len
--)
205 devname
= blkid_dev_devname(dev
);
206 if (access(devname
, F_OK
))
209 /* Get the uuid, label, type */
210 iter
= blkid_tag_iterate_begin(dev
);
211 while (blkid_tag_next(iter
, &type
, &value
) == 0) {
212 if (!strcmp(type
, "UUID"))
214 if (!strcmp(type
, "TYPE"))
216 if (!strcmp(type
, "LABEL"))
219 blkid_tag_iterate_end(iter
);
221 /* Get the mount point */
223 retval
= check_mount_point(devname
, &mount_flags
, mtpt
, sizeof(mtpt
));
225 if (mount_flags
& MF_MOUNTED
) {
227 strcpy(mtpt
, "(mounted, mtpt unknown)");
228 } else if (mount_flags
& MF_BUSY
)
229 strcpy(mtpt
, "(in use)");
231 strcpy(mtpt
, "(not mounted)");
234 pretty_print_line(devname
, fs_type
, label
, mtpt
, uuid
);
237 static void print_udev_format(const char *name
, const char *value
)
239 char enc
[265], safe
[256];
240 size_t namelen
= strlen(name
);
244 if (!strcmp(name
, "TYPE") || !strcmp(name
, "VERSION")) {
245 blkid_encode_string(value
, enc
, sizeof(enc
));
246 printf("ID_FS_%s=%s\n", name
, enc
);
248 } else if (!strcmp(name
, "UUID") ||
249 !strcmp(name
, "LABEL") ||
250 !strcmp(name
, "UUID_SUB")) {
252 blkid_safe_string(value
, safe
, sizeof(safe
));
253 printf("ID_FS_%s=%s\n", name
, safe
);
255 blkid_encode_string(value
, enc
, sizeof(enc
));
256 printf("ID_FS_%s_ENC=%s\n", name
, enc
);
258 } else if (!strcmp(name
, "PTTYPE")) {
259 printf("ID_PART_TABLE_TYPE=%s\n", value
);
261 } else if (!strcmp(name
, "PART_ENTRY_NAME") ||
262 !strcmp(name
, "PART_ENTRY_TYPE")) {
264 blkid_encode_string(value
, enc
, sizeof(enc
));
265 printf("ID_%s=%s\n", name
, enc
);
267 } else if (!strncmp(name
, "PART_ENTRY_", 11))
268 printf("ID_%s=%s\n", name
, value
);
270 else if (namelen
>= 15 && (
271 !strcmp(name
+ (namelen
- 12), "_SECTOR_SIZE") ||
272 !strcmp(name
+ (namelen
- 8), "_IO_SIZE") ||
273 !strcmp(name
, "ALIGNMENT_OFFSET")))
274 printf("ID_IOLIMIT_%s=%s\n", name
, value
);
276 printf("ID_FS_%s=%s\n", name
, value
);
279 static int has_item(char *ary
[], const char *item
)
283 for (p
= ary
; *p
!= NULL
; p
++)
284 if (!strcmp(item
, *p
))
289 static void print_value(int output
, int num
, const char *devname
,
290 const char *value
, const char *name
, size_t valsz
)
292 if (output
& OUTPUT_VALUE_ONLY
) {
293 fputs(value
, stdout
);
296 } else if (output
& OUTPUT_UDEV_LIST
) {
297 print_udev_format(name
, value
);
299 } else if (output
& OUTPUT_EXPORT_LIST
) {
300 if (num
== 1 && devname
)
301 printf("DEVNAME=%s\n", devname
);
304 safe_print(value
, valsz
);
308 if (num
== 1 && devname
)
309 printf("%s: ", devname
);
311 fputs("=\"", stdout
);
312 safe_print(value
, valsz
);
313 fputs("\" ", stdout
);
317 static void print_tags(blkid_dev dev
, char *show
[], int output
)
319 blkid_tag_iterate iter
;
320 const char *type
, *value
, *devname
;
322 static int first
= 1;
327 if (output
& OUTPUT_PRETTY_LIST
) {
328 pretty_print_dev(dev
);
332 devname
= blkid_dev_devname(dev
);
334 if (output
& OUTPUT_DEVICE_ONLY
) {
335 printf("%s\n", devname
);
339 iter
= blkid_tag_iterate_begin(dev
);
340 while (blkid_tag_next(iter
, &type
, &value
) == 0) {
341 if (show
[0] && !has_item(show
, type
))
344 if (num
== 1 && !first
&&
345 (output
& (OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
)))
346 /* add extra line between output from more devices */
349 print_value(output
, num
++, devname
, value
, type
, strlen(value
));
351 blkid_tag_iterate_end(iter
);
354 if (!(output
& (OUTPUT_VALUE_ONLY
| OUTPUT_UDEV_LIST
|
355 OUTPUT_EXPORT_LIST
)))
362 static int append_str(char **res
, size_t *sz
, const char *a
, const char *b
)
365 size_t asz
= a
? strlen(a
) : 0;
366 size_t bsz
= b
? strlen(b
) : 0;
367 size_t len
= *sz
+ asz
+ bsz
;
372 str
= realloc(str
, len
+ 1);
396 * Compose and print ID_FS_AMBIVALENT for udev
398 static int print_udev_ambivalent(blkid_probe pr
)
402 int count
= 0, rc
= -1;
404 while (!blkid_do_probe(pr
)) {
405 const char *usage_txt
= NULL
, *type
= NULL
, *version
= NULL
;
408 blkid_probe_lookup_value(pr
, "USAGE", &usage_txt
, NULL
);
409 blkid_probe_lookup_value(pr
, "TYPE", &type
, NULL
);
410 blkid_probe_lookup_value(pr
, "VERSION", &version
, NULL
);
412 if (!usage_txt
|| !type
)
415 blkid_encode_string(usage_txt
, enc
, sizeof(enc
));
416 if (append_str(&val
, &valsz
, enc
, ":"))
419 blkid_encode_string(type
, enc
, sizeof(enc
));
420 if (append_str(&val
, &valsz
, enc
, version
? ":" : " "))
424 blkid_encode_string(version
, enc
, sizeof(enc
));
425 if (append_str(&val
, &valsz
, enc
, " "))
432 *(val
+ valsz
- 1) = '\0'; /* rem tailing whitespace */
433 printf("ID_FS_AMBIVALEN=%s\n", val
);
441 static int lowprobe_superblocks(blkid_probe pr
)
444 int rc
, fd
= blkid_probe_get_fd(pr
);
446 if (fd
< 0 || fstat(fd
, &st
))
449 blkid_probe_enable_partitions(pr
, 1);
451 if (!S_ISCHR(st
.st_mode
) && blkid_probe_get_size(pr
) <= 1024 * 1440 &&
452 blkid_probe_is_wholedisk(pr
)) {
454 * check if the small disk is partitioned, if yes then
455 * don't probe for filesystems.
457 blkid_probe_enable_superblocks(pr
, 0);
459 rc
= blkid_do_fullprobe(pr
);
461 return rc
; /* -1 = error, 1 = nothing, 0 = succes */
463 if (blkid_probe_lookup_value(pr
, "PTTYPE", NULL
, NULL
) == 0)
464 return 0; /* partition table detected */
467 blkid_probe_set_partitions_flags(pr
, BLKID_PARTS_ENTRY_DETAILS
);
468 blkid_probe_enable_superblocks(pr
, 1);
470 return blkid_do_safeprobe(pr
);
473 static int lowprobe_topology(blkid_probe pr
)
475 /* enable topology probing only */
476 blkid_probe_enable_topology(pr
, 1);
478 blkid_probe_enable_superblocks(pr
, 0);
479 blkid_probe_enable_partitions(pr
, 0);
481 return blkid_do_fullprobe(pr
);
484 static int lowprobe_device(blkid_probe pr
, const char *devname
,
485 int chain
, char *show
[], int output
,
486 blkid_loff_t offset
, blkid_loff_t size
)
490 int nvals
= 0, n
, num
= 1;
494 static int first
= 1;
496 fd
= open(devname
, O_RDONLY
|O_CLOEXEC
);
498 fprintf(stderr
, "error: %s: %m\n", devname
);
499 return BLKID_EXIT_NOTFOUND
;
501 if (blkid_probe_set_device(pr
, fd
, offset
, size
))
504 if (chain
& LOWPROBE_TOPOLOGY
)
505 rc
= lowprobe_topology(pr
);
506 if (rc
>= 0 && (chain
& LOWPROBE_SUPERBLOCKS
))
507 rc
= lowprobe_superblocks(pr
);
512 nvals
= blkid_probe_numof_values(pr
);
515 !(chain
& LOWPROBE_TOPOLOGY
) &&
516 !(output
& OUTPUT_UDEV_LIST
) &&
517 !blkid_probe_has_value(pr
, "TYPE") &&
518 !blkid_probe_has_value(pr
, "PTTYPE"))
520 * Ignore probing result if there is not any filesystem or
521 * partition table on the device and udev output is not
524 * The udev db stores information about partitions, so
525 * PART_ENTRY_* values are alway important.
529 if (nvals
&& !first
&& output
& (OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
))
530 /* add extra line between output from devices */
533 if (nvals
&& (output
& OUTPUT_DEVICE_ONLY
)) {
534 printf("%s\n", devname
);
538 for (n
= 0; n
< nvals
; n
++) {
539 if (blkid_probe_get_value(pr
, n
, &name
, &data
, &len
))
541 if (show
[0] && !has_item(show
, name
))
543 len
= strnlen((char *) data
, len
);
544 print_value(output
, num
++, devname
, (char *) data
, name
, len
);
549 if (nvals
>= 1 && !(output
& (OUTPUT_VALUE_ONLY
|
550 OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
)))
554 if (output
& OUTPUT_UDEV_LIST
)
555 print_udev_ambivalent(pr
);
558 "%s: ambivalent result (probably more "
559 "filesystems on the device, use wipefs(8) "
560 "to see more details)\n",
566 return BLKID_EXIT_AMBIVAL
; /* ambivalent probing result */
568 return BLKID_EXIT_NOTFOUND
; /* nothing detected */
570 return 0; /* success */
573 /* converts comma separated list to BLKID_USAGE_* mask */
574 static int list_to_usage(const char *list
, int *flag
)
577 const char *word
= NULL
, *p
= list
;
579 if (p
&& strncmp(p
, "no", 2) == 0) {
580 *flag
= BLKID_FLTR_NOTIN
;
590 if (!strncmp(word
, "filesystem", 10))
591 mask
|= BLKID_USAGE_FILESYSTEM
;
592 else if (!strncmp(word
, "raid", 4))
593 mask
|= BLKID_USAGE_RAID
;
594 else if (!strncmp(word
, "crypto", 6))
595 mask
|= BLKID_USAGE_CRYPTO
;
596 else if (!strncmp(word
, "other", 5))
597 mask
|= BLKID_USAGE_OTHER
;
604 fprintf(stderr
, "unknown kerword in -u <list> argument: '%s'\n",
606 exit(BLKID_EXIT_OTHER
);
609 /* converts comma separated list to types[] */
610 static char **list_to_types(const char *list
, int *flag
)
613 const char *p
= list
;
616 if (p
&& strncmp(p
, "no", 2) == 0) {
617 *flag
= BLKID_FLTR_NOTIN
;
621 fprintf(stderr
, "error: -u <list> argument is empty\n");
624 for (i
= 1; p
&& (p
= strchr(p
, ',')); i
++, p
++);
626 res
= calloc(i
+ 1, sizeof(char *));
629 p
= *flag
& BLKID_FLTR_NOTIN
? list
+ 2 : list
;
633 const char *word
= p
;
635 res
[i
] = p
? strndup(word
, p
- word
) : strdup(word
);
644 fprintf(stderr
, "out of memory\n");
648 exit(BLKID_EXIT_OTHER
);
651 static void free_types_list(char *list
[])
657 for (n
= list
; *n
; n
++)
662 int main(int argc
, char **argv
)
664 blkid_cache cache
= NULL
;
665 char **devices
= NULL
;
666 char *show
[128] = { NULL
, };
667 char *search_type
= NULL
, *search_value
= NULL
;
670 char **fltr_type
= NULL
;
671 int fltr_flag
= BLKID_FLTR_ONLYIN
;
672 unsigned int numdev
= 0, numtag
= 0;
674 int err
= BLKID_EXIT_OTHER
;
676 int output_format
= 0;
677 int lookup
= 0, gc
= 0, lowprobe
= 0, eval
= 0;
679 uintmax_t offset
= 0, size
= 0;
681 static const ul_excl_t excl
[] = { /* rows and cols in in ASCII order */
685 int excl_st
[ARRAY_SIZE(excl
)] = UL_EXCL_STATUS_INIT
;
688 atexit(close_stdout
);
690 while ((c
= getopt (argc
, argv
,
691 "c:df:ghilL:n:ko:O:ps:S:t:u:U:w:Vv")) != EOF
) {
693 err_exclusive_options(c
, NULL
, excl
, excl_st
);
697 if (optarg
&& !*optarg
)
707 search_value
= xstrdup(optarg
);
708 search_type
= xstrdup("LABEL");
711 fltr_type
= list_to_types(optarg
, &fltr_flag
);
714 fltr_usage
= list_to_usage(optarg
, &fltr_flag
);
718 search_value
= xstrdup(optarg
);
719 search_type
= xstrdup("UUID");
722 lowprobe
|= LOWPROBE_TOPOLOGY
;
733 const char *name
= NULL
;
735 while (blkid_superblocks_get_name(idx
++, &name
, NULL
) == 0)
736 printf("%s\n", name
);
740 if (!strcmp(optarg
, "value"))
741 output_format
= OUTPUT_VALUE_ONLY
;
742 else if (!strcmp(optarg
, "device"))
743 output_format
= OUTPUT_DEVICE_ONLY
;
744 else if (!strcmp(optarg
, "list"))
745 output_format
= OUTPUT_PRETTY_LIST
; /* deprecated */
746 else if (!strcmp(optarg
, "udev"))
747 output_format
= OUTPUT_UDEV_LIST
;
748 else if (!strcmp(optarg
, "export"))
749 output_format
= OUTPUT_EXPORT_LIST
;
750 else if (!strcmp(optarg
, "full"))
753 fprintf(stderr
, "Invalid output format %s. "
754 "Choose from value,\n\t"
755 "device, list, udev or full\n", optarg
);
756 exit(BLKID_EXIT_OTHER
);
760 offset
= strtosize_or_err(optarg
, "invalid offset argument");
763 lowprobe
|= LOWPROBE_SUPERBLOCKS
;
766 if (numtag
+ 1 >= sizeof(show
) / sizeof(*show
)) {
767 fprintf(stderr
, "Too many tags specified\n");
770 show
[numtag
++] = optarg
;
774 size
= strtosize_or_err(optarg
, "invalid size argument");
778 fprintf(stderr
, "Can only search for "
779 "one NAME=value pair\n");
782 if (blkid_parse_tag_string(optarg
,
785 fprintf(stderr
, "-t needs NAME=value pair\n");
794 /* ignore - backward compatibility */
805 /* The rest of the args are device names */
807 devices
= calloc(argc
- optind
, sizeof(char *));
809 fprintf(stderr
, "Failed to allocate device name array\n");
813 while (optind
< argc
)
814 devices
[numdev
++] = argv
[optind
++];
818 print_version(stdout
);
822 /* convert LABEL/UUID lookup to evaluate request */
823 if (lookup
&& output_format
== OUTPUT_DEVICE_ONLY
&& search_type
&&
824 (!strcmp(search_type
, "LABEL") || !strcmp(search_type
, "UUID"))) {
829 if (!lowprobe
&& !eval
&& blkid_get_cache(&cache
, read
) < 0)
833 blkid_gc_cache(cache
);
837 err
= BLKID_EXIT_NOTFOUND
;
839 if (eval
== 0 && (output_format
& OUTPUT_PRETTY_LIST
)) {
841 fprintf(stderr
, "The low-level probing mode does not "
842 "support 'list' output format\n");
843 exit(BLKID_EXIT_OTHER
);
845 pretty_print_dev(NULL
);
855 fprintf(stderr
, "The low-level probing mode "
856 "requires a device\n");
857 exit(BLKID_EXIT_OTHER
);
860 /* automatically enable 'export' format for I/O Limits */
861 if (!output_format
&& (lowprobe
& LOWPROBE_TOPOLOGY
))
862 output_format
= OUTPUT_EXPORT_LIST
;
864 pr
= blkid_new_probe();
868 if (lowprobe
& LOWPROBE_SUPERBLOCKS
) {
869 blkid_probe_set_superblocks_flags(pr
,
870 BLKID_SUBLKS_LABEL
| BLKID_SUBLKS_UUID
|
871 BLKID_SUBLKS_TYPE
| BLKID_SUBLKS_SECTYPE
|
872 BLKID_SUBLKS_USAGE
| BLKID_SUBLKS_VERSION
);
874 if (fltr_usage
&& blkid_probe_filter_superblocks_usage(
875 pr
, fltr_flag
, fltr_usage
))
878 else if (fltr_type
&& blkid_probe_filter_superblocks_type(
879 pr
, fltr_flag
, fltr_type
))
883 for (i
= 0; i
< numdev
; i
++) {
884 err
= lowprobe_device(pr
, devices
[i
], lowprobe
, show
,
886 (blkid_loff_t
) offset
,
887 (blkid_loff_t
) size
);
891 blkid_free_probe(pr
);
896 char *res
= blkid_evaluate_tag(search_type
, search_value
, NULL
);
903 * Classic (cache based) API
908 fprintf(stderr
, "The lookup option requires a "
909 "search type specified using -t\n");
910 exit(BLKID_EXIT_OTHER
);
912 /* Load any additional devices not in the cache */
913 for (i
= 0; i
< numdev
; i
++)
914 blkid_get_dev(cache
, devices
[i
], BLKID_DEV_NORMAL
);
916 if ((dev
= blkid_find_dev_with_tag(cache
, search_type
,
918 print_tags(dev
, show
, output_format
);
921 /* If we didn't specify a single device, show all available devices */
922 } else if (!numdev
) {
923 blkid_dev_iterate iter
;
926 blkid_probe_all(cache
);
928 iter
= blkid_dev_iterate_begin(cache
);
929 blkid_dev_set_search(iter
, search_type
, search_value
);
930 while (blkid_dev_next(iter
, &dev
) == 0) {
931 dev
= blkid_verify(cache
, dev
);
934 print_tags(dev
, show
, output_format
);
937 blkid_dev_iterate_end(iter
);
938 /* Add all specified devices to cache (optionally display tags) */
939 } else for (i
= 0; i
< numdev
; i
++) {
940 blkid_dev dev
= blkid_get_dev(cache
, devices
[i
],
945 !blkid_dev_has_tag(dev
, search_type
,
948 print_tags(dev
, show
, output_format
);
956 free_types_list(fltr_type
);
957 if (!lowprobe
&& !eval
)
958 blkid_put_cache(cache
);