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> integer
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 * %Ib <inode> -> i_blocks
29 * %Il <inode> -> i_links_count
30 * %Im <inode> -> i_mode
31 * %IM <inode> -> i_mtime
32 * %IF <inode> -> i_faddr
33 * %If <inode> -> i_file_acl
34 * %Id <inode> -> i_dir_acl
35 * %Iu <inode> -> i_uid
36 * %Ig <inode> -> i_gid
37 * %j <ino2> inode number
38 * %m <com_err error message>
40 * %p ext2fs_get_pathname of directory <ino>
41 * %P ext2fs_get_pathname of <dirent>->ino with <ino2> as
42 * the containing directory. (If dirent is NULL
43 * then return the pathname of directory <ino2>)
44 * %q ext2fs_get_pathname of directory <dir>
45 * %Q ext2fs_get_pathname of directory <ino> with <dir> as
46 * the containing directory.
47 * %s <str> miscellaneous string
48 * %S backup superblock
49 * %X <num> hexadecimal format
51 * The following '@' expansions are supported:
53 * @a extended attribute
58 * @C conflicts with some other fs block
62 * @E Entry '%Dn' in %p (%i)
64 * @F for @i %i (%Q) is
91 #define _INLINE_ __inline__
97 * This structure defines the abbreviations used by the text strings
98 * below. The first character in the string is the index letter. An
99 * abbreviation of the form '@<i>' is expanded by looking up the index
100 * letter <i> in the table below.
102 static const char *abbrevs[] = {
103 N_("aextended attribute"),
104 N_("Aerror allocating"),
108 N_("Cconflicts with some other fs @b"),
115 N_("E@e '%Dn' in %p (%i)"),
117 N_("Ffor @i %i (%Q) is"),
133 * Give more user friendly names to the "special" inodes.
135 #define num_special_inodes 11
136 static const char *special_inode_name[] =
138 N_("<The NULL inode>"), /* 0 */
139 N_("<The bad blocks inode>"), /* 1 */
141 N_("<The ACL index inode>"), /* 3 */
142 N_("<The ACL data inode>"), /* 4 */
143 N_("<The boot loader inode>"), /* 5 */
144 N_("<The undelete directory inode>"), /* 6 */
145 N_("<The group descriptor inode>"), /* 7 */
146 N_("<The journal inode>"), /* 8 */
147 N_("<Reserved inode 9>"), /* 9 */
148 N_("<Reserved inode 10>"), /* 10 */
152 * This function does "safe" printing. It will convert non-printable
153 * ASCII characters using '^' and M- notation.
155 static void safe_print(const char *cp, int len)
168 if ((ch < 32) || (ch == 0x7f)) {
170 ch ^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
178 * This function prints a pathname, using the ext2fs_get_pathname
181 static void print_pathname(ext2_filsys fs, ext2_ino_t dir, ext2_ino_t ino)
186 if (!dir && (ino < num_special_inodes)) {
187 fputs(_(special_inode_name[ino]), stdout);
191 retval = ext2fs_get_pathname(fs, dir, ino, &path);
193 fputs("???", stdout);
195 safe_print(path, -1);
196 ext2fs_free_mem((void **) &path);
201 * This function handles the '@' expansion. We allow recursive
202 * expansion; an @ expression can contain further '@' and '%'
205 static _INLINE_ void expand_at_expression(e2fsck_t ctx, char ch,
206 struct problem_context *pctx,
209 const char **cpp, *str;
211 /* Search for the abbreviation */
212 for (cpp = abbrevs; *cpp; cpp++) {
218 if (*first && islower(*str)) {
220 fputc(toupper(*str++), stdout);
222 print_e2fsck_message(ctx, _(str), pctx, *first);
228 * This function expands '%IX' expressions
230 static _INLINE_ void expand_inode_expression(char ch,
231 struct problem_context *ctx)
233 struct ext2_inode *inode;
237 if (!ctx || !ctx->inode)
244 if (LINUX_S_ISDIR(inode->i_mode))
245 printf("%u", inode->i_size);
247 #ifdef EXT2_NO_64_TYPE
248 if (inode->i_size_high)
249 printf("0x%x%08x", inode->i_size_high,
252 printf("%u", inode->i_size);
254 printf("%llu", (inode->i_size |
255 ((__u64) inode->i_size_high << 32)));
260 printf("%u", inode->i_blocks);
263 printf("%d", inode->i_links_count);
266 printf("0%o", inode->i_mode);
270 time_str = ctime(&t);
271 printf("%.24s", time_str);
274 printf("%u", inode->i_faddr);
277 printf("%u", inode->i_file_acl);
280 printf("%u", (LINUX_S_ISDIR(inode->i_mode) ?
281 inode->i_dir_acl : 0));
284 printf("%d", (inode->i_uid |
285 (inode->osd2.linux2.l_i_uid_high << 16)));
288 printf("%d", (inode->i_gid |
289 (inode->osd2.linux2.l_i_gid_high << 16)));
299 * This function expands '%dX' expressions
301 static _INLINE_ void expand_dirent_expression(char ch,
302 struct problem_context *ctx)
304 struct ext2_dir_entry *dirent;
307 if (!ctx || !ctx->dirent)
310 dirent = ctx->dirent;
314 printf("%u", dirent->inode);
317 len = dirent->name_len & 0xFF;
318 if (len > EXT2_NAME_LEN)
320 if (len > dirent->rec_len)
321 len = dirent->rec_len;
322 safe_print(dirent->name, len);
325 printf("%u", dirent->rec_len);
328 printf("%u", dirent->name_len & 0xFF);
331 printf("%u", dirent->name_len >> 8);
340 static _INLINE_ void expand_percent_expression(ext2_filsys fs, char ch,
341 struct problem_context *ctx)
351 printf("%u", ctx->blk);
354 #ifdef EXT2_NO_64_TYPE
355 printf("%d", ctx->blkcount);
357 printf("%lld", ctx->blkcount);
361 printf("%u", ctx->blk2);
364 printf("%u", ctx->dir);
367 printf("%d", ctx->group);
370 printf("%u", ctx->ino);
373 printf("%u", ctx->ino2);
376 printf("%s", error_message(ctx->errcode));
379 #ifdef EXT2_NO_64_TYPE
380 printf("%u", ctx->num);
382 printf("%llu", ctx->num);
386 print_pathname(fs, ctx->ino, 0);
389 print_pathname(fs, ctx->ino2,
390 ctx->dirent ? ctx->dirent->inode : 0);
393 print_pathname(fs, ctx->dir, 0);
396 print_pathname(fs, ctx->dir, ctx->ino);
399 printf("%d", get_backup_sb(fs));
402 printf("%s", ctx->str ? ctx->str : "NULL");
405 #ifdef EXT2_NO_64_TYPE
406 printf("0x%x", ctx->num);
408 printf("0x%llx", ctx->num);
418 void print_e2fsck_message(e2fsck_t ctx, const char *msg,
419 struct problem_context *pctx, int first)
421 ext2_filsys fs = ctx->fs;
425 e2fsck_clear_progbar(ctx);
426 for (cp = msg; *cp; cp++) {
429 expand_at_expression(ctx, *cp, pctx, &first);
430 } else if (cp[0] == '%' && cp[1] == 'I') {
432 expand_inode_expression(*cp, pctx);
433 } else if (cp[0] == '%' && cp[1] == 'D') {
435 expand_dirent_expression(*cp, pctx);
436 } else if ((cp[0] == '%')) {
438 expand_percent_expression(fs, *cp, pctx);
440 for (i=0; cp[i]; i++)
441 if ((cp[i] == '@') || cp[i] == '%')
443 printf("%.*s", i, cp);