Whamcloud - gitweb
4953e8baf05fe78f07322edf3506014fa6323504
[fs/lustre-release.git] / 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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, Intel Corporation.
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 #define DEBUG_SUBSYSTEM S_LOV
38
39 #ifdef __KERNEL__
40 #include <libcfs/libcfs.h>
41 #else
42 #include <liblustre.h>
43 #endif
44
45 #include <obd_class.h>
46 #include <obd_lov.h>
47
48 #include "lov_internal.h"
49
50 /* compute object size given "stripeno" and the ost size */
51 obd_size lov_stripe_size(struct lov_stripe_md *lsm, obd_size ost_size,
52                          int stripeno)
53 {
54         unsigned long ssize = lsm->lsm_stripe_size;
55         unsigned long stripe_size;
56         obd_off swidth;
57         obd_size lov_size;
58         int magic = lsm->lsm_magic;
59         ENTRY;
60
61         if (ost_size == 0)
62                 RETURN(0);
63
64         LASSERT(lsm_op_find(magic) != NULL);
65         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, NULL, &swidth);
66
67         /* lov_do_div64(a, b) returns a % b, and a = a / b */
68         stripe_size = lov_do_div64(ost_size, ssize);
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 /* 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 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
126                       int stripeno, obd_off *obdoff)
127 {
128         unsigned long ssize  = lsm->lsm_stripe_size;
129         obd_off stripe_off, this_stripe, swidth;
130         int magic = lsm->lsm_magic;
131         int ret = 0;
132
133         if (lov_off == OBD_OBJECT_EOF) {
134                 *obdoff = OBD_OBJECT_EOF;
135                 return 0;
136         }
137
138         LASSERT(lsm_op_find(magic) != NULL);
139
140         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &lov_off,
141                                                 &swidth);
142
143         /* lov_do_div64(a, b) returns a % b, and a = a / b */
144         stripe_off = lov_do_div64(lov_off, swidth);
145
146         this_stripe = (obd_off)stripeno * ssize;
147         if (stripe_off < this_stripe) {
148                 stripe_off = 0;
149                 ret = -1;
150         } else {
151                 stripe_off -= this_stripe;
152
153                 if (stripe_off >= ssize) {
154                         stripe_off = ssize;
155                         ret = 1;
156                 }
157         }
158
159         *obdoff = lov_off * ssize + stripe_off;
160         return ret;
161 }
162
163 /* Given a whole-file size and a stripe number, give the file size which
164  * corresponds to the individual object of that stripe.
165  *
166  * This behaves basically in the same was as lov_stripe_offset, except that
167  * file sizes falling before the beginning of a stripe are clamped to the end
168  * of the previous stripe, not the beginning of the next:
169  *
170  *                                               S
171  * ---------------------------------------------------------------------
172  * |    0    |     1     |     2     |    0    |     1     |     2     |
173  * ---------------------------------------------------------------------
174  *
175  * if clamped to stripe 2 becomes:
176  *
177  *                                   S
178  * ---------------------------------------------------------------------
179  * |    0    |     1     |     2     |    0    |     1     |     2     |
180  * ---------------------------------------------------------------------
181  */
182 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
183                            int stripeno)
184 {
185         unsigned long ssize  = lsm->lsm_stripe_size;
186         obd_off stripe_off, this_stripe, swidth;
187         int magic = lsm->lsm_magic;
188
189         if (file_size == OBD_OBJECT_EOF)
190                 return OBD_OBJECT_EOF;
191
192         LASSERT(lsm_op_find(magic) != NULL);
193         lsm_op_find(magic)->lsm_stripe_by_index(lsm, &stripeno, &file_size,
194                                                 &swidth);
195
196         /* lov_do_div64(a, b) returns a % b, and a = a / b */
197         stripe_off = lov_do_div64(file_size, swidth);
198
199         this_stripe = (obd_off)stripeno * ssize;
200         if (stripe_off < this_stripe) {
201                 /* Move to end of previous stripe, or zero */
202                 if (file_size > 0) {
203                         file_size--;
204                         stripe_off = ssize;
205                 } else {
206                         stripe_off = 0;
207                 }
208         } else {
209                 stripe_off -= this_stripe;
210
211                 if (stripe_off >= ssize) {
212                         /* Clamp to end of this stripe */
213                         stripe_off = ssize;
214                 }
215         }
216
217         return (file_size * ssize + stripe_off);
218 }
219
220 /* given an extent in an lov and a stripe, calculate the extent of the stripe
221  * that is contained within the lov extent.  this returns true if the given
222  * stripe does intersect with the lov extent. */
223 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
224                           obd_off start, obd_off end,
225                           obd_off *obd_start, obd_off *obd_end)
226 {
227         int start_side, end_side;
228
229         start_side = lov_stripe_offset(lsm, start, stripeno, obd_start);
230         end_side = lov_stripe_offset(lsm, end, stripeno, obd_end);
231
232         CDEBUG(D_INODE, "["LPU64"->"LPU64"] -> [(%d) "LPU64"->"LPU64" (%d)]\n",
233                start, end, start_side, *obd_start, *obd_end, end_side);
234
235         /* this stripe doesn't intersect the file extent when neither
236          * start or the end intersected the stripe and obd_start and
237          * obd_end got rounded up to the save value. */
238         if (start_side != 0 && end_side != 0 && *obd_start == *obd_end)
239                 return 0;
240
241         /* as mentioned in the lov_stripe_offset commentary, end
242          * might have been shifted in the wrong direction.  This
243          * happens when an end offset is before the stripe when viewed
244          * through the "mod stripe size" math. we detect it being shifted
245          * in the wrong direction and touch it up.
246          * interestingly, this can't underflow since end must be > start
247          * if we passed through the previous check.
248          * (should we assert for that somewhere?) */
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, obd_off lov_off)
257 {
258         unsigned long ssize  = lsm->lsm_stripe_size;
259         obd_off stripe_off, swidth;
260         int magic = lsm->lsm_magic;
261
262         LASSERT(lsm_op_find(magic) != NULL);
263         lsm_op_find(magic)->lsm_stripe_by_offset(lsm, NULL, &lov_off, &swidth);
264
265         stripe_off = lov_do_div64(lov_off, swidth);
266
267         /* Puts stripe_off/ssize result into stripe_off */
268         lov_do_div64(stripe_off, ssize);
269
270         return stripe_off;
271 }