lustre/lov/lov_offset.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 #ifndef EXPORT_SYMTAB
  38 # define EXPORT_SYMTAB
  39 #endif
  40 #define DEBUG_SUBSYSTEM S_LOV
  41
  42 #ifdef __KERNEL__
  43 #include <libcfs/libcfs.h>
  44 #else
  45 #include <liblustre.h>
  46 #endif
  47
  48 #include <obd_class.h>
  49 #include <obd_lov.h>
  50
  51 #include "lov_internal.h"
  52
  53 /* compute object size given "stripeno" and the ost size */
  54 obd_size lov_stripe_size(struct lov_stripe_md *lsm, obd_size ost_size,
  55                          int stripeno)
  56 {
  57         unsigned long ssize  = lsm->lsm_stripe_size;
  58         unsigned long swidth, stripe_size;
  59         int sindex = stripeno;
  60         obd_size lov_size;
  61         int magic = lsm->lsm_magic;
  62         ENTRY;
  63
  64         if (ost_size == 0)
  65                 RETURN(0);
  66
  67         LASSERT(lsm_op_find(magic) != NULL);
  68         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, NULL, &swidth);
  69
  70         /* do_div(a, b) returns a % b, and a = a / b */
  71         stripe_size = do_div(ost_size, ssize);
  72         if (stripe_size)
  73                 lov_size = ost_size * swidth + stripeno * ssize + stripe_size;
  74         else
  75                 lov_size = (ost_size - 1) * swidth + (stripeno + 1) * ssize;
  76
  77         lov_size += lsm_op_find(magic)->lsm_stripe_offset_by_index(lsm, sindex);
  78         RETURN(lov_size);
  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 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
 130                       int stripeno, obd_off *obd_off)
 131 {
 132         unsigned long ssize  = lsm->lsm_stripe_size;
 133         unsigned long swidth, stripe_off, this_stripe;
 134         __u64 l_off, s_off;
 135         int magic = lsm->lsm_magic;
 136         int ret = 0;
 137
 138         if (lov_off == OBD_OBJECT_EOF) {
 139                 *obd_off = OBD_OBJECT_EOF;
 140                 return 0;
 141         }
 142
 143         LASSERT(lsm_op_find(magic) != NULL);
 144         /*It will check whether the lov_off and stripeno
 145          *are in the same extent.
 146          *1) lov_off extent < stripeno extent, ret = -1, obd_off = 0
 147          *2) lov_off extent > stripeno extent, ret = 1,
 148          *   obd_off = lov_off extent offset*/
 149         l_off = lsm_op_find(magic)->lsm_stripe_offset_by_index(lsm, stripeno);
 150         s_off = lsm_op_find(magic)->lsm_stripe_offset_by_offset(lsm, lov_off);
 151         if (s_off < l_off) {
 152                 ret = -1;
 153                 *obd_off = 0;
 154                 return ret;
 155         } else if (s_off > l_off) {
 156                 ret = 1;
 157                 *obd_off = s_off;
 158                 return ret;
 159         }
 160         /*If they are in the same extent, original logic*/
 161         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &lov_off,
 162                                                 &swidth);
 163
 164         /* do_div(a, b) returns a % b, and a = a / b */
 165         stripe_off = do_div(lov_off, swidth);
 166
 167         this_stripe = stripeno * ssize;
 168         if (stripe_off < this_stripe) {
 169                 stripe_off = 0;
 170                 ret = -1;
 171         } else {
 172                 stripe_off -= this_stripe;
 173
 174                 if (stripe_off >= ssize) {
 175                         stripe_off = ssize;
 176                         ret = 1;
 177                 }
 178         }
 179
 180         *obd_off = lov_off * ssize + stripe_off;
 181         return ret;
 182 }
 183
 184 /* Given a whole-file size and a stripe number, give the file size which
 185  * corresponds to the individual object of that stripe.
 186  *
 187  * This behaves basically in the same was as lov_stripe_offset, except that
 188  * file sizes falling before the beginning of a stripe are clamped to the end
 189  * of the previous stripe, not the beginning of the next:
 190  *
 191  *                                               S
 192  * ---------------------------------------------------------------------
 193  * |    0    |     1     |     2     |    0    |     1     |     2     |
 194  * ---------------------------------------------------------------------
 195  *
 196  * if clamped to stripe 2 becomes:
 197  *
 198  *                                   S
 199  * ---------------------------------------------------------------------
 200  * |    0    |     1     |     2     |    0    |     1     |     2     |
 201  * ---------------------------------------------------------------------
 202  */
 203 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
 204                            int stripeno)
 205 {
 206         unsigned long ssize  = lsm->lsm_stripe_size;
 207         unsigned long swidth, stripe_off, this_stripe;
 208         int magic = lsm->lsm_magic;
 209
 210         if (file_size == OBD_OBJECT_EOF)
 211                 return OBD_OBJECT_EOF;
 212
 213         LASSERT(lsm_op_find(magic) != NULL);
 214         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &file_size,
 215                                                 &swidth);
 216
 217         /* do_div(a, b) returns a % b, and a = a / b */
 218         stripe_off = do_div(file_size, swidth);
 219
 220         this_stripe = stripeno * ssize;
 221         if (stripe_off < this_stripe) {
 222                 /* Move to end of previous stripe, or zero */
 223                 if (file_size > 0) {
 224                         file_size--;
 225                         stripe_off = ssize;
 226                 } else {
 227                         stripe_off = 0;
 228                 }
 229         } else {
 230                 stripe_off -= this_stripe;
 231
 232                 if (stripe_off >= ssize) {
 233                         /* Clamp to end of this stripe */
 234                         stripe_off = ssize;
 235                 }
 236         }
 237
 238         return (file_size * ssize + stripe_off);
 239 }
 240
 241 /* given an extent in an lov and a stripe, calculate the extent of the stripe
 242  * that is contained within the lov extent.  this returns true if the given
 243  * stripe does intersect with the lov extent. */
 244 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 245                           obd_off start, obd_off end,
 246                           obd_off *obd_start, obd_off *obd_end)
 247 {
 248         int start_side, end_side;
 249
 250         start_side = lov_stripe_offset(lsm, start, stripeno, obd_start);
 251         end_side = lov_stripe_offset(lsm, end, stripeno, obd_end);
 252
 253         CDEBUG(D_INODE, "["LPU64"->"LPU64"] -> [(%d) "LPU64"->"LPU64" (%d)]\n",
 254                start, end, start_side, *obd_start, *obd_end, end_side);
 255
 256         /* this stripe doesn't intersect the file extent when neither
 257          * start or the end intersected the stripe and obd_start and
 258          * obd_end got rounded up to the save value. */
 259         if (start_side != 0 && end_side != 0 && *obd_start == *obd_end)
 260                 return 0;
 261
 262         /* as mentioned in the lov_stripe_offset commentary, end
 263          * might have been shifted in the wrong direction.  This
 264          * happens when an end offset is before the stripe when viewed
 265          * through the "mod stripe size" math. we detect it being shifted
 266          * in the wrong direction and touch it up.
 267          * interestingly, this can't underflow since end must be > start
 268          * if we passed through the previous check.
 269          * (should we assert for that somewhere?) */
 270         if (end_side != 0)
 271                 (*obd_end)--;
 272
 273         return 1;
 274 }
 275
 276 /* compute which stripe number "lov_off" will be written into */
 277 int lov_stripe_number(struct lov_stripe_md *lsm, obd_off lov_off)
 278 {
 279         unsigned long ssize  = lsm->lsm_stripe_size;
 280         unsigned long swidth, stripe_off;
 281         obd_off offset = lov_off;
 282         int magic = lsm->lsm_magic;
 283
 284         LASSERT(lsm_op_find(magic) != NULL);
 285         lsm_op_find(magic)->lsm_stripe_by_offset(lsm, NULL, &lov_off, &swidth);
 286
 287         stripe_off = do_div(lov_off, swidth);
 288
 289         return (stripe_off/ssize +
 290                 lsm_op_find(magic)->lsm_stripe_index_by_offset(lsm, offset));
 291 }