2 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 #include "xfs_format.h"
21 #include "xfs_log_format.h"
22 #include "xfs_trans_resv.h"
23 #include "xfs_mount.h"
24 #include "xfs_defer.h"
25 #include "xfs_da_format.h"
26 #include "xfs_da_btree.h"
27 #include "xfs_inode.h"
28 #include "xfs_trans.h"
29 #include "xfs_inode_item.h"
32 #include "xfs_dir2_priv.h"
33 #include "xfs_error.h"
34 #include "xfs_trace.h"
36 struct xfs_name xfs_name_dotdot = { (unsigned char *)"..", 2, XFS_DIR3_FT_DIR };
39 * Convert inode mode to directory entry filetype
41 unsigned char xfs_mode_to_ftype(int mode)
43 switch (mode & S_IFMT) {
45 return XFS_DIR3_FT_REG_FILE;
47 return XFS_DIR3_FT_DIR;
49 return XFS_DIR3_FT_CHRDEV;
51 return XFS_DIR3_FT_BLKDEV;
53 return XFS_DIR3_FT_FIFO;
55 return XFS_DIR3_FT_SOCK;
57 return XFS_DIR3_FT_SYMLINK;
59 return XFS_DIR3_FT_UNKNOWN;
64 * ASCII case-insensitive (ie. A-Z) support for directories that was
68 xfs_ascii_ci_hashname(
69 struct xfs_name *name)
74 for (i = 0, hash = 0; i < name->len; i++)
75 hash = tolower(name->name[i]) ^ rol32(hash, 7);
81 xfs_ascii_ci_compname(
82 struct xfs_da_args *args,
83 const unsigned char *name,
86 enum xfs_dacmp result;
89 if (args->namelen != len)
90 return XFS_CMP_DIFFERENT;
92 result = XFS_CMP_EXACT;
93 for (i = 0; i < len; i++) {
94 if (args->name[i] == name[i])
96 if (tolower(args->name[i]) != tolower(name[i]))
97 return XFS_CMP_DIFFERENT;
98 result = XFS_CMP_CASE;
104 static const struct xfs_nameops xfs_ascii_ci_nameops = {
105 .hashname = xfs_ascii_ci_hashname,
106 .compname = xfs_ascii_ci_compname,
111 struct xfs_mount *mp)
113 struct xfs_da_geometry *dageo;
117 ASSERT(mp->m_sb.sb_versionnum & XFS_SB_VERSION_DIRV2BIT);
118 ASSERT((1 << (mp->m_sb.sb_blocklog + mp->m_sb.sb_dirblklog)) <=
121 mp->m_dir_inode_ops = xfs_dir_get_ops(mp, NULL);
122 mp->m_nondir_inode_ops = xfs_nondir_get_ops(mp, NULL);
124 nodehdr_size = mp->m_dir_inode_ops->node_hdr_size;
125 mp->m_dir_geo = kmem_zalloc(sizeof(struct xfs_da_geometry),
126 KM_SLEEP | KM_MAYFAIL);
127 mp->m_attr_geo = kmem_zalloc(sizeof(struct xfs_da_geometry),
128 KM_SLEEP | KM_MAYFAIL);
129 if (!mp->m_dir_geo || !mp->m_attr_geo) {
130 kmem_free(mp->m_dir_geo);
131 kmem_free(mp->m_attr_geo);
135 /* set up directory geometry */
136 dageo = mp->m_dir_geo;
137 dageo->blklog = mp->m_sb.sb_blocklog + mp->m_sb.sb_dirblklog;
138 dageo->fsblog = mp->m_sb.sb_blocklog;
139 dageo->blksize = 1 << dageo->blklog;
140 dageo->fsbcount = 1 << mp->m_sb.sb_dirblklog;
143 * Now we've set up the block conversion variables, we can calculate the
144 * segment block constants using the geometry structure.
146 dageo->datablk = xfs_dir2_byte_to_da(dageo, XFS_DIR2_DATA_OFFSET);
147 dageo->leafblk = xfs_dir2_byte_to_da(dageo, XFS_DIR2_LEAF_OFFSET);
148 dageo->freeblk = xfs_dir2_byte_to_da(dageo, XFS_DIR2_FREE_OFFSET);
149 dageo->node_ents = (dageo->blksize - nodehdr_size) /
150 (uint)sizeof(xfs_da_node_entry_t);
151 dageo->magicpct = (dageo->blksize * 37) / 100;
153 /* set up attribute geometry - single fsb only */
154 dageo = mp->m_attr_geo;
155 dageo->blklog = mp->m_sb.sb_blocklog;
156 dageo->fsblog = mp->m_sb.sb_blocklog;
157 dageo->blksize = 1 << dageo->blklog;
159 dageo->node_ents = (dageo->blksize - nodehdr_size) /
160 (uint)sizeof(xfs_da_node_entry_t);
161 dageo->magicpct = (dageo->blksize * 37) / 100;
163 if (xfs_sb_version_hasasciici(&mp->m_sb))
164 mp->m_dirnameops = &xfs_ascii_ci_nameops;
166 mp->m_dirnameops = &xfs_default_nameops;
173 struct xfs_mount *mp)
175 kmem_free(mp->m_dir_geo);
176 kmem_free(mp->m_attr_geo);
180 * Return 1 if directory contains only "." and "..".
186 xfs_dir2_sf_hdr_t *sfp;
188 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
189 if (dp->i_d.di_size == 0) /* might happen during shutdown. */
191 if (dp->i_d.di_size > XFS_IFORK_DSIZE(dp))
193 sfp = (xfs_dir2_sf_hdr_t *)dp->i_df.if_u1.if_data;
198 * Validate a given inode number.
201 xfs_dir_ino_validate(
205 xfs_agblock_t agblkno;
211 agno = XFS_INO_TO_AGNO(mp, ino);
212 agblkno = XFS_INO_TO_AGBNO(mp, ino);
213 ioff = XFS_INO_TO_OFFSET(mp, ino);
214 agino = XFS_OFFBNO_TO_AGINO(mp, agblkno, ioff);
216 agno < mp->m_sb.sb_agcount &&
217 agblkno < mp->m_sb.sb_agblocks &&
219 ioff < (1 << mp->m_sb.sb_inopblog) &&
220 XFS_AGINO_TO_INO(mp, agno, agino) == ino;
221 if (unlikely(XFS_TEST_ERROR(!ino_ok, mp, XFS_ERRTAG_DIR_INO_VALIDATE))) {
222 xfs_warn(mp, "Invalid inode number 0x%Lx",
223 (unsigned long long) ino);
224 XFS_ERROR_REPORT("xfs_dir_ino_validate", XFS_ERRLEVEL_LOW, mp);
225 return -EFSCORRUPTED;
231 * Initialize a directory with its "." and ".." entries.
239 struct xfs_da_args *args;
242 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
243 error = xfs_dir_ino_validate(tp->t_mountp, pdp->i_ino);
247 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
251 args->geo = dp->i_mount->m_dir_geo;
254 error = xfs_dir2_sf_create(args, pdp->i_ino);
260 * Enter a name in a directory, or check for available space.
261 * If inum is 0, only the available space test is performed.
267 struct xfs_name *name,
268 xfs_ino_t inum, /* new entry inode number */
269 xfs_fsblock_t *first, /* bmap's firstblock */
270 struct xfs_defer_ops *dfops, /* bmap's freeblock list */
271 xfs_extlen_t total) /* bmap's total block count */
273 struct xfs_da_args *args;
275 int v; /* type-checking value */
277 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
279 rval = xfs_dir_ino_validate(tp->t_mountp, inum);
282 XFS_STATS_INC(dp->i_mount, xs_dir_create);
285 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
289 args->geo = dp->i_mount->m_dir_geo;
290 args->name = name->name;
291 args->namelen = name->len;
292 args->filetype = name->type;
293 args->hashval = dp->i_mount->m_dirnameops->hashname(name);
294 args->inumber = inum;
296 args->firstblock = first;
299 args->whichfork = XFS_DATA_FORK;
301 args->op_flags = XFS_DA_OP_ADDNAME | XFS_DA_OP_OKNOENT;
303 args->op_flags |= XFS_DA_OP_JUSTCHECK;
305 if (dp->i_d.di_format == XFS_DINODE_FMT_LOCAL) {
306 rval = xfs_dir2_sf_addname(args);
310 rval = xfs_dir2_isblock(args, &v);
314 rval = xfs_dir2_block_addname(args);
318 rval = xfs_dir2_isleaf(args, &v);
322 rval = xfs_dir2_leaf_addname(args);
324 rval = xfs_dir2_node_addname(args);
332 * If doing a CI lookup and case-insensitive match, dup actual name into
333 * args.value. Return EEXIST for success (ie. name found) or an error.
336 xfs_dir_cilookup_result(
337 struct xfs_da_args *args,
338 const unsigned char *name,
341 if (args->cmpresult == XFS_CMP_DIFFERENT)
343 if (args->cmpresult != XFS_CMP_CASE ||
344 !(args->op_flags & XFS_DA_OP_CILOOKUP))
347 args->value = kmem_alloc(len, KM_NOFS | KM_MAYFAIL);
351 memcpy(args->value, name, len);
352 args->valuelen = len;
357 * Lookup a name in a directory, give back the inode number.
358 * If ci_name is not NULL, returns the actual name in ci_name if it differs
359 * to name, or ci_name->name is set to NULL for an exact match.
366 struct xfs_name *name,
367 xfs_ino_t *inum, /* out: inode number */
368 struct xfs_name *ci_name) /* out: actual name if CI match */
370 struct xfs_da_args *args;
372 int v; /* type-checking value */
375 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
376 XFS_STATS_INC(dp->i_mount, xs_dir_lookup);
379 * We need to use KM_NOFS here so that lockdep will not throw false
380 * positive deadlock warnings on a non-transactional lookup path. It is
381 * safe to recurse into inode recalim in that case, but lockdep can't
382 * easily be taught about it. Hence KM_NOFS avoids having to add more
383 * lockdep Doing this avoids having to add a bunch of lockdep class
384 * annotations into the reclaim path for the ilock.
386 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
387 args->geo = dp->i_mount->m_dir_geo;
388 args->name = name->name;
389 args->namelen = name->len;
390 args->filetype = name->type;
391 args->hashval = dp->i_mount->m_dirnameops->hashname(name);
393 args->whichfork = XFS_DATA_FORK;
395 args->op_flags = XFS_DA_OP_OKNOENT;
397 args->op_flags |= XFS_DA_OP_CILOOKUP;
399 lock_mode = xfs_ilock_data_map_shared(dp);
400 if (dp->i_d.di_format == XFS_DINODE_FMT_LOCAL) {
401 rval = xfs_dir2_sf_lookup(args);
405 rval = xfs_dir2_isblock(args, &v);
409 rval = xfs_dir2_block_lookup(args);
413 rval = xfs_dir2_isleaf(args, &v);
417 rval = xfs_dir2_leaf_lookup(args);
419 rval = xfs_dir2_node_lookup(args);
425 *inum = args->inumber;
427 ci_name->name = args->value;
428 ci_name->len = args->valuelen;
432 xfs_iunlock(dp, lock_mode);
438 * Remove an entry from a directory.
444 struct xfs_name *name,
446 xfs_fsblock_t *first, /* bmap's firstblock */
447 struct xfs_defer_ops *dfops, /* bmap's freeblock list */
448 xfs_extlen_t total) /* bmap's total block count */
450 struct xfs_da_args *args;
452 int v; /* type-checking value */
454 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
455 XFS_STATS_INC(dp->i_mount, xs_dir_remove);
457 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
461 args->geo = dp->i_mount->m_dir_geo;
462 args->name = name->name;
463 args->namelen = name->len;
464 args->filetype = name->type;
465 args->hashval = dp->i_mount->m_dirnameops->hashname(name);
468 args->firstblock = first;
471 args->whichfork = XFS_DATA_FORK;
474 if (dp->i_d.di_format == XFS_DINODE_FMT_LOCAL) {
475 rval = xfs_dir2_sf_removename(args);
479 rval = xfs_dir2_isblock(args, &v);
483 rval = xfs_dir2_block_removename(args);
487 rval = xfs_dir2_isleaf(args, &v);
491 rval = xfs_dir2_leaf_removename(args);
493 rval = xfs_dir2_node_removename(args);
500 * Replace the inode number of a directory entry.
506 struct xfs_name *name, /* name of entry to replace */
507 xfs_ino_t inum, /* new inode number */
508 xfs_fsblock_t *first, /* bmap's firstblock */
509 struct xfs_defer_ops *dfops, /* bmap's freeblock list */
510 xfs_extlen_t total) /* bmap's total block count */
512 struct xfs_da_args *args;
514 int v; /* type-checking value */
516 ASSERT(S_ISDIR(VFS_I(dp)->i_mode));
518 rval = xfs_dir_ino_validate(tp->t_mountp, inum);
522 args = kmem_zalloc(sizeof(*args), KM_SLEEP | KM_NOFS);
526 args->geo = dp->i_mount->m_dir_geo;
527 args->name = name->name;
528 args->namelen = name->len;
529 args->filetype = name->type;
530 args->hashval = dp->i_mount->m_dirnameops->hashname(name);
531 args->inumber = inum;
533 args->firstblock = first;
536 args->whichfork = XFS_DATA_FORK;
539 if (dp->i_d.di_format == XFS_DINODE_FMT_LOCAL) {
540 rval = xfs_dir2_sf_replace(args);
544 rval = xfs_dir2_isblock(args, &v);
548 rval = xfs_dir2_block_replace(args);
552 rval = xfs_dir2_isleaf(args, &v);
556 rval = xfs_dir2_leaf_replace(args);
558 rval = xfs_dir2_node_replace(args);
565 * See if this entry can be added to the directory without allocating space.
571 struct xfs_name *name) /* name of entry to add */
573 return xfs_dir_createname(tp, dp, name, 0, NULL, NULL, 0);
581 * Add a block to the directory.
583 * This routine is for data and free blocks, not leaf/node blocks which are
584 * handled by xfs_da_grow_inode.
588 struct xfs_da_args *args,
589 int space, /* v2 dir's space XFS_DIR2_xxx_SPACE */
590 xfs_dir2_db_t *dbp) /* out: block number added */
592 struct xfs_inode *dp = args->dp;
593 struct xfs_mount *mp = dp->i_mount;
594 xfs_fileoff_t bno; /* directory offset of new block */
595 int count; /* count of filesystem blocks */
598 trace_xfs_dir2_grow_inode(args, space);
601 * Set lowest possible block in the space requested.
603 bno = XFS_B_TO_FSBT(mp, space * XFS_DIR2_SPACE_SIZE);
604 count = args->geo->fsbcount;
606 error = xfs_da_grow_inode_int(args, &bno, count);
610 *dbp = xfs_dir2_da_to_db(args->geo, (xfs_dablk_t)bno);
613 * Update file's size if this is the data space and it grew.
615 if (space == XFS_DIR2_DATA_SPACE) {
616 xfs_fsize_t size; /* directory file (data) size */
618 size = XFS_FSB_TO_B(mp, bno + count);
619 if (size > dp->i_d.di_size) {
620 dp->i_d.di_size = size;
621 xfs_trans_log_inode(args->trans, dp, XFS_ILOG_CORE);
628 * See if the directory is a single-block form directory.
632 struct xfs_da_args *args,
633 int *vp) /* out: 1 is block, 0 is not block */
635 xfs_fileoff_t last; /* last file offset */
638 if ((rval = xfs_bmap_last_offset(args->dp, &last, XFS_DATA_FORK)))
640 rval = XFS_FSB_TO_B(args->dp->i_mount, last) == args->geo->blksize;
641 if (rval != 0 && args->dp->i_d.di_size != args->geo->blksize)
642 return -EFSCORRUPTED;
648 * See if the directory is a single-leaf form directory.
652 struct xfs_da_args *args,
653 int *vp) /* out: 1 is block, 0 is not block */
655 xfs_fileoff_t last; /* last file offset */
658 if ((rval = xfs_bmap_last_offset(args->dp, &last, XFS_DATA_FORK)))
660 *vp = last == args->geo->leafblk + args->geo->fsbcount;
665 * Remove the given block from the directory.
666 * This routine is used for data and free blocks, leaf/node are done
667 * by xfs_da_shrink_inode.
670 xfs_dir2_shrink_inode(
675 xfs_fileoff_t bno; /* directory file offset */
676 xfs_dablk_t da; /* directory file offset */
677 int done; /* bunmap is finished */
683 trace_xfs_dir2_shrink_inode(args, db);
688 da = xfs_dir2_db_to_da(args->geo, db);
690 /* Unmap the fsblock(s). */
691 error = xfs_bunmapi(tp, dp, da, args->geo->fsbcount, 0, 0,
692 args->firstblock, args->dfops, &done);
695 * ENOSPC actually can happen if we're in a removename with no
696 * space reservation, and the resulting block removal would
697 * cause a bmap btree split or conversion from extents to btree.
698 * This can only happen for un-fragmented directory blocks,
699 * since you need to be punching out the middle of an extent.
700 * In this case we need to leave the block in the file, and not
701 * binval it. So the block has to be in a consistent empty
702 * state and appropriately logged. We don't free up the buffer,
703 * the caller can tell it hasn't happened since it got an error
710 * Invalidate the buffer from the transaction.
712 xfs_trans_binval(tp, bp);
714 * If it's not a data block, we're done.
716 if (db >= xfs_dir2_byte_to_db(args->geo, XFS_DIR2_LEAF_OFFSET))
719 * If the block isn't the last one in the directory, we're done.
721 if (dp->i_d.di_size > xfs_dir2_db_off_to_byte(args->geo, db + 1, 0))
724 if ((error = xfs_bmap_last_before(tp, dp, &bno, XFS_DATA_FORK))) {
726 * This can't really happen unless there's kernel corruption.
730 if (db == args->geo->datablk)
735 * Set the size to the new last block.
737 dp->i_d.di_size = XFS_FSB_TO_B(mp, bno);
738 xfs_trans_log_inode(tp, dp, XFS_ILOG_CORE);