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 obd_size lov_stripe_size(struct lov_stripe_md *lsm, obd_size ost_size,
  47                          int stripeno)
  48 {
  49         unsigned long ssize = lsm->lsm_stripe_size;
  50         unsigned long stripe_size;
  51         obd_off swidth;
  52         obd_size lov_size;
  53         int magic = lsm->lsm_magic;
  54         ENTRY;
  55
  56         if (ost_size == 0)
  57                 RETURN(0);
  58
  59         LASSERT(lsm_op_find(magic) != NULL);
  60         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, NULL, &swidth);
  61
  62         /* lov_do_div64(a, b) returns a % b, and a = a / b */
  63         stripe_size = lov_do_div64(ost_size, ssize);
  64         if (stripe_size)
  65                 lov_size = ost_size * swidth + stripeno * ssize + stripe_size;
  66         else
  67                 lov_size = (ost_size - 1) * swidth + (stripeno + 1) * ssize;
  68
  69         RETURN(lov_size);
  70 }
  71
  72 /**
  73  * Compute file level page index by stripe level page offset
  74  */
  75 pgoff_t lov_stripe_pgoff(struct lov_stripe_md *lsm, pgoff_t stripe_index,
  76                          int stripe)
  77 {
  78         obd_off offset;
  79
  80         offset = lov_stripe_size(lsm, stripe_index << PAGE_CACHE_SHIFT,
  81                                  stripe);
  82         return offset >> PAGE_CACHE_SHIFT;
  83 }
  84
  85 /* we have an offset in file backed by an lov and want to find out where
  86  * that offset lands in our given stripe of the file.  for the easy
  87  * case where the offset is within the stripe, we just have to scale the
  88  * offset down to make it relative to the stripe instead of the lov.
  89  *
  90  * the harder case is what to do when the offset doesn't intersect the
  91  * stripe.  callers will want start offsets clamped ahead to the start
  92  * of the nearest stripe in the file.  end offsets similarly clamped to the
  93  * nearest ending byte of a stripe in the file:
  94  *
  95  * all this function does is move offsets to the nearest region of the
  96  * stripe, and it does its work "mod" the full length of all the stripes.
  97  * consider a file with 3 stripes:
  98  *
  99  *             S                                              E
 100  * ---------------------------------------------------------------------
 101  * |    0    |     1     |     2     |    0    |     1     |     2     |
 102  * ---------------------------------------------------------------------
 103  *
 104  * to find stripe 1's offsets for S and E, it divides by the full stripe
 105  * width and does its math in the context of a single set of stripes:
 106  *
 107  *             S         E
 108  * -----------------------------------
 109  * |    0    |     1     |     2     |
 110  * -----------------------------------
 111  *
 112  * it'll notice that E is outside stripe 1 and clamp it to the end of the
 113  * stripe, then multiply it back out by lov_off to give the real offsets in
 114  * the stripe:
 115  *
 116  *   S                   E
 117  * ---------------------------------------------------------------------
 118  * |    1    |     1     |     1     |    1    |     1     |     1     |
 119  * ---------------------------------------------------------------------
 120  *
 121  * it would have done similarly and pulled S forward to the start of a 1
 122  * stripe if, say, S had landed in a 0 stripe.
 123  *
 124  * this rounding isn't always correct.  consider an E lov offset that lands
 125  * on a 0 stripe, the "mod stripe width" math will pull it forward to the
 126  * start of a 1 stripe, when in fact it wanted to be rounded back to the end
 127  * of a previous 1 stripe.  this logic is handled by callers and this is why:
 128  *
 129  * this function returns < 0 when the offset was "before" the stripe and
 130  * was moved forward to the start of the stripe in question;  0 when it
 131  * falls in the stripe and no shifting was done; > 0 when the offset
 132  * was outside the stripe and was pulled back to its final byte. */
 133 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
 134                       int stripeno, obd_off *obdoff)
 135 {
 136         unsigned long ssize  = lsm->lsm_stripe_size;
 137         obd_off stripe_off, this_stripe, swidth;
 138         int magic = lsm->lsm_magic;
 139         int ret = 0;
 140
 141         if (lov_off == OBD_OBJECT_EOF) {
 142                 *obdoff = OBD_OBJECT_EOF;
 143                 return 0;
 144         }
 145
 146         LASSERT(lsm_op_find(magic) != NULL);
 147
 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 = (obd_off)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 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
 191                            int stripeno)
 192 {
 193         unsigned long ssize  = lsm->lsm_stripe_size;
 194         obd_off stripe_off, this_stripe, swidth;
 195         int magic = lsm->lsm_magic;
 196
 197         if (file_size == OBD_OBJECT_EOF)
 198                 return OBD_OBJECT_EOF;
 199
 200         LASSERT(lsm_op_find(magic) != NULL);
 201         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &file_size,
 202                                                 &swidth);
 203
 204         /* lov_do_div64(a, b) returns a % b, and a = a / b */
 205         stripe_off = lov_do_div64(file_size, swidth);
 206
 207         this_stripe = (obd_off)stripeno * ssize;
 208         if (stripe_off < this_stripe) {
 209                 /* Move to end of previous stripe, or zero */
 210                 if (file_size > 0) {
 211                         file_size--;
 212                         stripe_off = ssize;
 213                 } else {
 214                         stripe_off = 0;
 215                 }
 216         } else {
 217                 stripe_off -= this_stripe;
 218
 219                 if (stripe_off >= ssize) {
 220                         /* Clamp to end of this stripe */
 221                         stripe_off = ssize;
 222                 }
 223         }
 224
 225         return (file_size * ssize + stripe_off);
 226 }
 227
 228 /* given an extent in an lov and a stripe, calculate the extent of the stripe
 229  * that is contained within the lov extent.  this returns true if the given
 230  * stripe does intersect with the lov extent. */
 231 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 232                           obd_off start, obd_off end,
 233                           obd_off *obd_start, obd_off *obd_end)
 234 {
 235         int start_side, end_side;
 236
 237         start_side = lov_stripe_offset(lsm, start, stripeno, obd_start);
 238         end_side = lov_stripe_offset(lsm, end, stripeno, obd_end);
 239
 240         CDEBUG(D_INODE, "["LPU64"->"LPU64"] -> [(%d) "LPU64"->"LPU64" (%d)]\n",
 241                start, end, start_side, *obd_start, *obd_end, end_side);
 242
 243         /* this stripe doesn't intersect the file extent when neither
 244          * start or the end intersected the stripe and obd_start and
 245          * obd_end got rounded up to the save value. */
 246         if (start_side != 0 && end_side != 0 && *obd_start == *obd_end)
 247                 return 0;
 248
 249         /* as mentioned in the lov_stripe_offset commentary, end
 250          * might have been shifted in the wrong direction.  This
 251          * happens when an end offset is before the stripe when viewed
 252          * through the "mod stripe size" math. we detect it being shifted
 253          * in the wrong direction and touch it up.
 254          * interestingly, this can't underflow since end must be > start
 255          * if we passed through the previous check.
 256          * (should we assert for that somewhere?) */
 257         if (end_side != 0)
 258                 (*obd_end)--;
 259
 260         return 1;
 261 }
 262
 263 /* compute which stripe number "lov_off" will be written into */
 264 int lov_stripe_number(struct lov_stripe_md *lsm, obd_off lov_off)
 265 {
 266         unsigned long ssize  = lsm->lsm_stripe_size;
 267         obd_off stripe_off, swidth;
 268         int magic = lsm->lsm_magic;
 269
 270         LASSERT(lsm_op_find(magic) != NULL);
 271         lsm_op_find(magic)->lsm_stripe_by_offset(lsm, NULL, &lov_off, &swidth);
 272
 273         stripe_off = lov_do_div64(lov_off, swidth);
 274
 275         /* Puts stripe_off/ssize result into stripe_off */
 276         lov_do_div64(stripe_off, ssize);
 277
 278         return stripe_off;
 279 }