blob: ebbe93f4f97bc7925a458996e2f8c11943223f9a [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 */
22
23#define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
24#define BLOCK_LSN(lsn) ((uint)(lsn))
25/* this is used in a spot where we might otherwise double-endian-flip */
26#define CYCLE_LSN_DISK(lsn) (((uint *)&(lsn))[0])
27
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
72 * XFS_LOG_FORCE: Start in-core log write now.
73 * XFS_LOG_URGE: Start write within some window of time.
74 *
75 * Note: Either XFS_LOG_FORCE or XFS_LOG_URGE must be set.
76 */
77#define XFS_LOG_SYNC 0x1
78#define XFS_LOG_FORCE 0x2
79#define XFS_LOG_URGE 0x4
80
81#endif /* __KERNEL__ */
82
83
84/* Log Clients */
85#define XFS_TRANSACTION 0x69
86#define XFS_VOLUME 0x2
87#define XFS_LOG 0xaa
88
Tim Shimmin7e9c6392005-09-02 16:42:05 +100089
90/* Region types for iovec's i_type */
Tim Shimmin7e9c6392005-09-02 16:42:05 +100091#define XLOG_REG_TYPE_BFORMAT 1
92#define XLOG_REG_TYPE_BCHUNK 2
93#define XLOG_REG_TYPE_EFI_FORMAT 3
94#define XLOG_REG_TYPE_EFD_FORMAT 4
95#define XLOG_REG_TYPE_IFORMAT 5
96#define XLOG_REG_TYPE_ICORE 6
97#define XLOG_REG_TYPE_IEXT 7
98#define XLOG_REG_TYPE_IBROOT 8
99#define XLOG_REG_TYPE_ILOCAL 9
100#define XLOG_REG_TYPE_IATTR_EXT 10
101#define XLOG_REG_TYPE_IATTR_BROOT 11
102#define XLOG_REG_TYPE_IATTR_LOCAL 12
103#define XLOG_REG_TYPE_QFORMAT 13
104#define XLOG_REG_TYPE_DQUOT 14
105#define XLOG_REG_TYPE_QUOTAOFF 15
106#define XLOG_REG_TYPE_LRHEADER 16
107#define XLOG_REG_TYPE_UNMOUNT 17
108#define XLOG_REG_TYPE_COMMIT 18
109#define XLOG_REG_TYPE_TRANSHDR 19
110#define XLOG_REG_TYPE_MAX 19
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000111
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000112#define XLOG_VEC_SET_TYPE(vecp, t) ((vecp)->i_type = (t))
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114typedef struct xfs_log_iovec {
115 xfs_caddr_t i_addr; /* beginning address of region */
116 int i_len; /* length in bytes of region */
Tim Shimmin12598452006-01-11 21:02:47 +1100117 uint i_type; /* type of region */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118} xfs_log_iovec_t;
119
120typedef void* xfs_log_ticket_t;
121
122/*
123 * Structure used to pass callback function and the function's argument
124 * to the log manager.
125 */
126typedef struct xfs_log_callback {
127 struct xfs_log_callback *cb_next;
128 void (*cb_func)(void *, int);
129 void *cb_arg;
130} xfs_log_callback_t;
131
132
133#ifdef __KERNEL__
134/* Log manager interfaces */
135struct xfs_mount;
136xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
137 xfs_log_ticket_t ticket,
138 void **iclog,
139 uint flags);
Christoph Hellwigf538d4d2005-11-02 10:26:59 +1100140int _xfs_log_force(struct xfs_mount *mp,
141 xfs_lsn_t lsn,
142 uint flags,
143 int *log_forced);
144#define xfs_log_force(mp, lsn, flags) \
145 _xfs_log_force(mp, lsn, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146int xfs_log_mount(struct xfs_mount *mp,
147 struct xfs_buftarg *log_target,
148 xfs_daddr_t start_block,
149 int num_bblocks);
150int xfs_log_mount_finish(struct xfs_mount *mp, int);
151void xfs_log_move_tail(struct xfs_mount *mp,
152 xfs_lsn_t tail_lsn);
153int xfs_log_notify(struct xfs_mount *mp,
154 void *iclog,
155 xfs_log_callback_t *callback_entry);
156int xfs_log_release_iclog(struct xfs_mount *mp,
157 void *iclog_hndl);
158int xfs_log_reserve(struct xfs_mount *mp,
159 int length,
160 int count,
161 xfs_log_ticket_t *ticket,
162 __uint8_t clientid,
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000163 uint flags,
164 uint t_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165int xfs_log_write(struct xfs_mount *mp,
166 xfs_log_iovec_t region[],
167 int nentries,
168 xfs_log_ticket_t ticket,
169 xfs_lsn_t *start_lsn);
170int xfs_log_unmount(struct xfs_mount *mp);
171int xfs_log_unmount_write(struct xfs_mount *mp);
172void xfs_log_unmount_dealloc(struct xfs_mount *mp);
173int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
174int xfs_log_need_covered(struct xfs_mount *mp);
175
176void xlog_iodone(struct xfs_buf *);
177
178#endif
179
180
181extern int xlog_debug; /* set to 1 to enable real log */
182
183
184#endif /* __XFS_LOG_H__ */