[XFS] Remove xfs_macros.c, xfs_macros.h, rework headers a whole lot.
[linux-2.6.git] / fs / xfs / xfs_log_priv.h
1 /*
2  * Copyright (c) 2000-2003 Silicon Graphics, Inc.  All Rights Reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of version 2 of the GNU General Public License as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it would be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11  *
12  * Further, this software is distributed without any warranty that it is
13  * free of the rightful claim of any third person regarding infringement
14  * or the like.  Any license provided herein, whether implied or
15  * otherwise, applies only to this software file.  Patent licenses, if
16  * any, provided herein do not apply to combinations of this program with
17  * other software, or any other product whatsoever.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, write the Free Software Foundation, Inc., 59
21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
22  *
23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
24  * Mountain View, CA  94043, or:
25  *
26  * http://www.sgi.com
27  *
28  * For further information regarding this notice, see:
29  *
30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
31  */
32 #ifndef __XFS_LOG_PRIV_H__
33 #define __XFS_LOG_PRIV_H__
34
35 struct xfs_buf;
36 struct ktrace;
37 struct log;
38 struct xlog_ticket;
39 struct xfs_buf_cancel;
40 struct xfs_mount;
41
42 /*
43  * Macros, structures, prototypes for internal log manager use.
44  */
45
46 #define XLOG_MIN_ICLOGS         2
47 #define XLOG_MED_ICLOGS         4
48 #define XLOG_MAX_ICLOGS         8
49 #define XLOG_CALLBACK_SIZE      10
50 #define XLOG_HEADER_MAGIC_NUM   0xFEEDbabe      /* Invalid cycle number */
51 #define XLOG_VERSION_1          1
52 #define XLOG_VERSION_2          2               /* Large IClogs, Log sunit */
53 #define XLOG_VERSION_OKBITS     (XLOG_VERSION_1 | XLOG_VERSION_2)
54 #define XLOG_RECORD_BSIZE       (16*1024)       /* eventually 32k */
55 #define XLOG_BIG_RECORD_BSIZE   (32*1024)       /* 32k buffers */
56 #define XLOG_MAX_RECORD_BSIZE   (256*1024)
57 #define XLOG_HEADER_CYCLE_SIZE  (32*1024)       /* cycle data in header */
58 #define XLOG_RECORD_BSHIFT      14              /* 16384 == 1 << 14 */
59 #define XLOG_BIG_RECORD_BSHIFT  15              /* 32k == 1 << 15 */
60 #define XLOG_MAX_RECORD_BSHIFT  18              /* 256k == 1 << 18 */
61 #define XLOG_BTOLSUNIT(log, b)  (((b)+(log)->l_mp->m_sb.sb_logsunit-1) / \
62                                  (log)->l_mp->m_sb.sb_logsunit)
63 #define XLOG_LSUNITTOB(log, su) ((su) * (log)->l_mp->m_sb.sb_logsunit)
64
65 #define XLOG_HEADER_SIZE        512
66
67 #define XLOG_REC_SHIFT(log) \
68         BTOBB(1 << (XFS_SB_VERSION_HASLOGV2(&log->l_mp->m_sb) ? \
69          XLOG_MAX_RECORD_BSHIFT : XLOG_BIG_RECORD_BSHIFT))
70 #define XLOG_TOTAL_REC_SHIFT(log) \
71         BTOBB(XLOG_MAX_ICLOGS << (XFS_SB_VERSION_HASLOGV2(&log->l_mp->m_sb) ? \
72          XLOG_MAX_RECORD_BSHIFT : XLOG_BIG_RECORD_BSHIFT))
73
74 /*
75  *  set lsns
76  */
77
78 #define ASSIGN_ANY_LSN_HOST(lsn,cycle,block)  \
79     { \
80         (lsn) = ((xfs_lsn_t)(cycle)<<32)|(block); \
81     }
82 #define ASSIGN_ANY_LSN_DISK(lsn,cycle,block)  \
83     { \
84         INT_SET(((uint *)&(lsn))[0], ARCH_CONVERT, (cycle)); \
85         INT_SET(((uint *)&(lsn))[1], ARCH_CONVERT, (block)); \
86     }
87 #define ASSIGN_LSN(lsn,log) \
88     ASSIGN_ANY_LSN_DISK(lsn,(log)->l_curr_cycle,(log)->l_curr_block);
89
90 #define XLOG_SET(f,b)           (((f) & (b)) == (b))
91
92 #define GET_CYCLE(ptr, arch) \
93     (INT_GET(*(uint *)(ptr), arch) == XLOG_HEADER_MAGIC_NUM ? \
94          INT_GET(*((uint *)(ptr)+1), arch) : \
95          INT_GET(*(uint *)(ptr), arch) \
96     )
97
98 #define BLK_AVG(blk1, blk2)     ((blk1+blk2) >> 1)
99
100
101 #ifdef __KERNEL__
102
103 /*
104  * get client id from packed copy.
105  *
106  * this hack is here because the xlog_pack code copies four bytes
107  * of xlog_op_header containing the fields oh_clientid, oh_flags
108  * and oh_res2 into the packed copy.
109  *
110  * later on this four byte chunk is treated as an int and the
111  * client id is pulled out.
112  *
113  * this has endian issues, of course.
114  */
115
116 #ifndef XFS_NATIVE_HOST
117 #define GET_CLIENT_ID(i,arch) \
118     ((i) & 0xff)
119 #else
120 #define GET_CLIENT_ID(i,arch) \
121     ((i) >> 24)
122 #endif
123
124 #define GRANT_LOCK(log)         mutex_spinlock(&(log)->l_grant_lock)
125 #define GRANT_UNLOCK(log, s)    mutex_spinunlock(&(log)->l_grant_lock, s)
126 #define LOG_LOCK(log)           mutex_spinlock(&(log)->l_icloglock)
127 #define LOG_UNLOCK(log, s)      mutex_spinunlock(&(log)->l_icloglock, s)
128
129 #define xlog_panic(args...)     cmn_err(CE_PANIC, ## args)
130 #define xlog_exit(args...)      cmn_err(CE_PANIC, ## args)
131 #define xlog_warn(args...)      cmn_err(CE_WARN, ## args)
132
133 /*
134  * In core log state
135  */
136 #define XLOG_STATE_ACTIVE    0x0001 /* Current IC log being written to */
137 #define XLOG_STATE_WANT_SYNC 0x0002 /* Want to sync this iclog; no more writes */
138 #define XLOG_STATE_SYNCING   0x0004 /* This IC log is syncing */
139 #define XLOG_STATE_DONE_SYNC 0x0008 /* Done syncing to disk */
140 #define XLOG_STATE_DO_CALLBACK \
141                              0x0010 /* Process callback functions */
142 #define XLOG_STATE_CALLBACK  0x0020 /* Callback functions now */
143 #define XLOG_STATE_DIRTY     0x0040 /* Dirty IC log, not ready for ACTIVE status*/
144 #define XLOG_STATE_IOERROR   0x0080 /* IO error happened in sync'ing log */
145 #define XLOG_STATE_ALL       0x7FFF /* All possible valid flags */
146 #define XLOG_STATE_NOTUSED   0x8000 /* This IC log not being used */
147 #endif  /* __KERNEL__ */
148
149 /*
150  * Flags to log operation header
151  *
152  * The first write of a new transaction will be preceded with a start
153  * record, XLOG_START_TRANS.  Once a transaction is committed, a commit
154  * record is written, XLOG_COMMIT_TRANS.  If a single region can not fit into
155  * the remainder of the current active in-core log, it is split up into
156  * multiple regions.  Each partial region will be marked with a
157  * XLOG_CONTINUE_TRANS until the last one, which gets marked with XLOG_END_TRANS.
158  *
159  */
160 #define XLOG_START_TRANS        0x01    /* Start a new transaction */
161 #define XLOG_COMMIT_TRANS       0x02    /* Commit this transaction */
162 #define XLOG_CONTINUE_TRANS     0x04    /* Cont this trans into new region */
163 #define XLOG_WAS_CONT_TRANS     0x08    /* Cont this trans into new region */
164 #define XLOG_END_TRANS          0x10    /* End a continued transaction */
165 #define XLOG_UNMOUNT_TRANS      0x20    /* Unmount a filesystem transaction */
166 #define XLOG_SKIP_TRANS         (XLOG_COMMIT_TRANS | XLOG_CONTINUE_TRANS | \
167                                  XLOG_WAS_CONT_TRANS | XLOG_END_TRANS | \
168                                  XLOG_UNMOUNT_TRANS)
169
170 #ifdef __KERNEL__
171 /*
172  * Flags to log ticket
173  */
174 #define XLOG_TIC_INITED         0x1     /* has been initialized */
175 #define XLOG_TIC_PERM_RESERV    0x2     /* permanent reservation */
176 #define XLOG_TIC_IN_Q           0x4
177 #endif  /* __KERNEL__ */
178
179 #define XLOG_UNMOUNT_TYPE       0x556e  /* Un for Unmount */
180
181 /*
182  * Flags for log structure
183  */
184 #define XLOG_CHKSUM_MISMATCH    0x1     /* used only during recovery */
185 #define XLOG_ACTIVE_RECOVERY    0x2     /* in the middle of recovery */
186 #define XLOG_RECOVERY_NEEDED    0x4     /* log was recovered */
187 #define XLOG_IO_ERROR           0x8     /* log hit an I/O error, and being
188                                            shutdown */
189 typedef __uint32_t xlog_tid_t;
190
191
192 #ifdef __KERNEL__
193 /*
194  * Below are states for covering allocation transactions.
195  * By covering, we mean changing the h_tail_lsn in the last on-disk
196  * log write such that no allocation transactions will be re-done during
197  * recovery after a system crash. Recovery starts at the last on-disk
198  * log write.
199  *
200  * These states are used to insert dummy log entries to cover
201  * space allocation transactions which can undo non-transactional changes
202  * after a crash. Writes to a file with space
203  * already allocated do not result in any transactions. Allocations
204  * might include space beyond the EOF. So if we just push the EOF a
205  * little, the last transaction for the file could contain the wrong
206  * size. If there is no file system activity, after an allocation
207  * transaction, and the system crashes, the allocation transaction
208  * will get replayed and the file will be truncated. This could
209  * be hours/days/... after the allocation occurred.
210  *
211  * The fix for this is to do two dummy transactions when the
212  * system is idle. We need two dummy transaction because the h_tail_lsn
213  * in the log record header needs to point beyond the last possible
214  * non-dummy transaction. The first dummy changes the h_tail_lsn to
215  * the first transaction before the dummy. The second dummy causes
216  * h_tail_lsn to point to the first dummy. Recovery starts at h_tail_lsn.
217  *
218  * These dummy transactions get committed when everything
219  * is idle (after there has been some activity).
220  *
221  * There are 5 states used to control this.
222  *
223  *  IDLE -- no logging has been done on the file system or
224  *              we are done covering previous transactions.
225  *  NEED -- logging has occurred and we need a dummy transaction
226  *              when the log becomes idle.
227  *  DONE -- we were in the NEED state and have committed a dummy
228  *              transaction.
229  *  NEED2 -- we detected that a dummy transaction has gone to the
230  *              on disk log with no other transactions.
231  *  DONE2 -- we committed a dummy transaction when in the NEED2 state.
232  *
233  * There are two places where we switch states:
234  *
235  * 1.) In xfs_sync, when we detect an idle log and are in NEED or NEED2.
236  *      We commit the dummy transaction and switch to DONE or DONE2,
237  *      respectively. In all other states, we don't do anything.
238  *
239  * 2.) When we finish writing the on-disk log (xlog_state_clean_log).
240  *
241  *      No matter what state we are in, if this isn't the dummy
242  *      transaction going out, the next state is NEED.
243  *      So, if we aren't in the DONE or DONE2 states, the next state
244  *      is NEED. We can't be finishing a write of the dummy record
245  *      unless it was committed and the state switched to DONE or DONE2.
246  *
247  *      If we are in the DONE state and this was a write of the
248  *              dummy transaction, we move to NEED2.
249  *
250  *      If we are in the DONE2 state and this was a write of the
251  *              dummy transaction, we move to IDLE.
252  *
253  *
254  * Writing only one dummy transaction can get appended to
255  * one file space allocation. When this happens, the log recovery
256  * code replays the space allocation and a file could be truncated.
257  * This is why we have the NEED2 and DONE2 states before going idle.
258  */
259
260 #define XLOG_STATE_COVER_IDLE   0
261 #define XLOG_STATE_COVER_NEED   1
262 #define XLOG_STATE_COVER_DONE   2
263 #define XLOG_STATE_COVER_NEED2  3
264 #define XLOG_STATE_COVER_DONE2  4
265
266 #define XLOG_COVER_OPS          5
267
268
269 /* Ticket reservation region accounting */ 
270 #if defined(XFS_LOG_RES_DEBUG)
271 #define XLOG_TIC_LEN_MAX        15
272 #define XLOG_TIC_RESET_RES(t) ((t)->t_res_num = \
273                                 (t)->t_res_arr_sum = (t)->t_res_num_ophdrs = 0)
274 #define XLOG_TIC_ADD_OPHDR(t) ((t)->t_res_num_ophdrs++)
275 #define XLOG_TIC_ADD_REGION(t, len, type)                               \
276         do {                                                            \
277                 if ((t)->t_res_num == XLOG_TIC_LEN_MAX) {               \
278                         /* add to overflow and start again */           \
279                         (t)->t_res_o_flow += (t)->t_res_arr_sum;        \
280                         (t)->t_res_num = 0;                             \
281                         (t)->t_res_arr_sum = 0;                         \
282                 }                                                       \
283                 (t)->t_res_arr[(t)->t_res_num].r_len = (len);           \
284                 (t)->t_res_arr[(t)->t_res_num].r_type = (type);         \
285                 (t)->t_res_arr_sum += (len);                            \
286                 (t)->t_res_num++;                                       \
287         } while (0)
288
289 /*
290  * Reservation region
291  * As would be stored in xfs_log_iovec but without the i_addr which
292  * we don't care about.
293  */
294 typedef struct xlog_res {
295         uint    r_len;
296         uint    r_type;
297 } xlog_res_t;
298 #else
299 #define XLOG_TIC_RESET_RES(t)
300 #define XLOG_TIC_ADD_OPHDR(t)
301 #define XLOG_TIC_ADD_REGION(t, len, type)
302 #endif
303
304
305 typedef struct xlog_ticket {
306         sv_t               t_sema;       /* sleep on this semaphore      : 20 */
307         struct xlog_ticket *t_next;      /*                              :4|8 */
308         struct xlog_ticket *t_prev;      /*                              :4|8 */
309         xlog_tid_t         t_tid;        /* transaction identifier       : 4  */
310         int                t_curr_res;   /* current reservation in bytes : 4  */
311         int                t_unit_res;   /* unit reservation in bytes    : 4  */
312         char               t_ocnt;       /* original count               : 1  */
313         char               t_cnt;        /* current count                : 1  */
314         char               t_clientid;   /* who does this belong to;     : 1  */
315         char               t_flags;      /* properties of reservation    : 1  */
316         uint               t_trans_type; /* transaction type             : 4  */
317
318 #if defined (XFS_LOG_RES_DEBUG)
319         /* reservation array fields */
320         uint               t_res_num;                    /* num in array : 4 */
321         xlog_res_t         t_res_arr[XLOG_TIC_LEN_MAX];  /* array of res : X */ 
322         uint               t_res_num_ophdrs;             /* num op hdrs  : 4 */
323         uint               t_res_arr_sum;                /* array sum    : 4 */
324         uint               t_res_o_flow;                 /* sum overflow : 4 */
325 #endif
326 } xlog_ticket_t;
327
328 #endif
329
330
331 typedef struct xlog_op_header {
332         xlog_tid_t oh_tid;      /* transaction id of operation  :  4 b */
333         int        oh_len;      /* bytes in data region         :  4 b */
334         __uint8_t  oh_clientid; /* who sent me this             :  1 b */
335         __uint8_t  oh_flags;    /*                              :  1 b */
336         ushort     oh_res2;     /* 32 bit align                 :  2 b */
337 } xlog_op_header_t;
338
339
340 /* valid values for h_fmt */
341 #define XLOG_FMT_UNKNOWN  0
342 #define XLOG_FMT_LINUX_LE 1
343 #define XLOG_FMT_LINUX_BE 2
344 #define XLOG_FMT_IRIX_BE  3
345
346 /* our fmt */
347 #ifdef XFS_NATIVE_HOST
348 #define XLOG_FMT XLOG_FMT_LINUX_BE
349 #else
350 #define XLOG_FMT XLOG_FMT_LINUX_LE
351 #endif
352
353 typedef struct xlog_rec_header {
354         uint      h_magicno;    /* log record (LR) identifier           :  4 */
355         uint      h_cycle;      /* write cycle of log                   :  4 */
356         int       h_version;    /* LR version                           :  4 */
357         int       h_len;        /* len in bytes; should be 64-bit aligned: 4 */
358         xfs_lsn_t h_lsn;        /* lsn of this LR                       :  8 */
359         xfs_lsn_t h_tail_lsn;   /* lsn of 1st LR w/ buffers not committed: 8 */
360         uint      h_chksum;     /* may not be used; non-zero if used    :  4 */
361         int       h_prev_block; /* block number to previous LR          :  4 */
362         int       h_num_logops; /* number of log operations in this LR  :  4 */
363         uint      h_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE];
364         /* new fields */
365         int       h_fmt;        /* format of log record                 :  4 */
366         uuid_t    h_fs_uuid;    /* uuid of FS                           : 16 */
367         int       h_size;       /* iclog size                           :  4 */
368 } xlog_rec_header_t;
369
370 typedef struct xlog_rec_ext_header {
371         uint      xh_cycle;     /* write cycle of log                   : 4 */
372         uint      xh_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE]; /*    : 256 */
373 } xlog_rec_ext_header_t;
374
375 #ifdef __KERNEL__
376 /*
377  * - A log record header is 512 bytes.  There is plenty of room to grow the
378  *      xlog_rec_header_t into the reserved space.
379  * - ic_data follows, so a write to disk can start at the beginning of
380  *      the iclog.
381  * - ic_forcesema is used to implement synchronous forcing of the iclog to disk.
382  * - ic_next is the pointer to the next iclog in the ring.
383  * - ic_bp is a pointer to the buffer used to write this incore log to disk.
384  * - ic_log is a pointer back to the global log structure.
385  * - ic_callback is a linked list of callback function/argument pairs to be
386  *      called after an iclog finishes writing.
387  * - ic_size is the full size of the header plus data.
388  * - ic_offset is the current number of bytes written to in this iclog.
389  * - ic_refcnt is bumped when someone is writing to the log.
390  * - ic_state is the state of the iclog.
391  */
392 typedef struct xlog_iclog_fields {
393         sv_t                    ic_forcesema;
394         sv_t                    ic_writesema;
395         struct xlog_in_core     *ic_next;
396         struct xlog_in_core     *ic_prev;
397         struct xfs_buf          *ic_bp;
398         struct log              *ic_log;
399         xfs_log_callback_t      *ic_callback;
400         xfs_log_callback_t      **ic_callback_tail;
401 #ifdef XFS_LOG_TRACE
402         struct ktrace           *ic_trace;
403 #endif
404         int                     ic_size;
405         int                     ic_offset;
406         int                     ic_refcnt;
407         int                     ic_bwritecnt;
408         ushort_t                ic_state;
409         char                    *ic_datap;      /* pointer to iclog data */
410 } xlog_iclog_fields_t;
411
412 typedef union xlog_in_core2 {
413         xlog_rec_header_t       hic_header;
414         xlog_rec_ext_header_t   hic_xheader;
415         char                    hic_sector[XLOG_HEADER_SIZE];
416 } xlog_in_core_2_t;
417
418 typedef struct xlog_in_core {
419         xlog_iclog_fields_t     hic_fields;
420         xlog_in_core_2_t        *hic_data;
421 } xlog_in_core_t;
422
423 /*
424  * Defines to save our code from this glop.
425  */
426 #define ic_forcesema    hic_fields.ic_forcesema
427 #define ic_writesema    hic_fields.ic_writesema
428 #define ic_next         hic_fields.ic_next
429 #define ic_prev         hic_fields.ic_prev
430 #define ic_bp           hic_fields.ic_bp
431 #define ic_log          hic_fields.ic_log
432 #define ic_callback     hic_fields.ic_callback
433 #define ic_callback_tail hic_fields.ic_callback_tail
434 #define ic_trace        hic_fields.ic_trace
435 #define ic_size         hic_fields.ic_size
436 #define ic_offset       hic_fields.ic_offset
437 #define ic_refcnt       hic_fields.ic_refcnt
438 #define ic_bwritecnt    hic_fields.ic_bwritecnt
439 #define ic_state        hic_fields.ic_state
440 #define ic_datap        hic_fields.ic_datap
441 #define ic_header       hic_data->hic_header
442
443 /*
444  * The reservation head lsn is not made up of a cycle number and block number.
445  * Instead, it uses a cycle number and byte number.  Logs don't expect to
446  * overflow 31 bits worth of byte offset, so using a byte number will mean
447  * that round off problems won't occur when releasing partial reservations.
448  */
449 typedef struct log {
450         /* The following block of fields are changed while holding icloglock */
451         sema_t                  l_flushsema;    /* iclog flushing semaphore */
452         int                     l_flushcnt;     /* # of procs waiting on this
453                                                  * sema */
454         int                     l_ticket_cnt;   /* free ticket count */
455         int                     l_ticket_tcnt;  /* total ticket count */
456         int                     l_covered_state;/* state of "covering disk
457                                                  * log entries" */
458         xlog_ticket_t           *l_freelist;    /* free list of tickets */
459         xlog_ticket_t           *l_unmount_free;/* kmem_free these addresses */
460         xlog_ticket_t           *l_tail;        /* free list of tickets */
461         xlog_in_core_t          *l_iclog;       /* head log queue       */
462         lock_t                  l_icloglock;    /* grab to change iclog state */
463         xfs_lsn_t               l_tail_lsn;     /* lsn of 1st LR with unflushed
464                                                  * buffers */
465         xfs_lsn_t               l_last_sync_lsn;/* lsn of last LR on disk */
466         struct xfs_mount        *l_mp;          /* mount point */
467         struct xfs_buf          *l_xbuf;        /* extra buffer for log
468                                                  * wrapping */
469         struct xfs_buftarg      *l_targ;        /* buftarg of log */
470         xfs_daddr_t             l_logBBstart;   /* start block of log */
471         int                     l_logsize;      /* size of log in bytes */
472         int                     l_logBBsize;    /* size of log in BB chunks */
473         int                     l_curr_cycle;   /* Cycle number of log writes */
474         int                     l_prev_cycle;   /* Cycle number before last
475                                                  * block increment */
476         int                     l_curr_block;   /* current logical log block */
477         int                     l_prev_block;   /* previous logical log block */
478         int                     l_iclog_size;   /* size of log in bytes */
479         int                     l_iclog_size_log; /* log power size of log */
480         int                     l_iclog_bufs;   /* number of iclog buffers */
481
482         /* The following field are used for debugging; need to hold icloglock */
483         char                    *l_iclog_bak[XLOG_MAX_ICLOGS];
484
485         /* The following block of fields are changed while holding grant_lock */
486         lock_t                  l_grant_lock;
487         xlog_ticket_t           *l_reserve_headq;
488         xlog_ticket_t           *l_write_headq;
489         int                     l_grant_reserve_cycle;
490         int                     l_grant_reserve_bytes;
491         int                     l_grant_write_cycle;
492         int                     l_grant_write_bytes;
493
494         /* The following fields don't need locking */
495 #ifdef XFS_LOG_TRACE
496         struct ktrace           *l_trace;
497         struct ktrace           *l_grant_trace;
498 #endif
499         uint                    l_flags;
500         uint                    l_quotaoffs_flag; /* XFS_DQ_*, for QUOTAOFFs */
501         struct xfs_buf_cancel   **l_buf_cancel_table;
502         int                     l_iclog_hsize;  /* size of iclog header */
503         int                     l_iclog_heads;  /* # of iclog header sectors */
504         uint                    l_sectbb_log;   /* log2 of sector size in BBs */
505         uint                    l_sectbb_mask;  /* sector size (in BBs)
506                                                  * alignment mask */
507 } xlog_t;
508
509 #define XLOG_GRANT_SUB_SPACE(log,bytes,type)    \
510         xlog_grant_sub_space(log,bytes,type)
511 static inline void xlog_grant_sub_space(struct log *log, int bytes, int type)
512 {
513         if (type == 'w') {                                              \
514                 (log)->l_grant_write_bytes -= (bytes);                  \
515                 if ((log)->l_grant_write_bytes < 0) {                   \
516                         (log)->l_grant_write_bytes += (log)->l_logsize; \
517                         (log)->l_grant_write_cycle--;                   \
518                 }                                                       \
519         } else {                                                        \
520                 (log)->l_grant_reserve_bytes -= (bytes);                \
521                 if ((log)->l_grant_reserve_bytes < 0) {                 \
522                         (log)->l_grant_reserve_bytes += (log)->l_logsize;\
523                         (log)->l_grant_reserve_cycle--;                 \
524                 }                                                       \
525          }                                                              \
526 }
527
528 #define XLOG_GRANT_ADD_SPACE(log,bytes,type)    \
529         xlog_grant_add_space(log,bytes,type)
530 static inline void
531 xlog_grant_add_space(struct log *log, int bytes, int type)
532 {
533         if (type == 'w') {                                              \
534                 (log)->l_grant_write_bytes += (bytes);                  \
535                 if ((log)->l_grant_write_bytes > (log)->l_logsize) {    \
536                         (log)->l_grant_write_bytes -= (log)->l_logsize; \
537                         (log)->l_grant_write_cycle++;                   \
538                 }                                                       \
539         } else {                                                        \
540                 (log)->l_grant_reserve_bytes += (bytes);                \
541                 if ((log)->l_grant_reserve_bytes > (log)->l_logsize) {  \
542                         (log)->l_grant_reserve_bytes -= (log)->l_logsize;\
543                         (log)->l_grant_reserve_cycle++;                 \
544                 }                                                       \
545          }                                                              \
546 }
547
548 #define XLOG_INS_TICKETQ(q, tic)        xlog_ins_ticketq(q, tic)
549 static inline void
550 xlog_ins_ticketq(struct xlog_ticket *q, struct xlog_ticket *tic)
551 {                                                       \
552         if (q) {                                        \
553                 (tic)->t_next       = (q);              \
554                 (tic)->t_prev       = (q)->t_prev;      \
555                 (q)->t_prev->t_next = (tic);            \
556                 (q)->t_prev         = (tic);            \
557         } else {                                        \
558                 (tic)->t_prev = (tic)->t_next = (tic);  \
559                 (q) = (tic);                            \
560         }                                               \
561         (tic)->t_flags |= XLOG_TIC_IN_Q;                \
562 }
563
564 #define XLOG_DEL_TICKETQ(q, tic)        xlog_del_ticketq(q, tic)
565 static inline void
566 xlog_del_ticketq(struct xlog_ticket *q, struct xlog_ticket *tic)
567 {                                                       \
568         if ((tic) == (tic)->t_next) {                   \
569                 (q) = NULL;                             \
570         } else {                                        \
571                 (q) = (tic)->t_next;                    \
572                 (tic)->t_next->t_prev = (tic)->t_prev;  \
573                 (tic)->t_prev->t_next = (tic)->t_next;  \
574         }                                               \
575         (tic)->t_next = (tic)->t_prev = NULL;           \
576         (tic)->t_flags &= ~XLOG_TIC_IN_Q;               \
577 }
578
579 /* common routines */
580 extern xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
581 extern int       xlog_find_tail(xlog_t  *log,
582                                 xfs_daddr_t *head_blk,
583                                 xfs_daddr_t *tail_blk,
584                                 int readonly);
585 extern int       xlog_recover(xlog_t *log, int readonly);
586 extern int       xlog_recover_finish(xlog_t *log, int mfsi_flags);
587 extern void      xlog_pack_data(xlog_t *log, xlog_in_core_t *iclog, int);
588 extern void      xlog_recover_process_iunlinks(xlog_t *log);
589
590 extern struct xfs_buf *xlog_get_bp(xlog_t *, int);
591 extern void      xlog_put_bp(struct xfs_buf *);
592 extern int       xlog_bread(xlog_t *, xfs_daddr_t, int, struct xfs_buf *);
593
594 /* iclog tracing */
595 #define XLOG_TRACE_GRAB_FLUSH  1
596 #define XLOG_TRACE_REL_FLUSH   2
597 #define XLOG_TRACE_SLEEP_FLUSH 3
598 #define XLOG_TRACE_WAKE_FLUSH  4
599
600 #endif  /* __KERNEL__ */
601
602 #endif  /* __XFS_LOG_PRIV_H__ */