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, 2014, 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_handler.c
38 * FLD (Fids Location Database)
40 * Author: Yury Umanets <umka@clusterfs.com>
41 * Author: WangDi <wangdi@clusterfs.com>
42 * Author: Pravin Shelar <pravin.shelar@sun.com>
45 #define DEBUG_SUBSYSTEM S_FLD
47 #include <libcfs/libcfs.h>
48 #include <linux/module.h>
51 #include <obd_support.h>
52 #include <lustre_fid.h>
53 #include <lustre_fld.h>
54 #include <lustre_req_layout.h>
55 #include <lprocfs_status.h>
56 #include "fld_internal.h"
58 /* context key constructor/destructor: fld_key_init, fld_key_fini */
59 LU_KEY_INIT_FINI(fld, struct fld_thread_info);
61 /* context key: fld_thread_key */
62 /* MGS thread may create llog file causing FLD lookup */
63 LU_CONTEXT_KEY_DEFINE(fld, LCT_MD_THREAD | LCT_DT_THREAD | LCT_MG_THREAD);
65 int fld_server_mod_init(void)
67 LU_CONTEXT_KEY_INIT(&fld_thread_key);
68 return lu_context_key_register(&fld_thread_key);
71 void fld_server_mod_exit(void)
73 lu_context_key_degister(&fld_thread_key);
76 int fld_declare_server_create(const struct lu_env *env,
77 struct lu_server_fld *fld,
78 const struct lu_seq_range *range,
83 rc = fld_declare_index_create(env, fld, range, th);
86 EXPORT_SYMBOL(fld_declare_server_create);
89 * Insert FLD index entry and update FLD cache.
91 * This function is called from the sequence allocator when a super-sequence
92 * is granted to a server.
94 int fld_server_create(const struct lu_env *env, struct lu_server_fld *fld,
95 const struct lu_seq_range *range, struct thandle *th)
99 mutex_lock(&fld->lsf_lock);
100 rc = fld_index_create(env, fld, range, th);
101 mutex_unlock(&fld->lsf_lock);
105 EXPORT_SYMBOL(fld_server_create);
108 * Extract index information from fld name like srv-fsname-MDT0000
110 int fld_name_to_index(const char *name, __u32 *index)
116 CDEBUG(D_INFO, "get index from %s\n", name);
117 dash = strrchr(name, '-');
121 rc = target_name2index(dash, index, NULL);
126 * Retrieve fldb entry from MDT0 and add to local FLDB and cache.
128 int fld_update_from_controller(const struct lu_env *env,
129 struct lu_server_fld *fld)
131 struct fld_thread_info *info;
132 struct lu_seq_range *range;
133 struct lu_seq_range_array *lsra;
135 struct ptlrpc_request *req;
140 /* Update only happens during initalization, i.e. local FLDB
141 * does not exist yet */
145 rc = fld_name_to_index(fld->lsf_name, &index);
149 /* No need update fldb for MDT0 */
153 info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
154 LASSERT(info != NULL);
155 range = &info->fti_lrange;
156 memset(range, 0, sizeof(*range));
157 range->lsr_index = index;
158 fld_range_set_mdt(range);
161 rc = fld_client_rpc(fld->lsf_control_exp, range, FLD_READ,
163 if (rc != 0 && rc != -EAGAIN)
166 LASSERT(req != NULL);
167 lsra = (struct lu_seq_range_array *)req_capsule_server_get(
168 &req->rq_pill, &RMF_GENERIC_DATA);
170 GOTO(out, rc = -EPROTO);
172 range_array_le_to_cpu(lsra, lsra);
173 for (i = 0; i < lsra->lsra_count; i++) {
176 if (lsra->lsra_lsr[i].lsr_flags != LU_SEQ_RANGE_MDT)
177 GOTO(out, rc = -EINVAL);
179 if (lsra->lsra_lsr[i].lsr_index != index)
180 GOTO(out, rc = -EINVAL);
182 mutex_lock(&fld->lsf_lock);
183 rc1 = fld_insert_entry(env, fld, &lsra->lsra_lsr[i]);
184 mutex_unlock(&fld->lsf_lock);
190 *range = lsra->lsra_lsr[lsra->lsra_count - 1];
191 } while (rc == -EAGAIN);
196 ptlrpc_req_finished(req);
200 EXPORT_SYMBOL(fld_update_from_controller);
203 * Lookup sequece in local cache/fldb.
205 int fld_local_lookup(const struct lu_env *env, struct lu_server_fld *fld,
206 u64 seq, struct lu_seq_range *range)
208 struct lu_seq_range *erange;
209 struct fld_thread_info *info;
213 info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
214 LASSERT(info != NULL);
215 erange = &info->fti_lrange;
217 /* Lookup it in the cache. */
218 rc = fld_cache_lookup(fld->lsf_cache, seq, erange);
220 if (unlikely(fld_range_type(erange) != fld_range_type(range) &&
221 !fld_range_is_any(range))) {
222 CERROR("%s: FLD cache range "DRANGE" does not match"
223 "requested flag %x: rc = %d\n", fld->lsf_name,
224 PRANGE(erange), range->lsr_flags, -EIO);
232 EXPORT_SYMBOL(fld_local_lookup);
235 * Lookup MDT/OST by seq, returns a range for given seq.
237 * If that entry is not cached in fld cache, request is sent to super
238 * sequence controller node (MDT0). All other MDT[1...N] and client
239 * cache fld entries, but this cache is not persistent.
241 int fld_server_lookup(const struct lu_env *env, struct lu_server_fld *fld,
242 u64 seq, struct lu_seq_range *range)
248 rc = fld_local_lookup(env, fld, seq, range);
252 rc = fld_name_to_index(fld->lsf_name, &index);
256 if (index == 0 && rc == LDD_F_SV_TYPE_MDT) {
257 /* On server side, all entries should be in cache.
258 * If we can not find it in cache, just return error */
259 CERROR("%s: Cannot find sequence "LPX64": rc = %d\n",
260 fld->lsf_name, seq, -ENOENT);
263 if (fld->lsf_control_exp == NULL) {
264 CERROR("%s: lookup "LPX64", but not connects to MDT0"
265 "yet: rc = %d.\n", fld->lsf_name, seq, -EIO);
268 /* send request to mdt0 i.e. super seq. controller.
269 * This is temporary solution, long term solution is fld
270 * replication on all mdt servers.
272 range->lsr_start = seq;
273 rc = fld_client_rpc(fld->lsf_control_exp,
274 range, FLD_QUERY, NULL);
276 fld_cache_insert(fld->lsf_cache, range);
280 EXPORT_SYMBOL(fld_server_lookup);
283 * All MDT server handle fld lookup operation. But only MDT0 has fld index.
284 * if entry is not found in cache we need to forward lookup request to MDT0
286 static int fld_handle_lookup(struct tgt_session_info *tsi)
288 struct obd_export *exp = tsi->tsi_exp;
289 struct lu_site *site = exp->exp_obd->obd_lu_dev->ld_site;
290 struct lu_server_fld *fld;
291 struct lu_seq_range *in;
292 struct lu_seq_range *out;
297 in = req_capsule_client_get(tsi->tsi_pill, &RMF_FLD_MDFLD);
299 RETURN(err_serious(-EPROTO));
301 rc = req_capsule_server_pack(tsi->tsi_pill);
302 if (unlikely(rc != 0))
303 RETURN(err_serious(rc));
305 out = req_capsule_server_get(tsi->tsi_pill, &RMF_FLD_MDFLD);
307 RETURN(err_serious(-EPROTO));
310 fld = lu_site2seq(site)->ss_server_fld;
312 rc = fld_server_lookup(tsi->tsi_env, fld, in->lsr_start, out);
314 CDEBUG(D_INFO, "%s: FLD req handle: error %d (range: "DRANGE")\n",
315 fld->lsf_name, rc, PRANGE(out));
320 static int fld_handle_read(struct tgt_session_info *tsi)
322 struct obd_export *exp = tsi->tsi_exp;
323 struct lu_site *site = exp->exp_obd->obd_lu_dev->ld_site;
324 struct lu_seq_range *in;
330 req_capsule_set(tsi->tsi_pill, &RQF_FLD_READ);
332 in = req_capsule_client_get(tsi->tsi_pill, &RMF_FLD_MDFLD);
334 RETURN(err_serious(-EPROTO));
336 req_capsule_set_size(tsi->tsi_pill, &RMF_GENERIC_DATA, RCL_SERVER,
339 rc = req_capsule_server_pack(tsi->tsi_pill);
340 if (unlikely(rc != 0))
341 RETURN(err_serious(rc));
343 data = req_capsule_server_get(tsi->tsi_pill, &RMF_GENERIC_DATA);
345 rc = fld_server_read(tsi->tsi_env, lu_site2seq(site)->ss_server_fld,
346 in, data, PAGE_CACHE_SIZE);
350 static int fld_handle_query(struct tgt_session_info *tsi)
356 req_capsule_set(tsi->tsi_pill, &RQF_FLD_QUERY);
358 rc = fld_handle_lookup(tsi);
364 * Returns true, if fid is local to this server node.
366 * WARNING: this function is *not* guaranteed to return false if fid is
367 * remote: it makes an educated conservative guess only.
369 * fid_is_local() is supposed to be used in assertion checks only.
371 int fid_is_local(const struct lu_env *env,
372 struct lu_site *site, const struct lu_fid *fid)
375 struct seq_server_site *ss_site;
376 struct lu_seq_range *range;
377 struct fld_thread_info *info;
380 info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
381 range = &info->fti_lrange;
383 result = 1; /* conservatively assume fid is local */
384 ss_site = lu_site2seq(site);
385 if (ss_site->ss_client_fld != NULL) {
388 rc = fld_cache_lookup(ss_site->ss_client_fld->lcf_cache,
389 fid_seq(fid), range);
391 result = (range->lsr_index == ss_site->ss_node_id);
395 EXPORT_SYMBOL(fid_is_local);
397 static void fld_server_proc_fini(struct lu_server_fld *fld);
400 static int fld_server_proc_init(struct lu_server_fld *fld)
405 fld->lsf_proc_dir = lprocfs_seq_register(fld->lsf_name,
407 fld_server_proc_list, fld);
408 if (IS_ERR(fld->lsf_proc_dir)) {
409 rc = PTR_ERR(fld->lsf_proc_dir);
413 rc = lprocfs_seq_create(fld->lsf_proc_dir, "fldb", 0444,
414 &fld_proc_seq_fops, fld);
416 lprocfs_remove(&fld->lsf_proc_dir);
417 fld->lsf_proc_dir = NULL;
423 static void fld_server_proc_fini(struct lu_server_fld *fld)
426 if (fld->lsf_proc_dir != NULL) {
427 if (!IS_ERR(fld->lsf_proc_dir))
428 lprocfs_remove(&fld->lsf_proc_dir);
429 fld->lsf_proc_dir = NULL;
434 static int fld_server_proc_init(struct lu_server_fld *fld)
439 static void fld_server_proc_fini(struct lu_server_fld *fld)
445 int fld_server_init(const struct lu_env *env, struct lu_server_fld *fld,
446 struct dt_device *dt, const char *prefix, int type)
448 int cache_size, cache_threshold;
453 snprintf(fld->lsf_name, sizeof(fld->lsf_name), "srv-%s", prefix);
455 cache_size = FLD_SERVER_CACHE_SIZE / sizeof(struct fld_cache_entry);
457 cache_threshold = cache_size * FLD_SERVER_CACHE_THRESHOLD / 100;
459 mutex_init(&fld->lsf_lock);
460 fld->lsf_cache = fld_cache_init(fld->lsf_name, cache_size,
462 if (IS_ERR(fld->lsf_cache)) {
463 rc = PTR_ERR(fld->lsf_cache);
464 fld->lsf_cache = NULL;
468 rc = fld_index_init(env, fld, dt, type);
472 rc = fld_server_proc_init(fld);
476 fld->lsf_control_exp = NULL;
480 fld_index_fini(env, fld);
482 fld_cache_fini(fld->lsf_cache);
485 EXPORT_SYMBOL(fld_server_init);
487 void fld_server_fini(const struct lu_env *env, struct lu_server_fld *fld)
491 fld_server_proc_fini(fld);
492 fld_index_fini(env, fld);
494 if (fld->lsf_cache != NULL) {
495 if (!IS_ERR(fld->lsf_cache))
496 fld_cache_fini(fld->lsf_cache);
497 fld->lsf_cache = NULL;
502 EXPORT_SYMBOL(fld_server_fini);
504 struct tgt_handler fld_handlers[] = {
505 TGT_FLD_HDL_VAR(0, FLD_QUERY, fld_handle_query),
506 TGT_FLD_HDL_VAR(0, FLD_READ, fld_handle_read),
508 EXPORT_SYMBOL(fld_handlers);