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;
44 struct llog_rec_tail lmr_tail;
45 } __attribute__((packed));
47 static int verify_handle(char *test, struct llog_handle *llh, int num_recs)
53 for (i = 0; i < LLOG_BITMAP_BYTES * 8; i++) {
54 if (ext2_test_bit(i, llh->lgh_hdr->llh_bitmap)) {
60 if (active_recs != num_recs) {
61 CERROR("%s: expected %d active recs after write, found %d\n",
62 test, num_recs, active_recs);
66 if (le32_to_cpu(llh->lgh_hdr->llh_count) != num_recs) {
67 CERROR("%s: handle->count is %d, expected %d after write\n",
68 test, le32_to_cpu(llh->lgh_hdr->llh_count), num_recs);
72 if (llh->lgh_last_idx < last_idx) {
73 CERROR("%s: handle->last_idx is %d, expected %d after write\n",
74 test, llh->lgh_last_idx, last_idx);
81 /* Test named-log create/open, close */
82 static int llog_test_1(struct obd_device *obd, char *name)
84 struct llog_handle *llh;
85 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
90 CERROR("1a: create a log with name: %s\n", name);
93 rc = llog_create(ctxt, &llh, NULL, name);
95 CERROR("1a: llog_create with name %s failed: %d\n", name, rc);
98 llog_init_handle(llh, LLOG_F_IS_PLAIN, &uuid);
100 if ((rc = verify_handle("1", llh, 1)))
104 CERROR("1b: close newly-created log\n");
105 rc2 = llog_close(llh);
107 CERROR("1b: close log %s failed: %d\n", name, rc2);
114 /* Test named-log reopen; returns opened log on success */
115 static int llog_test_2(struct obd_device *obd, char *name,
116 struct llog_handle **llh)
118 struct llog_handle *loghandle;
119 struct llog_logid logid;
121 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
124 CERROR("2a: re-open a log with name: %s\n", name);
125 rc = llog_create(ctxt, llh, NULL, name);
127 CERROR("2a: re-open log with name %s failed: %d\n", name, rc);
130 llog_init_handle(*llh, LLOG_F_IS_PLAIN, &uuid);
132 if ((rc = verify_handle("2", *llh, 1)))
135 CERROR("2b: create a log without specified NAME & LOGID\n");
136 rc = llog_create(ctxt, &loghandle, NULL, NULL);
138 CERROR("2b: create log failed\n");
141 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
142 logid = loghandle->lgh_id;
143 llog_close(loghandle);
145 CERROR("2b: re-open the log by LOGID\n");
146 rc = llog_create(ctxt, &loghandle, &logid, NULL);
148 CERROR("2b: re-open log by LOGID failed\n");
151 llog_init_handle(loghandle, LLOG_F_IS_PLAIN, &uuid);
153 CERROR("2b: destroy this log\n");
154 rc = llog_destroy(loghandle);
156 CERROR("2b: destroy log failed\n");
159 llog_free_handle(loghandle);
164 /* Test record writing, single and in bulk */
165 static int llog_test_3(struct obd_device *obd, struct llog_handle *llh)
167 struct llog_create_rec lcr;
169 int num_recs = 1; /* 1 for the header */
172 lcr.lcr_hdr.lrh_len = lcr.lcr_tail.lrt_len = cpu_to_le32(sizeof(lcr));
173 lcr.lcr_hdr.lrh_type = cpu_to_le32(OST_SZ_REC);
175 CERROR("3a: write one create_rec\n");
176 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
179 CERROR("3a: write one log record failed: %d\n", rc);
183 if ((rc = verify_handle("3a", llh, num_recs)))
186 CERROR("3b: write 10 cfg log records with 8 bytes bufs\n");
187 for (i = 0; i < 10; i++) {
188 struct llog_rec_hdr hdr;
190 hdr.lrh_len = cpu_to_le32(8);
191 hdr.lrh_type = cpu_to_le32(OBD_CFG_REC);
192 memset(buf, 0, sizeof buf);
193 rc = llog_write_rec(llh, &hdr, NULL, 0, buf, -1);
195 CERROR("3b: write 10 records failed at #%d: %d\n",
200 if ((rc = verify_handle("3c", llh, num_recs)))
204 if ((rc = verify_handle("3b", llh, num_recs)))
207 CERROR("3c: write 1000 more log records\n");
208 for (i = 0; i < 1000; i++) {
209 rc = llog_write_rec(llh, &lcr.lcr_hdr, NULL, 0, NULL, -1);
211 CERROR("3c: write 1000 records failed at #%d: %d\n",
216 if ((rc = verify_handle("3b", llh, num_recs)))
220 if ((rc = verify_handle("3c", llh, num_recs)))
226 /* Test catalogue additions */
227 static int llog_test_4(struct obd_device *obd)
229 struct llog_handle *cath;
232 struct llog_mini_rec lmr;
233 struct llog_cookie cookie;
234 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
237 struct llog_rec_hdr rec;
241 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len =
242 cpu_to_le32(LLOG_MIN_REC_SIZE);
243 lmr.lmr_hdr.lrh_type = cpu_to_le32(0xf00f00);
245 sprintf(name, "%x", llog_test_rand+1);
246 CERROR("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 CERROR("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 CERROR("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 CERROR("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 CERROR("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 = cpu_to_le32(buflen);
299 rec.lrh_type = cpu_to_le32(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 CERROR("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 (le32_to_cpu(rec->lrh_type) != LLOG_LOGID_MAGIC) {
325 CERROR("invalid record in catalog\n");
329 CERROR("seeing record at index %d - "LPX64":%x in log "LPX64"\n",
330 le32_to_cpu(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 (!le32_to_cpu(llh->lgh_hdr->llh_flags) & LLOG_F_IS_PLAIN) {
339 CERROR("log is not plain\n");
343 CERROR("seeing record at index %d in log "LPX64"\n",
344 le32_to_cpu(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 (!le32_to_cpu(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 = le32_to_cpu(rec->lrh_index);
362 llog_cat_cancel_records(llh->u.phd.phd_cat_handle, 1, &cookie);
371 /* Test log and catalogue processing */
372 static int llog_test_5(struct obd_device *obd)
374 struct llog_handle *llh = NULL;
377 struct llog_mini_rec lmr;
378 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
382 lmr.lmr_hdr.lrh_len = lmr.lmr_tail.lrt_len =
383 cpu_to_le32(LLOG_MIN_REC_SIZE);
384 lmr.lmr_hdr.lrh_type = cpu_to_le32(0xf00f00);
386 CERROR("5a: re-open catalog by id\n");
387 rc = llog_create(ctxt, &llh, &cat_logid, NULL);
389 CERROR("5a: llog_create with logid failed: %d\n", rc);
392 llog_init_handle(llh, LLOG_F_IS_CAT, &uuid);
394 CERROR("5b: print the catalog entries.. we expect 2\n");
395 rc = llog_process(llh, (llog_cb_t)cat_print_cb, "test 5");
397 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
401 CERROR("5c: Cancel 40000 records, see one log zapped\n");
402 rc = llog_cat_process(llh, llog_cancel_rec_cb, "foobar");
404 CERROR("5c: process with cat_cancel_cb failed: %d\n", rc);
408 CERROR("5d: add 1 record to the log with many canceled empty pages\n");
409 rc = llog_cat_add_rec(llh, &lmr.lmr_hdr, NULL, NULL);
411 CERROR("5d: add record to the log with many canceled empty\
416 CERROR("5b: print the catalog entries.. we expect 1\n");
417 rc = llog_process(llh, (llog_cb_t)cat_print_cb, "test 5");
419 CERROR("5b: process with cat_print_cb failed: %d\n", rc);
423 CERROR("5e: print plain log entries.. expect 6\n");
424 rc = llog_cat_process(llh, plain_print_cb, "foobar");
426 CERROR("5e: process with plain_print_cb failed: %d\n", rc);
431 CERROR("5: close re-opened catalog\n");
433 rc = llog_cat_put(llh);
435 CERROR("1b: close log %s failed: %d\n", name, rc);
439 /* Test client api; open log by name and process */
440 static int llog_test_6(struct obd_device *obd, char *name)
442 struct obd_device *mdc_obd;
443 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
444 struct obd_uuid *mds_uuid = &ctxt->loc_exp->exp_obd->obd_uuid;
445 struct lustre_handle exph = {0, };
446 struct obd_export *exp;
447 struct obd_uuid uuid = {"LLOG_TEST6_UUID"};
448 struct llog_handle *llh = NULL;
449 struct llog_ctxt *nctxt;
452 CERROR("6a: re-open log %s using client API\n", name);
453 mdc_obd = class_find_client_obd(mds_uuid, LUSTRE_MDC_NAME, NULL);
454 if (mdc_obd == NULL) {
455 CERROR("6: no MDC devices connected to %s found.\n",
460 rc = obd_connect(&exph, mdc_obd, &uuid);
462 CERROR("6: failed to connect to MDC: %s\n", mdc_obd->obd_name);
465 exp = class_conn2export(&exph);
467 nctxt = llog_get_context(mdc_obd, LLOG_CONFIG_REPL_CTXT);
468 rc = llog_create(nctxt, &llh, NULL, name);
470 CERROR("6: llog_create failed %d\n", rc);
474 rc = llog_init_handle(llh, LLOG_F_IS_PLAIN, NULL);
476 CERROR("6: llog_init_handle failed %d\n", rc);
480 rc = llog_process(llh, (llog_cb_t)plain_print_cb, NULL);
482 CERROR("6: llog_process failed %d\n", rc);
485 rc = llog_close(llh);
487 CERROR("6: llog_close failed: rc = %d\n", rc);
490 rc = obd_disconnect(exp, 0);
495 /* -------------------------------------------------------------------------
496 * Tests above, boring obd functions below
497 * ------------------------------------------------------------------------- */
498 static int llog_run_tests(struct obd_device *obd)
500 struct llog_handle *llh;
501 struct obd_run_ctxt saved;
502 struct llog_ctxt *ctxt = llog_get_context(obd, LLOG_TEST_ORIG_CTXT);
503 int rc, err, cleanup_phase = 0;
507 sprintf(name, "%x", llog_test_rand);
508 push_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_ctxt, NULL);
510 rc = llog_test_1(obd, name);
514 rc = llog_test_2(obd, name, &llh);
517 cleanup_phase = 1; /* close llh */
519 rc = llog_test_3(obd, llh);
523 rc = llog_test_4(obd);
527 rc = llog_test_5(obd);
531 rc = llog_test_6(obd, name);
536 switch (cleanup_phase) {
538 err = llog_close(llh);
540 CERROR("cleanup: llog_close failed: %d\n", err);
544 pop_ctxt(&saved, &ctxt->loc_exp->exp_obd->obd_ctxt, NULL);
551 static int llog_test_llog_init(struct obd_device *obd, struct obd_device *tgt,
552 int count, struct llog_logid *logid)
557 rc = llog_setup(obd, LLOG_TEST_ORIG_CTXT, tgt, 0, NULL, &llog_lvfs_ops);
561 static int llog_test_llog_finish(struct obd_device *obd, int count)
566 rc = llog_cleanup(llog_get_context(obd, LLOG_TEST_ORIG_CTXT));
570 static int llog_test_cleanup(struct obd_device *obd, int flags)
572 int rc = obd_llog_finish(obd, 0);
574 CERROR("failed to llog_test_llog_finish: %d\n", rc);
579 static int llog_test_setup(struct obd_device *obd, obd_count len, void *buf)
581 struct lustre_cfg *lcfg = buf;
582 struct obd_device *tgt;
586 if (lcfg->lcfg_inllen1 < 1) {
587 CERROR("requires a TARGET OBD name\n");
591 tgt = class_name2obd(lcfg->lcfg_inlbuf1);
592 if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
593 CERROR("target device not attached or not set up (%s)\n",
598 rc = obd_llog_init(obd, tgt, 0, NULL);
602 llog_test_rand = ll_insecure_random_int();
604 rc = llog_run_tests(obd);
606 llog_test_cleanup(obd, 0);
610 static int llog_test_attach(struct obd_device *dev, obd_count len, void *data)
612 struct lprocfs_static_vars lvars;
614 lprocfs_init_vars(ost, &lvars);
615 return lprocfs_obd_attach(dev, lvars.obd_vars);
618 static int llog_test_detach(struct obd_device *dev)
620 return lprocfs_obd_detach(dev);
623 static struct obd_ops llog_obd_ops = {
624 o_owner: THIS_MODULE,
625 o_attach: llog_test_attach,
626 o_detach: llog_test_detach,
627 o_setup: llog_test_setup,
628 o_cleanup: llog_test_cleanup,
629 o_llog_init: llog_test_llog_init,
630 o_llog_finish: llog_test_llog_finish,
634 static int __init llog_test_init(void)
636 struct lprocfs_static_vars lvars;
638 lprocfs_init_multi_vars(0, &lvars);
639 return class_register_type(&llog_obd_ops,lvars.module_vars,"llog_test");
642 static void __exit llog_test_exit(void)
644 class_unregister_type("llog_test");
647 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
648 MODULE_DESCRIPTION("llog test module");
649 MODULE_LICENSE("GPL");
651 module_init(llog_test_init);
652 module_exit(llog_test_exit);