e2fsck/message.c

   1 /*
   2  * message.c --- print e2fsck messages (with compression)
   3  *
   4  * Copyright 1996, 1997 by Theodore Ts'o
   5  *
   6  * %Begin-Header%
   7  * This file may be redistributed under the terms of the GNU Public
   8  * License.
   9  * %End-Header%
  10  *
  11  * print_e2fsck_message() prints a message to the user, using
  12  * compression techniques and expansions of abbreviations.
  13  *
  14  * The following % expansions are supported:
  15  *
  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
  25  *      %g      <group>                 integer
  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
  38  *      %It     <inode type>
  39  *      %j      <ino2>                  inode number
  40  *      %m      <com_err error message>
  41  *      %N      <num>
  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
  53  *
  54  * The following '@' expansions are supported:
  55  *
  56  *      @a      extended attribute
  57  *      @A      error allocating
  58  *      @b      block
  59  *      @B      bitmap
  60  *      @c      compress
  61  *      @C      conflicts with some other fs block
  62  *      @D      deleted
  63  *      @d      directory
  64  *      @e      entry
  65  *      @E      Entry '%Dn' in %p (%i)
  66  *      @f      filesystem
  67  *      @F      for @i %i (%Q) is
  68  *      @g      group
  69  *      @h      HTREE directory inode
  70  *      @i      inode
  71  *      @I      illegal
  72  *      @j      journal
  73  *      @l      lost+found
  74  *      @L      is a link
  75  *      @m      multiply-claimed
  76  *      @n      invalid
  77  *      @o      orphaned
  78  *      @p      problem in
  79  *      @q      quota
  80  *      @r      root inode
  81  *      @s      should be
  82  *      @S      superblock
  83  *      @u      unattached
  84  *      @v      device
  85  *      @x      extent
  86  *      @z      zero-length
  87  */
  88
  89 #include <stdlib.h>
  90 #include <unistd.h>
  91 #include <string.h>
  92 #include <ctype.h>
  93 #include <termios.h>
  94
  95 #include "e2fsck.h"
  96
  97 #include "problem.h"
  98
  99 #ifdef __GNUC__
 100 #define _INLINE_ __inline__
 101 #else
 102 #define _INLINE_
 103 #endif
 104
 105 /*
 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.
 110  */
 111 static const char *abbrevs[] = {
 112         N_("aextended attribute"),
 113         N_("Aerror allocating"),
 114         N_("bblock"),
 115         N_("Bbitmap"),
 116         N_("ccompress"),
 117         N_("Cconflicts with some other fs @b"),
 118         N_("iinode"),
 119         N_("Iillegal"),
 120         N_("jjournal"),
 121         N_("Ddeleted"),
 122         N_("ddirectory"),
 123         N_("eentry"),
 124         N_("E@e '%Dn' in %p (%i)"),
 125         N_("ffilesystem"),
 126         N_("Ffor @i %i (%Q) is"),
 127         N_("ggroup"),
 128         N_("hHTREE @d @i"),
 129         N_("llost+found"),
 130         N_("Lis a link"),
 131         N_("mmultiply-claimed"),
 132         N_("ninvalid"),
 133         N_("oorphaned"),
 134         N_("pproblem in"),
 135         N_("qquota"),
 136         N_("rroot @i"),
 137         N_("sshould be"),
 138         N_("Ssuper@b"),
 139         N_("uunattached"),
 140         N_("vdevice"),
 141         N_("xextent"),
 142         N_("zzero-length"),
 143         "@@",
 144         0
 145         };
 146
 147 /*
 148  * Give more user friendly names to the "special" inodes.
 149  */
 150 #define num_special_inodes      11
 151 static const char *special_inode_name[] =
 152 {
 153         N_("<The NULL inode>"),                 /* 0 */
 154         N_("<The bad blocks inode>"),           /* 1 */
 155         "/",                                    /* 2 */
 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 */
 164 };
 165
 166 /*
 167  * This function does "safe" printing.  It will convert non-printable
 168  * ASCII characters using '^' and M- notation.
 169  */
 170 static void safe_print(const char *cp, int len)
 171 {
 172         unsigned char   ch;
 173
 174         if (len < 0)
 175                 len = strlen(cp);
 176
 177         while (len--) {
 178                 ch = *cp++;
 179                 if (ch > 128) {
 180                         fputs("M-", stdout);
 181                         ch -= 128;
 182                 }
 183                 if ((ch < 32) || (ch == 0x7f)) {
 184                         fputc('^', stdout);
 185                         ch ^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
 186                 }
 187                 fputc(ch, stdout);
 188         }
 189 }
 190
 191
 192 /*
 193  * This function prints a pathname, using the ext2fs_get_pathname
 194  * function
 195  */
 196 static void print_pathname(ext2_filsys fs, ext2_ino_t dir, ext2_ino_t ino)
 197 {
 198         errcode_t       retval;
 199         char            *path;
 200
 201         if (!dir && (ino < num_special_inodes)) {
 202                 fputs(_(special_inode_name[ino]), stdout);
 203                 return;
 204         }
 205
 206         if (fs)
 207                 retval = ext2fs_get_pathname(fs, dir, ino, &path);
 208         if (!fs || retval)
 209                 fputs("???", stdout);
 210         else {
 211                 safe_print(path, -1);
 212                 ext2fs_free_mem(&path);
 213         }
 214 }
 215
 216 static void print_time(time_t t)
 217 {
 218         const char *            time_str;
 219         static int              do_gmt = -1;
 220
 221 #ifdef __dietlibc__
 222                 /* The diet libc doesn't respect the TZ environemnt variable */
 223                 if (do_gmt == -1) {
 224                         time_str = getenv("TZ");
 225                         if (!time_str)
 226                                 time_str = "";
 227                         do_gmt = !strcmp(time_str, "GMT0");
 228                 }
 229 #endif
 230                 time_str = asctime((do_gmt > 0) ? gmtime(&t) : localtime(&t));
 231                 printf("%.24s", time_str);
 232 }
 233
 234 /*
 235  * This function handles the '@' expansion.  We allow recursive
 236  * expansion; an @ expression can contain further '@' and '%'
 237  * expressions.
 238  */
 239 static _INLINE_ void expand_at_expression(e2fsck_t ctx, char ch,
 240                                           struct problem_context *pctx,
 241                                           int *first, int recurse)
 242 {
 243         const char **cpp, *str;
 244
 245         /* Search for the abbreviation */
 246         for (cpp = abbrevs; *cpp; cpp++) {
 247                 if (ch == *cpp[0])
 248                         break;
 249         }
 250         if (*cpp && recurse < 10) {
 251                 str = _(*cpp) + 1;
 252                 if (*first && islower(*str)) {
 253                         *first = 0;
 254                         fputc(toupper(*str++), stdout);
 255                 }
 256                 print_e2fsck_message(ctx, str, pctx, *first, recurse+1);
 257         } else
 258                 printf("@%c", ch);
 259 }
 260
 261 /*
 262  * This function expands '%IX' expressions
 263  */
 264 static _INLINE_ void expand_inode_expression(ext2_filsys fs, char ch,
 265                                              struct problem_context *ctx)
 266 {
 267         struct ext2_inode       *inode;
 268         struct ext2_inode_large *large_inode;
 269
 270         if (!ctx || !ctx->inode)
 271                 goto no_inode;
 272
 273         inode = ctx->inode;
 274         large_inode = (struct ext2_inode_large *) inode;
 275
 276         switch (ch) {
 277         case 's':
 278                 if (LINUX_S_ISDIR(inode->i_mode))
 279                         printf("%u", inode->i_size);
 280                 else {
 281 #ifdef EXT2_NO_64_TYPE
 282                         if (inode->i_size_high)
 283                                 printf("0x%x%08x", inode->i_size_high,
 284                                        inode->i_size);
 285                         else
 286                                 printf("%u", inode->i_size);
 287 #else
 288                         printf("%llu", EXT2_I_SIZE(inode));
 289 #endif
 290                 }
 291                 break;
 292         case 'S':
 293                 printf("%u", large_inode->i_extra_isize);
 294                 break;
 295         case 'b':
 296                 if (fs->super->s_feature_ro_compat &
 297                     EXT4_FEATURE_RO_COMPAT_HUGE_FILE)
 298                         printf("%llu", inode->i_blocks +
 299                                (((long long) inode->osd2.linux2.l_i_blocks_hi)
 300                                 << 32));
 301                 else
 302                         printf("%u", inode->i_blocks);
 303                 break;
 304         case 'l':
 305                 printf("%d", inode->i_links_count);
 306                 break;
 307         case 'm':
 308                 printf("0%o", inode->i_mode);
 309                 break;
 310         case 'M':
 311                 print_time(inode->i_mtime);
 312                 break;
 313         case 'F':
 314                 printf("%u", inode->i_faddr);
 315                 break;
 316         case 'f':
 317                 printf("%llu", ext2fs_file_acl_block(inode));
 318                 break;
 319         case 'd':
 320                 printf("%u", (LINUX_S_ISDIR(inode->i_mode) ?
 321                               inode->i_dir_acl : 0));
 322                 break;
 323         case 'u':
 324                 printf("%d", inode_uid(*inode));
 325                 break;
 326         case 'g':
 327                 printf("%d", inode_gid(*inode));
 328                 break;
 329         case 't':
 330                 if (LINUX_S_ISREG(inode->i_mode))
 331                         printf(_("regular file"));
 332                 else if (LINUX_S_ISDIR(inode->i_mode))
 333                         printf(_("directory"));
 334                 else if (LINUX_S_ISCHR(inode->i_mode))
 335                         printf(_("character device"));
 336                 else if (LINUX_S_ISBLK(inode->i_mode))
 337                         printf(_("block device"));
 338                 else if (LINUX_S_ISFIFO(inode->i_mode))
 339                         printf(_("named pipe"));
 340                 else if (LINUX_S_ISLNK(inode->i_mode))
 341                         printf(_("symbolic link"));
 342                 else if (LINUX_S_ISSOCK(inode->i_mode))
 343                         printf(_("socket"));
 344                 else
 345                         printf(_("unknown file type with mode 0%o"),
 346                                inode->i_mode);
 347                 break;
 348         default:
 349         no_inode:
 350                 printf("%%I%c", ch);
 351                 break;
 352         }
 353 }
 354
 355 /*
 356  * This function expands '%dX' expressions
 357  */
 358 static _INLINE_ void expand_dirent_expression(ext2_filsys fs, char ch,
 359                                               struct problem_context *ctx)
 360 {
 361         struct ext2_dir_entry   *dirent;
 362         unsigned int rec_len;
 363         int     len;
 364
 365         if (!ctx || !ctx->dirent)
 366                 goto no_dirent;
 367
 368         dirent = ctx->dirent;
 369
 370         switch (ch) {
 371         case 'i':
 372                 printf("%u", dirent->inode);
 373                 break;
 374         case 'n':
 375                 len = dirent->name_len & 0xFF;
 376                 if ((ext2fs_get_rec_len(fs, dirent, &rec_len) == 0) &&
 377                     (len > rec_len))
 378                         len = rec_len;
 379                 safe_print(dirent->name, len);
 380                 break;
 381         case 'r':
 382                 (void) ext2fs_get_rec_len(fs, dirent, &rec_len);
 383                 printf("%u", rec_len);
 384                 break;
 385         case 'l':
 386                 printf("%u", dirent->name_len & 0xFF);
 387                 break;
 388         case 't':
 389                 printf("%u", dirent->name_len >> 8);
 390                 break;
 391         default:
 392         no_dirent:
 393                 printf("%%D%c", ch);
 394                 break;
 395         }
 396 }
 397
 398 static _INLINE_ void expand_percent_expression(ext2_filsys fs, char ch,
 399                                                int *first,
 400                                                struct problem_context *ctx)
 401 {
 402         e2fsck_t e2fsck_ctx = fs ? (e2fsck_t) fs->priv_data : NULL;
 403         const char *m;
 404
 405         if (!ctx)
 406                 goto no_context;
 407
 408         switch (ch) {
 409         case '%':
 410                 fputc('%', stdout);
 411                 break;
 412         case 'b':
 413 #ifdef EXT2_NO_64_TYPE
 414                 printf("%u", (unsigned long) ctx->blk);
 415 #else
 416                 printf("%llu", (unsigned long long) ctx->blk);
 417 #endif
 418                 break;
 419         case 'B':
 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");
 428                 else
 429                         m = _("block #");
 430                 if (*first && islower(m[0]))
 431                         fputc(toupper(*m++), stdout);
 432                 fputs(m, stdout);
 433                 if (ctx->blkcount >= 0) {
 434 #ifdef EXT2_NO_64_TYPE
 435                         printf("%d", ctx->blkcount);
 436 #else
 437                         printf("%lld", (long long) ctx->blkcount);
 438 #endif
 439                 }
 440                 break;
 441         case 'c':
 442 #ifdef EXT2_NO_64_TYPE
 443                 printf("%u", (unsigned long) ctx->blk2);
 444 #else
 445                 printf("%llu", (unsigned long long) ctx->blk2);
 446 #endif
 447                 break;
 448         case 'd':
 449                 printf("%u", ctx->dir);
 450                 break;
 451         case 'g':
 452                 printf("%d", ctx->group);
 453                 break;
 454         case 'i':
 455                 printf("%u", ctx->ino);
 456                 break;
 457         case 'j':
 458                 printf("%u", ctx->ino2);
 459                 break;
 460         case 'm':
 461                 printf("%s", error_message(ctx->errcode));
 462                 break;
 463         case 'N':
 464 #ifdef EXT2_NO_64_TYPE
 465                 printf("%u", ctx->num);
 466 #else
 467                 printf("%llu", (long long)ctx->num);
 468 #endif
 469                 break;
 470         case 'p':
 471                 print_pathname(fs, ctx->ino, 0);
 472                 break;
 473         case 'P':
 474                 print_pathname(fs, ctx->ino2,
 475                                ctx->dirent ? ctx->dirent->inode : 0);
 476                 break;
 477         case 'q':
 478                 print_pathname(fs, ctx->dir, 0);
 479                 break;
 480         case 'Q':
 481                 print_pathname(fs, ctx->dir, ctx->ino);
 482                 break;
 483         case 'r':
 484 #ifdef EXT2_NO_64_TYPE
 485                 printf("%d", ctx->blkcount);
 486 #else
 487                 printf("%lld", (long long) ctx->blkcount);
 488 #endif
 489                 break;
 490         case 'S':
 491                 printf("%u", get_backup_sb(NULL, fs, NULL, NULL));
 492                 break;
 493         case 's':
 494                 printf("%s", ctx->str ? ctx->str : "NULL");
 495                 break;
 496         case 't':
 497                 print_time((time_t) ctx->num);
 498                 break;
 499         case 'T':
 500                 print_time(e2fsck_ctx ? e2fsck_ctx->now : time(0));
 501                 break;
 502         case 'X':
 503 #ifdef EXT2_NO_64_TYPE
 504                 printf("0x%x", ctx->num);
 505 #else
 506                 printf("0x%llx", (long long)ctx->num);
 507 #endif
 508                 break;
 509         default:
 510         no_context:
 511                 printf("%%%c", ch);
 512                 break;
 513         }
 514 }
 515
 516 void print_e2fsck_message(e2fsck_t ctx, const char *msg,
 517                           struct problem_context *pctx, int first,
 518                           int recurse)
 519 {
 520         ext2_filsys fs = ctx->fs;
 521         const char *    cp;
 522         int             i;
 523
 524         e2fsck_clear_progbar(ctx);
 525         for (cp = msg; *cp; cp++) {
 526                 if (cp[0] == '@') {
 527                         cp++;
 528                         expand_at_expression(ctx, *cp, pctx, &first, recurse);
 529                 } else if (cp[0] == '%' && cp[1] == 'I') {
 530                         cp += 2;
 531                         expand_inode_expression(fs, *cp, pctx);
 532                 } else if (cp[0] == '%' && cp[1] == 'D') {
 533                         cp += 2;
 534                         expand_dirent_expression(fs, *cp, pctx);
 535                 } else if ((cp[0] == '%')) {
 536                         cp++;
 537                         expand_percent_expression(fs, *cp, &first, pctx);
 538                 } else {
 539                         for (i=0; cp[i]; i++)
 540                                 if ((cp[i] == '@') || cp[i] == '%')
 541                                         break;
 542                         printf("%.*s", i, cp);
 543                         cp += i-1;
 544                 }
 545                 first = 0;
 546         }
 547 }