blob: 04c78e642cc83b237ed0c5d6258f82e0ccdcad26 [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_H__
19#define __XFS_LOG_H__
20
21/* get lsn fields */
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
23#define BLOCK_LSN(lsn) ((uint)(lsn))
Christoph Hellwigb53e6752007-10-12 10:59:34 +100024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/* this is used in a spot where we might otherwise double-endian-flip */
Christoph Hellwigb53e6752007-10-12 10:59:34 +100026#define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0])
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
28#ifdef __KERNEL__
29/*
Nathan Scottc41564b2006-03-29 08:55:14 +100030 * By comparing each component, we don't have to worry about extra
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 * endian issues in treating two 32 bit numbers as one 64 bit number
32 */
Andrew Mortona1365642006-01-08 01:04:09 -080033static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070034{
35 if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
36 return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
37
38 if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
39 return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
40
41 return 0;
42}
43
44#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
45
46/*
47 * Macros, structures, prototypes for interface to the log manager.
48 */
49
50/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * Flags to xfs_log_done()
52 */
53#define XFS_LOG_REL_PERM_RESERV 0x1
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055/*
56 * Flags to xfs_log_reserve()
57 *
58 * XFS_LOG_SLEEP: If space is not available, sleep (default)
59 * XFS_LOG_NOSLEEP: If space is not available, return error
60 * XFS_LOG_PERM_RESERV: Permanent reservation. When writes are
61 * performed against this type of reservation, the reservation
62 * is not decreased. Long running transactions should use this.
63 */
64#define XFS_LOG_SLEEP 0x0
65#define XFS_LOG_NOSLEEP 0x1
66#define XFS_LOG_PERM_RESERV 0x2
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68/*
69 * Flags to xfs_log_force()
70 *
71 * XFS_LOG_SYNC: Synchronous force in-core log to disk
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 */
73#define XFS_LOG_SYNC 0x1
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75#endif /* __KERNEL__ */
76
77
78/* Log Clients */
79#define XFS_TRANSACTION 0x69
80#define XFS_VOLUME 0x2
81#define XFS_LOG 0xaa
82
Tim Shimmin7e9c6392005-09-02 16:42:05 +100083
84/* Region types for iovec's i_type */
Tim Shimmin7e9c6392005-09-02 16:42:05 +100085#define XLOG_REG_TYPE_BFORMAT 1
86#define XLOG_REG_TYPE_BCHUNK 2
87#define XLOG_REG_TYPE_EFI_FORMAT 3
88#define XLOG_REG_TYPE_EFD_FORMAT 4
89#define XLOG_REG_TYPE_IFORMAT 5
90#define XLOG_REG_TYPE_ICORE 6
91#define XLOG_REG_TYPE_IEXT 7
92#define XLOG_REG_TYPE_IBROOT 8
93#define XLOG_REG_TYPE_ILOCAL 9
94#define XLOG_REG_TYPE_IATTR_EXT 10
95#define XLOG_REG_TYPE_IATTR_BROOT 11
96#define XLOG_REG_TYPE_IATTR_LOCAL 12
97#define XLOG_REG_TYPE_QFORMAT 13
98#define XLOG_REG_TYPE_DQUOT 14
99#define XLOG_REG_TYPE_QUOTAOFF 15
100#define XLOG_REG_TYPE_LRHEADER 16
101#define XLOG_REG_TYPE_UNMOUNT 17
102#define XLOG_REG_TYPE_COMMIT 18
103#define XLOG_REG_TYPE_TRANSHDR 19
104#define XLOG_REG_TYPE_MAX 19
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106typedef struct xfs_log_iovec {
Christoph Hellwig4139b3b2010-01-19 09:56:45 +0000107 xfs_caddr_t i_addr; /* beginning address of region */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 int i_len; /* length in bytes of region */
Tim Shimmin12598452006-01-11 21:02:47 +1100109 uint i_type; /* type of region */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110} xfs_log_iovec_t;
111
Dave Chinner55b66332010-03-23 11:43:17 +1100112struct xfs_log_vec {
113 struct xfs_log_vec *lv_next; /* next lv in build list */
114 int lv_niovecs; /* number of iovecs in lv */
115 struct xfs_log_iovec *lv_iovecp; /* iovec array */
Dave Chinner71e330b2010-05-21 14:37:18 +1000116 struct xfs_log_item *lv_item; /* owner */
117 char *lv_buf; /* formatted buffer */
118 int lv_buf_len; /* size of formatted buffer */
Dave Chinner55b66332010-03-23 11:43:17 +1100119};
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121/*
122 * Structure used to pass callback function and the function's argument
123 * to the log manager.
124 */
125typedef struct xfs_log_callback {
126 struct xfs_log_callback *cb_next;
127 void (*cb_func)(void *, int);
128 void *cb_arg;
129} xfs_log_callback_t;
130
131
132#ifdef __KERNEL__
133/* Log manager interfaces */
134struct xfs_mount;
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000135struct xlog_in_core;
Dave Chinnercc09c0d2008-11-17 17:37:10 +1100136struct xlog_ticket;
Dave Chinner43f5efc2010-03-23 10:10:00 +1100137struct xfs_log_item;
138struct xfs_item_ops;
Dave Chinner955833c2010-05-14 21:41:46 +1000139struct xfs_trans;
Dave Chinner43f5efc2010-03-23 10:10:00 +1100140
141void xfs_log_item_init(struct xfs_mount *mp,
142 struct xfs_log_item *item,
143 int type,
144 struct xfs_item_ops *ops);
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000147 struct xlog_ticket *ticket,
148 struct xlog_in_core **iclog,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 uint flags);
Christoph Hellwigf538d4d2005-11-02 10:26:59 +1100150int _xfs_log_force(struct xfs_mount *mp,
Christoph Hellwigf538d4d2005-11-02 10:26:59 +1100151 uint flags,
152 int *log_forced);
David Chinnerb911ca02008-04-10 12:24:30 +1000153void xfs_log_force(struct xfs_mount *mp,
David Chinnerb911ca02008-04-10 12:24:30 +1000154 uint flags);
Christoph Hellwiga14a3482010-01-19 09:56:46 +0000155int _xfs_log_force_lsn(struct xfs_mount *mp,
156 xfs_lsn_t lsn,
157 uint flags,
158 int *log_forced);
159void xfs_log_force_lsn(struct xfs_mount *mp,
160 xfs_lsn_t lsn,
161 uint flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162int xfs_log_mount(struct xfs_mount *mp,
163 struct xfs_buftarg *log_target,
164 xfs_daddr_t start_block,
165 int num_bblocks);
Christoph Hellwig42490232008-08-13 16:49:32 +1000166int xfs_log_mount_finish(struct xfs_mount *mp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167void xfs_log_move_tail(struct xfs_mount *mp,
168 xfs_lsn_t tail_lsn);
169int xfs_log_notify(struct xfs_mount *mp,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000170 struct xlog_in_core *iclog,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 xfs_log_callback_t *callback_entry);
172int xfs_log_release_iclog(struct xfs_mount *mp,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000173 struct xlog_in_core *iclog);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174int xfs_log_reserve(struct xfs_mount *mp,
175 int length,
176 int count,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000177 struct xlog_ticket **ticket,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 __uint8_t clientid,
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000179 uint flags,
180 uint t_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181int xfs_log_write(struct xfs_mount *mp,
182 xfs_log_iovec_t region[],
183 int nentries,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000184 struct xlog_ticket *ticket,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 xfs_lsn_t *start_lsn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186int xfs_log_unmount_write(struct xfs_mount *mp);
Christoph Hellwig21b699c2009-03-16 08:19:29 +0100187void xfs_log_unmount(struct xfs_mount *mp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
189int xfs_log_need_covered(struct xfs_mount *mp);
190
191void xlog_iodone(struct xfs_buf *);
192
Dave Chinner71e330b2010-05-21 14:37:18 +1000193struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
Dave Chinnercc09c0d2008-11-17 17:37:10 +1100194void xfs_log_ticket_put(struct xlog_ticket *ticket);
195
Dave Chinner955833c2010-05-14 21:41:46 +1000196xlog_tid_t xfs_log_get_trans_ident(struct xfs_trans *tp);
197
Dave Chinner71e330b2010-05-21 14:37:18 +1000198int xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
199 struct xfs_log_vec *log_vector,
200 xfs_lsn_t *commit_lsn, int flags);
Dave Chinnerccf7c232010-05-20 23:19:42 +1000201bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
Dave Chinner71e330b2010-05-21 14:37:18 +1000202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203#endif
204
205
206extern int xlog_debug; /* set to 1 to enable real log */
207
208
209#endif /* __XFS_LOG_H__ */