Whamcloud - gitweb
LU-11753 obdclass: index_page support variable length rec
[fs/lustre-release.git] / lustre / obdclass / dt_object.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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/obdclass/dt_object.c
33  *
34  * Dt Object.
35  * Generic functions from dt_object.h
36  *
37  * Author: Nikita Danilov <nikita@clusterfs.com>
38  */
39
40 #define DEBUG_SUBSYSTEM S_CLASS
41
42 #include <linux/list.h>
43 #include <obd_class.h>
44 #include <dt_object.h>
45 /* fid_be_to_cpu() */
46 #include <lustre_fid.h>
47 #include <lustre_nodemap.h>
48 #include <lustre_quota.h>
49 #include <lustre_lfsck.h>
50
51 /* context key constructor/destructor: dt_global_key_init, dt_global_key_fini */
52 LU_KEY_INIT(dt_global, struct dt_thread_info);
53 LU_KEY_FINI(dt_global, struct dt_thread_info);
54
55 struct lu_context_key dt_key = {
56         .lct_tags = LCT_MD_THREAD | LCT_DT_THREAD | LCT_MG_THREAD | LCT_LOCAL,
57         .lct_init = dt_global_key_init,
58         .lct_fini = dt_global_key_fini
59 };
60
61 /*
62  * no lock is necessary to protect the list, because call-backs
63  * are added during system startup. Please refer to "struct dt_device".
64  */
65 void dt_txn_callback_add(struct dt_device *dev, struct dt_txn_callback *cb)
66 {
67         list_add(&cb->dtc_linkage, &dev->dd_txn_callbacks);
68 }
69 EXPORT_SYMBOL(dt_txn_callback_add);
70
71 void dt_txn_callback_del(struct dt_device *dev, struct dt_txn_callback *cb)
72 {
73         list_del_init(&cb->dtc_linkage);
74 }
75 EXPORT_SYMBOL(dt_txn_callback_del);
76
77 int dt_txn_hook_start(const struct lu_env *env,
78                       struct dt_device *dev, struct thandle *th)
79 {
80         int rc = 0;
81         struct dt_txn_callback *cb;
82
83         if (th->th_local)
84                 return 0;
85
86         list_for_each_entry(cb, &dev->dd_txn_callbacks, dtc_linkage) {
87                 struct thandle *dtc_th = th;
88
89                 if (cb->dtc_txn_start == NULL ||
90                     !(cb->dtc_tag & env->le_ctx.lc_tags))
91                         continue;
92
93                 /*
94                  * Usually dt_txn_hook_start is called from bottom device,
95                  * and if the thandle has th_top, then we need use top
96                  * thandle for the callback in the top thandle layer
97                  */
98                 if (th->th_top != NULL)
99                         dtc_th = th->th_top;
100
101                 rc = cb->dtc_txn_start(env, dtc_th, cb->dtc_cookie);
102                 if (rc < 0)
103                         break;
104         }
105         return rc;
106 }
107 EXPORT_SYMBOL(dt_txn_hook_start);
108
109 int dt_txn_hook_stop(const struct lu_env *env, struct thandle *th)
110 {
111         struct dt_device *dev = th->th_dev;
112         struct dt_txn_callback *cb;
113         int rc = 0;
114
115         if (th->th_local)
116                 return 0;
117
118         if (OBD_FAIL_CHECK(OBD_FAIL_DT_TXN_STOP))
119                 return -EIO;
120
121         list_for_each_entry(cb, &dev->dd_txn_callbacks, dtc_linkage) {
122                 struct thandle *dtc_th = th;
123
124                 if (cb->dtc_txn_stop == NULL ||
125                     !(cb->dtc_tag & env->le_ctx.lc_tags))
126                         continue;
127
128                 /*
129                  * Usually dt_txn_hook_stop is called from bottom device,
130                  * and if the thandle has th_top, then we need use top
131                  * thandle for the callback in the top thandle layer
132                  */
133                 if (th->th_top != NULL)
134                         dtc_th = th->th_top;
135
136                 rc = cb->dtc_txn_stop(env, dtc_th, cb->dtc_cookie);
137                 if (rc < 0)
138                         break;
139         }
140         return rc;
141 }
142 EXPORT_SYMBOL(dt_txn_hook_stop);
143
144 void dt_txn_hook_commit(struct thandle *th)
145 {
146         struct dt_txn_callback *cb;
147
148         if (th->th_local)
149                 return;
150
151         list_for_each_entry(cb, &th->th_dev->dd_txn_callbacks,
152                             dtc_linkage) {
153                 /*
154                  * Right now, the bottom device (OSD) will use this hook
155                  * commit to notify OSP, so we do not check and replace
156                  * the thandle to top thandle now
157                  */
158                 if (cb->dtc_txn_commit)
159                         cb->dtc_txn_commit(th, cb->dtc_cookie);
160         }
161 }
162 EXPORT_SYMBOL(dt_txn_hook_commit);
163
164 int dt_device_init(struct dt_device *dev, struct lu_device_type *t)
165 {
166         INIT_LIST_HEAD(&dev->dd_txn_callbacks);
167         return lu_device_init(&dev->dd_lu_dev, t);
168 }
169 EXPORT_SYMBOL(dt_device_init);
170
171 void dt_device_fini(struct dt_device *dev)
172 {
173         lu_device_fini(&dev->dd_lu_dev);
174 }
175 EXPORT_SYMBOL(dt_device_fini);
176
177 int dt_object_init(struct dt_object *obj,
178                    struct lu_object_header *h, struct lu_device *d)
179
180 {
181         return lu_object_init(&obj->do_lu, h, d);
182 }
183 EXPORT_SYMBOL(dt_object_init);
184
185 void dt_object_fini(struct dt_object *obj)
186 {
187         lu_object_fini(&obj->do_lu);
188 }
189 EXPORT_SYMBOL(dt_object_fini);
190
191 int dt_try_as_dir(const struct lu_env *env, struct dt_object *obj)
192 {
193         if (obj->do_index_ops == NULL)
194                 obj->do_ops->do_index_try(env, obj, &dt_directory_features);
195         return obj->do_index_ops != NULL;
196 }
197 EXPORT_SYMBOL(dt_try_as_dir);
198
199 enum dt_format_type dt_mode_to_dft(__u32 mode)
200 {
201         enum dt_format_type result;
202
203         switch (mode & S_IFMT) {
204         case S_IFDIR:
205                 result = DFT_DIR;
206                 break;
207         case S_IFREG:
208                 result = DFT_REGULAR;
209                 break;
210         case S_IFLNK:
211                 result = DFT_SYM;
212                 break;
213         case S_IFCHR:
214         case S_IFBLK:
215         case S_IFIFO:
216         case S_IFSOCK:
217                 result = DFT_NODE;
218                 break;
219         default:
220                 LASSERTF(0, "invalid mode %o\n", mode);
221                 result = 0; /* Just for satisfying compiler. */
222                 break;
223         }
224         return result;
225 }
226 EXPORT_SYMBOL(dt_mode_to_dft);
227
228 /**
229  * lookup fid for object named \a name in directory \a dir.
230  */
231
232 int dt_lookup_dir(const struct lu_env *env, struct dt_object *dir,
233                   const char *name, struct lu_fid *fid)
234 {
235         if (dt_try_as_dir(env, dir))
236                 return dt_lookup(env, dir, (struct dt_rec *)fid,
237                                  (const struct dt_key *)name);
238         return -ENOTDIR;
239 }
240 EXPORT_SYMBOL(dt_lookup_dir);
241
242 /*
243  * this differs from dt_locate by top_dev as parameter
244  * but not one from lu_site
245  */
246 struct dt_object *dt_locate_at(const struct lu_env *env,
247                                struct dt_device *dev,
248                                const struct lu_fid *fid,
249                                struct lu_device *top_dev,
250                                const struct lu_object_conf *conf)
251 {
252         struct lu_object *lo;
253         struct lu_object *n;
254
255         lo = lu_object_find_at(env, top_dev, fid, conf);
256         if (IS_ERR(lo))
257                 return ERR_PTR(PTR_ERR(lo));
258
259         LASSERT(lo != NULL);
260
261         list_for_each_entry(n, &lo->lo_header->loh_layers, lo_linkage) {
262                 if (n->lo_dev == &dev->dd_lu_dev)
263                         return container_of0(n, struct dt_object, do_lu);
264         }
265
266         lu_object_put(env, lo);
267         return ERR_PTR(-ENOENT);
268 }
269 EXPORT_SYMBOL(dt_locate_at);
270
271 /**
272  * find an object named \a entry in given \a dfh->dfh_o directory.
273  */
274 static int dt_find_entry(const struct lu_env *env, const char *entry,
275                          void *data)
276 {
277         struct dt_find_hint *dfh = data;
278         struct dt_device *dt = dfh->dfh_dt;
279         struct lu_fid *fid = dfh->dfh_fid;
280         struct dt_object *obj = dfh->dfh_o;
281         int rc;
282
283         rc = dt_lookup_dir(env, obj, entry, fid);
284         dt_object_put(env, obj);
285         if (rc == 0) {
286                 obj = dt_locate(env, dt, fid);
287                 if (IS_ERR(obj))
288                         rc = PTR_ERR(obj);
289         }
290         dfh->dfh_o = obj;
291
292         return rc;
293 }
294
295 /**
296  * Abstract function which parses path name. This function feeds
297  * path component to \a entry_func.
298  */
299 int dt_path_parser(const struct lu_env *env,
300                    char *path, dt_entry_func_t entry_func,
301                    void *data)
302 {
303         char *e;
304         int rc = 0;
305
306         while (1) {
307                 e = strsep(&path, "/");
308                 if (e == NULL)
309                         break;
310
311                 if (e[0] == 0) {
312                         if (!path || path[0] == '\0')
313                                 break;
314                         continue;
315                 }
316                 rc = entry_func(env, e, data);
317                 if (rc)
318                         break;
319         }
320
321         return rc;
322 }
323
324 struct dt_object *
325 dt_store_resolve(const struct lu_env *env, struct dt_device *dt,
326                  const char *path, struct lu_fid *fid)
327 {
328         struct dt_thread_info *info = dt_info(env);
329         struct dt_find_hint *dfh = &info->dti_dfh;
330         struct dt_object *obj;
331         int result;
332
333
334         dfh->dfh_dt = dt;
335         dfh->dfh_fid = fid;
336
337         strlcpy(info->dti_buf, path, sizeof(info->dti_buf));
338
339         result = dt->dd_ops->dt_root_get(env, dt, fid);
340         if (result == 0) {
341                 obj = dt_locate(env, dt, fid);
342                 if (!IS_ERR(obj)) {
343                         dfh->dfh_o = obj;
344                         result = dt_path_parser(env, info->dti_buf,
345                                                 dt_find_entry, dfh);
346                         if (result != 0)
347                                 obj = ERR_PTR(result);
348                         else
349                                 obj = dfh->dfh_o;
350                 }
351         } else {
352                 obj = ERR_PTR(result);
353         }
354         return obj;
355 }
356
357 static struct dt_object *dt_reg_open(const struct lu_env *env,
358                                      struct dt_device *dt,
359                                      struct dt_object *p,
360                                      const char *name,
361                                      struct lu_fid *fid)
362 {
363         struct dt_object *o;
364         int result;
365
366         result = dt_lookup_dir(env, p, name, fid);
367         if (result == 0)
368                 o = dt_locate(env, dt, fid);
369         else
370                 o = ERR_PTR(result);
371
372         return o;
373 }
374
375 /**
376  * Open dt object named \a filename from \a dirname directory.
377  *      \param  dt      dt device
378  *      \param  fid     on success, object fid is stored in *fid
379  */
380 struct dt_object *dt_store_open(const struct lu_env *env, struct dt_device *dt,
381                                 const char *dirname, const char *filename,
382                                 struct lu_fid *fid)
383 {
384         struct dt_object *file;
385         struct dt_object *dir;
386
387         dir = dt_store_resolve(env, dt, dirname, fid);
388         if (!IS_ERR(dir)) {
389                 file = dt_reg_open(env, dt, dir, filename, fid);
390                 dt_object_put(env, dir);
391         } else {
392                 file = dir;
393         }
394
395         return file;
396 }
397
398 struct dt_object *dt_find_or_create(const struct lu_env *env,
399                                     struct dt_device *dt,
400                                     const struct lu_fid *fid,
401                                     struct dt_object_format *dof,
402                                     struct lu_attr *at)
403 {
404         struct dt_object *dto;
405         struct thandle *th;
406         int rc;
407
408         ENTRY;
409
410         dto = dt_locate(env, dt, fid);
411         if (IS_ERR(dto))
412                 RETURN(dto);
413
414         LASSERT(dto != NULL);
415         if (dt_object_exists(dto))
416                 RETURN(dto);
417
418         th = dt_trans_create(env, dt);
419         if (IS_ERR(th))
420                 GOTO(out, rc = PTR_ERR(th));
421
422         rc = dt_declare_create(env, dto, at, NULL, dof, th);
423         if (rc)
424                 GOTO(trans_stop, rc);
425
426         rc = dt_trans_start_local(env, dt, th);
427         if (rc)
428                 GOTO(trans_stop, rc);
429
430         dt_write_lock(env, dto, 0);
431         if (dt_object_exists(dto))
432                 GOTO(unlock, rc = 0);
433
434         CDEBUG(D_OTHER, "create new object "DFID"\n", PFID(fid));
435
436         rc = dt_create(env, dto, at, NULL, dof, th);
437         if (rc)
438                 GOTO(unlock, rc);
439         LASSERT(dt_object_exists(dto));
440 unlock:
441         dt_write_unlock(env, dto);
442 trans_stop:
443         dt_trans_stop(env, dt, th);
444 out:
445         if (rc) {
446                 dt_object_put(env, dto);
447                 dto = ERR_PTR(rc);
448         }
449
450         RETURN(dto);
451 }
452 EXPORT_SYMBOL(dt_find_or_create);
453
454 /* dt class init function. */
455 int dt_global_init(void)
456 {
457         int result;
458
459         LU_CONTEXT_KEY_INIT(&dt_key);
460         result = lu_context_key_register(&dt_key);
461         return result;
462 }
463
464 void dt_global_fini(void)
465 {
466         lu_context_key_degister(&dt_key);
467 }
468
469 /**
470  * Generic read helper. May return an error for partial reads.
471  *
472  * \param env  lustre environment
473  * \param dt   object to be read
474  * \param buf  lu_buf to be filled, with buffer pointer and length
475  * \param pos position to start reading, updated as data is read
476  *
477  * \retval real size of data read
478  * \retval -ve errno on failure
479  */
480 int dt_read(const struct lu_env *env, struct dt_object *dt,
481             struct lu_buf *buf, loff_t *pos)
482 {
483         LASSERTF(dt != NULL, "dt is NULL when we want to read record\n");
484         return dt->do_body_ops->dbo_read(env, dt, buf, pos);
485 }
486 EXPORT_SYMBOL(dt_read);
487
488 /**
489  * Read structures of fixed size from storage.  Unlike dt_read(), using
490  * dt_record_read() will return an error for partial reads.
491  *
492  * \param env  lustre environment
493  * \param dt   object to be read
494  * \param buf  lu_buf to be filled, with buffer pointer and length
495  * \param pos position to start reading, updated as data is read
496  *
497  * \retval 0 on successfully reading full buffer
498  * \retval -EFAULT on short read
499  * \retval -ve errno on failure
500  */
501 int dt_record_read(const struct lu_env *env, struct dt_object *dt,
502                    struct lu_buf *buf, loff_t *pos)
503 {
504         ssize_t size;
505
506         LASSERTF(dt != NULL, "dt is NULL when we want to read record\n");
507
508         size = dt->do_body_ops->dbo_read(env, dt, buf, pos);
509         if (size < 0)
510                 return size;
511         return (size == (ssize_t)buf->lb_len) ? 0 : -EFAULT;
512 }
513 EXPORT_SYMBOL(dt_record_read);
514
515 int dt_record_write(const struct lu_env *env, struct dt_object *dt,
516                     const struct lu_buf *buf, loff_t *pos, struct thandle *th)
517 {
518         ssize_t size;
519
520         LASSERTF(dt != NULL, "dt is NULL when we want to write record\n");
521         LASSERT(th != NULL);
522         LASSERT(dt->do_body_ops);
523         LASSERT(dt->do_body_ops->dbo_write);
524
525         size = dt->do_body_ops->dbo_write(env, dt, buf, pos, th);
526         if (size < 0)
527                 return size;
528         return (size == (ssize_t)buf->lb_len) ? 0 : -EFAULT;
529 }
530 EXPORT_SYMBOL(dt_record_write);
531
532 int dt_declare_version_set(const struct lu_env *env, struct dt_object *o,
533                            struct thandle *th)
534 {
535         struct lu_buf vbuf;
536         char *xname = XATTR_NAME_VERSION;
537
538         LASSERT(o);
539         vbuf.lb_buf = NULL;
540         vbuf.lb_len = sizeof(dt_obj_version_t);
541         return dt_declare_xattr_set(env, o, &vbuf, xname, 0, th);
542
543 }
544 EXPORT_SYMBOL(dt_declare_version_set);
545
546 void dt_version_set(const struct lu_env *env, struct dt_object *o,
547                     dt_obj_version_t version, struct thandle *th)
548 {
549         struct lu_buf vbuf;
550         char *xname = XATTR_NAME_VERSION;
551         int rc;
552
553         LASSERT(o);
554         vbuf.lb_buf = &version;
555         vbuf.lb_len = sizeof(version);
556
557         rc = dt_xattr_set(env, o, &vbuf, xname, 0, th);
558         if (rc < 0)
559                 CDEBUG(D_INODE, "Can't set version, rc %d\n", rc);
560         return;
561 }
562 EXPORT_SYMBOL(dt_version_set);
563
564 dt_obj_version_t dt_version_get(const struct lu_env *env, struct dt_object *o)
565 {
566         struct lu_buf vbuf;
567         char *xname = XATTR_NAME_VERSION;
568         dt_obj_version_t version;
569         int rc;
570
571         LASSERT(o);
572         vbuf.lb_buf = &version;
573         vbuf.lb_len = sizeof(version);
574         rc = dt_xattr_get(env, o, &vbuf, xname);
575         if (rc != sizeof(version)) {
576                 CDEBUG(D_INODE, "Can't get version, rc %d\n", rc);
577                 version = 0;
578         }
579         return version;
580 }
581 EXPORT_SYMBOL(dt_version_get);
582
583 /* list of all supported index types */
584
585 /* directories */
586 const struct dt_index_features dt_directory_features;
587 EXPORT_SYMBOL(dt_directory_features);
588
589 /* scrub iterator */
590 const struct dt_index_features dt_otable_features;
591 EXPORT_SYMBOL(dt_otable_features);
592
593 /* lfsck layout orphan */
594 const struct dt_index_features dt_lfsck_layout_orphan_features = {
595         .dif_flags              = 0,
596         .dif_keysize_min        = sizeof(struct lu_fid),
597         .dif_keysize_max        = sizeof(struct lu_fid),
598         .dif_recsize_min        = sizeof(struct lu_orphan_rec_v3),
599         .dif_recsize_max        = sizeof(struct lu_orphan_rec_v3),
600         .dif_ptrsize            = 4
601 };
602 EXPORT_SYMBOL(dt_lfsck_layout_orphan_features);
603
604 /* lfsck layout dangling */
605 const struct dt_index_features dt_lfsck_layout_dangling_features = {
606         .dif_flags              = DT_IND_UPDATE,
607         .dif_keysize_min        = sizeof(struct lfsck_layout_dangling_key),
608         .dif_keysize_max        = sizeof(struct lfsck_layout_dangling_key),
609         .dif_recsize_min        = sizeof(struct lu_fid),
610         .dif_recsize_max        = sizeof(struct lu_fid),
611         .dif_ptrsize            = 4
612 };
613 EXPORT_SYMBOL(dt_lfsck_layout_dangling_features);
614
615 /* lfsck namespace */
616 const struct dt_index_features dt_lfsck_namespace_features = {
617         .dif_flags              = DT_IND_UPDATE,
618         .dif_keysize_min        = sizeof(struct lu_fid),
619         .dif_keysize_max        = sizeof(struct lu_fid),
620         .dif_recsize_min        = sizeof(__u8),
621         .dif_recsize_max        = sizeof(__u8),
622         .dif_ptrsize            = 4
623 };
624 EXPORT_SYMBOL(dt_lfsck_namespace_features);
625
626 /* accounting indexes */
627 const struct dt_index_features dt_acct_features = {
628         .dif_flags              = DT_IND_UPDATE,
629         .dif_keysize_min        = sizeof(__u64), /* 64-bit uid/gid */
630         .dif_keysize_max        = sizeof(__u64), /* 64-bit uid/gid */
631         .dif_recsize_min        = sizeof(struct lquota_acct_rec), /* 16 bytes */
632         .dif_recsize_max        = sizeof(struct lquota_acct_rec), /* 16 bytes */
633         .dif_ptrsize            = 4
634 };
635 EXPORT_SYMBOL(dt_acct_features);
636
637 /* global quota files */
638 const struct dt_index_features dt_quota_glb_features = {
639         .dif_flags              = DT_IND_UPDATE,
640         /* a different key would have to be used for per-directory quota */
641         .dif_keysize_min        = sizeof(__u64), /* 64-bit uid/gid */
642         .dif_keysize_max        = sizeof(__u64), /* 64-bit uid/gid */
643         .dif_recsize_min        = sizeof(struct lquota_glb_rec), /* 32 bytes */
644         .dif_recsize_max        = sizeof(struct lquota_glb_rec), /* 32 bytes */
645         .dif_ptrsize            = 4
646 };
647 EXPORT_SYMBOL(dt_quota_glb_features);
648
649 /* slave quota files */
650 const struct dt_index_features dt_quota_slv_features = {
651         .dif_flags              = DT_IND_UPDATE,
652         /* a different key would have to be used for per-directory quota */
653         .dif_keysize_min        = sizeof(__u64), /* 64-bit uid/gid */
654         .dif_keysize_max        = sizeof(__u64), /* 64-bit uid/gid */
655         .dif_recsize_min        = sizeof(struct lquota_slv_rec), /* 8 bytes */
656         .dif_recsize_max        = sizeof(struct lquota_slv_rec), /* 8 bytes */
657         .dif_ptrsize            = 4
658 };
659 EXPORT_SYMBOL(dt_quota_slv_features);
660
661 /* nodemap files, nodemap_rec size asserted in nodemap_storage.c */
662 const struct dt_index_features dt_nodemap_features = {
663         .dif_flags              = DT_IND_UPDATE,
664         .dif_keysize_min        = sizeof(__u64), /* 64-bit nodemap/record id */
665         .dif_keysize_max        = sizeof(__u64), /* 64-bit nodemap/record id */
666         .dif_recsize_min        = sizeof(union nodemap_rec), /* 32 bytes */
667         .dif_recsize_max        = sizeof(union nodemap_rec), /* 32 bytes */
668         .dif_ptrsize            = 4
669 };
670 EXPORT_SYMBOL(dt_nodemap_features);
671
672 /*
673  * helper function returning what dt_index_features structure should be used
674  * based on the FID sequence. This is used by OBD_IDX_READ RPC
675  */
676 static inline const struct dt_index_features *dt_index_feat_select(__u64 seq,
677                                                                    __u32 mode)
678 {
679         if (seq == FID_SEQ_QUOTA_GLB) {
680                 /* global quota index */
681                 if (!S_ISREG(mode))
682                         /* global quota index should be a regular file */
683                         return ERR_PTR(-ENOENT);
684                 return &dt_quota_glb_features;
685         } else if (seq == FID_SEQ_QUOTA) {
686                 /* quota slave index */
687                 if (!S_ISREG(mode))
688                         /* slave index should be a regular file */
689                         return ERR_PTR(-ENOENT);
690                 return &dt_quota_slv_features;
691         } else if (seq == FID_SEQ_LAYOUT_RBTREE){
692                 return &dt_lfsck_layout_orphan_features;
693         } else if (seq >= FID_SEQ_NORMAL) {
694                 /* object is part of the namespace, verify that it is a
695                  * directory */
696                 if (!S_ISDIR(mode))
697                         /* sorry, we can only deal with directory */
698                         return ERR_PTR(-ENOTDIR);
699                 return &dt_directory_features;
700         }
701
702         return ERR_PTR(-EOPNOTSUPP);
703 }
704
705 /*
706  * Fill a lu_idxpage with key/record pairs read for transfer via OBD_IDX_READ
707  * RPC
708  *
709  * \param env - is the environment passed by the caller
710  * \param lp  - is a pointer to the lu_page to fill
711  * \param nob - is the maximum number of bytes that should be copied
712  * \param iops - is the index operation vector associated with the index object
713  * \param it   - is a pointer to the current iterator
714  * \param attr - is the index attribute to pass to iops->rec()
715  * \param arg  - is a pointer to the idx_info structure
716  */
717 static int dt_index_page_build(const struct lu_env *env, union lu_page *lp,
718                                size_t nob, const struct dt_it_ops *iops,
719                                struct dt_it *it, __u32 attr, void *arg)
720 {
721         struct idx_info *ii = (struct idx_info *)arg;
722         struct lu_idxpage *lip = &lp->lp_idx;
723         char *entry;
724         __u64 hash;
725         __u16 hashsize = 0;
726         __u16 keysize = 0;
727         __u16 recsize;
728         int rc;
729
730         ENTRY;
731
732         if (nob < LIP_HDR_SIZE)
733                 return -EINVAL;
734
735         /* initialize the header of the new container */
736         memset(lip, 0, LIP_HDR_SIZE);
737         lip->lip_magic = LIP_MAGIC;
738         nob           -= LIP_HDR_SIZE;
739
740         /* client wants to the 64-bit hash value associated with each record */
741         if (!(ii->ii_flags & II_FL_NOHASH))
742                 hashsize = sizeof(hash);
743
744         entry = lip->lip_entries;
745         do {
746                 /* fetch 64-bit hash value */
747                 hash = iops->store(env, it);
748                 ii->ii_hash_end = hash;
749
750                 if (OBD_FAIL_CHECK(OBD_FAIL_OBD_IDX_READ_BREAK)) {
751                         if (lip->lip_nr != 0)
752                                 GOTO(out, rc = 0);
753                 }
754
755                 if (!(ii->ii_flags & II_FL_NOKEY)) {
756                         keysize = iops->key_size(env, it);
757                         if (!(ii->ii_flags & II_FL_VARKEY) &&
758                             keysize != ii->ii_keysize) {
759                                 CERROR("keysize mismatch %hu != %hu.\n",
760                                        keysize, ii->ii_keysize);
761                                 GOTO(out, rc = -EINVAL);
762                         }
763                 }
764
765                 /* and finally the record */
766                 if (ii->ii_flags & II_FL_VARREC)
767                         recsize = iops->rec_size(env, it, attr);
768                 else
769                         recsize = ii->ii_recsize;
770
771                 if (nob < hashsize + keysize + recsize) {
772                         if (lip->lip_nr == 0)
773                                 GOTO(out, rc = -E2BIG);
774                         GOTO(out, rc = 0);
775                 }
776
777                 rc = iops->rec(env, it,
778                                (struct dt_rec *)(entry + hashsize + keysize),
779                                attr);
780                 if (!rc) {
781                         if (hashsize)
782                                 memcpy(entry, &hash, hashsize);
783                         if (keysize) {
784                                 struct dt_key *key;
785
786                                 key = iops->key(env, it);
787                                 memcpy(entry + hashsize, key, keysize);
788                         }
789                         /* hash/key/record successfully copied! */
790                         lip->lip_nr++;
791                         if (unlikely(lip->lip_nr == 1 && ii->ii_count == 0))
792                                 ii->ii_hash_start = hash;
793                         entry += hashsize + keysize + recsize;
794                         nob -= hashsize + keysize + recsize;
795                 } else if (rc != -ESTALE) {
796                         GOTO(out, rc);
797                 }
798
799                 /* move on to the next record */
800                 do {
801                         rc = iops->next(env, it);
802                 } while (rc == -ESTALE);
803         } while (rc == 0);
804
805         GOTO(out, rc);
806 out:
807         if (rc >= 0 && lip->lip_nr > 0)
808                 /* one more container */
809                 ii->ii_count++;
810         if (rc > 0)
811                 /* no more entries */
812                 ii->ii_hash_end = II_END_OFF;
813         return rc;
814 }
815
816
817 /*
818  * Walk index and fill lu_page containers with key/record pairs
819  *
820  * \param env - is the environment passed by the caller
821  * \param obj - is the index object to parse
822  * \param rdpg - is the lu_rdpg descriptor associated with the transfer
823  * \param filler - is the callback function responsible for filling a lu_page
824  *                 with key/record pairs in the format wanted by the caller.
825  *                 If NULL, uses dt_index_page_build
826  * \param arg    - is an opaq argument passed to the filler function
827  *
828  * \retval sum (in bytes) of all filled lu_pages
829  * \retval -ve errno on failure
830  */
831 int dt_index_walk(const struct lu_env *env, struct dt_object *obj,
832                   const struct lu_rdpg *rdpg, dt_index_page_build_t filler,
833                   void *arg)
834 {
835         struct dt_it *it;
836         const struct dt_it_ops *iops;
837         size_t pageidx, nob, nlupgs = 0;
838         int rc;
839         ENTRY;
840
841         LASSERT(rdpg->rp_pages != NULL);
842         LASSERT(obj->do_index_ops != NULL);
843
844         if (filler == NULL)
845                 filler = dt_index_page_build;
846
847         nob = rdpg->rp_count;
848         if (nob == 0)
849                 RETURN(-EFAULT);
850
851         /* Iterate through index and fill containers from @rdpg */
852         iops = &obj->do_index_ops->dio_it;
853         LASSERT(iops != NULL);
854         it = iops->init(env, obj, rdpg->rp_attrs);
855         if (IS_ERR(it))
856                 RETURN(PTR_ERR(it));
857
858         rc = iops->load(env, it, rdpg->rp_hash);
859         if (rc == 0) {
860                 /*
861                  * Iterator didn't find record with exactly the key requested.
862                  *
863                  * It is currently either
864                  *
865                  *     - positioned above record with key less than
866                  *     requested---skip it.
867                  *     - or not positioned at all (is in IAM_IT_SKEWED
868                  *     state)---position it on the next item.
869                  */
870                 rc = iops->next(env, it);
871         } else if (rc > 0) {
872                 rc = 0;
873         } else {
874                 if (rc == -ENODATA)
875                         rc = 0;
876                 GOTO(out, rc);
877         }
878
879         /*
880          * Fill containers one after the other. There might be multiple
881          * containers per physical page.
882          *
883          * At this point and across for-loop:
884          *  rc == 0 -> ok, proceed.
885          *  rc >  0 -> end of index.
886          *  rc <  0 -> error.
887          */
888         for (pageidx = 0; rc == 0 && nob > 0; pageidx++) {
889                 union lu_page   *lp;
890                 int              i;
891
892                 LASSERT(pageidx < rdpg->rp_npages);
893                 lp = kmap(rdpg->rp_pages[pageidx]);
894
895                 /* fill lu pages */
896                 for (i = 0; i < LU_PAGE_COUNT; i++, lp++, nob -= LU_PAGE_SIZE) {
897                         rc = filler(env, lp, min_t(size_t, nob, LU_PAGE_SIZE),
898                                     iops, it, rdpg->rp_attrs, arg);
899                         if (rc < 0)
900                                 break;
901                         /* one more lu_page */
902                         nlupgs++;
903                         if (rc > 0)
904                                 /* end of index */
905                                 break;
906                 }
907                 kunmap(rdpg->rp_pages[i]);
908         }
909
910 out:
911         iops->put(env, it);
912         iops->fini(env, it);
913
914         if (rc >= 0)
915                 rc = min_t(size_t, nlupgs * LU_PAGE_SIZE, rdpg->rp_count);
916
917         RETURN(rc);
918 }
919 EXPORT_SYMBOL(dt_index_walk);
920
921 /**
922  * Walk key/record pairs of an index and copy them into 4KB containers to be
923  * transferred over the network. This is the common handler for OBD_IDX_READ
924  * RPC processing.
925  *
926  * \param env - is the environment passed by the caller
927  * \param dev - is the dt_device storing the index
928  * \param ii  - is the idx_info structure packed by the client in the
929  *              OBD_IDX_READ request
930  * \param rdpg - is the lu_rdpg descriptor
931  *
932  * \retval on success, return sum (in bytes) of all filled containers
933  * \retval appropriate error otherwise.
934  */
935 int dt_index_read(const struct lu_env *env, struct dt_device *dev,
936                   struct idx_info *ii, const struct lu_rdpg *rdpg)
937 {
938         const struct dt_index_features  *feat;
939         struct dt_object                *obj;
940         int                              rc;
941         ENTRY;
942
943         /*
944          * rp_count shouldn't be null and should be a multiple of the container
945          * size
946          */
947         if (rdpg->rp_count == 0 || (rdpg->rp_count & (LU_PAGE_SIZE - 1)) != 0)
948                 RETURN(-EFAULT);
949
950         if (!fid_is_quota(&ii->ii_fid) && !fid_is_layout_rbtree(&ii->ii_fid) &&
951             !fid_is_norm(&ii->ii_fid))
952                 RETURN(-EOPNOTSUPP);
953
954         /* lookup index object subject to the transfer */
955         obj = dt_locate(env, dev, &ii->ii_fid);
956         if (IS_ERR(obj))
957                 RETURN(PTR_ERR(obj));
958         if (dt_object_exists(obj) == 0)
959                 GOTO(out, rc = -ENOENT);
960
961         /* fetch index features associated with index object */
962         feat = dt_index_feat_select(fid_seq(&ii->ii_fid),
963                                     lu_object_attr(&obj->do_lu));
964         if (IS_ERR(feat))
965                 GOTO(out, rc = PTR_ERR(feat));
966
967         /* load index feature if not done already */
968         if (obj->do_index_ops == NULL) {
969                 rc = obj->do_ops->do_index_try(env, obj, feat);
970                 if (rc)
971                         GOTO(out, rc);
972         }
973
974         /* fill ii_flags with supported index features */
975         ii->ii_flags &= (II_FL_NOHASH | II_FL_NOKEY | II_FL_VARKEY |
976                          II_FL_VARREC);
977
978         if (!(feat->dif_flags & DT_IND_VARKEY))
979                 ii->ii_keysize = feat->dif_keysize_max;
980
981         if (!(feat->dif_flags & DT_IND_VARREC))
982                 ii->ii_recsize = feat->dif_recsize_max;
983
984         if (feat->dif_flags & DT_IND_NONUNQ)
985                 /* key isn't necessarily unique */
986                 ii->ii_flags |= II_FL_NONUNQ;
987
988         if (!fid_is_layout_rbtree(&ii->ii_fid)) {
989                 dt_read_lock(env, obj, 0);
990                 /* fetch object version before walking the index */
991                 ii->ii_version = dt_version_get(env, obj);
992         }
993
994         /* walk the index and fill lu_idxpages with key/record pairs */
995         rc = dt_index_walk(env, obj, rdpg, dt_index_page_build, ii);
996         if (!fid_is_layout_rbtree(&ii->ii_fid))
997                 dt_read_unlock(env, obj);
998
999         if (rc == 0) {
1000                 /* index is empty */
1001                 LASSERT(ii->ii_count == 0);
1002                 ii->ii_hash_end = II_END_OFF;
1003         }
1004
1005         GOTO(out, rc);
1006 out:
1007         dt_object_put(env, obj);
1008         return rc;
1009 }
1010 EXPORT_SYMBOL(dt_index_read);
1011
1012 #ifdef CONFIG_PROC_FS
1013 int lprocfs_dt_blksize_seq_show(struct seq_file *m, void *v)
1014 {
1015         struct dt_device *dt = m->private;
1016         struct obd_statfs osfs;
1017
1018         int rc = dt_statfs(NULL, dt, &osfs);
1019         if (rc == 0)
1020                 seq_printf(m, "%u\n", (unsigned) osfs.os_bsize);
1021         return rc;
1022 }
1023 EXPORT_SYMBOL(lprocfs_dt_blksize_seq_show);
1024
1025 int lprocfs_dt_kbytestotal_seq_show(struct seq_file *m, void *v)
1026 {
1027         struct dt_device *dt = m->private;
1028         struct obd_statfs osfs;
1029
1030         int rc = dt_statfs(NULL, dt, &osfs);
1031         if (rc == 0) {
1032                 __u32 blk_size = osfs.os_bsize >> 10;
1033                 __u64 result = osfs.os_blocks;
1034
1035                 while (blk_size >>= 1)
1036                         result <<= 1;
1037
1038                 seq_printf(m, "%llu\n", result);
1039         }
1040         return rc;
1041 }
1042 EXPORT_SYMBOL(lprocfs_dt_kbytestotal_seq_show);
1043
1044 int lprocfs_dt_kbytesfree_seq_show(struct seq_file *m, void *v)
1045 {
1046         struct dt_device *dt = m->private;
1047         struct obd_statfs osfs;
1048
1049         int rc = dt_statfs(NULL, dt, &osfs);
1050         if (rc == 0) {
1051                 __u32 blk_size = osfs.os_bsize >> 10;
1052                 __u64 result = osfs.os_bfree;
1053
1054                 while (blk_size >>= 1)
1055                         result <<= 1;
1056
1057                 seq_printf(m, "%llu\n", result);
1058         }
1059         return rc;
1060 }
1061 EXPORT_SYMBOL(lprocfs_dt_kbytesfree_seq_show);
1062
1063 int lprocfs_dt_kbytesavail_seq_show(struct seq_file *m, void *v)
1064 {
1065         struct dt_device *dt = m->private;
1066         struct obd_statfs osfs;
1067
1068         int rc = dt_statfs(NULL, dt, &osfs);
1069         if (rc == 0) {
1070                 __u32 blk_size = osfs.os_bsize >> 10;
1071                 __u64 result = osfs.os_bavail;
1072
1073                 while (blk_size >>= 1)
1074                         result <<= 1;
1075
1076                 seq_printf(m, "%llu\n", result);
1077         }
1078         return rc;
1079 }
1080 EXPORT_SYMBOL(lprocfs_dt_kbytesavail_seq_show);
1081
1082 int lprocfs_dt_filestotal_seq_show(struct seq_file *m, void *v)
1083 {
1084         struct dt_device *dt = m->private;
1085         struct obd_statfs osfs;
1086
1087         int rc = dt_statfs(NULL, dt, &osfs);
1088         if (rc == 0)
1089                 seq_printf(m, "%llu\n", osfs.os_files);
1090         return rc;
1091 }
1092 EXPORT_SYMBOL(lprocfs_dt_filestotal_seq_show);
1093
1094 int lprocfs_dt_filesfree_seq_show(struct seq_file *m, void *v)
1095 {
1096         struct dt_device *dt = m->private;
1097         struct obd_statfs osfs;
1098
1099         int rc = dt_statfs(NULL, dt, &osfs);
1100         if (rc == 0)
1101                 seq_printf(m, "%llu\n", osfs.os_ffree);
1102         return rc;
1103 }
1104 EXPORT_SYMBOL(lprocfs_dt_filesfree_seq_show);
1105
1106 #endif /* CONFIG_PROC_FS */
1107
1108 static ssize_t uuid_show(struct kobject *kobj, struct attribute *attr,
1109                          char *buf)
1110 {
1111         struct dt_device *dt = container_of(kobj, struct dt_device,
1112                                             dd_kobj);
1113         struct lu_device *lu = dt2lu_dev(dt);
1114
1115         if (!lu->ld_obd)
1116                 return -ENODEV;
1117
1118         return sprintf(buf, "%s\n", lu->ld_obd->obd_uuid.uuid);
1119 }
1120 LUSTRE_RO_ATTR(uuid);
1121
1122 static ssize_t blocksize_show(struct kobject *kobj, struct attribute *attr,
1123                               char *buf)
1124 {
1125         struct dt_device *dt = container_of(kobj, struct dt_device,
1126                                             dd_kobj);
1127         struct obd_statfs osfs;
1128         int rc;
1129
1130         rc = dt_statfs(NULL, dt, &osfs);
1131         if (rc)
1132                 return rc;
1133
1134         return sprintf(buf, "%u\n", (unsigned) osfs.os_bsize);
1135 }
1136 LUSTRE_RO_ATTR(blocksize);
1137
1138 static ssize_t kbytestotal_show(struct kobject *kobj, struct attribute *attr,
1139                                 char *buf)
1140 {
1141         struct dt_device *dt = container_of(kobj, struct dt_device,
1142                                             dd_kobj);
1143         struct obd_statfs osfs;
1144         u32 blk_size;
1145         u64 result;
1146         int rc;
1147
1148         rc = dt_statfs(NULL, dt, &osfs);
1149         if (rc)
1150                 return rc;
1151
1152         blk_size = osfs.os_bsize >> 10;
1153         result = osfs.os_blocks;
1154
1155         while (blk_size >>= 1)
1156                 result <<= 1;
1157
1158         return sprintf(buf, "%llu\n", result);
1159 }
1160 LUSTRE_RO_ATTR(kbytestotal);
1161
1162 static ssize_t kbytesfree_show(struct kobject *kobj, struct attribute *attr,
1163                                char *buf)
1164 {
1165         struct dt_device *dt = container_of(kobj, struct dt_device,
1166                                             dd_kobj);
1167         struct obd_statfs osfs;
1168         u32 blk_size;
1169         u64 result;
1170         int rc;
1171
1172         rc = dt_statfs(NULL, dt, &osfs);
1173         if (rc)
1174                 return rc;
1175
1176         blk_size = osfs.os_bsize >> 10;
1177         result = osfs.os_bfree;
1178
1179         while (blk_size >>= 1)
1180                 result <<= 1;
1181
1182         return sprintf(buf, "%llu\n", result);
1183 }
1184 LUSTRE_RO_ATTR(kbytesfree);
1185
1186 static ssize_t kbytesavail_show(struct kobject *kobj, struct attribute *attr,
1187                                 char *buf)
1188 {
1189         struct dt_device *dt = container_of(kobj, struct dt_device,
1190                                             dd_kobj);
1191         struct obd_statfs osfs;
1192         u32 blk_size;
1193         u64 result;
1194         int rc;
1195
1196         rc = dt_statfs(NULL, dt, &osfs);
1197         if (rc)
1198                 return rc;
1199
1200         blk_size = osfs.os_bsize >> 10;
1201         result = osfs.os_bavail;
1202
1203         while (blk_size >>= 1)
1204                 result <<= 1;
1205
1206         return sprintf(buf, "%llu\n", result);
1207 }
1208 LUSTRE_RO_ATTR(kbytesavail);
1209
1210 static ssize_t filestotal_show(struct kobject *kobj, struct attribute *attr,
1211                                char *buf)
1212 {
1213         struct dt_device *dt = container_of(kobj, struct dt_device,
1214                                             dd_kobj);
1215         struct obd_statfs osfs;
1216         int rc;
1217
1218         rc = dt_statfs(NULL, dt, &osfs);
1219         if (rc)
1220                 return rc;
1221
1222         return sprintf(buf, "%llu\n", osfs.os_files);
1223 }
1224 LUSTRE_RO_ATTR(filestotal);
1225
1226 static ssize_t filesfree_show(struct kobject *kobj, struct attribute *attr,
1227                               char *buf)
1228 {
1229         struct dt_device *dt = container_of(kobj, struct dt_device,
1230                                             dd_kobj);
1231         struct obd_statfs osfs;
1232         int rc;
1233
1234         rc = dt_statfs(NULL, dt, &osfs);
1235         if (rc)
1236                 return rc;
1237
1238         return sprintf(buf, "%llu\n", osfs.os_ffree);
1239 }
1240 LUSTRE_RO_ATTR(filesfree);
1241
1242 static const struct attribute *dt_def_attrs[] = {
1243         &lustre_attr_uuid.attr,
1244         &lustre_attr_blocksize.attr,
1245         &lustre_attr_kbytestotal.attr,
1246         &lustre_attr_kbytesfree.attr,
1247         &lustre_attr_kbytesavail.attr,
1248         &lustre_attr_filestotal.attr,
1249         &lustre_attr_filesfree.attr,
1250         NULL,
1251 };
1252
1253 static void dt_sysfs_release(struct kobject *kobj)
1254 {
1255         struct dt_device *dt = container_of(kobj, struct dt_device,
1256                                             dd_kobj);
1257
1258         complete(&dt->dd_kobj_unregister);
1259 }
1260
1261 int dt_tunables_fini(struct dt_device *dt)
1262 {
1263         if (!dt)
1264                 return -EINVAL;
1265
1266         if (!IS_ERR_OR_NULL(dt->dd_debugfs_entry))
1267                 ldebugfs_remove(&dt->dd_debugfs_entry);
1268
1269         if (dt->dd_def_attrs)
1270                 sysfs_remove_files(&dt->dd_kobj, dt->dd_def_attrs);
1271
1272         kobject_put(&dt->dd_kobj);
1273         wait_for_completion(&dt->dd_kobj_unregister);
1274
1275         return 0;
1276 }
1277 EXPORT_SYMBOL(dt_tunables_fini);
1278
1279 int dt_tunables_init(struct dt_device *dt, struct obd_type *type,
1280                      const char *name, struct lprocfs_vars *list)
1281 {
1282         int rc;
1283
1284         dt->dd_ktype.sysfs_ops = &lustre_sysfs_ops;
1285         dt->dd_ktype.release = dt_sysfs_release;
1286
1287         init_completion(&dt->dd_kobj_unregister);
1288         rc = kobject_init_and_add(&dt->dd_kobj, &dt->dd_ktype, type->typ_kobj,
1289                                   "%s", name);
1290         if (rc)
1291                 return rc;
1292
1293         dt->dd_def_attrs = dt_def_attrs;
1294
1295         rc = sysfs_create_files(&dt->dd_kobj, dt->dd_def_attrs);
1296         if (rc) {
1297                 kobject_put(&dt->dd_kobj);
1298                 return rc;
1299         }
1300
1301         /*
1302          * No need to register debugfs if no enteries. This allows us to
1303          * choose between using dt_device or obd_device for debugfs.
1304          */
1305         if (!list)
1306                 return rc;
1307
1308         dt->dd_debugfs_entry = ldebugfs_register(name,
1309                                                  type->typ_debugfs_entry,
1310                                                  list, dt);
1311         if (IS_ERR_OR_NULL(dt->dd_debugfs_entry)) {
1312                 rc = dt->dd_debugfs_entry ? PTR_ERR(dt->dd_debugfs_entry)
1313                                           : -ENOMEM;
1314                 CERROR("%s: error %d setting up debugfs\n",
1315                        name, rc);
1316                 dt->dd_debugfs_entry = NULL;
1317                 sysfs_remove_files(&dt->dd_kobj, dt->dd_def_attrs);
1318                 kobject_put(&dt->dd_kobj);
1319                 return rc;
1320         }
1321
1322         return rc;
1323 }
1324 EXPORT_SYMBOL(dt_tunables_init);