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