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