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 (le32_to_cpu(llh->lgh_hdr->llh_count) != num_recs) {
66 CERROR("%s: handle->count is %d, expected %d after write\n",
67 test, le32_to_cpu(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 = cpu_to_le32(sizeof(lcr));
172 lcr.lcr_hdr.lrh_type = cpu_to_le32(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;
189 hdr.lrh_len = cpu_to_le32(8);
190 hdr.lrh_type = cpu_to_le32(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 =
241 cpu_to_le32(LLOG_MIN_REC_SIZE);
242 lmr.lmr_hdr.lrh_type = cpu_to_le32(0xf00f00);
244 sprintf(name, "%x", llog_test_rand+1);
245 CWARN("4a: create a catalog log with name: %s\n", name);
246 rc = llog_create(ctxt, &cath, NULL, name);
248 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
251 llog_init_handle(cath, LLOG_F_IS_CAT, &uuid);
253 cat_logid = cath->lgh_id;
255 CWARN("4b: write 1 record into the catalog\n");
256 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, &cookie, NULL);
258 CERROR("4b: write 1 catalog record failed at: %d\n", rc);
262 if ((rc = verify_handle("4b", cath, 2)))
265 if ((rc = verify_handle("4b", cath->u.chd.chd_current_log, num_recs)))
268 CWARN("4c: cancel 1 log record\n");
269 rc = llog_cat_cancel_records(cath, 1, &cookie);
271 CERROR("4c: cancel 1 catalog based record failed: %d\n", rc);
276 if ((rc = verify_handle("4c", cath->u.chd.chd_current_log, num_recs)))
279 CWARN("4d: write 40,000 more log records\n");
280 for (i = 0; i < 40000; i++) {
281 rc = llog_cat_add_rec(cath, &lmr.lmr_hdr, NULL, NULL);
283 CERROR("4d: write 40000 records failed at #%d: %d\n",
290 CWARN("4e: add 5 large records, one record per block\n");
291 buflen = LLOG_CHUNK_SIZE - sizeof(struct llog_rec_hdr)
292 - sizeof(struct llog_rec_tail);
293 OBD_ALLOC(buf, buflen);
295 GOTO(out, rc = -ENOMEM);
296 for (i = 0; i < 5; i++) {
297 rec.lrh_len = cpu_to_le32(buflen);
298 rec.lrh_type = cpu_to_le32(OBD_CFG_REC);
299 rc = llog_cat_add_rec(cath, &rec, NULL, buf);
301 CERROR("4e: write 5 records failed at #%d: %d\n",
303 OBD_FREE(buf, buflen);
308 OBD_FREE(buf, buflen);
311 CWARN("4f: put newly-created catalog\n");
312 rc = llog_cat_put(cath);
314 CERROR("1b: close log %s failed: %d\n", name, rc);
318 static int cat_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
321 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
323 if (le32_to_cpu(rec->lrh_type) != LLOG_LOGID_MAGIC) {
324 CERROR("invalid record in catalog\n");
328 CWARN("seeing record at index %d - "LPX64":%x in log "LPX64"\n",
329 le32_to_cpu(rec->lrh_index), lir->lid_id.lgl_oid,
330 lir->lid_id.lgl_ogen, llh->lgh_id.lgl_oid);
334 static int plain_print_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
337 if (!(le32_to_cpu(llh->lgh_hdr->llh_flags) & LLOG_F_IS_PLAIN)) {
338 CERROR("log is not plain\n");
342 CWARN("seeing record at index %d in log "LPX64"\n",
343 le32_to_cpu(rec->lrh_index), llh->lgh_id.lgl_oid);
347 static int llog_cancel_rec_cb(struct llog_handle *llh, struct llog_rec_hdr *rec,
350 struct llog_cookie cookie;
353 if (!(le32_to_cpu(llh->lgh_hdr->llh_flags) & LLOG_F_IS_PLAIN)) {
354 CERROR("log is not plain\n");
358 cookie.lgc_lgl = llh->lgh_id;
359 cookie.lgc_index = le32_to_cpu(rec->lrh_index);
361 llog_cat_cancel_records(llh->u.phd.phd_cat_handle, 1, &cookie);
370 /* Test log and catalogue processing */
371 static int llog_test_5(struct obd_device *obd)
373 struct llog_handle *llh = NULL;
376 struct llog_mini_rec lmr;
377 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
381 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len =
382 cpu_to_le32(LLOG_MIN_REC_SIZE);
383 lmr.lmr_hdr.lrh_type = cpu_to_le32(0xf00f00);
385 CWARN("5a: re-open catalog by id\n");
386 rc = llog_create(ctxt, &llh, &cat_logid, NULL);
388 CERROR("5a: llog_create with logid failed: %d\n", rc);
391 llog_init_handle(llh, LLOG_F_IS_CAT, &uuid);
393 CWARN("5b: print the catalog entries.. we expect 2\n");
394 rc = llog_process(llh, (llog_cb_t)cat_print_cb, "test 5", NULL);
396 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
400 CWARN("5c: Cancel 40000 records, see one log zapped\n");
401 rc = llog_cat_process(llh, llog_cancel_rec_cb, "foobar");
403 CERROR("5c: process with cat_cancel_cb failed: %d\n", rc);
407 CWARN("5d: add 1 record to the log with many canceled empty pages\n");
408 rc = llog_cat_add_rec(llh, &lmr.lmr_hdr, NULL, NULL);
410 CERROR("5d: add record to the log with many canceled empty\
415 CWARN("5b: print the catalog entries.. we expect 1\n");
416 rc = llog_process(llh, (llog_cb_t)cat_print_cb, "test 5", NULL);
418 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
422 CWARN("5e: print plain log entries.. expect 6\n");
423 rc = llog_cat_process(llh, plain_print_cb, "foobar");
425 CERROR("5e: process with plain_print_cb failed: %d\n", rc);
430 CWARN("5: close re-opened catalog\n");
432 rc = llog_cat_put(llh);
434 CERROR("1b: close log %s failed: %d\n", name, rc);
438 /* Test client api; open log by name and process */
439 static int llog_test_6(struct obd_device *obd, char *name)
441 struct obd_device *mdc_obd;
442 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
443 struct obd_uuid *mds_uuid = &ctxt->loc_exp->exp_obd->obd_uuid;
444 struct lustre_handle exph = {0, };
445 struct obd_export *exp;
446 struct obd_uuid uuid = {"LLOG_TEST6_UUID"};
447 struct llog_handle *llh = NULL;
448 struct llog_ctxt *nctxt;
451 CWARN("6a: re-open log %s using client API\n", name);
452 mdc_obd = class_find_client_obd(mds_uuid, LUSTRE_MDC_NAME, NULL);
453 if (mdc_obd == NULL) {
454 CERROR("6: no MDC devices connected to %s found.\n",
459 rc = obd_connect(&exph, mdc_obd, &uuid);
461 CERROR("6: failed to connect to MDC: %s\n", mdc_obd->obd_name);
464 exp = class_conn2export(&exph);
466 nctxt = llog_get_context(mdc_obd, LLOG_CONFIG_REPL_CTXT);
467 rc = llog_create(nctxt, &llh, NULL, name);
469 CERROR("6: llog_create failed %d\n", rc);
473 rc = llog_init_handle(llh, LLOG_F_IS_PLAIN, NULL);
475 CERROR("6: llog_init_handle failed %d\n", rc);
479 rc = llog_process(llh, (llog_cb_t)plain_print_cb, NULL, NULL);
481 CERROR("6: llog_process failed %d\n", rc);
484 rc = llog_close(llh);
486 CERROR("6: llog_close failed: rc = %d\n", rc);
489 rc = obd_disconnect(exp, 0);
494 /* -------------------------------------------------------------------------
495 * Tests above, boring obd functions below
496 * ------------------------------------------------------------------------- */
497 static int llog_run_tests(struct obd_device *obd)
499 struct llog_handle *llh;
500 struct obd_run_ctxt saved;
501 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
502 int rc, err, cleanup_phase = 0;
506 sprintf(name, "%x", llog_test_rand);
507 push_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_ctxt, NULL);
509 rc = llog_test_1(obd, name);
513 rc = llog_test_2(obd, name, &llh);
516 cleanup_phase = 1; /* close llh */
518 rc = llog_test_3(obd, llh);
522 rc = llog_test_4(obd);
526 rc = llog_test_5(obd);
530 rc = llog_test_6(obd, name);
535 switch (cleanup_phase) {
537 err = llog_close(llh);
539 CERROR("cleanup: llog_close failed: %d\n", err);
543 pop_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_ctxt, NULL);
550 static int llog_test_llog_init(struct obd_device *obd, struct obd_device *tgt,
551 int count, struct llog_logid *logid)
556 rc = llog_setup(obd, LLOG_TEST_ORIG_CTXT, tgt, 0, NULL, &llog_lvfs_ops);
560 static int llog_test_llog_finish(struct obd_device *obd, int count)
565 rc = llog_cleanup(llog_get_context(obd, LLOG_TEST_ORIG_CTXT));
569 static int llog_test_cleanup(struct obd_device *obd, int flags)
571 int rc = obd_llog_finish(obd, 0);
573 CERROR("failed to llog_test_llog_finish: %d\n", rc);
578 static int llog_test_setup(struct obd_device *obd, obd_count len, void *buf)
580 struct lustre_cfg *lcfg = buf;
581 struct obd_device *tgt;
585 if (lcfg->lcfg_inllen1 < 1) {
586 CERROR("requires a TARGET OBD name\n");
590 tgt = class_name2obd(lcfg->lcfg_inlbuf1);
591 if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
592 CERROR("target device not attached or not set up (%s)\n",
597 rc = obd_llog_init(obd, tgt, 0, NULL);
601 llog_test_rand = ll_insecure_random_int();
603 rc = llog_run_tests(obd);
605 llog_test_cleanup(obd, 0);
609 static struct lprocfs_vars lprocfs_ost_obd_vars[] = { {0} };
610 static struct lprocfs_vars lprocfs_ost_module_vars[] = { {0} };
611 LPROCFS_INIT_VARS(ost, lprocfs_ost_module_vars, lprocfs_ost_obd_vars)
613 static int llog_test_attach(struct obd_device *dev, obd_count len, void *data)
615 struct lprocfs_static_vars lvars;
617 lprocfs_init_vars(ost, &lvars);
618 return lprocfs_obd_attach(dev, lvars.obd_vars);
621 static int llog_test_detach(struct obd_device *dev)
623 return lprocfs_obd_detach(dev);
626 static struct obd_ops llog_obd_ops = {
627 o_owner: THIS_MODULE,
628 o_attach: llog_test_attach,
629 o_detach: llog_test_detach,
630 o_setup: llog_test_setup,
631 o_cleanup: llog_test_cleanup,
632 o_llog_init: llog_test_llog_init,
633 o_llog_finish: llog_test_llog_finish,
637 static struct lprocfs_vars lprocfs_obd_vars[] = { {0} };
638 static struct lprocfs_vars lprocfs_module_vars[] = { {0} };
639 LPROCFS_INIT_VARS(llog_test, lprocfs_module_vars, lprocfs_obd_vars)
641 static int __init llog_test_init(void)
643 struct lprocfs_static_vars lvars;
645 lprocfs_init_vars(llog_test, &lvars);
646 return class_register_type(&llog_obd_ops,lvars.module_vars,"llog_test");
649 static void __exit llog_test_exit(void)
651 class_unregister_type("llog_test");
654 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
655 MODULE_DESCRIPTION("llog test module");
656 MODULE_LICENSE("GPL");
658 module_init(llog_test_init);
659 module_exit(llog_test_exit);