]> Pileus Git - ~andy/linux/blob - fs/xfs/xfs_dir2.h
Linux 3.14
[~andy/linux] / fs / xfs / xfs_dir2.h
1 /*
2  * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
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.
8  *
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.
13  *
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
17  */
18 #ifndef __XFS_DIR2_H__
19 #define __XFS_DIR2_H__
20
21 struct xfs_bmap_free;
22 struct xfs_da_args;
23 struct xfs_inode;
24 struct xfs_mount;
25 struct xfs_trans;
26 struct xfs_dir2_sf_hdr;
27 struct xfs_dir2_sf_entry;
28 struct xfs_dir2_data_hdr;
29 struct xfs_dir2_data_entry;
30 struct xfs_dir2_data_unused;
31
32 extern struct xfs_name  xfs_name_dotdot;
33
34 /*
35  * directory operations vector for encode/decode routines
36  */
37 struct 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);
42         __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);
53
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);
59         struct xfs_dir2_data_free *
60                 (*data_bestfree_p)(struct xfs_dir2_data_hdr *hdr);
61
62         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;
66
67         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);
73         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);
77
78         int     leaf_hdr_size;
79         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);
83         int     (*leaf_max_ents)(struct xfs_mount *mp);
84         struct xfs_dir2_leaf_entry *
85                 (*leaf_ents_p)(struct xfs_dir2_leaf *lp);
86
87         int     node_hdr_size;
88         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);
92         struct xfs_da_node_entry *
93                 (*node_tree_p)(struct xfs_da_intnode *dap);
94
95         int     free_hdr_size;
96         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);
100         int     (*free_max_bests)(struct xfs_mount *mp);
101         __be16 * (*free_bests_p)(struct xfs_dir2_free *free);
102         xfs_dir2_db_t (*db_to_fdb)(struct xfs_mount *mp, xfs_dir2_db_t db);
103         int     (*db_to_fdindex)(struct xfs_mount *mp, xfs_dir2_db_t db);
104 };
105
106 extern const struct xfs_dir_ops *
107         xfs_dir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
108 extern const struct xfs_dir_ops *
109         xfs_nondir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
110
111 /*
112  * Generic directory interface routines
113  */
114 extern void xfs_dir_startup(void);
115 extern void xfs_dir_mount(struct xfs_mount *mp);
116 extern int xfs_dir_isempty(struct xfs_inode *dp);
117 extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp,
118                                 struct xfs_inode *pdp);
119 extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp,
120                                 struct xfs_name *name, xfs_ino_t inum,
121                                 xfs_fsblock_t *first,
122                                 struct xfs_bmap_free *flist, xfs_extlen_t tot);
123 extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp,
124                                 struct xfs_name *name, xfs_ino_t *inum,
125                                 struct xfs_name *ci_name);
126 extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp,
127                                 struct xfs_name *name, xfs_ino_t ino,
128                                 xfs_fsblock_t *first,
129                                 struct xfs_bmap_free *flist, xfs_extlen_t tot);
130 extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp,
131                                 struct xfs_name *name, xfs_ino_t inum,
132                                 xfs_fsblock_t *first,
133                                 struct xfs_bmap_free *flist, xfs_extlen_t tot);
134 extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp,
135                                 struct xfs_name *name, uint resblks);
136
137 /*
138  * Direct call from the bmap code, bypassing the generic directory layer.
139  */
140 extern int xfs_dir2_sf_to_block(struct xfs_da_args *args);
141
142 /*
143  * Interface routines used by userspace utilities
144  */
145 extern int xfs_dir2_isblock(struct xfs_trans *tp, struct xfs_inode *dp, int *r);
146 extern int xfs_dir2_isleaf(struct xfs_trans *tp, struct xfs_inode *dp, int *r);
147 extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
148                                 struct xfs_buf *bp);
149
150 extern void xfs_dir2_data_freescan(struct xfs_inode *dp,
151                 struct xfs_dir2_data_hdr *hdr, int *loghead);
152 extern void xfs_dir2_data_log_entry(struct xfs_trans *tp, struct xfs_inode *dp,
153                 struct xfs_buf *bp, struct xfs_dir2_data_entry *dep);
154 extern void xfs_dir2_data_log_header(struct xfs_trans *tp, struct xfs_inode *dp,
155                 struct xfs_buf *bp);
156 extern void xfs_dir2_data_log_unused(struct xfs_trans *tp, struct xfs_buf *bp,
157                 struct xfs_dir2_data_unused *dup);
158 extern void xfs_dir2_data_make_free(struct xfs_trans *tp, struct xfs_inode *dp,
159                 struct xfs_buf *bp, xfs_dir2_data_aoff_t offset,
160                 xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp);
161 extern void xfs_dir2_data_use_free(struct xfs_trans *tp, struct xfs_inode *dp,
162                 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup,
163                 xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len,
164                 int *needlogp, int *needscanp);
165
166 extern struct xfs_dir2_data_free *xfs_dir2_data_freefind(
167                 struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf,
168                 struct xfs_dir2_data_unused *dup);
169
170 extern const struct xfs_buf_ops xfs_dir3_block_buf_ops;
171 extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops;
172 extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops;
173 extern const struct xfs_buf_ops xfs_dir3_free_buf_ops;
174 extern const struct xfs_buf_ops xfs_dir3_data_buf_ops;
175
176 #endif  /* __XFS_DIR2_H__ */