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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/fld/fld_request.c
38 * FLD (Fids Location Database)
40 * Author: Yury Umanets <umka@clusterfs.com>
43 #define DEBUG_SUBSYSTEM S_FLD
46 # include <libcfs/libcfs.h>
47 # include <linux/module.h>
48 # include <linux/math64.h>
49 #else /* __KERNEL__ */
50 # include <liblustre.h>
51 # include <libcfs/list.h>
55 #include <obd_class.h>
56 #include <obd_support.h>
57 #include <lprocfs_status.h>
58 #include <lustre_req_layout.h>
59 #include <lustre_fld.h>
60 #include <lustre_mdc.h>
61 #include "fld_internal.h"
63 static int fld_rrb_hash(struct lu_client_fld *fld,
66 LASSERT(fld->lcf_count > 0);
67 return do_div(seq, fld->lcf_count);
70 static struct lu_fld_target *
71 fld_rrb_scan(struct lu_client_fld *fld, seqno_t seq)
73 struct lu_fld_target *target;
77 /* Because almost all of special sequence located in MDT0,
78 * it should go to index 0 directly, instead of calculating
79 * hash again, and also if other MDTs is not being connected,
80 * the fld lookup requests(for seq on MDT0) should not be
81 * blocked because of other MDTs */
82 if (fid_seq_is_norm(seq))
83 hash = fld_rrb_hash(fld, seq);
88 list_for_each_entry(target, &fld->lcf_targets, ft_chain) {
89 if (target->ft_idx == hash)
94 /* It is possible the remote target(MDT) are not connected to
95 * with client yet, so we will refer this to MDT0, which should
96 * be connected during mount */
101 CERROR("%s: Can't find target by hash %d (seq "LPX64"). "
102 "Targets (%d):\n", fld->lcf_name, hash, seq,
105 list_for_each_entry(target, &fld->lcf_targets, ft_chain) {
106 const char *srv_name = target->ft_srv != NULL ?
107 target->ft_srv->lsf_name : "<null>";
108 const char *exp_name = target->ft_exp != NULL ?
109 (char *)target->ft_exp->exp_obd->obd_uuid.uuid :
112 CERROR(" exp: 0x%p (%s), srv: 0x%p (%s), idx: "LPU64"\n",
113 target->ft_exp, exp_name, target->ft_srv,
114 srv_name, target->ft_idx);
118 * If target is not found, there is logical error anyway, so here is
119 * LBUG() to catch this situation.
125 struct lu_fld_hash fld_hash[] = {
128 .fh_hash_func = fld_rrb_hash,
129 .fh_scan_func = fld_rrb_scan
136 static struct lu_fld_target *
137 fld_client_get_target(struct lu_client_fld *fld, seqno_t seq)
139 struct lu_fld_target *target;
142 LASSERT(fld->lcf_hash != NULL);
144 spin_lock(&fld->lcf_lock);
145 target = fld->lcf_hash->fh_scan_func(fld, seq);
146 spin_unlock(&fld->lcf_lock);
148 if (target != NULL) {
149 CDEBUG(D_INFO, "%s: Found target (idx "LPU64
150 ") by seq "LPX64"\n", fld->lcf_name,
151 target->ft_idx, seq);
158 * Add export to FLD. This is usually done by CMM and LMV as they are main users
161 int fld_client_add_target(struct lu_client_fld *fld,
162 struct lu_fld_target *tar)
165 struct lu_fld_target *target, *tmp;
168 LASSERT(tar != NULL);
169 name = fld_target_name(tar);
170 LASSERT(name != NULL);
171 LASSERT(tar->ft_srv != NULL || tar->ft_exp != NULL);
173 if (fld->lcf_flags != LUSTRE_FLD_INIT) {
174 CERROR("%s: Attempt to add target %s (idx "LPU64") "
175 "on fly - skip it\n", fld->lcf_name, name,
179 CDEBUG(D_INFO, "%s: Adding target %s (idx "
180 LPU64")\n", fld->lcf_name, name, tar->ft_idx);
183 OBD_ALLOC_PTR(target);
187 spin_lock(&fld->lcf_lock);
188 list_for_each_entry(tmp, &fld->lcf_targets, ft_chain) {
189 if (tmp->ft_idx == tar->ft_idx) {
190 spin_unlock(&fld->lcf_lock);
191 OBD_FREE_PTR(target);
192 CERROR("Target %s exists in FLD and known as %s:#"LPU64"\n",
193 name, fld_target_name(tmp), tmp->ft_idx);
198 target->ft_exp = tar->ft_exp;
199 if (target->ft_exp != NULL)
200 class_export_get(target->ft_exp);
201 target->ft_srv = tar->ft_srv;
202 target->ft_idx = tar->ft_idx;
204 list_add_tail(&target->ft_chain, &fld->lcf_targets);
207 spin_unlock(&fld->lcf_lock);
211 EXPORT_SYMBOL(fld_client_add_target);
213 /* Remove export from FLD */
214 int fld_client_del_target(struct lu_client_fld *fld, __u64 idx)
216 struct lu_fld_target *target, *tmp;
219 spin_lock(&fld->lcf_lock);
220 list_for_each_entry_safe(target, tmp, &fld->lcf_targets, ft_chain) {
221 if (target->ft_idx == idx) {
223 list_del(&target->ft_chain);
224 spin_unlock(&fld->lcf_lock);
226 if (target->ft_exp != NULL)
227 class_export_put(target->ft_exp);
229 OBD_FREE_PTR(target);
233 spin_unlock(&fld->lcf_lock);
236 EXPORT_SYMBOL(fld_client_del_target);
239 static int fld_client_proc_init(struct lu_client_fld *fld)
244 fld->lcf_proc_dir = lprocfs_seq_register(fld->lcf_name,
247 if (IS_ERR(fld->lcf_proc_dir)) {
248 CERROR("%s: LProcFS failed in fld-init\n",
250 rc = PTR_ERR(fld->lcf_proc_dir);
254 rc = lprocfs_seq_add_vars(fld->lcf_proc_dir,
255 fld_client_proc_list, fld);
257 CERROR("%s: Can't init FLD proc, rc %d\n",
259 GOTO(out_cleanup, rc);
265 fld_client_proc_fini(fld);
269 void fld_client_proc_fini(struct lu_client_fld *fld)
272 if (fld->lcf_proc_dir) {
273 if (!IS_ERR(fld->lcf_proc_dir))
274 lprocfs_remove(&fld->lcf_proc_dir);
275 fld->lcf_proc_dir = NULL;
280 static int fld_client_proc_init(struct lu_client_fld *fld)
285 void fld_client_proc_fini(struct lu_client_fld *fld)
291 EXPORT_SYMBOL(fld_client_proc_fini);
293 static inline int hash_is_sane(int hash)
295 return (hash >= 0 && hash < ARRAY_SIZE(fld_hash));
298 int fld_client_init(struct lu_client_fld *fld,
299 const char *prefix, int hash)
301 int cache_size, cache_threshold;
305 LASSERT(fld != NULL);
307 snprintf(fld->lcf_name, sizeof(fld->lcf_name),
310 if (!hash_is_sane(hash)) {
311 CERROR("%s: Wrong hash function %#x\n",
312 fld->lcf_name, hash);
317 spin_lock_init(&fld->lcf_lock);
318 fld->lcf_hash = &fld_hash[hash];
319 fld->lcf_flags = LUSTRE_FLD_INIT;
320 INIT_LIST_HEAD(&fld->lcf_targets);
322 cache_size = FLD_CLIENT_CACHE_SIZE /
323 sizeof(struct fld_cache_entry);
325 cache_threshold = cache_size *
326 FLD_CLIENT_CACHE_THRESHOLD / 100;
328 fld->lcf_cache = fld_cache_init(fld->lcf_name,
329 cache_size, cache_threshold);
330 if (IS_ERR(fld->lcf_cache)) {
331 rc = PTR_ERR(fld->lcf_cache);
332 fld->lcf_cache = NULL;
336 rc = fld_client_proc_init(fld);
342 fld_client_fini(fld);
344 CDEBUG(D_INFO, "%s: Using \"%s\" hash\n",
345 fld->lcf_name, fld->lcf_hash->fh_name);
348 EXPORT_SYMBOL(fld_client_init);
350 void fld_client_fini(struct lu_client_fld *fld)
352 struct lu_fld_target *target, *tmp;
355 spin_lock(&fld->lcf_lock);
356 list_for_each_entry_safe(target, tmp, &fld->lcf_targets, ft_chain) {
358 list_del(&target->ft_chain);
359 if (target->ft_exp != NULL)
360 class_export_put(target->ft_exp);
361 OBD_FREE_PTR(target);
363 spin_unlock(&fld->lcf_lock);
365 if (fld->lcf_cache != NULL) {
366 if (!IS_ERR(fld->lcf_cache))
367 fld_cache_fini(fld->lcf_cache);
368 fld->lcf_cache = NULL;
373 EXPORT_SYMBOL(fld_client_fini);
375 int fld_client_rpc(struct obd_export *exp,
376 struct lu_seq_range *range, __u32 fld_op,
377 struct ptlrpc_request **reqp)
379 struct ptlrpc_request *req = NULL;
380 struct lu_seq_range *prange;
383 struct obd_import *imp;
386 LASSERT(exp != NULL);
389 imp = class_exp2cliimp(exp);
392 req = ptlrpc_request_alloc_pack(imp, &RQF_FLD_QUERY,
393 LUSTRE_MDS_VERSION, FLD_QUERY);
397 /* XXX: only needed when talking to old server(< 2.6), it should
398 * be removed when < 2.6 server is not supported */
399 op = req_capsule_client_get(&req->rq_pill, &RMF_FLD_OPC);
402 /* For MDS_MDS seq lookup, it will always use LWP connection,
403 * but LWP will be evicted after restart, so cause the error.
404 * so we will set no_delay for seq lookup request, once the
405 * request fails because of the eviction. always retry here */
406 if (imp->imp_connect_flags_orig & OBD_CONNECT_MDS_MDS) {
407 req->rq_allow_replay = 1;
408 req->rq_no_delay = 1;
412 req = ptlrpc_request_alloc_pack(imp, &RQF_FLD_READ,
413 LUSTRE_MDS_VERSION, FLD_READ);
417 req_capsule_set_size(&req->rq_pill, &RMF_GENERIC_DATA,
418 RCL_SERVER, PAGE_CACHE_SIZE);
428 prange = req_capsule_client_get(&req->rq_pill, &RMF_FLD_MDFLD);
430 ptlrpc_request_set_replen(req);
431 req->rq_request_portal = FLD_REQUEST_PORTAL;
432 req->rq_reply_portal = MDC_REPLY_PORTAL;
433 ptlrpc_at_set_req_timeout(req);
435 obd_get_request_slot(&exp->exp_obd->u.cli);
436 rc = ptlrpc_queue_wait(req);
437 obd_put_request_slot(&exp->exp_obd->u.cli);
439 if (rc == -EWOULDBLOCK || rc == -ESHUTDOWN) {
440 /* For no_delay req(see above), EWOULDBLOCK and
441 * ESHUTDOWN means the connection is being evicted,
442 * but this seq lookup should not return error,
443 * since it would cause unecessary failure of the
444 * application, instead it should retry here */
445 ptlrpc_req_finished(req);
452 if (fld_op == FLD_QUERY) {
453 prange = req_capsule_server_get(&req->rq_pill,
456 GOTO(out_req, rc = -EFAULT);
462 if (rc != 0 || reqp == NULL) {
463 ptlrpc_req_finished(req);
473 int fld_client_lookup(struct lu_client_fld *fld, seqno_t seq, mdsno_t *mds,
474 __u32 flags, const struct lu_env *env)
476 struct lu_seq_range res = { 0 };
477 struct lu_fld_target *target;
481 fld->lcf_flags |= LUSTRE_FLD_RUN;
483 rc = fld_cache_lookup(fld->lcf_cache, seq, &res);
485 *mds = res.lsr_index;
489 /* Can not find it in the cache */
490 target = fld_client_get_target(fld, seq);
491 LASSERT(target != NULL);
493 CDEBUG(D_INFO, "%s: Lookup fld entry (seq: "LPX64") on "
494 "target %s (idx "LPU64")\n", fld->lcf_name, seq,
495 fld_target_name(target), target->ft_idx);
498 fld_range_set_type(&res, flags);
500 #if defined(__KERNEL__) && defined(HAVE_SERVER_SUPPORT)
501 if (target->ft_srv != NULL) {
502 LASSERT(env != NULL);
503 rc = fld_server_lookup(env, target->ft_srv, seq, &res);
507 rc = fld_client_rpc(target->ft_exp, &res, FLD_QUERY, NULL);
511 *mds = res.lsr_index;
512 fld_cache_insert(fld->lcf_cache, &res);
517 EXPORT_SYMBOL(fld_client_lookup);
519 void fld_client_flush(struct lu_client_fld *fld)
521 fld_cache_flush(fld->lcf_cache);
523 EXPORT_SYMBOL(fld_client_flush);
527 struct proc_dir_entry *fld_type_proc_dir;
529 static int __init fld_mod_init(void)
531 fld_type_proc_dir = lprocfs_seq_register(LUSTRE_FLD_NAME,
534 if (IS_ERR(fld_type_proc_dir))
535 return PTR_ERR(fld_type_proc_dir);
537 #ifdef HAVE_SERVER_SUPPORT
538 fld_server_mod_init();
544 static void __exit fld_mod_exit(void)
546 #ifdef HAVE_SERVER_SUPPORT
547 fld_server_mod_exit();
550 if (fld_type_proc_dir != NULL && !IS_ERR(fld_type_proc_dir)) {
551 lprocfs_remove(&fld_type_proc_dir);
552 fld_type_proc_dir = NULL;
556 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
557 MODULE_DESCRIPTION("Lustre FLD");
558 MODULE_LICENSE("GPL");
560 cfs_module(mdd, LUSTRE_VERSION_STRING, fld_mod_init, fld_mod_exit);
561 #endif /* __KERNEL__ */