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
52 #include <liblustre.h>
55 #include <obd_class.h>
56 #include <lustre_log.h>
57 #include <libcfs/list.h>
59 /* Create a new log handle and add it to the open list.
60 * This log handle will be closed when all of the records in it are removed.
62 * Assumes caller has already pushed us into the kernel context and is locking.
64 static struct llog_handle *llog_cat_new_log(struct llog_handle *cathandle)
66 struct llog_handle *loghandle;
67 struct llog_log_hdr *llh;
68 struct llog_logid_rec rec = { { 0 }, };
69 int rc, index, bitmap_size;
72 llh = cathandle->lgh_hdr;
73 bitmap_size = LLOG_BITMAP_SIZE(llh);
75 index = (cathandle->lgh_last_idx + 1) % bitmap_size;
77 /* maximum number of available slots in catlog is bitmap_size - 2 */
78 if (llh->llh_cat_idx == index) {
79 CERROR("no free catalog slots for log...\n");
80 RETURN(ERR_PTR(-ENOSPC));
83 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED))
84 RETURN(ERR_PTR(-ENOSPC));
86 rc = llog_create(cathandle->lgh_ctxt, &loghandle, NULL, NULL);
90 rc = llog_init_handle(loghandle,
91 LLOG_F_IS_PLAIN | LLOG_F_ZAP_WHEN_EMPTY,
92 &cathandle->lgh_hdr->llh_tgtuuid);
94 GOTO(out_destroy, rc);
98 if (ext2_set_bit(index, llh->llh_bitmap)) {
99 CERROR("argh, index %u already set in log bitmap?\n",
101 LBUG(); /* should never happen */
103 cathandle->lgh_last_idx = index;
105 llh->llh_tail.lrt_index = index;
107 CDEBUG(D_RPCTRACE,"new recovery log "LPX64":%x for index %u of catalog "
108 LPX64"\n", loghandle->lgh_id.lgl_oid, loghandle->lgh_id.lgl_ogen,
109 index, cathandle->lgh_id.lgl_oid);
110 /* build the record for this log in the catalog */
111 rec.lid_hdr.lrh_len = sizeof(rec);
112 rec.lid_hdr.lrh_index = index;
113 rec.lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
114 rec.lid_id = loghandle->lgh_id;
115 rec.lid_tail.lrt_len = sizeof(rec);
116 rec.lid_tail.lrt_index = index;
118 /* update the catalog: header and record */
119 rc = llog_write_rec(cathandle, &rec.lid_hdr,
120 &loghandle->u.phd.phd_cookie, 1, NULL, index);
122 GOTO(out_destroy, rc);
125 loghandle->lgh_hdr->llh_cat_idx = index;
126 cathandle->u.chd.chd_current_log = loghandle;
127 LASSERT(cfs_list_empty(&loghandle->u.phd.phd_entry));
128 cfs_list_add_tail(&loghandle->u.phd.phd_entry,
129 &cathandle->u.chd.chd_head);
133 llog_destroy(loghandle);
138 /* Open an existent log handle and add it to the open list.
139 * This log handle will be closed when all of the records in it are removed.
141 * Assumes caller has already pushed us into the kernel context and is locking.
142 * We return a lock on the handle to ensure nobody yanks it from us.
144 int llog_cat_id2handle(struct llog_handle *cathandle, struct llog_handle **res,
145 struct llog_logid *logid)
147 struct llog_handle *loghandle;
151 if (cathandle == NULL)
154 cfs_list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
156 struct llog_logid *cgl = &loghandle->lgh_id;
157 if (cgl->lgl_oid == logid->lgl_oid) {
158 if (cgl->lgl_ogen != logid->lgl_ogen) {
159 CERROR("log "LPX64" generation %x != %x\n",
160 logid->lgl_oid, cgl->lgl_ogen,
164 loghandle->u.phd.phd_cat_handle = cathandle;
169 rc = llog_create(cathandle->lgh_ctxt, &loghandle, logid, NULL);
171 CERROR("error opening log id "LPX64":%x: rc %d\n",
172 logid->lgl_oid, logid->lgl_ogen, rc);
174 rc = llog_init_handle(loghandle, LLOG_F_IS_PLAIN, NULL);
176 cfs_list_add(&loghandle->u.phd.phd_entry,
177 &cathandle->u.chd.chd_head);
181 loghandle->u.phd.phd_cat_handle = cathandle;
182 loghandle->u.phd.phd_cookie.lgc_lgl = cathandle->lgh_id;
183 loghandle->u.phd.phd_cookie.lgc_index =
184 loghandle->lgh_hdr->llh_cat_idx;
192 int llog_cat_put(struct llog_handle *cathandle)
194 struct llog_handle *loghandle, *n;
198 cfs_list_for_each_entry_safe(loghandle, n, &cathandle->u.chd.chd_head,
200 int err = llog_close(loghandle);
202 CERROR("error closing loghandle\n");
204 rc = llog_close(cathandle);
207 EXPORT_SYMBOL(llog_cat_put);
210 * lockdep markers for nested struct llog_handle::lgh_lock locking.
217 /** Return the currently active log handle. If the current log handle doesn't
218 * have enough space left for the current record, start a new one.
220 * If reclen is 0, we only want to know what the currently active log is,
221 * otherwise we get a lock on this log so nobody can steal our space.
223 * Assumes caller has already pushed us into the kernel context and is locking.
225 * NOTE: loghandle is write-locked upon successful return
227 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
230 struct llog_handle *loghandle = NULL;
233 cfs_down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
234 loghandle = cathandle->u.chd.chd_current_log;
236 struct llog_log_hdr *llh = loghandle->lgh_hdr;
237 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
238 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
239 cfs_up_read(&cathandle->lgh_lock);
242 cfs_up_write(&loghandle->lgh_lock);
247 cfs_down_write(&loghandle->lgh_lock);
248 cfs_up_read(&cathandle->lgh_lock);
251 cfs_up_read(&cathandle->lgh_lock);
253 /* time to create new log */
255 /* first, we have to make sure the state hasn't changed */
256 cfs_down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
257 loghandle = cathandle->u.chd.chd_current_log;
259 struct llog_log_hdr *llh = loghandle->lgh_hdr;
260 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
261 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
262 cfs_up_write(&cathandle->lgh_lock);
265 cfs_up_write(&loghandle->lgh_lock);
269 CDEBUG(D_INODE, "creating new log\n");
270 loghandle = llog_cat_new_log(cathandle);
271 if (!IS_ERR(loghandle))
272 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
273 cfs_up_write(&cathandle->lgh_lock);
277 /* Add a single record to the recovery log(s) using a catalog
278 * Returns as llog_write_record
280 * Assumes caller has already pushed us into the kernel context.
282 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
283 struct llog_cookie *reccookie, void *buf)
285 struct llog_handle *loghandle;
289 LASSERT(rec->lrh_len <= LLOG_CHUNK_SIZE);
290 loghandle = llog_cat_current_log(cathandle, 1);
291 if (IS_ERR(loghandle))
292 RETURN(PTR_ERR(loghandle));
293 /* loghandle is already locked by llog_cat_current_log() for us */
294 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
296 CERROR("llog_write_rec %d: lh=%p\n", rc, loghandle);
297 cfs_up_write(&loghandle->lgh_lock);
299 /* to create a new plain log */
300 loghandle = llog_cat_current_log(cathandle, 1);
301 if (IS_ERR(loghandle))
302 RETURN(PTR_ERR(loghandle));
303 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
304 cfs_up_write(&loghandle->lgh_lock);
309 EXPORT_SYMBOL(llog_cat_add_rec);
311 /* For each cookie in the cookie array, we clear the log in-use bit and either:
312 * - the log is empty, so mark it free in the catalog header and delete it
313 * - the log is not empty, just write out the log header
315 * The cookies may be in different log files, so we need to get new logs
318 * Assumes caller has already pushed us into the kernel context.
320 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
321 struct llog_cookie *cookies)
323 int i, index, rc = 0;
326 cfs_down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
327 for (i = 0; i < count; i++, cookies++) {
328 struct llog_handle *loghandle;
329 struct llog_logid *lgl = &cookies->lgc_lgl;
331 rc = llog_cat_id2handle(cathandle, &loghandle, lgl);
333 CERROR("Cannot find log "LPX64"\n", lgl->lgl_oid);
337 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
338 rc = llog_cancel_rec(loghandle, cookies->lgc_index);
339 cfs_up_write(&loghandle->lgh_lock);
341 if (rc == 1) { /* log has been destroyed */
342 index = loghandle->u.phd.phd_cookie.lgc_index;
343 if (cathandle->u.chd.chd_current_log == loghandle)
344 cathandle->u.chd.chd_current_log = NULL;
345 llog_free_handle(loghandle);
348 llog_cat_set_first_idx(cathandle, index);
349 rc = llog_cancel_rec(cathandle, index);
351 CDEBUG(D_RPCTRACE,"cancel plain log at index %u"
352 " of catalog "LPX64"\n",
353 index, cathandle->lgh_id.lgl_oid);
356 cfs_up_write(&cathandle->lgh_lock);
360 EXPORT_SYMBOL(llog_cat_cancel_records);
362 int llog_cat_process_cb(struct llog_handle *cat_llh, struct llog_rec_hdr *rec,
365 struct llog_process_data *d = data;
366 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
367 struct llog_handle *llh;
371 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
372 CERROR("invalid record in catalog\n");
375 CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
376 LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
377 rec->lrh_index, cat_llh->lgh_id.lgl_oid);
379 rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
381 CERROR("Cannot find handle for log "LPX64"\n",
382 lir->lid_id.lgl_oid);
386 if (rec->lrh_index < d->lpd_startcat)
387 /* Skip processing of the logs until startcat */
390 if (d->lpd_startidx > 0) {
391 struct llog_process_cat_data cd;
393 cd.lpcd_first_idx = d->lpd_startidx;
394 cd.lpcd_last_idx = 0;
395 rc = llog_process_flags(llh, d->lpd_cb, d->lpd_data, &cd,
397 /* Continue processing the next log from idx 0 */
400 rc = llog_process_flags(llh, d->lpd_cb, d->lpd_data, NULL,
407 int llog_cat_process_flags(struct llog_handle *cat_llh, llog_cb_t cb,
408 void *data, int flags, int startcat, int startidx)
410 struct llog_process_data d;
411 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
415 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
418 d.lpd_startcat = startcat;
419 d.lpd_startidx = startidx;
422 if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
423 struct llog_process_cat_data cd;
425 CWARN("catlog "LPX64" crosses index zero\n",
426 cat_llh->lgh_id.lgl_oid);
428 cd.lpcd_first_idx = llh->llh_cat_idx;
429 cd.lpcd_last_idx = 0;
430 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, &cd,
435 cd.lpcd_first_idx = 0;
436 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
437 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, &cd,
440 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, NULL,
446 EXPORT_SYMBOL(llog_cat_process_flags);
448 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data,
449 int startcat, int startidx)
451 return llog_cat_process_flags(cat_llh, cb, data, 0, startcat, startidx);
453 EXPORT_SYMBOL(llog_cat_process);
456 int llog_cat_process_thread(void *data)
458 struct llog_process_cat_args *args = data;
459 struct llog_ctxt *ctxt = args->lpca_ctxt;
460 struct llog_handle *llh = NULL;
461 llog_cb_t cb = args->lpca_cb;
462 struct llog_logid logid;
466 cfs_daemonize_ctxt("ll_log_process");
468 logid = *(struct llog_logid *)(args->lpca_arg);
469 rc = llog_create(ctxt, &llh, &logid, NULL);
471 CERROR("llog_create() failed %d\n", rc);
474 rc = llog_init_handle(llh, LLOG_F_IS_CAT, NULL);
476 CERROR("llog_init_handle failed %d\n", rc);
477 GOTO(release_llh, rc);
481 rc = llog_cat_process(llh, cb, NULL, 0, 0);
482 if (rc != LLOG_PROC_BREAK && rc != 0)
483 CERROR("llog_cat_process() failed %d\n", rc);
486 CWARN("No callback function for recovery\n");
490 * Make sure that all cached data is sent.
492 llog_sync(ctxt, NULL);
493 GOTO(release_llh, rc);
495 rc = llog_cat_put(llh);
497 CERROR("llog_cat_put() failed %d\n", rc);
503 EXPORT_SYMBOL(llog_cat_process_thread);
506 static int llog_cat_reverse_process_cb(struct llog_handle *cat_llh,
507 struct llog_rec_hdr *rec, void *data)
509 struct llog_process_data *d = data;
510 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
511 struct llog_handle *llh;
514 if (le32_to_cpu(rec->lrh_type) != LLOG_LOGID_MAGIC) {
515 CERROR("invalid record in catalog\n");
518 CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
519 LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
520 le32_to_cpu(rec->lrh_index), cat_llh->lgh_id.lgl_oid);
522 rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
524 CERROR("Cannot find handle for log "LPX64"\n",
525 lir->lid_id.lgl_oid);
529 rc = llog_reverse_process(llh, d->lpd_cb, d->lpd_data, NULL);
533 int llog_cat_reverse_process(struct llog_handle *cat_llh,
534 llog_cb_t cb, void *data)
536 struct llog_process_data d;
537 struct llog_process_cat_data cd;
538 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
542 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
546 if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
547 CWARN("catalog "LPX64" crosses index zero\n",
548 cat_llh->lgh_id.lgl_oid);
550 cd.lpcd_first_idx = 0;
551 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
552 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
557 cd.lpcd_first_idx = le32_to_cpu(llh->llh_cat_idx);
558 cd.lpcd_last_idx = 0;
559 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
562 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
568 EXPORT_SYMBOL(llog_cat_reverse_process);
570 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index)
572 struct llog_log_hdr *llh = cathandle->lgh_hdr;
573 int i, bitmap_size, idx;
576 bitmap_size = LLOG_BITMAP_SIZE(llh);
577 if (llh->llh_cat_idx == (index - 1)) {
578 idx = llh->llh_cat_idx + 1;
579 llh->llh_cat_idx = idx;
580 if (idx == cathandle->lgh_last_idx)
582 for (i = (index + 1) % bitmap_size;
583 i != cathandle->lgh_last_idx;
584 i = (i + 1) % bitmap_size) {
585 if (!ext2_test_bit(i, llh->llh_bitmap)) {
586 idx = llh->llh_cat_idx + 1;
587 llh->llh_cat_idx = idx;
589 llh->llh_cat_idx = 0;
595 CDEBUG(D_RPCTRACE, "set catlog "LPX64" first idx %u\n",
596 cathandle->lgh_id.lgl_oid, llh->llh_cat_idx);