debugfs/xattrs.c

   1 /*
   2  * xattrs.c --- Modify extended attributes via debugfs.
   3  *
   4  * Copyright (C) 2014 Oracle.  This file may be redistributed
   5  * under the terms of the GNU Public License.
   6  */
   7
   8 #include "config.h"
   9 #include <stdio.h>
  10 #ifdef HAVE_GETOPT_H
  11 #include <getopt.h>
  12 #else
  13 extern int optind;
  14 extern char *optarg;
  15 #endif
  16 #include <ctype.h>
  17 #include "support/cstring.h"
  18
  19 #include "debugfs.h"
  20 #include "ext2fs/lfsck.h"
  21
  22 #define PRINT_XATTR_HEX         0x01
  23 #define PRINT_XATTR_RAW         0x02
  24 #define PRINT_XATTR_C           0x04
  25 #define PRINT_XATTR_STATFMT     0x08
  26 #define PRINT_XATTR_NOQUOTES    0x10
  27
  28 extern const char *debug_prog_name;
  29
  30 /* Dump extended attributes */
  31 static void print_xattr_hex(FILE *f, const char *str, int len)
  32 {
  33         int i;
  34
  35         for (i = 0; i < len; i++)
  36                 fprintf(f, "%02x ", (unsigned char)str[i]);
  37 }
  38
  39 /* Dump extended attributes */
  40 static void print_xattr_string(FILE *f, const char *str, int len, int flags)
  41 {
  42         int printable = 0;
  43         int i;
  44
  45         if (flags & PRINT_XATTR_RAW) {
  46                 fwrite(str, len, 1, f);
  47                 return;
  48         }
  49
  50         if ((flags & PRINT_XATTR_C) == 0) {
  51                 /* check: is string "printable enough?" */
  52                 for (i = 0; i < len; i++)
  53                         if (isprint(str[i]))
  54                                 printable++;
  55
  56                 if (printable <= len*7/8)
  57                         flags |= PRINT_XATTR_HEX;
  58         }
  59
  60         if (flags & PRINT_XATTR_HEX) {
  61                 print_xattr_hex(f, str, len);
  62         } else {
  63                 if ((flags & PRINT_XATTR_NOQUOTES) == 0)
  64                         fputc('\"', f);
  65                 print_c_string(f, str, len);
  66                 if ((flags & PRINT_XATTR_NOQUOTES) == 0)
  67                         fputc('\"', f);
  68         }
  69 }
  70
  71 static void print_xattr(FILE *f, char *name, char *value, size_t value_len,
  72                         int print_flags)
  73 {
  74         print_xattr_string(f, name, strlen(name), PRINT_XATTR_NOQUOTES);
  75         fprintf(f, " (%zu)", value_len);
  76         if ((print_flags & PRINT_XATTR_STATFMT) &&
  77             (strcmp(name, "system.data") == 0))
  78                 value_len = 0;
  79         if (value_len != 0 &&
  80             (!(print_flags & PRINT_XATTR_STATFMT) || (value_len < 120))) {
  81                 fprintf(f, " = ");
  82                 print_xattr_string(f, value, value_len, print_flags);
  83         }
  84         fputc('\n', f);
  85 }
  86
  87 static void print_fidstr(FILE *f, void *name, void *value,
  88                          ext2_ino_t inode_num, size_t value_len)
  89 {
  90         struct filter_fid_old *ff = value;
  91         int stripe;
  92
  93         /* Since Lustre 2.4 only the parent FID is stored in filter_fid,
  94          * and the self fid is stored in the LMA and is printed below. */
  95         if (value_len < sizeof(ff->ff_parent)) {
  96                 fprintf(stderr, "%s: error: filter_fid for inode %u smaller "
  97                         "than expected (%lu bytes).\n",
  98                         debug_prog_name, inode_num, value_len);
  99                 return;
 100         }
 101         fid_le_to_cpu(&ff->ff_parent, &ff->ff_parent);
 102         stripe = fid_ver(&ff->ff_parent); /* stripe index is stored in f_ver */
 103         ff->ff_parent.f_ver = 0;
 104
 105         fprintf(f, "  fid: ");
 106         /* Old larger filter_fid should only ever be used with seq = 0.
 107          * FID-on-OST should use LMA for FID_SEQ_NORMAL OST objects. */
 108         if (value_len == sizeof(*ff))
 109                 fprintf(f, "objid=%llu seq=%llu ",
 110                         ext2fs_le64_to_cpu(ff->ff_objid),
 111                         ext2fs_le64_to_cpu(ff->ff_seq));
 112
 113         fprintf(f, "parent="DFID" stripe=%u", PFID(&ff->ff_parent), stripe);
 114         if (value_len > sizeof(*ff)) {
 115                 struct filter_fid *ff_new = value;
 116
 117                 fprintf(f, " stripe_size=%u stripe_count=%u",
 118                         ext2fs_le32_to_cpu(ff_new->ff_stripe_size),
 119                         ext2fs_le32_to_cpu(ff_new->ff_stripe_count));
 120                 if (ff_new->ff_pfl_id != 0)
 121                         fprintf(f, " component_id=%u component_start=%llu "
 122                                 "component_end=%llu",
 123                                 ext2fs_le32_to_cpu(ff_new->ff_pfl_id),
 124                                 ext2fs_le64_to_cpu(ff_new->ff_pfl_start),
 125                                 ext2fs_le64_to_cpu(ff_new->ff_pfl_end));
 126         }
 127         fprintf(f, "\n");
 128 }
 129
 130 static void print_lmastr(FILE *f, void *name, void *value,
 131                          ext2_ino_t inode_num, size_t value_len)
 132 {
 133         struct lustre_mdt_attrs *lma = value;
 134         struct lustre_ost_attrs *loa = value;
 135
 136         if (value_len < offsetof(typeof(*lma), lma_self_fid) +
 137                         sizeof(lma->lma_self_fid)) {
 138                 fprintf(stderr, "%s: error: LMA for inode %u smaller than "
 139                         "expected (%lu bytes).\n",
 140                         debug_prog_name, inode_num, value_len);
 141                 return;
 142         }
 143         fid_le_to_cpu(&lma->lma_self_fid, &lma->lma_self_fid);
 144         fprintf(f, "  lma: fid="DFID" compat=%x incompat=%x\n",
 145                 PFID(&lma->lma_self_fid), ext2fs_le32_to_cpu(lma->lma_compat),
 146                 ext2fs_le32_to_cpu(lma->lma_incompat));
 147         if (value_len >= offsetof(typeof(*loa), loa_pfl_end) +
 148                   sizeof(loa->loa_pfl_end)) {
 149                 int idx;
 150                 int cnt;
 151
 152                 fid_le_to_cpu(&loa->loa_parent_fid, &loa->loa_parent_fid);
 153                 idx = loa->loa_parent_fid.f_ver & PFID_STRIPE_COUNT_MASK;
 154                 cnt = loa->loa_parent_fid.f_ver >> PFID_STRIPE_IDX_BITS;
 155                 loa->loa_parent_fid.f_ver = 0;
 156
 157                 fprintf(f, "  fid: parent="DFID" stripe=%u stripe_size=%u "
 158                         "stripe_count=%u", PFID(&loa->loa_parent_fid), idx,
 159                         ext2fs_le32_to_cpu(loa->loa_stripe_size), cnt);
 160                 if (loa->loa_pfl_id != 0)
 161                         fprintf(f, " component_id=%u component_start=%llu "
 162                                 "component_end=%llu",
 163                                 ext2fs_le32_to_cpu(loa->loa_pfl_id),
 164                                 ext2fs_le64_to_cpu(loa->loa_pfl_start),
 165                                 ext2fs_le64_to_cpu(loa->loa_pfl_end));
 166                 fprintf(f, "\n");
 167         }
 168 }
 169
 170 static int dump_attr(char *name, char *value, size_t value_len,
 171                      ext2_ino_t inode_num, void *data)
 172 {
 173         FILE *out = data;
 174
 175         fprintf(out, "  ");
 176         print_xattr(out, name, value, value_len, PRINT_XATTR_STATFMT);
 177         if (!strncmp(name, EXT2_ATTR_INDEX_TRUSTED_PREFIX LUSTRE_XATTR_OST_FID,
 178                      strlen(name)) ||
 179             !strncmp(name, EXT2_ATTR_INDEX_LUSTRE_PREFIX LUSTRE_XATTR_OST_FID,
 180                      strlen(name)))
 181                 print_fidstr(out, name, value, inode_num, value_len);
 182         if (!strncmp(name, EXT2_ATTR_INDEX_TRUSTED_PREFIX LUSTRE_XATTR_MDT_LMA,
 183                      strlen(name)) ||
 184             !strncmp(name, EXT2_ATTR_INDEX_LUSTRE_PREFIX LUSTRE_XATTR_MDT_LMA,
 185                      strlen(name)))
 186                 print_lmastr(out, name, value, inode_num, value_len);
 187         return 0;
 188 }
 189
 190 void dump_inode_attributes(FILE *out, ext2_ino_t ino)
 191 {
 192         struct ext2_xattr_handle *h;
 193         size_t sz;
 194         errcode_t err;
 195
 196         err = ext2fs_xattrs_open(current_fs, ino, &h);
 197         if (err)
 198                 return;
 199
 200         err = ext2fs_xattrs_read(h);
 201         if (err)
 202                 goto out;
 203
 204         err = ext2fs_xattrs_count(h, &sz);
 205         if (err || sz == 0)
 206                 goto out;
 207
 208         fprintf(out, "Extended attributes:\n");
 209         err = ext2fs_xattrs_iterate(h, dump_attr, out);
 210         if (err)
 211                 goto out;
 212
 213 out:
 214         err = ext2fs_xattrs_close(&h);
 215 }
 216
 217 void do_list_xattr(int argc, char **argv, int sci_idx EXT2FS_ATTR((unused)),
 218                    void *infop EXT2FS_ATTR((unused)))
 219 {
 220         ext2_ino_t ino;
 221
 222         if (argc != 2) {
 223                 printf("%s: Usage: %s <file>\n", argv[0],
 224                        argv[0]);
 225                 return;
 226         }
 227
 228         if (check_fs_open(argv[0]))
 229                 return;
 230
 231         ino = string_to_inode(argv[1]);
 232         if (!ino)
 233                 return;
 234
 235         dump_inode_attributes(stdout, ino);
 236 }
 237
 238 void do_get_xattr(int argc, char **argv, int sci_idx EXT2FS_ATTR((unused)),
 239                   void *infop EXT2FS_ATTR((unused)))
 240 {
 241         ext2_ino_t ino;
 242         struct ext2_xattr_handle *h;
 243         FILE *fp = NULL;
 244         char *buf = NULL;
 245         size_t buflen;
 246         int i;
 247         int print_flags = 0;
 248         unsigned int handle_flags = 0;
 249         errcode_t err;
 250
 251         reset_getopt();
 252         while ((i = getopt(argc, argv, "Cf:rxV")) != -1) {
 253                 switch (i) {
 254                 case 'f':
 255                         if (fp)
 256                                 fclose(fp);
 257                         fp = fopen(optarg, "w");
 258                         if (fp == NULL) {
 259                                 perror(optarg);
 260                                 return;
 261                         }
 262                         break;
 263                 case 'r':
 264                         handle_flags |= XATTR_HANDLE_FLAG_RAW;
 265                         break;
 266                 case 'x':
 267                         print_flags |= PRINT_XATTR_HEX;
 268                         break;
 269                 case 'V':
 270                         print_flags |= PRINT_XATTR_RAW|
 271                                 PRINT_XATTR_NOQUOTES;
 272                         break;
 273                 case 'C':
 274                         print_flags |= PRINT_XATTR_C;
 275                         break;
 276                 default:
 277                         goto usage;
 278                 }
 279         }
 280
 281         if (optind != argc - 2) {
 282         usage:
 283                 printf("%s: Usage: %s [-f outfile]|[-xVC] [-r] <file> <attr>\n",
 284                                argv[0], argv[0]);
 285
 286                 goto out2;
 287         }
 288
 289         if (check_fs_open(argv[0]))
 290                 goto out2;
 291
 292         ino = string_to_inode(argv[optind]);
 293         if (!ino)
 294                 goto out2;
 295
 296         err = ext2fs_xattrs_open(current_fs, ino, &h);
 297         if (err)
 298                 goto out2;
 299
 300         err = ext2fs_xattrs_flags(h, &handle_flags, NULL);
 301         if (err)
 302                 goto out;
 303
 304         err = ext2fs_xattrs_read(h);
 305         if (err)
 306                 goto out;
 307
 308         err = ext2fs_xattr_get(h, argv[optind + 1], (void **)&buf, &buflen);
 309         if (err)
 310                 goto out;
 311
 312         if (fp) {
 313                 fwrite(buf, buflen, 1, fp);
 314         } else {
 315                 if (print_flags & PRINT_XATTR_RAW) {
 316                         if (print_flags & (PRINT_XATTR_HEX|PRINT_XATTR_C))
 317                                 print_flags &= ~PRINT_XATTR_RAW;
 318                         print_xattr_string(stdout, buf, buflen, print_flags);
 319                 } else {
 320                         print_xattr(stdout, argv[optind + 1],
 321                                     buf, buflen, print_flags);
 322                 }
 323                 printf("\n");
 324         }
 325
 326         ext2fs_free_mem(&buf);
 327 out:
 328         ext2fs_xattrs_close(&h);
 329         if (err)
 330                 com_err(argv[0], err, "while getting extended attribute");
 331 out2:
 332         if (fp)
 333                 fclose(fp);
 334 }
 335
 336 void do_set_xattr(int argc, char **argv, int sci_idx EXT2FS_ATTR((unused)),
 337                   void *infop EXT2FS_ATTR((unused)))
 338 {
 339         ext2_ino_t ino;
 340         struct ext2_xattr_handle *h;
 341         FILE *fp = NULL;
 342         char *buf = NULL;
 343         size_t buflen;
 344         unsigned int handle_flags = 0;
 345         int i;
 346         errcode_t err;
 347
 348         reset_getopt();
 349         while ((i = getopt(argc, argv, "f:r")) != -1) {
 350                 switch (i) {
 351                 case 'f':
 352                         if (fp)
 353                                 fclose(fp);
 354                         fp = fopen(optarg, "r");
 355                         if (fp == NULL) {
 356                                 perror(optarg);
 357                                 return;
 358                         }
 359                         break;
 360                 case 'r':
 361                         handle_flags |= XATTR_HANDLE_FLAG_RAW;
 362                         break;
 363                 default:
 364                         goto print_usage;
 365                 }
 366         }
 367
 368         if (!(fp && optind == argc - 2) && !(!fp && optind == argc - 3)) {
 369         print_usage:
 370                 printf("Usage:\t%s [-r] <file> <attr> <value>\n", argv[0]);
 371                 printf("\t%s -f <value_file> [-r] <file> <attr>\n", argv[0]);
 372                 goto out2;
 373         }
 374
 375         if (check_fs_open(argv[0]))
 376                 goto out2;
 377         if (check_fs_read_write(argv[0]))
 378                 goto out2;
 379         if (check_fs_bitmaps(argv[0]))
 380                 goto out2;
 381
 382         ino = string_to_inode(argv[optind]);
 383         if (!ino)
 384                 goto out2;
 385
 386         err = ext2fs_xattrs_open(current_fs, ino, &h);
 387         if (err)
 388                 goto out2;
 389
 390         err = ext2fs_xattrs_flags(h, &handle_flags, NULL);
 391         if (err)
 392                 goto out;
 393
 394         err = ext2fs_xattrs_read(h);
 395         if (err)
 396                 goto out;
 397
 398         if (fp) {
 399                 err = ext2fs_get_mem(current_fs->blocksize, &buf);
 400                 if (err)
 401                         goto out;
 402                 buflen = fread(buf, 1, current_fs->blocksize, fp);
 403         } else {
 404                 buf = argv[optind + 2];
 405                 buflen = parse_c_string(buf);
 406         }
 407
 408         err = ext2fs_xattr_set(h, argv[optind + 1], buf, buflen);
 409 out:
 410         ext2fs_xattrs_close(&h);
 411         if (err)
 412                 com_err(argv[0], err, "while setting extended attribute");
 413 out2:
 414         if (fp) {
 415                 fclose(fp);
 416                 ext2fs_free_mem(&buf);
 417         }
 418 }
 419
 420 void do_rm_xattr(int argc, char **argv, int sci_idx EXT2FS_ATTR((unused)),
 421                  void *infop EXT2FS_ATTR((unused)))
 422 {
 423         ext2_ino_t ino;
 424         struct ext2_xattr_handle *h;
 425         int i;
 426         errcode_t err;
 427
 428         if (argc < 3) {
 429                 printf("%s: Usage: %s <file> <attrs>...\n", argv[0], argv[0]);
 430                 return;
 431         }
 432
 433         if (check_fs_open(argv[0]))
 434                 return;
 435         if (check_fs_read_write(argv[0]))
 436                 return;
 437         if (check_fs_bitmaps(argv[0]))
 438                 return;
 439
 440         ino = string_to_inode(argv[1]);
 441         if (!ino)
 442                 return;
 443
 444         err = ext2fs_xattrs_open(current_fs, ino, &h);
 445         if (err)
 446                 return;
 447
 448         err = ext2fs_xattrs_read(h);
 449         if (err)
 450                 goto out;
 451
 452         for (i = 2; i < argc; i++) {
 453                 err = ext2fs_xattr_remove(h, argv[i]);
 454                 if (err)
 455                         goto out;
 456         }
 457 out:
 458         ext2fs_xattrs_close(&h);
 459         if (err)
 460                 com_err(argv[0], err, "while removing extended attribute");
 461 }
 462
 463 /*
 464  * Return non-zero if the string has a minimal number of non-printable
 465  * characters.
 466  */
 467 static int is_mostly_printable(const char *cp, int len)
 468 {
 469         int     np = 0;
 470
 471         if (len < 0)
 472                 len = strlen(cp);
 473
 474         while (len--) {
 475                 if (!isprint(*cp++)) {
 476                         np++;
 477                         if (np > 3)
 478                                 return 0;
 479                 }
 480         }
 481         return 1;
 482 }
 483
 484 static void safe_print(FILE *f, const char *cp, int len)
 485 {
 486         unsigned char   ch;
 487
 488         if (len < 0)
 489                 len = strlen(cp);
 490
 491         while (len--) {
 492                 ch = *cp++;
 493                 if (ch > 128) {
 494                         fputs("M-", f);
 495                         ch -= 128;
 496                 }
 497                 if ((ch < 32) || (ch == 0x7f)) {
 498                         fputc('^', f);
 499                         ch ^= 0x40; /* ^@, ^A, ^B; ^? for DEL */
 500                 }
 501                 fputc(ch, f);
 502         }
 503 }
 504
 505 static void dump_xattr_raw_entries(FILE *f, unsigned char *buf,
 506                                    unsigned int start, unsigned int len,
 507                                    unsigned value_start)
 508 {
 509         struct ext2_ext_attr_entry ent;
 510         unsigned int off = start;
 511         unsigned int vstart;
 512
 513         while (off < len) {
 514                 if ((*(__u16 *) (buf + off)) == 0) {
 515                         fprintf(f, "last entry found at offset %u (%04o)\n",
 516                                 off, off);
 517                         break;
 518                 }
 519                 if ((off + sizeof(struct ext2_ext_attr_entry)) >= len) {
 520                         fprintf(f, "xattr buffer overrun at %u (len = %u)\n",
 521                                 off, len);
 522                         break;
 523                 }
 524 #if WORDS_BIGENDIAN
 525                 ext2fs_swap_ext_attr_entry(&ent,
 526                         (struct ext2_ext_attr_entry *) (buf + off));
 527 #else
 528                 ent = *((struct ext2_ext_attr_entry *) (buf + off));
 529 #endif
 530                 fprintf(f, "offset = %d (%04o), name_len = %u, "
 531                         "name_index = %u\n",
 532                         off, off, ent.e_name_len, ent.e_name_index);
 533                 vstart = value_start + ent.e_value_offs;
 534                 fprintf(f, "value_offset = %d (%04o), value_inum = %u, "
 535                         "value_size = %u\n", ent.e_value_offs,
 536                         vstart, ent.e_value_inum, ent.e_value_size);
 537                 off += sizeof(struct ext2_ext_attr_entry);
 538                 fprintf(f, "name = ");
 539                 if ((off + ent.e_name_len) >= len)
 540                         fprintf(f, "<runs off end>");
 541                 else
 542                         safe_print(f, (char *)(buf + off), ent.e_name_len);
 543                 fputc('\n', f);
 544                 if (ent.e_value_size == 0)
 545                         goto skip_value;
 546                 fprintf(f, "value = ");
 547                 if (ent.e_value_inum)
 548                         fprintf(f, "<ino %u>", ent.e_value_inum);
 549                 else if (ent.e_value_offs >= len ||
 550                          (vstart + ent.e_value_size) > len)
 551                         fprintf(f, "<runs off end>");
 552                 else if (is_mostly_printable((char *)(buf + vstart),
 553                                         ent.e_value_size))
 554                         safe_print(f, (char *)(buf + vstart),
 555                                    ent.e_value_size);
 556                 else {
 557                         fprintf(f, "<hexdump>\n");
 558                         do_byte_hexdump(f, (unsigned char *)(buf + vstart),
 559                                         ent.e_value_size);
 560                 }
 561                 fputc('\n', f);
 562         skip_value:
 563                 fputc('\n', f);
 564                 off += (ent.e_name_len + 3) & ~3;
 565         }
 566 }
 567
 568 void raw_inode_xattr_dump(FILE *f, unsigned char *buf, unsigned int len)
 569 {
 570         __u32 magic = ext2fs_le32_to_cpu(*((__le32 *) buf));
 571
 572         fprintf(f, "magic = %08x, length = %u, value_start =4 \n\n",
 573                 magic, len);
 574         if (magic == EXT2_EXT_ATTR_MAGIC)
 575                 dump_xattr_raw_entries(f, buf, 4, len, 4);
 576 }
 577
 578 void block_xattr_dump(FILE *f, unsigned char *buf, unsigned int len)
 579 {
 580         struct ext2_ext_attr_header header;
 581
 582 #ifdef WORDS_BIGENDIAN
 583         ext2fs_swap_ext_attr_header(&header,
 584                                     (struct ext2_ext_attr_header *) buf);
 585 #else
 586         header = *((struct ext2_ext_attr_header *) buf);
 587 #endif
 588         fprintf(f, "magic = %08x, length = %u\n", header.h_magic, len);
 589         if (header.h_magic != EXT2_EXT_ATTR_MAGIC)
 590                 return;
 591         fprintf(f, "refcount = %u, blocks = %u\n", header.h_refcount,
 592                 header.h_blocks);
 593         fprintf(f, "hash = %08x, checksum = %08x\n", header.h_hash,
 594                 header.h_checksum);
 595         fprintf(f, "reserved: %08x %08x %08x\n\n", header.h_reserved[0],
 596                 header.h_reserved[1], header.h_reserved[2]);
 597
 598         dump_xattr_raw_entries(f, buf,
 599                                sizeof(struct ext2_ext_attr_header), len, 0);
 600 }