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