The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/ufs/ffs/softdep.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: ec6808452d2a2598468fee7c01ef1230


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.