lustre/lov/lov_offset.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #define DEBUG_SUBSYSTEM S_LOV
  38
  39 #include <libcfs/libcfs.h>
  40
  41 #include <obd_class.h>
  42
  43 #include "lov_internal.h"
  44
  45 /* compute object size given "stripeno" and the ost size */
  46 u64 lov_stripe_size(struct lov_stripe_md *lsm, u64 ost_size, int stripeno)
  47 {
  48         unsigned long ssize = lsm->lsm_stripe_size;
  49         unsigned long stripe_size;
  50         loff_t swidth;
  51         loff_t lov_size;
  52         u32 magic = lsm->lsm_magic;
  53         ENTRY;
  54
  55         if (ost_size == 0)
  56                 RETURN(0);
  57
  58         LASSERT(lsm_op_find(magic) != NULL);
  59         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, NULL, &swidth);
  60
  61         /* lov_do_div64(a, b) returns a % b, and a = a / b */
  62         stripe_size = lov_do_div64(ost_size, ssize);
  63         if (stripe_size)
  64                 lov_size = ost_size * swidth + stripeno * ssize + stripe_size;
  65         else
  66                 lov_size = (ost_size - 1) * swidth + (stripeno + 1) * ssize;
  67
  68         RETURN(lov_size);
  69 }
  70
  71 /**
  72  * Compute file level page index by stripe level page offset
  73  */
  74 pgoff_t lov_stripe_pgoff(struct lov_stripe_md *lsm, pgoff_t stripe_index,
  75                          int stripe)
  76 {
  77         loff_t offset;
  78
  79         offset = lov_stripe_size(lsm, (stripe_index << PAGE_CACHE_SHIFT) + 1,
  80                                  stripe);
  81         return offset >> PAGE_CACHE_SHIFT;
  82 }
  83
  84 /* we have an offset in file backed by an lov and want to find out where
  85  * that offset lands in our given stripe of the file.  for the easy
  86  * case where the offset is within the stripe, we just have to scale the
  87  * offset down to make it relative to the stripe instead of the lov.
  88  *
  89  * the harder case is what to do when the offset doesn't intersect the
  90  * stripe.  callers will want start offsets clamped ahead to the start
  91  * of the nearest stripe in the file.  end offsets similarly clamped to the
  92  * nearest ending byte of a stripe in the file:
  93  *
  94  * all this function does is move offsets to the nearest region of the
  95  * stripe, and it does its work "mod" the full length of all the stripes.
  96  * consider a file with 3 stripes:
  97  *
  98  *             S                                              E
  99  * ---------------------------------------------------------------------
 100  * |    0    |     1     |     2     |    0    |     1     |     2     |
 101  * ---------------------------------------------------------------------
 102  *
 103  * to find stripe 1's offsets for S and E, it divides by the full stripe
 104  * width and does its math in the context of a single set of stripes:
 105  *
 106  *             S         E
 107  * -----------------------------------
 108  * |    0    |     1     |     2     |
 109  * -----------------------------------
 110  *
 111  * it'll notice that E is outside stripe 1 and clamp it to the end of the
 112  * stripe, then multiply it back out by lov_off to give the real offsets in
 113  * the stripe:
 114  *
 115  *   S                   E
 116  * ---------------------------------------------------------------------
 117  * |    1    |     1     |     1     |    1    |     1     |     1     |
 118  * ---------------------------------------------------------------------
 119  *
 120  * it would have done similarly and pulled S forward to the start of a 1
 121  * stripe if, say, S had landed in a 0 stripe.
 122  *
 123  * this rounding isn't always correct.  consider an E lov offset that lands
 124  * on a 0 stripe, the "mod stripe width" math will pull it forward to the
 125  * start of a 1 stripe, when in fact it wanted to be rounded back to the end
 126  * of a previous 1 stripe.  this logic is handled by callers and this is why:
 127  *
 128  * this function returns < 0 when the offset was "before" the stripe and
 129  * was moved forward to the start of the stripe in question;  0 when it
 130  * falls in the stripe and no shifting was done; > 0 when the offset
 131  * was outside the stripe and was pulled back to its final byte. */
 132 int lov_stripe_offset(struct lov_stripe_md *lsm, loff_t lov_off, int stripeno,
 133                       loff_t *obdoff)
 134 {
 135         unsigned long ssize  = lsm->lsm_stripe_size;
 136         loff_t stripe_off;
 137         loff_t this_stripe;
 138         loff_t swidth;
 139         u32 magic = lsm->lsm_magic;
 140         int ret = 0;
 141
 142         if (lov_off == OBD_OBJECT_EOF) {
 143                 *obdoff = OBD_OBJECT_EOF;
 144                 return 0;
 145         }
 146
 147         LASSERT(lsm_op_find(magic) != NULL);
 148         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &lov_off,
 149                                                 &swidth);
 150
 151         /* lov_do_div64(a, b) returns a % b, and a = a / b */
 152         stripe_off = lov_do_div64(lov_off, swidth);
 153
 154         this_stripe = (loff_t)stripeno * ssize;
 155         if (stripe_off < this_stripe) {
 156                 stripe_off = 0;
 157                 ret = -1;
 158         } else {
 159                 stripe_off -= this_stripe;
 160
 161                 if (stripe_off >= ssize) {
 162                         stripe_off = ssize;
 163                         ret = 1;
 164                 }
 165         }
 166
 167         *obdoff = lov_off * ssize + stripe_off;
 168         return ret;
 169 }
 170
 171 /* Given a whole-file size and a stripe number, give the file size which
 172  * corresponds to the individual object of that stripe.
 173  *
 174  * This behaves basically in the same was as lov_stripe_offset, except that
 175  * file sizes falling before the beginning of a stripe are clamped to the end
 176  * of the previous stripe, not the beginning of the next:
 177  *
 178  *                                               S
 179  * ---------------------------------------------------------------------
 180  * |    0    |     1     |     2     |    0    |     1     |     2     |
 181  * ---------------------------------------------------------------------
 182  *
 183  * if clamped to stripe 2 becomes:
 184  *
 185  *                                   S
 186  * ---------------------------------------------------------------------
 187  * |    0    |     1     |     2     |    0    |     1     |     2     |
 188  * ---------------------------------------------------------------------
 189  */
 190 loff_t lov_size_to_stripe(struct lov_stripe_md *lsm, u64 file_size,
 191                           int stripeno)
 192 {
 193         unsigned long ssize  = lsm->lsm_stripe_size;
 194         loff_t stripe_off;
 195         loff_t this_stripe;
 196         loff_t swidth;
 197         u32 magic = lsm->lsm_magic;
 198
 199         if (file_size == OBD_OBJECT_EOF)
 200                 return OBD_OBJECT_EOF;
 201
 202         LASSERT(lsm_op_find(magic) != NULL);
 203         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &file_size,
 204                                                 &swidth);
 205
 206         /* lov_do_div64(a, b) returns a % b, and a = a / b */
 207         stripe_off = lov_do_div64(file_size, swidth);
 208
 209         this_stripe = (loff_t)stripeno * ssize;
 210         if (stripe_off < this_stripe) {
 211                 /* Move to end of previous stripe, or zero */
 212                 if (file_size > 0) {
 213                         file_size--;
 214                         stripe_off = ssize;
 215                 } else {
 216                         stripe_off = 0;
 217                 }
 218         } else {
 219                 stripe_off -= this_stripe;
 220
 221                 if (stripe_off >= ssize) {
 222                         /* Clamp to end of this stripe */
 223                         stripe_off = ssize;
 224                 }
 225         }
 226
 227         return (file_size * ssize + stripe_off);
 228 }
 229
 230 /* given an extent in an lov and a stripe, calculate the extent of the stripe
 231  * that is contained within the lov extent.  this returns true if the given
 232  * stripe does intersect with the lov extent. */
 233 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 234                           loff_t start, loff_t end,
 235                           loff_t *obd_start, loff_t *obd_end)
 236 {
 237         int start_side, end_side;
 238
 239         start_side = lov_stripe_offset(lsm, start, stripeno, obd_start);
 240         end_side = lov_stripe_offset(lsm, end, stripeno, obd_end);
 241
 242         CDEBUG(D_INODE, "["LPD64"->"LPD64"] -> [(%d) "LPD64"->"LPD64" (%d)]\n",
 243                 start, end, start_side, *obd_start, *obd_end, end_side);
 244
 245         /* this stripe doesn't intersect the file extent when neither
 246          * start or the end intersected the stripe and obd_start and
 247          * obd_end got rounded up to the save value. */
 248         if (start_side != 0 && end_side != 0 && *obd_start == *obd_end)
 249                 return 0;
 250
 251         /* as mentioned in the lov_stripe_offset commentary, end
 252          * might have been shifted in the wrong direction.  This
 253          * happens when an end offset is before the stripe when viewed
 254          * through the "mod stripe size" math. we detect it being shifted
 255          * in the wrong direction and touch it up.
 256          * interestingly, this can't underflow since end must be > start
 257          * if we passed through the previous check.
 258          * (should we assert for that somewhere?) */
 259         if (end_side != 0)
 260                 (*obd_end)--;
 261
 262         return 1;
 263 }
 264
 265 /* compute which stripe number "lov_off" will be written into */
 266 int lov_stripe_number(struct lov_stripe_md *lsm, loff_t lov_off)
 267 {
 268         unsigned long ssize  = lsm->lsm_stripe_size;
 269         loff_t stripe_off;
 270         loff_t swidth;
 271         u32 magic = lsm->lsm_magic;
 272
 273         LASSERT(lsm_op_find(magic) != NULL);
 274         lsm_op_find(magic)->lsm_stripe_by_offset(lsm, NULL, &lov_off, &swidth);
 275
 276         stripe_off = lov_do_div64(lov_off, swidth);
 277
 278         /* Puts stripe_off/ssize result into stripe_off */
 279         lov_do_div64(stripe_off, ssize);
 280
 281         return stripe_off;
 282 }