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 * %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 * %s <str> miscellaneous string
50 * %S backup superblock
51 * %X <num> hexadecimal format
53 * The following '@' expansions are supported:
55 * @a extended attribute
60 * @C conflicts with some other fs block
64 * @E Entry '%Dn' in %p (%i)
66 * @F for @i %i (%Q) is
68 * @h HTREE directory inode
98 #define _INLINE_ __inline__
104 * This structure defines the abbreviations used by the text strings
105 * below. The first character in the string is the index letter. An
106 * abbreviation of the form '@<i>' is expanded by looking up the index
107 * letter <i> in the table below.
109 static const char *abbrevs[] = {
110 N_("aextended attribute"),
111 N_("Aerror allocating"),
115 N_("Cconflicts with some other fs @b"),
122 N_("E@e '%Dn' in %p (%i)"),
124 N_("Ffor @i %i (%Q) is"),
129 N_("mmultiply-claimed"),
145 * Give more user friendly names to the "special" inodes.
147 #define num_special_inodes 11
148 static const char *special_inode_name[] =
150 N_("<The NULL inode>"), /* 0 */
151 N_("<The bad blocks inode>"), /* 1 */
153 N_("<The ACL index inode>"), /* 3 */
154 N_("<The ACL data inode>"), /* 4 */
155 N_("<The boot loader inode>"), /* 5 */
156 N_("<The undelete directory inode>"), /* 6 */
157 N_("<The group descriptor inode>"), /* 7 */
158 N_("<The journal inode>"), /* 8 */
159 N_("<Reserved inode 9>"), /* 9 */
160 N_("<Reserved inode 10>"), /* 10 */
164 * This function does "safe" printing. It will convert non-printable
165 * ASCII characters using '^' and M- notation.
167 static void safe_print(const char *cp, int len)
180 if ((ch < 32) || (ch == 0x7f)) {
182 ch ^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
190 * This function prints a pathname, using the ext2fs_get_pathname
193 static void print_pathname(ext2_filsys fs, ext2_ino_t dir, ext2_ino_t ino)
198 if (!dir && (ino < num_special_inodes)) {
199 fputs(_(special_inode_name[ino]), stdout);
203 retval = ext2fs_get_pathname(fs, dir, ino, &path);
205 fputs("???", stdout);
207 safe_print(path, -1);
208 ext2fs_free_mem(&path);
213 * This function handles the '@' expansion. We allow recursive
214 * expansion; an @ expression can contain further '@' and '%'
217 static _INLINE_ void expand_at_expression(e2fsck_t ctx, char ch,
218 struct problem_context *pctx,
219 int *first, int recurse)
221 const char **cpp, *str;
223 /* Search for the abbreviation */
224 for (cpp = abbrevs; *cpp; cpp++) {
228 if (*cpp && recurse < 10) {
230 if (*first && islower(*str)) {
232 fputc(toupper(*str++), stdout);
234 print_e2fsck_message(ctx, str, pctx, *first, recurse+1);
240 * This function expands '%IX' expressions
242 static _INLINE_ void expand_inode_expression(char ch,
243 struct problem_context *ctx)
245 struct ext2_inode *inode;
246 struct ext2_inode_large *large_inode;
247 const char * time_str;
251 if (!ctx || !ctx->inode)
255 large_inode = (struct ext2_inode_large *) inode;
259 if (LINUX_S_ISDIR(inode->i_mode))
260 printf("%u", inode->i_size);
262 #ifdef EXT2_NO_64_TYPE
263 if (inode->i_size_high)
264 printf("0x%x%08x", inode->i_size_high,
267 printf("%u", inode->i_size);
269 printf("%llu", inode->i_size |
270 ((long long)inode->i_size_high << 32));
275 printf("%u", large_inode->i_extra_isize);
278 printf("%u", inode->i_blocks);
281 printf("%d", inode->i_links_count);
284 printf("0%o", inode->i_mode);
287 /* The diet libc doesn't respect the TZ environemnt variable */
289 time_str = getenv("TZ");
292 do_gmt = !strcmp(time_str, "GMT");
295 time_str = asctime(do_gmt ? gmtime(&t) : localtime(&t));
296 printf("%.24s", time_str);
299 printf("%u", inode->i_faddr);
302 printf("%u", inode->i_file_acl);
305 printf("%u", (LINUX_S_ISDIR(inode->i_mode) ?
306 inode->i_dir_acl : 0));
309 printf("%d", inode_uid(*inode));
312 printf("%d", inode_gid(*inode));
315 if (LINUX_S_ISREG(inode->i_mode))
316 printf(_("regular file"));
317 else if (LINUX_S_ISDIR(inode->i_mode))
318 printf(_("directory"));
319 else if (LINUX_S_ISCHR(inode->i_mode))
320 printf(_("character device"));
321 else if (LINUX_S_ISBLK(inode->i_mode))
322 printf(_("block device"));
323 else if (LINUX_S_ISFIFO(inode->i_mode))
324 printf(_("named pipe"));
325 else if (LINUX_S_ISLNK(inode->i_mode))
326 printf(_("symbolic link"));
327 else if (LINUX_S_ISSOCK(inode->i_mode))
330 printf(_("unknown file type with mode 0%o"),
341 * This function expands '%dX' expressions
343 static _INLINE_ void expand_dirent_expression(char ch,
344 struct problem_context *ctx)
346 struct ext2_dir_entry *dirent;
349 if (!ctx || !ctx->dirent)
352 dirent = ctx->dirent;
356 printf("%u", dirent->inode);
359 len = dirent->name_len & 0xFF;
360 if (len > EXT2_NAME_LEN)
362 if (len > dirent->rec_len)
363 len = dirent->rec_len;
364 safe_print(dirent->name, len);
367 printf("%u", dirent->rec_len);
370 printf("%u", dirent->name_len & 0xFF);
373 printf("%u", dirent->name_len >> 8);
382 static _INLINE_ void expand_percent_expression(ext2_filsys fs, char ch,
383 struct problem_context *ctx)
393 #ifdef EXT2_NO_64_TYPE
394 printf("%u", (unsigned long) ctx->blk);
396 printf("%llu", (unsigned long long) ctx->blk);
400 #ifdef EXT2_NO_64_TYPE
401 printf("%d", ctx->blkcount);
403 printf("%lld", (long long)ctx->blkcount);
407 #ifdef EXT2_NO_64_TYPE
408 printf("%u", (unsigned long) ctx->blk2);
410 printf("%llu", (unsigned long long) ctx->blk2);
414 printf("%u", ctx->dir);
417 printf("%d", ctx->group);
420 printf("%u", ctx->ino);
423 printf("%u", ctx->ino2);
426 printf("%s", error_message(ctx->errcode));
429 #ifdef EXT2_NO_64_TYPE
430 printf("%u", ctx->num);
432 printf("%llu", (long long)ctx->num);
436 print_pathname(fs, ctx->ino, 0);
439 print_pathname(fs, ctx->ino2,
440 ctx->dirent ? ctx->dirent->inode : 0);
443 print_pathname(fs, ctx->dir, 0);
446 print_pathname(fs, ctx->dir, ctx->ino);
449 printf("%u", get_backup_sb(NULL, fs, NULL, NULL));
452 printf("%s", ctx->str ? ctx->str : "NULL");
455 #ifdef EXT2_NO_64_TYPE
456 printf("0x%x", ctx->num);
458 printf("0x%llx", (long long)ctx->num);
468 void print_e2fsck_message(e2fsck_t ctx, const char *msg,
469 struct problem_context *pctx, int first,
472 ext2_filsys fs = ctx->fs;
476 e2fsck_clear_progbar(ctx);
477 for (cp = msg; *cp; cp++) {
480 expand_at_expression(ctx, *cp, pctx, &first, recurse);
481 } else if (cp[0] == '%' && cp[1] == 'I') {
483 expand_inode_expression(*cp, pctx);
484 } else if (cp[0] == '%' && cp[1] == 'D') {
486 expand_dirent_expression(*cp, pctx);
487 } else if ((cp[0] == '%')) {
489 expand_percent_expression(fs, *cp, pctx);
491 for (i=0; cp[i]; i++)
492 if ((cp[i] == '@') || cp[i] == '%')
494 printf("%.*s", i, cp);