blob: 076010a1376a02e5a54ef6c45531cbfa9188d0eb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18#ifndef __XFS_DIR2_H__
Christoph Hellwig57926642011-07-13 13:43:48 +020019#define __XFS_DIR2_H__
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Nathan Scottf6c2d1f2006-06-20 13:04:51 +100021struct xfs_bmap_free;
Christoph Hellwig57926642011-07-13 13:43:48 +020022struct xfs_da_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -070023struct xfs_inode;
Nathan Scottf6c2d1f2006-06-20 13:04:51 +100024struct xfs_mount;
Linus Torvalds1da177e2005-04-16 15:20:36 -070025struct xfs_trans;
Dave Chinner2b9ab5a2013-08-12 20:49:37 +100026struct xfs_dir2_sf_hdr;
27struct xfs_dir2_sf_entry;
28struct xfs_dir2_data_hdr;
29struct xfs_dir2_data_entry;
30struct xfs_dir2_data_unused;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Barry Naujok556b8b12008-04-10 12:22:07 +100032extern struct xfs_name xfs_name_dotdot;
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034/*
Dave Chinner32c54832013-10-29 22:11:46 +110035 * directory operations vector for encode/decode routines
36 */
37struct xfs_dir_ops {
38 int (*sf_entsize)(struct xfs_dir2_sf_hdr *hdr, int len);
39 struct xfs_dir2_sf_entry *
40 (*sf_nextentry)(struct xfs_dir2_sf_hdr *hdr,
41 struct xfs_dir2_sf_entry *sfep);
Dave Chinner47401752013-10-29 22:11:47 +110042 __uint8_t (*sf_get_ftype)(struct xfs_dir2_sf_entry *sfep);
43 void (*sf_put_ftype)(struct xfs_dir2_sf_entry *sfep,
44 __uint8_t ftype);
45 xfs_ino_t (*sf_get_ino)(struct xfs_dir2_sf_hdr *hdr,
46 struct xfs_dir2_sf_entry *sfep);
47 void (*sf_put_ino)(struct xfs_dir2_sf_hdr *hdr,
48 struct xfs_dir2_sf_entry *sfep,
49 xfs_ino_t ino);
50 xfs_ino_t (*sf_get_parent_ino)(struct xfs_dir2_sf_hdr *hdr);
51 void (*sf_put_parent_ino)(struct xfs_dir2_sf_hdr *hdr,
52 xfs_ino_t ino);
Dave Chinner9d23fc82013-10-29 22:11:48 +110053
54 int (*data_entsize)(int len);
55 __uint8_t (*data_get_ftype)(struct xfs_dir2_data_entry *dep);
56 void (*data_put_ftype)(struct xfs_dir2_data_entry *dep,
57 __uint8_t ftype);
58 __be16 * (*data_entry_tag_p)(struct xfs_dir2_data_entry *dep);
Dave Chinner2ca98772013-10-29 22:11:49 +110059 struct xfs_dir2_data_free *
60 (*data_bestfree_p)(struct xfs_dir2_data_hdr *hdr);
Dave Chinner9d23fc82013-10-29 22:11:48 +110061
62 xfs_dir2_data_aoff_t (*data_dot_offset)(void);
63 xfs_dir2_data_aoff_t (*data_dotdot_offset)(void);
64 xfs_dir2_data_aoff_t (*data_first_offset)(void);
Dave Chinner2ca98772013-10-29 22:11:49 +110065 size_t (*data_entry_offset)(void);
66
Dave Chinner9d23fc82013-10-29 22:11:48 +110067 struct xfs_dir2_data_entry *
68 (*data_dot_entry_p)(struct xfs_dir2_data_hdr *hdr);
69 struct xfs_dir2_data_entry *
70 (*data_dotdot_entry_p)(struct xfs_dir2_data_hdr *hdr);
71 struct xfs_dir2_data_entry *
72 (*data_first_entry_p)(struct xfs_dir2_data_hdr *hdr);
Dave Chinner2ca98772013-10-29 22:11:49 +110073 struct xfs_dir2_data_entry *
74 (*data_entry_p)(struct xfs_dir2_data_hdr *hdr);
75 struct xfs_dir2_data_unused *
76 (*data_unused_p)(struct xfs_dir2_data_hdr *hdr);
Dave Chinner32c54832013-10-29 22:11:46 +110077};
78
79extern const struct xfs_dir_ops xfs_dir2_ops;
80extern const struct xfs_dir_ops xfs_dir2_ftype_ops;
81extern const struct xfs_dir_ops xfs_dir3_ops;
82
83/*
Nathan Scottf6c2d1f2006-06-20 13:04:51 +100084 * Generic directory interface routines
85 */
86extern void xfs_dir_startup(void);
87extern void xfs_dir_mount(struct xfs_mount *mp);
88extern int xfs_dir_isempty(struct xfs_inode *dp);
89extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp,
90 struct xfs_inode *pdp);
91extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +100092 struct xfs_name *name, xfs_ino_t inum,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +100093 xfs_fsblock_t *first,
94 struct xfs_bmap_free *flist, xfs_extlen_t tot);
95extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok384f3ce2008-05-21 16:58:22 +100096 struct xfs_name *name, xfs_ino_t *inum,
97 struct xfs_name *ci_name);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +100098extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +100099 struct xfs_name *name, xfs_ino_t ino,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000100 xfs_fsblock_t *first,
101 struct xfs_bmap_free *flist, xfs_extlen_t tot);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000102extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +1000103 struct xfs_name *name, xfs_ino_t inum,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000104 xfs_fsblock_t *first,
105 struct xfs_bmap_free *flist, xfs_extlen_t tot);
106extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +1000107 struct xfs_name *name, uint resblks);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000108
109/*
Christoph Hellwig57926642011-07-13 13:43:48 +0200110 * Direct call from the bmap code, bypassing the generic directory layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 */
Christoph Hellwig57926642011-07-13 13:43:48 +0200112extern int xfs_dir2_sf_to_block(struct xfs_da_args *args);
Barry Naujok384f3ce2008-05-21 16:58:22 +1000113
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000114/*
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000115 * Interface routines used by userspace utilities
116 */
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000117extern int xfs_dir2_isblock(struct xfs_trans *tp, struct xfs_inode *dp, int *r);
118extern int xfs_dir2_isleaf(struct xfs_trans *tp, struct xfs_inode *dp, int *r);
119extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
120 struct xfs_buf *bp);
121
Dave Chinner9d23fc82013-10-29 22:11:48 +1100122extern void xfs_dir2_data_freescan(struct xfs_inode *dp,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000123 struct xfs_dir2_data_hdr *hdr, int *loghead);
Dave Chinner9d23fc82013-10-29 22:11:48 +1100124extern void xfs_dir2_data_log_entry(struct xfs_trans *tp, struct xfs_inode *dp,
125 struct xfs_buf *bp, struct xfs_dir2_data_entry *dep);
Dave Chinner2ca98772013-10-29 22:11:49 +1100126extern void xfs_dir2_data_log_header(struct xfs_trans *tp, struct xfs_inode *dp,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000127 struct xfs_buf *bp);
128extern void xfs_dir2_data_log_unused(struct xfs_trans *tp, struct xfs_buf *bp,
129 struct xfs_dir2_data_unused *dup);
Dave Chinner2ca98772013-10-29 22:11:49 +1100130extern void xfs_dir2_data_make_free(struct xfs_trans *tp, struct xfs_inode *dp,
131 struct xfs_buf *bp, xfs_dir2_data_aoff_t offset,
132 xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp);
133extern void xfs_dir2_data_use_free(struct xfs_trans *tp, struct xfs_inode *dp,
134 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000135 xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len,
136 int *needlogp, int *needscanp);
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000137
138extern struct xfs_dir2_data_free *xfs_dir2_data_freefind(
Dave Chinner2ca98772013-10-29 22:11:49 +1100139 struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf,
140 struct xfs_dir2_data_unused *dup);
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000141
142extern const struct xfs_buf_ops xfs_dir3_block_buf_ops;
143extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops;
144extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops;
145extern const struct xfs_buf_ops xfs_dir3_free_buf_ops;
146extern const struct xfs_buf_ops xfs_dir3_data_buf_ops;
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148#endif /* __XFS_DIR2_H__ */