1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (c) 2001-2003 Cluster File Systems, Inc.
5 * Author: Peter Braam <braam@clusterfs.com>
6 * Author: Andreas Dilger <adilger@clusterfs.com>
8 * This file is part of Lustre, http://www.lustre.org.
10 * Lustre is free software; you can redistribute it and/or
11 * modify it under the terms of version 2 of the GNU General Public
12 * License as published by the Free Software Foundation.
14 * Lustre is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with Lustre; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 # define EXPORT_SYMTAB
28 #include <linux/version.h>
29 #include <linux/module.h>
31 #include <linux/highmem.h>
33 #include <linux/stat.h>
34 #include <linux/sched.h>
35 #include <linux/smp_lock.h>
36 #include <linux/proc_fs.h>
37 #include <linux/init.h>
38 #include <asm/unistd.h>
40 #define DEBUG_SUBSYSTEM S_ECHO
42 #include <linux/obd_support.h>
43 #include <linux/obd_class.h>
44 #include <linux/obd_echo.h>
45 #include <linux/lustre_debug.h>
46 #include <linux/lustre_dlm.h>
47 #include <linux/lprocfs_status.h>
49 #define ECHO_INIT_OBJID 0x1000000000000000ULL
50 #define ECHO_HANDLE_MAGIC 0xabcd0123fedc9876ULL
52 #define ECHO_PERSISTENT_PAGES (ECHO_PERSISTENT_SIZE/PAGE_SIZE)
53 static struct page *echo_persistent_pages[ECHO_PERSISTENT_PAGES];
56 LPROC_ECHO_READ_BYTES = 1,
57 LPROC_ECHO_WRITE_BYTES = 2,
58 LPROC_ECHO_LAST = LPROC_ECHO_WRITE_BYTES +1
61 static int echo_connect(struct lustre_handle *conn, struct obd_device *obd,
62 struct obd_uuid *cluuid, unsigned long connect_flags)
64 return class_connect(conn, obd, cluuid);
67 static int echo_disconnect(struct obd_export *exp, unsigned long flags)
69 unsigned long irqflags;
71 LASSERT (exp != NULL);
73 ldlm_cancel_locks_for_export(exp);
75 spin_lock_irqsave(&exp->exp_lock, irqflags);
76 exp->exp_flags = flags;
77 /* complete all outstanding replies */
78 spin_lock_irqsave(&exp->exp_lock, irqflags);
79 while (!list_empty(&exp->exp_outstanding_replies)) {
80 struct ptlrpc_reply_state *rs =
81 list_entry(exp->exp_outstanding_replies.next,
82 struct ptlrpc_reply_state, rs_exp_list);
83 struct ptlrpc_service *svc = rs->rs_srv_ni->sni_service;
85 spin_lock(&svc->srv_lock);
86 list_del_init(&rs->rs_exp_list);
87 ptlrpc_schedule_difficult_reply(rs);
88 spin_unlock(&svc->srv_lock);
90 spin_unlock_irqrestore(&exp->exp_lock, irqflags);
92 return class_disconnect(exp, flags);
95 static int echo_destroy_export(struct obd_export *exp)
99 target_destroy_export(exp);
104 static __u64 echo_next_id(struct obd_device *obddev)
108 spin_lock(&obddev->u.echo.eo_lock);
109 id = ++obddev->u.echo.eo_lastino;
110 spin_unlock(&obddev->u.echo.eo_lock);
115 int echo_create(struct obd_export *exp, struct obdo *oa,
116 struct lov_stripe_md **ea, struct obd_trans_info *oti)
118 struct obd_device *obd = class_exp2obd(exp);
121 CERROR("invalid client cookie "LPX64"\n",
122 exp->exp_handle.h_cookie);
126 if (!(oa->o_mode && S_IFMT)) {
127 CERROR("echo obd: no type!\n");
131 if (!(oa->o_valid & OBD_MD_FLTYPE)) {
132 CERROR("invalid o_valid "LPX64"\n", oa->o_valid);
136 oa->o_id = echo_next_id(obd);
137 oa->o_valid = OBD_MD_FLID;
142 int echo_destroy(struct obd_export *exp, struct obdo *oa,
143 struct lov_stripe_md *ea, struct obd_trans_info *oti)
145 struct obd_device *obd = class_exp2obd(exp);
148 CERROR("invalid client cookie "LPX64"\n",
149 exp->exp_handle.h_cookie);
153 if (!(oa->o_valid & OBD_MD_FLID)) {
154 CERROR("obdo missing FLID valid flag: "LPX64"\n", oa->o_valid);
158 if (oa->o_id > obd->u.echo.eo_lastino || oa->o_id < ECHO_INIT_OBJID) {
159 CERROR("bad destroy objid: "LPX64"\n", oa->o_id);
167 static int echo_getattr(struct obd_export *exp, struct obdo *oa,
168 struct lov_stripe_md *md)
170 struct obd_device *obd = class_exp2obd(exp);
171 obd_id id = oa->o_id;
174 CERROR("invalid client cookie "LPX64"\n",
175 exp->exp_handle.h_cookie);
179 if (!(oa->o_valid & OBD_MD_FLID)) {
180 CERROR("obdo missing FLID valid flag: "LPX64"\n", oa->o_valid);
184 obdo_cpy_md(oa, &obd->u.echo.eo_oa, oa->o_valid);
190 static int echo_setattr(struct obd_export *exp, struct obdo *oa,
191 struct lov_stripe_md *md, struct obd_trans_info *oti)
193 struct obd_device *obd = class_exp2obd(exp);
196 CERROR("invalid client cookie "LPX64"\n",
197 exp->exp_handle.h_cookie);
201 if (!(oa->o_valid & OBD_MD_FLID)) {
202 CERROR("obdo missing FLID valid flag: "LPX64"\n", oa->o_valid);
206 memcpy(&obd->u.echo.eo_oa, oa, sizeof(*oa));
209 /* Save lock to force ACKed reply */
210 ldlm_lock_addref (&obd->u.echo.eo_nl_lock, LCK_NL);
211 oti->oti_ack_locks[0].mode = LCK_NL;
212 oti->oti_ack_locks[0].lock = obd->u.echo.eo_nl_lock;
218 echo_page_debug_setup(struct page *page, int rw, obd_id id,
219 __u64 offset, int len)
221 int page_offset = offset & (PAGE_SIZE - 1);
222 char *addr = ((char *)kmap(page)) + page_offset;
224 if (len % OBD_ECHO_BLOCK_SIZE != 0)
225 CERROR("Unexpected block size %d\n", len);
228 if (rw & OBD_BRW_READ)
229 block_debug_setup(addr, OBD_ECHO_BLOCK_SIZE,
232 block_debug_setup(addr, OBD_ECHO_BLOCK_SIZE,
233 0xecc0ecc0ecc0ecc0ULL,
234 0xecc0ecc0ecc0ecc0ULL);
236 addr += OBD_ECHO_BLOCK_SIZE;
237 offset += OBD_ECHO_BLOCK_SIZE;
238 len -= OBD_ECHO_BLOCK_SIZE;
245 echo_page_debug_check(struct page *page, obd_id id,
246 __u64 offset, int len)
248 int page_offset = offset & (PAGE_SIZE - 1);
249 char *addr = ((char *)kmap(page)) + page_offset;
253 if (len % OBD_ECHO_BLOCK_SIZE != 0)
254 CERROR("Unexpected block size %d\n", len);
257 rc2 = block_debug_check("echo", addr, OBD_ECHO_BLOCK_SIZE,
260 if (rc2 != 0 && rc == 0)
263 addr += OBD_ECHO_BLOCK_SIZE;
264 offset += OBD_ECHO_BLOCK_SIZE;
265 len -= OBD_ECHO_BLOCK_SIZE;
273 /* This allows us to verify that desc_private is passed unmolested */
274 #define DESC_PRIV 0x10293847
276 int echo_preprw(int cmd, struct obd_export *export, struct obdo *oa,
277 int objcount, struct obd_ioobj *obj, int niocount,
278 struct niobuf_remote *nb, struct niobuf_local *res,
279 struct obd_trans_info *oti)
281 struct obd_device *obd;
282 struct niobuf_local *r = res;
288 obd = export->exp_obd;
292 /* Temp fix to stop falling foul of osc_announce_cached() */
293 oa->o_valid &= ~(OBD_MD_FLBLOCKS | OBD_MD_FLGRANT);
295 memset(res, 0, sizeof(*res) * niocount);
297 CDEBUG(D_PAGE, "%s %d obdos with %d IOs\n",
298 cmd == OBD_BRW_READ ? "reading" : "writing", objcount, niocount);
301 oti->oti_handle = (void *)DESC_PRIV;
303 for (i = 0; i < objcount; i++, obj++) {
304 int gfp_mask = (obj->ioo_id & 1) ? GFP_HIGHUSER : GFP_KERNEL;
305 int ispersistent = obj->ioo_id == ECHO_PERSISTENT_OBJID;
306 int debug_setup = (!ispersistent &&
307 (oa->o_valid & OBD_MD_FLFLAGS) != 0 &&
308 (oa->o_flags & OBD_FL_DEBUG_CHECK) != 0);
311 for (j = 0 ; j < obj->ioo_bufcnt ; j++, nb++, r++) {
314 (nb->offset >> PAGE_SHIFT) < ECHO_PERSISTENT_PAGES) {
315 r->page = echo_persistent_pages[nb->offset >>
317 /* Take extra ref so __free_pages() can be called OK */
320 r->page = alloc_pages(gfp_mask, 0);
321 if (r->page == NULL) {
322 CERROR("can't get page %u/%u for id "
324 j, obj->ioo_bufcnt, obj->ioo_id);
325 GOTO(preprw_cleanup, rc = -ENOMEM);
329 tot_bytes += nb->len;
331 atomic_inc(&obd->u.echo.eo_prep);
333 r->offset = nb->offset;
335 LASSERT((r->offset & ~PAGE_MASK) + r->len <= PAGE_SIZE);
337 CDEBUG(D_PAGE, "$$$$ get page %p @ "LPU64" for %d\n",
338 r->page, r->offset, r->len);
340 if (cmd & OBD_BRW_READ)
344 echo_page_debug_setup(r->page, cmd, obj->ioo_id,
348 if (cmd & OBD_BRW_READ)
349 lprocfs_counter_add(obd->obd_stats, LPROC_ECHO_READ_BYTES,
352 lprocfs_counter_add(obd->obd_stats, LPROC_ECHO_WRITE_BYTES,
355 CDEBUG(D_PAGE, "%d pages allocated after prep\n",
356 atomic_read(&obd->u.echo.eo_prep));
361 /* It is possible that we would rather handle errors by allow
362 * any already-set-up pages to complete, rather than tearing them
363 * all down again. I believe that this is what the in-kernel
364 * prep/commit operations do.
366 CERROR("cleaning up %ld pages (%d obdos)\n", (long)(r - res), objcount);
369 /* NB if this is a persistent page, __free_pages will just
370 * lose the extra ref gained above */
371 __free_pages(r->page, 0);
372 atomic_dec(&obd->u.echo.eo_prep);
374 memset(res, 0, sizeof(*res) * niocount);
379 int echo_commitrw(int cmd, struct obd_export *export, struct obdo *oa,
380 int objcount, struct obd_ioobj *obj, int niocount,
381 struct niobuf_local *res, struct obd_trans_info *oti, int rc)
383 struct obd_device *obd;
384 struct niobuf_local *r = res;
388 obd = export->exp_obd;
393 GOTO(commitrw_cleanup, rc);
395 if ((cmd & OBD_BRW_RWMASK) == OBD_BRW_READ) {
396 CDEBUG(D_PAGE, "reading %d obdos with %d IOs\n",
399 CDEBUG(D_PAGE, "writing %d obdos with %d IOs\n",
403 if (niocount && !r) {
404 CERROR("NULL res niobuf with niocount %d\n", niocount);
408 LASSERT(oti == NULL || oti->oti_handle == (void *)DESC_PRIV);
410 for (i = 0; i < objcount; i++, obj++) {
411 int verify = (rc == 0 &&
412 obj->ioo_id != ECHO_PERSISTENT_OBJID &&
413 (oa->o_valid & OBD_MD_FLFLAGS) != 0 &&
414 (oa->o_flags & OBD_FL_DEBUG_CHECK) != 0);
418 for (j = 0 ; j < obj->ioo_bufcnt ; j++, r++) {
419 struct page *page = r->page;
423 CERROR("null page objid "LPU64":%p, buf %d/%d\n",
424 obj->ioo_id, page, j, obj->ioo_bufcnt);
425 GOTO(commitrw_cleanup, rc = -EFAULT);
430 CDEBUG(D_PAGE, "$$$$ use page %p, addr %p@"LPU64"\n",
431 r->page, addr, r->offset);
434 vrc = echo_page_debug_check(page, obj->ioo_id,
436 /* check all the pages always */
437 if (vrc != 0 && rc == 0)
442 /* NB see comment above regarding persistent pages */
443 __free_pages(page, 0);
444 atomic_dec(&obd->u.echo.eo_prep);
447 CDEBUG(D_PAGE, "%d pages remain after commit\n",
448 atomic_read(&obd->u.echo.eo_prep));
452 CERROR("cleaning up %ld pages (%d obdos)\n",
453 niocount - (long)(r - res) - 1, objcount);
454 while (++r < res + niocount) {
455 struct page *page = r->page;
457 /* NB see comment above regarding persistent pages */
458 __free_pages(page, 0);
459 atomic_dec(&obd->u.echo.eo_prep);
464 static int echo_setup(struct obd_device *obd, obd_count len, void *buf)
468 struct ldlm_res_id res_id = {.name = {1}};
472 spin_lock_init(&obd->u.echo.eo_lock);
473 obd->u.echo.eo_lastino = ECHO_INIT_OBJID;
475 obd->obd_namespace = ldlm_namespace_new("echo-tgt",
476 LDLM_NAMESPACE_SERVER);
477 if (obd->obd_namespace == NULL) {
481 rc = ldlm_cli_enqueue(NULL, NULL, obd->obd_namespace, res_id,
482 LDLM_PLAIN, NULL, LCK_NL, &lock_flags,
483 NULL, ldlm_completion_ast, NULL, NULL,
484 NULL, 0, NULL, &obd->u.echo.eo_nl_lock);
485 LASSERT (rc == ELDLM_OK);
489 ptlrpc_init_client (LDLM_CB_REQUEST_PORTAL, LDLM_CB_REPLY_PORTAL,
490 "echo_ldlm_cb_client", &obd->obd_ldlm_client);
494 static int echo_cleanup(struct obd_device *obd, int flags)
499 ldlm_lock_decref (&obd->u.echo.eo_nl_lock, LCK_NL);
501 /* XXX Bug 3413; wait for a bit to ensure the BL callback has
502 * happened before calling ldlm_namespace_free() */
503 set_current_state (TASK_UNINTERRUPTIBLE);
504 schedule_timeout (HZ);
506 ldlm_namespace_free(obd->obd_namespace, flags & OBD_OPT_FORCE);
508 leaked = atomic_read(&obd->u.echo.eo_prep);
510 CERROR("%d prep/commitrw pages leaked\n", leaked);
515 int echo_attach(struct obd_device *obd, obd_count len, void *data)
517 struct lprocfs_static_vars lvars;
520 lprocfs_init_vars(echo, &lvars);
521 rc = lprocfs_obd_attach(obd, lvars.obd_vars);
524 rc = lprocfs_alloc_obd_stats(obd, LPROC_ECHO_LAST);
528 lprocfs_counter_init(obd->obd_stats, LPROC_ECHO_READ_BYTES,
529 LPROCFS_CNTR_AVGMINMAX, "read_bytes", "bytes");
530 lprocfs_counter_init(obd->obd_stats, LPROC_ECHO_WRITE_BYTES,
531 LPROCFS_CNTR_AVGMINMAX, "write_bytes", "bytes");
535 int echo_detach(struct obd_device *dev)
537 lprocfs_free_obd_stats(dev);
538 return lprocfs_obd_detach(dev);
541 static struct obd_ops echo_obd_ops = {
542 .o_owner = THIS_MODULE,
543 .o_attach = echo_attach,
544 .o_detach = echo_detach,
545 .o_connect = echo_connect,
546 .o_disconnect = echo_disconnect,
547 .o_destroy_export = echo_destroy_export,
548 .o_create = echo_create,
549 .o_destroy = echo_destroy,
550 .o_getattr = echo_getattr,
551 .o_setattr = echo_setattr,
552 .o_preprw = echo_preprw,
553 .o_commitrw = echo_commitrw,
554 .o_setup = echo_setup,
555 .o_cleanup = echo_cleanup
558 extern int echo_client_init(void);
559 extern void echo_client_exit(void);
562 echo_persistent_pages_fini (void)
566 for (i = 0; i < ECHO_PERSISTENT_PAGES; i++)
567 if (echo_persistent_pages[i] != NULL) {
568 __free_pages (echo_persistent_pages[i], 0);
569 echo_persistent_pages[i] = NULL;
574 echo_persistent_pages_init (void)
579 for (i = 0; i < ECHO_PERSISTENT_PAGES; i++) {
580 int gfp_mask = (i < ECHO_PERSISTENT_PAGES/2) ?
581 GFP_KERNEL : GFP_HIGHUSER;
583 pg = alloc_pages (gfp_mask, 0);
585 echo_persistent_pages_fini ();
589 memset (kmap (pg), 0, PAGE_SIZE);
592 echo_persistent_pages[i] = pg;
598 static int __init obdecho_init(void)
600 struct lprocfs_static_vars lvars;
603 printk(KERN_INFO "Lustre: Echo OBD driver; info@clusterfs.com\n");
605 LASSERT(PAGE_SIZE % OBD_ECHO_BLOCK_SIZE == 0);
607 lprocfs_init_vars(echo, &lvars);
609 rc = echo_persistent_pages_init ();
613 rc = class_register_type(&echo_obd_ops, NULL, lvars.module_vars,
614 OBD_ECHO_DEVICENAME);
618 rc = echo_client_init();
622 class_unregister_type(OBD_ECHO_DEVICENAME);
624 echo_persistent_pages_fini ();
629 static void /*__exit*/ obdecho_exit(void)
632 class_unregister_type(OBD_ECHO_DEVICENAME);
633 echo_persistent_pages_fini ();
636 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
637 MODULE_DESCRIPTION("Lustre Testing Echo OBD driver");
638 MODULE_LICENSE("GPL");
640 module_init(obdecho_init);
641 module_exit(obdecho_exit);