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