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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2015, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Author: Nikita Danilov <nikita@clusterfs.com>
39 #define DEBUG_SUBSYSTEM S_OSD
41 #include <linux/module.h>
43 /* LUSTRE_VERSION_CODE */
44 #include <lustre_ver.h>
46 * struct OBD_{ALLOC,FREE}*()
50 #include <obd_support.h>
53 #include <lustre_fid.h>
54 #include <dt_object.h>
57 /* osd_lookup(), struct osd_thread_info */
58 #include "osd_internal.h"
59 #include "osd_scrub.h"
61 static unsigned int osd_oi_count = OSD_OI_FID_NR;
62 module_param(osd_oi_count, int, 0444);
63 MODULE_PARM_DESC(osd_oi_count, "Number of Object Index containers to be created, it's only valid for new filesystem.");
65 /** to serialize concurrent OI index initialization */
66 static struct mutex oi_init_lock;
68 static struct dt_index_features oi_feat = {
69 .dif_flags = DT_IND_UPDATE,
70 .dif_recsize_min = sizeof(struct osd_inode_id),
71 .dif_recsize_max = sizeof(struct osd_inode_id),
75 #define OSD_OI_NAME_BASE "oi.16"
77 static void osd_oi_table_put(struct osd_thread_info *info,
78 struct osd_oi **oi_table, unsigned oi_count)
80 struct iam_container *bag;
83 for (i = 0; i < oi_count; i++) {
84 if (oi_table[i] == NULL)
87 LASSERT(oi_table[i]->oi_inode != NULL);
89 bag = &(oi_table[i]->oi_dir.od_container);
90 if (bag->ic_object == oi_table[i]->oi_inode)
91 iam_container_fini(bag);
92 iput(oi_table[i]->oi_inode);
93 oi_table[i]->oi_inode = NULL;
94 OBD_FREE_PTR(oi_table[i]);
99 static int osd_oi_index_create_one(struct osd_thread_info *info,
100 struct osd_device *osd, const char *name,
101 struct dt_index_features *feat)
103 const struct lu_env *env = info->oti_env;
104 struct osd_inode_id *id = &info->oti_id;
105 struct buffer_head *bh;
107 struct ldiskfs_dir_entry_2 *de;
108 struct dentry *dentry;
109 struct super_block *sb = osd_sb(osd);
110 struct inode *dir = sb->s_root->d_inode;
114 dentry = osd_child_dentry_by_inode(env, dir, name, strlen(name));
115 bh = osd_ldiskfs_find_entry(dir, &dentry->d_name, &de, NULL, NULL);
117 osd_id_gen(id, le32_to_cpu(de->inode), OSD_OII_NOGEN);
119 inode = osd_iget(info, osd, id);
120 if (!IS_ERR(inode)) {
122 inode = ERR_PTR(-EEXIST);
124 return PTR_ERR(inode);
127 jh = osd_journal_start_sb(sb, LDISKFS_HT_MISC, 100);
131 inode = ldiskfs_create_inode(jh, dir, (S_IFREG | S_IRUGO | S_IWUSR));
133 ldiskfs_journal_stop(jh);
134 return PTR_ERR(inode);
137 ldiskfs_set_inode_state(inode, LDISKFS_STATE_LUSTRE_NOSCRUB);
138 unlock_new_inode(inode);
140 if (feat->dif_flags & DT_IND_VARKEY)
141 rc = iam_lvar_create(inode, feat->dif_keysize_max,
142 feat->dif_ptrsize, feat->dif_recsize_max,
145 rc = iam_lfix_create(inode, feat->dif_keysize_max,
146 feat->dif_ptrsize, feat->dif_recsize_max,
148 dentry = osd_child_dentry_by_inode(env, dir, name, strlen(name));
149 rc = osd_ldiskfs_add_entry(info, osd, jh, dentry, inode, NULL);
150 ldiskfs_journal_stop(jh);
155 static struct inode *osd_oi_index_open(struct osd_thread_info *info,
156 struct osd_device *osd,
158 struct dt_index_features *f,
161 struct dentry *dentry;
165 dentry = ll_lookup_one_len(name, osd_sb(osd)->s_root, strlen(name));
167 return (void *) dentry;
169 if (dentry->d_inode) {
170 LASSERT(!is_bad_inode(dentry->d_inode));
171 inode = dentry->d_inode;
172 atomic_inc(&inode->i_count);
179 shrink_dcache_parent(osd_sb(osd)->s_root);
181 return ERR_PTR(-ENOENT);
183 rc = osd_oi_index_create_one(info, osd, name, f);
187 dentry = ll_lookup_one_len(name, osd_sb(osd)->s_root, strlen(name));
189 return (void *) dentry;
191 if (dentry->d_inode) {
192 LASSERT(!is_bad_inode(dentry->d_inode));
193 inode = dentry->d_inode;
194 atomic_inc(&inode->i_count);
199 return ERR_PTR(-ENOENT);
203 * Open an OI(Ojbect Index) container.
205 * \param name Name of OI container
206 * \param objp Pointer of returned OI
209 * \retval -ve failure
211 static int osd_oi_open(struct osd_thread_info *info, struct osd_device *osd,
212 char *name, struct osd_oi **oi_slot, bool create)
214 struct osd_directory *dir;
215 struct iam_container *bag;
222 oi_feat.dif_keysize_min = sizeof(struct lu_fid);
223 oi_feat.dif_keysize_max = sizeof(struct lu_fid);
225 inode = osd_oi_index_open(info, osd, name, &oi_feat, create);
227 RETURN(PTR_ERR(inode));
229 /* 'What the @fid is' is not imporatant, because these objects
230 * have no OI mappings, and only are visible inside the OSD.*/
231 lu_igif_build(&info->oti_fid, inode->i_ino, inode->i_generation);
232 rc = osd_ea_fid_set(info, inode, &info->oti_fid, LMAC_NOT_IN_OI, 0);
238 GOTO(out_inode, rc = -ENOMEM);
240 oi->oi_inode = inode;
243 bag = &dir->od_container;
244 rc = iam_container_init(bag, &dir->od_descr, inode);
248 rc = iam_container_setup(bag);
250 GOTO(out_container, rc);
256 iam_container_fini(bag);
265 * Open OI(Object Index) table.
266 * If \a oi_count is zero, which means caller doesn't know how many OIs there
267 * will be, this function can either return 0 for new filesystem, or number
268 * of OIs on existed filesystem.
270 * If \a oi_count is non-zero, which means caller does know number of OIs on
271 * filesystem, this function should return the exactly same number on
272 * success, or error code in failure.
274 * \param oi_count Number of expected OI containers
275 * \param create Create OIs if doesn't exist
277 * \retval +ve number of opened OI containers
278 * \retval 0 no OI containers found
279 * \retval -ve failure
282 osd_oi_table_open(struct osd_thread_info *info, struct osd_device *osd,
283 struct osd_oi **oi_table, unsigned oi_count, bool create)
285 struct scrub_file *sf = &osd->od_scrub.os_file;
291 /* NB: oi_count != 0 means that we have already created/known all OIs
292 * and have known exact number of OIs. */
293 LASSERT(oi_count <= OSD_OI_FID_NR_MAX);
295 for (i = 0; i < (oi_count != 0 ? oi_count : OSD_OI_FID_NR_MAX); i++) {
298 if (oi_table[i] != NULL) {
303 sprintf(name, "%s.%d", OSD_OI_NAME_BASE, i);
304 rc = osd_oi_open(info, osd, name, &oi_table[i], create);
310 if (rc == -ENOENT && create == false) {
315 ldiskfs_set_bit(i, sf->sf_oi_bitmap);
319 CERROR("%.16s: can't open %s: rc = %d\n",
320 LDISKFS_SB(osd_sb(osd))->s_es->s_volume_name, name, rc);
322 CERROR("%.16s: expect to open total %d OI files.\n",
323 LDISKFS_SB(osd_sb(osd))->s_es->s_volume_name,
329 osd_oi_table_put(info, oi_table, oi_count > 0 ? oi_count : i);
336 static int osd_remove_oi_one(struct dentry *parent, const char *name,
339 struct dentry *child;
342 child = ll_lookup_one_len(name, parent, namelen);
346 rc = ll_vfs_unlink(parent->d_inode, child);
350 return rc == -ENOENT ? 0 : rc;
353 static int osd_remove_ois(struct osd_thread_info *info, struct osd_device *osd)
360 for (i = 0; i < osd->od_scrub.os_file.sf_oi_count; i++) {
361 namelen = snprintf(name, sizeof(name), "%s.%d",
362 OSD_OI_NAME_BASE, i);
363 rc = osd_remove_oi_one(osd_sb(osd)->s_root, name, namelen);
365 CERROR("%.16s: fail to remove the stale OI file %s: "
367 LDISKFS_SB(osd_sb(osd))->s_es->s_volume_name,
373 namelen = snprintf(name, sizeof(name), "%s", OSD_OI_NAME_BASE);
374 rc = osd_remove_oi_one(osd_sb(osd)->s_root, name, namelen);
376 CERROR("%.16s: fail to remove the stale OI file %s: rc = %d\n",
377 LDISKFS_SB(osd_sb(osd))->s_es->s_volume_name, name, rc);
382 int osd_oi_init(struct osd_thread_info *info, struct osd_device *osd,
385 struct osd_scrub *scrub = &osd->od_scrub;
386 struct scrub_file *sf = &scrub->os_file;
392 rc = osd_remove_ois(info, osd);
397 OBD_ALLOC(oi, sizeof(*oi) * OSD_OI_FID_NR_MAX);
401 mutex_lock(&oi_init_lock);
402 /* try to open existing multiple OIs first */
403 rc = osd_oi_table_open(info, osd, oi, sf->sf_oi_count, false);
408 if (rc == sf->sf_oi_count || sf->sf_oi_count == 0)
411 osd_scrub_file_reset(scrub,
412 LDISKFS_SB(osd_sb(osd))->s_es->s_uuid,
414 osd_oi_count = sf->sf_oi_count;
418 /* if previous failed then try found single OI from old filesystem */
419 rc = osd_oi_open(info, osd, OSD_OI_NAME_BASE, &oi[0], false);
420 if (rc == 0) { /* found single OI from old filesystem */
421 ldiskfs_clear_bit(0, sf->sf_oi_bitmap);
422 if (sf->sf_success_count == 0)
423 /* XXX: There is one corner case that if the OI_scrub
424 * file crashed or lost and we regard it upgrade,
425 * then we allow IGIF lookup to bypass OI files.
427 * The risk is that osd_fid_lookup() may found
428 * a wrong inode with the given IGIF especially
429 * when the MDT has performed file-level backup
430 * and restored after former upgrading from 1.8
431 * to 2.x. Fortunately, the osd_fid_lookup()can
432 * verify the inode to decrease the risk. */
433 osd_scrub_file_reset(scrub,
434 LDISKFS_SB(osd_sb(osd))->s_es->s_uuid,
437 } else if (rc != -ENOENT) {
438 CERROR("%.16s: can't open %s: rc = %d\n",
439 LDISKFS_SB(osd_sb(osd))->s_es->s_volume_name,
440 OSD_OI_NAME_BASE, rc);
444 if (sf->sf_oi_count > 0) {
447 memset(sf->sf_oi_bitmap, 0, SCRUB_OI_BITMAP_SIZE);
448 for (i = 0; i < osd_oi_count; i++)
449 ldiskfs_set_bit(i, sf->sf_oi_bitmap);
450 osd_scrub_file_reset(scrub,
451 LDISKFS_SB(osd_sb(osd))->s_es->s_uuid,
454 sf->sf_oi_count = osd_oi_count;
457 rc = osd_scrub_file_store(scrub);
459 osd_oi_table_put(info, oi, sf->sf_oi_count);
463 /* No OIs exist, new filesystem, create OI objects */
464 rc = osd_oi_table_open(info, osd, oi, osd_oi_count, true);
465 LASSERT(ergo(rc >= 0, rc == osd_oi_count));
471 OBD_FREE(oi, sizeof(*oi) * OSD_OI_FID_NR_MAX);
473 LASSERT((rc & (rc - 1)) == 0);
474 osd->od_oi_table = oi;
475 osd->od_oi_count = rc;
476 if (sf->sf_oi_count != rc) {
477 sf->sf_oi_count = rc;
478 rc = osd_scrub_file_store(scrub);
480 osd_oi_table_put(info, oi, sf->sf_oi_count);
481 OBD_FREE(oi, sizeof(*oi) * OSD_OI_FID_NR_MAX);
488 mutex_unlock(&oi_init_lock);
492 void osd_oi_fini(struct osd_thread_info *info, struct osd_device *osd)
494 if (unlikely(osd->od_oi_table == NULL))
497 osd_oi_table_put(info, osd->od_oi_table, osd->od_oi_count);
499 OBD_FREE(osd->od_oi_table,
500 sizeof(*(osd->od_oi_table)) * OSD_OI_FID_NR_MAX);
501 osd->od_oi_table = NULL;
504 static inline int fid_is_fs_root(const struct lu_fid *fid)
506 /* Map root inode to special local object FID */
507 return (unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
508 fid_oid(fid) == OSD_FS_ROOT_OID));
511 static int osd_oi_iam_lookup(struct osd_thread_info *oti,
512 struct osd_oi *oi, struct dt_rec *rec,
513 const struct dt_key *key)
515 struct iam_container *bag;
516 struct iam_iterator *it = &oti->oti_idx_it;
517 struct iam_path_descr *ipd;
522 LASSERT(oi->oi_inode);
524 bag = &oi->oi_dir.od_container;
525 ipd = osd_idx_ipd_get(oti->oti_env, bag);
529 /* got ipd now we can start iterator. */
530 iam_it_init(it, bag, 0, ipd);
532 rc = iam_it_get(it, (struct iam_key *)key);
534 iam_reccpy(&it->ii_path.ip_leaf, (struct iam_rec *)rec);
537 osd_ipd_put(oti->oti_env, bag, ipd);
539 LINVRNT(osd_invariant(obj));
544 int fid_is_on_ost(struct osd_thread_info *info, struct osd_device *osd,
545 const struct lu_fid *fid, enum oi_check_flags flags)
547 struct lu_seq_range *range = &info->oti_seq_range;
551 if (flags & OI_KNOWN_ON_OST)
554 if (unlikely(fid_is_local_file(fid) || fid_is_igif(fid) ||
555 fid_is_llog(fid)) || fid_is_name_llog(fid) ||
559 if (fid_is_idif(fid) || fid_is_last_id(fid))
562 if (!(flags & OI_CHECK_FLD))
565 if (osd_seq_site(osd)->ss_server_fld == NULL)
568 rc = osd_fld_lookup(info->oti_env, osd, fid_seq(fid), range);
571 CERROR("%s: lookup FLD "DFID": rc = %d\n",
572 osd_name(osd), PFID(fid), rc);
576 if (fld_range_is_ost(range))
582 static int __osd_oi_lookup(struct osd_thread_info *info, struct osd_device *osd,
583 const struct lu_fid *fid, struct osd_inode_id *id)
585 struct lu_fid *oi_fid = &info->oti_fid2;
588 fid_cpu_to_be(oi_fid, fid);
589 rc = osd_oi_iam_lookup(info, osd_fid2oi(osd, fid), (struct dt_rec *)id,
590 (const struct dt_key *)oi_fid);
592 osd_id_unpack(id, id);
594 } else if (rc == 0) {
600 int osd_oi_lookup(struct osd_thread_info *info, struct osd_device *osd,
601 const struct lu_fid *fid, struct osd_inode_id *id,
602 enum oi_check_flags flags)
604 if (unlikely(fid_is_last_id(fid)))
605 return osd_obj_spec_lookup(info, osd, fid, id);
607 if (fid_is_on_ost(info, osd, fid, flags) || fid_is_llog(fid))
608 return osd_obj_map_lookup(info, osd, fid, id);
611 if (unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE)) {
613 if (fid_is_fs_root(fid)) {
614 osd_id_gen(id, osd_sb(osd)->s_root->d_inode->i_ino,
615 osd_sb(osd)->s_root->d_inode->i_generation);
618 if (unlikely(fid_is_acct(fid)))
619 return osd_acct_obj_lookup(info, osd, fid, id);
621 /* For other special FIDs, try OI first, then do spec lookup */
622 rc = __osd_oi_lookup(info, osd, fid, id);
624 return osd_obj_spec_lookup(info, osd, fid, id);
628 if (!osd->od_igif_inoi && fid_is_igif(fid)) {
629 osd_id_gen(id, lu_igif_ino(fid), lu_igif_gen(fid));
633 return __osd_oi_lookup(info, osd, fid, id);
636 static int osd_oi_iam_refresh(struct osd_thread_info *oti, struct osd_oi *oi,
637 const struct dt_rec *rec, const struct dt_key *key,
638 handle_t *th, bool insert)
640 struct iam_container *bag;
641 struct iam_path_descr *ipd;
646 LASSERT(oi->oi_inode);
647 ll_vfs_dq_init(oi->oi_inode);
649 bag = &oi->oi_dir.od_container;
650 ipd = osd_idx_ipd_get(oti->oti_env, bag);
651 if (unlikely(ipd == NULL))
655 LASSERT(th->h_transaction != NULL);
657 rc = iam_insert(th, bag, (const struct iam_key *)key,
658 (const struct iam_rec *)rec, ipd);
660 rc = iam_update(th, bag, (const struct iam_key *)key,
661 (const struct iam_rec *)rec, ipd);
662 osd_ipd_put(oti->oti_env, bag, ipd);
663 LINVRNT(osd_invariant(obj));
667 int osd_oi_insert(struct osd_thread_info *info, struct osd_device *osd,
668 const struct lu_fid *fid, const struct osd_inode_id *id,
669 handle_t *th, enum oi_check_flags flags, bool *exist)
671 struct lu_fid *oi_fid = &info->oti_fid2;
672 struct osd_inode_id *oi_id = &info->oti_id2;
675 if (unlikely(fid_is_last_id(fid)))
676 return osd_obj_spec_insert(info, osd, fid, id, th);
678 if (fid_is_on_ost(info, osd, fid, flags) || fid_is_llog(fid))
679 return osd_obj_map_insert(info, osd, fid, id, th);
681 fid_cpu_to_be(oi_fid, fid);
682 osd_id_pack(oi_id, id);
683 rc = osd_oi_iam_refresh(info, osd_fid2oi(osd, fid),
684 (const struct dt_rec *)oi_id,
685 (const struct dt_key *)oi_fid, th, true);
688 struct lustre_mdt_attrs *lma = &info->oti_mdt_attrs;
693 rc = osd_oi_lookup(info, osd, fid, oi_id, 0);
697 if (unlikely(osd_id_eq(id, oi_id)))
700 /* Check whether the mapping for oi_id is valid or not. */
701 inode = osd_iget(info, osd, oi_id);
704 if (rc == -ENOENT || rc == -ESTALE)
709 /* The EA inode should NOT be in OI, old OI scrub may added
710 * such OI mapping by wrong, replace it. */
711 if (unlikely(osd_is_ea_inode(inode))) {
716 rc = osd_get_lma(info, inode, &info->oti_obj_dentry, lma);
724 if (!(lma->lma_compat & LMAC_NOT_IN_OI) &&
725 lu_fid_eq(fid, &lma->lma_self_fid)) {
726 CERROR("%.16s: the FID "DFID" is used by two objects: "
728 LDISKFS_SB(osd_sb(osd))->s_es->s_volume_name,
729 PFID(fid), oi_id->oii_ino, oi_id->oii_gen,
730 id->oii_ino, id->oii_gen);
735 osd_id_pack(oi_id, id);
736 rc = osd_oi_iam_refresh(info, osd_fid2oi(osd, fid),
737 (const struct dt_rec *)oi_id,
738 (const struct dt_key *)oi_fid, th, false);
746 if (unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE))
747 rc = osd_obj_spec_insert(info, osd, fid, id, th);
751 static int osd_oi_iam_delete(struct osd_thread_info *oti, struct osd_oi *oi,
752 const struct dt_key *key, handle_t *th)
754 struct iam_container *bag;
755 struct iam_path_descr *ipd;
760 LASSERT(oi->oi_inode);
761 ll_vfs_dq_init(oi->oi_inode);
763 bag = &oi->oi_dir.od_container;
764 ipd = osd_idx_ipd_get(oti->oti_env, bag);
765 if (unlikely(ipd == NULL))
769 LASSERT(th->h_transaction != NULL);
771 rc = iam_delete(th, bag, (const struct iam_key *)key, ipd);
772 osd_ipd_put(oti->oti_env, bag, ipd);
773 LINVRNT(osd_invariant(obj));
777 int osd_oi_delete(struct osd_thread_info *info,
778 struct osd_device *osd, const struct lu_fid *fid,
779 handle_t *th, enum oi_check_flags flags)
781 struct lu_fid *oi_fid = &info->oti_fid2;
783 /* clear idmap cache */
784 if (lu_fid_eq(fid, &info->oti_cache.oic_fid))
785 fid_zero(&info->oti_cache.oic_fid);
787 if (fid_is_last_id(fid))
790 if (fid_is_on_ost(info, osd, fid, flags) || fid_is_llog(fid))
791 return osd_obj_map_delete(info, osd, fid, th);
793 fid_cpu_to_be(oi_fid, fid);
794 return osd_oi_iam_delete(info, osd_fid2oi(osd, fid),
795 (const struct dt_key *)oi_fid, th);
798 int osd_oi_update(struct osd_thread_info *info, struct osd_device *osd,
799 const struct lu_fid *fid, const struct osd_inode_id *id,
800 handle_t *th, enum oi_check_flags flags)
802 struct lu_fid *oi_fid = &info->oti_fid2;
803 struct osd_inode_id *oi_id = &info->oti_id2;
806 if (unlikely(fid_is_last_id(fid)))
807 return osd_obj_spec_update(info, osd, fid, id, th);
809 if (fid_is_on_ost(info, osd, fid, flags) || fid_is_llog(fid))
810 return osd_obj_map_update(info, osd, fid, id, th);
812 fid_cpu_to_be(oi_fid, fid);
813 osd_id_pack(oi_id, id);
814 rc = osd_oi_iam_refresh(info, osd_fid2oi(osd, fid),
815 (const struct dt_rec *)oi_id,
816 (const struct dt_key *)oi_fid, th, false);
820 if (unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE))
821 rc = osd_obj_spec_update(info, osd, fid, id, th);
825 int osd_oi_mod_init(void)
827 if (osd_oi_count == 0 || osd_oi_count > OSD_OI_FID_NR_MAX)
828 osd_oi_count = OSD_OI_FID_NR;
830 if ((osd_oi_count & (osd_oi_count - 1)) != 0) {
831 LCONSOLE_WARN("Round up oi_count %d to power2 %d\n",
832 osd_oi_count, size_roundup_power2(osd_oi_count));
833 osd_oi_count = size_roundup_power2(osd_oi_count);
836 mutex_init(&oi_init_lock);