lustre/osc/osc_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, 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 /*
  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 OSC layer.
  41  *
  42  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  43  *   Author: Jinshan Xiong <jinshan.xiong@whamcloud.com>
  44  */
  45
  46 #ifndef OSC_CL_INTERNAL_H
  47 #define OSC_CL_INTERNAL_H
  48
  49 #include <libcfs/libcfs.h>
  50 #include <obd.h>
  51 /* osc_build_res_name() */
  52 #include <cl_object.h>
  53 #include <lclient.h>
  54 #include "osc_internal.h"
  55
  56 /** \defgroup osc osc
  57  *  @{
  58  */
  59
  60 struct osc_extent;
  61
  62 /**
  63  * State maintained by osc layer for each IO context.
  64  */
  65 struct osc_io {
  66         /** super class */
  67         struct cl_io_slice oi_cl;
  68         /** true if this io is lockless. */
  69         int                oi_lockless;
  70         /** active extents, we know how many bytes is going to be written,
  71          * so having an active extent will prevent it from being fragmented */
  72         struct osc_extent *oi_active;
  73         /** partially truncated extent, we need to hold this extent to prevent
  74          * page writeback from happening. */
  75         struct osc_extent *oi_trunc;
  76
  77         int oi_lru_reserved;
  78
  79         struct obd_info    oi_info;
  80         struct obdo        oi_oa;
  81         struct osc_async_cbargs {
  82                 bool              opc_rpc_sent;
  83                 int               opc_rc;
  84                 struct completion       opc_sync;
  85         } oi_cbarg;
  86 };
  87
  88 /**
  89  * State of transfer for osc.
  90  */
  91 struct osc_req {
  92         struct cl_req_slice    or_cl;
  93 };
  94
  95 /**
  96  * State maintained by osc layer for the duration of a system call.
  97  */
  98 struct osc_session {
  99         struct osc_io       os_io;
 100 };
 101
 102 #define OTI_PVEC_SIZE 256
 103 struct osc_thread_info {
 104         struct ldlm_res_id      oti_resname;
 105         ldlm_policy_data_t      oti_policy;
 106         struct cl_lock_descr    oti_descr;
 107         struct cl_attr          oti_attr;
 108         struct lustre_handle    oti_handle;
 109         struct cl_page_list     oti_plist;
 110         struct cl_io            oti_io;
 111         void                    *oti_pvec[OTI_PVEC_SIZE];
 112         /**
 113          * Fields used by cl_lock_discard_pages().
 114          */
 115         pgoff_t                 oti_next_index;
 116         pgoff_t                 oti_fn_index; /* first non-overlapped index */
 117 };
 118
 119 struct osc_object {
 120         struct cl_object   oo_cl;
 121         struct lov_oinfo  *oo_oinfo;
 122         /**
 123          * True if locking against this stripe got -EUSERS.
 124          */
 125         int                oo_contended;
 126         cfs_time_t         oo_contention_time;
 127 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 128         /**
 129          * IO context used for invariant checks in osc_lock_has_pages().
 130          */
 131         struct cl_io       oo_debug_io;
 132         /** Serialization object for osc_object::oo_debug_io. */
 133         struct mutex       oo_debug_mutex;
 134 #endif
 135         /**
 136          * List of pages in transfer.
 137          */
 138         struct list_head        oo_inflight[CRT_NR];
 139         /**
 140          * Lock, protecting ccc_object::cob_inflight, because a seat-belt is
 141          * locked during take-off and landing.
 142          */
 143         spinlock_t              oo_seatbelt;
 144
 145         /**
 146          * used by the osc to keep track of what objects to build into rpcs.
 147          * Protected by client_obd->cli_loi_list_lock.
 148          */
 149         struct list_head        oo_ready_item;
 150         struct list_head        oo_hp_ready_item;
 151         struct list_head        oo_write_item;
 152         struct list_head        oo_read_item;
 153
 154         /**
 155          * extent is a red black tree to manage (async) dirty pages.
 156          */
 157         struct rb_root       oo_root;
 158         /**
 159          * Manage write(dirty) extents.
 160          */
 161         struct list_head        oo_hp_exts;     /* list of hp extents */
 162         struct list_head        oo_urgent_exts; /* list of writeback extents */
 163         struct list_head        oo_rpc_exts;
 164
 165         struct list_head        oo_reading_exts;
 166
 167         atomic_t         oo_nr_reads;
 168         atomic_t         oo_nr_writes;
 169
 170         /** Protect extent tree. Will be used to protect
 171          * oo_{read|write}_pages soon. */
 172         spinlock_t          oo_lock;
 173
 174         /**
 175          * Radix tree for caching pages
 176          */
 177         struct radix_tree_root  oo_tree;
 178         spinlock_t              oo_tree_lock;
 179         unsigned long           oo_npages;
 180 };
 181
 182 static inline void osc_object_lock(struct osc_object *obj)
 183 {
 184         spin_lock(&obj->oo_lock);
 185 }
 186
 187 static inline int osc_object_trylock(struct osc_object *obj)
 188 {
 189         return spin_trylock(&obj->oo_lock);
 190 }
 191
 192 static inline void osc_object_unlock(struct osc_object *obj)
 193 {
 194         spin_unlock(&obj->oo_lock);
 195 }
 196
 197 static inline int osc_object_is_locked(struct osc_object *obj)
 198 {
 199 #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
 200         return spin_is_locked(&obj->oo_lock);
 201 #else
 202         /*
 203          * It is not perfect to return true all the time.
 204          * But since this function is only used for assertion
 205          * and checking, it seems OK.
 206          */
 207         return 1;
 208 #endif
 209 }
 210
 211 /*
 212  * Lock "micro-states" for osc layer.
 213  */
 214 enum osc_lock_state {
 215         OLS_NEW,
 216         OLS_ENQUEUED,
 217         OLS_UPCALL_RECEIVED,
 218         OLS_GRANTED,
 219         OLS_RELEASED,
 220         OLS_BLOCKED,
 221         OLS_CANCELLED
 222 };
 223
 224 /**
 225  * osc-private state of cl_lock.
 226  *
 227  * Interaction with DLM.
 228  *
 229  * CLIO enqueues all DLM locks through ptlrpcd (that is, in "async" mode).
 230  *
 231  * Once receive upcall is invoked, osc_lock remembers a handle of DLM lock in
 232  * osc_lock::ols_handle and a pointer to that lock in osc_lock::ols_lock.
 233  *
 234  * This pointer is protected through a reference, acquired by
 235  * osc_lock_upcall0(). Also, an additional reference is acquired by
 236  * ldlm_lock_addref() call protecting the lock from cancellation, until
 237  * osc_lock_unuse() releases it.
 238  *
 239  * Below is a description of how lock references are acquired and released
 240  * inside of DLM.
 241  *
 242  * - When new lock is created and enqueued to the server (ldlm_cli_enqueue())
 243  *      - ldlm_lock_create()
 244  *          - ldlm_lock_new(): initializes a lock with 2 references. One for
 245  *            the caller (released when reply from the server is received, or on
 246  *            error), and another for the hash table.
 247  *      - ldlm_lock_addref_internal(): protects the lock from cancellation.
 248  *
 249  * - When reply is received from the server (osc_enqueue_interpret())
 250  *      - ldlm_cli_enqueue_fini()
 251  *          - LDLM_LOCK_PUT(): releases caller reference acquired by
 252  *            ldlm_lock_new().
 253  *          - if (rc != 0)
 254  *                ldlm_lock_decref(): error case: matches ldlm_cli_enqueue().
 255  *      - ldlm_lock_decref(): for async locks, matches ldlm_cli_enqueue().
 256  *
 257  * - When lock is being cancelled (ldlm_lock_cancel())
 258  *      - ldlm_lock_destroy()
 259  *          - LDLM_LOCK_PUT(): releases hash-table reference acquired by
 260  *            ldlm_lock_new().
 261  *
 262  * osc_lock is detached from ldlm_lock by osc_lock_detach() that is called
 263  * either when lock is cancelled (osc_lock_blocking()), or when locks is
 264  * deleted without cancellation (e.g., from cl_locks_prune()). In the latter
 265  * case ldlm lock remains in memory, and can be re-attached to osc_lock in the
 266  * future.
 267  */
 268 struct osc_lock {
 269         struct cl_lock_slice     ols_cl;
 270         /** underlying DLM lock */
 271         struct ldlm_lock        *ols_lock;
 272         /** lock value block */
 273         struct ost_lvb           ols_lvb;
 274         /** DLM flags with which osc_lock::ols_lock was enqueued */
 275         __u64                    ols_flags;
 276         /** osc_lock::ols_lock handle */
 277         struct lustre_handle     ols_handle;
 278         struct ldlm_enqueue_info ols_einfo;
 279         enum osc_lock_state      ols_state;
 280
 281         /**
 282          * true, if ldlm_lock_addref() was called against
 283          * osc_lock::ols_lock. This is used for sanity checking.
 284          *
 285          * \see osc_lock::ols_has_ref
 286          */
 287         unsigned                  ols_hold :1,
 288         /**
 289          * this is much like osc_lock::ols_hold, except that this bit is
 290          * cleared _after_ reference in released in osc_lock_unuse(). This
 291          * fine distinction is needed because:
 292          *
 293          *     - if ldlm lock still has a reference, osc_ast_data_get() needs
 294          *       to return associated cl_lock (so that a flag is needed that is
 295          *       cleared after ldlm_lock_decref() returned), and
 296          *
 297          *     - ldlm_lock_decref() can invoke blocking ast (for a
 298          *       LDLM_FL_CBPENDING lock), and osc_lock functions like
 299          *       osc_lock_cancel() called from there need to know whether to
 300          *       release lock reference (so that a flag is needed that is
 301          *       cleared before ldlm_lock_decref() is called).
 302          */
 303                                  ols_has_ref:1,
 304         /**
 305          * inherit the lockless attribute from top level cl_io.
 306          * If true, osc_lock_enqueue is able to tolerate the -EUSERS error.
 307          */
 308                                  ols_locklessable:1,
 309         /**
 310          * set by osc_lock_use() to wait until blocking AST enters into
 311          * osc_ldlm_blocking_ast0(), so that cl_lock mutex can be used for
 312          * further synchronization.
 313          */
 314                                  ols_ast_wait:1,
 315         /**
 316          * If the data of this lock has been flushed to server side.
 317          */
 318                                  ols_flush:1,
 319         /**
 320          * if set, the osc_lock is a glimpse lock. For glimpse locks, we treat
 321          * the EVAVAIL error as torerable, this will make upper logic happy
 322          * to wait all glimpse locks to each OSTs to be completed.
 323          * Glimpse lock converts to normal lock if the server lock is
 324          * granted.
 325          * Glimpse lock should be destroyed immediately after use.
 326          */
 327                                  ols_glimpse:1,
 328         /**
 329          * For async glimpse lock.
 330          */
 331                                  ols_agl:1;
 332         /**
 333          * IO that owns this lock. This field is used for a dead-lock
 334          * avoidance by osc_lock_enqueue_wait().
 335          *
 336          * XXX: unfortunately, the owner of a osc_lock is not unique,
 337          * the lock may have multiple users, if the lock is granted and
 338          * then matched.
 339          */
 340         struct osc_io           *ols_owner;
 341 };
 342
 343
 344 /**
 345  * Page state private for osc layer.
 346  */
 347 struct osc_page {
 348         struct cl_page_slice  ops_cl;
 349         /**
 350          * Page queues used by osc to detect when RPC can be formed.
 351          */
 352         struct osc_async_page ops_oap;
 353         /**
 354          * An offset within page from which next transfer starts. This is used
 355          * by cl_page_clip() to submit partial page transfers.
 356          */
 357         int                   ops_from;
 358         /**
 359          * An offset within page at which next transfer ends.
 360          *
 361          * \see osc_page::ops_from.
 362          */
 363         int                   ops_to;
 364         /**
 365          * Boolean, true iff page is under transfer. Used for sanity checking.
 366          */
 367         unsigned              ops_transfer_pinned:1,
 368         /**
 369          * True for a `temporary page' created by read-ahead code, probably
 370          * outside of any DLM lock.
 371          */
 372                               ops_temp:1,
 373         /**
 374          * in LRU?
 375          */
 376                               ops_in_lru:1,
 377         /**
 378          * Set if the page must be transferred with OBD_BRW_SRVLOCK.
 379          */
 380                               ops_srvlock:1;
 381         /**
 382          * lru page list. See osc_lru_{del|use}() in osc_page.c for usage.
 383          */
 384         struct list_head        ops_lru;
 385         /**
 386          * Linkage into a per-osc_object list of pages in flight. For
 387          * debugging.
 388          */
 389         struct list_head        ops_inflight;
 390         /**
 391          * Thread that submitted this page for transfer. For debugging.
 392          */
 393         struct task_struct           *ops_submitter;
 394         /**
 395          * Submit time - the time when the page is starting RPC. For debugging.
 396          */
 397         cfs_time_t            ops_submit_time;
 398 };
 399
 400 extern struct kmem_cache *osc_lock_kmem;
 401 extern struct kmem_cache *osc_object_kmem;
 402 extern struct kmem_cache *osc_thread_kmem;
 403 extern struct kmem_cache *osc_session_kmem;
 404 extern struct kmem_cache *osc_req_kmem;
 405 extern struct kmem_cache *osc_extent_kmem;
 406
 407 extern struct lu_device_type osc_device_type;
 408 extern struct lu_context_key osc_key;
 409 extern struct lu_context_key osc_session_key;
 410
 411 #define OSC_FLAGS (ASYNC_URGENT|ASYNC_READY)
 412
 413 int osc_lock_init(const struct lu_env *env,
 414                   struct cl_object *obj, struct cl_lock *lock,
 415                   const struct cl_io *io);
 416 int osc_io_init  (const struct lu_env *env,
 417                   struct cl_object *obj, struct cl_io *io);
 418 int osc_req_init (const struct lu_env *env, struct cl_device *dev,
 419                   struct cl_req *req);
 420 struct lu_object *osc_object_alloc(const struct lu_env *env,
 421                                    const struct lu_object_header *hdr,
 422                                    struct lu_device *dev);
 423 int osc_page_init(const struct lu_env *env, struct cl_object *obj,
 424                   struct cl_page *page, pgoff_t ind);
 425
 426 void osc_index2policy  (ldlm_policy_data_t *policy, const struct cl_object *obj,
 427                         pgoff_t start, pgoff_t end);
 428 int  osc_lvb_print     (const struct lu_env *env, void *cookie,
 429                         lu_printer_t p, const struct ost_lvb *lvb);
 430
 431 void osc_lru_add_batch(struct client_obd *cli, struct list_head *list);
 432 void osc_page_submit(const struct lu_env *env, struct osc_page *opg,
 433                      enum cl_req_type crt, int brw_flags);
 434 int osc_cancel_async_page(const struct lu_env *env, struct osc_page *ops);
 435 int osc_set_async_flags(struct osc_object *obj, struct osc_page *opg,
 436                         obd_flag async_flags);
 437 int osc_prep_async_page(struct osc_object *osc, struct osc_page *ops,
 438                         struct page *page, loff_t offset);
 439 int osc_queue_async_io(const struct lu_env *env, struct cl_io *io,
 440                        struct osc_page *ops);
 441 int osc_page_cache_add(const struct lu_env *env,
 442                        const struct cl_page_slice *slice, struct cl_io *io);
 443 int osc_teardown_async_page(const struct lu_env *env, struct osc_object *obj,
 444                             struct osc_page *ops);
 445 int osc_flush_async_page(const struct lu_env *env, struct cl_io *io,
 446                          struct osc_page *ops);
 447 int osc_queue_sync_pages(const struct lu_env *env, struct osc_object *obj,
 448                          struct list_head *list, int cmd, int brw_flags);
 449 int osc_cache_truncate_start(const struct lu_env *env, struct osc_io *oio,
 450                              struct osc_object *obj, __u64 size);
 451 void osc_cache_truncate_end(const struct lu_env *env, struct osc_io *oio,
 452                             struct osc_object *obj);
 453 int osc_cache_writeback_range(const struct lu_env *env, struct osc_object *obj,
 454                               pgoff_t start, pgoff_t end, int hp, int discard);
 455 int osc_cache_wait_range(const struct lu_env *env, struct osc_object *obj,
 456                          pgoff_t start, pgoff_t end);
 457 void osc_io_unplug(const struct lu_env *env, struct client_obd *cli,
 458                    struct osc_object *osc, pdl_policy_t pol);
 459 int lru_queue_work(const struct lu_env *env, void *data);
 460
 461 void osc_object_set_contended  (struct osc_object *obj);
 462 void osc_object_clear_contended(struct osc_object *obj);
 463 int  osc_object_is_contended   (struct osc_object *obj);
 464
 465 int  osc_lock_is_lockless      (const struct osc_lock *olck);
 466
 467 /*****************************************************************************
 468  *
 469  * Accessors.
 470  *
 471  */
 472
 473 static inline struct osc_thread_info *osc_env_info(const struct lu_env *env)
 474 {
 475         struct osc_thread_info *info;
 476
 477         info = lu_context_key_get(&env->le_ctx, &osc_key);
 478         LASSERT(info != NULL);
 479         return info;
 480 }
 481
 482 static inline struct osc_session *osc_env_session(const struct lu_env *env)
 483 {
 484         struct osc_session *ses;
 485
 486         ses = lu_context_key_get(env->le_ses, &osc_session_key);
 487         LASSERT(ses != NULL);
 488         return ses;
 489 }
 490
 491 static inline struct osc_io *osc_env_io(const struct lu_env *env)
 492 {
 493         return &osc_env_session(env)->os_io;
 494 }
 495
 496 static inline int osc_is_object(const struct lu_object *obj)
 497 {
 498         return obj->lo_dev->ld_type == &osc_device_type;
 499 }
 500
 501 static inline struct osc_device *lu2osc_dev(const struct lu_device *d)
 502 {
 503         LINVRNT(d->ld_type == &osc_device_type);
 504         return container_of0(d, struct osc_device, od_cl.cd_lu_dev);
 505 }
 506
 507 static inline struct obd_export *osc_export(const struct osc_object *obj)
 508 {
 509         return lu2osc_dev(obj->oo_cl.co_lu.lo_dev)->od_exp;
 510 }
 511
 512 static inline struct client_obd *osc_cli(const struct osc_object *obj)
 513 {
 514         return &osc_export(obj)->exp_obd->u.cli;
 515 }
 516
 517 static inline struct osc_object *cl2osc(const struct cl_object *obj)
 518 {
 519         LINVRNT(osc_is_object(&obj->co_lu));
 520         return container_of0(obj, struct osc_object, oo_cl);
 521 }
 522
 523 static inline struct cl_object *osc2cl(const struct osc_object *obj)
 524 {
 525         return (struct cl_object *)&obj->oo_cl;
 526 }
 527
 528 static inline ldlm_mode_t osc_cl_lock2ldlm(enum cl_lock_mode mode)
 529 {
 530         LASSERT(mode == CLM_READ || mode == CLM_WRITE || mode == CLM_GROUP);
 531         if (mode == CLM_READ)
 532                 return LCK_PR;
 533         else if (mode == CLM_WRITE)
 534                 return LCK_PW;
 535         else
 536                 return LCK_GROUP;
 537 }
 538
 539 static inline enum cl_lock_mode osc_ldlm2cl_lock(ldlm_mode_t mode)
 540 {
 541         LASSERT(mode == LCK_PR || mode == LCK_PW || mode == LCK_GROUP);
 542         if (mode == LCK_PR)
 543                 return CLM_READ;
 544         else if (mode == LCK_PW)
 545                 return CLM_WRITE;
 546         else
 547                 return CLM_GROUP;
 548 }
 549
 550 static inline struct osc_page *cl2osc_page(const struct cl_page_slice *slice)
 551 {
 552         LINVRNT(osc_is_object(&slice->cpl_obj->co_lu));
 553         return container_of0(slice, struct osc_page, ops_cl);
 554 }
 555
 556 static inline struct osc_page *oap2osc(struct osc_async_page *oap)
 557 {
 558         return container_of0(oap, struct osc_page, ops_oap);
 559 }
 560
 561 static inline pgoff_t osc_index(struct osc_page *opg)
 562 {
 563         return opg->ops_cl.cpl_index;
 564 }
 565
 566 static inline struct cl_page *oap2cl_page(struct osc_async_page *oap)
 567 {
 568         return oap2osc(oap)->ops_cl.cpl_page;
 569 }
 570
 571 static inline struct osc_page *oap2osc_page(struct osc_async_page *oap)
 572 {
 573         return (struct osc_page *)container_of(oap, struct osc_page, ops_oap);
 574 }
 575
 576 static inline struct osc_lock *cl2osc_lock(const struct cl_lock_slice *slice)
 577 {
 578         LINVRNT(osc_is_object(&slice->cls_obj->co_lu));
 579         return container_of0(slice, struct osc_lock, ols_cl);
 580 }
 581
 582 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
 583 {
 584         return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
 585 }
 586
 587 static inline int osc_io_srvlock(struct osc_io *oio)
 588 {
 589         return (oio->oi_lockless && !oio->oi_cl.cis_io->ci_no_srvlock);
 590 }
 591
 592 enum osc_extent_state {
 593         OES_INV       = 0, /** extent is just initialized or destroyed */
 594         OES_ACTIVE    = 1, /** process is using this extent */
 595         OES_CACHE     = 2, /** extent is ready for IO */
 596         OES_LOCKING   = 3, /** locking page to prepare IO */
 597         OES_LOCK_DONE = 4, /** locking finished, ready to send */
 598         OES_RPC       = 5, /** in RPC */
 599         OES_TRUNC     = 6, /** being truncated */
 600         OES_STATE_MAX
 601 };
 602
 603 /**
 604  * osc_extent data to manage dirty pages.
 605  * osc_extent has the following attributes:
 606  * 1. all pages in the same must be in one RPC in write back;
 607  * 2. # of pages must be less than max_pages_per_rpc - implied by 1;
 608  * 3. must be covered by only 1 osc_lock;
 609  * 4. exclusive. It's impossible to have overlapped osc_extent.
 610  *
 611  * The lifetime of an extent is from when the 1st page is dirtied to when
 612  * all pages inside it are written out.
 613  *
 614  * LOCKING ORDER
 615  * =============
 616  * page lock -> client_obd_list_lock -> object lock(osc_object::oo_lock)
 617  */
 618 struct osc_extent {
 619         /** red-black tree node */
 620         struct rb_node          oe_node;
 621         /** osc_object of this extent */
 622         struct osc_object       *oe_obj;
 623         /** refcount, removed from red-black tree if reaches zero. */
 624         atomic_t                oe_refc;
 625         /** busy if non-zero */
 626         atomic_t                oe_users;
 627         /** link list of osc_object's oo_{hp|urgent|locking}_exts. */
 628         struct list_head        oe_link;
 629         /** state of this extent */
 630         unsigned int            oe_state;
 631         /** flags for this extent. */
 632         unsigned int            oe_intree:1,
 633         /** 0 is write, 1 is read */
 634                                 oe_rw:1,
 635                                 oe_srvlock:1,
 636                                 oe_memalloc:1,
 637         /** an ACTIVE extent is going to be truncated, so when this extent
 638          * is released, it will turn into TRUNC state instead of CACHE. */
 639                                 oe_trunc_pending:1,
 640         /** this extent should be written asap and someone may wait for the
 641          * write to finish. This bit is usually set along with urgent if
 642          * the extent was CACHE state.
 643          * fsync_wait extent can't be merged because new extent region may
 644          * exceed fsync range. */
 645                                 oe_fsync_wait:1,
 646         /** covering lock is being canceled */
 647                                 oe_hp:1,
 648         /** this extent should be written back asap. set if one of pages is
 649          * called by page WB daemon, or sync write or reading requests. */
 650                                 oe_urgent:1;
 651         /** how many grants allocated for this extent.
 652          *  Grant allocated for this extent. There is no grant allocated
 653          *  for reading extents and sync write extents. */
 654         unsigned int            oe_grants;
 655         /** # of dirty pages in this extent */
 656         unsigned int            oe_nr_pages;
 657         /** list of pending oap pages. Pages in this list are NOT sorted. */
 658         struct list_head        oe_pages;
 659         /** Since an extent has to be written out in atomic, this is used to
 660          * remember the next page need to be locked to write this extent out.
 661          * Not used right now.
 662          */
 663         struct osc_page         *oe_next_page;
 664         /** start and end index of this extent, include start and end
 665          * themselves. Page offset here is the page index of osc_pages.
 666          * oe_start is used as keyword for red-black tree. */
 667         pgoff_t                 oe_start;
 668         pgoff_t                 oe_end;
 669         /** maximum ending index of this extent, this is limited by
 670          * max_pages_per_rpc, lock extent and chunk size. */
 671         pgoff_t                 oe_max_end;
 672         /** waitqueue - for those who want to be notified if this extent's
 673          * state has changed. */
 674         wait_queue_head_t       oe_waitq;
 675         /** lock covering this extent */
 676         struct cl_lock          *oe_osclock;
 677         /** terminator of this extent. Must be true if this extent is in IO. */
 678         struct task_struct      *oe_owner;
 679         /** return value of writeback. If somebody is waiting for this extent,
 680          * this value can be known by outside world. */
 681         int                     oe_rc;
 682         /** max pages per rpc when this extent was created */
 683         unsigned int            oe_mppr;
 684 };
 685
 686 int osc_extent_finish(const struct lu_env *env, struct osc_extent *ext,
 687                       int sent, int rc);
 688 int osc_extent_release(const struct lu_env *env, struct osc_extent *ext);
 689
 690 int osc_lock_discard_pages(const struct lu_env *env, struct osc_lock *lock);
 691
 692 typedef int (*osc_page_gang_cbt)(const struct lu_env *, struct cl_io *,
 693                                  struct osc_page *, void *);
 694 int osc_page_gang_lookup(const struct lu_env *env, struct cl_io *io,
 695                          struct osc_object *osc, pgoff_t start, pgoff_t end,
 696                          osc_page_gang_cbt cb, void *cbdata);
 697
 698 /** @} osc */
 699
 700 #endif /* OSC_CL_INTERNAL_H */