2 * message.c --- print e2fsck messages (with compression)
4 * Copyright 1996, 1997 by Theodore Ts'o
7 * This file may be redistributed under the terms of the GNU Public
11 * print_e2fsck_message() prints a message to the user, using
12 * compression techniques and expansions of abbreviations.
14 * The following % expansions are supported:
16 * %b <blk> block number
17 * %B <blkcount> interpret blkcount as blkcount
18 * %c <blk2> block number
19 * %Di <dirent>->ino inode number
20 * %Dn <dirent>->name string
21 * %Dr <dirent>->rec_len
22 * %Dl <dirent>->name_len
23 * %Dt <dirent>->filetype
24 * %d <dir> inode number
26 * %i <ino> inode number
27 * %Is <inode> -> i_size
28 * %IS <inode> -> i_extra_isize
29 * %Ib <inode> -> i_blocks
30 * %Il <inode> -> i_links_count
31 * %Im <inode> -> i_mode
32 * %IM <inode> -> i_mtime
33 * %IF <inode> -> i_faddr
34 * %If <inode> -> i_file_acl
35 * %Id <inode> -> i_dir_acl
36 * %Iu <inode> -> i_uid
37 * %Ig <inode> -> i_gid
39 * %j <ino2> inode number
40 * %m <com_err error message>
42 * %p ext2fs_get_pathname of directory <ino>
43 * %P ext2fs_get_pathname of <dirent>->ino with <ino2> as
44 * the containing directory. (If dirent is NULL
45 * then return the pathname of directory <ino2>)
46 * %q ext2fs_get_pathname of directory <dir>
47 * %Q ext2fs_get_pathname of directory <ino> with <dir> as
48 * the containing directory.
49 * %r <blkcount> interpret blkcount as refcount
50 * %s <str> miscellaneous string
51 * %S backup superblock
52 * %X <num> hexadecimal format
54 * The following '@' expansions are supported:
56 * @a extended attribute
61 * @C conflicts with some other fs block
65 * @E Entry '%Dn' in %p (%i)
67 * @F for @i %i (%Q) is
69 * @h HTREE directory inode
100 #define _INLINE_ __inline__
106 * This structure defines the abbreviations used by the text strings
107 * below. The first character in the string is the index letter. An
108 * abbreviation of the form '@<i>' is expanded by looking up the index
109 * letter <i> in the table below.
111 static const char *abbrevs[] = {
112 N_("aextended attribute"),
113 N_("Aerror allocating"),
117 N_("Cconflicts with some other fs @b"),
124 N_("E@e '%Dn' in %p (%i)"),
126 N_("Ffor @i %i (%Q) is"),
131 N_("mmultiply-claimed"),
148 * Give more user friendly names to the "special" inodes.
150 #define num_special_inodes 11
151 static const char *special_inode_name[] =
153 N_("<The NULL inode>"), /* 0 */
154 N_("<The bad blocks inode>"), /* 1 */
156 N_("<The user quota inode>"), /* 3 */
157 N_("<The group quota inode>"), /* 4 */
158 N_("<The boot loader inode>"), /* 5 */
159 N_("<The undelete directory inode>"), /* 6 */
160 N_("<The group descriptor inode>"), /* 7 */
161 N_("<The journal inode>"), /* 8 */
162 N_("<Reserved inode 9>"), /* 9 */
163 N_("<Reserved inode 10>"), /* 10 */
167 * This function does "safe" printing. It will convert non-printable
168 * ASCII characters using '^' and M- notation.
170 static void safe_print(FILE *f, const char *cp, int len)
183 if ((ch < 32) || (ch == 0x7f)) {
185 ch ^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
193 * This function prints a pathname, using the ext2fs_get_pathname
196 static void print_pathname(FILE *f, ext2_filsys fs, ext2_ino_t dir,
199 errcode_t retval = 0;
202 if (!dir && (ino < num_special_inodes)) {
203 fputs(_(special_inode_name[ino]), f);
208 retval = ext2fs_get_pathname(fs, dir, ino, &path);
212 safe_print(f, path, -1);
213 ext2fs_free_mem(&path);
217 static void print_time(FILE *f, time_t t)
219 const char * time_str;
220 static int do_gmt = -1;
223 /* The diet libc doesn't respect the TZ environemnt variable */
225 time_str = getenv("TZ");
228 do_gmt = !strcmp(time_str, "GMT0");
231 time_str = asctime((do_gmt > 0) ? gmtime(&t) : localtime(&t));
232 fprintf(f, "%.24s", time_str);
236 * This function handles the '@' expansion. We allow recursive
237 * expansion; an @ expression can contain further '@' and '%'
240 static _INLINE_ void expand_at_expression(FILE *f, e2fsck_t ctx, char ch,
241 struct problem_context *pctx,
242 int *first, int recurse)
244 const char **cpp, *str;
246 /* Search for the abbreviation */
247 for (cpp = abbrevs; *cpp; cpp++) {
251 if (*cpp && recurse < 10) {
253 if (*first && islower(*str)) {
255 fputc(toupper(*str++), f);
257 print_e2fsck_message(f, ctx, str, pctx, *first, recurse+1);
259 fprintf(f, "@%c", ch);
263 * This function expands '%IX' expressions
265 static _INLINE_ void expand_inode_expression(FILE *f, ext2_filsys fs, char ch,
266 struct problem_context *ctx)
268 struct ext2_inode *inode;
269 struct ext2_inode_large *large_inode;
271 if (!ctx || !ctx->inode)
275 large_inode = (struct ext2_inode_large *) inode;
279 if (LINUX_S_ISDIR(inode->i_mode))
280 fprintf(f, "%u", inode->i_size);
282 #ifdef EXT2_NO_64_TYPE
283 if (inode->i_size_high)
284 fprintf(f, "0x%x%08x", inode->i_size_high,
287 fprintf(f, "%u", inode->i_size);
289 fprintf(f, "%llu", EXT2_I_SIZE(inode));
294 fprintf(f, "%u", large_inode->i_extra_isize);
297 if (fs->super->s_feature_ro_compat &
298 EXT4_FEATURE_RO_COMPAT_HUGE_FILE)
299 fprintf(f, "%llu", inode->i_blocks +
300 (((long long) inode->osd2.linux2.l_i_blocks_hi)
303 fprintf(f, "%u", inode->i_blocks);
306 fprintf(f, "%d", inode->i_links_count);
309 fprintf(f, "0%o", inode->i_mode);
312 print_time(f, inode->i_mtime);
315 fprintf(f, "%u", inode->i_faddr);
318 fprintf(f, "%llu", ext2fs_file_acl_block(fs, inode));
321 fprintf(f, "%u", (LINUX_S_ISDIR(inode->i_mode) ?
322 inode->i_dir_acl : 0));
325 fprintf(f, "%d", inode_uid(*inode));
328 fprintf(f, "%d", inode_gid(*inode));
331 if (LINUX_S_ISREG(inode->i_mode))
332 fputs(_("regular file"), f);
333 else if (LINUX_S_ISDIR(inode->i_mode))
334 fputs(_("directory"), f);
335 else if (LINUX_S_ISCHR(inode->i_mode))
336 fputs(_("character device"), f);
337 else if (LINUX_S_ISBLK(inode->i_mode))
338 fputs(_("block device"), f);
339 else if (LINUX_S_ISFIFO(inode->i_mode))
340 fputs(_("named pipe"), f);
341 else if (LINUX_S_ISLNK(inode->i_mode))
342 fputs(_("symbolic link"), f);
343 else if (LINUX_S_ISSOCK(inode->i_mode))
344 fputs(_("socket"), f);
346 fprintf(f, _("unknown file type with mode 0%o"),
351 fprintf(f, "%%I%c", ch);
357 * This function expands '%dX' expressions
359 static _INLINE_ void expand_dirent_expression(FILE *f, ext2_filsys fs, char ch,
360 struct problem_context *ctx)
362 struct ext2_dir_entry *dirent;
363 unsigned int rec_len, len;
365 if (!ctx || !ctx->dirent)
368 dirent = ctx->dirent;
372 fprintf(f, "%u", dirent->inode);
375 len = dirent->name_len & 0xFF;
376 if ((ext2fs_get_rec_len(fs, dirent, &rec_len) == 0) &&
379 safe_print(f, dirent->name, len);
382 (void) ext2fs_get_rec_len(fs, dirent, &rec_len);
383 fprintf(f, "%u", rec_len);
386 fprintf(f, "%u", dirent->name_len & 0xFF);
389 fprintf(f, "%u", dirent->name_len >> 8);
393 fprintf(f, "%%D%c", ch);
398 static _INLINE_ void expand_percent_expression(FILE *f, ext2_filsys fs,
399 char ch, int width, int *first,
400 struct problem_context *ctx)
402 e2fsck_t e2fsck_ctx = fs ? (e2fsck_t) fs->priv_data : NULL;
413 #ifdef EXT2_NO_64_TYPE
414 fprintf(f, "%*u", width, (unsigned long) ctx->blk);
416 fprintf(f, "%*llu", width, (unsigned long long) ctx->blk);
420 if (ctx->blkcount == BLOCK_COUNT_IND)
421 m = _("indirect block");
422 else if (ctx->blkcount == BLOCK_COUNT_DIND)
423 m = _("double indirect block");
424 else if (ctx->blkcount == BLOCK_COUNT_TIND)
425 m = _("triple indirect block");
426 else if (ctx->blkcount == BLOCK_COUNT_TRANSLATOR)
427 m = _("translator block");
430 if (*first && islower(m[0]))
431 fputc(toupper(*m++), f);
433 if (ctx->blkcount >= 0) {
434 #ifdef EXT2_NO_64_TYPE
435 fprintf(f, "%d", ctx->blkcount);
437 fprintf(f, "%lld", (long long) ctx->blkcount);
442 #ifdef EXT2_NO_64_TYPE
443 fprintf(f, "%*u", width, (unsigned long) ctx->blk2);
445 fprintf(f, "%*llu", width, (unsigned long long) ctx->blk2);
449 fprintf(f, "%*u", width, ctx->dir);
452 fprintf(f, "%*u", width, ctx->group);
455 fprintf(f, "%*u", width, ctx->ino);
458 fprintf(f, "%*u", width, ctx->ino2);
461 fprintf(f, "%*s", width, error_message(ctx->errcode));
464 #ifdef EXT2_NO_64_TYPE
465 fprintf(f, "%*u", width, ctx->num);
467 fprintf(f, "%*llu", width, (long long)ctx->num);
471 print_pathname(f, fs, ctx->ino, 0);
474 print_pathname(f, fs, ctx->ino2,
475 ctx->dirent ? ctx->dirent->inode : 0);
478 print_pathname(f, fs, ctx->dir, 0);
481 print_pathname(f, fs, ctx->dir, ctx->ino);
484 #ifdef EXT2_NO_64_TYPE
485 fprintf(f, "%*d", width, ctx->blkcount);
487 fprintf(f, "%*lld", width, (long long) ctx->blkcount);
491 fprintf(f, "%llu", get_backup_sb(NULL, fs, NULL, NULL));
494 fprintf(f, "%*s", width, ctx->str ? ctx->str : "NULL");
497 print_time(f, (time_t) ctx->num);
500 print_time(f, e2fsck_ctx ? e2fsck_ctx->now : time(0));
503 fprintf(f, "0x%0*x", width, ctx->csum1);
506 #ifdef EXT2_NO_64_TYPE
507 fprintf(f, "0x%0*x", width, ctx->num);
509 fprintf(f, "0x%0*llx", width, (long long)ctx->num);
513 fprintf(f, "0x%0*x", width, ctx->csum2);
517 fprintf(f, "%%%c", ch);
522 void print_e2fsck_message(FILE *f, e2fsck_t ctx, const char *msg,
523 struct problem_context *pctx, int first,
526 ext2_filsys fs = ctx->fs;
530 e2fsck_clear_progbar(ctx);
531 for (cp = msg; *cp; cp++) {
534 expand_at_expression(f, ctx, *cp, pctx, &first,
536 } else if (cp[0] == '%') {
539 while (isdigit(cp[0])) {
540 width = (width * 10) + cp[0] - '0';
545 expand_inode_expression(f, fs, *cp, pctx);
546 } else if (cp[0] == 'D') {
548 expand_dirent_expression(f, fs, *cp, pctx);
550 expand_percent_expression(f, fs, *cp, width,
554 for (i=0; cp[i]; i++)
555 if ((cp[i] == '@') || cp[i] == '%')
557 fprintf(f, "%.*s", i, cp);