xfs_log.h 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  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. /* get lsn fields */
  21. #define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
  22. #define BLOCK_LSN(lsn) ((uint)(lsn))
  23. /* this is used in a spot where we might otherwise double-endian-flip */
  24. #define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0])
  25. #ifdef __KERNEL__
  26. /*
  27. * By comparing each component, we don't have to worry about extra
  28. * endian issues in treating two 32 bit numbers as one 64 bit number
  29. */
  30. static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
  31. {
  32. if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
  33. return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
  34. if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
  35. return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
  36. return 0;
  37. }
  38. #define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
  39. /*
  40. * Macros, structures, prototypes for interface to the log manager.
  41. */
  42. /*
  43. * Flags to xfs_log_done()
  44. */
  45. #define XFS_LOG_REL_PERM_RESERV 0x1
  46. /*
  47. * Flags to xfs_log_reserve()
  48. *
  49. * XFS_LOG_PERM_RESERV: Permanent reservation. When writes are
  50. * performed against this type of reservation, the reservation
  51. * is not decreased. Long running transactions should use this.
  52. */
  53. #define XFS_LOG_PERM_RESERV 0x2
  54. /*
  55. * Flags to xfs_log_force()
  56. *
  57. * XFS_LOG_SYNC: Synchronous force in-core log to disk
  58. */
  59. #define XFS_LOG_SYNC 0x1
  60. #endif /* __KERNEL__ */
  61. /* Log Clients */
  62. #define XFS_TRANSACTION 0x69
  63. #define XFS_VOLUME 0x2
  64. #define XFS_LOG 0xaa
  65. /* Region types for iovec's i_type */
  66. #define XLOG_REG_TYPE_BFORMAT 1
  67. #define XLOG_REG_TYPE_BCHUNK 2
  68. #define XLOG_REG_TYPE_EFI_FORMAT 3
  69. #define XLOG_REG_TYPE_EFD_FORMAT 4
  70. #define XLOG_REG_TYPE_IFORMAT 5
  71. #define XLOG_REG_TYPE_ICORE 6
  72. #define XLOG_REG_TYPE_IEXT 7
  73. #define XLOG_REG_TYPE_IBROOT 8
  74. #define XLOG_REG_TYPE_ILOCAL 9
  75. #define XLOG_REG_TYPE_IATTR_EXT 10
  76. #define XLOG_REG_TYPE_IATTR_BROOT 11
  77. #define XLOG_REG_TYPE_IATTR_LOCAL 12
  78. #define XLOG_REG_TYPE_QFORMAT 13
  79. #define XLOG_REG_TYPE_DQUOT 14
  80. #define XLOG_REG_TYPE_QUOTAOFF 15
  81. #define XLOG_REG_TYPE_LRHEADER 16
  82. #define XLOG_REG_TYPE_UNMOUNT 17
  83. #define XLOG_REG_TYPE_COMMIT 18
  84. #define XLOG_REG_TYPE_TRANSHDR 19
  85. #define XLOG_REG_TYPE_MAX 19
  86. typedef struct xfs_log_iovec {
  87. void *i_addr; /* beginning address of region */
  88. int i_len; /* length in bytes of region */
  89. uint i_type; /* type of region */
  90. } xfs_log_iovec_t;
  91. struct xfs_log_vec {
  92. struct xfs_log_vec *lv_next; /* next lv in build list */
  93. int lv_niovecs; /* number of iovecs in lv */
  94. struct xfs_log_iovec *lv_iovecp; /* iovec array */
  95. struct xfs_log_item *lv_item; /* owner */
  96. char *lv_buf; /* formatted buffer */
  97. int lv_buf_len; /* size of formatted buffer */
  98. };
  99. /*
  100. * Structure used to pass callback function and the function's argument
  101. * to the log manager.
  102. */
  103. typedef struct xfs_log_callback {
  104. struct xfs_log_callback *cb_next;
  105. void (*cb_func)(void *, int);
  106. void *cb_arg;
  107. } xfs_log_callback_t;
  108. #ifdef __KERNEL__
  109. /* Log manager interfaces */
  110. struct xfs_mount;
  111. struct xlog_in_core;
  112. struct xlog_ticket;
  113. struct xfs_log_item;
  114. struct xfs_item_ops;
  115. struct xfs_trans;
  116. void xfs_log_item_init(struct xfs_mount *mp,
  117. struct xfs_log_item *item,
  118. int type,
  119. struct xfs_item_ops *ops);
  120. xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
  121. struct xlog_ticket *ticket,
  122. struct xlog_in_core **iclog,
  123. uint flags);
  124. int _xfs_log_force(struct xfs_mount *mp,
  125. uint flags,
  126. int *log_forced);
  127. void xfs_log_force(struct xfs_mount *mp,
  128. uint flags);
  129. int _xfs_log_force_lsn(struct xfs_mount *mp,
  130. xfs_lsn_t lsn,
  131. uint flags,
  132. int *log_forced);
  133. void xfs_log_force_lsn(struct xfs_mount *mp,
  134. xfs_lsn_t lsn,
  135. uint flags);
  136. int xfs_log_mount(struct xfs_mount *mp,
  137. struct xfs_buftarg *log_target,
  138. xfs_daddr_t start_block,
  139. int num_bblocks);
  140. int xfs_log_mount_finish(struct xfs_mount *mp);
  141. void xfs_log_move_tail(struct xfs_mount *mp,
  142. xfs_lsn_t tail_lsn);
  143. int xfs_log_notify(struct xfs_mount *mp,
  144. struct xlog_in_core *iclog,
  145. xfs_log_callback_t *callback_entry);
  146. int xfs_log_release_iclog(struct xfs_mount *mp,
  147. struct xlog_in_core *iclog);
  148. int xfs_log_reserve(struct xfs_mount *mp,
  149. int length,
  150. int count,
  151. struct xlog_ticket **ticket,
  152. __uint8_t clientid,
  153. uint flags,
  154. uint t_type);
  155. int xfs_log_write(struct xfs_mount *mp,
  156. xfs_log_iovec_t region[],
  157. int nentries,
  158. struct xlog_ticket *ticket,
  159. xfs_lsn_t *start_lsn);
  160. int xfs_log_unmount_write(struct xfs_mount *mp);
  161. void xfs_log_unmount(struct xfs_mount *mp);
  162. int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
  163. int xfs_log_need_covered(struct xfs_mount *mp);
  164. void xlog_iodone(struct xfs_buf *);
  165. struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
  166. void xfs_log_ticket_put(struct xlog_ticket *ticket);
  167. void xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
  168. struct xfs_log_vec *log_vector,
  169. xfs_lsn_t *commit_lsn, int flags);
  170. bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
  171. #endif
  172. #endif /* __XFS_LOG_H__ */