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