Whamcloud - gitweb
a651f024016cd3a563469aabbba239f7990b9ce9
[fs/lustre-release.git] / lustre / fld / fld_handler.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
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
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/fld/fld_handler.c
37  *
38  * FLD (Fids Location Database)
39  *
40  * Author: Yury Umanets <umka@clusterfs.com>
41  * Author: WangDi <wangdi@clusterfs.com>
42  * Author: Pravin Shelar <pravin.shelar@sun.com>
43  */
44
45 #define DEBUG_SUBSYSTEM S_FLD
46
47 #include <libcfs/libcfs.h>
48 #include <linux/module.h>
49
50 #include <obd.h>
51 #include <obd_support.h>
52 #include <lustre_fid.h>
53 #include <lustre_fld.h>
54 #include <md_object.h>
55 #include <lustre_req_layout.h>
56 #include <lprocfs_status.h>
57 #include "fld_internal.h"
58
59 /* context key constructor/destructor: fld_key_init, fld_key_fini */
60 LU_KEY_INIT_FINI(fld, struct fld_thread_info);
61
62 /* context key: fld_thread_key */
63 /* MGS thread may create llog file causing FLD lookup */
64 LU_CONTEXT_KEY_DEFINE(fld, LCT_MD_THREAD | LCT_DT_THREAD | LCT_MG_THREAD);
65
66 int fld_server_mod_init(void)
67 {
68         LU_CONTEXT_KEY_INIT(&fld_thread_key);
69         return lu_context_key_register(&fld_thread_key);
70 }
71
72 void fld_server_mod_exit(void)
73 {
74         lu_context_key_degister(&fld_thread_key);
75 }
76
77 int fld_declare_server_create(const struct lu_env *env,
78                               struct lu_server_fld *fld,
79                               const struct lu_seq_range *range,
80                               struct thandle *th)
81 {
82         int rc;
83
84         rc = fld_declare_index_create(env, fld, range, th);
85         RETURN(rc);
86 }
87 EXPORT_SYMBOL(fld_declare_server_create);
88
89 /**
90  * Insert FLD index entry and update FLD cache.
91  *
92  * This function is called from the sequence allocator when a super-sequence
93  * is granted to a server.
94  */
95 int fld_server_create(const struct lu_env *env, struct lu_server_fld *fld,
96                       const struct lu_seq_range *range, struct thandle *th)
97 {
98         int rc;
99
100         mutex_lock(&fld->lsf_lock);
101         rc = fld_index_create(env, fld, range, th);
102         mutex_unlock(&fld->lsf_lock);
103
104         RETURN(rc);
105 }
106 EXPORT_SYMBOL(fld_server_create);
107
108 /**
109  * Extract index information from fld name like srv-fsname-MDT0000
110  **/
111 int fld_name_to_index(const char *name, __u32 *index)
112 {
113         char *dash;
114         int rc;
115         ENTRY;
116
117         CDEBUG(D_INFO, "get index from %s\n", name);
118         dash = strrchr(name, '-');
119         if (dash == NULL)
120                 RETURN(-EINVAL);
121         dash++;
122         rc = target_name2index(dash, index, NULL);
123         RETURN(rc);
124 }
125
126 /**
127  * Retrieve fldb entry from MDT0 and add to local FLDB and cache.
128  **/
129 int fld_update_from_controller(const struct lu_env *env,
130                                struct lu_server_fld *fld)
131 {
132         struct fld_thread_info    *info;
133         struct lu_seq_range       *range;
134         struct lu_seq_range_array *lsra;
135         __u32                     index;
136         struct ptlrpc_request     *req;
137         int                       rc;
138         int                       i;
139         ENTRY;
140
141         /* Update only happens during initalization, i.e. local FLDB
142          * does not exist yet */
143         if (!fld->lsf_new)
144                 RETURN(0);
145
146         rc = fld_name_to_index(fld->lsf_name, &index);
147         if (rc < 0)
148                 RETURN(rc);
149
150         /* No need update fldb for MDT0 */
151         if (index == 0)
152                 RETURN(0);
153
154         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
155         LASSERT(info != NULL);
156         range = &info->fti_lrange;
157         memset(range, 0, sizeof(*range));
158         range->lsr_index = index;
159         fld_range_set_mdt(range);
160
161         do {
162                 rc = fld_client_rpc(fld->lsf_control_exp, range, FLD_READ,
163                                     &req);
164                 if (rc != 0 && rc != -EAGAIN)
165                         GOTO(out, rc);
166
167                 LASSERT(req != NULL);
168                 lsra = (struct lu_seq_range_array *)req_capsule_server_get(
169                                           &req->rq_pill, &RMF_GENERIC_DATA);
170                 if (lsra == NULL)
171                         GOTO(out, rc = -EPROTO);
172
173                 range_array_le_to_cpu(lsra, lsra);
174                 for (i = 0; i < lsra->lsra_count; i++) {
175                         int rc1;
176
177                         if (lsra->lsra_lsr[i].lsr_flags != LU_SEQ_RANGE_MDT)
178                                 GOTO(out, rc = -EINVAL);
179
180                         if (lsra->lsra_lsr[i].lsr_index != index)
181                                 GOTO(out, rc = -EINVAL);
182
183                         rc1 = fld_insert_entry(env, fld, &lsra->lsra_lsr[i]);
184                         if (rc1 != 0)
185                                 GOTO(out, rc = rc1);
186                 }
187                 if (rc == -EAGAIN)
188                         *range = lsra->lsra_lsr[lsra->lsra_count - 1];
189         } while (rc == -EAGAIN);
190
191         fld->lsf_new = 1;
192 out:
193         if (req != NULL)
194                 ptlrpc_req_finished(req);
195
196         RETURN(rc);
197 }
198 EXPORT_SYMBOL(fld_update_from_controller);
199
200 /**
201  * Lookup sequece in local cache/fldb.
202  **/
203 int fld_local_lookup(const struct lu_env *env, struct lu_server_fld *fld,
204                      seqno_t seq, struct lu_seq_range *range)
205 {
206         struct lu_seq_range *erange;
207         struct fld_thread_info *info;
208         int rc;
209         ENTRY;
210
211         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
212         LASSERT(info != NULL);
213         erange = &info->fti_lrange;
214
215         /* Lookup it in the cache. */
216         rc = fld_cache_lookup(fld->lsf_cache, seq, erange);
217         if (rc == 0) {
218                 if (unlikely(fld_range_type(erange) != fld_range_type(range) &&
219                              !fld_range_is_any(range))) {
220                         CERROR("%s: FLD cache range "DRANGE" does not match"
221                                "requested flag %x: rc = %d\n", fld->lsf_name,
222                                PRANGE(erange), range->lsr_flags, -EIO);
223                         RETURN(-EIO);
224                 }
225                 *range = *erange;
226                 RETURN(0);
227         }
228         RETURN(rc);
229 }
230 EXPORT_SYMBOL(fld_local_lookup);
231
232 /**
233  *  Lookup MDT/OST by seq, returns a range for given seq.
234  *
235  *  If that entry is not cached in fld cache, request is sent to super
236  *  sequence controller node (MDT0). All other MDT[1...N] and client
237  *  cache fld entries, but this cache is not persistent.
238  */
239 int fld_server_lookup(const struct lu_env *env, struct lu_server_fld *fld,
240                       seqno_t seq, struct lu_seq_range *range)
241 {
242         __u32 index;
243         int rc;
244         ENTRY;
245
246         rc = fld_local_lookup(env, fld, seq, range);
247         if (likely(rc == 0))
248                 RETURN(rc);
249
250         rc = fld_name_to_index(fld->lsf_name, &index);
251         if (rc < 0)
252                 RETURN(rc);
253         else
254                 rc = 0;
255
256         if (index == 0) {
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, -EIO);
261                 RETURN(-EIO);
262         } else {
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);
266                         RETURN(-EIO);
267                 }
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.
271                  */
272                 range->lsr_start = seq;
273                 rc = fld_client_rpc(fld->lsf_control_exp,
274                                     range, FLD_QUERY, NULL);
275                 if (rc == 0)
276                         fld_cache_insert(fld->lsf_cache, range);
277         }
278         RETURN(rc);
279 }
280 EXPORT_SYMBOL(fld_server_lookup);
281
282 /**
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
285  */
286 static int fld_handle_lookup(struct tgt_session_info *tsi)
287 {
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;
293         int                     rc;
294
295         ENTRY;
296
297         in = req_capsule_client_get(tsi->tsi_pill, &RMF_FLD_MDFLD);
298         if (in == NULL)
299                 RETURN(err_serious(-EPROTO));
300
301         rc = req_capsule_server_pack(tsi->tsi_pill);
302         if (unlikely(rc != 0))
303                 RETURN(err_serious(rc));
304
305         out = req_capsule_server_get(tsi->tsi_pill, &RMF_FLD_MDFLD);
306         if (out == NULL)
307                 RETURN(err_serious(-EPROTO));
308         *out = *in;
309
310         fld = lu_site2seq(site)->ss_server_fld;
311
312         rc = fld_server_lookup(tsi->tsi_env, fld, in->lsr_start, out);
313
314         CDEBUG(D_INFO, "%s: FLD req handle: error %d (range: "DRANGE")\n",
315                fld->lsf_name, rc, PRANGE(out));
316
317         RETURN(rc);
318 }
319
320 static int fld_handle_read(struct tgt_session_info *tsi)
321 {
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;
325         void                    *data;
326         int                     rc;
327
328         ENTRY;
329
330         req_capsule_set(tsi->tsi_pill, &RQF_FLD_READ);
331
332         in = req_capsule_client_get(tsi->tsi_pill, &RMF_FLD_MDFLD);
333         if (in == NULL)
334                 RETURN(err_serious(-EPROTO));
335
336         req_capsule_set_size(tsi->tsi_pill, &RMF_GENERIC_DATA, RCL_SERVER,
337                              PAGE_CACHE_SIZE);
338
339         rc = req_capsule_server_pack(tsi->tsi_pill);
340         if (unlikely(rc != 0))
341                 RETURN(err_serious(rc));
342
343         data = req_capsule_server_get(tsi->tsi_pill, &RMF_GENERIC_DATA);
344
345         rc = fld_server_read(tsi->tsi_env, lu_site2seq(site)->ss_server_fld,
346                              in, data, PAGE_CACHE_SIZE);
347         RETURN(rc);
348 }
349
350 static int fld_handle_query(struct tgt_session_info *tsi)
351 {
352         int     rc;
353
354         ENTRY;
355
356         req_capsule_set(tsi->tsi_pill, &RQF_FLD_QUERY);
357
358         rc = fld_handle_lookup(tsi);
359
360         RETURN(rc);
361 }
362
363 /*
364  * Returns true, if fid is local to this server node.
365  *
366  * WARNING: this function is *not* guaranteed to return false if fid is
367  * remote: it makes an educated conservative guess only.
368  *
369  * fid_is_local() is supposed to be used in assertion checks only.
370  */
371 int fid_is_local(const struct lu_env *env,
372                  struct lu_site *site, const struct lu_fid *fid)
373 {
374         int result;
375         struct seq_server_site *ss_site;
376         struct lu_seq_range *range;
377         struct fld_thread_info *info;
378         ENTRY;
379
380         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
381         range = &info->fti_lrange;
382
383         result = 1; /* conservatively assume fid is local */
384         ss_site = lu_site2seq(site);
385         if (ss_site->ss_client_fld != NULL) {
386                 int rc;
387
388                 rc = fld_cache_lookup(ss_site->ss_client_fld->lcf_cache,
389                                       fid_seq(fid), range);
390                 if (rc == 0)
391                         result = (range->lsr_index == ss_site->ss_node_id);
392         }
393         return result;
394 }
395 EXPORT_SYMBOL(fid_is_local);
396
397 static void fld_server_proc_fini(struct lu_server_fld *fld);
398
399 #ifdef LPROCFS
400 static int fld_server_proc_init(struct lu_server_fld *fld)
401 {
402         int rc = 0;
403         ENTRY;
404
405         fld->lsf_proc_dir = lprocfs_register(fld->lsf_name,
406                                              fld_type_proc_dir,
407                                              fld_server_proc_list, fld);
408         if (IS_ERR(fld->lsf_proc_dir)) {
409                 rc = PTR_ERR(fld->lsf_proc_dir);
410                 RETURN(rc);
411         }
412
413         rc = lprocfs_seq_create(fld->lsf_proc_dir, "fldb", 0444,
414                                 &fld_proc_seq_fops, fld);
415         if (rc) {
416                 lprocfs_remove(&fld->lsf_proc_dir);
417                 fld->lsf_proc_dir = NULL;
418         }
419
420         RETURN(rc);
421 }
422
423 static void fld_server_proc_fini(struct lu_server_fld *fld)
424 {
425         ENTRY;
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;
430         }
431         EXIT;
432 }
433 #else
434 static int fld_server_proc_init(struct lu_server_fld *fld)
435 {
436         return 0;
437 }
438
439 static void fld_server_proc_fini(struct lu_server_fld *fld)
440 {
441         return;
442 }
443 #endif
444
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)
447 {
448         int cache_size, cache_threshold;
449         int rc;
450
451         ENTRY;
452
453         snprintf(fld->lsf_name, sizeof(fld->lsf_name), "srv-%s", prefix);
454
455         cache_size = FLD_SERVER_CACHE_SIZE / sizeof(struct fld_cache_entry);
456
457         cache_threshold = cache_size * FLD_SERVER_CACHE_THRESHOLD / 100;
458
459         mutex_init(&fld->lsf_lock);
460         fld->lsf_cache = fld_cache_init(fld->lsf_name, cache_size,
461                                         cache_threshold);
462         if (IS_ERR(fld->lsf_cache)) {
463                 rc = PTR_ERR(fld->lsf_cache);
464                 fld->lsf_cache = NULL;
465                 RETURN(rc);
466         }
467
468         rc = fld_index_init(env, fld, dt);
469         if (rc)
470                 GOTO(out_cache, rc);
471
472         rc = fld_server_proc_init(fld);
473         if (rc)
474                 GOTO(out_index, rc);
475
476         fld->lsf_control_exp = NULL;
477
478         RETURN(0);
479 out_index:
480         fld_index_fini(env, fld);
481 out_cache:
482         fld_cache_fini(fld->lsf_cache);
483         return rc;
484 }
485 EXPORT_SYMBOL(fld_server_init);
486
487 void fld_server_fini(const struct lu_env *env, struct lu_server_fld *fld)
488 {
489         ENTRY;
490
491         fld_server_proc_fini(fld);
492         fld_index_fini(env, fld);
493
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;
498         }
499
500         EXIT;
501 }
502 EXPORT_SYMBOL(fld_server_fini);
503
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),
507 };
508 EXPORT_SYMBOL(fld_handlers);