lustre/lov/lov_cl_internal.h

   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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2015, 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 /*
  37  * This file is part of Lustre, http://www.lustre.org/
  38  * Lustre is a trademark of Sun Microsystems, Inc.
  39  *
  40  * Internal interfaces of LOV layer.
  41  *
  42  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  43  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
  44  */
  45
  46 #ifndef LOV_CL_INTERNAL_H
  47 #define LOV_CL_INTERNAL_H
  48
  49 #include <libcfs/libcfs.h>
  50 #include <obd.h>
  51 #include <cl_object.h>
  52 #include "lov_internal.h"
  53
  54 /** \defgroup lov lov
  55  * Logical object volume layer. This layer implements data striping (raid0).
  56  *
  57  * At the lov layer top-entity (object, page, lock, io) is connected to one or
  58  * more sub-entities: top-object, representing a file is connected to a set of
  59  * sub-objects, each representing a stripe, file-level top-lock is connected
  60  * to a set of per-stripe sub-locks, top-page is connected to a (single)
  61  * sub-page, and a top-level IO is connected to a set of (potentially
  62  * concurrent) sub-IO's.
  63  *
  64  * Sub-object, sub-page, and sub-io have well-defined top-object and top-page
  65  * respectively, while a single sub-lock can be part of multiple top-locks.
  66  *
  67  * Reference counting models are different for different types of entities:
  68  *
  69  *     - top-object keeps a reference to its sub-objects, and destroys them
  70  *       when it is destroyed.
  71  *
  72  *     - top-page keeps a reference to its sub-page, and destroys it when it
  73  *       is destroyed.
  74  *
  75  *     - IO's are not reference counted.
  76  *
  77  * To implement a connection between top and sub entities, lov layer is split
  78  * into two pieces: lov ("upper half"), and lovsub ("bottom half"), both
  79  * implementing full set of cl-interfaces. For example, top-object has vvp and
  80  * lov layers, and it's sub-object has lovsub and osc layers. lovsub layer is
  81  * used to track child-parent relationship.
  82  *
  83  * @{
  84  */
  85
  86 struct lovsub_device;
  87 struct lovsub_object;
  88 struct lovsub_lock;
  89
  90 enum lov_device_flags {
  91         LOV_DEV_INITIALIZED = 1 << 0
  92 };
  93
  94 /*
  95  * Upper half.
  96  */
  97
  98 struct lov_device {
  99         /*
 100          * XXX Locking of lov-private data is missing.
 101          */
 102         struct cl_device          ld_cl;
 103         struct lov_obd           *ld_lov;
 104         /** size of lov_device::ld_target[] array */
 105         __u32                     ld_target_nr;
 106         struct lovsub_device    **ld_target;
 107         __u32                     ld_flags;
 108 };
 109
 110 /**
 111  * Layout type.
 112  */
 113 enum lov_layout_type {
 114         LLT_EMPTY,      /** empty file without body (mknod + truncate) */
 115         LLT_RAID0,      /** striped file */
 116         LLT_RELEASED,   /** file with no objects (data in HSM) */
 117         LLT_NR
 118 };
 119
 120 static inline char *llt2str(enum lov_layout_type llt)
 121 {
 122         switch (llt) {
 123         case LLT_EMPTY:
 124                 return "EMPTY";
 125         case LLT_RAID0:
 126                 return "RAID0";
 127         case LLT_RELEASED:
 128                 return "RELEASED";
 129         case LLT_NR:
 130                 LBUG();
 131         }
 132         LBUG();
 133         return "";
 134 }
 135
 136 /**
 137  * lov-specific file state.
 138  *
 139  * lov object has particular layout type, determining how top-object is built
 140  * on top of sub-objects. Layout type can change dynamically. When this
 141  * happens, lov_object::lo_type_guard semaphore is taken in exclusive mode,
 142  * all state pertaining to the old layout type is destroyed, and new state is
 143  * constructed. All object methods take said semaphore in the shared mode,
 144  * providing serialization against transition between layout types.
 145  *
 146  * To avoid multiple `if' or `switch' statements, selecting behavior for the
 147  * current layout type, object methods perform double-dispatch, invoking
 148  * function corresponding to the current layout type.
 149  */
 150 struct lov_object {
 151         struct cl_object       lo_cl;
 152         /**
 153          * Serializes object operations with transitions between layout types.
 154          *
 155          * This semaphore is taken in shared mode by all object methods, and
 156          * is taken in exclusive mode when object type is changed.
 157          *
 158          * \see lov_object::lo_type
 159          */
 160         struct rw_semaphore     lo_type_guard;
 161         /**
 162          * Type of an object. Protected by lov_object::lo_type_guard.
 163          */
 164         enum lov_layout_type    lo_type;
 165         /**
 166          * True if layout is invalid. This bit is cleared when layout lock
 167          * is lost.
 168          */
 169         bool                    lo_layout_invalid;
 170         /**
 171          * How many IOs are on going on this object. Layout can be changed
 172          * only if there is no active IO.
 173          */
 174         atomic_t               lo_active_ios;
 175         /**
 176          * Waitq - wait for no one else is using lo_lsm
 177          */
 178         wait_queue_head_t       lo_waitq;
 179         /**
 180          * Layout metadata. NULL if empty layout.
 181          */
 182         struct lov_stripe_md  *lo_lsm;
 183
 184         union lov_layout_state {
 185                 struct lov_layout_raid0 {
 186                         unsigned               lo_nr;
 187                         /**
 188                          * When this is true, lov_object::lo_attr contains
 189                          * valid up to date attributes for a top-level
 190                          * object. This field is reset to 0 when attributes of
 191                          * any sub-object change.
 192                          */
 193                         int                    lo_attr_valid;
 194                         /**
 195                          * Array of sub-objects. Allocated when top-object is
 196                          * created (lov_init_raid0()).
 197                          *
 198                          * Top-object is a strict master of its sub-objects:
 199                          * it is created before them, and outlives its
 200                          * children (this later is necessary so that basic
 201                          * functions like cl_object_top() always
 202                          * work). Top-object keeps a reference on every
 203                          * sub-object.
 204                          *
 205                          * When top-object is destroyed (lov_delete_raid0())
 206                          * it releases its reference to a sub-object and waits
 207                          * until the latter is finally destroyed.
 208                          *
 209                          * May be vmalloc'd, must be freed with OBD_FREE_LARGE.
 210                          */
 211                         struct lovsub_object **lo_sub;
 212                         /**
 213                          * protect lo_sub
 214                          */
 215                         spinlock_t              lo_sub_lock;
 216                         /**
 217                          * Cached object attribute, built from sub-object
 218                          * attributes.
 219                          */
 220                         struct cl_attr         lo_attr;
 221                 } raid0;
 222                 struct lov_layout_state_empty {
 223                 } empty;
 224                 struct lov_layout_state_released {
 225                 } released;
 226         } u;
 227         /**
 228          * Thread that acquired lov_object::lo_type_guard in an exclusive
 229          * mode.
 230          */
 231         struct task_struct            *lo_owner;
 232 };
 233
 234 /**
 235  * State lov_lock keeps for each sub-lock.
 236  */
 237 struct lov_lock_sub {
 238         /** sub-lock itself */
 239         struct cl_lock          sub_lock;
 240         /** Set if the sublock has ever been enqueued, meaning it may
 241          * hold resources of underlying layers */
 242         unsigned int            sub_is_enqueued:1,
 243                                 sub_initialized:1;
 244         int                     sub_stripe;
 245 };
 246
 247 /**
 248  * lov-specific lock state.
 249  */
 250 struct lov_lock {
 251         struct cl_lock_slice    lls_cl;
 252         /** Number of sub-locks in this lock */
 253         int                     lls_nr;
 254         /** sublock array */
 255         struct lov_lock_sub     lls_sub[0];
 256 };
 257
 258 struct lov_page {
 259         struct cl_page_slice    lps_cl;
 260         unsigned int            lps_stripe; /* stripe index */
 261 };
 262
 263 /*
 264  * Bottom half.
 265  */
 266
 267 struct lovsub_device {
 268         struct cl_device   acid_cl;
 269         struct cl_device  *acid_next;
 270 };
 271
 272 struct lovsub_object {
 273         struct cl_object_header lso_header;
 274         struct cl_object        lso_cl;
 275         struct lov_object      *lso_super;
 276         int                     lso_index;
 277 };
 278
 279 /**
 280  * Lock state at lovsub layer.
 281  */
 282 struct lovsub_lock {
 283         struct cl_lock_slice  lss_cl;
 284 };
 285
 286 /**
 287  * Describe the environment settings for sublocks.
 288  */
 289 struct lov_sublock_env {
 290         const struct lu_env *lse_env;
 291         struct cl_io        *lse_io;
 292 };
 293
 294 struct lovsub_page {
 295         struct cl_page_slice lsb_cl;
 296 };
 297
 298
 299 struct lov_thread_info {
 300         struct cl_object_conf   lti_stripe_conf;
 301         struct lu_fid           lti_fid;
 302         struct ost_lvb          lti_lvb;
 303         struct cl_2queue        lti_cl2q;
 304         struct cl_page_list     lti_plist;
 305         wait_queue_t            lti_waiter;
 306 };
 307
 308 /**
 309  * State that lov_io maintains for every sub-io.
 310  */
 311 struct lov_io_sub {
 312         __u16                   sub_stripe;
 313         /**
 314          * environment's refcheck.
 315          *
 316          * \see cl_env_get()
 317          */
 318         __u16                   sub_refcheck;
 319         /**
 320          * true, iff cl_io_init() was successfully executed against
 321          * lov_io_sub::sub_io.
 322          */
 323         __u16                   sub_io_initialized:1,
 324         /**
 325          * True, iff lov_io_sub::sub_io and lov_io_sub::sub_env weren't
 326          * allocated, but borrowed from a per-device emergency pool.
 327          */
 328                                 sub_borrowed:1;
 329         /**
 330          * Linkage into a list (hanging off lov_io::lis_active) of all
 331          * sub-io's active for the current IO iteration.
 332          */
 333         struct list_head        sub_linkage;
 334         /**
 335          * sub-io for a stripe. Ideally sub-io's can be stopped and resumed
 336          * independently, with lov acting as a scheduler to maximize overall
 337          * throughput.
 338          */
 339         struct cl_io            *sub_io;
 340         /**
 341          * environment, in which sub-io executes.
 342          */
 343         struct lu_env           *sub_env;
 344 };
 345
 346 /**
 347  * IO state private for LOV.
 348  */
 349 struct lov_io {
 350         /** super-class */
 351         struct cl_io_slice lis_cl;
 352         /**
 353          * Pointer to the object slice. This is a duplicate of
 354          * lov_io::lis_cl::cis_object.
 355          */
 356         struct lov_object *lis_object;
 357         /**
 358          * Original end-of-io position for this IO, set by the upper layer as
 359          * cl_io::u::ci_rw::pos + cl_io::u::ci_rw::count. lov remembers this,
 360          * changes pos and count to fit IO into a single stripe and uses saved
 361          * value to determine when IO iterations have to stop.
 362          *
 363          * This is used only for CIT_READ and CIT_WRITE io's.
 364          */
 365         loff_t             lis_io_endpos;
 366
 367         /**
 368          * starting position within a file, for the current io loop iteration
 369          * (stripe), used by ci_io_loop().
 370          */
 371         loff_t                   lis_pos;
 372         /**
 373          * end position with in a file, for the current stripe io. This is
 374          * exclusive (i.e., next offset after last byte affected by io).
 375          */
 376         loff_t                   lis_endpos;
 377
 378         int                     lis_stripe_count;
 379         int                     lis_active_subios;
 380
 381         /**
 382          * the index of ls_single_subio in ls_subios array
 383          */
 384         int                     lis_single_subio_index;
 385         struct cl_io            lis_single_subio;
 386
 387         /**
 388          * size of ls_subios array, actually the highest stripe #
 389          * May be vmalloc'd, must be freed with OBD_FREE_LARGE().
 390          */
 391         int                     lis_nr_subios;
 392         struct lov_io_sub       *lis_subs;
 393         /**
 394          * List of active sub-io's.
 395          */
 396         struct list_head        lis_active;
 397 };
 398
 399 struct lov_session {
 400         struct lov_io          ls_io;
 401         struct lov_sublock_env ls_subenv;
 402 };
 403
 404 extern struct lu_device_type lov_device_type;
 405 extern struct lu_device_type lovsub_device_type;
 406
 407 extern struct lu_context_key lov_key;
 408 extern struct lu_context_key lov_session_key;
 409
 410 extern struct kmem_cache *lov_lock_kmem;
 411 extern struct kmem_cache *lov_object_kmem;
 412 extern struct kmem_cache *lov_thread_kmem;
 413 extern struct kmem_cache *lov_session_kmem;
 414
 415 extern struct kmem_cache *lovsub_lock_kmem;
 416 extern struct kmem_cache *lovsub_object_kmem;
 417
 418 int   lov_object_init     (const struct lu_env *env, struct lu_object *obj,
 419                            const struct lu_object_conf *conf);
 420 int   lovsub_object_init  (const struct lu_env *env, struct lu_object *obj,
 421                            const struct lu_object_conf *conf);
 422 int   lov_lock_init       (const struct lu_env *env, struct cl_object *obj,
 423                            struct cl_lock *lock, const struct cl_io *io);
 424 int   lov_io_init         (const struct lu_env *env, struct cl_object *obj,
 425                            struct cl_io *io);
 426 int   lovsub_lock_init    (const struct lu_env *env, struct cl_object *obj,
 427                            struct cl_lock *lock, const struct cl_io *io);
 428
 429 int   lov_lock_init_raid0 (const struct lu_env *env, struct cl_object *obj,
 430                            struct cl_lock *lock, const struct cl_io *io);
 431 int   lov_lock_init_empty (const struct lu_env *env, struct cl_object *obj,
 432                            struct cl_lock *lock, const struct cl_io *io);
 433 int   lov_io_init_raid0   (const struct lu_env *env, struct cl_object *obj,
 434                            struct cl_io *io);
 435 int   lov_io_init_empty   (const struct lu_env *env, struct cl_object *obj,
 436                            struct cl_io *io);
 437 int   lov_io_init_released(const struct lu_env *env, struct cl_object *obj,
 438                            struct cl_io *io);
 439
 440 struct lov_io_sub *lov_sub_get(const struct lu_env *env, struct lov_io *lio,
 441                                int stripe);
 442
 443 int   lov_page_init       (const struct lu_env *env, struct cl_object *ob,
 444                            struct cl_page *page, pgoff_t index);
 445 int   lovsub_page_init    (const struct lu_env *env, struct cl_object *ob,
 446                            struct cl_page *page, pgoff_t index);
 447 int   lov_page_init_empty (const struct lu_env *env, struct cl_object *obj,
 448                            struct cl_page *page, pgoff_t index);
 449 int   lov_page_init_raid0 (const struct lu_env *env, struct cl_object *obj,
 450                            struct cl_page *page, pgoff_t index);
 451 struct lu_object *lov_object_alloc   (const struct lu_env *env,
 452                                       const struct lu_object_header *hdr,
 453                                       struct lu_device *dev);
 454 struct lu_object *lovsub_object_alloc(const struct lu_env *env,
 455                                       const struct lu_object_header *hdr,
 456                                       struct lu_device *dev);
 457
 458 struct lov_stripe_md *lov_lsm_addref(struct lov_object *lov);
 459 int lov_page_stripe(const struct cl_page *page);
 460
 461 #define lov_foreach_target(lov, var)                    \
 462         for (var = 0; var < lov_targets_nr(lov); ++var)
 463
 464 /*****************************************************************************
 465  *
 466  * Type conversions.
 467  *
 468  * Accessors.
 469  *
 470  */
 471
 472 static inline struct lov_session *lov_env_session(const struct lu_env *env)
 473 {
 474         struct lov_session *ses;
 475
 476         ses = lu_context_key_get(env->le_ses, &lov_session_key);
 477         LASSERT(ses != NULL);
 478         return ses;
 479 }
 480
 481 static inline struct lov_io *lov_env_io(const struct lu_env *env)
 482 {
 483         return &lov_env_session(env)->ls_io;
 484 }
 485
 486 static inline int lov_is_object(const struct lu_object *obj)
 487 {
 488         return obj->lo_dev->ld_type == &lov_device_type;
 489 }
 490
 491 static inline int lovsub_is_object(const struct lu_object *obj)
 492 {
 493         return obj->lo_dev->ld_type == &lovsub_device_type;
 494 }
 495
 496 static inline struct lu_device *lov2lu_dev(struct lov_device *lov)
 497 {
 498         return &lov->ld_cl.cd_lu_dev;
 499 }
 500
 501 static inline struct lov_device *lu2lov_dev(const struct lu_device *d)
 502 {
 503         LINVRNT(d->ld_type == &lov_device_type);
 504         return container_of0(d, struct lov_device, ld_cl.cd_lu_dev);
 505 }
 506
 507 static inline struct cl_device *lovsub2cl_dev(struct lovsub_device *lovsub)
 508 {
 509         return &lovsub->acid_cl;
 510 }
 511
 512 static inline struct lu_device *lovsub2lu_dev(struct lovsub_device *lovsub)
 513 {
 514         return &lovsub2cl_dev(lovsub)->cd_lu_dev;
 515 }
 516
 517 static inline struct lovsub_device *lu2lovsub_dev(const struct lu_device *d)
 518 {
 519         LINVRNT(d->ld_type == &lovsub_device_type);
 520         return container_of0(d, struct lovsub_device, acid_cl.cd_lu_dev);
 521 }
 522
 523 static inline struct lovsub_device *cl2lovsub_dev(const struct cl_device *d)
 524 {
 525         LINVRNT(d->cd_lu_dev.ld_type == &lovsub_device_type);
 526         return container_of0(d, struct lovsub_device, acid_cl);
 527 }
 528
 529 static inline struct lu_object *lov2lu(struct lov_object *lov)
 530 {
 531         return &lov->lo_cl.co_lu;
 532 }
 533
 534 static inline struct cl_object *lov2cl(struct lov_object *lov)
 535 {
 536         return &lov->lo_cl;
 537 }
 538
 539 static inline struct lov_object *lu2lov(const struct lu_object *obj)
 540 {
 541         LINVRNT(lov_is_object(obj));
 542         return container_of0(obj, struct lov_object, lo_cl.co_lu);
 543 }
 544
 545 static inline struct lov_object *cl2lov(const struct cl_object *obj)
 546 {
 547         LINVRNT(lov_is_object(&obj->co_lu));
 548         return container_of0(obj, struct lov_object, lo_cl);
 549 }
 550
 551 static inline struct lu_object *lovsub2lu(struct lovsub_object *los)
 552 {
 553         return &los->lso_cl.co_lu;
 554 }
 555
 556 static inline struct cl_object *lovsub2cl(struct lovsub_object *los)
 557 {
 558         return &los->lso_cl;
 559 }
 560
 561 static inline struct lovsub_object *cl2lovsub(const struct cl_object *obj)
 562 {
 563         LINVRNT(lovsub_is_object(&obj->co_lu));
 564         return container_of0(obj, struct lovsub_object, lso_cl);
 565 }
 566
 567 static inline struct lovsub_object *lu2lovsub(const struct lu_object *obj)
 568 {
 569         LINVRNT(lovsub_is_object(obj));
 570         return container_of0(obj, struct lovsub_object, lso_cl.co_lu);
 571 }
 572
 573 static inline struct lovsub_lock *
 574 cl2lovsub_lock(const struct cl_lock_slice *slice)
 575 {
 576         LINVRNT(lovsub_is_object(&slice->cls_obj->co_lu));
 577         return container_of(slice, struct lovsub_lock, lss_cl);
 578 }
 579
 580 static inline struct lovsub_lock *cl2sub_lock(const struct cl_lock *lock)
 581 {
 582         const struct cl_lock_slice *slice;
 583
 584         slice = cl_lock_at(lock, &lovsub_device_type);
 585         LASSERT(slice != NULL);
 586         return cl2lovsub_lock(slice);
 587 }
 588
 589 static inline struct lov_lock *cl2lov_lock(const struct cl_lock_slice *slice)
 590 {
 591         LINVRNT(lov_is_object(&slice->cls_obj->co_lu));
 592         return container_of(slice, struct lov_lock, lls_cl);
 593 }
 594
 595 static inline struct lov_page *cl2lov_page(const struct cl_page_slice *slice)
 596 {
 597         LINVRNT(lov_is_object(&slice->cpl_obj->co_lu));
 598         return container_of0(slice, struct lov_page, lps_cl);
 599 }
 600
 601 static inline struct lovsub_page *
 602 cl2lovsub_page(const struct cl_page_slice *slice)
 603 {
 604         LINVRNT(lovsub_is_object(&slice->cpl_obj->co_lu));
 605         return container_of0(slice, struct lovsub_page, lsb_cl);
 606 }
 607
 608 static inline struct lov_io *cl2lov_io(const struct lu_env *env,
 609                                 const struct cl_io_slice *ios)
 610 {
 611         struct lov_io *lio;
 612
 613         lio = container_of(ios, struct lov_io, lis_cl);
 614         LASSERT(lio == lov_env_io(env));
 615         return lio;
 616 }
 617
 618 static inline int lov_targets_nr(const struct lov_device *lov)
 619 {
 620         return lov->ld_lov->desc.ld_tgt_count;
 621 }
 622
 623 static inline struct lov_thread_info *lov_env_info(const struct lu_env *env)
 624 {
 625         struct lov_thread_info *info;
 626
 627         info = lu_context_key_get(&env->le_ctx, &lov_key);
 628         LASSERT(info != NULL);
 629         return info;
 630 }
 631
 632 static inline struct lov_layout_raid0 *lov_r0(struct lov_object *lov)
 633 {
 634         LASSERT(lov->lo_type == LLT_RAID0);
 635         LASSERT(lov->lo_lsm->lsm_magic == LOV_MAGIC ||
 636                 lov->lo_lsm->lsm_magic == LOV_MAGIC_V3);
 637         return &lov->u.raid0;
 638 }
 639
 640 /* lov_pack.c */
 641 int lov_getstripe(struct lov_object *obj, struct lov_stripe_md *lsm,
 642                   struct lov_user_md __user *lump);
 643
 644 /** @} lov */
 645
 646 #endif