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