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