^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * All Rights Reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) #ifndef __XFS_LOG_H__
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #define __XFS_LOG_H__
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) struct xfs_cil_ctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) struct xfs_log_vec {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) struct xfs_log_vec *lv_next; /* next lv in build list */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) int lv_niovecs; /* number of iovecs in lv */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) struct xfs_log_iovec *lv_iovecp; /* iovec array */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) struct xfs_log_item *lv_item; /* owner */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) char *lv_buf; /* formatted buffer */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) int lv_bytes; /* accounted space in buffer */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) int lv_buf_len; /* aligned size of buffer */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) int lv_size; /* size of allocated lv */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define XFS_LOG_VEC_ORDERED (-1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) static inline void *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) xlog_prepare_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) uint type)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) struct xfs_log_iovec *vec = *vecp;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) if (vec) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) ASSERT(vec - lv->lv_iovecp < lv->lv_niovecs);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) vec++;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) vec = &lv->lv_iovecp[0];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) vec->i_type = type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) vec->i_addr = lv->lv_buf + lv->lv_buf_len;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) ASSERT(IS_ALIGNED((unsigned long)vec->i_addr, sizeof(uint64_t)));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) *vecp = vec;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) return vec->i_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) * We need to make sure the next buffer is naturally aligned for the biggest
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) * basic data type we put into it. We already accounted for this padding when
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) * sizing the buffer.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) * However, this padding does not get written into the log, and hence we have to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) * track the space used by the log vectors separately to prevent log space hangs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) * due to inaccurate accounting (i.e. a leak) of the used log space through the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) * CIL context ticket.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) static inline void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) xlog_finish_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec *vec, int len)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) lv->lv_buf_len += round_up(len, sizeof(uint64_t));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) lv->lv_bytes += len;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) vec->i_len = len;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) static inline void *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) xlog_copy_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) uint type, void *data, int len)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) void *buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) buf = xlog_prepare_iovec(lv, vecp, type);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) memcpy(buf, data, len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) xlog_finish_iovec(lv, *vecp, len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) return buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) * By comparing each component, we don't have to worry about extra
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * endian issues in treating two 32 bit numbers as one 64 bit number
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) #define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) * Flags to xfs_log_force()
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) * XFS_LOG_SYNC: Synchronous force in-core log to disk
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) #define XFS_LOG_SYNC 0x1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) /* Log manager interfaces */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) struct xfs_mount;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) struct xlog_in_core;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) struct xlog_ticket;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) struct xfs_log_item;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) struct xfs_item_ops;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) struct xfs_trans;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) int xfs_log_force(struct xfs_mount *mp, uint flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) int xfs_log_force_lsn(struct xfs_mount *mp, xfs_lsn_t lsn, uint flags,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) int *log_forced);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) int xfs_log_mount(struct xfs_mount *mp,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) struct xfs_buftarg *log_target,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) xfs_daddr_t start_block,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) int num_bblocks);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) int xfs_log_mount_finish(struct xfs_mount *mp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) void xfs_log_mount_cancel(struct xfs_mount *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) void xfs_log_space_wake(struct xfs_mount *mp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) void xfs_log_release_iclog(struct xlog_in_core *iclog);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) int xfs_log_reserve(struct xfs_mount *mp,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) int length,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) int count,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) struct xlog_ticket **ticket,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) uint8_t clientid,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) bool permanent);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) int xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) void xfs_log_unmount(struct xfs_mount *mp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) void xfs_log_ticket_put(struct xlog_ticket *ticket);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) void xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) xfs_lsn_t *commit_lsn, bool regrant);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) void xlog_cil_process_committed(struct list_head *list);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) void xfs_log_work_queue(struct xfs_mount *mp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) void xfs_log_quiesce(struct xfs_mount *mp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) bool xfs_log_check_lsn(struct xfs_mount *, xfs_lsn_t);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) bool xfs_log_in_recovery(struct xfs_mount *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) xfs_lsn_t xlog_grant_push_threshold(struct xlog *log, int need_bytes);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) #endif /* __XFS_LOG_H__ */