blob: a5b3c021a40600af5e70f823db6d5bd7332a3226 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2003,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_LOG_PRIV_H__
19#define __XFS_LOG_PRIV_H__
20
21struct xfs_buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -070022struct log;
Nathan Scotta844f452005-11-02 14:38:42 +110023struct xlog_ticket;
Linus Torvalds1da177e2005-04-16 15:20:36 -070024struct xfs_mount;
25
26/*
27 * Macros, structures, prototypes for internal log manager use.
28 */
29
30#define XLOG_MIN_ICLOGS 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#define XLOG_MAX_ICLOGS 8
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#define XLOG_HEADER_MAGIC_NUM 0xFEEDbabe /* Invalid cycle number */
33#define XLOG_VERSION_1 1
34#define XLOG_VERSION_2 2 /* Large IClogs, Log sunit */
35#define XLOG_VERSION_OKBITS (XLOG_VERSION_1 | XLOG_VERSION_2)
Eric Sandeendcb3b832007-08-16 16:25:33 +100036#define XLOG_MIN_RECORD_BSIZE (16*1024) /* eventually 32k */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#define XLOG_BIG_RECORD_BSIZE (32*1024) /* 32k buffers */
38#define XLOG_MAX_RECORD_BSIZE (256*1024)
39#define XLOG_HEADER_CYCLE_SIZE (32*1024) /* cycle data in header */
Eric Sandeendcb3b832007-08-16 16:25:33 +100040#define XLOG_MIN_RECORD_BSHIFT 14 /* 16384 == 1 << 14 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#define XLOG_BIG_RECORD_BSHIFT 15 /* 32k == 1 << 15 */
42#define XLOG_MAX_RECORD_BSHIFT 18 /* 256k == 1 << 18 */
43#define XLOG_BTOLSUNIT(log, b) (((b)+(log)->l_mp->m_sb.sb_logsunit-1) / \
44 (log)->l_mp->m_sb.sb_logsunit)
45#define XLOG_LSUNITTOB(log, su) ((su) * (log)->l_mp->m_sb.sb_logsunit)
46
47#define XLOG_HEADER_SIZE 512
48
49#define XLOG_REC_SHIFT(log) \
Eric Sandeen62118702008-03-06 13:44:28 +110050 BTOBB(1 << (xfs_sb_version_haslogv2(&log->l_mp->m_sb) ? \
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 XLOG_MAX_RECORD_BSHIFT : XLOG_BIG_RECORD_BSHIFT))
52#define XLOG_TOTAL_REC_SHIFT(log) \
Eric Sandeen62118702008-03-06 13:44:28 +110053 BTOBB(XLOG_MAX_ICLOGS << (xfs_sb_version_haslogv2(&log->l_mp->m_sb) ? \
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 XLOG_MAX_RECORD_BSHIFT : XLOG_BIG_RECORD_BSHIFT))
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Christoph Hellwig03bea6f2007-10-12 10:58:05 +100057static inline xfs_lsn_t xlog_assign_lsn(uint cycle, uint block)
58{
59 return ((xfs_lsn_t)cycle << 32) | block;
60}
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Christoph Hellwig03bea6f2007-10-12 10:58:05 +100062static inline uint xlog_get_cycle(char *ptr)
63{
Christoph Hellwigb53e6752007-10-12 10:59:34 +100064 if (be32_to_cpu(*(__be32 *)ptr) == XLOG_HEADER_MAGIC_NUM)
65 return be32_to_cpu(*((__be32 *)ptr + 1));
Christoph Hellwig03bea6f2007-10-12 10:58:05 +100066 else
Christoph Hellwigb53e6752007-10-12 10:59:34 +100067 return be32_to_cpu(*(__be32 *)ptr);
Christoph Hellwig03bea6f2007-10-12 10:58:05 +100068}
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70#define BLK_AVG(blk1, blk2) ((blk1+blk2) >> 1)
71
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#ifdef __KERNEL__
73
74/*
75 * get client id from packed copy.
76 *
77 * this hack is here because the xlog_pack code copies four bytes
78 * of xlog_op_header containing the fields oh_clientid, oh_flags
79 * and oh_res2 into the packed copy.
80 *
81 * later on this four byte chunk is treated as an int and the
82 * client id is pulled out.
83 *
84 * this has endian issues, of course.
85 */
Christoph Hellwigb53e6752007-10-12 10:59:34 +100086static inline uint xlog_get_client_id(__be32 i)
Christoph Hellwig03bea6f2007-10-12 10:58:05 +100087{
Christoph Hellwigb53e6752007-10-12 10:59:34 +100088 return be32_to_cpu(i) >> 24;
Christoph Hellwig03bea6f2007-10-12 10:58:05 +100089}
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#define xlog_panic(args...) cmn_err(CE_PANIC, ## args)
92#define xlog_exit(args...) cmn_err(CE_PANIC, ## args)
93#define xlog_warn(args...) cmn_err(CE_WARN, ## args)
94
95/*
96 * In core log state
97 */
98#define XLOG_STATE_ACTIVE 0x0001 /* Current IC log being written to */
99#define XLOG_STATE_WANT_SYNC 0x0002 /* Want to sync this iclog; no more writes */
100#define XLOG_STATE_SYNCING 0x0004 /* This IC log is syncing */
101#define XLOG_STATE_DONE_SYNC 0x0008 /* Done syncing to disk */
102#define XLOG_STATE_DO_CALLBACK \
103 0x0010 /* Process callback functions */
104#define XLOG_STATE_CALLBACK 0x0020 /* Callback functions now */
105#define XLOG_STATE_DIRTY 0x0040 /* Dirty IC log, not ready for ACTIVE status*/
106#define XLOG_STATE_IOERROR 0x0080 /* IO error happened in sync'ing log */
107#define XLOG_STATE_ALL 0x7FFF /* All possible valid flags */
108#define XLOG_STATE_NOTUSED 0x8000 /* This IC log not being used */
109#endif /* __KERNEL__ */
110
111/*
112 * Flags to log operation header
113 *
114 * The first write of a new transaction will be preceded with a start
115 * record, XLOG_START_TRANS. Once a transaction is committed, a commit
116 * record is written, XLOG_COMMIT_TRANS. If a single region can not fit into
117 * the remainder of the current active in-core log, it is split up into
118 * multiple regions. Each partial region will be marked with a
119 * XLOG_CONTINUE_TRANS until the last one, which gets marked with XLOG_END_TRANS.
120 *
121 */
122#define XLOG_START_TRANS 0x01 /* Start a new transaction */
123#define XLOG_COMMIT_TRANS 0x02 /* Commit this transaction */
124#define XLOG_CONTINUE_TRANS 0x04 /* Cont this trans into new region */
125#define XLOG_WAS_CONT_TRANS 0x08 /* Cont this trans into new region */
126#define XLOG_END_TRANS 0x10 /* End a continued transaction */
127#define XLOG_UNMOUNT_TRANS 0x20 /* Unmount a filesystem transaction */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129#ifdef __KERNEL__
130/*
131 * Flags to log ticket
132 */
133#define XLOG_TIC_INITED 0x1 /* has been initialized */
134#define XLOG_TIC_PERM_RESERV 0x2 /* permanent reservation */
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000135
136#define XLOG_TIC_FLAGS \
137 { XLOG_TIC_INITED, "XLOG_TIC_INITED" }, \
Dave Chinner10547942010-12-21 12:02:25 +1100138 { XLOG_TIC_PERM_RESERV, "XLOG_TIC_PERM_RESERV" }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140#endif /* __KERNEL__ */
141
142#define XLOG_UNMOUNT_TYPE 0x556e /* Un for Unmount */
143
144/*
145 * Flags for log structure
146 */
147#define XLOG_CHKSUM_MISMATCH 0x1 /* used only during recovery */
148#define XLOG_ACTIVE_RECOVERY 0x2 /* in the middle of recovery */
149#define XLOG_RECOVERY_NEEDED 0x4 /* log was recovered */
150#define XLOG_IO_ERROR 0x8 /* log hit an I/O error, and being
151 shutdown */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153#ifdef __KERNEL__
154/*
155 * Below are states for covering allocation transactions.
156 * By covering, we mean changing the h_tail_lsn in the last on-disk
157 * log write such that no allocation transactions will be re-done during
158 * recovery after a system crash. Recovery starts at the last on-disk
159 * log write.
160 *
161 * These states are used to insert dummy log entries to cover
162 * space allocation transactions which can undo non-transactional changes
163 * after a crash. Writes to a file with space
164 * already allocated do not result in any transactions. Allocations
165 * might include space beyond the EOF. So if we just push the EOF a
166 * little, the last transaction for the file could contain the wrong
167 * size. If there is no file system activity, after an allocation
168 * transaction, and the system crashes, the allocation transaction
169 * will get replayed and the file will be truncated. This could
170 * be hours/days/... after the allocation occurred.
171 *
172 * The fix for this is to do two dummy transactions when the
173 * system is idle. We need two dummy transaction because the h_tail_lsn
174 * in the log record header needs to point beyond the last possible
175 * non-dummy transaction. The first dummy changes the h_tail_lsn to
176 * the first transaction before the dummy. The second dummy causes
177 * h_tail_lsn to point to the first dummy. Recovery starts at h_tail_lsn.
178 *
179 * These dummy transactions get committed when everything
180 * is idle (after there has been some activity).
181 *
182 * There are 5 states used to control this.
183 *
184 * IDLE -- no logging has been done on the file system or
185 * we are done covering previous transactions.
186 * NEED -- logging has occurred and we need a dummy transaction
187 * when the log becomes idle.
188 * DONE -- we were in the NEED state and have committed a dummy
189 * transaction.
190 * NEED2 -- we detected that a dummy transaction has gone to the
191 * on disk log with no other transactions.
192 * DONE2 -- we committed a dummy transaction when in the NEED2 state.
193 *
194 * There are two places where we switch states:
195 *
196 * 1.) In xfs_sync, when we detect an idle log and are in NEED or NEED2.
197 * We commit the dummy transaction and switch to DONE or DONE2,
198 * respectively. In all other states, we don't do anything.
199 *
200 * 2.) When we finish writing the on-disk log (xlog_state_clean_log).
201 *
202 * No matter what state we are in, if this isn't the dummy
203 * transaction going out, the next state is NEED.
204 * So, if we aren't in the DONE or DONE2 states, the next state
205 * is NEED. We can't be finishing a write of the dummy record
206 * unless it was committed and the state switched to DONE or DONE2.
207 *
208 * If we are in the DONE state and this was a write of the
209 * dummy transaction, we move to NEED2.
210 *
211 * If we are in the DONE2 state and this was a write of the
212 * dummy transaction, we move to IDLE.
213 *
214 *
215 * Writing only one dummy transaction can get appended to
216 * one file space allocation. When this happens, the log recovery
217 * code replays the space allocation and a file could be truncated.
218 * This is why we have the NEED2 and DONE2 states before going idle.
219 */
220
221#define XLOG_STATE_COVER_IDLE 0
222#define XLOG_STATE_COVER_NEED 1
223#define XLOG_STATE_COVER_DONE 2
224#define XLOG_STATE_COVER_NEED2 3
225#define XLOG_STATE_COVER_DONE2 4
226
227#define XLOG_COVER_OPS 5
228
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000229
230/* Ticket reservation region accounting */
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000231#define XLOG_TIC_LEN_MAX 15
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000232
233/*
234 * Reservation region
235 * As would be stored in xfs_log_iovec but without the i_addr which
236 * we don't care about.
237 */
238typedef struct xlog_res {
Tim Shimmin12598452006-01-11 21:02:47 +1100239 uint r_len; /* region length :4 */
240 uint r_type; /* region's transaction type :4 */
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000241} xlog_res_t;
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243typedef struct xlog_ticket {
David Chinner12017fa2008-08-13 16:34:31 +1000244 sv_t t_wait; /* ticket wait queue : 20 */
Dave Chinner10547942010-12-21 12:02:25 +1100245 struct list_head t_queue; /* reserve/write queue */
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000246 xlog_tid_t t_tid; /* transaction identifier : 4 */
Dave Chinnercc09c0d2008-11-17 17:37:10 +1100247 atomic_t t_ref; /* ticket reference count : 4 */
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000248 int t_curr_res; /* current reservation in bytes : 4 */
249 int t_unit_res; /* unit reservation in bytes : 4 */
250 char t_ocnt; /* original count : 1 */
251 char t_cnt; /* current count : 1 */
252 char t_clientid; /* who does this belong to; : 1 */
253 char t_flags; /* properties of reservation : 1 */
254 uint t_trans_type; /* transaction type : 4 */
255
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000256 /* reservation array fields */
257 uint t_res_num; /* num in array : 4 */
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000258 uint t_res_num_ophdrs; /* num op hdrs : 4 */
259 uint t_res_arr_sum; /* array sum : 4 */
260 uint t_res_o_flow; /* sum overflow : 4 */
Tim Shimmin12598452006-01-11 21:02:47 +1100261 xlog_res_t t_res_arr[XLOG_TIC_LEN_MAX]; /* array of res : 8 * 15 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262} xlog_ticket_t;
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264#endif
265
266
267typedef struct xlog_op_header {
Christoph Hellwig67fcb7b2007-10-12 10:58:59 +1000268 __be32 oh_tid; /* transaction id of operation : 4 b */
269 __be32 oh_len; /* bytes in data region : 4 b */
270 __u8 oh_clientid; /* who sent me this : 1 b */
271 __u8 oh_flags; /* : 1 b */
272 __u16 oh_res2; /* 32 bit align : 2 b */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273} xlog_op_header_t;
274
275
276/* valid values for h_fmt */
277#define XLOG_FMT_UNKNOWN 0
278#define XLOG_FMT_LINUX_LE 1
279#define XLOG_FMT_LINUX_BE 2
280#define XLOG_FMT_IRIX_BE 3
281
282/* our fmt */
Nathan Scottf016bad2005-09-08 15:30:05 +1000283#ifdef XFS_NATIVE_HOST
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284#define XLOG_FMT XLOG_FMT_LINUX_BE
285#else
Nathan Scottf016bad2005-09-08 15:30:05 +1000286#define XLOG_FMT XLOG_FMT_LINUX_LE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287#endif
288
289typedef struct xlog_rec_header {
Christoph Hellwigb53e6752007-10-12 10:59:34 +1000290 __be32 h_magicno; /* log record (LR) identifier : 4 */
291 __be32 h_cycle; /* write cycle of log : 4 */
292 __be32 h_version; /* LR version : 4 */
293 __be32 h_len; /* len in bytes; should be 64-bit aligned: 4 */
294 __be64 h_lsn; /* lsn of this LR : 8 */
295 __be64 h_tail_lsn; /* lsn of 1st LR w/ buffers not committed: 8 */
296 __be32 h_chksum; /* may not be used; non-zero if used : 4 */
297 __be32 h_prev_block; /* block number to previous LR : 4 */
298 __be32 h_num_logops; /* number of log operations in this LR : 4 */
299 __be32 h_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 /* new fields */
Christoph Hellwigb53e6752007-10-12 10:59:34 +1000301 __be32 h_fmt; /* format of log record : 4 */
302 uuid_t h_fs_uuid; /* uuid of FS : 16 */
303 __be32 h_size; /* iclog size : 4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304} xlog_rec_header_t;
305
306typedef struct xlog_rec_ext_header {
Christoph Hellwigb53e6752007-10-12 10:59:34 +1000307 __be32 xh_cycle; /* write cycle of log : 4 */
308 __be32 xh_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE]; /* : 256 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309} xlog_rec_ext_header_t;
310
311#ifdef __KERNEL__
Christoph Hellwigb28708d2008-11-28 14:23:38 +1100312
313/*
314 * Quite misnamed, because this union lays out the actual on-disk log buffer.
315 */
316typedef union xlog_in_core2 {
317 xlog_rec_header_t hic_header;
318 xlog_rec_ext_header_t hic_xheader;
319 char hic_sector[XLOG_HEADER_SIZE];
320} xlog_in_core_2_t;
321
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322/*
323 * - A log record header is 512 bytes. There is plenty of room to grow the
324 * xlog_rec_header_t into the reserved space.
325 * - ic_data follows, so a write to disk can start at the beginning of
326 * the iclog.
David Chinner12017fa2008-08-13 16:34:31 +1000327 * - ic_forcewait is used to implement synchronous forcing of the iclog to disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 * - ic_next is the pointer to the next iclog in the ring.
329 * - ic_bp is a pointer to the buffer used to write this incore log to disk.
330 * - ic_log is a pointer back to the global log structure.
331 * - ic_callback is a linked list of callback function/argument pairs to be
332 * called after an iclog finishes writing.
333 * - ic_size is the full size of the header plus data.
334 * - ic_offset is the current number of bytes written to in this iclog.
335 * - ic_refcnt is bumped when someone is writing to the log.
336 * - ic_state is the state of the iclog.
David Chinner114d23a2008-04-10 12:18:39 +1000337 *
338 * Because of cacheline contention on large machines, we need to separate
339 * various resources onto different cachelines. To start with, make the
340 * structure cacheline aligned. The following fields can be contended on
341 * by independent processes:
342 *
343 * - ic_callback_*
344 * - ic_refcnt
345 * - fields protected by the global l_icloglock
346 *
347 * so we need to ensure that these fields are located in separate cachelines.
348 * We'll put all the read-only and l_icloglock fields in the first cacheline,
349 * and move everything else out to subsequent cachelines.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 */
Christoph Hellwigb28708d2008-11-28 14:23:38 +1100351typedef struct xlog_in_core {
David Chinner12017fa2008-08-13 16:34:31 +1000352 sv_t ic_force_wait;
353 sv_t ic_write_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 struct xlog_in_core *ic_next;
355 struct xlog_in_core *ic_prev;
356 struct xfs_buf *ic_bp;
357 struct log *ic_log;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 int ic_size;
359 int ic_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 int ic_bwritecnt;
Christoph Hellwiga5687782009-02-09 08:37:39 +0100361 unsigned short ic_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 char *ic_datap; /* pointer to iclog data */
David Chinner114d23a2008-04-10 12:18:39 +1000363
364 /* Callback structures need their own cacheline */
365 spinlock_t ic_callback_lock ____cacheline_aligned_in_smp;
366 xfs_log_callback_t *ic_callback;
367 xfs_log_callback_t **ic_callback_tail;
368
369 /* reference counts need their own cacheline */
370 atomic_t ic_refcnt ____cacheline_aligned_in_smp;
Christoph Hellwigb28708d2008-11-28 14:23:38 +1100371 xlog_in_core_2_t *ic_data;
372#define ic_header ic_data->hic_header
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373} xlog_in_core_t;
374
375/*
Dave Chinner71e330b2010-05-21 14:37:18 +1000376 * The CIL context is used to aggregate per-transaction details as well be
377 * passed to the iclog for checkpoint post-commit processing. After being
378 * passed to the iclog, another context needs to be allocated for tracking the
379 * next set of transactions to be aggregated into a checkpoint.
380 */
381struct xfs_cil;
382
383struct xfs_cil_ctx {
384 struct xfs_cil *cil;
385 xfs_lsn_t sequence; /* chkpt sequence # */
386 xfs_lsn_t start_lsn; /* first LSN of chkpt commit */
387 xfs_lsn_t commit_lsn; /* chkpt commit record lsn */
388 struct xlog_ticket *ticket; /* chkpt ticket */
389 int nvecs; /* number of regions */
390 int space_used; /* aggregate size of regions */
391 struct list_head busy_extents; /* busy extents in chkpt */
392 struct xfs_log_vec *lv_chain; /* logvecs being pushed */
393 xfs_log_callback_t log_cb; /* completion callback hook. */
394 struct list_head committing; /* ctx committing list */
395};
396
397/*
398 * Committed Item List structure
399 *
400 * This structure is used to track log items that have been committed but not
401 * yet written into the log. It is used only when the delayed logging mount
402 * option is enabled.
403 *
404 * This structure tracks the list of committing checkpoint contexts so
405 * we can avoid the problem of having to hold out new transactions during a
406 * flush until we have a the commit record LSN of the checkpoint. We can
407 * traverse the list of committing contexts in xlog_cil_push_lsn() to find a
408 * sequence match and extract the commit LSN directly from there. If the
409 * checkpoint is still in the process of committing, we can block waiting for
410 * the commit LSN to be determined as well. This should make synchronous
411 * operations almost as efficient as the old logging methods.
412 */
413struct xfs_cil {
414 struct log *xc_log;
415 struct list_head xc_cil;
416 spinlock_t xc_cil_lock;
417 struct xfs_cil_ctx *xc_ctx;
418 struct rw_semaphore xc_ctx_lock;
419 struct list_head xc_committing;
420 sv_t xc_commit_wait;
Dave Chinnera44f13e2010-08-24 11:40:03 +1000421 xfs_lsn_t xc_current_sequence;
Dave Chinner71e330b2010-05-21 14:37:18 +1000422};
423
424/*
Dave Chinner80168672010-09-24 18:13:44 +1000425 * The amount of log space we allow the CIL to aggregate is difficult to size.
426 * Whatever we choose, we have to make sure we can get a reservation for the
427 * log space effectively, that it is large enough to capture sufficient
428 * relogging to reduce log buffer IO significantly, but it is not too large for
429 * the log or induces too much latency when writing out through the iclogs. We
430 * track both space consumed and the number of vectors in the checkpoint
431 * context, so we need to decide which to use for limiting.
Dave Chinnerdf806152010-05-17 15:52:13 +1000432 *
433 * Every log buffer we write out during a push needs a header reserved, which
434 * is at least one sector and more for v2 logs. Hence we need a reservation of
435 * at least 512 bytes per 32k of log space just for the LR headers. That means
436 * 16KB of reservation per megabyte of delayed logging space we will consume,
437 * plus various headers. The number of headers will vary based on the num of
438 * io vectors, so limiting on a specific number of vectors is going to result
439 * in transactions of varying size. IOWs, it is more consistent to track and
440 * limit space consumed in the log rather than by the number of objects being
441 * logged in order to prevent checkpoint ticket overruns.
442 *
443 * Further, use of static reservations through the log grant mechanism is
444 * problematic. It introduces a lot of complexity (e.g. reserve grant vs write
445 * grant) and a significant deadlock potential because regranting write space
446 * can block on log pushes. Hence if we have to regrant log space during a log
447 * push, we can deadlock.
448 *
449 * However, we can avoid this by use of a dynamic "reservation stealing"
450 * technique during transaction commit whereby unused reservation space in the
451 * transaction ticket is transferred to the CIL ctx commit ticket to cover the
452 * space needed by the checkpoint transaction. This means that we never need to
453 * specifically reserve space for the CIL checkpoint transaction, nor do we
454 * need to regrant space once the checkpoint completes. This also means the
455 * checkpoint transaction ticket is specific to the checkpoint context, rather
456 * than the CIL itself.
457 *
Dave Chinner80168672010-09-24 18:13:44 +1000458 * With dynamic reservations, we can effectively make up arbitrary limits for
459 * the checkpoint size so long as they don't violate any other size rules.
460 * Recovery imposes a rule that no transaction exceed half the log, so we are
461 * limited by that. Furthermore, the log transaction reservation subsystem
462 * tries to keep 25% of the log free, so we need to keep below that limit or we
463 * risk running out of free log space to start any new transactions.
464 *
465 * In order to keep background CIL push efficient, we will set a lower
466 * threshold at which background pushing is attempted without blocking current
467 * transaction commits. A separate, higher bound defines when CIL pushes are
468 * enforced to ensure we stay within our maximum checkpoint size bounds.
469 * threshold, yet give us plenty of space for aggregation on large logs.
Dave Chinnerdf806152010-05-17 15:52:13 +1000470 */
Dave Chinner80168672010-09-24 18:13:44 +1000471#define XLOG_CIL_SPACE_LIMIT(log) (log->l_logsize >> 3)
472#define XLOG_CIL_HARD_SPACE_LIMIT(log) (3 * (log->l_logsize >> 4))
Dave Chinnerdf806152010-05-17 15:52:13 +1000473
474/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 * The reservation head lsn is not made up of a cycle number and block number.
476 * Instead, it uses a cycle number and byte number. Logs don't expect to
477 * overflow 31 bits worth of byte offset, so using a byte number will mean
478 * that round off problems won't occur when releasing partial reservations.
479 */
480typedef struct log {
David Chinner4679b2d2008-04-10 12:18:54 +1000481 /* The following fields don't need locking */
482 struct xfs_mount *l_mp; /* mount point */
David Chinnera9c21c12008-10-30 17:39:35 +1100483 struct xfs_ail *l_ailp; /* AIL log is working with */
Dave Chinner71e330b2010-05-21 14:37:18 +1000484 struct xfs_cil *l_cilp; /* CIL log is working with */
David Chinner4679b2d2008-04-10 12:18:54 +1000485 struct xfs_buf *l_xbuf; /* extra buffer for log
486 * wrapping */
487 struct xfs_buftarg *l_targ; /* buftarg of log */
488 uint l_flags;
489 uint l_quotaoffs_flag; /* XFS_DQ_*, for QUOTAOFFs */
Christoph Hellwigd5689ea2010-12-01 22:06:22 +0000490 struct list_head *l_buf_cancel_table;
David Chinner4679b2d2008-04-10 12:18:54 +1000491 int l_iclog_hsize; /* size of iclog header */
492 int l_iclog_heads; /* # of iclog header sectors */
Alex Elder48389ef2010-04-20 17:10:21 +1000493 uint l_sectBBsize; /* sector size in BBs (2^n) */
David Chinner4679b2d2008-04-10 12:18:54 +1000494 int l_iclog_size; /* size of log in bytes */
495 int l_iclog_size_log; /* log power size of log */
496 int l_iclog_bufs; /* number of iclog buffers */
497 xfs_daddr_t l_logBBstart; /* start block of log */
498 int l_logsize; /* size of log in bytes */
499 int l_logBBsize; /* size of log in BB chunks */
500
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 /* The following block of fields are changed while holding icloglock */
Matthew Wilcoxd748c622008-05-19 16:34:27 +1000502 sv_t l_flush_wait ____cacheline_aligned_in_smp;
503 /* waiting for iclog flush */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 int l_covered_state;/* state of "covering disk
505 * log entries" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 xlog_in_core_t *l_iclog; /* head log queue */
Eric Sandeenb22cd72c2007-10-11 17:37:10 +1000507 spinlock_t l_icloglock; /* grab to change iclog state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 xfs_lsn_t l_tail_lsn; /* lsn of 1st LR with unflushed
509 * buffers */
510 xfs_lsn_t l_last_sync_lsn;/* lsn of last LR on disk */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 int l_curr_cycle; /* Cycle number of log writes */
512 int l_prev_cycle; /* Cycle number before last
513 * block increment */
514 int l_curr_block; /* current logical log block */
515 int l_prev_block; /* previous logical log block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
517 /* The following block of fields are changed while holding grant_lock */
David Chinner4679b2d2008-04-10 12:18:54 +1000518 spinlock_t l_grant_lock ____cacheline_aligned_in_smp;
Dave Chinner10547942010-12-21 12:02:25 +1100519 struct list_head l_reserveq;
520 struct list_head l_writeq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 int l_grant_reserve_cycle;
522 int l_grant_reserve_bytes;
523 int l_grant_write_cycle;
524 int l_grant_write_bytes;
525
David Chinner4679b2d2008-04-10 12:18:54 +1000526 /* The following field are used for debugging; need to hold icloglock */
527#ifdef DEBUG
528 char *l_iclog_bak[XLOG_MAX_ICLOGS];
529#endif
530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531} xlog_t;
532
Christoph Hellwigd5689ea2010-12-01 22:06:22 +0000533#define XLOG_BUF_CANCEL_BUCKET(log, blkno) \
534 ((log)->l_buf_cancel_table + ((__uint64_t)blkno % XLOG_BC_TABLE_SIZE))
535
Nathan Scottcfcbbbd2005-11-02 15:12:04 +1100536#define XLOG_FORCED_SHUTDOWN(log) ((log)->l_flags & XLOG_IO_ERROR)
537
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538/* common routines */
539extern xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
Eric Sandeen65be6052006-01-11 15:34:19 +1100540extern int xlog_recover(xlog_t *log);
Christoph Hellwig42490232008-08-13 16:49:32 +1000541extern int xlog_recover_finish(xlog_t *log);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542extern void xlog_pack_data(xlog_t *log, xlog_in_core_t *iclog, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Dave Chinner71e330b2010-05-21 14:37:18 +1000544extern kmem_zone_t *xfs_log_ticket_zone;
545struct xlog_ticket *xlog_ticket_alloc(struct log *log, int unit_bytes,
546 int count, char client, uint xflags,
547 int alloc_flags);
548
David Chinnereb01c9c2008-04-10 12:18:46 +1000549
Christoph Hellwige6b1f272010-03-23 11:47:38 +1100550static inline void
551xlog_write_adv_cnt(void **ptr, int *len, int *off, size_t bytes)
552{
553 *ptr += bytes;
554 *len -= bytes;
555 *off += bytes;
556}
557
Dave Chinner71e330b2010-05-21 14:37:18 +1000558void xlog_print_tic_res(struct xfs_mount *mp, struct xlog_ticket *ticket);
559int xlog_write(struct log *log, struct xfs_log_vec *log_vector,
560 struct xlog_ticket *tic, xfs_lsn_t *start_lsn,
561 xlog_in_core_t **commit_iclog, uint flags);
562
563/*
564 * Committed Item List interfaces
565 */
566int xlog_cil_init(struct log *log);
567void xlog_cil_init_post_recovery(struct log *log);
568void xlog_cil_destroy(struct log *log);
569
Dave Chinnera44f13e2010-08-24 11:40:03 +1000570/*
571 * CIL force routines
572 */
573xfs_lsn_t xlog_cil_force_lsn(struct log *log, xfs_lsn_t sequence);
574
575static inline void
576xlog_cil_force(struct log *log)
577{
578 xlog_cil_force_lsn(log, log->l_cilp->xc_current_sequence);
579}
Dave Chinner71e330b2010-05-21 14:37:18 +1000580
Tim Shimmin955e47a2006-09-28 11:04:16 +1000581/*
582 * Unmount record type is used as a pseudo transaction type for the ticket.
583 * It's value must be outside the range of XFS_TRANS_* values.
584 */
585#define XLOG_UNMOUNT_REC_TYPE (-1U)
586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587#endif /* __KERNEL__ */
588
589#endif /* __XFS_LOG_PRIV_H__ */