Whamcloud - gitweb
Branch: b1_4
[fs/lustre-release.git] / lustre / obdecho / echo.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  *  Copyright (c) 2001-2003 Cluster File Systems, Inc.
5  *   Author: Peter Braam <braam@clusterfs.com>
6  *   Author: Andreas Dilger <adilger@clusterfs.com>
7  *
8  *   This file is part of Lustre, http://www.lustre.org.
9  *
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.
13  *
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.
18  *
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.
22  */
23
24 #ifndef EXPORT_SYMTAB
25 # define EXPORT_SYMTAB
26 #endif
27
28 #include <linux/version.h>
29 #include <linux/module.h>
30 #include <linux/mm.h>
31 #include <linux/highmem.h>
32 #include <linux/fs.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>
39
40 #define DEBUG_SUBSYSTEM S_ECHO
41
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>
48
49 #define ECHO_INIT_OBJID      0x1000000000000000ULL
50 #define ECHO_HANDLE_MAGIC    0xabcd0123fedc9876ULL
51
52 #define ECHO_PERSISTENT_PAGES (ECHO_PERSISTENT_SIZE/PAGE_SIZE)
53 static struct page *echo_persistent_pages[ECHO_PERSISTENT_PAGES];
54
55 enum {
56         LPROC_ECHO_READ_BYTES = 1,
57         LPROC_ECHO_WRITE_BYTES = 2,
58         LPROC_ECHO_LAST = LPROC_ECHO_WRITE_BYTES +1
59 };
60
61 static int echo_connect(struct lustre_handle *conn, struct obd_device *obd,
62                         struct obd_uuid *cluuid, struct obd_connect_data *data)
63 {
64         data->ocd_connect_flags &= ECHO_CONNECT_SUPPORTED;
65         return class_connect(conn, obd, cluuid);
66 }
67
68 static int echo_disconnect(struct obd_export *exp)
69 {
70         unsigned long irqflags;
71
72         LASSERT (exp != NULL);
73
74         ldlm_cancel_locks_for_export(exp);
75
76         /* complete all outstanding replies */
77         spin_lock_irqsave(&exp->exp_lock, irqflags);
78         while (!list_empty(&exp->exp_outstanding_replies)) {
79                 struct ptlrpc_reply_state *rs =
80                         list_entry(exp->exp_outstanding_replies.next,
81                                    struct ptlrpc_reply_state, rs_exp_list);
82                 struct ptlrpc_service *svc = rs->rs_srv_ni->sni_service;
83
84                 spin_lock(&svc->srv_lock);
85                 list_del_init(&rs->rs_exp_list);
86                 ptlrpc_schedule_difficult_reply(rs);
87                 spin_unlock(&svc->srv_lock);
88         }
89         spin_unlock_irqrestore(&exp->exp_lock, irqflags);
90
91         return class_disconnect(exp);
92 }
93
94 static int echo_destroy_export(struct obd_export *exp)
95 {
96         ENTRY;
97         
98         target_destroy_export(exp);
99
100         RETURN(0);
101 }
102
103  static __u64 echo_next_id(struct obd_device *obddev)
104 {
105         obd_id id;
106
107         spin_lock(&obddev->u.echo.eo_lock);
108         id = ++obddev->u.echo.eo_lastino;
109         spin_unlock(&obddev->u.echo.eo_lock);
110
111         return id;
112 }
113
114 int echo_create(struct obd_export *exp, struct obdo *oa,
115                 struct lov_stripe_md **ea, struct obd_trans_info *oti)
116 {
117         struct obd_device *obd = class_exp2obd(exp);
118
119         if (!obd) {
120                 CERROR("invalid client cookie "LPX64"\n", 
121                        exp->exp_handle.h_cookie);
122                 return -EINVAL;
123         }
124
125         if (!(oa->o_mode && S_IFMT)) {
126                 CERROR("echo obd: no type!\n");
127                 return -ENOENT;
128         }
129
130         if (!(oa->o_valid & OBD_MD_FLTYPE)) {
131                 CERROR("invalid o_valid "LPX64"\n", oa->o_valid);
132                 return -EINVAL;
133         }
134
135         oa->o_id = echo_next_id(obd);
136         oa->o_valid = OBD_MD_FLID;
137
138         return 0;
139 }
140
141 int echo_destroy(struct obd_export *exp, struct obdo *oa,
142                  struct lov_stripe_md *ea, struct obd_trans_info *oti)
143 {
144         struct obd_device *obd = class_exp2obd(exp);
145
146         if (!obd) {
147                 CERROR("invalid client cookie "LPX64"\n",
148                        exp->exp_handle.h_cookie);
149                 RETURN(-EINVAL);
150         }
151
152         if (!(oa->o_valid & OBD_MD_FLID)) {
153                 CERROR("obdo missing FLID valid flag: "LPX64"\n", oa->o_valid);
154                 RETURN(-EINVAL);
155         }
156
157         if (oa->o_id > obd->u.echo.eo_lastino || oa->o_id < ECHO_INIT_OBJID) {
158                 CERROR("bad destroy objid: "LPX64"\n", oa->o_id);
159                 RETURN(-EINVAL);
160         }
161
162         return 0;
163 }
164
165 static int echo_getattr(struct obd_export *exp, struct obdo *oa,
166                         struct lov_stripe_md *md)
167 {
168         struct obd_device *obd = class_exp2obd(exp);
169         obd_id id = oa->o_id;
170
171         if (!obd) {
172                 CERROR("invalid client cookie "LPX64"\n", 
173                        exp->exp_handle.h_cookie);
174                 RETURN(-EINVAL);
175         }
176
177         if (!(oa->o_valid & OBD_MD_FLID)) {
178                 CERROR("obdo missing FLID valid flag: "LPX64"\n", oa->o_valid);
179                 RETURN(-EINVAL);
180         }
181
182         obdo_cpy_md(oa, &obd->u.echo.eo_oa, oa->o_valid);
183         oa->o_id = id;
184
185         return 0;
186 }
187
188 static int echo_setattr(struct obd_export *exp, struct obdo *oa,
189                         struct lov_stripe_md *md, struct obd_trans_info *oti)
190 {
191         struct obd_device *obd = class_exp2obd(exp);
192
193         if (!obd) {
194                 CERROR("invalid client cookie "LPX64"\n", 
195                        exp->exp_handle.h_cookie);
196                 RETURN(-EINVAL);
197         }
198
199         if (!(oa->o_valid & OBD_MD_FLID)) {
200                 CERROR("obdo missing FLID valid flag: "LPX64"\n", oa->o_valid);
201                 RETURN(-EINVAL);
202         }
203
204         memcpy(&obd->u.echo.eo_oa, oa, sizeof(*oa));
205
206         if (oa->o_id & 4) {
207                 /* Save lock to force ACKed reply */
208                 ldlm_lock_addref (&obd->u.echo.eo_nl_lock, LCK_NL);
209                 oti->oti_ack_locks[0].mode = LCK_NL;
210                 oti->oti_ack_locks[0].lock = obd->u.echo.eo_nl_lock;
211         }
212
213         return 0;
214 }
215
216 static void
217 echo_page_debug_setup(struct page *page, int rw, obd_id id,
218                       __u64 offset, int len)
219 {
220         int   page_offset = offset & (PAGE_SIZE - 1);
221         char *addr        = ((char *)kmap(page)) + page_offset;
222
223         if (len % OBD_ECHO_BLOCK_SIZE != 0)
224                 CERROR("Unexpected block size %d\n", len);
225
226         while (len > 0) {
227                 if (rw & OBD_BRW_READ)
228                         block_debug_setup(addr, OBD_ECHO_BLOCK_SIZE,
229                                           offset, id);
230                 else
231                         block_debug_setup(addr, OBD_ECHO_BLOCK_SIZE,
232                                           0xecc0ecc0ecc0ecc0ULL,
233                                           0xecc0ecc0ecc0ecc0ULL);
234                 
235                 addr   += OBD_ECHO_BLOCK_SIZE;
236                 offset += OBD_ECHO_BLOCK_SIZE;
237                 len    -= OBD_ECHO_BLOCK_SIZE;
238         }
239
240         kunmap(page);
241 }
242
243 static int
244 echo_page_debug_check(struct page *page, obd_id id,
245                       __u64 offset, int len)
246 {
247         int   page_offset = offset & (PAGE_SIZE - 1);
248         char *addr        = ((char *)kmap(page)) + page_offset;
249         int   rc          = 0;
250         int   rc2;
251
252         if (len % OBD_ECHO_BLOCK_SIZE != 0)
253                 CERROR("Unexpected block size %d\n", len);
254
255         while (len > 0) {
256                 rc2 = block_debug_check("echo", addr, OBD_ECHO_BLOCK_SIZE,
257                                         offset, id);
258
259                 if (rc2 != 0 && rc == 0)
260                         rc = rc2;
261                 
262                 addr   += OBD_ECHO_BLOCK_SIZE;
263                 offset += OBD_ECHO_BLOCK_SIZE;
264                 len    -= OBD_ECHO_BLOCK_SIZE;
265         }
266
267         kunmap(page);
268
269         return (rc);
270 }
271
272 /* This allows us to verify that desc_private is passed unmolested */
273 #define DESC_PRIV 0x10293847
274
275 int echo_preprw(int cmd, struct obd_export *export, struct obdo *oa,
276                 int objcount, struct obd_ioobj *obj, int niocount,
277                 struct niobuf_remote *nb, struct niobuf_local *res,
278                 struct obd_trans_info *oti)
279 {
280         struct obd_device *obd;
281         struct niobuf_local *r = res;
282         int tot_bytes = 0;
283         int rc = 0;
284         int i;
285         ENTRY;
286
287         obd = export->exp_obd;
288         if (obd == NULL)
289                 RETURN(-EINVAL);
290
291         /* Temp fix to stop falling foul of osc_announce_cached() */
292         oa->o_valid &= ~(OBD_MD_FLBLOCKS | OBD_MD_FLGRANT);
293
294         memset(res, 0, sizeof(*res) * niocount);
295
296         CDEBUG(D_PAGE, "%s %d obdos with %d IOs\n",
297                cmd == OBD_BRW_READ ? "reading" : "writing", objcount, niocount);
298
299         if (oti)
300                 oti->oti_handle = (void *)DESC_PRIV;
301
302         for (i = 0; i < objcount; i++, obj++) {
303                 int gfp_mask = (obj->ioo_id & 1) ? GFP_HIGHUSER : GFP_KERNEL;
304                 int ispersistent = obj->ioo_id == ECHO_PERSISTENT_OBJID;
305                 int debug_setup = (!ispersistent &&
306                                    (oa->o_valid & OBD_MD_FLFLAGS) != 0 &&
307                                    (oa->o_flags & OBD_FL_DEBUG_CHECK) != 0);
308                 int j;
309
310                 for (j = 0 ; j < obj->ioo_bufcnt ; j++, nb++, r++) {
311
312                         if (ispersistent &&
313                             (nb->offset >> PAGE_SHIFT) < ECHO_PERSISTENT_PAGES) {
314                                 r->page = echo_persistent_pages[nb->offset >>
315                                                                 PAGE_SHIFT];
316                                 /* Take extra ref so __free_pages() can be called OK */
317                                 get_page (r->page);
318                         } else {
319                                 r->page = alloc_pages(gfp_mask, 0);
320                                 if (r->page == NULL) {
321                                         CERROR("can't get page %u/%u for id "
322                                                LPU64"\n",
323                                                j, obj->ioo_bufcnt, obj->ioo_id);
324                                         GOTO(preprw_cleanup, rc = -ENOMEM);
325                                 }
326                         }
327
328                         tot_bytes += nb->len;
329
330                         atomic_inc(&obd->u.echo.eo_prep);
331
332                         r->offset = nb->offset;
333                         r->len = nb->len;
334                         LASSERT((r->offset & ~PAGE_MASK) + r->len <= PAGE_SIZE);
335
336                         CDEBUG(D_PAGE, "$$$$ get page %p @ "LPU64" for %d\n",
337                                r->page, r->offset, r->len);
338
339                         if (cmd & OBD_BRW_READ)
340                                 r->rc = r->len;
341
342                         if (debug_setup)
343                                 echo_page_debug_setup(r->page, cmd, obj->ioo_id,
344                                                       r->offset, r->len);
345                 }
346         }
347         if (cmd & OBD_BRW_READ)
348                 lprocfs_counter_add(obd->obd_stats, LPROC_ECHO_READ_BYTES,
349                                     tot_bytes);
350         else
351                 lprocfs_counter_add(obd->obd_stats, LPROC_ECHO_WRITE_BYTES,
352                                     tot_bytes);
353
354         CDEBUG(D_PAGE, "%d pages allocated after prep\n",
355                atomic_read(&obd->u.echo.eo_prep));
356
357         RETURN(0);
358
359 preprw_cleanup:
360         /* It is possible that we would rather handle errors by  allow
361          * any already-set-up pages to complete, rather than tearing them
362          * all down again.  I believe that this is what the in-kernel
363          * prep/commit operations do.
364          */
365         CERROR("cleaning up %ld pages (%d obdos)\n", (long)(r - res), objcount);
366         while (r-- > res) {
367                 kunmap(r->page);
368                 /* NB if this is a persistent page, __free_pages will just
369                  * lose the extra ref gained above */
370                 __free_pages(r->page, 0);
371                 atomic_dec(&obd->u.echo.eo_prep);
372         }
373         memset(res, 0, sizeof(*res) * niocount);
374
375         return rc;
376 }
377
378 int echo_commitrw(int cmd, struct obd_export *export, struct obdo *oa,
379                   int objcount, struct obd_ioobj *obj, int niocount,
380                   struct niobuf_local *res, struct obd_trans_info *oti, int rc)
381 {
382         struct obd_device *obd;
383         struct niobuf_local *r = res;
384         int i, vrc = 0;
385         ENTRY;
386
387         obd = export->exp_obd;
388         if (obd == NULL)
389                 RETURN(-EINVAL);
390
391         if (rc)
392                 GOTO(commitrw_cleanup, rc);
393
394         if ((cmd & OBD_BRW_RWMASK) == OBD_BRW_READ) {
395                 CDEBUG(D_PAGE, "reading %d obdos with %d IOs\n",
396                        objcount, niocount);
397         } else {
398                 CDEBUG(D_PAGE, "writing %d obdos with %d IOs\n",
399                        objcount, niocount);
400         }
401
402         if (niocount && !r) {
403                 CERROR("NULL res niobuf with niocount %d\n", niocount);
404                 RETURN(-EINVAL);
405         }
406
407         LASSERT(oti == NULL || oti->oti_handle == (void *)DESC_PRIV);
408
409         for (i = 0; i < objcount; i++, obj++) {
410                 int verify = (rc == 0 &&
411                               obj->ioo_id != ECHO_PERSISTENT_OBJID &&
412                               (oa->o_valid & OBD_MD_FLFLAGS) != 0 &&
413                               (oa->o_flags & OBD_FL_DEBUG_CHECK) != 0);
414                 int j;
415
416                 for (j = 0 ; j < obj->ioo_bufcnt ; j++, r++) {
417                         struct page *page = r->page;
418                         void *addr;
419
420                         if (page == NULL) {
421                                 CERROR("null page objid "LPU64":%p, buf %d/%d\n",
422                                        obj->ioo_id, page, j, obj->ioo_bufcnt);
423                                 GOTO(commitrw_cleanup, rc = -EFAULT);
424                         }
425
426                         addr = kmap(page);
427
428                         CDEBUG(D_PAGE, "$$$$ use page %p, addr %p@"LPU64"\n",
429                                r->page, addr, r->offset);
430
431                         if (verify) {
432                                 vrc = echo_page_debug_check(page, obj->ioo_id, 
433                                                             r->offset, r->len);
434                                 /* check all the pages always */
435                                 if (vrc != 0 && rc == 0)
436                                         rc = vrc;
437                         }
438
439                         kunmap(page);
440                         /* NB see comment above regarding persistent pages */
441                         __free_pages(page, 0);
442                         atomic_dec(&obd->u.echo.eo_prep);
443                 }
444         }
445         CDEBUG(D_PAGE, "%d pages remain after commit\n",
446                atomic_read(&obd->u.echo.eo_prep));
447         RETURN(rc);
448
449 commitrw_cleanup:
450         CERROR("cleaning up %ld pages (%d obdos)\n",
451                niocount - (long)(r - res) - 1, objcount);
452         while (++r < res + niocount) {
453                 struct page *page = r->page;
454
455                 /* NB see comment above regarding persistent pages */
456                 __free_pages(page, 0);
457                 atomic_dec(&obd->u.echo.eo_prep);
458         }
459         return rc;
460 }
461
462 static int echo_setup(struct obd_device *obd, obd_count len, void *buf)
463 {
464         struct lprocfs_static_vars lvars;
465         int                        rc;
466         int                        lock_flags = 0;
467         struct ldlm_res_id         res_id = {.name = {1}};
468         ENTRY;
469
470         spin_lock_init(&obd->u.echo.eo_lock);
471         obd->u.echo.eo_lastino = ECHO_INIT_OBJID;
472
473         obd->obd_namespace = ldlm_namespace_new("echo-tgt",
474                                                 LDLM_NAMESPACE_SERVER);
475         if (obd->obd_namespace == NULL) {
476                 LBUG();
477                 RETURN(-ENOMEM);
478         }
479
480         rc = ldlm_cli_enqueue(NULL, NULL, obd->obd_namespace, res_id,
481                               LDLM_PLAIN, NULL, LCK_NL, &lock_flags,
482                               NULL, ldlm_completion_ast, NULL, NULL,
483                               NULL, 0, NULL, &obd->u.echo.eo_nl_lock);
484         LASSERT (rc == ELDLM_OK);
485
486         lprocfs_init_vars(echo, &lvars);
487         if (lprocfs_obd_setup(obd, lvars.obd_vars) == 0 &&
488             lprocfs_alloc_obd_stats(obd, LPROC_ECHO_LAST) == 0) {
489                 lprocfs_counter_init(obd->obd_stats, LPROC_ECHO_READ_BYTES,
490                                      LPROCFS_CNTR_AVGMINMAX,
491                                      "read_bytes", "bytes");
492                 lprocfs_counter_init(obd->obd_stats, LPROC_ECHO_WRITE_BYTES,
493                                      LPROCFS_CNTR_AVGMINMAX,
494                                      "write_bytes", "bytes");
495         }
496
497         ptlrpc_init_client (LDLM_CB_REQUEST_PORTAL, LDLM_CB_REPLY_PORTAL,
498                             "echo_ldlm_cb_client", &obd->obd_ldlm_client);
499         RETURN(0);
500 }
501
502 static int echo_cleanup(struct obd_device *obd)
503 {
504         int leaked;
505         ENTRY;
506
507         lprocfs_free_obd_stats(obd);
508         lprocfs_obd_cleanup(obd);
509
510         ldlm_lock_decref (&obd->u.echo.eo_nl_lock, LCK_NL);
511
512         /* XXX Bug 3413; wait for a bit to ensure the BL callback has
513          * happened before calling ldlm_namespace_free() */
514         set_current_state (TASK_UNINTERRUPTIBLE);
515         schedule_timeout (HZ);
516         
517         ldlm_namespace_free(obd->obd_namespace, obd->obd_force);
518
519         leaked = atomic_read(&obd->u.echo.eo_prep);
520         if (leaked != 0)
521                 CERROR("%d prep/commitrw pages leaked\n", leaked);
522
523         RETURN(0);
524 }
525
526 static struct obd_ops echo_obd_ops = {
527         .o_owner           = THIS_MODULE,
528         .o_connect         = echo_connect,
529         .o_disconnect      = echo_disconnect,
530         .o_destroy_export  = echo_destroy_export,
531         .o_create          = echo_create,
532         .o_destroy         = echo_destroy,
533         .o_getattr         = echo_getattr,
534         .o_setattr         = echo_setattr,
535         .o_preprw          = echo_preprw,
536         .o_commitrw        = echo_commitrw,
537         .o_setup           = echo_setup,
538         .o_cleanup         = echo_cleanup
539 };
540
541 extern int echo_client_init(void);
542 extern void echo_client_exit(void);
543
544 static void
545 echo_persistent_pages_fini (void)
546 {
547         int     i;
548
549         for (i = 0; i < ECHO_PERSISTENT_PAGES; i++)
550                 if (echo_persistent_pages[i] != NULL) {
551                         __free_pages (echo_persistent_pages[i], 0);
552                         echo_persistent_pages[i] = NULL;
553                 }
554 }
555
556 static int
557 echo_persistent_pages_init (void)
558 {
559         struct page *pg;
560         int          i;
561
562         for (i = 0; i < ECHO_PERSISTENT_PAGES; i++) {
563                 int gfp_mask = (i < ECHO_PERSISTENT_PAGES/2) ?
564                         GFP_KERNEL : GFP_HIGHUSER;
565
566                 pg = alloc_pages (gfp_mask, 0);
567                 if (pg == NULL) {
568                         echo_persistent_pages_fini ();
569                         return (-ENOMEM);
570                 }
571
572                 memset (kmap (pg), 0, PAGE_SIZE);
573                 kunmap (pg);
574
575                 echo_persistent_pages[i] = pg;
576         }
577
578         return (0);
579 }
580
581 static int __init obdecho_init(void)
582 {
583         struct lprocfs_static_vars lvars;
584         int rc;
585
586         printk(KERN_INFO "Lustre: Echo OBD driver; info@clusterfs.com\n");
587
588         LASSERT(PAGE_SIZE % OBD_ECHO_BLOCK_SIZE == 0);
589
590         lprocfs_init_vars(echo, &lvars);
591
592         rc = echo_persistent_pages_init ();
593         if (rc != 0)
594                 goto failed_0;
595
596         rc = class_register_type(&echo_obd_ops, lvars.module_vars,
597                                  OBD_ECHO_DEVICENAME);
598         if (rc != 0)
599                 goto failed_1;
600
601         rc = echo_client_init();
602         if (rc == 0)
603                 RETURN (0);
604
605         class_unregister_type(OBD_ECHO_DEVICENAME);
606  failed_1:
607         echo_persistent_pages_fini ();
608  failed_0:
609         RETURN(rc);
610 }
611
612 static void /*__exit*/ obdecho_exit(void)
613 {
614         echo_client_exit();
615         class_unregister_type(OBD_ECHO_DEVICENAME);
616         echo_persistent_pages_fini ();
617 }
618
619 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
620 MODULE_DESCRIPTION("Lustre Testing Echo OBD driver");
621 MODULE_LICENSE("GPL");
622
623 module_init(obdecho_init);
624 module_exit(obdecho_exit);