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
9 struct xlog_format_buf;
10 struct xfs_cil_ctx;
11
12 /* Region types for iovec's i_type */
13 #define XLOG_REG_TYPE_BFORMAT 1
14 #define XLOG_REG_TYPE_BCHUNK 2
15 #define XLOG_REG_TYPE_EFI_FORMAT 3
16 #define XLOG_REG_TYPE_EFD_FORMAT 4
17 #define XLOG_REG_TYPE_IFORMAT 5
18 #define XLOG_REG_TYPE_ICORE 6
19 #define XLOG_REG_TYPE_IEXT 7
20 #define XLOG_REG_TYPE_IBROOT 8
21 #define XLOG_REG_TYPE_ILOCAL 9
22 #define XLOG_REG_TYPE_IATTR_EXT 10
23 #define XLOG_REG_TYPE_IATTR_BROOT 11
24 #define XLOG_REG_TYPE_IATTR_LOCAL 12
25 #define XLOG_REG_TYPE_QFORMAT 13
26 #define XLOG_REG_TYPE_DQUOT 14
27 #define XLOG_REG_TYPE_QUOTAOFF 15
28 #define XLOG_REG_TYPE_LRHEADER 16
29 #define XLOG_REG_TYPE_UNMOUNT 17
30 #define XLOG_REG_TYPE_COMMIT 18
31 #define XLOG_REG_TYPE_TRANSHDR 19
32 #define XLOG_REG_TYPE_ICREATE 20
33 #define XLOG_REG_TYPE_RUI_FORMAT 21
34 #define XLOG_REG_TYPE_RUD_FORMAT 22
35 #define XLOG_REG_TYPE_CUI_FORMAT 23
36 #define XLOG_REG_TYPE_CUD_FORMAT 24
37 #define XLOG_REG_TYPE_BUI_FORMAT 25
38 #define XLOG_REG_TYPE_BUD_FORMAT 26
39 #define XLOG_REG_TYPE_ATTRI_FORMAT 27
40 #define XLOG_REG_TYPE_ATTRD_FORMAT 28
41 #define XLOG_REG_TYPE_ATTR_NAME 29
42 #define XLOG_REG_TYPE_ATTR_VALUE 30
43 #define XLOG_REG_TYPE_XMI_FORMAT 31
44 #define XLOG_REG_TYPE_XMD_FORMAT 32
45 #define XLOG_REG_TYPE_ATTR_NEWNAME 33
46 #define XLOG_REG_TYPE_ATTR_NEWVALUE 34
47 #define XLOG_REG_TYPE_MAX 34
48
49 #define XFS_LOG_VEC_ORDERED (-1)
50
51 /*
52 * Calculate the log iovec length for a given user buffer length. Intended to be
53 * used by ->iop_size implementations when sizing buffers of arbitrary
54 * alignments.
55 */
56 static inline int
xlog_calc_iovec_len(int len)57 xlog_calc_iovec_len(int len)
58 {
59 return roundup(len, sizeof(uint32_t));
60 }
61
62 void *xlog_format_start(struct xlog_format_buf *lfb, uint16_t type);
63 void xlog_format_commit(struct xlog_format_buf *lfb, unsigned int data_len);
64
65 /*
66 * Copy the amount of data requested by the caller into a new log iovec.
67 */
68 static inline void *
xlog_format_copy(struct xlog_format_buf * lfb,uint16_t type,void * data,unsigned int len)69 xlog_format_copy(
70 struct xlog_format_buf *lfb,
71 uint16_t type,
72 void *data,
73 unsigned int len)
74 {
75 void *buf;
76
77 buf = xlog_format_start(lfb, type);
78 memcpy(buf, data, len);
79 xlog_format_commit(lfb, len);
80 return buf;
81 }
82
83 /*
84 * Flags to xfs_log_force()
85 *
86 * XFS_LOG_SYNC: Synchronous force in-core log to disk
87 */
88 #define XFS_LOG_SYNC 0x1
89
90 /* Log manager interfaces */
91 struct xfs_mount;
92 struct xlog_in_core;
93 struct xlog_ticket;
94 struct xfs_log_item;
95 struct xfs_item_ops;
96 struct xfs_trans;
97 struct xlog;
98
99 int xfs_log_force(struct xfs_mount *mp, uint flags);
100 int xfs_log_force_seq(struct xfs_mount *mp, xfs_csn_t seq, uint flags,
101 int *log_forced);
102 int xfs_log_mount(struct xfs_mount *mp,
103 struct xfs_buftarg *log_target,
104 xfs_daddr_t start_block,
105 int num_bblocks);
106 int xfs_log_mount_finish(struct xfs_mount *mp);
107 void xfs_log_mount_cancel(struct xfs_mount *);
108 void xfs_log_space_wake(struct xfs_mount *mp);
109 int xfs_log_reserve(struct xfs_mount *mp, int length, int count,
110 struct xlog_ticket **ticket, bool permanent);
111 int xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
112 void xfs_log_unmount(struct xfs_mount *mp);
113 bool xfs_log_writable(struct xfs_mount *mp);
114
115 struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
116 void xfs_log_ticket_put(struct xlog_ticket *ticket);
117
118 void xlog_cil_process_committed(struct list_head *list);
119 bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
120
121 void xfs_log_work_queue(struct xfs_mount *mp);
122 int xfs_log_quiesce(struct xfs_mount *mp);
123 void xfs_log_clean(struct xfs_mount *mp);
124 bool xfs_log_check_lsn(struct xfs_mount *, xfs_lsn_t);
125
126 bool xlog_force_shutdown(struct xlog *log, uint32_t shutdown_flags);
127
128 #endif /* __XFS_LOG_H__ */
129