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(NULL, ctxt, &llh, NULL, name);
104 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
108 llog_init_handle(NULL, 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(NULL, 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(NULL, ctxt, llh, NULL, name);
136 CERROR("2a: re-open log with name %s failed: %d\n", name, rc);
139 llog_init_handle(NULL, *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(NULL, 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(NULL, 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(NULL, llh, &lcr.lcr_hdr, NULL, 0, NULL,
224 CERROR("3c: write 1000 records failed at #%d: %d\n",
229 if ((rc = verify_handle("3b", llh, num_recs)))
233 if ((rc = verify_handle("3c", llh, num_recs)))
236 CWARN("3d: write log more than BITMAP_SIZE, return -ENOSPC\n");
237 for (i = 0; i < LLOG_BITMAP_SIZE(llh->lgh_hdr) + 1; i++) {
238 struct llog_rec_hdr hdr;
242 memset(buf_odd, 0, sizeof buf_odd);
243 memset(buf_even, 0, sizeof buf_even);
246 hdr.lrh_type = OBD_CFG_REC;
247 rc = llog_write_rec(NULL, llh, &hdr, NULL, 0, buf_even,
251 hdr.lrh_type = OBD_CFG_REC;
252 rc = llog_write_rec(NULL, llh, &hdr, NULL, 0, buf_odd,
259 CERROR("3c: write recs failed at #%d: %d\n",
267 CWARN("3d: write record more than BITMAP size!\n");
270 if ((rc = verify_handle("3d", llh, num_recs)))
276 /* Test catalogue additions */
277 static int llog_test_4(struct obd_device *obd)
279 struct llog_handle *cath;
282 struct llog_mini_rec lmr;
283 struct llog_cookie cookie;
284 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
287 struct llog_rec_hdr rec;
291 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
292 lmr.lmr_hdr.lrh_type = 0xf00f00;
294 sprintf(name, "%x", llog_test_rand+1);
295 CWARN("4a: create a catalog log with name: %s\n", name);
296 rc = llog_create(NULL, ctxt, &cath, NULL, name);
298 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
301 llog_init_handle(NULL, cath, LLOG_F_IS_CAT, &uuid);
303 cat_logid = cath->lgh_id;
305 CWARN("4b: write 1 record into the catalog\n");
306 rc = llog_cat_add_rec(NULL, cath, &lmr.lmr_hdr, &cookie, NULL);
308 CERROR("4b: write 1 catalog record failed at: %d\n", rc);
312 if ((rc = verify_handle("4b", cath, 2)))
313 GOTO(ctxt_release, rc);
315 if ((rc = verify_handle("4b", cath->u.chd.chd_current_log, num_recs)))
316 GOTO(ctxt_release, rc);
318 CWARN("4c: cancel 1 log record\n");
319 rc = llog_cat_cancel_records(NULL, cath, 1, &cookie);
321 CERROR("4c: cancel 1 catalog based record failed: %d\n", rc);
326 if ((rc = verify_handle("4c", cath->u.chd.chd_current_log, num_recs)))
327 GOTO(ctxt_release, rc);
329 CWARN("4d: write 40,000 more log records\n");
330 for (i = 0; i < 40000; i++) {
331 rc = llog_cat_add_rec(NULL, cath, &lmr.lmr_hdr, NULL, NULL);
333 CERROR("4d: write 40000 records failed at #%d: %d\n",
340 CWARN("4e: add 5 large records, one record per block\n");
341 buflen = LLOG_CHUNK_SIZE - sizeof(struct llog_rec_hdr)
342 - sizeof(struct llog_rec_tail);
343 OBD_ALLOC(buf, buflen);
345 GOTO(out, rc = -ENOMEM);
346 for (i = 0; i < 5; i++) {
347 rec.lrh_len = buflen;
348 rec.lrh_type = OBD_CFG_REC;
349 rc = llog_cat_add_rec(NULL, cath, &rec, NULL, buf);
351 CERROR("4e: write 5 records failed at #%d: %d\n",
353 OBD_FREE(buf, buflen);
358 OBD_FREE(buf, buflen);
361 CWARN("4f: put newly-created catalog\n");
362 rc = llog_cat_put(NULL, cath);
366 CERROR("1b: close log %s failed: %d\n", name, rc);
370 static int cat_print_cb(const struct lu_env *env, struct llog_handle *llh,
371 struct llog_rec_hdr *rec, void *data)
373 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
375 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
376 CERROR("invalid record in catalog\n");
380 CWARN("seeing record at index %d - "LPX64":%x in log "LPX64"\n",
381 rec->lrh_index, lir->lid_id.lgl_oid,
382 lir->lid_id.lgl_ogen, llh->lgh_id.lgl_oid);
386 static int plain_print_cb(const struct lu_env *env, struct llog_handle *llh,
387 struct llog_rec_hdr *rec, void *data)
389 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
390 CERROR("log is not plain\n");
394 CWARN("seeing record at index %d in log "LPX64"\n",
395 rec->lrh_index, llh->lgh_id.lgl_oid);
399 static int llog_cancel_rec_cb(const struct lu_env *env,
400 struct llog_handle *llh,
401 struct llog_rec_hdr *rec, void *data)
403 struct llog_cookie cookie;
406 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
407 CERROR("log is not plain\n");
411 cookie.lgc_lgl = llh->lgh_id;
412 cookie.lgc_index = rec->lrh_index;
414 llog_cat_cancel_records(NULL, llh->u.phd.phd_cat_handle, 1, &cookie);
421 /* Test log and catalogue processing */
422 static int llog_test_5(struct obd_device *obd)
424 struct llog_handle *llh = NULL;
427 struct llog_mini_rec lmr;
428 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
432 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
433 lmr.lmr_hdr.lrh_type = 0xf00f00;
435 CWARN("5a: re-open catalog by id\n");
436 rc = llog_create(NULL, ctxt, &llh, &cat_logid, NULL);
438 CERROR("5a: llog_create with logid failed: %d\n", rc);
441 llog_init_handle(NULL, llh, LLOG_F_IS_CAT, &uuid);
443 CWARN("5b: print the catalog entries.. we expect 2\n");
444 rc = llog_process(NULL, llh, cat_print_cb, "test 5", NULL);
446 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
450 CWARN("5c: Cancel 40000 records, see one log zapped\n");
451 rc = llog_cat_process(NULL, llh, llog_cancel_rec_cb, "foobar", 0, 0);
453 CERROR("5c: process with cat_cancel_cb failed: %d\n", rc);
457 CWARN("5d: add 1 record to the log with many canceled empty pages\n");
458 rc = llog_cat_add_rec(NULL, llh, &lmr.lmr_hdr, NULL, NULL);
460 CERROR("5d: add record to the log with many canceled empty\
465 CWARN("5b: print the catalog entries.. we expect 1\n");
466 rc = llog_process(NULL, llh, cat_print_cb, "test 5", NULL);
468 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
472 CWARN("5e: print plain log entries.. expect 6\n");
473 rc = llog_cat_process(NULL, llh, plain_print_cb, "foobar", 0, 0);
475 CERROR("5e: process with plain_print_cb failed: %d\n", rc);
479 CWARN("5f: print plain log entries reversely.. expect 6\n");
480 rc = llog_cat_reverse_process(NULL, llh, plain_print_cb, "foobar");
482 CERROR("5f: reversely process with plain_print_cb failed: %d\n", rc);
487 CWARN("5: close re-opened catalog\n");
489 rc = llog_cat_put(NULL, llh);
491 CERROR("1b: close log %s failed: %d\n", name, rc);
497 /* Test client api; open log by name and process */
498 static int llog_test_6(struct obd_device *obd, char *name)
500 struct obd_device *mgc_obd;
501 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
502 struct obd_uuid *mgs_uuid = &ctxt->loc_exp->exp_obd->obd_uuid;
503 struct obd_export *exp;
504 struct obd_uuid uuid = {"LLOG_TEST6_UUID"};
505 struct llog_handle *llh = NULL;
506 struct llog_ctxt *nctxt;
509 CWARN("6a: re-open log %s using client API\n", name);
510 mgc_obd = class_find_client_obd(mgs_uuid, LUSTRE_MGC_NAME, NULL);
511 if (mgc_obd == NULL) {
512 CERROR("6: no MGC devices connected to %s found.\n",
514 GOTO(ctxt_release, rc = -ENOENT);
517 rc = obd_connect(NULL, &exp, mgc_obd, &uuid,
518 NULL /* obd_connect_data */, NULL);
519 if (rc != -EALREADY) {
520 CERROR("6: connect on connected MDC (%s) failed to return"
521 " -EALREADY", mgc_obd->obd_name);
524 GOTO(ctxt_release, rc = -EINVAL);
527 nctxt = llog_get_context(mgc_obd, LLOG_CONFIG_REPL_CTXT);
528 rc = llog_create(NULL, nctxt, &llh, NULL, name);
530 CERROR("6: llog_create failed %d\n", rc);
531 llog_ctxt_put(nctxt);
532 GOTO(ctxt_release, rc);
535 rc = llog_init_handle(NULL, llh, LLOG_F_IS_PLAIN, NULL);
537 CERROR("6: llog_init_handle failed %d\n", rc);
541 rc = llog_process(NULL, llh, plain_print_cb, NULL, NULL);
543 CERROR("6: llog_process failed %d\n", rc);
545 rc = llog_reverse_process(NULL, llh, plain_print_cb, NULL, NULL);
547 CERROR("6: llog_reverse_process failed %d\n", rc);
550 rc = llog_close(NULL, llh);
551 llog_ctxt_put(nctxt);
553 CERROR("6: llog_close failed: rc = %d\n", rc);
560 static int llog_test_7(struct obd_device *obd)
562 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
563 struct llog_handle *llh;
564 struct llog_create_rec lcr;
569 sprintf(name, "%x", llog_test_rand+2);
570 CWARN("7: create a log with name: %s\n", name);
573 rc = llog_create(NULL, ctxt, &llh, NULL, name);
575 CERROR("7: llog_create with name %s failed: %d\n", name, rc);
576 GOTO(ctxt_release, rc);
578 llog_init_handle(NULL, llh, LLOG_F_IS_PLAIN, &uuid);
580 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
581 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
582 rc = llog_write_rec(NULL, llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
584 CERROR("7: write one log record failed: %d\n", rc);
585 GOTO(ctxt_release, rc);
588 rc = llog_destroy(NULL, llh);
590 CERROR("7: llog_destroy failed: %d\n", rc);
592 llog_free_handle(llh);
598 /* -------------------------------------------------------------------------
599 * Tests above, boring obd functions below
600 * ------------------------------------------------------------------------- */
601 static int llog_run_tests(struct obd_device *obd)
603 struct llog_handle *llh;
604 struct lvfs_run_ctxt saved;
605 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
606 int rc, err, cleanup_phase = 0;
610 sprintf(name, "%x", llog_test_rand);
611 push_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_lvfs_ctxt, NULL);
613 rc = llog_test_1(obd, name);
617 rc = llog_test_2(obd, name, &llh);
620 cleanup_phase = 1; /* close llh */
622 rc = llog_test_3(obd, llh);
626 rc = llog_test_4(obd);
630 rc = llog_test_5(obd);
634 rc = llog_test_6(obd, name);
638 rc = llog_test_7(obd);
643 switch (cleanup_phase) {
645 err = llog_close(NULL, llh);
647 CERROR("cleanup: llog_close failed: %d\n", err);
651 pop_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_lvfs_ctxt, NULL);
657 static int llog_test_llog_init(struct obd_device *obd,
658 struct obd_llog_group *olg,
659 struct obd_device *tgt, int *index)
664 rc = llog_setup(obd, &obd->obd_olg, LLOG_TEST_ORIG_CTXT, tgt, 0, NULL,
669 static int llog_test_llog_finish(struct obd_device *obd, int count)
674 rc = llog_cleanup(llog_get_context(obd, LLOG_TEST_ORIG_CTXT));
678 static struct lprocfs_vars lprocfs_llog_test_obd_vars[] = { {0} };
679 static struct lprocfs_vars lprocfs_llog_test_module_vars[] = { {0} };
680 static void lprocfs_llog_test_init_vars(struct lprocfs_static_vars *lvars)
682 lvars->module_vars = lprocfs_llog_test_module_vars;
683 lvars->obd_vars = lprocfs_llog_test_obd_vars;
687 static int llog_test_cleanup(struct obd_device *obd)
689 int rc = obd_llog_finish(obd, 0);
691 CERROR("failed to llog_test_llog_finish: %d\n", rc);
693 lprocfs_obd_cleanup(obd);
698 static int llog_test_setup(struct obd_device *obd, struct lustre_cfg *lcfg)
700 struct lprocfs_static_vars lvars;
701 struct obd_device *tgt;
705 if (lcfg->lcfg_bufcount < 2) {
706 CERROR("requires a TARGET OBD name\n");
710 if (lcfg->lcfg_buflens[1] < 1) {
711 CERROR("requires a TARGET OBD name\n");
716 tgt = class_name2obd(lustre_cfg_string(lcfg, 1));
717 if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
718 CERROR("target device not attached or not set up (%s)\n",
719 lustre_cfg_string(lcfg, 1));
723 rc = obd_llog_init(obd, NULL, tgt, NULL);
727 llog_test_rand = cfs_rand();
729 rc = llog_run_tests(obd);
731 llog_test_cleanup(obd);
733 lprocfs_llog_test_init_vars(&lvars);
734 lprocfs_obd_setup(obd, lvars.obd_vars);
739 static struct obd_ops llog_obd_ops = {
740 .o_owner = THIS_MODULE,
741 .o_setup = llog_test_setup,
742 .o_cleanup = llog_test_cleanup,
743 .o_llog_init = llog_test_llog_init,
744 .o_llog_finish = llog_test_llog_finish,
747 static int __init llog_test_init(void)
749 struct lprocfs_static_vars lvars;
751 lprocfs_llog_test_init_vars(&lvars);
752 return class_register_type(&llog_obd_ops, NULL,
753 lvars.module_vars,"llog_test", NULL);
756 static void __exit llog_test_exit(void)
758 class_unregister_type("llog_test");
761 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
762 MODULE_DESCRIPTION("llog test module");
763 MODULE_LICENSE("GPL");
765 module_init(llog_test_init);
766 module_exit(llog_test_exit);