Whamcloud - gitweb
*** empty log message ***
[fs/lustre-release.git] / lustre / obdclass / llog_cat.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
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.
11  *
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).
17  *
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
21  *
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
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/obdclass/llog_cat.c
37  *
38  * OST<->MDS recovery logging infrastructure.
39  *
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
43  *
44  * Author: Andreas Dilger <adilger@clusterfs.com>
45  */
46
47 #define DEBUG_SUBSYSTEM S_LOG
48
49 #ifndef EXPORT_SYMTAB
50 #define EXPORT_SYMTAB
51 #endif
52
53 #ifndef __KERNEL__
54 #include <liblustre.h>
55 #endif
56
57 #include <obd_class.h>
58 #include <lustre_log.h>
59 #include <libcfs/list.h>
60
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.
63  *
64  * Assumes caller has already pushed us into the kernel context and is locking.
65  */
66 static struct llog_handle *llog_cat_new_log(struct llog_handle *cathandle)
67 {
68         struct llog_handle *loghandle;
69         struct llog_log_hdr *llh;
70         struct llog_logid_rec rec = { { 0 }, };
71         int rc, index, bitmap_size;
72         ENTRY;
73
74         llh = cathandle->lgh_hdr;
75         bitmap_size = LLOG_BITMAP_SIZE(llh);
76
77         index = (cathandle->lgh_last_idx + 1) % bitmap_size;
78
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));
83         }
84
85         if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED))
86                 RETURN(ERR_PTR(-ENOSPC));
87
88         rc = llog_create(cathandle->lgh_ctxt, &loghandle, NULL, NULL);
89         if (rc)
90                 RETURN(ERR_PTR(rc));
91
92         rc = llog_init_handle(loghandle,
93                               LLOG_F_IS_PLAIN | LLOG_F_ZAP_WHEN_EMPTY,
94                               &cathandle->lgh_hdr->llh_tgtuuid);
95         if (rc)
96                 GOTO(out_destroy, rc);
97
98         if (index == 0)
99                 index = 1;
100         if (ext2_set_bit(index, llh->llh_bitmap)) {
101                 CERROR("argh, index %u already set in log bitmap?\n",
102                        index);
103                 LBUG(); /* should never happen */
104         }
105         cathandle->lgh_last_idx = index;
106         llh->llh_count++;
107         llh->llh_tail.lrt_index = index;
108
109         CDEBUG(D_RPCTRACE,"new recovery log "LPX64":%x for index %u of catalog "
110                LPX64"\n", loghandle->lgh_id.lgl_oid, loghandle->lgh_id.lgl_ogen,
111                index, cathandle->lgh_id.lgl_oid);
112         /* build the record for this log in the catalog */
113         rec.lid_hdr.lrh_len = sizeof(rec);
114         rec.lid_hdr.lrh_index = index;
115         rec.lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
116         rec.lid_id = loghandle->lgh_id;
117         rec.lid_tail.lrt_len = sizeof(rec);
118         rec.lid_tail.lrt_index = index;
119
120         /* update the catalog: header and record */
121         rc = llog_write_rec(cathandle, &rec.lid_hdr,
122                             &loghandle->u.phd.phd_cookie, 1, NULL, index);
123         if (rc < 0) {
124                 GOTO(out_destroy, rc);
125         }
126
127         loghandle->lgh_hdr->llh_cat_idx = index;
128         cathandle->u.chd.chd_current_log = loghandle;
129         LASSERT(list_empty(&loghandle->u.phd.phd_entry));
130         list_add_tail(&loghandle->u.phd.phd_entry, &cathandle->u.chd.chd_head);
131
132 out_destroy:
133         if (rc < 0)
134                 llog_destroy(loghandle);
135
136         RETURN(loghandle);
137 }
138
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.
141  *
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.
144  */
145 int llog_cat_id2handle(struct llog_handle *cathandle, struct llog_handle **res,
146                        struct llog_logid *logid)
147 {
148         struct llog_handle *loghandle;
149         int rc = 0;
150         ENTRY;
151
152         if (cathandle == NULL)
153                 RETURN(-EBADF);
154
155         list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
156                             u.phd.phd_entry) {
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,
162                                        logid->lgl_ogen);
163                                 continue;
164                         }
165                         loghandle->u.phd.phd_cat_handle = cathandle;
166                         GOTO(out, rc = 0);
167                 }
168         }
169
170         rc = llog_create(cathandle->lgh_ctxt, &loghandle, logid, NULL);
171         if (rc) {
172                 CERROR("error opening log id "LPX64":%x: rc %d\n",
173                        logid->lgl_oid, logid->lgl_ogen, rc);
174         } else {
175                 rc = llog_init_handle(loghandle, LLOG_F_IS_PLAIN, NULL);
176                 if (!rc) {
177                         list_add(&loghandle->u.phd.phd_entry,
178                                  &cathandle->u.chd.chd_head);
179                 }
180         }
181         if (!rc) {
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;
186         }
187
188 out:
189         *res = loghandle;
190         RETURN(rc);
191 }
192
193 int llog_cat_put(struct llog_handle *cathandle)
194 {
195         struct llog_handle *loghandle, *n;
196         int rc;
197         ENTRY;
198
199         list_for_each_entry_safe(loghandle, n, &cathandle->u.chd.chd_head,
200                                  u.phd.phd_entry) {
201                 int err = llog_close(loghandle);
202                 if (err)
203                         CERROR("error closing loghandle\n");
204         }
205         rc = llog_close(cathandle);
206         RETURN(rc);
207 }
208 EXPORT_SYMBOL(llog_cat_put);
209
210 /**
211  * lockdep markers for nested struct llog_handle::lgh_lock locking.
212  */
213 enum {
214         LLOGH_CAT,
215         LLOGH_LOG
216 };
217
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.
220  *
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.
223  *
224  * Assumes caller has already pushed us into the kernel context and is locking.
225  *
226  * NOTE: loghandle is write-locked upon successful return
227  */
228 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
229                                                 int create)
230 {
231         struct llog_handle *loghandle = NULL;
232         ENTRY;
233
234         down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
235         loghandle = cathandle->u.chd.chd_current_log;
236         if (loghandle) {
237                 struct llog_log_hdr *llh = loghandle->lgh_hdr;
238                 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
239                 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
240                         up_read(&cathandle->lgh_lock);
241                         RETURN(loghandle);
242                 } else {
243                         up_write(&loghandle->lgh_lock);
244                 }
245         }
246         if (!create) {
247                 if (loghandle)
248                         down_write(&loghandle->lgh_lock);
249                 up_read(&cathandle->lgh_lock);
250                 RETURN(loghandle);
251         }
252         up_read(&cathandle->lgh_lock);
253
254         /* time to create new log */
255
256         /* first, we have to make sure the state hasn't changed */
257         down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
258         loghandle = cathandle->u.chd.chd_current_log;
259         if (loghandle) {
260                 struct llog_log_hdr *llh = loghandle->lgh_hdr;
261                 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
262                 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
263                         up_write(&cathandle->lgh_lock);
264                         RETURN(loghandle);
265                 } else {
266                         up_write(&loghandle->lgh_lock);
267                 }
268         }
269
270         CDEBUG(D_INODE, "creating new log\n");
271         loghandle = llog_cat_new_log(cathandle);
272         if (!IS_ERR(loghandle))
273                 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
274         up_write(&cathandle->lgh_lock);
275         RETURN(loghandle);
276 }
277
278 /* Add a single record to the recovery log(s) using a catalog
279  * Returns as llog_write_record
280  *
281  * Assumes caller has already pushed us into the kernel context.
282  */
283 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
284                      struct llog_cookie *reccookie, void *buf)
285 {
286         struct llog_handle *loghandle;
287         int rc;
288         ENTRY;
289
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);
296         if (rc < 0)
297                 CERROR("llog_write_rec %d: lh=%p\n", rc, loghandle);
298         up_write(&loghandle->lgh_lock);
299         if (rc == -ENOSPC) {
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                 up_write(&loghandle->lgh_lock);
306         }
307
308         RETURN(rc);
309 }
310 EXPORT_SYMBOL(llog_cat_add_rec);
311
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
315  *
316  * The cookies may be in different log files, so we need to get new logs
317  * each time.
318  *
319  * Assumes caller has already pushed us into the kernel context.
320  */
321 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
322                             struct llog_cookie *cookies)
323 {
324         int i, index, rc = 0;
325         ENTRY;
326
327         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;
331
332                 rc = llog_cat_id2handle(cathandle, &loghandle, lgl);
333                 if (rc) {
334                         CERROR("Cannot find log "LPX64"\n", lgl->lgl_oid);
335                         break;
336                 }
337
338                 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
339                 rc = llog_cancel_rec(loghandle, cookies->lgc_index);
340                 up_write(&loghandle->lgh_lock);
341
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);
347
348                         LASSERT(index);
349                         llog_cat_set_first_idx(cathandle, index);
350                         rc = llog_cancel_rec(cathandle, index);
351                         if (rc == 0)
352                                 CDEBUG(D_RPCTRACE,"cancel plain log at index %u"
353                                        " of catalog "LPX64"\n",
354                                        index, cathandle->lgh_id.lgl_oid);
355                 }
356         }
357         up_write(&cathandle->lgh_lock);
358
359         RETURN(rc);
360 }
361 EXPORT_SYMBOL(llog_cat_cancel_records);
362
363 int llog_cat_process_cb(struct llog_handle *cat_llh, struct llog_rec_hdr *rec,
364                         void *data)
365 {
366         struct llog_process_data *d = data;
367         struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
368         struct llog_handle *llh;
369         int rc;
370
371         ENTRY;
372         if (rec->lrh_type != LLOG_LOGID_MAGIC) {
373                 CERROR("invalid record in catalog\n");
374                 RETURN(-EINVAL);
375         }
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);
379
380         rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
381         if (rc) {
382                 CERROR("Cannot find handle for log "LPX64"\n",
383                        lir->lid_id.lgl_oid);
384                 RETURN(rc);
385         }
386
387         if (rec->lrh_index < d->lpd_startcat)
388                 /* Skip processing of the logs until startcat */
389                 RETURN(0);
390
391         if (d->lpd_startidx > 0) {
392                 struct llog_process_cat_data cd;
393
394                 cd.lpcd_first_idx = d->lpd_startidx;
395                 cd.lpcd_last_idx = 0;
396                 rc = llog_process(llh, d->lpd_cb, d->lpd_data, &cd);
397                 /* Continue processing the next log from idx 0 */
398                 d->lpd_startidx = 0;
399         } else {
400                 rc = llog_process(llh, d->lpd_cb, d->lpd_data, NULL);
401         }
402
403         RETURN(rc);
404 }
405
406 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data,
407                      int startcat, int startidx)
408 {
409         struct llog_process_data d;
410         struct llog_log_hdr *llh = cat_llh->lgh_hdr;
411         int rc;
412         ENTRY;
413
414         LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
415         d.lpd_data = data;
416         d.lpd_cb = cb;
417         d.lpd_startcat = startcat;
418         d.lpd_startidx = startidx;
419
420         if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
421                 struct llog_process_cat_data cd;
422
423                 CWARN("catlog "LPX64" crosses index zero\n",
424                       cat_llh->lgh_id.lgl_oid);
425
426                 cd.lpcd_first_idx = llh->llh_cat_idx;
427                 cd.lpcd_last_idx = 0;
428                 rc = llog_process(cat_llh, llog_cat_process_cb, &d, &cd);
429                 if (rc != 0)
430                         RETURN(rc);
431
432                 cd.lpcd_first_idx = 0;
433                 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
434                 rc = llog_process(cat_llh, llog_cat_process_cb, &d, &cd);
435         } else {
436                 rc = llog_process(cat_llh, llog_cat_process_cb, &d, NULL);
437         }
438
439         RETURN(rc);
440 }
441 EXPORT_SYMBOL(llog_cat_process);
442
443 #ifdef __KERNEL__
444 int llog_cat_process_thread(void *data)
445 {
446         struct llog_process_cat_args *args = data;
447         struct llog_ctxt *ctxt = args->lpca_ctxt;
448         struct llog_handle *llh = NULL;
449         llog_cb_t cb = args->lpca_cb;
450         struct llog_logid logid;
451         int rc;
452         ENTRY;
453
454         cfs_daemonize_ctxt("ll_log_process");
455
456         logid = *(struct llog_logid *)(args->lpca_arg);
457         rc = llog_create(ctxt, &llh, &logid, NULL);
458         if (rc) {
459                 CERROR("llog_create() failed %d\n", rc);
460                 GOTO(out, rc);
461         }
462         rc = llog_init_handle(llh, LLOG_F_IS_CAT, NULL);
463         if (rc) {
464                 CERROR("llog_init_handle failed %d\n", rc);
465                 GOTO(release_llh, rc);
466         }
467
468         if (cb) {
469                 rc = llog_cat_process(llh, cb, NULL, 0, 0);
470                 if (rc != LLOG_PROC_BREAK && rc != 0)
471                         CERROR("llog_cat_process() failed %d\n", rc);
472                 cb(llh, NULL, NULL);
473         } else {
474                 CWARN("No callback function for recovery\n");
475         }
476
477         /*
478          * Make sure that all cached data is sent.
479          */
480         llog_sync(ctxt, NULL);
481         GOTO(release_llh, rc);
482 release_llh:
483         rc = llog_cat_put(llh);
484         if (rc)
485                 CERROR("llog_cat_put() failed %d\n", rc);
486 out:
487         llog_ctxt_put(ctxt);
488         OBD_FREE_PTR(args);
489         return rc;
490 }
491 EXPORT_SYMBOL(llog_cat_process_thread);
492 #endif
493
494 static int llog_cat_reverse_process_cb(struct llog_handle *cat_llh,
495                                        struct llog_rec_hdr *rec, void *data)
496 {
497         struct llog_process_data *d = data;
498         struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
499         struct llog_handle *llh;
500         int rc;
501
502         if (le32_to_cpu(rec->lrh_type) != LLOG_LOGID_MAGIC) {
503                 CERROR("invalid record in catalog\n");
504                 RETURN(-EINVAL);
505         }
506         CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
507                LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
508                le32_to_cpu(rec->lrh_index), cat_llh->lgh_id.lgl_oid);
509
510         rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
511         if (rc) {
512                 CERROR("Cannot find handle for log "LPX64"\n",
513                        lir->lid_id.lgl_oid);
514                 RETURN(rc);
515         }
516
517         rc = llog_reverse_process(llh, d->lpd_cb, d->lpd_data, NULL);
518         RETURN(rc);
519 }
520
521 int llog_cat_reverse_process(struct llog_handle *cat_llh,
522                              llog_cb_t cb, void *data)
523 {
524         struct llog_process_data d;
525         struct llog_process_cat_data cd;
526         struct llog_log_hdr *llh = cat_llh->lgh_hdr;
527         int rc;
528         ENTRY;
529
530         LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
531         d.lpd_data = data;
532         d.lpd_cb = cb;
533
534         if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
535                 CWARN("catalog "LPX64" crosses index zero\n",
536                       cat_llh->lgh_id.lgl_oid);
537
538                 cd.lpcd_first_idx = 0;
539                 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
540                 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
541                                           &d, &cd);
542                 if (rc != 0)
543                         RETURN(rc);
544
545                 cd.lpcd_first_idx = le32_to_cpu(llh->llh_cat_idx);
546                 cd.lpcd_last_idx = 0;
547                 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
548                                           &d, &cd);
549         } else {
550                 rc = llog_reverse_process(cat_llh, llog_cat_reverse_process_cb,
551                                           &d, NULL);
552         }
553
554         RETURN(rc);
555 }
556 EXPORT_SYMBOL(llog_cat_reverse_process);
557
558 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index)
559 {
560         struct llog_log_hdr *llh = cathandle->lgh_hdr;
561         int i, bitmap_size, idx;
562         ENTRY;
563
564         bitmap_size = LLOG_BITMAP_SIZE(llh);
565         if (llh->llh_cat_idx == (index - 1)) {
566                 idx = llh->llh_cat_idx + 1;
567                 llh->llh_cat_idx = idx;
568                 if (idx == cathandle->lgh_last_idx)
569                         goto out;
570                 for (i = (index + 1) % bitmap_size;
571                      i != cathandle->lgh_last_idx;
572                      i = (i + 1) % bitmap_size) {
573                         if (!ext2_test_bit(i, llh->llh_bitmap)) {
574                                 idx = llh->llh_cat_idx + 1;
575                                 llh->llh_cat_idx = idx;
576                         } else if (i == 0) {
577                                 llh->llh_cat_idx = 0;
578                         } else {
579                                 break;
580                         }
581                 }
582 out:
583                 CDEBUG(D_RPCTRACE, "set catlog "LPX64" first idx %u\n",
584                        cathandle->lgh_id.lgl_oid, llh->llh_cat_idx);
585         }
586
587         RETURN(0);
588 }