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