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