xfs_log.h 5.5 KB

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