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