blob: e639e8e9a2a978ed6404725ce52b6f4cdbe840ba [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2002,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_TRANS_H__
19#define __XFS_TRANS_H__
20
Barry Naujok847fff52008-10-30 17:05:38 +110021struct xfs_log_item;
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023/*
24 * This is the structure written in the log at the head of
25 * every transaction. It identifies the type and id of the
26 * transaction, and contains the number of items logged by
27 * the transaction so we know how many to expect during recovery.
28 *
29 * Do not change the below structure without redoing the code in
30 * xlog_recover_add_to_trans() and xlog_recover_add_to_cont_trans().
31 */
32typedef struct xfs_trans_header {
33 uint th_magic; /* magic number */
34 uint th_type; /* transaction type */
35 __int32_t th_tid; /* transaction id (unused) */
36 uint th_num_items; /* num items logged by trans */
37} xfs_trans_header_t;
38
39#define XFS_TRANS_HEADER_MAGIC 0x5452414e /* TRAN */
40
41/*
42 * Log item types.
43 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#define XFS_LI_EFI 0x1236
45#define XFS_LI_EFD 0x1237
46#define XFS_LI_IUNLINK 0x1238
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define XFS_LI_INODE 0x123b /* aligned ino chunks, var-size ibufs */
48#define XFS_LI_BUF 0x123c /* v2 bufs, variable sized inode bufs */
49#define XFS_LI_DQUOT 0x123d
50#define XFS_LI_QUOTAOFF 0x123e
51
Dave Chinner9abbc532010-04-13 15:06:46 +100052#define XFS_LI_TYPE_DESC \
53 { XFS_LI_EFI, "XFS_LI_EFI" }, \
54 { XFS_LI_EFD, "XFS_LI_EFD" }, \
55 { XFS_LI_IUNLINK, "XFS_LI_IUNLINK" }, \
56 { XFS_LI_INODE, "XFS_LI_INODE" }, \
57 { XFS_LI_BUF, "XFS_LI_BUF" }, \
58 { XFS_LI_DQUOT, "XFS_LI_DQUOT" }, \
59 { XFS_LI_QUOTAOFF, "XFS_LI_QUOTAOFF" }
60
Linus Torvalds1da177e2005-04-16 15:20:36 -070061/*
62 * Transaction types. Used to distinguish types of buffers.
63 */
64#define XFS_TRANS_SETATTR_NOT_SIZE 1
65#define XFS_TRANS_SETATTR_SIZE 2
66#define XFS_TRANS_INACTIVE 3
67#define XFS_TRANS_CREATE 4
68#define XFS_TRANS_CREATE_TRUNC 5
69#define XFS_TRANS_TRUNCATE_FILE 6
70#define XFS_TRANS_REMOVE 7
71#define XFS_TRANS_LINK 8
72#define XFS_TRANS_RENAME 9
73#define XFS_TRANS_MKDIR 10
74#define XFS_TRANS_RMDIR 11
75#define XFS_TRANS_SYMLINK 12
76#define XFS_TRANS_SET_DMATTRS 13
77#define XFS_TRANS_GROWFS 14
78#define XFS_TRANS_STRAT_WRITE 15
79#define XFS_TRANS_DIOSTRAT 16
Christoph Hellwig13e6d5c2009-08-31 21:00:31 -030080/* 17 was XFS_TRANS_WRITE_SYNC */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081#define XFS_TRANS_WRITEID 18
82#define XFS_TRANS_ADDAFORK 19
83#define XFS_TRANS_ATTRINVAL 20
84#define XFS_TRANS_ATRUNCATE 21
85#define XFS_TRANS_ATTR_SET 22
86#define XFS_TRANS_ATTR_RM 23
87#define XFS_TRANS_ATTR_FLAG 24
88#define XFS_TRANS_CLEAR_AGI_BUCKET 25
89#define XFS_TRANS_QM_SBCHANGE 26
90/*
91 * Dummy entries since we use the transaction type to index into the
92 * trans_type[] in xlog_recover_print_trans_head()
93 */
94#define XFS_TRANS_DUMMY1 27
95#define XFS_TRANS_DUMMY2 28
96#define XFS_TRANS_QM_QUOTAOFF 29
97#define XFS_TRANS_QM_DQALLOC 30
98#define XFS_TRANS_QM_SETQLIM 31
99#define XFS_TRANS_QM_DQCLUSTER 32
100#define XFS_TRANS_QM_QINOCREATE 33
101#define XFS_TRANS_QM_QUOTAOFF_END 34
102#define XFS_TRANS_SB_UNIT 35
103#define XFS_TRANS_FSYNC_TS 36
104#define XFS_TRANS_GROWFSRT_ALLOC 37
105#define XFS_TRANS_GROWFSRT_ZERO 38
106#define XFS_TRANS_GROWFSRT_FREE 39
107#define XFS_TRANS_SWAPEXT 40
David Chinner92821e22007-05-24 15:26:31 +1000108#define XFS_TRANS_SB_COUNT 41
Dave Chinner71e330b2010-05-21 14:37:18 +1000109#define XFS_TRANS_CHECKPOINT 42
110#define XFS_TRANS_TYPE_MAX 42
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111/* new transaction types need to be reflected in xfs_logprint(8) */
112
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000113#define XFS_TRANS_TYPES \
114 { XFS_TRANS_SETATTR_NOT_SIZE, "SETATTR_NOT_SIZE" }, \
115 { XFS_TRANS_SETATTR_SIZE, "SETATTR_SIZE" }, \
116 { XFS_TRANS_INACTIVE, "INACTIVE" }, \
117 { XFS_TRANS_CREATE, "CREATE" }, \
118 { XFS_TRANS_CREATE_TRUNC, "CREATE_TRUNC" }, \
119 { XFS_TRANS_TRUNCATE_FILE, "TRUNCATE_FILE" }, \
120 { XFS_TRANS_REMOVE, "REMOVE" }, \
121 { XFS_TRANS_LINK, "LINK" }, \
122 { XFS_TRANS_RENAME, "RENAME" }, \
123 { XFS_TRANS_MKDIR, "MKDIR" }, \
124 { XFS_TRANS_RMDIR, "RMDIR" }, \
125 { XFS_TRANS_SYMLINK, "SYMLINK" }, \
126 { XFS_TRANS_SET_DMATTRS, "SET_DMATTRS" }, \
127 { XFS_TRANS_GROWFS, "GROWFS" }, \
128 { XFS_TRANS_STRAT_WRITE, "STRAT_WRITE" }, \
129 { XFS_TRANS_DIOSTRAT, "DIOSTRAT" }, \
130 { XFS_TRANS_WRITEID, "WRITEID" }, \
131 { XFS_TRANS_ADDAFORK, "ADDAFORK" }, \
132 { XFS_TRANS_ATTRINVAL, "ATTRINVAL" }, \
133 { XFS_TRANS_ATRUNCATE, "ATRUNCATE" }, \
134 { XFS_TRANS_ATTR_SET, "ATTR_SET" }, \
135 { XFS_TRANS_ATTR_RM, "ATTR_RM" }, \
136 { XFS_TRANS_ATTR_FLAG, "ATTR_FLAG" }, \
137 { XFS_TRANS_CLEAR_AGI_BUCKET, "CLEAR_AGI_BUCKET" }, \
138 { XFS_TRANS_QM_SBCHANGE, "QM_SBCHANGE" }, \
139 { XFS_TRANS_QM_QUOTAOFF, "QM_QUOTAOFF" }, \
140 { XFS_TRANS_QM_DQALLOC, "QM_DQALLOC" }, \
141 { XFS_TRANS_QM_SETQLIM, "QM_SETQLIM" }, \
142 { XFS_TRANS_QM_DQCLUSTER, "QM_DQCLUSTER" }, \
143 { XFS_TRANS_QM_QINOCREATE, "QM_QINOCREATE" }, \
144 { XFS_TRANS_QM_QUOTAOFF_END, "QM_QOFF_END" }, \
145 { XFS_TRANS_SB_UNIT, "SB_UNIT" }, \
146 { XFS_TRANS_FSYNC_TS, "FSYNC_TS" }, \
147 { XFS_TRANS_GROWFSRT_ALLOC, "GROWFSRT_ALLOC" }, \
148 { XFS_TRANS_GROWFSRT_ZERO, "GROWFSRT_ZERO" }, \
149 { XFS_TRANS_GROWFSRT_FREE, "GROWFSRT_FREE" }, \
150 { XFS_TRANS_SWAPEXT, "SWAPEXT" }, \
151 { XFS_TRANS_SB_COUNT, "SB_COUNT" }, \
Dave Chinner71e330b2010-05-21 14:37:18 +1000152 { XFS_TRANS_CHECKPOINT, "CHECKPOINT" }, \
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000153 { XFS_TRANS_DUMMY1, "DUMMY1" }, \
154 { XFS_TRANS_DUMMY2, "DUMMY2" }, \
155 { XLOG_UNMOUNT_REC_TYPE, "UNMOUNT" }
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157/*
158 * This structure is used to track log items associated with
159 * a transaction. It points to the log item and keeps some
160 * flags to track the state of the log item. It also tracks
161 * the amount of space needed to log the item it describes
162 * once we get to commit processing (see xfs_trans_commit()).
163 */
164typedef struct xfs_log_item_desc {
Barry Naujok847fff52008-10-30 17:05:38 +1100165 struct xfs_log_item *lid_item;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 ushort lid_size;
167 unsigned char lid_flags;
168 unsigned char lid_index;
169} xfs_log_item_desc_t;
170
171#define XFS_LID_DIRTY 0x1
172#define XFS_LID_PINNED 0x2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174/*
175 * This structure is used to maintain a chunk list of log_item_desc
176 * structures. The free field is a bitmask indicating which descriptors
177 * in this chunk's array are free. The unused field is the first value
178 * not used since this chunk was allocated.
179 */
180#define XFS_LIC_NUM_SLOTS 15
181typedef struct xfs_log_item_chunk {
182 struct xfs_log_item_chunk *lic_next;
183 ushort lic_free;
184 ushort lic_unused;
185 xfs_log_item_desc_t lic_descs[XFS_LIC_NUM_SLOTS];
186} xfs_log_item_chunk_t;
187
188#define XFS_LIC_MAX_SLOT (XFS_LIC_NUM_SLOTS - 1)
189#define XFS_LIC_FREEMASK ((1 << XFS_LIC_NUM_SLOTS) - 1)
190
191
192/*
193 * Initialize the given chunk. Set the chunk's free descriptor mask
194 * to indicate that all descriptors are free. The caller gets to set
195 * lic_unused to the right value (0 matches all free). The
196 * lic_descs.lid_index values are set up as each desc is allocated.
197 */
Nathan Scotta844f452005-11-02 14:38:42 +1100198static inline void xfs_lic_init(xfs_log_item_chunk_t *cp)
199{
200 cp->lic_free = XFS_LIC_FREEMASK;
201}
202
Nathan Scotta844f452005-11-02 14:38:42 +1100203static inline void xfs_lic_init_slot(xfs_log_item_chunk_t *cp, int slot)
204{
205 cp->lic_descs[slot].lid_index = (unsigned char)(slot);
206}
207
Nathan Scotta844f452005-11-02 14:38:42 +1100208static inline int xfs_lic_vacancy(xfs_log_item_chunk_t *cp)
209{
210 return cp->lic_free & XFS_LIC_FREEMASK;
211}
212
Nathan Scotta844f452005-11-02 14:38:42 +1100213static inline void xfs_lic_all_free(xfs_log_item_chunk_t *cp)
214{
215 cp->lic_free = XFS_LIC_FREEMASK;
216}
217
Nathan Scotta844f452005-11-02 14:38:42 +1100218static inline int xfs_lic_are_all_free(xfs_log_item_chunk_t *cp)
219{
220 return ((cp->lic_free & XFS_LIC_FREEMASK) == XFS_LIC_FREEMASK);
221}
222
Nathan Scotta844f452005-11-02 14:38:42 +1100223static inline int xfs_lic_isfree(xfs_log_item_chunk_t *cp, int slot)
224{
225 return (cp->lic_free & (1 << slot));
226}
227
Nathan Scotta844f452005-11-02 14:38:42 +1100228static inline void xfs_lic_claim(xfs_log_item_chunk_t *cp, int slot)
229{
230 cp->lic_free &= ~(1 << slot);
231}
232
Nathan Scotta844f452005-11-02 14:38:42 +1100233static inline void xfs_lic_relse(xfs_log_item_chunk_t *cp, int slot)
234{
235 cp->lic_free |= 1 << slot;
236}
237
Nathan Scotta844f452005-11-02 14:38:42 +1100238static inline xfs_log_item_desc_t *
239xfs_lic_slot(xfs_log_item_chunk_t *cp, int slot)
240{
241 return &(cp->lic_descs[slot]);
242}
243
Nathan Scotta844f452005-11-02 14:38:42 +1100244static inline int xfs_lic_desc_to_slot(xfs_log_item_desc_t *dp)
245{
246 return (uint)dp->lid_index;
247}
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249/*
250 * Calculate the address of a chunk given a descriptor pointer:
251 * dp - dp->lid_index give the address of the start of the lic_descs array.
252 * From this we subtract the offset of the lic_descs field in a chunk.
253 * All of this yields the address of the chunk, which is
254 * cast to a chunk pointer.
255 */
Nathan Scotta844f452005-11-02 14:38:42 +1100256static inline xfs_log_item_chunk_t *
257xfs_lic_desc_to_chunk(xfs_log_item_desc_t *dp)
258{
259 return (xfs_log_item_chunk_t*) \
260 (((xfs_caddr_t)((dp) - (dp)->lid_index)) - \
261 (xfs_caddr_t)(((xfs_log_item_chunk_t*)0)->lic_descs));
262}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264#define XFS_TRANS_MAGIC 0x5452414E /* 'TRAN' */
265/*
266 * Values for t_flags.
267 */
268#define XFS_TRANS_DIRTY 0x01 /* something needs to be logged */
269#define XFS_TRANS_SB_DIRTY 0x02 /* superblock is modified */
270#define XFS_TRANS_PERM_LOG_RES 0x04 /* xact took a permanent log res */
271#define XFS_TRANS_SYNC 0x08 /* make commit synchronous */
272#define XFS_TRANS_DQ_DIRTY 0x10 /* at least one dquot in trx dirty */
273#define XFS_TRANS_RESERVE 0x20 /* OK to use reserved data blocks */
274
275/*
276 * Values for call flags parameter.
277 */
278#define XFS_TRANS_NOSLEEP 0x1
279#define XFS_TRANS_WAIT 0x2
280#define XFS_TRANS_RELEASE_LOG_RES 0x4
281#define XFS_TRANS_ABORT 0x8
282
283/*
284 * Field values for xfs_trans_mod_sb.
285 */
286#define XFS_TRANS_SB_ICOUNT 0x00000001
287#define XFS_TRANS_SB_IFREE 0x00000002
288#define XFS_TRANS_SB_FDBLOCKS 0x00000004
289#define XFS_TRANS_SB_RES_FDBLOCKS 0x00000008
290#define XFS_TRANS_SB_FREXTENTS 0x00000010
291#define XFS_TRANS_SB_RES_FREXTENTS 0x00000020
292#define XFS_TRANS_SB_DBLOCKS 0x00000040
293#define XFS_TRANS_SB_AGCOUNT 0x00000080
294#define XFS_TRANS_SB_IMAXPCT 0x00000100
295#define XFS_TRANS_SB_REXTSIZE 0x00000200
296#define XFS_TRANS_SB_RBMBLOCKS 0x00000400
297#define XFS_TRANS_SB_RBLOCKS 0x00000800
298#define XFS_TRANS_SB_REXTENTS 0x00001000
299#define XFS_TRANS_SB_REXTSLOG 0x00002000
300
301
302/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 * Per-extent log reservation for the allocation btree changes
304 * involved in freeing or allocating an extent.
305 * 2 trees * (2 blocks/level * max depth - 1) * block size
306 */
307#define XFS_ALLOCFREE_LOG_RES(mp,nx) \
308 ((nx) * (2 * XFS_FSB_TO_B((mp), 2 * XFS_AG_MAXLEVELS(mp) - 1)))
309#define XFS_ALLOCFREE_LOG_COUNT(mp,nx) \
310 ((nx) * (2 * (2 * XFS_AG_MAXLEVELS(mp) - 1)))
311
312/*
313 * Per-directory log reservation for any directory change.
314 * dir blocks: (1 btree block per level + data block + free block) * dblock size
315 * bmap btree: (levels + 2) * max depth * block size
316 * v2 directory blocks can be fragmented below the dirblksize down to the fsb
317 * size, so account for that in the DAENTER macros.
318 */
319#define XFS_DIROP_LOG_RES(mp) \
320 (XFS_FSB_TO_B(mp, XFS_DAENTER_BLOCKS(mp, XFS_DATA_FORK)) + \
321 (XFS_FSB_TO_B(mp, XFS_DAENTER_BMAPS(mp, XFS_DATA_FORK) + 1)))
322#define XFS_DIROP_LOG_COUNT(mp) \
323 (XFS_DAENTER_BLOCKS(mp, XFS_DATA_FORK) + \
324 XFS_DAENTER_BMAPS(mp, XFS_DATA_FORK) + 1)
325
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
327#define XFS_WRITE_LOG_RES(mp) ((mp)->m_reservations.tr_write)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328#define XFS_ITRUNCATE_LOG_RES(mp) ((mp)->m_reservations.tr_itruncate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329#define XFS_RENAME_LOG_RES(mp) ((mp)->m_reservations.tr_rename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330#define XFS_LINK_LOG_RES(mp) ((mp)->m_reservations.tr_link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331#define XFS_REMOVE_LOG_RES(mp) ((mp)->m_reservations.tr_remove)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332#define XFS_SYMLINK_LOG_RES(mp) ((mp)->m_reservations.tr_symlink)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333#define XFS_CREATE_LOG_RES(mp) ((mp)->m_reservations.tr_create)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334#define XFS_MKDIR_LOG_RES(mp) ((mp)->m_reservations.tr_mkdir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335#define XFS_IFREE_LOG_RES(mp) ((mp)->m_reservations.tr_ifree)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336#define XFS_ICHANGE_LOG_RES(mp) ((mp)->m_reservations.tr_ichange)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337#define XFS_GROWDATA_LOG_RES(mp) ((mp)->m_reservations.tr_growdata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338#define XFS_GROWRTALLOC_LOG_RES(mp) ((mp)->m_reservations.tr_growrtalloc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339#define XFS_GROWRTZERO_LOG_RES(mp) ((mp)->m_reservations.tr_growrtzero)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340#define XFS_GROWRTFREE_LOG_RES(mp) ((mp)->m_reservations.tr_growrtfree)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341#define XFS_SWRITE_LOG_RES(mp) ((mp)->m_reservations.tr_swrite)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342/*
343 * Logging the inode timestamps on an fsync -- same as SWRITE
344 * as long as SWRITE logs the entire inode core
345 */
346#define XFS_FSYNC_TS_LOG_RES(mp) ((mp)->m_reservations.tr_swrite)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347#define XFS_WRITEID_LOG_RES(mp) ((mp)->m_reservations.tr_swrite)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348#define XFS_ADDAFORK_LOG_RES(mp) ((mp)->m_reservations.tr_addafork)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349#define XFS_ATTRINVAL_LOG_RES(mp) ((mp)->m_reservations.tr_attrinval)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350#define XFS_ATTRSET_LOG_RES(mp, ext) \
351 ((mp)->m_reservations.tr_attrset + \
352 (ext * (mp)->m_sb.sb_sectsize) + \
353 (ext * XFS_FSB_TO_B((mp), XFS_BM_MAXLEVELS(mp, XFS_ATTR_FORK))) + \
354 (128 * (ext + (ext * XFS_BM_MAXLEVELS(mp, XFS_ATTR_FORK)))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355#define XFS_ATTRRM_LOG_RES(mp) ((mp)->m_reservations.tr_attrrm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356#define XFS_CLEAR_AGI_BUCKET_LOG_RES(mp) ((mp)->m_reservations.tr_clearagi)
357
358
359/*
360 * Various log count values.
361 */
362#define XFS_DEFAULT_LOG_COUNT 1
363#define XFS_DEFAULT_PERM_LOG_COUNT 2
364#define XFS_ITRUNCATE_LOG_COUNT 2
365#define XFS_INACTIVE_LOG_COUNT 2
366#define XFS_CREATE_LOG_COUNT 2
367#define XFS_MKDIR_LOG_COUNT 3
368#define XFS_SYMLINK_LOG_COUNT 3
369#define XFS_REMOVE_LOG_COUNT 2
370#define XFS_LINK_LOG_COUNT 2
371#define XFS_RENAME_LOG_COUNT 2
372#define XFS_WRITE_LOG_COUNT 2
373#define XFS_ADDAFORK_LOG_COUNT 2
374#define XFS_ATTRINVAL_LOG_COUNT 1
375#define XFS_ATTRSET_LOG_COUNT 3
376#define XFS_ATTRRM_LOG_COUNT 3
377
378/*
379 * Here we centralize the specification of XFS meta-data buffer
380 * reference count values. This determine how hard the buffer
381 * cache tries to hold onto the buffer.
382 */
383#define XFS_AGF_REF 4
384#define XFS_AGI_REF 4
385#define XFS_AGFL_REF 3
386#define XFS_INO_BTREE_REF 3
387#define XFS_ALLOC_BTREE_REF 2
388#define XFS_BMAP_BTREE_REF 2
389#define XFS_DIR_BTREE_REF 2
390#define XFS_ATTR_BTREE_REF 1
391#define XFS_INO_REF 1
392#define XFS_DQUOT_REF 1
393
394#ifdef __KERNEL__
Barry Naujok847fff52008-10-30 17:05:38 +1100395
396struct xfs_buf;
397struct xfs_buftarg;
398struct xfs_efd_log_item;
399struct xfs_efi_log_item;
400struct xfs_inode;
401struct xfs_item_ops;
402struct xfs_log_iovec;
403struct xfs_log_item_desc;
404struct xfs_mount;
405struct xfs_trans;
406struct xfs_dquot_acct;
Dave Chinnered3b4d62010-05-21 12:07:08 +1000407struct xfs_busy_extent;
Barry Naujok847fff52008-10-30 17:05:38 +1100408
409typedef struct xfs_log_item {
410 struct list_head li_ail; /* AIL pointers */
411 xfs_lsn_t li_lsn; /* last on-disk lsn */
412 struct xfs_log_item_desc *li_desc; /* ptr to current desc*/
413 struct xfs_mount *li_mountp; /* ptr to fs mount */
David Chinnerfc1829f2008-10-30 17:39:46 +1100414 struct xfs_ail *li_ailp; /* ptr to AIL */
Barry Naujok847fff52008-10-30 17:05:38 +1100415 uint li_type; /* item type */
416 uint li_flags; /* misc flags */
417 struct xfs_log_item *li_bio_list; /* buffer item list */
418 void (*li_cb)(struct xfs_buf *,
419 struct xfs_log_item *);
420 /* buffer item iodone */
421 /* callback func */
422 struct xfs_item_ops *li_ops; /* function list */
Dave Chinner71e330b2010-05-21 14:37:18 +1000423
424 /* delayed logging */
425 struct list_head li_cil; /* CIL pointers */
426 struct xfs_log_vec *li_lv; /* active log vector */
Dave Chinnerccf7c232010-05-20 23:19:42 +1000427 xfs_lsn_t li_seq; /* CIL commit seq */
Barry Naujok847fff52008-10-30 17:05:38 +1100428} xfs_log_item_t;
429
430#define XFS_LI_IN_AIL 0x1
431#define XFS_LI_ABORTED 0x2
432
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000433#define XFS_LI_FLAGS \
434 { XFS_LI_IN_AIL, "IN_AIL" }, \
435 { XFS_LI_ABORTED, "ABORTED" }
436
Barry Naujok847fff52008-10-30 17:05:38 +1100437typedef struct xfs_item_ops {
438 uint (*iop_size)(xfs_log_item_t *);
439 void (*iop_format)(xfs_log_item_t *, struct xfs_log_iovec *);
440 void (*iop_pin)(xfs_log_item_t *);
Dave Chinner8e123852010-03-08 11:26:03 +1100441 void (*iop_unpin)(xfs_log_item_t *);
Barry Naujok847fff52008-10-30 17:05:38 +1100442 void (*iop_unpin_remove)(xfs_log_item_t *, struct xfs_trans *);
443 uint (*iop_trylock)(xfs_log_item_t *);
444 void (*iop_unlock)(xfs_log_item_t *);
445 xfs_lsn_t (*iop_committed)(xfs_log_item_t *, xfs_lsn_t);
446 void (*iop_push)(xfs_log_item_t *);
447 void (*iop_pushbuf)(xfs_log_item_t *);
448 void (*iop_committing)(xfs_log_item_t *, xfs_lsn_t);
449} xfs_item_ops_t;
450
451#define IOP_SIZE(ip) (*(ip)->li_ops->iop_size)(ip)
452#define IOP_FORMAT(ip,vp) (*(ip)->li_ops->iop_format)(ip, vp)
453#define IOP_PIN(ip) (*(ip)->li_ops->iop_pin)(ip)
Dave Chinner8e123852010-03-08 11:26:03 +1100454#define IOP_UNPIN(ip) (*(ip)->li_ops->iop_unpin)(ip)
Barry Naujok847fff52008-10-30 17:05:38 +1100455#define IOP_UNPIN_REMOVE(ip,tp) (*(ip)->li_ops->iop_unpin_remove)(ip, tp)
456#define IOP_TRYLOCK(ip) (*(ip)->li_ops->iop_trylock)(ip)
457#define IOP_UNLOCK(ip) (*(ip)->li_ops->iop_unlock)(ip)
458#define IOP_COMMITTED(ip, lsn) (*(ip)->li_ops->iop_committed)(ip, lsn)
459#define IOP_PUSH(ip) (*(ip)->li_ops->iop_push)(ip)
460#define IOP_PUSHBUF(ip) (*(ip)->li_ops->iop_pushbuf)(ip)
461#define IOP_COMMITTING(ip, lsn) (*(ip)->li_ops->iop_committing)(ip, lsn)
462
463/*
464 * Return values for the IOP_TRYLOCK() routines.
465 */
466#define XFS_ITEM_SUCCESS 0
467#define XFS_ITEM_PINNED 1
468#define XFS_ITEM_LOCKED 2
Dave Chinnerd808f612010-02-02 10:13:42 +1100469#define XFS_ITEM_PUSHBUF 3
Barry Naujok847fff52008-10-30 17:05:38 +1100470
471/*
Barry Naujok847fff52008-10-30 17:05:38 +1100472 * This is the type of function which can be given to xfs_trans_callback()
473 * to be called upon the transaction's commit to disk.
474 */
475typedef void (*xfs_trans_callback_t)(struct xfs_trans *, void *);
476
477/*
478 * This is the structure maintained for every active transaction.
479 */
480typedef struct xfs_trans {
481 unsigned int t_magic; /* magic number */
482 xfs_log_callback_t t_logcb; /* log callback struct */
483 unsigned int t_type; /* transaction type */
484 unsigned int t_log_res; /* amt of log space resvd */
485 unsigned int t_log_count; /* count for perm log res */
486 unsigned int t_blk_res; /* # of blocks resvd */
487 unsigned int t_blk_res_used; /* # of resvd blocks used */
488 unsigned int t_rtx_res; /* # of rt extents resvd */
489 unsigned int t_rtx_res_used; /* # of resvd rt extents used */
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000490 struct xlog_ticket *t_ticket; /* log mgr ticket */
Barry Naujok847fff52008-10-30 17:05:38 +1100491 xfs_lsn_t t_lsn; /* log seq num of start of
492 * transaction. */
493 xfs_lsn_t t_commit_lsn; /* log seq num of end of
494 * transaction. */
495 struct xfs_mount *t_mountp; /* ptr to fs mount struct */
496 struct xfs_dquot_acct *t_dqinfo; /* acctg info for dquots */
497 xfs_trans_callback_t t_callback; /* transaction callback */
498 void *t_callarg; /* callback arg */
499 unsigned int t_flags; /* misc flags */
500 int64_t t_icount_delta; /* superblock icount change */
501 int64_t t_ifree_delta; /* superblock ifree change */
502 int64_t t_fdblocks_delta; /* superblock fdblocks chg */
503 int64_t t_res_fdblocks_delta; /* on-disk only chg */
504 int64_t t_frextents_delta;/* superblock freextents chg*/
505 int64_t t_res_frextents_delta; /* on-disk only chg */
506#ifdef DEBUG
507 int64_t t_ag_freeblks_delta; /* debugging counter */
508 int64_t t_ag_flist_delta; /* debugging counter */
509 int64_t t_ag_btree_delta; /* debugging counter */
510#endif
511 int64_t t_dblocks_delta;/* superblock dblocks change */
512 int64_t t_agcount_delta;/* superblock agcount change */
513 int64_t t_imaxpct_delta;/* superblock imaxpct change */
514 int64_t t_rextsize_delta;/* superblock rextsize chg */
515 int64_t t_rbmblocks_delta;/* superblock rbmblocks chg */
516 int64_t t_rblocks_delta;/* superblock rblocks change */
517 int64_t t_rextents_delta;/* superblocks rextents chg */
518 int64_t t_rextslog_delta;/* superblocks rextslog chg */
519 unsigned int t_items_free; /* log item descs free */
520 xfs_log_item_chunk_t t_items; /* first log item desc chunk */
521 xfs_trans_header_t t_header; /* header for in-log trans */
Dave Chinnered3b4d62010-05-21 12:07:08 +1000522 struct list_head t_busy; /* list of busy extents */
Barry Naujok847fff52008-10-30 17:05:38 +1100523 unsigned long t_pflags; /* saved process flags state */
524} xfs_trans_t;
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/*
527 * XFS transaction mechanism exported interfaces that are
528 * actually macros.
529 */
530#define xfs_trans_get_log_res(tp) ((tp)->t_log_res)
531#define xfs_trans_get_log_count(tp) ((tp)->t_log_count)
532#define xfs_trans_get_block_res(tp) ((tp)->t_blk_res)
533#define xfs_trans_set_sync(tp) ((tp)->t_flags |= XFS_TRANS_SYNC)
534
535#ifdef DEBUG
David Chinner20f4ebf2007-02-10 18:36:10 +1100536#define xfs_trans_agblocks_delta(tp, d) ((tp)->t_ag_freeblks_delta += (int64_t)d)
537#define xfs_trans_agflist_delta(tp, d) ((tp)->t_ag_flist_delta += (int64_t)d)
538#define xfs_trans_agbtree_delta(tp, d) ((tp)->t_ag_btree_delta += (int64_t)d)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539#else
540#define xfs_trans_agblocks_delta(tp, d)
541#define xfs_trans_agflist_delta(tp, d)
542#define xfs_trans_agbtree_delta(tp, d)
543#endif
544
545/*
546 * XFS transaction mechanism exported interfaces.
547 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548xfs_trans_t *xfs_trans_alloc(struct xfs_mount *, uint);
Christoph Hellwig80641dc2009-10-19 04:00:03 +0000549xfs_trans_t *_xfs_trans_alloc(struct xfs_mount *, uint, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550xfs_trans_t *xfs_trans_dup(xfs_trans_t *);
551int xfs_trans_reserve(xfs_trans_t *, uint, uint, uint,
552 uint, uint);
David Chinner20f4ebf2007-02-10 18:36:10 +1100553void xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554struct xfs_buf *xfs_trans_get_buf(xfs_trans_t *, struct xfs_buftarg *, xfs_daddr_t,
555 int, uint);
556int xfs_trans_read_buf(struct xfs_mount *, xfs_trans_t *,
557 struct xfs_buftarg *, xfs_daddr_t, int, uint,
558 struct xfs_buf **);
559struct xfs_buf *xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *, int);
560
561void xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
562void xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
563void xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
Tim Shimminefa092f2005-09-05 08:29:01 +1000564void xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565void xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
566void xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567void xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
568void xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
569void xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
570int xfs_trans_iget(struct xfs_mount *, xfs_trans_t *,
571 xfs_ino_t , uint, uint, struct xfs_inode **);
572void xfs_trans_ijoin(xfs_trans_t *, struct xfs_inode *, uint);
573void xfs_trans_ihold(xfs_trans_t *, struct xfs_inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574void xfs_trans_log_buf(xfs_trans_t *, struct xfs_buf *, uint, uint);
575void xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
576struct xfs_efi_log_item *xfs_trans_get_efi(xfs_trans_t *, uint);
577void xfs_efi_release(struct xfs_efi_log_item *, uint);
578void xfs_trans_log_efi_extent(xfs_trans_t *,
579 struct xfs_efi_log_item *,
580 xfs_fsblock_t,
581 xfs_extlen_t);
582struct xfs_efd_log_item *xfs_trans_get_efd(xfs_trans_t *,
583 struct xfs_efi_log_item *,
584 uint);
585void xfs_trans_log_efd_extent(xfs_trans_t *,
586 struct xfs_efd_log_item *,
587 xfs_fsblock_t,
588 xfs_extlen_t);
Christoph Hellwigf538d4d2005-11-02 10:26:59 +1100589int _xfs_trans_commit(xfs_trans_t *,
590 uint flags,
Christoph Hellwigf538d4d2005-11-02 10:26:59 +1100591 int *);
Eric Sandeen1c72bf92007-05-08 13:48:42 +1000592#define xfs_trans_commit(tp, flags) _xfs_trans_commit(tp, flags, NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593void xfs_trans_cancel(xfs_trans_t *, int);
David Chinner249a8c12008-02-05 12:13:32 +1100594int xfs_trans_ail_init(struct xfs_mount *);
595void xfs_trans_ail_destroy(struct xfs_mount *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
David Chinnera8272ce2007-11-23 16:28:09 +1100597extern kmem_zone_t *xfs_trans_zone;
598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599#endif /* __KERNEL__ */
600
Barry Naujok847fff52008-10-30 17:05:38 +1100601void xfs_trans_init(struct xfs_mount *);
602int xfs_trans_roll(struct xfs_trans **, struct xfs_inode *);
603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604#endif /* __XFS_TRANS_H__ */