blob: 4dff261e6ed59ee8b9749c189554428115e8c4df [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
Dave Chinner1c9a5b22013-10-30 09:15:02 +110062 xfs_dir2_data_aoff_t data_dot_offset;
63 xfs_dir2_data_aoff_t data_dotdot_offset;
64 xfs_dir2_data_aoff_t data_first_offset;
65 size_t data_entry_offset;
Dave Chinner2ca98772013-10-29 22:11:49 +110066
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 Chinner41419562013-10-29 22:11:50 +110077
Dave Chinner1c9a5b22013-10-30 09:15:02 +110078 int leaf_hdr_size;
Dave Chinner01ba43b2013-10-29 22:11:52 +110079 void (*leaf_hdr_to_disk)(struct xfs_dir2_leaf *to,
80 struct xfs_dir3_icleaf_hdr *from);
81 void (*leaf_hdr_from_disk)(struct xfs_dir3_icleaf_hdr *to,
82 struct xfs_dir2_leaf *from);
Dave Chinner8f661932014-06-06 15:15:59 +100083 int (*leaf_max_ents)(struct xfs_da_geometry *geo);
Dave Chinner41419562013-10-29 22:11:50 +110084 struct xfs_dir2_leaf_entry *
85 (*leaf_ents_p)(struct xfs_dir2_leaf *lp);
Dave Chinner4bceb182013-10-29 22:11:51 +110086
Dave Chinner1c9a5b22013-10-30 09:15:02 +110087 int node_hdr_size;
Dave Chinner01ba43b2013-10-29 22:11:52 +110088 void (*node_hdr_to_disk)(struct xfs_da_intnode *to,
89 struct xfs_da3_icnode_hdr *from);
90 void (*node_hdr_from_disk)(struct xfs_da3_icnode_hdr *to,
91 struct xfs_da_intnode *from);
Dave Chinner4bceb182013-10-29 22:11:51 +110092 struct xfs_da_node_entry *
93 (*node_tree_p)(struct xfs_da_intnode *dap);
Dave Chinner01ba43b2013-10-29 22:11:52 +110094
Dave Chinner1c9a5b22013-10-30 09:15:02 +110095 int free_hdr_size;
Dave Chinner01ba43b2013-10-29 22:11:52 +110096 void (*free_hdr_to_disk)(struct xfs_dir2_free *to,
97 struct xfs_dir3_icfree_hdr *from);
98 void (*free_hdr_from_disk)(struct xfs_dir3_icfree_hdr *to,
99 struct xfs_dir2_free *from);
Dave Chinner8f661932014-06-06 15:15:59 +1000100 int (*free_max_bests)(struct xfs_da_geometry *geo);
Dave Chinner24dd0f52013-10-30 13:48:41 -0500101 __be16 * (*free_bests_p)(struct xfs_dir2_free *free);
Dave Chinner8f661932014-06-06 15:15:59 +1000102 xfs_dir2_db_t (*db_to_fdb)(struct xfs_da_geometry *geo,
103 xfs_dir2_db_t db);
104 int (*db_to_fdindex)(struct xfs_da_geometry *geo,
105 xfs_dir2_db_t db);
Dave Chinner32c54832013-10-29 22:11:46 +1100106};
107
Dave Chinner41419562013-10-29 22:11:50 +1100108extern const struct xfs_dir_ops *
109 xfs_dir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
Dave Chinner4bceb182013-10-29 22:11:51 +1100110extern const struct xfs_dir_ops *
111 xfs_nondir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
Dave Chinner32c54832013-10-29 22:11:46 +1100112
113/*
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000114 * Generic directory interface routines
115 */
116extern void xfs_dir_startup(void);
Dave Chinner0650b552014-06-06 15:01:58 +1000117extern int xfs_da_mount(struct xfs_mount *mp);
118extern void xfs_da_unmount(struct xfs_mount *mp);
119
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000120extern int xfs_dir_isempty(struct xfs_inode *dp);
121extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp,
122 struct xfs_inode *pdp);
123extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +1000124 struct xfs_name *name, xfs_ino_t inum,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000125 xfs_fsblock_t *first,
126 struct xfs_bmap_free *flist, xfs_extlen_t tot);
127extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok384f3ce2008-05-21 16:58:22 +1000128 struct xfs_name *name, xfs_ino_t *inum,
129 struct xfs_name *ci_name);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000130extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +1000131 struct xfs_name *name, xfs_ino_t ino,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000132 xfs_fsblock_t *first,
133 struct xfs_bmap_free *flist, xfs_extlen_t tot);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000134extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +1000135 struct xfs_name *name, xfs_ino_t inum,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000136 xfs_fsblock_t *first,
137 struct xfs_bmap_free *flist, xfs_extlen_t tot);
138extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp,
Eric Sandeen94f3cad2014-09-09 11:57:52 +1000139 struct xfs_name *name);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000140
141/*
Christoph Hellwig57926642011-07-13 13:43:48 +0200142 * Direct call from the bmap code, bypassing the generic directory layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 */
Christoph Hellwig57926642011-07-13 13:43:48 +0200144extern int xfs_dir2_sf_to_block(struct xfs_da_args *args);
Barry Naujok384f3ce2008-05-21 16:58:22 +1000145
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000146/*
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000147 * Interface routines used by userspace utilities
148 */
Dave Chinner53f82db2014-06-06 15:20:32 +1000149extern int xfs_dir2_isblock(struct xfs_da_args *args, int *r);
150extern int xfs_dir2_isleaf(struct xfs_da_args *args, int *r);
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000151extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
152 struct xfs_buf *bp);
153
Dave Chinner9d23fc82013-10-29 22:11:48 +1100154extern void xfs_dir2_data_freescan(struct xfs_inode *dp,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000155 struct xfs_dir2_data_hdr *hdr, int *loghead);
Dave Chinnerbc851782014-06-06 15:20:54 +1000156extern void xfs_dir2_data_log_entry(struct xfs_da_args *args,
Dave Chinner9d23fc82013-10-29 22:11:48 +1100157 struct xfs_buf *bp, struct xfs_dir2_data_entry *dep);
Dave Chinnerbc851782014-06-06 15:20:54 +1000158extern void xfs_dir2_data_log_header(struct xfs_da_args *args,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000159 struct xfs_buf *bp);
Dave Chinnerbc851782014-06-06 15:20:54 +1000160extern void xfs_dir2_data_log_unused(struct xfs_da_args *args,
161 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup);
162extern void xfs_dir2_data_make_free(struct xfs_da_args *args,
Dave Chinner2ca98772013-10-29 22:11:49 +1100163 struct xfs_buf *bp, xfs_dir2_data_aoff_t offset,
164 xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp);
Dave Chinnerbc851782014-06-06 15:20:54 +1000165extern void xfs_dir2_data_use_free(struct xfs_da_args *args,
Dave Chinner2ca98772013-10-29 22:11:49 +1100166 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000167 xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len,
168 int *needlogp, int *needscanp);
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000169
170extern struct xfs_dir2_data_free *xfs_dir2_data_freefind(
Dave Chinner2ca98772013-10-29 22:11:49 +1100171 struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf,
172 struct xfs_dir2_data_unused *dup);
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000173
174extern const struct xfs_buf_ops xfs_dir3_block_buf_ops;
175extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops;
176extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops;
177extern const struct xfs_buf_ops xfs_dir3_free_buf_ops;
178extern const struct xfs_buf_ops xfs_dir3_data_buf_ops;
179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180#endif /* __XFS_DIR2_H__ */