4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2015, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #define DEBUG_SUBSYSTEM S_ECHO
34 #include "../../include/linux/libcfs/libcfs.h"
36 #include "../include/obd.h"
37 #include "../include/obd_support.h"
38 #include "../include/obd_class.h"
39 #include "../include/lustre_debug.h"
40 #include "../include/lprocfs_status.h"
41 #include "../include/cl_object.h"
42 #include "../include/lustre_fid.h"
43 #include "../include/lustre_acl.h"
44 #include "../include/lustre/lustre_ioctl.h"
45 #include "../include/lustre_net.h"
47 #include "echo_internal.h"
49 /** \defgroup echo_client Echo Client
54 struct cl_device ed_cl;
55 struct echo_client_obd *ed_ec;
57 struct cl_site ed_site_myself;
58 struct cl_site *ed_site;
59 struct lu_device *ed_next;
63 struct cl_object eo_cl;
64 struct cl_object_header eo_hdr;
66 struct echo_device *eo_dev;
67 struct list_head eo_obj_chain;
68 struct lov_oinfo *eo_oinfo;
73 struct echo_object_conf {
74 struct cl_object_conf eoc_cl;
75 struct lov_oinfo **eoc_oinfo;
79 struct cl_page_slice ep_cl;
84 struct cl_lock_slice el_cl;
85 struct list_head el_chain;
86 struct echo_object *el_object;
91 static int echo_client_setup(const struct lu_env *env,
92 struct obd_device *obddev,
93 struct lustre_cfg *lcfg);
94 static int echo_client_cleanup(struct obd_device *obddev);
96 /** \defgroup echo_helpers Helper functions
99 static inline struct echo_device *cl2echo_dev(const struct cl_device *dev)
101 return container_of0(dev, struct echo_device, ed_cl);
104 static inline struct cl_device *echo_dev2cl(struct echo_device *d)
109 static inline struct echo_device *obd2echo_dev(const struct obd_device *obd)
111 return cl2echo_dev(lu2cl_dev(obd->obd_lu_dev));
114 static inline struct cl_object *echo_obj2cl(struct echo_object *eco)
119 static inline struct echo_object *cl2echo_obj(const struct cl_object *o)
121 return container_of(o, struct echo_object, eo_cl);
124 static inline struct echo_page *cl2echo_page(const struct cl_page_slice *s)
126 return container_of(s, struct echo_page, ep_cl);
129 static inline struct echo_lock *cl2echo_lock(const struct cl_lock_slice *s)
131 return container_of(s, struct echo_lock, el_cl);
134 static inline struct cl_lock *echo_lock2cl(const struct echo_lock *ecl)
136 return ecl->el_cl.cls_lock;
139 static struct lu_context_key echo_thread_key;
140 static inline struct echo_thread_info *echo_env_info(const struct lu_env *env)
142 struct echo_thread_info *info;
144 info = lu_context_key_get(&env->le_ctx, &echo_thread_key);
150 struct echo_object_conf *cl2echo_conf(const struct cl_object_conf *c)
152 return container_of(c, struct echo_object_conf, eoc_cl);
155 /** @} echo_helpers */
156 static int cl_echo_object_put(struct echo_object *eco);
157 static int cl_echo_object_brw(struct echo_object *eco, int rw, u64 offset,
158 struct page **pages, int npages, int async);
160 struct echo_thread_info {
161 struct echo_object_conf eti_conf;
162 struct lustre_md eti_md;
164 struct cl_2queue eti_queue;
166 struct cl_lock eti_lock;
167 struct lu_fid eti_fid;
168 struct lu_fid eti_fid2;
171 /* No session used right now */
172 struct echo_session_info {
176 static struct kmem_cache *echo_lock_kmem;
177 static struct kmem_cache *echo_object_kmem;
178 static struct kmem_cache *echo_thread_kmem;
179 static struct kmem_cache *echo_session_kmem;
181 static struct lu_kmem_descr echo_caches[] = {
183 .ckd_cache = &echo_lock_kmem,
184 .ckd_name = "echo_lock_kmem",
185 .ckd_size = sizeof(struct echo_lock)
188 .ckd_cache = &echo_object_kmem,
189 .ckd_name = "echo_object_kmem",
190 .ckd_size = sizeof(struct echo_object)
193 .ckd_cache = &echo_thread_kmem,
194 .ckd_name = "echo_thread_kmem",
195 .ckd_size = sizeof(struct echo_thread_info)
198 .ckd_cache = &echo_session_kmem,
199 .ckd_name = "echo_session_kmem",
200 .ckd_size = sizeof(struct echo_session_info)
207 /** \defgroup echo_page Page operations
209 * Echo page operations.
213 static int echo_page_own(const struct lu_env *env,
214 const struct cl_page_slice *slice,
215 struct cl_io *io, int nonblock)
217 struct echo_page *ep = cl2echo_page(slice);
220 mutex_lock(&ep->ep_lock);
221 else if (!mutex_trylock(&ep->ep_lock))
226 static void echo_page_disown(const struct lu_env *env,
227 const struct cl_page_slice *slice,
230 struct echo_page *ep = cl2echo_page(slice);
232 LASSERT(mutex_is_locked(&ep->ep_lock));
233 mutex_unlock(&ep->ep_lock);
236 static void echo_page_discard(const struct lu_env *env,
237 const struct cl_page_slice *slice,
238 struct cl_io *unused)
240 cl_page_delete(env, slice->cpl_page);
243 static int echo_page_is_vmlocked(const struct lu_env *env,
244 const struct cl_page_slice *slice)
246 if (mutex_is_locked(&cl2echo_page(slice)->ep_lock))
251 static void echo_page_completion(const struct lu_env *env,
252 const struct cl_page_slice *slice,
255 LASSERT(slice->cpl_page->cp_sync_io);
258 static void echo_page_fini(const struct lu_env *env,
259 struct cl_page_slice *slice)
261 struct echo_object *eco = cl2echo_obj(slice->cpl_obj);
263 atomic_dec(&eco->eo_npages);
264 put_page(slice->cpl_page->cp_vmpage);
267 static int echo_page_prep(const struct lu_env *env,
268 const struct cl_page_slice *slice,
269 struct cl_io *unused)
274 static int echo_page_print(const struct lu_env *env,
275 const struct cl_page_slice *slice,
276 void *cookie, lu_printer_t printer)
278 struct echo_page *ep = cl2echo_page(slice);
280 (*printer)(env, cookie, LUSTRE_ECHO_CLIENT_NAME"-page@%p %d vm@%p\n",
281 ep, mutex_is_locked(&ep->ep_lock),
282 slice->cpl_page->cp_vmpage);
286 static const struct cl_page_operations echo_page_ops = {
287 .cpo_own = echo_page_own,
288 .cpo_disown = echo_page_disown,
289 .cpo_discard = echo_page_discard,
290 .cpo_fini = echo_page_fini,
291 .cpo_print = echo_page_print,
292 .cpo_is_vmlocked = echo_page_is_vmlocked,
295 .cpo_prep = echo_page_prep,
296 .cpo_completion = echo_page_completion,
299 .cpo_prep = echo_page_prep,
300 .cpo_completion = echo_page_completion,
307 /** \defgroup echo_lock Locking
309 * echo lock operations
313 static void echo_lock_fini(const struct lu_env *env,
314 struct cl_lock_slice *slice)
316 struct echo_lock *ecl = cl2echo_lock(slice);
318 LASSERT(list_empty(&ecl->el_chain));
319 kmem_cache_free(echo_lock_kmem, ecl);
322 static struct cl_lock_operations echo_lock_ops = {
323 .clo_fini = echo_lock_fini,
328 /** \defgroup echo_cl_ops cl_object operations
330 * operations for cl_object
334 static int echo_page_init(const struct lu_env *env, struct cl_object *obj,
335 struct cl_page *page, pgoff_t index)
337 struct echo_page *ep = cl_object_page_slice(obj, page);
338 struct echo_object *eco = cl2echo_obj(obj);
340 get_page(page->cp_vmpage);
341 mutex_init(&ep->ep_lock);
342 cl_page_slice_add(page, &ep->ep_cl, obj, index, &echo_page_ops);
343 atomic_inc(&eco->eo_npages);
347 static int echo_io_init(const struct lu_env *env, struct cl_object *obj,
353 static int echo_lock_init(const struct lu_env *env,
354 struct cl_object *obj, struct cl_lock *lock,
355 const struct cl_io *unused)
357 struct echo_lock *el;
359 el = kmem_cache_zalloc(echo_lock_kmem, GFP_NOFS);
361 cl_lock_slice_add(lock, &el->el_cl, obj, &echo_lock_ops);
362 el->el_object = cl2echo_obj(obj);
363 INIT_LIST_HEAD(&el->el_chain);
364 atomic_set(&el->el_refcount, 0);
366 return !el ? -ENOMEM : 0;
369 static int echo_conf_set(const struct lu_env *env, struct cl_object *obj,
370 const struct cl_object_conf *conf)
375 static const struct cl_object_operations echo_cl_obj_ops = {
376 .coo_page_init = echo_page_init,
377 .coo_lock_init = echo_lock_init,
378 .coo_io_init = echo_io_init,
379 .coo_conf_set = echo_conf_set
382 /** @} echo_cl_ops */
384 /** \defgroup echo_lu_ops lu_object operations
386 * operations for echo lu object.
390 static int echo_object_init(const struct lu_env *env, struct lu_object *obj,
391 const struct lu_object_conf *conf)
393 struct echo_device *ed = cl2echo_dev(lu2cl_dev(obj->lo_dev));
394 struct echo_client_obd *ec = ed->ed_ec;
395 struct echo_object *eco = cl2echo_obj(lu2cl(obj));
396 const struct cl_object_conf *cconf;
397 struct echo_object_conf *econf;
400 struct lu_object *below;
401 struct lu_device *under;
404 below = under->ld_ops->ldo_object_alloc(env, obj->lo_header,
408 lu_object_add(obj, below);
411 cconf = lu2cl_conf(conf);
412 econf = cl2echo_conf(cconf);
414 LASSERT(econf->eoc_oinfo);
416 * Transfer the oinfo pointer to eco that it won't be
419 eco->eo_oinfo = *econf->eoc_oinfo;
420 *econf->eoc_oinfo = NULL;
423 atomic_set(&eco->eo_npages, 0);
424 cl_object_page_init(lu2cl(obj), sizeof(struct echo_page));
426 spin_lock(&ec->ec_lock);
427 list_add_tail(&eco->eo_obj_chain, &ec->ec_objects);
428 spin_unlock(&ec->ec_lock);
433 static void echo_object_free(const struct lu_env *env, struct lu_object *obj)
435 struct echo_object *eco = cl2echo_obj(lu2cl(obj));
436 struct echo_client_obd *ec = eco->eo_dev->ed_ec;
438 LASSERT(atomic_read(&eco->eo_npages) == 0);
440 spin_lock(&ec->ec_lock);
441 list_del_init(&eco->eo_obj_chain);
442 spin_unlock(&ec->ec_lock);
445 lu_object_header_fini(obj->lo_header);
447 kfree(eco->eo_oinfo);
448 kmem_cache_free(echo_object_kmem, eco);
451 static int echo_object_print(const struct lu_env *env, void *cookie,
452 lu_printer_t p, const struct lu_object *o)
454 struct echo_object *obj = cl2echo_obj(lu2cl(o));
456 return (*p)(env, cookie, "echoclient-object@%p", obj);
459 static const struct lu_object_operations echo_lu_obj_ops = {
460 .loo_object_init = echo_object_init,
461 .loo_object_delete = NULL,
462 .loo_object_release = NULL,
463 .loo_object_free = echo_object_free,
464 .loo_object_print = echo_object_print,
465 .loo_object_invariant = NULL
468 /** @} echo_lu_ops */
470 /** \defgroup echo_lu_dev_ops lu_device operations
472 * Operations for echo lu device.
476 static struct lu_object *echo_object_alloc(const struct lu_env *env,
477 const struct lu_object_header *hdr,
478 struct lu_device *dev)
480 struct echo_object *eco;
481 struct lu_object *obj = NULL;
483 /* we're the top dev. */
485 eco = kmem_cache_zalloc(echo_object_kmem, GFP_NOFS);
487 struct cl_object_header *hdr = &eco->eo_hdr;
489 obj = &echo_obj2cl(eco)->co_lu;
490 cl_object_header_init(hdr);
491 hdr->coh_page_bufsize = cfs_size_round(sizeof(struct cl_page));
493 lu_object_init(obj, &hdr->coh_lu, dev);
494 lu_object_add_top(&hdr->coh_lu, obj);
496 eco->eo_cl.co_ops = &echo_cl_obj_ops;
497 obj->lo_ops = &echo_lu_obj_ops;
502 static const struct lu_device_operations echo_device_lu_ops = {
503 .ldo_object_alloc = echo_object_alloc,
506 /** @} echo_lu_dev_ops */
508 static const struct cl_device_operations echo_device_cl_ops = {
511 /** \defgroup echo_init Setup and teardown
513 * Init and fini functions for echo client.
517 static int echo_site_init(const struct lu_env *env, struct echo_device *ed)
519 struct cl_site *site = &ed->ed_site_myself;
522 /* initialize site */
523 rc = cl_site_init(site, &ed->ed_cl);
525 CERROR("Cannot initialize site for echo client(%d)\n", rc);
529 rc = lu_site_init_finish(&site->cs_lu);
537 static void echo_site_fini(const struct lu_env *env, struct echo_device *ed)
540 cl_site_fini(ed->ed_site);
545 static void *echo_thread_key_init(const struct lu_context *ctx,
546 struct lu_context_key *key)
548 struct echo_thread_info *info;
550 info = kmem_cache_zalloc(echo_thread_kmem, GFP_NOFS);
552 info = ERR_PTR(-ENOMEM);
556 static void echo_thread_key_fini(const struct lu_context *ctx,
557 struct lu_context_key *key, void *data)
559 struct echo_thread_info *info = data;
561 kmem_cache_free(echo_thread_kmem, info);
564 static void echo_thread_key_exit(const struct lu_context *ctx,
565 struct lu_context_key *key, void *data)
569 static struct lu_context_key echo_thread_key = {
570 .lct_tags = LCT_CL_THREAD,
571 .lct_init = echo_thread_key_init,
572 .lct_fini = echo_thread_key_fini,
573 .lct_exit = echo_thread_key_exit
576 static void *echo_session_key_init(const struct lu_context *ctx,
577 struct lu_context_key *key)
579 struct echo_session_info *session;
581 session = kmem_cache_zalloc(echo_session_kmem, GFP_NOFS);
583 session = ERR_PTR(-ENOMEM);
587 static void echo_session_key_fini(const struct lu_context *ctx,
588 struct lu_context_key *key, void *data)
590 struct echo_session_info *session = data;
592 kmem_cache_free(echo_session_kmem, session);
595 static void echo_session_key_exit(const struct lu_context *ctx,
596 struct lu_context_key *key, void *data)
600 static struct lu_context_key echo_session_key = {
601 .lct_tags = LCT_SESSION,
602 .lct_init = echo_session_key_init,
603 .lct_fini = echo_session_key_fini,
604 .lct_exit = echo_session_key_exit
607 LU_TYPE_INIT_FINI(echo, &echo_thread_key, &echo_session_key);
609 static struct lu_device *echo_device_alloc(const struct lu_env *env,
610 struct lu_device_type *t,
611 struct lustre_cfg *cfg)
613 struct lu_device *next;
614 struct echo_device *ed;
615 struct cl_device *cd;
616 struct obd_device *obd = NULL; /* to keep compiler happy */
617 struct obd_device *tgt;
618 const char *tgt_type_name;
621 ed = kzalloc(sizeof(*ed), GFP_NOFS);
628 rc = cl_device_init(cd, t);
632 cd->cd_lu_dev.ld_ops = &echo_device_lu_ops;
633 cd->cd_ops = &echo_device_cl_ops;
635 obd = class_name2obd(lustre_cfg_string(cfg, 0));
639 tgt = class_name2obd(lustre_cfg_string(cfg, 1));
641 CERROR("Can not find tgt device %s\n",
642 lustre_cfg_string(cfg, 1));
644 goto out_device_fini;
647 next = tgt->obd_lu_dev;
648 if (!strcmp(tgt->obd_type->typ_name, LUSTRE_MDT_NAME)) {
649 CERROR("echo MDT client must be run on server\n");
651 goto out_device_fini;
654 rc = echo_site_init(env, ed);
656 goto out_device_fini;
658 rc = echo_client_setup(env, obd, cfg);
662 ed->ed_ec = &obd->u.echo_client;
664 /* if echo client is to be stacked upon ost device, the next is
665 * NULL since ost is not a clio device so far
667 if (next && !lu_device_is_cl(next))
670 tgt_type_name = tgt->obd_type->typ_name;
677 next->ld_site = &ed->ed_site->cs_lu;
678 rc = next->ld_type->ldt_ops->ldto_device_init(env, next,
679 next->ld_type->ldt_name,
685 LASSERT(strcmp(tgt_type_name, LUSTRE_OST_NAME) == 0);
689 return &cd->cd_lu_dev;
692 err = echo_client_cleanup(obd);
694 CERROR("Cleanup obd device %s error(%d)\n",
697 echo_site_fini(env, ed);
699 cl_device_fini(&ed->ed_cl);
706 static int echo_device_init(const struct lu_env *env, struct lu_device *d,
707 const char *name, struct lu_device *next)
713 static struct lu_device *echo_device_fini(const struct lu_env *env,
716 struct echo_device *ed = cl2echo_dev(lu2cl_dev(d));
717 struct lu_device *next = ed->ed_next;
720 next = next->ld_type->ldt_ops->ldto_device_fini(env, next);
724 static void echo_lock_release(const struct lu_env *env,
725 struct echo_lock *ecl,
728 struct cl_lock *clk = echo_lock2cl(ecl);
730 cl_lock_release(env, clk);
733 static struct lu_device *echo_device_free(const struct lu_env *env,
736 struct echo_device *ed = cl2echo_dev(lu2cl_dev(d));
737 struct echo_client_obd *ec = ed->ed_ec;
738 struct echo_object *eco;
739 struct lu_device *next = ed->ed_next;
741 CDEBUG(D_INFO, "echo device:%p is going to be freed, next = %p\n",
744 lu_site_purge(env, &ed->ed_site->cs_lu, -1);
746 /* check if there are objects still alive.
747 * It shouldn't have any object because lu_site_purge would cleanup
748 * all of cached objects. Anyway, probably the echo device is being
749 * parallelly accessed.
751 spin_lock(&ec->ec_lock);
752 list_for_each_entry(eco, &ec->ec_objects, eo_obj_chain)
754 spin_unlock(&ec->ec_lock);
757 lu_site_purge(env, &ed->ed_site->cs_lu, -1);
760 "Waiting for the reference of echo object to be dropped\n");
762 /* Wait for the last reference to be dropped. */
763 spin_lock(&ec->ec_lock);
764 while (!list_empty(&ec->ec_objects)) {
765 spin_unlock(&ec->ec_lock);
766 CERROR("echo_client still has objects at cleanup time, wait for 1 second\n");
767 set_current_state(TASK_UNINTERRUPTIBLE);
768 schedule_timeout(cfs_time_seconds(1));
769 lu_site_purge(env, &ed->ed_site->cs_lu, -1);
770 spin_lock(&ec->ec_lock);
772 spin_unlock(&ec->ec_lock);
774 LASSERT(list_empty(&ec->ec_locks));
776 CDEBUG(D_INFO, "No object exists, exiting...\n");
778 echo_client_cleanup(d->ld_obd);
781 next = next->ld_type->ldt_ops->ldto_device_free(env, next);
783 LASSERT(ed->ed_site == lu2cl_site(d->ld_site));
784 echo_site_fini(env, ed);
785 cl_device_fini(&ed->ed_cl);
791 static const struct lu_device_type_operations echo_device_type_ops = {
792 .ldto_init = echo_type_init,
793 .ldto_fini = echo_type_fini,
795 .ldto_start = echo_type_start,
796 .ldto_stop = echo_type_stop,
798 .ldto_device_alloc = echo_device_alloc,
799 .ldto_device_free = echo_device_free,
800 .ldto_device_init = echo_device_init,
801 .ldto_device_fini = echo_device_fini
804 static struct lu_device_type echo_device_type = {
805 .ldt_tags = LU_DEVICE_CL,
806 .ldt_name = LUSTRE_ECHO_CLIENT_NAME,
807 .ldt_ops = &echo_device_type_ops,
808 .ldt_ctx_tags = LCT_CL_THREAD,
813 /** \defgroup echo_exports Exported operations
815 * exporting functions to echo client
820 /* Interfaces to echo client obd device */
821 static struct echo_object *
822 cl_echo_object_find(struct echo_device *d, const struct ost_id *oi)
825 struct echo_thread_info *info;
826 struct echo_object_conf *conf;
827 struct lov_oinfo *oinfo = NULL;
828 struct echo_object *eco;
829 struct cl_object *obj;
834 LASSERTF(ostid_id(oi), DOSTID "\n", POSTID(oi));
835 LASSERTF(ostid_seq(oi) == FID_SEQ_ECHO, DOSTID "\n", POSTID(oi));
837 /* Never return an object if the obd is to be freed. */
838 if (echo_dev2cl(d)->cd_lu_dev.ld_obd->obd_stopping)
839 return ERR_PTR(-ENODEV);
841 env = cl_env_get(&refcheck);
845 info = echo_env_info(env);
846 conf = &info->eti_conf;
848 oinfo = kzalloc(sizeof(*oinfo), GFP_NOFS);
850 eco = ERR_PTR(-ENOMEM);
855 conf->eoc_cl.u.coc_oinfo = oinfo;
859 * If echo_object_init() is successful then ownership of oinfo
860 * is transferred to the object.
862 conf->eoc_oinfo = &oinfo;
864 fid = &info->eti_fid;
865 rc = ostid_to_fid(fid, (struct ost_id *)oi, 0);
871 /* In the function below, .hs_keycmp resolves to
872 * lu_obj_hop_keycmp()
874 /* coverity[overrun-buffer-val] */
875 obj = cl_object_find(env, echo_dev2cl(d), fid, &conf->eoc_cl);
881 eco = cl2echo_obj(obj);
882 if (eco->eo_deleted) {
883 cl_object_put(env, obj);
884 eco = ERR_PTR(-EAGAIN);
889 cl_env_put(env, &refcheck);
893 static int cl_echo_object_put(struct echo_object *eco)
896 struct cl_object *obj = echo_obj2cl(eco);
899 env = cl_env_get(&refcheck);
903 /* an external function to kill an object? */
904 if (eco->eo_deleted) {
905 struct lu_object_header *loh = obj->co_lu.lo_header;
907 LASSERT(&eco->eo_hdr == luh2coh(loh));
908 set_bit(LU_OBJECT_HEARD_BANSHEE, &loh->loh_flags);
911 cl_object_put(env, obj);
912 cl_env_put(env, &refcheck);
916 static int cl_echo_enqueue0(struct lu_env *env, struct echo_object *eco,
917 u64 start, u64 end, int mode,
918 __u64 *cookie, __u32 enqflags)
922 struct cl_object *obj;
923 struct cl_lock_descr *descr;
924 struct echo_thread_info *info;
927 info = echo_env_info(env);
929 lck = &info->eti_lock;
930 obj = echo_obj2cl(eco);
932 memset(lck, 0, sizeof(*lck));
933 descr = &lck->cll_descr;
934 descr->cld_obj = obj;
935 descr->cld_start = cl_index(obj, start);
936 descr->cld_end = cl_index(obj, end);
937 descr->cld_mode = mode == LCK_PW ? CLM_WRITE : CLM_READ;
938 descr->cld_enq_flags = enqflags;
941 rc = cl_lock_request(env, io, lck);
943 struct echo_client_obd *ec = eco->eo_dev->ed_ec;
944 struct echo_lock *el;
946 el = cl2echo_lock(cl_lock_at(lck, &echo_device_type));
947 spin_lock(&ec->ec_lock);
948 if (list_empty(&el->el_chain)) {
949 list_add(&el->el_chain, &ec->ec_locks);
950 el->el_cookie = ++ec->ec_unique;
952 atomic_inc(&el->el_refcount);
953 *cookie = el->el_cookie;
954 spin_unlock(&ec->ec_lock);
959 static int cl_echo_cancel0(struct lu_env *env, struct echo_device *ed,
962 struct echo_client_obd *ec = ed->ed_ec;
963 struct echo_lock *ecl = NULL;
964 struct list_head *el;
965 int found = 0, still_used = 0;
967 spin_lock(&ec->ec_lock);
968 list_for_each(el, &ec->ec_locks) {
969 ecl = list_entry(el, struct echo_lock, el_chain);
970 CDEBUG(D_INFO, "ecl: %p, cookie: %#llx\n", ecl, ecl->el_cookie);
971 found = (ecl->el_cookie == cookie);
973 if (atomic_dec_and_test(&ecl->el_refcount))
974 list_del_init(&ecl->el_chain);
980 spin_unlock(&ec->ec_lock);
985 echo_lock_release(env, ecl, still_used);
989 static void echo_commit_callback(const struct lu_env *env, struct cl_io *io,
990 struct cl_page *page)
992 struct echo_thread_info *info;
993 struct cl_2queue *queue;
995 info = echo_env_info(env);
996 LASSERT(io == &info->eti_io);
998 queue = &info->eti_queue;
999 cl_page_list_add(&queue->c2_qout, page);
1002 static int cl_echo_object_brw(struct echo_object *eco, int rw, u64 offset,
1003 struct page **pages, int npages, int async)
1006 struct echo_thread_info *info;
1007 struct cl_object *obj = echo_obj2cl(eco);
1008 struct echo_device *ed = eco->eo_dev;
1009 struct cl_2queue *queue;
1011 struct cl_page *clp;
1012 struct lustre_handle lh = { 0 };
1013 size_t page_size = cl_page_size(obj);
1018 LASSERT((offset & ~PAGE_MASK) == 0);
1019 LASSERT(ed->ed_next);
1020 env = cl_env_get(&refcheck);
1022 return PTR_ERR(env);
1024 info = echo_env_info(env);
1026 queue = &info->eti_queue;
1028 cl_2queue_init(queue);
1030 io->ci_ignore_layout = 1;
1031 rc = cl_io_init(env, io, CIT_MISC, obj);
1036 rc = cl_echo_enqueue0(env, eco, offset,
1037 offset + npages * PAGE_SIZE - 1,
1038 rw == READ ? LCK_PR : LCK_PW, &lh.cookie,
1043 for (i = 0; i < npages; i++) {
1045 clp = cl_page_find(env, obj, cl_index(obj, offset),
1046 pages[i], CPT_TRANSIENT);
1051 LASSERT(clp->cp_type == CPT_TRANSIENT);
1053 rc = cl_page_own(env, io, clp);
1055 LASSERT(clp->cp_state == CPS_FREEING);
1056 cl_page_put(env, clp);
1060 * Add a page to the incoming page list of 2-queue.
1062 cl_page_list_add(&queue->c2_qin, clp);
1064 /* drop the reference count for cl_page_find, so that the page
1065 * will be freed in cl_2queue_fini.
1067 cl_page_put(env, clp);
1068 cl_page_clip(env, clp, 0, page_size);
1070 offset += page_size;
1074 enum cl_req_type typ = rw == READ ? CRT_READ : CRT_WRITE;
1076 async = async && (typ == CRT_WRITE);
1078 rc = cl_io_commit_async(env, io, &queue->c2_qin,
1080 echo_commit_callback);
1082 rc = cl_io_submit_sync(env, io, typ, queue, 0);
1083 CDEBUG(D_INFO, "echo_client %s write returns %d\n",
1084 async ? "async" : "sync", rc);
1087 cl_echo_cancel0(env, ed, lh.cookie);
1089 cl_2queue_discard(env, io, queue);
1090 cl_2queue_disown(env, io, queue);
1091 cl_2queue_fini(env, queue);
1092 cl_io_fini(env, io);
1094 cl_env_put(env, &refcheck);
1098 /** @} echo_exports */
1100 static u64 last_object_id;
1102 static int echo_create_object(const struct lu_env *env, struct echo_device *ed,
1103 struct obdo *oa, struct obd_trans_info *oti)
1105 struct echo_object *eco;
1106 struct echo_client_obd *ec = ed->ed_ec;
1110 if (!(oa->o_valid & OBD_MD_FLID) ||
1111 !(oa->o_valid & OBD_MD_FLGROUP) ||
1112 !fid_seq_is_echo(ostid_seq(&oa->o_oi))) {
1113 CERROR("invalid oid " DOSTID "\n", POSTID(&oa->o_oi));
1117 if (!ostid_id(&oa->o_oi))
1118 ostid_set_id(&oa->o_oi, ++last_object_id);
1120 rc = obd_create(env, ec->ec_exp, oa, oti);
1122 CERROR("Cannot create objects: rc = %d\n", rc);
1127 oa->o_valid |= OBD_MD_FLID;
1129 eco = cl_echo_object_find(ed, &oa->o_oi);
1134 cl_echo_object_put(eco);
1136 CDEBUG(D_INFO, "oa oid "DOSTID"\n", POSTID(&oa->o_oi));
1140 obd_destroy(env, ec->ec_exp, oa, oti);
1142 CERROR("create object failed with: rc = %d\n", rc);
1146 static int echo_get_object(struct echo_object **ecop, struct echo_device *ed,
1149 struct echo_object *eco;
1152 if (!(oa->o_valid & OBD_MD_FLID) || !(oa->o_valid & OBD_MD_FLGROUP) ||
1153 !ostid_id(&oa->o_oi)) {
1154 CERROR("invalid oid " DOSTID "\n", POSTID(&oa->o_oi));
1159 eco = cl_echo_object_find(ed, &oa->o_oi);
1167 static void echo_put_object(struct echo_object *eco)
1171 rc = cl_echo_object_put(eco);
1173 CERROR("%s: echo client drop an object failed: rc = %d\n",
1174 eco->eo_dev->ed_ec->ec_exp->exp_obd->obd_name, rc);
1178 echo_client_page_debug_setup(struct page *page, int rw, u64 id,
1179 u64 offset, u64 count)
1186 /* no partial pages on the client */
1187 LASSERT(count == PAGE_SIZE);
1191 for (delta = 0; delta < PAGE_SIZE; delta += OBD_ECHO_BLOCK_SIZE) {
1192 if (rw == OBD_BRW_WRITE) {
1193 stripe_off = offset + delta;
1196 stripe_off = 0xdeadbeef00c0ffeeULL;
1197 stripe_id = 0xdeadbeef00c0ffeeULL;
1199 block_debug_setup(addr + delta, OBD_ECHO_BLOCK_SIZE,
1200 stripe_off, stripe_id);
1206 static int echo_client_page_debug_check(struct page *page, u64 id,
1207 u64 offset, u64 count)
1216 /* no partial pages on the client */
1217 LASSERT(count == PAGE_SIZE);
1221 for (rc = delta = 0; delta < PAGE_SIZE; delta += OBD_ECHO_BLOCK_SIZE) {
1222 stripe_off = offset + delta;
1225 rc2 = block_debug_check("test_brw",
1226 addr + delta, OBD_ECHO_BLOCK_SIZE,
1227 stripe_off, stripe_id);
1229 CERROR("Error in echo object %#llx\n", id);
1238 static int echo_client_kbrw(struct echo_device *ed, int rw, struct obdo *oa,
1239 struct echo_object *eco, u64 offset,
1240 u64 count, int async,
1241 struct obd_trans_info *oti)
1244 struct brw_page *pga;
1245 struct brw_page *pgp;
1246 struct page **pages;
1254 verify = (ostid_id(&oa->o_oi) != ECHO_PERSISTENT_OBJID &&
1255 (oa->o_valid & OBD_MD_FLFLAGS) != 0 &&
1256 (oa->o_flags & OBD_FL_DEBUG_CHECK) != 0);
1258 gfp_mask = ((ostid_id(&oa->o_oi) & 2) == 0) ? GFP_KERNEL : GFP_HIGHUSER;
1260 LASSERT(rw == OBD_BRW_WRITE || rw == OBD_BRW_READ);
1263 (count & (~PAGE_MASK)) != 0)
1266 /* XXX think again with misaligned I/O */
1267 npages = count >> PAGE_SHIFT;
1269 if (rw == OBD_BRW_WRITE)
1270 brw_flags = OBD_BRW_ASYNC;
1272 pga = kcalloc(npages, sizeof(*pga), GFP_NOFS);
1276 pages = kcalloc(npages, sizeof(*pages), GFP_NOFS);
1282 for (i = 0, pgp = pga, off = offset;
1284 i++, pgp++, off += PAGE_SIZE) {
1285 LASSERT(!pgp->pg); /* for cleanup */
1288 pgp->pg = alloc_page(gfp_mask);
1293 pgp->count = PAGE_SIZE;
1295 pgp->flag = brw_flags;
1298 echo_client_page_debug_setup(pgp->pg, rw,
1299 ostid_id(&oa->o_oi), off,
1303 /* brw mode can only be used at client */
1304 LASSERT(ed->ed_next);
1305 rc = cl_echo_object_brw(eco, rw, offset, pages, npages, async);
1308 if (rc != 0 || rw != OBD_BRW_READ)
1311 for (i = 0, pgp = pga; i < npages; i++, pgp++) {
1318 vrc = echo_client_page_debug_check(pgp->pg,
1319 ostid_id(&oa->o_oi),
1320 pgp->off, pgp->count);
1321 if (vrc != 0 && rc == 0)
1324 __free_page(pgp->pg);
1331 static int echo_client_prep_commit(const struct lu_env *env,
1332 struct obd_export *exp, int rw,
1333 struct obdo *oa, struct echo_object *eco,
1334 u64 offset, u64 count,
1335 u64 batch, struct obd_trans_info *oti,
1338 struct obd_ioobj ioo;
1339 struct niobuf_local *lnb;
1340 struct niobuf_remote *rnb;
1342 u64 npages, tot_pages;
1343 int i, ret = 0, brw_flags = 0;
1345 if (count <= 0 || (count & (~PAGE_MASK)) != 0)
1348 npages = batch >> PAGE_SHIFT;
1349 tot_pages = count >> PAGE_SHIFT;
1351 lnb = kcalloc(npages, sizeof(struct niobuf_local), GFP_NOFS);
1352 rnb = kcalloc(npages, sizeof(struct niobuf_remote), GFP_NOFS);
1359 if (rw == OBD_BRW_WRITE && async)
1360 brw_flags |= OBD_BRW_ASYNC;
1362 obdo_to_ioobj(oa, &ioo);
1366 for (; tot_pages; tot_pages -= npages) {
1369 if (tot_pages < npages)
1372 for (i = 0; i < npages; i++, off += PAGE_SIZE) {
1373 rnb[i].rnb_offset = off;
1374 rnb[i].rnb_len = PAGE_SIZE;
1375 rnb[i].rnb_flags = brw_flags;
1378 ioo.ioo_bufcnt = npages;
1381 ret = obd_preprw(env, rw, exp, oa, 1, &ioo, rnb, &lpages,
1385 LASSERT(lpages == npages);
1387 for (i = 0; i < lpages; i++) {
1388 struct page *page = lnb[i].lnb_page;
1390 /* read past eof? */
1391 if (!page && lnb[i].lnb_rc == 0)
1395 lnb[i].lnb_flags |= OBD_BRW_ASYNC;
1397 if (ostid_id(&oa->o_oi) == ECHO_PERSISTENT_OBJID ||
1398 (oa->o_valid & OBD_MD_FLFLAGS) == 0 ||
1399 (oa->o_flags & OBD_FL_DEBUG_CHECK) == 0)
1402 if (rw == OBD_BRW_WRITE)
1403 echo_client_page_debug_setup(page, rw,
1404 ostid_id(&oa->o_oi),
1408 echo_client_page_debug_check(page,
1409 ostid_id(&oa->o_oi),
1414 ret = obd_commitrw(env, rw, exp, oa, 1, &ioo,
1415 rnb, npages, lnb, oti, ret);
1419 /* Reset oti otherwise it would confuse ldiskfs. */
1420 memset(oti, 0, sizeof(*oti));
1422 /* Reuse env context. */
1423 lu_context_exit((struct lu_context *)&env->le_ctx);
1424 lu_context_enter((struct lu_context *)&env->le_ctx);
1433 static int echo_client_brw_ioctl(const struct lu_env *env, int rw,
1434 struct obd_export *exp,
1435 struct obd_ioctl_data *data,
1436 struct obd_trans_info *dummy_oti)
1438 struct obd_device *obd = class_exp2obd(exp);
1439 struct echo_device *ed = obd2echo_dev(obd);
1440 struct echo_client_obd *ec = ed->ed_ec;
1441 struct obdo *oa = &data->ioc_obdo1;
1442 struct echo_object *eco;
1447 LASSERT(oa->o_valid & OBD_MD_FLGROUP);
1449 rc = echo_get_object(&eco, ed, oa);
1453 oa->o_valid &= ~OBD_MD_FLHANDLE;
1455 /* OFD/obdfilter works only via prep/commit */
1456 test_mode = (long)data->ioc_pbuf1;
1460 if (!ed->ed_next && test_mode != 3) {
1462 data->ioc_plen1 = data->ioc_count;
1465 /* Truncate batch size to maximum */
1466 if (data->ioc_plen1 > PTLRPC_MAX_BRW_SIZE)
1467 data->ioc_plen1 = PTLRPC_MAX_BRW_SIZE;
1469 switch (test_mode) {
1473 rc = echo_client_kbrw(ed, rw, oa,
1474 eco, data->ioc_offset,
1475 data->ioc_count, async, dummy_oti);
1478 rc = echo_client_prep_commit(env, ec->ec_exp, rw, oa,
1479 eco, data->ioc_offset,
1480 data->ioc_count, data->ioc_plen1,
1486 echo_put_object(eco);
1491 echo_client_iocontrol(unsigned int cmd, struct obd_export *exp, int len,
1492 void *karg, void __user *uarg)
1494 struct obd_device *obd = exp->exp_obd;
1495 struct echo_device *ed = obd2echo_dev(obd);
1496 struct echo_client_obd *ec = ed->ed_ec;
1497 struct echo_object *eco;
1498 struct obd_ioctl_data *data = karg;
1499 struct obd_trans_info dummy_oti;
1501 struct oti_req_ack_lock *ack_lock;
1504 int rw = OBD_BRW_READ;
1508 memset(&dummy_oti, 0, sizeof(dummy_oti));
1510 oa = &data->ioc_obdo1;
1511 if (!(oa->o_valid & OBD_MD_FLGROUP)) {
1512 oa->o_valid |= OBD_MD_FLGROUP;
1513 ostid_set_seq_echo(&oa->o_oi);
1516 /* This FID is unpacked just for validation at this point */
1517 rc = ostid_to_fid(&fid, &oa->o_oi, 0);
1521 env = kzalloc(sizeof(*env), GFP_NOFS);
1525 rc = lu_env_init(env, LCT_DT_THREAD);
1532 case OBD_IOC_CREATE: /* may create echo object */
1533 if (!capable(CFS_CAP_SYS_ADMIN)) {
1538 rc = echo_create_object(env, ed, oa, &dummy_oti);
1541 case OBD_IOC_DESTROY:
1542 if (!capable(CFS_CAP_SYS_ADMIN)) {
1547 rc = echo_get_object(&eco, ed, oa);
1549 rc = obd_destroy(env, ec->ec_exp, oa, &dummy_oti);
1551 eco->eo_deleted = 1;
1552 echo_put_object(eco);
1556 case OBD_IOC_GETATTR:
1557 rc = echo_get_object(&eco, ed, oa);
1559 struct obd_info oinfo = {
1563 rc = obd_getattr(env, ec->ec_exp, &oinfo);
1564 echo_put_object(eco);
1568 case OBD_IOC_SETATTR:
1569 if (!capable(CFS_CAP_SYS_ADMIN)) {
1574 rc = echo_get_object(&eco, ed, oa);
1576 struct obd_info oinfo = {
1580 rc = obd_setattr(env, ec->ec_exp, &oinfo, NULL);
1581 echo_put_object(eco);
1585 case OBD_IOC_BRW_WRITE:
1586 if (!capable(CFS_CAP_SYS_ADMIN)) {
1593 case OBD_IOC_BRW_READ:
1594 rc = echo_client_brw_ioctl(env, rw, exp, data, &dummy_oti);
1598 CERROR("echo_ioctl(): unrecognised ioctl %#x\n", cmd);
1607 /* XXX this should be in a helper also called by target_send_reply */
1608 for (ack_lock = dummy_oti.oti_ack_locks, i = 0; i < 4;
1610 if (!ack_lock->mode)
1612 ldlm_lock_decref(&ack_lock->lock, ack_lock->mode);
1618 static int echo_client_setup(const struct lu_env *env,
1619 struct obd_device *obddev, struct lustre_cfg *lcfg)
1621 struct echo_client_obd *ec = &obddev->u.echo_client;
1622 struct obd_device *tgt;
1623 struct obd_uuid echo_uuid = { "ECHO_UUID" };
1624 struct obd_connect_data *ocd = NULL;
1627 if (lcfg->lcfg_bufcount < 2 || LUSTRE_CFG_BUFLEN(lcfg, 1) < 1) {
1628 CERROR("requires a TARGET OBD name\n");
1632 tgt = class_name2obd(lustre_cfg_string(lcfg, 1));
1633 if (!tgt || !tgt->obd_attached || !tgt->obd_set_up) {
1634 CERROR("device not attached or not set up (%s)\n",
1635 lustre_cfg_string(lcfg, 1));
1639 spin_lock_init(&ec->ec_lock);
1640 INIT_LIST_HEAD(&ec->ec_objects);
1641 INIT_LIST_HEAD(&ec->ec_locks);
1644 ocd = kzalloc(sizeof(*ocd), GFP_NOFS);
1648 ocd->ocd_connect_flags = OBD_CONNECT_VERSION | OBD_CONNECT_REQPORTAL |
1649 OBD_CONNECT_BRW_SIZE |
1650 OBD_CONNECT_GRANT | OBD_CONNECT_FULL20 |
1651 OBD_CONNECT_64BITHASH | OBD_CONNECT_LVB_TYPE |
1653 ocd->ocd_brw_size = DT_MAX_BRW_SIZE;
1654 ocd->ocd_version = LUSTRE_VERSION_CODE;
1655 ocd->ocd_group = FID_SEQ_ECHO;
1657 rc = obd_connect(env, &ec->ec_exp, tgt, &echo_uuid, ocd, NULL);
1662 CERROR("fail to connect to device %s\n",
1663 lustre_cfg_string(lcfg, 1));
1670 static int echo_client_cleanup(struct obd_device *obddev)
1672 struct echo_client_obd *ec = &obddev->u.echo_client;
1675 if (!list_empty(&obddev->obd_exports)) {
1676 CERROR("still has clients!\n");
1680 LASSERT(atomic_read(&ec->ec_exp->exp_refcount) > 0);
1681 rc = obd_disconnect(ec->ec_exp);
1683 CERROR("fail to disconnect device: %d\n", rc);
1688 static int echo_client_connect(const struct lu_env *env,
1689 struct obd_export **exp,
1690 struct obd_device *src, struct obd_uuid *cluuid,
1691 struct obd_connect_data *data, void *localdata)
1694 struct lustre_handle conn = { 0 };
1696 rc = class_connect(&conn, src, cluuid);
1698 *exp = class_conn2export(&conn);
1704 static int echo_client_disconnect(struct obd_export *exp)
1713 rc = class_disconnect(exp);
1719 static struct obd_ops echo_client_obd_ops = {
1720 .owner = THIS_MODULE,
1721 .iocontrol = echo_client_iocontrol,
1722 .connect = echo_client_connect,
1723 .disconnect = echo_client_disconnect
1726 static int echo_client_init(void)
1730 rc = lu_kmem_init(echo_caches);
1732 rc = class_register_type(&echo_client_obd_ops, NULL,
1733 LUSTRE_ECHO_CLIENT_NAME,
1736 lu_kmem_fini(echo_caches);
1741 static void echo_client_exit(void)
1743 class_unregister_type(LUSTRE_ECHO_CLIENT_NAME);
1744 lu_kmem_fini(echo_caches);
1747 static int __init obdecho_init(void)
1749 LCONSOLE_INFO("Echo OBD driver; http://www.lustre.org/\n");
1751 LASSERT(PAGE_SIZE % OBD_ECHO_BLOCK_SIZE == 0);
1753 return echo_client_init();
1756 static void /*__exit*/ obdecho_exit(void)
1761 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
1762 MODULE_DESCRIPTION("Lustre Echo Client test driver");
1763 MODULE_VERSION(LUSTRE_VERSION_STRING);
1764 MODULE_LICENSE("GPL");
1766 module_init(obdecho_init);
1767 module_exit(obdecho_exit);
1769 /** @} echo_client */