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