2 * linux/fs/ufs/ufs_dir.c
5 * Adrian Rodriguez (adrian@franklins-tower.rutgers.edu)
6 * Laboratory for Computer Science Research Computing Facility
7 * Rutgers, The State University of New Jersey
9 * swab support by Francois-Rene Rideau <fare@tunes.org> 19970406
11 * 4.4BSD (FreeBSD) support added on February 1st 1998 by
12 * Niels Kristian Bech Jensen <nkbj@image.dk> partially based
13 * on code by Martin von Loewis <martin@mira.isdn.cs.tu-berlin.de>.
15 * Migration to usage of "page cache" on May 2006 by
16 * Evgeniy Dushistov <dushistov@mail.ru> based on ext2 code base.
19 #include <linux/time.h>
21 #include <linux/swap.h>
29 * NOTE! unlike strncmp, ufs_match returns 1 for success, 0 for failure.
31 * len <= UFS_MAXNAMLEN and de != NULL are guaranteed by caller.
33 static inline int ufs_match(struct super_block *sb, int len,
34 const unsigned char *name, struct ufs_dir_entry *de)
36 if (len != ufs_get_de_namlen(sb, de))
40 return !memcmp(name, de->d_name, len);
43 static int ufs_commit_chunk(struct page *page, loff_t pos, unsigned len)
45 struct address_space *mapping = page->mapping;
46 struct inode *dir = mapping->host;
50 block_write_end(NULL, mapping, pos, len, len, page, NULL);
51 if (pos+len > dir->i_size) {
52 i_size_write(dir, pos+len);
53 mark_inode_dirty(dir);
56 err = write_one_page(page, 1);
62 static inline void ufs_put_page(struct page *page)
65 page_cache_release(page);
68 static inline unsigned long ufs_dir_pages(struct inode *inode)
70 return (inode->i_size+PAGE_CACHE_SIZE-1)>>PAGE_CACHE_SHIFT;
73 ino_t ufs_inode_by_name(struct inode *dir, const struct qstr *qstr)
76 struct ufs_dir_entry *de;
79 de = ufs_find_entry(dir, qstr, &page);
81 res = fs32_to_cpu(dir->i_sb, de->d_ino);
88 /* Releases the page */
89 void ufs_set_link(struct inode *dir, struct ufs_dir_entry *de,
90 struct page *page, struct inode *inode)
92 loff_t pos = page_offset(page) +
93 (char *) de - (char *) page_address(page);
94 unsigned len = fs16_to_cpu(dir->i_sb, de->d_reclen);
98 err = ufs_prepare_chunk(page, pos, len);
101 de->d_ino = cpu_to_fs32(dir->i_sb, inode->i_ino);
102 ufs_set_de_type(dir->i_sb, de, inode->i_mode);
104 err = ufs_commit_chunk(page, pos, len);
106 dir->i_mtime = dir->i_ctime = CURRENT_TIME_SEC;
107 mark_inode_dirty(dir);
111 static void ufs_check_page(struct page *page)
113 struct inode *dir = page->mapping->host;
114 struct super_block *sb = dir->i_sb;
115 char *kaddr = page_address(page);
116 unsigned offs, rec_len;
117 unsigned limit = PAGE_CACHE_SIZE;
118 const unsigned chunk_mask = UFS_SB(sb)->s_uspi->s_dirblksize - 1;
119 struct ufs_dir_entry *p;
122 if ((dir->i_size >> PAGE_CACHE_SHIFT) == page->index) {
123 limit = dir->i_size & ~PAGE_CACHE_MASK;
124 if (limit & chunk_mask)
129 for (offs = 0; offs <= limit - UFS_DIR_REC_LEN(1); offs += rec_len) {
130 p = (struct ufs_dir_entry *)(kaddr + offs);
131 rec_len = fs16_to_cpu(sb, p->d_reclen);
133 if (rec_len < UFS_DIR_REC_LEN(1))
137 if (rec_len < UFS_DIR_REC_LEN(ufs_get_de_namlen(sb, p)))
139 if (((offs + rec_len - 1) ^ offs) & ~chunk_mask)
141 if (fs32_to_cpu(sb, p->d_ino) > (UFS_SB(sb)->s_uspi->s_ipg *
142 UFS_SB(sb)->s_uspi->s_ncg))
148 SetPageChecked(page);
151 /* Too bad, we had an error */
154 ufs_error(sb, "ufs_check_page",
155 "size of directory #%lu is not a multiple of chunk size",
160 error = "rec_len is smaller than minimal";
163 error = "unaligned directory entry";
166 error = "rec_len is too small for name_len";
169 error = "directory entry across blocks";
172 error = "inode out of bounds";
174 ufs_error (sb, "ufs_check_page", "bad entry in directory #%lu: %s - "
175 "offset=%lu, rec_len=%d, name_len=%d",
176 dir->i_ino, error, (page->index<<PAGE_CACHE_SHIFT)+offs,
177 rec_len, ufs_get_de_namlen(sb, p));
180 p = (struct ufs_dir_entry *)(kaddr + offs);
181 ufs_error(sb, __func__,
182 "entry in directory #%lu spans the page boundary"
184 dir->i_ino, (page->index<<PAGE_CACHE_SHIFT)+offs);
186 SetPageChecked(page);
190 static struct page *ufs_get_page(struct inode *dir, unsigned long n)
192 struct address_space *mapping = dir->i_mapping;
193 struct page *page = read_mapping_page(mapping, n, NULL);
196 if (!PageChecked(page))
197 ufs_check_page(page);
205 return ERR_PTR(-EIO);
209 * Return the offset into page `page_nr' of the last valid
210 * byte in that page, plus one.
213 ufs_last_byte(struct inode *inode, unsigned long page_nr)
215 unsigned last_byte = inode->i_size;
217 last_byte -= page_nr << PAGE_CACHE_SHIFT;
218 if (last_byte > PAGE_CACHE_SIZE)
219 last_byte = PAGE_CACHE_SIZE;
223 static inline struct ufs_dir_entry *
224 ufs_next_entry(struct super_block *sb, struct ufs_dir_entry *p)
226 return (struct ufs_dir_entry *)((char *)p +
227 fs16_to_cpu(sb, p->d_reclen));
230 struct ufs_dir_entry *ufs_dotdot(struct inode *dir, struct page **p)
232 struct page *page = ufs_get_page(dir, 0);
233 struct ufs_dir_entry *de = NULL;
236 de = ufs_next_entry(dir->i_sb,
237 (struct ufs_dir_entry *)page_address(page));
246 * finds an entry in the specified directory with the wanted name. It
247 * returns the page in which the entry was found, and the entry itself
248 * (as a parameter - res_dir). Page is returned mapped and unlocked.
249 * Entry is guaranteed to be valid.
251 struct ufs_dir_entry *ufs_find_entry(struct inode *dir, const struct qstr *qstr,
252 struct page **res_page)
254 struct super_block *sb = dir->i_sb;
255 const unsigned char *name = qstr->name;
256 int namelen = qstr->len;
257 unsigned reclen = UFS_DIR_REC_LEN(namelen);
258 unsigned long start, n;
259 unsigned long npages = ufs_dir_pages(dir);
260 struct page *page = NULL;
261 struct ufs_inode_info *ui = UFS_I(dir);
262 struct ufs_dir_entry *de;
264 UFSD("ENTER, dir_ino %lu, name %s, namlen %u\n", dir->i_ino, name, namelen);
266 if (npages == 0 || namelen > UFS_MAXNAMLEN)
272 start = ui->i_dir_start_lookup;
279 page = ufs_get_page(dir, n);
281 kaddr = page_address(page);
282 de = (struct ufs_dir_entry *) kaddr;
283 kaddr += ufs_last_byte(dir, n) - reclen;
284 while ((char *) de <= kaddr) {
285 if (de->d_reclen == 0) {
286 ufs_error(dir->i_sb, __func__,
287 "zero-length directory entry");
291 if (ufs_match(sb, namelen, name, de))
293 de = ufs_next_entry(sb, de);
299 } while (n != start);
305 ui->i_dir_start_lookup = n;
312 int ufs_add_link(struct dentry *dentry, struct inode *inode)
314 struct inode *dir = dentry->d_parent->d_inode;
315 const unsigned char *name = dentry->d_name.name;
316 int namelen = dentry->d_name.len;
317 struct super_block *sb = dir->i_sb;
318 unsigned reclen = UFS_DIR_REC_LEN(namelen);
319 const unsigned int chunk_size = UFS_SB(sb)->s_uspi->s_dirblksize;
320 unsigned short rec_len, name_len;
321 struct page *page = NULL;
322 struct ufs_dir_entry *de;
323 unsigned long npages = ufs_dir_pages(dir);
329 UFSD("ENTER, name %s, namelen %u\n", name, namelen);
332 * We take care of directory expansion in the same loop.
333 * This code plays outside i_size, so it locks the page
334 * to protect that region.
336 for (n = 0; n <= npages; n++) {
339 page = ufs_get_page(dir, n);
344 kaddr = page_address(page);
345 dir_end = kaddr + ufs_last_byte(dir, n);
346 de = (struct ufs_dir_entry *)kaddr;
347 kaddr += PAGE_CACHE_SIZE - reclen;
348 while ((char *)de <= kaddr) {
349 if ((char *)de == dir_end) {
352 rec_len = chunk_size;
353 de->d_reclen = cpu_to_fs16(sb, chunk_size);
357 if (de->d_reclen == 0) {
358 ufs_error(dir->i_sb, __func__,
359 "zero-length directory entry");
364 if (ufs_match(sb, namelen, name, de))
366 name_len = UFS_DIR_REC_LEN(ufs_get_de_namlen(sb, de));
367 rec_len = fs16_to_cpu(sb, de->d_reclen);
368 if (!de->d_ino && rec_len >= reclen)
370 if (rec_len >= name_len + reclen)
372 de = (struct ufs_dir_entry *) ((char *) de + rec_len);
381 pos = page_offset(page) +
382 (char*)de - (char*)page_address(page);
383 err = ufs_prepare_chunk(page, pos, rec_len);
387 struct ufs_dir_entry *de1 =
388 (struct ufs_dir_entry *) ((char *) de + name_len);
389 de1->d_reclen = cpu_to_fs16(sb, rec_len - name_len);
390 de->d_reclen = cpu_to_fs16(sb, name_len);
395 ufs_set_de_namlen(sb, de, namelen);
396 memcpy(de->d_name, name, namelen + 1);
397 de->d_ino = cpu_to_fs32(sb, inode->i_ino);
398 ufs_set_de_type(sb, de, inode->i_mode);
400 err = ufs_commit_chunk(page, pos, rec_len);
401 dir->i_mtime = dir->i_ctime = CURRENT_TIME_SEC;
403 mark_inode_dirty(dir);
414 static inline unsigned
415 ufs_validate_entry(struct super_block *sb, char *base,
416 unsigned offset, unsigned mask)
418 struct ufs_dir_entry *de = (struct ufs_dir_entry*)(base + offset);
419 struct ufs_dir_entry *p = (struct ufs_dir_entry*)(base + (offset&mask));
420 while ((char*)p < (char*)de) {
421 if (p->d_reclen == 0)
423 p = ufs_next_entry(sb, p);
425 return (char *)p - base;
430 * This is blatantly stolen from ext2fs
433 ufs_readdir(struct file *file, struct dir_context *ctx)
435 loff_t pos = ctx->pos;
436 struct inode *inode = file_inode(file);
437 struct super_block *sb = inode->i_sb;
438 unsigned int offset = pos & ~PAGE_CACHE_MASK;
439 unsigned long n = pos >> PAGE_CACHE_SHIFT;
440 unsigned long npages = ufs_dir_pages(inode);
441 unsigned chunk_mask = ~(UFS_SB(sb)->s_uspi->s_dirblksize - 1);
442 int need_revalidate = file->f_version != inode->i_version;
443 unsigned flags = UFS_SB(sb)->s_flags;
447 if (pos > inode->i_size - UFS_DIR_REC_LEN(1))
450 for ( ; n < npages; n++, offset = 0) {
452 struct ufs_dir_entry *de;
454 struct page *page = ufs_get_page(inode, n);
457 ufs_error(sb, __func__,
460 ctx->pos += PAGE_CACHE_SIZE - offset;
463 kaddr = page_address(page);
464 if (unlikely(need_revalidate)) {
466 offset = ufs_validate_entry(sb, kaddr, offset, chunk_mask);
467 ctx->pos = (n<<PAGE_CACHE_SHIFT) + offset;
469 file->f_version = inode->i_version;
472 de = (struct ufs_dir_entry *)(kaddr+offset);
473 limit = kaddr + ufs_last_byte(inode, n) - UFS_DIR_REC_LEN(1);
474 for ( ;(char*)de <= limit; de = ufs_next_entry(sb, de)) {
475 if (de->d_reclen == 0) {
476 ufs_error(sb, __func__,
477 "zero-length directory entry");
482 unsigned char d_type = DT_UNKNOWN;
484 UFSD("filldir(%s,%u)\n", de->d_name,
485 fs32_to_cpu(sb, de->d_ino));
486 UFSD("namlen %u\n", ufs_get_de_namlen(sb, de));
488 if ((flags & UFS_DE_MASK) == UFS_DE_44BSD)
489 d_type = de->d_u.d_44.d_type;
491 if (!dir_emit(ctx, de->d_name,
492 ufs_get_de_namlen(sb, de),
493 fs32_to_cpu(sb, de->d_ino),
499 ctx->pos += fs16_to_cpu(sb, de->d_reclen);
508 * ufs_delete_entry deletes a directory entry by merging it with the
511 int ufs_delete_entry(struct inode *inode, struct ufs_dir_entry *dir,
514 struct super_block *sb = inode->i_sb;
515 char *kaddr = page_address(page);
516 unsigned from = ((char*)dir - kaddr) & ~(UFS_SB(sb)->s_uspi->s_dirblksize - 1);
517 unsigned to = ((char*)dir - kaddr) + fs16_to_cpu(sb, dir->d_reclen);
519 struct ufs_dir_entry *pde = NULL;
520 struct ufs_dir_entry *de = (struct ufs_dir_entry *) (kaddr + from);
525 UFSD("ino %u, reclen %u, namlen %u, name %s\n",
526 fs32_to_cpu(sb, de->d_ino),
527 fs16_to_cpu(sb, de->d_reclen),
528 ufs_get_de_namlen(sb, de), de->d_name);
530 while ((char*)de < (char*)dir) {
531 if (de->d_reclen == 0) {
532 ufs_error(inode->i_sb, __func__,
533 "zero-length directory entry");
538 de = ufs_next_entry(sb, de);
541 from = (char*)pde - (char*)page_address(page);
543 pos = page_offset(page) + from;
545 err = ufs_prepare_chunk(page, pos, to - from);
548 pde->d_reclen = cpu_to_fs16(sb, to - from);
550 err = ufs_commit_chunk(page, pos, to - from);
551 inode->i_ctime = inode->i_mtime = CURRENT_TIME_SEC;
552 mark_inode_dirty(inode);
559 int ufs_make_empty(struct inode * inode, struct inode *dir)
561 struct super_block * sb = dir->i_sb;
562 struct address_space *mapping = inode->i_mapping;
563 struct page *page = grab_cache_page(mapping, 0);
564 const unsigned int chunk_size = UFS_SB(sb)->s_uspi->s_dirblksize;
565 struct ufs_dir_entry * de;
572 err = ufs_prepare_chunk(page, 0, chunk_size);
579 base = (char*)page_address(page);
580 memset(base, 0, PAGE_CACHE_SIZE);
582 de = (struct ufs_dir_entry *) base;
584 de->d_ino = cpu_to_fs32(sb, inode->i_ino);
585 ufs_set_de_type(sb, de, inode->i_mode);
586 ufs_set_de_namlen(sb, de, 1);
587 de->d_reclen = cpu_to_fs16(sb, UFS_DIR_REC_LEN(1));
588 strcpy (de->d_name, ".");
589 de = (struct ufs_dir_entry *)
590 ((char *)de + fs16_to_cpu(sb, de->d_reclen));
591 de->d_ino = cpu_to_fs32(sb, dir->i_ino);
592 ufs_set_de_type(sb, de, dir->i_mode);
593 de->d_reclen = cpu_to_fs16(sb, chunk_size - UFS_DIR_REC_LEN(1));
594 ufs_set_de_namlen(sb, de, 2);
595 strcpy (de->d_name, "..");
598 err = ufs_commit_chunk(page, 0, chunk_size);
600 page_cache_release(page);
605 * routine to check that the specified directory is empty (for rmdir)
607 int ufs_empty_dir(struct inode * inode)
609 struct super_block *sb = inode->i_sb;
610 struct page *page = NULL;
611 unsigned long i, npages = ufs_dir_pages(inode);
613 for (i = 0; i < npages; i++) {
615 struct ufs_dir_entry *de;
616 page = ufs_get_page(inode, i);
621 kaddr = page_address(page);
622 de = (struct ufs_dir_entry *)kaddr;
623 kaddr += ufs_last_byte(inode, i) - UFS_DIR_REC_LEN(1);
625 while ((char *)de <= kaddr) {
626 if (de->d_reclen == 0) {
627 ufs_error(inode->i_sb, __func__,
628 "zero-length directory entry: "
629 "kaddr=%p, de=%p\n", kaddr, de);
633 u16 namelen=ufs_get_de_namlen(sb, de);
634 /* check for . and .. */
635 if (de->d_name[0] != '.')
641 fs32_to_cpu(sb, de->d_ino))
643 } else if (de->d_name[1] != '.')
646 de = ufs_next_entry(sb, de);
657 const struct file_operations ufs_dir_operations = {
658 .read = generic_read_dir,
659 .iterate = ufs_readdir,
660 .fsync = generic_file_fsync,
661 .llseek = generic_file_llseek,