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
101 #define _INLINE_ __inline__
107 * This structure defines the abbreviations used by the text strings
108 * below. The first character in the string is the index letter. An
109 * abbreviation of the form '@<i>' is expanded by looking up the index
110 * letter <i> in the table below.
112 static const char *abbrevs
[] = {
113 N_("aextended attribute"),
114 N_("Aerror allocating"),
118 N_("Cconflicts with some other fs @b"),
125 N_("E@e '%Dn' in %p (%i)"),
127 N_("Ffor @i %i (%Q) is"),
132 N_("mmultiply-claimed"),
149 * Give more user friendly names to the "special" inodes.
151 #define num_special_inodes 11
152 static const char *special_inode_name
[] =
154 N_("<The NULL inode>"), /* 0 */
155 N_("<The bad blocks inode>"), /* 1 */
157 N_("<The user quota inode>"), /* 3 */
158 N_("<The group quota inode>"), /* 4 */
159 N_("<The boot loader inode>"), /* 5 */
160 N_("<The undelete directory inode>"), /* 6 */
161 N_("<The group descriptor inode>"), /* 7 */
162 N_("<The journal inode>"), /* 8 */
163 N_("<Reserved inode 9>"), /* 9 */
164 N_("<Reserved inode 10>"), /* 10 */
168 * This function does "safe" printing. It will convert non-printable
169 * ASCII characters using '^' and M- notation.
171 static void safe_print(FILE *f
, const char *cp
, int len
)
184 if ((ch
< 32) || (ch
== 0x7f)) {
186 ch
^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
194 * This function prints a pathname, using the ext2fs_get_pathname
197 static void print_pathname(FILE *f
, ext2_filsys fs
, ext2_ino_t dir
,
200 errcode_t retval
= 0;
203 if (!dir
&& (ino
< num_special_inodes
)) {
204 fputs(_(special_inode_name
[ino
]), f
);
209 retval
= ext2fs_get_pathname(fs
, dir
, ino
, &path
);
213 safe_print(f
, path
, -1);
214 ext2fs_free_mem(&path
);
218 static void print_time(FILE *f
, time_t t
)
220 const char * time_str
;
221 static int do_gmt
= -1;
224 /* The diet libc doesn't respect the TZ environemnt variable */
226 time_str
= getenv("TZ");
229 do_gmt
= !strcmp(time_str
, "GMT") ||
230 !strcmp(time_str
, "GMT0");
233 time_str
= asctime((do_gmt
> 0) ? gmtime(&t
) : localtime(&t
));
234 fprintf(f
, "%.24s", time_str
);
238 * This function handles the '@' expansion. We allow recursive
239 * expansion; an @ expression can contain further '@' and '%'
242 static _INLINE_
void expand_at_expression(FILE *f
, e2fsck_t ctx
, char ch
,
243 struct problem_context
*pctx
,
244 int *first
, int recurse
)
246 const char **cpp
, *str
;
248 /* Search for the abbreviation */
249 for (cpp
= abbrevs
; *cpp
; cpp
++) {
253 if (*cpp
&& recurse
< 10) {
255 if (*first
&& islower(*str
)) {
257 fputc(toupper(*str
++), f
);
259 print_e2fsck_message(f
, ctx
, str
, pctx
, *first
, recurse
+1);
261 fprintf(f
, "@%c", ch
);
265 * This function expands '%IX' expressions
267 static _INLINE_
void expand_inode_expression(FILE *f
, ext2_filsys fs
, char ch
,
268 struct problem_context
*ctx
)
270 struct ext2_inode
*inode
;
271 struct ext2_inode_large
*large_inode
;
273 if (!ctx
|| !ctx
->inode
)
277 large_inode
= (struct ext2_inode_large
*) inode
;
281 if (LINUX_S_ISDIR(inode
->i_mode
))
282 fprintf(f
, "%u", inode
->i_size
);
284 #ifdef EXT2_NO_64_TYPE
285 if (inode
->i_size_high
)
286 fprintf(f
, "0x%x%08x", inode
->i_size_high
,
289 fprintf(f
, "%u", inode
->i_size
);
291 fprintf(f
, "%llu", EXT2_I_SIZE(inode
));
296 fprintf(f
, "%u", large_inode
->i_extra_isize
);
299 if (fs
->super
->s_feature_ro_compat
&
300 EXT4_FEATURE_RO_COMPAT_HUGE_FILE
)
301 fprintf(f
, "%llu", inode
->i_blocks
+
302 (((long long) inode
->osd2
.linux2
.l_i_blocks_hi
)
305 fprintf(f
, "%u", inode
->i_blocks
);
308 fprintf(f
, "%d", inode
->i_links_count
);
311 fprintf(f
, "0%o", inode
->i_mode
);
314 print_time(f
, inode
->i_mtime
);
317 fprintf(f
, "%u", inode
->i_faddr
);
320 fprintf(f
, "%llu", ext2fs_file_acl_block(fs
, inode
));
323 fprintf(f
, "%u", (LINUX_S_ISDIR(inode
->i_mode
) ?
324 inode
->i_dir_acl
: 0));
327 fprintf(f
, "%d", inode_uid(*inode
));
330 fprintf(f
, "%d", inode_gid(*inode
));
333 if (LINUX_S_ISREG(inode
->i_mode
))
334 fputs(_("regular file"), f
);
335 else if (LINUX_S_ISDIR(inode
->i_mode
))
336 fputs(_("directory"), f
);
337 else if (LINUX_S_ISCHR(inode
->i_mode
))
338 fputs(_("character device"), f
);
339 else if (LINUX_S_ISBLK(inode
->i_mode
))
340 fputs(_("block device"), f
);
341 else if (LINUX_S_ISFIFO(inode
->i_mode
))
342 fputs(_("named pipe"), f
);
343 else if (LINUX_S_ISLNK(inode
->i_mode
))
344 fputs(_("symbolic link"), f
);
345 else if (LINUX_S_ISSOCK(inode
->i_mode
))
346 fputs(_("socket"), f
);
348 fprintf(f
, _("unknown file type with mode 0%o"),
353 fprintf(f
, "%%I%c", ch
);
359 * This function expands '%dX' expressions
361 static _INLINE_
void expand_dirent_expression(FILE *f
, ext2_filsys fs
, char ch
,
362 struct problem_context
*ctx
)
364 struct ext2_dir_entry
*dirent
;
365 unsigned int rec_len
, len
;
367 if (!ctx
|| !ctx
->dirent
)
370 dirent
= ctx
->dirent
;
374 fprintf(f
, "%u", dirent
->inode
);
377 len
= ext2fs_dirent_name_len(dirent
);
378 if ((ext2fs_get_rec_len(fs
, dirent
, &rec_len
) == 0) &&
381 safe_print(f
, dirent
->name
, len
);
384 (void) ext2fs_get_rec_len(fs
, dirent
, &rec_len
);
385 fprintf(f
, "%u", rec_len
);
388 fprintf(f
, "%u", ext2fs_dirent_name_len(dirent
));
391 fprintf(f
, "%u", ext2fs_dirent_file_type(dirent
));
395 fprintf(f
, "%%D%c", ch
);
400 static _INLINE_
void expand_percent_expression(FILE *f
, ext2_filsys fs
,
401 char ch
, int width
, int *first
,
402 struct problem_context
*ctx
)
404 e2fsck_t e2fsck_ctx
= fs
? (e2fsck_t
) fs
->priv_data
: NULL
;
415 #ifdef EXT2_NO_64_TYPE
416 fprintf(f
, "%*u", width
, (unsigned long) ctx
->blk
);
418 fprintf(f
, "%*llu", width
, (unsigned long long) ctx
->blk
);
422 if (ctx
->blkcount
== BLOCK_COUNT_IND
)
423 m
= _("indirect block");
424 else if (ctx
->blkcount
== BLOCK_COUNT_DIND
)
425 m
= _("double indirect block");
426 else if (ctx
->blkcount
== BLOCK_COUNT_TIND
)
427 m
= _("triple indirect block");
428 else if (ctx
->blkcount
== BLOCK_COUNT_TRANSLATOR
)
429 m
= _("translator block");
432 if (*first
&& islower(m
[0]))
433 fputc(toupper(*m
++), f
);
435 if (ctx
->blkcount
>= 0) {
436 #ifdef EXT2_NO_64_TYPE
437 fprintf(f
, "%d", ctx
->blkcount
);
439 fprintf(f
, "%lld", (long long) ctx
->blkcount
);
444 #ifdef EXT2_NO_64_TYPE
445 fprintf(f
, "%*u", width
, (unsigned long) ctx
->blk2
);
447 fprintf(f
, "%*llu", width
, (unsigned long long) ctx
->blk2
);
451 fprintf(f
, "%*u", width
, ctx
->dir
);
454 fprintf(f
, "%*u", width
, ctx
->group
);
457 fprintf(f
, "%*u", width
, ctx
->ino
);
460 fprintf(f
, "%*u", width
, ctx
->ino2
);
463 fprintf(f
, "%*s", width
, error_message(ctx
->errcode
));
466 #ifdef EXT2_NO_64_TYPE
467 fprintf(f
, "%*u", width
, ctx
->num
);
469 fprintf(f
, "%*llu", width
, (long long)ctx
->num
);
473 print_pathname(f
, fs
, ctx
->ino
, 0);
476 print_pathname(f
, fs
, ctx
->ino2
,
477 ctx
->dirent
? ctx
->dirent
->inode
: 0);
480 print_pathname(f
, fs
, ctx
->dir
, 0);
483 print_pathname(f
, fs
, ctx
->dir
, ctx
->ino
);
486 #ifdef EXT2_NO_64_TYPE
487 fprintf(f
, "%*d", width
, ctx
->blkcount
);
489 fprintf(f
, "%*lld", width
, (long long) ctx
->blkcount
);
493 fprintf(f
, "%llu", get_backup_sb(NULL
, fs
, NULL
, NULL
));
496 fprintf(f
, "%*s", width
, ctx
->str
? ctx
->str
: "NULL");
499 print_time(f
, (time_t) ctx
->num
);
502 print_time(f
, e2fsck_ctx
? e2fsck_ctx
->now
: time(0));
505 fprintf(f
, "0x%0*x", width
, ctx
->csum1
);
508 #ifdef EXT2_NO_64_TYPE
509 fprintf(f
, "0x%0*x", width
, ctx
->num
);
511 fprintf(f
, "0x%0*llx", width
, (long long)ctx
->num
);
515 fprintf(f
, "0x%0*x", width
, ctx
->csum2
);
519 fprintf(f
, "%%%c", ch
);
524 void print_e2fsck_message(FILE *f
, e2fsck_t ctx
, const char *msg
,
525 struct problem_context
*pctx
, int first
,
528 ext2_filsys fs
= ctx
->fs
;
532 e2fsck_clear_progbar(ctx
);
533 for (cp
= msg
; *cp
; cp
++) {
536 expand_at_expression(f
, ctx
, *cp
, pctx
, &first
,
538 } else if (cp
[0] == '%') {
541 while (isdigit(cp
[0])) {
542 width
= (width
* 10) + cp
[0] - '0';
547 expand_inode_expression(f
, fs
, *cp
, pctx
);
548 } else if (cp
[0] == 'D') {
550 expand_dirent_expression(f
, fs
, *cp
, pctx
);
552 expand_percent_expression(f
, fs
, *cp
, width
,
556 for (i
=0; cp
[i
]; i
++)
557 if ((cp
[i
] == '@') || cp
[i
] == '%')
559 fprintf(f
, "%.*s", i
, cp
);