softdep.h 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105
  1. /*-
  2. * Copyright 1998, 2000 Marshall Kirk McKusick. All Rights Reserved.
  3. *
  4. * The soft updates code is derived from the appendix of a University
  5. * of Michigan technical report (Gregory R. Ganger and Yale N. Patt,
  6. * "Soft Updates: A Solution to the Metadata Update Problem in File
  7. * Systems", CSE-TR-254-95, August 1995).
  8. *
  9. * Further information about soft updates can be obtained from:
  10. *
  11. * Marshall Kirk McKusick http://www.mckusick.com/softdep/
  12. * 1614 Oxford Street mckusick@mckusick.com
  13. * Berkeley, CA 94709-1608 +1-510-843-9542
  14. * USA
  15. *
  16. * Redistribution and use in source and binary forms, with or without
  17. * modification, are permitted provided that the following conditions
  18. * are met:
  19. *
  20. * 1. Redistributions of source code must retain the above copyright
  21. * notice, this list of conditions and the following disclaimer.
  22. * 2. Redistributions in binary form must reproduce the above copyright
  23. * notice, this list of conditions and the following disclaimer in the
  24. * documentation and/or other materials provided with the distribution.
  25. *
  26. * THIS SOFTWARE IS PROVIDED BY MARSHALL KIRK MCKUSICK ``AS IS'' AND ANY
  27. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29. * DISCLAIMED. IN NO EVENT SHALL MARSHALL KIRK MCKUSICK BE LIABLE FOR
  30. * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36. * SUCH DAMAGE.
  37. *
  38. * @(#)softdep.h 9.7 (McKusick) 6/21/00
  39. * $FreeBSD$
  40. */
  41. typedef struct Fs Fs;
  42. /*
  43. * Allocation dependencies are handled with undo/redo on the in-memory
  44. * copy of the data. A particular data dependency is eliminated when
  45. * it is ALLCOMPLETE: that is ATTACHED, DEPCOMPLETE, and COMPLETE.
  46. *
  47. * The ATTACHED flag means that the data is not currently being written
  48. * to disk.
  49. *
  50. * The UNDONE flag means that the data has been rolled back to a safe
  51. * state for writing to the disk. When the I/O completes, the data is
  52. * restored to its current form and the state reverts to ATTACHED.
  53. * The data must be locked throughout the rollback, I/O, and roll
  54. * forward so that the rolled back information is never visible to
  55. * user processes.
  56. *
  57. * The COMPLETE flag indicates that the item has been written. For example,
  58. * a dependency that requires that an inode be written will be marked
  59. * COMPLETE after the inode has been written to disk.
  60. *
  61. * The DEPCOMPLETE flag indicates the completion of any other
  62. * dependencies such as the writing of a cylinder group map has been
  63. * completed. A dependency structure may be freed only when both it
  64. * and its dependencies have completed and any rollbacks that are in
  65. * progress have finished as indicated by the set of ALLCOMPLETE flags
  66. * all being set.
  67. *
  68. * The two MKDIR flags indicate additional dependencies that must be done
  69. * when creating a new directory. MKDIR_BODY is cleared when the directory
  70. * data block containing the "." and ".." entries has been written.
  71. * MKDIR_PARENT is cleared when the parent inode with the increased link
  72. * count for ".." has been written. When both MKDIR flags have been
  73. * cleared, the DEPCOMPLETE flag is set to indicate that the directory
  74. * dependencies have been completed. The writing of the directory inode
  75. * itself sets the COMPLETE flag which then allows the directory entry for
  76. * the new directory to be written to disk. The RMDIR flag marks a dirrem
  77. * structure as representing the removal of a directory rather than a
  78. * file. When the removal dependencies are completed, additional work needs
  79. * to be done* (an additional decrement of the associated inode, and a
  80. * decrement of the parent inode).
  81. *
  82. * The DIRCHG flag marks a diradd structure as representing the changing
  83. * of an existing entry rather than the addition of a new one. When
  84. * the update is complete the dirrem associated with the inode for
  85. * the old name must be added to the worklist to do the necessary
  86. * reference count decrement.
  87. *
  88. * The GOINGAWAY flag indicates that the data structure is frozen from
  89. * further change until its dependencies have been completed and its
  90. * resources freed after which it will be discarded.
  91. *
  92. * The IOSTARTED flag prevents multiple calls to the I/O start routine from
  93. * doing multiple rollbacks.
  94. *
  95. * The NEWBLOCK flag marks pagedep structures that have just been allocated,
  96. * so must be claimed by the inode before all dependencies are complete.
  97. *
  98. * The INPROGRESS flag marks worklist structures that are still on the
  99. * worklist, but are being considered for action by some process.
  100. *
  101. * The UFS1FMT flag indicates that the inode being processed is a ufs1 format.
  102. *
  103. * The EXTDATA flag indicates that the allocdirect describes an
  104. * extended-attributes dependency.
  105. *
  106. * The ONWORKLIST flag shows whether the structure is currently linked
  107. * onto a worklist.
  108. *
  109. * The UNLINK* flags track the progress of updating the on-disk linked
  110. * list of active but unlinked inodes. When an inode is first unlinked
  111. * it is marked as UNLINKED. When its on-disk di_freelink has been
  112. * written its UNLINKNEXT flags is set. When its predecessor in the
  113. * list has its di_freelink pointing at us its UNLINKPREV is set.
  114. * When the on-disk list can reach it from the superblock, its
  115. * UNLINKONLIST flag is set. Once all of these flags are set, it
  116. * is safe to let its last name be removed.
  117. */
  118. #define ATTACHED 0x000001
  119. #define UNDONE 0x000002
  120. #define COMPLETE 0x000004
  121. #define DEPCOMPLETE 0x000008
  122. #define MKDIR_PARENT 0x000010 /* diradd, mkdir, jaddref, jsegdep only */
  123. #define MKDIR_BODY 0x000020 /* diradd, mkdir, jaddref only */
  124. #define RMDIR 0x000040 /* dirrem only */
  125. #define DIRCHG 0x000080 /* diradd, dirrem only */
  126. #define GOINGAWAY 0x000100 /* indirdep, jremref only */
  127. #define IOSTARTED 0x000200 /* inodedep, pagedep, bmsafemap only */
  128. #define DELAYEDFREE 0x000400 /* allocindirect free delayed. */
  129. #define NEWBLOCK 0x000800 /* pagedep, jaddref only */
  130. #define INPROGRESS 0x001000 /* dirrem, freeblks, freefrag, freefile only */
  131. #define UFS1FMT 0x002000 /* indirdep only */
  132. #define EXTDATA 0x004000 /* allocdirect only */
  133. #define ONWORKLIST 0x008000
  134. #define IOWAITING 0x010000 /* Thread is waiting for IO to complete. */
  135. #define ONDEPLIST 0x020000 /* Structure is on a dependency list. */
  136. #define UNLINKED 0x040000 /* inodedep has been unlinked. */
  137. #define UNLINKNEXT 0x080000 /* inodedep has valid di_freelink */
  138. #define UNLINKPREV 0x100000 /* inodedep is pointed at in the unlink list */
  139. #define UNLINKONLIST 0x200000 /* inodedep is in the unlinked list on disk */
  140. #define UNLINKLINKS (UNLINKNEXT | UNLINKPREV)
  141. #define WRITESUCCEEDED 0x400000 /* the disk write completed successfully */
  142. #define ALLCOMPLETE (ATTACHED | COMPLETE | DEPCOMPLETE)
  143. /*
  144. * Values for each of the soft dependency types.
  145. */
  146. #define D_PAGEDEP 0
  147. #define D_INODEDEP 1
  148. #define D_BMSAFEMAP 2
  149. #define D_NEWBLK 3
  150. #define D_ALLOCDIRECT 4
  151. #define D_INDIRDEP 5
  152. #define D_ALLOCINDIR 6
  153. #define D_FREEFRAG 7
  154. #define D_FREEBLKS 8
  155. #define D_FREEFILE 9
  156. #define D_DIRADD 10
  157. #define D_MKDIR 11
  158. #define D_DIRREM 12
  159. #define D_NEWDIRBLK 13
  160. #define D_FREEWORK 14
  161. #define D_FREEDEP 15
  162. #define D_JADDREF 16
  163. #define D_JREMREF 17
  164. #define D_JMVREF 18
  165. #define D_JNEWBLK 19
  166. #define D_JFREEBLK 20
  167. #define D_JFREEFRAG 21
  168. #define D_JSEG 22
  169. #define D_JSEGDEP 23
  170. #define D_SBDEP 24
  171. #define D_JTRUNC 25
  172. #define D_JFSYNC 26
  173. #define D_SENTINEL 27
  174. #define D_LAST D_SENTINEL
  175. /*
  176. * The workitem queue.
  177. *
  178. * It is sometimes useful and/or necessary to clean up certain dependencies
  179. * in the background rather than during execution of an application process
  180. * or interrupt service routine. To realize this, we append dependency
  181. * structures corresponding to such tasks to a "workitem" queue. In a soft
  182. * updates implementation, most pending workitems should not wait for more
  183. * than a couple of seconds, so the filesystem syncer process awakens once
  184. * per second to process the items on the queue.
  185. */
  186. LIST_HEAD(workhead, worklist);
  187. /*
  188. * Each request can be linked onto a work queue through its worklist structure.
  189. * To avoid the need for a pointer to the structure itself, this structure
  190. * MUST be declared FIRST in each type in which it appears! If more than one
  191. * worklist is needed in the structure, then a wk_data field must be added
  192. * and the macros below changed to use it.
  193. */
  194. struct worklist {
  195. LIST_ENTRY(worklist) wk_list; /* list of work requests */
  196. struct mount *wk_mp; /* Mount we live in */
  197. unsigned int wk_type:8, /* type of request */
  198. wk_state:24; /* state flags */
  199. };
  200. #define WK_DATA(wk) ((void *)(wk))
  201. #define WK_PAGEDEP(wk) ((struct pagedep *)(wk))
  202. #define WK_INODEDEP(wk) ((struct inodedep *)(wk))
  203. #define WK_BMSAFEMAP(wk) ((struct bmsafemap *)(wk))
  204. #define WK_NEWBLK(wk) ((struct newblk *)(wk))
  205. #define WK_ALLOCDIRECT(wk) ((struct allocdirect *)(wk))
  206. #define WK_INDIRDEP(wk) ((struct indirdep *)(wk))
  207. #define WK_ALLOCINDIR(wk) ((struct allocindir *)(wk))
  208. #define WK_FREEFRAG(wk) ((struct freefrag *)(wk))
  209. #define WK_FREEBLKS(wk) ((struct freeblks *)(wk))
  210. #define WK_FREEWORK(wk) ((struct freework *)(wk))
  211. #define WK_FREEFILE(wk) ((struct freefile *)(wk))
  212. #define WK_DIRADD(wk) ((struct diradd *)(wk))
  213. #define WK_MKDIR(wk) ((struct mkdir *)(wk))
  214. #define WK_DIRREM(wk) ((struct dirrem *)(wk))
  215. #define WK_NEWDIRBLK(wk) ((struct newdirblk *)(wk))
  216. #define WK_JADDREF(wk) ((struct jaddref *)(wk))
  217. #define WK_JREMREF(wk) ((struct jremref *)(wk))
  218. #define WK_JMVREF(wk) ((struct jmvref *)(wk))
  219. #define WK_JSEGDEP(wk) ((struct jsegdep *)(wk))
  220. #define WK_JSEG(wk) ((struct jseg *)(wk))
  221. #define WK_JNEWBLK(wk) ((struct jnewblk *)(wk))
  222. #define WK_JFREEBLK(wk) ((struct jfreeblk *)(wk))
  223. #define WK_FREEDEP(wk) ((struct freedep *)(wk))
  224. #define WK_JFREEFRAG(wk) ((struct jfreefrag *)(wk))
  225. #define WK_SBDEP(wk) ((struct sbdep *)(wk))
  226. #define WK_JTRUNC(wk) ((struct jtrunc *)(wk))
  227. #define WK_JFSYNC(wk) ((struct jfsync *)(wk))
  228. /*
  229. * Various types of lists
  230. */
  231. LIST_HEAD(dirremhd, dirrem);
  232. LIST_HEAD(diraddhd, diradd);
  233. LIST_HEAD(newblkhd, newblk);
  234. LIST_HEAD(inodedephd, inodedep);
  235. LIST_HEAD(allocindirhd, allocindir);
  236. LIST_HEAD(allocdirecthd, allocdirect);
  237. TAILQ_HEAD(allocdirectlst, allocdirect);
  238. LIST_HEAD(indirdephd, indirdep);
  239. LIST_HEAD(jaddrefhd, jaddref);
  240. LIST_HEAD(jremrefhd, jremref);
  241. LIST_HEAD(jmvrefhd, jmvref);
  242. LIST_HEAD(jnewblkhd, jnewblk);
  243. LIST_HEAD(jblkdephd, jblkdep);
  244. LIST_HEAD(freeworkhd, freework);
  245. TAILQ_HEAD(freeworklst, freework);
  246. TAILQ_HEAD(jseglst, jseg);
  247. TAILQ_HEAD(inoreflst, inoref);
  248. TAILQ_HEAD(freeblklst, freeblks);
  249. /*
  250. * The "pagedep" structure tracks the various dependencies related to
  251. * a particular directory page. If a directory page has any dependencies,
  252. * it will have a pagedep linked to its associated buffer. The
  253. * pd_dirremhd list holds the list of dirrem requests which decrement
  254. * inode reference counts. These requests are processed after the
  255. * directory page with the corresponding zero'ed entries has been
  256. * written. The pd_diraddhd list maintains the list of diradd requests
  257. * which cannot be committed until their corresponding inode has been
  258. * written to disk. Because a directory may have many new entries
  259. * being created, several lists are maintained hashed on bits of the
  260. * offset of the entry into the directory page to keep the lists from
  261. * getting too long. Once a new directory entry has been cleared to
  262. * be written, it is moved to the pd_pendinghd list. After the new
  263. * entry has been written to disk it is removed from the pd_pendinghd
  264. * list, any removed operations are done, and the dependency structure
  265. * is freed.
  266. */
  267. #define DAHASHSZ 5
  268. #define DIRADDHASH(offset) (((offset) >> 2) % DAHASHSZ)
  269. struct pagedep {
  270. struct worklist pd_list; /* page buffer */
  271. # define pd_state pd_list.wk_state /* check for multiple I/O starts */
  272. LIST_ENTRY(pagedep) pd_hash; /* hashed lookup */
  273. ino_t pd_ino; /* associated file */
  274. ufs_lbn_t pd_lbn; /* block within file */
  275. struct newdirblk *pd_newdirblk; /* associated newdirblk if NEWBLOCK */
  276. struct dirremhd pd_dirremhd; /* dirrem's waiting for page */
  277. struct diraddhd pd_diraddhd[DAHASHSZ]; /* diradd dir entry updates */
  278. struct diraddhd pd_pendinghd; /* directory entries awaiting write */
  279. struct jmvrefhd pd_jmvrefhd; /* Dependent journal writes. */
  280. };
  281. /*
  282. * The "inodedep" structure tracks the set of dependencies associated
  283. * with an inode. One task that it must manage is delayed operations
  284. * (i.e., work requests that must be held until the inodedep's associated
  285. * inode has been written to disk). Getting an inode from its incore
  286. * state to the disk requires two steps to be taken by the filesystem
  287. * in this order: first the inode must be copied to its disk buffer by
  288. * the VOP_UPDATE operation; second the inode's buffer must be written
  289. * to disk. To ensure that both operations have happened in the required
  290. * order, the inodedep maintains two lists. Delayed operations are
  291. * placed on the id_inowait list. When the VOP_UPDATE is done, all
  292. * operations on the id_inowait list are moved to the id_bufwait list.
  293. * When the buffer is written, the items on the id_bufwait list can be
  294. * safely moved to the work queue to be processed. A second task of the
  295. * inodedep structure is to track the status of block allocation within
  296. * the inode. Each block that is allocated is represented by an
  297. * "allocdirect" structure (see below). It is linked onto the id_newinoupdt
  298. * list until both its contents and its allocation in the cylinder
  299. * group map have been written to disk. Once these dependencies have been
  300. * satisfied, it is removed from the id_newinoupdt list and any followup
  301. * actions such as releasing the previous block or fragment are placed
  302. * on the id_inowait list. When an inode is updated (a VOP_UPDATE is
  303. * done), the "inodedep" structure is linked onto the buffer through
  304. * its worklist. Thus, it will be notified when the buffer is about
  305. * to be written and when it is done. At the update time, all the
  306. * elements on the id_newinoupdt list are moved to the id_inoupdt list
  307. * since those changes are now relevant to the copy of the inode in the
  308. * buffer. Also at update time, the tasks on the id_inowait list are
  309. * moved to the id_bufwait list so that they will be executed when
  310. * the updated inode has been written to disk. When the buffer containing
  311. * the inode is written to disk, any updates listed on the id_inoupdt
  312. * list are rolled back as they are not yet safe. Following the write,
  313. * the changes are once again rolled forward and any actions on the
  314. * id_bufwait list are processed (since those actions are now safe).
  315. * The entries on the id_inoupdt and id_newinoupdt lists must be kept
  316. * sorted by logical block number to speed the calculation of the size
  317. * of the rolled back inode (see explanation in initiate_write_inodeblock).
  318. * When a directory entry is created, it is represented by a diradd.
  319. * The diradd is added to the id_inowait list as it cannot be safely
  320. * written to disk until the inode that it represents is on disk. After
  321. * the inode is written, the id_bufwait list is processed and the diradd
  322. * entries are moved to the id_pendinghd list where they remain until
  323. * the directory block containing the name has been written to disk.
  324. * The purpose of keeping the entries on the id_pendinghd list is so that
  325. * the softdep_fsync function can find and push the inode's directory
  326. * name(s) as part of the fsync operation for that file.
  327. */
  328. struct inodedep {
  329. struct worklist id_list; /* buffer holding inode block */
  330. # define id_state id_list.wk_state /* inode dependency state */
  331. LIST_ENTRY(inodedep) id_hash; /* hashed lookup */
  332. TAILQ_ENTRY(inodedep) id_unlinked; /* Unlinked but ref'd inodes */
  333. Fs *id_fs; /* associated filesystem */
  334. ino_t id_ino; /* dependent inode */
  335. nlink_t id_nlinkdelta; /* saved effective link count */
  336. nlink_t id_savednlink; /* Link saved during rollback */
  337. LIST_ENTRY(inodedep) id_deps; /* bmsafemap's list of inodedep's */
  338. struct bmsafemap *id_bmsafemap; /* related bmsafemap (if pending) */
  339. struct diradd *id_mkdiradd; /* diradd for a mkdir. */
  340. struct inoreflst id_inoreflst; /* Inode reference adjustments. */
  341. long id_savedextsize; /* ext size saved during rollback */
  342. off_t id_savedsize; /* file size saved during rollback */
  343. struct dirremhd id_dirremhd; /* Removals pending. */
  344. struct workhead id_pendinghd; /* entries awaiting directory write */
  345. struct workhead id_bufwait; /* operations after inode written */
  346. struct workhead id_inowait; /* operations waiting inode update */
  347. struct allocdirectlst id_inoupdt; /* updates before inode written */
  348. struct allocdirectlst id_newinoupdt; /* updates when inode written */
  349. struct allocdirectlst id_extupdt; /* extdata updates pre-inode write */
  350. struct allocdirectlst id_newextupdt; /* extdata updates at ino write */
  351. struct freeblklst id_freeblklst; /* List of partial truncates. */
  352. union {
  353. struct ufs1_dinode *idu_savedino1; /* saved ufs1_dinode contents */
  354. struct ufs2_dinode *idu_savedino2; /* saved ufs2_dinode contents */
  355. } id_un;
  356. };
  357. #define id_savedino1 id_un.idu_savedino1
  358. #define id_savedino2 id_un.idu_savedino2
  359. /*
  360. * A "bmsafemap" structure maintains a list of dependency structures
  361. * that depend on the update of a particular cylinder group map.
  362. * It has lists for newblks, allocdirects, allocindirs, and inodedeps.
  363. * It is attached to the buffer of a cylinder group block when any of
  364. * these things are allocated from the cylinder group. It is freed
  365. * after the cylinder group map is written and the state of its
  366. * dependencies are updated with DEPCOMPLETE to indicate that it has
  367. * been processed.
  368. */
  369. struct bmsafemap {
  370. struct worklist sm_list; /* cylgrp buffer */
  371. # define sm_state sm_list.wk_state
  372. LIST_ENTRY(bmsafemap) sm_hash; /* Hash links. */
  373. LIST_ENTRY(bmsafemap) sm_next; /* Mount list. */
  374. int sm_cg;
  375. struct buf *sm_buf; /* associated buffer */
  376. struct allocdirecthd sm_allocdirecthd; /* allocdirect deps */
  377. struct allocdirecthd sm_allocdirectwr; /* writing allocdirect deps */
  378. struct allocindirhd sm_allocindirhd; /* allocindir deps */
  379. struct allocindirhd sm_allocindirwr; /* writing allocindir deps */
  380. struct inodedephd sm_inodedephd; /* inodedep deps */
  381. struct inodedephd sm_inodedepwr; /* writing inodedep deps */
  382. struct newblkhd sm_newblkhd; /* newblk deps */
  383. struct newblkhd sm_newblkwr; /* writing newblk deps */
  384. struct jaddrefhd sm_jaddrefhd; /* Pending inode allocations. */
  385. struct jnewblkhd sm_jnewblkhd; /* Pending block allocations. */
  386. struct workhead sm_freehd; /* Freedep deps. */
  387. struct workhead sm_freewr; /* Written freedeps. */
  388. };
  389. /*
  390. * A "newblk" structure is attached to a bmsafemap structure when a block
  391. * or fragment is allocated from a cylinder group. Its state is set to
  392. * DEPCOMPLETE when its cylinder group map is written. It is converted to
  393. * an allocdirect or allocindir allocation once the allocator calls the
  394. * appropriate setup function. It will initially be linked onto a bmsafemap
  395. * list. Once converted it can be linked onto the lists described for
  396. * allocdirect or allocindir as described below.
  397. */
  398. struct newblk {
  399. struct worklist nb_list; /* See comment above. */
  400. # define nb_state nb_list.wk_state
  401. LIST_ENTRY(newblk) nb_hash; /* Hashed lookup. */
  402. LIST_ENTRY(newblk) nb_deps; /* Bmsafemap's list of newblks. */
  403. struct jnewblk *nb_jnewblk; /* New block journal entry. */
  404. struct bmsafemap *nb_bmsafemap;/* Cylgrp dep (if pending). */
  405. struct freefrag *nb_freefrag; /* Fragment to be freed (if any). */
  406. struct indirdephd nb_indirdeps; /* Children indirect blocks. */
  407. struct workhead nb_newdirblk; /* Dir block to notify when written. */
  408. struct workhead nb_jwork; /* Journal work pending. */
  409. ufs2_daddr_t nb_newblkno; /* New value of block pointer. */
  410. };
  411. /*
  412. * An "allocdirect" structure is attached to an "inodedep" when a new block
  413. * or fragment is allocated and pointed to by the inode described by
  414. * "inodedep". The worklist is linked to the buffer that holds the block.
  415. * When the block is first allocated, it is linked to the bmsafemap
  416. * structure associated with the buffer holding the cylinder group map
  417. * from which it was allocated. When the cylinder group map is written
  418. * to disk, ad_state has the DEPCOMPLETE flag set. When the block itself
  419. * is written, the COMPLETE flag is set. Once both the cylinder group map
  420. * and the data itself have been written, it is safe to write the inode
  421. * that claims the block. If there was a previous fragment that had been
  422. * allocated before the file was increased in size, the old fragment may
  423. * be freed once the inode claiming the new block is written to disk.
  424. * This ad_fragfree request is attached to the id_inowait list of the
  425. * associated inodedep (pointed to by ad_inodedep) for processing after
  426. * the inode is written. When a block is allocated to a directory, an
  427. * fsync of a file whose name is within that block must ensure not only
  428. * that the block containing the file name has been written, but also
  429. * that the on-disk inode references that block. When a new directory
  430. * block is created, we allocate a newdirblk structure which is linked
  431. * to the associated allocdirect (on its ad_newdirblk list). When the
  432. * allocdirect has been satisfied, the newdirblk structure is moved to
  433. * the inodedep id_bufwait list of its directory to await the inode
  434. * being written. When the inode is written, the directory entries are
  435. * fully committed and can be deleted from their pagedep->id_pendinghd
  436. * and inodedep->id_pendinghd lists.
  437. */
  438. struct allocdirect {
  439. struct newblk ad_block; /* Common block logic */
  440. # define ad_list ad_block.nb_list /* block pointer worklist */
  441. # define ad_state ad_list.wk_state /* block pointer state */
  442. TAILQ_ENTRY(allocdirect) ad_next; /* inodedep's list of allocdirect's */
  443. struct inodedep *ad_inodedep; /* associated inodedep */
  444. ufs2_daddr_t ad_oldblkno; /* old value of block pointer */
  445. int ad_offset; /* Pointer offset in parent. */
  446. long ad_newsize; /* size of new block */
  447. long ad_oldsize; /* size of old block */
  448. };
  449. #define ad_newblkno ad_block.nb_newblkno
  450. #define ad_freefrag ad_block.nb_freefrag
  451. #define ad_newdirblk ad_block.nb_newdirblk
  452. /*
  453. * A single "indirdep" structure manages all allocation dependencies for
  454. * pointers in an indirect block. The up-to-date state of the indirect
  455. * block is stored in ir_savedata. The set of pointers that may be safely
  456. * written to the disk is stored in ir_safecopy. The state field is used
  457. * only to track whether the buffer is currently being written (in which
  458. * case it is not safe to update ir_safecopy). Ir_deplisthd contains the
  459. * list of allocindir structures, one for each block that needs to be
  460. * written to disk. Once the block and its bitmap allocation have been
  461. * written the safecopy can be updated to reflect the allocation and the
  462. * allocindir structure freed. If ir_state indicates that an I/O on the
  463. * indirect block is in progress when ir_safecopy is to be updated, the
  464. * update is deferred by placing the allocindir on the ir_donehd list.
  465. * When the I/O on the indirect block completes, the entries on the
  466. * ir_donehd list are processed by updating their corresponding ir_safecopy
  467. * pointers and then freeing the allocindir structure.
  468. */
  469. struct indirdep {
  470. struct worklist ir_list; /* buffer holding indirect block */
  471. # define ir_state ir_list.wk_state /* indirect block pointer state */
  472. LIST_ENTRY(indirdep) ir_next; /* alloc{direct,indir} list */
  473. TAILQ_HEAD(, freework) ir_trunc; /* List of truncations. */
  474. caddr_t ir_saveddata; /* buffer cache contents */
  475. struct buf *ir_savebp; /* buffer holding safe copy */
  476. struct buf *ir_bp; /* buffer holding live copy */
  477. struct allocindirhd ir_completehd; /* waiting for indirdep complete */
  478. struct allocindirhd ir_writehd; /* Waiting for the pointer write. */
  479. struct allocindirhd ir_donehd; /* done waiting to update safecopy */
  480. struct allocindirhd ir_deplisthd; /* allocindir deps for this block */
  481. struct freeblks *ir_freeblks; /* Freeblks that frees this indir. */
  482. };
  483. /*
  484. * An "allocindir" structure is attached to an "indirdep" when a new block
  485. * is allocated and pointed to by the indirect block described by the
  486. * "indirdep". The worklist is linked to the buffer that holds the new block.
  487. * When the block is first allocated, it is linked to the bmsafemap
  488. * structure associated with the buffer holding the cylinder group map
  489. * from which it was allocated. When the cylinder group map is written
  490. * to disk, ai_state has the DEPCOMPLETE flag set. When the block itself
  491. * is written, the COMPLETE flag is set. Once both the cylinder group map
  492. * and the data itself have been written, it is safe to write the entry in
  493. * the indirect block that claims the block; the "allocindir" dependency
  494. * can then be freed as it is no longer applicable.
  495. */
  496. struct allocindir {
  497. struct newblk ai_block; /* Common block area */
  498. # define ai_state ai_block.nb_list.wk_state /* indirect pointer state */
  499. LIST_ENTRY(allocindir) ai_next; /* indirdep's list of allocindir's */
  500. struct indirdep *ai_indirdep; /* address of associated indirdep */
  501. ufs2_daddr_t ai_oldblkno; /* old value of block pointer */
  502. ufs_lbn_t ai_lbn; /* Logical block number. */
  503. int ai_offset; /* Pointer offset in parent. */
  504. };
  505. #define ai_newblkno ai_block.nb_newblkno
  506. #define ai_freefrag ai_block.nb_freefrag
  507. #define ai_newdirblk ai_block.nb_newdirblk
  508. /*
  509. * The allblk union is used to size the newblk structure on allocation so
  510. * that it may be any one of three types.
  511. */
  512. union allblk {
  513. struct allocindir ab_allocindir;
  514. struct allocdirect ab_allocdirect;
  515. struct newblk ab_newblk;
  516. };
  517. /*
  518. * A "freefrag" structure is attached to an "inodedep" when a previously
  519. * allocated fragment is replaced with a larger fragment, rather than extended.
  520. * The "freefrag" structure is constructed and attached when the replacement
  521. * block is first allocated. It is processed after the inode claiming the
  522. * bigger block that replaces it has been written to disk.
  523. */
  524. struct freefrag {
  525. struct worklist ff_list; /* id_inowait or delayed worklist */
  526. # define ff_state ff_list.wk_state
  527. struct worklist *ff_jdep; /* Associated journal entry. */
  528. struct workhead ff_jwork; /* Journal work pending. */
  529. ufs2_daddr_t ff_blkno; /* fragment physical block number */
  530. long ff_fragsize; /* size of fragment being deleted */
  531. ino_t ff_inum; /* owning inode number */
  532. enum vtype ff_vtype; /* owning inode's file type */
  533. };
  534. /*
  535. * A "freeblks" structure is attached to an "inodedep" when the
  536. * corresponding file's length is reduced to zero. It records all
  537. * the information needed to free the blocks of a file after its
  538. * zero'ed inode has been written to disk. The actual work is done
  539. * by child freework structures which are responsible for individual
  540. * inode pointers while freeblks is responsible for retiring the
  541. * entire operation when it is complete and holding common members.
  542. */
  543. struct freeblks {
  544. struct worklist fb_list; /* id_inowait or delayed worklist */
  545. # define fb_state fb_list.wk_state /* inode and dirty block state */
  546. TAILQ_ENTRY(freeblks) fb_next; /* List of inode truncates. */
  547. struct jblkdephd fb_jblkdephd; /* Journal entries pending */
  548. struct workhead fb_freeworkhd; /* Work items pending */
  549. struct workhead fb_jwork; /* Journal work pending */
  550. struct vnode *fb_devvp; /* filesystem device vnode */
  551. #ifdef QUOTA
  552. struct dquot *fb_quota[MAXQUOTAS]; /* quotas to be adjusted */
  553. #endif
  554. uint64_t fb_modrev; /* Inode revision at start of trunc. */
  555. off_t fb_len; /* Length we're truncating to. */
  556. ufs2_daddr_t fb_chkcnt; /* Blocks released. */
  557. ino_t fb_inum; /* inode owner of blocks */
  558. enum vtype fb_vtype; /* inode owner's file type */
  559. uid_t fb_uid; /* uid of previous owner of blocks */
  560. int fb_ref; /* Children outstanding. */
  561. int fb_cgwait; /* cg writes outstanding. */
  562. };
  563. /*
  564. * A "freework" structure handles the release of a tree of blocks or a single
  565. * block. Each indirect block in a tree is allocated its own freework
  566. * structure so that the indirect block may be freed only when all of its
  567. * children are freed. In this way we enforce the rule that an allocated
  568. * block must have a valid path to a root that is journaled. Each child
  569. * block acquires a reference and when the ref hits zero the parent ref
  570. * is decremented. If there is no parent the freeblks ref is decremented.
  571. */
  572. struct freework {
  573. struct worklist fw_list; /* Delayed worklist. */
  574. # define fw_state fw_list.wk_state
  575. LIST_ENTRY(freework) fw_segs; /* Seg list. */
  576. TAILQ_ENTRY(freework) fw_next; /* Hash/Trunc list. */
  577. struct jnewblk *fw_jnewblk; /* Journal entry to cancel. */
  578. struct freeblks *fw_freeblks; /* Root of operation. */
  579. struct freework *fw_parent; /* Parent indirect. */
  580. struct indirdep *fw_indir; /* indirect block. */
  581. ufs2_daddr_t fw_blkno; /* Our block #. */
  582. ufs_lbn_t fw_lbn; /* Original lbn before free. */
  583. uint16_t fw_frags; /* Number of frags. */
  584. uint16_t fw_ref; /* Number of children out. */
  585. uint16_t fw_off; /* Current working position. */
  586. uint16_t fw_start; /* Start of partial truncate. */
  587. };
  588. /*
  589. * A "freedep" structure is allocated to track the completion of a bitmap
  590. * write for a freework. One freedep may cover many freed blocks so long
  591. * as they reside in the same cylinder group. When the cg is written
  592. * the freedep decrements the ref on the freework which may permit it
  593. * to be freed as well.
  594. */
  595. struct freedep {
  596. struct worklist fd_list; /* Delayed worklist. */
  597. struct freework *fd_freework; /* Parent freework. */
  598. };
  599. /*
  600. * A "freefile" structure is attached to an inode when its
  601. * link count is reduced to zero. It marks the inode as free in
  602. * the cylinder group map after the zero'ed inode has been written
  603. * to disk and any associated blocks and fragments have been freed.
  604. */
  605. struct freefile {
  606. struct worklist fx_list; /* id_inowait or delayed worklist */
  607. mode_t fx_mode; /* mode of inode */
  608. ino_t fx_oldinum; /* inum of the unlinked file */
  609. struct vnode *fx_devvp; /* filesystem device vnode */
  610. struct workhead fx_jwork; /* journal work pending. */
  611. };
  612. /*
  613. * A "diradd" structure is linked to an "inodedep" id_inowait list when a
  614. * new directory entry is allocated that references the inode described
  615. * by "inodedep". When the inode itself is written (either the initial
  616. * allocation for new inodes or with the increased link count for
  617. * existing inodes), the COMPLETE flag is set in da_state. If the entry
  618. * is for a newly allocated inode, the "inodedep" structure is associated
  619. * with a bmsafemap which prevents the inode from being written to disk
  620. * until the cylinder group has been updated. Thus the da_state COMPLETE
  621. * flag cannot be set until the inode bitmap dependency has been removed.
  622. * When creating a new file, it is safe to write the directory entry that
  623. * claims the inode once the referenced inode has been written. Since
  624. * writing the inode clears the bitmap dependencies, the DEPCOMPLETE flag
  625. * in the diradd can be set unconditionally when creating a file. When
  626. * creating a directory, there are two additional dependencies described by
  627. * mkdir structures (see their description below). When these dependencies
  628. * are resolved the DEPCOMPLETE flag is set in the diradd structure.
  629. * If there are multiple links created to the same inode, there will be
  630. * a separate diradd structure created for each link. The diradd is
  631. * linked onto the pg_diraddhd list of the pagedep for the directory
  632. * page that contains the entry. When a directory page is written,
  633. * the pg_diraddhd list is traversed to rollback any entries that are
  634. * not yet ready to be written to disk. If a directory entry is being
  635. * changed (by rename) rather than added, the DIRCHG flag is set and
  636. * the da_previous entry points to the entry that will be "removed"
  637. * once the new entry has been committed. During rollback, entries
  638. * with da_previous are replaced with the previous inode number rather
  639. * than zero.
  640. *
  641. * The overlaying of da_pagedep and da_previous is done to keep the
  642. * structure down. If a da_previous entry is present, the pointer to its
  643. * pagedep is available in the associated dirrem entry. If the DIRCHG flag
  644. * is set, the da_previous entry is valid; if not set the da_pagedep entry
  645. * is valid. The DIRCHG flag never changes; it is set when the structure
  646. * is created if appropriate and is never cleared.
  647. */
  648. struct diradd {
  649. struct worklist da_list; /* id_inowait or id_pendinghd list */
  650. # define da_state da_list.wk_state /* state of the new directory entry */
  651. LIST_ENTRY(diradd) da_pdlist; /* pagedep holding directory block */
  652. doff_t da_offset; /* offset of new dir entry in dir blk */
  653. ino_t da_newinum; /* inode number for the new dir entry */
  654. union {
  655. struct dirrem *dau_previous; /* entry being replaced in dir change */
  656. struct pagedep *dau_pagedep; /* pagedep dependency for addition */
  657. } da_un;
  658. struct workhead da_jwork; /* Journal work awaiting completion. */
  659. };
  660. #define da_previous da_un.dau_previous
  661. #define da_pagedep da_un.dau_pagedep
  662. /*
  663. * Two "mkdir" structures are needed to track the additional dependencies
  664. * associated with creating a new directory entry. Normally a directory
  665. * addition can be committed as soon as the newly referenced inode has been
  666. * written to disk with its increased link count. When a directory is
  667. * created there are two additional dependencies: writing the directory
  668. * data block containing the "." and ".." entries (MKDIR_BODY) and writing
  669. * the parent inode with the increased link count for ".." (MKDIR_PARENT).
  670. * These additional dependencies are tracked by two mkdir structures that
  671. * reference the associated "diradd" structure. When they have completed,
  672. * they set the DEPCOMPLETE flag on the diradd so that it knows that its
  673. * extra dependencies have been completed. The md_state field is used only
  674. * to identify which type of dependency the mkdir structure is tracking.
  675. * It is not used in the mainline code for any purpose other than consistency
  676. * checking. All the mkdir structures in the system are linked together on
  677. * a list. This list is needed so that a diradd can find its associated
  678. * mkdir structures and deallocate them if it is prematurely freed (as for
  679. * example if a mkdir is immediately followed by a rmdir of the same directory).
  680. * Here, the free of the diradd must traverse the list to find the associated
  681. * mkdir structures that reference it. The deletion would be faster if the
  682. * diradd structure were simply augmented to have two pointers that referenced
  683. * the associated mkdir's. However, this would increase the size of the diradd
  684. * structure to speed a very infrequent operation.
  685. */
  686. struct mkdir {
  687. struct worklist md_list; /* id_inowait or buffer holding dir */
  688. # define md_state md_list.wk_state /* type: MKDIR_PARENT or MKDIR_BODY */
  689. struct diradd *md_diradd; /* associated diradd */
  690. struct jaddref *md_jaddref; /* dependent jaddref. */
  691. struct buf *md_buf; /* MKDIR_BODY: buffer holding dir */
  692. LIST_ENTRY(mkdir) md_mkdirs; /* list of all mkdirs */
  693. };
  694. /*
  695. * A "dirrem" structure describes an operation to decrement the link
  696. * count on an inode. The dirrem structure is attached to the pg_dirremhd
  697. * list of the pagedep for the directory page that contains the entry.
  698. * It is processed after the directory page with the deleted entry has
  699. * been written to disk.
  700. */
  701. struct dirrem {
  702. struct worklist dm_list; /* delayed worklist */
  703. # define dm_state dm_list.wk_state /* state of the old directory entry */
  704. LIST_ENTRY(dirrem) dm_next; /* pagedep's list of dirrem's */
  705. LIST_ENTRY(dirrem) dm_inonext; /* inodedep's list of dirrem's */
  706. struct jremrefhd dm_jremrefhd; /* Pending remove reference deps. */
  707. ino_t dm_oldinum; /* inum of the removed dir entry */
  708. doff_t dm_offset; /* offset of removed dir entry in blk */
  709. union {
  710. struct pagedep *dmu_pagedep; /* pagedep dependency for remove */
  711. ino_t dmu_dirinum; /* parent inode number (for rmdir) */
  712. } dm_un;
  713. struct workhead dm_jwork; /* Journal work awaiting completion. */
  714. };
  715. #define dm_pagedep dm_un.dmu_pagedep
  716. #define dm_dirinum dm_un.dmu_dirinum
  717. /*
  718. * A "newdirblk" structure tracks the progress of a newly allocated
  719. * directory block from its creation until it is claimed by its on-disk
  720. * inode. When a block is allocated to a directory, an fsync of a file
  721. * whose name is within that block must ensure not only that the block
  722. * containing the file name has been written, but also that the on-disk
  723. * inode references that block. When a new directory block is created,
  724. * we allocate a newdirblk structure which is linked to the associated
  725. * allocdirect (on its ad_newdirblk list). When the allocdirect has been
  726. * satisfied, the newdirblk structure is moved to the inodedep id_bufwait
  727. * list of its directory to await the inode being written. When the inode
  728. * is written, the directory entries are fully committed and can be
  729. * deleted from their pagedep->id_pendinghd and inodedep->id_pendinghd
  730. * lists. Note that we could track directory blocks allocated to indirect
  731. * blocks using a similar scheme with the allocindir structures. Rather
  732. * than adding this level of complexity, we simply write those newly
  733. * allocated indirect blocks synchronously as such allocations are rare.
  734. * In the case of a new directory the . and .. links are tracked with
  735. * a mkdir rather than a pagedep. In this case we track the mkdir
  736. * so it can be released when it is written. A workhead is used
  737. * to simplify canceling a mkdir that is removed by a subsequent dirrem.
  738. */
  739. struct newdirblk {
  740. struct worklist db_list; /* id_inowait or pg_newdirblk */
  741. # define db_state db_list.wk_state
  742. struct pagedep *db_pagedep; /* associated pagedep */
  743. struct workhead db_mkdir;
  744. };
  745. /*
  746. * The inoref structure holds the elements common to jaddref and jremref
  747. * so they may easily be queued in-order on the inodedep.
  748. */
  749. struct inoref {
  750. struct worklist if_list; /* Journal pending or jseg entries. */
  751. # define if_state if_list.wk_state
  752. TAILQ_ENTRY(inoref) if_deps; /* Links for inodedep. */
  753. struct jsegdep *if_jsegdep; /* Will track our journal record. */
  754. off_t if_diroff; /* Directory offset. */
  755. ino_t if_ino; /* Inode number. */
  756. ino_t if_parent; /* Parent inode number. */
  757. nlink_t if_nlink; /* nlink before addition. */
  758. uint16_t if_mode; /* File mode, needed for IFMT. */
  759. };
  760. /*
  761. * A "jaddref" structure tracks a new reference (link count) on an inode
  762. * and prevents the link count increase and bitmap allocation until a
  763. * journal entry can be written. Once the journal entry is written,
  764. * the inode is put on the pendinghd of the bmsafemap and a diradd or
  765. * mkdir entry is placed on the bufwait list of the inode. The DEPCOMPLETE
  766. * flag is used to indicate that all of the required information for writing
  767. * the journal entry is present. MKDIR_BODY and MKDIR_PARENT are used to
  768. * differentiate . and .. links from regular file names. NEWBLOCK indicates
  769. * a bitmap is still pending. If a new reference is canceled by a delete
  770. * prior to writing the journal the jaddref write is canceled and the
  771. * structure persists to prevent any disk-visible changes until it is
  772. * ultimately released when the file is freed or the link is dropped again.
  773. */
  774. struct jaddref {
  775. struct inoref ja_ref; /* see inoref above. */
  776. # define ja_list ja_ref.if_list /* Jrnl pending, id_inowait, dm_jwork.*/
  777. # define ja_state ja_ref.if_list.wk_state
  778. LIST_ENTRY(jaddref) ja_bmdeps; /* Links for bmsafemap. */
  779. union {
  780. struct diradd *jau_diradd; /* Pending diradd. */
  781. struct mkdir *jau_mkdir; /* MKDIR_{PARENT,BODY} */
  782. } ja_un;
  783. };
  784. #define ja_diradd ja_un.jau_diradd
  785. #define ja_mkdir ja_un.jau_mkdir
  786. #define ja_diroff ja_ref.if_diroff
  787. #define ja_ino ja_ref.if_ino
  788. #define ja_parent ja_ref.if_parent
  789. #define ja_mode ja_ref.if_mode
  790. /*
  791. * A "jremref" structure tracks a removed reference (unlink) on an
  792. * inode and prevents the directory remove from proceeding until the
  793. * journal entry is written. Once the journal has been written the remove
  794. * may proceed as normal.
  795. */
  796. struct jremref {
  797. struct inoref jr_ref; /* see inoref above. */
  798. # define jr_list jr_ref.if_list /* Linked to softdep_journal_pending. */
  799. # define jr_state jr_ref.if_list.wk_state
  800. LIST_ENTRY(jremref) jr_deps; /* Links for dirrem. */
  801. struct dirrem *jr_dirrem; /* Back pointer to dirrem. */
  802. };
  803. /*
  804. * A "jmvref" structure tracks a name relocations within the same
  805. * directory block that occur as a result of directory compaction.
  806. * It prevents the updated directory entry from being written to disk
  807. * until the journal entry is written. Once the journal has been
  808. * written the compacted directory may be written to disk.
  809. */
  810. struct jmvref {
  811. struct worklist jm_list; /* Linked to softdep_journal_pending. */
  812. LIST_ENTRY(jmvref) jm_deps; /* Jmvref on pagedep. */
  813. struct pagedep *jm_pagedep; /* Back pointer to pagedep. */
  814. ino_t jm_parent; /* Containing directory inode number. */
  815. ino_t jm_ino; /* Inode number of our entry. */
  816. off_t jm_oldoff; /* Our old offset in directory. */
  817. off_t jm_newoff; /* Our new offset in directory. */
  818. };
  819. /*
  820. * A "jnewblk" structure tracks a newly allocated block or fragment and
  821. * prevents the direct or indirect block pointer as well as the cg bitmap
  822. * from being written until it is logged. After it is logged the jsegdep
  823. * is attached to the allocdirect or allocindir until the operation is
  824. * completed or reverted. If the operation is reverted prior to the journal
  825. * write the jnewblk structure is maintained to prevent the bitmaps from
  826. * reaching the disk. Ultimately the jnewblk structure will be passed
  827. * to the free routine as the in memory cg is modified back to the free
  828. * state at which time it can be released. It may be held on any of the
  829. * fx_jwork, fw_jwork, fb_jwork, ff_jwork, nb_jwork, or ir_jwork lists.
  830. */
  831. struct jnewblk {
  832. struct worklist jn_list; /* See lists above. */
  833. # define jn_state jn_list.wk_state
  834. struct jsegdep *jn_jsegdep; /* Will track our journal record. */
  835. LIST_ENTRY(jnewblk) jn_deps; /* Jnewblks on sm_jnewblkhd. */
  836. struct worklist *jn_dep; /* Dependency to ref completed seg. */
  837. ufs_lbn_t jn_lbn; /* Lbn to which allocated. */
  838. ufs2_daddr_t jn_blkno; /* Blkno allocated */
  839. ino_t jn_ino; /* Ino to which allocated. */
  840. int jn_oldfrags; /* Previous fragments when extended. */
  841. int jn_frags; /* Number of fragments. */
  842. };
  843. /*
  844. * A "jblkdep" structure tracks jfreeblk and jtrunc records attached to a
  845. * freeblks structure.
  846. */
  847. struct jblkdep {
  848. struct worklist jb_list; /* For softdep journal pending. */
  849. struct jsegdep *jb_jsegdep; /* Reference to the jseg. */
  850. struct freeblks *jb_freeblks; /* Back pointer to freeblks. */
  851. LIST_ENTRY(jblkdep) jb_deps; /* Dep list on freeblks. */
  852. };
  853. /*
  854. * A "jfreeblk" structure tracks the journal write for freeing a block
  855. * or tree of blocks. The block pointer must not be cleared in the inode
  856. * or indirect prior to the jfreeblk being written to the journal.
  857. */
  858. struct jfreeblk {
  859. struct jblkdep jf_dep; /* freeblks linkage. */
  860. ufs_lbn_t jf_lbn; /* Lbn from which blocks freed. */
  861. ufs2_daddr_t jf_blkno; /* Blkno being freed. */
  862. ino_t jf_ino; /* Ino from which blocks freed. */
  863. int jf_frags; /* Number of frags being freed. */
  864. };
  865. /*
  866. * A "jfreefrag" tracks the freeing of a single block when a fragment is
  867. * extended or an indirect page is replaced. It is not part of a larger
  868. * freeblks operation.
  869. */
  870. struct jfreefrag {
  871. struct worklist fr_list; /* Linked to softdep_journal_pending. */
  872. # define fr_state fr_list.wk_state
  873. struct jsegdep *fr_jsegdep; /* Will track our journal record. */
  874. struct freefrag *fr_freefrag; /* Back pointer to freefrag. */
  875. ufs_lbn_t fr_lbn; /* Lbn from which frag freed. */
  876. ufs2_daddr_t fr_blkno; /* Blkno being freed. */
  877. ino_t fr_ino; /* Ino from which frag freed. */
  878. int fr_frags; /* Size of frag being freed. */
  879. };
  880. /*
  881. * A "jtrunc" journals the intent to truncate an inode's data or extent area.
  882. */
  883. struct jtrunc {
  884. struct jblkdep jt_dep; /* freeblks linkage. */
  885. off_t jt_size; /* Final file size. */
  886. int jt_extsize; /* Final extent size. */
  887. ino_t jt_ino; /* Ino being truncated. */
  888. };
  889. /*
  890. * A "jfsync" journals the completion of an fsync which invalidates earlier
  891. * jtrunc records in the journal.
  892. */
  893. struct jfsync {
  894. struct worklist jfs_list; /* For softdep journal pending. */
  895. off_t jfs_size; /* Sync file size. */
  896. int jfs_extsize; /* Sync extent size. */
  897. ino_t jfs_ino; /* ino being synced. */
  898. };
  899. /*
  900. * A "jsegdep" structure tracks a single reference to a written journal
  901. * segment so the journal space can be reclaimed when all dependencies
  902. * have been written. It can hang off of id_inowait, dm_jwork, da_jwork,
  903. * nb_jwork, ff_jwork, or fb_jwork lists.
  904. */
  905. struct jsegdep {
  906. struct worklist jd_list; /* See above for lists. */
  907. # define jd_state jd_list.wk_state
  908. struct jseg *jd_seg; /* Our journal record. */
  909. };
  910. /*
  911. * A "jseg" structure contains all of the journal records written in a
  912. * single disk write. The jaddref and jremref structures are linked into
  913. * js_entries so thay may be completed when the write completes. The
  914. * js_entries also include the write dependency structures: jmvref,
  915. * jnewblk, jfreeblk, jfreefrag, and jtrunc. The js_refs field counts
  916. * the number of entries on the js_entries list. Thus there is a single
  917. * jseg entry to describe each journal write.
  918. */
  919. struct jseg {
  920. struct worklist js_list; /* b_deps link for journal */
  921. # define js_state js_list.wk_state
  922. struct workhead js_entries; /* Entries awaiting write */
  923. LIST_HEAD(, freework) js_indirs;/* List of indirects in this seg. */
  924. TAILQ_ENTRY(jseg) js_next; /* List of all unfinished segments. */
  925. struct jblocks *js_jblocks; /* Back pointer to block/seg list */
  926. struct buf *js_buf; /* Buffer while unwritten */
  927. uint64_t js_seq; /* Journal record sequence number. */
  928. uint64_t js_oldseq; /* Oldest valid sequence number. */
  929. int js_size; /* Size of journal record in bytes. */
  930. int js_cnt; /* Total items allocated. */
  931. int js_refs; /* Count of js_entries items. */
  932. };
  933. /*
  934. * A 'sbdep' structure tracks the head of the free inode list and
  935. * superblock writes. This makes sure the superblock is always pointing at
  936. * the first possible unlinked inode for the suj recovery process. If a
  937. * block write completes and we discover a new head is available the buf
  938. * is dirtied and the dep is kept. See the description of the UNLINK*
  939. * flags above for more details.
  940. */
  941. struct sbdep {
  942. struct worklist sb_list; /* b_dep linkage */
  943. struct fs *sb_fs; /* Filesystem pointer within buf. */
  944. struct ufsmount *sb_ump; /* Our mount structure */
  945. };
  946. /*
  947. * Private journaling structures.
  948. */
  949. struct jblocks {
  950. struct jseglst jb_segs; /* TAILQ of current segments. */
  951. struct jseg *jb_writeseg; /* Next write to complete. */
  952. struct jseg *jb_oldestseg; /* Oldest segment with valid entries. */
  953. struct jextent *jb_extent; /* Extent array. */
  954. uint64_t jb_nextseq; /* Next sequence number. */
  955. uint64_t jb_oldestwrseq; /* Oldest written sequence number. */
  956. uint8_t jb_needseg; /* Need a forced segment. */
  957. uint8_t jb_suspended; /* Did journal suspend writes? */
  958. int jb_avail; /* Available extents. */
  959. int jb_used; /* Last used extent. */
  960. int jb_head; /* Allocator head. */
  961. int jb_off; /* Allocator extent offset. */
  962. int jb_blocks; /* Total disk blocks covered. */
  963. int jb_free; /* Total disk blocks free. */
  964. int jb_min; /* Minimum free space. */
  965. int jb_low; /* Low on space. */
  966. int jb_age; /* Insertion time of oldest rec. */
  967. };
  968. struct jextent {
  969. ufs2_daddr_t je_daddr; /* Disk block address. */
  970. int je_blocks; /* Disk block count. */
  971. };
  972. /*
  973. * Hash table declarations.
  974. */
  975. LIST_HEAD(mkdirlist, mkdir);
  976. LIST_HEAD(pagedep_hashhead, pagedep);
  977. LIST_HEAD(inodedep_hashhead, inodedep);
  978. LIST_HEAD(newblk_hashhead, newblk);
  979. LIST_HEAD(bmsafemap_hashhead, bmsafemap);
  980. TAILQ_HEAD(indir_hashhead, freework);
  981. #if 0
  982. /*
  983. * Per-filesystem soft dependency data.
  984. * Allocated at mount and freed at unmount.
  985. */
  986. struct mount_softdeps {
  987. /* HARVEY TODO This lock is used in interrupt */
  988. struct rwlock sd_fslock; /* softdep lock */
  989. struct workhead sd_workitem_pending; /* softdep work queue */
  990. struct worklist *sd_worklist_tail; /* Tail pointer for above */
  991. struct workhead sd_journal_pending; /* journal work queue */
  992. struct worklist *sd_journal_tail; /* Tail pointer for above */
  993. struct jblocks *sd_jblocks; /* Journal block information */
  994. struct inodedeplst sd_unlinked; /* Unlinked inodes */
  995. struct bmsafemaphd sd_dirtycg; /* Dirty CGs */
  996. struct mkdirlist sd_mkdirlisthd; /* Track mkdirs */
  997. struct pagedep_hashhead *sd_pdhash; /* pagedep hash table */
  998. uint64_t sd_pdhashsize; /* pagedep hash table size-1 */
  999. long sd_pdnextclean; /* next hash bucket to clean */
  1000. struct inodedep_hashhead *sd_idhash; /* inodedep hash table */
  1001. uint64_t sd_idhashsize; /* inodedep hash table size-1 */
  1002. long sd_idnextclean; /* next hash bucket to clean */
  1003. struct newblk_hashhead *sd_newblkhash; /* newblk hash table */
  1004. uint64_t sd_newblkhashsize; /* newblk hash table size-1 */
  1005. struct bmsafemap_hashhead *sd_bmhash; /* bmsafemap hash table */
  1006. uint64_t sd_bmhashsize; /* bmsafemap hash table size-1*/
  1007. struct indir_hashhead *sd_indirhash; /* indir hash table */
  1008. uint64_t sd_indirhashsize; /* indir hash table size-1 */
  1009. int sd_on_journal; /* Items on the journal list */
  1010. int sd_on_worklist; /* Items on the worklist */
  1011. int sd_deps; /* Total dependency count */
  1012. int sd_accdeps; /* accumulated dep count */
  1013. int sd_req; /* Wakeup when deps hits 0. */
  1014. int sd_flags; /* comm with flushing thread */
  1015. int sd_cleanups; /* Calls to cleanup */
  1016. struct thread *sd_flushtd; /* thread handling flushing */
  1017. TAILQ_ENTRY(mount_softdeps) sd_next; /* List of softdep filesystem */
  1018. struct ufsmount *sd_ump; /* our ufsmount structure */
  1019. uint64_t sd_curdeps[D_LAST + 1]; /* count of current deps */
  1020. };
  1021. #endif // 0
  1022. /*
  1023. * Flags for communicating with the syncer thread.
  1024. */
  1025. #define FLUSH_EXIT 0x0001 /* time to exit */
  1026. #define FLUSH_CLEANUP 0x0002 /* need to clear out softdep structures */
  1027. #define FLUSH_STARTING 0x0004 /* flush thread not yet started */
  1028. /*
  1029. * Keep the old names from when these were in the ufsmount structure.
  1030. */
  1031. #define softdep_workitem_pending um_softdep->sd_workitem_pending
  1032. #define softdep_worklist_tail um_softdep->sd_worklist_tail
  1033. #define softdep_journal_pending um_softdep->sd_journal_pending
  1034. #define softdep_journal_tail um_softdep->sd_journal_tail
  1035. #define softdep_jblocks um_softdep->sd_jblocks
  1036. #define softdep_unlinked um_softdep->sd_unlinked
  1037. #define softdep_dirtycg um_softdep->sd_dirtycg
  1038. #define softdep_mkdirlisthd um_softdep->sd_mkdirlisthd
  1039. #define pagedep_hashtbl um_softdep->sd_pdhash
  1040. #define pagedep_hash_size um_softdep->sd_pdhashsize
  1041. #define pagedep_nextclean um_softdep->sd_pdnextclean
  1042. #define inodedep_hashtbl um_softdep->sd_idhash
  1043. #define inodedep_hash_size um_softdep->sd_idhashsize
  1044. #define inodedep_nextclean um_softdep->sd_idnextclean
  1045. #define newblk_hashtbl um_softdep->sd_newblkhash
  1046. #define newblk_hash_size um_softdep->sd_newblkhashsize
  1047. #define bmsafemap_hashtbl um_softdep->sd_bmhash
  1048. #define bmsafemap_hash_size um_softdep->sd_bmhashsize
  1049. #define indir_hashtbl um_softdep->sd_indirhash
  1050. #define indir_hash_size um_softdep->sd_indirhashsize
  1051. #define softdep_on_journal um_softdep->sd_on_journal
  1052. #define softdep_on_worklist um_softdep->sd_on_worklist
  1053. #define softdep_deps um_softdep->sd_deps
  1054. #define softdep_accdeps um_softdep->sd_accdeps
  1055. #define softdep_req um_softdep->sd_req
  1056. #define softdep_flags um_softdep->sd_flags
  1057. #define softdep_flushtd um_softdep->sd_flushtd
  1058. #define softdep_curdeps um_softdep->sd_curdeps