fs/nfs/blocklayout/blocklayout.h

   1 /*
   2  *  linux/fs/nfs/blocklayout/blocklayout.h
   3  *
   4  *  Module for the NFSv4.1 pNFS block layout driver.
   5  *
   6  *  Copyright (c) 2006 The Regents of the University of Michigan.
   7  *  All rights reserved.
   8  *
   9  *  Andy Adamson <andros@citi.umich.edu>
  10  *  Fred Isaman <iisaman@umich.edu>
  11  *
  12  * permission is granted to use, copy, create derivative works and
  13  * redistribute this software and such derivative works for any purpose,
  14  * so long as the name of the university of michigan is not used in
  15  * any advertising or publicity pertaining to the use or distribution
  16  * of this software without specific, written prior authorization.  if
  17  * the above copyright notice or any other identification of the
  18  * university of michigan is included in any copy of any portion of
  19  * this software, then the disclaimer below must also be included.
  20  *
  21  * this software is provided as is, without representation from the
  22  * university of michigan as to its fitness for any purpose, and without
  23  * warranty by the university of michigan of any kind, either express
  24  * or implied, including without limitation the implied warranties of
  25  * merchantability and fitness for a particular purpose.  the regents
  26  * of the university of michigan shall not be liable for any damages,
  27  * including special, indirect, incidental, or consequential damages,
  28  * with respect to any claim arising out or in connection with the use
  29  * of the software, even if it has been or is hereafter advised of the
  30  * possibility of such damages.
  31  */
  32 #ifndef FS_NFS_NFS4BLOCKLAYOUT_H
  33 #define FS_NFS_NFS4BLOCKLAYOUT_H
  34
  35 #include <linux/device-mapper.h>
  36 #include <linux/nfs_fs.h>
  37 #include <linux/sunrpc/rpc_pipe_fs.h>
  38
  39 #include "../nfs4_fs.h"
  40 #include "../pnfs.h"
  41 #include "../netns.h"
  42
  43 #define PAGE_CACHE_SECTORS (PAGE_CACHE_SIZE >> SECTOR_SHIFT)
  44 #define PAGE_CACHE_SECTOR_SHIFT (PAGE_CACHE_SHIFT - SECTOR_SHIFT)
  45 #define SECTOR_SIZE (1 << SECTOR_SHIFT)
  46
  47 struct block_mount_id {
  48         spinlock_t                      bm_lock;    /* protects list */
  49         struct list_head                bm_devlist; /* holds pnfs_block_dev */
  50 };
  51
  52 struct pnfs_block_dev {
  53         struct list_head                bm_node;
  54         struct nfs4_deviceid            bm_mdevid;    /* associated devid */
  55         struct block_device             *bm_mdev;     /* meta device itself */
  56         struct net                      *net;
  57 };
  58
  59 enum exstate4 {
  60         PNFS_BLOCK_READWRITE_DATA       = 0,
  61         PNFS_BLOCK_READ_DATA            = 1,
  62         PNFS_BLOCK_INVALID_DATA         = 2, /* mapped, but data is invalid */
  63         PNFS_BLOCK_NONE_DATA            = 3  /* unmapped, it's a hole */
  64 };
  65
  66 /* sector_t fields are all in 512-byte sectors */
  67 struct pnfs_block_extent {
  68         union {
  69                 struct rb_node  be_node;
  70                 struct list_head be_list;
  71         };
  72         struct nfs4_deviceid be_devid;  /* FIXME: could use device cache instead */
  73         struct block_device *be_mdev;
  74         sector_t        be_f_offset;    /* the starting offset in the file */
  75         sector_t        be_length;      /* the size of the extent */
  76         sector_t        be_v_offset;    /* the starting offset in the volume */
  77         enum exstate4   be_state;       /* the state of this extent */
  78 #define EXTENT_WRITTEN          1
  79 #define EXTENT_COMMITTING       2
  80         unsigned int    be_tag;
  81 };
  82
  83 struct pnfs_block_layout {
  84         struct pnfs_layout_hdr  bl_layout;
  85         struct rb_root          bl_ext_rw;
  86         struct rb_root          bl_ext_ro;
  87         spinlock_t              bl_ext_lock;   /* Protects list manipulation */
  88 };
  89
  90 #define BLK_ID(lo) ((struct block_mount_id *)(NFS_SERVER(lo->plh_inode)->pnfs_ld_data))
  91
  92 static inline struct pnfs_block_layout *
  93 BLK_LO2EXT(struct pnfs_layout_hdr *lo)
  94 {
  95         return container_of(lo, struct pnfs_block_layout, bl_layout);
  96 }
  97
  98 static inline struct pnfs_block_layout *
  99 BLK_LSEG2EXT(struct pnfs_layout_segment *lseg)
 100 {
 101         return BLK_LO2EXT(lseg->pls_layout);
 102 }
 103
 104 struct bl_pipe_msg {
 105         struct rpc_pipe_msg msg;
 106         wait_queue_head_t *bl_wq;
 107 };
 108
 109 struct bl_msg_hdr {
 110         u8  type;
 111         u16 totallen; /* length of entire message, including hdr itself */
 112 };
 113
 114 #define BL_DEVICE_UMOUNT               0x0 /* Umount--delete devices */
 115 #define BL_DEVICE_MOUNT                0x1 /* Mount--create devices*/
 116 #define BL_DEVICE_REQUEST_INIT         0x0 /* Start request */
 117 #define BL_DEVICE_REQUEST_PROC         0x1 /* User level process succeeds */
 118 #define BL_DEVICE_REQUEST_ERR          0x2 /* User level process fails */
 119
 120 /* blocklayoutdev.c */
 121 ssize_t bl_pipe_downcall(struct file *, const char __user *, size_t);
 122 void bl_pipe_destroy_msg(struct rpc_pipe_msg *);
 123 void nfs4_blkdev_put(struct block_device *bdev);
 124 struct pnfs_block_dev *nfs4_blk_decode_device(struct nfs_server *server,
 125                                                 struct pnfs_device *dev);
 126 int nfs4_blk_process_layoutget(struct pnfs_layout_hdr *lo,
 127                                 struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
 128
 129 /* blocklayoutdm.c */
 130 void bl_free_block_dev(struct pnfs_block_dev *bdev);
 131
 132 /* extent_tree.c */
 133 int ext_tree_insert(struct pnfs_block_layout *bl,
 134                 struct pnfs_block_extent *new);
 135 int ext_tree_remove(struct pnfs_block_layout *bl, bool rw, sector_t start,
 136                 sector_t end);
 137 int ext_tree_mark_written(struct pnfs_block_layout *bl, sector_t start,
 138                 sector_t len);
 139 bool ext_tree_lookup(struct pnfs_block_layout *bl, sector_t isect,
 140                 struct pnfs_block_extent *ret, bool rw);
 141 int ext_tree_encode_commit(struct pnfs_block_layout *bl,
 142                 struct xdr_stream *xdr);
 143 void ext_tree_mark_committed(struct pnfs_block_layout *bl, int status);
 144
 145 #endif /* FS_NFS_NFS4BLOCKLAYOUT_H */