1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/obdclass/llog_cat.c
38 * OST<->MDS recovery logging infrastructure.
40 * Invariants in implementation:
41 * - we do not share logs among different OST<->MDS connections, so that
42 * if an OST or MDS fails it need only look at log(s) relevant to itself
44 * Author: Andreas Dilger <adilger@clusterfs.com>
47 #define DEBUG_SUBSYSTEM S_LOG
54 #include <liblustre.h>
57 #include <obd_class.h>
58 #include <lustre_log.h>
59 #include <libcfs/list.h>
61 /* Create a new log handle and add it to the open list.
62 * This log handle will be closed when all of the records in it are removed.
64 * Assumes caller has already pushed us into the kernel context and is locking.
66 static struct llog_handle *llog_cat_new_log(struct llog_handle *cathandle)
68 struct llog_handle *loghandle;
69 struct llog_log_hdr *llh;
70 struct llog_logid_rec rec = { { 0 }, };
71 int rc, index, bitmap_size;
74 llh = cathandle->lgh_hdr;
75 bitmap_size = LLOG_BITMAP_SIZE(llh);
77 index = (cathandle->lgh_last_idx + 1) % bitmap_size;
79 /* maximum number of available slots in catlog is bitmap_size - 2 */
80 if (llh->llh_cat_idx == index) {
81 CERROR("no free catalog slots for log...\n");
82 RETURN(ERR_PTR(-ENOSPC));
85 if (OBD_FAIL_CHECK_ONCE(OBD_FAIL_MDS_LLOG_CREATE_FAILED))
86 RETURN(ERR_PTR(-ENOSPC));
88 rc = llog_create(cathandle->lgh_ctxt, &loghandle, NULL, NULL);
92 rc = llog_init_handle(loghandle,
93 LLOG_F_IS_PLAIN | LLOG_F_ZAP_WHEN_EMPTY,
94 &cathandle->lgh_hdr->llh_tgtuuid);
96 GOTO(out_destroy, rc);
99 if (ext2_set_bit(index, llh->llh_bitmap)) {
100 CERROR("argh, index %u already set in log bitmap?\n",
102 LBUG(); /* should never happen */
104 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(list_empty(&loghandle->u.phd.phd_entry));
129 list_add_tail(&loghandle->u.phd.phd_entry, &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 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 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 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);
209 /* Return the currently active log handle. If the current log handle doesn't
210 * have enough space left for the current record, start a new one.
212 * If reclen is 0, we only want to know what the currently active log is,
213 * otherwise we get a lock on this log so nobody can steal our space.
215 * Assumes caller has already pushed us into the kernel context and is locking.
217 * NOTE: loghandle is write-locked upon successful return
219 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
222 struct llog_handle *loghandle = NULL;
225 down_read(&cathandle->lgh_lock);
226 loghandle = cathandle->u.chd.chd_current_log;
228 struct llog_log_hdr *llh = loghandle->lgh_hdr;
229 down_write(&loghandle->lgh_lock);
230 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
231 up_read(&cathandle->lgh_lock);
234 up_write(&loghandle->lgh_lock);
239 down_write(&loghandle->lgh_lock);
240 up_read(&cathandle->lgh_lock);
243 up_read(&cathandle->lgh_lock);
245 /* time to create new log */
247 /* first, we have to make sure the state hasn't changed */
248 down_write(&cathandle->lgh_lock);
249 loghandle = cathandle->u.chd.chd_current_log;
251 struct llog_log_hdr *llh = loghandle->lgh_hdr;
252 down_write(&loghandle->lgh_lock);
253 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
254 up_write(&cathandle->lgh_lock);
257 up_write(&loghandle->lgh_lock);
261 CDEBUG(D_INODE, "creating new log\n");
262 loghandle = llog_cat_new_log(cathandle);
263 if (!IS_ERR(loghandle))
264 down_write(&loghandle->lgh_lock);
265 up_write(&cathandle->lgh_lock);
269 /* Add a single record to the recovery log(s) using a catalog
270 * Returns as llog_write_record
272 * Assumes caller has already pushed us into the kernel context.
274 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
275 struct llog_cookie *reccookie, void *buf)
277 struct llog_handle *loghandle;
281 LASSERT(rec->lrh_len <= LLOG_CHUNK_SIZE);
282 loghandle = llog_cat_current_log(cathandle, 1);
283 if (IS_ERR(loghandle))
284 RETURN(PTR_ERR(loghandle));
285 /* loghandle is already locked by llog_cat_current_log() for us */
286 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
287 up_write(&loghandle->lgh_lock);
289 /* to create a new plain log */
290 loghandle = llog_cat_current_log(cathandle, 1);
291 if (IS_ERR(loghandle))
292 RETURN(PTR_ERR(loghandle));
293 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
294 up_write(&loghandle->lgh_lock);
299 EXPORT_SYMBOL(llog_cat_add_rec);
301 /* For each cookie in the cookie array, we clear the log in-use bit and either:
302 * - the log is empty, so mark it free in the catalog header and delete it
303 * - the log is not empty, just write out the log header
305 * The cookies may be in different log files, so we need to get new logs
308 * Assumes caller has already pushed us into the kernel context.
310 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
311 struct llog_cookie *cookies)
313 int i, index, rc = 0;
316 down_write(&cathandle->lgh_lock);
317 for (i = 0; i < count; i++, cookies++) {
318 struct llog_handle *loghandle;
319 struct llog_logid *lgl = &cookies->lgc_lgl;
321 rc = llog_cat_id2handle(cathandle, &loghandle, lgl);
323 CERROR("Cannot find log "LPX64"\n", lgl->lgl_oid);
327 down_write(&loghandle->lgh_lock);
328 rc = llog_cancel_rec(loghandle, cookies->lgc_index);
329 up_write(&loghandle->lgh_lock);
331 if (rc == 1) { /* log has been destroyed */
332 index = loghandle->u.phd.phd_cookie.lgc_index;
333 if (cathandle->u.chd.chd_current_log == loghandle)
334 cathandle->u.chd.chd_current_log = NULL;
335 llog_free_handle(loghandle);
338 llog_cat_set_first_idx(cathandle, index);
339 rc = llog_cancel_rec(cathandle, index);
341 CDEBUG(D_RPCTRACE,"cancel plain log at index %u"
342 " of catalog "LPX64"\n",
343 index, cathandle->lgh_id.lgl_oid);
346 up_write(&cathandle->lgh_lock);
350 EXPORT_SYMBOL(llog_cat_cancel_records);
352 int llog_cat_process_cb(struct llog_handle *cat_llh, struct llog_rec_hdr *rec,
355 struct llog_process_data *d = data;
356 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
357 struct llog_handle *llh;
361 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
362 CERROR("invalid record in catalog\n");
365 CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
366 LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
367 rec->lrh_index, cat_llh->lgh_id.lgl_oid);
369 rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
371 CERROR("Cannot find handle for log "LPX64"\n",
372 lir->lid_id.lgl_oid);
376 rc = llog_process(llh, d->lpd_cb, d->lpd_data, NULL);
380 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data)
382 struct llog_process_data d;
383 struct llog_process_cat_data cd;
384 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
388 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
392 if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
393 CWARN("catlog "LPX64" crosses index zero\n",
394 cat_llh->lgh_id.lgl_oid);
396 cd.lpcd_first_idx = llh->llh_cat_idx;
397 cd.lpcd_last_idx = 0;
398 rc = llog_process(cat_llh, llog_cat_process_cb, &d, &cd);
402 cd.lpcd_first_idx = 0;
403 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
404 rc = llog_process(cat_llh, llog_cat_process_cb, &d, &cd);
406 rc = llog_process(cat_llh, llog_cat_process_cb, &d, NULL);
411 EXPORT_SYMBOL(llog_cat_process);
414 int llog_cat_process_thread(void *data)
416 struct llog_process_cat_args *args = data;
417 struct llog_ctxt *ctxt = args->lpca_ctxt;
418 struct llog_handle *llh = NULL;
419 void *cb = args->lpca_cb;
420 struct llog_logid logid;
424 cfs_daemonize_ctxt("ll_log_process");
426 logid = *(struct llog_logid *)(args->lpca_arg);
427 rc = llog_create(ctxt, &llh, &logid, NULL);
429 CERROR("llog_create() failed %d\n", rc);
432 rc = llog_init_handle(llh, LLOG_F_IS_CAT, NULL);
434 CERROR("llog_init_handle failed %d\n", rc);
435 GOTO(release_llh, rc);
439 rc = llog_cat_process(llh, (llog_cb_t)cb, NULL);
440 if (rc != LLOG_PROC_BREAK && rc != 0)
441 CERROR("llog_cat_process() failed %d\n", rc);
443 CWARN("No callback function for recovery\n");
447 * Make sure that all cached data is sent.
449 llog_sync(ctxt, NULL);
450 GOTO(release_llh, rc);
452 rc = llog_cat_put(llh);
454 CERROR("llog_cat_put() failed %d\n", rc);
460 EXPORT_SYMBOL(llog_cat_process_thread);
463 static int llog_cat_reverse_process_cb(struct llog_handle *cat_llh,
464 struct llog_rec_hdr *rec, void *data)
466 struct llog_process_data *d = data;
467 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
468 struct llog_handle *llh;
471 if (le32_to_cpu(rec->lrh_type) != LLOG_LOGID_MAGIC) {
472 CERROR("invalid record in catalog\n");
475 CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
476 LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
477 le32_to_cpu(rec->lrh_index), cat_llh->lgh_id.lgl_oid);
479 rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
481 CERROR("Cannot find handle for log "LPX64"\n",
482 lir->lid_id.lgl_oid);
486 rc = llog_reverse_process(llh, d->lpd_cb, d->lpd_data, NULL);
490 int llog_cat_reverse_process(struct llog_handle *cat_llh,
491 llog_cb_t cb, void *data)
493 struct llog_process_data d;
494 struct llog_process_cat_data cd;
495 struct llog_log_hdr *llh = cat_llh->lgh_hdr;
499 LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
503 if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
504 CWARN("catalog "LPX64" crosses index zero\n",
505 cat_llh->lgh_id.lgl_oid);
507 cd.lpcd_first_idx = 0;
508 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
509 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
514 cd.lpcd_first_idx = le32_to_cpu(llh->llh_cat_idx);
515 cd.lpcd_last_idx = 0;
516 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
519 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
525 EXPORT_SYMBOL(llog_cat_reverse_process);
527 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index)
529 struct llog_log_hdr *llh = cathandle->lgh_hdr;
530 int i, bitmap_size, idx;
533 bitmap_size = LLOG_BITMAP_SIZE(llh);
534 if (llh->llh_cat_idx == (index - 1)) {
535 idx = llh->llh_cat_idx + 1;
536 llh->llh_cat_idx = idx;
537 if (idx == cathandle->lgh_last_idx)
539 for (i = (index + 1) % bitmap_size;
540 i != cathandle->lgh_last_idx;
541 i = (i + 1) % bitmap_size) {
542 if (!ext2_test_bit(i, llh->llh_bitmap)) {
543 idx = llh->llh_cat_idx + 1;
544 llh->llh_cat_idx = idx;
546 llh->llh_cat_idx = 0;
552 CDEBUG(D_RPCTRACE, "set catlog "LPX64" first idx %u\n",
553 cathandle->lgh_id.lgl_oid, llh->llh_cat_idx);