1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/mdd/mdd_orphans.c
38 * Orphan handling code
40 * Author: Mike Pershin <tappro@clusterfs.com>
41 * Pravin B Shelar <pravin.shelar@sun.com>
45 # define EXPORT_SYMTAB
47 #define DEBUG_SUBSYSTEM S_MDS
50 #include <obd_class.h>
51 #include <lustre_ver.h>
52 #include <obd_support.h>
53 #include <lustre_fid.h>
54 #include "mdd_internal.h"
56 const char orph_index_name[] = "PENDING";
63 #define ORPHAN_FILE_NAME_FORMAT "%016llx:%08x:%08x:%2x"
64 #define ORPHAN_FILE_NAME_FORMAT_18 "%llx:%08x"
66 static struct dt_key* orph_key_fill(const struct lu_env *env,
67 const struct lu_fid *lf, __u32 op)
69 char *key = mdd_env_info(env)->mti_orph_key;
73 rc = snprintf(key, NAME_MAX + 1, ORPHAN_FILE_NAME_FORMAT,
74 (long long unsigned int)fid_seq(lf),
75 fid_oid(lf), fid_ver(lf), op);
77 return (struct dt_key*) key;
82 static struct dt_key* orph_key_fill_18(const struct lu_env *env,
83 const struct lu_fid *lf)
85 char *key = mdd_env_info(env)->mti_orph_key;
89 rc = snprintf(key, NAME_MAX + 1, ORPHAN_FILE_NAME_FORMAT_18,
90 (unsigned long long)fid_seq(lf), fid_oid(lf));
92 return (struct dt_key*) key;
97 static int orphan_key_to_fid(char *key, struct lu_fid *lf)
102 rc = sscanf(key, ORPHAN_FILE_NAME_FORMAT,
103 (long long unsigned int *)&lf->f_seq, &lf->f_oid,
109 rc = sscanf(key, ORPHAN_FILE_NAME_FORMAT_18,
110 (long long unsigned int *)&lf->f_seq, &lf->f_oid);
116 CERROR("can not parse orphan file name %s\n",key);
120 static inline void mdd_orphan_write_lock(const struct lu_env *env,
121 struct mdd_device *mdd)
124 struct dt_object *dor = mdd->mdd_orphans;
125 dor->do_ops->do_write_lock(env, dor, MOR_TGT_ORPHAN);
128 static inline void mdd_orphan_write_unlock(const struct lu_env *env,
129 struct mdd_device *mdd)
132 struct dt_object *dor = mdd->mdd_orphans;
133 dor->do_ops->do_write_unlock(env, dor);
136 static inline int mdd_orphan_insert_obj(const struct lu_env *env,
137 struct mdd_device *mdd,
138 struct mdd_object *obj,
142 struct dt_object *dor = mdd->mdd_orphans;
143 const struct lu_fid *lf = mdo2fid(obj);
144 struct dt_key *key = orph_key_fill(env, lf, op);
147 return dor->do_index_ops->dio_insert(env, dor,
153 static inline int mdd_orphan_delete_obj(const struct lu_env *env,
154 struct mdd_device *mdd ,
158 struct dt_object *dor = mdd->mdd_orphans;
160 return dor->do_index_ops->dio_delete(env, dor,
165 static inline void mdd_orphan_ref_add(const struct lu_env *env,
166 struct mdd_device *mdd,
169 struct dt_object *dor = mdd->mdd_orphans;
170 dor->do_ops->do_ref_add(env, dor, th);
173 static inline void mdd_orphan_ref_del(const struct lu_env *env,
174 struct mdd_device *mdd,
177 struct dt_object *dor = mdd->mdd_orphans;
178 dor->do_ops->do_ref_del(env, dor, th);
182 static int orph_index_insert(const struct lu_env *env,
183 struct mdd_object *obj,
187 struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
188 struct dt_object *dor = mdd->mdd_orphans;
189 const struct lu_fid *lf_dor = lu_object_fid(&dor->do_lu);
190 struct dt_object *next = mdd_object_child(obj);
191 const struct dt_key *dotdot = (const struct dt_key *) "..";
195 LASSERT(mdd_write_locked(env, obj) != 0);
196 LASSERT(!(obj->mod_flags & ORPHAN_OBJ));
197 LASSERT(obj->mod_count > 0);
199 mdd_orphan_write_lock(env, mdd);
201 rc = mdd_orphan_insert_obj(env, mdd, obj, op, th);
205 mdo_ref_add(env, obj, th);
206 if (!S_ISDIR(mdd_object_type(obj)))
209 mdo_ref_add(env, obj, th);
210 mdd_orphan_ref_add(env, mdd, th);
212 /* try best to fixup directory, dont return errors
214 if (!dt_try_as_dir(env, next))
216 next->do_index_ops->dio_delete(env, next,
217 dotdot, th, BYPASS_CAPA);
219 next->do_index_ops->dio_insert(env, next,
220 (struct dt_rec *) lf_dor,
221 dotdot, th, BYPASS_CAPA, 1);
225 obj->mod_flags |= ORPHAN_OBJ;
227 mdd_orphan_write_unlock(env, mdd);
233 * destroy osd object on mdd and associated ost objects.
235 * \param obj orphan object
236 * \param mdd used for sending llog msg to osts
241 static int orphan_object_kill(const struct lu_env *env,
242 struct mdd_object *obj,
243 struct mdd_device *mdd,
246 struct lu_attr *la = &mdd_env_info(env)->mti_la;
250 /* No need to lock this object as its recovery phase, and
251 * no other thread can access it. But we need to lock it
252 * as its precondition for osd api we using. */
254 mdo_ref_del(env, obj, th);
255 if (S_ISDIR(mdd_object_type(obj))) {
256 mdo_ref_del(env, obj, th);
257 mdd_orphan_ref_del(env, mdd, th);
259 /* regular file , cleanup linked ost objects */
260 rc = mdd_la_get(env, obj, la, BYPASS_CAPA);
262 rc = mdd_lov_destroy(env, mdd, obj, la);
267 static int orph_index_delete(const struct lu_env *env,
268 struct mdd_object *obj,
272 struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
273 struct dt_object *dor = mdd->mdd_orphans;
279 LASSERT(mdd_write_locked(env, obj) != 0);
280 LASSERT(obj->mod_flags & ORPHAN_OBJ);
281 LASSERT(obj->mod_count == 0);
285 key = orph_key_fill(env, mdo2fid(obj), op);
286 mdd_orphan_write_lock(env, mdd);
288 rc = mdd_orphan_delete_obj(env, mdd, key, th);
291 key = orph_key_fill_18(env, mdo2fid(obj));
292 rc = mdd_orphan_delete_obj(env, mdd, key, th);
296 /* lov objects will be destroyed by caller */
297 mdo_ref_del(env, obj, th);
298 if (S_ISDIR(mdd_object_type(obj))) {
299 mdo_ref_del(env, obj, th);
300 mdd_orphan_ref_del(env, mdd, th);
302 obj->mod_flags &= ~ORPHAN_OBJ;
304 CERROR("could not delete object: rc = %d\n",rc);
307 mdd_orphan_write_unlock(env, mdd);
312 static int orphan_object_destroy(const struct lu_env *env,
313 struct mdd_object *obj,
316 struct thandle *th = NULL;
317 struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
321 mdd_txn_param_build(env, mdd, MDD_TXN_UNLINK_OP);
322 th = mdd_trans_start(env, mdd);
324 CERROR("Cannot get thandle\n");
328 mdd_write_lock(env, obj, MOR_TGT_CHILD);
329 if (likely(obj->mod_count == 0)) {
330 mdd_orphan_write_lock(env, mdd);
331 rc = mdd_orphan_delete_obj(env, mdd, key, th);
333 orphan_object_kill(env, obj, mdd, th);
335 CERROR("could not delete object: rc = %d\n",rc);
336 mdd_orphan_write_unlock(env, mdd);
338 mdd_write_unlock(env, obj);
339 mdd_trans_stop(env, mdd, 0, th);
344 static int orph_key_test_and_del(const struct lu_env *env,
345 struct mdd_device *mdd,
349 struct mdd_object *mdo;
352 mdo = mdd_object_find(env, mdd, lf);
358 if (mdo->mod_count == 0) {
359 CWARN("Found orphan! Delete it\n");
360 rc = orphan_object_destroy(env, mdo, key);
362 mdd_write_lock(env, mdo, MOR_TGT_CHILD);
363 if (likely(mdo->mod_count > 0)) {
364 CDEBUG(D_HA, "Found orphan, open count = %d\n",
366 mdo->mod_flags |= ORPHAN_OBJ;
368 mdd_write_unlock(env, mdo);
371 mdd_object_put(env, mdo);
375 static int orph_index_iterate(const struct lu_env *env,
376 struct mdd_device *mdd)
378 struct dt_object *dor = mdd->mdd_orphans;
379 char *mti_key = mdd_env_info(env)->mti_orph_key;
380 const struct dt_it_ops *iops;
390 /* In recovery phase, do not need for any lock here */
392 iops = &dor->do_index_ops->dio_it;
393 it = iops->init(env, dor, BYPASS_CAPA);
395 result = iops->load(env, it, 0);
400 key = (void *)iops->key(env, it);
402 CERROR("key failed when clean pending.\n");
405 key_sz = iops->key_size(env, it);
407 /* filter out "." and ".." entries from
412 memcpy(mti_key, key, key_sz);
415 if (orphan_key_to_fid(mti_key, &fid))
417 if (!fid_is_sane(&fid)) {
418 CERROR("fid is not sane when clean pending.\n");
422 /* kill orphan object */
423 cookie = iops->store(env, it);
425 rc = orph_key_test_and_del(env, mdd, &fid,
426 (struct dt_key *)mti_key);
428 /* after index delete reset iterator */
430 result = iops->get(env, it,
433 result = iops->load(env, it, cookie);
435 result = iops->next(env, it);
436 } while (result == 0);
438 } else if (result == 0) {
439 CERROR("Input/Output for clean pending.\n");
440 /* Index contains no zero key? */
446 CERROR("not enough memory for clean pending.\n");
453 int orph_index_init(const struct lu_env *env, struct mdd_device *mdd)
460 d = dt_store_open(env, mdd->mdd_child, "", orph_index_name, &fid);
462 mdd->mdd_orphans = d;
463 if (!dt_try_as_dir(env, d)) {
465 CERROR("\"%s\" is not an index! : rc = %d\n",
466 orph_index_name, rc);
469 CERROR("cannot find \"%s\" obj %d\n",
470 orph_index_name, (int)PTR_ERR(d));
477 void orph_index_fini(const struct lu_env *env, struct mdd_device *mdd)
480 if (mdd->mdd_orphans != NULL) {
481 lu_object_put(env, &mdd->mdd_orphans->do_lu);
482 mdd->mdd_orphans = NULL;
488 * Iterate orphan index to cleanup orphan objects in case of recovery.
489 * \param d mdd device in recovery.
493 int __mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d)
495 return orph_index_iterate(env, d);
499 * delete an orphan \a obj from orphan index.
500 * \param obj file or directory.
501 * \param th transaction for index insert.
503 * \pre obj nlink == 0 && obj->mod_count != 0
506 * \retval -ve index operation error.
509 int __mdd_orphan_add(const struct lu_env *env,
510 struct mdd_object *obj, struct thandle *th)
512 return orph_index_insert(env, obj, ORPH_OP_UNLINK, th);
516 * delete an orphan \a obj from orphan index.
517 * \param obj file or directory.
518 * \param th transaction for index deletion and object destruction.
520 * \pre obj->mod_count == 0 && ORPHAN_OBJ is set for obj.
523 * \retval -ve index operation error.
526 int __mdd_orphan_del(const struct lu_env *env,
527 struct mdd_object *obj, struct thandle *th)
529 return orph_index_delete(env, obj, ORPH_OP_UNLINK, th);