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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * lustre/osd-zfs/osd_index.c
33 * Author: Alex Zhuravlev <bzzz@whamcloud.com>
34 * Author: Mike Pershin <tappro@whamcloud.com>
37 #define DEBUG_SUBSYSTEM S_OSD
39 #include <libcfs/libcfs.h>
40 #include <obd_support.h>
41 #include <lustre_net.h>
43 #include <obd_class.h>
44 #include <lustre_disk.h>
45 #include <lustre_fid.h>
47 #include "osd_internal.h"
49 #include <sys/dnode.h>
53 #include <sys/spa_impl.h>
54 #include <sys/zfs_znode.h>
55 #include <sys/dmu_tx.h>
56 #include <sys/dmu_objset.h>
57 #include <sys/dsl_prop.h>
58 #include <sys/sa_impl.h>
60 #include <lustre_scrub.h>
62 /* We don't actually have direct access to the zap_hashbits() function
63 * so just pretend like we do for now. If this ever breaks we can look at
65 #define zap_hashbits(zc) 48
68 * | cd (16 bits) | hash (48 bits) |
69 * we need it in other form:
70 * |0| hash (48 bit) | cd (15 bit) |
71 * to be a full 64-bit ordered hash so that Lustre readdir can use it to merge
72 * the readdir hashes from multiple directory stripes uniformly on the client.
73 * Another point is sign bit, the hash range should be in [0, 2^63-1] because
74 * loff_t (for llseek) needs to be a positive value. This means the "cd" field
75 * should only be the low 15 bits.
77 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc)
79 uint64_t zfs_hash = zap_cursor_serialize(zc) & (~0ULL >> 1);
81 return (zfs_hash >> zap_hashbits(zc)) |
82 (zfs_hash << (63 - zap_hashbits(zc)));
85 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
86 uint64_t id, uint64_t dirhash)
88 uint64_t zfs_hash = ((dirhash << zap_hashbits(zc)) & (~0ULL >> 1)) |
89 (dirhash >> (63 - zap_hashbits(zc)));
91 zap_cursor_init_serialized(zc, os, id, zfs_hash);
94 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
95 uint64_t id, uint64_t dirhash)
100 if (unlikely(t == NULL))
103 osd_zap_cursor_init_serialized(t, os, id, dirhash);
109 void osd_zap_cursor_fini(zap_cursor_t *zc)
115 static inline void osd_obj_cursor_init_serialized(zap_cursor_t *zc,
116 struct osd_object *o,
119 struct osd_device *d = osd_obj2dev(o);
120 osd_zap_cursor_init_serialized(zc, d->od_os,
121 o->oo_dn->dn_object, dirhash);
124 static inline int osd_obj_cursor_init(zap_cursor_t **zc, struct osd_object *o,
127 struct osd_device *d = osd_obj2dev(o);
128 return osd_zap_cursor_init(zc, d->od_os, o->oo_dn->dn_object, dirhash);
131 static struct dt_it *osd_index_it_init(const struct lu_env *env,
132 struct dt_object *dt,
135 struct osd_thread_info *info = osd_oti_get(env);
136 struct osd_zap_it *it;
137 struct osd_object *obj = osd_dt_obj(dt);
138 struct lu_object *lo = &dt->do_lu;
142 if (obj->oo_destroyed)
143 RETURN(ERR_PTR(-ENOENT));
145 LASSERT(lu_object_exists(lo));
149 OBD_SLAB_ALLOC_PTR_GFP(it, osd_zapit_cachep, GFP_NOFS);
151 RETURN(ERR_PTR(-ENOMEM));
153 rc = osd_obj_cursor_init(&it->ozi_zc, obj, 0);
155 OBD_SLAB_FREE_PTR(it, osd_zapit_cachep);
163 RETURN((struct dt_it *)it);
166 static void osd_index_it_fini(const struct lu_env *env, struct dt_it *di)
168 struct osd_zap_it *it = (struct osd_zap_it *)di;
169 struct osd_object *obj;
173 LASSERT(it->ozi_obj);
177 osd_zap_cursor_fini(it->ozi_zc);
178 osd_object_put(env, obj);
179 OBD_SLAB_FREE_PTR(it, osd_zapit_cachep);
185 static void osd_index_it_put(const struct lu_env *env, struct dt_it *di)
187 /* PBS: do nothing : ref are incremented at retrive and decreamented
191 static inline void osd_it_append_attrs(struct lu_dirent *ent, __u32 attr,
194 const unsigned align = sizeof(struct luda_type) - 1;
195 struct luda_type *lt;
197 /* check if file type is required */
198 if (attr & LUDA_TYPE) {
199 len = (len + align) & ~align;
201 lt = (void *)ent->lde_name + len;
202 lt->lt_type = cpu_to_le16(DTTOIF(type));
203 ent->lde_attrs |= LUDA_TYPE;
206 ent->lde_attrs = cpu_to_le32(ent->lde_attrs);
209 int __osd_xattr_load_by_oid(struct osd_device *osd, uint64_t oid, nvlist_t **sa)
215 rc = -dmu_bonus_hold(osd->od_os, oid, osd_obj_tag, &db);
217 CERROR("%s: can't get bonus, rc = %d\n", osd->od_svname, rc);
221 rc = -sa_handle_get_from_db(osd->od_os, db, NULL, SA_HDL_PRIVATE, &hdl);
223 dmu_buf_rele(db, osd_obj_tag);
227 rc = __osd_xattr_load(osd, hdl, sa);
229 sa_handle_destroy(hdl);
234 * Get the object's FID from its LMA EA.
236 * \param[in] env pointer to the thread context
237 * \param[in] osd pointer to the OSD device
238 * \param[in] oid the object's local identifier
239 * \param[out] fid the buffer to hold the object's FID
241 * \retval 0 for success
242 * \retval negative error number on failure
244 int osd_get_fid_by_oid(const struct lu_env *env, struct osd_device *osd,
245 uint64_t oid, struct lu_fid *fid)
247 struct objset *os = osd->od_os;
248 struct osd_thread_info *oti = osd_oti_get(env);
249 struct lustre_mdt_attrs *lma =
250 (struct lustre_mdt_attrs *)oti->oti_buf;
252 nvlist_t *sa_xattr = NULL;
253 sa_handle_t *sa_hdl = NULL;
254 uchar_t *nv_value = NULL;
255 uint64_t xattr = ZFS_NO_OBJECT;
260 rc = __osd_xattr_load_by_oid(osd, oid, &sa_xattr);
267 rc = -nvlist_lookup_byte_array(sa_xattr, XATTR_NAME_LMA, &nv_value,
275 if (unlikely(size > sizeof(oti->oti_buf)))
276 GOTO(out, rc = -ERANGE);
278 memcpy(lma, nv_value, size);
283 rc = -sa_handle_get(os, oid, NULL, SA_HDL_PRIVATE, &sa_hdl);
287 rc = -sa_lookup(sa_hdl, SA_ZPL_XATTR(osd), &xattr, 8);
288 sa_handle_destroy(sa_hdl);
293 buf.lb_len = sizeof(oti->oti_buf);
294 rc = __osd_xattr_get_large(env, osd, xattr, &buf,
295 XATTR_NAME_LMA, &size);
300 if (size < sizeof(*lma))
301 GOTO(out, rc = -EIO);
303 lustre_lma_swab(lma);
304 if (unlikely((lma->lma_incompat & ~LMA_INCOMPAT_SUPP) ||
305 CFS_FAIL_CHECK(OBD_FAIL_OSD_LMA_INCOMPAT))) {
306 CWARN("%s: unsupported incompat LMA feature(s) %#x for "
307 "oid = %#llx\n", osd->od_svname,
308 lma->lma_incompat & ~LMA_INCOMPAT_SUPP, oid);
309 GOTO(out, rc = -EOPNOTSUPP);
311 *fid = lma->lma_self_fid;
316 if (sa_xattr != NULL)
317 nvlist_free(sa_xattr);
322 * As we don't know FID, we can't use LU object, so this function
323 * partially duplicate osd_xattr_get_internal() which is built around
324 * LU-object and uses it to cache data like regular EA dnode, etc
326 static int osd_find_parent_by_dnode(const struct lu_env *env,
328 struct lu_fid *fid, uint64_t *oid)
330 struct osd_object *obj = osd_dt_obj(o);
331 struct osd_device *osd = osd_obj2dev(obj);
332 uint64_t dnode = ZFS_NO_OBJECT;
336 /* first of all, get parent dnode from own attributes */
337 rc = osd_sa_handle_get(obj);
340 rc = -sa_lookup(obj->oo_sa_hdl, SA_ZPL_PARENT(osd), &dnode, 8);
344 rc = osd_get_fid_by_oid(env, osd, dnode, fid);
350 static int osd_find_parent_fid(const struct lu_env *env, struct dt_object *o,
351 struct lu_fid *fid, uint64_t *oid)
353 struct link_ea_header *leh;
354 struct link_ea_entry *lee;
359 buf.lb_buf = osd_oti_get(env)->oti_buf;
360 buf.lb_len = sizeof(osd_oti_get(env)->oti_buf);
362 rc = osd_xattr_get(env, o, &buf, XATTR_NAME_LINK);
364 rc = osd_xattr_get(env, o, &LU_BUF_NULL, XATTR_NAME_LINK);
368 OBD_ALLOC(buf.lb_buf, rc);
369 if (buf.lb_buf == NULL)
372 rc = osd_xattr_get(env, o, &buf, XATTR_NAME_LINK);
376 if (rc < sizeof(*leh) + sizeof(*lee))
377 GOTO(out, rc = -EINVAL);
380 if (leh->leh_magic == __swab32(LINK_EA_MAGIC)) {
381 leh->leh_magic = LINK_EA_MAGIC;
382 leh->leh_reccount = __swab32(leh->leh_reccount);
383 leh->leh_len = __swab64(leh->leh_len);
385 if (leh->leh_magic != LINK_EA_MAGIC)
386 GOTO(out, rc = -EINVAL);
387 if (leh->leh_reccount == 0)
388 GOTO(out, rc = -ENODATA);
390 lee = (struct link_ea_entry *)(leh + 1);
391 fid_be_to_cpu(fid, (const struct lu_fid *)&lee->lee_parent_fid);
395 if (buf.lb_buf != osd_oti_get(env)->oti_buf)
396 OBD_FREE(buf.lb_buf, buf.lb_len);
399 /* this block can be enabled for additional verification
400 * it's trying to match FID from LinkEA vs. FID from LMA */
404 rc2 = osd_find_parent_by_dnode(env, o, &fid2, oid);
406 if (lu_fid_eq(fid, &fid2) == 0)
407 CERROR("wrong parent: "DFID" != "DFID"\n",
408 PFID(fid), PFID(&fid2));
412 /* no LinkEA is found, let's try to find the fid in parent's LMA */
413 if (unlikely(rc != 0))
414 rc = osd_find_parent_by_dnode(env, o, fid, oid);
420 * When lookup item under striped directory, we need to locate the master
421 * MDT-object of the striped directory firstly, then the client will send
422 * lookup (getattr_by_name) RPC to the MDT with some slave MDT-object's FID
423 * and the item's name. If the system is restored from MDT file level backup,
424 * then before the OI scrub completely built the OI files, the OI mappings of
425 * the master MDT-object and slave MDT-object may be invalid. Usually, it is
426 * not a problem for the master MDT-object. Because when locate the master
427 * MDT-object, we will do name based lookup (for the striped directory itself)
428 * firstly, during such process we can setup the correct OI mapping for the
429 * master MDT-object. But it will be trouble for the slave MDT-object. Because
430 * the client will not trigger name based lookup on the MDT to locate the slave
431 * MDT-object before locating item under the striped directory, then when
432 * osd_fid_lookup(), it will find that the OI mapping for the slave MDT-object
433 * is invalid and does not know what the right OI mapping is, then the MDT has
434 * to return -EINPROGRESS to the client to notify that the OI scrub is rebuiding
435 * the OI file, related OI mapping is unknown yet, please try again later. And
436 * then client will re-try the RPC again and again until related OI mapping has
437 * been updated. That is quite inefficient.
439 * To resolve above trouble, we will handle it as the following two cases:
441 * 1) The slave MDT-object and the master MDT-object are on different MDTs.
442 * It is relative easy. Be as one of remote MDT-objects, the slave MDT-object
443 * is linked under /REMOTE_PARENT_DIR with the name of its FID string.
444 * We can locate the slave MDT-object via lookup the /REMOTE_PARENT_DIR
445 * directly. Please check osd_fid_lookup().
447 * 2) The slave MDT-object and the master MDT-object reside on the same MDT.
448 * Under such case, during lookup the master MDT-object, we will lookup the
449 * slave MDT-object via readdir against the master MDT-object, because the
450 * slave MDT-objects information are stored as sub-directories with the name
451 * "${FID}:${index}". Then when find the local slave MDT-object, its OI
452 * mapping will be recorded. Then subsequent osd_fid_lookup() will know
453 * the correct OI mapping for the slave MDT-object.
455 static int osd_check_lmv(const struct lu_env *env, struct osd_device *osd,
456 uint64_t oid, const struct lu_fid *fid)
458 struct osd_thread_info *info = osd_oti_get(env);
459 struct luz_direntry *zde = &info->oti_zde;
460 zap_attribute_t *za = &info->oti_za;
461 zap_cursor_t *zc = &info->oti_zc;
462 struct lu_fid *tfid = &info->oti_fid;
463 nvlist_t *nvbuf = NULL;
464 struct lmv_mds_md_v1 *lmv = NULL;
469 rc = __osd_xattr_load_by_oid(osd, oid, &nvbuf);
470 if (rc == -ENOENT || rc == -EEXIST || rc == -ENODATA)
476 rc = -nvlist_lookup_byte_array(nvbuf, XATTR_NAME_LMV,
477 (uchar_t **)&lmv, &size);
478 if (rc == -ENOENT || rc == -EEXIST || rc == -ENODATA)
479 GOTO(out_nvbuf, rc = 0);
484 if (le32_to_cpu(lmv->lmv_magic) != LMV_MAGIC_V1)
485 GOTO(out_nvbuf, rc = -EINVAL);
487 zap_cursor_init_serialized(zc, osd->od_os, oid, 0);
488 rc = -zap_cursor_retrieve(zc, za);
490 zap_cursor_advance(zc);
492 CERROR("%s: fail to init for check LMV "DFID"(%llu): rc = %d\n",
493 osd_name(osd), PFID(fid), oid, rc);
498 rc = -zap_cursor_retrieve(zc, za);
500 GOTO(out_zc, rc = 0);
503 CERROR("%s: fail to locate next for check LMV "
504 DFID"(%llu): rc = %d\n",
505 osd_name(osd), PFID(fid), oid, rc);
510 sscanf(za->za_name + 1, SFID, RFID(tfid));
511 if (fid_is_sane(tfid) && !osd_remote_fid(env, osd, tfid)) {
512 rc = osd_zap_lookup(osd, oid, NULL, za->za_name,
513 za->za_integer_length,
514 sizeof(*zde) / za->za_integer_length,
517 CERROR("%s: fail to lookup for check LMV "
518 DFID"(%llu): rc = %d\n",
519 osd_name(osd), PFID(fid), oid, rc);
523 rc = osd_oii_insert(env, osd, tfid,
524 zde->lzd_reg.zde_dnode, false);
528 zap_cursor_advance(zc);
540 osd_zfs_consistency_check(const struct lu_env *env, struct osd_device *osd,
541 struct osd_object *obj, const struct lu_fid *fid,
542 u64 oid, bool is_dir)
544 struct lustre_scrub *scrub = &osd->od_scrub;
552 /* oid == ZFS_NO_OBJECT must be for lookup ".." case */
553 if (oid == ZFS_NO_OBJECT) {
554 rc = osd_sa_handle_get(obj);
558 rc = -sa_lookup(obj->oo_sa_hdl, SA_ZPL_PARENT(osd), &oid, 8);
563 if (!scrub_needs_check(&osd->od_scrub, fid, oid))
566 rc = osd_fid_lookup(env, osd, fid, &oid2);
572 rc = __osd_obj2dnode(osd->od_os, oid, &dn);
573 /* The object has been removed (by race maybe). */
578 } else if (rc || oid == oid2) {
585 if (scrub->os_running) {
587 rc = __osd_obj2dnode(osd->od_os, oid, &dn);
588 /* The object has been removed (by race maybe). */
593 rc = osd_oii_insert(env, osd, fid, oid, insert);
594 /* There is race condition between osd_oi_lookup and OI scrub.
595 * The OI scrub finished just after osd_oi_lookup() failure.
596 * Under such case, it is unnecessary to trigger OI scrub again,
597 * but try to call osd_oi_lookup() again. */
598 if (unlikely(rc == -EAGAIN))
602 rc = osd_check_lmv(env, osd, oid, fid);
609 if (osd->od_scrub.os_auto_scrub_interval != AS_NEVER && ++once == 1) {
610 rc = osd_scrub_start(env, osd, SS_AUTO_FULL |
611 SS_CLEAR_DRYRUN | SS_CLEAR_FAILOUT);
612 CDEBUG_LIMIT(D_LFSCK | D_CONSOLE | D_WARNING,
613 "%s: trigger partial OI scrub for RPC inconsistency, checking FID "DFID"/%#llx): rc = %d\n",
614 osd_name(osd), PFID(fid), oid, rc);
626 static int osd_dir_lookup(const struct lu_env *env, struct dt_object *dt,
627 struct dt_rec *rec, const struct dt_key *key)
629 struct osd_thread_info *oti = osd_oti_get(env);
630 struct osd_object *obj = osd_dt_obj(dt);
631 struct osd_device *osd = osd_obj2dev(obj);
632 struct lu_fid *fid = (struct lu_fid *)rec;
633 char *name = (char *)key;
634 uint64_t oid = ZFS_NO_OBJECT;
638 if (name[0] == '.') {
640 const struct lu_fid *f = lu_object_fid(&dt->do_lu);
641 memcpy(rec, f, sizeof(*f));
643 } else if (name[1] == '.' && name[2] == 0) {
644 rc = osd_find_parent_fid(env, dt, fid, &oid);
649 memset(&oti->oti_zde.lzd_fid, 0, sizeof(struct lu_fid));
651 down_read(&obj->oo_guard);
652 if (obj->oo_destroyed)
653 GOTO(out_unlock, rc = -ENOENT);
655 rc = osd_zap_lookup(osd, obj->oo_dn->dn_object, obj->oo_dn,
656 (char *)key, 8, sizeof(oti->oti_zde) / 8,
657 (void *)&oti->oti_zde);
659 up_read(&obj->oo_guard);
663 oid = oti->oti_zde.lzd_reg.zde_dnode;
664 if (likely(fid_is_sane(&oti->oti_zde.lzd_fid))) {
665 memcpy(rec, &oti->oti_zde.lzd_fid, sizeof(struct lu_fid));
666 GOTO(out_unlock, rc = 0);
669 rc = osd_get_fid_by_oid(env, osd, oti->oti_zde.lzd_reg.zde_dnode, fid);
672 up_read(&obj->oo_guard);
674 if (!rc && !osd_remote_fid(env, osd, fid)) {
675 bool is_dir = S_ISDIR(DTTOIF(oti->oti_zde.lzd_reg.zde_type));
678 * this should ask the scrubber to check OI given
679 * the mapping we just found in the dir entry.
680 * but result of that check should not affect
681 * result of the lookup in the directory.
682 * otherwise such a direntry becomes hidden
683 * from the layers above, including LFSCK which
684 * is supposed to fix dangling entries.
686 osd_zfs_consistency_check(env, osd, obj, fid, oid, is_dir);
689 return rc == 0 ? 1 : (rc == -ENOENT ? -ENODATA : rc);
693 * In DNE environment, the object and its name entry may reside on different
694 * MDTs. Under such case, we will create an agent object on the MDT where the
695 * name entry resides. The agent object is empty, and indicates that the real
696 * object for the name entry resides on another MDT. If without agent object,
697 * related name entry will be skipped when perform MDT side file level backup
698 * and restore via ZPL by userspace tool, such as 'tar'.
700 static int osd_create_agent_object(const struct lu_env *env,
701 struct osd_device *osd,
702 struct luz_direntry *zde,
703 uint64_t parent, dmu_tx_t *tx)
705 struct osd_thread_info *info = osd_oti_get(env);
706 struct lustre_mdt_attrs *lma = &info->oti_mdt_attrs;
707 struct lu_attr *la = &info->oti_la;
708 nvlist_t *nvbuf = NULL;
714 if (CFS_FAIL_CHECK(OBD_FAIL_LFSCK_NO_AGENTOBJ))
717 rc = -nvlist_alloc(&nvbuf, NV_UNIQUE_NAME, KM_SLEEP);
721 lustre_lma_init(lma, &zde->lzd_fid, 0, LMAI_AGENT);
722 lustre_lma_swab(lma);
723 rc = -nvlist_add_byte_array(nvbuf, XATTR_NAME_LMA, (uchar_t *)lma,
728 la->la_valid = LA_TYPE | LA_MODE;
729 la->la_mode = (DTTOIF(zde->lzd_reg.zde_type) & S_IFMT) |
730 S_IRUGO | S_IWUSR | S_IXUGO;
732 if (S_ISDIR(la->la_mode))
733 rc = __osd_zap_create(env, osd, &dn, tx, la,
734 osd_find_dnsize(osd, OSD_BASE_EA_IN_BONUS), 0);
736 rc = __osd_object_create(env, osd, NULL, &zde->lzd_fid,
741 zde->lzd_reg.zde_dnode = dn->dn_object;
742 rc = -sa_handle_get(osd->od_os, dn->dn_object, NULL,
743 SA_HDL_PRIVATE, &hdl);
745 rc = __osd_attr_init(env, osd, NULL, hdl, tx,
747 sa_handle_destroy(hdl);
755 dmu_object_free(osd->od_os, dn->dn_object, tx);
765 int osd_add_to_remote_parent(const struct lu_env *env,
766 struct osd_device *osd,
767 struct osd_object *obj,
768 struct osd_thandle *oh)
770 struct osd_thread_info *info = osd_oti_get(env);
771 struct luz_direntry *zde = &info->oti_zde;
772 char *name = info->oti_str;
773 const struct lu_fid *fid = lu_object_fid(&obj->oo_dt.do_lu);
774 struct lustre_mdt_attrs *lma = (struct lustre_mdt_attrs *)info->oti_buf;
775 struct lu_buf buf = {
777 .lb_len = sizeof(info->oti_buf),
783 if (CFS_FAIL_CHECK(OBD_FAIL_LFSCK_NO_AGENTENT))
786 rc = osd_xattr_get_internal(env, obj, &buf, XATTR_NAME_LMA, &size);
788 CWARN("%s: fail to load LMA for adding "
789 DFID" to remote parent: rc = %d\n",
790 osd_name(osd), PFID(fid), rc);
794 lustre_lma_swab(lma);
795 lma->lma_incompat |= LMAI_REMOTE_PARENT;
796 lustre_lma_swab(lma);
798 rc = osd_xattr_set_internal(env, obj, &buf, XATTR_NAME_LMA,
799 LU_XATTR_REPLACE, oh);
801 CWARN("%s: fail to update LMA for adding "
802 DFID" to remote parent: rc = %d\n",
803 osd_name(osd), PFID(fid), rc);
807 osd_fid2str(name, fid, sizeof(info->oti_str));
808 zde->lzd_reg.zde_dnode = obj->oo_dn->dn_object;
809 zde->lzd_reg.zde_type = S_DT(S_IFDIR);
812 rc = osd_zap_add(osd, osd->od_remote_parent_dir, NULL,
813 name, 8, sizeof(*zde) / 8, zde, oh->ot_tx);
814 if (unlikely(rc == -EEXIST))
817 CWARN("%s: fail to add name entry for "
818 DFID" to remote parent: rc = %d\n",
819 osd_name(osd), PFID(fid), rc);
821 lu_object_set_agent_entry(&obj->oo_dt.do_lu);
826 int osd_delete_from_remote_parent(const struct lu_env *env,
827 struct osd_device *osd,
828 struct osd_object *obj,
829 struct osd_thandle *oh, bool destroy)
831 struct osd_thread_info *info = osd_oti_get(env);
832 char *name = info->oti_str;
833 const struct lu_fid *fid = lu_object_fid(&obj->oo_dt.do_lu);
834 struct lustre_mdt_attrs *lma = (struct lustre_mdt_attrs *)info->oti_buf;
835 struct lu_buf buf = {
837 .lb_len = sizeof(info->oti_buf),
843 osd_fid2str(name, fid, sizeof(info->oti_str));
844 rc = osd_zap_remove(osd, osd->od_remote_parent_dir, NULL,
846 if (unlikely(rc == -ENOENT))
849 CERROR("%s: fail to remove entry under remote "
850 "parent for "DFID": rc = %d\n",
851 osd_name(osd), PFID(fid), rc);
856 rc = osd_xattr_get_internal(env, obj, &buf, XATTR_NAME_LMA, &size);
858 CERROR("%s: fail to load LMA for removing "
859 DFID" from remote parent: rc = %d\n",
860 osd_name(osd), PFID(fid), rc);
864 lustre_lma_swab(lma);
865 lma->lma_incompat &= ~LMAI_REMOTE_PARENT;
866 lustre_lma_swab(lma);
868 rc = osd_xattr_set_internal(env, obj, &buf, XATTR_NAME_LMA,
869 LU_XATTR_REPLACE, oh);
871 CERROR("%s: fail to update LMA for removing "
872 DFID" from remote parent: rc = %d\n",
873 osd_name(osd), PFID(fid), rc);
875 lu_object_clear_agent_entry(&obj->oo_dt.do_lu);
880 static int osd_declare_dir_insert(const struct lu_env *env,
881 struct dt_object *dt,
882 const struct dt_rec *rec,
883 const struct dt_key *key,
886 struct osd_object *obj = osd_dt_obj(dt);
887 struct osd_device *osd = osd_obj2dev(obj);
888 const struct dt_insert_rec *rec1;
889 const struct lu_fid *fid;
890 struct osd_thandle *oh;
892 struct osd_idmap_cache *idc;
895 rec1 = (struct dt_insert_rec *)rec;
897 LASSERT(fid != NULL);
898 LASSERT(rec1->rec_type != 0);
901 oh = container_of(th, struct osd_thandle, ot_super);
903 idc = osd_idc_find_or_init(env, osd, fid);
905 RETURN(PTR_ERR(idc));
907 if (idc->oic_remote) {
908 const char *name = (const char *)key;
910 if (name[0] != '.' || name[1] != '.' || name[2] != 0) {
911 /* Prepare agent object for remote entry that will
912 * be used for operations via ZPL, such as MDT side
913 * file-level backup and restore. */
914 dmu_tx_hold_sa_create(oh->ot_tx,
915 osd_find_dnsize(osd, OSD_BASE_EA_IN_BONUS));
916 if (S_ISDIR(rec1->rec_type))
917 dmu_tx_hold_zap(oh->ot_tx, DMU_NEW_OBJECT,
922 /* This is for inserting dot/dotdot for new created dir. */
923 if (obj->oo_dn == NULL)
924 object = DMU_NEW_OBJECT;
926 object = obj->oo_dn->dn_object;
928 /* do not specify the key as then DMU is trying to look it up
929 * which is very expensive. usually the layers above lookup
930 * before insertion */
931 osd_tx_hold_zap(oh->ot_tx, object, obj->oo_dn, TRUE, NULL);
936 static int osd_seq_exists(const struct lu_env *env, struct osd_device *osd,
939 struct lu_seq_range *range = &osd_oti_get(env)->oti_seq_range;
940 struct seq_server_site *ss = osd_seq_site(osd);
945 LASSERT(ss->ss_server_fld != NULL);
947 rc = osd_fld_lookup(env, osd, seq, range);
950 CERROR("%s: Can not lookup fld for %#llx\n",
955 RETURN(ss->ss_node_id == range->lsr_index);
958 int osd_remote_fid(const struct lu_env *env, struct osd_device *osd,
959 const struct lu_fid *fid)
961 struct seq_server_site *ss = osd_seq_site(osd);
964 /* FID seqs not in FLDB, must be local seq */
965 if (unlikely(!fid_seq_in_fldb(fid_seq(fid))))
968 /* If FLD is not being initialized yet, it only happens during the
969 * initialization, likely during mgs initialization, and we assume
970 * this is local FID. */
971 if (ss == NULL || ss->ss_server_fld == NULL)
974 /* Only check the local FLDB here */
975 if (osd_seq_exists(env, osd, fid_seq(fid)))
982 * Inserts (key, value) pair in \a directory object.
984 * \param dt osd index object
985 * \param key key for index
986 * \param rec record reference
987 * \param th transaction handler
990 * \retval -ve failure
992 static int osd_dir_insert(const struct lu_env *env, struct dt_object *dt,
993 const struct dt_rec *rec, const struct dt_key *key,
996 struct osd_thread_info *oti = osd_oti_get(env);
997 struct osd_object *parent = osd_dt_obj(dt);
998 struct osd_device *osd = osd_obj2dev(parent);
999 struct dt_insert_rec *rec1 = (struct dt_insert_rec *)rec;
1000 const struct lu_fid *fid = rec1->rec_fid;
1001 struct osd_thandle *oh;
1002 struct osd_idmap_cache *idc;
1003 const char *name = (const char *)key;
1004 struct luz_direntry *zde = &oti->oti_zde;
1005 int num = sizeof(*zde) / 8;
1009 LASSERT(parent->oo_dn);
1011 LASSERT(dt_object_exists(dt));
1012 LASSERT(osd_invariant(parent));
1014 LASSERT(th != NULL);
1015 oh = container_of(th, struct osd_thandle, ot_super);
1017 idc = osd_idc_find(env, osd, fid);
1018 if (unlikely(idc == NULL)) {
1019 /* this dt_insert() wasn't declared properly, so
1020 * FID is missing in OI cache. we better do not
1021 * lookup FID in FLDB/OI and don't risk to deadlock,
1022 * but in some special cases (lfsck testing, etc)
1023 * it's much simpler than fixing a caller */
1024 idc = osd_idc_find_or_init(env, osd, fid);
1026 CERROR("%s: "DFID" wasn't declared for insert\n",
1027 osd_name(osd), PFID(fid));
1028 RETURN(PTR_ERR(idc));
1032 BUILD_BUG_ON(sizeof(zde->lzd_reg) != 8);
1033 BUILD_BUG_ON(sizeof(*zde) % 8 != 0);
1035 memset(&zde->lzd_reg, 0, sizeof(zde->lzd_reg));
1036 zde->lzd_reg.zde_type = S_DT(rec1->rec_type & S_IFMT);
1037 zde->lzd_fid = *fid;
1039 if (idc->oic_remote) {
1040 if (name[0] != '.' || name[1] != '.' || name[2] != 0) {
1041 /* Create agent inode for remote object that will
1042 * be used for MDT file-level backup and restore. */
1043 rc = osd_create_agent_object(env, osd, zde,
1044 parent->oo_dn->dn_object, oh->ot_tx);
1046 CWARN("%s: Fail to create agent object for "
1048 osd_name(osd), PFID(fid), rc);
1049 /* Ignore the failure since the system can go
1050 * ahead if we do not care about the MDT side
1051 * file-level backup and restore. */
1056 if (unlikely(idc->oic_dnode == 0)) {
1057 /* for a reason OI cache wasn't filled properly */
1058 CERROR("%s: OIC for "DFID" isn't filled\n",
1059 osd_name(osd), PFID(fid));
1062 if (name[0] == '.') {
1064 /* do not store ".", instead generate it
1065 * during iteration */
1067 } else if (name[1] == '.' && name[2] == 0) {
1068 uint64_t dnode = idc->oic_dnode;
1069 if (CFS_FAIL_CHECK(OBD_FAIL_LFSCK_BAD_PARENT))
1072 /* update parent dnode in the child.
1073 * later it will be used to generate ".." */
1074 rc = osd_object_sa_update(parent,
1081 zde->lzd_reg.zde_dnode = idc->oic_dnode;
1084 if (CFS_FAIL_CHECK(OBD_FAIL_FID_INDIR))
1085 zde->lzd_fid.f_ver = ~0;
1087 /* The logic is not related with IGIF, just re-use the fail_loc value
1088 * to be consistent with ldiskfs case, then share the same test logic */
1089 if (CFS_FAIL_CHECK(OBD_FAIL_FID_IGIF))
1092 /* Insert (key,oid) into ZAP */
1093 rc = osd_zap_add(osd, parent->oo_dn->dn_object, parent->oo_dn,
1094 name, 8, num, (void *)zde, oh->ot_tx);
1095 if (unlikely(rc == -EEXIST &&
1096 name[0] == '.' && name[1] == '.' && name[2] == 0))
1097 /* Update (key,oid) in ZAP */
1098 rc = -zap_update(osd->od_os, parent->oo_dn->dn_object, name, 8,
1099 sizeof(*zde) / 8, (void *)zde, oh->ot_tx);
1106 static int osd_declare_dir_delete(const struct lu_env *env,
1107 struct dt_object *dt,
1108 const struct dt_key *key,
1111 struct osd_object *obj = osd_dt_obj(dt);
1112 dnode_t *zap_dn = obj->oo_dn;
1113 struct osd_thandle *oh;
1114 const char *name = (const char *)key;
1117 LASSERT(dt_object_exists(dt));
1118 LASSERT(osd_invariant(obj));
1119 LASSERT(zap_dn != NULL);
1121 LASSERT(th != NULL);
1122 oh = container_of(th, struct osd_thandle, ot_super);
1125 * In Orion . and .. were stored in the directory (not generated upon
1126 * request as now). We preserve them for backward compatibility.
1128 if (name[0] == '.') {
1131 else if (name[1] == '.' && name[2] == 0)
1135 /* do not specify the key as then DMU is trying to look it up
1136 * which is very expensive. usually the layers above lookup
1137 * before deletion */
1138 osd_tx_hold_zap(oh->ot_tx, zap_dn->dn_object, zap_dn, FALSE, NULL);
1140 /* For destroying agent object if have. */
1141 dmu_tx_hold_bonus(oh->ot_tx, DMU_NEW_OBJECT);
1146 static int osd_dir_delete(const struct lu_env *env, struct dt_object *dt,
1147 const struct dt_key *key, struct thandle *th)
1149 struct luz_direntry *zde = &osd_oti_get(env)->oti_zde;
1150 struct osd_object *obj = osd_dt_obj(dt);
1151 struct osd_device *osd = osd_obj2dev(obj);
1152 struct osd_thandle *oh;
1153 dnode_t *zap_dn = obj->oo_dn;
1154 char *name = (char *)key;
1160 LASSERT(th != NULL);
1161 oh = container_of(th, struct osd_thandle, ot_super);
1164 * In Orion . and .. were stored in the directory (not generated upon
1165 * request as now). we preserve them for backward compatibility
1167 if (name[0] == '.') {
1170 } else if (name[1] == '.' && name[2] == 0) {
1175 /* XXX: We have to say that lookup during delete_declare will affect
1176 * performance, but we have to check whether the name entry (to
1177 * be deleted) has agent object or not to avoid orphans.
1179 * We will improve that in the future, some possible solutions,
1181 * 1) Some hint from the caller via transaction handle to make
1182 * the lookup conditionally.
1183 * 2) Enhance the ZFS logic to recognize the OSD lookup result
1184 * and delete the given entry directly without lookup again
1185 * internally. LU-10190 */
1186 memset(&zde->lzd_fid, 0, sizeof(zde->lzd_fid));
1187 rc = osd_zap_lookup(osd, zap_dn->dn_object, zap_dn, name, 8, 3, zde);
1190 CERROR("%s: failed to locate entry %s: rc = %d\n",
1191 osd->od_svname, name, rc);
1195 if (unlikely(osd_remote_fid(env, osd, &zde->lzd_fid) > 0)) {
1196 rc = -dmu_object_free(osd->od_os, zde->lzd_reg.zde_dnode,
1199 CERROR("%s: failed to destroy agent object (%llu) "
1200 "for the entry %s: rc = %d\n", osd->od_svname,
1201 (__u64)zde->lzd_reg.zde_dnode, name, rc);
1204 /* Remove key from the ZAP */
1205 rc = osd_zap_remove(osd, zap_dn->dn_object, zap_dn,
1206 (char *)key, oh->ot_tx);
1208 CERROR("%s: zap_remove %s failed: rc = %d\n",
1209 osd->od_svname, name, rc);
1214 static struct dt_it *osd_dir_it_init(const struct lu_env *env,
1215 struct dt_object *dt,
1218 struct osd_zap_it *it;
1220 it = (struct osd_zap_it *)osd_index_it_init(env, dt, unused);
1222 it->ozi_pos = OZI_POS_INIT;
1224 RETURN((struct dt_it *)it);
1228 * Move Iterator to record specified by \a key
1230 * \param di osd iterator
1231 * \param key key for index
1233 * \retval +ve di points to record with least key not larger than key
1234 * \retval 0 di points to exact matched key
1235 * \retval -ve failure
1237 static int osd_dir_it_get(const struct lu_env *env,
1238 struct dt_it *di, const struct dt_key *key)
1240 struct osd_zap_it *it = (struct osd_zap_it *)di;
1241 struct osd_object *obj = it->ozi_obj;
1242 char *name = (char *)key;
1247 LASSERT(it->ozi_zc);
1249 /* reset the cursor */
1250 zap_cursor_fini(it->ozi_zc);
1251 osd_obj_cursor_init_serialized(it->ozi_zc, obj, 0);
1253 /* XXX: implementation of the API is broken at the moment */
1254 LASSERT(((const char *)key)[0] == 0);
1257 it->ozi_pos = OZI_POS_INIT;
1261 if (name[0] == '.') {
1263 it->ozi_pos = OZI_POS_DOT;
1265 } else if (name[1] == '.' && name[2] == 0) {
1266 it->ozi_pos = OZI_POS_DOTDOT;
1271 /* neither . nor .. - some real record */
1272 it->ozi_pos = OZI_POS_REAL;
1279 static void osd_dir_it_put(const struct lu_env *env, struct dt_it *di)
1281 /* PBS: do nothing : ref are incremented at retrive and decreamented
1286 * in Orion . and .. were stored in the directory, while ZPL
1287 * and current osd-zfs generate them up on request. so, we
1288 * need to ignore previously stored . and ..
1290 static int osd_index_retrieve_skip_dots(struct osd_zap_it *it,
1291 zap_attribute_t *za)
1296 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1299 if (unlikely(rc == 0 && za->za_name[0] == '.')) {
1300 if (za->za_name[1] == 0) {
1302 } else if (za->za_name[1] == '.' &&
1303 za->za_name[2] == 0) {
1306 if (unlikely(isdot))
1307 zap_cursor_advance(it->ozi_zc);
1309 } while (unlikely(rc == 0 && isdot));
1315 * to load a directory entry at a time and stored it in
1316 * iterator's in-memory data structure.
1318 * \param di, struct osd_it_ea, iterator's in memory structure
1320 * \retval +ve, iterator reached to end
1321 * \retval 0, iterator not reached to end
1322 * \retval -ve, on error
1324 static int osd_dir_it_next(const struct lu_env *env, struct dt_it *di)
1326 struct osd_zap_it *it = (struct osd_zap_it *)di;
1327 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1332 /* temp. storage should be enough for any key supported by ZFS */
1333 BUILD_BUG_ON(sizeof(za->za_name) > sizeof(it->ozi_name));
1336 * the first ->next() moves the cursor to .
1337 * the second ->next() moves the cursor to ..
1338 * then we get to the real records and have to verify any exist
1340 if (it->ozi_pos <= OZI_POS_DOTDOT) {
1342 if (it->ozi_pos <= OZI_POS_DOTDOT)
1346 zap_cursor_advance(it->ozi_zc);
1350 * According to current API we need to return error if its last entry.
1351 * zap_cursor_advance() does not return any value. So we need to call
1352 * retrieve to check if there is any record. We should make
1353 * changes to Iterator API to not return status for this API
1355 rc = osd_index_retrieve_skip_dots(it, za);
1357 if (rc == -ENOENT) /* end of dir */
1363 static struct dt_key *osd_dir_it_key(const struct lu_env *env,
1364 const struct dt_it *di)
1366 struct osd_zap_it *it = (struct osd_zap_it *)di;
1367 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1371 if (it->ozi_pos <= OZI_POS_DOT) {
1372 it->ozi_pos = OZI_POS_DOT;
1373 RETURN((struct dt_key *)".");
1374 } else if (it->ozi_pos == OZI_POS_DOTDOT) {
1375 RETURN((struct dt_key *)"..");
1378 if ((rc = -zap_cursor_retrieve(it->ozi_zc, za)))
1379 RETURN(ERR_PTR(rc));
1381 strcpy(it->ozi_name, za->za_name);
1383 RETURN((struct dt_key *)it->ozi_name);
1386 static int osd_dir_it_key_size(const struct lu_env *env, const struct dt_it *di)
1388 struct osd_zap_it *it = (struct osd_zap_it *)di;
1389 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1393 if (it->ozi_pos <= OZI_POS_DOT) {
1394 it->ozi_pos = OZI_POS_DOT;
1396 } else if (it->ozi_pos == OZI_POS_DOTDOT) {
1400 if ((rc = -zap_cursor_retrieve(it->ozi_zc, za)) == 0)
1401 rc = strlen(za->za_name);
1407 osd_dirent_update(const struct lu_env *env, struct osd_device *dev,
1408 uint64_t zap, const char *key, struct luz_direntry *zde)
1414 tx = dmu_tx_create(dev->od_os);
1418 dmu_tx_hold_zap(tx, zap, TRUE, NULL);
1419 rc = -dmu_tx_assign(tx, TXG_WAIT);
1421 rc = -zap_update(dev->od_os, zap, key, 8, sizeof(*zde) / 8,
1422 (const void *)zde, tx);
1431 static int osd_update_entry_for_agent(const struct lu_env *env,
1432 struct osd_device *osd,
1433 uint64_t zap, const char *name,
1434 struct luz_direntry *zde, __u32 attr)
1436 dmu_tx_t *tx = NULL;
1440 if (attr & LUDA_VERIFY_DRYRUN)
1443 tx = dmu_tx_create(osd->od_os);
1445 GOTO(out, rc = -ENOMEM);
1447 dmu_tx_hold_sa_create(tx, osd_find_dnsize(osd, OSD_BASE_EA_IN_BONUS));
1448 dmu_tx_hold_zap(tx, zap, FALSE, NULL);
1449 rc = -dmu_tx_assign(tx, TXG_WAIT);
1455 rc = osd_create_agent_object(env, osd, zde, zap, tx);
1457 rc = -zap_update(osd->od_os, zap, name, 8, sizeof(*zde) / 8,
1458 (const void *)zde, tx);
1464 CDEBUG(D_LFSCK, "%s: Updated (%s) remote entry for "DFID": rc = %d\n",
1465 osd_name(osd), (attr & LUDA_VERIFY_DRYRUN) ? "(ro)" : "(rw)",
1466 PFID(&zde->lzd_fid), rc);
1470 static int osd_dir_it_rec(const struct lu_env *env, const struct dt_it *di,
1471 struct dt_rec *dtrec, __u32 attr)
1473 struct osd_zap_it *it = (struct osd_zap_it *)di;
1474 struct lu_dirent *lde = (struct lu_dirent *)dtrec;
1475 struct osd_thread_info *info = osd_oti_get(env);
1476 struct luz_direntry *zde = &info->oti_zde;
1477 zap_attribute_t *za = &info->oti_za;
1478 struct lu_fid *fid = &info->oti_fid;
1479 struct osd_device *osd = osd_obj2dev(it->ozi_obj);
1484 if (it->ozi_pos <= OZI_POS_DOT) {
1485 /* notice hash=0 here, this is needed to avoid
1486 * case when some real entry (after ./..) may
1487 * have hash=0. in this case the client would
1488 * be confused having records out of hash order. */
1489 lde->lde_hash = cpu_to_le64(0);
1490 strcpy(lde->lde_name, ".");
1491 lde->lde_namelen = cpu_to_le16(1);
1492 fid_cpu_to_le(&lde->lde_fid,
1493 lu_object_fid(&it->ozi_obj->oo_dt.do_lu));
1494 lde->lde_attrs = LUDA_FID;
1495 /* append lustre attributes */
1496 osd_it_append_attrs(lde, attr, 1, S_DT(S_IFDIR));
1497 lde->lde_reclen = cpu_to_le16(lu_dirent_calc_size(1, attr));
1498 it->ozi_pos = OZI_POS_DOT;
1500 } else if (it->ozi_pos == OZI_POS_DOTDOT) {
1501 /* same as for . above */
1502 lde->lde_hash = cpu_to_le64(0);
1503 strcpy(lde->lde_name, "..");
1504 lde->lde_namelen = cpu_to_le16(2);
1505 rc = osd_find_parent_fid(env, &it->ozi_obj->oo_dt, fid, NULL);
1507 fid_cpu_to_le(&lde->lde_fid, fid);
1508 lde->lde_attrs = LUDA_FID;
1509 } else if (rc != -ENOENT) {
1510 /* ENOENT happens at the root of filesystem, ignore */
1514 /* append lustre attributes */
1515 osd_it_append_attrs(lde, attr, 2, S_DT(S_IFDIR));
1516 lde->lde_reclen = cpu_to_le16(lu_dirent_calc_size(2, attr));
1522 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1526 lde->lde_hash = cpu_to_le64(osd_zap_cursor_serialize(it->ozi_zc));
1527 namelen = strlen(za->za_name);
1528 if (namelen > NAME_MAX)
1530 strcpy(lde->lde_name, za->za_name);
1531 lde->lde_namelen = cpu_to_le16(namelen);
1533 if (za->za_integer_length != 8) {
1534 CERROR("%s: unsupported direntry format: %d %d\n",
1536 za->za_integer_length, (int)za->za_num_integers);
1540 rc = osd_zap_lookup(osd, it->ozi_zc->zc_zapobj, it->ozi_obj->oo_dn,
1541 za->za_name, za->za_integer_length, 3, zde);
1545 if (za->za_num_integers >= 3 && fid_is_sane(&zde->lzd_fid)) {
1546 lde->lde_attrs = LUDA_FID;
1547 fid_cpu_to_le(&lde->lde_fid, &zde->lzd_fid);
1548 if (unlikely(zde->lzd_reg.zde_dnode == ZFS_NO_OBJECT &&
1549 osd_remote_fid(env, osd, &zde->lzd_fid) > 0 &&
1550 attr & LUDA_VERIFY)) {
1551 /* It is mainly used for handling the MDT
1552 * upgraded from old ZFS based backend. */
1553 rc = osd_update_entry_for_agent(env, osd,
1554 it->ozi_obj->oo_dn->dn_object,
1555 za->za_name, zde, attr);
1557 lde->lde_attrs |= LUDA_REPAIR;
1559 lde->lde_attrs |= LUDA_UNKNOWN;
1562 if (!(attr & (LUDA_VERIFY | LUDA_VERIFY_DRYRUN)))
1563 GOTO(pack_attr, rc = 0);
1566 if (CFS_FAIL_CHECK(OBD_FAIL_FID_LOOKUP))
1569 rc = osd_get_fid_by_oid(env, osd, zde->lzd_reg.zde_dnode, fid);
1571 lde->lde_attrs = LUDA_UNKNOWN;
1572 GOTO(pack_attr, rc = 0);
1575 if (za->za_num_integers >= 3 && fid_is_sane(&zde->lzd_fid) &&
1576 lu_fid_eq(&zde->lzd_fid, fid))
1577 GOTO(pack_attr, rc = 0);
1579 if (!(attr & LUDA_VERIFY)) {
1580 fid_cpu_to_le(&lde->lde_fid, fid);
1581 lde->lde_attrs = LUDA_FID;
1582 GOTO(pack_attr, rc = 0);
1585 if (attr & LUDA_VERIFY_DRYRUN) {
1586 fid_cpu_to_le(&lde->lde_fid, fid);
1587 lde->lde_attrs = LUDA_FID | LUDA_REPAIR;
1588 GOTO(pack_attr, rc = 0);
1591 fid_cpu_to_le(&lde->lde_fid, fid);
1592 lde->lde_attrs = LUDA_FID;
1593 zde->lzd_fid = *fid;
1594 rc = osd_dirent_update(env, osd, it->ozi_zc->zc_zapobj,
1597 lde->lde_attrs |= LUDA_UNKNOWN;
1598 GOTO(pack_attr, rc = 0);
1601 lde->lde_attrs |= LUDA_REPAIR;
1603 GOTO(pack_attr, rc = 0);
1606 osd_it_append_attrs(lde, attr, namelen, zde->lzd_reg.zde_type);
1607 lde->lde_reclen = cpu_to_le16(lu_dirent_calc_size(namelen, attr));
1611 static int osd_dir_it_rec_size(const struct lu_env *env, const struct dt_it *di,
1614 struct osd_zap_it *it = (struct osd_zap_it *)di;
1615 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1620 if (it->ozi_pos <= OZI_POS_DOT)
1622 else if (it->ozi_pos == OZI_POS_DOTDOT)
1626 rc = lu_dirent_calc_size(namelen, attr);
1630 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1631 if (unlikely(rc != 0))
1634 if (za->za_integer_length != 8 || za->za_num_integers < 3) {
1635 CERROR("%s: unsupported direntry format: %d %d\n",
1636 osd_obj2dev(it->ozi_obj)->od_svname,
1637 za->za_integer_length, (int)za->za_num_integers);
1641 namelen = strlen(za->za_name);
1642 if (namelen > NAME_MAX)
1645 rc = lu_dirent_calc_size(namelen, attr);
1650 static __u64 osd_dir_it_store(const struct lu_env *env, const struct dt_it *di)
1652 struct osd_zap_it *it = (struct osd_zap_it *)di;
1656 if (it->ozi_pos <= OZI_POS_DOTDOT)
1659 pos = osd_zap_cursor_serialize(it->ozi_zc);
1666 * rc == 0 -> end of directory.
1667 * rc > 0 -> ok, proceed.
1668 * rc < 0 -> error. ( EOVERFLOW can be masked.)
1670 static int osd_dir_it_load(const struct lu_env *env,
1671 const struct dt_it *di, __u64 hash)
1673 struct osd_zap_it *it = (struct osd_zap_it *)di;
1674 struct osd_object *obj = it->ozi_obj;
1675 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1679 /* reset the cursor */
1680 zap_cursor_fini(it->ozi_zc);
1681 osd_obj_cursor_init_serialized(it->ozi_zc, obj, hash);
1684 it->ozi_pos = OZI_POS_INIT;
1685 rc = +1; /* there will be ./.. at least */
1687 it->ozi_pos = OZI_POS_REAL;
1688 /* to return whether the end has been reached */
1689 rc = osd_index_retrieve_skip_dots(it, za);
1692 else if (rc == -ENOENT)
1699 const struct dt_index_operations osd_dir_ops = {
1700 .dio_lookup = osd_dir_lookup,
1701 .dio_declare_insert = osd_declare_dir_insert,
1702 .dio_insert = osd_dir_insert,
1703 .dio_declare_delete = osd_declare_dir_delete,
1704 .dio_delete = osd_dir_delete,
1706 .init = osd_dir_it_init,
1707 .fini = osd_index_it_fini,
1708 .get = osd_dir_it_get,
1709 .put = osd_dir_it_put,
1710 .next = osd_dir_it_next,
1711 .key = osd_dir_it_key,
1712 .key_size = osd_dir_it_key_size,
1713 .rec = osd_dir_it_rec,
1714 .rec_size = osd_dir_it_rec_size,
1715 .store = osd_dir_it_store,
1716 .load = osd_dir_it_load
1721 * Primitives for index files using binary keys.
1724 /* key integer_size is 8 */
1725 static int osd_prepare_key_uint64(struct osd_object *o, __u64 *dst,
1726 const struct dt_key *src)
1733 /* align keysize to 64bit */
1734 size = (o->oo_keysize + sizeof(__u64) - 1) / sizeof(__u64);
1735 size *= sizeof(__u64);
1737 LASSERT(size <= MAXNAMELEN);
1739 if (unlikely(size > o->oo_keysize))
1740 memset(dst + o->oo_keysize, 0, size - o->oo_keysize);
1741 memcpy(dst, (const char *)src, o->oo_keysize);
1743 return (size/sizeof(__u64));
1746 static int osd_index_lookup(const struct lu_env *env, struct dt_object *dt,
1747 struct dt_rec *rec, const struct dt_key *key)
1749 struct osd_object *obj = osd_dt_obj(dt);
1750 struct osd_device *osd = osd_obj2dev(obj);
1751 __u64 *k = osd_oti_get(env)->oti_key64;
1755 rc = osd_prepare_key_uint64(obj, k, key);
1757 rc = -zap_lookup_uint64(osd->od_os, obj->oo_dn->dn_object,
1758 k, rc, obj->oo_recusize, obj->oo_recsize,
1760 RETURN(rc == 0 ? 1 : rc);
1763 static int osd_declare_index_insert(const struct lu_env *env,
1764 struct dt_object *dt,
1765 const struct dt_rec *rec,
1766 const struct dt_key *key,
1769 struct osd_object *obj = osd_dt_obj(dt);
1770 struct osd_thandle *oh;
1773 LASSERT(th != NULL);
1774 oh = container_of(th, struct osd_thandle, ot_super);
1776 LASSERT(obj->oo_dn);
1778 /* do not specify the key as then DMU is trying to look it up
1779 * which is very expensive. usually the layers above lookup
1780 * before insertion */
1781 osd_tx_hold_zap(oh->ot_tx, obj->oo_dn->dn_object, obj->oo_dn,
1787 static int osd_index_insert(const struct lu_env *env, struct dt_object *dt,
1788 const struct dt_rec *rec, const struct dt_key *key,
1791 struct osd_object *obj = osd_dt_obj(dt);
1792 struct osd_device *osd = osd_obj2dev(obj);
1793 struct osd_thandle *oh;
1794 __u64 *k = osd_oti_get(env)->oti_key64;
1798 LASSERT(obj->oo_dn);
1799 LASSERT(dt_object_exists(dt));
1800 LASSERT(osd_invariant(obj));
1801 LASSERT(th != NULL);
1803 oh = container_of(th, struct osd_thandle, ot_super);
1805 rc = osd_prepare_key_uint64(obj, k, key);
1807 /* Insert (key,oid) into ZAP */
1808 rc = -zap_add_uint64(osd->od_os, obj->oo_dn->dn_object,
1809 k, rc, obj->oo_recusize, obj->oo_recsize,
1810 (void *)rec, oh->ot_tx);
1814 static int osd_declare_index_delete(const struct lu_env *env,
1815 struct dt_object *dt,
1816 const struct dt_key *key,
1819 struct osd_object *obj = osd_dt_obj(dt);
1820 struct osd_thandle *oh;
1823 LASSERT(dt_object_exists(dt));
1824 LASSERT(osd_invariant(obj));
1825 LASSERT(th != NULL);
1826 LASSERT(obj->oo_dn);
1828 oh = container_of(th, struct osd_thandle, ot_super);
1830 /* do not specify the key as then DMU is trying to look it up
1831 * which is very expensive. usually the layers above lookup
1832 * before deletion */
1833 osd_tx_hold_zap(oh->ot_tx, obj->oo_dn->dn_object, obj->oo_dn,
1839 static int osd_index_delete(const struct lu_env *env, struct dt_object *dt,
1840 const struct dt_key *key, struct thandle *th)
1842 struct osd_object *obj = osd_dt_obj(dt);
1843 struct osd_device *osd = osd_obj2dev(obj);
1844 struct osd_thandle *oh;
1845 __u64 *k = osd_oti_get(env)->oti_key64;
1849 LASSERT(obj->oo_dn);
1850 LASSERT(th != NULL);
1851 oh = container_of(th, struct osd_thandle, ot_super);
1853 rc = osd_prepare_key_uint64(obj, k, key);
1855 /* Remove binary key from the ZAP */
1856 rc = -zap_remove_uint64(osd->od_os, obj->oo_dn->dn_object,
1861 static int osd_index_it_get(const struct lu_env *env, struct dt_it *di,
1862 const struct dt_key *key)
1864 struct osd_zap_it *it = (struct osd_zap_it *)di;
1865 struct osd_object *obj = it->ozi_obj;
1866 struct osd_device *osd = osd_obj2dev(obj);
1870 LASSERT(it->ozi_zc);
1873 * XXX: we need a binary version of zap_cursor_move_to_key()
1874 * to implement this API */
1875 if (*((const __u64 *)key) != 0)
1876 CERROR("NOT IMPLEMETED YET (move to %#llx)\n",
1879 zap_cursor_fini(it->ozi_zc);
1880 zap_cursor_init(it->ozi_zc, osd->od_os, obj->oo_dn->dn_object);
1886 static int osd_index_it_next(const struct lu_env *env, struct dt_it *di)
1888 struct osd_zap_it *it = (struct osd_zap_it *)di;
1889 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1893 if (it->ozi_reset == 0)
1894 zap_cursor_advance(it->ozi_zc);
1898 * According to current API we need to return error if it's last entry.
1899 * zap_cursor_advance() does not return any value. So we need to call
1900 * retrieve to check if there is any record. We should make
1901 * changes to Iterator API to not return status for this API
1903 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1910 static struct dt_key *osd_index_it_key(const struct lu_env *env,
1911 const struct dt_it *di)
1913 struct osd_zap_it *it = (struct osd_zap_it *)di;
1914 struct osd_object *obj = it->ozi_obj;
1915 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1920 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1922 RETURN(ERR_PTR(rc));
1924 /* the binary key is stored in the name */
1925 memcpy(&it->ozi_key, za->za_name, obj->oo_keysize);
1927 RETURN((struct dt_key *)&it->ozi_key);
1930 static int osd_index_it_key_size(const struct lu_env *env,
1931 const struct dt_it *di)
1933 struct osd_zap_it *it = (struct osd_zap_it *)di;
1934 struct osd_object *obj = it->ozi_obj;
1935 RETURN(obj->oo_keysize);
1938 static int osd_index_it_rec(const struct lu_env *env, const struct dt_it *di,
1939 struct dt_rec *rec, __u32 attr)
1941 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1942 struct osd_zap_it *it = (struct osd_zap_it *)di;
1943 struct osd_object *obj = it->ozi_obj;
1944 struct osd_device *osd = osd_obj2dev(obj);
1945 __u64 *k = osd_oti_get(env)->oti_key64;
1950 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1954 rc = osd_prepare_key_uint64(obj, k, (const struct dt_key *)za->za_name);
1956 rc = -zap_lookup_uint64(osd->od_os, obj->oo_dn->dn_object,
1957 k, rc, obj->oo_recusize, obj->oo_recsize,
1962 static __u64 osd_index_it_store(const struct lu_env *env,
1963 const struct dt_it *di)
1965 struct osd_zap_it *it = (struct osd_zap_it *)di;
1968 RETURN((__u64)zap_cursor_serialize(it->ozi_zc));
1971 static int osd_index_it_load(const struct lu_env *env, const struct dt_it *di,
1974 struct osd_zap_it *it = (struct osd_zap_it *)di;
1975 struct osd_object *obj = it->ozi_obj;
1976 struct osd_device *osd = osd_obj2dev(obj);
1977 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1981 /* reset the cursor */
1982 zap_cursor_fini(it->ozi_zc);
1983 zap_cursor_init_serialized(it->ozi_zc, osd->od_os,
1984 obj->oo_dn->dn_object, hash);
1987 rc = -zap_cursor_retrieve(it->ozi_zc, za);
1990 else if (rc == -ENOENT)
1996 static const struct dt_index_operations osd_index_ops = {
1997 .dio_lookup = osd_index_lookup,
1998 .dio_declare_insert = osd_declare_index_insert,
1999 .dio_insert = osd_index_insert,
2000 .dio_declare_delete = osd_declare_index_delete,
2001 .dio_delete = osd_index_delete,
2003 .init = osd_index_it_init,
2004 .fini = osd_index_it_fini,
2005 .get = osd_index_it_get,
2006 .put = osd_index_it_put,
2007 .next = osd_index_it_next,
2008 .key = osd_index_it_key,
2009 .key_size = osd_index_it_key_size,
2010 .rec = osd_index_it_rec,
2011 .store = osd_index_it_store,
2012 .load = osd_index_it_load
2016 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
2017 const struct dt_index_features *feat)
2019 struct osd_object *obj = osd_dt_obj(dt);
2020 struct osd_device *osd = osd_obj2dev(obj);
2021 const struct lu_fid *fid = lu_object_fid(&dt->do_lu);
2025 down_read(&obj->oo_guard);
2028 * XXX: implement support for fixed-size keys sorted with natural
2029 * numerical way (not using internal hash value)
2031 if (feat->dif_flags & DT_IND_RANGE)
2032 GOTO(out, rc = -ERANGE);
2034 if (unlikely(feat == &dt_otable_features)) {
2035 dt->do_index_ops = &osd_otable_ops;
2039 LASSERT(!dt_object_exists(dt) || obj->oo_dn != NULL);
2040 if (likely(feat == &dt_directory_features)) {
2041 if (!dt_object_exists(dt) || osd_object_is_zap(obj->oo_dn))
2042 dt->do_index_ops = &osd_dir_ops;
2044 GOTO(out, rc = -ENOTDIR);
2045 } else if (unlikely(feat == &dt_acct_features)) {
2046 LASSERT(fid_is_acct(fid));
2047 dt->do_index_ops = &osd_acct_index_ops;
2048 } else if (dt->do_index_ops == NULL) {
2049 /* For index file, we don't support variable key & record sizes
2050 * and the key has to be unique */
2051 if ((feat->dif_flags & ~DT_IND_UPDATE) != 0)
2052 GOTO(out, rc = -EINVAL);
2054 if (feat->dif_keysize_max > ZAP_MAXNAMELEN)
2055 GOTO(out, rc = -E2BIG);
2056 if (feat->dif_keysize_max != feat->dif_keysize_min)
2057 GOTO(out, rc = -EINVAL);
2059 /* As for the record size, it should be a multiple of 8 bytes
2060 * and smaller than the maximum value length supported by ZAP.
2062 if (feat->dif_recsize_max > ZAP_MAXVALUELEN)
2063 GOTO(out, rc = -E2BIG);
2064 if (feat->dif_recsize_max != feat->dif_recsize_min)
2065 GOTO(out, rc = -EINVAL);
2067 obj->oo_keysize = feat->dif_keysize_max;
2068 obj->oo_recsize = feat->dif_recsize_max;
2069 obj->oo_recusize = 1;
2071 /* ZFS prefers to work with array of 64bits */
2072 if ((obj->oo_recsize & 7) == 0) {
2073 obj->oo_recsize >>= 3;
2074 obj->oo_recusize = 8;
2076 dt->do_index_ops = &osd_index_ops;
2078 if (feat == &dt_lfsck_layout_orphan_features ||
2079 feat == &dt_lfsck_layout_dangling_features ||
2080 feat == &dt_lfsck_namespace_features)
2083 rc = osd_index_register(osd, fid, obj->oo_keysize,
2084 obj->oo_recusize * obj->oo_recsize);
2086 CWARN("%s: failed to register index "DFID": rc = %d\n",
2087 osd_name(osd), PFID(fid), rc);
2091 CDEBUG(D_LFSCK, "%s: index object "DFID
2092 " (%u/%u/%u) registered\n",
2093 osd_name(osd), PFID(fid), obj->oo_keysize,
2094 obj->oo_recusize, obj->oo_recsize);
2098 up_read(&obj->oo_guard);