lustre/fid/fid_handler.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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/fid/fid_handler.c
  37  *
  38  * Lustre Sequence Manager
  39  *
  40  * Author: Yury Umanets <umka@clusterfs.com>
  41  */
  42
  43 #ifndef EXPORT_SYMTAB
  44 # define EXPORT_SYMTAB
  45 #endif
  46 #define DEBUG_SUBSYSTEM S_FID
  47
  48 #ifdef __KERNEL__
  49 # include <libcfs/libcfs.h>
  50 # include <linux/module.h>
  51 #else /* __KERNEL__ */
  52 # include <liblustre.h>
  53 #endif
  54
  55 #include <obd.h>
  56 #include <obd_class.h>
  57 #include <dt_object.h>
  58 #include <md_object.h>
  59 #include <obd_support.h>
  60 #include <lustre_req_layout.h>
  61 #include <lustre_fid.h>
  62 #include "fid_internal.h"
  63
  64 #ifdef __KERNEL__
  65 /* Assigns client to sequence controller node. */
  66 int seq_server_set_cli(struct lu_server_seq *seq,
  67                        struct lu_client_seq *cli,
  68                        const struct lu_env *env)
  69 {
  70         int rc = 0;
  71         ENTRY;
  72
  73         /*
  74          * Ask client for new range, assign that range to ->seq_space and write
  75          * seq state to backing store should be atomic.
  76          */
  77         down(&seq->lss_sem);
  78
  79         if (cli == NULL) {
  80                 CDEBUG(D_INFO, "%s: Detached sequence client %s\n",
  81                        seq->lss_name, cli->lcs_name);
  82                 seq->lss_cli = cli;
  83                 GOTO(out_up, rc = 0);
  84         }
  85
  86         if (seq->lss_cli != NULL) {
  87                 CERROR("%s: Sequence controller is already "
  88                        "assigned\n", seq->lss_name);
  89                 GOTO(out_up, rc = -EINVAL);
  90         }
  91
  92         CDEBUG(D_INFO, "%s: Attached sequence controller %s\n",
  93                seq->lss_name, cli->lcs_name);
  94
  95         seq->lss_cli = cli;
  96         cli->lcs_space.lsr_mdt = seq->lss_site->ms_node_id;
  97         EXIT;
  98 out_up:
  99         up(&seq->lss_sem);
 100         return rc;
 101 }
 102 EXPORT_SYMBOL(seq_server_set_cli);
 103
 104 /**
 105  * On controller node, allocate new super sequence for regular sequence server.
 106  * As this super sequence controller, this node suppose to maintain fld
 107  * and update index.
 108  * \a out range always has currect mds node number of requester.
 109  */
 110
 111 static int __seq_server_alloc_super(struct lu_server_seq *seq,
 112                                     struct lu_seq_range *in,
 113                                     struct lu_seq_range *out,
 114                                     const struct lu_env *env)
 115 {
 116         struct lu_seq_range *space = &seq->lss_space;
 117         struct thandle *th;
 118         __u64 mdt = out->lsr_mdt;
 119         int rc, credit;
 120         ENTRY;
 121
 122         LASSERT(range_is_sane(space));
 123
 124         if (in != NULL) {
 125                 CDEBUG(D_INFO, "%s: Input seq range: "
 126                        DRANGE"\n", seq->lss_name, PRANGE(in));
 127
 128                 if (in->lsr_end > space->lsr_start)
 129                         space->lsr_start = in->lsr_end;
 130                 *out = *in;
 131
 132                 CDEBUG(D_INFO, "%s: Recovered space: "DRANGE"\n",
 133                        seq->lss_name, PRANGE(space));
 134         } else {
 135                 if (range_space(space) < seq->lss_width) {
 136                         CWARN("%s: Sequences space to be exhausted soon. "
 137                               "Only "LPU64" sequences left\n", seq->lss_name,
 138                               range_space(space));
 139                         *out = *space;
 140                         space->lsr_start = space->lsr_end;
 141                 } else if (range_is_exhausted(space)) {
 142                         CERROR("%s: Sequences space is exhausted\n",
 143                                seq->lss_name);
 144                         RETURN(-ENOSPC);
 145                 } else {
 146                         range_alloc(out, space, seq->lss_width);
 147                 }
 148         }
 149         out->lsr_mdt = mdt;
 150
 151         credit = SEQ_TXN_STORE_CREDITS + FLD_TXN_INDEX_INSERT_CREDITS;
 152
 153         th = seq_store_trans_start(seq, env, credit);
 154         if (IS_ERR(th))
 155                 RETURN(PTR_ERR(th));
 156
 157         rc = seq_store_write(seq, env, th);
 158         if (rc) {
 159                 CERROR("%s: Can't write space data, rc %d\n",
 160                        seq->lss_name, rc);
 161                 goto out;
 162         }
 163
 164         rc = fld_server_create(seq->lss_site->ms_server_fld,
 165                                env, out, th);
 166         if (rc) {
 167                 CERROR("%s: Can't Update fld database, rc %d\n",
 168                        seq->lss_name, rc);
 169         }
 170
 171 out:
 172         seq_store_trans_stop(seq, env, th);
 173
 174         CDEBUG(D_INFO, "%s: super-sequence allocation rc = %d "
 175                DRANGE"\n", seq->lss_name, rc, PRANGE(out));
 176
 177         RETURN(rc);
 178 }
 179
 180 int seq_server_alloc_super(struct lu_server_seq *seq,
 181                            struct lu_seq_range *in,
 182                            struct lu_seq_range *out,
 183                            const struct lu_env *env)
 184 {
 185         int rc;
 186         ENTRY;
 187
 188         down(&seq->lss_sem);
 189         rc = __seq_server_alloc_super(seq, in, out, env);
 190         up(&seq->lss_sem);
 191
 192         RETURN(rc);
 193 }
 194
 195 static int __seq_server_alloc_meta(struct lu_server_seq *seq,
 196                                    struct lu_seq_range *in,
 197                                    struct lu_seq_range *out,
 198                                    const struct lu_env *env)
 199 {
 200         struct lu_seq_range *space = &seq->lss_space;
 201         struct thandle *th;
 202         int rc = 0;
 203
 204         ENTRY;
 205
 206         LASSERT(range_is_sane(space));
 207
 208         /*
 209          * This is recovery case. Adjust super range if input range looks like
 210          * it is allocated from new super.
 211          */
 212         if (in != NULL) {
 213                 CDEBUG(D_INFO, "%s: Input seq range: "
 214                        DRANGE"\n", seq->lss_name, PRANGE(in));
 215
 216                 if (range_is_exhausted(space)) {
 217                         /*
 218                          * Server cannot send empty range to client, this is why
 219                          * we check here that range from client is "newer" than
 220                          * exhausted super.
 221                          */
 222                         LASSERT(in->lsr_end > space->lsr_start);
 223
 224                         /*
 225                          * Start is set to end of last allocated, because it
 226                          * *is* already allocated so we take that into account
 227                          * and do not use for other allocations.
 228                          */
 229                         space->lsr_start = in->lsr_end;
 230
 231                         /*
 232                          * End is set to in->lsr_start + super sequence
 233                          * allocation unit. That is because in->lsr_start is
 234                          * first seq in new allocated range from controller
 235                          * before failure.
 236                          */
 237                         space->lsr_end = in->lsr_start + LUSTRE_SEQ_SUPER_WIDTH;
 238
 239                         if (!seq->lss_cli) {
 240                                 CERROR("%s: No sequence controller "
 241                                        "is attached.\n", seq->lss_name);
 242                                 RETURN(-ENODEV);
 243                         }
 244
 245                         /*
 246                          * Let controller know that this is recovery and last
 247                          * obtained range from it was @space.
 248                          */
 249                         rc = seq_client_replay_super(seq->lss_cli, space, env);
 250
 251                         if (rc) {
 252                                 CERROR("%s: Can't replay super-sequence, "
 253                                        "rc %d\n", seq->lss_name, rc);
 254                                 RETURN(rc);
 255                         }
 256                 } else {
 257                         /*
 258                          * Update super start by end from client's range. Super
 259                          * end should not be changed if range was not exhausted.
 260                          */
 261                         if (in->lsr_end > space->lsr_start)
 262                                 space->lsr_start = in->lsr_end;
 263                 }
 264
 265                 *out = *in;
 266
 267                 CDEBUG(D_INFO, "%s: Recovered space: "DRANGE"\n",
 268                        seq->lss_name, PRANGE(space));
 269         } else {
 270                 /*
 271                  * XXX: Avoid cascading RPCs using kind of async preallocation
 272                  * when meta-sequence is close to exhausting.
 273                  */
 274                 if (range_is_exhausted(space)) {
 275                         if (!seq->lss_cli) {
 276                                 CERROR("%s: No sequence controller "
 277                                        "is attached.\n", seq->lss_name);
 278                                 RETURN(-ENODEV);
 279                         }
 280
 281                         rc = seq_client_alloc_super(seq->lss_cli, env);
 282                         if (rc) {
 283                                 CERROR("%s: Can't allocate super-sequence, "
 284                                        "rc %d\n", seq->lss_name, rc);
 285                                 RETURN(rc);
 286                         }
 287
 288                         /* Saving new range to allocation space. */
 289                         *space = seq->lss_cli->lcs_space;
 290                         LASSERT(range_is_sane(space));
 291                 }
 292
 293                 range_alloc(out, space, seq->lss_width);
 294         }
 295
 296         th = seq_store_trans_start(seq, env, SEQ_TXN_STORE_CREDITS);
 297         if (IS_ERR(th))
 298                 RETURN(PTR_ERR(th));
 299
 300         rc = seq_store_write(seq, env, th);
 301         if (rc) {
 302                 CERROR("%s: Can't write space data, rc %d\n",
 303                        seq->lss_name, rc);
 304         }
 305
 306         if (rc == 0) {
 307                 CDEBUG(D_INFO, "%s: Allocated meta-sequence "
 308                        DRANGE"\n", seq->lss_name, PRANGE(out));
 309         }
 310
 311         seq_store_trans_stop(seq, env, th);
 312         RETURN(rc);
 313 }
 314
 315 int seq_server_alloc_meta(struct lu_server_seq *seq,
 316                           struct lu_seq_range *in,
 317                           struct lu_seq_range *out,
 318                           const struct lu_env *env)
 319 {
 320         int rc;
 321         ENTRY;
 322
 323         down(&seq->lss_sem);
 324         rc = __seq_server_alloc_meta(seq, in, out, env);
 325         up(&seq->lss_sem);
 326
 327         RETURN(rc);
 328 }
 329 EXPORT_SYMBOL(seq_server_alloc_meta);
 330
 331 static int seq_server_handle(struct lu_site *site,
 332                              const struct lu_env *env,
 333                              __u32 opc, struct lu_seq_range *in,
 334                              struct lu_seq_range *out)
 335 {
 336         int rc;
 337         struct md_site *mite;
 338         ENTRY;
 339
 340         mite = lu_site2md(site);
 341         switch (opc) {
 342         case SEQ_ALLOC_META:
 343                 if (!mite->ms_server_seq) {
 344                         CERROR("Sequence server is not "
 345                                "initialized\n");
 346                         RETURN(-EINVAL);
 347                 }
 348                 rc = seq_server_alloc_meta(mite->ms_server_seq,
 349                                            in, out, env);
 350                 break;
 351         case SEQ_ALLOC_SUPER:
 352                 if (!mite->ms_control_seq) {
 353                         CERROR("Sequence controller is not "
 354                                "initialized\n");
 355                         RETURN(-EINVAL);
 356                 }
 357                 rc = seq_server_alloc_super(mite->ms_control_seq,
 358                                             in, out, env);
 359                 break;
 360         default:
 361                 rc = -EINVAL;
 362                 break;
 363         }
 364
 365         RETURN(rc);
 366 }
 367
 368 static int seq_req_handle(struct ptlrpc_request *req,
 369                           const struct lu_env *env,
 370                           struct seq_thread_info *info)
 371 {
 372         struct lu_seq_range *out, *in = NULL, *tmp;
 373         struct lu_site *site;
 374         int rc = -EPROTO;
 375         __u32 *opc;
 376         ENTRY;
 377
 378         site = req->rq_export->exp_obd->obd_lu_dev->ld_site;
 379         LASSERT(site != NULL);
 380
 381         rc = req_capsule_server_pack(info->sti_pill);
 382         if (rc)
 383                 RETURN(err_serious(rc));
 384
 385         opc = req_capsule_client_get(info->sti_pill, &RMF_SEQ_OPC);
 386         if (opc != NULL) {
 387                 out = req_capsule_server_get(info->sti_pill, &RMF_SEQ_RANGE);
 388                 if (out == NULL)
 389                         RETURN(err_serious(-EPROTO));
 390
 391                 tmp = req_capsule_client_get(info->sti_pill, &RMF_SEQ_RANGE);
 392
 393                 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
 394                         in = tmp;
 395                         LASSERT(!range_is_zero(in) && range_is_sane(in));
 396                 }
 397                 /* seq client passed mdt id, we need to pass that using out
 398                  * range parameter */
 399
 400                 out->lsr_mdt = tmp->lsr_mdt;
 401                 rc = seq_server_handle(site, env, *opc, in, out);
 402         } else
 403                 rc = err_serious(-EPROTO);
 404
 405         RETURN(rc);
 406 }
 407
 408 /* context key constructor/destructor: seq_key_init, seq_key_fini */
 409 LU_KEY_INIT_FINI(seq, struct seq_thread_info);
 410
 411 /* context key: seq_thread_key */
 412 LU_CONTEXT_KEY_DEFINE(seq, LCT_MD_THREAD);
 413
 414 static void seq_thread_info_init(struct ptlrpc_request *req,
 415                                  struct seq_thread_info *info)
 416 {
 417         info->sti_pill = &req->rq_pill;
 418         /* Init request capsule */
 419         req_capsule_init(info->sti_pill, req, RCL_SERVER);
 420         req_capsule_set(info->sti_pill, &RQF_SEQ_QUERY);
 421 }
 422
 423 static void seq_thread_info_fini(struct seq_thread_info *info)
 424 {
 425         req_capsule_fini(info->sti_pill);
 426 }
 427
 428 static int seq_handle(struct ptlrpc_request *req)
 429 {
 430         const struct lu_env *env;
 431         struct seq_thread_info *info;
 432         int rc;
 433
 434         env = req->rq_svc_thread->t_env;
 435         LASSERT(env != NULL);
 436
 437         info = lu_context_key_get(&env->le_ctx, &seq_thread_key);
 438         LASSERT(info != NULL);
 439
 440         seq_thread_info_init(req, info);
 441         rc = seq_req_handle(req, env, info);
 442         seq_thread_info_fini(info);
 443
 444         return rc;
 445 }
 446
 447 /*
 448  * Entry point for handling FLD RPCs called from MDT.
 449  */
 450 int seq_query(struct com_thread_info *info)
 451 {
 452         return seq_handle(info->cti_pill->rc_req);
 453 }
 454 EXPORT_SYMBOL(seq_query);
 455
 456 static void seq_server_proc_fini(struct lu_server_seq *seq);
 457
 458 #ifdef LPROCFS
 459 static int seq_server_proc_init(struct lu_server_seq *seq)
 460 {
 461         int rc;
 462         ENTRY;
 463
 464         seq->lss_proc_dir = lprocfs_register(seq->lss_name,
 465                                              seq_type_proc_dir,
 466                                              NULL, NULL);
 467         if (IS_ERR(seq->lss_proc_dir)) {
 468                 rc = PTR_ERR(seq->lss_proc_dir);
 469                 RETURN(rc);
 470         }
 471
 472         rc = lprocfs_add_vars(seq->lss_proc_dir,
 473                               seq_server_proc_list, seq);
 474         if (rc) {
 475                 CERROR("%s: Can't init sequence manager "
 476                        "proc, rc %d\n", seq->lss_name, rc);
 477                 GOTO(out_cleanup, rc);
 478         }
 479
 480         RETURN(0);
 481
 482 out_cleanup:
 483         seq_server_proc_fini(seq);
 484         return rc;
 485 }
 486
 487 static void seq_server_proc_fini(struct lu_server_seq *seq)
 488 {
 489         ENTRY;
 490         if (seq->lss_proc_dir != NULL) {
 491                 if (!IS_ERR(seq->lss_proc_dir))
 492                         lprocfs_remove(&seq->lss_proc_dir);
 493                 seq->lss_proc_dir = NULL;
 494         }
 495         EXIT;
 496 }
 497 #else
 498 static int seq_server_proc_init(struct lu_server_seq *seq)
 499 {
 500         return 0;
 501 }
 502
 503 static void seq_server_proc_fini(struct lu_server_seq *seq)
 504 {
 505         return;
 506 }
 507 #endif
 508
 509 int seq_server_init(struct lu_server_seq *seq,
 510                     struct dt_device *dev,
 511                     const char *prefix,
 512                     enum lu_mgr_type type,
 513                     struct md_site *ms,
 514                     const struct lu_env *env)
 515 {
 516         struct thandle *th;
 517         int rc, is_srv = (type == LUSTRE_SEQ_SERVER);
 518         ENTRY;
 519
 520         LASSERT(dev != NULL);
 521         LASSERT(prefix != NULL);
 522
 523         seq->lss_cli = NULL;
 524         seq->lss_type = type;
 525         seq->lss_site = ms;
 526         range_init(&seq->lss_space);
 527         sema_init(&seq->lss_sem, 1);
 528
 529         seq->lss_width = is_srv ?
 530                 LUSTRE_SEQ_META_WIDTH : LUSTRE_SEQ_SUPER_WIDTH;
 531
 532         snprintf(seq->lss_name, sizeof(seq->lss_name),
 533                  "%s-%s", (is_srv ? "srv" : "ctl"), prefix);
 534
 535         rc = seq_store_init(seq, env, dev);
 536         if (rc)
 537                 GOTO(out, rc);
 538         /* Request backing store for saved sequence info. */
 539         rc = seq_store_read(seq, env);
 540         if (rc == -ENODATA) {
 541
 542                 /* Nothing is read, init by default value. */
 543                 seq->lss_space = is_srv ?
 544                         LUSTRE_SEQ_ZERO_RANGE:
 545                         LUSTRE_SEQ_SPACE_RANGE;
 546
 547                 seq->lss_space.lsr_mdt = ms->ms_node_id;
 548                 CDEBUG(D_INFO, "%s: No data found "
 549                        "on store. Initialize space\n",
 550                        seq->lss_name);
 551
 552                 th = seq_store_trans_start(seq, env, SEQ_TXN_STORE_CREDITS);
 553                 if (IS_ERR(th))
 554                         RETURN(PTR_ERR(th));
 555
 556                 /* Save default controller value to store. */
 557                 rc = seq_store_write(seq, env, th);
 558                 if (rc) {
 559                         CERROR("%s: Can't write space data, "
 560                                "rc %d\n", seq->lss_name, rc);
 561                 }
 562                 seq_store_trans_stop(seq, env, th);
 563         } else if (rc) {
 564                 CERROR("%s: Can't read space data, rc %d\n",
 565                        seq->lss_name, rc);
 566                 GOTO(out, rc);
 567         }
 568
 569         if (is_srv) {
 570                 LASSERT(range_is_sane(&seq->lss_space));
 571         } else {
 572                 LASSERT(!range_is_zero(&seq->lss_space) &&
 573                         range_is_sane(&seq->lss_space));
 574         }
 575
 576         rc  = seq_server_proc_init(seq);
 577         if (rc)
 578                 GOTO(out, rc);
 579
 580         EXIT;
 581 out:
 582         if (rc)
 583                 seq_server_fini(seq, env);
 584         return rc;
 585 }
 586 EXPORT_SYMBOL(seq_server_init);
 587
 588 void seq_server_fini(struct lu_server_seq *seq,
 589                      const struct lu_env *env)
 590 {
 591         ENTRY;
 592
 593         seq_server_proc_fini(seq);
 594         seq_store_fini(seq, env);
 595
 596         EXIT;
 597 }
 598 EXPORT_SYMBOL(seq_server_fini);
 599
 600 cfs_proc_dir_entry_t *seq_type_proc_dir = NULL;
 601
 602 static struct lu_local_obj_desc llod_seq_srv = {
 603         .llod_name      = LUSTRE_SEQ_SRV_NAME,
 604         .llod_oid       = FID_SEQ_SRV_OID,
 605         .llod_is_index  = 0,
 606 };
 607
 608 static struct lu_local_obj_desc llod_seq_ctl = {
 609         .llod_name      = LUSTRE_SEQ_CTL_NAME,
 610         .llod_oid       = FID_SEQ_CTL_OID,
 611         .llod_is_index  = 0,
 612 };
 613
 614 static int __init fid_mod_init(void)
 615 {
 616         seq_type_proc_dir = lprocfs_register(LUSTRE_SEQ_NAME,
 617                                              proc_lustre_root,
 618                                              NULL, NULL);
 619         if (IS_ERR(seq_type_proc_dir))
 620                 return PTR_ERR(seq_type_proc_dir);
 621
 622         llo_local_obj_register(&llod_seq_srv);
 623         llo_local_obj_register(&llod_seq_ctl);
 624
 625         LU_CONTEXT_KEY_INIT(&seq_thread_key);
 626         lu_context_key_register(&seq_thread_key);
 627         return 0;
 628 }
 629
 630 static void __exit fid_mod_exit(void)
 631 {
 632         llo_local_obj_unregister(&llod_seq_srv);
 633         llo_local_obj_unregister(&llod_seq_ctl);
 634
 635         lu_context_key_degister(&seq_thread_key);
 636         if (seq_type_proc_dir != NULL && !IS_ERR(seq_type_proc_dir)) {
 637                 lprocfs_remove(&seq_type_proc_dir);
 638                 seq_type_proc_dir = NULL;
 639         }
 640 }
 641
 642 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
 643 MODULE_DESCRIPTION("Lustre FID Module");
 644 MODULE_LICENSE("GPL");
 645
 646 cfs_module(fid, "0.1.0", fid_mod_init, fid_mod_exit);
 647 #endif