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_test.c
38 * Author: Phil Schwan <phil@clusterfs.com>
42 # define EXPORT_SYMTAB
44 #define DEBUG_SUBSYSTEM S_CLASS
46 #include <linux/module.h>
47 #include <linux/init.h>
49 #include <obd_class.h>
50 #include <lustre_log.h>
52 static int llog_test_rand;
53 static struct obd_uuid uuid = { .uuid = "test_uuid" };
54 static struct llog_logid cat_logid;
56 struct llog_mini_rec {
57 struct llog_rec_hdr lmr_hdr;
58 struct llog_rec_tail lmr_tail;
59 } __attribute__((packed));
61 static int verify_handle(char *test, struct llog_handle *llh, int num_recs)
67 for (i = 0; i < LLOG_BITMAP_BYTES * 8; i++) {
68 if (ext2_test_bit(i, llh->lgh_hdr->llh_bitmap)) {
74 if (active_recs != num_recs) {
75 CERROR("%s: expected %d active recs after write, found %d\n",
76 test, num_recs, active_recs);
80 if (llh->lgh_hdr->llh_count != num_recs) {
81 CERROR("%s: handle->count is %d, expected %d after write\n",
82 test, llh->lgh_hdr->llh_count, num_recs);
86 if (llh->lgh_last_idx < last_idx) {
87 CERROR("%s: handle->last_idx is %d, expected %d after write\n",
88 test, llh->lgh_last_idx, last_idx);
95 /* Test named-log create/open, close */
96 static int llog_test_1(struct obd_device *obd, char *name)
98 struct llog_handle *llh;
99 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
104 CWARN("1a: create a log with name: %s\n", name);
107 rc = llog_create(ctxt, &llh, NULL, name);
109 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
113 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
115 if ((rc = verify_handle("1", llh, 1)))
119 CWARN("1b: close newly-created log\n");
120 rc2 = llog_close(llh);
123 CERROR("1b: close log %s failed: %d\n", name, rc2);
130 /* Test named-log reopen; returns opened log on success */
131 static int llog_test_2(struct obd_device *obd, char *name,
132 struct llog_handle **llh)
134 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
138 CWARN("2a: re-open a log with name: %s\n", name);
139 rc = llog_create(ctxt, llh, NULL, name);
141 CERROR("2a: re-open log with name %s failed: %d\n", name, rc);
144 llog_init_handle(*llh, LLOG_F_IS_PLAIN, &uuid);
146 if ((rc = verify_handle("2", *llh, 1)))
149 CWARN("2b: create a log without specified NAME & LOGID\n");
150 rc = llog_create(ctxt, &loghandle, NULL, NULL);
152 CERROR("2b: create log failed\n");
155 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
156 logid = loghandle->lgh_id;
157 llog_close(loghandle);
159 CWARN("2b: re-open the log by LOGID\n");
160 rc = llog_create(ctxt, &loghandle, &logid, NULL);
162 CERROR("2b: re-open log by LOGID failed\n");
165 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
167 CWARN("2b: destroy this log\n");
168 rc = llog_destroy(loghandle);
170 CERROR("2b: destroy log failed\n");
173 llog_free_handle(loghandle);
181 /* Test record writing, single and in bulk */
182 static int llog_test_3(struct obd_device *obd, struct llog_handle *llh)
184 struct llog_create_rec lcr;
186 int num_recs = 1; /* 1 for the header */
189 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
190 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
192 CWARN("3a: write one create_rec\n");
193 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
196 CERROR("3a: write one log record failed: %d\n", rc);
200 if ((rc = verify_handle("3a", llh, num_recs)))
203 CWARN("3b: write 10 cfg log records with 8 bytes bufs\n");
204 for (i = 0; i < 10; i++) {
205 struct llog_rec_hdr hdr;
208 hdr.lrh_type = OBD_CFG_REC;
209 memset(buf, 0, sizeof buf);
210 rc = llog_write_rec(llh, &hdr, NULL, 0, buf, -1);
212 CERROR("3b: write 10 records failed at #%d: %d\n",
217 if ((rc = verify_handle("3c", llh, num_recs)))
221 if ((rc = verify_handle("3b", llh, num_recs)))
224 CWARN("3c: write 1000 more log records\n");
225 for (i = 0; i < 1000; i++) {
226 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
228 CERROR("3c: write 1000 records failed at #%d: %d\n",
233 if ((rc = verify_handle("3b", llh, num_recs)))
237 if ((rc = verify_handle("3c", llh, num_recs)))
240 CWARN("3d: write log more than BITMAP_SIZE, return -ENOSPC\n");
241 for (i = 0; i < LLOG_BITMAP_SIZE(llh->lgh_hdr) + 1; i++) {
242 struct llog_rec_hdr hdr;
246 memset(buf_odd, 0, sizeof buf_odd);
247 memset(buf_even, 0, sizeof buf_even);
250 hdr.lrh_type = OBD_CFG_REC;
251 rc = llog_write_rec(llh, &hdr, NULL, 0, buf_even, -1);
254 hdr.lrh_type = OBD_CFG_REC;
255 rc = llog_write_rec(llh, &hdr, NULL, 0, buf_odd, -1);
261 CERROR("3c: write recs failed at #%d: %d\n",
269 CWARN("3d: write record more than BITMAP size!\n");
272 if ((rc = verify_handle("3d", llh, num_recs)))
278 /* Test catalogue additions */
279 static int llog_test_4(struct obd_device *obd)
281 struct llog_handle *cath;
284 struct llog_mini_rec lmr;
285 struct llog_cookie cookie;
286 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
289 struct llog_rec_hdr rec;
293 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
294 lmr.lmr_hdr.lrh_type = 0xf00f00;
296 sprintf(name, "%x", llog_test_rand+1);
297 CWARN("4a: create a catalog log with name: %s\n", name);
298 rc = llog_create(ctxt, &cath, NULL, name);
300 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
303 llog_init_handle(cath, LLOG_F_IS_CAT, &uuid);
305 cat_logid = cath->lgh_id;
307 CWARN("4b: write 1 record into the catalog\n");
308 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, &cookie, NULL);
310 CERROR("4b: write 1 catalog record failed at: %d\n", rc);
314 if ((rc = verify_handle("4b", cath, 2)))
315 GOTO(ctxt_release, rc);
317 if ((rc = verify_handle("4b", cath->u.chd.chd_current_log, num_recs)))
318 GOTO(ctxt_release, rc);
320 CWARN("4c: cancel 1 log record\n");
321 rc = llog_cat_cancel_records(cath, 1, &cookie);
323 CERROR("4c: cancel 1 catalog based record failed: %d\n", rc);
328 if ((rc = verify_handle("4c", cath->u.chd.chd_current_log, num_recs)))
329 GOTO(ctxt_release, rc);
331 CWARN("4d: write 40,000 more log records\n");
332 for (i = 0; i < 40000; i++) {
333 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, NULL, NULL);
335 CERROR("4d: write 40000 records failed at #%d: %d\n",
342 CWARN("4e: add 5 large records, one record per block\n");
343 buflen = LLOG_CHUNK_SIZE - sizeof(struct llog_rec_hdr)
344 - sizeof(struct llog_rec_tail);
345 OBD_ALLOC(buf, buflen);
347 GOTO(out, rc = -ENOMEM);
348 for (i = 0; i < 5; i++) {
349 rec.lrh_len = buflen;
350 rec.lrh_type = OBD_CFG_REC;
351 rc = llog_cat_add_rec(cath, &rec, NULL, buf);
353 CERROR("4e: write 5 records failed at #%d: %d\n",
355 OBD_FREE(buf, buflen);
360 OBD_FREE(buf, buflen);
363 CWARN("4f: put newly-created catalog\n");
364 rc = llog_cat_put(cath);
368 CERROR("1b: close log %s failed: %d\n", name, rc);
372 static int cat_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
375 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
377 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
378 CERROR("invalid record in catalog\n");
382 CWARN("seeing record at index %d - "LPX64":%x in log "LPX64"\n",
383 rec->lrh_index, lir->lid_id.lgl_oid,
384 lir->lid_id.lgl_ogen, llh->lgh_id.lgl_oid);
388 static int plain_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
391 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
392 CERROR("log is not plain\n");
396 CWARN("seeing record at index %d in log "LPX64"\n",
397 rec->lrh_index, llh->lgh_id.lgl_oid);
401 static int llog_cancel_rec_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
404 struct llog_cookie cookie;
407 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
408 CERROR("log is not plain\n");
412 cookie.lgc_lgl = llh->lgh_id;
413 cookie.lgc_index = rec->lrh_index;
415 llog_cat_cancel_records(llh->u.phd.phd_cat_handle, 1, &cookie);
422 /* Test log and catalogue processing */
423 static int llog_test_5(struct obd_device *obd)
425 struct llog_handle *llh = NULL;
428 struct llog_mini_rec lmr;
429 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
433 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
434 lmr.lmr_hdr.lrh_type = 0xf00f00;
436 CWARN("5a: re-open catalog by id\n");
437 rc = llog_create(ctxt, &llh, &cat_logid, NULL);
439 CERROR("5a: llog_create with logid failed: %d\n", rc);
442 llog_init_handle(llh, LLOG_F_IS_CAT, &uuid);
444 CWARN("5b: print the catalog entries.. we expect 2\n");
445 rc = llog_process(llh, cat_print_cb, "test 5", NULL);
447 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
451 CWARN("5c: Cancel 40000 records, see one log zapped\n");
452 rc = llog_cat_process(llh, llog_cancel_rec_cb, "foobar", 0, 0);
454 CERROR("5c: process with cat_cancel_cb failed: %d\n", rc);
458 CWARN("5d: add 1 record to the log with many canceled empty pages\n");
459 rc = llog_cat_add_rec(llh, &lmr.lmr_hdr, NULL, NULL);
461 CERROR("5d: add record to the log with many canceled empty\
466 CWARN("5b: print the catalog entries.. we expect 1\n");
467 rc = llog_process(llh, cat_print_cb, "test 5", NULL);
469 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
473 CWARN("5e: print plain log entries.. expect 6\n");
474 rc = llog_cat_process(llh, plain_print_cb, "foobar", 0, 0);
476 CERROR("5e: process with plain_print_cb failed: %d\n", rc);
480 CWARN("5f: print plain log entries reversely.. expect 6\n");
481 rc = llog_cat_reverse_process(llh, plain_print_cb, "foobar");
483 CERROR("5f: reversely process with plain_print_cb failed: %d\n", rc);
488 CWARN("5: close re-opened catalog\n");
490 rc = llog_cat_put(llh);
492 CERROR("1b: close log %s failed: %d\n", name, rc);
498 /* Test client api; open log by name and process */
499 static int llog_test_6(struct obd_device *obd, char *name)
501 struct obd_device *mgc_obd;
502 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
503 struct obd_uuid *mgs_uuid = &ctxt->loc_exp->exp_obd->obd_uuid;
504 struct obd_export *exp;
505 struct obd_uuid uuid = {"LLOG_TEST6_UUID"};
506 struct llog_handle *llh = NULL;
507 struct llog_ctxt *nctxt;
510 CWARN("6a: re-open log %s using client API\n", name);
511 mgc_obd = class_find_client_obd(mgs_uuid, LUSTRE_MGC_NAME, NULL);
512 if (mgc_obd == NULL) {
513 CERROR("6: no MGC devices connected to %s found.\n",
515 GOTO(ctxt_release, rc = -ENOENT);
518 rc = obd_connect(NULL, &exp, mgc_obd, &uuid,
519 NULL /* obd_connect_data */, NULL);
521 CERROR("6: failed to connect to MGC: %s\n", mgc_obd->obd_name);
522 GOTO(ctxt_release, rc);
524 LASSERTF(exp->exp_obd == mgc_obd, "%p - %p - %p\n", exp, exp->exp_obd, mgc_obd);
526 nctxt = llog_get_context(mgc_obd, LLOG_CONFIG_REPL_CTXT);
527 rc = llog_create(nctxt, &llh, NULL, name);
529 CERROR("6: llog_create failed %d\n", rc);
530 llog_ctxt_put(nctxt);
531 GOTO(ctxt_release, rc);
534 rc = llog_init_handle(llh, LLOG_F_IS_PLAIN, NULL);
536 CERROR("6: llog_init_handle failed %d\n", rc);
540 rc = llog_process(llh, plain_print_cb, NULL, NULL);
542 CERROR("6: llog_process failed %d\n", rc);
544 rc = llog_reverse_process(llh, plain_print_cb, NULL, NULL);
546 CERROR("6: llog_reverse_process failed %d\n", rc);
549 rc = llog_close(llh);
550 llog_ctxt_put(nctxt);
552 CERROR("6: llog_close failed: rc = %d\n", rc);
554 CDEBUG(D_INFO, "obd %p - %p - %p - %p\n",
555 mgc_obd, exp, exp->exp_obd, exp->exp_obd->obd_type);
556 rc = obd_disconnect(exp);
562 static int llog_test_7(struct obd_device *obd)
564 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
565 struct llog_handle *llh;
566 struct llog_create_rec lcr;
571 sprintf(name, "%x", llog_test_rand+2);
572 CWARN("7: create a log with name: %s\n", name);
575 rc = llog_create(ctxt, &llh, NULL, name);
577 CERROR("7: llog_create with name %s failed: %d\n", name, rc);
578 GOTO(ctxt_release, rc);
580 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
582 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
583 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
584 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
586 CERROR("7: write one log record failed: %d\n", rc);
587 GOTO(ctxt_release, rc);
590 rc = llog_destroy(llh);
592 CERROR("7: llog_destroy failed: %d\n", rc);
594 llog_free_handle(llh);
600 /* -------------------------------------------------------------------------
601 * Tests above, boring obd functions below
602 * ------------------------------------------------------------------------- */
603 static int llog_run_tests(struct obd_device *obd)
605 struct llog_handle *llh;
606 struct lvfs_run_ctxt saved;
607 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
608 int rc, err, cleanup_phase = 0;
612 sprintf(name, "%x", llog_test_rand);
613 push_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_lvfs_ctxt, NULL);
615 rc = llog_test_1(obd, name);
619 rc = llog_test_2(obd, name, &llh);
622 cleanup_phase = 1; /* close llh */
624 rc = llog_test_3(obd, llh);
628 rc = llog_test_4(obd);
632 rc = llog_test_5(obd);
636 rc = llog_test_6(obd, name);
640 rc = llog_test_7(obd);
645 switch (cleanup_phase) {
647 err = llog_close(llh);
649 CERROR("cleanup: llog_close failed: %d\n", err);
653 pop_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_lvfs_ctxt, NULL);
660 static int llog_test_llog_init(struct obd_device *obd,
661 struct obd_llog_group *olg,
662 struct obd_device *tgt, int count,
663 struct llog_catid *logid, struct obd_uuid *uuid)
668 rc = llog_setup(obd, &obd->obd_olg, LLOG_TEST_ORIG_CTXT, tgt, 0, NULL,
673 static int llog_test_llog_finish(struct obd_device *obd, int count)
678 rc = llog_cleanup(llog_get_context(obd, LLOG_TEST_ORIG_CTXT));
682 static struct lprocfs_vars lprocfs_llog_test_obd_vars[] = { {0} };
683 static struct lprocfs_vars lprocfs_llog_test_module_vars[] = { {0} };
684 static void lprocfs_llog_test_init_vars(struct lprocfs_static_vars *lvars)
686 lvars->module_vars = lprocfs_llog_test_module_vars;
687 lvars->obd_vars = lprocfs_llog_test_obd_vars;
691 static int llog_test_cleanup(struct obd_device *obd)
693 int rc = obd_llog_finish(obd, 0);
695 CERROR("failed to llog_test_llog_finish: %d\n", rc);
697 lprocfs_obd_cleanup(obd);
702 static int llog_test_setup(struct obd_device *obd, struct lustre_cfg *lcfg)
704 struct lprocfs_static_vars lvars;
705 struct obd_device *tgt;
709 if (lcfg->lcfg_bufcount < 2) {
710 CERROR("requires a TARGET OBD name\n");
714 if (lcfg->lcfg_buflens[1] < 1) {
715 CERROR("requires a TARGET OBD name\n");
719 tgt = class_name2obd(lustre_cfg_string(lcfg, 1));
720 if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
721 CERROR("target device not attached or not set up (%s)\n",
722 lustre_cfg_string(lcfg, 1));
726 rc = obd_llog_init(obd, NULL, tgt, 0, NULL, NULL);
730 llog_test_rand = ll_rand();
732 rc = llog_run_tests(obd);
734 llog_test_cleanup(obd);
736 lprocfs_llog_test_init_vars(&lvars);
737 lprocfs_obd_setup(obd, lvars.obd_vars);
742 static struct obd_ops llog_obd_ops = {
743 .o_owner = THIS_MODULE,
744 .o_setup = llog_test_setup,
745 .o_cleanup = llog_test_cleanup,
746 .o_llog_init = llog_test_llog_init,
747 .o_llog_finish = llog_test_llog_finish,
750 static int __init llog_test_init(void)
752 struct lprocfs_static_vars lvars;
754 lprocfs_llog_test_init_vars(&lvars);
755 return class_register_type(&llog_obd_ops, NULL,
756 lvars.module_vars,"llog_test", NULL);
759 static void __exit llog_test_exit(void)
761 class_unregister_type("llog_test");
764 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
765 MODULE_DESCRIPTION("llog test module");
766 MODULE_LICENSE("GPL");
768 module_init(llog_test_init);
769 module_exit(llog_test_exit);