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 Lustre, http://www.lustre.org/
9 * Lustre is free software; you can redistribute it and/or
10 * modify it under the terms of version 2 of the GNU General Public
11 * License as published by the Free Software Foundation.
13 * Lustre is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with Lustre; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 * A kernel module which tests the llog API from the OBD setup function.
26 # define EXPORT_SYMTAB
28 #define DEBUG_SUBSYSTEM S_CLASS
30 #include <linux/module.h>
31 #include <linux/init.h>
33 #include <linux/obd_class.h>
34 #include <linux/lustre_log.h>
35 #include <linux/lustre_mds.h> /* for LUSTRE_MDC_NAME */
37 static int llog_test_rand;
38 static struct obd_uuid uuid = { .uuid = "test_uuid" };
39 static struct llog_logid cat_logid;
41 struct llog_mini_rec {
42 struct llog_rec_hdr lmr_hdr;
43 struct llog_rec_tail lmr_tail;
44 } __attribute__((packed));
46 static int verify_handle(char *test, struct llog_handle *llh, int num_recs)
52 for (i = 0; i < LLOG_BITMAP_BYTES * 8; i++) {
53 if (ext2_test_bit(i, llh->lgh_hdr->llh_bitmap)) {
59 if (active_recs != num_recs) {
60 CERROR("%s: expected %d active recs after write, found %d\n",
61 test, num_recs, active_recs);
65 if (llh->lgh_hdr->llh_count != num_recs) {
66 CERROR("%s: handle->count is %d, expected %d after write\n",
67 test, llh->lgh_hdr->llh_count, num_recs);
71 if (llh->lgh_last_idx < last_idx) {
72 CERROR("%s: handle->last_idx is %d, expected %d after write\n",
73 test, llh->lgh_last_idx, last_idx);
80 /* Test named-log create/open, close */
81 static int llog_test_1(struct obd_device *obd, char *name)
83 struct llog_handle *llh;
84 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
89 CWARN("1a: create a log with name: %s\n", name);
92 rc = llog_create(ctxt, &llh, NULL, name);
94 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
97 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
99 if ((rc = verify_handle("1", llh, 1)))
103 CWARN("1b: close newly-created log\n");
104 rc2 = llog_close(llh);
106 CERROR("1b: close log %s failed: %d\n", name, rc2);
113 /* Test named-log reopen; returns opened log on success */
114 static int llog_test_2(struct obd_device *obd, char *name,
115 struct llog_handle **llh)
117 struct llog_handle *loghandle;
118 struct llog_logid logid;
120 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
123 CWARN("2a: re-open a log with name: %s\n", name);
124 rc = llog_create(ctxt, llh, NULL, name);
126 CERROR("2a: re-open log with name %s failed: %d\n", name, rc);
129 llog_init_handle(*llh, LLOG_F_IS_PLAIN, &uuid);
131 if ((rc = verify_handle("2", *llh, 1)))
134 CWARN("2b: create a log without specified NAME & LOGID\n");
135 rc = llog_create(ctxt, &loghandle, NULL, NULL);
137 CERROR("2b: create log failed\n");
140 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
141 logid = loghandle->lgh_id;
142 llog_close(loghandle);
144 CWARN("2b: re-open the log by LOGID\n");
145 rc = llog_create(ctxt, &loghandle, &logid, NULL);
147 CERROR("2b: re-open log by LOGID failed\n");
150 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
152 CWARN("2b: destroy this log\n");
153 rc = llog_destroy(loghandle);
155 CERROR("2b: destroy log failed\n");
158 llog_free_handle(loghandle);
163 /* Test record writing, single and in bulk */
164 static int llog_test_3(struct obd_device *obd, struct llog_handle *llh)
166 struct llog_create_rec lcr;
168 int num_recs = 1; /* 1 for the header */
171 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
172 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
174 CWARN("3a: write one create_rec\n");
175 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
178 CERROR("3a: write one log record failed: %d\n", rc);
182 if ((rc = verify_handle("3a", llh, num_recs)))
185 CWARN("3b: write 10 cfg log records with 8 bytes bufs\n");
186 for (i = 0; i < 10; i++) {
187 struct llog_rec_hdr hdr;
190 hdr.lrh_type = OBD_CFG_REC;
191 memset(buf, 0, sizeof buf);
192 rc = llog_write_rec(llh, &hdr, NULL, 0, buf, -1);
194 CERROR("3b: write 10 records failed at #%d: %d\n",
199 if ((rc = verify_handle("3c", llh, num_recs)))
203 if ((rc = verify_handle("3b", llh, num_recs)))
206 CWARN("3c: write 1000 more log records\n");
207 for (i = 0; i < 1000; i++) {
208 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
210 CERROR("3c: write 1000 records failed at #%d: %d\n",
215 if ((rc = verify_handle("3b", llh, num_recs)))
219 if ((rc = verify_handle("3c", llh, num_recs)))
225 /* Test catalogue additions */
226 static int llog_test_4(struct obd_device *obd)
228 struct llog_handle *cath;
231 struct llog_mini_rec lmr;
232 struct llog_cookie cookie;
233 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
236 struct llog_rec_hdr rec;
240 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
241 lmr.lmr_hdr.lrh_type = 0xf00f00;
243 sprintf(name, "%x", llog_test_rand+1);
244 CWARN("4a: create a catalog log with name: %s\n", name);
245 rc = llog_create(ctxt, &cath, NULL, name);
247 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
250 llog_init_handle(cath, LLOG_F_IS_CAT, &uuid);
252 cat_logid = cath->lgh_id;
254 CWARN("4b: write 1 record into the catalog\n");
255 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, &cookie, NULL);
257 CERROR("4b: write 1 catalog record failed at: %d\n", rc);
261 if ((rc = verify_handle("4b", cath, 2)))
264 if ((rc = verify_handle("4b", cath->u.chd.chd_current_log, num_recs)))
267 CWARN("4c: cancel 1 log record\n");
268 rc = llog_cat_cancel_records(cath, 1, &cookie);
270 CERROR("4c: cancel 1 catalog based record failed: %d\n", rc);
275 if ((rc = verify_handle("4c", cath->u.chd.chd_current_log, num_recs)))
278 CWARN("4d: write 40,000 more log records\n");
279 for (i = 0; i < 40000; i++) {
280 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, NULL, NULL);
282 CERROR("4d: write 40000 records failed at #%d: %d\n",
289 CWARN("4e: add 5 large records, one record per block\n");
290 buflen = LLOG_CHUNK_SIZE - sizeof(struct llog_rec_hdr)
291 - sizeof(struct llog_rec_tail);
292 OBD_ALLOC(buf, buflen);
294 GOTO(out, rc = -ENOMEM);
295 for (i = 0; i < 5; i++) {
296 rec.lrh_len = buflen;
297 rec.lrh_type = OBD_CFG_REC;
298 rc = llog_cat_add_rec(cath, &rec, NULL, buf);
300 CERROR("4e: write 5 records failed at #%d: %d\n",
302 OBD_FREE(buf, buflen);
307 OBD_FREE(buf, buflen);
310 CWARN("4f: put newly-created catalog\n");
311 rc = llog_cat_put(cath);
313 CERROR("1b: close log %s failed: %d\n", name, rc);
317 static int cat_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
320 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
322 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
323 CERROR("invalid record in catalog\n");
327 CWARN("seeing record at index %d - "LPX64":%x in log "LPX64"\n",
328 rec->lrh_index, lir->lid_id.lgl_oid,
329 lir->lid_id.lgl_ogen, llh->lgh_id.lgl_oid);
333 static int plain_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
336 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
337 CERROR("log is not plain\n");
341 CWARN("seeing record at index %d in log "LPX64"\n",
342 rec->lrh_index, llh->lgh_id.lgl_oid);
346 static int llog_cancel_rec_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
349 struct llog_cookie cookie;
352 if (!(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)) {
353 CERROR("log is not plain\n");
357 cookie.lgc_lgl = llh->lgh_id;
358 cookie.lgc_index = rec->lrh_index;
360 llog_cat_cancel_records(llh->u.phd.phd_cat_handle, 1, &cookie);
367 /* Test log and catalogue processing */
368 static int llog_test_5(struct obd_device *obd)
370 struct llog_handle *llh = NULL;
373 struct llog_mini_rec lmr;
374 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
378 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len = LLOG_MIN_REC_SIZE;
379 lmr.lmr_hdr.lrh_type = 0xf00f00;
381 CWARN("5a: re-open catalog by id\n");
382 rc = llog_create(ctxt, &llh, &cat_logid, NULL);
384 CERROR("5a: llog_create with logid failed: %d\n", rc);
387 llog_init_handle(llh, LLOG_F_IS_CAT, &uuid);
389 CWARN("5b: print the catalog entries.. we expect 2\n");
390 rc = llog_process(llh, (llog_cb_t)cat_print_cb, "test 5", NULL);
392 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
396 CWARN("5c: Cancel 40000 records, see one log zapped\n");
397 rc = llog_cat_process(llh, llog_cancel_rec_cb, "foobar");
399 CERROR("5c: process with cat_cancel_cb failed: %d\n", rc);
403 CWARN("5d: add 1 record to the log with many canceled empty pages\n");
404 rc = llog_cat_add_rec(llh, &lmr.lmr_hdr, NULL, NULL);
406 CERROR("5d: add record to the log with many canceled empty\
411 CWARN("5b: print the catalog entries.. we expect 1\n");
412 rc = llog_process(llh, (llog_cb_t)cat_print_cb, "test 5", NULL);
414 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
418 CWARN("5e: print plain log entries.. expect 6\n");
419 rc = llog_cat_process(llh, plain_print_cb, "foobar");
421 CERROR("5e: process with plain_print_cb failed: %d\n", rc);
426 CWARN("5: close re-opened catalog\n");
428 rc = llog_cat_put(llh);
430 CERROR("1b: close log %s failed: %d\n", name, rc);
434 /* Test client api; open log by name and process */
435 static int llog_test_6(struct obd_device *obd, char *name)
437 struct obd_device *mdc_obd;
438 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
439 struct obd_uuid *mds_uuid = &ctxt->loc_exp->exp_obd->obd_uuid;
440 struct lustre_handle exph = {0, };
441 struct obd_export *exp;
442 struct obd_uuid uuid = {"LLOG_TEST6_UUID"};
443 struct llog_handle *llh = NULL;
444 struct llog_ctxt *nctxt;
447 CWARN("6a: re-open log %s using client API\n", name);
448 mdc_obd = class_find_client_obd(mds_uuid, LUSTRE_MDC_NAME, NULL);
449 if (mdc_obd == NULL) {
450 CERROR("6: no MDC devices connected to %s found.\n",
455 rc = obd_connect(&exph, mdc_obd, &uuid);
457 CERROR("6: failed to connect to MDC: %s\n", mdc_obd->obd_name);
460 exp = class_conn2export(&exph);
462 nctxt = llog_get_context(mdc_obd, LLOG_CONFIG_REPL_CTXT);
463 rc = llog_create(nctxt, &llh, NULL, name);
465 CERROR("6: llog_create failed %d\n", rc);
469 rc = llog_init_handle(llh, LLOG_F_IS_PLAIN, NULL);
471 CERROR("6: llog_init_handle failed %d\n", rc);
475 rc = llog_process(llh, (llog_cb_t)plain_print_cb, NULL, NULL);
477 CERROR("6: llog_process failed %d\n", rc);
480 rc = llog_close(llh);
482 CERROR("6: llog_close failed: rc = %d\n", rc);
485 rc = obd_disconnect(exp);
490 static int llog_test_7(struct obd_device *obd)
492 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
493 struct llog_handle *llh;
494 struct llog_create_rec lcr;
499 sprintf(name, "%x", llog_test_rand+2);
500 CWARN("7: create a log with name: %s\n", name);
503 rc = llog_create(ctxt, &llh, NULL, name);
505 CERROR("7: llog_create with name %s failed: %d\n", name, rc);
508 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
510 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = sizeof(lcr);
511 lcr.lcr_hdr.lrh_type = OST_SZ_REC;
512 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
514 CERROR("7: write one log record failed: %d\n", rc);
518 rc = llog_destroy(llh);
520 CERROR("7: llog_destroy failed: %d\n", rc);
522 llog_free_handle(llh);
526 /* -------------------------------------------------------------------------
527 * Tests above, boring obd functions below
528 * ------------------------------------------------------------------------- */
529 static int llog_run_tests(struct obd_device *obd)
531 struct llog_handle *llh;
532 struct obd_run_ctxt saved;
533 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
534 int rc, err, cleanup_phase = 0;
538 sprintf(name, "%x", llog_test_rand);
539 push_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_ctxt, NULL);
541 rc = llog_test_1(obd, name);
545 rc = llog_test_2(obd, name, &llh);
548 cleanup_phase = 1; /* close llh */
550 rc = llog_test_3(obd, llh);
554 rc = llog_test_4(obd);
558 rc = llog_test_5(obd);
562 rc = llog_test_6(obd, name);
566 rc = llog_test_7(obd);
571 switch (cleanup_phase) {
573 err = llog_close(llh);
575 CERROR("cleanup: llog_close failed: %d\n", err);
579 pop_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_ctxt, NULL);
586 static int llog_test_llog_init(struct obd_device *obd, struct obd_device *tgt,
587 int count, struct llog_catid *logid)
592 rc = llog_setup(obd, LLOG_TEST_ORIG_CTXT, tgt, 0, NULL, &llog_lvfs_ops);
596 static int llog_test_llog_finish(struct obd_device *obd, int count)
601 rc = llog_cleanup(llog_get_context(obd, LLOG_TEST_ORIG_CTXT));
605 static int llog_test_cleanup(struct obd_device *obd)
607 int rc = obd_llog_finish(obd, 0);
609 CERROR("failed to llog_test_llog_finish: %d\n", rc);
611 lprocfs_obd_cleanup(obd);
616 static int llog_test_setup(struct obd_device *obd, obd_count len, void *buf)
618 struct lprocfs_static_vars lvars;
619 struct lustre_cfg *lcfg = buf;
620 struct obd_device *tgt;
624 if (lcfg->lcfg_bufcount < 2) {
625 CERROR("requires a TARGET OBD name\n");
629 if (lcfg->lcfg_buflens[1] < 1) {
630 CERROR("requires a TARGET OBD name\n");
634 tgt = class_name2obd(lustre_cfg_string(lcfg, 1));
635 if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
636 CERROR("target device not attached or not set up (%s)\n",
637 lustre_cfg_string(lcfg, 1));
641 rc = obd_llog_init(obd, tgt, 0, NULL);
645 llog_test_rand = ll_insecure_random_int();
647 rc = llog_run_tests(obd);
649 llog_test_cleanup(obd);
651 lprocfs_init_vars(llog_test, &lvars);
652 lprocfs_obd_setup(obd, lvars.obd_vars);
657 static struct obd_ops llog_obd_ops = {
658 .o_owner = THIS_MODULE,
659 .o_setup = llog_test_setup,
660 .o_cleanup = llog_test_cleanup,
661 .o_llog_init = llog_test_llog_init,
662 .o_llog_finish = llog_test_llog_finish,
665 static struct lprocfs_vars lprocfs_obd_vars[] = { {0} };
666 static struct lprocfs_vars lprocfs_module_vars[] = { {0} };
667 LPROCFS_INIT_VARS(llog_test, lprocfs_module_vars, lprocfs_obd_vars)
669 static int __init llog_test_init(void)
671 struct lprocfs_static_vars lvars;
673 lprocfs_init_vars(llog_test, &lvars);
674 return class_register_type(&llog_obd_ops,lvars.module_vars,"llog_test");
677 static void __exit llog_test_exit(void)
679 class_unregister_type("llog_test");
682 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
683 MODULE_DESCRIPTION("llog test module");
684 MODULE_LICENSE("GPL");
686 module_init(llog_test_init);
687 module_exit(llog_test_exit);