1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2003 Cluster File Systems, Inc.
5 * Author: Phil Schwan <phil@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 * A kernel module which tests the llog API from the OBD setup function.
29 # define EXPORT_SYMTAB
31 #define DEBUG_SUBSYSTEM S_CLASS
33 #include <linux/module.h>
34 #include <linux/init.h>
36 #include <obd_class.h>
37 #include <lustre_log.h>
39 static int llog_test_rand;
40 static struct obd_uuid uuid = { .uuid = "test_uuid" };
41 static struct llog_logid cat_logid;
43 struct llog_mini_rec {
44 struct llog_rec_hdr lmr_hdr;
45 struct llog_rec_tail lmr_tail;
46 } __attribute__((packed));
48 static int verify_handle(char *test, struct llog_handle *llh, int num_recs)
54 for (i = 0; i < LLOG_BITMAP_BYTES * 8; i++) {
55 if (ext2_test_bit(i, llh->lgh_hdr->llh_bitmap)) {
61 if (active_recs != num_recs) {
62 CERROR("%s: expected %d active recs after write, found %d\n",
63 test, num_recs, active_recs);
67 if (llh->lgh_hdr->llh_count != num_recs) {
68 CERROR("%s: handle->count is %d, expected %d after write\n",
69 test, llh->lgh_hdr->llh_count, num_recs);
73 if (llh->lgh_last_idx < last_idx) {
74 CERROR("%s: handle->last_idx is %d, expected %d after write\n",
75 test, llh->lgh_last_idx, last_idx);
82 /* Test named-log create/open, close */
83 static int llog_test_1(struct obd_device *obd, char *name)
85 struct llog_handle *llh;
86 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
91 CWARN("1a: create a log with name: %s\n", name);
94 rc = llog_create(ctxt, &llh, NULL, name);
96 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
99 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
101 if ((rc = verify_handle("1", llh, 1)))
105 CWARN("1b: close newly-created log\n");
106 rc2 = llog_close(llh);
108 CERROR("1b: close log %s failed: %d\n", name, rc2);
115 /* Test named-log reopen; returns opened log on success */
116 static int llog_test_2(struct obd_device *obd, char *name,
117 struct llog_handle **llh)
119 struct llog_handle *loghandle;
120 struct llog_logid logid;
122 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
125 CWARN("2a: re-open a log with name: %s\n", name);
126 rc = llog_create(ctxt, llh, NULL, name);
128 CERROR("2a: re-open log with name %s failed: %d\n", name, rc);
131 llog_init_handle(*llh, LLOG_F_IS_PLAIN, &uuid);
133 if ((rc = verify_handle("2", *llh, 1)))
136 CWARN("2b: create a log without specified NAME & LOGID\n");
137 rc = llog_create(ctxt, &loghandle, NULL, NULL);
139 CERROR("2b: create log failed\n");
142 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
143 logid = loghandle->lgh_id;
144 llog_close(loghandle);
146 CWARN("2b: re-open the log by LOGID\n");
147 rc = llog_create(ctxt, &loghandle, &logid, NULL);
149 CERROR("2b: re-open log by LOGID failed\n");
152 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
154 CWARN("2b: destroy this log\n");
155 rc = llog_destroy(loghandle);
157 CERROR("2b: destroy log failed\n");
160 llog_free_handle(loghandle);
165 /* Test record writing, single and in bulk */
166 static int llog_test_3(struct obd_device *obd, struct llog_handle *llh)
168 struct llog_create_rec lcr;
170 int num_recs = 1; /* 1 for the header */
173 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
174 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
176 CWARN("3a: write one create_rec\n");
177 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
180 CERROR("3a: write one log record failed: %d\n", rc);
184 if ((rc = verify_handle("3a", llh, num_recs)))
187 CWARN("3b: write 10 cfg log records with 8 bytes bufs\n");
188 for (i = 0; i < 10; i++) {
189 struct llog_rec_hdr hdr;
192 hdr.lrh_type = OBD_CFG_REC;
193 memset(buf, 0, sizeof buf);
194 rc = llog_write_rec(llh, &hdr, NULL, 0, buf, -1);
196 CERROR("3b: write 10 records failed at #%d: %d\n",
201 if ((rc = verify_handle("3c", llh, num_recs)))
205 if ((rc = verify_handle("3b", llh, num_recs)))
208 CWARN("3c: write 1000 more log records\n");
209 for (i = 0; i < 1000; i++) {
210 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
212 CERROR("3c: write 1000 records failed at #%d: %d\n",
217 if ((rc = verify_handle("3b", llh, num_recs)))
221 if ((rc = verify_handle("3c", llh, num_recs)))
227 /* Test catalogue additions */
228 static int llog_test_4(struct obd_device *obd)
230 struct llog_handle *cath;
233 struct llog_mini_rec lmr;
234 struct llog_cookie cookie;
235 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
238 struct llog_rec_hdr rec;
242 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
243 lmr.lmr_hdr.lrh_type = 0xf00f00;
245 sprintf(name, "%x", llog_test_rand+1);
246 CWARN("4a: create a catalog log with name: %s\n", name);
247 rc = llog_create(ctxt, &cath, NULL, name);
249 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
252 llog_init_handle(cath, LLOG_F_IS_CAT, &uuid);
254 cat_logid = cath->lgh_id;
256 CWARN("4b: write 1 record into the catalog\n");
257 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, &cookie, NULL);
259 CERROR("4b: write 1 catalog record failed at: %d\n", rc);
263 if ((rc = verify_handle("4b", cath, 2)))
266 if ((rc = verify_handle("4b", cath->u.chd.chd_current_log, num_recs)))
269 CWARN("4c: cancel 1 log record\n");
270 rc = llog_cat_cancel_records(cath, 1, &cookie);
272 CERROR("4c: cancel 1 catalog based record failed: %d\n", rc);
277 if ((rc = verify_handle("4c", cath->u.chd.chd_current_log, num_recs)))
280 CWARN("4d: write 40,000 more log records\n");
281 for (i = 0; i < 40000; i++) {
282 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, NULL, NULL);
284 CERROR("4d: write 40000 records failed at #%d: %d\n",
291 CWARN("4e: add 5 large records, one record per block\n");
292 buflen = LLOG_CHUNK_SIZE - sizeof(struct llog_rec_hdr)
293 - sizeof(struct llog_rec_tail);
294 OBD_ALLOC(buf, buflen);
296 GOTO(out, rc = -ENOMEM);
297 for (i = 0; i < 5; i++) {
298 rec.lrh_len = buflen;
299 rec.lrh_type = OBD_CFG_REC;
300 rc = llog_cat_add_rec(cath, &rec, NULL, buf);
302 CERROR("4e: write 5 records failed at #%d: %d\n",
304 OBD_FREE(buf, buflen);
309 OBD_FREE(buf, buflen);
312 CWARN("4f: put newly-created catalog\n");
313 rc = llog_cat_put(cath);
315 CERROR("1b: close log %s failed: %d\n", name, rc);
319 static int cat_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
322 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
324 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
325 CERROR("invalid record in catalog\n");
329 CWARN("seeing record at index %d - "LPX64":%x in log "LPX64"\n",
330 rec->lrh_index, lir->lid_id.lgl_oid,
331 lir->lid_id.lgl_ogen, llh->lgh_id.lgl_oid);
335 static int plain_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
338 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
339 CERROR("log is not plain\n");
343 CWARN("seeing record at index %d in log "LPX64"\n",
344 rec->lrh_index, llh->lgh_id.lgl_oid);
348 static int llog_cancel_rec_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
351 struct llog_cookie cookie;
354 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
355 CERROR("log is not plain\n");
359 cookie.lgc_lgl = llh->lgh_id;
360 cookie.lgc_index = rec->lrh_index;
362 llog_cat_cancel_records(llh->u.phd.phd_cat_handle, 1, &cookie);
369 /* Test log and catalogue processing */
370 static int llog_test_5(struct obd_device *obd)
372 struct llog_handle *llh = NULL;
375 struct llog_mini_rec lmr;
376 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
380 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
381 lmr.lmr_hdr.lrh_type = 0xf00f00;
383 CWARN("5a: re-open catalog by id\n");
384 rc = llog_create(ctxt, &llh, &cat_logid, NULL);
386 CERROR("5a: llog_create with logid failed: %d\n", rc);
389 llog_init_handle(llh, LLOG_F_IS_CAT, &uuid);
391 CWARN("5b: print the catalog entries.. we expect 2\n");
392 rc = llog_process(llh, cat_print_cb, "test 5", NULL);
394 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
398 CWARN("5c: Cancel 40000 records, see one log zapped\n");
399 rc = llog_cat_process(llh, llog_cancel_rec_cb, "foobar");
401 CERROR("5c: process with cat_cancel_cb failed: %d\n", rc);
405 CWARN("5d: add 1 record to the log with many canceled empty pages\n");
406 rc = llog_cat_add_rec(llh, &lmr.lmr_hdr, NULL, NULL);
408 CERROR("5d: add record to the log with many canceled empty\
413 CWARN("5b: print the catalog entries.. we expect 1\n");
414 rc = llog_process(llh, cat_print_cb, "test 5", NULL);
416 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
420 CWARN("5e: print plain log entries.. expect 6\n");
421 rc = llog_cat_process(llh, plain_print_cb, "foobar");
423 CERROR("5e: process with plain_print_cb failed: %d\n", rc);
427 CWARN("5f: print plain log entries reversely.. expect 6\n");
428 rc = llog_cat_reverse_process(llh, plain_print_cb, "foobar");
430 CERROR("5f: reversely process with plain_print_cb failed: %d\n", rc);
435 CWARN("5: close re-opened catalog\n");
437 rc = llog_cat_put(llh);
439 CERROR("1b: close log %s failed: %d\n", name, rc);
443 /* Test client api; open log by name and process */
444 static int llog_test_6(struct obd_device *obd, char *name)
446 struct obd_device *mdc_obd;
447 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
448 struct obd_uuid *mds_uuid = &ctxt->loc_exp->exp_obd->obd_uuid;
449 struct lustre_handle exph = {0, };
450 struct obd_export *exp;
451 struct obd_uuid uuid = {"LLOG_TEST6_UUID"};
452 struct llog_handle *llh = NULL;
453 struct llog_ctxt *nctxt;
456 CWARN("6a: re-open log %s using client API\n", name);
457 mdc_obd = class_find_client_obd(mds_uuid, LUSTRE_MDC_NAME, NULL);
458 if (mdc_obd == NULL) {
459 CERROR("6: no MDC devices connected to %s found.\n",
464 rc = obd_connect(NULL,
465 &exph, mdc_obd, &uuid, NULL /* obd_connect_data */);
467 CERROR("6: failed to connect to MDC: %s\n", mdc_obd->obd_name);
470 exp = class_conn2export(&exph);
472 nctxt = llog_get_context(mdc_obd, LLOG_CONFIG_REPL_CTXT);
473 rc = llog_create(nctxt, &llh, NULL, name);
475 CERROR("6: llog_create failed %d\n", rc);
479 rc = llog_init_handle(llh, LLOG_F_IS_PLAIN, NULL);
481 CERROR("6: llog_init_handle failed %d\n", rc);
485 rc = llog_process(llh, plain_print_cb, NULL, NULL);
487 CERROR("6: llog_process failed %d\n", rc);
489 rc = llog_reverse_process(llh, plain_print_cb, NULL, NULL);
491 CERROR("6: llog_reverse_process failed %d\n", rc);
494 rc = llog_close(llh);
496 CERROR("6: llog_close failed: rc = %d\n", rc);
499 rc = obd_disconnect(exp);
504 static int llog_test_7(struct obd_device *obd)
506 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
507 struct llog_handle *llh;
508 struct llog_create_rec lcr;
513 sprintf(name, "%x", llog_test_rand+2);
514 CWARN("7: create a log with name: %s\n", name);
517 rc = llog_create(ctxt, &llh, NULL, name);
519 CERROR("7: llog_create with name %s failed: %d\n", name, rc);
522 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
524 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
525 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
526 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
528 CERROR("7: write one log record failed: %d\n", rc);
532 rc = llog_destroy(llh);
534 CERROR("7: llog_destroy failed: %d\n", rc);
536 llog_free_handle(llh);
540 /* -------------------------------------------------------------------------
541 * Tests above, boring obd functions below
542 * ------------------------------------------------------------------------- */
543 static int llog_run_tests(struct obd_device *obd)
545 struct llog_handle *llh;
546 struct lvfs_run_ctxt saved;
547 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
548 int rc, err, cleanup_phase = 0;
552 sprintf(name, "%x", llog_test_rand);
553 push_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_lvfs_ctxt, NULL);
555 rc = llog_test_1(obd, name);
559 rc = llog_test_2(obd, name, &llh);
562 cleanup_phase = 1; /* close llh */
564 rc = llog_test_3(obd, llh);
568 rc = llog_test_4(obd);
572 rc = llog_test_5(obd);
576 rc = llog_test_6(obd, name);
580 rc = llog_test_7(obd);
585 switch (cleanup_phase) {
587 err = llog_close(llh);
589 CERROR("cleanup: llog_close failed: %d\n", err);
593 pop_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_lvfs_ctxt, NULL);
600 static int llog_test_llog_init(struct obd_device *obd, struct obd_llogs *llogs,
601 struct obd_device *tgt, int count,
602 struct llog_catid *logid, struct obd_uuid *uuid)
607 rc = llog_setup(obd, llogs, LLOG_TEST_ORIG_CTXT, tgt, 0, NULL,
612 static int llog_test_llog_finish(struct obd_device *obd, int count)
617 rc = llog_cleanup(llog_get_context(obd, LLOG_TEST_ORIG_CTXT));
621 static int llog_test_cleanup(struct obd_device *obd)
623 int rc = obd_llog_finish(obd, 0);
625 CERROR("failed to llog_test_llog_finish: %d\n", rc);
627 lprocfs_obd_cleanup(obd);
632 static int llog_test_setup(struct obd_device *obd, struct lustre_cfg *lcfg)
634 struct lprocfs_static_vars lvars;
635 struct obd_device *tgt;
639 if (lcfg->lcfg_bufcount < 2) {
640 CERROR("requires a TARGET OBD name\n");
644 if (lcfg->lcfg_buflens[1] < 1) {
645 CERROR("requires a TARGET OBD name\n");
649 tgt = class_name2obd(lustre_cfg_string(lcfg, 1));
650 if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
651 CERROR("target device not attached or not set up (%s)\n",
652 lustre_cfg_string(lcfg, 1));
656 rc = obd_llog_init(obd, NULL, tgt, 0, NULL, NULL);
660 llog_test_rand = ll_rand();
662 rc = llog_run_tests(obd);
664 llog_test_cleanup(obd);
666 lprocfs_init_vars(llog_test, &lvars);
667 lprocfs_obd_setup(obd, lvars.obd_vars);
672 static struct obd_ops llog_obd_ops = {
673 .o_owner = THIS_MODULE,
674 .o_setup = llog_test_setup,
675 .o_cleanup = llog_test_cleanup,
676 .o_llog_init = llog_test_llog_init,
677 .o_llog_finish = llog_test_llog_finish,
681 static struct lprocfs_vars lprocfs_obd_vars[] = { {0} };
682 static struct lprocfs_vars lprocfs_module_vars[] = { {0} };
683 LPROCFS_INIT_VARS(llog_test, lprocfs_module_vars, lprocfs_obd_vars)
686 static int __init llog_test_init(void)
688 struct lprocfs_static_vars lvars;
690 lprocfs_init_vars(llog_test, &lvars);
691 return class_register_type(&llog_obd_ops, NULL,
692 lvars.module_vars,"llog_test", NULL);
695 static void __exit llog_test_exit(void)
697 class_unregister_type("llog_test");
700 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
701 MODULE_DESCRIPTION("llog test module");
702 MODULE_LICENSE("GPL");
704 module_init(llog_test_init);
705 module_exit(llog_test_exit);