lustre/fld/fld_request.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_request.c
  37  *
  38  * FLD (Fids Location Database)
  39  *
  40  * Author: Yury Umanets <umka@clusterfs.com>
  41  */
  42
  43 #define DEBUG_SUBSYSTEM S_FLD
  44
  45 #ifdef __KERNEL__
  46 # include <libcfs/libcfs.h>
  47 # include <linux/module.h>
  48 # include <asm/div64.h>
  49 #else /* __KERNEL__ */
  50 # include <liblustre.h>
  51 # include <libcfs/list.h>
  52 #endif
  53
  54 #include <obd.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"
  62
  63 /* TODO: these 3 functions are copies of flow-control code from mdc_lib.c
  64  * It should be common thing. The same about mdc RPC lock */
  65 static int fld_req_avail(struct client_obd *cli, struct mdc_cache_waiter *mcw)
  66 {
  67         int rc;
  68         ENTRY;
  69         client_obd_list_lock(&cli->cl_loi_list_lock);
  70         rc = cfs_list_empty(&mcw->mcw_entry);
  71         client_obd_list_unlock(&cli->cl_loi_list_lock);
  72         RETURN(rc);
  73 };
  74
  75 static void fld_enter_request(struct client_obd *cli)
  76 {
  77         struct mdc_cache_waiter mcw;
  78         struct l_wait_info lwi = { 0 };
  79
  80         client_obd_list_lock(&cli->cl_loi_list_lock);
  81         if (cli->cl_r_in_flight >= cli->cl_max_rpcs_in_flight) {
  82                 cfs_list_add_tail(&mcw.mcw_entry, &cli->cl_cache_waiters);
  83                 init_waitqueue_head(&mcw.mcw_waitq);
  84                 client_obd_list_unlock(&cli->cl_loi_list_lock);
  85                 l_wait_event(mcw.mcw_waitq, fld_req_avail(cli, &mcw), &lwi);
  86         } else {
  87                 cli->cl_r_in_flight++;
  88                 client_obd_list_unlock(&cli->cl_loi_list_lock);
  89         }
  90 }
  91
  92 static void fld_exit_request(struct client_obd *cli)
  93 {
  94         cfs_list_t *l, *tmp;
  95         struct mdc_cache_waiter *mcw;
  96
  97         client_obd_list_lock(&cli->cl_loi_list_lock);
  98         cli->cl_r_in_flight--;
  99         cfs_list_for_each_safe(l, tmp, &cli->cl_cache_waiters) {
 100
 101                 if (cli->cl_r_in_flight >= cli->cl_max_rpcs_in_flight) {
 102                         /* No free request slots anymore */
 103                         break;
 104                 }
 105
 106                 mcw = cfs_list_entry(l, struct mdc_cache_waiter, mcw_entry);
 107                 cfs_list_del_init(&mcw->mcw_entry);
 108                 cli->cl_r_in_flight++;
 109                 wake_up(&mcw->mcw_waitq);
 110         }
 111         client_obd_list_unlock(&cli->cl_loi_list_lock);
 112 }
 113
 114 static int fld_rrb_hash(struct lu_client_fld *fld,
 115                         seqno_t seq)
 116 {
 117         LASSERT(fld->lcf_count > 0);
 118         return do_div(seq, fld->lcf_count);
 119 }
 120
 121 static struct lu_fld_target *
 122 fld_rrb_scan(struct lu_client_fld *fld, seqno_t seq)
 123 {
 124         struct lu_fld_target *target;
 125         int hash;
 126         ENTRY;
 127
 128         /* Because almost all of special sequence located in MDT0,
 129          * it should go to index 0 directly, instead of calculating
 130          * hash again, and also if other MDTs is not being connected,
 131          * the fld lookup requests(for seq on MDT0) should not be
 132          * blocked because of other MDTs */
 133         if (fid_seq_is_norm(seq))
 134                 hash = fld_rrb_hash(fld, seq);
 135         else
 136                 hash = 0;
 137
 138         cfs_list_for_each_entry(target, &fld->lcf_targets, ft_chain) {
 139                 if (target->ft_idx == hash)
 140                         RETURN(target);
 141         }
 142
 143         CERROR("%s: Can't find target by hash %d (seq "LPX64"). "
 144                "Targets (%d):\n", fld->lcf_name, hash, seq,
 145                fld->lcf_count);
 146
 147         cfs_list_for_each_entry(target, &fld->lcf_targets, ft_chain) {
 148                 const char *srv_name = target->ft_srv != NULL  ?
 149                         target->ft_srv->lsf_name : "<null>";
 150                 const char *exp_name = target->ft_exp != NULL ?
 151                         (char *)target->ft_exp->exp_obd->obd_uuid.uuid :
 152                         "<null>";
 153
 154                 CERROR("  exp: 0x%p (%s), srv: 0x%p (%s), idx: "LPU64"\n",
 155                        target->ft_exp, exp_name, target->ft_srv,
 156                        srv_name, target->ft_idx);
 157         }
 158
 159         /*
 160          * If target is not found, there is logical error anyway, so here is
 161          * LBUG() to catch this situation.
 162          */
 163         LBUG();
 164         RETURN(NULL);
 165 }
 166
 167 struct lu_fld_hash fld_hash[] = {
 168         {
 169                 .fh_name = "RRB",
 170                 .fh_hash_func = fld_rrb_hash,
 171                 .fh_scan_func = fld_rrb_scan
 172         },
 173         {
 174                 0,
 175         }
 176 };
 177
 178 static struct lu_fld_target *
 179 fld_client_get_target(struct lu_client_fld *fld, seqno_t seq)
 180 {
 181         struct lu_fld_target *target;
 182         ENTRY;
 183
 184         LASSERT(fld->lcf_hash != NULL);
 185
 186         spin_lock(&fld->lcf_lock);
 187         target = fld->lcf_hash->fh_scan_func(fld, seq);
 188         spin_unlock(&fld->lcf_lock);
 189
 190         if (target != NULL) {
 191                 CDEBUG(D_INFO, "%s: Found target (idx "LPU64
 192                        ") by seq "LPX64"\n", fld->lcf_name,
 193                        target->ft_idx, seq);
 194         }
 195
 196         RETURN(target);
 197 }
 198
 199 /*
 200  * Add export to FLD. This is usually done by CMM and LMV as they are main users
 201  * of FLD module.
 202  */
 203 int fld_client_add_target(struct lu_client_fld *fld,
 204                           struct lu_fld_target *tar)
 205 {
 206         const char *name;
 207         struct lu_fld_target *target, *tmp;
 208         ENTRY;
 209
 210         LASSERT(tar != NULL);
 211         name = fld_target_name(tar);
 212         LASSERT(name != NULL);
 213         LASSERT(tar->ft_srv != NULL || tar->ft_exp != NULL);
 214
 215         if (fld->lcf_flags != LUSTRE_FLD_INIT) {
 216                 CERROR("%s: Attempt to add target %s (idx "LPU64") "
 217                        "on fly - skip it\n", fld->lcf_name, name,
 218                        tar->ft_idx);
 219                 RETURN(0);
 220         } else {
 221                 CDEBUG(D_INFO, "%s: Adding target %s (idx "
 222                        LPU64")\n", fld->lcf_name, name, tar->ft_idx);
 223         }
 224
 225         OBD_ALLOC_PTR(target);
 226         if (target == NULL)
 227                 RETURN(-ENOMEM);
 228
 229         spin_lock(&fld->lcf_lock);
 230         cfs_list_for_each_entry(tmp, &fld->lcf_targets, ft_chain) {
 231                 if (tmp->ft_idx == tar->ft_idx) {
 232                         spin_unlock(&fld->lcf_lock);
 233                         OBD_FREE_PTR(target);
 234                         CERROR("Target %s exists in FLD and known as %s:#"LPU64"\n",
 235                                name, fld_target_name(tmp), tmp->ft_idx);
 236                         RETURN(-EEXIST);
 237                 }
 238         }
 239
 240         target->ft_exp = tar->ft_exp;
 241         if (target->ft_exp != NULL)
 242                 class_export_get(target->ft_exp);
 243         target->ft_srv = tar->ft_srv;
 244         target->ft_idx = tar->ft_idx;
 245
 246         cfs_list_add_tail(&target->ft_chain,
 247                           &fld->lcf_targets);
 248
 249         fld->lcf_count++;
 250         spin_unlock(&fld->lcf_lock);
 251
 252         RETURN(0);
 253 }
 254 EXPORT_SYMBOL(fld_client_add_target);
 255
 256 /* Remove export from FLD */
 257 int fld_client_del_target(struct lu_client_fld *fld, __u64 idx)
 258 {
 259         struct lu_fld_target *target, *tmp;
 260         ENTRY;
 261
 262         spin_lock(&fld->lcf_lock);
 263         cfs_list_for_each_entry_safe(target, tmp,
 264                                      &fld->lcf_targets, ft_chain) {
 265                 if (target->ft_idx == idx) {
 266                         fld->lcf_count--;
 267                         cfs_list_del(&target->ft_chain);
 268                         spin_unlock(&fld->lcf_lock);
 269
 270                         if (target->ft_exp != NULL)
 271                                 class_export_put(target->ft_exp);
 272
 273                         OBD_FREE_PTR(target);
 274                         RETURN(0);
 275                 }
 276         }
 277         spin_unlock(&fld->lcf_lock);
 278         RETURN(-ENOENT);
 279 }
 280 EXPORT_SYMBOL(fld_client_del_target);
 281
 282 #ifdef LPROCFS
 283 static int fld_client_proc_init(struct lu_client_fld *fld)
 284 {
 285         int rc;
 286         ENTRY;
 287
 288         fld->lcf_proc_dir = lprocfs_register(fld->lcf_name,
 289                                              fld_type_proc_dir,
 290                                              NULL, NULL);
 291
 292         if (IS_ERR(fld->lcf_proc_dir)) {
 293                 CERROR("%s: LProcFS failed in fld-init\n",
 294                        fld->lcf_name);
 295                 rc = PTR_ERR(fld->lcf_proc_dir);
 296                 RETURN(rc);
 297         }
 298
 299         rc = lprocfs_add_vars(fld->lcf_proc_dir,
 300                               fld_client_proc_list, fld);
 301         if (rc) {
 302                 CERROR("%s: Can't init FLD proc, rc %d\n",
 303                        fld->lcf_name, rc);
 304                 GOTO(out_cleanup, rc);
 305         }
 306
 307         RETURN(0);
 308
 309 out_cleanup:
 310         fld_client_proc_fini(fld);
 311         return rc;
 312 }
 313
 314 void fld_client_proc_fini(struct lu_client_fld *fld)
 315 {
 316         ENTRY;
 317         if (fld->lcf_proc_dir) {
 318                 if (!IS_ERR(fld->lcf_proc_dir))
 319                         lprocfs_remove(&fld->lcf_proc_dir);
 320                 fld->lcf_proc_dir = NULL;
 321         }
 322         EXIT;
 323 }
 324 #else
 325 static int fld_client_proc_init(struct lu_client_fld *fld)
 326 {
 327         return 0;
 328 }
 329
 330 void fld_client_proc_fini(struct lu_client_fld *fld)
 331 {
 332         return;
 333 }
 334 #endif
 335
 336 EXPORT_SYMBOL(fld_client_proc_fini);
 337
 338 static inline int hash_is_sane(int hash)
 339 {
 340         return (hash >= 0 && hash < ARRAY_SIZE(fld_hash));
 341 }
 342
 343 int fld_client_init(struct lu_client_fld *fld,
 344                     const char *prefix, int hash)
 345 {
 346         int cache_size, cache_threshold;
 347         int rc;
 348         ENTRY;
 349
 350         LASSERT(fld != NULL);
 351
 352         snprintf(fld->lcf_name, sizeof(fld->lcf_name),
 353                  "cli-%s", prefix);
 354
 355         if (!hash_is_sane(hash)) {
 356                 CERROR("%s: Wrong hash function %#x\n",
 357                        fld->lcf_name, hash);
 358                 RETURN(-EINVAL);
 359         }
 360
 361         fld->lcf_count = 0;
 362         spin_lock_init(&fld->lcf_lock);
 363         fld->lcf_hash = &fld_hash[hash];
 364         fld->lcf_flags = LUSTRE_FLD_INIT;
 365         CFS_INIT_LIST_HEAD(&fld->lcf_targets);
 366
 367         cache_size = FLD_CLIENT_CACHE_SIZE /
 368                 sizeof(struct fld_cache_entry);
 369
 370         cache_threshold = cache_size *
 371                 FLD_CLIENT_CACHE_THRESHOLD / 100;
 372
 373         fld->lcf_cache = fld_cache_init(fld->lcf_name,
 374                                         cache_size, cache_threshold);
 375         if (IS_ERR(fld->lcf_cache)) {
 376                 rc = PTR_ERR(fld->lcf_cache);
 377                 fld->lcf_cache = NULL;
 378                 GOTO(out, rc);
 379         }
 380
 381         rc = fld_client_proc_init(fld);
 382         if (rc)
 383                 GOTO(out, rc);
 384         EXIT;
 385 out:
 386         if (rc)
 387                 fld_client_fini(fld);
 388         else
 389                 CDEBUG(D_INFO, "%s: Using \"%s\" hash\n",
 390                        fld->lcf_name, fld->lcf_hash->fh_name);
 391         return rc;
 392 }
 393 EXPORT_SYMBOL(fld_client_init);
 394
 395 void fld_client_fini(struct lu_client_fld *fld)
 396 {
 397         struct lu_fld_target *target, *tmp;
 398         ENTRY;
 399
 400         spin_lock(&fld->lcf_lock);
 401         cfs_list_for_each_entry_safe(target, tmp,
 402                                      &fld->lcf_targets, ft_chain) {
 403                 fld->lcf_count--;
 404                 cfs_list_del(&target->ft_chain);
 405                 if (target->ft_exp != NULL)
 406                         class_export_put(target->ft_exp);
 407                 OBD_FREE_PTR(target);
 408         }
 409         spin_unlock(&fld->lcf_lock);
 410
 411         if (fld->lcf_cache != NULL) {
 412                 if (!IS_ERR(fld->lcf_cache))
 413                         fld_cache_fini(fld->lcf_cache);
 414                 fld->lcf_cache = NULL;
 415         }
 416
 417         EXIT;
 418 }
 419 EXPORT_SYMBOL(fld_client_fini);
 420
 421 int fld_client_rpc(struct obd_export *exp,
 422                    struct lu_seq_range *range, __u32 fld_op,
 423                    struct ptlrpc_request **reqp)
 424 {
 425         struct ptlrpc_request *req = NULL;
 426         struct lu_seq_range   *prange;
 427         __u32                 *op;
 428         int                    rc = 0;
 429         struct obd_import     *imp;
 430         ENTRY;
 431
 432         LASSERT(exp != NULL);
 433
 434         imp = class_exp2cliimp(exp);
 435         switch (fld_op) {
 436         case FLD_QUERY:
 437                 req = ptlrpc_request_alloc_pack(imp, &RQF_FLD_QUERY,
 438                                                 LUSTRE_MDS_VERSION, FLD_QUERY);
 439                 if (req == NULL)
 440                         RETURN(-ENOMEM);
 441
 442                 /* XXX: only needed when talking to old server(< 2.6), it should
 443                  * be removed when < 2.6 server is not supported */
 444                 op = req_capsule_client_get(&req->rq_pill, &RMF_FLD_OPC);
 445                 *op = FLD_LOOKUP;
 446
 447                 if (imp->imp_connect_flags_orig & OBD_CONNECT_MDS_MDS)
 448                         req->rq_allow_replay = 1;
 449                 break;
 450         case FLD_READ:
 451                 req = ptlrpc_request_alloc_pack(imp, &RQF_FLD_READ,
 452                                                 LUSTRE_MDS_VERSION, FLD_READ);
 453                 if (req == NULL)
 454                         RETURN(-ENOMEM);
 455
 456                 req_capsule_set_size(&req->rq_pill, &RMF_GENERIC_DATA,
 457                                      RCL_SERVER, PAGE_CACHE_SIZE);
 458                 break;
 459         default:
 460                 rc = -EINVAL;
 461                 break;
 462         }
 463
 464         if (rc != 0)
 465                 RETURN(rc);
 466
 467         prange = req_capsule_client_get(&req->rq_pill, &RMF_FLD_MDFLD);
 468         *prange = *range;
 469         ptlrpc_request_set_replen(req);
 470         req->rq_request_portal = FLD_REQUEST_PORTAL;
 471         req->rq_reply_portal = MDC_REPLY_PORTAL;
 472         ptlrpc_at_set_req_timeout(req);
 473
 474         fld_enter_request(&exp->exp_obd->u.cli);
 475         rc = ptlrpc_queue_wait(req);
 476         fld_exit_request(&exp->exp_obd->u.cli);
 477         if (rc)
 478                 GOTO(out_req, rc);
 479
 480         if (fld_op == FLD_QUERY) {
 481                 prange = req_capsule_server_get(&req->rq_pill,
 482                                                 &RMF_FLD_MDFLD);
 483                 if (prange == NULL)
 484                         GOTO(out_req, rc = -EFAULT);
 485                 *range = *prange;
 486         }
 487
 488         EXIT;
 489 out_req:
 490         if (rc != 0 || reqp == NULL) {
 491                 ptlrpc_req_finished(req);
 492                 req = NULL;
 493         }
 494
 495         if (reqp != NULL)
 496                 *reqp = req;
 497
 498         return rc;
 499 }
 500
 501 int fld_client_lookup(struct lu_client_fld *fld, seqno_t seq, mdsno_t *mds,
 502                       __u32 flags, const struct lu_env *env)
 503 {
 504         struct lu_seq_range res = { 0 };
 505         struct lu_fld_target *target;
 506         int rc;
 507         ENTRY;
 508
 509         fld->lcf_flags |= LUSTRE_FLD_RUN;
 510
 511         rc = fld_cache_lookup(fld->lcf_cache, seq, &res);
 512         if (rc == 0) {
 513                 *mds = res.lsr_index;
 514                 RETURN(0);
 515         }
 516
 517         /* Can not find it in the cache */
 518         target = fld_client_get_target(fld, seq);
 519         LASSERT(target != NULL);
 520
 521         CDEBUG(D_INFO, "%s: Lookup fld entry (seq: "LPX64") on "
 522                "target %s (idx "LPU64")\n", fld->lcf_name, seq,
 523                fld_target_name(target), target->ft_idx);
 524
 525         res.lsr_start = seq;
 526         fld_range_set_type(&res, flags);
 527
 528 #if defined(__KERNEL__) && defined(HAVE_SERVER_SUPPORT)
 529         if (target->ft_srv != NULL) {
 530                 LASSERT(env != NULL);
 531                 rc = fld_server_lookup(env, target->ft_srv, seq, &res);
 532         } else
 533 #endif
 534         {
 535                 rc = fld_client_rpc(target->ft_exp, &res, FLD_QUERY, NULL);
 536         }
 537
 538         if (rc == 0) {
 539                 *mds = res.lsr_index;
 540                 fld_cache_insert(fld->lcf_cache, &res);
 541         }
 542
 543         RETURN(rc);
 544 }
 545 EXPORT_SYMBOL(fld_client_lookup);
 546
 547 void fld_client_flush(struct lu_client_fld *fld)
 548 {
 549         fld_cache_flush(fld->lcf_cache);
 550 }
 551 EXPORT_SYMBOL(fld_client_flush);
 552
 553 #ifdef __KERNEL__
 554
 555 struct proc_dir_entry *fld_type_proc_dir;
 556
 557 static int __init fld_mod_init(void)
 558 {
 559         fld_type_proc_dir = lprocfs_register(LUSTRE_FLD_NAME,
 560                                              proc_lustre_root,
 561                                              NULL, NULL);
 562         if (IS_ERR(fld_type_proc_dir))
 563                 return PTR_ERR(fld_type_proc_dir);
 564
 565 #ifdef HAVE_SERVER_SUPPORT
 566         fld_server_mod_init();
 567 #endif
 568
 569         return 0;
 570 }
 571
 572 static void __exit fld_mod_exit(void)
 573 {
 574 #ifdef HAVE_SERVER_SUPPORT
 575         fld_server_mod_exit();
 576 #endif
 577
 578         if (fld_type_proc_dir != NULL && !IS_ERR(fld_type_proc_dir)) {
 579                 lprocfs_remove(&fld_type_proc_dir);
 580                 fld_type_proc_dir = NULL;
 581         }
 582 }
 583
 584 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
 585 MODULE_DESCRIPTION("Lustre FLD");
 586 MODULE_LICENSE("GPL");
 587
 588 cfs_module(mdd, LUSTRE_VERSION_STRING, fld_mod_init, fld_mod_exit);
 589 #endif /* __KERNEL__ */