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 [sun.com URL with a
  20  * copy of GPLv2].
  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         EXIT;
  97 out_up:
  98         up(&seq->lss_sem);
  99         return rc;
 100 }
 101 EXPORT_SYMBOL(seq_server_set_cli);
 102
 103 /*
 104  * On controller node, allocate new super sequence for regular sequence server.
 105  */
 106 static int __seq_server_alloc_super(struct lu_server_seq *seq,
 107                                     struct lu_range *in,
 108                                     struct lu_range *out,
 109                                     const struct lu_env *env)
 110 {
 111         struct lu_range *space = &seq->lss_space;
 112         int rc;
 113         ENTRY;
 114
 115         LASSERT(range_is_sane(space));
 116
 117         if (in != NULL) {
 118                 CDEBUG(D_INFO, "%s: Input seq range: "
 119                        DRANGE"\n", seq->lss_name, PRANGE(in));
 120
 121                 if (in->lr_end > space->lr_start)
 122                         space->lr_start = in->lr_end;
 123                 *out = *in;
 124
 125                 CDEBUG(D_INFO, "%s: Recovered space: "DRANGE"\n",
 126                        seq->lss_name, PRANGE(space));
 127         } else {
 128                 if (range_space(space) < seq->lss_width) {
 129                         CWARN("%s: Sequences space to be exhausted soon. "
 130                               "Only "LPU64" sequences left\n", seq->lss_name,
 131                               range_space(space));
 132                         *out = *space;
 133                         space->lr_start = space->lr_end;
 134                 } else if (range_is_exhausted(space)) {
 135                         CERROR("%s: Sequences space is exhausted\n",
 136                                seq->lss_name);
 137                         RETURN(-ENOSPC);
 138                 } else {
 139                         range_alloc(out, space, seq->lss_width);
 140                 }
 141         }
 142
 143         rc = seq_store_write(seq, env);
 144         if (rc) {
 145                 CERROR("%s: Can't write space data, rc %d\n",
 146                        seq->lss_name, rc);
 147                 RETURN(rc);
 148         }
 149
 150         CDEBUG(D_INFO, "%s: Allocated super-sequence "
 151                DRANGE"\n", seq->lss_name, PRANGE(out));
 152
 153         RETURN(rc);
 154 }
 155
 156 int seq_server_alloc_super(struct lu_server_seq *seq,
 157                            struct lu_range *in,
 158                            struct lu_range *out,
 159                            const struct lu_env *env)
 160 {
 161         int rc;
 162         ENTRY;
 163
 164         down(&seq->lss_sem);
 165         rc = __seq_server_alloc_super(seq, in, out, env);
 166         up(&seq->lss_sem);
 167
 168         RETURN(rc);
 169 }
 170
 171 static int __seq_server_alloc_meta(struct lu_server_seq *seq,
 172                                    struct lu_range *in,
 173                                    struct lu_range *out,
 174                                    const struct lu_env *env)
 175 {
 176         struct lu_range *space = &seq->lss_space;
 177         int rc = 0;
 178         ENTRY;
 179
 180         LASSERT(range_is_sane(space));
 181
 182         /*
 183          * This is recovery case. Adjust super range if input range looks like
 184          * it is allocated from new super.
 185          */
 186         if (in != NULL) {
 187                 CDEBUG(D_INFO, "%s: Input seq range: "
 188                        DRANGE"\n", seq->lss_name, PRANGE(in));
 189
 190                 if (range_is_exhausted(space)) {
 191                         /*
 192                          * Server cannot send empty range to client, this is why
 193                          * we check here that range from client is "newer" than
 194                          * exhausted super.
 195                          */
 196                         LASSERT(in->lr_end > space->lr_start);
 197
 198                         /*
 199                          * Start is set to end of last allocated, because it
 200                          * *is* already allocated so we take that into account
 201                          * and do not use for other allocations.
 202                          */
 203                         space->lr_start = in->lr_end;
 204
 205                         /*
 206                          * End is set to in->lr_start + super sequence
 207                          * allocation unit. That is because in->lr_start is
 208                          * first seq in new allocated range from controller
 209                          * before failure.
 210                          */
 211                         space->lr_end = in->lr_start + LUSTRE_SEQ_SUPER_WIDTH;
 212
 213                         if (!seq->lss_cli) {
 214                                 CERROR("%s: No sequence controller "
 215                                        "is attached.\n", seq->lss_name);
 216                                 RETURN(-ENODEV);
 217                         }
 218
 219                         /*
 220                          * Let controller know that this is recovery and last
 221                          * obtained range from it was @space.
 222                          */
 223                         rc = seq_client_replay_super(seq->lss_cli, space, env);
 224                         if (rc) {
 225                                 CERROR("%s: Can't replay super-sequence, "
 226                                        "rc %d\n", seq->lss_name, rc);
 227                                 RETURN(rc);
 228                         }
 229                 } else {
 230                         /*
 231                          * Update super start by end from client's range. Super
 232                          * end should not be changed if range was not exhausted.
 233                          */
 234                         if (in->lr_end > space->lr_start)
 235                                 space->lr_start = in->lr_end;
 236                 }
 237
 238                 *out = *in;
 239
 240                 CDEBUG(D_INFO, "%s: Recovered space: "DRANGE"\n",
 241                        seq->lss_name, PRANGE(space));
 242         } else {
 243                 /*
 244                  * XXX: Avoid cascading RPCs using kind of async preallocation
 245                  * when meta-sequence is close to exhausting.
 246                  */
 247                 if (range_is_exhausted(space)) {
 248                         if (!seq->lss_cli) {
 249                                 CERROR("%s: No sequence controller "
 250                                        "is attached.\n", seq->lss_name);
 251                                 RETURN(-ENODEV);
 252                         }
 253
 254                         rc = seq_client_alloc_super(seq->lss_cli, env);
 255                         if (rc) {
 256                                 CERROR("%s: Can't allocate super-sequence, "
 257                                        "rc %d\n", seq->lss_name, rc);
 258                                 RETURN(rc);
 259                         }
 260
 261                         /* Saving new range to allocation space. */
 262                         *space = seq->lss_cli->lcs_space;
 263                         LASSERT(range_is_sane(space));
 264                 }
 265
 266                 range_alloc(out, space, seq->lss_width);
 267         }
 268
 269         rc = seq_store_write(seq, env);
 270         if (rc) {
 271                 CERROR("%s: Can't write space data, rc %d\n",
 272                        seq->lss_name, rc);
 273         }
 274
 275         if (rc == 0) {
 276                 CDEBUG(D_INFO, "%s: Allocated meta-sequence "
 277                        DRANGE"\n", seq->lss_name, PRANGE(out));
 278         }
 279
 280         RETURN(rc);
 281 }
 282
 283 int seq_server_alloc_meta(struct lu_server_seq *seq,
 284                           struct lu_range *in,
 285                           struct lu_range *out,
 286                           const struct lu_env *env)
 287 {
 288         int rc;
 289         ENTRY;
 290
 291         down(&seq->lss_sem);
 292         rc = __seq_server_alloc_meta(seq, in, out, env);
 293         up(&seq->lss_sem);
 294
 295         RETURN(rc);
 296 }
 297 EXPORT_SYMBOL(seq_server_alloc_meta);
 298
 299 static int seq_server_handle(struct lu_site *site,
 300                              const struct lu_env *env,
 301                              __u32 opc, struct lu_range *in,
 302                              struct lu_range *out)
 303 {
 304         int rc;
 305         ENTRY;
 306
 307         switch (opc) {
 308         case SEQ_ALLOC_META:
 309                 if (!site->ls_server_seq) {
 310                         CERROR("Sequence server is not "
 311                                "initialized\n");
 312                         RETURN(-EINVAL);
 313                 }
 314                 rc = seq_server_alloc_meta(site->ls_server_seq,
 315                                            in, out, env);
 316                 break;
 317         case SEQ_ALLOC_SUPER:
 318                 if (!site->ls_control_seq) {
 319                         CERROR("Sequence controller is not "
 320                                "initialized\n");
 321                         RETURN(-EINVAL);
 322                 }
 323                 rc = seq_server_alloc_super(site->ls_control_seq,
 324                                             in, out, env);
 325                 break;
 326         default:
 327                 rc = -EINVAL;
 328                 break;
 329         }
 330
 331         RETURN(rc);
 332 }
 333
 334 static int seq_req_handle(struct ptlrpc_request *req,
 335                           const struct lu_env *env,
 336                           struct seq_thread_info *info)
 337 {
 338         struct lu_range *out, *in = NULL;
 339         struct lu_site *site;
 340         int rc = -EPROTO;
 341         __u32 *opc;
 342         ENTRY;
 343
 344         site = req->rq_export->exp_obd->obd_lu_dev->ld_site;
 345         LASSERT(site != NULL);
 346
 347         rc = req_capsule_server_pack(info->sti_pill);
 348         if (rc)
 349                 RETURN(err_serious(rc));
 350
 351         opc = req_capsule_client_get(info->sti_pill, &RMF_SEQ_OPC);
 352         if (opc != NULL) {
 353                 out = req_capsule_server_get(info->sti_pill, &RMF_SEQ_RANGE);
 354                 if (out == NULL)
 355                         RETURN(err_serious(-EPROTO));
 356
 357                 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
 358                         in = req_capsule_client_get(info->sti_pill,
 359                                                     &RMF_SEQ_RANGE);
 360
 361                         LASSERT(!range_is_zero(in) && range_is_sane(in));
 362                 }
 363
 364                 rc = seq_server_handle(site, env, *opc, in, out);
 365         } else
 366                 rc = err_serious(-EPROTO);
 367
 368         RETURN(rc);
 369 }
 370
 371 /* context key constructor/destructor: seq_key_init, seq_key_fini */
 372 LU_KEY_INIT_FINI(seq, struct seq_thread_info);
 373
 374 /* context key: seq_thread_key */
 375 LU_CONTEXT_KEY_DEFINE(seq, LCT_MD_THREAD);
 376
 377 static void seq_thread_info_init(struct ptlrpc_request *req,
 378                                  struct seq_thread_info *info)
 379 {
 380         info->sti_pill = &req->rq_pill;
 381         /* Init request capsule */
 382         req_capsule_init(info->sti_pill, req, RCL_SERVER);
 383         req_capsule_set(info->sti_pill, &RQF_SEQ_QUERY);
 384 }
 385
 386 static void seq_thread_info_fini(struct seq_thread_info *info)
 387 {
 388         req_capsule_fini(info->sti_pill);
 389 }
 390
 391 static int seq_handle(struct ptlrpc_request *req)
 392 {
 393         const struct lu_env *env;
 394         struct seq_thread_info *info;
 395         int rc;
 396
 397         env = req->rq_svc_thread->t_env;
 398         LASSERT(env != NULL);
 399
 400         info = lu_context_key_get(&env->le_ctx, &seq_thread_key);
 401         LASSERT(info != NULL);
 402
 403         seq_thread_info_init(req, info);
 404         rc = seq_req_handle(req, env, info);
 405         seq_thread_info_fini(info);
 406
 407         return rc;
 408 }
 409
 410 /*
 411  * Entry point for handling FLD RPCs called from MDT.
 412  */
 413 int seq_query(struct com_thread_info *info)
 414 {
 415         return seq_handle(info->cti_pill->rc_req);
 416 }
 417 EXPORT_SYMBOL(seq_query);
 418
 419 static void seq_server_proc_fini(struct lu_server_seq *seq);
 420
 421 #ifdef LPROCFS
 422 static int seq_server_proc_init(struct lu_server_seq *seq)
 423 {
 424         int rc;
 425         ENTRY;
 426
 427         seq->lss_proc_dir = lprocfs_register(seq->lss_name,
 428                                              seq_type_proc_dir,
 429                                              NULL, NULL);
 430         if (IS_ERR(seq->lss_proc_dir)) {
 431                 rc = PTR_ERR(seq->lss_proc_dir);
 432                 RETURN(rc);
 433         }
 434
 435         rc = lprocfs_add_vars(seq->lss_proc_dir,
 436                               seq_server_proc_list, seq);
 437         if (rc) {
 438                 CERROR("%s: Can't init sequence manager "
 439                        "proc, rc %d\n", seq->lss_name, rc);
 440                 GOTO(out_cleanup, rc);
 441         }
 442
 443         RETURN(0);
 444
 445 out_cleanup:
 446         seq_server_proc_fini(seq);
 447         return rc;
 448 }
 449
 450 static void seq_server_proc_fini(struct lu_server_seq *seq)
 451 {
 452         ENTRY;
 453         if (seq->lss_proc_dir != NULL) {
 454                 if (!IS_ERR(seq->lss_proc_dir))
 455                         lprocfs_remove(&seq->lss_proc_dir);
 456                 seq->lss_proc_dir = NULL;
 457         }
 458         EXIT;
 459 }
 460 #else
 461 static int seq_server_proc_init(struct lu_server_seq *seq)
 462 {
 463         return 0;
 464 }
 465
 466 static void seq_server_proc_fini(struct lu_server_seq *seq)
 467 {
 468         return;
 469 }
 470 #endif
 471
 472 int seq_server_init(struct lu_server_seq *seq,
 473                     struct dt_device *dev,
 474                     const char *prefix,
 475                     enum lu_mgr_type type,
 476                     const struct lu_env *env)
 477 {
 478         int rc, is_srv = (type == LUSTRE_SEQ_SERVER);
 479         ENTRY;
 480
 481         LASSERT(dev != NULL);
 482         LASSERT(prefix != NULL);
 483
 484         seq->lss_cli = NULL;
 485         seq->lss_type = type;
 486         range_zero(&seq->lss_space);
 487         sema_init(&seq->lss_sem, 1);
 488
 489         seq->lss_width = is_srv ?
 490                 LUSTRE_SEQ_META_WIDTH : LUSTRE_SEQ_SUPER_WIDTH;
 491
 492         snprintf(seq->lss_name, sizeof(seq->lss_name),
 493                  "%s-%s", (is_srv ? "srv" : "ctl"), prefix);
 494
 495         rc = seq_store_init(seq, env, dev);
 496         if (rc)
 497                 GOTO(out, rc);
 498
 499         /* Request backing store for saved sequence info. */
 500         rc = seq_store_read(seq, env);
 501         if (rc == -ENODATA) {
 502
 503                 /* Nothing is read, init by default value. */
 504                 seq->lss_space = is_srv ?
 505                         LUSTRE_SEQ_ZERO_RANGE:
 506                         LUSTRE_SEQ_SPACE_RANGE;
 507
 508                 CDEBUG(D_INFO, "%s: No data found "
 509                        "on store. Initialize space\n",
 510                        seq->lss_name);
 511
 512                 /* Save default controller value to store. */
 513                 rc = seq_store_write(seq, env);
 514                 if (rc) {
 515                         CERROR("%s: Can't write space data, "
 516                                "rc %d\n", seq->lss_name, rc);
 517                 }
 518         } else if (rc) {
 519                 CERROR("%s: Can't read space data, rc %d\n",
 520                        seq->lss_name, rc);
 521                 GOTO(out, rc);
 522         }
 523
 524         if (is_srv) {
 525                 LASSERT(range_is_sane(&seq->lss_space));
 526         } else {
 527                 LASSERT(!range_is_zero(&seq->lss_space) &&
 528                         range_is_sane(&seq->lss_space));
 529         }
 530
 531         rc  = seq_server_proc_init(seq);
 532         if (rc)
 533                 GOTO(out, rc);
 534
 535         EXIT;
 536 out:
 537         if (rc)
 538                 seq_server_fini(seq, env);
 539         return rc;
 540 }
 541 EXPORT_SYMBOL(seq_server_init);
 542
 543 void seq_server_fini(struct lu_server_seq *seq,
 544                      const struct lu_env *env)
 545 {
 546         ENTRY;
 547
 548         seq_server_proc_fini(seq);
 549         seq_store_fini(seq, env);
 550
 551         EXIT;
 552 }
 553 EXPORT_SYMBOL(seq_server_fini);
 554
 555 cfs_proc_dir_entry_t *seq_type_proc_dir = NULL;
 556
 557 static int __init fid_mod_init(void)
 558 {
 559         seq_type_proc_dir = lprocfs_register(LUSTRE_SEQ_NAME,
 560                                              proc_lustre_root,
 561                                              NULL, NULL);
 562         if (IS_ERR(seq_type_proc_dir))
 563                 return PTR_ERR(seq_type_proc_dir);
 564
 565         LU_CONTEXT_KEY_INIT(&seq_thread_key);
 566         lu_context_key_register(&seq_thread_key);
 567         return 0;
 568 }
 569
 570 static void __exit fid_mod_exit(void)
 571 {
 572         lu_context_key_degister(&seq_thread_key);
 573         if (seq_type_proc_dir != NULL && !IS_ERR(seq_type_proc_dir)) {
 574                 lprocfs_remove(&seq_type_proc_dir);
 575                 seq_type_proc_dir = NULL;
 576         }
 577 }
 578
 579 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
 580 MODULE_DESCRIPTION("Lustre FID Module");
 581 MODULE_LICENSE("GPL");
 582
 583 cfs_module(fid, "0.1.0", fid_mod_init, fid_mod_exit);
 584 #endif