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>
21 #ifdef HAVE_SYS_IOCTL_H
22 #include <sys/ioctl.h>
27 extern int getopt(int argc
, char * const argv
[], const char *optstring
);
32 #define OUTPUT_VALUE_ONLY (1 << 1)
33 #define OUTPUT_DEVICE_ONLY (1 << 2)
34 #define OUTPUT_PRETTY_LIST (1 << 3)
35 #define OUTPUT_UDEV_LIST (1 << 4)
36 #define OUTPUT_EXPORT_LIST (1 << 5)
38 #define LOWPROBE_TOPOLOGY (1 << 1)
39 #define LOWPROBE_SUPERBLOCKS (1 << 2)
43 #include "ismounted.h"
44 #include "strtosize.h"
46 const char *progname
= "blkid";
48 static void print_version(FILE *out
)
50 fprintf(out
, "%s from %s (libblkid %s, %s)\n",
51 progname
, PACKAGE_STRING
, LIBBLKID_VERSION
, LIBBLKID_DATE
);
54 static void usage(int error
)
56 FILE *out
= error
? stderr
: stdout
;
61 " %1$s -L <label> | -U <uuid>\n\n"
62 " %1$s [-c <file>] [-ghlLv] [-o format] [-s <tag>] \n"
63 " [-t <token>] [-w <file>] [dev ...]\n\n"
64 " %1$s -p [-s <tag>] [-O <offset>] [-S <size>] \n"
65 " [-o format] <dev> [dev ...]\n\n"
66 " %1$s -i [-s <tag>] [-o format] <dev> [dev ...]\n\n"
68 " -c <file> cache file (default: /etc/blkid.tab, /dev/null = none)\n"
69 " -h print this usage message and exit\n"
70 " -g garbage collect the blkid cache\n"
71 " -o <format> output format; can be one of:\n"
72 " value, device, list, udev, export or full; (default: full)\n"
73 " -s <tag> show specified tag(s) (default show all tags)\n"
74 " -t <token> find device with a specific token (NAME=value pair)\n"
75 " -l lookup the the first device with arguments specified by -t\n"
76 " -L <label> convert LABEL to device name\n"
77 " -U <uuid> convert UUID to device name\n"
78 " -v print version and exit\n"
79 " -w <file> write cache to different file (/dev/null = no write)\n"
80 " <dev> specify device(s) to probe (default: all devices)\n\n"
81 "Low-level probing options:\n"
82 " -p low-level superblocks probing (bypass cache)\n"
83 " -i gather information about I/O limits\n"
84 " -S <size> overwrite device size\n"
85 " -O <offset> probe at the given offset\n"
86 " -u <list> filter by \"usage\" (e.g. -u filesystem,raid)\n"
87 " -n <list> filter by filesystem type (e.g. -n vfat,ext3)\n"
95 * This function does "safe" printing. It will convert non-printable
96 * ASCII characters using '^' and M- notation.
98 static void safe_print(const char *cp
, int len
)
111 if ((ch
< 32) || (ch
== 0x7f)) {
113 ch
^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
119 static int get_terminal_width(void)
122 struct ttysize t_win
;
125 struct winsize w_win
;
130 if (ioctl (0, TIOCGSIZE
, &t_win
) == 0)
131 return (t_win
.ts_cols
);
134 if (ioctl (0, TIOCGWINSZ
, &w_win
) == 0)
135 return (w_win
.ws_col
);
137 cp
= getenv("COLUMNS");
139 return strtol(cp
, NULL
, 10);
143 static int pretty_print_word(const char *str
, int max_len
,
144 int left_len
, int overflow_nl
)
146 int len
= strlen(str
) + left_len
;
150 if (overflow_nl
&& len
> max_len
) {
153 } else if (len
> max_len
)
157 while (len
++ < max_len
);
161 static void pretty_print_line(const char *device
, const char *fs_type
,
162 const char *label
, const char *mtpt
,
165 static int device_len
= 10, fs_type_len
= 7;
166 static int label_len
= 8, mtpt_len
= 14;
167 static int term_width
= -1;
171 term_width
= get_terminal_width();
173 if (term_width
> 80) {
186 len
= pretty_print_word(device
, device_len
, 0, 1);
187 len
= pretty_print_word(fs_type
, fs_type_len
, len
, 0);
188 len
= pretty_print_word(label
, label_len
, len
, 0);
189 len
= pretty_print_word(mtpt
, mtpt_len
, len
, 0);
194 static void pretty_print_dev(blkid_dev dev
)
196 blkid_tag_iterate iter
;
197 const char *type
, *value
, *devname
;
198 const char *uuid
= "", *fs_type
= "", *label
= "";
199 int len
, mount_flags
;
204 pretty_print_line("device", "fs_type", "label",
205 "mount point", "UUID");
206 for (len
=get_terminal_width()-1; len
> 0; len
--)
212 devname
= blkid_dev_devname(dev
);
213 if (access(devname
, F_OK
))
216 /* Get the uuid, label, type */
217 iter
= blkid_tag_iterate_begin(dev
);
218 while (blkid_tag_next(iter
, &type
, &value
) == 0) {
219 if (!strcmp(type
, "UUID"))
221 if (!strcmp(type
, "TYPE"))
223 if (!strcmp(type
, "LABEL"))
226 blkid_tag_iterate_end(iter
);
228 /* Get the mount point */
230 retval
= check_mount_point(devname
, &mount_flags
, mtpt
, sizeof(mtpt
));
232 if (mount_flags
& MF_MOUNTED
) {
234 strcpy(mtpt
, "(mounted, mtpt unknown)");
235 } else if (mount_flags
& MF_BUSY
)
236 strcpy(mtpt
, "(in use)");
238 strcpy(mtpt
, "(not mounted)");
241 pretty_print_line(devname
, fs_type
, label
, mtpt
, uuid
);
244 static void print_udev_format(const char *name
, const char *value
, size_t sz
)
246 char enc
[265], safe
[256];
247 size_t namelen
= strlen(name
);
251 if (!strcmp(name
, "TYPE") || !strcmp(name
, "VERSION")) {
252 blkid_encode_string(value
, enc
, sizeof(enc
));
253 printf("ID_FS_%s=%s\n", name
, enc
);
255 } else if (!strcmp(name
, "UUID") ||
256 !strcmp(name
, "LABEL") ||
257 !strcmp(name
, "UUID_SUB")) {
259 blkid_safe_string(value
, safe
, sizeof(safe
));
260 printf("ID_FS_%s=%s\n", name
, safe
);
262 blkid_encode_string(value
, enc
, sizeof(enc
));
263 printf("ID_FS_%s_ENC=%s\n", name
, enc
);
265 } else if (!strcmp(name
, "PTTYPE")) {
266 printf("ID_PART_TABLE_TYPE=%s\n", value
);
268 } else if (!strcmp(name
, "PART_ENTRY_NAME") ||
269 !strcmp(name
, "PART_ENTRY_TYPE")) {
271 blkid_encode_string(value
, enc
, sizeof(enc
));
272 printf("ID_%s=%s\n", name
, enc
);
274 } else if (!strncmp(name
, "PART_ENTRY_", 11))
275 printf("ID_%s=%s\n", name
, value
);
277 else if (namelen
>= 15 && (
278 !strcmp(name
+ (namelen
- 12), "_SECTOR_SIZE") ||
279 !strcmp(name
+ (namelen
- 8), "_IO_SIZE") ||
280 !strcmp(name
, "ALIGNMENT_OFFSET")))
281 printf("ID_IOLIMIT_%s=%s\n", name
, value
);
283 printf("ID_FS_%s=%s\n", name
, value
);
286 static int has_item(char *ary
[], const char *item
)
290 for (p
= ary
; *p
!= NULL
; p
++)
291 if (!strcmp(item
, *p
))
296 static void print_value(int output
, int num
, const char *devname
,
297 const char *value
, const char *name
, size_t valsz
)
299 if (output
& OUTPUT_VALUE_ONLY
) {
300 fputs(value
, stdout
);
303 } else if (output
& OUTPUT_UDEV_LIST
) {
304 print_udev_format(name
, value
, valsz
);
306 } else if (output
& OUTPUT_EXPORT_LIST
) {
309 safe_print(value
, valsz
);
313 if (num
== 1 && devname
)
314 printf("%s: ", devname
);
316 fputs("=\"", stdout
);
317 safe_print(value
, valsz
);
318 fputs("\" ", stdout
);
322 static void print_tags(blkid_dev dev
, char *show
[], int output
)
324 blkid_tag_iterate iter
;
325 const char *type
, *value
, *devname
;
327 static int first
= 1;
332 if (output
& OUTPUT_PRETTY_LIST
) {
333 pretty_print_dev(dev
);
337 devname
= blkid_dev_devname(dev
);
339 if (output
& OUTPUT_DEVICE_ONLY
) {
340 printf("%s\n", devname
);
344 iter
= blkid_tag_iterate_begin(dev
);
345 while (blkid_tag_next(iter
, &type
, &value
) == 0) {
346 if (show
[0] && !has_item(show
, type
))
349 if (num
== 1 && !first
&&
350 (output
& (OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
)))
351 /* add extra line between output from more devices */
354 print_value(output
, num
++, devname
, value
, type
, strlen(value
));
356 blkid_tag_iterate_end(iter
);
359 if (!(output
& (OUTPUT_VALUE_ONLY
| OUTPUT_UDEV_LIST
|
360 OUTPUT_EXPORT_LIST
)))
367 static int append_str(char **res
, size_t *sz
, const char *a
, const char *b
)
370 size_t asz
= a
? strlen(a
) : 0;
371 size_t bsz
= b
? strlen(b
) : 0;
372 size_t len
= *sz
+ asz
+ bsz
;
377 str
= realloc(str
, len
+ 1);
399 * Compose and print ID_FS_AMBIVALENT for udev
401 static int print_udev_ambivalent(blkid_probe pr
)
405 int count
= 0, rc
= -1;
407 while (!blkid_do_probe(pr
)) {
408 const char *usage
= NULL
, *type
= NULL
, *version
= NULL
;
411 blkid_probe_lookup_value(pr
, "USAGE", &usage
, NULL
);
412 blkid_probe_lookup_value(pr
, "TYPE", &type
, NULL
);
413 blkid_probe_lookup_value(pr
, "VERSION", &version
, NULL
);
418 blkid_encode_string(usage
, enc
, sizeof(enc
));
419 if (append_str(&val
, &valsz
, enc
, ":"))
422 blkid_encode_string(type
, enc
, sizeof(enc
));
423 if (append_str(&val
, &valsz
, enc
, version
? ":" : " "))
427 blkid_encode_string(version
, enc
, sizeof(enc
));
428 if (append_str(&val
, &valsz
, enc
, " "))
435 *(val
+ valsz
- 1) = '\0'; /* rem tailing whitespace */
436 printf("ID_FS_AMBIVALEN=%s\n", val
);
444 static int lowprobe_superblocks(blkid_probe pr
)
449 if (fstat(blkid_probe_get_fd(pr
), &st
))
452 blkid_probe_enable_partitions(pr
, 1);
453 blkid_probe_set_partitions_flags(pr
, BLKID_PARTS_ENTRY_DETAILS
);
455 if (!S_ISCHR(st
.st_mode
) && blkid_probe_get_size(pr
) <= 1024 * 1440) {
457 * check if the small disk is partitioned, if yes then
458 * don't probe for filesystems.
460 blkid_probe_enable_superblocks(pr
, 0);
462 rc
= blkid_do_fullprobe(pr
);
464 return rc
; /* -1 = error, 1 = nothing, 0 = succes */
466 if (blkid_probe_lookup_value(pr
, "PTTYPE", NULL
, NULL
) == 0)
467 return 0; /* partition table detected */
469 /* small whole-disk is unpartitioned, probe for filesystems only */
470 blkid_probe_enable_partitions(pr
, 0);
473 blkid_probe_enable_superblocks(pr
, 1);
475 return blkid_do_safeprobe(pr
);
478 static int lowprobe_topology(blkid_probe pr
)
480 /* enable topology probing only */
481 blkid_probe_enable_topology(pr
, 1);
483 blkid_probe_enable_superblocks(pr
, 0);
484 blkid_probe_enable_partitions(pr
, 0);
486 return blkid_do_fullprobe(pr
);
489 static int lowprobe_device(blkid_probe pr
, const char *devname
,
490 int chain
, char *show
[], int output
,
491 blkid_loff_t offset
, blkid_loff_t size
)
495 int nvals
= 0, n
, num
= 1;
499 static int first
= 1;
501 fd
= open(devname
, O_RDONLY
);
503 fprintf(stderr
, "error: %s: %s\n", devname
, strerror(errno
));
506 if (blkid_probe_set_device(pr
, fd
, offset
, size
))
509 if (chain
& LOWPROBE_TOPOLOGY
)
510 rc
= lowprobe_topology(pr
);
511 if (rc
>= 0 && (chain
& LOWPROBE_SUPERBLOCKS
))
512 rc
= lowprobe_superblocks(pr
);
516 nvals
= blkid_probe_numof_values(pr
);
518 if (nvals
&& !first
&& output
& (OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
))
519 /* add extra line between output from devices */
522 if (output
& OUTPUT_DEVICE_ONLY
) {
523 printf("%s\n", devname
);
527 for (n
= 0; n
< nvals
; n
++) {
528 if (blkid_probe_get_value(pr
, n
, &name
, &data
, &len
))
530 if (show
[0] && !has_item(show
, name
))
532 len
= strnlen((char *) data
, len
);
533 print_value(output
, num
++, devname
, (char *) data
, name
, len
);
538 if (nvals
>= 1 && !(output
& (OUTPUT_VALUE_ONLY
|
539 OUTPUT_UDEV_LIST
| OUTPUT_EXPORT_LIST
)))
543 if (output
& OUTPUT_UDEV_LIST
)
544 print_udev_ambivalent(pr
);
547 "%s: ambivalent result (probably more "
548 "filesystems on the device, use wipefs(8) "
549 "to see more details)\n",
553 return !nvals
? 2 : 0;
556 /* converts comma separated list to BLKID_USAGE_* mask */
557 static int list_to_usage(const char *list
, int *flag
)
560 const char *word
= NULL
, *p
= list
;
562 if (p
&& strncmp(p
, "no", 2) == 0) {
563 *flag
= BLKID_FLTR_NOTIN
;
573 if (!strncmp(word
, "filesystem", 10))
574 mask
|= BLKID_USAGE_FILESYSTEM
;
575 else if (!strncmp(word
, "raid", 4))
576 mask
|= BLKID_USAGE_RAID
;
577 else if (!strncmp(word
, "crypto", 6))
578 mask
|= BLKID_USAGE_CRYPTO
;
579 else if (!strncmp(word
, "other", 5))
580 mask
|= BLKID_USAGE_OTHER
;
587 fprintf(stderr
, "unknown kerword in -u <list> argument: '%s'\n",
592 /* converts comma separated list to types[] */
593 static char **list_to_types(const char *list
, int *flag
)
596 const char *p
= list
;
599 if (p
&& strncmp(p
, "no", 2) == 0) {
600 *flag
= BLKID_FLTR_NOTIN
;
604 fprintf(stderr
, "error: -u <list> argument is empty\n");
607 for (i
= 1; p
&& (p
= strchr(p
, ',')); i
++, p
++);
609 res
= calloc(i
+ 1, sizeof(char *));
612 p
= *flag
& BLKID_FLTR_NOTIN
? list
+ 2 : list
;
616 const char *word
= p
;
618 res
[i
] = p
? strndup(word
, p
- word
) : strdup(word
);
627 fprintf(stderr
, "out of memory\n");
634 static void free_types_list(char *list
[])
640 for (n
= list
; *n
; n
++)
645 int main(int argc
, char **argv
)
647 blkid_cache cache
= NULL
;
648 char *devices
[128] = { NULL
, };
649 char *show
[128] = { NULL
, };
650 char *search_type
= NULL
, *search_value
= NULL
;
654 char **fltr_type
= NULL
;
655 int fltr_flag
= BLKID_FLTR_ONLYIN
;
656 unsigned int numdev
= 0, numtag
= 0;
660 int output_format
= 0;
661 int lookup
= 0, gc
= 0, lowprobe
= 0, eval
= 0;
663 uintmax_t offset
= 0, size
= 0;
667 while ((c
= getopt (argc
, argv
, "c:f:ghilL:n:o:O:ps:S:t:u:U:w:v")) != EOF
)
670 if (optarg
&& !*optarg
)
679 search_value
= strdup(optarg
);
680 search_type
= strdup("LABEL");
684 fprintf(stderr
, "error: -u and -n options are mutually exclusive\n");
687 fltr_type
= list_to_types(optarg
, &fltr_flag
);
691 fprintf(stderr
, "error: -u and -n options are mutually exclusive\n");
694 fltr_usage
= list_to_usage(optarg
, &fltr_flag
);
698 search_value
= strdup(optarg
);
699 search_type
= strdup("UUID");
702 lowprobe
|= LOWPROBE_TOPOLOGY
;
711 if (!strcmp(optarg
, "value"))
712 output_format
= OUTPUT_VALUE_ONLY
;
713 else if (!strcmp(optarg
, "device"))
714 output_format
= OUTPUT_DEVICE_ONLY
;
715 else if (!strcmp(optarg
, "list"))
716 output_format
= OUTPUT_PRETTY_LIST
;
717 else if (!strcmp(optarg
, "udev"))
718 output_format
= OUTPUT_UDEV_LIST
;
719 else if (!strcmp(optarg
, "export"))
720 output_format
= OUTPUT_EXPORT_LIST
;
721 else if (!strcmp(optarg
, "full"))
724 fprintf(stderr
, "Invalid output format %s. "
725 "Choose from value,\n\t"
726 "device, list, udev or full\n", optarg
);
731 if (strtosize(optarg
, &offset
))
733 "Invalid offset '%s' specified\n",
737 lowprobe
|= LOWPROBE_SUPERBLOCKS
;
740 if (numtag
+ 1 >= sizeof(show
) / sizeof(*show
)) {
741 fprintf(stderr
, "Too many tags specified\n");
744 show
[numtag
++] = optarg
;
748 if (strtosize(optarg
, &size
))
750 "Invalid size '%s' specified\n",
755 fprintf(stderr
, "Can only search for "
756 "one NAME=value pair\n");
759 if (blkid_parse_tag_string(optarg
,
762 fprintf(stderr
, "-t needs NAME=value pair\n");
770 if (optarg
&& !*optarg
)
781 while (optind
< argc
)
782 devices
[numdev
++] = argv
[optind
++];
785 print_version(stdout
);
789 /* convert LABEL/UUID lookup to evaluate request */
790 if (lookup
&& output_format
== OUTPUT_DEVICE_ONLY
&& search_type
&&
791 (!strcmp(search_type
, "LABEL") || !strcmp(search_type
, "UUID"))) {
796 if (!lowprobe
&& !eval
&& blkid_get_cache(&cache
, read
) < 0)
800 blkid_gc_cache(cache
);
806 if (eval
== 0 && (output_format
& OUTPUT_PRETTY_LIST
)) {
808 fprintf(stderr
, "The low-level probing mode does not "
809 "support 'list' output format\n");
812 pretty_print_dev(NULL
);
822 fprintf(stderr
, "The low-level probing mode "
823 "requires a device\n");
827 /* automatically enable 'export' format for I/O Limits */
828 if (!output_format
&& (lowprobe
& LOWPROBE_TOPOLOGY
))
829 output_format
= OUTPUT_EXPORT_LIST
;
831 pr
= blkid_new_probe();
835 if (lowprobe
& LOWPROBE_SUPERBLOCKS
) {
836 blkid_probe_set_superblocks_flags(pr
,
837 BLKID_SUBLKS_LABEL
| BLKID_SUBLKS_UUID
|
838 BLKID_SUBLKS_TYPE
| BLKID_SUBLKS_SECTYPE
|
839 BLKID_SUBLKS_USAGE
| BLKID_SUBLKS_VERSION
);
841 if (fltr_usage
&& blkid_probe_filter_superblocks_usage(
842 pr
, fltr_flag
, fltr_usage
))
845 else if (fltr_type
&& blkid_probe_filter_superblocks_type(
846 pr
, fltr_flag
, fltr_type
))
850 for (i
= 0; i
< numdev
; i
++)
851 err
= lowprobe_device(pr
, devices
[i
], lowprobe
, show
,
853 (blkid_loff_t
) offset
,
854 (blkid_loff_t
) size
);
855 blkid_free_probe(pr
);
860 char *res
= blkid_evaluate_tag(search_type
, search_value
, NULL
);
867 * Classic (cache based) API
872 fprintf(stderr
, "The lookup option requires a "
873 "search type specified using -t\n");
876 /* Load any additional devices not in the cache */
877 for (i
= 0; i
< numdev
; i
++)
878 blkid_get_dev(cache
, devices
[i
], BLKID_DEV_NORMAL
);
880 if ((dev
= blkid_find_dev_with_tag(cache
, search_type
,
882 print_tags(dev
, show
, output_format
);
885 /* If we didn't specify a single device, show all available devices */
886 } else if (!numdev
) {
887 blkid_dev_iterate iter
;
890 blkid_probe_all(cache
);
892 iter
= blkid_dev_iterate_begin(cache
);
893 blkid_dev_set_search(iter
, search_type
, search_value
);
894 while (blkid_dev_next(iter
, &dev
) == 0) {
895 dev
= blkid_verify(cache
, dev
);
898 print_tags(dev
, show
, output_format
);
901 blkid_dev_iterate_end(iter
);
902 /* Add all specified devices to cache (optionally display tags) */
903 } else for (i
= 0; i
< numdev
; i
++) {
904 blkid_dev dev
= blkid_get_dev(cache
, devices
[i
],
909 !blkid_dev_has_tag(dev
, search_type
,
912 print_tags(dev
, show
, output_format
);
920 free_types_list(fltr_type
);
921 if (!lowprobe
&& !eval
)
922 blkid_put_cache(cache
);