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 0x0001
33 #define OUTPUT_DEVICE_ONLY 0x0002
34 #define OUTPUT_PRETTY_LIST 0x0004
35 #define OUTPUT_UDEV_LIST 0x0008
39 #include "ismounted.h"
40 #include "strtosize.h"
42 const char *progname
= "blkid";
44 static void print_version(FILE *out
)
46 fprintf(out
, "%s from %s (libblkid %s, %s)\n",
47 progname
, PACKAGE_STRING
, LIBBLKID_VERSION
, LIBBLKID_DATE
);
50 static void usage(int error
)
52 FILE *out
= error
? stderr
: stdout
;
57 " %1$s -L <label> | -U <uuid>\n\n"
58 " %1$s [-c <file>] [-ghlLv] [-o format] [-s <tag>] \n"
59 " [-t <token>] [-w <file>] [dev ...]\n\n"
60 " %1$s -p [-O <offset>] [-S <size>] [-o format] <dev> [dev ...]\n\n"
62 " -c <file> cache file (default: /etc/blkid.tab, /dev/null = none)\n"
63 " -h print this usage message and exit\n"
64 " -g garbage collect the blkid cache\n"
65 " -o <format> output format; can be one of:\n"
66 " value, device, list, udev or full; (default: full)\n"
67 " -s <tag> show specified tag(s) (default show all tags)\n"
68 " -t <token> find device with a specific token (NAME=value pair)\n"
69 " -l lookup the the first device with arguments specified by -t\n"
70 " -L <label> convert LABEL to device name\n"
71 " -U <uuid> convert UUID to device name\n"
72 " -v print version and exit\n"
73 " -w <file> write cache to different file (/dev/null = no write)\n"
74 " <dev> specify device(s) to probe (default: all devices)\n\n"
75 "Low-level probing options:\n"
76 " -p switch to low-level mode (bypass cache)\n"
77 " -S <size> overwrite device size\n"
78 " -O <offset> probe at the given offset\n"
79 " -u <list> filter by \"usage\" (e.g. -u filesystem,raid)\n"
80 " -n <list> filter by filesystem type (e.g. -n vfat,ext3)\n"
88 * This function does "safe" printing. It will convert non-printable
89 * ASCII characters using '^' and M- notation.
91 static void safe_print(const char *cp
, int len
)
104 if ((ch
< 32) || (ch
== 0x7f)) {
106 ch
^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
112 static int get_terminal_width(void)
115 struct ttysize t_win
;
118 struct winsize w_win
;
123 if (ioctl (0, TIOCGSIZE
, &t_win
) == 0)
124 return (t_win
.ts_cols
);
127 if (ioctl (0, TIOCGWINSZ
, &w_win
) == 0)
128 return (w_win
.ws_col
);
130 cp
= getenv("COLUMNS");
132 return strtol(cp
, NULL
, 10);
136 static int pretty_print_word(const char *str
, int max_len
,
137 int left_len
, int overflow_nl
)
139 int len
= strlen(str
) + left_len
;
143 if (overflow_nl
&& len
> max_len
) {
146 } else if (len
> max_len
)
150 while (len
++ < max_len
);
154 static void pretty_print_line(const char *device
, const char *fs_type
,
155 const char *label
, const char *mtpt
,
158 static int device_len
= 10, fs_type_len
= 7;
159 static int label_len
= 8, mtpt_len
= 14;
160 static int term_width
= -1;
164 term_width
= get_terminal_width();
166 if (term_width
> 80) {
179 len
= pretty_print_word(device
, device_len
, 0, 1);
180 len
= pretty_print_word(fs_type
, fs_type_len
, len
, 0);
181 len
= pretty_print_word(label
, label_len
, len
, 0);
182 len
= 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
, size_t sz
)
239 char enc
[265], safe
[256];
243 if (!strcmp(name
, "TYPE") || !strcmp(name
, "VERSION")) {
244 blkid_encode_string(value
, enc
, sizeof(enc
));
245 printf("ID_FS_%s=%s\n", name
, enc
);
247 } else if (!strcmp(name
, "UUID") ||
248 !strcmp(name
, "LABEL") ||
249 !strcmp(name
, "UUID_SUB")) {
251 blkid_safe_string(value
, safe
, sizeof(safe
));
252 printf("ID_FS_%s=%s\n", name
, safe
);
254 blkid_encode_string(value
, enc
, sizeof(enc
));
255 printf("ID_FS_%s_ENC=%s\n", name
, enc
);
257 } else if (!strcmp(name
, "PTTYPE")) {
258 printf("ID_PART_TABLE_TYPE=%s\n", value
);
260 } else if (!strcmp(name
, "PART_ENTRY_NAME") ||
261 !strcmp(name
, "PART_ENTRY_TYPE")) {
263 blkid_safe_string(value
, safe
, sizeof(safe
));
264 printf("ID_%s=%s\n", name
, safe
);
266 blkid_encode_string(value
, enc
, sizeof(enc
));
267 printf("ID_%s_ENC=%s\n", name
, enc
);
269 } else if (!strncmp(name
, "PART_ENTRY_", 11))
270 printf("ID_%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
, valsz
);
297 if (num
== 1 && devname
)
298 printf("%s: ", devname
);
300 fputs("=\"", stdout
);
301 safe_print(value
, valsz
);
302 fputs("\" ", stdout
);
306 static void print_tags(blkid_dev dev
, char *show
[], int output
)
308 blkid_tag_iterate iter
;
309 const char *type
, *value
, *devname
;
315 if (output
& OUTPUT_PRETTY_LIST
) {
316 pretty_print_dev(dev
);
320 devname
= blkid_dev_devname(dev
);
322 if (output
& OUTPUT_DEVICE_ONLY
) {
323 printf("%s\n", devname
);
327 iter
= blkid_tag_iterate_begin(dev
);
328 while (blkid_tag_next(iter
, &type
, &value
) == 0) {
329 if (show
[0] && !has_item(show
, type
))
331 print_value(output
, num
++, devname
, value
, type
, strlen(value
));
333 blkid_tag_iterate_end(iter
);
335 if (num
> 1 && !(output
& (OUTPUT_VALUE_ONLY
| OUTPUT_UDEV_LIST
)))
340 static int append_str(char **res
, size_t *sz
, const char *a
, const char *b
)
343 size_t asz
= a
? strlen(a
) : 0;
344 size_t bsz
= b
? strlen(b
) : 0;
345 size_t len
= *sz
+ asz
+ bsz
;
350 str
= realloc(str
, len
+ 1);
372 * Compose and print ID_FS_AMBIVALENT for udev
374 static int print_udev_ambivalent(blkid_probe pr
)
378 int count
= 0, rc
= -1;
380 while (!blkid_do_probe(pr
)) {
381 const char *usage
= NULL
, *type
= NULL
, *version
= NULL
;
384 blkid_probe_lookup_value(pr
, "USAGE", &usage
, NULL
);
385 blkid_probe_lookup_value(pr
, "TYPE", &type
, NULL
);
386 blkid_probe_lookup_value(pr
, "VERSION", &version
, NULL
);
391 blkid_encode_string(usage
, enc
, sizeof(enc
));
392 if (append_str(&val
, &valsz
, enc
, ":"))
395 blkid_encode_string(type
, enc
, sizeof(enc
));
396 if (append_str(&val
, &valsz
, enc
, version
? ":" : " "))
400 blkid_encode_string(version
, enc
, sizeof(enc
));
401 if (append_str(&val
, &valsz
, enc
, " "))
408 *(val
+ valsz
- 1) = '\0'; /* rem tailing whitespace */
409 printf("ID_FS_AMBIVALEN=%s\n", val
);
417 static int lowprobe_device(blkid_probe pr
, const char *devname
, char *show
[],
418 int output
, blkid_loff_t offset
, blkid_loff_t size
)
422 int nvals
= 0, n
, num
= 1;
427 static int first
= 1;
429 fd
= open(devname
, O_RDONLY
);
431 fprintf(stderr
, "error: %s: %s\n", devname
, strerror(errno
));
434 if (blkid_probe_set_device(pr
, fd
, offset
, size
))
440 blkid_probe_enable_partitions(pr
, 1);
441 blkid_probe_set_partitions_flags(pr
, BLKID_PARTS_ENTRY_DETAILS
);
443 if (!S_ISCHR(st
.st_mode
) && blkid_probe_get_size(pr
) <= 1024 * 1440) {
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 goto done
; /* -1 = error, 1 = nothing, 0 = succes */
454 if (blkid_probe_lookup_value(pr
, "PTTYPE", NULL
, NULL
) == 0)
455 /* partition table detected */
458 /* small whole-disk is unpartitioned, probe for filesystems only */
459 blkid_probe_enable_partitions(pr
, 0);
462 blkid_probe_enable_superblocks(pr
, 1);
464 rc
= blkid_do_safeprobe(pr
);
468 nvals
= blkid_probe_numof_values(pr
);
470 if (nvals
&& !first
&& output
& OUTPUT_UDEV_LIST
)
471 /* add extra line between output from devices */
474 if (output
& OUTPUT_DEVICE_ONLY
) {
475 printf("%s\n", devname
);
479 for (n
= 0; n
< nvals
; n
++) {
480 if (blkid_probe_get_value(pr
, n
, &name
, &data
, &len
))
482 if (show
[0] && !has_item(show
, name
))
484 len
= strnlen((char *) data
, len
);
485 print_value(output
, num
++, devname
, (char *) data
, name
, len
);
490 if (nvals
>= 1 && !(output
& (OUTPUT_VALUE_ONLY
| OUTPUT_UDEV_LIST
)))
494 if (output
& OUTPUT_UDEV_LIST
)
495 print_udev_ambivalent(pr
);
498 "%s: ambivalent result (probably more "
499 "filesystems on the device, use wipefs(8) "
500 "to see more details)\n",
504 return !nvals
? 2 : 0;
507 /* converts comma separated list to BLKID_USAGE_* mask */
508 static int list_to_usage(const char *list
, int *flag
)
511 const char *word
= NULL
, *p
= list
;
513 if (p
&& strncmp(p
, "no", 2) == 0) {
514 *flag
= BLKID_FLTR_NOTIN
;
524 if (!strncmp(word
, "filesystem", 10))
525 mask
|= BLKID_USAGE_FILESYSTEM
;
526 else if (!strncmp(word
, "raid", 4))
527 mask
|= BLKID_USAGE_RAID
;
528 else if (!strncmp(word
, "crypto", 6))
529 mask
|= BLKID_USAGE_CRYPTO
;
530 else if (!strncmp(word
, "other", 5))
531 mask
|= BLKID_USAGE_OTHER
;
538 fprintf(stderr
, "unknown kerword in -u <list> argument: '%s'\n",
543 /* converts comma separated list to types[] */
544 static char **list_to_types(const char *list
, int *flag
)
547 const char *p
= list
;
550 if (p
&& strncmp(p
, "no", 2) == 0) {
551 *flag
= BLKID_FLTR_NOTIN
;
555 fprintf(stderr
, "error: -u <list> argument is empty\n");
558 for (i
= 1; p
&& (p
= strchr(p
, ',')); i
++, p
++);
560 res
= calloc(i
+ 1, sizeof(char *));
563 p
= *flag
& BLKID_FLTR_NOTIN
? list
+ 2 : list
;
567 const char *word
= p
;
569 res
[i
] = p
? strndup(word
, p
- word
) : strdup(word
);
578 fprintf(stderr
, "out of memory\n");
585 static void free_types_list(char *list
[])
591 for (n
= list
; *n
; n
++)
596 int main(int argc
, char **argv
)
598 blkid_cache cache
= NULL
;
599 char *devices
[128] = { NULL
, };
600 char *show
[128] = { NULL
, };
601 char *search_type
= NULL
, *search_value
= NULL
;
605 char **fltr_type
= NULL
;
606 int fltr_flag
= BLKID_FLTR_ONLYIN
;
607 unsigned int numdev
= 0, numtag
= 0;
611 int output_format
= 0;
612 int lookup
= 0, gc
= 0, lowprobe
= 0, eval
= 0;
614 uintmax_t offset
= 0, size
= 0;
618 while ((c
= getopt (argc
, argv
, "c:f:ghlL:n:o:O:ps:S:t:u:U:w:v")) != EOF
)
621 if (optarg
&& !*optarg
)
630 search_value
= strdup(optarg
);
631 search_type
= strdup("LABEL");
635 fprintf(stderr
, "error: -u and -n options are mutually exclusive\n");
638 fltr_type
= list_to_types(optarg
, &fltr_flag
);
642 fprintf(stderr
, "error: -u and -n options are mutually exclusive\n");
645 fltr_usage
= list_to_usage(optarg
, &fltr_flag
);
649 search_value
= strdup(optarg
);
650 search_type
= strdup("UUID");
659 if (!strcmp(optarg
, "value"))
660 output_format
= OUTPUT_VALUE_ONLY
;
661 else if (!strcmp(optarg
, "device"))
662 output_format
= OUTPUT_DEVICE_ONLY
;
663 else if (!strcmp(optarg
, "list"))
664 output_format
= OUTPUT_PRETTY_LIST
;
665 else if (!strcmp(optarg
, "udev"))
666 output_format
= OUTPUT_UDEV_LIST
;
667 else if (!strcmp(optarg
, "full"))
670 fprintf(stderr
, "Invalid output format %s. "
671 "Choose from value,\n\t"
672 "device, list, udev or full\n", optarg
);
677 if (strtosize(optarg
, &offset
))
679 "Invalid offset '%s' specified\n",
686 if (numtag
+ 1 >= sizeof(show
) / sizeof(*show
)) {
687 fprintf(stderr
, "Too many tags specified\n");
690 show
[numtag
++] = optarg
;
694 if (strtosize(optarg
, &size
))
696 "Invalid size '%s' specified\n",
701 fprintf(stderr
, "Can only search for "
702 "one NAME=value pair\n");
705 if (blkid_parse_tag_string(optarg
,
708 fprintf(stderr
, "-t needs NAME=value pair\n");
716 if (optarg
&& !*optarg
)
727 while (optind
< argc
)
728 devices
[numdev
++] = argv
[optind
++];
731 print_version(stdout
);
735 /* convert LABEL/UUID lookup to evaluate request */
736 if (lookup
&& output_format
== OUTPUT_DEVICE_ONLY
&& search_type
&&
737 (!strcmp(search_type
, "LABEL") || !strcmp(search_type
, "UUID"))) {
742 if (!lowprobe
&& !eval
&& blkid_get_cache(&cache
, read
) < 0)
746 blkid_gc_cache(cache
);
752 if (eval
== 0 && output_format
& OUTPUT_PRETTY_LIST
) {
754 fprintf(stderr
, "The low-level probing mode does not "
755 "support 'list' output format\n");
758 pretty_print_dev(NULL
);
768 fprintf(stderr
, "The low-level probing mode "
769 "requires a device\n");
772 pr
= blkid_new_probe();
776 blkid_probe_set_superblocks_flags(pr
,
777 BLKID_SUBLKS_LABEL
| BLKID_SUBLKS_UUID
|
778 BLKID_SUBLKS_TYPE
| BLKID_SUBLKS_SECTYPE
|
779 BLKID_SUBLKS_USAGE
| BLKID_SUBLKS_VERSION
);
782 blkid_probe_filter_superblocks_usage(pr
, fltr_flag
, fltr_usage
))
784 else if (fltr_type
&&
785 blkid_probe_filter_superblocks_type(pr
, fltr_flag
, fltr_type
))
788 for (i
= 0; i
< numdev
; i
++)
789 err
= lowprobe_device(pr
, devices
[i
], show
,
791 (blkid_loff_t
) offset
,
792 (blkid_loff_t
) size
);
793 blkid_free_probe(pr
);
798 char *res
= blkid_evaluate_tag(search_type
, search_value
, NULL
);
805 * Classic (cache based) API
810 fprintf(stderr
, "The lookup option requires a "
811 "search type specified using -t\n");
814 /* Load any additional devices not in the cache */
815 for (i
= 0; i
< numdev
; i
++)
816 blkid_get_dev(cache
, devices
[i
], BLKID_DEV_NORMAL
);
818 if ((dev
= blkid_find_dev_with_tag(cache
, search_type
,
820 print_tags(dev
, show
, output_format
);
823 /* If we didn't specify a single device, show all available devices */
824 } else if (!numdev
) {
825 blkid_dev_iterate iter
;
828 blkid_probe_all(cache
);
830 iter
= blkid_dev_iterate_begin(cache
);
831 blkid_dev_set_search(iter
, search_type
, search_value
);
832 while (blkid_dev_next(iter
, &dev
) == 0) {
833 dev
= blkid_verify(cache
, dev
);
836 print_tags(dev
, show
, output_format
);
839 blkid_dev_iterate_end(iter
);
840 /* Add all specified devices to cache (optionally display tags) */
841 } else for (i
= 0; i
< numdev
; i
++) {
842 blkid_dev dev
= blkid_get_dev(cache
, devices
[i
],
847 !blkid_dev_has_tag(dev
, search_type
,
850 print_tags(dev
, show
, output_format
);
858 free_types_list(fltr_type
);
859 if (!lowprobe
&& !eval
)
860 blkid_put_cache(cache
);