Documentation/filesystems/nfs/pnfs.rst

   1 ==========================
   2 Reference counting in pnfs
   3 ==========================
   4
   5 The are several inter-related caches.  We have layouts which can
   6 reference multiple devices, each of which can reference multiple data servers.
   7 Each data server can be referenced by multiple devices.  Each device
   8 can be referenced by multiple layouts. To keep all of this straight,
   9 we need to reference count.
  10
  11
  12 struct pnfs_layout_hdr
  13 ======================
  14
  15 The on-the-wire command LAYOUTGET corresponds to struct
  16 pnfs_layout_segment, usually referred to by the variable name lseg.
  17 Each nfs_inode may hold a pointer to a cache of these layout
  18 segments in nfsi->layout, of type struct pnfs_layout_hdr.
  19
  20 We reference the header for the inode pointing to it, across each
  21 outstanding RPC call that references it (LAYOUTGET, LAYOUTRETURN,
  22 LAYOUTCOMMIT), and for each lseg held within.
  23
  24 Each header is also (when non-empty) put on a list associated with
  25 struct nfs_client (cl_layouts).  Being put on this list does not bump
  26 the reference count, as the layout is kept around by the lseg that
  27 keeps it in the list.
  28
  29 deviceid_cache
  30 ==============
  31
  32 lsegs reference device ids, which are resolved per nfs_client and
  33 layout driver type.  The device ids are held in a RCU cache (struct
  34 nfs4_deviceid_cache).  The cache itself is referenced across each
  35 mount.  The entries (struct nfs4_deviceid) themselves are held across
  36 the lifetime of each lseg referencing them.
  37
  38 RCU is used because the deviceid is basically a write once, read many
  39 data structure.  The hlist size of 32 buckets needs better
  40 justification, but seems reasonable given that we can have multiple
  41 deviceid's per filesystem, and multiple filesystems per nfs_client.
  42
  43 The hash code is copied from the nfsd code base.  A discussion of
  44 hashing and variations of this algorithm can be found `here.
  45 <http://groups.google.com/group/comp.lang.c/browse_thread/thread/9522965e2b8d3809>`_
  46
  47 data server cache
  48 =================
  49
  50 file driver devices refer to data servers, which are kept in a module
  51 level cache.  Its reference is held over the lifetime of the deviceid
  52 pointing to it.
  53
  54 lseg
  55 ====
  56
  57 lseg maintains an extra reference corresponding to the NFS_LSEG_VALID
  58 bit which holds it in the pnfs_layout_hdr's list.  When the final lseg
  59 is removed from the pnfs_layout_hdr's list, the NFS_LAYOUT_DESTROYED
  60 bit is set, preventing any new lsegs from being added.
  61
  62 layout drivers
  63 ==============
  64
  65 PNFS utilizes what is called layout drivers. The STD defines 4 basic
  66 layout types: "files", "objects", "blocks", and "flexfiles". For each
  67 of these types there is a layout-driver with a common function-vectors
  68 table which are called by the nfs-client pnfs-core to implement the
  69 different layout types.
  70
  71 Files-layout-driver code is in: fs/nfs/filelayout/.. directory
  72 Blocks-layout-driver code is in: fs/nfs/blocklayout/.. directory
  73 Flexfiles-layout-driver code is in: fs/nfs/flexfilelayout/.. directory
  74
  75 blocks-layout setup
  76 ===================
  77
  78 TODO: Document the setup needs of the blocks layout driver