Whamcloud - gitweb
LU-1346 libcfs: replace libcfs wrappers with kernel API
[fs/lustre-release.git] / lustre / lov / lov_pack.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) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/lov/lov_pack.c
37  *
38  * (Un)packing of OST/MDS requests
39  *
40  * Author: Andreas Dilger <adilger@clusterfs.com>
41  */
42
43 #define DEBUG_SUBSYSTEM S_LOV
44 #ifndef __KERNEL__
45 #include <liblustre.h>
46 #endif
47
48 #include <lustre_net.h>
49 #include <obd.h>
50 #include <obd_lov.h>
51 #include <obd_class.h>
52 #include <obd_support.h>
53 #include <lustre/lustre_user.h>
54
55 #include "lov_internal.h"
56
57 static void lov_dump_lmm_common(int level, void *lmmp)
58 {
59         struct lov_mds_md *lmm = lmmp;
60
61         CDEBUG(level, "objid "LPX64", magic 0x%08x, pattern %#x\n",
62                (__u64)le64_to_cpu(lmm->lmm_object_id),
63                le32_to_cpu(lmm->lmm_magic),
64                le32_to_cpu(lmm->lmm_pattern));
65         CDEBUG(level,"stripe_size %u, stripe_count %u, layout_gen %u\n",
66                le32_to_cpu(lmm->lmm_stripe_size),
67                le16_to_cpu(lmm->lmm_stripe_count),
68                le16_to_cpu(lmm->lmm_layout_gen));
69 }
70
71 static void lov_dump_lmm_objects(int level, struct lov_ost_data *lod,
72                                  int stripe_count)
73 {
74         int i;
75
76         if (stripe_count > LOV_V1_INSANE_STRIPE_COUNT) {
77                 CDEBUG(level, "bad stripe_count %u > max_stripe_count %u\n",
78                        stripe_count, LOV_V1_INSANE_STRIPE_COUNT);
79         }
80
81         for (i = 0; i < stripe_count; ++i, ++lod) {
82                 CDEBUG(level, "stripe %u idx %u subobj "LPX64"/"LPX64"\n", i,
83                        le32_to_cpu(lod->l_ost_idx),
84                        (__u64)le64_to_cpu(lod->l_object_seq),
85                        (__u64)le64_to_cpu(lod->l_object_id));
86         }
87 }
88
89 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm)
90 {
91         lov_dump_lmm_common(level, lmm);
92         lov_dump_lmm_objects(level, lmm->lmm_objects,
93                              le16_to_cpu(lmm->lmm_stripe_count));
94 }
95
96 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm)
97 {
98         lov_dump_lmm_common(level, lmm);
99         CDEBUG(level,"pool_name "LOV_POOLNAMEF"\n", lmm->lmm_pool_name);
100         lov_dump_lmm_objects(level, lmm->lmm_objects,
101                              le16_to_cpu(lmm->lmm_stripe_count));
102 }
103
104 void lov_dump_lmm(int level, void *lmm)
105 {
106         int magic;
107
108         magic = ((struct lov_mds_md_v1 *)(lmm))->lmm_magic;
109         switch (magic) {
110         case LOV_MAGIC_V1:
111                 return lov_dump_lmm_v1(level, (struct lov_mds_md_v1 *)(lmm));
112         case LOV_MAGIC_V3:
113                 return lov_dump_lmm_v3(level, (struct lov_mds_md_v3 *)(lmm));
114         default:
115                 CERROR("Cannot recognize lmm_magic %x", magic);
116         }
117         return;
118 }
119
120 #define LMM_ASSERT(test)                                                \
121 do {                                                                    \
122         if (!(test)) lov_dump_lmm(D_ERROR, lmm);                        \
123         LASSERT(test); /* so we know what assertion failed */           \
124 } while(0)
125
126 /* Pack LOV object metadata for disk storage.  It is packed in LE byte
127  * order and is opaque to the networking layer.
128  *
129  * XXX In the future, this will be enhanced to get the EA size from the
130  *     underlying OSC device(s) to get their EA sizes so we can stack
131  *     LOVs properly.  For now lov_mds_md_size() just assumes one obd_id
132  *     per stripe.
133  */
134 int lov_packmd(struct obd_export *exp, struct lov_mds_md **lmmp,
135                struct lov_stripe_md *lsm)
136 {
137         struct obd_device *obd = class_exp2obd(exp);
138         struct lov_obd *lov = &obd->u.lov;
139         struct lov_mds_md_v1 *lmmv1;
140         struct lov_mds_md_v3 *lmmv3;
141         __u16 stripe_count;
142         struct lov_ost_data_v1 *lmm_objects;
143         int lmm_size, lmm_magic;
144         int i;
145         ENTRY;
146
147         if (lsm) {
148                 lmm_magic = lsm->lsm_magic;
149         } else {
150                 if (lmmp && *lmmp)
151                         lmm_magic = le32_to_cpu((*lmmp)->lmm_magic);
152                 else
153                         /* lsm == NULL and lmmp == NULL */
154                         lmm_magic = LOV_MAGIC;
155         }
156
157         if ((lmm_magic != LOV_MAGIC_V1) &&
158             (lmm_magic != LOV_MAGIC_V3)) {
159                 CERROR("bad mem LOV MAGIC: 0x%08X != 0x%08X nor 0x%08X\n",
160                         lmm_magic, LOV_MAGIC_V1, LOV_MAGIC_V3);
161                 RETURN(-EINVAL);
162
163         }
164
165         if (lsm) {
166                 /* If we are just sizing the EA, limit the stripe count
167                  * to the actual number of OSTs in this filesystem. */
168                 if (!lmmp) {
169                         stripe_count = lov_get_stripecnt(lov, lmm_magic,
170                                                          lsm->lsm_stripe_count);
171                         lsm->lsm_stripe_count = stripe_count;
172                 } else {
173                         stripe_count = lsm->lsm_stripe_count;
174                 }
175         } else {
176                 /* No need to allocate more than maximum supported stripes.
177                  * Anyway, this is pretty inaccurate since ld_tgt_count now
178                  * represents max index and we should rely on the actual number
179                  * of OSTs instead */
180                 stripe_count = lov_mds_md_stripecnt(lov->lov_ocd.ocd_max_easize,
181                                                     lmm_magic);
182                 if (stripe_count > lov->desc.ld_tgt_count)
183                         stripe_count = lov->desc.ld_tgt_count;
184         }
185
186         /* XXX LOV STACKING call into osc for sizes */
187         lmm_size = lov_mds_md_size(stripe_count, lmm_magic);
188
189         if (!lmmp)
190                 RETURN(lmm_size);
191
192         if (*lmmp && !lsm) {
193                 stripe_count = le16_to_cpu((*lmmp)->lmm_stripe_count);
194                 lmm_size = lov_mds_md_size(stripe_count, lmm_magic);
195                 OBD_FREE_LARGE(*lmmp, lmm_size);
196                 *lmmp = NULL;
197                 RETURN(0);
198         }
199
200         if (!*lmmp) {
201                 OBD_ALLOC_LARGE(*lmmp, lmm_size);
202                 if (!*lmmp)
203                         RETURN(-ENOMEM);
204         }
205
206         CDEBUG(D_INFO, "lov_packmd: LOV_MAGIC 0x%08X, lmm_size = %d \n",
207                lmm_magic, lmm_size);
208
209         lmmv1 = *lmmp;
210         lmmv3 = (struct lov_mds_md_v3 *)*lmmp;
211         if (lmm_magic == LOV_MAGIC_V3)
212                 lmmv3->lmm_magic = cpu_to_le32(LOV_MAGIC_V3);
213         else
214                 lmmv1->lmm_magic = cpu_to_le32(LOV_MAGIC_V1);
215
216         if (!lsm)
217                 RETURN(lmm_size);
218
219         /* lmmv1 and lmmv3 point to the same struct and have the
220          * same first fields
221          */
222         lmmv1->lmm_object_id = cpu_to_le64(lsm->lsm_object_id);
223         lmmv1->lmm_object_seq = cpu_to_le64(lsm->lsm_object_seq);
224         lmmv1->lmm_stripe_size = cpu_to_le32(lsm->lsm_stripe_size);
225         lmmv1->lmm_stripe_count = cpu_to_le16(stripe_count);
226         lmmv1->lmm_pattern = cpu_to_le32(lsm->lsm_pattern);
227         lmmv1->lmm_layout_gen = cpu_to_le16(lsm->lsm_layout_gen);
228         if (lsm->lsm_magic == LOV_MAGIC_V3) {
229                 strncpy(lmmv3->lmm_pool_name, lsm->lsm_pool_name,
230                         LOV_MAXPOOLNAME);
231                 lmm_objects = lmmv3->lmm_objects;
232         } else {
233                 lmm_objects = lmmv1->lmm_objects;
234         }
235
236         for (i = 0; i < stripe_count; i++) {
237                 struct lov_oinfo *loi = lsm->lsm_oinfo[i];
238                 /* XXX LOV STACKING call down to osc_packmd() to do packing */
239                 LASSERTF(loi->loi_id, "lmm_oid "LPU64" stripe %u/%u idx %u\n",
240                          lmmv1->lmm_object_id, i, stripe_count, loi->loi_ost_idx);
241                 lmm_objects[i].l_object_id = cpu_to_le64(loi->loi_id);
242                 lmm_objects[i].l_object_seq = cpu_to_le64(loi->loi_seq);
243                 lmm_objects[i].l_ost_gen = cpu_to_le32(loi->loi_ost_gen);
244                 lmm_objects[i].l_ost_idx = cpu_to_le32(loi->loi_ost_idx);
245         }
246
247         RETURN(lmm_size);
248 }
249
250 /* Find the max stripecount we should use */
251 __u16 lov_get_stripecnt(struct lov_obd *lov, __u32 magic, __u16 stripe_count)
252 {
253         __u32 max_stripes = LOV_MAX_STRIPE_COUNT_OLD;
254
255         if (!stripe_count)
256                 stripe_count = lov->desc.ld_default_stripe_count;
257         if (stripe_count > lov->desc.ld_active_tgt_count)
258                 stripe_count = lov->desc.ld_active_tgt_count;
259         if (!stripe_count)
260                 stripe_count = 1;
261
262         /* stripe count is based on whether ldiskfs can handle
263          * larger EA sizes */
264         if (lov->lov_ocd.ocd_connect_flags & OBD_CONNECT_MAX_EASIZE &&
265             lov->lov_ocd.ocd_max_easize)
266                 max_stripes = lov_mds_md_stripecnt(lov->lov_ocd.ocd_max_easize,
267                                                    magic);
268
269         if (stripe_count > max_stripes)
270                 stripe_count = max_stripes;
271
272         return stripe_count;
273 }
274
275
276 static int lov_verify_lmm(void *lmm, int lmm_bytes, __u16 *stripe_count)
277 {
278         int rc;
279
280         if (lsm_op_find(le32_to_cpu(*(__u32 *)lmm)) == NULL) {
281                 char *buffer;
282                 int sz;
283
284                 CERROR("bad disk LOV MAGIC: 0x%08X; dumping LMM (size=%d):\n",
285                        le32_to_cpu(*(__u32 *)lmm), lmm_bytes);
286                 sz = lmm_bytes * 2 + 1;
287                 OBD_ALLOC_LARGE(buffer, sz);
288                 if (buffer != NULL) {
289                         int i;
290
291                         for (i = 0; i < lmm_bytes; i++)
292                                 sprintf(buffer+2*i, "%.2X", ((char *)lmm)[i]);
293                         buffer[sz - 1] = '\0';
294                         CERROR("%s\n", buffer);
295                         OBD_FREE_LARGE(buffer, sz);
296                 }
297                 return -EINVAL;
298         }
299         rc = lsm_op_find(le32_to_cpu(*(__u32 *)lmm))->lsm_lmm_verify(lmm,
300                                      lmm_bytes, stripe_count);
301         return rc;
302 }
303
304 int lov_alloc_memmd(struct lov_stripe_md **lsmp, __u16 stripe_count,
305                     int pattern, int magic)
306 {
307         int i, lsm_size;
308         ENTRY;
309
310         CDEBUG(D_INFO, "alloc lsm, stripe_count %d\n", stripe_count);
311
312         *lsmp = lsm_alloc_plain(stripe_count, &lsm_size);
313         if (!*lsmp) {
314                 CERROR("can't allocate lsmp stripe_count %d\n", stripe_count);
315                 RETURN(-ENOMEM);
316         }
317
318         cfs_atomic_set(&(*lsmp)->lsm_refc, 1);
319         spin_lock_init(&(*lsmp)->lsm_lock);
320         (*lsmp)->lsm_magic = magic;
321         (*lsmp)->lsm_stripe_count = stripe_count;
322         (*lsmp)->lsm_maxbytes = LUSTRE_STRIPE_MAXBYTES * stripe_count;
323         (*lsmp)->lsm_pattern = pattern;
324         (*lsmp)->lsm_pool_name[0] = '\0';
325         (*lsmp)->lsm_layout_gen = 0;
326         (*lsmp)->lsm_oinfo[0]->loi_ost_idx = ~0;
327
328         for (i = 0; i < stripe_count; i++)
329                 loi_init((*lsmp)->lsm_oinfo[i]);
330
331         RETURN(lsm_size);
332 }
333
334 int lov_free_memmd(struct lov_stripe_md **lsmp)
335 {
336         struct lov_stripe_md *lsm = *lsmp;
337         int refc;
338
339         *lsmp = NULL;
340         LASSERT(cfs_atomic_read(&lsm->lsm_refc) > 0);
341         if ((refc = cfs_atomic_dec_return(&lsm->lsm_refc)) == 0) {
342                 LASSERT(lsm_op_find(lsm->lsm_magic) != NULL);
343                 lsm_op_find(lsm->lsm_magic)->lsm_free(lsm);
344         }
345         return refc;
346 }
347
348
349 /* Unpack LOV object metadata from disk storage.  It is packed in LE byte
350  * order and is opaque to the networking layer.
351  */
352 int lov_unpackmd(struct obd_export *exp,  struct lov_stripe_md **lsmp,
353                  struct lov_mds_md *lmm, int lmm_bytes)
354 {
355         struct obd_device *obd = class_exp2obd(exp);
356         struct lov_obd *lov = &obd->u.lov;
357         int rc = 0, lsm_size;
358         __u16 stripe_count;
359         __u32 magic;
360         ENTRY;
361
362         /* If passed an MDS struct use values from there, otherwise defaults */
363         if (lmm) {
364                 rc = lov_verify_lmm(lmm, lmm_bytes, &stripe_count);
365                 if (rc)
366                         RETURN(rc);
367                 magic = le32_to_cpu(lmm->lmm_magic);
368         } else {
369                 magic = LOV_MAGIC;
370                 stripe_count = lov_get_stripecnt(lov, magic, 0);
371         }
372
373         /* If we aren't passed an lsmp struct, we just want the size */
374         if (!lsmp) {
375                 /* XXX LOV STACKING call into osc for sizes */
376                 LBUG();
377                 RETURN(lov_stripe_md_size(stripe_count));
378         }
379         /* If we are passed an allocated struct but nothing to unpack, free */
380         if (*lsmp && !lmm) {
381                 lov_free_memmd(lsmp);
382                 RETURN(0);
383         }
384
385         lsm_size = lov_alloc_memmd(lsmp, stripe_count, LOV_PATTERN_RAID0,
386                                    magic);
387         if (lsm_size < 0)
388                 RETURN(lsm_size);
389
390         /* If we are passed a pointer but nothing to unpack, we only alloc */
391         if (!lmm)
392                 RETURN(lsm_size);
393
394         LASSERT(lsm_op_find(magic) != NULL);
395         rc = lsm_op_find(magic)->lsm_unpackmd(lov, *lsmp, lmm);
396         if (rc) {
397                 lov_free_memmd(lsmp);
398                 RETURN(rc);
399         }
400
401         RETURN(lsm_size);
402 }
403
404 static int __lov_setstripe(struct obd_export *exp, int max_lmm_size,
405                            struct lov_stripe_md **lsmp,
406                            struct lov_user_md *lump)
407 {
408         struct obd_device *obd = class_exp2obd(exp);
409         struct lov_obd *lov = &obd->u.lov;
410         char buffer[sizeof(struct lov_user_md_v3)];
411         struct lov_user_md_v3 *lumv3 = (struct lov_user_md_v3 *)&buffer[0];
412         struct lov_user_md_v1 *lumv1 = (struct lov_user_md_v1 *)&buffer[0];
413         int lmm_magic;
414         __u16 stripe_count;
415         int rc;
416         ENTRY;
417
418         rc = lov_lum_swab_if_needed(lumv3, &lmm_magic, lump);
419         if (rc)
420                 RETURN(rc);
421
422         /* in the rest of the tests, as *lumv1 and lumv3 have the same
423          * fields, we use lumv1 to avoid code duplication */
424
425         if (lumv1->lmm_pattern == 0) {
426                 lumv1->lmm_pattern = lov->desc.ld_pattern ?
427                         lov->desc.ld_pattern : LOV_PATTERN_RAID0;
428         }
429
430         if (lumv1->lmm_pattern != LOV_PATTERN_RAID0) {
431                 CDEBUG(D_IOCTL, "bad userland stripe pattern: %#x\n",
432                        lumv1->lmm_pattern);
433                 RETURN(-EINVAL);
434         }
435
436         /* 64kB is the largest common page size we see (ia64), and matches the
437          * check in lfs */
438         if (lumv1->lmm_stripe_size & (LOV_MIN_STRIPE_SIZE - 1)) {
439                 CDEBUG(D_IOCTL, "stripe size %u not multiple of %u, fixing\n",
440                        lumv1->lmm_stripe_size, LOV_MIN_STRIPE_SIZE);
441                 lumv1->lmm_stripe_size = LOV_MIN_STRIPE_SIZE;
442         }
443
444         if ((lumv1->lmm_stripe_offset >= lov->desc.ld_tgt_count) &&
445             (lumv1->lmm_stripe_offset !=
446              (typeof(lumv1->lmm_stripe_offset))(-1))) {
447                 CDEBUG(D_IOCTL, "stripe offset %u > number of OSTs %u\n",
448                        lumv1->lmm_stripe_offset, lov->desc.ld_tgt_count);
449                 RETURN(-EINVAL);
450         }
451         stripe_count = lov_get_stripecnt(lov, lmm_magic,
452                                          lumv1->lmm_stripe_count);
453
454         if (max_lmm_size) {
455                 int max_stripes = (max_lmm_size -
456                                    lov_mds_md_size(0, lmm_magic)) /
457                                    sizeof(struct lov_ost_data_v1);
458                 if (unlikely(max_stripes < stripe_count)) {
459                         CDEBUG(D_IOCTL, "stripe count reset from %d to %d\n",
460                                stripe_count, max_stripes);
461                         stripe_count = max_stripes;
462                 }
463         }
464
465         if (lmm_magic == LOV_USER_MAGIC_V3) {
466                 struct pool_desc *pool;
467
468                 /* In the function below, .hs_keycmp resolves to
469                  * pool_hashkey_keycmp() */
470                 /* coverity[overrun-buffer-val] */
471                 pool = lov_find_pool(lov, lumv3->lmm_pool_name);
472                 if (pool != NULL) {
473                         if (lumv3->lmm_stripe_offset !=
474                             (typeof(lumv3->lmm_stripe_offset))(-1)) {
475                                 rc = lov_check_index_in_pool(
476                                         lumv3->lmm_stripe_offset, pool);
477                                 if (rc < 0) {
478                                         lov_pool_putref(pool);
479                                         RETURN(-EINVAL);
480                                 }
481                         }
482
483                         if (stripe_count > pool_tgt_count(pool))
484                                 stripe_count = pool_tgt_count(pool);
485
486                         lov_pool_putref(pool);
487                 }
488         }
489
490         rc = lov_alloc_memmd(lsmp, stripe_count, lumv1->lmm_pattern, lmm_magic);
491
492         if (rc >= 0) {
493                 (*lsmp)->lsm_oinfo[0]->loi_ost_idx = lumv1->lmm_stripe_offset;
494                 (*lsmp)->lsm_stripe_size = lumv1->lmm_stripe_size;
495                 if (lmm_magic == LOV_USER_MAGIC_V3)
496                         strncpy((*lsmp)->lsm_pool_name, lumv3->lmm_pool_name,
497                                 LOV_MAXPOOLNAME);
498                 rc = 0;
499         }
500
501         RETURN(rc);
502 }
503
504 /* Configure object striping information on a new file.
505  *
506  * @lmmu is a pointer to a user struct with one or more of the fields set to
507  * indicate the application preference: lmm_stripe_count, lmm_stripe_size,
508  * lmm_stripe_offset, and lmm_stripe_pattern.  lmm_magic must be LOV_MAGIC.
509  * @lsmp is a pointer to an in-core stripe MD that needs to be filled in.
510  */
511 int lov_setstripe(struct obd_export *exp, int max_lmm_size,
512                   struct lov_stripe_md **lsmp, struct lov_user_md *lump)
513 {
514         int rc;
515         mm_segment_t seg;
516
517         seg = get_fs();
518         set_fs(KERNEL_DS);
519
520         rc = __lov_setstripe(exp, max_lmm_size, lsmp, lump);
521         set_fs(seg);
522         RETURN(rc);
523 }
524
525 int lov_setea(struct obd_export *exp, struct lov_stripe_md **lsmp,
526               struct lov_user_md *lump)
527 {
528         int i;
529         int rc;
530         struct obd_export *oexp;
531         struct lov_obd *lov = &exp->exp_obd->u.lov;
532         obd_id last_id = 0;
533         struct lov_user_ost_data_v1 *lmm_objects;
534
535         ENTRY;
536
537         if (lump->lmm_magic == LOV_USER_MAGIC_V3)
538                 lmm_objects = ((struct lov_user_md_v3 *)lump)->lmm_objects;
539         else
540                 lmm_objects = lump->lmm_objects;
541
542         for (i = 0; i < lump->lmm_stripe_count; i++) {
543                 __u32 len = sizeof(last_id);
544                 oexp = lov->lov_tgts[lmm_objects[i].l_ost_idx]->ltd_exp;
545                 rc = obd_get_info(NULL, oexp, sizeof(KEY_LAST_ID), KEY_LAST_ID,
546                                   &len, &last_id, NULL);
547                 if (rc)
548                         RETURN(rc);
549                 if (lmm_objects[i].l_object_id > last_id) {
550                         CERROR("Setting EA for object > than last id on "
551                                "ost idx %d "LPD64" > "LPD64" \n",
552                                lmm_objects[i].l_ost_idx,
553                                lmm_objects[i].l_object_id, last_id);
554                         RETURN(-EINVAL);
555                 }
556         }
557
558         rc = lov_setstripe(exp, 0, lsmp, lump);
559         if (rc)
560                 RETURN(rc);
561
562         for (i = 0; i < lump->lmm_stripe_count; i++) {
563                 (*lsmp)->lsm_oinfo[i]->loi_ost_idx =
564                         lmm_objects[i].l_ost_idx;
565                 (*lsmp)->lsm_oinfo[i]->loi_id = lmm_objects[i].l_object_id;
566                 (*lsmp)->lsm_oinfo[i]->loi_seq = lmm_objects[i].l_object_seq;
567         }
568         RETURN(0);
569 }
570
571
572 /* Retrieve object striping information.
573  *
574  * @lump is a pointer to an in-core struct with lmm_ost_count indicating
575  * the maximum number of OST indices which will fit in the user buffer.
576  * lmm_magic must be LOV_USER_MAGIC.
577  */
578 int lov_getstripe(struct obd_export *exp, struct lov_stripe_md *lsm,
579                   struct lov_user_md *lump)
580 {
581         /*
582          * XXX huge struct allocated on stack.
583          */
584         /* we use lov_user_md_v3 because it is larger than lov_user_md_v1 */
585         struct lov_user_md_v3 lum;
586         struct lov_mds_md *lmmk = NULL;
587         int rc, lmm_size;
588         int lum_size;
589         mm_segment_t seg;
590         ENTRY;
591
592         if (!lsm)
593                 RETURN(-ENODATA);
594
595         /*
596          * "Switch to kernel segment" to allow copying from kernel space by
597          * copy_{to,from}_user().
598          */
599         seg = get_fs();
600         set_fs(KERNEL_DS);
601
602         /* we only need the header part from user space to get lmm_magic and
603          * lmm_stripe_count, (the header part is common to v1 and v3) */
604         lum_size = sizeof(struct lov_user_md_v1);
605         if (cfs_copy_from_user(&lum, lump, lum_size))
606                 GOTO(out_set, rc = -EFAULT);
607         else if ((lum.lmm_magic != LOV_USER_MAGIC) &&
608                  (lum.lmm_magic != LOV_USER_MAGIC_V3))
609                 GOTO(out_set, rc = -EINVAL);
610
611         if (lum.lmm_stripe_count &&
612             (lum.lmm_stripe_count < lsm->lsm_stripe_count)) {
613                 /* Return right size of stripe to user */
614                 lum.lmm_stripe_count = lsm->lsm_stripe_count;
615                 rc = cfs_copy_to_user(lump, &lum, lum_size);
616                 GOTO(out_set, rc = -EOVERFLOW);
617         }
618         rc = lov_packmd(exp, &lmmk, lsm);
619         if (rc < 0)
620                 GOTO(out_set, rc);
621         lmm_size = rc;
622         rc = 0;
623
624         /* FIXME: Bug 1185 - copy fields properly when structs change */
625         /* struct lov_user_md_v3 and struct lov_mds_md_v3 must be the same */
626         CLASSERT(sizeof(lum) == sizeof(struct lov_mds_md_v3));
627         CLASSERT(sizeof lum.lmm_objects[0] == sizeof lmmk->lmm_objects[0]);
628
629         if ((cpu_to_le32(LOV_MAGIC) != LOV_MAGIC) &&
630             ((lmmk->lmm_magic == cpu_to_le32(LOV_MAGIC_V1)) ||
631             (lmmk->lmm_magic == cpu_to_le32(LOV_MAGIC_V3)))) {
632                 lustre_swab_lov_mds_md(lmmk);
633                 lustre_swab_lov_user_md_objects(
634                                 (struct lov_user_ost_data*)lmmk->lmm_objects,
635                                 lmmk->lmm_stripe_count);
636         }
637         if (lum.lmm_magic == LOV_USER_MAGIC) {
638                 /* User request for v1, we need skip lmm_pool_name */
639                 if (lmmk->lmm_magic == LOV_MAGIC_V3) {
640                         memmove((char*)(&lmmk->lmm_stripe_count) +
641                                 sizeof(lmmk->lmm_stripe_count),
642                                 ((struct lov_mds_md_v3*)lmmk)->lmm_objects,
643                                 lmmk->lmm_stripe_count *
644                                 sizeof(struct lov_ost_data_v1));
645                         lmm_size -= LOV_MAXPOOLNAME;
646                 }
647         } else {
648                 /* if v3 we just have to update the lum_size */
649                 lum_size = sizeof(struct lov_user_md_v3);
650         }
651
652         /* User wasn't expecting this many OST entries */
653         if (lum.lmm_stripe_count == 0)
654                 lmm_size = lum_size;
655         else if (lum.lmm_stripe_count < lmmk->lmm_stripe_count)
656                 GOTO(out_set, rc = -EOVERFLOW);
657         /*
658          * Have a difference between lov_mds_md & lov_user_md.
659          * So we have to re-order the data before copy to user.
660          */
661         lum.lmm_stripe_count = lmmk->lmm_stripe_count;
662         lum.u.lum_layout_gen = lmmk->lmm_layout_gen;
663         ((struct lov_user_md*)lmmk)->u.lum_layout_gen = lum.u.lum_layout_gen;
664         ((struct lov_user_md*)lmmk)->lmm_stripe_count = lum.lmm_stripe_count;
665         if (cfs_copy_to_user(lump, lmmk, lmm_size))
666                 rc = -EFAULT;
667
668         obd_free_diskmd(exp, &lmmk);
669 out_set:
670         set_fs(seg);
671         RETURN(rc);
672 }