lustre/llite/dir.c

   1 /*
   2  *
   3  * Copyright (C) 1992, 1993, 1994, 1995
   4  * Remy Card (card@masi.ibp.fr)
   5  * Laboratoire MASI - Institut Blaise Pascal
   6  * Universite Pierre et Marie Curie (Paris VI)
   7  *
   8  *  from
   9  *
  10  *  linux/fs/minix/dir.c
  11  *  linux/fs/ext2/dir.c
  12  *
  13  *  Copyright (C) 1991, 1992  Linus Torvalds
  14  *
  15  *  ext2 directory handling functions
  16  *
  17  *  Big-endian to little-endian byte-swapping/bitmaps by
  18  *        David S. Miller (davem@caip.rutgers.edu), 1995
  19  *
  20  *  All code that works with directory layout had been switched to pagecache
  21  *  and moved here. AV
  22  *
  23  *  Adapted for Lustre Light
  24  *  Copyright (C) 2002, Cluster File Systems, Inc.
  25  *
  26  */
  27
  28 #include <linux/fs.h>
  29 #include <linux/ext2_fs.h>
  30 #include <linux/pagemap.h>
  31 #include <linux/mm.h>
  32 #include <linux/obd_support.h>
  33 #include <linux/locks.h>
  34
  35 typedef struct ext2_dir_entry_2 ext2_dirent;
  36
  37 #define PageChecked(page)        test_bit(PG_checked, &(page)->flags)
  38 #define SetPageChecked(page)     set_bit(PG_checked, &(page)->flags)
  39
  40 int waitfor_one_page(struct page *page)
  41 {
  42         int error = 0;
  43         struct buffer_head *bh, *head = page->buffers;
  44
  45         bh = head;
  46         do {
  47                 wait_on_buffer(bh);
  48                 if (buffer_req(bh) && !buffer_uptodate(bh))
  49                         error = -EIO;
  50         } while ((bh = bh->b_this_page) != head);
  51         return error;
  52 }
  53
  54 /*
  55  * ext2 uses block-sized chunks. Arguably, sector-sized ones would be
  56  * more robust, but we have what we have
  57  */
  58 static inline unsigned ext2_chunk_size(struct inode *inode)
  59 {
  60         //return inode->i_sb->s_blocksize;
  61         return PAGE_SIZE;
  62 }
  63
  64 static inline void ext2_put_page(struct page *page)
  65 {
  66         kunmap(page);
  67         page_cache_release(page);
  68 }
  69
  70 static inline unsigned long dir_pages(struct inode *inode)
  71 {
  72         return (inode->i_size+PAGE_CACHE_SIZE-1)>>PAGE_CACHE_SHIFT;
  73 }
  74
  75 extern void set_page_clean(struct page *page);
  76
  77 static int ext2_commit_chunk(struct page *page, unsigned from, unsigned to)
  78 {
  79         struct inode *dir = page->mapping->host;
  80         int err = 0;
  81         dir->i_version = ++event;
  82         SetPageUptodate(page);
  83         set_page_clean(page);
  84
  85         //page->mapping->a_ops->commit_write(NULL, page, from, to);
  86         //if (IS_SYNC(dir))
  87         //      err = waitfor_one_page(page);
  88         return err;
  89 }
  90
  91 static void ext2_check_page(struct page *page)
  92 {
  93         struct inode *dir = page->mapping->host;
  94         unsigned chunk_size = ext2_chunk_size(dir);
  95         char *kaddr = page_address(page);
  96         //      u32 max_inumber = le32_to_cpu(sb->u.ext2_sb.s_es->s_inodes_count);
  97         unsigned offs, rec_len;
  98         unsigned limit = PAGE_CACHE_SIZE;
  99         ext2_dirent *p;
 100         char *error;
 101
 102         if ((dir->i_size >> PAGE_CACHE_SHIFT) == page->index) {
 103                 limit = dir->i_size & ~PAGE_CACHE_MASK;
 104                 if (limit & (chunk_size - 1))
 105                         goto Ebadsize;
 106                 for (offs = limit; offs<PAGE_CACHE_SIZE; offs += chunk_size) {
 107                         ext2_dirent *p = (ext2_dirent*)(kaddr + offs);
 108                         p->rec_len = cpu_to_le16(chunk_size);
 109                 }
 110                 if (!limit)
 111                         goto out;
 112         }
 113         for (offs = 0; offs <= limit - EXT2_DIR_REC_LEN(1); offs += rec_len) {
 114                 p = (ext2_dirent *)(kaddr + offs);
 115                 rec_len = le16_to_cpu(p->rec_len);
 116
 117                 if (rec_len < EXT2_DIR_REC_LEN(1))
 118                         goto Eshort;
 119                 if (rec_len & 3)
 120                         goto Ealign;
 121                 if (rec_len < EXT2_DIR_REC_LEN(p->name_len))
 122                         goto Enamelen;
 123                 if (((offs + rec_len - 1) ^ offs) & ~(chunk_size-1))
 124                         goto Espan;
 125                 //              if (le32_to_cpu(p->inode) > max_inumber)
 126                 //goto Einumber;
 127         }
 128         if (offs != limit)
 129                 goto Eend;
 130 out:
 131         SetPageChecked(page);
 132         return;
 133
 134         /* Too bad, we had an error */
 135
 136 Ebadsize:
 137         printk("ext2_check_page"
 138                 "size of directory #%lu is not a multiple of chunk size",
 139                 dir->i_ino
 140         );
 141         goto fail;
 142 Eshort:
 143         error = "rec_len is smaller than minimal";
 144         goto bad_entry;
 145 Ealign:
 146         error = "unaligned directory entry";
 147         goto bad_entry;
 148 Enamelen:
 149         error = "rec_len is too small for name_len";
 150         goto bad_entry;
 151 Espan:
 152         error = "directory entry across blocks";
 153         goto bad_entry;
 154         //Einumber:
 155         // error = "inode out of bounds";
 156 bad_entry:
 157         printk("ext2_check_page: bad entry in directory #%lu: %s - "
 158                 "offset=%lu, inode=%lu, rec_len=%d, name_len=%d",
 159                 dir->i_ino, error, (page->index<<PAGE_CACHE_SHIFT)+offs,
 160                 (unsigned long) le32_to_cpu(p->inode),
 161                 rec_len, p->name_len);
 162         goto fail;
 163 Eend:
 164         p = (ext2_dirent *)(kaddr + offs);
 165         printk("ext2_check_page"
 166                 "entry in directory #%lu spans the page boundary"
 167                 "offset=%lu, inode=%lu",
 168                 dir->i_ino, (page->index<<PAGE_CACHE_SHIFT)+offs,
 169                 (unsigned long) le32_to_cpu(p->inode));
 170 fail:
 171         SetPageChecked(page);
 172         SetPageError(page);
 173 }
 174
 175 static struct page * ext2_get_page(struct inode *dir, unsigned long n)
 176 {
 177         struct address_space *mapping = dir->i_mapping;
 178         struct page *page = read_cache_page(mapping, n,
 179                                 (filler_t*)mapping->a_ops->readpage, NULL);
 180         if (!IS_ERR(page)) {
 181                 wait_on_page(page);
 182                 kmap(page);
 183                 if (!Page_Uptodate(page))
 184                         goto fail;
 185                 if (!PageChecked(page))
 186                         ext2_check_page(page);
 187                 if (PageError(page))
 188                         goto fail;
 189         }
 190         return page;
 191
 192 fail:
 193         ext2_put_page(page);
 194         return ERR_PTR(-EIO);
 195 }
 196
 197 /*
 198  * NOTE! unlike strncmp, ext2_match returns 1 for success, 0 for failure.
 199  *
 200  * len <= EXT2_NAME_LEN and de != NULL are guaranteed by caller.
 201  */
 202 static inline int ext2_match (int len, const char * const name,
 203                                         struct ext2_dir_entry_2 * de)
 204 {
 205         if (len != de->name_len)
 206                 return 0;
 207         if (!de->inode)
 208                 return 0;
 209         return !memcmp(name, de->name, len);
 210 }
 211
 212 /*
 213  * p is at least 6 bytes before the end of page
 214  */
 215 static inline ext2_dirent *ext2_next_entry(ext2_dirent *p)
 216 {
 217         return (ext2_dirent *)((char*)p + le16_to_cpu(p->rec_len));
 218 }
 219
 220 static inline unsigned
 221 ext2_validate_entry(char *base, unsigned offset, unsigned mask)
 222 {
 223         ext2_dirent *de = (ext2_dirent*)(base + offset);
 224         ext2_dirent *p = (ext2_dirent*)(base + (offset&mask));
 225         while ((char*)p < (char*)de)
 226                 p = ext2_next_entry(p);
 227         return (char *)p - base;
 228 }
 229
 230 static unsigned char ext2_filetype_table[EXT2_FT_MAX] = {
 231         [EXT2_FT_UNKNOWN]       DT_UNKNOWN,
 232         [EXT2_FT_REG_FILE]      DT_REG,
 233         [EXT2_FT_DIR]           DT_DIR,
 234         [EXT2_FT_CHRDEV]        DT_CHR,
 235         [EXT2_FT_BLKDEV]        DT_BLK,
 236         [EXT2_FT_FIFO]          DT_FIFO,
 237         [EXT2_FT_SOCK]          DT_SOCK,
 238         [EXT2_FT_SYMLINK]       DT_LNK,
 239 };
 240
 241 static unsigned int ll_dt2fmt[DT_WHT + 1] = {
 242         [EXT2_FT_UNKNOWN]       0,
 243         [EXT2_FT_REG_FILE]      S_IFREG,
 244         [EXT2_FT_DIR]           S_IFDIR,
 245         [EXT2_FT_CHRDEV]        S_IFCHR,
 246         [EXT2_FT_BLKDEV]        S_IFBLK,
 247         [EXT2_FT_FIFO]          S_IFIFO,
 248         [EXT2_FT_SOCK]          S_IFSOCK,
 249         [EXT2_FT_SYMLINK]       S_IFLNK
 250 };
 251
 252 #define S_SHIFT 12
 253 static unsigned char ext2_type_by_mode[S_IFMT >> S_SHIFT] = {
 254         [S_IFREG >> S_SHIFT]    EXT2_FT_REG_FILE,
 255         [S_IFDIR >> S_SHIFT]    EXT2_FT_DIR,
 256         [S_IFCHR >> S_SHIFT]    EXT2_FT_CHRDEV,
 257         [S_IFBLK >> S_SHIFT]    EXT2_FT_BLKDEV,
 258         [S_IFIFO >> S_SHIFT]    EXT2_FT_FIFO,
 259         [S_IFSOCK >> S_SHIFT]   EXT2_FT_SOCK,
 260         [S_IFLNK >> S_SHIFT]    EXT2_FT_SYMLINK,
 261 };
 262
 263 static inline void ext2_set_de_type(ext2_dirent *de, struct inode *inode)
 264 {
 265         mode_t mode = inode->i_mode;
 266         de->file_type = ext2_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
 267 }
 268
 269 int
 270 new_ll_readdir (struct file * filp, void * dirent, filldir_t filldir)
 271 {
 272         loff_t pos = filp->f_pos;
 273         struct inode *inode = filp->f_dentry->d_inode;
 274         // XXX struct super_block *sb = inode->i_sb;
 275         unsigned offset = pos & ~PAGE_CACHE_MASK;
 276         unsigned long n = pos >> PAGE_CACHE_SHIFT;
 277         unsigned long npages = dir_pages(inode);
 278         unsigned chunk_mask = ~(ext2_chunk_size(inode)-1);
 279         unsigned char *types = NULL;
 280         int need_revalidate = (filp->f_version != inode->i_version);
 281
 282         if (pos > inode->i_size - EXT2_DIR_REC_LEN(1))
 283                 goto done;
 284
 285         types = ext2_filetype_table;
 286
 287         for ( ; n < npages; n++, offset = 0) {
 288                 char *kaddr, *limit;
 289                 ext2_dirent *de;
 290                 struct page *page = ext2_get_page(inode, n);
 291
 292                 if (IS_ERR(page))
 293                         continue;
 294                 kaddr = page_address(page);
 295                 if (need_revalidate) {
 296                         offset = ext2_validate_entry(kaddr, offset, chunk_mask);
 297                         need_revalidate = 0;
 298                 }
 299                 de = (ext2_dirent *)(kaddr+offset);
 300                 limit = kaddr + PAGE_CACHE_SIZE - EXT2_DIR_REC_LEN(1);
 301                 for ( ;(char*)de <= limit; de = ext2_next_entry(de))
 302                         if (de->inode) {
 303                                 int over;
 304                                 unsigned char d_type = DT_UNKNOWN;
 305
 306                                 if (types && de->file_type < EXT2_FT_MAX)
 307                                         d_type = types[de->file_type];
 308
 309                                 offset = (char *)de - kaddr;
 310                                 over = filldir(dirent, de->name, de->name_len,
 311                                                 (n<<PAGE_CACHE_SHIFT) | offset,
 312                                                 le32_to_cpu(de->inode), d_type);
 313                                 if (over) {
 314                                         ext2_put_page(page);
 315                                         goto done;
 316                                 }
 317                         }
 318                 ext2_put_page(page);
 319         }
 320
 321 done:
 322         filp->f_pos = (n << PAGE_CACHE_SHIFT) | offset;
 323         filp->f_version = inode->i_version;
 324         UPDATE_ATIME(inode);
 325         return 0;
 326 }
 327
 328 /*
 329  *      ext2_find_entry()
 330  *
 331  * finds an entry in the specified directory with the wanted name. It
 332  * returns the page in which the entry was found, and the entry itself
 333  * (as a parameter - res_dir). Page is returned mapped and unlocked.
 334  * Entry is guaranteed to be valid.
 335  */
 336 struct ext2_dir_entry_2 * ext2_find_entry (struct inode * dir,
 337                         struct dentry *dentry, struct page ** res_page)
 338 {
 339         const char *name = dentry->d_name.name;
 340         int namelen = dentry->d_name.len;
 341         unsigned reclen = EXT2_DIR_REC_LEN(namelen);
 342         unsigned long start, n;
 343         unsigned long npages = dir_pages(dir);
 344         struct page *page = NULL;
 345         ext2_dirent * de;
 346
 347         /* OFFSET_CACHE */
 348         *res_page = NULL;
 349
 350         //      start = dir->u.ext2_i.i_dir_start_lookup;
 351         start = 0;
 352         if (start >= npages)
 353                 start = 0;
 354         n = start;
 355         do {
 356                 char *kaddr;
 357                 page = ext2_get_page(dir, n);
 358                 if (!IS_ERR(page)) {
 359                         kaddr = page_address(page);
 360                         de = (ext2_dirent *) kaddr;
 361                         kaddr += PAGE_CACHE_SIZE - reclen;
 362                         while ((char *) de <= kaddr) {
 363                                 if (ext2_match (namelen, name, de))
 364                                         goto found;
 365                                 de = ext2_next_entry(de);
 366                         }
 367                         ext2_put_page(page);
 368                 }
 369                 if (++n >= npages)
 370                         n = 0;
 371         } while (n != start);
 372         return NULL;
 373
 374 found:
 375         *res_page = page;
 376         //      dir->u.ext2_i.i_dir_start_lookup = n;
 377         return de;
 378 }
 379
 380 struct ext2_dir_entry_2 * ext2_dotdot (struct inode *dir, struct page **p)
 381 {
 382         struct page *page = ext2_get_page(dir, 0);
 383         ext2_dirent *de = NULL;
 384
 385         if (!IS_ERR(page)) {
 386                 de = ext2_next_entry((ext2_dirent *) page_address(page));
 387                 *p = page;
 388         }
 389         return de;
 390 }
 391
 392 ino_t ll_inode_by_name(struct inode * dir, struct dentry *dentry, int *type)
 393 {
 394         ino_t res = 0;
 395         struct ext2_dir_entry_2 * de;
 396         struct page *page;
 397
 398         de = ext2_find_entry (dir, dentry, &page);
 399         if (de) {
 400                 res = le32_to_cpu(de->inode);
 401                 *type = ll_dt2fmt[de->file_type];
 402                 kunmap(page);
 403                 page_cache_release(page);
 404         }
 405         return res;
 406 }
 407
 408 /* Releases the page */
 409 void ext2_set_link(struct inode *dir, struct ext2_dir_entry_2 *de,
 410                         struct page *page, struct inode *inode)
 411 {
 412         unsigned from = (char *) de - (char *) page_address(page);
 413         unsigned to = from + le16_to_cpu(de->rec_len);
 414         int err;
 415
 416         lock_page(page);
 417         err = page->mapping->a_ops->prepare_write(NULL, page, from, to);
 418         if (err)
 419                 BUG();
 420         de->inode = cpu_to_le32(inode->i_ino);
 421         ext2_set_de_type (de, inode);
 422         dir->i_mtime = dir->i_ctime = CURRENT_TIME;
 423         err = ext2_commit_chunk(page, from, to);
 424         UnlockPage(page);
 425         ext2_put_page(page);
 426 }
 427
 428 /*
 429  *      Parent is locked.
 430  */
 431 int ll_add_link (struct dentry *dentry, struct inode *inode)
 432 {
 433         struct inode *dir = dentry->d_parent->d_inode;
 434         const char *name = dentry->d_name.name;
 435         int namelen = dentry->d_name.len;
 436         unsigned reclen = EXT2_DIR_REC_LEN(namelen);
 437         unsigned short rec_len, name_len;
 438         struct page *page = NULL;
 439         ext2_dirent * de;
 440         unsigned long npages = dir_pages(dir);
 441         unsigned long n;
 442         char *kaddr;
 443         unsigned from, to;
 444         int err;
 445
 446         /* We take care of directory expansion in the same loop */
 447         for (n = 0; n <= npages; n++) {
 448                 page = ext2_get_page(dir, n);
 449                 err = PTR_ERR(page);
 450                 if (IS_ERR(page))
 451                         goto out;
 452                 kaddr = page_address(page);
 453                 de = (ext2_dirent *)kaddr;
 454                 kaddr += PAGE_CACHE_SIZE - reclen;
 455                 while ((char *)de <= kaddr) {
 456                         err = -EEXIST;
 457                         if (ext2_match (namelen, name, de))
 458                                 goto out_page;
 459                         name_len = EXT2_DIR_REC_LEN(de->name_len);
 460                         rec_len = le16_to_cpu(de->rec_len);
 461                         if ( n==npages && rec_len == 0) {
 462                                 printk("Fatal dir behaviour\n");
 463                                 goto out_page;
 464                         }
 465                         if (!de->inode && rec_len >= reclen)
 466                                 goto got_it;
 467                         if (rec_len >= name_len + reclen)
 468                                 goto got_it;
 469                         de = (ext2_dirent *) ((char *) de + rec_len);
 470                 }
 471                 ext2_put_page(page);
 472         }
 473         BUG();
 474         return -EINVAL;
 475
 476 got_it:
 477         from = (char*)de - (char*)page_address(page);
 478         to = from + rec_len;
 479         lock_page(page);
 480         //err = page->mapping->a_ops->prepare_write(NULL, page, from, to);
 481         //if (err)
 482         //      goto out_unlock;
 483         if (de->inode) {
 484                 ext2_dirent *de1 = (ext2_dirent *) ((char *) de + name_len);
 485                 de1->rec_len = cpu_to_le16(rec_len - name_len);
 486                 de->rec_len = cpu_to_le16(name_len);
 487                 de = de1;
 488         }
 489         de->name_len = namelen;
 490         memcpy (de->name, name, namelen);
 491         de->inode = cpu_to_le32(inode->i_ino);
 492         ext2_set_de_type (de, inode);
 493         CDEBUG(D_INODE, "type set to %o\n", de->file_type);
 494         dir->i_mtime = dir->i_ctime = CURRENT_TIME;
 495         err = ext2_commit_chunk(page, from, to);
 496
 497         // change_inode happens with the commit_chunk
 498         /* XXX OFFSET_CACHE */
 499
 500 out_unlock:
 501         UnlockPage(page);
 502 out_page:
 503         ext2_put_page(page);
 504 out:
 505         return err;
 506 }
 507
 508 /*
 509  * ext2_delete_entry deletes a directory entry by merging it with the
 510  * previous entry. Page is up-to-date. Releases the page.
 511  */
 512 int ext2_delete_entry (struct ext2_dir_entry_2 * dir, struct page * page )
 513 {
 514         struct address_space *mapping = page->mapping;
 515         struct inode *inode = mapping->host;
 516         char *kaddr = page_address(page);
 517         unsigned from = ((char*)dir - kaddr) & ~(ext2_chunk_size(inode)-1);
 518         unsigned to = ((char*)dir - kaddr) + le16_to_cpu(dir->rec_len);
 519         ext2_dirent * pde = NULL;
 520         ext2_dirent * de = (ext2_dirent *) (kaddr + from);
 521         int err;
 522
 523         while ((char*)de < (char*)dir) {
 524                 pde = de;
 525                 de = ext2_next_entry(de);
 526         }
 527         if (pde)
 528                 from = (char*)pde - (char*)page_address(page);
 529         lock_page(page);
 530         err = mapping->a_ops->prepare_write(NULL, page, from, to);
 531         if (err)
 532                 BUG();
 533         if (pde)
 534                 pde->rec_len = cpu_to_le16(to-from);
 535         dir->inode = 0;
 536         inode->i_ctime = inode->i_mtime = CURRENT_TIME;
 537         err = ext2_commit_chunk(page, from, to);
 538         UnlockPage(page);
 539         ext2_put_page(page);
 540         return err;
 541 }
 542
 543 /*
 544  * Set the first fragment of directory.
 545  */
 546 int ext2_make_empty(struct inode *inode, struct inode *parent)
 547 {
 548         struct address_space *mapping = inode->i_mapping;
 549         struct page *page = grab_cache_page(mapping, 0);
 550         unsigned chunk_size = ext2_chunk_size(inode);
 551         struct ext2_dir_entry_2 * de;
 552         char *base;
 553         int err;
 554         ENTRY;
 555
 556         if (!page)
 557                 return -ENOMEM;
 558         err = mapping->a_ops->prepare_write(NULL, page, 0, chunk_size);
 559         if (err)
 560                 goto fail;
 561
 562         base = page_address(page);
 563
 564         de = (struct ext2_dir_entry_2 *) base;
 565         de->name_len = 1;
 566         de->rec_len = cpu_to_le16(EXT2_DIR_REC_LEN(1));
 567         memcpy (de->name, ".\0\0", 4);
 568         de->inode = cpu_to_le32(inode->i_ino);
 569         ext2_set_de_type (de, inode);
 570
 571         de = (struct ext2_dir_entry_2 *) (base + EXT2_DIR_REC_LEN(1));
 572         de->name_len = 2;
 573         de->rec_len = cpu_to_le16(chunk_size - EXT2_DIR_REC_LEN(1));
 574         de->inode = cpu_to_le32(parent->i_ino);
 575         memcpy (de->name, "..\0", 4);
 576         ext2_set_de_type (de, inode);
 577
 578         err = ext2_commit_chunk(page, 0, chunk_size);
 579 fail:
 580         UnlockPage(page);
 581         page_cache_release(page);
 582         ENTRY;
 583         return err;
 584 }
 585
 586 /*
 587  * routine to check that the specified directory is empty (for rmdir)
 588  */
 589 int ext2_empty_dir (struct inode * inode)
 590 {
 591         struct page *page = NULL;
 592         unsigned long i, npages = dir_pages(inode);
 593
 594         for (i = 0; i < npages; i++) {
 595                 char *kaddr;
 596                 ext2_dirent * de;
 597                 page = ext2_get_page(inode, i);
 598
 599                 if (IS_ERR(page))
 600                         continue;
 601
 602                 kaddr = page_address(page);
 603                 de = (ext2_dirent *)kaddr;
 604                 kaddr += PAGE_CACHE_SIZE-EXT2_DIR_REC_LEN(1);
 605
 606                 while ((char *)de <= kaddr) {
 607                         if (de->inode != 0) {
 608                                 /* check for . and .. */
 609                                 if (de->name[0] != '.')
 610                                         goto not_empty;
 611                                 if (de->name_len > 2)
 612                                         goto not_empty;
 613                                 if (de->name_len < 2) {
 614                                         if (de->inode !=
 615                                             cpu_to_le32(inode->i_ino))
 616                                                 goto not_empty;
 617                                 } else if (de->name[1] != '.')
 618                                         goto not_empty;
 619                         }
 620                         de = ext2_next_entry(de);
 621                 }
 622                 ext2_put_page(page);
 623         }
 624         return 1;
 625
 626 not_empty:
 627         ext2_put_page(page);
 628         return 0;
 629 }
 630
 631 struct file_operations ll_dir_operations = {
 632         read: generic_read_dir,
 633         readdir: new_ll_readdir
 634 };