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 struct 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_buf_len; /* size of formatted buffer */ 28 int lv_size; /* size of allocated lv */ 29 }; 30 31 #define XFS_LOG_VEC_ORDERED (-1) 32 33 static inline void * 34 xlog_prepare_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp, 35 uint type) 36 { 37 struct xfs_log_iovec *vec = *vecp; 38 39 if (vec) { 40 ASSERT(vec - lv->lv_iovecp < lv->lv_niovecs); 41 vec++; 42 } else { 43 vec = &lv->lv_iovecp[0]; 44 } 45 46 vec->i_type = type; 47 vec->i_addr = lv->lv_buf + lv->lv_buf_len; 48 49 ASSERT(IS_ALIGNED((unsigned long)vec->i_addr, sizeof(uint64_t))); 50 51 *vecp = vec; 52 return vec->i_addr; 53 } 54 55 static inline void 56 xlog_finish_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec *vec, int len) 57 { 58 /* 59 * We need to make sure the next buffer is naturally aligned for the 60 * biggest basic data type we put into it. We already accounted for 61 * this when sizing the buffer. 62 */ 63 lv->lv_buf_len += round_up(len, sizeof(uint64_t)); 64 vec->i_len = len; 65 } 66 67 static inline void * 68 xlog_copy_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp, 69 uint type, void *data, int len) 70 { 71 void *buf; 72 73 buf = xlog_prepare_iovec(lv, vecp, type); 74 memcpy(buf, data, len); 75 xlog_finish_iovec(lv, *vecp, len); 76 return buf; 77 } 78 79 /* 80 * Structure used to pass callback function and the function's argument 81 * to the log manager. 82 */ 83 typedef struct xfs_log_callback { 84 struct xfs_log_callback *cb_next; 85 void (*cb_func)(void *, int); 86 void *cb_arg; 87 } xfs_log_callback_t; 88 89 /* 90 * By comparing each component, we don't have to worry about extra 91 * endian issues in treating two 32 bit numbers as one 64 bit number 92 */ 93 static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2) 94 { 95 if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2)) 96 return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999; 97 98 if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2)) 99 return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999; 100 101 return 0; 102 } 103 104 #define XFS_LSN_CMP(x,y) _lsn_cmp(x,y) 105 106 /* 107 * Macros, structures, prototypes for interface to the log manager. 108 */ 109 110 /* 111 * Flags to xfs_log_done() 112 */ 113 #define XFS_LOG_REL_PERM_RESERV 0x1 114 115 /* 116 * Flags to xfs_log_force() 117 * 118 * XFS_LOG_SYNC: Synchronous force in-core log to disk 119 */ 120 #define XFS_LOG_SYNC 0x1 121 122 /* Log manager interfaces */ 123 struct xfs_mount; 124 struct xlog_in_core; 125 struct xlog_ticket; 126 struct xfs_log_item; 127 struct xfs_item_ops; 128 struct xfs_trans; 129 struct xfs_log_callback; 130 131 xfs_lsn_t xfs_log_done(struct xfs_mount *mp, 132 struct xlog_ticket *ticket, 133 struct xlog_in_core **iclog, 134 uint flags); 135 int _xfs_log_force(struct xfs_mount *mp, 136 uint flags, 137 int *log_forced); 138 void xfs_log_force(struct xfs_mount *mp, 139 uint flags); 140 int _xfs_log_force_lsn(struct xfs_mount *mp, 141 xfs_lsn_t lsn, 142 uint flags, 143 int *log_forced); 144 void xfs_log_force_lsn(struct xfs_mount *mp, 145 xfs_lsn_t lsn, 146 uint flags); 147 int xfs_log_mount(struct xfs_mount *mp, 148 struct xfs_buftarg *log_target, 149 xfs_daddr_t start_block, 150 int num_bblocks); 151 int xfs_log_mount_finish(struct xfs_mount *mp); 152 xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp); 153 xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp); 154 void xfs_log_space_wake(struct xfs_mount *mp); 155 int xfs_log_notify(struct xfs_mount *mp, 156 struct xlog_in_core *iclog, 157 struct xfs_log_callback *callback_entry); 158 int xfs_log_release_iclog(struct xfs_mount *mp, 159 struct xlog_in_core *iclog); 160 int xfs_log_reserve(struct xfs_mount *mp, 161 int length, 162 int count, 163 struct xlog_ticket **ticket, 164 __uint8_t clientid, 165 bool permanent, 166 uint t_type); 167 int xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic); 168 int xfs_log_unmount_write(struct xfs_mount *mp); 169 void xfs_log_unmount(struct xfs_mount *mp); 170 int xfs_log_force_umount(struct xfs_mount *mp, int logerror); 171 int xfs_log_need_covered(struct xfs_mount *mp); 172 173 void xlog_iodone(struct xfs_buf *); 174 175 struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket); 176 void xfs_log_ticket_put(struct xlog_ticket *ticket); 177 178 void xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp, 179 xfs_lsn_t *commit_lsn, int flags); 180 bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip); 181 182 void xfs_log_work_queue(struct xfs_mount *mp); 183 void xfs_log_worker(struct work_struct *work); 184 void xfs_log_quiesce(struct xfs_mount *mp); 185 186 #endif /* __XFS_LOG_H__ */ 187