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