4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
31 * Copyright (c) 2012, 2013, Intel Corporation.
32 * Use is subject to license terms.
35 * This file is part of Lustre, http://www.lustre.org/
36 * Lustre is a trademark of Sun Microsystems, Inc.
38 * lustre/osd-zfs/osd_index.c
40 * Author: Alex Zhuravlev <bzzz@whamcloud.com>
41 * Author: Mike Pershin <tappro@whamcloud.com>
44 #define DEBUG_SUBSYSTEM S_OSD
46 #include <lustre_ver.h>
47 #include <libcfs/libcfs.h>
48 #include <obd_support.h>
49 #include <lustre_net.h>
51 #include <obd_class.h>
52 #include <lustre_disk.h>
53 #include <lustre_fid.h>
55 #include "osd_internal.h"
57 #include <sys/dnode.h>
62 #include <sys/spa_impl.h>
63 #include <sys/zfs_znode.h>
64 #include <sys/dmu_tx.h>
65 #include <sys/dmu_objset.h>
66 #include <sys/dsl_prop.h>
67 #include <sys/sa_impl.h>
70 static inline int osd_object_is_zap(dmu_buf_t *db)
72 dmu_buf_impl_t *dbi = (dmu_buf_impl_t *) db;
78 rc = (dn->dn_type == DMU_OT_DIRECTORY_CONTENTS ||
79 dn->dn_type == DMU_OT_USERGROUP_USED);
85 /* We don't actually have direct access to the zap_hashbits() function
86 * so just pretend like we do for now. If this ever breaks we can look at
88 #define zap_hashbits(zc) 48
91 * | cd (16 bits) | hash (48 bits) |
92 * we need it in other form:
93 * |0| hash (48 bit) | cd (15 bit) |
94 * to be a full 64-bit ordered hash so that Lustre readdir can use it to merge
95 * the readdir hashes from multiple directory stripes uniformly on the client.
96 * Another point is sign bit, the hash range should be in [0, 2^63-1] because
97 * loff_t (for llseek) needs to be a positive value. This means the "cd" field
98 * should only be the low 15 bits.
100 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc)
102 uint64_t zfs_hash = zap_cursor_serialize(zc) & (~0ULL >> 1);
104 return (zfs_hash >> zap_hashbits(zc)) |
105 (zfs_hash << (63 - zap_hashbits(zc)));
108 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
109 uint64_t id, uint64_t dirhash)
111 uint64_t zfs_hash = ((dirhash << zap_hashbits(zc)) & (~0ULL >> 1)) |
112 (dirhash >> (63 - zap_hashbits(zc)));
114 zap_cursor_init_serialized(zc, os, id, zfs_hash);
117 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
118 uint64_t id, uint64_t dirhash)
123 if (unlikely(t == NULL))
126 osd_zap_cursor_init_serialized(t, os, id, dirhash);
132 void osd_zap_cursor_fini(zap_cursor_t *zc)
138 static inline void osd_obj_cursor_init_serialized(zap_cursor_t *zc,
139 struct osd_object *o,
142 struct osd_device *d = osd_obj2dev(o);
143 zap_cursor_init_serialized(zc, d->od_os, o->oo_db->db_object, dirhash);
146 static inline int osd_obj_cursor_init(zap_cursor_t **zc, struct osd_object *o,
149 struct osd_device *d = osd_obj2dev(o);
150 return osd_zap_cursor_init(zc, d->od_os, o->oo_db->db_object, dirhash);
153 static struct dt_it *osd_index_it_init(const struct lu_env *env,
154 struct dt_object *dt,
156 struct lustre_capa *capa)
158 struct osd_thread_info *info = osd_oti_get(env);
159 struct osd_zap_it *it;
160 struct osd_object *obj = osd_dt_obj(dt);
161 struct lu_object *lo = &dt->do_lu;
165 /* XXX: check capa ? */
167 LASSERT(lu_object_exists(lo));
169 LASSERT(osd_object_is_zap(obj->oo_db));
172 if (info->oti_it_inline) {
175 RETURN(ERR_PTR(-ENOMEM));
177 it = &info->oti_it_zap;
178 info->oti_it_inline = 1;
181 rc = osd_obj_cursor_init(&it->ozi_zc, obj, 0);
183 if (it != &info->oti_it_zap)
186 info->oti_it_inline = 0;
196 RETURN((struct dt_it *)it);
199 static void osd_index_it_fini(const struct lu_env *env, struct dt_it *di)
201 struct osd_thread_info *info = osd_oti_get(env);
202 struct osd_zap_it *it = (struct osd_zap_it *)di;
203 struct osd_object *obj;
207 LASSERT(it->ozi_obj);
211 osd_zap_cursor_fini(it->ozi_zc);
212 lu_object_put(env, &obj->oo_dt.do_lu);
213 if (it != &info->oti_it_zap)
216 info->oti_it_inline = 0;
222 static void osd_index_it_put(const struct lu_env *env, struct dt_it *di)
224 /* PBS: do nothing : ref are incremented at retrive and decreamented
228 static inline void osd_it_append_attrs(struct lu_dirent *ent, __u32 attr,
231 const unsigned align = sizeof(struct luda_type) - 1;
232 struct luda_type *lt;
234 /* check if file type is required */
235 if (attr & LUDA_TYPE) {
236 len = (len + align) & ~align;
238 lt = (void *)ent->lde_name + len;
239 lt->lt_type = cpu_to_le16(DTTOIF(type));
240 ent->lde_attrs |= LUDA_TYPE;
243 ent->lde_attrs = cpu_to_le32(ent->lde_attrs);
247 * as we don't know FID, we can't use LU object, so this function
248 * partially duplicate __osd_xattr_get() which is built around
249 * LU-object and uses it to cache data like regular EA dnode, etc
251 static int osd_find_parent_by_dnode(const struct lu_env *env,
255 struct osd_device *osd = osd_obj2dev(osd_dt_obj(o));
256 struct lustre_mdt_attrs *lma;
259 nvlist_t *nvbuf = NULL;
265 /* first of all, get parent dnode from own attributes */
266 LASSERT(osd_dt_obj(o)->oo_db);
267 rc = -sa_handle_get(osd->od_os, osd_dt_obj(o)->oo_db->db_object,
268 NULL, SA_HDL_PRIVATE, &sa_hdl);
272 dnode = ZFS_NO_OBJECT;
273 rc = -sa_lookup(sa_hdl, SA_ZPL_PARENT(osd), &dnode, 8);
274 sa_handle_destroy(sa_hdl);
278 /* now get EA buffer */
279 rc = __osd_xattr_load(osd, dnode, &nvbuf);
283 /* XXX: if we get that far.. should we cache the result? */
285 /* try to find LMA attribute */
286 LASSERT(nvbuf != NULL);
287 rc = -nvlist_lookup_byte_array(nvbuf, XATTR_NAME_LMA, &value, &size);
288 if (rc == 0 && size >= sizeof(*lma)) {
289 lma = (struct lustre_mdt_attrs *)value;
290 lustre_lma_swab(lma);
291 *fid = lma->lma_self_fid;
296 /* no LMA attribute in SA, let's try regular EA */
298 /* first of all, get parent dnode storing regular EA */
299 rc = -sa_handle_get(osd->od_os, dnode, NULL, SA_HDL_PRIVATE, &sa_hdl);
303 dnode = ZFS_NO_OBJECT;
304 rc = -sa_lookup(sa_hdl, SA_ZPL_XATTR(osd), &dnode, 8);
305 sa_handle_destroy(sa_hdl);
309 CLASSERT(sizeof(*lma) <= sizeof(osd_oti_get(env)->oti_buf));
310 buf.lb_buf = osd_oti_get(env)->oti_buf;
311 buf.lb_len = sizeof(osd_oti_get(env)->oti_buf);
313 /* now try to find LMA */
314 rc = __osd_xattr_get_large(env, osd, dnode, &buf,
315 XATTR_NAME_LMA, &size);
316 if (rc == 0 && size >= sizeof(*lma)) {
318 lustre_lma_swab(lma);
319 *fid = lma->lma_self_fid;
324 GOTO(out, rc = -EIO);
333 static int osd_find_parent_fid(const struct lu_env *env, struct dt_object *o,
336 struct link_ea_header *leh;
337 struct link_ea_entry *lee;
342 buf.lb_buf = osd_oti_get(env)->oti_buf;
343 buf.lb_len = sizeof(osd_oti_get(env)->oti_buf);
345 rc = osd_xattr_get(env, o, &buf, XATTR_NAME_LINK, BYPASS_CAPA);
347 rc = osd_xattr_get(env, o, &LU_BUF_NULL,
348 XATTR_NAME_LINK, BYPASS_CAPA);
352 OBD_ALLOC(buf.lb_buf, rc);
353 if (buf.lb_buf == NULL)
356 rc = osd_xattr_get(env, o, &buf, XATTR_NAME_LINK, BYPASS_CAPA);
360 if (rc < sizeof(*leh) + sizeof(*lee))
361 GOTO(out, rc = -EINVAL);
364 if (leh->leh_magic == __swab32(LINK_EA_MAGIC)) {
365 leh->leh_magic = LINK_EA_MAGIC;
366 leh->leh_reccount = __swab32(leh->leh_reccount);
367 leh->leh_len = __swab64(leh->leh_len);
369 if (leh->leh_magic != LINK_EA_MAGIC)
370 GOTO(out, rc = -EINVAL);
371 if (leh->leh_reccount == 0)
372 GOTO(out, rc = -ENODATA);
374 lee = (struct link_ea_entry *)(leh + 1);
375 fid_be_to_cpu(fid, (const struct lu_fid *)&lee->lee_parent_fid);
379 if (buf.lb_buf != osd_oti_get(env)->oti_buf)
380 OBD_FREE(buf.lb_buf, buf.lb_len);
383 /* this block can be enabled for additional verification
384 * it's trying to match FID from LinkEA vs. FID from LMA */
388 rc2 = osd_find_parent_by_dnode(env, o, &fid2);
390 if (lu_fid_eq(fid, &fid2) == 0)
391 CERROR("wrong parent: "DFID" != "DFID"\n",
392 PFID(fid), PFID(&fid2));
396 /* no LinkEA is found, let's try to find the fid in parent's LMA */
397 if (unlikely(rc != 0))
398 rc = osd_find_parent_by_dnode(env, o, fid);
403 static int osd_dir_lookup(const struct lu_env *env, struct dt_object *dt,
404 struct dt_rec *rec, const struct dt_key *key,
405 struct lustre_capa *capa)
407 struct osd_thread_info *oti = osd_oti_get(env);
408 struct osd_object *obj = osd_dt_obj(dt);
409 struct osd_device *osd = osd_obj2dev(obj);
410 char *name = (char *)key;
414 LASSERT(osd_object_is_zap(obj->oo_db));
416 if (name[0] == '.') {
418 const struct lu_fid *f = lu_object_fid(&dt->do_lu);
419 memcpy(rec, f, sizeof(*f));
421 } else if (name[1] == '.' && name[2] == 0) {
422 rc = osd_find_parent_fid(env, dt, (struct lu_fid *)rec);
423 RETURN(rc == 0 ? 1 : rc);
427 rc = -zap_lookup(osd->od_os, obj->oo_db->db_object,
428 (char *)key, 8, sizeof(oti->oti_zde) / 8,
429 (void *)&oti->oti_zde);
430 memcpy(rec, &oti->oti_zde.lzd_fid, sizeof(struct lu_fid));
432 RETURN(rc == 0 ? 1 : rc);
435 static int osd_declare_dir_insert(const struct lu_env *env,
436 struct dt_object *dt,
437 const struct dt_rec *rec,
438 const struct dt_key *key,
441 struct osd_object *obj = osd_dt_obj(dt);
442 struct osd_thandle *oh;
446 oh = container_of0(th, struct osd_thandle, ot_super);
449 LASSERT(osd_object_is_zap(obj->oo_db));
451 dmu_tx_hold_bonus(oh->ot_tx, obj->oo_db->db_object);
452 dmu_tx_hold_zap(oh->ot_tx, obj->oo_db->db_object, TRUE, (char *)key);
458 * Find the osd object for given fid.
460 * \param fid need to find the osd object having this fid
462 * \retval osd_object on success
463 * \retval -ve on error
465 struct osd_object *osd_object_find(const struct lu_env *env,
466 struct dt_object *dt,
467 const struct lu_fid *fid)
469 struct lu_device *ludev = dt->do_lu.lo_dev;
470 struct osd_object *child = NULL;
471 struct lu_object *luch;
472 struct lu_object *lo;
475 * at this point topdev might not exist yet
476 * (i.e. MGS is preparing profiles). so we can
477 * not rely on topdev and instead lookup with
478 * our device passed as topdev. this can't work
479 * if the object isn't cached yet (as osd doesn't
480 * allocate lu_header). IOW, the object must be
481 * in the cache, otherwise lu_object_alloc() crashes
484 luch = lu_object_find_at(env, ludev, fid, NULL);
488 if (lu_object_exists(luch)) {
489 lo = lu_object_locate(luch->lo_header, ludev->ld_type);
493 LU_OBJECT_DEBUG(D_ERROR, env, luch,
494 "%s: object can't be located "DFID"\n",
495 osd_dev(ludev)->od_svname, PFID(fid));
498 lu_object_put(env, luch);
499 CERROR("%s: Unable to get osd_object "DFID"\n",
500 osd_dev(ludev)->od_svname, PFID(fid));
501 child = ERR_PTR(-ENOENT);
504 LU_OBJECT_DEBUG(D_ERROR, env, luch,
505 "%s: lu_object does not exists "DFID"\n",
506 osd_dev(ludev)->od_svname, PFID(fid));
507 lu_object_put(env, luch);
508 child = ERR_PTR(-ENOENT);
515 * Put the osd object once done with it.
517 * \param obj osd object that needs to be put
519 static inline void osd_object_put(const struct lu_env *env,
520 struct osd_object *obj)
522 lu_object_put(env, &obj->oo_dt.do_lu);
525 static int osd_seq_exists(const struct lu_env *env, struct osd_device *osd,
528 struct lu_seq_range *range = &osd_oti_get(env)->oti_seq_range;
529 struct seq_server_site *ss = osd_seq_site(osd);
534 LASSERT(ss->ss_server_fld != NULL);
536 rc = osd_fld_lookup(env, osd, seq, range);
538 CERROR("%s: Can not lookup fld for "LPX64"\n",
543 RETURN(ss->ss_node_id == range->lsr_index);
546 static int osd_remote_fid(const struct lu_env *env, struct osd_device *osd,
547 const struct lu_fid *fid)
549 struct seq_server_site *ss = osd_seq_site(osd);
552 /* FID seqs not in FLDB, must be local seq */
553 if (unlikely(!fid_seq_in_fldb(fid_seq(fid))))
556 /* If FLD is not being initialized yet, it only happens during the
557 * initialization, likely during mgs initialization, and we assume
558 * this is local FID. */
559 if (ss == NULL || ss->ss_server_fld == NULL)
562 /* Only check the local FLDB here */
563 if (osd_seq_exists(env, osd, fid_seq(fid)))
570 * Inserts (key, value) pair in \a directory object.
572 * \param dt osd index object
573 * \param key key for index
574 * \param rec record reference
575 * \param th transaction handler
576 * \param capa capability descriptor
577 * \param ignore_quota update should not affect quota
580 * \retval -ve failure
582 static int osd_dir_insert(const struct lu_env *env, struct dt_object *dt,
583 const struct dt_rec *rec, const struct dt_key *key,
584 struct thandle *th, struct lustre_capa *capa,
587 struct osd_thread_info *oti = osd_oti_get(env);
588 struct osd_object *parent = osd_dt_obj(dt);
589 struct osd_device *osd = osd_obj2dev(parent);
590 struct dt_insert_rec *rec1 = (struct dt_insert_rec *)rec;
591 const struct lu_fid *fid = rec1->rec_fid;
592 struct osd_thandle *oh;
593 struct osd_object *child = NULL;
595 char *name = (char *)key;
599 LASSERT(parent->oo_db);
600 LASSERT(osd_object_is_zap(parent->oo_db));
602 LASSERT(dt_object_exists(dt));
603 LASSERT(osd_invariant(parent));
606 oh = container_of0(th, struct osd_thandle, ot_super);
608 rc = osd_remote_fid(env, osd, fid);
610 CERROR("%s: Can not find object "DFID": rc = %d\n",
611 osd->od_svname, PFID(fid), rc);
615 if (unlikely(rc == 1)) {
616 /* Insert remote entry */
617 memset(&oti->oti_zde.lzd_reg, 0, sizeof(oti->oti_zde.lzd_reg));
618 oti->oti_zde.lzd_reg.zde_type = IFTODT(rec1->rec_type & S_IFMT);
621 * To simulate old Orion setups with ./.. stored in the
624 /* Insert local entry */
625 child = osd_object_find(env, dt, fid);
627 RETURN(PTR_ERR(child));
629 LASSERT(child->oo_db);
630 if (name[0] == '.') {
632 /* do not store ".", instead generate it
633 * during iteration */
635 } else if (name[1] == '.' && name[2] == 0) {
636 /* update parent dnode in the child.
637 * later it will be used to generate ".." */
638 rc = osd_object_sa_update(parent,
640 &child->oo_db->db_object,
645 CLASSERT(sizeof(oti->oti_zde.lzd_reg) == 8);
646 CLASSERT(sizeof(oti->oti_zde) % 8 == 0);
647 attr = child->oo_dt.do_lu.lo_header ->loh_attr;
648 oti->oti_zde.lzd_reg.zde_type = IFTODT(attr & S_IFMT);
649 oti->oti_zde.lzd_reg.zde_dnode = child->oo_db->db_object;
652 oti->oti_zde.lzd_fid = *fid;
653 /* Insert (key,oid) into ZAP */
654 rc = -zap_add(osd->od_os, parent->oo_db->db_object,
655 (char *)key, 8, sizeof(oti->oti_zde) / 8,
656 (void *)&oti->oti_zde, oh->ot_tx);
660 osd_object_put(env, child);
665 static int osd_declare_dir_delete(const struct lu_env *env,
666 struct dt_object *dt,
667 const struct dt_key *key,
670 struct osd_object *obj = osd_dt_obj(dt);
671 struct osd_thandle *oh;
674 LASSERT(dt_object_exists(dt));
675 LASSERT(osd_invariant(obj));
678 oh = container_of0(th, struct osd_thandle, ot_super);
681 LASSERT(osd_object_is_zap(obj->oo_db));
683 dmu_tx_hold_zap(oh->ot_tx, obj->oo_db->db_object, TRUE, (char *)key);
688 static int osd_dir_delete(const struct lu_env *env, struct dt_object *dt,
689 const struct dt_key *key, struct thandle *th,
690 struct lustre_capa *capa)
692 struct osd_object *obj = osd_dt_obj(dt);
693 struct osd_device *osd = osd_obj2dev(obj);
694 struct osd_thandle *oh;
695 dmu_buf_t *zap_db = obj->oo_db;
696 char *name = (char *)key;
701 LASSERT(osd_object_is_zap(obj->oo_db));
704 oh = container_of0(th, struct osd_thandle, ot_super);
707 * In Orion . and .. were stored in the directory (not generated upon
708 * request as now). we preserve them for backward compatibility
710 if (name[0] == '.') {
713 } else if (name[1] == '.' && name[2] == 0) {
718 /* Remove key from the ZAP */
719 rc = -zap_remove(osd->od_os, zap_db->db_object,
720 (char *) key, oh->ot_tx);
722 if (unlikely(rc && rc != -ENOENT))
723 CERROR("%s: zap_remove failed: rc = %d\n", osd->od_svname, rc);
728 static struct dt_it *osd_dir_it_init(const struct lu_env *env,
729 struct dt_object *dt,
731 struct lustre_capa *capa)
733 struct osd_zap_it *it;
735 it = (struct osd_zap_it *)osd_index_it_init(env, dt, unused, capa);
739 RETURN((struct dt_it *)it);
743 * Move Iterator to record specified by \a key
745 * \param di osd iterator
746 * \param key key for index
748 * \retval +ve di points to record with least key not larger than key
749 * \retval 0 di points to exact matched key
750 * \retval -ve failure
752 static int osd_dir_it_get(const struct lu_env *env,
753 struct dt_it *di, const struct dt_key *key)
755 struct osd_zap_it *it = (struct osd_zap_it *)di;
756 struct osd_object *obj = it->ozi_obj;
757 char *name = (char *)key;
764 /* reset the cursor */
765 zap_cursor_fini(it->ozi_zc);
766 osd_obj_cursor_init_serialized(it->ozi_zc, obj, 0);
768 /* XXX: implementation of the API is broken at the moment */
769 LASSERT(((const char *)key)[0] == 0);
776 if (name[0] == '.') {
780 } else if (name[1] == '.' && name[2] == 0) {
786 /* neither . nor .. - some real record */
794 static void osd_dir_it_put(const struct lu_env *env, struct dt_it *di)
796 /* PBS: do nothing : ref are incremented at retrive and decreamented
801 * in Orion . and .. were stored in the directory, while ZPL
802 * and current osd-zfs generate them up on request. so, we
803 * need to ignore previously stored . and ..
805 static int osd_index_retrieve_skip_dots(struct osd_zap_it *it,
811 rc = -zap_cursor_retrieve(it->ozi_zc, za);
814 if (unlikely(rc == 0 && za->za_name[0] == '.')) {
815 if (za->za_name[1] == 0) {
817 } else if (za->za_name[1] == '.' &&
818 za->za_name[2] == 0) {
822 zap_cursor_advance(it->ozi_zc);
824 } while (unlikely(rc == 0 && isdot));
830 * to load a directory entry at a time and stored it in
831 * iterator's in-memory data structure.
833 * \param di, struct osd_it_ea, iterator's in memory structure
835 * \retval +ve, iterator reached to end
836 * \retval 0, iterator not reached to end
837 * \retval -ve, on error
839 static int osd_dir_it_next(const struct lu_env *env, struct dt_it *di)
841 struct osd_zap_it *it = (struct osd_zap_it *)di;
842 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
845 /* temp. storage should be enough for any key supported by ZFS */
846 CLASSERT(sizeof(za->za_name) <= sizeof(it->ozi_name));
849 * the first ->next() moves the cursor to .
850 * the second ->next() moves the cursor to ..
851 * then we get to the real records and have to verify any exist
853 if (it->ozi_pos <= 2) {
859 zap_cursor_advance(it->ozi_zc);
862 * According to current API we need to return error if its last entry.
863 * zap_cursor_advance() does not return any value. So we need to call
864 * retrieve to check if there is any record. We should make
865 * changes to Iterator API to not return status for this API
867 rc = osd_index_retrieve_skip_dots(it, za);
869 if (rc == -ENOENT) /* end of dir */
875 static struct dt_key *osd_dir_it_key(const struct lu_env *env,
876 const struct dt_it *di)
878 struct osd_zap_it *it = (struct osd_zap_it *)di;
879 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
883 if (it->ozi_pos <= 1) {
885 RETURN((struct dt_key *)".");
886 } else if (it->ozi_pos == 2) {
887 RETURN((struct dt_key *)"..");
890 if ((rc = -zap_cursor_retrieve(it->ozi_zc, za)))
893 strcpy(it->ozi_name, za->za_name);
895 RETURN((struct dt_key *)it->ozi_name);
898 static int osd_dir_it_key_size(const struct lu_env *env, const struct dt_it *di)
900 struct osd_zap_it *it = (struct osd_zap_it *)di;
901 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
905 if (it->ozi_pos <= 1) {
908 } else if (it->ozi_pos == 2) {
912 if ((rc = -zap_cursor_retrieve(it->ozi_zc, za)) == 0)
913 rc = strlen(za->za_name);
918 static int osd_dir_it_rec(const struct lu_env *env, const struct dt_it *di,
919 struct dt_rec *dtrec, __u32 attr)
921 struct osd_zap_it *it = (struct osd_zap_it *)di;
922 struct lu_dirent *lde = (struct lu_dirent *)dtrec;
923 struct luz_direntry *zde = &osd_oti_get(env)->oti_zde;
924 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
928 if (it->ozi_pos <= 1) {
929 lde->lde_hash = cpu_to_le64(1);
930 strcpy(lde->lde_name, ".");
931 lde->lde_namelen = cpu_to_le16(1);
932 lde->lde_fid = *lu_object_fid(&it->ozi_obj->oo_dt.do_lu);
933 lde->lde_attrs = LUDA_FID;
934 /* append lustre attributes */
935 osd_it_append_attrs(lde, attr, 1, IFTODT(S_IFDIR));
936 lde->lde_reclen = cpu_to_le16(lu_dirent_calc_size(1, attr));
940 } else if (it->ozi_pos == 2) {
941 lde->lde_hash = cpu_to_le64(2);
942 strcpy(lde->lde_name, "..");
943 lde->lde_namelen = cpu_to_le16(2);
944 lde->lde_attrs = LUDA_FID;
945 /* append lustre attributes */
946 osd_it_append_attrs(lde, attr, 2, IFTODT(S_IFDIR));
947 lde->lde_reclen = cpu_to_le16(lu_dirent_calc_size(2, attr));
948 rc = osd_find_parent_fid(env, &it->ozi_obj->oo_dt, &lde->lde_fid);
950 * early Orion code was not setting LinkEA, so it's possible
951 * some setups still have objects with no LinkEA set.
952 * but at that time .. was a real record in the directory
953 * so we should try to lookup .. in ZAP
961 rc = -zap_cursor_retrieve(it->ozi_zc, za);
962 if (unlikely(rc != 0))
965 lde->lde_hash = cpu_to_le64(osd_zap_cursor_serialize(it->ozi_zc));
966 namelen = strlen(za->za_name);
967 if (namelen > NAME_MAX)
968 GOTO(out, rc = -EOVERFLOW);
969 strcpy(lde->lde_name, za->za_name);
970 lde->lde_namelen = cpu_to_le16(namelen);
972 if (za->za_integer_length != 8 || za->za_num_integers < 3) {
973 CERROR("%s: unsupported direntry format: %d %d\n",
974 osd_obj2dev(it->ozi_obj)->od_svname,
975 za->za_integer_length, (int)za->za_num_integers);
977 GOTO(out, rc = -EIO);
980 rc = -zap_lookup(it->ozi_zc->zc_objset, it->ozi_zc->zc_zapobj,
981 za->za_name, za->za_integer_length, 3, zde);
985 lde->lde_fid = zde->lzd_fid;
986 lde->lde_attrs = LUDA_FID;
988 /* append lustre attributes */
989 osd_it_append_attrs(lde, attr, namelen, zde->lzd_reg.zde_type);
991 lde->lde_reclen = cpu_to_le16(lu_dirent_calc_size(namelen, attr));
997 static int osd_dir_it_rec_size(const struct lu_env *env, const struct dt_it *di,
1000 struct osd_zap_it *it = (struct osd_zap_it *)di;
1001 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1002 int rc, namelen = 0;
1005 if (it->ozi_pos <= 1)
1007 else if (it->ozi_pos == 2)
1011 rc = lu_dirent_calc_size(namelen, attr);
1015 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1016 if (unlikely(rc != 0))
1019 if (za->za_integer_length != 8 || za->za_num_integers < 3) {
1020 CERROR("%s: unsupported direntry format: %d %d\n",
1021 osd_obj2dev(it->ozi_obj)->od_svname,
1022 za->za_integer_length, (int)za->za_num_integers);
1026 namelen = strlen(za->za_name);
1027 if (namelen > NAME_MAX)
1030 rc = lu_dirent_calc_size(namelen, attr);
1035 static __u64 osd_dir_it_store(const struct lu_env *env, const struct dt_it *di)
1037 struct osd_zap_it *it = (struct osd_zap_it *)di;
1041 if (it->ozi_pos <= 2)
1044 pos = osd_zap_cursor_serialize(it->ozi_zc);
1051 * rc == 0 -> end of directory.
1052 * rc > 0 -> ok, proceed.
1053 * rc < 0 -> error. ( EOVERFLOW can be masked.)
1055 static int osd_dir_it_load(const struct lu_env *env,
1056 const struct dt_it *di, __u64 hash)
1058 struct osd_zap_it *it = (struct osd_zap_it *)di;
1059 struct osd_object *obj = it->ozi_obj;
1060 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1064 /* reset the cursor */
1065 zap_cursor_fini(it->ozi_zc);
1066 osd_obj_cursor_init_serialized(it->ozi_zc, obj, hash);
1073 /* to return whether the end has been reached */
1074 rc = osd_index_retrieve_skip_dots(it, za);
1077 else if (rc == -ENOENT)
1084 static struct dt_index_operations osd_dir_ops = {
1085 .dio_lookup = osd_dir_lookup,
1086 .dio_declare_insert = osd_declare_dir_insert,
1087 .dio_insert = osd_dir_insert,
1088 .dio_declare_delete = osd_declare_dir_delete,
1089 .dio_delete = osd_dir_delete,
1091 .init = osd_dir_it_init,
1092 .fini = osd_index_it_fini,
1093 .get = osd_dir_it_get,
1094 .put = osd_dir_it_put,
1095 .next = osd_dir_it_next,
1096 .key = osd_dir_it_key,
1097 .key_size = osd_dir_it_key_size,
1098 .rec = osd_dir_it_rec,
1099 .rec_size = osd_dir_it_rec_size,
1100 .store = osd_dir_it_store,
1101 .load = osd_dir_it_load
1106 * Primitives for index files using binary keys.
1109 /* key integer_size is 8 */
1110 static int osd_prepare_key_uint64(struct osd_object *o, __u64 *dst,
1111 const struct dt_key *src)
1118 /* align keysize to 64bit */
1119 size = (o->oo_keysize + sizeof(__u64) - 1) / sizeof(__u64);
1120 size *= sizeof(__u64);
1122 LASSERT(size <= MAXNAMELEN);
1124 if (unlikely(size > o->oo_keysize))
1125 memset(dst + o->oo_keysize, 0, size - o->oo_keysize);
1126 memcpy(dst, (const char *)src, o->oo_keysize);
1128 return (size/sizeof(__u64));
1131 static int osd_index_lookup(const struct lu_env *env, struct dt_object *dt,
1132 struct dt_rec *rec, const struct dt_key *key,
1133 struct lustre_capa *capa)
1135 struct osd_object *obj = osd_dt_obj(dt);
1136 struct osd_device *osd = osd_obj2dev(obj);
1137 __u64 *k = osd_oti_get(env)->oti_key64;
1141 rc = osd_prepare_key_uint64(obj, k, key);
1143 rc = -zap_lookup_uint64(osd->od_os, obj->oo_db->db_object,
1144 k, rc, obj->oo_recusize, obj->oo_recsize,
1146 RETURN(rc == 0 ? 1 : rc);
1149 static int osd_declare_index_insert(const struct lu_env *env,
1150 struct dt_object *dt,
1151 const struct dt_rec *rec,
1152 const struct dt_key *key,
1155 struct osd_object *obj = osd_dt_obj(dt);
1156 struct osd_thandle *oh;
1159 LASSERT(th != NULL);
1160 oh = container_of0(th, struct osd_thandle, ot_super);
1162 LASSERT(obj->oo_db);
1164 dmu_tx_hold_bonus(oh->ot_tx, obj->oo_db->db_object);
1166 /* It is not clear what API should be used for binary keys, so we pass
1167 * a null name which has the side effect of over-reserving space,
1168 * accounting for the worst case. See zap_count_write() */
1169 dmu_tx_hold_zap(oh->ot_tx, obj->oo_db->db_object, TRUE, NULL);
1174 static int osd_index_insert(const struct lu_env *env, struct dt_object *dt,
1175 const struct dt_rec *rec, const struct dt_key *key,
1176 struct thandle *th, struct lustre_capa *capa,
1179 struct osd_object *obj = osd_dt_obj(dt);
1180 struct osd_device *osd = osd_obj2dev(obj);
1181 struct osd_thandle *oh;
1182 __u64 *k = osd_oti_get(env)->oti_key64;
1186 LASSERT(obj->oo_db);
1187 LASSERT(dt_object_exists(dt));
1188 LASSERT(osd_invariant(obj));
1189 LASSERT(th != NULL);
1191 oh = container_of0(th, struct osd_thandle, ot_super);
1193 rc = osd_prepare_key_uint64(obj, k, key);
1195 /* Insert (key,oid) into ZAP */
1196 rc = -zap_add_uint64(osd->od_os, obj->oo_db->db_object,
1197 k, rc, obj->oo_recusize, obj->oo_recsize,
1198 (void *)rec, oh->ot_tx);
1202 static int osd_declare_index_delete(const struct lu_env *env,
1203 struct dt_object *dt,
1204 const struct dt_key *key,
1207 struct osd_object *obj = osd_dt_obj(dt);
1208 struct osd_thandle *oh;
1211 LASSERT(dt_object_exists(dt));
1212 LASSERT(osd_invariant(obj));
1213 LASSERT(th != NULL);
1214 LASSERT(obj->oo_db);
1216 oh = container_of0(th, struct osd_thandle, ot_super);
1217 dmu_tx_hold_zap(oh->ot_tx, obj->oo_db->db_object, TRUE, NULL);
1222 static int osd_index_delete(const struct lu_env *env, struct dt_object *dt,
1223 const struct dt_key *key, struct thandle *th,
1224 struct lustre_capa *capa)
1226 struct osd_object *obj = osd_dt_obj(dt);
1227 struct osd_device *osd = osd_obj2dev(obj);
1228 struct osd_thandle *oh;
1229 __u64 *k = osd_oti_get(env)->oti_key64;
1233 LASSERT(obj->oo_db);
1234 LASSERT(th != NULL);
1235 oh = container_of0(th, struct osd_thandle, ot_super);
1237 rc = osd_prepare_key_uint64(obj, k, key);
1239 /* Remove binary key from the ZAP */
1240 rc = -zap_remove_uint64(osd->od_os, obj->oo_db->db_object,
1245 static int osd_index_it_get(const struct lu_env *env, struct dt_it *di,
1246 const struct dt_key *key)
1248 struct osd_zap_it *it = (struct osd_zap_it *)di;
1249 struct osd_object *obj = it->ozi_obj;
1250 struct osd_device *osd = osd_obj2dev(obj);
1254 LASSERT(it->ozi_zc);
1257 * XXX: we need a binary version of zap_cursor_move_to_key()
1258 * to implement this API */
1259 if (*((const __u64 *)key) != 0)
1260 CERROR("NOT IMPLEMETED YET (move to "LPX64")\n",
1263 zap_cursor_fini(it->ozi_zc);
1264 zap_cursor_init(it->ozi_zc, osd->od_os, obj->oo_db->db_object);
1270 static int osd_index_it_next(const struct lu_env *env, struct dt_it *di)
1272 struct osd_zap_it *it = (struct osd_zap_it *)di;
1273 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1277 if (it->ozi_reset == 0)
1278 zap_cursor_advance(it->ozi_zc);
1282 * According to current API we need to return error if it's last entry.
1283 * zap_cursor_advance() does not return any value. So we need to call
1284 * retrieve to check if there is any record. We should make
1285 * changes to Iterator API to not return status for this API
1287 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1294 static struct dt_key *osd_index_it_key(const struct lu_env *env,
1295 const struct dt_it *di)
1297 struct osd_zap_it *it = (struct osd_zap_it *)di;
1298 struct osd_object *obj = it->ozi_obj;
1299 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1304 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1306 RETURN(ERR_PTR(rc));
1308 /* the binary key is stored in the name */
1309 memcpy(&it->ozi_key, za->za_name, obj->oo_keysize);
1311 RETURN((struct dt_key *)&it->ozi_key);
1314 static int osd_index_it_key_size(const struct lu_env *env,
1315 const struct dt_it *di)
1317 struct osd_zap_it *it = (struct osd_zap_it *)di;
1318 struct osd_object *obj = it->ozi_obj;
1319 RETURN(obj->oo_keysize);
1322 static int osd_index_it_rec(const struct lu_env *env, const struct dt_it *di,
1323 struct dt_rec *rec, __u32 attr)
1325 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1326 struct osd_zap_it *it = (struct osd_zap_it *)di;
1327 struct osd_object *obj = it->ozi_obj;
1328 struct osd_device *osd = osd_obj2dev(obj);
1329 __u64 *k = osd_oti_get(env)->oti_key64;
1334 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1338 rc = osd_prepare_key_uint64(obj, k, (const struct dt_key *)za->za_name);
1340 rc = -zap_lookup_uint64(osd->od_os, obj->oo_db->db_object,
1341 k, rc, obj->oo_recusize, obj->oo_recsize,
1346 static __u64 osd_index_it_store(const struct lu_env *env,
1347 const struct dt_it *di)
1349 struct osd_zap_it *it = (struct osd_zap_it *)di;
1352 RETURN((__u64)zap_cursor_serialize(it->ozi_zc));
1355 static int osd_index_it_load(const struct lu_env *env, const struct dt_it *di,
1358 struct osd_zap_it *it = (struct osd_zap_it *)di;
1359 struct osd_object *obj = it->ozi_obj;
1360 struct osd_device *osd = osd_obj2dev(obj);
1361 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1365 /* reset the cursor */
1366 zap_cursor_fini(it->ozi_zc);
1367 zap_cursor_init_serialized(it->ozi_zc, osd->od_os,
1368 obj->oo_db->db_object, hash);
1371 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1374 else if (rc == -ENOENT)
1380 static struct dt_index_operations osd_index_ops = {
1381 .dio_lookup = osd_index_lookup,
1382 .dio_declare_insert = osd_declare_index_insert,
1383 .dio_insert = osd_index_insert,
1384 .dio_declare_delete = osd_declare_index_delete,
1385 .dio_delete = osd_index_delete,
1387 .init = osd_index_it_init,
1388 .fini = osd_index_it_fini,
1389 .get = osd_index_it_get,
1390 .put = osd_index_it_put,
1391 .next = osd_index_it_next,
1392 .key = osd_index_it_key,
1393 .key_size = osd_index_it_key_size,
1394 .rec = osd_index_it_rec,
1395 .store = osd_index_it_store,
1396 .load = osd_index_it_load
1400 struct osd_metadnode_it {
1401 struct osd_device *mit_dev;
1403 struct lu_fid mit_fid;
1405 __u64 mit_prefetched_dnode;
1408 static struct dt_it *osd_zfs_otable_it_init(const struct lu_env *env,
1409 struct dt_object *dt, __u32 attr,
1410 struct lustre_capa *capa)
1412 struct osd_device *dev = osd_dev(dt->do_lu.lo_dev);
1413 struct osd_metadnode_it *it;
1417 if (unlikely(it == NULL))
1418 RETURN(ERR_PTR(-ENOMEM));
1422 /* XXX: dmu_object_next() does NOT find dnodes allocated
1423 * in the current non-committed txg, so we force txg
1424 * commit to find all existing dnodes ... */
1425 txg_wait_synced(dmu_objset_pool(dev->od_os), 0ULL);
1427 RETURN((struct dt_it *)it);
1430 static void osd_zfs_otable_it_fini(const struct lu_env *env, struct dt_it *di)
1432 struct osd_metadnode_it *it = (struct osd_metadnode_it *)di;
1437 static int osd_zfs_otable_it_get(const struct lu_env *env,
1438 struct dt_it *di, const struct dt_key *key)
1443 static void osd_zfs_otable_it_put(const struct lu_env *env, struct dt_it *di)
1447 #define OTABLE_PREFETCH 256
1449 static void osd_zfs_otable_prefetch(const struct lu_env *env,
1450 struct osd_metadnode_it *it)
1452 struct osd_device *dev = it->mit_dev;
1455 /* can go negative on the very first access to the iterator
1456 * or if some non-Lustre objects were found */
1457 if (unlikely(it->mit_prefetched < 0))
1458 it->mit_prefetched = 0;
1460 if (it->mit_prefetched >= (OTABLE_PREFETCH >> 1))
1463 if (it->mit_prefetched_dnode == 0)
1464 it->mit_prefetched_dnode = it->mit_pos;
1466 while (it->mit_prefetched < OTABLE_PREFETCH) {
1467 rc = -dmu_object_next(dev->od_os, &it->mit_prefetched_dnode,
1469 if (unlikely(rc != 0))
1472 /* dmu_prefetch() was exported in 0.6.2, if you use with
1473 * an older release, just comment it out - this is an
1475 dmu_prefetch(dev->od_os, it->mit_prefetched_dnode, 0, 0);
1477 it->mit_prefetched++;
1481 static int osd_zfs_otable_it_next(const struct lu_env *env, struct dt_it *di)
1483 struct osd_metadnode_it *it = (struct osd_metadnode_it *)di;
1484 struct lustre_mdt_attrs *lma;
1485 struct osd_device *dev = it->mit_dev;
1486 nvlist_t *nvbuf = NULL;
1491 memset(&it->mit_fid, 0, sizeof(it->mit_fid));
1493 dnode = it->mit_pos;
1495 rc = -dmu_object_next(dev->od_os, &it->mit_pos, B_FALSE, 0);
1496 if (unlikely(rc != 0))
1498 it->mit_prefetched--;
1500 /* LMA is required for this to be a Lustre object.
1501 * If there is no xattr skip it. */
1502 rc = __osd_xattr_load(dev, it->mit_pos, &nvbuf);
1503 if (unlikely(rc != 0))
1506 LASSERT(nvbuf != NULL);
1507 rc = -nvlist_lookup_byte_array(nvbuf, XATTR_NAME_LMA, &v, &s);
1508 if (likely(rc == 0)) {
1510 lma = (struct lustre_mdt_attrs *)v;
1511 lustre_lma_swab(lma);
1512 it->mit_fid = lma->lma_self_fid;
1516 /* not a Lustre object, try next one */
1523 /* we aren't prefetching in the above loop because the number of
1524 * non-Lustre objects is very small and we will be repeating very
1525 * rare. in case we want to use this to iterate over non-Lustre
1526 * objects (i.e. when we convert regular ZFS in Lustre) it makes
1527 * sense to initiate prefetching in the loop */
1529 /* 0 - there are more items, +1 - the end */
1530 if (likely(rc == 0))
1531 osd_zfs_otable_prefetch(env, it);
1533 CDEBUG(D_OTHER, "advance: %llu -> %llu "DFID": %d\n", dnode,
1534 it->mit_pos, PFID(&it->mit_fid), rc);
1540 static struct dt_key *osd_zfs_otable_it_key(const struct lu_env *env,
1541 const struct dt_it *di)
1546 static int osd_zfs_otable_it_key_size(const struct lu_env *env,
1547 const struct dt_it *di)
1549 return sizeof(__u64);
1552 static int osd_zfs_otable_it_rec(const struct lu_env *env,
1553 const struct dt_it *di,
1554 struct dt_rec *rec, __u32 attr)
1556 struct osd_metadnode_it *it = (struct osd_metadnode_it *)di;
1557 struct lu_fid *fid = (struct lu_fid *)rec;
1566 static __u64 osd_zfs_otable_it_store(const struct lu_env *env,
1567 const struct dt_it *di)
1569 struct osd_metadnode_it *it = (struct osd_metadnode_it *)di;
1574 static int osd_zfs_otable_it_load(const struct lu_env *env,
1575 const struct dt_it *di, __u64 hash)
1577 struct osd_metadnode_it *it = (struct osd_metadnode_it *)di;
1580 it->mit_prefetched = 0;
1581 it->mit_prefetched_dnode = 0;
1583 return osd_zfs_otable_it_next(env, (struct dt_it *)di);
1586 static int osd_zfs_otable_it_key_rec(const struct lu_env *env,
1587 const struct dt_it *di, void *key_rec)
1592 const struct dt_index_operations osd_zfs_otable_ops = {
1594 .init = osd_zfs_otable_it_init,
1595 .fini = osd_zfs_otable_it_fini,
1596 .get = osd_zfs_otable_it_get,
1597 .put = osd_zfs_otable_it_put,
1598 .next = osd_zfs_otable_it_next,
1599 .key = osd_zfs_otable_it_key,
1600 .key_size = osd_zfs_otable_it_key_size,
1601 .rec = osd_zfs_otable_it_rec,
1602 .store = osd_zfs_otable_it_store,
1603 .load = osd_zfs_otable_it_load,
1604 .key_rec = osd_zfs_otable_it_key_rec,
1608 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
1609 const struct dt_index_features *feat)
1611 struct osd_object *obj = osd_dt_obj(dt);
1614 LASSERT(dt_object_exists(dt));
1617 * XXX: implement support for fixed-size keys sorted with natural
1618 * numerical way (not using internal hash value)
1620 if (feat->dif_flags & DT_IND_RANGE)
1623 if (unlikely(feat == &dt_otable_features)) {
1624 dt->do_index_ops = &osd_zfs_otable_ops;
1628 LASSERT(obj->oo_db != NULL);
1629 if (likely(feat == &dt_directory_features)) {
1630 if (osd_object_is_zap(obj->oo_db))
1631 dt->do_index_ops = &osd_dir_ops;
1634 } else if (unlikely(feat == &dt_acct_features)) {
1635 LASSERT(fid_is_acct(lu_object_fid(&dt->do_lu)));
1636 dt->do_index_ops = &osd_acct_index_ops;
1637 } else if (osd_object_is_zap(obj->oo_db) &&
1638 dt->do_index_ops == NULL) {
1639 /* For index file, we don't support variable key & record sizes
1640 * and the key has to be unique */
1641 if ((feat->dif_flags & ~DT_IND_UPDATE) != 0)
1644 if (feat->dif_keysize_max > ZAP_MAXNAMELEN)
1646 if (feat->dif_keysize_max != feat->dif_keysize_min)
1649 /* As for the record size, it should be a multiple of 8 bytes
1650 * and smaller than the maximum value length supported by ZAP.
1652 if (feat->dif_recsize_max > ZAP_MAXVALUELEN)
1654 if (feat->dif_recsize_max != feat->dif_recsize_min)
1657 obj->oo_keysize = feat->dif_keysize_max;
1658 obj->oo_recsize = feat->dif_recsize_max;
1659 obj->oo_recusize = 1;
1661 /* ZFS prefers to work with array of 64bits */
1662 if ((obj->oo_recsize & 7) == 0) {
1663 obj->oo_recsize >>= 3;
1664 obj->oo_recusize = 8;
1666 dt->do_index_ops = &osd_index_ops;