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.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
34 * lustre/obdclass/llog_cat.c
36 * OST<->MDS recovery logging infrastructure.
38 * Invariants in implementation:
39 * - we do not share logs among different OST<->MDS connections, so that
40 * if an OST or MDS fails it need only look at log(s) relevant to itself
42 * Author: Andreas Dilger <adilger@clusterfs.com>
45 #define DEBUG_SUBSYSTEM S_LOG
48 #include <liblustre.h>
51 #include <obd_class.h>
52 #include <lustre_log.h>
53 #include <libcfs/list.h>
55 /* Create a new log handle and add it to the open list.
56 * This log handle will be closed when all of the records in it are removed.
58 * Assumes caller has already pushed us into the kernel context and is locking.
60 static struct llog_handle *llog_cat_new_log(struct llog_handle *cathandle)
62 struct llog_handle *loghandle;
63 struct llog_log_hdr *llh;
64 struct llog_logid_rec rec = { { 0 }, };
65 int rc, index, bitmap_size;
68 llh = cathandle->lgh_hdr;
69 bitmap_size = LLOG_BITMAP_SIZE(llh);
71 index = (cathandle->lgh_last_idx + 1) % bitmap_size;
73 /* maximum number of available slots in catlog is bitmap_size - 2 */
74 if (llh->llh_cat_idx == index) {
75 CERROR("no free catalog slots for log...\n");
76 RETURN(ERR_PTR(-ENOSPC));
79 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED))
80 RETURN(ERR_PTR(-ENOSPC));
82 rc = llog_create(cathandle->lgh_ctxt, &loghandle, NULL, NULL);
86 rc = llog_init_handle(loghandle,
87 LLOG_F_IS_PLAIN | LLOG_F_ZAP_WHEN_EMPTY,
88 &cathandle->lgh_hdr->llh_tgtuuid);
90 GOTO(out_destroy, rc);
94 if (ext2_set_bit(index, llh->llh_bitmap)) {
95 CERROR("argh, index %u already set in log bitmap?\n",
97 LBUG(); /* should never happen */
99 cathandle->lgh_last_idx = index;
101 llh->llh_tail.lrt_index = index;
103 CDEBUG(D_RPCTRACE,"new recovery log "LPX64":%x for index %u of catalog "
104 LPX64"\n", loghandle->lgh_id.lgl_oid, loghandle->lgh_id.lgl_ogen,
105 index, cathandle->lgh_id.lgl_oid);
106 /* build the record for this log in the catalog */
107 rec.lid_hdr.lrh_len = sizeof(rec);
108 rec.lid_hdr.lrh_index = index;
109 rec.lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
110 rec.lid_id = loghandle->lgh_id;
111 rec.lid_tail.lrt_len = sizeof(rec);
112 rec.lid_tail.lrt_index = index;
114 /* update the catalog: header and record */
115 rc = llog_write_rec(cathandle, &rec.lid_hdr,
116 &loghandle->u.phd.phd_cookie, 1, NULL, index);
118 GOTO(out_destroy, rc);
121 loghandle->lgh_hdr->llh_cat_idx = index;
122 cathandle->u.chd.chd_current_log = loghandle;
123 LASSERT(cfs_list_empty(&loghandle->u.phd.phd_entry));
124 cfs_list_add_tail(&loghandle->u.phd.phd_entry,
125 &cathandle->u.chd.chd_head);
129 llog_destroy(loghandle);
134 /* Open an existent log handle and add it to the open list.
135 * This log handle will be closed when all of the records in it are removed.
137 * Assumes caller has already pushed us into the kernel context and is locking.
138 * We return a lock on the handle to ensure nobody yanks it from us.
140 int llog_cat_id2handle(struct llog_handle *cathandle, struct llog_handle **res,
141 struct llog_logid *logid)
143 struct llog_handle *loghandle;
147 if (cathandle == NULL)
150 cfs_list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
152 struct llog_logid *cgl = &loghandle->lgh_id;
153 if (cgl->lgl_oid == logid->lgl_oid) {
154 if (cgl->lgl_ogen != logid->lgl_ogen) {
155 CERROR("log "LPX64" generation %x != %x\n",
156 logid->lgl_oid, cgl->lgl_ogen,
160 loghandle->u.phd.phd_cat_handle = cathandle;
165 rc = llog_create(cathandle->lgh_ctxt, &loghandle, logid, NULL);
167 CERROR("error opening log id "LPX64":%x: rc %d\n",
168 logid->lgl_oid, logid->lgl_ogen, rc);
170 rc = llog_init_handle(loghandle, LLOG_F_IS_PLAIN, NULL);
172 cfs_list_add(&loghandle->u.phd.phd_entry,
173 &cathandle->u.chd.chd_head);
177 loghandle->u.phd.phd_cat_handle = cathandle;
178 loghandle->u.phd.phd_cookie.lgc_lgl = cathandle->lgh_id;
179 loghandle->u.phd.phd_cookie.lgc_index =
180 loghandle->lgh_hdr->llh_cat_idx;
188 int llog_cat_put(struct llog_handle *cathandle)
190 struct llog_handle *loghandle, *n;
194 cfs_list_for_each_entry_safe(loghandle, n, &cathandle->u.chd.chd_head,
196 int err = llog_close(loghandle);
198 CERROR("error closing loghandle\n");
200 rc = llog_close(cathandle);
203 EXPORT_SYMBOL(llog_cat_put);
206 * lockdep markers for nested struct llog_handle::lgh_lock locking.
213 /** Return the currently active log handle. If the current log handle doesn't
214 * have enough space left for the current record, start a new one.
216 * If reclen is 0, we only want to know what the currently active log is,
217 * otherwise we get a lock on this log so nobody can steal our space.
219 * Assumes caller has already pushed us into the kernel context and is locking.
221 * NOTE: loghandle is write-locked upon successful return
223 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
226 struct llog_handle *loghandle = NULL;
229 cfs_down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
230 loghandle = cathandle->u.chd.chd_current_log;
232 struct llog_log_hdr *llh = loghandle->lgh_hdr;
233 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
234 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
235 cfs_up_read(&cathandle->lgh_lock);
238 cfs_up_write(&loghandle->lgh_lock);
243 cfs_down_write(&loghandle->lgh_lock);
244 cfs_up_read(&cathandle->lgh_lock);
247 cfs_up_read(&cathandle->lgh_lock);
249 /* time to create new log */
251 /* first, we have to make sure the state hasn't changed */
252 cfs_down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
253 loghandle = cathandle->u.chd.chd_current_log;
255 struct llog_log_hdr *llh = loghandle->lgh_hdr;
256 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
257 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
258 cfs_up_write(&cathandle->lgh_lock);
261 cfs_up_write(&loghandle->lgh_lock);
265 CDEBUG(D_INODE, "creating new log\n");
266 loghandle = llog_cat_new_log(cathandle);
267 if (!IS_ERR(loghandle))
268 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
269 cfs_up_write(&cathandle->lgh_lock);
273 /* Add a single record to the recovery log(s) using a catalog
274 * Returns as llog_write_record
276 * Assumes caller has already pushed us into the kernel context.
278 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
279 struct llog_cookie *reccookie, void *buf)
281 struct llog_handle *loghandle;
285 LASSERT(rec->lrh_len <= LLOG_CHUNK_SIZE);
286 loghandle = llog_cat_current_log(cathandle, 1);
287 if (IS_ERR(loghandle))
288 RETURN(PTR_ERR(loghandle));
289 /* loghandle is already locked by llog_cat_current_log() for us */
290 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
292 CERROR("llog_write_rec %d: lh=%p\n", rc, loghandle);
293 cfs_up_write(&loghandle->lgh_lock);
295 /* to create a new plain log */
296 loghandle = llog_cat_current_log(cathandle, 1);
297 if (IS_ERR(loghandle))
298 RETURN(PTR_ERR(loghandle));
299 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
300 cfs_up_write(&loghandle->lgh_lock);
305 EXPORT_SYMBOL(llog_cat_add_rec);
307 /* For each cookie in the cookie array, we clear the log in-use bit and either:
308 * - the log is empty, so mark it free in the catalog header and delete it
309 * - the log is not empty, just write out the log header
311 * The cookies may be in different log files, so we need to get new logs
314 * Assumes caller has already pushed us into the kernel context.
316 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
317 struct llog_cookie *cookies)
319 int i, index, rc = 0;
322 cfs_down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
323 for (i = 0; i < count; i++, cookies++) {
324 struct llog_handle *loghandle;
325 struct llog_logid *lgl = &cookies->lgc_lgl;
327 rc = llog_cat_id2handle(cathandle, &loghandle, lgl);
329 CERROR("Cannot find log "LPX64"\n", lgl->lgl_oid);
333 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
334 rc = llog_cancel_rec(loghandle, cookies->lgc_index);
335 cfs_up_write(&loghandle->lgh_lock);
337 if (rc == 1) { /* log has been destroyed */
338 index = loghandle->u.phd.phd_cookie.lgc_index;
339 if (cathandle->u.chd.chd_current_log == loghandle)
340 cathandle->u.chd.chd_current_log = NULL;
341 llog_free_handle(loghandle);
344 llog_cat_set_first_idx(cathandle, index);
345 rc = llog_cancel_rec(cathandle, index);
347 CDEBUG(D_RPCTRACE,"cancel plain log at index %u"
348 " of catalog "LPX64"\n",
349 index, cathandle->lgh_id.lgl_oid);
352 cfs_up_write(&cathandle->lgh_lock);
356 EXPORT_SYMBOL(llog_cat_cancel_records);
358 int llog_cat_process_cb(struct llog_handle *cat_llh, struct llog_rec_hdr *rec,
361 struct llog_process_data *d = data;
362 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
363 struct llog_handle *llh;
367 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
368 CERROR("invalid record in catalog\n");
371 CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
372 LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
373 rec->lrh_index, cat_llh->lgh_id.lgl_oid);
375 rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
377 CERROR("Cannot find handle for log "LPX64"\n",
378 lir->lid_id.lgl_oid);
382 if (rec->lrh_index < d->lpd_startcat)
383 /* Skip processing of the logs until startcat */
386 if (d->lpd_startidx > 0) {
387 struct llog_process_cat_data cd;
389 cd.lpcd_first_idx = d->lpd_startidx;
390 cd.lpcd_last_idx = 0;
391 rc = llog_process_flags(llh, d->lpd_cb, d->lpd_data, &cd,
393 /* Continue processing the next log from idx 0 */
396 rc = llog_process_flags(llh, d->lpd_cb, d->lpd_data, NULL,
403 int llog_cat_process_flags(struct llog_handle *cat_llh, llog_cb_t cb,
404 void *data, int flags, int startcat, int startidx)
406 struct llog_process_data d;
407 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
411 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
414 d.lpd_startcat = startcat;
415 d.lpd_startidx = startidx;
418 if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
419 struct llog_process_cat_data cd;
421 CWARN("catlog "LPX64" crosses index zero\n",
422 cat_llh->lgh_id.lgl_oid);
424 cd.lpcd_first_idx = llh->llh_cat_idx;
425 cd.lpcd_last_idx = 0;
426 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, &cd,
431 cd.lpcd_first_idx = 0;
432 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
433 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, &cd,
436 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, NULL,
442 EXPORT_SYMBOL(llog_cat_process_flags);
444 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data,
445 int startcat, int startidx)
447 return llog_cat_process_flags(cat_llh, cb, data, 0, startcat, startidx);
449 EXPORT_SYMBOL(llog_cat_process);
452 int llog_cat_process_thread(void *data)
454 struct llog_process_cat_args *args = data;
455 struct llog_ctxt *ctxt = args->lpca_ctxt;
456 struct llog_handle *llh = NULL;
457 llog_cb_t cb = args->lpca_cb;
458 struct llog_logid logid;
462 cfs_daemonize_ctxt("ll_log_process");
464 logid = *(struct llog_logid *)(args->lpca_arg);
465 rc = llog_create(ctxt, &llh, &logid, NULL);
467 CERROR("llog_create() failed %d\n", rc);
470 rc = llog_init_handle(llh, LLOG_F_IS_CAT, NULL);
472 CERROR("llog_init_handle failed %d\n", rc);
473 GOTO(release_llh, rc);
477 rc = llog_cat_process(llh, cb, NULL, 0, 0);
478 if (rc != LLOG_PROC_BREAK && rc != 0)
479 CERROR("llog_cat_process() failed %d\n", rc);
482 CWARN("No callback function for recovery\n");
486 * Make sure that all cached data is sent.
488 llog_sync(ctxt, NULL, 0);
489 GOTO(release_llh, rc);
491 rc = llog_cat_put(llh);
493 CERROR("llog_cat_put() failed %d\n", rc);
499 EXPORT_SYMBOL(llog_cat_process_thread);
502 static int llog_cat_reverse_process_cb(struct llog_handle *cat_llh,
503 struct llog_rec_hdr *rec, void *data)
505 struct llog_process_data *d = data;
506 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
507 struct llog_handle *llh;
510 if (le32_to_cpu(rec->lrh_type) != LLOG_LOGID_MAGIC) {
511 CERROR("invalid record in catalog\n");
514 CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
515 LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
516 le32_to_cpu(rec->lrh_index), cat_llh->lgh_id.lgl_oid);
518 rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
520 CERROR("Cannot find handle for log "LPX64"\n",
521 lir->lid_id.lgl_oid);
525 rc = llog_reverse_process(llh, d->lpd_cb, d->lpd_data, NULL);
529 int llog_cat_reverse_process(struct llog_handle *cat_llh,
530 llog_cb_t cb, void *data)
532 struct llog_process_data d;
533 struct llog_process_cat_data cd;
534 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
538 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
542 if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
543 CWARN("catalog "LPX64" crosses index zero\n",
544 cat_llh->lgh_id.lgl_oid);
546 cd.lpcd_first_idx = 0;
547 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
548 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
553 cd.lpcd_first_idx = le32_to_cpu(llh->llh_cat_idx);
554 cd.lpcd_last_idx = 0;
555 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
558 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
564 EXPORT_SYMBOL(llog_cat_reverse_process);
566 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index)
568 struct llog_log_hdr *llh = cathandle->lgh_hdr;
569 int i, bitmap_size, idx;
572 bitmap_size = LLOG_BITMAP_SIZE(llh);
573 if (llh->llh_cat_idx == (index - 1)) {
574 idx = llh->llh_cat_idx + 1;
575 llh->llh_cat_idx = idx;
576 if (idx == cathandle->lgh_last_idx)
578 for (i = (index + 1) % bitmap_size;
579 i != cathandle->lgh_last_idx;
580 i = (i + 1) % bitmap_size) {
581 if (!ext2_test_bit(i, llh->llh_bitmap)) {
582 idx = llh->llh_cat_idx + 1;
583 llh->llh_cat_idx = idx;
585 llh->llh_cat_idx = 0;
591 CDEBUG(D_RPCTRACE, "set catlog "LPX64" first idx %u\n",
592 cathandle->lgh_id.lgl_oid, llh->llh_cat_idx);