lustre/obdfs/dir.c

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