segment.h 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * segment.h - NILFS Segment constructor prototypes and definitions
  4. *
  5. * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
  6. *
  7. * Written by Ryusuke Konishi.
  8. *
  9. */
  10. #ifndef _NILFS_SEGMENT_H
  11. #define _NILFS_SEGMENT_H
  12. #include <linux/types.h>
  13. #include <linux/fs.h>
  14. #include <linux/buffer_head.h>
  15. #include <linux/workqueue.h>
  16. #include "nilfs.h"
  17. struct nilfs_root;
  18. /**
  19. * struct nilfs_recovery_info - Recovery information
  20. * @ri_need_recovery: Recovery status
  21. * @ri_super_root: Block number of the last super root
  22. * @ri_ri_cno: Number of the last checkpoint
  23. * @ri_lsegs_start: Region for roll-forwarding (start block number)
  24. * @ri_lsegs_end: Region for roll-forwarding (end block number)
  25. * @ri_lseg_start_seq: Sequence value of the segment at ri_lsegs_start
  26. * @ri_used_segments: List of segments to be mark active
  27. * @ri_pseg_start: Block number of the last partial segment
  28. * @ri_seq: Sequence number on the last partial segment
  29. * @ri_segnum: Segment number on the last partial segment
  30. * @ri_nextnum: Next segment number on the last partial segment
  31. */
  32. struct nilfs_recovery_info {
  33. int ri_need_recovery;
  34. sector_t ri_super_root;
  35. __u64 ri_cno;
  36. sector_t ri_lsegs_start;
  37. sector_t ri_lsegs_end;
  38. u64 ri_lsegs_start_seq;
  39. struct list_head ri_used_segments;
  40. sector_t ri_pseg_start;
  41. u64 ri_seq;
  42. __u64 ri_segnum;
  43. __u64 ri_nextnum;
  44. };
  45. /* ri_need_recovery */
  46. #define NILFS_RECOVERY_SR_UPDATED 1 /* The super root was updated */
  47. #define NILFS_RECOVERY_ROLLFORWARD_DONE 2 /* Rollforward was carried out */
  48. /**
  49. * struct nilfs_cstage - Context of collection stage
  50. * @scnt: Stage count, must be accessed via wrappers:
  51. * nilfs_sc_cstage_inc(), nilfs_sc_cstage_set(), nilfs_sc_cstage_get()
  52. * @flags: State flags
  53. * @dirty_file_ptr: Pointer on dirty_files list, or inode of a target file
  54. * @gc_inode_ptr: Pointer on the list of gc-inodes
  55. */
  56. struct nilfs_cstage {
  57. int scnt;
  58. unsigned int flags;
  59. struct nilfs_inode_info *dirty_file_ptr;
  60. struct nilfs_inode_info *gc_inode_ptr;
  61. };
  62. struct nilfs_segment_buffer;
  63. struct nilfs_segsum_pointer {
  64. struct buffer_head *bh;
  65. unsigned int offset; /* offset in bytes */
  66. };
  67. /**
  68. * struct nilfs_sc_info - Segment constructor information
  69. * @sc_super: Back pointer to super_block struct
  70. * @sc_root: root object of the current filesystem tree
  71. * @sc_nblk_inc: Block count of current generation
  72. * @sc_dirty_files: List of files to be written
  73. * @sc_gc_inodes: List of GC inodes having blocks to be written
  74. * @sc_iput_queue: list of inodes for which iput should be done
  75. * @sc_iput_work: work struct to defer iput call
  76. * @sc_freesegs: array of segment numbers to be freed
  77. * @sc_nfreesegs: number of segments on @sc_freesegs
  78. * @sc_dsync_inode: inode whose data pages are written for a sync operation
  79. * @sc_dsync_start: start byte offset of data pages
  80. * @sc_dsync_end: end byte offset of data pages (inclusive)
  81. * @sc_segbufs: List of segment buffers
  82. * @sc_write_logs: List of segment buffers to hold logs under writing
  83. * @sc_segbuf_nblocks: Number of available blocks in segment buffers.
  84. * @sc_curseg: Current segment buffer
  85. * @sc_stage: Collection stage
  86. * @sc_finfo_ptr: pointer to the current finfo struct in the segment summary
  87. * @sc_binfo_ptr: pointer to the current binfo struct in the segment summary
  88. * @sc_blk_cnt: Block count of a file
  89. * @sc_datablk_cnt: Data block count of a file
  90. * @sc_nblk_this_inc: Number of blocks included in the current logical segment
  91. * @sc_seg_ctime: Creation time
  92. * @sc_cno: checkpoint number of current log
  93. * @sc_flags: Internal flags
  94. * @sc_state_lock: spinlock for sc_state and so on
  95. * @sc_state: Segctord state flags
  96. * @sc_flush_request: inode bitmap of metadata files to be flushed
  97. * @sc_wait_request: Client request queue
  98. * @sc_wait_daemon: Daemon wait queue
  99. * @sc_wait_task: Start/end wait queue to control segctord task
  100. * @sc_seq_request: Request counter
  101. * @sc_seq_accept: Accepted request count
  102. * @sc_seq_done: Completion counter
  103. * @sc_sync: Request of explicit sync operation
  104. * @sc_interval: Timeout value of background construction
  105. * @sc_mjcp_freq: Frequency of creating checkpoints
  106. * @sc_lseg_stime: Start time of the latest logical segment
  107. * @sc_watermark: Watermark for the number of dirty buffers
  108. * @sc_timer: Timer for segctord
  109. * @sc_task: current thread of segctord
  110. */
  111. struct nilfs_sc_info {
  112. struct super_block *sc_super;
  113. struct nilfs_root *sc_root;
  114. unsigned long sc_nblk_inc;
  115. struct list_head sc_dirty_files;
  116. struct list_head sc_gc_inodes;
  117. struct list_head sc_iput_queue;
  118. struct work_struct sc_iput_work;
  119. __u64 *sc_freesegs;
  120. size_t sc_nfreesegs;
  121. struct nilfs_inode_info *sc_dsync_inode;
  122. loff_t sc_dsync_start;
  123. loff_t sc_dsync_end;
  124. /* Segment buffers */
  125. struct list_head sc_segbufs;
  126. struct list_head sc_write_logs;
  127. unsigned long sc_segbuf_nblocks;
  128. struct nilfs_segment_buffer *sc_curseg;
  129. struct nilfs_cstage sc_stage;
  130. struct nilfs_segsum_pointer sc_finfo_ptr;
  131. struct nilfs_segsum_pointer sc_binfo_ptr;
  132. unsigned long sc_blk_cnt;
  133. unsigned long sc_datablk_cnt;
  134. unsigned long sc_nblk_this_inc;
  135. time64_t sc_seg_ctime;
  136. __u64 sc_cno;
  137. unsigned long sc_flags;
  138. spinlock_t sc_state_lock;
  139. unsigned long sc_state;
  140. unsigned long sc_flush_request;
  141. wait_queue_head_t sc_wait_request;
  142. wait_queue_head_t sc_wait_daemon;
  143. wait_queue_head_t sc_wait_task;
  144. __u32 sc_seq_request;
  145. __u32 sc_seq_accepted;
  146. __u32 sc_seq_done;
  147. int sc_sync;
  148. unsigned long sc_interval;
  149. unsigned long sc_mjcp_freq;
  150. unsigned long sc_lseg_stime; /* in 1/HZ seconds */
  151. unsigned long sc_watermark;
  152. struct timer_list sc_timer;
  153. struct task_struct *sc_timer_task;
  154. struct task_struct *sc_task;
  155. };
  156. /* sc_flags */
  157. enum {
  158. NILFS_SC_DIRTY, /* One or more dirty meta-data blocks exist */
  159. NILFS_SC_UNCLOSED, /* Logical segment is not closed */
  160. NILFS_SC_SUPER_ROOT, /* The latest segment has a super root */
  161. NILFS_SC_PRIOR_FLUSH, /*
  162. * Requesting immediate flush without making a
  163. * checkpoint
  164. */
  165. NILFS_SC_HAVE_DELTA, /*
  166. * Next checkpoint will have update of files
  167. * other than DAT, cpfile, sufile, or files
  168. * moved by GC.
  169. */
  170. };
  171. /* sc_state */
  172. #define NILFS_SEGCTOR_QUIT 0x0001 /* segctord is being destroyed */
  173. #define NILFS_SEGCTOR_COMMIT 0x0004 /* committed transaction exists */
  174. /*
  175. * Constant parameters
  176. */
  177. #define NILFS_SC_CLEANUP_RETRY 3 /*
  178. * Retry count of construction when
  179. * destroying segctord
  180. */
  181. /*
  182. * Default values of timeout, in seconds.
  183. */
  184. #define NILFS_SC_DEFAULT_TIMEOUT 5 /*
  185. * Timeout value of dirty blocks.
  186. * It triggers construction of a
  187. * logical segment with a super root.
  188. */
  189. #define NILFS_SC_DEFAULT_SR_FREQ 30 /*
  190. * Maximum frequency of super root
  191. * creation
  192. */
  193. /*
  194. * The default threshold amount of data, in block counts.
  195. */
  196. #define NILFS_SC_DEFAULT_WATERMARK 3600
  197. /* super.c */
  198. extern struct kmem_cache *nilfs_transaction_cachep;
  199. /* segment.c */
  200. extern void nilfs_relax_pressure_in_lock(struct super_block *);
  201. extern int nilfs_construct_segment(struct super_block *);
  202. extern int nilfs_construct_dsync_segment(struct super_block *, struct inode *,
  203. loff_t, loff_t);
  204. extern void nilfs_flush_segment(struct super_block *, ino_t);
  205. extern int nilfs_clean_segments(struct super_block *, struct nilfs_argv *,
  206. void **);
  207. int nilfs_attach_log_writer(struct super_block *sb, struct nilfs_root *root);
  208. void nilfs_detach_log_writer(struct super_block *sb);
  209. /* recovery.c */
  210. extern int nilfs_read_super_root_block(struct the_nilfs *, sector_t,
  211. struct buffer_head **, int);
  212. extern int nilfs_search_super_root(struct the_nilfs *,
  213. struct nilfs_recovery_info *);
  214. int nilfs_salvage_orphan_logs(struct the_nilfs *nilfs, struct super_block *sb,
  215. struct nilfs_recovery_info *ri);
  216. extern void nilfs_dispose_segment_list(struct list_head *);
  217. #endif /* _NILFS_SEGMENT_H */