fs/nfs/blocklayout/blocklayoutdev.c

   1 /*
   2  *  linux/fs/nfs/blocklayout/blocklayoutdev.c
   3  *
   4  *  Device operations for the pnfs nfs4 file 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 #include <linux/module.h>
  33 #include <linux/buffer_head.h> /* __bread */
  34
  35 #include <linux/genhd.h>
  36 #include <linux/blkdev.h>
  37 #include <linux/hash.h>
  38
  39 #include "blocklayout.h"
  40
  41 #define NFSDBG_FACILITY         NFSDBG_PNFS_LD
  42
  43 static int decode_sector_number(__be32 **rp, sector_t *sp)
  44 {
  45         uint64_t s;
  46
  47         *rp = xdr_decode_hyper(*rp, &s);
  48         if (s & 0x1ff) {
  49                 printk(KERN_WARNING "NFS: %s: sector not aligned\n", __func__);
  50                 return -1;
  51         }
  52         *sp = s >> SECTOR_SHIFT;
  53         return 0;
  54 }
  55
  56 /*
  57  * Release the block device
  58  */
  59 void nfs4_blkdev_put(struct block_device *bdev)
  60 {
  61         dprintk("%s for device %d:%d\n", __func__, MAJOR(bdev->bd_dev),
  62                         MINOR(bdev->bd_dev));
  63         blkdev_put(bdev, FMODE_READ);
  64 }
  65
  66 ssize_t bl_pipe_downcall(struct file *filp, const char __user *src,
  67                          size_t mlen)
  68 {
  69         struct nfs_net *nn = net_generic(filp->f_dentry->d_sb->s_fs_info,
  70                                          nfs_net_id);
  71
  72         if (mlen != sizeof (struct bl_dev_msg))
  73                 return -EINVAL;
  74
  75         if (copy_from_user(&nn->bl_mount_reply, src, mlen) != 0)
  76                 return -EFAULT;
  77
  78         wake_up(&nn->bl_wq);
  79
  80         return mlen;
  81 }
  82
  83 void bl_pipe_destroy_msg(struct rpc_pipe_msg *msg)
  84 {
  85         struct bl_pipe_msg *bl_pipe_msg = container_of(msg, struct bl_pipe_msg, msg);
  86
  87         if (msg->errno >= 0)
  88                 return;
  89         wake_up(bl_pipe_msg->bl_wq);
  90 }
  91
  92 /*
  93  * Decodes pnfs_block_deviceaddr4 which is XDR encoded in dev->dev_addr_buf.
  94  */
  95 struct pnfs_block_dev *
  96 nfs4_blk_decode_device(struct nfs_server *server,
  97                        struct pnfs_device *dev)
  98 {
  99         struct pnfs_block_dev *rv;
 100         struct block_device *bd = NULL;
 101         struct bl_pipe_msg bl_pipe_msg;
 102         struct rpc_pipe_msg *msg = &bl_pipe_msg.msg;
 103         struct bl_msg_hdr bl_msg = {
 104                 .type = BL_DEVICE_MOUNT,
 105                 .totallen = dev->mincount,
 106         };
 107         uint8_t *dataptr;
 108         DECLARE_WAITQUEUE(wq, current);
 109         int offset, len, i, rc;
 110         struct net *net = server->nfs_client->cl_net;
 111         struct nfs_net *nn = net_generic(net, nfs_net_id);
 112         struct bl_dev_msg *reply = &nn->bl_mount_reply;
 113
 114         dprintk("%s CREATING PIPEFS MESSAGE\n", __func__);
 115         dprintk("%s: deviceid: %s, mincount: %d\n", __func__, dev->dev_id.data,
 116                 dev->mincount);
 117
 118         bl_pipe_msg.bl_wq = &nn->bl_wq;
 119         memset(msg, 0, sizeof(*msg));
 120         msg->data = kzalloc(sizeof(bl_msg) + dev->mincount, GFP_NOFS);
 121         if (!msg->data) {
 122                 rv = ERR_PTR(-ENOMEM);
 123                 goto out;
 124         }
 125
 126         memcpy(msg->data, &bl_msg, sizeof(bl_msg));
 127         dataptr = (uint8_t *) msg->data;
 128         len = dev->mincount;
 129         offset = sizeof(bl_msg);
 130         for (i = 0; len > 0; i++) {
 131                 memcpy(&dataptr[offset], page_address(dev->pages[i]),
 132                                 len < PAGE_CACHE_SIZE ? len : PAGE_CACHE_SIZE);
 133                 len -= PAGE_CACHE_SIZE;
 134                 offset += PAGE_CACHE_SIZE;
 135         }
 136         msg->len = sizeof(bl_msg) + dev->mincount;
 137
 138         dprintk("%s CALLING USERSPACE DAEMON\n", __func__);
 139         add_wait_queue(&nn->bl_wq, &wq);
 140         rc = rpc_queue_upcall(nn->bl_device_pipe, msg);
 141         if (rc < 0) {
 142                 remove_wait_queue(&nn->bl_wq, &wq);
 143                 rv = ERR_PTR(rc);
 144                 goto out;
 145         }
 146
 147         set_current_state(TASK_UNINTERRUPTIBLE);
 148         schedule();
 149         remove_wait_queue(&nn->bl_wq, &wq);
 150
 151         if (reply->status != BL_DEVICE_REQUEST_PROC) {
 152                 dprintk("%s failed to open device: %d\n",
 153                         __func__, reply->status);
 154                 rv = ERR_PTR(-EINVAL);
 155                 goto out;
 156         }
 157
 158         bd = blkdev_get_by_dev(MKDEV(reply->major, reply->minor),
 159                                FMODE_READ, NULL);
 160         if (IS_ERR(bd)) {
 161                 dprintk("%s failed to open device : %ld\n", __func__,
 162                         PTR_ERR(bd));
 163                 rv = ERR_CAST(bd);
 164                 goto out;
 165         }
 166
 167         rv = kzalloc(sizeof(*rv), GFP_NOFS);
 168         if (!rv) {
 169                 rv = ERR_PTR(-ENOMEM);
 170                 goto out;
 171         }
 172
 173         rv->bm_mdev = bd;
 174         memcpy(&rv->bm_mdevid, &dev->dev_id, sizeof(struct nfs4_deviceid));
 175         rv->net = net;
 176         dprintk("%s Created device %s with bd_block_size %u\n",
 177                 __func__,
 178                 bd->bd_disk->disk_name,
 179                 bd->bd_block_size);
 180
 181 out:
 182         kfree(msg->data);
 183         return rv;
 184 }
 185
 186 /* Map deviceid returned by the server to constructed block_device */
 187 static struct block_device *translate_devid(struct pnfs_layout_hdr *lo,
 188                                             struct nfs4_deviceid *id)
 189 {
 190         struct block_device *rv = NULL;
 191         struct block_mount_id *mid;
 192         struct pnfs_block_dev *dev;
 193
 194         dprintk("%s enter, lo=%p, id=%p\n", __func__, lo, id);
 195         mid = BLK_ID(lo);
 196         spin_lock(&mid->bm_lock);
 197         list_for_each_entry(dev, &mid->bm_devlist, bm_node) {
 198                 if (memcmp(id->data, dev->bm_mdevid.data,
 199                            NFS4_DEVICEID4_SIZE) == 0) {
 200                         rv = dev->bm_mdev;
 201                         goto out;
 202                 }
 203         }
 204  out:
 205         spin_unlock(&mid->bm_lock);
 206         dprintk("%s returning %p\n", __func__, rv);
 207         return rv;
 208 }
 209
 210 /* Tracks info needed to ensure extents in layout obey constraints of spec */
 211 struct layout_verification {
 212         u32 mode;       /* R or RW */
 213         u64 start;      /* Expected start of next non-COW extent */
 214         u64 inval;      /* Start of INVAL coverage */
 215         u64 cowread;    /* End of COW read coverage */
 216 };
 217
 218 /* Verify the extent meets the layout requirements of the pnfs-block draft,
 219  * section 2.3.1.
 220  */
 221 static int verify_extent(struct pnfs_block_extent *be,
 222                          struct layout_verification *lv)
 223 {
 224         if (lv->mode == IOMODE_READ) {
 225                 if (be->be_state == PNFS_BLOCK_READWRITE_DATA ||
 226                     be->be_state == PNFS_BLOCK_INVALID_DATA)
 227                         return -EIO;
 228                 if (be->be_f_offset != lv->start)
 229                         return -EIO;
 230                 lv->start += be->be_length;
 231                 return 0;
 232         }
 233         /* lv->mode == IOMODE_RW */
 234         if (be->be_state == PNFS_BLOCK_READWRITE_DATA) {
 235                 if (be->be_f_offset != lv->start)
 236                         return -EIO;
 237                 if (lv->cowread > lv->start)
 238                         return -EIO;
 239                 lv->start += be->be_length;
 240                 lv->inval = lv->start;
 241                 return 0;
 242         } else if (be->be_state == PNFS_BLOCK_INVALID_DATA) {
 243                 if (be->be_f_offset != lv->start)
 244                         return -EIO;
 245                 lv->start += be->be_length;
 246                 return 0;
 247         } else if (be->be_state == PNFS_BLOCK_READ_DATA) {
 248                 if (be->be_f_offset > lv->start)
 249                         return -EIO;
 250                 if (be->be_f_offset < lv->inval)
 251                         return -EIO;
 252                 if (be->be_f_offset < lv->cowread)
 253                         return -EIO;
 254                 /* It looks like you might want to min this with lv->start,
 255                  * but you really don't.
 256                  */
 257                 lv->inval = lv->inval + be->be_length;
 258                 lv->cowread = be->be_f_offset + be->be_length;
 259                 return 0;
 260         } else
 261                 return -EIO;
 262 }
 263
 264 /* XDR decode pnfs_block_layout4 structure */
 265 int
 266 nfs4_blk_process_layoutget(struct pnfs_layout_hdr *lo,
 267                            struct nfs4_layoutget_res *lgr, gfp_t gfp_flags)
 268 {
 269         struct pnfs_block_layout *bl = BLK_LO2EXT(lo);
 270         int i, status = -EIO;
 271         uint32_t count;
 272         struct pnfs_block_extent *be = NULL, *save;
 273         struct xdr_stream stream;
 274         struct xdr_buf buf;
 275         struct page *scratch;
 276         __be32 *p;
 277         struct layout_verification lv = {
 278                 .mode = lgr->range.iomode,
 279                 .start = lgr->range.offset >> SECTOR_SHIFT,
 280                 .inval = lgr->range.offset >> SECTOR_SHIFT,
 281                 .cowread = lgr->range.offset >> SECTOR_SHIFT,
 282         };
 283         LIST_HEAD(extents);
 284
 285         dprintk("---> %s\n", __func__);
 286
 287         scratch = alloc_page(gfp_flags);
 288         if (!scratch)
 289                 return -ENOMEM;
 290
 291         xdr_init_decode_pages(&stream, &buf, lgr->layoutp->pages, lgr->layoutp->len);
 292         xdr_set_scratch_buffer(&stream, page_address(scratch), PAGE_SIZE);
 293
 294         p = xdr_inline_decode(&stream, 4);
 295         if (unlikely(!p))
 296                 goto out_err;
 297
 298         count = be32_to_cpup(p++);
 299
 300         dprintk("%s enter, number of extents %i\n", __func__, count);
 301         p = xdr_inline_decode(&stream, (28 + NFS4_DEVICEID4_SIZE) * count);
 302         if (unlikely(!p))
 303                 goto out_err;
 304
 305         /* Decode individual extents, putting them in temporary
 306          * staging area until whole layout is decoded to make error
 307          * recovery easier.
 308          */
 309         for (i = 0; i < count; i++) {
 310                 be = bl_alloc_extent();
 311                 if (!be) {
 312                         status = -ENOMEM;
 313                         goto out_err;
 314                 }
 315                 memcpy(&be->be_devid, p, NFS4_DEVICEID4_SIZE);
 316                 p += XDR_QUADLEN(NFS4_DEVICEID4_SIZE);
 317                 be->be_mdev = translate_devid(lo, &be->be_devid);
 318                 if (!be->be_mdev)
 319                         goto out_err;
 320
 321                 /* The next three values are read in as bytes,
 322                  * but stored as 512-byte sector lengths
 323                  */
 324                 if (decode_sector_number(&p, &be->be_f_offset) < 0)
 325                         goto out_err;
 326                 if (decode_sector_number(&p, &be->be_length) < 0)
 327                         goto out_err;
 328                 if (decode_sector_number(&p, &be->be_v_offset) < 0)
 329                         goto out_err;
 330                 be->be_state = be32_to_cpup(p++);
 331                 if (be->be_state == PNFS_BLOCK_INVALID_DATA)
 332                         be->be_inval = &bl->bl_inval;
 333                 if (verify_extent(be, &lv)) {
 334                         dprintk("%s verify failed\n", __func__);
 335                         goto out_err;
 336                 }
 337                 list_add_tail(&be->be_node, &extents);
 338         }
 339         if (lgr->range.offset + lgr->range.length !=
 340                         lv.start << SECTOR_SHIFT) {
 341                 dprintk("%s Final length mismatch\n", __func__);
 342                 be = NULL;
 343                 goto out_err;
 344         }
 345         if (lv.start < lv.cowread) {
 346                 dprintk("%s Final uncovered COW extent\n", __func__);
 347                 be = NULL;
 348                 goto out_err;
 349         }
 350         /* Extents decoded properly, now try to merge them in to
 351          * existing layout extents.
 352          */
 353         spin_lock(&bl->bl_ext_lock);
 354         list_for_each_entry_safe(be, save, &extents, be_node) {
 355                 list_del(&be->be_node);
 356                 status = bl_add_merge_extent(bl, be);
 357                 if (status) {
 358                         spin_unlock(&bl->bl_ext_lock);
 359                         /* This is a fairly catastrophic error, as the
 360                          * entire layout extent lists are now corrupted.
 361                          * We should have some way to distinguish this.
 362                          */
 363                         be = NULL;
 364                         goto out_err;
 365                 }
 366         }
 367         spin_unlock(&bl->bl_ext_lock);
 368         status = 0;
 369  out:
 370         __free_page(scratch);
 371         dprintk("%s returns %i\n", __func__, status);
 372         return status;
 373
 374  out_err:
 375         bl_put_extent(be);
 376         while (!list_empty(&extents)) {
 377                 be = list_first_entry(&extents, struct pnfs_block_extent,
 378                                       be_node);
 379                 list_del(&be->be_node);
 380                 bl_put_extent(be);
 381         }
 382         goto out;
 383 }