1 // SPDX-License-Identifier: GPL-2.0
3 * linux/fs/ufs/ufs_dir.c
7 * Laboratory for Computer Science Research Computing Facility
8 * Rutgers, The State University of New Jersey
12 * 4.4BSD (FreeBSD) support added on February 1st 1998 by
16 * Migration to usage of "page cache" on May 2006 by
20 #include <linux/time.h>
22 #include <linux/swap.h>
23 #include <linux/iversion.h>
31 * NOTE! unlike strncmp, ufs_match returns 1 for success, 0 for failure.
33 * len <= UFS_MAXNAMLEN and de != NULL are guaranteed by caller.
35 static inline int ufs_match(struct super_block *sb, int len,
36 const unsigned char *name, struct ufs_dir_entry *de)
38 if (len != ufs_get_de_namlen(sb, de))
42 return !memcmp(name, de->d_name, len);
45 static void ufs_commit_chunk(struct page *page, loff_t pos, unsigned len)
47 struct address_space *mapping = page->mapping;
48 struct inode *dir = mapping->host;
50 inode_inc_iversion(dir);
51 block_write_end(NULL, mapping, pos, len, len, page, NULL);
52 if (pos+len > dir->i_size) {
53 i_size_write(dir, pos+len);
54 mark_inode_dirty(dir);
59 static int ufs_handle_dirsync(struct inode *dir)
63 err = filemap_write_and_wait(dir->i_mapping);
65 err = sync_inode_metadata(dir, 1);
69 static inline void ufs_put_page(struct page *page)
75 ino_t ufs_inode_by_name(struct inode *dir, const struct qstr *qstr)
78 struct ufs_dir_entry *de;
81 de = ufs_find_entry(dir, qstr, &page);
83 res = fs32_to_cpu(dir->i_sb, de->d_ino);
90 /* Releases the page */
91 void ufs_set_link(struct inode *dir, struct ufs_dir_entry *de,
92 struct page *page, struct inode *inode,
95 loff_t pos = page_offset(page) +
96 (char *) de - (char *) page_address(page);
97 unsigned len = fs16_to_cpu(dir->i_sb, de->d_reclen);
101 err = ufs_prepare_chunk(page, pos, len);
104 de->d_ino = cpu_to_fs32(dir->i_sb, inode->i_ino);
105 ufs_set_de_type(dir->i_sb, de, inode->i_mode);
107 ufs_commit_chunk(page, pos, len);
110 inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
111 mark_inode_dirty(dir);
112 ufs_handle_dirsync(dir);
116 static bool ufs_check_page(struct page *page)
118 struct inode *dir = page->mapping->host;
119 struct super_block *sb = dir->i_sb;
120 char *kaddr = page_address(page);
121 unsigned offs, rec_len;
122 unsigned limit = PAGE_SIZE;
123 const unsigned chunk_mask = UFS_SB(sb)->s_uspi->s_dirblksize - 1;
124 struct ufs_dir_entry *p;
127 if ((dir->i_size >> PAGE_SHIFT) == page->index) {
128 limit = dir->i_size & ~PAGE_MASK;
129 if (limit & chunk_mask)
134 for (offs = 0; offs <= limit - UFS_DIR_REC_LEN(1); offs += rec_len) {
135 p = (struct ufs_dir_entry *)(kaddr + offs);
136 rec_len = fs16_to_cpu(sb, p->d_reclen);
138 if (rec_len < UFS_DIR_REC_LEN(1))
142 if (rec_len < UFS_DIR_REC_LEN(ufs_get_de_namlen(sb, p)))
144 if (((offs + rec_len - 1) ^ offs) & ~chunk_mask)
146 if (fs32_to_cpu(sb, p->d_ino) > (UFS_SB(sb)->s_uspi->s_ipg *
147 UFS_SB(sb)->s_uspi->s_ncg))
153 SetPageChecked(page);
156 /* Too bad, we had an error */
159 ufs_error(sb, "ufs_check_page",
160 "size of directory #%lu is not a multiple of chunk size",
165 error = "rec_len is smaller than minimal";
168 error = "unaligned directory entry";
171 error = "rec_len is too small for name_len";
174 error = "directory entry across blocks";
177 error = "inode out of bounds";
179 ufs_error (sb, "ufs_check_page", "bad entry in directory #%lu: %s - "
180 "offset=%lu, rec_len=%d, name_len=%d",
181 dir->i_ino, error, (page->index<<PAGE_SHIFT)+offs,
182 rec_len, ufs_get_de_namlen(sb, p));
185 p = (struct ufs_dir_entry *)(kaddr + offs);
186 ufs_error(sb, __func__,
187 "entry in directory #%lu spans the page boundary"
189 dir->i_ino, (page->index<<PAGE_SHIFT)+offs);
194 static struct page *ufs_get_page(struct inode *dir, unsigned long n)
196 struct address_space *mapping = dir->i_mapping;
197 struct page *page = read_mapping_page(mapping, n, NULL);
200 if (unlikely(!PageChecked(page))) {
201 if (!ufs_check_page(page))
209 return ERR_PTR(-EIO);
213 * Return the offset into page `page_nr' of the last valid
214 * byte in that page, plus one.
217 ufs_last_byte(struct inode *inode, unsigned long page_nr)
219 unsigned last_byte = inode->i_size;
221 last_byte -= page_nr << PAGE_SHIFT;
222 if (last_byte > PAGE_SIZE)
223 last_byte = PAGE_SIZE;
227 static inline struct ufs_dir_entry *
228 ufs_next_entry(struct super_block *sb, struct ufs_dir_entry *p)
230 return (struct ufs_dir_entry *)((char *)p +
231 fs16_to_cpu(sb, p->d_reclen));
234 struct ufs_dir_entry *ufs_dotdot(struct inode *dir, struct page **p)
236 struct page *page = ufs_get_page(dir, 0);
237 struct ufs_dir_entry *de = NULL;
240 de = ufs_next_entry(dir->i_sb,
241 (struct ufs_dir_entry *)page_address(page));
250 * finds an entry in the specified directory with the wanted name. It
251 * returns the page in which the entry was found, and the entry itself
252 * (as a parameter - res_dir). Page is returned mapped and unlocked.
253 * Entry is guaranteed to be valid.
255 struct ufs_dir_entry *ufs_find_entry(struct inode *dir, const struct qstr *qstr,
256 struct page **res_page)
258 struct super_block *sb = dir->i_sb;
259 const unsigned char *name = qstr->name;
260 int namelen = qstr->len;
261 unsigned reclen = UFS_DIR_REC_LEN(namelen);
262 unsigned long start, n;
263 unsigned long npages = dir_pages(dir);
264 struct page *page = NULL;
265 struct ufs_inode_info *ui = UFS_I(dir);
266 struct ufs_dir_entry *de;
268 UFSD("ENTER, dir_ino %lu, name %s, namlen %u\n", dir->i_ino, name, namelen);
270 if (npages == 0 || namelen > UFS_MAXNAMLEN)
276 start = ui->i_dir_start_lookup;
283 page = ufs_get_page(dir, n);
285 kaddr = page_address(page);
286 de = (struct ufs_dir_entry *) kaddr;
287 kaddr += ufs_last_byte(dir, n) - reclen;
288 while ((char *) de <= kaddr) {
289 if (ufs_match(sb, namelen, name, de))
291 de = ufs_next_entry(sb, de);
297 } while (n != start);
303 ui->i_dir_start_lookup = n;
310 int ufs_add_link(struct dentry *dentry, struct inode *inode)
312 struct inode *dir = d_inode(dentry->d_parent);
313 const unsigned char *name = dentry->d_name.name;
314 int namelen = dentry->d_name.len;
315 struct super_block *sb = dir->i_sb;
316 unsigned reclen = UFS_DIR_REC_LEN(namelen);
317 const unsigned int chunk_size = UFS_SB(sb)->s_uspi->s_dirblksize;
318 unsigned short rec_len, name_len;
319 struct page *page = NULL;
320 struct ufs_dir_entry *de;
321 unsigned long npages = dir_pages(dir);
327 UFSD("ENTER, name %s, namelen %u\n", name, namelen);
330 * We take care of directory expansion in the same loop.
331 * This code plays outside i_size, so it locks the page
332 * to protect that region.
334 for (n = 0; n <= npages; n++) {
337 page = ufs_get_page(dir, n);
342 kaddr = page_address(page);
343 dir_end = kaddr + ufs_last_byte(dir, n);
344 de = (struct ufs_dir_entry *)kaddr;
345 kaddr += PAGE_SIZE - reclen;
346 while ((char *)de <= kaddr) {
347 if ((char *)de == dir_end) {
350 rec_len = chunk_size;
351 de->d_reclen = cpu_to_fs16(sb, chunk_size);
355 if (de->d_reclen == 0) {
356 ufs_error(dir->i_sb, __func__,
357 "zero-length directory entry");
362 if (ufs_match(sb, namelen, name, de))
364 name_len = UFS_DIR_REC_LEN(ufs_get_de_namlen(sb, de));
365 rec_len = fs16_to_cpu(sb, de->d_reclen);
366 if (!de->d_ino && rec_len >= reclen)
368 if (rec_len >= name_len + reclen)
370 de = (struct ufs_dir_entry *) ((char *) de + rec_len);
379 pos = page_offset(page) +
380 (char*)de - (char*)page_address(page);
381 err = ufs_prepare_chunk(page, pos, rec_len);
385 struct ufs_dir_entry *de1 =
386 (struct ufs_dir_entry *) ((char *) de + name_len);
387 de1->d_reclen = cpu_to_fs16(sb, rec_len - name_len);
388 de->d_reclen = cpu_to_fs16(sb, name_len);
393 ufs_set_de_namlen(sb, de, namelen);
394 memcpy(de->d_name, name, namelen + 1);
395 de->d_ino = cpu_to_fs32(sb, inode->i_ino);
396 ufs_set_de_type(sb, de, inode->i_mode);
398 ufs_commit_chunk(page, pos, rec_len);
399 inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
401 mark_inode_dirty(dir);
402 err = ufs_handle_dirsync(dir);
413 static inline unsigned
414 ufs_validate_entry(struct super_block *sb, char *base,
415 unsigned offset, unsigned mask)
417 struct ufs_dir_entry *de = (struct ufs_dir_entry*)(base + offset);
418 struct ufs_dir_entry *p = (struct ufs_dir_entry*)(base + (offset&mask));
419 while ((char*)p < (char*)de)
420 p = ufs_next_entry(sb, p);
421 return (char *)p - base;
426 * This is blatantly stolen from ext2fs
429 ufs_readdir(struct file *file, struct dir_context *ctx)
431 loff_t pos = ctx->pos;
432 struct inode *inode = file_inode(file);
433 struct super_block *sb = inode->i_sb;
434 unsigned int offset = pos & ~PAGE_MASK;
435 unsigned long n = pos >> PAGE_SHIFT;
436 unsigned long npages = dir_pages(inode);
437 unsigned chunk_mask = ~(UFS_SB(sb)->s_uspi->s_dirblksize - 1);
438 bool need_revalidate = !inode_eq_iversion(inode, file->f_version);
439 unsigned flags = UFS_SB(sb)->s_flags;
443 if (pos > inode->i_size - UFS_DIR_REC_LEN(1))
446 for ( ; n < npages; n++, offset = 0) {
448 struct ufs_dir_entry *de;
450 struct page *page = ufs_get_page(inode, n);
453 ufs_error(sb, __func__,
456 ctx->pos += PAGE_SIZE - offset;
459 kaddr = page_address(page);
460 if (unlikely(need_revalidate)) {
462 offset = ufs_validate_entry(sb, kaddr, offset, chunk_mask);
463 ctx->pos = (n<<PAGE_SHIFT) + offset;
465 file->f_version = inode_query_iversion(inode);
466 need_revalidate = false;
468 de = (struct ufs_dir_entry *)(kaddr+offset);
469 limit = kaddr + ufs_last_byte(inode, n) - UFS_DIR_REC_LEN(1);
470 for ( ;(char*)de <= limit; de = ufs_next_entry(sb, de)) {
472 unsigned char d_type = DT_UNKNOWN;
474 UFSD("filldir(%s,%u)\n", de->d_name,
475 fs32_to_cpu(sb, de->d_ino));
476 UFSD("namlen %u\n", ufs_get_de_namlen(sb, de));
478 if ((flags & UFS_DE_MASK) == UFS_DE_44BSD)
479 d_type = de->d_u.d_44.d_type;
481 if (!dir_emit(ctx, de->d_name,
482 ufs_get_de_namlen(sb, de),
483 fs32_to_cpu(sb, de->d_ino),
489 ctx->pos += fs16_to_cpu(sb, de->d_reclen);
498 * ufs_delete_entry deletes a directory entry by merging it with the
501 int ufs_delete_entry(struct inode *inode, struct ufs_dir_entry *dir,
504 struct super_block *sb = inode->i_sb;
505 char *kaddr = page_address(page);
506 unsigned from = ((char*)dir - kaddr) & ~(UFS_SB(sb)->s_uspi->s_dirblksize - 1);
507 unsigned to = ((char*)dir - kaddr) + fs16_to_cpu(sb, dir->d_reclen);
509 struct ufs_dir_entry *pde = NULL;
510 struct ufs_dir_entry *de = (struct ufs_dir_entry *) (kaddr + from);
515 UFSD("ino %u, reclen %u, namlen %u, name %s\n",
516 fs32_to_cpu(sb, de->d_ino),
517 fs16_to_cpu(sb, de->d_reclen),
518 ufs_get_de_namlen(sb, de), de->d_name);
520 while ((char*)de < (char*)dir) {
521 if (de->d_reclen == 0) {
522 ufs_error(inode->i_sb, __func__,
523 "zero-length directory entry");
528 de = ufs_next_entry(sb, de);
531 from = (char*)pde - (char*)page_address(page);
533 pos = page_offset(page) + from;
535 err = ufs_prepare_chunk(page, pos, to - from);
538 pde->d_reclen = cpu_to_fs16(sb, to - from);
540 ufs_commit_chunk(page, pos, to - from);
541 inode_set_mtime_to_ts(inode, inode_set_ctime_current(inode));
542 mark_inode_dirty(inode);
543 err = ufs_handle_dirsync(inode);
550 int ufs_make_empty(struct inode * inode, struct inode *dir)
552 struct super_block * sb = dir->i_sb;
553 struct address_space *mapping = inode->i_mapping;
554 struct page *page = grab_cache_page(mapping, 0);
555 const unsigned int chunk_size = UFS_SB(sb)->s_uspi->s_dirblksize;
556 struct ufs_dir_entry * de;
563 err = ufs_prepare_chunk(page, 0, chunk_size);
570 base = (char*)page_address(page);
571 memset(base, 0, PAGE_SIZE);
573 de = (struct ufs_dir_entry *) base;
575 de->d_ino = cpu_to_fs32(sb, inode->i_ino);
576 ufs_set_de_type(sb, de, inode->i_mode);
577 ufs_set_de_namlen(sb, de, 1);
578 de->d_reclen = cpu_to_fs16(sb, UFS_DIR_REC_LEN(1));
579 strcpy (de->d_name, ".");
580 de = (struct ufs_dir_entry *)
581 ((char *)de + fs16_to_cpu(sb, de->d_reclen));
582 de->d_ino = cpu_to_fs32(sb, dir->i_ino);
583 ufs_set_de_type(sb, de, dir->i_mode);
584 de->d_reclen = cpu_to_fs16(sb, chunk_size - UFS_DIR_REC_LEN(1));
585 ufs_set_de_namlen(sb, de, 2);
586 strcpy (de->d_name, "..");
589 ufs_commit_chunk(page, 0, chunk_size);
590 err = ufs_handle_dirsync(inode);
597 * routine to check that the specified directory is empty (for rmdir)
599 int ufs_empty_dir(struct inode * inode)
601 struct super_block *sb = inode->i_sb;
602 struct page *page = NULL;
603 unsigned long i, npages = dir_pages(inode);
605 for (i = 0; i < npages; i++) {
607 struct ufs_dir_entry *de;
608 page = ufs_get_page(inode, i);
613 kaddr = page_address(page);
614 de = (struct ufs_dir_entry *)kaddr;
615 kaddr += ufs_last_byte(inode, i) - UFS_DIR_REC_LEN(1);
617 while ((char *)de <= kaddr) {
618 if (de->d_reclen == 0) {
619 ufs_error(inode->i_sb, __func__,
620 "zero-length directory entry: "
621 "kaddr=%p, de=%p\n", kaddr, de);
625 u16 namelen=ufs_get_de_namlen(sb, de);
626 /* check for . and .. */
627 if (de->d_name[0] != '.')
633 fs32_to_cpu(sb, de->d_ino))
635 } else if (de->d_name[1] != '.')
638 de = ufs_next_entry(sb, de);
649 const struct file_operations ufs_dir_operations = {
650 .read = generic_read_dir,
651 .iterate_shared = ufs_readdir,
652 .fsync = generic_file_fsync,
653 .llseek = generic_file_llseek,