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"
52 /* Create a new log handle and add it to the open list.
53 * This log handle will be closed when all of the records in it are removed.
55 * Assumes caller has already pushed us into the kernel context and is locking.
57 static int llog_cat_new_log(const struct lu_env *env,
58 struct llog_handle *cathandle,
59 struct llog_handle *loghandle,
62 struct llog_thread_info *lgi = llog_info(env);
63 struct llog_logid_rec *rec = &lgi->lgi_logid;
64 struct thandle *handle = NULL;
65 struct dt_device *dt = NULL;
66 struct llog_log_hdr *llh = cathandle->lgh_hdr;
71 index = (cathandle->lgh_last_idx + 1) %
72 (OBD_FAIL_PRECHECK(OBD_FAIL_CAT_RECORDS) ? (cfs_fail_val + 1) :
73 LLOG_HDR_BITMAP_SIZE(llh));
75 /* check that new llog index will not overlap with the first one.
76 * - llh_cat_idx is the index just before the first/oldest still in-use
78 * - lgh_last_idx is the last/newest used index in catalog
80 * When catalog is not wrapped yet then lgh_last_idx is always larger
81 * than llh_cat_idx. After the wrap around lgh_last_idx re-starts
82 * from 0 and llh_cat_idx becomes the upper limit for it
84 * Check if catalog has already wrapped around or not by comparing
85 * last_idx and cat_idx */
86 if ((index == llh->llh_cat_idx + 1 && llh->llh_count > 1) ||
87 (index == 0 && llh->llh_cat_idx == 0)) {
88 if (cathandle->lgh_name == NULL) {
89 CWARN("%s: there are no more free slots in catalog "
91 loghandle->lgh_ctxt->loc_obd->obd_name,
92 PFID(&cathandle->lgh_id.lgl_oi.oi_fid),
93 cathandle->lgh_id.lgl_ogen);
95 CWARN("%s: there are no more free slots in "
97 loghandle->lgh_ctxt->loc_obd->obd_name,
103 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED))
106 if (loghandle->lgh_hdr != NULL) {
107 /* If llog object is remote and creation is failed, lgh_hdr
108 * might be left over here, free it first */
109 LASSERT(!llog_exist(loghandle));
110 OBD_FREE_LARGE(loghandle->lgh_hdr, loghandle->lgh_hdr_size);
111 loghandle->lgh_hdr = NULL;
115 dt = lu2dt_dev(cathandle->lgh_obj->do_lu.lo_dev);
117 handle = dt_trans_create(env, dt);
119 RETURN(PTR_ERR(handle));
121 /* Create update llog object synchronously, which
122 * happens during inialization process see
123 * lod_sub_prep_llog(), to make sure the update
124 * llog object is created before corss-MDT writing
125 * updates into the llog object */
126 if (cathandle->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID)
129 handle->th_wait_submit = 1;
131 rc = llog_declare_create(env, loghandle, handle);
135 rec->lid_hdr.lrh_len = sizeof(*rec);
136 rec->lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
137 rec->lid_id = loghandle->lgh_id;
138 rc = llog_declare_write_rec(env, cathandle, &rec->lid_hdr, -1,
143 rc = dt_trans_start_local(env, dt, handle);
150 rc = llog_create(env, loghandle, th);
151 /* if llog is already created, no need to initialize it */
154 } else if (rc != 0) {
155 CERROR("%s: can't create new plain llog in catalog: rc = %d\n",
156 loghandle->lgh_ctxt->loc_obd->obd_name, rc);
160 rc = llog_init_handle(env, loghandle,
161 LLOG_F_IS_PLAIN | LLOG_F_ZAP_WHEN_EMPTY,
162 &cathandle->lgh_hdr->llh_tgtuuid);
166 /* build the record for this log in the catalog */
167 rec->lid_hdr.lrh_len = sizeof(*rec);
168 rec->lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
169 rec->lid_id = loghandle->lgh_id;
171 /* append the new record into catalog. The new index will be
172 * assigned to the record and updated in rec header */
173 rc = llog_write_rec(env, cathandle, &rec->lid_hdr,
174 &loghandle->u.phd.phd_cookie, LLOG_NEXT_IDX, th);
176 GOTO(out_destroy, rc);
178 CDEBUG(D_OTHER, "new plain log "DFID".%u of catalog "DFID"\n",
179 PFID(&loghandle->lgh_id.lgl_oi.oi_fid), rec->lid_hdr.lrh_index,
180 PFID(&cathandle->lgh_id.lgl_oi.oi_fid));
182 loghandle->lgh_hdr->llh_cat_idx = rec->lid_hdr.lrh_index;
184 /* limit max size of plain llog so that space can be
185 * released sooner, especially on small filesystems */
186 /* 2MB for the cases when free space hasn't been learned yet */
187 loghandle->lgh_max_size = 2 << 20;
188 dt = lu2dt_dev(cathandle->lgh_obj->do_lu.lo_dev);
189 rc = dt_statfs(env, dt, &lgi->lgi_statfs);
190 if (rc == 0 && lgi->lgi_statfs.os_bfree > 0) {
191 __u64 freespace = (lgi->lgi_statfs.os_bfree *
192 lgi->lgi_statfs.os_bsize) >> 6;
193 if (freespace < loghandle->lgh_max_size)
194 loghandle->lgh_max_size = freespace;
195 /* shouldn't be > 128MB in any case?
196 * it's 256K records of 512 bytes each */
197 if (freespace > (128 << 20))
198 loghandle->lgh_max_size = 128 << 20;
203 if (handle != NULL) {
204 handle->th_result = rc >= 0 ? 0 : rc;
205 dt_trans_stop(env, dt, handle);
210 /* to signal llog_cat_close() it shouldn't try to destroy the llog,
211 * we want to destroy it in this transaction, otherwise the object
212 * becomes an orphan */
213 loghandle->lgh_hdr->llh_flags &= ~LLOG_F_ZAP_WHEN_EMPTY;
214 /* this is to mimic full log, so another llog_cat_current_log()
215 * can skip it and ask for another onet */
216 loghandle->lgh_last_idx = LLOG_HDR_BITMAP_SIZE(loghandle->lgh_hdr) + 1;
217 llog_trans_destroy(env, loghandle, th);
219 dt_trans_stop(env, dt, handle);
223 static int llog_cat_refresh(const struct lu_env *env,
224 struct llog_handle *cathandle)
226 struct llog_handle *loghandle;
229 down_write(&cathandle->lgh_lock);
230 list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
232 if (!llog_exist(loghandle))
235 rc = llog_read_header(env, loghandle, NULL);
240 rc = llog_read_header(env, cathandle, NULL);
242 up_write(&loghandle->lgh_lock);
248 * prepare current/next log for catalog.
250 * if log is NULL, open it, and declare create, NB, if log is remote, create it
251 * synchronously here, see comments below.
253 static int llog_cat_prep_log(const struct lu_env *env,
254 struct llog_handle *cathandle,
255 struct llog_handle **ploghandle,
260 if (IS_ERR_OR_NULL(*ploghandle)) {
261 down_write(&cathandle->lgh_lock);
262 if (IS_ERR_OR_NULL(*ploghandle)) {
263 struct llog_handle *loghandle;
265 rc = llog_open(env, cathandle->lgh_ctxt, &loghandle,
266 NULL, NULL, LLOG_OPEN_NEW);
268 *ploghandle = loghandle;
269 list_add_tail(&loghandle->u.phd.phd_entry,
270 &cathandle->u.chd.chd_head);
273 up_write(&cathandle->lgh_lock);
279 if (llog_exist(*ploghandle))
282 if (dt_object_remote(cathandle->lgh_obj)) {
284 down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
285 down_write_nested(&(*ploghandle)->lgh_lock, LLOGH_LOG);
286 if (!llog_exist(*ploghandle)) {
287 /* For remote operation, if we put the llog object
288 * creation in the current transaction, then the
289 * llog object will not be created on the remote
290 * target until the transaction stop, if other
291 * operations start before the transaction stop,
292 * and use the same llog object, will be dependent
293 * on the success of this transaction. So let's
294 * create the llog object synchronously here to
295 * remove the dependency. */
296 rc = llog_cat_new_log(env, cathandle, *ploghandle,
299 up_write(&(*ploghandle)->lgh_lock);
300 up_read(&cathandle->lgh_lock);
302 rc = llog_cat_refresh(env, cathandle);
304 goto create_remote_log;
309 up_write(&(*ploghandle)->lgh_lock);
310 up_read(&cathandle->lgh_lock);
312 struct llog_thread_info *lgi = llog_info(env);
313 struct llog_logid_rec *lirec = &lgi->lgi_logid;
315 rc = llog_declare_create(env, *ploghandle, th);
319 lirec->lid_hdr.lrh_len = sizeof(*lirec);
320 rc = llog_declare_write_rec(env, cathandle, &lirec->lid_hdr, -1,
327 /* Open an existent log handle and add it to the open list.
328 * This log handle will be closed when all of the records in it are removed.
330 * Assumes caller has already pushed us into the kernel context and is locking.
331 * We return a lock on the handle to ensure nobody yanks it from us.
333 * This takes extra reference on llog_handle via llog_handle_get() and require
334 * this reference to be put by caller using llog_handle_put()
336 int llog_cat_id2handle(const struct lu_env *env, struct llog_handle *cathandle,
337 struct llog_handle **res, struct llog_logid *logid)
339 struct llog_handle *loghandle;
345 if (cathandle == NULL)
348 fmt = cathandle->lgh_hdr->llh_flags & LLOG_F_EXT_MASK;
349 down_write(&cathandle->lgh_lock);
350 list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
352 struct llog_logid *cgl = &loghandle->lgh_id;
354 if (ostid_id(&cgl->lgl_oi) == ostid_id(&logid->lgl_oi) &&
355 ostid_seq(&cgl->lgl_oi) == ostid_seq(&logid->lgl_oi)) {
356 if (cgl->lgl_ogen != logid->lgl_ogen) {
357 CWARN("%s: log "DFID" generation %x != %x\n",
358 loghandle->lgh_ctxt->loc_obd->obd_name,
359 PFID(&logid->lgl_oi.oi_fid),
360 cgl->lgl_ogen, logid->lgl_ogen);
363 loghandle->u.phd.phd_cat_handle = cathandle;
364 up_write(&cathandle->lgh_lock);
368 up_write(&cathandle->lgh_lock);
370 rc = llog_open(env, cathandle->lgh_ctxt, &loghandle, logid, NULL,
373 CERROR("%s: error opening log id "DFID":%x: rc = %d\n",
374 cathandle->lgh_ctxt->loc_obd->obd_name,
375 PFID(&logid->lgl_oi.oi_fid), logid->lgl_ogen, rc);
379 rc = llog_init_handle(env, loghandle, LLOG_F_IS_PLAIN | fmt, NULL);
381 llog_close(env, loghandle);
386 down_write(&cathandle->lgh_lock);
387 list_add_tail(&loghandle->u.phd.phd_entry, &cathandle->u.chd.chd_head);
388 up_write(&cathandle->lgh_lock);
390 loghandle->u.phd.phd_cat_handle = cathandle;
391 loghandle->u.phd.phd_cookie.lgc_lgl = cathandle->lgh_id;
392 loghandle->u.phd.phd_cookie.lgc_index =
393 loghandle->lgh_hdr->llh_cat_idx;
396 llog_handle_get(loghandle);
401 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle)
403 struct llog_handle *loghandle, *n;
408 list_for_each_entry_safe(loghandle, n, &cathandle->u.chd.chd_head,
410 struct llog_log_hdr *llh = loghandle->lgh_hdr;
413 /* unlink open-not-created llogs */
414 list_del_init(&loghandle->u.phd.phd_entry);
415 llh = loghandle->lgh_hdr;
416 if (loghandle->lgh_obj != NULL && llh != NULL &&
417 (llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
418 (llh->llh_count == 1)) {
419 rc = llog_destroy(env, loghandle);
421 CERROR("%s: failure destroying log during "
422 "cleanup: rc = %d\n",
423 loghandle->lgh_ctxt->loc_obd->obd_name,
426 index = loghandle->u.phd.phd_cookie.lgc_index;
427 llog_cat_cleanup(env, cathandle, NULL, index);
429 llog_close(env, loghandle);
431 /* if handle was stored in ctxt, remove it too */
432 if (cathandle->lgh_ctxt->loc_handle == cathandle)
433 cathandle->lgh_ctxt->loc_handle = NULL;
434 rc = llog_close(env, cathandle);
437 EXPORT_SYMBOL(llog_cat_close);
440 * lockdep markers for nested struct llog_handle::lgh_lock locking.
447 /** Return the currently active log handle. If the current log handle doesn't
448 * have enough space left for the current record, start a new one.
450 * If reclen is 0, we only want to know what the currently active log is,
451 * otherwise we get a lock on this log so nobody can steal our space.
453 * Assumes caller has already pushed us into the kernel context and is locking.
455 * NOTE: loghandle is write-locked upon successful return
457 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
460 struct llog_handle *loghandle = NULL;
464 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED2)) {
465 down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
466 GOTO(next, loghandle);
469 down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
470 loghandle = cathandle->u.chd.chd_current_log;
472 struct llog_log_hdr *llh;
474 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
475 llh = loghandle->lgh_hdr;
476 if (llh == NULL || !llog_is_full(loghandle)) {
477 up_read(&cathandle->lgh_lock);
480 up_write(&loghandle->lgh_lock);
483 up_read(&cathandle->lgh_lock);
485 /* time to use next log */
487 /* first, we have to make sure the state hasn't changed */
488 down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
489 loghandle = cathandle->u.chd.chd_current_log;
491 struct llog_log_hdr *llh;
493 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
494 llh = loghandle->lgh_hdr;
495 if (llh == NULL || !llog_is_full(loghandle))
496 GOTO(out_unlock, loghandle);
498 up_write(&loghandle->lgh_lock);
502 /* Sigh, the chd_next_log and chd_current_log is initialized
503 * in declare phase, and we do not serialize the catlog
504 * accessing, so it might be possible the llog creation
505 * thread (see llog_cat_declare_add_rec()) did not create
506 * llog successfully, then the following thread might
507 * meet this situation. */
508 if (IS_ERR_OR_NULL(cathandle->u.chd.chd_next_log)) {
509 CERROR("%s: next log does not exist!\n",
510 cathandle->lgh_ctxt->loc_obd->obd_name);
511 loghandle = ERR_PTR(-EIO);
512 if (cathandle->u.chd.chd_next_log == NULL) {
513 /* Store the error in chd_next_log, so
514 * the following process can get correct
516 cathandle->u.chd.chd_next_log = loghandle;
518 GOTO(out_unlock, loghandle);
521 CDEBUG(D_INODE, "use next log\n");
523 loghandle = cathandle->u.chd.chd_next_log;
524 cathandle->u.chd.chd_current_log = loghandle;
525 cathandle->u.chd.chd_next_log = NULL;
526 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
529 up_write(&cathandle->lgh_lock);
534 /* Add a single record to the recovery log(s) using a catalog
535 * Returns as llog_write_record
537 * Assumes caller has already pushed us into the kernel context.
539 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
540 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
543 struct llog_handle *loghandle;
547 LASSERT(rec->lrh_len <= cathandle->lgh_ctxt->loc_chunk_size);
550 loghandle = llog_cat_current_log(cathandle, th);
551 if (IS_ERR(loghandle))
552 RETURN(PTR_ERR(loghandle));
554 /* loghandle is already locked by llog_cat_current_log() for us */
555 if (!llog_exist(loghandle)) {
556 rc = llog_cat_new_log(env, cathandle, loghandle, th);
558 up_write(&loghandle->lgh_lock);
559 /* nobody should be trying to use this llog */
560 down_write(&cathandle->lgh_lock);
561 /* only reset current log if still room in catalog, to
562 * avoid unnecessarily and racy creation of new and
563 * partially initialized llog_handle
565 if ((cathandle->u.chd.chd_current_log == loghandle) &&
567 cathandle->u.chd.chd_current_log = NULL;
568 up_write(&cathandle->lgh_lock);
572 /* now let's try to add the record */
573 rc = llog_write_rec(env, loghandle, rec, reccookie, LLOG_NEXT_IDX, th);
575 CDEBUG_LIMIT(rc == -ENOSPC ? D_HA : D_ERROR,
576 "llog_write_rec %d: lh=%p\n", rc, loghandle);
577 /* -ENOSPC is returned if no empty records left
578 * and when it's lack of space on the stogage.
579 * there is no point to try again if it's the second
580 * case. many callers (like llog test) expect ENOSPC,
581 * so we preserve this error code, but look for the
582 * actual cause here */
583 if (rc == -ENOSPC && llog_is_full(loghandle))
586 up_write(&loghandle->lgh_lock);
588 if (rc == -ENOBUFS) {
591 CERROR("%s: error on 2nd llog: rc = %d\n",
592 cathandle->lgh_ctxt->loc_obd->obd_name, rc);
597 EXPORT_SYMBOL(llog_cat_add_rec);
599 int llog_cat_declare_add_rec(const struct lu_env *env,
600 struct llog_handle *cathandle,
601 struct llog_rec_hdr *rec, struct thandle *th)
607 rc = llog_cat_prep_log(env, cathandle,
608 &cathandle->u.chd.chd_current_log, th);
612 rc = llog_cat_prep_log(env, cathandle, &cathandle->u.chd.chd_next_log,
618 rc = llog_declare_write_rec(env, cathandle->u.chd.chd_current_log,
620 if (rc == -ESTALE && dt_object_remote(cathandle->lgh_obj)) {
621 rc = llog_cat_refresh(env, cathandle);
628 * XXX: we hope for declarations made for existing llog this might be
629 * not correct with some backends where declarations are expected
630 * against specific object like ZFS with full debugging enabled.
632 rc = llog_declare_write_rec(env, cathandle->u.chd.chd_next_log, rec, -1,
638 EXPORT_SYMBOL(llog_cat_declare_add_rec);
640 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
641 struct llog_rec_hdr *rec, struct llog_cookie *reccookie)
643 struct llog_ctxt *ctxt;
644 struct dt_device *dt;
645 struct thandle *th = NULL;
648 ctxt = cathandle->lgh_ctxt;
650 LASSERT(ctxt->loc_exp);
652 LASSERT(cathandle->lgh_obj != NULL);
653 dt = lu2dt_dev(cathandle->lgh_obj->do_lu.lo_dev);
655 th = dt_trans_create(env, dt);
659 rc = llog_cat_declare_add_rec(env, cathandle, rec, th);
663 rc = dt_trans_start_local(env, dt, th);
666 rc = llog_cat_add_rec(env, cathandle, rec, reccookie, th);
668 dt_trans_stop(env, dt, th);
671 EXPORT_SYMBOL(llog_cat_add);
673 /* For each cookie in the cookie array, we clear the log in-use bit and either:
674 * - the log is empty, so mark it free in the catalog header and delete it
675 * - the log is not empty, just write out the log header
677 * The cookies may be in different log files, so we need to get new logs
680 * Assumes caller has already pushed us into the kernel context.
682 int llog_cat_cancel_records(const struct lu_env *env,
683 struct llog_handle *cathandle, int count,
684 struct llog_cookie *cookies)
686 int i, index, rc = 0, failed = 0;
690 for (i = 0; i < count; i++, cookies++) {
691 struct llog_handle *loghandle;
692 struct llog_logid *lgl = &cookies->lgc_lgl;
695 rc = llog_cat_id2handle(env, cathandle, &loghandle, lgl);
697 CDEBUG(D_HA, "%s: cannot find llog for handle "DFID":%x"
699 cathandle->lgh_ctxt->loc_obd->obd_name,
700 PFID(&lgl->lgl_oi.oi_fid), lgl->lgl_ogen, rc);
705 if ((cathandle->lgh_ctxt->loc_flags &
706 LLOG_CTXT_FLAG_NORMAL_FID) && !llog_exist(loghandle)) {
707 /* For update log, some of loghandles of cathandle
708 * might not exist because remote llog creation might
709 * be failed, so let's skip the record cancellation
710 * for these non-exist llogs.
713 CDEBUG(D_HA, "%s: llog "DFID":%x does not exist"
715 cathandle->lgh_ctxt->loc_obd->obd_name,
716 PFID(&lgl->lgl_oi.oi_fid), lgl->lgl_ogen, lrc);
723 lrc = llog_cancel_rec(env, loghandle, cookies->lgc_index);
724 if (lrc == LLOG_DEL_PLAIN) { /* log has been destroyed */
725 index = loghandle->u.phd.phd_cookie.lgc_index;
726 lrc = llog_cat_cleanup(env, cathandle, loghandle,
730 } else if (lrc == -ENOENT) {
731 if (rc == 0) /* ENOENT shouldn't rewrite any error */
733 } else if (lrc < 0) {
738 llog_handle_put(loghandle);
741 CERROR("%s: fail to cancel %d of %d llog-records: rc = %d\n",
742 cathandle->lgh_ctxt->loc_obd->obd_name, failed, count,
747 EXPORT_SYMBOL(llog_cat_cancel_records);
749 static int llog_cat_process_common(const struct lu_env *env,
750 struct llog_handle *cat_llh,
751 struct llog_rec_hdr *rec,
752 struct llog_handle **llhp)
754 struct llog_logid_rec *lir = container_of(rec, typeof(*lir), lid_hdr);
755 struct llog_log_hdr *hdr;
759 if (rec->lrh_type != le32_to_cpu(LLOG_LOGID_MAGIC)) {
761 CWARN("%s: invalid record in catalog "DFID":%x: rc = %d\n",
762 cat_llh->lgh_ctxt->loc_obd->obd_name,
763 PFID(&cat_llh->lgh_id.lgl_oi.oi_fid),
764 cat_llh->lgh_id.lgl_ogen, rc);
767 CDEBUG(D_HA, "processing log "DFID":%x at index %u of catalog "DFID"\n",
768 PFID(&lir->lid_id.lgl_oi.oi_fid), lir->lid_id.lgl_ogen,
769 le32_to_cpu(rec->lrh_index),
770 PFID(&cat_llh->lgh_id.lgl_oi.oi_fid));
772 rc = llog_cat_id2handle(env, cat_llh, llhp, &lir->lid_id);
774 /* After a server crash, a stub of index record in catlog could
775 * be kept, because plain log destroy + catlog index record
776 * deletion are not atomic. So we end up with an index but no
777 * actual record. Destroy the index and move on. */
778 if (rc == -ENOENT || rc == -ESTALE)
779 rc = LLOG_DEL_RECORD;
781 CWARN("%s: can't find llog handle "DFID":%x: rc = %d\n",
782 cat_llh->lgh_ctxt->loc_obd->obd_name,
783 PFID(&lir->lid_id.lgl_oi.oi_fid),
784 lir->lid_id.lgl_ogen, rc);
789 /* clean old empty llogs, do not consider current llog in use */
790 /* ignore remote (lgh_obj == NULL) llogs */
791 hdr = (*llhp)->lgh_hdr;
792 if ((hdr->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
793 hdr->llh_count == 1 && cat_llh->lgh_obj != NULL &&
794 *llhp != cat_llh->u.chd.chd_current_log) {
795 rc = llog_destroy(env, *llhp);
797 CWARN("%s: can't destroy empty log "DFID": rc = %d\n",
798 (*llhp)->lgh_ctxt->loc_obd->obd_name,
799 PFID(&lir->lid_id.lgl_oi.oi_fid), rc);
806 static int llog_cat_process_cb(const struct lu_env *env,
807 struct llog_handle *cat_llh,
808 struct llog_rec_hdr *rec, void *data)
810 struct llog_process_data *d = data;
811 struct llog_handle *llh = NULL;
815 rc = llog_cat_process_common(env, cat_llh, rec, &llh);
819 if (rec->lrh_index < d->lpd_startcat) {
820 /* Skip processing of the logs until startcat */
822 } else if (d->lpd_startidx > 0) {
823 struct llog_process_cat_data cd;
825 cd.lpcd_first_idx = d->lpd_startidx;
826 cd.lpcd_last_idx = 0;
827 rc = llog_process_or_fork(env, llh, d->lpd_cb, d->lpd_data,
829 /* Continue processing the next log from idx 0 */
832 rc = llog_process_or_fork(env, llh, d->lpd_cb, d->lpd_data,
837 /* The empty plain log was destroyed while processing */
838 if (rc == LLOG_DEL_PLAIN) {
839 rc = llog_cat_cleanup(env, cat_llh, llh,
840 llh->u.phd.phd_cookie.lgc_index);
841 } else if (rc == LLOG_DEL_RECORD) {
842 /* clear wrong catalog entry */
843 rc = llog_cat_cleanup(env, cat_llh, NULL, rec->lrh_index);
847 llog_handle_put(llh);
852 int llog_cat_process_or_fork(const struct lu_env *env,
853 struct llog_handle *cat_llh, llog_cb_t cat_cb,
854 llog_cb_t cb, void *data, int startcat,
855 int startidx, bool fork)
857 struct llog_process_data d;
858 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
862 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
865 d.lpd_startcat = startcat;
866 d.lpd_startidx = startidx;
868 if (llh->llh_cat_idx >= cat_llh->lgh_last_idx &&
869 llh->llh_count > 1) {
870 struct llog_process_cat_data cd;
872 CWARN("%s: catlog "DFID" crosses index zero\n",
873 cat_llh->lgh_ctxt->loc_obd->obd_name,
874 PFID(&cat_llh->lgh_id.lgl_oi.oi_fid));
876 cd.lpcd_first_idx = llh->llh_cat_idx;
877 cd.lpcd_last_idx = 0;
878 rc = llog_process_or_fork(env, cat_llh, cat_cb,
883 cd.lpcd_first_idx = 0;
884 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
885 rc = llog_process_or_fork(env, cat_llh, cat_cb,
888 rc = llog_process_or_fork(env, cat_llh, cat_cb,
895 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
896 llog_cb_t cb, void *data, int startcat, int startidx)
898 return llog_cat_process_or_fork(env, cat_llh, llog_cat_process_cb,
899 cb, data, startcat, startidx, false);
901 EXPORT_SYMBOL(llog_cat_process);
903 static int llog_cat_size_cb(const struct lu_env *env,
904 struct llog_handle *cat_llh,
905 struct llog_rec_hdr *rec, void *data)
907 struct llog_process_data *d = data;
908 struct llog_handle *llh = NULL;
909 __u64 *cum_size = d->lpd_data;
914 rc = llog_cat_process_common(env, cat_llh, rec, &llh);
916 if (rc == LLOG_DEL_PLAIN) {
917 /* empty log was deleted, don't count it */
918 rc = llog_cat_cleanup(env, cat_llh, llh,
919 llh->u.phd.phd_cookie.lgc_index);
920 } else if (rc == LLOG_DEL_RECORD) {
921 /* clear wrong catalog entry */
922 rc = llog_cat_cleanup(env, cat_llh, NULL, rec->lrh_index);
924 size = llog_size(env, llh);
927 CDEBUG(D_INFO, "Add llog entry "DFID" size=%llu, tot=%llu\n",
928 PFID(&llh->lgh_id.lgl_oi.oi_fid), size, *cum_size);
932 llog_handle_put(llh);
937 __u64 llog_cat_size(const struct lu_env *env, struct llog_handle *cat_llh)
939 __u64 size = llog_size(env, cat_llh);
941 llog_cat_process_or_fork(env, cat_llh, llog_cat_size_cb,
942 NULL, &size, 0, 0, false);
946 EXPORT_SYMBOL(llog_cat_size);
948 /* currently returns the number of "free" entries in catalog,
949 * ie the available entries for a new plain LLOG file creation,
950 * even if catalog has wrapped
952 __u32 llog_cat_free_space(struct llog_handle *cat_llh)
954 /* simulate almost full Catalog */
955 if (OBD_FAIL_CHECK(OBD_FAIL_CAT_FREE_RECORDS))
958 if (cat_llh->lgh_hdr->llh_count == 1)
959 return LLOG_HDR_BITMAP_SIZE(cat_llh->lgh_hdr) - 1;
961 if (cat_llh->lgh_last_idx > cat_llh->lgh_hdr->llh_cat_idx)
962 return LLOG_HDR_BITMAP_SIZE(cat_llh->lgh_hdr) - 1 +
963 cat_llh->lgh_hdr->llh_cat_idx - cat_llh->lgh_last_idx;
965 /* catalog is presently wrapped */
966 return cat_llh->lgh_hdr->llh_cat_idx - cat_llh->lgh_last_idx;
968 EXPORT_SYMBOL(llog_cat_free_space);
970 static int llog_cat_reverse_process_cb(const struct lu_env *env,
971 struct llog_handle *cat_llh,
972 struct llog_rec_hdr *rec, void *data)
974 struct llog_process_data *d = data;
975 struct llog_handle *llh;
979 rc = llog_cat_process_common(env, cat_llh, rec, &llh);
981 /* The empty plain log was destroyed while processing */
982 if (rc == LLOG_DEL_PLAIN) {
983 rc = llog_cat_cleanup(env, cat_llh, llh,
984 llh->u.phd.phd_cookie.lgc_index);
985 } else if (rc == LLOG_DEL_RECORD) {
986 /* clear wrong catalog entry */
987 rc = llog_cat_cleanup(env, cat_llh, NULL, rec->lrh_index);
992 rc = llog_reverse_process(env, llh, d->lpd_cb, d->lpd_data, NULL);
994 /* The empty plain was destroyed while processing */
995 if (rc == LLOG_DEL_PLAIN)
996 rc = llog_cat_cleanup(env, cat_llh, llh,
997 llh->u.phd.phd_cookie.lgc_index);
999 llog_handle_put(llh);
1003 int llog_cat_reverse_process(const struct lu_env *env,
1004 struct llog_handle *cat_llh,
1005 llog_cb_t cb, void *data)
1007 struct llog_process_data d;
1008 struct llog_process_cat_data cd;
1009 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
1013 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
1017 if (llh->llh_cat_idx >= cat_llh->lgh_last_idx &&
1018 llh->llh_count > 1) {
1019 CWARN("%s: catalog "DFID" crosses index zero\n",
1020 cat_llh->lgh_ctxt->loc_obd->obd_name,
1021 PFID(&cat_llh->lgh_id.lgl_oi.oi_fid));
1023 cd.lpcd_first_idx = 0;
1024 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
1025 rc = llog_reverse_process(env, cat_llh,
1026 llog_cat_reverse_process_cb,
1031 cd.lpcd_first_idx = le32_to_cpu(llh->llh_cat_idx);
1032 cd.lpcd_last_idx = 0;
1033 rc = llog_reverse_process(env, cat_llh,
1034 llog_cat_reverse_process_cb,
1037 rc = llog_reverse_process(env, cat_llh,
1038 llog_cat_reverse_process_cb,
1044 EXPORT_SYMBOL(llog_cat_reverse_process);
1046 static int llog_cat_set_first_idx(struct llog_handle *cathandle, int idx)
1048 struct llog_log_hdr *llh = cathandle->lgh_hdr;
1053 bitmap_size = LLOG_HDR_BITMAP_SIZE(llh);
1055 * The llh_cat_idx equals to the first used index minus 1
1056 * so if we canceled the first index then llh_cat_idx
1059 if (llh->llh_cat_idx == (idx - 1)) {
1060 llh->llh_cat_idx = idx;
1062 while (idx != cathandle->lgh_last_idx) {
1063 idx = (idx + 1) % bitmap_size;
1064 if (!ext2_test_bit(idx, LLOG_HDR_BITMAP(llh))) {
1065 /* update llh_cat_idx for each unset bit,
1066 * expecting the next one is set */
1067 llh->llh_cat_idx = idx;
1068 } else if (idx == 0) {
1069 /* skip header bit */
1070 llh->llh_cat_idx = 0;
1073 /* the first index is found */
1078 CDEBUG(D_RPCTRACE, "catlog "DFID" first idx %u, last_idx %u\n",
1079 PFID(&cathandle->lgh_id.lgl_oi.oi_fid),
1080 llh->llh_cat_idx, cathandle->lgh_last_idx);
1086 /* Cleanup deleted plain llog traces from catalog */
1087 int llog_cat_cleanup(const struct lu_env *env, struct llog_handle *cathandle,
1088 struct llog_handle *loghandle, int index)
1093 if (loghandle != NULL) {
1094 /* remove destroyed llog from catalog list and
1095 * chd_current_log variable */
1096 down_write(&cathandle->lgh_lock);
1097 if (cathandle->u.chd.chd_current_log == loghandle)
1098 cathandle->u.chd.chd_current_log = NULL;
1099 list_del_init(&loghandle->u.phd.phd_entry);
1100 up_write(&cathandle->lgh_lock);
1101 LASSERT(index == loghandle->u.phd.phd_cookie.lgc_index);
1102 /* llog was opened and keep in a list, close it now */
1103 llog_close(env, loghandle);
1106 /* do not attempt to cleanup on-disk llog if on client side */
1107 if (cathandle->lgh_obj == NULL)
1110 /* remove plain llog entry from catalog by index */
1111 llog_cat_set_first_idx(cathandle, index);
1112 rc = llog_cancel_rec(env, cathandle, index);
1114 CDEBUG(D_HA, "cancel plain log at index %u of catalog "DFID"\n",
1115 index, PFID(&cathandle->lgh_id.lgl_oi.oi_fid));