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