1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001-2003 Cluster File Systems, Inc.
5 * Author: Andreas Dilger <adilger@clusterfs.com>
7 * This file is part of the Lustre file system, http://www.lustre.org
8 * Lustre is a trademark of Cluster File Systems, Inc.
10 * You may have signed or agreed to another license before downloading
11 * this software. If so, you are bound by the terms and conditions
12 * of that agreement, and the following does not apply to you. See the
13 * LICENSE file included with this distribution for more information.
15 * If you did not agree to a different license, then this copy of Lustre
16 * is open source software; you can redistribute it and/or modify it
17 * under the terms of version 2 of the GNU General Public License as
18 * published by the Free Software Foundation.
20 * In either case, Lustre is distributed in the hope that it will be
21 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
22 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * license text for more details.
25 * OST<->MDS recovery logging infrastructure.
27 * Invariants in implementation:
28 * - we do not share logs among different OST<->MDS connections, so that
29 * if an OST or MDS fails it need only look at log(s) relevant to itself
32 #define DEBUG_SUBSYSTEM S_LOG
39 #include <liblustre.h>
42 #include <obd_class.h>
43 #include <lustre_log.h>
44 #include <libcfs/list.h>
46 /* Allocate a new log or catalog handle */
47 struct llog_handle *llog_alloc_handle(void)
49 struct llog_handle *loghandle;
52 OBD_ALLOC(loghandle, sizeof(*loghandle));
53 if (loghandle == NULL)
54 RETURN(ERR_PTR(-ENOMEM));
56 init_rwsem(&loghandle->lgh_lock);
60 EXPORT_SYMBOL(llog_alloc_handle);
63 void llog_free_handle(struct llog_handle *loghandle)
68 if (!loghandle->lgh_hdr)
70 if (loghandle->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)
71 list_del_init(&loghandle->u.phd.phd_entry);
72 if (loghandle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)
73 LASSERT(list_empty(&loghandle->u.chd.chd_head));
74 OBD_FREE(loghandle->lgh_hdr, LLOG_CHUNK_SIZE);
77 OBD_FREE(loghandle, sizeof(*loghandle));
79 EXPORT_SYMBOL(llog_free_handle);
81 /* returns negative on error; 0 if success; 1 if success & log destroyed */
82 int llog_cancel_rec(struct llog_handle *loghandle, int index)
84 struct llog_log_hdr *llh = loghandle->lgh_hdr;
88 CDEBUG(D_HA, "canceling %d in log "LPX64"\n",
89 index, loghandle->lgh_id.lgl_oid);
92 CERROR("cannot cancel index 0 (which is header)\n");
96 if (!ext2_clear_bit(index, llh->llh_bitmap)) {
97 CDEBUG(D_HA, "catalog index %u already clear?\n", index);
103 if ((llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
104 (llh->llh_count == 1) &&
105 (loghandle->lgh_last_idx == (LLOG_BITMAP_BYTES * 8) - 1)) {
106 rc = llog_destroy(loghandle);
108 CERROR("failure destroying log after last cancel: %d\n",
110 ext2_set_bit(index, llh->llh_bitmap);
118 rc = llog_write_rec(loghandle, &llh->llh_hdr, NULL, 0, NULL, 0);
120 CERROR("failure re-writing header %d\n", rc);
121 ext2_set_bit(index, llh->llh_bitmap);
126 EXPORT_SYMBOL(llog_cancel_rec);
128 int llog_init_handle(struct llog_handle *handle, int flags,
129 struct obd_uuid *uuid)
132 struct llog_log_hdr *llh;
134 LASSERT(handle->lgh_hdr == NULL);
136 OBD_ALLOC(llh, sizeof(*llh));
139 handle->lgh_hdr = llh;
140 /* first assign flags to use llog_client_ops */
141 llh->llh_flags = flags;
142 rc = llog_read_header(handle);
144 flags = llh->llh_flags;
145 if (uuid && !obd_uuid_equals(uuid, &llh->llh_tgtuuid)) {
146 CERROR("uuid mismatch: %s/%s\n", (char *)uuid->uuid,
147 (char *)llh->llh_tgtuuid.uuid);
151 } else if (rc != LLOG_EEMPTY || !flags) {
152 /* set a pesudo flag for initialization */
153 flags = LLOG_F_IS_CAT;
158 handle->lgh_last_idx = 0; /* header is record with index 0 */
159 llh->llh_count = 1; /* for the header record */
160 llh->llh_hdr.lrh_type = LLOG_HDR_MAGIC;
161 llh->llh_hdr.lrh_len = llh->llh_tail.lrt_len = LLOG_CHUNK_SIZE;
162 llh->llh_hdr.lrh_index = llh->llh_tail.lrt_index = 0;
163 llh->llh_timestamp = CURRENT_SECONDS;
165 memcpy(&llh->llh_tgtuuid, uuid, sizeof(llh->llh_tgtuuid));
166 llh->llh_bitmap_offset = offsetof(typeof(*llh),llh_bitmap);
167 ext2_set_bit(0, llh->llh_bitmap);
170 if (flags & LLOG_F_IS_CAT) {
171 CFS_INIT_LIST_HEAD(&handle->u.chd.chd_head);
172 llh->llh_size = sizeof(struct llog_logid_rec);
173 } else if (flags & LLOG_F_IS_PLAIN) {
174 CFS_INIT_LIST_HEAD(&handle->u.phd.phd_entry);
176 CERROR("Unknown flags: %#x (Expected %#x or %#x\n",
177 flags, LLOG_F_IS_CAT, LLOG_F_IS_PLAIN);
182 OBD_FREE(llh, sizeof(*llh));
183 handle->lgh_hdr = NULL;
187 EXPORT_SYMBOL(llog_init_handle);
189 int llog_close(struct llog_handle *loghandle)
191 struct llog_operations *lop;
195 rc = llog_handle2ops(loghandle, &lop);
198 if (lop->lop_close == NULL)
199 GOTO(out, -EOPNOTSUPP);
200 rc = lop->lop_close(loghandle);
202 llog_free_handle(loghandle);
205 EXPORT_SYMBOL(llog_close);
207 int llog_process(struct llog_handle *loghandle, llog_cb_t cb,
208 void *data, void *catdata)
210 struct llog_log_hdr *llh = loghandle->lgh_hdr;
211 struct llog_process_cat_data *cd = catdata;
213 __u64 cur_offset = LLOG_CHUNK_SIZE, last_offset;
214 int rc = 0, index = 1, last_index;
215 int saved_index = 0, last_called_index = 0;
220 OBD_ALLOC(buf, LLOG_CHUNK_SIZE);
225 last_called_index = cd->first_idx;
226 index = cd->first_idx + 1;
228 if (cd != NULL && cd->last_idx)
229 last_index = cd->last_idx;
231 last_index = LLOG_BITMAP_BYTES * 8 - 1;
234 struct llog_rec_hdr *rec;
236 /* skip records not set in bitmap */
237 while (index <= last_index &&
238 !ext2_test_bit(index, llh->llh_bitmap))
241 LASSERT(index <= last_index + 1);
242 if (index == last_index + 1)
245 CDEBUG(D_OTHER, "index: %d last_index %d\n",
248 /* get the buf with our target record; avoid old garbage */
249 last_offset = cur_offset;
250 rc = llog_next_block(loghandle, &saved_index, index,
251 &cur_offset, buf, LLOG_CHUNK_SIZE);
255 /* NB: when rec->lrh_len is accessed it is already swabbed
256 * since it is used at the "end" of the loop and the rec
257 * swabbing is done at the beginning of the loop. */
258 for (rec = (struct llog_rec_hdr *)buf;
259 (char *)rec < buf + LLOG_CHUNK_SIZE;
260 rec = (struct llog_rec_hdr *)((char *)rec + rec->lrh_len)){
262 CDEBUG(D_OTHER, "processing rec 0x%p type %#x\n",
265 if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
266 lustre_swab_llog_rec(rec, NULL);
268 CDEBUG(D_OTHER, "after swabbing, type=%#x idx=%d\n",
269 rec->lrh_type, rec->lrh_index);
271 if (rec->lrh_index == 0)
272 GOTO(out, 0); /* no more records */
274 if (rec->lrh_len == 0 || rec->lrh_len >LLOG_CHUNK_SIZE){
275 CWARN("invalid length %d in llog record for "
276 "index %d/%d\n", rec->lrh_len,
277 rec->lrh_index, index);
278 GOTO(out, rc = -EINVAL);
281 if (rec->lrh_index < index) {
282 CDEBUG(D_OTHER, "skipping lrh_index %d\n",
288 "lrh_index: %d lrh_len: %d (%d remains)\n",
289 rec->lrh_index, rec->lrh_len,
290 (int)(buf + LLOG_CHUNK_SIZE - (char *)rec));
292 loghandle->lgh_cur_idx = rec->lrh_index;
293 loghandle->lgh_cur_offset = (char *)rec - (char *)buf +
296 /* if set, process the callback on this record */
297 if (ext2_test_bit(index, llh->llh_bitmap)) {
298 rc = cb(loghandle, rec, data);
299 last_called_index = index;
300 if (rc == LLOG_PROC_BREAK) {
301 CDEBUG(D_HA, "recovery from log: "LPX64
303 loghandle->lgh_id.lgl_oid,
304 loghandle->lgh_id.lgl_ogen);
306 } else if (rc == LLOG_DEL_RECORD) {
307 llog_cancel_rec(loghandle, rec->lrh_index);
313 CDEBUG(D_OTHER, "Skipped index %d\n", index);
316 /* next record, still in buffer? */
318 if (index > last_index)
325 cd->last_idx = last_called_index;
327 OBD_FREE(buf, LLOG_CHUNK_SIZE);
330 EXPORT_SYMBOL(llog_process);
332 inline int llog_get_size(struct llog_handle *loghandle)
334 if (loghandle && loghandle->lgh_hdr)
335 return loghandle->lgh_hdr->llh_count;
338 EXPORT_SYMBOL(llog_get_size);
340 int llog_reverse_process(struct llog_handle *loghandle, llog_cb_t cb,
341 void *data, void *catdata)
343 struct llog_log_hdr *llh = loghandle->lgh_hdr;
344 struct llog_process_cat_data *cd = catdata;
346 int rc = 0, first_index = 1, index, idx;
349 OBD_ALLOC(buf, LLOG_CHUNK_SIZE);
354 first_index = cd->first_idx + 1;
355 if (cd != NULL && cd->last_idx)
356 index = cd->last_idx;
358 index = LLOG_BITMAP_BYTES * 8 - 1;
361 struct llog_rec_hdr *rec;
362 struct llog_rec_tail *tail;
364 /* skip records not set in bitmap */
365 while (index >= first_index &&
366 !ext2_test_bit(index, llh->llh_bitmap))
369 LASSERT(index >= first_index - 1);
370 if (index == first_index - 1)
373 /* get the buf with our target record; avoid old garbage */
374 memset(buf, 0, LLOG_CHUNK_SIZE);
375 rc = llog_prev_block(loghandle, index, buf, LLOG_CHUNK_SIZE);
380 idx = le32_to_cpu(rec->lrh_index);
382 CDEBUG(D_HA, "index %u : idx %u\n", index, idx);
383 while (idx < index) {
384 rec = ((void *)rec + le32_to_cpu(rec->lrh_len));
387 tail = (void *)rec + le32_to_cpu(rec->lrh_len) - sizeof(*tail);
389 /* process records in buffer, starting where we found one */
390 while ((void *)tail > buf) {
391 rec = (void *)tail - le32_to_cpu(tail->lrt_len) +
394 if (rec->lrh_index == 0)
395 GOTO(out, 0); /* no more records */
397 /* if set, process the callback on this record */
398 if (ext2_test_bit(index, llh->llh_bitmap)) {
399 rc = cb(loghandle, rec, data);
400 if (rc == LLOG_PROC_BREAK) {
401 CWARN("recovery from log: "LPX64":%x"
403 loghandle->lgh_id.lgl_oid,
404 loghandle->lgh_id.lgl_ogen);
411 /* previous record, still in buffer? */
413 if (index < first_index)
415 tail = (void *)rec - sizeof(*tail);
421 OBD_FREE(buf, LLOG_CHUNK_SIZE);
424 EXPORT_SYMBOL(llog_reverse_process);