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.
30 * Copyright (c) 2012, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/osd-zfs/osd_oi.c
37 * OI functions to map fid to dnode
39 * Author: Alex Zhuravlev <bzzz@whamcloud.com>
40 * Author: Mike Pershin <tappro@whamcloud.com>
41 * Author: Di Wang <di.wang@intel.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 #define OSD_OI_FID_NR (1UL << 7)
71 #define OSD_OI_FID_NR_MAX (1UL << OSD_OI_FID_OID_BITS_MAX)
72 unsigned int osd_oi_count = OSD_OI_FID_NR;
76 * zfs osd maintains names for known fids in the name hierarchy
77 * so that one can mount filesystem with regular ZFS stack and
85 static const struct named_oid oids[] = {
86 { LAST_RECV_OID, LAST_RCVD },
87 { OFD_LAST_GROUP_OID, "LAST_GROUP" },
88 { LLOG_CATALOGS_OID, "CATALOGS" },
89 { MGS_CONFIGS_OID, NULL /*MOUNT_CONFIGS_DIR*/ },
90 { FID_SEQ_SRV_OID, "seq_srv" },
91 { FID_SEQ_CTL_OID, "seq_ctl" },
92 { FLD_INDEX_OID, "fld" },
93 { MDD_LOV_OBJ_OID, LOV_OBJID },
94 { OFD_HEALTH_CHECK_OID, HEALTH_CHECK },
95 { ACCT_USER_OID, "acct_usr_inode" },
96 { ACCT_GROUP_OID, "acct_grp_inode" },
97 { REPLY_DATA_OID, REPLY_DATA },
101 static char *oid2name(const unsigned long oid)
105 while (oids[i].oid) {
106 if (oids[i].oid == oid)
114 * Lookup an existing OI by the given name.
117 osd_oi_lookup(const struct lu_env *env, struct osd_device *o,
118 uint64_t parent, const char *name, struct osd_oi *oi)
120 struct zpl_direntry *zde = &osd_oti_get(env)->oti_zde.lzd_reg;
123 rc = -zap_lookup(o->od_os, parent, name, 8, 1, (void *)zde);
127 rc = strlcpy(oi->oi_name, name, sizeof(oi->oi_name));
128 if (rc >= sizeof(oi->oi_name))
132 oi->oi_zapid = zde->zde_dnode;
138 * Create a new OI with the given name.
141 osd_oi_create(const struct lu_env *env, struct osd_device *o,
142 uint64_t parent, const char *name, uint64_t *child)
144 struct zpl_direntry *zde = &osd_oti_get(env)->oti_zde.lzd_reg;
145 struct lu_attr *la = &osd_oti_get(env)->oti_la;
150 /* verify it doesn't already exist */
151 rc = -zap_lookup(o->od_os, parent, name, 8, 1, (void *)zde);
155 /* create fid-to-dnode index */
156 tx = dmu_tx_create(o->od_os);
160 dmu_tx_hold_zap(tx, DMU_NEW_OBJECT, 1, NULL);
161 dmu_tx_hold_bonus(tx, parent);
162 dmu_tx_hold_zap(tx, parent, TRUE, name);
163 LASSERT(tx->tx_objset->os_sa);
164 dmu_tx_hold_sa_create(tx, ZFS_SA_BASE_ATTR_SIZE);
166 rc = -dmu_tx_assign(tx, TXG_WAIT);
172 la->la_valid = LA_MODE | LA_UID | LA_GID;
173 la->la_mode = S_IFDIR | S_IRUGO | S_IWUSR | S_IXUGO;
174 la->la_uid = la->la_gid = 0;
175 __osd_zap_create(env, o, &db, tx, la, parent, 0);
177 zde->zde_dnode = db->db_object;
179 zde->zde_type = IFTODT(S_IFDIR);
181 rc = -zap_add(o->od_os, parent, name, 8, 1, (void *)zde, tx);
185 *child = db->db_object;
186 sa_buf_rele(db, osd_obj_tag);
192 osd_oi_find_or_create(const struct lu_env *env, struct osd_device *o,
193 uint64_t parent, const char *name, uint64_t *child)
198 rc = osd_oi_lookup(env, o, parent, name, &oi);
200 *child = oi.oi_zapid;
201 else if (rc == -ENOENT)
202 rc = osd_oi_create(env, o, parent, name, child);
208 * Lookup the target index/flags of the fid, so it will know where
209 * the object is located (tgt index) and it is MDT or OST object.
211 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
212 u64 seq, struct lu_seq_range *range)
214 struct seq_server_site *ss = osd_seq_site(osd);
216 if (fid_seq_is_idif(seq)) {
217 fld_range_set_ost(range);
218 range->lsr_index = idif_ost_idx(seq);
222 if (!fid_seq_in_fldb(seq)) {
223 fld_range_set_mdt(range);
225 /* FIXME: If ss is NULL, it suppose not get lsr_index
227 range->lsr_index = ss->ss_node_id;
232 fld_range_set_any(range);
233 /* OSD will only do local fld lookup */
234 return fld_local_lookup(env, ss->ss_server_fld, seq, range);
237 int fid_is_on_ost(const struct lu_env *env, struct osd_device *osd,
238 const struct lu_fid *fid)
240 struct lu_seq_range *range = &osd_oti_get(env)->oti_seq_range;
244 if (fid_is_idif(fid))
247 if (unlikely(fid_is_local_file(fid) || fid_is_llog(fid)) ||
248 fid_is_name_llog(fid) || fid_is_quota(fid))
251 rc = osd_fld_lookup(env, osd, fid_seq(fid), range);
254 CERROR("%s: "DFID" lookup failed: rc = %d\n",
255 osd_name(osd), PFID(fid), rc);
259 if (fld_range_is_ost(range))
265 static struct osd_seq *osd_seq_find_locked(struct osd_seq_list *seq_list,
268 struct osd_seq *osd_seq;
270 list_for_each_entry(osd_seq, &seq_list->osl_seq_list, os_seq_list) {
271 if (osd_seq->os_seq == seq)
277 static struct osd_seq *osd_seq_find(struct osd_seq_list *seq_list, u64 seq)
279 struct osd_seq *osd_seq;
281 read_lock(&seq_list->osl_seq_list_lock);
282 osd_seq = osd_seq_find_locked(seq_list, seq);
283 read_unlock(&seq_list->osl_seq_list_lock);
288 static struct osd_seq *osd_find_or_add_seq(const struct lu_env *env,
289 struct osd_device *osd, u64 seq)
291 struct osd_seq_list *seq_list = &osd->od_seq_list;
292 struct osd_seq *osd_seq;
293 char *key = osd_oti_get(env)->oti_buf;
294 char *seq_name = osd_oti_get(env)->oti_str;
301 osd_seq = osd_seq_find(seq_list, seq);
305 down(&seq_list->osl_seq_init_sem);
306 /* Check again, in case some one else already add it
308 osd_seq = osd_seq_find(seq_list, seq);
312 OBD_ALLOC_PTR(osd_seq);
314 GOTO(out, rc = -ENOMEM);
316 INIT_LIST_HEAD(&osd_seq->os_seq_list);
317 osd_seq->os_seq = seq;
319 /* Init subdir count to be 32, but each seq can have
320 * different subdir count */
321 osd_seq->os_subdir_count = OSD_OST_MAP_SIZE;
322 OBD_ALLOC(osd_seq->os_compat_dirs,
323 sizeof(uint64_t) * osd_seq->os_subdir_count);
324 if (osd_seq->os_compat_dirs == NULL)
325 GOTO(out, rc = -ENOMEM);
327 oi.oi_zapid = osd->od_O_id;
328 sprintf(seq_name, (fid_seq_is_rsvd(seq) ||
329 fid_seq_is_mdt0(seq)) ? LPU64 : LPX64i,
330 fid_seq_is_idif(seq) ? 0 : seq);
332 rc = osd_oi_find_or_create(env, osd, oi.oi_zapid, seq_name, &odb);
334 CERROR("%s: Can not create %s : rc = %d\n",
335 osd_name(osd), seq_name, rc);
339 for (i = 0; i < OSD_OST_MAP_SIZE; i++) {
340 sprintf(key, "d%d", i);
341 rc = osd_oi_find_or_create(env, osd, odb, key, &sdb);
344 osd_seq->os_compat_dirs[i] = sdb;
347 write_lock(&seq_list->osl_seq_list_lock);
348 list_add(&osd_seq->os_seq_list, &seq_list->osl_seq_list);
349 write_unlock(&seq_list->osl_seq_list_lock);
351 up(&seq_list->osl_seq_init_sem);
353 if (osd_seq != NULL && osd_seq->os_compat_dirs != NULL)
354 OBD_FREE(osd_seq->os_compat_dirs,
355 sizeof(uint64_t) * osd_seq->os_subdir_count);
357 OBD_FREE_PTR(osd_seq);
358 osd_seq = ERR_PTR(rc);
364 * objects w/o a natural reference (unlike a file on a MDS)
365 * are put under a special hierarchy /O/<seq>/d0..dXX
366 * this function returns a directory specific fid belongs to
369 osd_get_idx_for_ost_obj(const struct lu_env *env, struct osd_device *osd,
370 const struct lu_fid *fid, char *buf)
372 struct osd_seq *osd_seq;
377 osd_seq = osd_find_or_add_seq(env, osd, fid_seq(fid));
378 if (IS_ERR(osd_seq)) {
379 CERROR("%s: Can not find seq group "DFID"\n", osd_name(osd),
381 return PTR_ERR(osd_seq);
384 if (fid_is_last_id(fid)) {
387 rc = fid_to_ostid(fid, &osd_oti_get(env)->oti_ostid);
388 LASSERT(rc == 0); /* we should not get here with IGIF */
389 id = ostid_id(&osd_oti_get(env)->oti_ostid);
392 b = id % OSD_OST_MAP_SIZE;
393 LASSERT(osd_seq->os_compat_dirs[b]);
395 sprintf(buf, LPU64, id);
397 return osd_seq->os_compat_dirs[b];
400 /* XXX: f_ver is not counted, but may differ too */
401 static void osd_fid2str(char *buf, const struct lu_fid *fid)
403 sprintf(buf, DFID_NOBRACE, PFID(fid));
407 * Determine the zap object id which is being used as the OI for the
408 * given fid. The lowest N bits in the sequence ID are used as the
409 * index key. On failure 0 is returned which zfs treats internally
410 * as an invalid object id.
413 osd_get_idx_for_fid(struct osd_device *osd, const struct lu_fid *fid,
418 LASSERT(osd->od_oi_table != NULL);
419 oi = osd->od_oi_table[fid_seq(fid) & (osd->od_oi_count - 1)];
420 osd_fid2str(buf, fid);
425 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
426 const struct lu_fid *fid, char *buf)
433 if (fid_is_on_ost(env, osd, fid) == 1 || fid_seq(fid) == FID_SEQ_ECHO) {
434 zapid = osd_get_idx_for_ost_obj(env, osd, fid, buf);
435 } else if (unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE)) {
436 /* special objects with fixed known fids get their name */
437 char *name = oid2name(fid_oid(fid));
440 zapid = osd->od_root;
442 if (fid_is_acct(fid))
443 zapid = MASTER_NODE_OBJ;
445 zapid = osd_get_idx_for_fid(osd, fid, buf);
448 zapid = osd_get_idx_for_fid(osd, fid, buf);
454 static inline int fid_is_fs_root(const struct lu_fid *fid)
456 /* Map root inode to special local object FID */
457 return fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
458 fid_oid(fid) == OSD_FS_ROOT_OID;
461 int osd_fid_lookup(const struct lu_env *env, struct osd_device *dev,
462 const struct lu_fid *fid, uint64_t *oid)
464 struct osd_thread_info *info = osd_oti_get(env);
465 char *buf = info->oti_buf;
470 if (OBD_FAIL_CHECK(OBD_FAIL_SRV_ENOENT))
473 if (unlikely(fid_is_acct(fid))) {
474 if (fid_oid(fid) == ACCT_USER_OID)
475 *oid = dev->od_iusr_oid;
477 *oid = dev->od_igrp_oid;
478 } else if (unlikely(fid_is_fs_root(fid))) {
481 zapid = osd_get_name_n_idx(env, dev, fid, buf);
483 rc = -zap_lookup(dev->od_os, zapid, buf,
484 8, 1, &info->oti_zde);
487 *oid = info->oti_zde.lzd_reg.zde_dnode;
491 dmu_prefetch(dev->od_os, *oid, 0, 0);
497 * Close an entry in a specific slot.
500 osd_oi_remove_table(const struct lu_env *env, struct osd_device *o, int key)
504 LASSERT(key < o->od_oi_count);
506 oi = o->od_oi_table[key];
509 o->od_oi_table[key] = NULL;
514 * Allocate and open a new entry in the specified unused slot.
517 osd_oi_add_table(const struct lu_env *env, struct osd_device *o,
523 LASSERT(key < o->od_oi_count);
524 LASSERT(o->od_oi_table[key] == NULL);
530 rc = osd_oi_lookup(env, o, o->od_root, name, oi);
536 o->od_oi_table[key] = oi;
542 * Depopulate the OI table.
545 osd_oi_close_table(const struct lu_env *env, struct osd_device *o)
549 for (i = 0; i < o->od_oi_count; i++)
550 osd_oi_remove_table(env, o, i);
554 * Populate the OI table based.
557 osd_oi_open_table(const struct lu_env *env, struct osd_device *o, int count)
563 for (i = 0; i < count; i++) {
564 sprintf(name, "%s.%d", DMU_OSD_OI_NAME_BASE, i);
565 rc = osd_oi_add_table(env, o, name, i);
567 osd_oi_close_table(env, o);
576 * Determine if the type and number of OIs used by this file system.
579 osd_oi_probe(const struct lu_env *env, struct osd_device *o, int *count)
581 uint64_t root_oid = o->od_root;
588 * Check for multiple OIs and determine the count. There is no
589 * gap handling, if an OI is missing the wrong size can be returned.
590 * The only safeguard is that we know the number of OIs must be a
591 * power of two and this is checked for basic sanity.
593 for (*count = 0; *count < OSD_OI_FID_NR_MAX; (*count)++) {
594 sprintf(name, "%s.%d", DMU_OSD_OI_NAME_BASE, *count);
595 rc = osd_oi_lookup(env, o, root_oid, name, &oi);
603 if ((*count & (*count - 1)) != 0)
613 * No OIs exist, this must be a new filesystem.
620 static void osd_ost_seq_init(const struct lu_env *env, struct osd_device *osd)
622 struct osd_seq_list *osl = &osd->od_seq_list;
624 INIT_LIST_HEAD(&osl->osl_seq_list);
625 rwlock_init(&osl->osl_seq_list_lock);
626 sema_init(&osl->osl_seq_init_sem, 1);
629 static void osd_ost_seq_fini(const struct lu_env *env, struct osd_device *osd)
631 struct osd_seq_list *osl = &osd->od_seq_list;
632 struct osd_seq *osd_seq, *tmp;
634 write_lock(&osl->osl_seq_list_lock);
635 list_for_each_entry_safe(osd_seq, tmp, &osl->osl_seq_list,
637 list_del(&osd_seq->os_seq_list);
638 OBD_FREE(osd_seq->os_compat_dirs,
639 sizeof(uint64_t) * osd_seq->os_subdir_count);
640 OBD_FREE(osd_seq, sizeof(*osd_seq));
642 write_unlock(&osl->osl_seq_list_lock);
648 * Create /O subdirectory to map legacy OST objects for compatibility.
651 osd_oi_init_compat(const struct lu_env *env, struct osd_device *o)
657 rc = osd_oi_find_or_create(env, o, o->od_root, "O", &sdb);
663 osd_ost_seq_init(env, o);
664 /* Create on-disk indexes to maintain per-UID/GID inode usage.
665 * Those new indexes are created in the top-level ZAP outside the
666 * namespace in order not to confuse ZPL which might interpret those
667 * indexes as directories and assume the values are object IDs */
668 rc = osd_oi_find_or_create(env, o, MASTER_NODE_OBJ,
669 oid2name(ACCT_USER_OID), &odb);
672 o->od_iusr_oid = odb;
674 rc = osd_oi_find_or_create(env, o, MASTER_NODE_OBJ,
675 oid2name(ACCT_GROUP_OID), &odb);
678 o->od_igrp_oid = odb;
684 * Initialize the OIs by either opening or creating them as needed.
686 int osd_oi_init(const struct lu_env *env, struct osd_device *o)
688 char *key = osd_oti_get(env)->oti_buf;
689 int i, rc, count = 0;
692 rc = osd_oi_probe(env, o, &count);
699 count = osd_oi_count;
702 for (i = 0; i < count; i++) {
703 sprintf(key, "%s.%d", DMU_OSD_OI_NAME_BASE, i);
704 rc = osd_oi_find_or_create(env, o, odb, key, &sdb);
710 rc = osd_oi_init_compat(env, o);
714 LASSERT((count & (count - 1)) == 0);
715 o->od_oi_count = count;
716 OBD_ALLOC(o->od_oi_table, sizeof(struct osd_oi *) * count);
717 if (o->od_oi_table == NULL)
720 rc = osd_oi_open_table(env, o, count);
722 OBD_FREE(o->od_oi_table, sizeof(struct osd_oi *) * count);
723 o->od_oi_table = NULL;
729 void osd_oi_fini(const struct lu_env *env, struct osd_device *o)
733 osd_ost_seq_fini(env, o);
735 if (o->od_oi_table != NULL) {
736 (void) osd_oi_close_table(env, o);
737 OBD_FREE(o->od_oi_table,
738 sizeof(struct osd_oi *) * o->od_oi_count);
739 o->od_oi_table = NULL;
746 int osd_options_init(void)
748 /* osd_oi_count - Default number of OIs, 128 works well for ZFS */
749 if (osd_oi_count == 0 || osd_oi_count > OSD_OI_FID_NR_MAX)
750 osd_oi_count = OSD_OI_FID_NR;
752 if ((osd_oi_count & (osd_oi_count - 1)) != 0) {
753 LCONSOLE_WARN("Round up osd_oi_count %d to power2 %d\n",
754 osd_oi_count, size_roundup_power2(osd_oi_count));
755 osd_oi_count = size_roundup_power2(osd_oi_count);