2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
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.
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.
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
18 #ifndef __XFS_LOG_PRIV_H__
19 #define __XFS_LOG_PRIV_H__
25 struct xfs_buf_cancel;
29 * Macros, structures, prototypes for internal log manager use.
32 #define XLOG_MIN_ICLOGS 2
33 #define XLOG_MAX_ICLOGS 8
34 #define XLOG_HEADER_MAGIC_NUM 0xFEEDbabe /* Invalid cycle number */
35 #define XLOG_VERSION_1 1
36 #define XLOG_VERSION_2 2 /* Large IClogs, Log sunit */
37 #define XLOG_VERSION_OKBITS (XLOG_VERSION_1 | XLOG_VERSION_2)
38 #define XLOG_MIN_RECORD_BSIZE (16*1024) /* eventually 32k */
39 #define XLOG_BIG_RECORD_BSIZE (32*1024) /* 32k buffers */
40 #define XLOG_MAX_RECORD_BSIZE (256*1024)
41 #define XLOG_HEADER_CYCLE_SIZE (32*1024) /* cycle data in header */
42 #define XLOG_MIN_RECORD_BSHIFT 14 /* 16384 == 1 << 14 */
43 #define XLOG_BIG_RECORD_BSHIFT 15 /* 32k == 1 << 15 */
44 #define XLOG_MAX_RECORD_BSHIFT 18 /* 256k == 1 << 18 */
45 #define XLOG_BTOLSUNIT(log, b) (((b)+(log)->l_mp->m_sb.sb_logsunit-1) / \
46 (log)->l_mp->m_sb.sb_logsunit)
47 #define XLOG_LSUNITTOB(log, su) ((su) * (log)->l_mp->m_sb.sb_logsunit)
49 #define XLOG_HEADER_SIZE 512
51 #define XLOG_REC_SHIFT(log) \
52 BTOBB(1 << (XFS_SB_VERSION_HASLOGV2(&log->l_mp->m_sb) ? \
53 XLOG_MAX_RECORD_BSHIFT : XLOG_BIG_RECORD_BSHIFT))
54 #define XLOG_TOTAL_REC_SHIFT(log) \
55 BTOBB(XLOG_MAX_ICLOGS << (XFS_SB_VERSION_HASLOGV2(&log->l_mp->m_sb) ? \
56 XLOG_MAX_RECORD_BSHIFT : XLOG_BIG_RECORD_BSHIFT))
62 #define ASSIGN_ANY_LSN_HOST(lsn,cycle,block) \
64 (lsn) = ((xfs_lsn_t)(cycle)<<32)|(block); \
66 #define ASSIGN_ANY_LSN_DISK(lsn,cycle,block) \
68 INT_SET(((uint *)&(lsn))[0], ARCH_CONVERT, (cycle)); \
69 INT_SET(((uint *)&(lsn))[1], ARCH_CONVERT, (block)); \
71 #define ASSIGN_LSN(lsn,log) \
72 ASSIGN_ANY_LSN_DISK(lsn,(log)->l_curr_cycle,(log)->l_curr_block);
74 #define XLOG_SET(f,b) (((f) & (b)) == (b))
76 #define GET_CYCLE(ptr, arch) \
77 (INT_GET(*(uint *)(ptr), arch) == XLOG_HEADER_MAGIC_NUM ? \
78 INT_GET(*((uint *)(ptr)+1), arch) : \
79 INT_GET(*(uint *)(ptr), arch) \
82 #define BLK_AVG(blk1, blk2) ((blk1+blk2) >> 1)
88 * get client id from packed copy.
90 * this hack is here because the xlog_pack code copies four bytes
91 * of xlog_op_header containing the fields oh_clientid, oh_flags
92 * and oh_res2 into the packed copy.
94 * later on this four byte chunk is treated as an int and the
95 * client id is pulled out.
97 * this has endian issues, of course.
100 #ifndef XFS_NATIVE_HOST
101 #define GET_CLIENT_ID(i,arch) \
104 #define GET_CLIENT_ID(i,arch) \
108 #define xlog_panic(args...) cmn_err(CE_PANIC, ## args)
109 #define xlog_exit(args...) cmn_err(CE_PANIC, ## args)
110 #define xlog_warn(args...) cmn_err(CE_WARN, ## args)
115 #define XLOG_STATE_ACTIVE 0x0001 /* Current IC log being written to */
116 #define XLOG_STATE_WANT_SYNC 0x0002 /* Want to sync this iclog; no more writes */
117 #define XLOG_STATE_SYNCING 0x0004 /* This IC log is syncing */
118 #define XLOG_STATE_DONE_SYNC 0x0008 /* Done syncing to disk */
119 #define XLOG_STATE_DO_CALLBACK \
120 0x0010 /* Process callback functions */
121 #define XLOG_STATE_CALLBACK 0x0020 /* Callback functions now */
122 #define XLOG_STATE_DIRTY 0x0040 /* Dirty IC log, not ready for ACTIVE status*/
123 #define XLOG_STATE_IOERROR 0x0080 /* IO error happened in sync'ing log */
124 #define XLOG_STATE_ALL 0x7FFF /* All possible valid flags */
125 #define XLOG_STATE_NOTUSED 0x8000 /* This IC log not being used */
126 #endif /* __KERNEL__ */
129 * Flags to log operation header
131 * The first write of a new transaction will be preceded with a start
132 * record, XLOG_START_TRANS. Once a transaction is committed, a commit
133 * record is written, XLOG_COMMIT_TRANS. If a single region can not fit into
134 * the remainder of the current active in-core log, it is split up into
135 * multiple regions. Each partial region will be marked with a
136 * XLOG_CONTINUE_TRANS until the last one, which gets marked with XLOG_END_TRANS.
139 #define XLOG_START_TRANS 0x01 /* Start a new transaction */
140 #define XLOG_COMMIT_TRANS 0x02 /* Commit this transaction */
141 #define XLOG_CONTINUE_TRANS 0x04 /* Cont this trans into new region */
142 #define XLOG_WAS_CONT_TRANS 0x08 /* Cont this trans into new region */
143 #define XLOG_END_TRANS 0x10 /* End a continued transaction */
144 #define XLOG_UNMOUNT_TRANS 0x20 /* Unmount a filesystem transaction */
148 * Flags to log ticket
150 #define XLOG_TIC_INITED 0x1 /* has been initialized */
151 #define XLOG_TIC_PERM_RESERV 0x2 /* permanent reservation */
152 #define XLOG_TIC_IN_Q 0x4
153 #endif /* __KERNEL__ */
155 #define XLOG_UNMOUNT_TYPE 0x556e /* Un for Unmount */
158 * Flags for log structure
160 #define XLOG_CHKSUM_MISMATCH 0x1 /* used only during recovery */
161 #define XLOG_ACTIVE_RECOVERY 0x2 /* in the middle of recovery */
162 #define XLOG_RECOVERY_NEEDED 0x4 /* log was recovered */
163 #define XLOG_IO_ERROR 0x8 /* log hit an I/O error, and being
165 typedef __uint32_t xlog_tid_t;
170 * Below are states for covering allocation transactions.
171 * By covering, we mean changing the h_tail_lsn in the last on-disk
172 * log write such that no allocation transactions will be re-done during
173 * recovery after a system crash. Recovery starts at the last on-disk
176 * These states are used to insert dummy log entries to cover
177 * space allocation transactions which can undo non-transactional changes
178 * after a crash. Writes to a file with space
179 * already allocated do not result in any transactions. Allocations
180 * might include space beyond the EOF. So if we just push the EOF a
181 * little, the last transaction for the file could contain the wrong
182 * size. If there is no file system activity, after an allocation
183 * transaction, and the system crashes, the allocation transaction
184 * will get replayed and the file will be truncated. This could
185 * be hours/days/... after the allocation occurred.
187 * The fix for this is to do two dummy transactions when the
188 * system is idle. We need two dummy transaction because the h_tail_lsn
189 * in the log record header needs to point beyond the last possible
190 * non-dummy transaction. The first dummy changes the h_tail_lsn to
191 * the first transaction before the dummy. The second dummy causes
192 * h_tail_lsn to point to the first dummy. Recovery starts at h_tail_lsn.
194 * These dummy transactions get committed when everything
195 * is idle (after there has been some activity).
197 * There are 5 states used to control this.
199 * IDLE -- no logging has been done on the file system or
200 * we are done covering previous transactions.
201 * NEED -- logging has occurred and we need a dummy transaction
202 * when the log becomes idle.
203 * DONE -- we were in the NEED state and have committed a dummy
205 * NEED2 -- we detected that a dummy transaction has gone to the
206 * on disk log with no other transactions.
207 * DONE2 -- we committed a dummy transaction when in the NEED2 state.
209 * There are two places where we switch states:
211 * 1.) In xfs_sync, when we detect an idle log and are in NEED or NEED2.
212 * We commit the dummy transaction and switch to DONE or DONE2,
213 * respectively. In all other states, we don't do anything.
215 * 2.) When we finish writing the on-disk log (xlog_state_clean_log).
217 * No matter what state we are in, if this isn't the dummy
218 * transaction going out, the next state is NEED.
219 * So, if we aren't in the DONE or DONE2 states, the next state
220 * is NEED. We can't be finishing a write of the dummy record
221 * unless it was committed and the state switched to DONE or DONE2.
223 * If we are in the DONE state and this was a write of the
224 * dummy transaction, we move to NEED2.
226 * If we are in the DONE2 state and this was a write of the
227 * dummy transaction, we move to IDLE.
230 * Writing only one dummy transaction can get appended to
231 * one file space allocation. When this happens, the log recovery
232 * code replays the space allocation and a file could be truncated.
233 * This is why we have the NEED2 and DONE2 states before going idle.
236 #define XLOG_STATE_COVER_IDLE 0
237 #define XLOG_STATE_COVER_NEED 1
238 #define XLOG_STATE_COVER_DONE 2
239 #define XLOG_STATE_COVER_NEED2 3
240 #define XLOG_STATE_COVER_DONE2 4
242 #define XLOG_COVER_OPS 5
245 /* Ticket reservation region accounting */
246 #define XLOG_TIC_LEN_MAX 15
250 * As would be stored in xfs_log_iovec but without the i_addr which
251 * we don't care about.
253 typedef struct xlog_res {
254 uint r_len; /* region length :4 */
255 uint r_type; /* region's transaction type :4 */
258 typedef struct xlog_ticket {
259 sv_t t_sema; /* sleep on this semaphore : 20 */
260 struct xlog_ticket *t_next; /* :4|8 */
261 struct xlog_ticket *t_prev; /* :4|8 */
262 xlog_tid_t t_tid; /* transaction identifier : 4 */
263 int t_curr_res; /* current reservation in bytes : 4 */
264 int t_unit_res; /* unit reservation in bytes : 4 */
265 char t_ocnt; /* original count : 1 */
266 char t_cnt; /* current count : 1 */
267 char t_clientid; /* who does this belong to; : 1 */
268 char t_flags; /* properties of reservation : 1 */
269 uint t_trans_type; /* transaction type : 4 */
271 /* reservation array fields */
272 uint t_res_num; /* num in array : 4 */
273 uint t_res_num_ophdrs; /* num op hdrs : 4 */
274 uint t_res_arr_sum; /* array sum : 4 */
275 uint t_res_o_flow; /* sum overflow : 4 */
276 xlog_res_t t_res_arr[XLOG_TIC_LEN_MAX]; /* array of res : 8 * 15 */
282 typedef struct xlog_op_header {
283 xlog_tid_t oh_tid; /* transaction id of operation : 4 b */
284 int oh_len; /* bytes in data region : 4 b */
285 __uint8_t oh_clientid; /* who sent me this : 1 b */
286 __uint8_t oh_flags; /* : 1 b */
287 ushort oh_res2; /* 32 bit align : 2 b */
291 /* valid values for h_fmt */
292 #define XLOG_FMT_UNKNOWN 0
293 #define XLOG_FMT_LINUX_LE 1
294 #define XLOG_FMT_LINUX_BE 2
295 #define XLOG_FMT_IRIX_BE 3
298 #ifdef XFS_NATIVE_HOST
299 #define XLOG_FMT XLOG_FMT_LINUX_BE
301 #define XLOG_FMT XLOG_FMT_LINUX_LE
304 typedef struct xlog_rec_header {
305 uint h_magicno; /* log record (LR) identifier : 4 */
306 uint h_cycle; /* write cycle of log : 4 */
307 int h_version; /* LR version : 4 */
308 int h_len; /* len in bytes; should be 64-bit aligned: 4 */
309 xfs_lsn_t h_lsn; /* lsn of this LR : 8 */
310 xfs_lsn_t h_tail_lsn; /* lsn of 1st LR w/ buffers not committed: 8 */
311 uint h_chksum; /* may not be used; non-zero if used : 4 */
312 int h_prev_block; /* block number to previous LR : 4 */
313 int h_num_logops; /* number of log operations in this LR : 4 */
314 uint h_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE];
316 int h_fmt; /* format of log record : 4 */
317 uuid_t h_fs_uuid; /* uuid of FS : 16 */
318 int h_size; /* iclog size : 4 */
321 typedef struct xlog_rec_ext_header {
322 uint xh_cycle; /* write cycle of log : 4 */
323 uint xh_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE]; /* : 256 */
324 } xlog_rec_ext_header_t;
328 * - A log record header is 512 bytes. There is plenty of room to grow the
329 * xlog_rec_header_t into the reserved space.
330 * - ic_data follows, so a write to disk can start at the beginning of
332 * - ic_forcesema is used to implement synchronous forcing of the iclog to disk.
333 * - ic_next is the pointer to the next iclog in the ring.
334 * - ic_bp is a pointer to the buffer used to write this incore log to disk.
335 * - ic_log is a pointer back to the global log structure.
336 * - ic_callback is a linked list of callback function/argument pairs to be
337 * called after an iclog finishes writing.
338 * - ic_size is the full size of the header plus data.
339 * - ic_offset is the current number of bytes written to in this iclog.
340 * - ic_refcnt is bumped when someone is writing to the log.
341 * - ic_state is the state of the iclog.
343 typedef struct xlog_iclog_fields {
346 struct xlog_in_core *ic_next;
347 struct xlog_in_core *ic_prev;
348 struct xfs_buf *ic_bp;
350 xfs_log_callback_t *ic_callback;
351 xfs_log_callback_t **ic_callback_tail;
353 struct ktrace *ic_trace;
360 char *ic_datap; /* pointer to iclog data */
361 } xlog_iclog_fields_t;
363 typedef union xlog_in_core2 {
364 xlog_rec_header_t hic_header;
365 xlog_rec_ext_header_t hic_xheader;
366 char hic_sector[XLOG_HEADER_SIZE];
369 typedef struct xlog_in_core {
370 xlog_iclog_fields_t hic_fields;
371 xlog_in_core_2_t *hic_data;
375 * Defines to save our code from this glop.
377 #define ic_forcesema hic_fields.ic_forcesema
378 #define ic_writesema hic_fields.ic_writesema
379 #define ic_next hic_fields.ic_next
380 #define ic_prev hic_fields.ic_prev
381 #define ic_bp hic_fields.ic_bp
382 #define ic_log hic_fields.ic_log
383 #define ic_callback hic_fields.ic_callback
384 #define ic_callback_tail hic_fields.ic_callback_tail
385 #define ic_trace hic_fields.ic_trace
386 #define ic_size hic_fields.ic_size
387 #define ic_offset hic_fields.ic_offset
388 #define ic_refcnt hic_fields.ic_refcnt
389 #define ic_bwritecnt hic_fields.ic_bwritecnt
390 #define ic_state hic_fields.ic_state
391 #define ic_datap hic_fields.ic_datap
392 #define ic_header hic_data->hic_header
395 * The reservation head lsn is not made up of a cycle number and block number.
396 * Instead, it uses a cycle number and byte number. Logs don't expect to
397 * overflow 31 bits worth of byte offset, so using a byte number will mean
398 * that round off problems won't occur when releasing partial reservations.
401 /* The following block of fields are changed while holding icloglock */
402 sema_t l_flushsema; /* iclog flushing semaphore */
403 int l_flushcnt; /* # of procs waiting on this
405 int l_ticket_cnt; /* free ticket count */
406 int l_ticket_tcnt; /* total ticket count */
407 int l_covered_state;/* state of "covering disk
409 xlog_ticket_t *l_freelist; /* free list of tickets */
410 xlog_ticket_t *l_unmount_free;/* kmem_free these addresses */
411 xlog_ticket_t *l_tail; /* free list of tickets */
412 xlog_in_core_t *l_iclog; /* head log queue */
413 spinlock_t l_icloglock; /* grab to change iclog state */
414 xfs_lsn_t l_tail_lsn; /* lsn of 1st LR with unflushed
416 xfs_lsn_t l_last_sync_lsn;/* lsn of last LR on disk */
417 struct xfs_mount *l_mp; /* mount point */
418 struct xfs_buf *l_xbuf; /* extra buffer for log
420 struct xfs_buftarg *l_targ; /* buftarg of log */
421 xfs_daddr_t l_logBBstart; /* start block of log */
422 int l_logsize; /* size of log in bytes */
423 int l_logBBsize; /* size of log in BB chunks */
424 int l_curr_cycle; /* Cycle number of log writes */
425 int l_prev_cycle; /* Cycle number before last
427 int l_curr_block; /* current logical log block */
428 int l_prev_block; /* previous logical log block */
429 int l_iclog_size; /* size of log in bytes */
430 int l_iclog_size_log; /* log power size of log */
431 int l_iclog_bufs; /* number of iclog buffers */
433 /* The following field are used for debugging; need to hold icloglock */
434 char *l_iclog_bak[XLOG_MAX_ICLOGS];
436 /* The following block of fields are changed while holding grant_lock */
437 spinlock_t l_grant_lock;
438 xlog_ticket_t *l_reserve_headq;
439 xlog_ticket_t *l_write_headq;
440 int l_grant_reserve_cycle;
441 int l_grant_reserve_bytes;
442 int l_grant_write_cycle;
443 int l_grant_write_bytes;
445 /* The following fields don't need locking */
447 struct ktrace *l_trace;
448 struct ktrace *l_grant_trace;
451 uint l_quotaoffs_flag; /* XFS_DQ_*, for QUOTAOFFs */
452 struct xfs_buf_cancel **l_buf_cancel_table;
453 int l_iclog_hsize; /* size of iclog header */
454 int l_iclog_heads; /* # of iclog header sectors */
455 uint l_sectbb_log; /* log2 of sector size in BBs */
456 uint l_sectbb_mask; /* sector size (in BBs)
460 #define XLOG_FORCED_SHUTDOWN(log) ((log)->l_flags & XLOG_IO_ERROR)
463 /* common routines */
464 extern xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
465 extern int xlog_find_tail(xlog_t *log,
466 xfs_daddr_t *head_blk,
467 xfs_daddr_t *tail_blk);
468 extern int xlog_recover(xlog_t *log);
469 extern int xlog_recover_finish(xlog_t *log, int mfsi_flags);
470 extern void xlog_pack_data(xlog_t *log, xlog_in_core_t *iclog, int);
471 extern void xlog_recover_process_iunlinks(xlog_t *log);
473 extern struct xfs_buf *xlog_get_bp(xlog_t *, int);
474 extern void xlog_put_bp(struct xfs_buf *);
475 extern int xlog_bread(xlog_t *, xfs_daddr_t, int, struct xfs_buf *);
478 #define XLOG_TRACE_GRAB_FLUSH 1
479 #define XLOG_TRACE_REL_FLUSH 2
480 #define XLOG_TRACE_SLEEP_FLUSH 3
481 #define XLOG_TRACE_WAKE_FLUSH 4
484 * Unmount record type is used as a pseudo transaction type for the ticket.
485 * It's value must be outside the range of XFS_TRANS_* values.
487 #define XLOG_UNMOUNT_REC_TYPE (-1U)
489 #endif /* __KERNEL__ */
491 #endif /* __XFS_LOG_PRIV_H__ */