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 */ 33 static 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_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 67 68 /* 69 * Flags to xfs_log_force() 70 * 71 * XFS_LOG_SYNC: Synchronous force in-core log to disk 72 */ 73 #define XFS_LOG_SYNC 0x1 74 75 #endif /* __KERNEL__ */ 76 77 78 /* Log Clients */ 79 #define XFS_TRANSACTION 0x69 80 #define XFS_VOLUME 0x2 81 #define XFS_LOG 0xaa 82 83 84 /* Region types for iovec's i_type */ 85 #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 105 106 typedef struct xfs_log_iovec { 107 xfs_caddr_t i_addr; /* beginning address of region */ 108 int i_len; /* length in bytes of region */ 109 uint i_type; /* type of region */ 110 } xfs_log_iovec_t; 111 112 struct 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 */ 116 struct xfs_log_item *lv_item; /* owner */ 117 char *lv_buf; /* formatted buffer */ 118 int lv_buf_len; /* size of formatted buffer */ 119 }; 120 121 /* 122 * Structure used to pass callback function and the function's argument 123 * to the log manager. 124 */ 125 typedef 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 */ 134 struct xfs_mount; 135 struct xlog_in_core; 136 struct xlog_ticket; 137 struct xfs_log_item; 138 struct xfs_item_ops; 139 struct xfs_trans; 140 141 void xfs_log_item_init(struct xfs_mount *mp, 142 struct xfs_log_item *item, 143 int type, 144 struct xfs_item_ops *ops); 145 146 xfs_lsn_t xfs_log_done(struct xfs_mount *mp, 147 struct xlog_ticket *ticket, 148 struct xlog_in_core **iclog, 149 uint flags); 150 int _xfs_log_force(struct xfs_mount *mp, 151 uint flags, 152 int *log_forced); 153 void xfs_log_force(struct xfs_mount *mp, 154 uint flags); 155 int _xfs_log_force_lsn(struct xfs_mount *mp, 156 xfs_lsn_t lsn, 157 uint flags, 158 int *log_forced); 159 void xfs_log_force_lsn(struct xfs_mount *mp, 160 xfs_lsn_t lsn, 161 uint flags); 162 int xfs_log_mount(struct xfs_mount *mp, 163 struct xfs_buftarg *log_target, 164 xfs_daddr_t start_block, 165 int num_bblocks); 166 int xfs_log_mount_finish(struct xfs_mount *mp); 167 void xfs_log_move_tail(struct xfs_mount *mp, 168 xfs_lsn_t tail_lsn); 169 int xfs_log_notify(struct xfs_mount *mp, 170 struct xlog_in_core *iclog, 171 xfs_log_callback_t *callback_entry); 172 int xfs_log_release_iclog(struct xfs_mount *mp, 173 struct xlog_in_core *iclog); 174 int xfs_log_reserve(struct xfs_mount *mp, 175 int length, 176 int count, 177 struct xlog_ticket **ticket, 178 __uint8_t clientid, 179 uint flags, 180 uint t_type); 181 int xfs_log_write(struct xfs_mount *mp, 182 xfs_log_iovec_t region[], 183 int nentries, 184 struct xlog_ticket *ticket, 185 xfs_lsn_t *start_lsn); 186 int xfs_log_unmount_write(struct xfs_mount *mp); 187 void xfs_log_unmount(struct xfs_mount *mp); 188 int xfs_log_force_umount(struct xfs_mount *mp, int logerror); 189 int xfs_log_need_covered(struct xfs_mount *mp); 190 191 void xlog_iodone(struct xfs_buf *); 192 193 struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket); 194 void xfs_log_ticket_put(struct xlog_ticket *ticket); 195 196 xlog_tid_t xfs_log_get_trans_ident(struct xfs_trans *tp); 197 198 int 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); 201 bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip); 202 203 #endif 204 205 206 extern int xlog_debug; /* set to 1 to enable real log */ 207 208 209 #endif /* __XFS_LOG_H__ */ 210