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