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) 2003, 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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/obdclass/llog_cat.c
34 * OST<->MDS recovery logging infrastructure.
36 * Invariants in implementation:
37 * - we do not share logs among different OST<->MDS connections, so that
38 * if an OST or MDS fails it need only look at log(s) relevant to itself
40 * Author: Andreas Dilger <adilger@clusterfs.com>
41 * Author: Alexey Zhuravlev <alexey.zhuravlev@intel.com>
42 * Author: Mikhail Pershin <mike.pershin@intel.com>
45 #define DEBUG_SUBSYSTEM S_LOG
48 #include <obd_class.h>
50 #include "llog_internal.h"
54 * lockdep markers for nested struct llog_handle::lgh_lock locking.
61 /* Create a new log handle and add it to the open list.
62 * This log handle will be closed when all of the records in it are removed.
64 * Assumes caller has already pushed us into the kernel context and is locking.
66 static int llog_cat_new_log(const struct lu_env *env,
67 struct llog_handle *cathandle,
68 struct llog_handle *loghandle,
71 struct llog_thread_info *lgi = llog_info(env);
72 struct llog_logid_rec *rec = &lgi->lgi_logid;
73 struct thandle *handle = NULL;
74 struct dt_device *dt = NULL;
75 struct llog_log_hdr *llh = cathandle->lgh_hdr;
80 index = (cathandle->lgh_last_idx + 1) %
81 (OBD_FAIL_PRECHECK(OBD_FAIL_CAT_RECORDS) ? (cfs_fail_val + 1) :
82 LLOG_HDR_BITMAP_SIZE(llh));
84 /* check that new llog index will not overlap with the first one.
85 * - llh_cat_idx is the index just before the first/oldest still in-use
87 * - lgh_last_idx is the last/newest used index in catalog
89 * When catalog is not wrapped yet then lgh_last_idx is always larger
90 * than llh_cat_idx. After the wrap around lgh_last_idx re-starts
91 * from 0 and llh_cat_idx becomes the upper limit for it
93 * Check if catalog has already wrapped around or not by comparing
94 * last_idx and cat_idx */
95 if ((index == llh->llh_cat_idx + 1 && llh->llh_count > 1) ||
96 (index == 0 && llh->llh_cat_idx == 0)) {
97 if (cathandle->lgh_name == NULL) {
98 CWARN("%s: there are no more free slots in catalog "
100 loghandle->lgh_ctxt->loc_obd->obd_name,
101 PFID(&cathandle->lgh_id.lgl_oi.oi_fid),
102 cathandle->lgh_id.lgl_ogen);
104 CWARN("%s: there are no more free slots in "
106 loghandle->lgh_ctxt->loc_obd->obd_name,
107 cathandle->lgh_name);
112 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED))
115 if (loghandle->lgh_hdr != NULL) {
116 /* If llog object is remote and creation is failed, lgh_hdr
117 * might be left over here, free it first */
118 LASSERT(!llog_exist(loghandle));
119 OBD_FREE_LARGE(loghandle->lgh_hdr, loghandle->lgh_hdr_size);
120 loghandle->lgh_hdr = NULL;
124 dt = lu2dt_dev(cathandle->lgh_obj->do_lu.lo_dev);
126 handle = dt_trans_create(env, dt);
128 RETURN(PTR_ERR(handle));
130 /* Create update llog object synchronously, which
131 * happens during inialization process see
132 * lod_sub_prep_llog(), to make sure the update
133 * llog object is created before corss-MDT writing
134 * updates into the llog object */
135 if (cathandle->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID)
138 handle->th_wait_submit = 1;
140 rc = llog_declare_create(env, loghandle, handle);
144 rec->lid_hdr.lrh_len = sizeof(*rec);
145 rec->lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
146 rec->lid_id = loghandle->lgh_id;
147 rc = llog_declare_write_rec(env, cathandle, &rec->lid_hdr, -1,
152 rc = dt_trans_start_local(env, dt, handle);
159 rc = llog_create(env, loghandle, th);
160 /* if llog is already created, no need to initialize it */
163 } else if (rc != 0) {
164 CERROR("%s: can't create new plain llog in catalog: rc = %d\n",
165 loghandle->lgh_ctxt->loc_obd->obd_name, rc);
169 rc = llog_init_handle(env, loghandle,
170 LLOG_F_IS_PLAIN | LLOG_F_ZAP_WHEN_EMPTY,
171 &cathandle->lgh_hdr->llh_tgtuuid);
175 /* build the record for this log in the catalog */
176 rec->lid_hdr.lrh_len = sizeof(*rec);
177 rec->lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
178 rec->lid_id = loghandle->lgh_id;
180 /* append the new record into catalog. The new index will be
181 * assigned to the record and updated in rec header */
182 rc = llog_write_rec(env, cathandle, &rec->lid_hdr,
183 &loghandle->u.phd.phd_cookie, LLOG_NEXT_IDX, th);
185 GOTO(out_destroy, rc);
187 CDEBUG(D_OTHER, "new plain log "DFID".%u of catalog "DFID"\n",
188 PFID(&loghandle->lgh_id.lgl_oi.oi_fid), rec->lid_hdr.lrh_index,
189 PFID(&cathandle->lgh_id.lgl_oi.oi_fid));
191 loghandle->lgh_hdr->llh_cat_idx = rec->lid_hdr.lrh_index;
193 /* limit max size of plain llog so that space can be
194 * released sooner, especially on small filesystems */
195 /* 2MB for the cases when free space hasn't been learned yet */
196 loghandle->lgh_max_size = 2 << 20;
197 dt = lu2dt_dev(cathandle->lgh_obj->do_lu.lo_dev);
198 rc = dt_statfs(env, dt, &lgi->lgi_statfs, NULL);
199 if (rc == 0 && lgi->lgi_statfs.os_bfree > 0) {
200 __u64 freespace = (lgi->lgi_statfs.os_bfree *
201 lgi->lgi_statfs.os_bsize) >> 6;
202 if (freespace < loghandle->lgh_max_size)
203 loghandle->lgh_max_size = freespace;
204 /* shouldn't be > 128MB in any case?
205 * it's 256K records of 512 bytes each */
206 if (freespace > (128 << 20))
207 loghandle->lgh_max_size = 128 << 20;
212 if (handle != NULL) {
213 handle->th_result = rc >= 0 ? 0 : rc;
214 dt_trans_stop(env, dt, handle);
219 /* to signal llog_cat_close() it shouldn't try to destroy the llog,
220 * we want to destroy it in this transaction, otherwise the object
221 * becomes an orphan */
222 loghandle->lgh_hdr->llh_flags &= ~LLOG_F_ZAP_WHEN_EMPTY;
223 /* this is to mimic full log, so another llog_cat_current_log()
224 * can skip it and ask for another onet */
225 loghandle->lgh_last_idx = LLOG_HDR_BITMAP_SIZE(loghandle->lgh_hdr) + 1;
226 llog_trans_destroy(env, loghandle, th);
228 dt_trans_stop(env, dt, handle);
232 static int llog_cat_refresh(const struct lu_env *env,
233 struct llog_handle *cathandle)
235 struct llog_handle *loghandle;
238 down_write(&cathandle->lgh_lock);
239 list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
241 if (!llog_exist(loghandle))
244 rc = llog_read_header(env, loghandle, NULL);
249 rc = llog_read_header(env, cathandle, NULL);
251 up_write(&loghandle->lgh_lock);
257 * prepare current/next log for catalog.
259 * if \a *ploghandle is NULL, open it, and declare create, NB, if \a
260 * *ploghandle is remote, create it synchronously here, see comments
263 * \a cathandle->lgh_lock is down_read-ed, it gets down_write-ed if \a
264 * *ploghandle has to be opened.
266 static int llog_cat_prep_log(const struct lu_env *env,
267 struct llog_handle *cathandle,
268 struct llog_handle **ploghandle,
277 if (IS_ERR_OR_NULL(*ploghandle)) {
278 up_read(&cathandle->lgh_lock);
279 down_write(&cathandle->lgh_lock);
281 if (IS_ERR_OR_NULL(*ploghandle)) {
282 struct llog_handle *loghandle;
284 rc = llog_open(env, cathandle->lgh_ctxt, &loghandle,
285 NULL, NULL, LLOG_OPEN_NEW);
287 *ploghandle = loghandle;
288 list_add_tail(&loghandle->u.phd.phd_entry,
289 &cathandle->u.chd.chd_head);
296 rc = llog_exist(*ploghandle);
302 if (dt_object_remote(cathandle->lgh_obj)) {
303 down_write_nested(&(*ploghandle)->lgh_lock, LLOGH_LOG);
304 if (!llog_exist(*ploghandle)) {
305 /* For remote operation, if we put the llog object
306 * creation in the current transaction, then the
307 * llog object will not be created on the remote
308 * target until the transaction stop, if other
309 * operations start before the transaction stop,
310 * and use the same llog object, will be dependent
311 * on the success of this transaction. So let's
312 * create the llog object synchronously here to
313 * remove the dependency. */
314 rc = llog_cat_new_log(env, cathandle, *ploghandle,
317 up_write(&(*ploghandle)->lgh_lock);
319 up_write(&cathandle->lgh_lock);
321 up_read(&cathandle->lgh_lock);
323 rc = llog_cat_refresh(env, cathandle);
324 down_read_nested(&cathandle->lgh_lock,
328 /* *ploghandle might become NULL, restart */
332 up_write(&(*ploghandle)->lgh_lock);
334 struct llog_thread_info *lgi = llog_info(env);
335 struct llog_logid_rec *lirec = &lgi->lgi_logid;
337 rc = llog_declare_create(env, *ploghandle, th);
341 lirec->lid_hdr.lrh_len = sizeof(*lirec);
342 rc = llog_declare_write_rec(env, cathandle, &lirec->lid_hdr, -1,
348 up_write(&cathandle->lgh_lock);
349 down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
356 /* Open an existent log handle and add it to the open list.
357 * This log handle will be closed when all of the records in it are removed.
359 * Assumes caller has already pushed us into the kernel context and is locking.
360 * We return a lock on the handle to ensure nobody yanks it from us.
362 * This takes extra reference on llog_handle via llog_handle_get() and require
363 * this reference to be put by caller using llog_handle_put()
365 int llog_cat_id2handle(const struct lu_env *env, struct llog_handle *cathandle,
366 struct llog_handle **res, struct llog_logid *logid)
368 struct llog_handle *loghandle;
374 if (cathandle == NULL)
377 fmt = cathandle->lgh_hdr->llh_flags & LLOG_F_EXT_MASK;
378 down_write(&cathandle->lgh_lock);
379 list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
381 struct llog_logid *cgl = &loghandle->lgh_id;
383 if (ostid_id(&cgl->lgl_oi) == ostid_id(&logid->lgl_oi) &&
384 ostid_seq(&cgl->lgl_oi) == ostid_seq(&logid->lgl_oi)) {
385 if (cgl->lgl_ogen != logid->lgl_ogen) {
386 CWARN("%s: log "DFID" generation %x != %x\n",
387 loghandle->lgh_ctxt->loc_obd->obd_name,
388 PFID(&logid->lgl_oi.oi_fid),
389 cgl->lgl_ogen, logid->lgl_ogen);
392 loghandle->u.phd.phd_cat_handle = cathandle;
393 up_write(&cathandle->lgh_lock);
397 up_write(&cathandle->lgh_lock);
399 rc = llog_open(env, cathandle->lgh_ctxt, &loghandle, logid, NULL,
402 CERROR("%s: error opening log id "DFID":%x: rc = %d\n",
403 cathandle->lgh_ctxt->loc_obd->obd_name,
404 PFID(&logid->lgl_oi.oi_fid), logid->lgl_ogen, rc);
408 rc = llog_init_handle(env, loghandle, LLOG_F_IS_PLAIN | fmt, NULL);
410 llog_close(env, loghandle);
415 down_write(&cathandle->lgh_lock);
416 list_add_tail(&loghandle->u.phd.phd_entry, &cathandle->u.chd.chd_head);
417 up_write(&cathandle->lgh_lock);
419 loghandle->u.phd.phd_cat_handle = cathandle;
420 loghandle->u.phd.phd_cookie.lgc_lgl = cathandle->lgh_id;
421 loghandle->u.phd.phd_cookie.lgc_index =
422 loghandle->lgh_hdr->llh_cat_idx;
425 llog_handle_get(loghandle);
430 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle)
432 struct llog_handle *loghandle, *n;
437 list_for_each_entry_safe(loghandle, n, &cathandle->u.chd.chd_head,
439 struct llog_log_hdr *llh = loghandle->lgh_hdr;
442 /* unlink open-not-created llogs */
443 list_del_init(&loghandle->u.phd.phd_entry);
444 llh = loghandle->lgh_hdr;
445 if (loghandle->lgh_obj != NULL && llh != NULL &&
446 (llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
447 (llh->llh_count == 1)) {
448 rc = llog_destroy(env, loghandle);
450 CERROR("%s: failure destroying log during "
451 "cleanup: rc = %d\n",
452 loghandle->lgh_ctxt->loc_obd->obd_name,
455 index = loghandle->u.phd.phd_cookie.lgc_index;
456 llog_cat_cleanup(env, cathandle, NULL, index);
458 llog_close(env, loghandle);
460 /* if handle was stored in ctxt, remove it too */
461 if (cathandle->lgh_ctxt->loc_handle == cathandle)
462 cathandle->lgh_ctxt->loc_handle = NULL;
463 rc = llog_close(env, cathandle);
466 EXPORT_SYMBOL(llog_cat_close);
468 /** Return the currently active log handle. If the current log handle doesn't
469 * have enough space left for the current record, start a new one.
471 * If reclen is 0, we only want to know what the currently active log is,
472 * otherwise we get a lock on this log so nobody can steal our space.
474 * Assumes caller has already pushed us into the kernel context and is locking.
476 * NOTE: loghandle is write-locked upon successful return
478 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
481 struct llog_handle *loghandle = NULL;
485 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED2)) {
486 down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
487 GOTO(next, loghandle);
490 down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
491 loghandle = cathandle->u.chd.chd_current_log;
493 struct llog_log_hdr *llh;
495 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
496 llh = loghandle->lgh_hdr;
497 if (llh == NULL || !llog_is_full(loghandle)) {
498 up_read(&cathandle->lgh_lock);
501 up_write(&loghandle->lgh_lock);
504 up_read(&cathandle->lgh_lock);
506 /* time to use next log */
508 /* first, we have to make sure the state hasn't changed */
509 down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
510 loghandle = cathandle->u.chd.chd_current_log;
512 struct llog_log_hdr *llh;
514 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
515 llh = loghandle->lgh_hdr;
516 if (llh == NULL || !llog_is_full(loghandle))
517 GOTO(out_unlock, loghandle);
519 up_write(&loghandle->lgh_lock);
523 /* Sigh, the chd_next_log and chd_current_log is initialized
524 * in declare phase, and we do not serialize the catlog
525 * accessing, so it might be possible the llog creation
526 * thread (see llog_cat_declare_add_rec()) did not create
527 * llog successfully, then the following thread might
528 * meet this situation. */
529 if (IS_ERR_OR_NULL(cathandle->u.chd.chd_next_log)) {
530 CERROR("%s: next log does not exist!\n",
531 cathandle->lgh_ctxt->loc_obd->obd_name);
532 loghandle = ERR_PTR(-EIO);
533 if (cathandle->u.chd.chd_next_log == NULL) {
534 /* Store the error in chd_next_log, so
535 * the following process can get correct
537 cathandle->u.chd.chd_next_log = loghandle;
539 GOTO(out_unlock, loghandle);
542 CDEBUG(D_INODE, "use next log\n");
544 loghandle = cathandle->u.chd.chd_next_log;
545 cathandle->u.chd.chd_current_log = loghandle;
546 cathandle->u.chd.chd_next_log = NULL;
547 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
550 up_write(&cathandle->lgh_lock);
555 /* Add a single record to the recovery log(s) using a catalog
556 * Returns as llog_write_record
558 * Assumes caller has already pushed us into the kernel context.
560 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
561 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
564 struct llog_handle *loghandle;
568 LASSERT(rec->lrh_len <= cathandle->lgh_ctxt->loc_chunk_size);
571 loghandle = llog_cat_current_log(cathandle, th);
572 if (IS_ERR(loghandle))
573 RETURN(PTR_ERR(loghandle));
575 /* loghandle is already locked by llog_cat_current_log() for us */
576 if (!llog_exist(loghandle)) {
577 rc = llog_cat_new_log(env, cathandle, loghandle, th);
579 up_write(&loghandle->lgh_lock);
580 /* nobody should be trying to use this llog */
581 down_write(&cathandle->lgh_lock);
582 if (cathandle->u.chd.chd_current_log == loghandle)
583 cathandle->u.chd.chd_current_log = NULL;
584 up_write(&cathandle->lgh_lock);
588 /* now let's try to add the record */
589 rc = llog_write_rec(env, loghandle, rec, reccookie, LLOG_NEXT_IDX, th);
591 CDEBUG_LIMIT(rc == -ENOSPC ? D_HA : D_ERROR,
592 "llog_write_rec %d: lh=%p\n", rc, loghandle);
593 /* -ENOSPC is returned if no empty records left
594 * and when it's lack of space on the stogage.
595 * there is no point to try again if it's the second
596 * case. many callers (like llog test) expect ENOSPC,
597 * so we preserve this error code, but look for the
598 * actual cause here */
599 if (rc == -ENOSPC && llog_is_full(loghandle))
602 up_write(&loghandle->lgh_lock);
604 if (rc == -ENOBUFS) {
607 CERROR("%s: error on 2nd llog: rc = %d\n",
608 cathandle->lgh_ctxt->loc_obd->obd_name, rc);
613 EXPORT_SYMBOL(llog_cat_add_rec);
615 int llog_cat_declare_add_rec(const struct lu_env *env,
616 struct llog_handle *cathandle,
617 struct llog_rec_hdr *rec, struct thandle *th)
624 down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
625 rc = llog_cat_prep_log(env, cathandle,
626 &cathandle->u.chd.chd_current_log, th);
630 rc = llog_cat_prep_log(env, cathandle, &cathandle->u.chd.chd_next_log,
635 rc = llog_declare_write_rec(env, cathandle->u.chd.chd_current_log,
637 if (rc == -ESTALE && dt_object_remote(cathandle->lgh_obj)) {
638 up_read(&cathandle->lgh_lock);
639 rc = llog_cat_refresh(env, cathandle);
647 * XXX: we hope for declarations made for existing llog this might be
648 * not correct with some backends where declarations are expected
649 * against specific object like ZFS with full debugging enabled.
651 rc = llog_declare_write_rec(env, cathandle->u.chd.chd_next_log, rec, -1,
655 up_read(&cathandle->lgh_lock);
658 EXPORT_SYMBOL(llog_cat_declare_add_rec);
660 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
661 struct llog_rec_hdr *rec, struct llog_cookie *reccookie)
663 struct llog_ctxt *ctxt;
664 struct dt_device *dt;
665 struct thandle *th = NULL;
668 ctxt = cathandle->lgh_ctxt;
670 LASSERT(ctxt->loc_exp);
672 LASSERT(cathandle->lgh_obj != NULL);
673 dt = lu2dt_dev(cathandle->lgh_obj->do_lu.lo_dev);
675 th = dt_trans_create(env, dt);
679 rc = llog_cat_declare_add_rec(env, cathandle, rec, th);
683 rc = dt_trans_start_local(env, dt, th);
686 rc = llog_cat_add_rec(env, cathandle, rec, reccookie, th);
688 dt_trans_stop(env, dt, th);
691 EXPORT_SYMBOL(llog_cat_add);
693 int llog_cat_cancel_arr_rec(const struct lu_env *env,
694 struct llog_handle *cathandle,
695 struct llog_logid *lgl, int count, int *index)
697 struct llog_handle *loghandle;
701 rc = llog_cat_id2handle(env, cathandle, &loghandle, lgl);
703 CDEBUG(D_HA, "%s: cannot find llog for handle "DFID":%x"
705 cathandle->lgh_ctxt->loc_obd->obd_name,
706 PFID(&lgl->lgl_oi.oi_fid), lgl->lgl_ogen, rc);
710 if ((cathandle->lgh_ctxt->loc_flags &
711 LLOG_CTXT_FLAG_NORMAL_FID) && !llog_exist(loghandle)) {
712 /* For update log, some of loghandles of cathandle
713 * might not exist because remote llog creation might
714 * be failed, so let's skip the record cancellation
715 * for these non-exist llogs.
718 CDEBUG(D_HA, "%s: llog "DFID":%x does not exist"
720 cathandle->lgh_ctxt->loc_obd->obd_name,
721 PFID(&lgl->lgl_oi.oi_fid), lgl->lgl_ogen, rc);
723 llog_handle_put(loghandle);
727 rc = llog_cancel_arr_rec(env, loghandle, count, index);
728 if (rc == LLOG_DEL_PLAIN) { /* log has been destroyed */
731 cat_index = loghandle->u.phd.phd_cookie.lgc_index;
732 rc = llog_cat_cleanup(env, cathandle, loghandle, cat_index);
734 CERROR("%s: fail to cancel catalog record: rc = %d\n",
735 cathandle->lgh_ctxt->loc_obd->obd_name, rc);
739 llog_handle_put(loghandle);
742 CERROR("%s: fail to cancel %d llog-records: rc = %d\n",
743 cathandle->lgh_ctxt->loc_obd->obd_name, count,
748 EXPORT_SYMBOL(llog_cat_cancel_arr_rec);
750 /* For each cookie in the cookie array, we clear the log in-use bit and either:
751 * - the log is empty, so mark it free in the catalog header and delete it
752 * - the log is not empty, just write out the log header
754 * The cookies may be in different log files, so we need to get new logs
757 * Assumes caller has already pushed us into the kernel context.
759 int llog_cat_cancel_records(const struct lu_env *env,
760 struct llog_handle *cathandle, int count,
761 struct llog_cookie *cookies)
763 int i, rc = 0, failed = 0;
767 for (i = 0; i < count; i++, cookies++) {
770 lrc = llog_cat_cancel_arr_rec(env, cathandle, &cookies->lgc_lgl,
771 1, &cookies->lgc_index);
779 CERROR("%s: fail to cancel %d of %d llog-records: rc = %d\n",
780 cathandle->lgh_ctxt->loc_obd->obd_name, failed, count,
784 EXPORT_SYMBOL(llog_cat_cancel_records);
786 static int llog_cat_process_common(const struct lu_env *env,
787 struct llog_handle *cat_llh,
788 struct llog_rec_hdr *rec,
789 struct llog_handle **llhp)
791 struct llog_logid_rec *lir = container_of(rec, typeof(*lir), lid_hdr);
792 struct llog_log_hdr *hdr;
796 if (rec->lrh_type != le32_to_cpu(LLOG_LOGID_MAGIC)) {
798 CWARN("%s: invalid record in catalog "DFID":%x: rc = %d\n",
799 cat_llh->lgh_ctxt->loc_obd->obd_name,
800 PFID(&cat_llh->lgh_id.lgl_oi.oi_fid),
801 cat_llh->lgh_id.lgl_ogen, rc);
804 CDEBUG(D_HA, "processing log "DFID":%x at index %u of catalog "DFID"\n",
805 PFID(&lir->lid_id.lgl_oi.oi_fid), lir->lid_id.lgl_ogen,
806 le32_to_cpu(rec->lrh_index),
807 PFID(&cat_llh->lgh_id.lgl_oi.oi_fid));
809 rc = llog_cat_id2handle(env, cat_llh, llhp, &lir->lid_id);
811 /* After a server crash, a stub of index record in catlog could
812 * be kept, because plain log destroy + catlog index record
813 * deletion are not atomic. So we end up with an index but no
814 * actual record. Destroy the index and move on. */
815 if (rc == -ENOENT || rc == -ESTALE)
816 rc = LLOG_DEL_RECORD;
818 CWARN("%s: can't find llog handle "DFID":%x: rc = %d\n",
819 cat_llh->lgh_ctxt->loc_obd->obd_name,
820 PFID(&lir->lid_id.lgl_oi.oi_fid),
821 lir->lid_id.lgl_ogen, rc);
826 /* clean old empty llogs, do not consider current llog in use */
827 /* ignore remote (lgh_obj == NULL) llogs */
828 hdr = (*llhp)->lgh_hdr;
829 if ((hdr->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
830 hdr->llh_count == 1 && cat_llh->lgh_obj != NULL &&
831 *llhp != cat_llh->u.chd.chd_current_log) {
832 rc = llog_destroy(env, *llhp);
834 CWARN("%s: can't destroy empty log "DFID": rc = %d\n",
835 (*llhp)->lgh_ctxt->loc_obd->obd_name,
836 PFID(&lir->lid_id.lgl_oi.oi_fid), rc);
843 static int llog_cat_process_cb(const struct lu_env *env,
844 struct llog_handle *cat_llh,
845 struct llog_rec_hdr *rec, void *data)
847 struct llog_process_data *d = data;
848 struct llog_handle *llh = NULL;
852 rc = llog_cat_process_common(env, cat_llh, rec, &llh);
856 if (rec->lrh_index < d->lpd_startcat) {
857 /* Skip processing of the logs until startcat */
859 } else if (d->lpd_startidx > 0) {
860 struct llog_process_cat_data cd;
862 cd.lpcd_first_idx = d->lpd_startidx;
863 cd.lpcd_last_idx = 0;
864 rc = llog_process_or_fork(env, llh, d->lpd_cb, d->lpd_data,
866 /* Continue processing the next log from idx 0 */
869 rc = llog_process_or_fork(env, llh, d->lpd_cb, d->lpd_data,
874 /* The empty plain log was destroyed while processing */
875 if (rc == LLOG_DEL_PLAIN) {
876 rc = llog_cat_cleanup(env, cat_llh, llh,
877 llh->u.phd.phd_cookie.lgc_index);
878 } else if (rc == LLOG_DEL_RECORD) {
879 /* clear wrong catalog entry */
880 rc = llog_cat_cleanup(env, cat_llh, NULL, rec->lrh_index);
884 llog_handle_put(llh);
889 int llog_cat_process_or_fork(const struct lu_env *env,
890 struct llog_handle *cat_llh, llog_cb_t cat_cb,
891 llog_cb_t cb, void *data, int startcat,
892 int startidx, bool fork)
894 struct llog_process_data d;
895 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
900 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
903 d.lpd_startcat = (startcat == LLOG_CAT_FIRST ? 0 : startcat);
904 d.lpd_startidx = startidx;
906 if (llh->llh_cat_idx >= cat_llh->lgh_last_idx &&
907 llh->llh_count > 1) {
908 struct llog_process_cat_data cd;
910 CWARN("%s: catlog "DFID" crosses index zero\n",
911 cat_llh->lgh_ctxt->loc_obd->obd_name,
912 PFID(&cat_llh->lgh_id.lgl_oi.oi_fid));
913 /*startcat = 0 is default value for general processing */
914 if ((startcat != LLOG_CAT_FIRST &&
915 startcat >= llh->llh_cat_idx) || !startcat) {
916 /* processing the catalog part at the end */
917 cd.lpcd_first_idx = (startcat ? startcat :
919 if (OBD_FAIL_PRECHECK(OBD_FAIL_CAT_RECORDS))
920 cd.lpcd_last_idx = cfs_fail_val;
922 cd.lpcd_last_idx = 0;
923 rc = llog_process_or_fork(env, cat_llh, cat_cb,
925 /* Reset the startcat becasue it has already reached
932 /* processing the catalog part at the begining */
933 cd.lpcd_first_idx = (startcat == LLOG_CAT_FIRST) ? 0 : startcat;
934 /* Note, the processing will stop at the lgh_last_idx value,
935 * and it could be increased during processing. So records
936 * between current lgh_last_idx and lgh_last_idx in future
937 * would left unprocessed.
939 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
940 rc = llog_process_or_fork(env, cat_llh, cat_cb,
943 rc = llog_process_or_fork(env, cat_llh, cat_cb,
949 EXPORT_SYMBOL(llog_cat_process_or_fork);
951 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
952 llog_cb_t cb, void *data, int startcat, int startidx)
954 return llog_cat_process_or_fork(env, cat_llh, llog_cat_process_cb,
955 cb, data, startcat, startidx, false);
957 EXPORT_SYMBOL(llog_cat_process);
959 static int llog_cat_size_cb(const struct lu_env *env,
960 struct llog_handle *cat_llh,
961 struct llog_rec_hdr *rec, void *data)
963 struct llog_process_data *d = data;
964 struct llog_handle *llh = NULL;
965 __u64 *cum_size = d->lpd_data;
970 rc = llog_cat_process_common(env, cat_llh, rec, &llh);
972 if (rc == LLOG_DEL_PLAIN) {
973 /* empty log was deleted, don't count it */
974 rc = llog_cat_cleanup(env, cat_llh, llh,
975 llh->u.phd.phd_cookie.lgc_index);
976 } else if (rc == LLOG_DEL_RECORD) {
977 /* clear wrong catalog entry */
978 rc = llog_cat_cleanup(env, cat_llh, NULL, rec->lrh_index);
980 size = llog_size(env, llh);
983 CDEBUG(D_INFO, "Add llog entry "DFID" size=%llu, tot=%llu\n",
984 PFID(&llh->lgh_id.lgl_oi.oi_fid), size, *cum_size);
988 llog_handle_put(llh);
993 __u64 llog_cat_size(const struct lu_env *env, struct llog_handle *cat_llh)
995 __u64 size = llog_size(env, cat_llh);
997 llog_cat_process_or_fork(env, cat_llh, llog_cat_size_cb,
998 NULL, &size, 0, 0, false);
1002 EXPORT_SYMBOL(llog_cat_size);
1004 /* currently returns the number of "free" entries in catalog,
1005 * ie the available entries for a new plain LLOG file creation,
1006 * even if catalog has wrapped
1008 __u32 llog_cat_free_space(struct llog_handle *cat_llh)
1010 /* simulate almost full Catalog */
1011 if (OBD_FAIL_CHECK(OBD_FAIL_CAT_FREE_RECORDS))
1012 return cfs_fail_val;
1014 if (cat_llh->lgh_hdr->llh_count == 1)
1015 return LLOG_HDR_BITMAP_SIZE(cat_llh->lgh_hdr) - 1;
1017 if (cat_llh->lgh_last_idx > cat_llh->lgh_hdr->llh_cat_idx)
1018 return LLOG_HDR_BITMAP_SIZE(cat_llh->lgh_hdr) - 1 +
1019 cat_llh->lgh_hdr->llh_cat_idx - cat_llh->lgh_last_idx;
1021 /* catalog is presently wrapped */
1022 return cat_llh->lgh_hdr->llh_cat_idx - cat_llh->lgh_last_idx;
1024 EXPORT_SYMBOL(llog_cat_free_space);
1026 static int llog_cat_reverse_process_cb(const struct lu_env *env,
1027 struct llog_handle *cat_llh,
1028 struct llog_rec_hdr *rec, void *data)
1030 struct llog_process_data *d = data;
1031 struct llog_handle *llh;
1035 rc = llog_cat_process_common(env, cat_llh, rec, &llh);
1037 /* The empty plain log was destroyed while processing */
1038 if (rc == LLOG_DEL_PLAIN) {
1039 rc = llog_cat_cleanup(env, cat_llh, llh,
1040 llh->u.phd.phd_cookie.lgc_index);
1041 } else if (rc == LLOG_DEL_RECORD) {
1042 /* clear wrong catalog entry */
1043 rc = llog_cat_cleanup(env, cat_llh, NULL, rec->lrh_index);
1048 rc = llog_reverse_process(env, llh, d->lpd_cb, d->lpd_data, NULL);
1050 /* The empty plain was destroyed while processing */
1051 if (rc == LLOG_DEL_PLAIN)
1052 rc = llog_cat_cleanup(env, cat_llh, llh,
1053 llh->u.phd.phd_cookie.lgc_index);
1055 llog_handle_put(llh);
1059 int llog_cat_reverse_process(const struct lu_env *env,
1060 struct llog_handle *cat_llh,
1061 llog_cb_t cb, void *data)
1063 struct llog_process_data d;
1064 struct llog_process_cat_data cd;
1065 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
1069 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
1073 if (llh->llh_cat_idx >= cat_llh->lgh_last_idx &&
1074 llh->llh_count > 1) {
1075 CWARN("%s: catalog "DFID" crosses index zero\n",
1076 cat_llh->lgh_ctxt->loc_obd->obd_name,
1077 PFID(&cat_llh->lgh_id.lgl_oi.oi_fid));
1079 cd.lpcd_first_idx = 0;
1080 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
1081 rc = llog_reverse_process(env, cat_llh,
1082 llog_cat_reverse_process_cb,
1087 cd.lpcd_first_idx = le32_to_cpu(llh->llh_cat_idx);
1088 cd.lpcd_last_idx = 0;
1089 rc = llog_reverse_process(env, cat_llh,
1090 llog_cat_reverse_process_cb,
1093 rc = llog_reverse_process(env, cat_llh,
1094 llog_cat_reverse_process_cb,
1100 EXPORT_SYMBOL(llog_cat_reverse_process);
1102 static int llog_cat_set_first_idx(struct llog_handle *cathandle, int idx)
1104 struct llog_log_hdr *llh = cathandle->lgh_hdr;
1109 bitmap_size = LLOG_HDR_BITMAP_SIZE(llh);
1111 * The llh_cat_idx equals to the first used index minus 1
1112 * so if we canceled the first index then llh_cat_idx
1115 if (llh->llh_cat_idx == (idx - 1)) {
1116 llh->llh_cat_idx = idx;
1118 while (idx != cathandle->lgh_last_idx) {
1119 idx = (idx + 1) % bitmap_size;
1120 if (!ext2_test_bit(idx, LLOG_HDR_BITMAP(llh))) {
1121 /* update llh_cat_idx for each unset bit,
1122 * expecting the next one is set */
1123 llh->llh_cat_idx = idx;
1124 } else if (idx == 0) {
1125 /* skip header bit */
1126 llh->llh_cat_idx = 0;
1129 /* the first index is found */
1134 CDEBUG(D_RPCTRACE, "catlog "DFID" first idx %u, last_idx %u\n",
1135 PFID(&cathandle->lgh_id.lgl_oi.oi_fid),
1136 llh->llh_cat_idx, cathandle->lgh_last_idx);
1142 /* Cleanup deleted plain llog traces from catalog */
1143 int llog_cat_cleanup(const struct lu_env *env, struct llog_handle *cathandle,
1144 struct llog_handle *loghandle, int index)
1149 if (loghandle != NULL) {
1150 /* remove destroyed llog from catalog list and
1151 * chd_current_log variable */
1152 down_write(&cathandle->lgh_lock);
1153 if (cathandle->u.chd.chd_current_log == loghandle)
1154 cathandle->u.chd.chd_current_log = NULL;
1155 list_del_init(&loghandle->u.phd.phd_entry);
1156 up_write(&cathandle->lgh_lock);
1157 LASSERT(index == loghandle->u.phd.phd_cookie.lgc_index);
1158 /* llog was opened and keep in a list, close it now */
1159 llog_close(env, loghandle);
1162 /* do not attempt to cleanup on-disk llog if on client side */
1163 if (cathandle->lgh_obj == NULL)
1166 /* remove plain llog entry from catalog by index */
1167 llog_cat_set_first_idx(cathandle, index);
1168 rc = llog_cancel_rec(env, cathandle, index);
1170 CDEBUG(D_HA, "cancel plain log at index %u of catalog "DFID"\n",
1171 index, PFID(&cathandle->lgh_id.lgl_oi.oi_fid));