1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
8 #include "xfs_shared.h"
9 #include "xfs_format.h"
10 #include "xfs_log_format.h"
11 #include "xfs_trans_resv.h"
12 #include "xfs_mount.h"
13 #include "xfs_inode.h"
14 #include "xfs_trans.h"
17 #include "xfs_dir2_priv.h"
18 #include "xfs_errortag.h"
19 #include "xfs_error.h"
20 #include "xfs_trace.h"
22 struct xfs_name xfs_name_dotdot = { (unsigned char *)"..", 2, XFS_DIR3_FT_DIR };
25 * Convert inode mode to directory entry filetype
31 switch (mode & S_IFMT) {
33 return XFS_DIR3_FT_REG_FILE;
35 return XFS_DIR3_FT_DIR;
37 return XFS_DIR3_FT_CHRDEV;
39 return XFS_DIR3_FT_BLKDEV;
41 return XFS_DIR3_FT_FIFO;
43 return XFS_DIR3_FT_SOCK;
45 return XFS_DIR3_FT_SYMLINK;
47 return XFS_DIR3_FT_UNKNOWN;
52 * ASCII case-insensitive (ie. A-Z) support for directories that was
56 xfs_ascii_ci_hashname(
57 struct xfs_name *name)
62 for (i = 0, hash = 0; i < name->len; i++)
63 hash = tolower(name->name[i]) ^ rol32(hash, 7);
69 xfs_ascii_ci_compname(
70 struct xfs_da_args *args,
71 const unsigned char *name,
74 enum xfs_dacmp result;
77 if (args->namelen != len)
78 return XFS_CMP_DIFFERENT;
80 result = XFS_CMP_EXACT;
81 for (i = 0; i < len; i++) {
82 if (args->name[i] == name[i])
84 if (tolower(args->name[i]) != tolower(name[i]))
85 return XFS_CMP_DIFFERENT;
86 result = XFS_CMP_CASE;
92 static const struct xfs_nameops xfs_ascii_ci_nameops = {
93 .hashname = xfs_ascii_ci_hashname,
94 .compname = xfs_ascii_ci_compname,
101 struct xfs_da_geometry *dageo;
105 ASSERT(mp->m_sb.sb_versionnum & XFS_SB_VERSION_DIRV2BIT);
106 ASSERT(xfs_dir2_dirblock_bytes(&mp->m_sb) <= XFS_MAX_BLOCKSIZE);
108 mp->m_dir_inode_ops = xfs_dir_get_ops(mp, NULL);
109 mp->m_nondir_inode_ops = xfs_nondir_get_ops(mp, NULL);
111 nodehdr_size = mp->m_dir_inode_ops->node_hdr_size;
112 mp->m_dir_geo = kmem_zalloc(sizeof(struct xfs_da_geometry),
113 KM_SLEEP | KM_MAYFAIL);
114 mp->m_attr_geo = kmem_zalloc(sizeof(struct xfs_da_geometry),
115 KM_SLEEP | KM_MAYFAIL);
116 if (!mp->m_dir_geo || !mp->m_attr_geo) {
117 kmem_free(mp->m_dir_geo);
118 kmem_free(mp->m_attr_geo);
122 /* set up directory geometry */
123 dageo = mp->m_dir_geo;
124 dageo->blklog = mp->m_sb.sb_blocklog + mp->m_sb.sb_dirblklog;
125 dageo->fsblog = mp->m_sb.sb_blocklog;
126 dageo->blksize = xfs_dir2_dirblock_bytes(&mp->m_sb);
127 dageo->fsbcount = 1 << mp->m_sb.sb_dirblklog;
130 * Now we've set up the block conversion variables, we can calculate the
131 * segment block constants using the geometry structure.
133 dageo->datablk = xfs_dir2_byte_to_da(dageo, XFS_DIR2_DATA_OFFSET);
134 dageo->leafblk = xfs_dir2_byte_to_da(dageo, XFS_DIR2_LEAF_OFFSET);
135 dageo->freeblk = xfs_dir2_byte_to_da(dageo, XFS_DIR2_FREE_OFFSET);
136 dageo->node_ents = (dageo->blksize - nodehdr_size) /
137 (uint)sizeof(xfs_da_node_entry_t);
138 dageo->magicpct = (dageo->blksize * 37) / 100;
140 /* set up attribute geometry - single fsb only */
141 dageo = mp->m_attr_geo;
142 dageo->blklog = mp->m_sb.sb_blocklog;
143 dageo->fsblog = mp->m_sb.sb_blocklog;
144 dageo->blksize = 1 << dageo->blklog;
146 dageo->node_ents = (dageo->blksize - nodehdr_size) /
147 (uint)sizeof(xfs_da_node_entry_t);
148 dageo->magicpct = (dageo->blksize * 37) / 100;
150 if (xfs_sb_version_hasasciici(&mp->m_sb))
151 mp->m_dirnameops = &xfs_ascii_ci_nameops;
153 mp->m_dirnameops = &xfs_default_nameops;
160 struct xfs_mount *mp)
162 kmem_free(mp->m_dir_geo);
163 kmem_free(mp->m_attr_geo);
167 * Return 1 if directory contains only "." and "..".
173 xfs_dir2_sf_hdr_t *sfp;
175 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
176 if (dp->i_d.di_size == 0) /* might happen during shutdown. */
178 if (dp->i_d.di_size > XFS_IFORK_DSIZE(dp))
180 sfp = (xfs_dir2_sf_hdr_t *)dp->i_df.if_u1.if_data;
185 * Validate a given inode number.
188 xfs_dir_ino_validate(
192 bool ino_ok = xfs_verify_dir_ino(mp, ino);
194 if (unlikely(XFS_TEST_ERROR(!ino_ok, mp, XFS_ERRTAG_DIR_INO_VALIDATE))) {
195 xfs_warn(mp, "Invalid inode number 0x%Lx",
196 (unsigned long long) ino);
197 XFS_ERROR_REPORT("xfs_dir_ino_validate", XFS_ERRLEVEL_LOW, mp);
198 return -EFSCORRUPTED;
204 * Initialize a directory with its "." and ".." entries.
212 struct xfs_da_args *args;
215 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
216 error = xfs_dir_ino_validate(tp->t_mountp, pdp->i_ino);
220 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
224 args->geo = dp->i_mount->m_dir_geo;
227 error = xfs_dir2_sf_create(args, pdp->i_ino);
233 * Enter a name in a directory, or check for available space.
234 * If inum is 0, only the available space test is performed.
238 struct xfs_trans *tp,
239 struct xfs_inode *dp,
240 struct xfs_name *name,
241 xfs_ino_t inum, /* new entry inode number */
242 xfs_extlen_t total) /* bmap's total block count */
244 struct xfs_da_args *args;
246 int v; /* type-checking value */
248 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
251 rval = xfs_dir_ino_validate(tp->t_mountp, inum);
254 XFS_STATS_INC(dp->i_mount, xs_dir_create);
257 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
261 args->geo = dp->i_mount->m_dir_geo;
262 args->name = name->name;
263 args->namelen = name->len;
264 args->filetype = name->type;
265 args->hashval = dp->i_mount->m_dirnameops->hashname(name);
266 args->inumber = inum;
269 args->whichfork = XFS_DATA_FORK;
271 args->op_flags = XFS_DA_OP_ADDNAME | XFS_DA_OP_OKNOENT;
273 args->op_flags |= XFS_DA_OP_JUSTCHECK;
275 if (dp->i_d.di_format == XFS_DINODE_FMT_LOCAL) {
276 rval = xfs_dir2_sf_addname(args);
280 rval = xfs_dir2_isblock(args, &v);
284 rval = xfs_dir2_block_addname(args);
288 rval = xfs_dir2_isleaf(args, &v);
292 rval = xfs_dir2_leaf_addname(args);
294 rval = xfs_dir2_node_addname(args);
302 * If doing a CI lookup and case-insensitive match, dup actual name into
303 * args.value. Return EEXIST for success (ie. name found) or an error.
306 xfs_dir_cilookup_result(
307 struct xfs_da_args *args,
308 const unsigned char *name,
311 if (args->cmpresult == XFS_CMP_DIFFERENT)
313 if (args->cmpresult != XFS_CMP_CASE ||
314 !(args->op_flags & XFS_DA_OP_CILOOKUP))
317 args->value = kmem_alloc(len, KM_NOFS | KM_MAYFAIL);
321 memcpy(args->value, name, len);
322 args->valuelen = len;
327 * Lookup a name in a directory, give back the inode number.
328 * If ci_name is not NULL, returns the actual name in ci_name if it differs
329 * to name, or ci_name->name is set to NULL for an exact match.
336 struct xfs_name *name,
337 xfs_ino_t *inum, /* out: inode number */
338 struct xfs_name *ci_name) /* out: actual name if CI match */
340 struct xfs_da_args *args;
342 int v; /* type-checking value */
345 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
346 XFS_STATS_INC(dp->i_mount, xs_dir_lookup);
349 * We need to use KM_NOFS here so that lockdep will not throw false
350 * positive deadlock warnings on a non-transactional lookup path. It is
351 * safe to recurse into inode recalim in that case, but lockdep can't
352 * easily be taught about it. Hence KM_NOFS avoids having to add more
353 * lockdep Doing this avoids having to add a bunch of lockdep class
354 * annotations into the reclaim path for the ilock.
356 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
357 args->geo = dp->i_mount->m_dir_geo;
358 args->name = name->name;
359 args->namelen = name->len;
360 args->filetype = name->type;
361 args->hashval = dp->i_mount->m_dirnameops->hashname(name);
363 args->whichfork = XFS_DATA_FORK;
365 args->op_flags = XFS_DA_OP_OKNOENT;
367 args->op_flags |= XFS_DA_OP_CILOOKUP;
369 lock_mode = xfs_ilock_data_map_shared(dp);
370 if (dp->i_d.di_format == XFS_DINODE_FMT_LOCAL) {
371 rval = xfs_dir2_sf_lookup(args);
375 rval = xfs_dir2_isblock(args, &v);
379 rval = xfs_dir2_block_lookup(args);
383 rval = xfs_dir2_isleaf(args, &v);
387 rval = xfs_dir2_leaf_lookup(args);
389 rval = xfs_dir2_node_lookup(args);
395 *inum = args->inumber;
397 ci_name->name = args->value;
398 ci_name->len = args->valuelen;
402 xfs_iunlock(dp, lock_mode);
408 * Remove an entry from a directory.
412 struct xfs_trans *tp,
413 struct xfs_inode *dp,
414 struct xfs_name *name,
416 xfs_extlen_t total) /* bmap's total block count */
418 struct xfs_da_args *args;
420 int v; /* type-checking value */
422 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
423 XFS_STATS_INC(dp->i_mount, xs_dir_remove);
425 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
429 args->geo = dp->i_mount->m_dir_geo;
430 args->name = name->name;
431 args->namelen = name->len;
432 args->filetype = name->type;
433 args->hashval = dp->i_mount->m_dirnameops->hashname(name);
437 args->whichfork = XFS_DATA_FORK;
440 if (dp->i_d.di_format == XFS_DINODE_FMT_LOCAL) {
441 rval = xfs_dir2_sf_removename(args);
445 rval = xfs_dir2_isblock(args, &v);
449 rval = xfs_dir2_block_removename(args);
453 rval = xfs_dir2_isleaf(args, &v);
457 rval = xfs_dir2_leaf_removename(args);
459 rval = xfs_dir2_node_removename(args);
466 * Replace the inode number of a directory entry.
470 struct xfs_trans *tp,
471 struct xfs_inode *dp,
472 struct xfs_name *name, /* name of entry to replace */
473 xfs_ino_t inum, /* new inode number */
474 xfs_extlen_t total) /* bmap's total block count */
476 struct xfs_da_args *args;
478 int v; /* type-checking value */
480 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
482 rval = xfs_dir_ino_validate(tp->t_mountp, inum);
486 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
490 args->geo = dp->i_mount->m_dir_geo;
491 args->name = name->name;
492 args->namelen = name->len;
493 args->filetype = name->type;
494 args->hashval = dp->i_mount->m_dirnameops->hashname(name);
495 args->inumber = inum;
498 args->whichfork = XFS_DATA_FORK;
501 if (dp->i_d.di_format == XFS_DINODE_FMT_LOCAL) {
502 rval = xfs_dir2_sf_replace(args);
506 rval = xfs_dir2_isblock(args, &v);
510 rval = xfs_dir2_block_replace(args);
514 rval = xfs_dir2_isleaf(args, &v);
518 rval = xfs_dir2_leaf_replace(args);
520 rval = xfs_dir2_node_replace(args);
527 * See if this entry can be added to the directory without allocating space.
533 struct xfs_name *name) /* name of entry to add */
535 return xfs_dir_createname(tp, dp, name, 0, 0);
543 * Add a block to the directory.
545 * This routine is for data and free blocks, not leaf/node blocks which are
546 * handled by xfs_da_grow_inode.
550 struct xfs_da_args *args,
551 int space, /* v2 dir's space XFS_DIR2_xxx_SPACE */
552 xfs_dir2_db_t *dbp) /* out: block number added */
554 struct xfs_inode *dp = args->dp;
555 struct xfs_mount *mp = dp->i_mount;
556 xfs_fileoff_t bno; /* directory offset of new block */
557 int count; /* count of filesystem blocks */
560 trace_xfs_dir2_grow_inode(args, space);
563 * Set lowest possible block in the space requested.
565 bno = XFS_B_TO_FSBT(mp, space * XFS_DIR2_SPACE_SIZE);
566 count = args->geo->fsbcount;
568 error = xfs_da_grow_inode_int(args, &bno, count);
572 *dbp = xfs_dir2_da_to_db(args->geo, (xfs_dablk_t)bno);
575 * Update file's size if this is the data space and it grew.
577 if (space == XFS_DIR2_DATA_SPACE) {
578 xfs_fsize_t size; /* directory file (data) size */
580 size = XFS_FSB_TO_B(mp, bno + count);
581 if (size > dp->i_d.di_size) {
582 dp->i_d.di_size = size;
583 xfs_trans_log_inode(args->trans, dp, XFS_ILOG_CORE);
590 * See if the directory is a single-block form directory.
594 struct xfs_da_args *args,
595 int *vp) /* out: 1 is block, 0 is not block */
597 xfs_fileoff_t last; /* last file offset */
600 if ((rval = xfs_bmap_last_offset(args->dp, &last, XFS_DATA_FORK)))
602 rval = XFS_FSB_TO_B(args->dp->i_mount, last) == args->geo->blksize;
603 if (rval != 0 && args->dp->i_d.di_size != args->geo->blksize)
604 return -EFSCORRUPTED;
610 * See if the directory is a single-leaf form directory.
614 struct xfs_da_args *args,
615 int *vp) /* out: 1 is block, 0 is not block */
617 xfs_fileoff_t last; /* last file offset */
620 if ((rval = xfs_bmap_last_offset(args->dp, &last, XFS_DATA_FORK)))
622 *vp = last == args->geo->leafblk + args->geo->fsbcount;
627 * Remove the given block from the directory.
628 * This routine is used for data and free blocks, leaf/node are done
629 * by xfs_da_shrink_inode.
632 xfs_dir2_shrink_inode(
633 struct xfs_da_args *args,
637 xfs_fileoff_t bno; /* directory file offset */
638 xfs_dablk_t da; /* directory file offset */
639 int done; /* bunmap is finished */
640 struct xfs_inode *dp;
642 struct xfs_mount *mp;
643 struct xfs_trans *tp;
645 trace_xfs_dir2_shrink_inode(args, db);
650 da = xfs_dir2_db_to_da(args->geo, db);
652 /* Unmap the fsblock(s). */
653 error = xfs_bunmapi(tp, dp, da, args->geo->fsbcount, 0, 0, &done);
656 * ENOSPC actually can happen if we're in a removename with no
657 * space reservation, and the resulting block removal would
658 * cause a bmap btree split or conversion from extents to btree.
659 * This can only happen for un-fragmented directory blocks,
660 * since you need to be punching out the middle of an extent.
661 * In this case we need to leave the block in the file, and not
662 * binval it. So the block has to be in a consistent empty
663 * state and appropriately logged. We don't free up the buffer,
664 * the caller can tell it hasn't happened since it got an error
671 * Invalidate the buffer from the transaction.
673 xfs_trans_binval(tp, bp);
675 * If it's not a data block, we're done.
677 if (db >= xfs_dir2_byte_to_db(args->geo, XFS_DIR2_LEAF_OFFSET))
680 * If the block isn't the last one in the directory, we're done.
682 if (dp->i_d.di_size > xfs_dir2_db_off_to_byte(args->geo, db + 1, 0))
685 if ((error = xfs_bmap_last_before(tp, dp, &bno, XFS_DATA_FORK))) {
687 * This can't really happen unless there's kernel corruption.
691 if (db == args->geo->datablk)
696 * Set the size to the new last block.
698 dp->i_d.di_size = XFS_FSB_TO_B(mp, bno);
699 xfs_trans_log_inode(tp, dp, XFS_ILOG_CORE);
703 /* Returns true if the directory entry name is valid. */
710 * MAXNAMELEN includes the trailing null, but (name/length) leave it
711 * out, so use >= for the length check.
713 if (length >= MAXNAMELEN)
716 /* There shouldn't be any slashes or nulls here */
717 return !memchr(name, '/', length) && !memchr(name, 0, length);