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