Whamcloud - gitweb
Branch HEAD
[fs/lustre-release.git] / lustre / obdecho / echo_client.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #define DEBUG_SUBSYSTEM S_ECHO
38 #ifdef __KERNEL__
39 #include <libcfs/libcfs.h>
40 #else
41 #include <liblustre.h>
42 #endif
43
44 #include <obd.h>
45 #include <obd_support.h>
46 #include <obd_class.h>
47 #include <lustre_debug.h>
48 #include <lprocfs_status.h>
49 #include <cl_object.h>
50
51 #include "echo_internal.h"
52
53 struct echo_device {
54         struct cl_device        ed_cl;
55         struct echo_client_obd *ed_ec;
56
57         struct cl_site          ed_site_myself;
58         struct cl_site         *ed_site;
59         struct lu_device       *ed_next;
60         int                     ed_next_islov;
61 };
62
63 struct echo_object {
64         struct cl_object        eo_cl;
65         struct cl_object_header eo_hdr;
66
67         struct echo_device     *eo_dev;
68         struct list_head        eo_obj_chain;
69         struct lov_stripe_md   *eo_lsm;
70         atomic_t                eo_npages;
71         int                     eo_deleted;
72 };
73
74 struct echo_object_conf {
75         struct cl_object_conf  eoc_cl;
76         struct lov_stripe_md **eoc_md;
77 };
78
79 struct echo_page {
80         struct cl_page_slice   ep_cl;
81         cfs_page_t            *ep_vmpage;
82 };
83
84 struct echo_lock {
85         struct cl_lock_slice   el_cl;
86         struct list_head       el_chain;
87         struct echo_object    *el_object;
88         __u64                  el_cookie;
89 };
90
91 struct echo_io {
92         struct cl_io_slice     ei_cl;
93 };
94
95 #if 0
96 struct echo_req {
97         struct cl_req_slice er_cl;
98 };
99 #endif
100
101 static int echo_client_setup(struct obd_device *obddev,
102                              struct lustre_cfg *lcfg);
103 static int echo_client_cleanup(struct obd_device *obddev);
104
105
106 /** \defgroup echo_helpers
107  * @{
108  */
109 static inline struct echo_device *cl2echo_dev(const struct cl_device *dev)
110 {
111         return container_of0(dev, struct echo_device, ed_cl);
112 }
113
114 static inline struct cl_device *echo_dev2cl(struct echo_device *d)
115 {
116         return &d->ed_cl;
117 }
118
119 static inline struct echo_device *obd2echo_dev(const struct obd_device *obd)
120 {
121         return cl2echo_dev(lu2cl_dev(obd->obd_lu_dev));
122 }
123
124 static inline struct cl_object *echo_obj2cl(struct echo_object *eco)
125 {
126         return &eco->eo_cl;
127 }
128
129 static inline struct echo_object *cl2echo_obj(const struct cl_object *o)
130 {
131         return container_of(o, struct echo_object, eo_cl);
132 }
133
134 static inline struct echo_page *cl2echo_page(const struct cl_page_slice *s)
135 {
136         return container_of(s, struct echo_page, ep_cl);
137 }
138
139 static inline struct echo_lock *cl2echo_lock(const struct cl_lock_slice *s)
140 {
141         return container_of(s, struct echo_lock, el_cl);
142 }
143
144 static inline struct cl_lock *echo_lock2cl(const struct echo_lock *ecl)
145 {
146         return ecl->el_cl.cls_lock;
147 }
148
149 static struct lu_context_key echo_thread_key;
150 static inline struct echo_thread_info *echo_env_info(const struct lu_env *env)
151 {
152         struct echo_thread_info *info;
153         info = lu_context_key_get(&env->le_ctx, &echo_thread_key);
154         LASSERT(info != NULL);
155         return info;
156 }
157
158 static inline
159 struct echo_object_conf *cl2echo_conf(const struct cl_object_conf *c)
160 {
161         return container_of(c, struct echo_object_conf, eoc_cl);
162 }
163
164 static inline void lsm2fid(struct lov_stripe_md *lsm, struct lu_fid *fid)
165 {
166         fid_zero(fid);
167         fid->f_seq = lsm->lsm_object_gr << 16 | lsm->lsm_object_id >> 32;
168         fid->f_oid = lsm->lsm_object_id;
169 }
170 /** @} echo_helpers */
171
172 static struct echo_object *cl_echo_object_find(struct echo_device *d,
173                                                struct lov_stripe_md **lsm);
174 static int cl_echo_object_put(struct echo_object *eco);
175 static int cl_echo_enqueue   (struct echo_object *eco, obd_off start,
176                               obd_off end, int mode, __u64 *cookie);
177 static int cl_echo_cancel    (struct echo_device *d, __u64 cookie);
178 static int cl_echo_object_brw(struct echo_object *eco, int rw, obd_off offset,
179                               cfs_page_t **pages, int npages, int async);
180
181 static struct echo_thread_info *echo_env_info(const struct lu_env *env);
182
183 struct echo_thread_info {
184         struct echo_object_conf eti_conf;
185         struct lustre_md        eti_md;
186
187         struct cl_2queue        eti_queue;
188         struct cl_io            eti_io;
189         struct cl_lock_descr    eti_descr;
190         struct lu_fid           eti_fid;
191 };
192
193 /* No session used right now */
194 struct echo_session_info {
195         unsigned long dummy;
196 };
197
198 static cfs_mem_cache_t *echo_page_kmem;
199 static cfs_mem_cache_t *echo_lock_kmem;
200 static cfs_mem_cache_t *echo_object_kmem;
201 static cfs_mem_cache_t *echo_thread_kmem;
202 static cfs_mem_cache_t *echo_session_kmem;
203 //static cfs_mem_cache_t *echo_req_kmem;
204
205 static struct lu_kmem_descr echo_caches[] = {
206         {
207                 .ckd_cache = &echo_page_kmem,
208                 .ckd_name  = "echo_page_kmem",
209                 .ckd_size  = sizeof (struct echo_page)
210         },
211         {
212                 .ckd_cache = &echo_lock_kmem,
213                 .ckd_name  = "echo_lock_kmem",
214                 .ckd_size  = sizeof (struct echo_lock)
215         },
216         {
217                 .ckd_cache = &echo_object_kmem,
218                 .ckd_name  = "echo_object_kmem",
219                 .ckd_size  = sizeof (struct echo_object)
220         },
221         {
222                 .ckd_cache = &echo_thread_kmem,
223                 .ckd_name  = "echo_thread_kmem",
224                 .ckd_size  = sizeof (struct echo_thread_info)
225         },
226         {
227                 .ckd_cache = &echo_session_kmem,
228                 .ckd_name  = "echo_session_kmem",
229                 .ckd_size  = sizeof (struct echo_session_info)
230         },
231 #if 0
232         {
233                 .ckd_cache = &echo_req_kmem,
234                 .ckd_name  = "echo_req_kmem",
235                 .ckd_size  = sizeof (struct echo_req)
236         },
237 #endif
238         {
239                 .ckd_cache = NULL
240         }
241 };
242
243 /** defgroup echo_page echo_page
244  *
245  * Echo page operations.
246  *
247  * @{
248  */
249 cfs_page_t *echo_page_vmpage(const struct lu_env *env,
250                              const struct cl_page_slice *slice)
251 {
252         return cl2echo_page(slice)->ep_vmpage;
253 }
254
255 static void echo_page_discard(const struct lu_env *env,
256                               const struct cl_page_slice *slice,
257                               struct cl_io *unused)
258 {
259         cl_page_delete(env, slice->cpl_page);
260 }
261
262 static int echo_page_is_vmlocked(const struct lu_env *env,
263                                  const struct cl_page_slice *slice)
264 {
265         return 1;
266 }
267
268 static void echo_page_completion(const struct lu_env *env,
269                                  const struct cl_page_slice *slice,
270                                  int ioret)
271 {
272         LASSERT(slice->cpl_page->cp_sync_io != NULL);
273 }
274
275 static void echo_page_fini(const struct lu_env *env,
276                            struct cl_page_slice *slice)
277 {
278         struct echo_page *ep    = cl2echo_page(slice);
279         struct echo_object *eco = cl2echo_obj(slice->cpl_obj);
280         cfs_page_t *vmpage      = ep->ep_vmpage;
281         ENTRY;
282
283         atomic_dec(&eco->eo_npages);
284         page_cache_release(vmpage);
285         OBD_SLAB_FREE_PTR(ep, echo_page_kmem);
286         EXIT;
287 }
288
289 static int echo_page_prep(const struct lu_env *env,
290                           const struct cl_page_slice *slice,
291                           struct cl_io *unused)
292 {
293         return 0;
294 }
295
296 static int echo_page_print(const struct lu_env *env,
297                            const struct cl_page_slice *slice,
298                            void *cookie, lu_printer_t printer)
299 {
300         struct echo_page *ep = cl2echo_page(slice);
301
302         (*printer)(env, cookie, LUSTRE_ECHO_CLIENT_NAME"-page@%p vm@%p\n",
303                    ep, ep->ep_vmpage);
304         return 0;
305 }
306
307 static const struct cl_page_operations echo_page_ops = {
308         .cpo_discard       = echo_page_discard,
309         .cpo_vmpage        = echo_page_vmpage,
310         .cpo_fini          = echo_page_fini,
311         .cpo_print         = echo_page_print,
312         .cpo_is_vmlocked   = echo_page_is_vmlocked,
313         .io = {
314                 [CRT_READ] = {
315                         .cpo_prep        = echo_page_prep,
316                         .cpo_completion  = echo_page_completion,
317                 },
318                 [CRT_WRITE] = {
319                         .cpo_prep        = echo_page_prep,
320                         .cpo_completion  = echo_page_completion,
321                 }
322         }
323 };
324 /** @} echo_page */
325
326 /** \defgroup echo_lock echo_lock
327  *
328  * echo lock operations
329  *
330  * @{
331  */
332 static void echo_lock_fini(const struct lu_env *env,
333                            struct cl_lock_slice *slice)
334 {
335         struct echo_lock *ecl = cl2echo_lock(slice);
336
337         LASSERT(list_empty(&ecl->el_chain));
338         OBD_SLAB_FREE_PTR(ecl, echo_lock_kmem);
339 }
340
341 static void echo_lock_delete(const struct lu_env *env,
342                              const struct cl_lock_slice *slice)
343 {
344         struct echo_lock *ecl      = cl2echo_lock(slice);
345
346         LASSERT(list_empty(&ecl->el_chain));
347 }
348
349 static int echo_lock_fits_into(const struct lu_env *env,
350                                const struct cl_lock_slice *slice,
351                                const struct cl_lock_descr *need,
352                                const struct cl_io *unused)
353 {
354         return 1;
355 }
356
357 static struct cl_lock_operations echo_lock_ops = {
358         .clo_fini      = echo_lock_fini,
359         .clo_delete    = echo_lock_delete,
360         .clo_fits_into = echo_lock_fits_into
361 };
362
363 /** @} echo_lock */
364
365 /** \defgroup echo_cl_ops echo_cl_ops
366  *
367  * operations for cl_object
368  *
369  * @{
370  */
371 static struct cl_page *echo_page_init(const struct lu_env *env,
372                                       struct cl_object *obj,
373                                       struct cl_page *page, cfs_page_t *vmpage)
374 {
375         struct echo_page *ep;
376         ENTRY;
377
378         OBD_SLAB_ALLOC_PTR_GFP(ep, echo_page_kmem, CFS_ALLOC_IO);
379         if (ep != NULL) {
380                 struct echo_object *eco = cl2echo_obj(obj);
381                 ep->ep_vmpage = vmpage;
382                 page_cache_get(vmpage);
383                 cl_page_slice_add(page, &ep->ep_cl, obj, &echo_page_ops);
384                 atomic_inc(&eco->eo_npages);
385         }
386         RETURN(ERR_PTR(ep ? 0 : -ENOMEM));
387 }
388
389 static int echo_io_init(const struct lu_env *env, struct cl_object *obj,
390                         struct cl_io *io)
391 {
392         return 0;
393 }
394
395 static int echo_lock_init(const struct lu_env *env,
396                           struct cl_object *obj, struct cl_lock *lock,
397                           const struct cl_io *unused)
398 {
399         struct echo_lock *el;
400         ENTRY;
401
402         OBD_SLAB_ALLOC_PTR_GFP(el, echo_lock_kmem, CFS_ALLOC_IO);
403         if (el != NULL) {
404                 cl_lock_slice_add(lock, &el->el_cl, obj, &echo_lock_ops);
405                 el->el_object = cl2echo_obj(obj);
406                 CFS_INIT_LIST_HEAD(&el->el_chain);
407         }
408         RETURN(el == NULL ? -ENOMEM : 0);
409 }
410
411 static int echo_conf_set(const struct lu_env *env, struct cl_object *obj,
412                          const struct cl_object_conf *conf)
413 {
414         return 0;
415 }
416
417 static const struct cl_object_operations echo_cl_obj_ops = {
418         .coo_page_init = echo_page_init,
419         .coo_lock_init = echo_lock_init,
420         .coo_io_init   = echo_io_init,
421         .coo_conf_set  = echo_conf_set
422 };
423 /** @} echo_cl_ops */
424
425 /** \defgroup echo_lu_ops echo_lu_ops
426  *
427  * operations for echo lu object.
428  *
429  * @{
430  */
431 static int echo_object_init(const struct lu_env *env, struct lu_object *obj,
432                             const struct lu_object_conf *conf)
433 {
434         const struct cl_object_conf *cconf = lu2cl_conf(conf);
435         struct echo_object_conf *econf = cl2echo_conf(cconf);
436         struct echo_device *ed         = cl2echo_dev(lu2cl_dev(obj->lo_dev));
437         struct echo_client_obd *ec     = ed->ed_ec;
438         struct echo_object *eco        = cl2echo_obj(lu2cl(obj));
439         ENTRY;
440
441         if (ed->ed_next) {
442                 struct lu_object  *below;
443                 struct lu_device  *under;
444
445                 under = ed->ed_next;
446                 below = under->ld_ops->ldo_object_alloc(env, obj->lo_header,
447                                                         under);
448                 if (below == NULL)
449                         RETURN(-ENOMEM);
450                 lu_object_add(obj, below);
451         }
452
453         LASSERT(econf->eoc_md);
454         eco->eo_lsm = *econf->eoc_md;
455         eco->eo_dev = ed;
456         atomic_set(&eco->eo_npages, 0);
457
458         /* clear the lsm pointer so that it won't get freed. */
459         *econf->eoc_md = NULL;
460
461         spin_lock(&ec->ec_lock);
462         list_add_tail(&eco->eo_obj_chain, &ec->ec_objects);
463         spin_unlock(&ec->ec_lock);
464
465         RETURN(0);
466 }
467
468 static void echo_object_free(const struct lu_env *env, struct lu_object *obj)
469 {
470         struct echo_object *eco    = cl2echo_obj(lu2cl(obj));
471         struct echo_client_obd *ec = eco->eo_dev->ed_ec;
472         struct lov_stripe_md *lsm  = eco->eo_lsm;
473         ENTRY;
474
475         LASSERT(atomic_read(&eco->eo_npages) == 0);
476
477         spin_lock(&ec->ec_lock);
478         list_del_init(&eco->eo_obj_chain);
479         spin_unlock(&ec->ec_lock);
480
481         lu_object_fini(obj);
482         lu_object_header_fini(obj->lo_header);
483
484         if (lsm)
485                 obd_free_memmd(ec->ec_exp, &lsm);
486         OBD_SLAB_FREE_PTR(eco, echo_object_kmem);
487         EXIT;
488 }
489
490 static int echo_object_print(const struct lu_env *env, void *cookie,
491                             lu_printer_t p, const struct lu_object *o)
492 {
493         struct echo_object *obj = cl2echo_obj(lu2cl(o));
494
495         return (*p)(env, cookie, "echoclient-object@%p", obj);
496 }
497
498
499 static const struct lu_object_operations echo_lu_obj_ops = {
500         .loo_object_init      = echo_object_init,
501         .loo_object_delete    = NULL,
502         .loo_object_release   = NULL,
503         .loo_object_free      = echo_object_free,
504         .loo_object_print     = echo_object_print,
505         .loo_object_invariant = NULL
506 };
507 /** @} echo_lu_ops */
508
509 /** \defgroup echo_lu_dev_ops
510  *
511  * Operations for echo lu device.
512  *
513  * @{
514  */
515 static struct lu_object *echo_object_alloc(const struct lu_env *env,
516                                          const struct lu_object_header *hdr,
517                                          struct lu_device *dev)
518 {
519         struct echo_object *eco;
520         struct lu_object *obj = NULL;
521         ENTRY;
522
523         /* we're the top dev. */
524         LASSERT(hdr == NULL);
525         OBD_SLAB_ALLOC_PTR_GFP(eco, echo_object_kmem, CFS_ALLOC_IO);
526         if (eco != NULL) {
527                 struct cl_object_header *hdr = &eco->eo_hdr;
528
529                 obj = &echo_obj2cl(eco)->co_lu;
530                 cl_object_header_init(hdr);
531                 lu_object_init(obj, &hdr->coh_lu, dev);
532                 lu_object_add_top(&hdr->coh_lu, obj);
533
534                 eco->eo_cl.co_ops = &echo_cl_obj_ops;
535                 obj->lo_ops       = &echo_lu_obj_ops;
536         }
537         RETURN(obj);
538 }
539
540 static struct lu_device_operations echo_device_lu_ops = {
541         .ldo_object_alloc   = echo_object_alloc,
542 };
543 /** @} echo_lu_dev_ops */
544
545 static struct cl_device_operations echo_device_cl_ops = {
546 };
547
548 /** \defgroup echo_init echo_init
549  *
550  * Init and fini functions for echo client.
551  *
552  * @{
553  */
554 static int echo_site_init(const struct lu_env *env, struct echo_device *ed)
555 {
556         struct cl_site *site = &ed->ed_site_myself;
557         int rc;
558
559         /* initialize site */
560         rc = cl_site_init(site, &ed->ed_cl);
561         if (rc) {
562                 CERROR("Cannot initilize site for echo client(%d)\n", rc);
563                 return rc;
564         }
565
566         rc = lu_site_init_finish(&site->cs_lu);
567         if (rc)
568                 return rc;
569
570         ed->ed_site = site;
571         return 0;
572 }
573
574 static void echo_site_fini(const struct lu_env *env, struct echo_device *ed)
575 {
576         if (ed->ed_site) {
577                 cl_site_fini(ed->ed_site);
578                 ed->ed_site = NULL;
579         }
580 }
581
582 static void *echo_thread_key_init(const struct lu_context *ctx,
583                           struct lu_context_key *key)
584 {
585         struct echo_thread_info *info;
586
587         OBD_SLAB_ALLOC_PTR_GFP(info, echo_thread_kmem, CFS_ALLOC_IO);
588         if (info == NULL)
589                 info = ERR_PTR(-ENOMEM);
590         return info;
591 }
592
593 static void echo_thread_key_fini(const struct lu_context *ctx,
594                          struct lu_context_key *key, void *data)
595 {
596         struct echo_thread_info *info = data;
597         OBD_SLAB_FREE_PTR(info, echo_thread_kmem);
598 }
599
600 static void echo_thread_key_exit(const struct lu_context *ctx,
601                          struct lu_context_key *key, void *data)
602 {
603 }
604
605 static struct lu_context_key echo_thread_key = {
606         .lct_tags = LCT_CL_THREAD,
607         .lct_init = echo_thread_key_init,
608         .lct_fini = echo_thread_key_fini,
609         .lct_exit = echo_thread_key_exit
610 };
611
612 static void *echo_session_key_init(const struct lu_context *ctx,
613                                   struct lu_context_key *key)
614 {
615         struct echo_session_info *session;
616
617         OBD_SLAB_ALLOC_PTR_GFP(session, echo_session_kmem, CFS_ALLOC_IO);
618         if (session == NULL)
619                 session = ERR_PTR(-ENOMEM);
620         return session;
621 }
622
623 static void echo_session_key_fini(const struct lu_context *ctx,
624                                  struct lu_context_key *key, void *data)
625 {
626         struct echo_session_info *session = data;
627         OBD_SLAB_FREE_PTR(session, echo_session_kmem);
628 }
629
630 static void echo_session_key_exit(const struct lu_context *ctx,
631                                  struct lu_context_key *key, void *data)
632 {
633 }
634
635 static struct lu_context_key echo_session_key = {
636         .lct_tags = LCT_SESSION,
637         .lct_init = echo_session_key_init,
638         .lct_fini = echo_session_key_fini,
639         .lct_exit = echo_session_key_exit
640 };
641
642 LU_TYPE_INIT_FINI(echo, &echo_thread_key, &echo_session_key);
643
644 static struct lu_device *echo_device_alloc(const struct lu_env *env,
645                                            struct lu_device_type *t,
646                                            struct lustre_cfg *cfg)
647 {
648         struct lu_device   *next;
649         struct echo_device *ed;
650         struct cl_device   *cd;
651         struct obd_device  *obd = NULL; /* to keep compiler happy */
652         struct obd_device  *tgt;
653         const char *tgt_type_name;
654         int rc;
655         int cleanup = 0;
656         ENTRY;
657
658         OBD_ALLOC_PTR(ed);
659         if (ed == NULL)
660                 GOTO(out, rc = -ENOMEM);
661
662         cleanup = 1;
663         cd = &ed->ed_cl;
664         rc = cl_device_init(cd, t);
665         if (rc)
666                 GOTO(out, rc);
667
668         cd->cd_lu_dev.ld_ops = &echo_device_lu_ops;
669         cd->cd_ops = &echo_device_cl_ops;
670
671         cleanup = 2;
672         rc = echo_site_init(env, ed);
673         if (rc)
674                 GOTO(out, rc);
675
676         cleanup = 3;
677         obd = class_name2obd(lustre_cfg_string(cfg, 0));
678         LASSERT(obd != NULL);
679         rc = echo_client_setup(obd, cfg);
680         if (rc)
681                 GOTO(out, rc);
682         ed->ed_ec = &obd->u.echo_client;
683
684         cleanup = 4;
685         tgt = class_name2obd(lustre_cfg_string(cfg, 1));
686         LASSERT(tgt != NULL);
687         next = tgt->obd_lu_dev;
688         if (next != NULL && !lu_device_is_cl(next))
689                 next = NULL;
690
691         /*
692          * if echo client is to be stacked upon ost device, the next is NULL
693          * since ost is not a clio device so far
694          */
695         tgt_type_name = tgt->obd_type->typ_name;
696         if (next != NULL) {
697                 LASSERT(next != NULL);
698                 if (next->ld_site != NULL)
699                         GOTO(out, rc = -EBUSY);
700
701                 next->ld_site = &ed->ed_site->cs_lu;
702                 rc = next->ld_type->ldt_ops->ldto_device_init(env, next,
703                                              next->ld_type->ldt_name, NULL);
704                 if (rc)
705                         GOTO(out, rc);
706
707                 /* Trikcy case, I have to determine the obd type since clio
708                  * uses the different parameters to initialize objects for
709                  * lov & osc.
710                  */
711                 if (strcmp(tgt_type_name, LUSTRE_LOV_NAME) == 0)
712                         ed->ed_next_islov = 1;
713                 else
714                         LASSERT(strcmp(tgt_type_name, LUSTRE_OSC_NAME) == 0);
715         } else
716                 LASSERT(strcmp(tgt_type_name, LUSTRE_OST_NAME) == 0);
717
718         ed->ed_next = next;
719         RETURN(&cd->cd_lu_dev);
720
721 out:
722         switch(cleanup) {
723         case 4: {
724                 int rc2;
725                 rc2 = echo_client_cleanup(obd);
726                 if (rc2)
727                         CERROR("Cleanup obd device %s error(%d)\n",
728                                obd->obd_name, rc2);
729         }
730
731         case 3:
732                 echo_site_fini(env, ed);
733         case 2:
734                 cl_device_fini(&ed->ed_cl);
735         case 1:
736                 OBD_FREE_PTR(ed);
737         case 0:
738         default:
739                 break;
740         }
741         return(ERR_PTR(rc));
742 }
743
744 static int echo_device_init(const struct lu_env *env, struct lu_device *d,
745                           const char *name, struct lu_device *next)
746 {
747         LBUG();
748         return 0;
749 }
750
751 static struct lu_device *echo_device_fini(const struct lu_env *env,
752                                           struct lu_device *d)
753 {
754         struct echo_device *ed = cl2echo_dev(lu2cl_dev(d));
755         struct lu_device *next = ed->ed_next;
756
757         while (next)
758                 next = next->ld_type->ldt_ops->ldto_device_fini(env, next);
759         return NULL;
760 }
761
762 static struct lu_device *echo_device_free(const struct lu_env *env,
763                                           struct lu_device *d)
764 {
765         struct echo_device     *ed   = cl2echo_dev(lu2cl_dev(d));
766         struct echo_client_obd *ec   = ed->ed_ec;
767         struct lu_device       *next = ed->ed_next;
768
769         printk("ed = %p, ec = %p, next = %p\n", ed, ec, next);
770
771         /* destroy locks */
772         spin_lock(&ec->ec_lock);
773         while (!list_empty(&ec->ec_locks)) {
774                 struct echo_lock *ecl = list_entry(ec->ec_locks.next,
775                                                    struct echo_lock, el_chain);
776                 struct cl_lock *lock  = echo_lock2cl(ecl);
777
778                 list_del_init(&ecl->el_chain);
779                 spin_unlock(&ec->ec_lock);
780
781                 CERROR("echo client: pending lock %p\n", ecl);
782
783                 cl_lock_get(lock);
784                 cl_unuse(env, lock);
785                 cl_lock_release(env, lock, "ec enqueue", ecl->el_object);
786
787                 cl_lock_mutex_get(env, lock);
788                 cl_lock_cancel(env, lock);
789                 cl_lock_delete(env, lock);
790                 cl_lock_mutex_put(env, lock);
791                 cl_lock_put(env, lock);
792
793                 spin_lock(&ec->ec_lock);
794         }
795         spin_unlock(&ec->ec_lock);
796
797         LASSERT(ed->ed_site);
798         lu_site_purge(env, &ed->ed_site->cs_lu, -1);
799
800         /* check if there are objects still alive, assume only one reference */
801         spin_lock(&ec->ec_lock);
802         while (!list_empty(&ec->ec_objects)) {
803                 struct echo_object *eco;
804                 eco = list_entry(ec->ec_objects.next, struct echo_object,
805                                  eo_obj_chain);
806                 spin_unlock(&ec->ec_lock);
807
808                 eco->eo_deleted = 1;
809                 cl_echo_object_put(eco);
810
811                 spin_lock(&ec->ec_lock);
812         }
813         spin_unlock(&ec->ec_lock);
814
815         echo_client_cleanup(d->ld_obd);
816
817         while (next)
818                 next = next->ld_type->ldt_ops->ldto_device_free(env, next);
819
820         LASSERT(ed->ed_site == lu2cl_site(d->ld_site));
821         echo_site_fini(env, ed);
822         cl_device_fini(&ed->ed_cl);
823         OBD_FREE_PTR(ed);
824
825         return NULL;
826 }
827
828 static const struct lu_device_type_operations echo_device_type_ops = {
829         .ldto_init = echo_type_init,
830         .ldto_fini = echo_type_fini,
831
832         .ldto_start = echo_type_start,
833         .ldto_stop  = echo_type_stop,
834
835         .ldto_device_alloc = echo_device_alloc,
836         .ldto_device_free  = echo_device_free,
837         .ldto_device_init  = echo_device_init,
838         .ldto_device_fini  = echo_device_fini
839 };
840
841 static struct lu_device_type echo_device_type = {
842         .ldt_tags     = LU_DEVICE_CL,
843         .ldt_name     = LUSTRE_ECHO_CLIENT_NAME,
844         .ldt_ops      = &echo_device_type_ops,
845         .ldt_ctx_tags = LCT_CL_THREAD
846 };
847 /** @} echo_init */
848
849 /** \defgroup echo_exports
850  *
851  * exporting functions to echo client
852  *
853  * @{
854  */
855
856 /* Interfaces to echo client obd device */
857 static struct echo_object *cl_echo_object_find(struct echo_device *d,
858                                                struct lov_stripe_md **lsmp)
859 {
860         struct lu_env *env;
861         struct echo_thread_info *info;
862         struct echo_object_conf *conf;
863         struct lov_stripe_md    *lsm;
864         struct echo_object *eco;
865         struct cl_object   *obj;
866         struct lu_fid *fid;
867         int refcheck;
868         ENTRY;
869
870         LASSERT(lsmp);
871         lsm = *lsmp;
872         LASSERT(lsm);
873         LASSERT(lsm->lsm_object_id);
874
875         env = cl_env_get(&refcheck);
876         if (IS_ERR(env))
877                 RETURN((void *)env);
878
879         info = echo_env_info(env);
880         conf = &info->eti_conf;
881         if (d->ed_next) {
882                 if (!d->ed_next_islov) {
883                         struct lov_oinfo *oinfo = lsm->lsm_oinfo[0];
884                         LASSERT(oinfo != NULL);
885                         oinfo->loi_id = lsm->lsm_object_id;
886                         oinfo->loi_gr = lsm->lsm_object_gr;
887                         conf->eoc_cl.u.coc_oinfo = oinfo;
888                 } else {
889                         struct lustre_md *md;
890                         md = &info->eti_md;
891                         memset(md, 0, sizeof *md);
892                         md->lsm = lsm;
893                         conf->eoc_cl.u.coc_md = md;
894                 }
895         }
896         conf->eoc_md = lsmp;
897
898         fid  = &info->eti_fid;
899         lsm2fid(lsm, fid);
900
901         obj = cl_object_find(env, echo_dev2cl(d), fid, &conf->eoc_cl);
902         if (IS_ERR(obj))
903                 GOTO(out, eco = (void*)obj);
904
905         eco = cl2echo_obj(obj);
906         if (eco->eo_deleted) {
907                 cl_object_put(env, obj);
908                 eco = ERR_PTR(-EAGAIN);
909         }
910
911 out:
912         cl_env_put(env, &refcheck);
913         RETURN(eco);
914 }
915
916 static int cl_echo_object_put(struct echo_object *eco)
917 {
918         struct lu_env *env;
919         struct cl_object *obj = echo_obj2cl(eco);
920         int refcheck;
921         ENTRY;
922
923         env = cl_env_get(&refcheck);
924         if (IS_ERR(env))
925                 RETURN(PTR_ERR(env));
926
927         /* an external function to kill an object? */
928         if (eco->eo_deleted) {
929                 struct lu_object_header *loh = obj->co_lu.lo_header;
930                 LASSERT(&eco->eo_hdr == luh2coh(loh));
931                 set_bit(LU_OBJECT_HEARD_BANSHEE, &loh->loh_flags);
932                 cl_object_prune(env, obj);
933         }
934
935         cl_object_put(env, obj);
936         cl_env_put(env, &refcheck);
937         RETURN(0);
938 }
939
940 static int cl_echo_enqueue(struct echo_object *eco, obd_off start, obd_off end,
941                            int mode, __u64 *cookie)
942 {
943         struct lu_env *env;
944         struct cl_lock *lck;
945         struct echo_thread_info *info;
946         struct cl_io *io;
947         struct cl_lock_descr *descr;
948         struct cl_object *obj = echo_obj2cl(eco);
949         int refcheck;
950         int result;
951         ENTRY;
952
953         env = cl_env_get(&refcheck);
954         if (IS_ERR(env))
955                 RETURN(PTR_ERR(env));
956
957         info = echo_env_info(env);
958         descr = &info->eti_descr;
959         descr->cld_obj   = obj;
960         descr->cld_start = cl_index(obj, start);
961         descr->cld_end   = cl_index(obj, end);
962         descr->cld_mode  = mode == LCK_PW ? CLM_WRITE : CLM_READ;
963
964         io = &info->eti_io;
965         io->ci_obj = obj;
966         result = cl_io_init(env, io, CIT_MISC, obj);
967         if (result < 0)
968                 GOTO(out, result);
969         LASSERT(result == 0);
970
971         result = -ENOMEM;
972         lck = cl_lock_request(env, io, descr, CEF_ASYNC, "ec enqueue", eco);
973         if (lck) {
974                 struct echo_client_obd *ec = eco->eo_dev->ed_ec;
975                 struct echo_lock *el;
976
977                 result = cl_wait(env, lck);
978                 if (result == 0) {
979                         el = cl2echo_lock(cl_lock_at(lck, &echo_device_type));
980                         spin_lock(&ec->ec_lock);
981                         list_add(&el->el_chain, &ec->ec_locks);
982                         *cookie = el->el_cookie = ++ec->ec_unique;
983                         spin_unlock(&ec->ec_lock);
984                 } else
985                         cl_lock_release(env, lck, "ec enqueue", cfs_current());
986         }
987         cl_io_fini(env, io);
988
989         EXIT;
990 out:
991         cl_env_put(env, &refcheck);
992         return result;
993 }
994
995 static int cl_echo_cancel(struct echo_device *ed, __u64 cookie)
996 {
997         struct echo_client_obd *ec = ed->ed_ec;
998         struct echo_lock       *ecl = NULL;
999         struct list_head       *el;
1000         int found = 0;
1001         int result;
1002
1003         struct lu_env *env;
1004         int refcheck;
1005         ENTRY;
1006
1007         env = cl_env_get(&refcheck);
1008         if (IS_ERR(env))
1009                 RETURN(PTR_ERR(env));
1010
1011         spin_lock (&ec->ec_lock);
1012         list_for_each (el, &ec->ec_locks) {
1013                 ecl = list_entry (el, struct echo_lock, el_chain);
1014                 CDEBUG(D_INFO, "ecl: %p, cookie: %llx\n", ecl, ecl->el_cookie);
1015                 found = (ecl->el_cookie == cookie);
1016                 if (found) {
1017                         list_del_init(&ecl->el_chain);
1018                         break;
1019                 }
1020         }
1021         spin_unlock (&ec->ec_lock);
1022
1023         result = -ENOENT;
1024         if (found) {
1025                 struct cl_lock *clk = echo_lock2cl(ecl);
1026
1027                 cl_lock_get(clk);
1028                 cl_unuse(env, clk);
1029                 cl_lock_release(env, clk, "ec enqueue", ecl->el_object);
1030
1031                 cl_lock_mutex_get(env, clk);
1032                 cl_lock_cancel(env, clk);
1033                 cl_lock_delete(env, clk);
1034                 cl_lock_mutex_put(env, clk);
1035                 cl_lock_put(env, clk);
1036                 result = 0;
1037         }
1038         cl_env_put(env, &refcheck);
1039         RETURN(result);
1040 }
1041
1042 static int cl_echo_async_brw(const struct lu_env *env, struct cl_io *io,
1043                              enum cl_req_type unused, struct cl_2queue *queue)
1044 {
1045         struct cl_page *clp;
1046         struct cl_page *temp;
1047         int result = 0;
1048         ENTRY;
1049
1050         cl_page_list_for_each_safe(clp, temp, &queue->c2_qin) {
1051                 int rc;
1052                 rc = cl_page_cache_add(env, io, clp, CRT_WRITE);
1053                 if (rc == 0)
1054                         continue;
1055                 result = result ?: rc;
1056         }
1057         RETURN(result);
1058 }
1059
1060 static int cl_echo_object_brw(struct echo_object *eco, int rw, obd_off offset,
1061                               cfs_page_t **pages, int npages, int async)
1062 {
1063         struct lu_env           *env;
1064         struct echo_thread_info *info;
1065         struct cl_object        *obj = echo_obj2cl(eco);
1066         struct echo_device      *ed  = eco->eo_dev;
1067         struct cl_2queue        *queue;
1068         struct cl_io            *io;
1069         struct cl_page          *clp;
1070
1071         int page_size = cl_page_size(obj);
1072         int refcheck;
1073         int rc;
1074         int i;
1075         ENTRY;
1076
1077         LASSERT(ed->ed_next != NULL);
1078         env = cl_env_get(&refcheck);
1079         if (IS_ERR(env))
1080                 RETURN(PTR_ERR(env));
1081
1082         info    = echo_env_info(env);
1083         io      = &info->eti_io;
1084         queue   = &info->eti_queue;
1085
1086         cl_2queue_init(queue);
1087         rc = cl_io_init(env, io, CIT_MISC, obj);
1088         if (rc < 0)
1089                 GOTO(out, rc);
1090         LASSERT(rc == 0);
1091
1092         for (i = 0; i < npages; i++) {
1093                 LASSERT(pages[i]);
1094                 clp = cl_page_find(env, obj, cl_index(obj, offset),
1095                                    pages[i], CPT_TRANSIENT);
1096                 if (IS_ERR(clp)) {
1097                         rc = PTR_ERR(clp);
1098                         break;
1099                 }
1100                 LASSERT(clp->cp_type == CPT_TRANSIENT);
1101
1102                 rc = cl_page_own(env, io, clp);
1103                 if (rc) {
1104                         LASSERT(clp->cp_state == CPS_FREEING);
1105                         cl_page_put(env, clp);
1106                         break;
1107                 }
1108
1109                 cl_2queue_add(queue, clp);
1110
1111                 /* drop the reference count for cl_page_find, so that the page
1112                  * will be freed in cl_2queue_fini. */
1113                 cl_page_put(env, clp);
1114                 offset += page_size;
1115         }
1116
1117         if (rc == 0) {
1118                 enum cl_req_type typ = rw == READ ? CRT_READ : CRT_WRITE;
1119
1120                 async = async && (typ == CRT_WRITE);
1121                 if (async)
1122                         rc = cl_echo_async_brw(env, io, typ, queue);
1123                 else
1124                         rc = cl_io_submit_sync(env, io, typ, queue,
1125                                                CRP_NORMAL, 0);
1126                 CDEBUG(D_INFO, "echo_client %s write returns %d\n",
1127                        async ? "async" : "sync", rc);
1128         }
1129
1130         cl_2queue_discard(env, io, queue);
1131         cl_2queue_disown(env, io, queue);
1132         cl_2queue_fini(env, queue);
1133         cl_io_fini(env, io);
1134
1135         EXIT;
1136 out:
1137         cl_env_put(env, &refcheck);
1138         return rc;
1139 }
1140 /** @} echo_exports */
1141
1142
1143 static obd_id last_object_id;
1144
1145 static int
1146 echo_copyout_lsm (struct lov_stripe_md *lsm, void *_ulsm, int ulsm_nob)
1147 {
1148         struct lov_stripe_md *ulsm = _ulsm;
1149         int nob, i;
1150
1151         nob = offsetof (struct lov_stripe_md, lsm_oinfo[lsm->lsm_stripe_count]);
1152         if (nob > ulsm_nob)
1153                 return (-EINVAL);
1154
1155         if (copy_to_user (ulsm, lsm, sizeof(ulsm)))
1156                 return (-EFAULT);
1157
1158         for (i = 0; i < lsm->lsm_stripe_count; i++) {
1159                 if (copy_to_user (ulsm->lsm_oinfo[i], lsm->lsm_oinfo[i],
1160                                   sizeof(lsm->lsm_oinfo[0])))
1161                         return (-EFAULT);
1162         }
1163         return 0;
1164 }
1165
1166 static int
1167 echo_copyin_lsm (struct echo_device *ed, struct lov_stripe_md *lsm,
1168                  void *ulsm, int ulsm_nob)
1169 {
1170         struct echo_client_obd *ec = ed->ed_ec;
1171         int                     i;
1172
1173         if (ulsm_nob < sizeof (*lsm))
1174                 return (-EINVAL);
1175
1176         if (copy_from_user (lsm, ulsm, sizeof (*lsm)))
1177                 return (-EFAULT);
1178
1179         if (lsm->lsm_stripe_count > ec->ec_nstripes ||
1180             lsm->lsm_magic != LOV_MAGIC ||
1181             (lsm->lsm_stripe_size & (~CFS_PAGE_MASK)) != 0 ||
1182             ((__u64)lsm->lsm_stripe_size * lsm->lsm_stripe_count > ~0UL))
1183                 return (-EINVAL);
1184
1185
1186         for (i = 0; i < lsm->lsm_stripe_count; i++) {
1187                 if (copy_from_user(lsm->lsm_oinfo[i],
1188                                    ((struct lov_stripe_md *)ulsm)->lsm_oinfo[i],
1189                                    sizeof(lsm->lsm_oinfo[0])))
1190                         return (-EFAULT);
1191         }
1192         return (0);
1193 }
1194
1195 static int echo_create_object(struct echo_device *ed, int on_target,
1196                               struct obdo *oa, void *ulsm, int ulsm_nob,
1197                               struct obd_trans_info *oti)
1198 {
1199         struct echo_object     *eco;
1200         struct echo_client_obd *ec = ed->ed_ec;
1201         struct lov_stripe_md   *lsm = NULL;
1202         int                     rc;
1203         int                     created = 0;
1204         ENTRY;
1205
1206         if ((oa->o_valid & OBD_MD_FLID) == 0 && /* no obj id */
1207             (on_target ||                       /* set_stripe */
1208              ec->ec_nstripes != 0)) {           /* LOV */
1209                 CERROR ("No valid oid\n");
1210                 RETURN(-EINVAL);
1211         }
1212
1213         rc = obd_alloc_memmd(ec->ec_exp, &lsm);
1214         if (rc < 0) {
1215                 CERROR("Cannot allocate md, rc = %d\n", rc);
1216                 GOTO(failed, rc);
1217         }
1218
1219         if (ulsm != NULL) {
1220                 int i, idx;
1221
1222                 rc = echo_copyin_lsm (ed, lsm, ulsm, ulsm_nob);
1223                 if (rc != 0)
1224                         GOTO(failed, rc);
1225
1226                 if (lsm->lsm_stripe_count == 0)
1227                         lsm->lsm_stripe_count = ec->ec_nstripes;
1228
1229                 if (lsm->lsm_stripe_size == 0)
1230                         lsm->lsm_stripe_size = CFS_PAGE_SIZE;
1231
1232                 idx = ll_rand();
1233
1234                 /* setup stripes: indices + default ids if required */
1235                 for (i = 0; i < lsm->lsm_stripe_count; i++) {
1236                         if (lsm->lsm_oinfo[i]->loi_id == 0)
1237                                 lsm->lsm_oinfo[i]->loi_id = lsm->lsm_object_id;
1238
1239                         lsm->lsm_oinfo[i]->loi_ost_idx =
1240                                 (idx + i) % ec->ec_nstripes;
1241                 }
1242         }
1243
1244         /* setup object ID here for !on_target and LOV hint */
1245         if (oa->o_valid & OBD_MD_FLID)
1246                 lsm->lsm_object_id = oa->o_id;
1247
1248         if (lsm->lsm_object_id == 0)
1249                 lsm->lsm_object_id = ++last_object_id;
1250
1251         rc = 0;
1252         if (on_target) {
1253                 oa->o_gr = FILTER_GROUP_ECHO;
1254                 oa->o_valid |= OBD_MD_FLGROUP;
1255
1256                 rc = obd_create(ec->ec_exp, oa, &lsm, oti);
1257                 if (rc != 0) {
1258                         CERROR("Cannot create objects, rc = %d\n", rc);
1259                         GOTO(failed, rc);
1260                 }
1261                 created = 1;
1262         }
1263
1264         /* See what object ID we were given */
1265         oa->o_id = lsm->lsm_object_id;
1266         oa->o_valid |= OBD_MD_FLID;
1267
1268         eco = cl_echo_object_find(ed, &lsm);
1269         if (IS_ERR(eco))
1270                 GOTO(failed, rc = PTR_ERR(eco));
1271         cl_echo_object_put(eco);
1272
1273         CDEBUG(D_INFO, "oa->o_id = %lx\n", (long)oa->o_id);
1274         EXIT;
1275
1276  failed:
1277         if (created && rc)
1278                 obd_destroy(ec->ec_exp, oa, lsm, oti, NULL, NULL);
1279         if (lsm)
1280                 obd_free_memmd(ec->ec_exp, &lsm);
1281         if (rc)
1282                 CERROR("create object failed with rc = %d\n", rc);
1283         return (rc);
1284 }
1285
1286 static int echo_get_object(struct echo_object **ecop, struct echo_device *ed,
1287                            struct obdo *oa)
1288 {
1289         struct echo_client_obd *ec  = ed->ed_ec;
1290         struct lov_stripe_md   *lsm = NULL;
1291         struct echo_object     *eco;
1292         int                     rc;
1293         ENTRY;
1294
1295         if ((oa->o_valid & OBD_MD_FLID) == 0 ||
1296             oa->o_id == 0)  /* disallow use of object id 0 */
1297         {
1298                 CERROR ("No valid oid\n");
1299                 RETURN(-EINVAL);
1300         }
1301
1302         rc = obd_alloc_memmd(ec->ec_exp, &lsm);
1303         if (rc < 0)
1304                 RETURN(rc);
1305
1306         lsm->lsm_object_id = oa->o_id;
1307         if (oa->o_valid & OBD_MD_FLGROUP)
1308                 lsm->lsm_object_gr = oa->o_gr;
1309         else
1310                 lsm->lsm_object_gr = FILTER_GROUP_ECHO;
1311
1312         rc = 0;
1313         eco = cl_echo_object_find(ed, &lsm);
1314         if (!IS_ERR(eco))
1315                 *ecop = eco;
1316         else
1317                 rc = PTR_ERR(eco);
1318         if (lsm)
1319                 obd_free_memmd(ec->ec_exp, &lsm);
1320         RETURN(rc);
1321 }
1322
1323 static void echo_put_object(struct echo_object *eco)
1324 {
1325         if (cl_echo_object_put(eco))
1326                 CERROR("echo client: drop an object failed");
1327 }
1328
1329 static void
1330 echo_get_stripe_off_id (struct lov_stripe_md *lsm, obd_off *offp, obd_id *idp)
1331 {
1332         unsigned long stripe_count;
1333         unsigned long stripe_size;
1334         unsigned long width;
1335         unsigned long woffset;
1336         int           stripe_index;
1337         obd_off       offset;
1338
1339         if (lsm->lsm_stripe_count <= 1)
1340                 return;
1341
1342         offset       = *offp;
1343         stripe_size  = lsm->lsm_stripe_size;
1344         stripe_count = lsm->lsm_stripe_count;
1345
1346         /* width = # bytes in all stripes */
1347         width = stripe_size * stripe_count;
1348
1349         /* woffset = offset within a width; offset = whole number of widths */
1350         woffset = do_div (offset, width);
1351
1352         stripe_index = woffset / stripe_size;
1353
1354         *idp = lsm->lsm_oinfo[stripe_index]->loi_id;
1355         *offp = offset * stripe_size + woffset % stripe_size;
1356 }
1357
1358 static void
1359 echo_client_page_debug_setup(struct lov_stripe_md *lsm,
1360                              cfs_page_t *page, int rw, obd_id id,
1361                              obd_off offset, obd_off count)
1362 {
1363         char    *addr;
1364         obd_off  stripe_off;
1365         obd_id   stripe_id;
1366         int      delta;
1367
1368         /* no partial pages on the client */
1369         LASSERT(count == CFS_PAGE_SIZE);
1370
1371         addr = cfs_kmap(page);
1372
1373         for (delta = 0; delta < CFS_PAGE_SIZE; delta += OBD_ECHO_BLOCK_SIZE) {
1374                 if (rw == OBD_BRW_WRITE) {
1375                         stripe_off = offset + delta;
1376                         stripe_id = id;
1377                         echo_get_stripe_off_id(lsm, &stripe_off, &stripe_id);
1378                 } else {
1379                         stripe_off = 0xdeadbeef00c0ffeeULL;
1380                         stripe_id = 0xdeadbeef00c0ffeeULL;
1381                 }
1382                 block_debug_setup(addr + delta, OBD_ECHO_BLOCK_SIZE,
1383                                   stripe_off, stripe_id);
1384         }
1385
1386         cfs_kunmap(page);
1387 }
1388
1389 static int echo_client_page_debug_check(struct lov_stripe_md *lsm,
1390                                         cfs_page_t *page, obd_id id,
1391                                         obd_off offset, obd_off count)
1392 {
1393         obd_off stripe_off;
1394         obd_id  stripe_id;
1395         char   *addr;
1396         int     delta;
1397         int     rc;
1398         int     rc2;
1399
1400         /* no partial pages on the client */
1401         LASSERT(count == CFS_PAGE_SIZE);
1402
1403         addr = cfs_kmap(page);
1404
1405         for (rc = delta = 0; delta < CFS_PAGE_SIZE; delta += OBD_ECHO_BLOCK_SIZE) {
1406                 stripe_off = offset + delta;
1407                 stripe_id = id;
1408                 echo_get_stripe_off_id (lsm, &stripe_off, &stripe_id);
1409
1410                 rc2 = block_debug_check("test_brw",
1411                                         addr + delta, OBD_ECHO_BLOCK_SIZE,
1412                                         stripe_off, stripe_id);
1413                 if (rc2 != 0) {
1414                         CERROR ("Error in echo object "LPX64"\n", id);
1415                         rc = rc2;
1416                 }
1417         }
1418
1419         cfs_kunmap(page);
1420         return rc;
1421 }
1422
1423 static int echo_client_kbrw(struct echo_device *ed, int rw, struct obdo *oa,
1424                             struct echo_object *eco, obd_off offset,
1425                             obd_size count, int async,
1426                             struct obd_trans_info *oti)
1427 {
1428         struct echo_client_obd *ec  = ed->ed_ec;
1429         struct lov_stripe_md   *lsm = eco->eo_lsm;
1430         obd_count               npages;
1431         struct brw_page        *pga;
1432         struct brw_page        *pgp;
1433         cfs_page_t            **pages;
1434         obd_off                 off;
1435         int                     i;
1436         int                     rc;
1437         int                     verify;
1438         int                     gfp_mask;
1439         ENTRY;
1440
1441         verify = ((oa->o_id) != ECHO_PERSISTENT_OBJID &&
1442                   (oa->o_valid & OBD_MD_FLFLAGS) != 0 &&
1443                   (oa->o_flags & OBD_FL_DEBUG_CHECK) != 0);
1444
1445         gfp_mask = ((oa->o_id & 2) == 0) ? CFS_ALLOC_STD : CFS_ALLOC_HIGHUSER;
1446
1447         LASSERT(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ);
1448         LASSERT(lsm != NULL);
1449         LASSERT(lsm->lsm_object_id == oa->o_id);
1450
1451         if (count <= 0 ||
1452             (count & (~CFS_PAGE_MASK)) != 0)
1453                 RETURN(-EINVAL);
1454
1455         /* XXX think again with misaligned I/O */
1456         npages = count >> CFS_PAGE_SHIFT;
1457
1458         OBD_ALLOC(pga, npages * sizeof(*pga));
1459         if (pga == NULL)
1460                 RETURN(-ENOMEM);
1461
1462         OBD_ALLOC(pages, npages * sizeof(*pages));
1463         if (pages == NULL) {
1464                 OBD_FREE(pga, npages * sizeof(*pga));
1465                 RETURN(-ENOMEM);
1466         }
1467
1468         for (i = 0, pgp = pga, off = offset;
1469              i < npages;
1470              i++, pgp++, off += CFS_PAGE_SIZE) {
1471
1472                 LASSERT (pgp->pg == NULL);      /* for cleanup */
1473
1474                 rc = -ENOMEM;
1475                 OBD_PAGE_ALLOC(pgp->pg, gfp_mask);
1476                 if (pgp->pg == NULL)
1477                         goto out;
1478
1479                 pages[i] = pgp->pg;
1480                 pgp->count = CFS_PAGE_SIZE;
1481                 pgp->off = off;
1482                 pgp->flag = 0;
1483
1484                 if (verify)
1485                         echo_client_page_debug_setup(lsm, pgp->pg, rw,
1486                                                      oa->o_id, off, pgp->count);
1487         }
1488
1489         if (ed->ed_next == NULL) {
1490                 struct obd_info oinfo = { { { 0 } } };
1491                 oinfo.oi_oa = oa;
1492                 oinfo.oi_md = lsm;
1493                 rc = obd_brw(rw, ec->ec_exp, &oinfo, npages, pga, oti);
1494         } else
1495                 rc = cl_echo_object_brw(eco, rw, offset, pages, npages, async);
1496
1497  out:
1498         if (rc != 0 || rw != OBD_BRW_READ)
1499                 verify = 0;
1500
1501         for (i = 0, pgp = pga; i < npages; i++, pgp++) {
1502                 if (pgp->pg == NULL)
1503                         continue;
1504
1505                 if (verify) {
1506                         int vrc;
1507                         vrc = echo_client_page_debug_check(lsm, pgp->pg, oa->o_id,
1508                                                            pgp->off, pgp->count);
1509                         if (vrc != 0 && rc == 0)
1510                                 rc = vrc;
1511                 }
1512                 OBD_PAGE_FREE(pgp->pg);
1513         }
1514         OBD_FREE(pga, npages * sizeof(*pga));
1515         OBD_FREE(pages, npages * sizeof(*pages));
1516         RETURN(rc);
1517 }
1518
1519 static int echo_client_prep_commit(struct obd_export *exp, int rw,
1520                                    struct obdo *oa, struct echo_object *eco,
1521                                    obd_off offset, obd_size count,
1522                                    obd_size batch, struct obd_trans_info *oti)
1523 {
1524         struct lov_stripe_md *lsm = eco->eo_lsm;
1525         struct obd_ioobj ioo;
1526         struct niobuf_local *lnb;
1527         struct niobuf_remote *rnb;
1528         obd_off off;
1529         obd_size npages, tot_pages;
1530         int i, ret = 0;
1531         ENTRY;
1532
1533         if (count <= 0 || (count & (~CFS_PAGE_MASK)) != 0 ||
1534             (lsm != NULL && lsm->lsm_object_id != oa->o_id))
1535                 RETURN(-EINVAL);
1536
1537         npages = batch >> CFS_PAGE_SHIFT;
1538         tot_pages = count >> CFS_PAGE_SHIFT;
1539
1540         OBD_ALLOC(lnb, npages * sizeof(struct niobuf_local));
1541         OBD_ALLOC(rnb, npages * sizeof(struct niobuf_remote));
1542
1543         if (lnb == NULL || rnb == NULL)
1544                 GOTO(out, ret = -ENOMEM);
1545
1546         obdo_to_ioobj(oa, &ioo);
1547
1548         off = offset;
1549
1550         for(; tot_pages; tot_pages -= npages) {
1551                 int lpages;
1552
1553                 if (tot_pages < npages)
1554                         npages = tot_pages;
1555
1556                 for (i = 0; i < npages; i++, off += CFS_PAGE_SIZE) {
1557                         rnb[i].offset = off;
1558                         rnb[i].len = CFS_PAGE_SIZE;
1559                 }
1560
1561                 ioo.ioo_bufcnt = npages;
1562                 oti->oti_transno = 0;
1563
1564                 lpages = npages;
1565                 ret = obd_preprw(rw, exp, oa, 1, &ioo, rnb, &lpages, lnb, oti,
1566                                  NULL);
1567                 if (ret != 0)
1568                         GOTO(out, ret);
1569                 LASSERT(lpages == npages);
1570
1571                 for (i = 0; i < lpages; i++) {
1572                         cfs_page_t *page = lnb[i].page;
1573
1574                         /* read past eof? */
1575                         if (page == NULL && lnb[i].rc == 0)
1576                                 continue;
1577
1578                         if (oa->o_id == ECHO_PERSISTENT_OBJID ||
1579                             (oa->o_valid & OBD_MD_FLFLAGS) == 0 ||
1580                             (oa->o_flags & OBD_FL_DEBUG_CHECK) == 0)
1581                                 continue;
1582
1583                         if (rw == OBD_BRW_WRITE)
1584                                 echo_client_page_debug_setup(lsm, page, rw,
1585                                                              oa->o_id,
1586                                                              rnb[i].offset,
1587                                                              rnb[i].len);
1588                         else
1589                                 echo_client_page_debug_check(lsm, page,
1590                                                              oa->o_id,
1591                                                              rnb[i].offset,
1592                                                              rnb[i].len);
1593                 }
1594
1595                 ret = obd_commitrw(rw, exp, oa, 1,&ioo,rnb,npages,lnb,oti,ret);
1596                 if (ret != 0)
1597                         GOTO(out, ret);
1598         }
1599
1600 out:
1601         if (lnb)
1602                 OBD_FREE(lnb, npages * sizeof(struct niobuf_local));
1603         if (rnb)
1604                 OBD_FREE(rnb, npages * sizeof(struct niobuf_remote));
1605         RETURN(ret);
1606 }
1607
1608 static int echo_client_brw_ioctl(int rw, struct obd_export *exp,
1609                                  struct obd_ioctl_data *data)
1610 {
1611         struct obd_device *obd = class_exp2obd(exp);
1612         struct echo_device *ed = obd2echo_dev(obd);
1613         struct echo_client_obd *ec = ed->ed_ec;
1614         struct obd_trans_info dummy_oti = { .oti_thread = NULL };
1615         struct echo_object *eco;
1616         int rc;
1617         int async = 1;
1618         ENTRY;
1619
1620         rc = echo_get_object(&eco, ed, &data->ioc_obdo1);
1621         if (rc)
1622                 RETURN(rc);
1623
1624         data->ioc_obdo1.o_valid &= ~OBD_MD_FLHANDLE;
1625         data->ioc_obdo1.o_valid |= OBD_MD_FLGROUP;
1626         data->ioc_obdo1.o_gr = FILTER_GROUP_ECHO;
1627
1628         switch((long)data->ioc_pbuf1) {
1629         case 1:
1630                 async = 0;
1631                 /* fall through */
1632         case 2:
1633                 rc = echo_client_kbrw(ed, rw, &data->ioc_obdo1,
1634                                       eco, data->ioc_offset,
1635                                       data->ioc_count, async, &dummy_oti);
1636                 break;
1637         case 3:
1638                 rc = echo_client_prep_commit(ec->ec_exp, rw, &data->ioc_obdo1,
1639                                             eco, data->ioc_offset,
1640                                             data->ioc_count, data->ioc_plen1,
1641                                             &dummy_oti);
1642                 break;
1643         default:
1644                 rc = -EINVAL;
1645         }
1646         echo_put_object(eco);
1647         RETURN(rc);
1648 }
1649
1650 static int
1651 echo_client_enqueue(struct obd_export *exp, struct obdo *oa,
1652                     int mode, obd_off offset, obd_size nob)
1653 {
1654         struct echo_device     *ed = obd2echo_dev(exp->exp_obd);
1655         struct lustre_handle   *ulh = &oa->o_handle;
1656         struct echo_object     *eco;
1657         obd_off                 end;
1658         int                     rc;
1659         ENTRY;
1660
1661         if (ed->ed_next == NULL)
1662                 RETURN(-EOPNOTSUPP);
1663
1664         if (!(mode == LCK_PR || mode == LCK_PW))
1665                 RETURN(-EINVAL);
1666
1667         if ((offset & (~CFS_PAGE_MASK)) != 0 ||
1668             (nob & (~CFS_PAGE_MASK)) != 0)
1669                 RETURN(-EINVAL);
1670
1671         rc = echo_get_object (&eco, ed, oa);
1672         if (rc != 0)
1673                 RETURN(rc);
1674
1675         end = (nob == 0) ? ((obd_off) -1) : (offset + nob - 1);
1676         rc = cl_echo_enqueue(eco, offset, end, mode, &ulh->cookie);
1677         if (rc == 0) {
1678                 oa->o_valid |= OBD_MD_FLHANDLE;
1679                 CDEBUG(D_INFO, "Cookie is %llx\n", ulh->cookie);
1680         }
1681         echo_put_object(eco);
1682         RETURN(rc);
1683 }
1684
1685 static int
1686 echo_client_cancel(struct obd_export *exp, struct obdo *oa)
1687 {
1688         struct echo_device *ed     = obd2echo_dev(exp->exp_obd);
1689         __u64               cookie = oa->o_handle.cookie;
1690
1691         if ((oa->o_valid & OBD_MD_FLHANDLE) == 0)
1692                 return -EINVAL;
1693
1694         CDEBUG(D_INFO, "Cookie is %llx\n", cookie);
1695         return cl_echo_cancel(ed, cookie);
1696 }
1697
1698 static int
1699 echo_client_iocontrol(unsigned int cmd, struct obd_export *exp,
1700                       int len, void *karg, void *uarg)
1701 {
1702         struct obd_device      *obd = exp->exp_obd;
1703         struct echo_device     *ed = obd2echo_dev(obd);
1704         struct echo_client_obd *ec = ed->ed_ec;
1705         struct echo_object     *eco;
1706         struct obd_ioctl_data  *data = karg;
1707         struct obd_trans_info   dummy_oti;
1708         struct oti_req_ack_lock *ack_lock;
1709         struct obdo            *oa;
1710         int                     rw = OBD_BRW_READ;
1711         int                     rc = 0;
1712         int                     i;
1713         ENTRY;
1714
1715         unlock_kernel();
1716
1717         memset(&dummy_oti, 0, sizeof(dummy_oti));
1718
1719         switch (cmd) {
1720         case OBD_IOC_CREATE:                    /* may create echo object */
1721                 if (!cfs_capable(CFS_CAP_SYS_ADMIN))
1722                         GOTO (out, rc = -EPERM);
1723
1724                 rc = echo_create_object (ed, 1, &data->ioc_obdo1,
1725                                          data->ioc_pbuf1, data->ioc_plen1,
1726                                          &dummy_oti);
1727                 GOTO(out, rc);
1728
1729         case OBD_IOC_DESTROY:
1730                 if (!cfs_capable(CFS_CAP_SYS_ADMIN))
1731                         GOTO (out, rc = -EPERM);
1732
1733                 rc = echo_get_object (&eco, ed, &data->ioc_obdo1);
1734                 if (rc == 0) {
1735                         oa = &data->ioc_obdo1;
1736                         oa->o_gr = FILTER_GROUP_ECHO;
1737                         oa->o_valid |= OBD_MD_FLGROUP;
1738                         rc = obd_destroy(ec->ec_exp, oa, eco->eo_lsm,
1739                                          &dummy_oti, NULL, NULL);
1740                         if (rc == 0)
1741                                 eco->eo_deleted = 1;
1742                         echo_put_object(eco);
1743                 }
1744                 GOTO(out, rc);
1745
1746         case OBD_IOC_GETATTR:
1747                 rc = echo_get_object (&eco, ed, &data->ioc_obdo1);
1748                 if (rc == 0) {
1749                         struct obd_info oinfo = { { { 0 } } };
1750                         oinfo.oi_md = eco->eo_lsm;
1751                         oinfo.oi_oa = &data->ioc_obdo1;
1752                         rc = obd_getattr(ec->ec_exp, &oinfo);
1753                         echo_put_object(eco);
1754                 }
1755                 GOTO(out, rc);
1756
1757         case OBD_IOC_SETATTR:
1758                 if (!cfs_capable(CFS_CAP_SYS_ADMIN))
1759                         GOTO (out, rc = -EPERM);
1760
1761                 rc = echo_get_object (&eco, ed, &data->ioc_obdo1);
1762                 if (rc == 0) {
1763                         struct obd_info oinfo = { { { 0 } } };
1764                         oinfo.oi_oa = &data->ioc_obdo1;
1765                         oinfo.oi_md = eco->eo_lsm;
1766
1767                         rc = obd_setattr(ec->ec_exp, &oinfo, NULL);
1768                         echo_put_object(eco);
1769                 }
1770                 GOTO(out, rc);
1771
1772         case OBD_IOC_BRW_WRITE:
1773                 if (!cfs_capable(CFS_CAP_SYS_ADMIN))
1774                         GOTO (out, rc = -EPERM);
1775
1776                 rw = OBD_BRW_WRITE;
1777                 /* fall through */
1778         case OBD_IOC_BRW_READ:
1779                 rc = echo_client_brw_ioctl(rw, exp, data);
1780                 GOTO(out, rc);
1781
1782         case ECHO_IOC_GET_STRIPE:
1783                 rc = echo_get_object(&eco, ed, &data->ioc_obdo1);
1784                 if (rc == 0) {
1785                         rc = echo_copyout_lsm(eco->eo_lsm, data->ioc_pbuf1,
1786                                               data->ioc_plen1);
1787                         echo_put_object(eco);
1788                 }
1789                 GOTO(out, rc);
1790
1791         case ECHO_IOC_SET_STRIPE:
1792                 if (!cfs_capable(CFS_CAP_SYS_ADMIN))
1793                         GOTO (out, rc = -EPERM);
1794
1795                 if (data->ioc_pbuf1 == NULL) {  /* unset */
1796                         rc = echo_get_object(&eco, ed, &data->ioc_obdo1);
1797                         if (rc == 0) {
1798                                 eco->eo_deleted = 1;
1799                                 echo_put_object(eco);
1800                         }
1801                 } else {
1802                         rc = echo_create_object(ed, 0, &data->ioc_obdo1,
1803                                                 data->ioc_pbuf1,
1804                                                 data->ioc_plen1, &dummy_oti);
1805                 }
1806                 GOTO (out, rc);
1807
1808         case ECHO_IOC_ENQUEUE:
1809                 if (!cfs_capable(CFS_CAP_SYS_ADMIN))
1810                         GOTO (out, rc = -EPERM);
1811
1812                 rc = echo_client_enqueue(exp, &data->ioc_obdo1,
1813                                          data->ioc_conn1, /* lock mode */
1814                                          data->ioc_offset,
1815                                          data->ioc_count);/*extent*/
1816                 GOTO (out, rc);
1817
1818         case ECHO_IOC_CANCEL:
1819                 rc = echo_client_cancel(exp, &data->ioc_obdo1);
1820                 GOTO (out, rc);
1821
1822         default:
1823                 CERROR ("echo_ioctl(): unrecognised ioctl %#x\n", cmd);
1824                 GOTO (out, rc = -ENOTTY);
1825         }
1826
1827         EXIT;
1828  out:
1829
1830         /* XXX this should be in a helper also called by target_send_reply */
1831         for (ack_lock = dummy_oti.oti_ack_locks, i = 0; i < 4;
1832              i++, ack_lock++) {
1833                 if (!ack_lock->mode)
1834                         break;
1835                 ldlm_lock_decref(&ack_lock->lock, ack_lock->mode);
1836         }
1837
1838         lock_kernel();
1839
1840         return rc;
1841 }
1842
1843 static int echo_client_setup(struct obd_device *obddev, struct lustre_cfg *lcfg)
1844 {
1845         struct echo_client_obd *ec = &obddev->u.echo_client;
1846         struct obd_device *tgt;
1847         struct obd_uuid echo_uuid = { "ECHO_UUID" };
1848         struct obd_connect_data *ocd = NULL;
1849         int rc;
1850         ENTRY;
1851
1852         if (lcfg->lcfg_bufcount < 2 || LUSTRE_CFG_BUFLEN(lcfg, 1) < 1) {
1853                 CERROR("requires a TARGET OBD name\n");
1854                 RETURN(-EINVAL);
1855         }
1856
1857         tgt = class_name2obd(lustre_cfg_string(lcfg, 1));
1858         if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
1859                 CERROR("device not attached or not set up (%s)\n",
1860                        lustre_cfg_string(lcfg, 1));
1861                 RETURN(-EINVAL);
1862         }
1863
1864         spin_lock_init (&ec->ec_lock);
1865         CFS_INIT_LIST_HEAD (&ec->ec_objects);
1866         CFS_INIT_LIST_HEAD (&ec->ec_locks);
1867         ec->ec_unique = 0;
1868         ec->ec_nstripes = 0;
1869
1870         OBD_ALLOC(ocd, sizeof(*ocd));
1871         if (ocd == NULL) {
1872                 CERROR("Can't alloc ocd connecting to %s\n",
1873                        lustre_cfg_string(lcfg, 1));
1874                 return -ENOMEM;
1875         }
1876
1877         ocd->ocd_connect_flags = OBD_CONNECT_VERSION | OBD_CONNECT_REQPORTAL |
1878                                  OBD_CONNECT_GRANT;
1879         ocd->ocd_version = LUSTRE_VERSION_CODE;
1880         ocd->ocd_group = FILTER_GROUP_ECHO;
1881
1882         rc = obd_connect(NULL, &ec->ec_exp, tgt, &echo_uuid, ocd, NULL);
1883
1884         OBD_FREE(ocd, sizeof(*ocd));
1885
1886         if (rc != 0) {
1887                 CERROR("fail to connect to device %s\n",
1888                        lustre_cfg_string(lcfg, 1));
1889                 return (rc);
1890         }
1891
1892         RETURN(rc);
1893 }
1894
1895 static int echo_client_cleanup(struct obd_device *obddev)
1896 {
1897         struct echo_client_obd *ec = &obddev->u.echo_client;
1898         int rc;
1899         ENTRY;
1900
1901         if (!list_empty(&obddev->obd_exports)) {
1902                 CERROR("still has clients!\n");
1903                 RETURN(-EBUSY);
1904         }
1905
1906         rc = obd_disconnect(ec->ec_exp);
1907         if (rc != 0)
1908                 CERROR("fail to disconnect device: %d\n", rc);
1909
1910         RETURN(rc);
1911 }
1912
1913 static int echo_client_connect(const struct lu_env *env,
1914                                struct obd_export **exp,
1915                                struct obd_device *src, struct obd_uuid *cluuid,
1916                                struct obd_connect_data *data, void *localdata)
1917 {
1918         int                rc;
1919         struct lustre_handle conn = { 0 };
1920
1921         ENTRY;
1922         rc = class_connect(&conn, src, cluuid);
1923         if (rc == 0) {
1924                 *exp = class_conn2export(&conn);
1925         }
1926
1927         RETURN (rc);
1928 }
1929
1930 static int echo_client_disconnect(struct obd_export *exp)
1931 {
1932 #if 0
1933         struct obd_device      *obd;
1934         struct echo_client_obd *ec;
1935         struct ec_lock         *ecl;
1936 #endif
1937         int                     rc;
1938         ENTRY;
1939
1940         if (exp == NULL)
1941                 GOTO(out, rc = -EINVAL);
1942
1943 #if 0
1944         obd = exp->exp_obd;
1945         ec = &obd->u.echo_client;
1946
1947         /* no more contention on export's lock list */
1948         while (!list_empty (&exp->exp_ec_data.eced_locks)) {
1949                 ecl = list_entry (exp->exp_ec_data.eced_locks.next,
1950                                   struct ec_lock, ecl_exp_chain);
1951                 list_del (&ecl->ecl_exp_chain);
1952
1953                 rc = obd_cancel(ec->ec_exp, ecl->ecl_object->eco_lsm,
1954                                  ecl->ecl_mode, &ecl->ecl_lock_handle);
1955
1956                 CDEBUG (D_INFO, "Cancel lock on object "LPX64" on disconnect "
1957                         "(%d)\n", ecl->ecl_object->eco_id, rc);
1958
1959                 echo_put_object (ecl->ecl_object);
1960                 OBD_FREE (ecl, sizeof (*ecl));
1961         }
1962 #endif
1963
1964         rc = class_disconnect(exp);
1965         GOTO(out, rc);
1966  out:
1967         return rc;
1968 }
1969
1970 static struct obd_ops echo_obd_ops = {
1971         .o_owner       = THIS_MODULE,
1972
1973 #if 0
1974         .o_setup       = echo_client_setup,
1975         .o_cleanup     = echo_client_cleanup,
1976 #endif
1977
1978         .o_iocontrol   = echo_client_iocontrol,
1979         .o_connect     = echo_client_connect,
1980         .o_disconnect  = echo_client_disconnect
1981 };
1982
1983 int echo_client_init(void)
1984 {
1985         struct lprocfs_static_vars lvars = { 0 };
1986         int rc;
1987
1988         lprocfs_echo_init_vars(&lvars);
1989         rc = class_register_type(&echo_obd_ops, NULL, lvars.module_vars,
1990                                  LUSTRE_ECHO_CLIENT_NAME, &echo_device_type);
1991         if (rc == 0)
1992                 lu_kmem_init(echo_caches);
1993         return rc;
1994 }
1995
1996 void echo_client_exit(void)
1997 {
1998         class_unregister_type(LUSTRE_ECHO_CLIENT_NAME);
1999         lu_kmem_fini(echo_caches);
2000 }
2001