[linux.git] / fs / xfs / xfs_dir2.h

/*
 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef __XFS_DIR2_H__
#define	__XFS_DIR2_H__

struct uio;
struct xfs_dabuf;
struct xfs_da_args;
struct xfs_dir2_put_args;
struct xfs_bmap_free;
struct xfs_inode;
struct xfs_mount;
struct xfs_trans;

/*
 * Directory version 2.
 * There are 4 possible formats:
 *	shortform
 *	single block - data with embedded leaf at the end
 *	multiple data blocks, single leaf+freeindex block
 *	data blocks, node&leaf blocks (btree), freeindex blocks
 *
 *	The shortform format is in xfs_dir2_sf.h.
 *	The single block format is in xfs_dir2_block.h.
 *	The data block format is in xfs_dir2_data.h.
 *	The leaf and freeindex block formats are in xfs_dir2_leaf.h.
 *	Node blocks are the same as the other version, in xfs_da_btree.h.
 */

/*
 * Byte offset in data block and shortform entry.
 */
typedef	__uint16_t	xfs_dir2_data_off_t;
#define	NULLDATAOFF	0xffffU
typedef uint		xfs_dir2_data_aoff_t;	/* argument form */

/*
 * Directory block number (logical dirblk in file)
 */
typedef	__uint32_t	xfs_dir2_db_t;

/*
 * Byte offset in a directory.
 */
typedef	xfs_off_t	xfs_dir2_off_t;

extern struct xfs_name	xfs_name_dotdot;

/*
 * Generic directory interface routines
 */
extern void xfs_dir_startup(void);
extern void xfs_dir_mount(struct xfs_mount *mp);
extern int xfs_dir_isempty(struct xfs_inode *dp);
extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp,
				struct xfs_inode *pdp);
extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp,
				struct xfs_name *name, xfs_ino_t inum,
				xfs_fsblock_t *first,
				struct xfs_bmap_free *flist, xfs_extlen_t tot);
extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp,
				struct xfs_name *name, xfs_ino_t *inum);
extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp,
				struct xfs_name *name, xfs_ino_t ino,
				xfs_fsblock_t *first,
				struct xfs_bmap_free *flist, xfs_extlen_t tot);
extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp,
				struct xfs_name *name, xfs_ino_t inum,
				xfs_fsblock_t *first,
				struct xfs_bmap_free *flist, xfs_extlen_t tot);
extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp,
				struct xfs_name *name, uint resblks);
extern int xfs_dir_ino_validate(struct xfs_mount *mp, xfs_ino_t ino);

/*
 * Utility routines for v2 directories.
 */
extern int xfs_dir2_grow_inode(struct xfs_da_args *args, int space,
				xfs_dir2_db_t *dbp);
extern int xfs_dir2_isblock(struct xfs_trans *tp, struct xfs_inode *dp,
				int *vp);
extern int xfs_dir2_isleaf(struct xfs_trans *tp, struct xfs_inode *dp,
				int *vp);
extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
				struct xfs_dabuf *bp);

#endif	/* __XFS_DIR2_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
7b718769 NS	3	* All Rights Reserved.
1da177e4	4	*
7b718769 NS	5	* This program is free software; you can redistribute it and/or
7b718769 NS	6	* modify it under the terms of the GNU General Public License as
1da177e4 LT	7	* published by the Free Software Foundation.
1da177e4 LT	8	*
7b718769 NS	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.
1da177e4	13	*
7b718769 NS	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
1da177e4 LT	17	*/
	18	#ifndef __XFS_DIR2_H__
	19	#define __XFS_DIR2_H__
	20
	21	struct uio;
	22	struct xfs_dabuf;
	23	struct xfs_da_args;
	24	struct xfs_dir2_put_args;
f6c2d1fa	25	struct xfs_bmap_free;
1da177e4	26	struct xfs_inode;
f6c2d1fa	27	struct xfs_mount;
1da177e4 LT	28	struct xfs_trans;
	29
	30	/*
	31	* Directory version 2.
	32	* There are 4 possible formats:
	33	* shortform
	34	* single block - data with embedded leaf at the end
	35	* multiple data blocks, single leaf+freeindex block
	36	* data blocks, node&leaf blocks (btree), freeindex blocks
	37	*
	38	* The shortform format is in xfs_dir2_sf.h.
	39	* The single block format is in xfs_dir2_block.h.
	40	* The data block format is in xfs_dir2_data.h.
	41	* The leaf and freeindex block formats are in xfs_dir2_leaf.h.
	42	* Node blocks are the same as the other version, in xfs_da_btree.h.
	43	*/
	44
	45	/*
	46	* Byte offset in data block and shortform entry.
	47	*/
	48	typedef __uint16_t xfs_dir2_data_off_t;
	49	#define NULLDATAOFF 0xffffU
	50	typedef uint xfs_dir2_data_aoff_t; /* argument form */
	51
	52	/*
	53	* Directory block number (logical dirblk in file)
	54	*/
	55	typedef __uint32_t xfs_dir2_db_t;
	56
	57	/*
	58	* Byte offset in a directory.
	59	*/
2d0f864b	60	typedef xfs_off_t xfs_dir2_off_t;
1da177e4	61
556b8b16 BN	62	extern struct xfs_name xfs_name_dotdot;
556b8b16 BN	63
1da177e4	64	/*
f6c2d1fa NS	65	* Generic directory interface routines
	66	*/
	67	extern void xfs_dir_startup(void);
	68	extern void xfs_dir_mount(struct xfs_mount *mp);
	69	extern int xfs_dir_isempty(struct xfs_inode *dp);
	70	extern int xfs_dir_init(struct xfs_trans tp, struct xfs_inode dp,
	71	struct xfs_inode *pdp);
	72	extern int xfs_dir_createname(struct xfs_trans tp, struct xfs_inode dp,
556b8b16	73	struct xfs_name *name, xfs_ino_t inum,
f6c2d1fa NS	74	xfs_fsblock_t *first,
	75	struct xfs_bmap_free *flist, xfs_extlen_t tot);
	76	extern int xfs_dir_lookup(struct xfs_trans tp, struct xfs_inode dp,
556b8b16	77	struct xfs_name name, xfs_ino_t inum);
f6c2d1fa	78	extern int xfs_dir_removename(struct xfs_trans tp, struct xfs_inode dp,
556b8b16	79	struct xfs_name *name, xfs_ino_t ino,
f6c2d1fa NS	80	xfs_fsblock_t *first,
f6c2d1fa NS	81	struct xfs_bmap_free *flist, xfs_extlen_t tot);
f6c2d1fa	82	extern int xfs_dir_replace(struct xfs_trans tp, struct xfs_inode dp,
556b8b16	83	struct xfs_name *name, xfs_ino_t inum,
f6c2d1fa NS	84	xfs_fsblock_t *first,
	85	struct xfs_bmap_free *flist, xfs_extlen_t tot);
	86	extern int xfs_dir_canenter(struct xfs_trans tp, struct xfs_inode dp,
556b8b16	87	struct xfs_name *name, uint resblks);
f6c2d1fa NS	88	extern int xfs_dir_ino_validate(struct xfs_mount *mp, xfs_ino_t ino);
	89
	90	/*
	91	* Utility routines for v2 directories.
1da177e4	92	*/
2d0f864b NS	93	extern int xfs_dir2_grow_inode(struct xfs_da_args *args, int space,
	94	xfs_dir2_db_t *dbp);
	95	extern int xfs_dir2_isblock(struct xfs_trans tp, struct xfs_inode dp,
	96	int *vp);
	97	extern int xfs_dir2_isleaf(struct xfs_trans tp, struct xfs_inode dp,
	98	int *vp);
	99	extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
	100	struct xfs_dabuf *bp);
1da177e4 LT	101
1da177e4 LT	102	#endif /* __XFS_DIR2_H__ */