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);
95 cfs_spin_lock(&loghandle->lgh_hdr_lock);
97 if (ext2_set_bit(index, llh->llh_bitmap)) {
98 CERROR("argh, index %u already set in log bitmap?\n",
100 cfs_spin_unlock(&loghandle->lgh_hdr_lock);
101 LBUG(); /* should never happen */
103 cfs_spin_unlock(&loghandle->lgh_hdr_lock);
105 cathandle->lgh_last_idx = index;
106 llh->llh_tail.lrt_index = index;
108 CDEBUG(D_RPCTRACE,"new recovery log "LPX64":%x for index %u of catalog "
109 LPX64"\n", loghandle->lgh_id.lgl_oid, loghandle->lgh_id.lgl_ogen,
110 index, cathandle->lgh_id.lgl_oid);
111 /* build the record for this log in the catalog */
112 rec.lid_hdr.lrh_len = sizeof(rec);
113 rec.lid_hdr.lrh_index = index;
114 rec.lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
115 rec.lid_id = loghandle->lgh_id;
116 rec.lid_tail.lrt_len = sizeof(rec);
117 rec.lid_tail.lrt_index = index;
119 /* update the catalog: header and record */
120 rc = llog_write_rec(cathandle, &rec.lid_hdr,
121 &loghandle->u.phd.phd_cookie, 1, NULL, index);
123 GOTO(out_destroy, rc);
126 loghandle->lgh_hdr->llh_cat_idx = index;
127 cathandle->u.chd.chd_current_log = loghandle;
128 LASSERT(cfs_list_empty(&loghandle->u.phd.phd_entry));
129 cfs_list_add_tail(&loghandle->u.phd.phd_entry,
130 &cathandle->u.chd.chd_head);
134 llog_destroy(loghandle);
139 /* Open an existent log handle and add it to the open list.
140 * This log handle will be closed when all of the records in it are removed.
142 * Assumes caller has already pushed us into the kernel context and is locking.
143 * We return a lock on the handle to ensure nobody yanks it from us.
145 int llog_cat_id2handle(struct llog_handle *cathandle, struct llog_handle **res,
146 struct llog_logid *logid)
148 struct llog_handle *loghandle;
152 if (cathandle == NULL)
155 cfs_list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
157 struct llog_logid *cgl = &loghandle->lgh_id;
158 if (cgl->lgl_oid == logid->lgl_oid) {
159 if (cgl->lgl_ogen != logid->lgl_ogen) {
160 CERROR("log "LPX64" generation %x != %x\n",
161 logid->lgl_oid, cgl->lgl_ogen,
165 loghandle->u.phd.phd_cat_handle = cathandle;
170 rc = llog_create(cathandle->lgh_ctxt, &loghandle, logid, NULL);
172 CERROR("error opening log id "LPX64":%x: rc %d\n",
173 logid->lgl_oid, logid->lgl_ogen, rc);
175 rc = llog_init_handle(loghandle, LLOG_F_IS_PLAIN, NULL);
177 cfs_list_add(&loghandle->u.phd.phd_entry,
178 &cathandle->u.chd.chd_head);
182 loghandle->u.phd.phd_cat_handle = cathandle;
183 loghandle->u.phd.phd_cookie.lgc_lgl = cathandle->lgh_id;
184 loghandle->u.phd.phd_cookie.lgc_index =
185 loghandle->lgh_hdr->llh_cat_idx;
193 int llog_cat_put(struct llog_handle *cathandle)
195 struct llog_handle *loghandle, *n;
199 cfs_list_for_each_entry_safe(loghandle, n, &cathandle->u.chd.chd_head,
201 int err = llog_close(loghandle);
203 CERROR("error closing loghandle\n");
205 rc = llog_close(cathandle);
208 EXPORT_SYMBOL(llog_cat_put);
211 * lockdep markers for nested struct llog_handle::lgh_lock locking.
218 /** Return the currently active log handle. If the current log handle doesn't
219 * have enough space left for the current record, start a new one.
221 * If reclen is 0, we only want to know what the currently active log is,
222 * otherwise we get a lock on this log so nobody can steal our space.
224 * Assumes caller has already pushed us into the kernel context and is locking.
226 * NOTE: loghandle is write-locked upon successful return
228 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
231 struct llog_handle *loghandle = NULL;
234 cfs_down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
235 loghandle = cathandle->u.chd.chd_current_log;
237 struct llog_log_hdr *llh = loghandle->lgh_hdr;
238 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
239 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
240 cfs_up_read(&cathandle->lgh_lock);
243 cfs_up_write(&loghandle->lgh_lock);
248 cfs_down_write(&loghandle->lgh_lock);
249 cfs_up_read(&cathandle->lgh_lock);
252 cfs_up_read(&cathandle->lgh_lock);
254 /* time to create new log */
256 /* first, we have to make sure the state hasn't changed */
257 cfs_down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
258 loghandle = cathandle->u.chd.chd_current_log;
260 struct llog_log_hdr *llh = loghandle->lgh_hdr;
261 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
262 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
263 cfs_up_write(&cathandle->lgh_lock);
266 cfs_up_write(&loghandle->lgh_lock);
270 CDEBUG(D_INODE, "creating new log\n");
271 loghandle = llog_cat_new_log(cathandle);
272 if (!IS_ERR(loghandle))
273 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
274 cfs_up_write(&cathandle->lgh_lock);
278 /* Add a single record to the recovery log(s) using a catalog
279 * Returns as llog_write_record
281 * Assumes caller has already pushed us into the kernel context.
283 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
284 struct llog_cookie *reccookie, void *buf)
286 struct llog_handle *loghandle;
290 LASSERT(rec->lrh_len <= LLOG_CHUNK_SIZE);
291 loghandle = llog_cat_current_log(cathandle, 1);
292 if (IS_ERR(loghandle))
293 RETURN(PTR_ERR(loghandle));
294 /* loghandle is already locked by llog_cat_current_log() for us */
295 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
297 CERROR("llog_write_rec %d: lh=%p\n", rc, loghandle);
298 cfs_up_write(&loghandle->lgh_lock);
300 /* to create a new plain log */
301 loghandle = llog_cat_current_log(cathandle, 1);
302 if (IS_ERR(loghandle))
303 RETURN(PTR_ERR(loghandle));
304 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
305 cfs_up_write(&loghandle->lgh_lock);
310 EXPORT_SYMBOL(llog_cat_add_rec);
312 /* For each cookie in the cookie array, we clear the log in-use bit and either:
313 * - the log is empty, so mark it free in the catalog header and delete it
314 * - the log is not empty, just write out the log header
316 * The cookies may be in different log files, so we need to get new logs
319 * Assumes caller has already pushed us into the kernel context.
321 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
322 struct llog_cookie *cookies)
324 int i, index, rc = 0;
327 cfs_down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
328 for (i = 0; i < count; i++, cookies++) {
329 struct llog_handle *loghandle;
330 struct llog_logid *lgl = &cookies->lgc_lgl;
332 rc = llog_cat_id2handle(cathandle, &loghandle, lgl);
334 CERROR("Cannot find log "LPX64"\n", lgl->lgl_oid);
338 cfs_down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
339 rc = llog_cancel_rec(loghandle, cookies->lgc_index);
340 cfs_up_write(&loghandle->lgh_lock);
342 if (rc == 1) { /* log has been destroyed */
343 index = loghandle->u.phd.phd_cookie.lgc_index;
344 if (cathandle->u.chd.chd_current_log == loghandle)
345 cathandle->u.chd.chd_current_log = NULL;
346 llog_free_handle(loghandle);
349 llog_cat_set_first_idx(cathandle, index);
350 rc = llog_cancel_rec(cathandle, index);
352 CDEBUG(D_RPCTRACE,"cancel plain log at index %u"
353 " of catalog "LPX64"\n",
354 index, cathandle->lgh_id.lgl_oid);
357 cfs_up_write(&cathandle->lgh_lock);
361 EXPORT_SYMBOL(llog_cat_cancel_records);
363 int llog_cat_process_cb(struct llog_handle *cat_llh, struct llog_rec_hdr *rec,
366 struct llog_process_data *d = data;
367 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
368 struct llog_handle *llh;
372 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
373 CERROR("invalid record in catalog\n");
376 CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
377 LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
378 rec->lrh_index, cat_llh->lgh_id.lgl_oid);
380 rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
382 CERROR("Cannot find handle for log "LPX64"\n",
383 lir->lid_id.lgl_oid);
387 if (rec->lrh_index < d->lpd_startcat)
388 /* Skip processing of the logs until startcat */
391 if (d->lpd_startidx > 0) {
392 struct llog_process_cat_data cd;
394 cd.lpcd_first_idx = d->lpd_startidx;
395 cd.lpcd_last_idx = 0;
396 rc = llog_process_flags(llh, d->lpd_cb, d->lpd_data, &cd,
398 /* Continue processing the next log from idx 0 */
401 rc = llog_process_flags(llh, d->lpd_cb, d->lpd_data, NULL,
408 int llog_cat_process_flags(struct llog_handle *cat_llh, llog_cb_t cb,
409 void *data, int flags, int startcat, int startidx)
411 struct llog_process_data d;
412 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
416 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
419 d.lpd_startcat = startcat;
420 d.lpd_startidx = startidx;
423 if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
424 struct llog_process_cat_data cd;
426 CWARN("catlog "LPX64" crosses index zero\n",
427 cat_llh->lgh_id.lgl_oid);
429 cd.lpcd_first_idx = llh->llh_cat_idx;
430 cd.lpcd_last_idx = 0;
431 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, &cd,
436 cd.lpcd_first_idx = 0;
437 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
438 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, &cd,
441 rc = llog_process_flags(cat_llh, llog_cat_process_cb, &d, NULL,
447 EXPORT_SYMBOL(llog_cat_process_flags);
449 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data,
450 int startcat, int startidx)
452 return llog_cat_process_flags(cat_llh, cb, data, 0, startcat, startidx);
454 EXPORT_SYMBOL(llog_cat_process);
457 int llog_cat_process_thread(void *data)
459 struct llog_process_cat_args *args = data;
460 struct llog_ctxt *ctxt = args->lpca_ctxt;
461 struct llog_handle *llh = NULL;
462 llog_cb_t cb = args->lpca_cb;
463 struct llog_logid logid;
467 cfs_daemonize_ctxt("ll_log_process");
469 logid = *(struct llog_logid *)(args->lpca_arg);
470 rc = llog_create(ctxt, &llh, &logid, NULL);
472 CERROR("llog_create() failed %d\n", rc);
475 rc = llog_init_handle(llh, LLOG_F_IS_CAT, NULL);
477 CERROR("llog_init_handle failed %d\n", rc);
478 GOTO(release_llh, rc);
482 rc = llog_cat_process(llh, cb, NULL, 0, 0);
483 if (rc != LLOG_PROC_BREAK && rc != 0)
484 CERROR("llog_cat_process() failed %d\n", rc);
487 CWARN("No callback function for recovery\n");
491 * Make sure that all cached data is sent.
493 llog_sync(ctxt, NULL, 0);
494 GOTO(release_llh, rc);
496 rc = llog_cat_put(llh);
498 CERROR("llog_cat_put() failed %d\n", rc);
504 EXPORT_SYMBOL(llog_cat_process_thread);
507 static int llog_cat_reverse_process_cb(struct llog_handle *cat_llh,
508 struct llog_rec_hdr *rec, void *data)
510 struct llog_process_data *d = data;
511 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
512 struct llog_handle *llh;
515 if (le32_to_cpu(rec->lrh_type) != LLOG_LOGID_MAGIC) {
516 CERROR("invalid record in catalog\n");
519 CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
520 LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
521 le32_to_cpu(rec->lrh_index), cat_llh->lgh_id.lgl_oid);
523 rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
525 CERROR("Cannot find handle for log "LPX64"\n",
526 lir->lid_id.lgl_oid);
530 rc = llog_reverse_process(llh, d->lpd_cb, d->lpd_data, NULL);
534 int llog_cat_reverse_process(struct llog_handle *cat_llh,
535 llog_cb_t cb, void *data)
537 struct llog_process_data d;
538 struct llog_process_cat_data cd;
539 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
543 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
547 if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
548 CWARN("catalog "LPX64" crosses index zero\n",
549 cat_llh->lgh_id.lgl_oid);
551 cd.lpcd_first_idx = 0;
552 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
553 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
558 cd.lpcd_first_idx = le32_to_cpu(llh->llh_cat_idx);
559 cd.lpcd_last_idx = 0;
560 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
563 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
569 EXPORT_SYMBOL(llog_cat_reverse_process);
571 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index)
573 struct llog_log_hdr *llh = cathandle->lgh_hdr;
574 int i, bitmap_size, idx;
577 bitmap_size = LLOG_BITMAP_SIZE(llh);
578 if (llh->llh_cat_idx == (index - 1)) {
579 idx = llh->llh_cat_idx + 1;
580 llh->llh_cat_idx = idx;
581 if (idx == cathandle->lgh_last_idx)
583 for (i = (index + 1) % bitmap_size;
584 i != cathandle->lgh_last_idx;
585 i = (i + 1) % bitmap_size) {
586 if (!ext2_test_bit(i, llh->llh_bitmap)) {
587 idx = llh->llh_cat_idx + 1;
588 llh->llh_cat_idx = idx;
590 llh->llh_cat_idx = 0;
596 CDEBUG(D_RPCTRACE, "set catlog "LPX64" first idx %u\n",
597 cathandle->lgh_id.lgl_oid, llh->llh_cat_idx);