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_size_high
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
53 * %U quota type (in <num>)
54 * %S backup superblock
55 * %X <num> hexadecimal format
57 * The following '@' expansions are supported:
59 * @a extended attribute
64 * @C conflicts with some other fs block
68 * @E Entry '%Dn' in %p (%i)
70 * @F for @i %i (%Q) is
72 * @h HTREE directory inode
98 #include "support/quotaio.h"
104 #define _INLINE_ __inline__
110 * This structure defines the abbreviations used by the text strings
111 * below. The first character in the string is the index letter. An
112 * abbreviation of the form '@<i>' is expanded by looking up the index
113 * letter <i> in the table below.
115 static const char *abbrevs[] = {
116 N_("aextended attribute"),
117 N_("Aerror allocating"),
121 N_("Cconflicts with some other fs @b"),
125 N_("E@e '%Dn' in %p (%i)"),
127 N_("Ffor @i %i (%Q) is"),
135 N_("mmultiply-claimed"),
152 * Give more user friendly names to the "special" inodes.
154 #define num_special_inodes 11
155 static const char *special_inode_name[] =
157 N_("<The NULL inode>"), /* 0 */
158 N_("<The bad blocks inode>"), /* 1 */
160 N_("<The user quota inode>"), /* 3 */
161 N_("<The group quota inode>"), /* 4 */
162 N_("<The boot loader inode>"), /* 5 */
163 N_("<The undelete directory inode>"), /* 6 */
164 N_("<The group descriptor inode>"), /* 7 */
165 N_("<The journal inode>"), /* 8 */
166 N_("<Reserved inode 9>"), /* 9 */
167 N_("<Reserved inode 10>"), /* 10 */
171 * This function does "safe" printing. It will convert non-printable
172 * ASCII characters using '^' and M- notation.
174 static void safe_print(FILE *f, const char *cp, int len)
187 if ((ch < 32) || (ch == 0x7f)) {
189 ch ^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
197 * This function prints a pathname, using the ext2fs_get_pathname
200 static void print_pathname(FILE *f, ext2_filsys fs, ext2_ino_t dir,
203 errcode_t retval = 0;
206 if (!dir && (ino < num_special_inodes)) {
207 fputs(_(special_inode_name[ino]), f);
212 retval = ext2fs_get_pathname(fs, dir, ino, &path);
216 safe_print(f, path, -1);
217 ext2fs_free_mem(&path);
221 static void print_time(FILE *f, time_t t)
223 const char * time_str;
224 static int do_gmt = -1;
227 /* The diet libc doesn't respect the TZ environment variable */
229 time_str = getenv("TZ");
232 do_gmt = !strcmp(time_str, "GMT") ||
233 !strcmp(time_str, "GMT0");
236 time_str = asctime((do_gmt > 0) ? gmtime(&t) : localtime(&t));
237 fprintf(f, "%.24s", time_str);
241 * This function handles the '@' expansion. We allow recursive
242 * expansion; an @ expression can contain further '@' and '%'
245 static _INLINE_ void expand_at_expression(FILE *f, e2fsck_t ctx, char ch,
246 struct problem_context *pctx,
247 int *first, int recurse)
249 const char **cpp, *str;
251 /* Search for the abbreviation */
252 for (cpp = abbrevs; *cpp; cpp++) {
256 if (*cpp && recurse < 10) {
258 if (*first && islower(*str)) {
260 fputc(toupper(*str++), f);
262 print_e2fsck_message(f, ctx, str, pctx, *first, recurse+1);
264 fprintf(f, "@%c", ch);
268 * This function expands '%IX' expressions
270 static _INLINE_ void expand_inode_expression(FILE *f, ext2_filsys fs, char ch,
271 struct problem_context *ctx)
273 struct ext2_inode *inode;
274 struct ext2_inode_large *large_inode;
276 if (!ctx || !ctx->inode)
280 large_inode = (struct ext2_inode_large *) inode;
284 fprintf(f, "%llu", (unsigned long long) EXT2_I_SIZE(inode));
287 fprintf(f, "%u", large_inode->i_extra_isize);
290 if (ext2fs_has_feature_huge_file(fs->super))
291 fprintf(f, "%llu", inode->i_blocks +
292 (((long long) inode->osd2.linux2.l_i_blocks_hi)
295 fprintf(f, "%u", inode->i_blocks);
298 fprintf(f, "%d", inode->i_links_count);
301 fprintf(f, "0%o", inode->i_mode);
304 print_time(f, inode->i_mtime);
307 fprintf(f, "%u", inode->i_faddr);
311 (unsigned long long) ext2fs_file_acl_block(fs, inode));
314 fprintf(f, "%u", (LINUX_S_ISDIR(inode->i_mode) ?
315 inode->i_size_high : 0));
318 fprintf(f, "%d", inode_uid(*inode));
321 fprintf(f, "%d", inode_gid(*inode));
324 if (LINUX_S_ISREG(inode->i_mode))
325 fputs(_("regular file"), f);
326 else if (LINUX_S_ISDIR(inode->i_mode))
327 fputs(_("directory"), f);
328 else if (LINUX_S_ISCHR(inode->i_mode))
329 fputs(_("character device"), f);
330 else if (LINUX_S_ISBLK(inode->i_mode))
331 fputs(_("block device"), f);
332 else if (LINUX_S_ISFIFO(inode->i_mode))
333 fputs(_("named pipe"), f);
334 else if (LINUX_S_ISLNK(inode->i_mode))
335 fputs(_("symbolic link"), f);
336 else if (LINUX_S_ISSOCK(inode->i_mode))
337 fputs(_("socket"), f);
339 fprintf(f, _("unknown file type with mode 0%o"),
344 fprintf(f, "%%I%c", ch);
350 * This function expands '%dX' expressions
352 static _INLINE_ void expand_dirent_expression(FILE *f, ext2_filsys fs, char ch,
353 struct problem_context *ctx)
355 struct ext2_dir_entry *dirent;
356 unsigned int rec_len, len;
358 if (!ctx || !ctx->dirent)
361 dirent = ctx->dirent;
365 fprintf(f, "%u", dirent->inode);
368 len = ext2fs_dirent_name_len(dirent);
369 if ((ext2fs_get_rec_len(fs, dirent, &rec_len) == 0) &&
372 safe_print(f, dirent->name, len);
375 (void) ext2fs_get_rec_len(fs, dirent, &rec_len);
376 fprintf(f, "%u", rec_len);
379 fprintf(f, "%u", ext2fs_dirent_name_len(dirent));
382 fprintf(f, "%u", ext2fs_dirent_file_type(dirent));
386 fprintf(f, "%%D%c", ch);
391 static _INLINE_ void expand_percent_expression(FILE *f, ext2_filsys fs,
392 char ch, int width, int *first,
393 struct problem_context *ctx)
395 e2fsck_t e2fsck_ctx = fs ? (e2fsck_t) fs->priv_data : NULL;
406 fprintf(f, "%*llu", width, (unsigned long long) ctx->blk);
409 if (ctx->blkcount == BLOCK_COUNT_IND)
410 m = _("indirect block");
411 else if (ctx->blkcount == BLOCK_COUNT_DIND)
412 m = _("double indirect block");
413 else if (ctx->blkcount == BLOCK_COUNT_TIND)
414 m = _("triple indirect block");
415 else if (ctx->blkcount == BLOCK_COUNT_TRANSLATOR)
416 m = _("translator block");
419 if (*first && islower(m[0]))
420 fputc(toupper(*m++), f);
422 if (ctx->blkcount >= 0)
423 fprintf(f, "%lld", (long long) ctx->blkcount);
426 fprintf(f, "%*llu", width, (unsigned long long) ctx->blk2);
429 fprintf(f, "%*u", width, ctx->dir);
432 fprintf(f, "%*u", width, ctx->group);
435 fprintf(f, "%*u", width, ctx->ino);
438 fprintf(f, "%*u", width, ctx->ino2);
441 fprintf(f, "%*s", width, error_message(ctx->errcode));
444 fprintf(f, "%*llu", width, (long long)ctx->num);
447 fprintf(f, "%*llu", width, (long long)ctx->num2);
450 print_pathname(f, fs, ctx->ino, 0);
453 print_pathname(f, fs, ctx->ino2,
454 ctx->dirent ? ctx->dirent->inode : 0);
457 print_pathname(f, fs, ctx->dir, 0);
460 print_pathname(f, fs, ctx->dir, ctx->ino);
463 fprintf(f, "%*lld", width, (long long) ctx->blkcount);
467 (unsigned long long) get_backup_sb(NULL, fs,
471 fprintf(f, "%*s", width, ctx->str ? ctx->str : "NULL");
474 print_time(f, (time_t) ctx->num);
477 print_time(f, e2fsck_ctx ? e2fsck_ctx->now : time(0));
491 m = _("unknown quota type");
494 if (*first && islower(m[0]))
495 fputc(toupper(*m++), f);
497 if (ctx->num > PRJQUOTA)
498 fprintf(f, " %d", (int) ctx->num);
501 fprintf(f, "0x%0*x", width, ctx->csum1);
504 fprintf(f, "0x%0*llx", width, (long long)ctx->num);
507 fprintf(f, "0x%0*x", width, ctx->csum2);
511 fprintf(f, "%%%c", ch);
516 void print_e2fsck_message(FILE *f, e2fsck_t ctx, const char *msg,
517 struct problem_context *pctx, int first,
520 ext2_filsys fs = ctx->fs;
524 e2fsck_clear_progbar(ctx);
525 for (cp = msg; *cp; cp++) {
528 expand_at_expression(f, ctx, *cp, pctx, &first,
530 } else if (cp[0] == '%') {
533 while (isdigit(cp[0])) {
534 width = (width * 10) + cp[0] - '0';
539 expand_inode_expression(f, fs, *cp, pctx);
540 } else if (cp[0] == 'D') {
542 expand_dirent_expression(f, fs, *cp, pctx);
544 expand_percent_expression(f, fs, *cp, width,
548 for (i=0; cp[i]; i++)
549 if ((cp[i] == '@') || cp[i] == '%')
551 fprintf(f, "%.*s", i, cp);