ocfs2: remove handle argument to ocfs2_start_trans()
[powerpc.git] / fs / ocfs2 / journal.h
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * journal.h
5  *
6  * Defines journalling api and structures.
7  *
8  * Copyright (C) 2003, 2005 Oracle.  All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public
21  * License along with this program; if not, write to the
22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23  * Boston, MA 021110-1307, USA.
24  */
25
26 #ifndef OCFS2_JOURNAL_H
27 #define OCFS2_JOURNAL_H
28
29 #include <linux/fs.h>
30 #include <linux/jbd.h>
31
32 enum ocfs2_journal_state {
33         OCFS2_JOURNAL_FREE = 0,
34         OCFS2_JOURNAL_LOADED,
35         OCFS2_JOURNAL_IN_SHUTDOWN,
36 };
37
38 struct ocfs2_super;
39 struct ocfs2_dinode;
40 struct ocfs2_journal_handle;
41
42 struct ocfs2_journal {
43         enum ocfs2_journal_state   j_state;    /* Journals current state   */
44
45         journal_t                 *j_journal; /* The kernels journal type */
46         struct inode              *j_inode;   /* Kernel inode pointing to
47                                                * this journal             */
48         struct ocfs2_super        *j_osb;     /* pointer to the super
49                                                * block for the node
50                                                * we're currently
51                                                * running on -- not
52                                                * necessarily the super
53                                                * block from the node
54                                                * which we usually run
55                                                * from (recovery,
56                                                * etc)                     */
57         struct buffer_head        *j_bh;      /* Journal disk inode block */
58         atomic_t                  j_num_trans; /* Number of transactions
59                                                 * currently in the system. */
60         unsigned long             j_trans_id;
61         struct rw_semaphore       j_trans_barrier;
62         wait_queue_head_t         j_checkpointed;
63
64         spinlock_t                j_lock;
65         struct list_head          j_la_cleanups;
66         struct work_struct        j_recovery_work;
67 };
68
69 extern spinlock_t trans_inc_lock;
70
71 /* wrap j_trans_id so we never have it equal to zero. */
72 static inline unsigned long ocfs2_inc_trans_id(struct ocfs2_journal *j)
73 {
74         unsigned long old_id;
75         spin_lock(&trans_inc_lock);
76         old_id = j->j_trans_id++;
77         if (unlikely(!j->j_trans_id))
78                 j->j_trans_id = 1;
79         spin_unlock(&trans_inc_lock);
80         return old_id;
81 }
82
83 static inline void ocfs2_set_inode_lock_trans(struct ocfs2_journal *journal,
84                                               struct inode *inode)
85 {
86         spin_lock(&trans_inc_lock);
87         OCFS2_I(inode)->ip_last_trans = journal->j_trans_id;
88         spin_unlock(&trans_inc_lock);
89 }
90
91 /* Used to figure out whether it's safe to drop a metadata lock on an
92  * inode. Returns true if all the inodes changes have been
93  * checkpointed to disk. You should be holding the spinlock on the
94  * metadata lock while calling this to be sure that nobody can take
95  * the lock and put it on another transaction. */
96 static inline int ocfs2_inode_fully_checkpointed(struct inode *inode)
97 {
98         int ret;
99         struct ocfs2_journal *journal = OCFS2_SB(inode->i_sb)->journal;
100
101         spin_lock(&trans_inc_lock);
102         ret = time_after(journal->j_trans_id, OCFS2_I(inode)->ip_last_trans);
103         spin_unlock(&trans_inc_lock);
104         return ret;
105 }
106
107 /* convenience function to check if an inode is still new (has never
108  * hit disk) Will do you a favor and set created_trans = 0 when you've
109  * been checkpointed.  returns '1' if the inode is still new. */
110 static inline int ocfs2_inode_is_new(struct inode *inode)
111 {
112         int ret;
113
114         /* System files are never "new" as they're written out by
115          * mkfs. This helps us early during mount, before we have the
116          * journal open and j_trans_id could be junk. */
117         if (OCFS2_I(inode)->ip_flags & OCFS2_INODE_SYSTEM_FILE)
118                 return 0;
119         spin_lock(&trans_inc_lock);
120         ret = !(time_after(OCFS2_SB(inode->i_sb)->journal->j_trans_id,
121                            OCFS2_I(inode)->ip_created_trans));
122         if (!ret)
123                 OCFS2_I(inode)->ip_created_trans = 0;
124         spin_unlock(&trans_inc_lock);
125         return ret;
126 }
127
128 static inline void ocfs2_inode_set_new(struct ocfs2_super *osb,
129                                        struct inode *inode)
130 {
131         spin_lock(&trans_inc_lock);
132         OCFS2_I(inode)->ip_created_trans = osb->journal->j_trans_id;
133         spin_unlock(&trans_inc_lock);
134 }
135
136 struct ocfs2_journal_handle {
137         handle_t            *k_handle; /* kernel handle.                */
138 };
139
140 /* Exported only for the journal struct init code in super.c. Do not call. */
141 void ocfs2_complete_recovery(void *data);
142
143 /*
144  *  Journal Control:
145  *  Initialize, Load, Shutdown, Wipe a journal.
146  *
147  *  ocfs2_journal_init     - Initialize journal structures in the OSB.
148  *  ocfs2_journal_load     - Load the given journal off disk. Replay it if
149  *                          there's transactions still in there.
150  *  ocfs2_journal_shutdown - Shutdown a journal, this will flush all
151  *                          uncommitted, uncheckpointed transactions.
152  *  ocfs2_journal_wipe     - Wipe transactions from a journal. Optionally
153  *                          zero out each block.
154  *  ocfs2_recovery_thread  - Perform recovery on a node. osb is our own osb.
155  *  ocfs2_mark_dead_nodes - Start recovery on nodes we won't get a heartbeat
156  *                          event on.
157  *  ocfs2_start_checkpoint - Kick the commit thread to do a checkpoint.
158  */
159 void   ocfs2_set_journal_params(struct ocfs2_super *osb);
160 int    ocfs2_journal_init(struct ocfs2_journal *journal,
161                           int *dirty);
162 void   ocfs2_journal_shutdown(struct ocfs2_super *osb);
163 int    ocfs2_journal_wipe(struct ocfs2_journal *journal,
164                           int full);
165 int    ocfs2_journal_load(struct ocfs2_journal *journal);
166 int    ocfs2_check_journals_nolocks(struct ocfs2_super *osb);
167 void   ocfs2_recovery_thread(struct ocfs2_super *osb,
168                              int node_num);
169 int    ocfs2_mark_dead_nodes(struct ocfs2_super *osb);
170 void   ocfs2_complete_mount_recovery(struct ocfs2_super *osb);
171
172 static inline void ocfs2_start_checkpoint(struct ocfs2_super *osb)
173 {
174         atomic_set(&osb->needs_checkpoint, 1);
175         wake_up(&osb->checkpoint_event);
176 }
177
178 static inline void ocfs2_checkpoint_inode(struct inode *inode)
179 {
180         struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
181
182         if (!ocfs2_inode_fully_checkpointed(inode)) {
183                 /* WARNING: This only kicks off a single
184                  * checkpoint. If someone races you and adds more
185                  * metadata to the journal, you won't know, and will
186                  * wind up waiting *alot* longer than necessary. Right
187                  * now we only use this in clear_inode so that's
188                  * OK. */
189                 ocfs2_start_checkpoint(osb);
190
191                 wait_event(osb->journal->j_checkpointed,
192                            ocfs2_inode_fully_checkpointed(inode));
193         }
194 }
195
196 /*
197  *  Transaction Handling:
198  *  Manage the lifetime of a transaction handle.
199  *
200  *  ocfs2_start_trans      - Begin a transaction. Give it an upper estimate of
201  *                          the number of blocks that will be changed during
202  *                          this handle.
203  *  ocfs2_commit_trans     - Complete a handle.
204  *  ocfs2_extend_trans     - Extend a handle by nblocks credits. This may
205  *                          commit the handle to disk in the process, but will
206  *                          not release any locks taken during the transaction.
207  *  ocfs2_journal_access   - Notify the handle that we want to journal this
208  *                          buffer. Will have to call ocfs2_journal_dirty once
209  *                          we've actually dirtied it. Type is one of . or .
210  *  ocfs2_journal_dirty    - Mark a journalled buffer as having dirty data.
211  *  ocfs2_journal_dirty_data - Indicate that a data buffer should go out before
212  *                             the current handle commits.
213  */
214
215 /* You must always start_trans with a number of buffs > 0, but it's
216  * perfectly legal to go through an entire transaction without having
217  * dirtied any buffers. */
218 struct ocfs2_journal_handle *ocfs2_start_trans(struct ocfs2_super *osb,
219                                                int max_buffs);
220 void                         ocfs2_commit_trans(struct ocfs2_super *osb,
221                                                 struct ocfs2_journal_handle *handle);
222 int                          ocfs2_extend_trans(handle_t *handle, int nblocks);
223
224 /*
225  * Create access is for when we get a newly created buffer and we're
226  * not gonna read it off disk, but rather fill it ourselves.  Right
227  * now, we don't do anything special with this (it turns into a write
228  * request), but this is a good placeholder in case we do...
229  *
230  * Write access is for when we read a block off disk and are going to
231  * modify it. This way the journalling layer knows it may need to make
232  * a copy of that block (if it's part of another, uncommitted
233  * transaction) before we do so.
234  */
235 #define OCFS2_JOURNAL_ACCESS_CREATE 0
236 #define OCFS2_JOURNAL_ACCESS_WRITE  1
237 #define OCFS2_JOURNAL_ACCESS_UNDO   2
238
239 int                  ocfs2_journal_access(struct ocfs2_journal_handle *handle,
240                                           struct inode *inode,
241                                           struct buffer_head *bh,
242                                           int type);
243 /*
244  * A word about the journal_access/journal_dirty "dance". It is
245  * entirely legal to journal_access a buffer more than once (as long
246  * as the access type is the same -- I'm not sure what will happen if
247  * access type is different but this should never happen anyway) It is
248  * also legal to journal_dirty a buffer more than once. In fact, you
249  * can even journal_access a buffer after you've done a
250  * journal_access/journal_dirty pair. The only thing you cannot do
251  * however, is journal_dirty a buffer which you haven't yet passed to
252  * journal_access at least once.
253  *
254  * That said, 99% of the time this doesn't matter and this is what the
255  * path looks like:
256  *
257  *      <read a bh>
258  *      ocfs2_journal_access(handle, bh,        OCFS2_JOURNAL_ACCESS_WRITE);
259  *      <modify the bh>
260  *      ocfs2_journal_dirty(handle, bh);
261  */
262 int                  ocfs2_journal_dirty(struct ocfs2_journal_handle *handle,
263                                          struct buffer_head *bh);
264 int                  ocfs2_journal_dirty_data(handle_t *handle,
265                                               struct buffer_head *bh);
266
267 /*
268  *  Credit Macros:
269  *  Convenience macros to calculate number of credits needed.
270  *
271  *  For convenience sake, I have a set of macros here which calculate
272  *  the *maximum* number of sectors which will be changed for various
273  *  metadata updates.
274  */
275
276 /* simple file updates like chmod, etc. */
277 #define OCFS2_INODE_UPDATE_CREDITS 1
278
279 /* get one bit out of a suballocator: dinode + group descriptor +
280  * prev. group desc. if we relink. */
281 #define OCFS2_SUBALLOC_ALLOC (3)
282
283 /* dinode + group descriptor update. We don't relink on free yet. */
284 #define OCFS2_SUBALLOC_FREE  (2)
285
286 #define OCFS2_TRUNCATE_LOG_UPDATE OCFS2_INODE_UPDATE_CREDITS
287 #define OCFS2_TRUNCATE_LOG_FLUSH_ONE_REC (OCFS2_SUBALLOC_FREE                 \
288                                          + OCFS2_TRUNCATE_LOG_UPDATE)
289
290 /* data block for new dir/symlink, 2 for bitmap updates (bitmap fe +
291  * bitmap block for the new bit) */
292 #define OCFS2_DIR_LINK_ADDITIONAL_CREDITS (1 + 2)
293
294 /* parent fe, parent block, new file entry, inode alloc fe, inode alloc
295  * group descriptor + mkdir/symlink blocks */
296 #define OCFS2_MKNOD_CREDITS (3 + OCFS2_SUBALLOC_ALLOC                         \
297                             + OCFS2_DIR_LINK_ADDITIONAL_CREDITS)
298
299 /* local alloc metadata change + main bitmap updates */
300 #define OCFS2_WINDOW_MOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS                 \
301                                   + OCFS2_SUBALLOC_ALLOC + OCFS2_SUBALLOC_FREE)
302
303 /* used when we don't need an allocation change for a dir extend. One
304  * for the dinode, one for the new block. */
305 #define OCFS2_SIMPLE_DIR_EXTEND_CREDITS (2)
306
307 /* file update (nlink, etc) + dir entry block */
308 #define OCFS2_LINK_CREDITS  (OCFS2_INODE_UPDATE_CREDITS + 1)
309
310 /* inode + dir inode (if we unlink a dir), + dir entry block + orphan
311  * dir inode link */
312 #define OCFS2_UNLINK_CREDITS  (2 * OCFS2_INODE_UPDATE_CREDITS + 1             \
313                               + OCFS2_LINK_CREDITS)
314
315 /* dinode + orphan dir dinode + inode alloc dinode + orphan dir entry +
316  * inode alloc group descriptor */
317 #define OCFS2_DELETE_INODE_CREDITS (3 * OCFS2_INODE_UPDATE_CREDITS + 1 + 1)
318
319 /* dinode update, old dir dinode update, new dir dinode update, old
320  * dir dir entry, new dir dir entry, dir entry update for renaming
321  * directory + target unlink */
322 #define OCFS2_RENAME_CREDITS (3 * OCFS2_INODE_UPDATE_CREDITS + 3              \
323                              + OCFS2_UNLINK_CREDITS)
324
325 static inline int ocfs2_calc_extend_credits(struct super_block *sb,
326                                             struct ocfs2_dinode *fe,
327                                             u32 bits_wanted)
328 {
329         int bitmap_blocks, sysfile_bitmap_blocks, dinode_blocks;
330
331         /* bitmap dinode, group desc. + relinked group. */
332         bitmap_blocks = OCFS2_SUBALLOC_ALLOC;
333
334         /* we might need to shift tree depth so lets assume an
335          * absolute worst case of complete fragmentation.  Even with
336          * that, we only need one update for the dinode, and then
337          * however many metadata chunks needed * a remaining suballoc
338          * alloc. */
339         sysfile_bitmap_blocks = 1 +
340                 (OCFS2_SUBALLOC_ALLOC - 1) * ocfs2_extend_meta_needed(fe);
341
342         /* this does not include *new* metadata blocks, which are
343          * accounted for in sysfile_bitmap_blocks. fe +
344          * prev. last_eb_blk + blocks along edge of tree.
345          * calc_symlink_credits passes because we just need 1
346          * credit for the dinode there. */
347         dinode_blocks = 1 + 1 + le16_to_cpu(fe->id2.i_list.l_tree_depth);
348
349         return bitmap_blocks + sysfile_bitmap_blocks + dinode_blocks;
350 }
351
352 static inline int ocfs2_calc_symlink_credits(struct super_block *sb)
353 {
354         int blocks = OCFS2_MKNOD_CREDITS;
355
356         /* links can be longer than one block so we may update many
357          * within our single allocated extent. */
358         blocks += ocfs2_clusters_to_blocks(sb, 1);
359
360         return blocks;
361 }
362
363 static inline int ocfs2_calc_group_alloc_credits(struct super_block *sb,
364                                                  unsigned int cpg)
365 {
366         int blocks;
367         int bitmap_blocks = OCFS2_SUBALLOC_ALLOC + 1;
368         /* parent inode update + new block group header + bitmap inode update
369            + bitmap blocks affected */
370         blocks = 1 + 1 + 1 + bitmap_blocks;
371         return blocks;
372 }
373
374 static inline int ocfs2_calc_tree_trunc_credits(struct super_block *sb,
375                                                 unsigned int clusters_to_del,
376                                                 struct ocfs2_dinode *fe,
377                                                 struct ocfs2_extent_list *last_el)
378 {
379         /* for dinode + all headers in this pass + update to next leaf */
380         u16 next_free = le16_to_cpu(last_el->l_next_free_rec);
381         u16 tree_depth = le16_to_cpu(fe->id2.i_list.l_tree_depth);
382         int credits = 1 + tree_depth + 1;
383         int i;
384
385         i = next_free - 1;
386         BUG_ON(i < 0);
387
388         /* We may be deleting metadata blocks, so metadata alloc dinode +
389            one desc. block for each possible delete. */
390         if (tree_depth && next_free == 1 &&
391             le32_to_cpu(last_el->l_recs[i].e_clusters) == clusters_to_del)
392                 credits += 1 + tree_depth;
393
394         /* update to the truncate log. */
395         credits += OCFS2_TRUNCATE_LOG_UPDATE;
396
397         return credits;
398 }
399
400 #endif /* OCFS2_JOURNAL_H */