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, 2017, 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         time64_t                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         /** true if this io has CAP_SYS_RESOURCE */
 140                            oi_cap_sys_resource:1;
 141         /** how many LRU pages are reserved for this IO */
 142         unsigned long      oi_lru_reserved;
 143
 144         /** active extents, we know how many bytes is going to be written,
 145          * so having an active extent will prevent it from being fragmented */
 146         struct osc_extent *oi_active;
 147         /** partially truncated extent, we need to hold this extent to prevent
 148          * page writeback from happening. */
 149         struct osc_extent *oi_trunc;
 150         /** write osc_lock for this IO, used by osc_extent_find(). */
 151         struct osc_lock   *oi_write_osclock;
 152         struct obdo        oi_oa;
 153         struct osc_async_cbargs {
 154                 bool              opc_rpc_sent;
 155                 int               opc_rc;
 156                 struct completion opc_sync;
 157         } oi_cbarg;
 158 };
 159
 160 /**
 161  * State maintained by osc layer for the duration of a system call.
 162  */
 163 struct osc_session {
 164         struct osc_io os_io;
 165 };
 166
 167 #define OTI_PVEC_SIZE 256
 168 struct osc_thread_info {
 169         struct ldlm_res_id      oti_resname;
 170         union ldlm_policy_data  oti_policy;
 171         struct cl_attr          oti_attr;
 172         struct cl_io            oti_io;
 173         struct pagevec          oti_pagevec;
 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 static inline __u64 osc_enq2ldlm_flags(__u32 enqflags)
 186 {
 187         __u64 result = 0;
 188
 189         CDEBUG(D_DLMTRACE, "flags: %x\n", enqflags);
 190
 191         LASSERT((enqflags & ~CEF_MASK) == 0);
 192
 193         if (enqflags & CEF_NONBLOCK)
 194                 result |= LDLM_FL_BLOCK_NOWAIT;
 195         if (enqflags & CEF_GLIMPSE)
 196                 result |= LDLM_FL_HAS_INTENT;
 197         if (enqflags & CEF_DISCARD_DATA)
 198                 result |= LDLM_FL_AST_DISCARD_DATA;
 199         if (enqflags & CEF_PEEK)
 200                 result |= LDLM_FL_TEST_LOCK;
 201         if (enqflags & CEF_LOCK_MATCH)
 202                 result |= LDLM_FL_MATCH_LOCK;
 203         if (enqflags & CEF_LOCK_NO_EXPAND)
 204                 result |= LDLM_FL_NO_EXPANSION;
 205         if (enqflags & CEF_SPECULATIVE)
 206                 result |= LDLM_FL_SPECULATIVE;
 207         return result;
 208 }
 209
 210 typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
 211                                     int rc);
 212
 213 struct osc_enqueue_args {
 214         struct obd_export       *oa_exp;
 215         enum ldlm_type          oa_type;
 216         enum ldlm_mode          oa_mode;
 217         __u64                   *oa_flags;
 218         osc_enqueue_upcall_f    oa_upcall;
 219         void                    *oa_cookie;
 220         struct ost_lvb          *oa_lvb;
 221         struct lustre_handle    oa_lockh;
 222         bool                    oa_speculative;
 223 };
 224
 225 /**
 226  * Bit flags for osc_dlm_lock_at_pageoff().
 227  */
 228 enum osc_dap_flags {
 229         /**
 230          * Just check if the desired lock exists, it won't hold reference
 231          * count on lock.
 232          */
 233         OSC_DAP_FL_TEST_LOCK = 1 << 0,
 234         /**
 235          * Return the lock even if it is being canceled.
 236          */
 237         OSC_DAP_FL_CANCELING = 1 << 1
 238 };
 239
 240 /*
 241  * The set of operations which are different for MDC and OSC objects
 242  */
 243 struct osc_object_operations {
 244         void (*oto_build_res_name)(struct osc_object *osc,
 245                                    struct ldlm_res_id *resname);
 246         struct ldlm_lock* (*oto_dlmlock_at_pgoff)(const struct lu_env *env,
 247                                                 struct osc_object *obj,
 248                                                 pgoff_t index,
 249                                                 enum osc_dap_flags dap_flags);
 250 };
 251
 252 struct osc_object {
 253         struct cl_object        oo_cl;
 254         struct lov_oinfo        *oo_oinfo;
 255         /**
 256          * True if locking against this stripe got -EUSERS.
 257          */
 258         int                     oo_contended;
 259         ktime_t                 oo_contention_time;
 260 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 261         /**
 262          * IO context used for invariant checks in osc_lock_has_pages().
 263          */
 264         struct cl_io            oo_debug_io;
 265         /** Serialization object for osc_object::oo_debug_io. */
 266         struct mutex            oo_debug_mutex;
 267 #endif
 268         /**
 269          * used by the osc to keep track of what objects to build into rpcs.
 270          * Protected by client_obd->cli_loi_list_lock.
 271          */
 272         struct list_head        oo_ready_item;
 273         struct list_head        oo_hp_ready_item;
 274         struct list_head        oo_write_item;
 275         struct list_head        oo_read_item;
 276
 277         /**
 278          * extent is a red black tree to manage (async) dirty pages.
 279          */
 280         struct rb_root          oo_root;
 281         /**
 282          * Manage write(dirty) extents.
 283          */
 284         struct list_head        oo_hp_exts;     /* list of hp extents */
 285         struct list_head        oo_urgent_exts; /* list of writeback extents */
 286         struct list_head        oo_full_exts;
 287
 288         struct list_head        oo_reading_exts;
 289
 290         atomic_t                oo_nr_reads;
 291         atomic_t                oo_nr_writes;
 292
 293         /** Protect extent tree. Will be used to protect
 294          * oo_{read|write}_pages soon. */
 295         spinlock_t              oo_lock;
 296
 297         /**
 298          * Radix tree for caching pages
 299          */
 300         spinlock_t              oo_tree_lock;
 301         struct radix_tree_root  oo_tree;
 302         unsigned long           oo_npages;
 303
 304         /* Protect osc_lock this osc_object has */
 305         struct list_head        oo_ol_list;
 306         spinlock_t              oo_ol_spin;
 307
 308         /** number of active IOs of this object */
 309         atomic_t                oo_nr_ios;
 310         wait_queue_head_t       oo_io_waitq;
 311
 312         const struct osc_object_operations *oo_obj_ops;
 313         bool                    oo_initialized;
 314 };
 315
 316 static inline void osc_build_res_name(struct osc_object *osc,
 317                                       struct ldlm_res_id *resname)
 318 {
 319         return osc->oo_obj_ops->oto_build_res_name(osc, resname);
 320 }
 321
 322 static inline struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
 323                                                     struct osc_object *obj,
 324                                                     pgoff_t index,
 325                                                     enum osc_dap_flags flags)
 326 {
 327         return obj->oo_obj_ops->oto_dlmlock_at_pgoff(env, obj, index, flags);
 328 }
 329
 330 static inline void osc_object_lock(struct osc_object *obj)
 331 {
 332         spin_lock(&obj->oo_lock);
 333 }
 334
 335 static inline int osc_object_trylock(struct osc_object *obj)
 336 {
 337         return spin_trylock(&obj->oo_lock);
 338 }
 339
 340 static inline void osc_object_unlock(struct osc_object *obj)
 341 {
 342         spin_unlock(&obj->oo_lock);
 343 }
 344
 345 #define assert_osc_object_is_locked(obj)        \
 346         assert_spin_locked(&obj->oo_lock)
 347
 348 static inline void osc_object_set_contended(struct osc_object *obj)
 349 {
 350         obj->oo_contention_time = ktime_get();
 351         /* mb(); */
 352         obj->oo_contended = 1;
 353 }
 354
 355 static inline void osc_object_clear_contended(struct osc_object *obj)
 356 {
 357         obj->oo_contended = 0;
 358 }
 359
 360 /*
 361  * Lock "micro-states" for osc layer.
 362  */
 363 enum osc_lock_state {
 364         OLS_NEW,
 365         OLS_ENQUEUED,
 366         OLS_UPCALL_RECEIVED,
 367         OLS_GRANTED,
 368         OLS_CANCELLED
 369 };
 370
 371 /**
 372  * osc-private state of cl_lock.
 373  *
 374  * Interaction with DLM.
 375  *
 376  * Once receive upcall is invoked, osc_lock remembers a handle of DLM lock in
 377  * osc_lock::ols_handle and a pointer to that lock in osc_lock::ols_dlmlock.
 378  *
 379  * This pointer is protected through a reference, acquired by
 380  * osc_lock_upcall0(). Also, an additional reference is acquired by
 381  * ldlm_lock_addref() call protecting the lock from cancellation, until
 382  * osc_lock_unuse() releases it.
 383  *
 384  * Below is a description of how lock references are acquired and released
 385  * inside of DLM.
 386  *
 387  * - When new lock is created and enqueued to the server (ldlm_cli_enqueue())
 388  *      - ldlm_lock_create()
 389  *          - ldlm_lock_new(): initializes a lock with 2 references. One for
 390  *            the caller (released when reply from the server is received, or on
 391  *            error), and another for the hash table.
 392  *      - ldlm_lock_addref_internal(): protects the lock from cancellation.
 393  *
 394  * - When reply is received from the server (osc_enqueue_interpret())
 395  *      - ldlm_cli_enqueue_fini()
 396  *          - LDLM_LOCK_PUT(): releases caller reference acquired by
 397  *            ldlm_lock_new().
 398  *          - if (rc != 0)
 399  *                ldlm_lock_decref(): error case: matches ldlm_cli_enqueue().
 400  *      - ldlm_lock_decref(): for async locks, matches ldlm_cli_enqueue().
 401  *
 402  * - When lock is being cancelled (ldlm_lock_cancel())
 403  *      - ldlm_lock_destroy()
 404  *          - LDLM_LOCK_PUT(): releases hash-table reference acquired by
 405  *            ldlm_lock_new().
 406  *
 407  * osc_lock is detached from ldlm_lock by osc_lock_detach() that is called
 408  * either when lock is cancelled (osc_lock_blocking()), or when locks is
 409  * deleted without cancellation (e.g., from cl_locks_prune()). In the latter
 410  * case ldlm lock remains in memory, and can be re-attached to osc_lock in the
 411  * future.
 412  */
 413 struct osc_lock {
 414         struct cl_lock_slice    ols_cl;
 415         /** Internal lock to protect states, etc. */
 416         spinlock_t              ols_lock;
 417         /** Owner sleeps on this channel for state change */
 418         struct cl_sync_io       *ols_owner;
 419         /** waiting list for this lock to be cancelled */
 420         struct list_head        ols_waiting_list;
 421         /** wait entry of ols_waiting_list */
 422         struct list_head        ols_wait_entry;
 423         /** list entry for osc_object::oo_ol_list */
 424         struct list_head        ols_nextlock_oscobj;
 425
 426         /** underlying DLM lock */
 427         struct ldlm_lock        *ols_dlmlock;
 428         /** DLM flags with which osc_lock::ols_lock was enqueued */
 429         __u64                   ols_flags;
 430         /** osc_lock::ols_lock handle */
 431         struct lustre_handle    ols_handle;
 432         struct ldlm_enqueue_info ols_einfo;
 433         enum osc_lock_state     ols_state;
 434         /** lock value block */
 435         struct ost_lvb          ols_lvb;
 436         /** Lockless operations to be used by lockless lock */
 437         const struct cl_lock_operations *ols_lockless_ops;
 438         /**
 439          * true, if ldlm_lock_addref() was called against
 440          * osc_lock::ols_lock. This is used for sanity checking.
 441          *
 442          * \see osc_lock::ols_has_ref
 443          */
 444         unsigned                ols_hold :1,
 445         /**
 446          * this is much like osc_lock::ols_hold, except that this bit is
 447          * cleared _after_ reference in released in osc_lock_unuse(). This
 448          * fine distinction is needed because:
 449          *
 450          *     - if ldlm lock still has a reference, osc_ast_data_get() needs
 451          *       to return associated cl_lock (so that a flag is needed that is
 452          *       cleared after ldlm_lock_decref() returned), and
 453          *
 454          *     - ldlm_lock_decref() can invoke blocking ast (for a
 455          *       LDLM_FL_CBPENDING lock), and osc_lock functions like
 456          *       osc_lock_cancel() called from there need to know whether to
 457          *       release lock reference (so that a flag is needed that is
 458          *       cleared before ldlm_lock_decref() is called).
 459          */
 460                                 ols_has_ref:1,
 461         /**
 462          * inherit the lockless attribute from top level cl_io.
 463          * If true, osc_lock_enqueue is able to tolerate the -EUSERS error.
 464          */
 465                                 ols_locklessable:1,
 466         /**
 467          * if set, the osc_lock is a glimpse lock. For glimpse locks, we treat
 468          * the EVAVAIL error as torerable, this will make upper logic happy
 469          * to wait all glimpse locks to each OSTs to be completed.
 470          * Glimpse lock converts to normal lock if the server lock is granted.
 471          * Glimpse lock should be destroyed immediately after use.
 472          */
 473                                 ols_glimpse:1,
 474         /**
 475          * For async glimpse lock.
 476          */
 477                                 ols_agl:1,
 478         /**
 479          * for speculative locks - asynchronous glimpse locks and ladvise
 480          * lockahead manual lock requests
 481          *
 482          * Used to tell osc layer to not wait for the ldlm reply from the
 483          * server, so the osc lock will be short lived - It only exists to
 484          * create the ldlm request and is not updated on request completion.
 485          */
 486                                 ols_speculative:1;
 487 };
 488
 489 static inline int osc_lock_is_lockless(const struct osc_lock *ols)
 490 {
 491         return (ols->ols_cl.cls_ops == ols->ols_lockless_ops);
 492 }
 493
 494 /**
 495  * Page state private for osc layer.
 496  */
 497 struct osc_page {
 498         struct cl_page_slice  ops_cl;
 499         /**
 500          * Page queues used by osc to detect when RPC can be formed.
 501          */
 502         struct osc_async_page ops_oap;
 503         /**
 504          * An offset within page from which next transfer starts. This is used
 505          * by cl_page_clip() to submit partial page transfers.
 506          */
 507         int                   ops_from;
 508         /**
 509          * An offset within page at which next transfer ends.
 510          *
 511          * \see osc_page::ops_from.
 512          */
 513         int                   ops_to;
 514         /**
 515          * Boolean, true iff page is under transfer. Used for sanity checking.
 516          */
 517         unsigned              ops_transfer_pinned:1,
 518         /**
 519          * in LRU?
 520          */
 521                                 ops_in_lru:1,
 522         /**
 523          * Set if the page must be transferred with OBD_BRW_SRVLOCK.
 524          */
 525                                 ops_srvlock:1,
 526         /**
 527          * If the page is in osc_object::oo_tree.
 528          */
 529                                 ops_intree:1;
 530         /**
 531          * lru page list. See osc_lru_{del|use}() in osc_page.c for usage.
 532          */
 533         struct list_head        ops_lru;
 534         /**
 535          * Submit time - the time when the page is starting RPC. For debugging.
 536          */
 537         ktime_t                 ops_submit_time;
 538 };
 539
 540 struct osc_brw_async_args {
 541         struct obdo             *aa_oa;
 542         int                      aa_requested_nob;
 543         int                      aa_nio_count;
 544         u32                      aa_page_count;
 545         int                      aa_resends;
 546         struct brw_page         **aa_ppga;
 547         struct client_obd       *aa_cli;
 548         struct list_head         aa_oaps;
 549         struct list_head         aa_exts;
 550 };
 551
 552 extern struct kmem_cache *osc_lock_kmem;
 553 extern struct kmem_cache *osc_object_kmem;
 554 extern struct kmem_cache *osc_thread_kmem;
 555 extern struct kmem_cache *osc_session_kmem;
 556 extern struct kmem_cache *osc_extent_kmem;
 557 extern struct kmem_cache *osc_quota_kmem;
 558 extern struct kmem_cache *osc_obdo_kmem;
 559
 560 extern struct lu_context_key osc_key;
 561 extern struct lu_context_key osc_session_key;
 562
 563 #define OSC_FLAGS (ASYNC_URGENT|ASYNC_READY)
 564
 565 /* osc_page.c */
 566 int osc_page_init(const struct lu_env *env, struct cl_object *obj,
 567                   struct cl_page *page, pgoff_t ind);
 568 void osc_index2policy(union ldlm_policy_data *policy, const struct cl_object *obj,
 569                       pgoff_t start, pgoff_t end);
 570 void osc_lru_add_batch(struct client_obd *cli, struct list_head *list);
 571 void osc_page_submit(const struct lu_env *env, struct osc_page *opg,
 572                      enum cl_req_type crt, int brw_flags);
 573 int lru_queue_work(const struct lu_env *env, void *data);
 574 long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
 575                     long target, bool force);
 576
 577 /* osc_cache.c */
 578 int osc_cancel_async_page(const struct lu_env *env, struct osc_page *ops);
 579 int osc_set_async_flags(struct osc_object *obj, struct osc_page *opg,
 580                         u32 async_flags);
 581 int osc_prep_async_page(struct osc_object *osc, struct osc_page *ops,
 582                         struct page *page, loff_t offset);
 583 int osc_queue_async_io(const struct lu_env *env, struct cl_io *io,
 584                        struct osc_page *ops, cl_commit_cbt cb);
 585 int osc_page_cache_add(const struct lu_env *env, struct osc_page *opg,
 586                        struct cl_io *io, cl_commit_cbt cb);
 587 int osc_teardown_async_page(const struct lu_env *env, struct osc_object *obj,
 588                             struct osc_page *ops);
 589 int osc_flush_async_page(const struct lu_env *env, struct cl_io *io,
 590                          struct osc_page *ops);
 591 int osc_queue_sync_pages(const struct lu_env *env, const struct cl_io *io,
 592                          struct osc_object *obj, struct list_head *list,
 593                          int brw_flags);
 594 int osc_cache_truncate_start(const struct lu_env *env, struct osc_object *obj,
 595                              __u64 size, struct osc_extent **extp);
 596 void osc_cache_truncate_end(const struct lu_env *env, struct osc_extent *ext);
 597 int osc_cache_writeback_range(const struct lu_env *env, struct osc_object *obj,
 598                               pgoff_t start, pgoff_t end, int hp, int discard);
 599 int osc_cache_wait_range(const struct lu_env *env, struct osc_object *obj,
 600                          pgoff_t start, pgoff_t end);
 601 int osc_io_unplug0(const struct lu_env *env, struct client_obd *cli,
 602                    struct osc_object *osc, int async);
 603 void osc_wake_cache_waiters(struct client_obd *cli);
 604
 605 static inline int osc_io_unplug_async(const struct lu_env *env,
 606                                       struct client_obd *cli,
 607                                       struct osc_object *osc)
 608 {
 609         return osc_io_unplug0(env, cli, osc, 1);
 610 }
 611
 612 static inline void osc_io_unplug(const struct lu_env *env,
 613                                  struct client_obd *cli,
 614                                  struct osc_object *osc)
 615 {
 616         (void)osc_io_unplug0(env, cli, osc, 0);
 617 }
 618
 619 typedef int (*osc_page_gang_cbt)(const struct lu_env *, struct cl_io *,
 620                                  struct osc_page *, void *);
 621 int osc_page_gang_lookup(const struct lu_env *env, struct cl_io *io,
 622                         struct osc_object *osc, pgoff_t start, pgoff_t end,
 623                         osc_page_gang_cbt cb, void *cbdata);
 624 int osc_discard_cb(const struct lu_env *env, struct cl_io *io,
 625                    struct osc_page *ops, void *cbdata);
 626
 627 /* osc_dev.c */
 628 int osc_device_init(const struct lu_env *env, struct lu_device *d,
 629                     const char *name, struct lu_device *next);
 630 struct lu_device *osc_device_fini(const struct lu_env *env,
 631                                   struct lu_device *d);
 632 struct lu_device *osc_device_free(const struct lu_env *env,
 633                                   struct lu_device *d);
 634
 635 /* osc_object.c */
 636 int osc_object_init(const struct lu_env *env, struct lu_object *obj,
 637                     const struct lu_object_conf *conf);
 638 void osc_object_free(const struct lu_env *env, struct lu_object *obj);
 639 int osc_lvb_print(const struct lu_env *env, void *cookie,
 640                   lu_printer_t p, const struct ost_lvb *lvb);
 641 int osc_object_print(const struct lu_env *env, void *cookie,
 642                      lu_printer_t p, const struct lu_object *obj);
 643 int osc_attr_get(const struct lu_env *env, struct cl_object *obj,
 644                  struct cl_attr *attr);
 645 int osc_attr_update(const struct lu_env *env, struct cl_object *obj,
 646                     const struct cl_attr *attr, unsigned valid);
 647 int osc_object_glimpse(const struct lu_env *env, const struct cl_object *obj,
 648                        struct ost_lvb *lvb);
 649 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
 650 int osc_object_is_contended(struct osc_object *obj);
 651 int osc_object_find_cbdata(const struct lu_env *env, struct cl_object *obj,
 652                            ldlm_iterator_t iter, void *data);
 653 int osc_object_prune(const struct lu_env *env, struct cl_object *obj);
 654
 655 /* osc_request.c */
 656 void osc_init_grant(struct client_obd *cli, struct obd_connect_data *ocd);
 657 int osc_setup_common(struct obd_device *obd, struct lustre_cfg *lcfg);
 658 int osc_precleanup_common(struct obd_device *obd);
 659 int osc_cleanup_common(struct obd_device *obd);
 660 int osc_set_info_async(const struct lu_env *env, struct obd_export *exp,
 661                        u32 keylen, void *key, u32 vallen, void *val,
 662                        struct ptlrpc_request_set *set);
 663 int osc_ldlm_resource_invalidate(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 664                                  struct hlist_node *hnode, void *arg);
 665 int osc_reconnect(const struct lu_env *env, struct obd_export *exp,
 666                   struct obd_device *obd, struct obd_uuid *cluuid,
 667                   struct obd_connect_data *data, void *localdata);
 668 int osc_disconnect(struct obd_export *exp);
 669 int osc_punch_send(struct obd_export *exp, struct obdo *oa,
 670                    obd_enqueue_update_f upcall, void *cookie);
 671
 672 /* osc_io.c */
 673 int osc_io_submit(const struct lu_env *env, const struct cl_io_slice *ios,
 674                   enum cl_req_type crt, struct cl_2queue *queue);
 675 int osc_io_commit_async(const struct lu_env *env,
 676                         const struct cl_io_slice *ios,
 677                         struct cl_page_list *qin, int from, int to,
 678                         cl_commit_cbt cb);
 679 int osc_io_iter_init(const struct lu_env *env, const struct cl_io_slice *ios);
 680 void osc_io_iter_fini(const struct lu_env *env,
 681                       const struct cl_io_slice *ios);
 682 int osc_io_rw_iter_init(const struct lu_env *env,
 683                         const struct cl_io_slice *ios);
 684 void osc_io_rw_iter_fini(const struct lu_env *env,
 685                             const struct cl_io_slice *ios);
 686 int osc_io_fault_start(const struct lu_env *env, const struct cl_io_slice *ios);
 687 void osc_io_setattr_end(const struct lu_env *env,
 688                         const struct cl_io_slice *slice);
 689 int osc_io_read_start(const struct lu_env *env,
 690                       const struct cl_io_slice *slice);
 691 int osc_io_write_start(const struct lu_env *env,
 692                        const struct cl_io_slice *slice);
 693 void osc_io_end(const struct lu_env *env, const struct cl_io_slice *slice);
 694 int osc_fsync_ost(const struct lu_env *env, struct osc_object *obj,
 695                   struct cl_fsync_io *fio);
 696 void osc_io_fsync_end(const struct lu_env *env,
 697                       const struct cl_io_slice *slice);
 698 void osc_read_ahead_release(const struct lu_env *env, void *cbdata);
 699
 700 /* osc_lock.c */
 701 void osc_lock_to_lockless(const struct lu_env *env, struct osc_lock *ols,
 702                           int force);
 703 void osc_lock_wake_waiters(const struct lu_env *env, struct osc_object *osc,
 704                            struct osc_lock *oscl);
 705 int osc_lock_enqueue_wait(const struct lu_env *env, struct osc_object *obj,
 706                           struct osc_lock *oscl);
 707 void osc_lock_set_writer(const struct lu_env *env, const struct cl_io *io,
 708                          struct cl_object *obj, struct osc_lock *oscl);
 709 int osc_lock_print(const struct lu_env *env, void *cookie,
 710                    lu_printer_t p, const struct cl_lock_slice *slice);
 711 void osc_lock_cancel(const struct lu_env *env,
 712                      const struct cl_lock_slice *slice);
 713 void osc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice);
 714 int osc_ldlm_glimpse_ast(struct ldlm_lock *dlmlock, void *data);
 715 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
 716
 717 /*****************************************************************************
 718  *
 719  * Accessors and type conversions.
 720  *
 721  */
 722 static inline struct osc_thread_info *osc_env_info(const struct lu_env *env)
 723 {
 724         struct osc_thread_info *info;
 725
 726         info = lu_context_key_get(&env->le_ctx, &osc_key);
 727         LASSERT(info != NULL);
 728         return info;
 729 }
 730
 731 static inline struct osc_session *osc_env_session(const struct lu_env *env)
 732 {
 733         struct osc_session *ses;
 734
 735         ses = lu_context_key_get(env->le_ses, &osc_session_key);
 736         LASSERT(ses != NULL);
 737         return ses;
 738 }
 739
 740 static inline struct osc_io *osc_env_io(const struct lu_env *env)
 741 {
 742         return &osc_env_session(env)->os_io;
 743 }
 744
 745 static inline struct osc_device *lu2osc_dev(const struct lu_device *d)
 746 {
 747         return container_of0(d, struct osc_device, od_cl.cd_lu_dev);
 748 }
 749
 750 static inline struct obd_export *osc_export(const struct osc_object *obj)
 751 {
 752         return lu2osc_dev(obj->oo_cl.co_lu.lo_dev)->od_exp;
 753 }
 754
 755 static inline struct client_obd *osc_cli(const struct osc_object *obj)
 756 {
 757         return &osc_export(obj)->exp_obd->u.cli;
 758 }
 759
 760 static inline struct osc_object *cl2osc(const struct cl_object *obj)
 761 {
 762         return container_of0(obj, struct osc_object, oo_cl);
 763 }
 764
 765 static inline struct cl_object *osc2cl(const struct osc_object *obj)
 766 {
 767         return (struct cl_object *)&obj->oo_cl;
 768 }
 769
 770 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
 771 {
 772         return container_of0(d->obd_lu_dev, struct osc_device,
 773                              od_cl.cd_lu_dev);
 774 }
 775
 776 static inline struct lu_device *osc2lu_dev(struct osc_device *osc)
 777 {
 778         return &osc->od_cl.cd_lu_dev;
 779 }
 780
 781 static inline struct lu_object *osc2lu(struct osc_object *osc)
 782 {
 783         return &osc->oo_cl.co_lu;
 784 }
 785
 786 static inline struct osc_object *lu2osc(const struct lu_object *obj)
 787 {
 788         return container_of0(obj, struct osc_object, oo_cl.co_lu);
 789 }
 790
 791 static inline struct osc_io *cl2osc_io(const struct lu_env *env,
 792                                        const struct cl_io_slice *slice)
 793 {
 794         struct osc_io *oio = container_of0(slice, struct osc_io, oi_cl);
 795
 796         LINVRNT(oio == osc_env_io(env));
 797         return oio;
 798 }
 799
 800 static inline enum ldlm_mode osc_cl_lock2ldlm(enum cl_lock_mode mode)
 801 {
 802         LASSERT(mode == CLM_READ || mode == CLM_WRITE || mode == CLM_GROUP);
 803         if (mode == CLM_READ)
 804                 return LCK_PR;
 805         if (mode == CLM_WRITE)
 806                 return LCK_PW;
 807         return LCK_GROUP;
 808 }
 809
 810 static inline enum cl_lock_mode osc_ldlm2cl_lock(enum ldlm_mode mode)
 811 {
 812         LASSERT(mode == LCK_PR || mode == LCK_PW || mode == LCK_GROUP);
 813         if (mode == LCK_PR)
 814                 return CLM_READ;
 815         if (mode == LCK_PW)
 816                 return CLM_WRITE;
 817         return CLM_GROUP;
 818 }
 819
 820 static inline struct osc_page *cl2osc_page(const struct cl_page_slice *slice)
 821 {
 822         return container_of0(slice, struct osc_page, ops_cl);
 823 }
 824
 825 static inline struct osc_page *oap2osc(struct osc_async_page *oap)
 826 {
 827         return container_of0(oap, struct osc_page, ops_oap);
 828 }
 829
 830 static inline pgoff_t osc_index(struct osc_page *opg)
 831 {
 832         return opg->ops_cl.cpl_index;
 833 }
 834
 835 static inline struct cl_page *oap2cl_page(struct osc_async_page *oap)
 836 {
 837         return oap2osc(oap)->ops_cl.cpl_page;
 838 }
 839
 840 static inline struct osc_page *oap2osc_page(struct osc_async_page *oap)
 841 {
 842         return (struct osc_page *)container_of(oap, struct osc_page, ops_oap);
 843 }
 844
 845 static inline struct osc_page *
 846 osc_cl_page_osc(struct cl_page *page, struct osc_object *osc)
 847 {
 848         const struct cl_page_slice *slice;
 849
 850         LASSERT(osc != NULL);
 851         slice = cl_object_page_slice(&osc->oo_cl, page);
 852         return cl2osc_page(slice);
 853 }
 854
 855 static inline struct osc_lock *cl2osc_lock(const struct cl_lock_slice *slice)
 856 {
 857         return container_of0(slice, struct osc_lock, ols_cl);
 858 }
 859
 860 static inline int osc_io_srvlock(struct osc_io *oio)
 861 {
 862         return (oio->oi_lockless && !oio->oi_cl.cis_io->ci_no_srvlock);
 863 }
 864
 865 enum osc_extent_state {
 866         OES_INV       = 0, /** extent is just initialized or destroyed */
 867         OES_ACTIVE    = 1, /** process is using this extent */
 868         OES_CACHE     = 2, /** extent is ready for IO */
 869         OES_LOCKING   = 3, /** locking page to prepare IO */
 870         OES_LOCK_DONE = 4, /** locking finished, ready to send */
 871         OES_RPC       = 5, /** in RPC */
 872         OES_TRUNC     = 6, /** being truncated */
 873         OES_STATE_MAX
 874 };
 875
 876 /**
 877  * osc_extent data to manage dirty pages.
 878  * osc_extent has the following attributes:
 879  * 1. all pages in the same must be in one RPC in write back;
 880  * 2. # of pages must be less than max_pages_per_rpc - implied by 1;
 881  * 3. must be covered by only 1 osc_lock;
 882  * 4. exclusive. It's impossible to have overlapped osc_extent.
 883  *
 884  * The lifetime of an extent is from when the 1st page is dirtied to when
 885  * all pages inside it are written out.
 886  *
 887  * LOCKING ORDER
 888  * =============
 889  * page lock -> client_obd_list_lock -> object lock(osc_object::oo_lock)
 890  */
 891 struct osc_extent {
 892         /** red-black tree node */
 893         struct rb_node          oe_node;
 894         /** osc_object of this extent */
 895         struct osc_object       *oe_obj;
 896         /** refcount, removed from red-black tree if reaches zero. */
 897         atomic_t                oe_refc;
 898         /** busy if non-zero */
 899         atomic_t                oe_users;
 900         /** link list of osc_object's oo_{hp|urgent|locking}_exts. */
 901         struct list_head        oe_link;
 902         /** state of this extent */
 903         enum osc_extent_state   oe_state;
 904         /** flags for this extent. */
 905         unsigned int            oe_intree:1,
 906         /** 0 is write, 1 is read */
 907                                 oe_rw:1,
 908         /** sync extent, queued by osc_queue_sync_pages() */
 909                                 oe_sync:1,
 910         /** set if this extent has partial, sync pages.
 911          * Extents with partial page(s) can't merge with others in RPC */
 912                                 oe_no_merge:1,
 913                                 oe_srvlock:1,
 914                                 oe_memalloc:1,
 915         /** an ACTIVE extent is going to be truncated, so when this extent
 916          * is released, it will turn into TRUNC state instead of CACHE. */
 917                                 oe_trunc_pending:1,
 918         /** this extent should be written asap and someone may wait for the
 919          * write to finish. This bit is usually set along with urgent if
 920          * the extent was CACHE state.
 921          * fsync_wait extent can't be merged because new extent region may
 922          * exceed fsync range. */
 923                                 oe_fsync_wait:1,
 924         /** covering lock is being canceled */
 925                                 oe_hp:1,
 926         /** this extent should be written back asap. set if one of pages is
 927          * called by page WB daemon, or sync write or reading requests. */
 928                                 oe_urgent:1,
 929         /** Non-delay RPC should be used for this extent. */
 930                                 oe_ndelay:1,
 931         /** direct IO pages */
 932                                 oe_dio:1;
 933         /** how many grants allocated for this extent.
 934          *  Grant allocated for this extent. There is no grant allocated
 935          *  for reading extents and sync write extents. */
 936         unsigned int            oe_grants;
 937         /** # of dirty pages in this extent */
 938         unsigned int            oe_nr_pages;
 939         /** list of pending oap pages. Pages in this list are NOT sorted. */
 940         struct list_head        oe_pages;
 941         /** start and end index of this extent, include start and end
 942          * themselves. Page offset here is the page index of osc_pages.
 943          * oe_start is used as keyword for red-black tree. */
 944         pgoff_t                 oe_start;
 945         pgoff_t                 oe_end;
 946         /** maximum ending index of this extent, this is limited by
 947          * max_pages_per_rpc, lock extent and chunk size. */
 948         pgoff_t                 oe_max_end;
 949         /** waitqueue - for those who want to be notified if this extent's
 950          * state has changed. */
 951         wait_queue_head_t       oe_waitq;
 952         /** lock covering this extent */
 953         struct ldlm_lock        *oe_dlmlock;
 954         /** terminator of this extent. Must be true if this extent is in IO. */
 955         struct task_struct      *oe_owner;
 956         /** return value of writeback. If somebody is waiting for this extent,
 957          * this value can be known by outside world. */
 958         int                     oe_rc;
 959         /** max pages per rpc when this extent was created */
 960         unsigned int            oe_mppr;
 961         /** FLR: layout version when this osc_extent is publised */
 962         __u32                   oe_layout_version;
 963 };
 964
 965 /** @} osc */
 966
 967 #endif /* LUSTRE_OSC_H */