blkid.c revision 36f4c4080206f5ad4df37c3cb77f20df2f062266 
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#ifdef HAVE_TERMIOS_H
17#include <termios.h>
18#endif
19#ifdef HAVE_TERMIO_H
20#include <termio.h>
21#endif
22#ifdef HAVE_SYS_IOCTL_H
23#include <sys/ioctl.h>
24#endif
25#ifdef HAVE_GETOPT_H
26#include <getopt.h>
27#else
28extern int getopt(int argc, char * const argv[], const char *optstring);
29extern char *optarg;
30extern int optind;
31#endif
32
33#define OUTPUT_VALUE_ONLY	0x0001
34#define OUTPUT_DEVICE_ONLY	0x0002
35#define OUTPUT_PRETTY_LIST	0x0004
36
37#include "ext2fs/ext2fs.h"
38#include "blkid/blkid.h"
39
40const char *progname = "blkid";
41
42static void print_version(FILE *out)
43{
44	fprintf(out, "%s %s (%s)\n", progname, BLKID_VERSION, BLKID_DATE);
45}
46
47static void usage(int error)
48{
49	FILE *out = error ? stderr : stdout;
50
51	print_version(out);
52	fprintf(out,
53		"usage:\t%s [-c <file>] [-ghlLv] [-o format] "
54		"[-s <tag>] [-t <token>]\n    [-w <file>] [dev ...]\n"
55		"\t-c\tcache file (default: /etc/blkid.tab, /dev/null = none)\n"
56		"\t-h\tprint this usage message and exit\n"
57		"\t-g\tgarbage collect the blkid cache\n"
58		"\t-s\tshow specified tag(s) (default show all tags)\n"
59		"\t-t\tfind device with a specific token (NAME=value pair)\n"
60		"\t-l\tlookup the the first device with arguments specified by -t\n"
61		"\t-v\tprint version and exit\n"
62		"\t-w\twrite cache to different file (/dev/null = no write)\n"
63		"\tdev\tspecify device(s) to probe (default: all devices)\n",
64		progname);
65	exit(error);
66}
67
68/*
69 * This function does "safe" printing.  It will convert non-printable
70 * ASCII characters using '^' and M- notation.
71 */
72static void safe_print(const char *cp, int len)
73{
74	unsigned char	ch;
75
76	if (len < 0)
77		len = strlen(cp);
78
79	while (len--) {
80		ch = *cp++;
81		if (ch > 128) {
82			fputs("M-", stdout);
83			ch -= 128;
84		}
85		if ((ch < 32) || (ch == 0x7f)) {
86			fputc('^', stdout);
87			ch ^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
88		}
89		fputc(ch, stdout);
90	}
91}
92
93static int get_terminal_width(void)
94{
95#ifdef TIOCGSIZE
96	struct ttysize	t_win;
97#endif
98#ifdef TIOCGWINSZ
99	struct winsize	w_win;
100#endif
101        const char	*cp;
102
103#ifdef TIOCGSIZE
104	if (ioctl (0, TIOCGSIZE, &t_win) == 0)
105		return (t_win.ts_cols);
106#endif
107#ifdef TIOCGWINSZ
108	if (ioctl (0, TIOCGWINSZ, &w_win) == 0)
109		return (w_win.ws_col);
110#endif
111        cp = getenv("COLUMNS");
112	if (cp)
113		return strtol(cp, NULL, 10);
114	return 80;
115}
116
117static int pretty_print_word(const char *str, int max_len,
118			     int left_len, int overflow_nl)
119{
120	int len = strlen(str) + left_len;
121	int ret = 0;
122
123	fputs(str, stdout);
124	if (overflow_nl && len > max_len) {
125		fputc('\n', stdout);
126		len = 0;
127	} else if (len > max_len)
128		ret = len - max_len;
129	do
130		fputc(' ', stdout);
131	while (len++ < max_len);
132	return ret;
133}
134
135static void pretty_print_line(const char *device, const char *fs_type,
136			      const char *label, const char *mtpt,
137			      const char *uuid)
138{
139	static int device_len = 10, fs_type_len = 7;
140	static int label_len = 8, mtpt_len = 14;
141	static int term_width = -1;
142	int len, w;
143
144	if (term_width < 0)
145		term_width = get_terminal_width();
146
147	if (term_width > 80) {
148		term_width -= 80;
149		w = term_width / 10;
150		if (w > 8)
151			w = 8;
152		term_width -= 2*w;
153		label_len += w;
154		fs_type_len += w;
155		w = term_width/2;
156		device_len += w;
157		mtpt_len +=w;
158	}
159
160	len = pretty_print_word(device, device_len, 0, 1);
161	len = pretty_print_word(fs_type, fs_type_len, len, 0);
162	len = pretty_print_word(label, label_len, len, 0);
163	len = pretty_print_word(mtpt, mtpt_len, len, 0);
164	fputs(uuid, stdout);
165	fputc('\n', stdout);
166}
167
168static void pretty_print_dev(blkid_dev dev)
169{
170	blkid_tag_iterate	iter;
171	const char		*type, *value, *devname;
172	const char		*uuid = "", *fs_type = "", *label = "";
173	char			*cp;
174	int			len, mount_flags;
175	char			mtpt[80];
176	errcode_t		retval;
177
178	if (dev == NULL) {
179		pretty_print_line("device", "fs_type", "label",
180				  "mount point", "UUID");
181		for (len=get_terminal_width()-1; len > 0; len--)
182			fputc('-', stdout);
183		fputc('\n', stdout);
184		return;
185	}
186
187	devname = blkid_dev_devname(dev);
188	if (access(devname, F_OK))
189		return;
190
191	/* Get the uuid, label, type */
192	iter = blkid_tag_iterate_begin(dev);
193	while (blkid_tag_next(iter, &type, &value) == 0) {
194		if (!strcmp(type, "UUID"))
195			uuid = value;
196		if (!strcmp(type, "TYPE"))
197			fs_type = value;
198		if (!strcmp(type, "LABEL"))
199			label = value;
200	}
201	blkid_tag_iterate_end(iter);
202
203	/* Get the mount point */
204	mtpt[0] = 0;
205	retval = ext2fs_check_mount_point(devname, &mount_flags,
206					  mtpt, sizeof(mtpt));
207	if (retval == 0) {
208		if (mount_flags & EXT2_MF_MOUNTED) {
209			if (!mtpt[0])
210				strcpy(mtpt, "(mounted, mtpt unknown)");
211		} else if (mount_flags & EXT2_MF_BUSY)
212			strcpy(mtpt, "(in use)");
213		else
214			strcpy(mtpt, "(not mounted)");
215	}
216
217	pretty_print_line(devname, fs_type, label, mtpt, uuid);
218}
219
220static void print_tags(blkid_dev dev, char *show[], int numtag, int output)
221{
222	blkid_tag_iterate	iter;
223	const char		*type, *value;
224	int 			i, first = 1;
225
226	if (!dev)
227		return;
228
229	if (output & OUTPUT_PRETTY_LIST) {
230		pretty_print_dev(dev);
231		return;
232	}
233
234	if (output & OUTPUT_DEVICE_ONLY) {
235		printf("%s\n", blkid_dev_devname(dev));
236		return;
237	}
238
239	iter = blkid_tag_iterate_begin(dev);
240	while (blkid_tag_next(iter, &type, &value) == 0) {
241		if (numtag && show) {
242			for (i=0; i < numtag; i++)
243				if (!strcmp(type, show[i]))
244					break;
245			if (i >= numtag)
246				continue;
247		}
248		if (output & OUTPUT_VALUE_ONLY) {
249			fputs(value, stdout);
250			fputc('\n', stdout);
251		} else {
252			if (first) {
253				printf("%s: ", blkid_dev_devname(dev));
254				first = 0;
255			}
256			fputs(type, stdout);
257			fputs("=\"", stdout);
258			safe_print(value, -1);
259			fputs("\" ", stdout);
260		}
261	}
262	blkid_tag_iterate_end(iter);
263
264	if (!first && !(output & OUTPUT_VALUE_ONLY))
265		printf("\n");
266}
267
268int main(int argc, char **argv)
269{
270	blkid_cache cache = NULL;
271	char *devices[128] = { NULL, };
272	char *show[128] = { NULL, };
273	char *search_type = NULL, *search_value = NULL;
274	char *read = NULL;
275	char *write = NULL;
276	unsigned int numdev = 0, numtag = 0;
277	int version = 0;
278	int err = 4;
279	unsigned int i;
280	int output_format = 0;
281	int lookup = 0, gc = 0;
282	int c;
283
284	while ((c = getopt (argc, argv, "c:f:ghlLo:s:t:w:v")) != EOF)
285		switch (c) {
286		case 'c':
287			if (optarg && !*optarg)
288				read = NULL;
289			else
290				read = optarg;
291			if (!write)
292				write = read;
293			break;
294		case 'l':
295			lookup++;
296			break;
297		case 'L':
298			output_format = OUTPUT_PRETTY_LIST;
299			break;
300		case 'g':
301			gc = 1;
302			break;
303		case 'o':
304			if (!strcmp(optarg, "value"))
305				output_format = OUTPUT_VALUE_ONLY;
306			else if (!strcmp(optarg, "device"))
307				output_format = OUTPUT_DEVICE_ONLY;
308			else if (!strcmp(optarg, "list"))
309				output_format = OUTPUT_PRETTY_LIST;
310			else if (!strcmp(optarg, "full"))
311				output_format = 0;
312			else {
313				fprintf(stderr, "Invalid output format %s. "
314					"Choose from value,\n\t"
315					"device, list, or full\n", optarg);
316				exit(1);
317			}
318			break;
319		case 's':
320			if (numtag >= sizeof(show) / sizeof(*show)) {
321				fprintf(stderr, "Too many tags specified\n");
322				usage(err);
323			}
324			show[numtag++] = optarg;
325			break;
326		case 't':
327			if (search_type) {
328				fprintf(stderr, "Can only search for "
329						"one NAME=value pair\n");
330				usage(err);
331			}
332			if (blkid_parse_tag_string(optarg,
333						   &search_type,
334						   &search_value)) {
335				fprintf(stderr, "-t needs NAME=value pair\n");
336				usage(err);
337			}
338			break;
339		case 'v':
340			version = 1;
341			break;
342		case 'w':
343			if (optarg && !*optarg)
344				write = NULL;
345			else
346				write = optarg;
347			break;
348		case 'h':
349			err = 0;
350		default:
351			usage(err);
352		}
353
354	while (optind < argc)
355		devices[numdev++] = argv[optind++];
356
357	if (version) {
358		print_version(stdout);
359		goto exit;
360	}
361
362	if (blkid_get_cache(&cache, read) < 0)
363		goto exit;
364
365	err = 2;
366	if (gc) {
367		blkid_gc_cache(cache);
368		goto exit;
369	}
370	if (output_format & OUTPUT_PRETTY_LIST)
371		pretty_print_dev(NULL);
372
373	if (lookup) {
374		blkid_dev dev;
375
376		if (!search_type) {
377			fprintf(stderr, "The lookup option requires a "
378				"search type specified using -t\n");
379			exit(1);
380		}
381		/* Load any additional devices not in the cache */
382		for (i = 0; i < numdev; i++)
383			blkid_get_dev(cache, devices[i], BLKID_DEV_NORMAL);
384
385		if ((dev = blkid_find_dev_with_tag(cache, search_type,
386						   search_value))) {
387			print_tags(dev, show, numtag, output_format);
388			err = 0;
389		}
390	/* If we didn't specify a single device, show all available devices */
391	} else if (!numdev) {
392		blkid_dev_iterate	iter;
393		blkid_dev		dev;
394
395		blkid_probe_all(cache);
396
397		iter = blkid_dev_iterate_begin(cache);
398		blkid_dev_set_search(iter, search_type, search_value);
399		while (blkid_dev_next(iter, &dev) == 0) {
400			dev = blkid_verify(cache, dev);
401			if (!dev)
402				continue;
403			print_tags(dev, show, numtag, output_format);
404			err = 0;
405		}
406		blkid_dev_iterate_end(iter);
407	/* Add all specified devices to cache (optionally display tags) */
408	} else for (i = 0; i < numdev; i++) {
409		blkid_dev dev = blkid_get_dev(cache, devices[i],
410						  BLKID_DEV_NORMAL);
411
412		if (dev) {
413			if (search_type &&
414			    !blkid_dev_has_tag(dev, search_type,
415					       search_value))
416				continue;
417			print_tags(dev, show, numtag, output_format);
418			err = 0;
419		}
420	}
421
422exit:
423	if (search_type)
424		free(search_type);
425	if (search_value)
426		free(search_value);
427	blkid_put_cache(cache);
428	return err;
429}
430