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_test.c
36 * Author: Phil Schwan <phil@clusterfs.com>
39 #define DEBUG_SUBSYSTEM S_CLASS
41 #include <linux/module.h>
42 #include <linux/init.h>
44 #include <obd_class.h>
45 #include <lustre_log.h>
47 static int llog_test_rand;
48 static struct obd_uuid uuid = { .uuid = "test_uuid" };
49 static struct llog_logid cat_logid;
51 struct llog_mini_rec {
52 struct llog_rec_hdr lmr_hdr;
53 struct llog_rec_tail lmr_tail;
54 } __attribute__((packed));
56 static int verify_handle(char *test, struct llog_handle *llh, int num_recs)
62 for (i = 0; i < LLOG_BITMAP_BYTES * 8; i++) {
63 if (ext2_test_bit(i, llh->lgh_hdr->llh_bitmap)) {
69 if (active_recs != num_recs) {
70 CERROR("%s: expected %d active recs after write, found %d\n",
71 test, num_recs, active_recs);
75 if (llh->lgh_hdr->llh_count != num_recs) {
76 CERROR("%s: handle->count is %d, expected %d after write\n",
77 test, llh->lgh_hdr->llh_count, num_recs);
81 if (llh->lgh_last_idx < last_idx) {
82 CERROR("%s: handle->last_idx is %d, expected %d after write\n",
83 test, llh->lgh_last_idx, last_idx);
90 /* Test named-log create/open, close */
91 static int llog_test_1(struct obd_device *obd, char *name)
93 struct llog_handle *llh;
94 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
99 CWARN("1a: create a log with name: %s\n", name);
102 rc = llog_create(ctxt, &llh, NULL, name);
104 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
108 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
110 if ((rc = verify_handle("1", llh, 1)))
114 CWARN("1b: close newly-created log\n");
115 rc2 = llog_close(llh);
118 CERROR("1b: close log %s failed: %d\n", name, rc2);
125 /* Test named-log reopen; returns opened log on success */
126 static int llog_test_2(struct obd_device *obd, char *name,
127 struct llog_handle **llh)
129 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
133 CWARN("2a: re-open a log with name: %s\n", name);
134 rc = llog_create(ctxt, llh, NULL, name);
136 CERROR("2a: re-open log with name %s failed: %d\n", name, rc);
139 llog_init_handle(*llh, LLOG_F_IS_PLAIN, &uuid);
141 if ((rc = verify_handle("2", *llh, 1)))
144 CWARN("2b: create a log without specified NAME & LOGID\n");
145 rc = llog_create(ctxt, &loghandle, NULL, NULL);
147 CERROR("2b: create log failed\n");
150 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
151 logid = loghandle->lgh_id;
152 llog_close(loghandle);
154 CWARN("2b: re-open the log by LOGID\n");
155 rc = llog_create(ctxt, &loghandle, &logid, NULL);
157 CERROR("2b: re-open log by LOGID failed\n");
160 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
162 CWARN("2b: destroy this log\n");
163 rc = llog_destroy(loghandle);
165 CERROR("2b: destroy log failed\n");
168 llog_free_handle(loghandle);
176 /* Test record writing, single and in bulk */
177 static int llog_test_3(struct obd_device *obd, struct llog_handle *llh)
179 struct llog_create_rec lcr;
181 int num_recs = 1; /* 1 for the header */
184 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
185 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
187 CWARN("3a: write one create_rec\n");
188 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
191 CERROR("3a: write one log record failed: %d\n", rc);
195 if ((rc = verify_handle("3a", llh, num_recs)))
198 CWARN("3b: write 10 cfg log records with 8 bytes bufs\n");
199 for (i = 0; i < 10; i++) {
200 struct llog_rec_hdr hdr;
203 hdr.lrh_type = OBD_CFG_REC;
204 memset(buf, 0, sizeof buf);
205 rc = llog_write_rec(llh, &hdr, NULL, 0, buf, -1);
207 CERROR("3b: write 10 records failed at #%d: %d\n",
212 if ((rc = verify_handle("3c", llh, num_recs)))
216 if ((rc = verify_handle("3b", llh, num_recs)))
219 CWARN("3c: write 1000 more log records\n");
220 for (i = 0; i < 1000; i++) {
221 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
223 CERROR("3c: write 1000 records failed at #%d: %d\n",
228 if ((rc = verify_handle("3b", llh, num_recs)))
232 if ((rc = verify_handle("3c", llh, num_recs)))
235 CWARN("3d: write log more than BITMAP_SIZE, return -ENOSPC\n");
236 for (i = 0; i < LLOG_BITMAP_SIZE(llh->lgh_hdr) + 1; i++) {
237 struct llog_rec_hdr hdr;
241 memset(buf_odd, 0, sizeof buf_odd);
242 memset(buf_even, 0, sizeof buf_even);
245 hdr.lrh_type = OBD_CFG_REC;
246 rc = llog_write_rec(llh, &hdr, NULL, 0, buf_even, -1);
249 hdr.lrh_type = OBD_CFG_REC;
250 rc = llog_write_rec(llh, &hdr, NULL, 0, buf_odd, -1);
256 CERROR("3c: write recs failed at #%d: %d\n",
264 CWARN("3d: write record more than BITMAP size!\n");
267 if ((rc = verify_handle("3d", llh, num_recs)))
273 /* Test catalogue additions */
274 static int llog_test_4(struct obd_device *obd)
276 struct llog_handle *cath;
279 struct llog_mini_rec lmr;
280 struct llog_cookie cookie;
281 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
284 struct llog_rec_hdr rec;
288 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
289 lmr.lmr_hdr.lrh_type = 0xf00f00;
291 sprintf(name, "%x", llog_test_rand+1);
292 CWARN("4a: create a catalog log with name: %s\n", name);
293 rc = llog_create(ctxt, &cath, NULL, name);
295 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
298 llog_init_handle(cath, LLOG_F_IS_CAT, &uuid);
300 cat_logid = cath->lgh_id;
302 CWARN("4b: write 1 record into the catalog\n");
303 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, &cookie, NULL);
305 CERROR("4b: write 1 catalog record failed at: %d\n", rc);
309 if ((rc = verify_handle("4b", cath, 2)))
310 GOTO(ctxt_release, rc);
312 if ((rc = verify_handle("4b", cath->u.chd.chd_current_log, num_recs)))
313 GOTO(ctxt_release, rc);
315 CWARN("4c: cancel 1 log record\n");
316 rc = llog_cat_cancel_records(cath, 1, &cookie);
318 CERROR("4c: cancel 1 catalog based record failed: %d\n", rc);
323 if ((rc = verify_handle("4c", cath->u.chd.chd_current_log, num_recs)))
324 GOTO(ctxt_release, rc);
326 CWARN("4d: write 40,000 more log records\n");
327 for (i = 0; i < 40000; i++) {
328 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, NULL, NULL);
330 CERROR("4d: write 40000 records failed at #%d: %d\n",
337 CWARN("4e: add 5 large records, one record per block\n");
338 buflen = LLOG_CHUNK_SIZE - sizeof(struct llog_rec_hdr)
339 - sizeof(struct llog_rec_tail);
340 OBD_ALLOC(buf, buflen);
342 GOTO(out, rc = -ENOMEM);
343 for (i = 0; i < 5; i++) {
344 rec.lrh_len = buflen;
345 rec.lrh_type = OBD_CFG_REC;
346 rc = llog_cat_add_rec(cath, &rec, NULL, buf);
348 CERROR("4e: write 5 records failed at #%d: %d\n",
350 OBD_FREE(buf, buflen);
355 OBD_FREE(buf, buflen);
358 CWARN("4f: put newly-created catalog\n");
359 rc = llog_cat_put(cath);
363 CERROR("1b: close log %s failed: %d\n", name, rc);
367 static int cat_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
370 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
372 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
373 CERROR("invalid record in catalog\n");
377 CWARN("seeing record at index %d - "LPX64":%x in log "LPX64"\n",
378 rec->lrh_index, lir->lid_id.lgl_oid,
379 lir->lid_id.lgl_ogen, llh->lgh_id.lgl_oid);
383 static int plain_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
386 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
387 CERROR("log is not plain\n");
391 CWARN("seeing record at index %d in log "LPX64"\n",
392 rec->lrh_index, llh->lgh_id.lgl_oid);
396 static int llog_cancel_rec_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
399 struct llog_cookie cookie;
402 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
403 CERROR("log is not plain\n");
407 cookie.lgc_lgl = llh->lgh_id;
408 cookie.lgc_index = rec->lrh_index;
410 llog_cat_cancel_records(llh->u.phd.phd_cat_handle, 1, &cookie);
417 /* Test log and catalogue processing */
418 static int llog_test_5(struct obd_device *obd)
420 struct llog_handle *llh = NULL;
423 struct llog_mini_rec lmr;
424 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
428 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
429 lmr.lmr_hdr.lrh_type = 0xf00f00;
431 CWARN("5a: re-open catalog by id\n");
432 rc = llog_create(ctxt, &llh, &cat_logid, NULL);
434 CERROR("5a: llog_create with logid failed: %d\n", rc);
437 llog_init_handle(llh, LLOG_F_IS_CAT, &uuid);
439 CWARN("5b: print the catalog entries.. we expect 2\n");
440 rc = llog_process(NULL, llh, cat_print_cb, "test 5", NULL);
442 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
446 CWARN("5c: Cancel 40000 records, see one log zapped\n");
447 rc = llog_cat_process(NULL, llh, llog_cancel_rec_cb, "foobar", 0, 0);
449 CERROR("5c: process with cat_cancel_cb failed: %d\n", rc);
453 CWARN("5d: add 1 record to the log with many canceled empty pages\n");
454 rc = llog_cat_add_rec(llh, &lmr.lmr_hdr, NULL, NULL);
456 CERROR("5d: add record to the log with many canceled empty\
461 CWARN("5b: print the catalog entries.. we expect 1\n");
462 rc = llog_process(NULL, llh, cat_print_cb, "test 5", NULL);
464 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
468 CWARN("5e: print plain log entries.. expect 6\n");
469 rc = llog_cat_process(NULL, llh, plain_print_cb, "foobar", 0, 0);
471 CERROR("5e: process with plain_print_cb failed: %d\n", rc);
475 CWARN("5f: print plain log entries reversely.. expect 6\n");
476 rc = llog_cat_reverse_process(NULL, llh, plain_print_cb, "foobar");
478 CERROR("5f: reversely process with plain_print_cb failed: %d\n", rc);
483 CWARN("5: close re-opened catalog\n");
485 rc = llog_cat_put(llh);
487 CERROR("1b: close log %s failed: %d\n", name, rc);
493 /* Test client api; open log by name and process */
494 static int llog_test_6(struct obd_device *obd, char *name)
496 struct obd_device *mgc_obd;
497 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
498 struct obd_uuid *mgs_uuid = &ctxt->loc_exp->exp_obd->obd_uuid;
499 struct obd_export *exp;
500 struct obd_uuid uuid = {"LLOG_TEST6_UUID"};
501 struct llog_handle *llh = NULL;
502 struct llog_ctxt *nctxt;
505 CWARN("6a: re-open log %s using client API\n", name);
506 mgc_obd = class_find_client_obd(mgs_uuid, LUSTRE_MGC_NAME, NULL);
507 if (mgc_obd == NULL) {
508 CERROR("6: no MGC devices connected to %s found.\n",
510 GOTO(ctxt_release, rc = -ENOENT);
513 rc = obd_connect(NULL, &exp, mgc_obd, &uuid,
514 NULL /* obd_connect_data */, NULL);
515 if (rc != -EALREADY) {
516 CERROR("6: connect on connected MDC (%s) failed to return"
517 " -EALREADY", mgc_obd->obd_name);
520 GOTO(ctxt_release, rc = -EINVAL);
523 nctxt = llog_get_context(mgc_obd, LLOG_CONFIG_REPL_CTXT);
524 rc = llog_create(nctxt, &llh, NULL, name);
526 CERROR("6: llog_create failed %d\n", rc);
527 llog_ctxt_put(nctxt);
528 GOTO(ctxt_release, rc);
531 rc = llog_init_handle(llh, LLOG_F_IS_PLAIN, NULL);
533 CERROR("6: llog_init_handle failed %d\n", rc);
537 rc = llog_process(NULL, llh, plain_print_cb, NULL, NULL);
539 CERROR("6: llog_process failed %d\n", rc);
541 rc = llog_reverse_process(NULL, llh, plain_print_cb, NULL, NULL);
543 CERROR("6: llog_reverse_process failed %d\n", rc);
546 rc = llog_close(llh);
547 llog_ctxt_put(nctxt);
549 CERROR("6: llog_close failed: rc = %d\n", rc);
556 static int llog_test_7(struct obd_device *obd)
558 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
559 struct llog_handle *llh;
560 struct llog_create_rec lcr;
565 sprintf(name, "%x", llog_test_rand+2);
566 CWARN("7: create a log with name: %s\n", name);
569 rc = llog_create(ctxt, &llh, NULL, name);
571 CERROR("7: llog_create with name %s failed: %d\n", name, rc);
572 GOTO(ctxt_release, rc);
574 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
576 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
577 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
578 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
580 CERROR("7: write one log record failed: %d\n", rc);
581 GOTO(ctxt_release, rc);
584 rc = llog_destroy(llh);
586 CERROR("7: llog_destroy failed: %d\n", rc);
588 llog_free_handle(llh);
594 /* -------------------------------------------------------------------------
595 * Tests above, boring obd functions below
596 * ------------------------------------------------------------------------- */
597 static int llog_run_tests(struct obd_device *obd)
599 struct llog_handle *llh;
600 struct lvfs_run_ctxt saved;
601 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
602 int rc, err, cleanup_phase = 0;
606 sprintf(name, "%x", llog_test_rand);
607 push_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_lvfs_ctxt, NULL);
609 rc = llog_test_1(obd, name);
613 rc = llog_test_2(obd, name, &llh);
616 cleanup_phase = 1; /* close llh */
618 rc = llog_test_3(obd, llh);
622 rc = llog_test_4(obd);
626 rc = llog_test_5(obd);
630 rc = llog_test_6(obd, name);
634 rc = llog_test_7(obd);
639 switch (cleanup_phase) {
641 err = llog_close(llh);
643 CERROR("cleanup: llog_close failed: %d\n", err);
647 pop_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_lvfs_ctxt, NULL);
654 static int llog_test_llog_init(struct obd_device *obd,
655 struct obd_llog_group *olg,
656 struct obd_device *tgt, int *index)
661 rc = llog_setup(obd, &obd->obd_olg, LLOG_TEST_ORIG_CTXT, tgt, 0, NULL,
666 static int llog_test_llog_finish(struct obd_device *obd, int count)
671 rc = llog_cleanup(llog_get_context(obd, LLOG_TEST_ORIG_CTXT));
675 static struct lprocfs_vars lprocfs_llog_test_obd_vars[] = { {0} };
676 static struct lprocfs_vars lprocfs_llog_test_module_vars[] = { {0} };
677 static void lprocfs_llog_test_init_vars(struct lprocfs_static_vars *lvars)
679 lvars->module_vars = lprocfs_llog_test_module_vars;
680 lvars->obd_vars = lprocfs_llog_test_obd_vars;
684 static int llog_test_cleanup(struct obd_device *obd)
686 int rc = obd_llog_finish(obd, 0);
688 CERROR("failed to llog_test_llog_finish: %d\n", rc);
690 lprocfs_obd_cleanup(obd);
695 static int llog_test_setup(struct obd_device *obd, struct lustre_cfg *lcfg)
697 struct lprocfs_static_vars lvars;
698 struct obd_device *tgt;
702 if (lcfg->lcfg_bufcount < 2) {
703 CERROR("requires a TARGET OBD name\n");
707 if (lcfg->lcfg_buflens[1] < 1) {
708 CERROR("requires a TARGET OBD name\n");
713 tgt = class_name2obd(lustre_cfg_string(lcfg, 1));
714 if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
715 CERROR("target device not attached or not set up (%s)\n",
716 lustre_cfg_string(lcfg, 1));
720 rc = obd_llog_init(obd, NULL, tgt, NULL);
724 llog_test_rand = cfs_rand();
726 rc = llog_run_tests(obd);
728 llog_test_cleanup(obd);
730 lprocfs_llog_test_init_vars(&lvars);
731 lprocfs_obd_setup(obd, lvars.obd_vars);
736 static struct obd_ops llog_obd_ops = {
737 .o_owner = THIS_MODULE,
738 .o_setup = llog_test_setup,
739 .o_cleanup = llog_test_cleanup,
740 .o_llog_init = llog_test_llog_init,
741 .o_llog_finish = llog_test_llog_finish,
744 static int __init llog_test_init(void)
746 struct lprocfs_static_vars lvars;
748 lprocfs_llog_test_init_vars(&lvars);
749 return class_register_type(&llog_obd_ops, NULL,
750 lvars.module_vars,"llog_test", NULL);
753 static void __exit llog_test_exit(void)
755 class_unregister_type("llog_test");
758 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
759 MODULE_DESCRIPTION("llog test module");
760 MODULE_LICENSE("GPL");
762 module_init(llog_test_init);
763 module_exit(llog_test_exit);