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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/obdclass/llog.c
38 * OST<->MDS recovery logging infrastructure.
39 * Invariants in implementation:
40 * - we do not share logs among different OST<->MDS connections, so that
41 * if an OST or MDS fails it need only look at log(s) relevant to itself
43 * Author: Andreas Dilger <adilger@clusterfs.com>
44 * Author: Alex Zhuravlev <bzzz@whamcloud.com>
45 * Author: Mikhail Pershin <tappro@whamcloud.com>
48 #define DEBUG_SUBSYSTEM S_LOG
51 #include <obd_class.h>
52 #include <lustre_log.h>
53 #include "llog_internal.h"
56 * Allocate a new log or catalog handle
57 * Used inside llog_open().
59 struct llog_handle *llog_alloc_handle(void)
61 struct llog_handle *loghandle;
63 OBD_ALLOC_PTR(loghandle);
64 if (loghandle == NULL)
67 init_rwsem(&loghandle->lgh_lock);
68 spin_lock_init(&loghandle->lgh_hdr_lock);
69 INIT_LIST_HEAD(&loghandle->u.phd.phd_entry);
70 atomic_set(&loghandle->lgh_refcount, 1);
76 * Free llog handle and header data if exists. Used in llog_close() only
78 void llog_free_handle(struct llog_handle *loghandle)
80 LASSERT(loghandle != NULL);
82 /* failed llog_init_handle */
83 if (!loghandle->lgh_hdr)
86 if (loghandle->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)
87 LASSERT(list_empty(&loghandle->u.phd.phd_entry));
88 else if (loghandle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)
89 LASSERT(list_empty(&loghandle->u.chd.chd_head));
90 LASSERT(sizeof(*(loghandle->lgh_hdr)) == LLOG_CHUNK_SIZE);
91 OBD_FREE(loghandle->lgh_hdr, LLOG_CHUNK_SIZE);
93 OBD_FREE_PTR(loghandle);
96 void llog_handle_get(struct llog_handle *loghandle)
98 atomic_inc(&loghandle->lgh_refcount);
101 void llog_handle_put(struct llog_handle *loghandle)
103 LASSERT(atomic_read(&loghandle->lgh_refcount) > 0);
104 if (atomic_dec_and_test(&loghandle->lgh_refcount))
105 llog_free_handle(loghandle);
108 /* returns negative on error; 0 if success; 1 if success & log destroyed */
109 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
112 struct llog_log_hdr *llh = loghandle->lgh_hdr;
116 CDEBUG(D_RPCTRACE, "Canceling %d in log "DOSTID"\n",
117 index, POSTID(&loghandle->lgh_id.lgl_oi));
120 CERROR("Can't cancel index 0 which is header\n");
124 spin_lock(&loghandle->lgh_hdr_lock);
125 if (!ext2_clear_bit(index, llh->llh_bitmap)) {
126 spin_unlock(&loghandle->lgh_hdr_lock);
127 CDEBUG(D_RPCTRACE, "Catalog index %u already clear?\n", index);
133 if ((llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
134 (llh->llh_count == 1) &&
135 (loghandle->lgh_last_idx == (LLOG_BITMAP_BYTES * 8) - 1)) {
136 spin_unlock(&loghandle->lgh_hdr_lock);
137 rc = llog_destroy(env, loghandle);
139 CERROR("%s: can't destroy empty llog #"DOSTID
141 loghandle->lgh_ctxt->loc_obd->obd_name,
142 POSTID(&loghandle->lgh_id.lgl_oi),
143 loghandle->lgh_id.lgl_ogen, rc);
146 RETURN(LLOG_DEL_PLAIN);
148 spin_unlock(&loghandle->lgh_hdr_lock);
150 rc = llog_write(env, loghandle, &llh->llh_hdr, LLOG_HEADER_IDX);
152 CERROR("%s: fail to write header for llog #"DOSTID
154 loghandle->lgh_ctxt->loc_obd->obd_name,
155 POSTID(&loghandle->lgh_id.lgl_oi),
156 loghandle->lgh_id.lgl_ogen, rc);
161 spin_lock(&loghandle->lgh_hdr_lock);
162 ext2_set_bit(index, llh->llh_bitmap);
164 spin_unlock(&loghandle->lgh_hdr_lock);
167 EXPORT_SYMBOL(llog_cancel_rec);
169 static int llog_read_header(const struct lu_env *env,
170 struct llog_handle *handle,
171 struct obd_uuid *uuid)
173 struct llog_operations *lop;
176 rc = llog_handle2ops(handle, &lop);
180 if (lop->lop_read_header == NULL)
183 rc = lop->lop_read_header(env, handle);
184 if (rc == LLOG_EEMPTY) {
185 struct llog_log_hdr *llh = handle->lgh_hdr;
187 handle->lgh_last_idx = 0; /* header is record with index 0 */
188 llh->llh_count = 1; /* for the header record */
189 llh->llh_hdr.lrh_type = LLOG_HDR_MAGIC;
190 llh->llh_hdr.lrh_len = llh->llh_tail.lrt_len = LLOG_CHUNK_SIZE;
191 llh->llh_hdr.lrh_index = llh->llh_tail.lrt_index = 0;
192 llh->llh_timestamp = cfs_time_current_sec();
194 memcpy(&llh->llh_tgtuuid, uuid,
195 sizeof(llh->llh_tgtuuid));
196 llh->llh_bitmap_offset = offsetof(typeof(*llh), llh_bitmap);
197 ext2_set_bit(0, llh->llh_bitmap);
203 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
204 int flags, struct obd_uuid *uuid)
206 struct llog_log_hdr *llh;
207 enum llog_flag fmt = flags & LLOG_F_EXT_MASK;
211 LASSERT(handle->lgh_hdr == NULL);
216 handle->lgh_hdr = llh;
217 /* first assign flags to use llog_client_ops */
218 llh->llh_flags = flags;
219 rc = llog_read_header(env, handle, uuid);
221 if (unlikely((llh->llh_flags & LLOG_F_IS_PLAIN &&
222 flags & LLOG_F_IS_CAT) ||
223 (llh->llh_flags & LLOG_F_IS_CAT &&
224 flags & LLOG_F_IS_PLAIN))) {
225 CERROR("%s: llog type is %s but initializing %s\n",
226 handle->lgh_ctxt->loc_obd->obd_name,
227 llh->llh_flags & LLOG_F_IS_CAT ?
229 flags & LLOG_F_IS_CAT ? "catalog" : "plain");
230 GOTO(out, rc = -EINVAL);
231 } else if (llh->llh_flags &
232 (LLOG_F_IS_PLAIN | LLOG_F_IS_CAT)) {
234 * it is possible to open llog without specifying llog
235 * type so it is taken from llh_flags
237 flags = llh->llh_flags;
239 /* for some reason the llh_flags has no type set */
240 CERROR("llog type is not specified!\n");
241 GOTO(out, rc = -EINVAL);
244 !obd_uuid_equals(uuid, &llh->llh_tgtuuid))) {
245 CERROR("%s: llog uuid mismatch: %s/%s\n",
246 handle->lgh_ctxt->loc_obd->obd_name,
248 (char *)llh->llh_tgtuuid.uuid);
249 GOTO(out, rc = -EEXIST);
252 if (flags & LLOG_F_IS_CAT) {
253 LASSERT(list_empty(&handle->u.chd.chd_head));
254 INIT_LIST_HEAD(&handle->u.chd.chd_head);
255 llh->llh_size = sizeof(struct llog_logid_rec);
256 } else if (!(flags & LLOG_F_IS_PLAIN)) {
257 CERROR("%s: unknown flags: %#x (expected %#x or %#x)\n",
258 handle->lgh_ctxt->loc_obd->obd_name,
259 flags, LLOG_F_IS_CAT, LLOG_F_IS_PLAIN);
262 llh->llh_flags |= fmt;
266 handle->lgh_hdr = NULL;
270 EXPORT_SYMBOL(llog_init_handle);
272 static int llog_process_thread(void *arg)
274 struct llog_process_info *lpi = arg;
275 struct llog_handle *loghandle = lpi->lpi_loghandle;
276 struct llog_log_hdr *llh = loghandle->lgh_hdr;
277 struct llog_process_cat_data *cd = lpi->lpi_catdata;
279 __u64 cur_offset = LLOG_CHUNK_SIZE;
281 int rc = 0, index = 1, last_index;
283 int last_called_index = 0;
289 OBD_ALLOC(buf, LLOG_CHUNK_SIZE);
291 lpi->lpi_rc = -ENOMEM;
296 last_called_index = cd->lpcd_first_idx;
297 index = cd->lpcd_first_idx + 1;
299 if (cd != NULL && cd->lpcd_last_idx)
300 last_index = cd->lpcd_last_idx;
302 last_index = LLOG_BITMAP_BYTES * 8 - 1;
305 struct llog_rec_hdr *rec;
307 /* skip records not set in bitmap */
308 while (index <= last_index &&
309 !ext2_test_bit(index, llh->llh_bitmap))
312 LASSERT(index <= last_index + 1);
313 if (index == last_index + 1)
316 CDEBUG(D_OTHER, "index: %d last_index %d\n",
319 /* get the buf with our target record; avoid old garbage */
320 memset(buf, 0, LLOG_CHUNK_SIZE);
321 last_offset = cur_offset;
322 rc = llog_next_block(lpi->lpi_env, loghandle, &saved_index,
323 index, &cur_offset, buf, LLOG_CHUNK_SIZE);
327 /* NB: when rec->lrh_len is accessed it is already swabbed
328 * since it is used at the "end" of the loop and the rec
329 * swabbing is done at the beginning of the loop. */
330 for (rec = (struct llog_rec_hdr *)buf;
331 (char *)rec < buf + LLOG_CHUNK_SIZE;
332 rec = llog_rec_hdr_next(rec)) {
334 CDEBUG(D_OTHER, "processing rec 0x%p type %#x\n",
337 if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
338 lustre_swab_llog_rec(rec);
340 CDEBUG(D_OTHER, "after swabbing, type=%#x idx=%d\n",
341 rec->lrh_type, rec->lrh_index);
343 if (rec->lrh_index == 0) {
344 /* probably another rec just got added? */
345 if (index <= loghandle->lgh_last_idx)
346 GOTO(repeat, rc = 0);
347 GOTO(out, rc = 0); /* no more records */
349 if (rec->lrh_len == 0 ||
350 rec->lrh_len > LLOG_CHUNK_SIZE) {
351 CWARN("invalid length %d in llog record for "
352 "index %d/%d\n", rec->lrh_len,
353 rec->lrh_index, index);
354 GOTO(out, rc = -EINVAL);
357 if (rec->lrh_index < index) {
358 CDEBUG(D_OTHER, "skipping lrh_index %d\n",
364 "lrh_index: %d lrh_len: %d (%d remains)\n",
365 rec->lrh_index, rec->lrh_len,
366 (int)(buf + LLOG_CHUNK_SIZE - (char *)rec));
368 loghandle->lgh_cur_idx = rec->lrh_index;
369 loghandle->lgh_cur_offset = (char *)rec - (char *)buf +
372 /* if set, process the callback on this record */
373 if (ext2_test_bit(index, llh->llh_bitmap)) {
374 rc = lpi->lpi_cb(lpi->lpi_env, loghandle, rec,
376 last_called_index = index;
377 if (rc == LLOG_PROC_BREAK) {
379 } else if (rc == LLOG_DEL_RECORD) {
380 rc = llog_cancel_rec(lpi->lpi_env,
387 CDEBUG(D_OTHER, "Skipped index %d\n", index);
390 /* next record, still in buffer? */
392 if (index > last_index)
399 cd->lpcd_last_idx = last_called_index;
401 if (unlikely(rc == -EIO && loghandle->lgh_obj != NULL)) {
402 /* something bad happened to the processing of a local
403 * llog file, probably I/O error or the log got corrupted..
404 * to be able to finally release the log we discard any
405 * remaining bits in the header */
406 CERROR("Local llog found corrupted\n");
407 while (index <= last_index) {
408 if (ext2_test_bit(index, llh->llh_bitmap) != 0)
409 llog_cancel_rec(lpi->lpi_env, loghandle, index);
415 OBD_FREE(buf, LLOG_CHUNK_SIZE);
420 static int llog_process_thread_daemonize(void *arg)
422 struct llog_process_info *lpi = arg;
428 /* client env has no keys, tags is just 0 */
429 rc = lu_env_init(&env, LCT_LOCAL | LCT_MG_THREAD);
434 rc = llog_process_thread(arg);
438 complete(&lpi->lpi_completion);
442 int llog_process_or_fork(const struct lu_env *env,
443 struct llog_handle *loghandle,
444 llog_cb_t cb, void *data, void *catdata, bool fork)
446 struct llog_process_info *lpi;
453 CERROR("cannot alloc pointer\n");
456 lpi->lpi_loghandle = loghandle;
458 lpi->lpi_cbdata = data;
459 lpi->lpi_catdata = catdata;
462 struct task_struct *task;
464 /* The new thread can't use parent env,
465 * init the new one in llog_process_thread_daemonize. */
467 init_completion(&lpi->lpi_completion);
468 task = kthread_run(llog_process_thread_daemonize, lpi,
469 "llog_process_thread");
472 CERROR("%s: cannot start thread: rc = %d\n",
473 loghandle->lgh_ctxt->loc_obd->obd_name, rc);
476 wait_for_completion(&lpi->lpi_completion);
479 llog_process_thread(lpi);
487 EXPORT_SYMBOL(llog_process_or_fork);
489 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
490 llog_cb_t cb, void *data, void *catdata)
493 rc = llog_process_or_fork(env, loghandle, cb, data, catdata, true);
494 return rc == LLOG_DEL_PLAIN ? 0 : rc;
496 EXPORT_SYMBOL(llog_process);
498 int llog_reverse_process(const struct lu_env *env,
499 struct llog_handle *loghandle, llog_cb_t cb,
500 void *data, void *catdata)
502 struct llog_log_hdr *llh = loghandle->lgh_hdr;
503 struct llog_process_cat_data *cd = catdata;
505 int rc = 0, first_index = 1, index, idx;
508 OBD_ALLOC(buf, LLOG_CHUNK_SIZE);
513 first_index = cd->lpcd_first_idx + 1;
514 if (cd != NULL && cd->lpcd_last_idx)
515 index = cd->lpcd_last_idx;
517 index = LLOG_BITMAP_BYTES * 8 - 1;
520 struct llog_rec_hdr *rec;
521 struct llog_rec_tail *tail;
523 /* skip records not set in bitmap */
524 while (index >= first_index &&
525 !ext2_test_bit(index, llh->llh_bitmap))
528 LASSERT(index >= first_index - 1);
529 if (index == first_index - 1)
532 /* get the buf with our target record; avoid old garbage */
533 memset(buf, 0, LLOG_CHUNK_SIZE);
534 rc = llog_prev_block(env, loghandle, index, buf,
540 idx = rec->lrh_index;
541 CDEBUG(D_RPCTRACE, "index %u : idx %u\n", index, idx);
542 while (idx < index) {
543 rec = (void *)rec + rec->lrh_len;
544 if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
545 lustre_swab_llog_rec(rec);
548 LASSERT(idx == index);
549 tail = (void *)rec + rec->lrh_len - sizeof(*tail);
551 /* process records in buffer, starting where we found one */
552 while ((void *)tail > buf) {
553 if (tail->lrt_index == 0)
554 GOTO(out, rc = 0); /* no more records */
556 /* if set, process the callback on this record */
557 if (ext2_test_bit(index, llh->llh_bitmap)) {
558 rec = (void *)tail - tail->lrt_len +
561 rc = cb(env, loghandle, rec, data);
562 if (rc == LLOG_PROC_BREAK) {
564 } else if (rc == LLOG_DEL_RECORD) {
565 rc = llog_cancel_rec(env, loghandle,
572 /* previous record, still in buffer? */
574 if (index < first_index)
576 tail = (void *)tail - tail->lrt_len;
582 OBD_FREE(buf, LLOG_CHUNK_SIZE);
585 EXPORT_SYMBOL(llog_reverse_process);
591 * llog_open - open llog, may not exist
592 * llog_exist - check if llog exists
593 * llog_close - close opened llog, pair for open, frees llog_handle
594 * llog_declare_create - declare llog creation
595 * llog_create - create new llog on disk, need transaction handle
596 * llog_declare_write_rec - declaration of llog write
597 * llog_write_rec - write llog record on disk, need transaction handle
598 * llog_declare_add - declare llog catalog record addition
599 * llog_add - add llog record in catalog, need transaction handle
601 int llog_exist(struct llog_handle *loghandle)
603 struct llog_operations *lop;
608 rc = llog_handle2ops(loghandle, &lop);
611 if (lop->lop_exist == NULL)
614 rc = lop->lop_exist(loghandle);
617 EXPORT_SYMBOL(llog_exist);
619 int llog_declare_create(const struct lu_env *env,
620 struct llog_handle *loghandle, struct thandle *th)
622 struct llog_operations *lop;
627 rc = llog_handle2ops(loghandle, &lop);
630 if (lop->lop_declare_create == NULL)
633 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
635 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
636 rc = lop->lop_declare_create(env, loghandle, th);
638 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
641 EXPORT_SYMBOL(llog_declare_create);
643 int llog_create(const struct lu_env *env, struct llog_handle *handle,
646 struct llog_operations *lop;
651 rc = llog_handle2ops(handle, &lop);
654 if (lop->lop_create == NULL)
657 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
659 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
660 rc = lop->lop_create(env, handle, th);
662 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
665 EXPORT_SYMBOL(llog_create);
667 int llog_declare_write_rec(const struct lu_env *env,
668 struct llog_handle *handle,
669 struct llog_rec_hdr *rec, int idx,
672 struct llog_operations *lop;
677 rc = llog_handle2ops(handle, &lop);
681 if (lop->lop_declare_write_rec == NULL)
684 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
686 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
687 rc = lop->lop_declare_write_rec(env, handle, rec, idx, th);
689 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
692 EXPORT_SYMBOL(llog_declare_write_rec);
694 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
695 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
696 int idx, struct thandle *th)
698 struct llog_operations *lop;
699 int raised, rc, buflen;
703 rc = llog_handle2ops(handle, &lop);
708 if (lop->lop_write_rec == NULL)
711 buflen = rec->lrh_len;
712 LASSERT(cfs_size_round(buflen) == buflen);
714 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
716 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
717 rc = lop->lop_write_rec(env, handle, rec, logcookies, idx, th);
719 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
722 EXPORT_SYMBOL(llog_write_rec);
724 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
725 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
732 if (lgh->lgh_logops->lop_add == NULL)
735 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
737 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
738 rc = lgh->lgh_logops->lop_add(env, lgh, rec, logcookies, th);
740 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
743 EXPORT_SYMBOL(llog_add);
745 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
746 struct llog_rec_hdr *rec, struct thandle *th)
752 if (lgh->lgh_logops->lop_declare_add == NULL)
755 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
757 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
758 rc = lgh->lgh_logops->lop_declare_add(env, lgh, rec, th);
760 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
763 EXPORT_SYMBOL(llog_declare_add);
766 * Helper function to open llog or create it if doesn't exist.
767 * It hides all transaction handling from caller.
769 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
770 struct llog_handle **res, struct llog_logid *logid,
779 rc = llog_open(env, ctxt, res, logid, name, LLOG_OPEN_NEW);
783 if (llog_exist(*res))
786 LASSERT((*res)->lgh_obj != NULL);
788 d = lu2dt_dev((*res)->lgh_obj->do_lu.lo_dev);
790 th = dt_trans_create(env, d);
792 GOTO(out, rc = PTR_ERR(th));
794 rc = llog_declare_create(env, *res, th);
796 rc = dt_trans_start_local(env, d, th);
798 rc = llog_create(env, *res, th);
800 dt_trans_stop(env, d, th);
803 llog_close(env, *res);
806 EXPORT_SYMBOL(llog_open_create);
809 * Helper function to delete existent llog.
811 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
812 struct llog_logid *logid, char *name)
814 struct llog_handle *handle;
819 /* nothing to erase */
820 if (name == NULL && logid == NULL)
823 rc = llog_open(env, ctxt, &handle, logid, name, LLOG_OPEN_EXISTS);
827 rc = llog_init_handle(env, handle, LLOG_F_IS_PLAIN, NULL);
829 rc = llog_destroy(env, handle);
831 rc2 = llog_close(env, handle);
836 EXPORT_SYMBOL(llog_erase);
839 * Helper function for write record in llog.
840 * It hides all transaction handling from caller.
841 * Valid only with local llog.
843 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
844 struct llog_rec_hdr *rec, int idx)
846 struct dt_device *dt;
853 LASSERT(loghandle->lgh_ctxt);
854 LASSERT(loghandle->lgh_obj != NULL);
856 dt = lu2dt_dev(loghandle->lgh_obj->do_lu.lo_dev);
858 th = dt_trans_create(env, dt);
862 rc = llog_declare_write_rec(env, loghandle, rec, idx, th);
866 rc = dt_trans_start_local(env, dt, th);
870 down_write(&loghandle->lgh_lock);
871 rc = llog_write_rec(env, loghandle, rec, NULL, idx, th);
872 up_write(&loghandle->lgh_lock);
874 dt_trans_stop(env, dt, th);
877 EXPORT_SYMBOL(llog_write);
879 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
880 struct llog_handle **lgh, struct llog_logid *logid,
881 char *name, enum llog_open_param open_param)
889 LASSERT(ctxt->loc_logops);
891 if (ctxt->loc_logops->lop_open == NULL) {
896 *lgh = llog_alloc_handle();
899 (*lgh)->lgh_ctxt = ctxt;
900 (*lgh)->lgh_logops = ctxt->loc_logops;
902 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
904 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
905 rc = ctxt->loc_logops->lop_open(env, *lgh, logid, name, open_param);
907 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
909 llog_free_handle(*lgh);
914 EXPORT_SYMBOL(llog_open);
916 int llog_close(const struct lu_env *env, struct llog_handle *loghandle)
918 struct llog_operations *lop;
923 rc = llog_handle2ops(loghandle, &lop);
926 if (lop->lop_close == NULL)
927 GOTO(out, rc = -EOPNOTSUPP);
928 rc = lop->lop_close(env, loghandle);
930 llog_handle_put(loghandle);
933 EXPORT_SYMBOL(llog_close);
936 * Helper function to get the llog size in records. It is used by MGS
937 * mostly to check that config llog exists and contains data.
939 * \param[in] env execution environment
940 * \param[in] ctxt llog context
941 * \param[in] name llog name
943 * \retval true if there are records in llog besides a header
944 * \retval false on error or llog without records
946 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
949 struct llog_handle *llh;
952 rc = llog_open(env, ctxt, &llh, NULL, name, LLOG_OPEN_EXISTS);
954 if (likely(rc == -ENOENT))
959 rc = llog_init_handle(env, llh, LLOG_F_IS_PLAIN, NULL);
962 rc = llog_get_size(llh);
965 llog_close(env, llh);
967 /* The header is record 1, the llog is still considered as empty
968 * if there is only header */
971 EXPORT_SYMBOL(llog_is_empty);
973 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
974 struct llog_rec_hdr *rec, void *data)
976 struct llog_handle *copy_llh = data;
978 /* Append all records */
979 return llog_write(env, copy_llh, rec, LLOG_NEXT_IDX);
981 EXPORT_SYMBOL(llog_copy_handler);
983 /* backup plain llog */
984 int llog_backup(const struct lu_env *env, struct obd_device *obd,
985 struct llog_ctxt *ctxt, struct llog_ctxt *bctxt,
986 char *name, char *backup)
988 struct llog_handle *llh, *bllh;
993 /* open original log */
994 rc = llog_open(env, ctxt, &llh, NULL, name, LLOG_OPEN_EXISTS);
996 /* the -ENOENT case is also reported to the caller
997 * but silently so it should handle that if needed.
1000 CERROR("%s: failed to open log %s: rc = %d\n",
1001 obd->obd_name, name, rc);
1005 rc = llog_init_handle(env, llh, LLOG_F_IS_PLAIN, NULL);
1007 GOTO(out_close, rc);
1009 /* Make sure there's no old backup log */
1010 rc = llog_erase(env, bctxt, NULL, backup);
1011 if (rc < 0 && rc != -ENOENT)
1012 GOTO(out_close, rc);
1014 /* open backup log */
1015 rc = llog_open_create(env, bctxt, &bllh, NULL, backup);
1017 CERROR("%s: failed to open backup logfile %s: rc = %d\n",
1018 obd->obd_name, backup, rc);
1019 GOTO(out_close, rc);
1022 /* check that backup llog is not the same object as original one */
1023 if (llh->lgh_obj == bllh->lgh_obj) {
1024 CERROR("%s: backup llog %s to itself (%s), objects %p/%p\n",
1025 obd->obd_name, name, backup, llh->lgh_obj,
1027 GOTO(out_backup, rc = -EEXIST);
1030 rc = llog_init_handle(env, bllh, LLOG_F_IS_PLAIN, NULL);
1032 GOTO(out_backup, rc);
1034 /* Copy log record by record */
1035 rc = llog_process_or_fork(env, llh, llog_copy_handler, (void *)bllh,
1038 CERROR("%s: failed to backup log %s: rc = %d\n",
1039 obd->obd_name, name, rc);
1041 llog_close(env, bllh);
1043 llog_close(env, llh);
1046 EXPORT_SYMBOL(llog_backup);