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 (c) 2005, 2010, Oracle and/or its affiliates. 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         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         RETURN(lov_size);
  78 }
  79
  80 /* we have an offset in file backed by an lov and want to find out where
  81  * that offset lands in our given stripe of the file.  for the easy
  82  * case where the offset is within the stripe, we just have to scale the
  83  * offset down to make it relative to the stripe instead of the lov.
  84  *
  85  * the harder case is what to do when the offset doesn't intersect the
  86  * stripe.  callers will want start offsets clamped ahead to the start
  87  * of the nearest stripe in the file.  end offsets similarly clamped to the
  88  * nearest ending byte of a stripe in the file:
  89  *
  90  * all this function does is move offsets to the nearest region of the
  91  * stripe, and it does its work "mod" the full length of all the stripes.
  92  * consider a file with 3 stripes:
  93  *
  94  *             S                                              E
  95  * ---------------------------------------------------------------------
  96  * |    0    |     1     |     2     |    0    |     1     |     2     |
  97  * ---------------------------------------------------------------------
  98  *
  99  * to find stripe 1's offsets for S and E, it divides by the full stripe
 100  * width and does its math in the context of a single set of stripes:
 101  *
 102  *             S         E
 103  * -----------------------------------
 104  * |    0    |     1     |     2     |
 105  * -----------------------------------
 106  *
 107  * it'll notice that E is outside stripe 1 and clamp it to the end of the
 108  * stripe, then multiply it back out by lov_off to give the real offsets in
 109  * the stripe:
 110  *
 111  *   S                   E
 112  * ---------------------------------------------------------------------
 113  * |    1    |     1     |     1     |    1    |     1     |     1     |
 114  * ---------------------------------------------------------------------
 115  *
 116  * it would have done similarly and pulled S forward to the start of a 1
 117  * stripe if, say, S had landed in a 0 stripe.
 118  *
 119  * this rounding isn't always correct.  consider an E lov offset that lands
 120  * on a 0 stripe, the "mod stripe width" math will pull it forward to the
 121  * start of a 1 stripe, when in fact it wanted to be rounded back to the end
 122  * of a previous 1 stripe.  this logic is handled by callers and this is why:
 123  *
 124  * this function returns < 0 when the offset was "before" the stripe and
 125  * was moved forward to the start of the stripe in question;  0 when it
 126  * falls in the stripe and no shifting was done; > 0 when the offset
 127  * was outside the stripe and was pulled back to its final byte. */
 128 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
 129                       int stripeno, obd_off *obdoff)
 130 {
 131         unsigned long ssize  = lsm->lsm_stripe_size;
 132         obd_off stripe_off, this_stripe, swidth;
 133         int magic = lsm->lsm_magic;
 134         int ret = 0;
 135
 136         if (lov_off == OBD_OBJECT_EOF) {
 137                 *obdoff = OBD_OBJECT_EOF;
 138                 return 0;
 139         }
 140
 141         LASSERT(lsm_op_find(magic) != NULL);
 142
 143         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &lov_off,
 144                                                 &swidth);
 145
 146         /* ll_do_div64(a, b) returns a % b, and a = a / b */
 147         stripe_off = ll_do_div64(lov_off, swidth);
 148
 149         this_stripe = (obd_off)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 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
 186                            int stripeno)
 187 {
 188         unsigned long ssize  = lsm->lsm_stripe_size;
 189         obd_off 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         LASSERT(lsm_op_find(magic) != NULL);
 196         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &file_size,
 197                                                 &swidth);
 198
 199         /* ll_do_div64(a, b) returns a % b, and a = a / b */
 200         stripe_off = ll_do_div64(file_size, swidth);
 201
 202         this_stripe = (obd_off)stripeno * ssize;
 203         if (stripe_off < this_stripe) {
 204                 /* Move to end of previous stripe, or zero */
 205                 if (file_size > 0) {
 206                         file_size--;
 207                         stripe_off = ssize;
 208                 } else {
 209                         stripe_off = 0;
 210                 }
 211         } else {
 212                 stripe_off -= this_stripe;
 213
 214                 if (stripe_off >= ssize) {
 215                         /* Clamp to end of this stripe */
 216                         stripe_off = ssize;
 217                 }
 218         }
 219
 220         return (file_size * ssize + stripe_off);
 221 }
 222
 223 /* given an extent in an lov and a stripe, calculate the extent of the stripe
 224  * that is contained within the lov extent.  this returns true if the given
 225  * stripe does intersect with the lov extent. */
 226 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 227                           obd_off start, obd_off end,
 228                           obd_off *obd_start, obd_off *obd_end)
 229 {
 230         int start_side, end_side;
 231
 232         start_side = lov_stripe_offset(lsm, start, stripeno, obd_start);
 233         end_side = lov_stripe_offset(lsm, end, stripeno, obd_end);
 234
 235         CDEBUG(D_INODE, "["LPU64"->"LPU64"] -> [(%d) "LPU64"->"LPU64" (%d)]\n",
 236                start, end, start_side, *obd_start, *obd_end, end_side);
 237
 238         /* this stripe doesn't intersect the file extent when neither
 239          * start or the end intersected the stripe and obd_start and
 240          * obd_end got rounded up to the save value. */
 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         if (end_side != 0)
 253                 (*obd_end)--;
 254
 255         return 1;
 256 }
 257
 258 /* compute which stripe number "lov_off" will be written into */
 259 int lov_stripe_number(struct lov_stripe_md *lsm, obd_off lov_off)
 260 {
 261         unsigned long ssize  = lsm->lsm_stripe_size;
 262         obd_off stripe_off, swidth;
 263         int magic = lsm->lsm_magic;
 264
 265         LASSERT(lsm_op_find(magic) != NULL);
 266         lsm_op_find(magic)->lsm_stripe_by_offset(lsm, NULL, &lov_off, &swidth);
 267
 268         stripe_off = ll_do_div64(lov_off, swidth);
 269
 270         /* Puts stripe_off/ssize result into stripe_off */
 271         do_div(stripe_off, ssize);
 272
 273         return stripe_off;
 274 }