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