Loading...
1/*
2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
4 *
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.
8 *
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.
13 *
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
17 */
18#ifndef __XFS_LOG_H__
19#define __XFS_LOG_H__
20
21struct xfs_log_vec {
22 struct xfs_log_vec *lv_next; /* next lv in build list */
23 int lv_niovecs; /* number of iovecs in lv */
24 struct xfs_log_iovec *lv_iovecp; /* iovec array */
25 struct xfs_log_item *lv_item; /* owner */
26 char *lv_buf; /* formatted buffer */
27 int lv_bytes; /* accounted space in buffer */
28 int lv_buf_len; /* aligned size of buffer */
29 int lv_size; /* size of allocated lv */
30};
31
32#define XFS_LOG_VEC_ORDERED (-1)
33
34static inline void *
35xlog_prepare_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp,
36 uint type)
37{
38 struct xfs_log_iovec *vec = *vecp;
39
40 if (vec) {
41 ASSERT(vec - lv->lv_iovecp < lv->lv_niovecs);
42 vec++;
43 } else {
44 vec = &lv->lv_iovecp[0];
45 }
46
47 vec->i_type = type;
48 vec->i_addr = lv->lv_buf + lv->lv_buf_len;
49
50 ASSERT(IS_ALIGNED((unsigned long)vec->i_addr, sizeof(uint64_t)));
51
52 *vecp = vec;
53 return vec->i_addr;
54}
55
56/*
57 * We need to make sure the next buffer is naturally aligned for the biggest
58 * basic data type we put into it. We already accounted for this padding when
59 * sizing the buffer.
60 *
61 * However, this padding does not get written into the log, and hence we have to
62 * track the space used by the log vectors separately to prevent log space hangs
63 * due to inaccurate accounting (i.e. a leak) of the used log space through the
64 * CIL context ticket.
65 */
66static inline void
67xlog_finish_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec *vec, int len)
68{
69 lv->lv_buf_len += round_up(len, sizeof(uint64_t));
70 lv->lv_bytes += len;
71 vec->i_len = len;
72}
73
74static inline void *
75xlog_copy_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp,
76 uint type, void *data, int len)
77{
78 void *buf;
79
80 buf = xlog_prepare_iovec(lv, vecp, type);
81 memcpy(buf, data, len);
82 xlog_finish_iovec(lv, *vecp, len);
83 return buf;
84}
85
86/*
87 * Structure used to pass callback function and the function's argument
88 * to the log manager.
89 */
90typedef struct xfs_log_callback {
91 struct xfs_log_callback *cb_next;
92 void (*cb_func)(void *, int);
93 void *cb_arg;
94} xfs_log_callback_t;
95
96/*
97 * By comparing each component, we don't have to worry about extra
98 * endian issues in treating two 32 bit numbers as one 64 bit number
99 */
100static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
101{
102 if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
103 return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
104
105 if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
106 return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
107
108 return 0;
109}
110
111#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
112
113/*
114 * Flags to xfs_log_force()
115 *
116 * XFS_LOG_SYNC: Synchronous force in-core log to disk
117 */
118#define XFS_LOG_SYNC 0x1
119
120/* Log manager interfaces */
121struct xfs_mount;
122struct xlog_in_core;
123struct xlog_ticket;
124struct xfs_log_item;
125struct xfs_item_ops;
126struct xfs_trans;
127
128xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
129 struct xlog_ticket *ticket,
130 struct xlog_in_core **iclog,
131 bool regrant);
132int xfs_log_force(struct xfs_mount *mp, uint flags);
133int xfs_log_force_lsn(struct xfs_mount *mp, xfs_lsn_t lsn, uint flags,
134 int *log_forced);
135int xfs_log_mount(struct xfs_mount *mp,
136 struct xfs_buftarg *log_target,
137 xfs_daddr_t start_block,
138 int num_bblocks);
139int xfs_log_mount_finish(struct xfs_mount *mp);
140int xfs_log_mount_cancel(struct xfs_mount *);
141xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
142xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
143void xfs_log_space_wake(struct xfs_mount *mp);
144int xfs_log_notify(struct xlog_in_core *iclog,
145 struct xfs_log_callback *callback_entry);
146int xfs_log_release_iclog(struct xfs_mount *mp,
147 struct xlog_in_core *iclog);
148int xfs_log_reserve(struct xfs_mount *mp,
149 int length,
150 int count,
151 struct xlog_ticket **ticket,
152 uint8_t clientid,
153 bool permanent);
154int xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
155void xfs_log_unmount(struct xfs_mount *mp);
156int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
157
158struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
159void xfs_log_ticket_put(struct xlog_ticket *ticket);
160
161void xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
162 xfs_lsn_t *commit_lsn, bool regrant);
163bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
164
165void xfs_log_work_queue(struct xfs_mount *mp);
166void xfs_log_quiesce(struct xfs_mount *mp);
167bool xfs_log_check_lsn(struct xfs_mount *, xfs_lsn_t);
168
169#endif /* __XFS_LOG_H__ */
1/*
2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
4 *
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.
8 *
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.
13 *
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
17 */
18#ifndef __XFS_LOG_H__
19#define __XFS_LOG_H__
20
21/* get lsn fields */
22#define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
23#define BLOCK_LSN(lsn) ((uint)(lsn))
24
25/* this is used in a spot where we might otherwise double-endian-flip */
26#define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0])
27
28#ifdef __KERNEL__
29/*
30 * By comparing each component, we don't have to worry about extra
31 * endian issues in treating two 32 bit numbers as one 64 bit number
32 */
33static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
34{
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/*
51 * Flags to xfs_log_done()
52 */
53#define XFS_LOG_REL_PERM_RESERV 0x1
54
55/*
56 * Flags to xfs_log_force()
57 *
58 * XFS_LOG_SYNC: Synchronous force in-core log to disk
59 */
60#define XFS_LOG_SYNC 0x1
61
62#endif /* __KERNEL__ */
63
64
65/* Log Clients */
66#define XFS_TRANSACTION 0x69
67#define XFS_VOLUME 0x2
68#define XFS_LOG 0xaa
69
70
71/* Region types for iovec's i_type */
72#define XLOG_REG_TYPE_BFORMAT 1
73#define XLOG_REG_TYPE_BCHUNK 2
74#define XLOG_REG_TYPE_EFI_FORMAT 3
75#define XLOG_REG_TYPE_EFD_FORMAT 4
76#define XLOG_REG_TYPE_IFORMAT 5
77#define XLOG_REG_TYPE_ICORE 6
78#define XLOG_REG_TYPE_IEXT 7
79#define XLOG_REG_TYPE_IBROOT 8
80#define XLOG_REG_TYPE_ILOCAL 9
81#define XLOG_REG_TYPE_IATTR_EXT 10
82#define XLOG_REG_TYPE_IATTR_BROOT 11
83#define XLOG_REG_TYPE_IATTR_LOCAL 12
84#define XLOG_REG_TYPE_QFORMAT 13
85#define XLOG_REG_TYPE_DQUOT 14
86#define XLOG_REG_TYPE_QUOTAOFF 15
87#define XLOG_REG_TYPE_LRHEADER 16
88#define XLOG_REG_TYPE_UNMOUNT 17
89#define XLOG_REG_TYPE_COMMIT 18
90#define XLOG_REG_TYPE_TRANSHDR 19
91#define XLOG_REG_TYPE_MAX 19
92
93typedef struct xfs_log_iovec {
94 void *i_addr; /* beginning address of region */
95 int i_len; /* length in bytes of region */
96 uint i_type; /* type of region */
97} xfs_log_iovec_t;
98
99struct xfs_log_vec {
100 struct xfs_log_vec *lv_next; /* next lv in build list */
101 int lv_niovecs; /* number of iovecs in lv */
102 struct xfs_log_iovec *lv_iovecp; /* iovec array */
103 struct xfs_log_item *lv_item; /* owner */
104 char *lv_buf; /* formatted buffer */
105 int lv_buf_len; /* size of formatted buffer */
106};
107
108/*
109 * Structure used to pass callback function and the function's argument
110 * to the log manager.
111 */
112typedef struct xfs_log_callback {
113 struct xfs_log_callback *cb_next;
114 void (*cb_func)(void *, int);
115 void *cb_arg;
116} xfs_log_callback_t;
117
118
119#ifdef __KERNEL__
120/* Log manager interfaces */
121struct xfs_mount;
122struct xlog_in_core;
123struct xlog_ticket;
124struct xfs_log_item;
125struct xfs_item_ops;
126struct xfs_trans;
127
128void xfs_log_item_init(struct xfs_mount *mp,
129 struct xfs_log_item *item,
130 int type,
131 const struct xfs_item_ops *ops);
132
133xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
134 struct xlog_ticket *ticket,
135 struct xlog_in_core **iclog,
136 uint flags);
137int _xfs_log_force(struct xfs_mount *mp,
138 uint flags,
139 int *log_forced);
140void xfs_log_force(struct xfs_mount *mp,
141 uint flags);
142int _xfs_log_force_lsn(struct xfs_mount *mp,
143 xfs_lsn_t lsn,
144 uint flags,
145 int *log_forced);
146void xfs_log_force_lsn(struct xfs_mount *mp,
147 xfs_lsn_t lsn,
148 uint flags);
149int xfs_log_mount(struct xfs_mount *mp,
150 struct xfs_buftarg *log_target,
151 xfs_daddr_t start_block,
152 int num_bblocks);
153int xfs_log_mount_finish(struct xfs_mount *mp);
154xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
155xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
156void xfs_log_space_wake(struct xfs_mount *mp);
157int xfs_log_notify(struct xfs_mount *mp,
158 struct xlog_in_core *iclog,
159 xfs_log_callback_t *callback_entry);
160int xfs_log_release_iclog(struct xfs_mount *mp,
161 struct xlog_in_core *iclog);
162int xfs_log_reserve(struct xfs_mount *mp,
163 int length,
164 int count,
165 struct xlog_ticket **ticket,
166 __uint8_t clientid,
167 bool permanent,
168 uint t_type);
169int xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
170int xfs_log_unmount_write(struct xfs_mount *mp);
171void xfs_log_unmount(struct xfs_mount *mp);
172int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
173int xfs_log_need_covered(struct xfs_mount *mp);
174
175void xlog_iodone(struct xfs_buf *);
176
177struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
178void xfs_log_ticket_put(struct xlog_ticket *ticket);
179
180int xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
181 xfs_lsn_t *commit_lsn, int flags);
182bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
183
184#endif
185#endif /* __XFS_LOG_H__ */