lustre/osc/osc_cl_internal.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36 /*
  37  * This file is part of Lustre, http://www.lustre.org/
  38  * Lustre is a trademark of Sun Microsystems, Inc.
  39  *
  40  * Internal interfaces of OSC layer.
  41  *
  42  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  43  */
  44
  45 #ifndef OSC_CL_INTERNAL_H
  46 #define OSC_CL_INTERNAL_H
  47
  48 #ifdef __KERNEL__
  49 # include <libcfs/libcfs.h>
  50 #else
  51 # include <liblustre.h>
  52 #endif
  53
  54 #include <obd.h>
  55 /* osc_build_res_name() */
  56 #include <obd_ost.h>
  57 #include <cl_object.h>
  58 #include "osc_internal.h"
  59
  60 /** \defgroup osc osc
  61  *  @{
  62  */
  63
  64 /**
  65  * State maintained by osc layer for each IO context.
  66  */
  67 struct osc_io {
  68         /** super class */
  69         struct cl_io_slice oi_cl;
  70         /** true if this io is lockless. */
  71         int                oi_lockless;
  72
  73         struct obdo        oi_oa;
  74         struct osc_punch_cbargs {
  75                 int               opc_rc;
  76                 struct completion opc_sync;
  77         } oi_punch_cbarg;
  78 };
  79
  80 /**
  81  * State of transfer for osc.
  82  */
  83 struct osc_req {
  84         struct cl_req_slice    or_cl;
  85 };
  86
  87 /**
  88  * State maintained by osc layer for the duration of a system call.
  89  */
  90 struct osc_session {
  91         struct osc_io       os_io;
  92 };
  93
  94 struct osc_thread_info {
  95         struct ldlm_res_id      oti_resname;
  96         ldlm_policy_data_t      oti_policy;
  97         struct cl_lock_descr    oti_descr;
  98         struct cl_attr          oti_attr;
  99         struct lustre_handle    oti_handle;
 100         struct cl_page_list     oti_plist;
 101 };
 102
 103 struct osc_object {
 104         struct cl_object   oo_cl;
 105         struct lov_oinfo  *oo_oinfo;
 106         /**
 107          * True if locking against this stripe got -EUSERS.
 108          */
 109         int                oo_contended;
 110         cfs_time_t         oo_contention_time;
 111 #ifdef INVARIANT_CHECK
 112         /**
 113          * IO context used for invariant checks in osc_lock_has_pages().
 114          */
 115         struct cl_io       oo_debug_io;
 116         /** Serialization object for osc_object::oo_debug_io. */
 117         struct mutex       oo_debug_mutex;
 118 #endif
 119         /**
 120          * List of pages in transfer.
 121          */
 122         struct list_head   oo_inflight[CRT_NR];
 123         /**
 124          * Lock, protecting ccc_object::cob_inflight, because a seat-belt is
 125          * locked during take-off and landing.
 126          */
 127         spinlock_t         oo_seatbelt;
 128 };
 129
 130 /*
 131  * Lock "micro-states" for osc layer.
 132  */
 133 enum osc_lock_state {
 134         OLS_NEW,
 135         OLS_ENQUEUED,
 136         OLS_UPCALL_RECEIVED,
 137         OLS_GRANTED,
 138         OLS_RELEASED,
 139         OLS_BLOCKED,
 140         OLS_CANCELLED
 141 };
 142
 143 /**
 144  * osc-private state of cl_lock.
 145  *
 146  * Interaction with DLM.
 147  *
 148  * CLIO enqueues all DLM locks through ptlrpcd (that is, in "async" mode).
 149  *
 150  * Once receive upcall is invoked, osc_lock remembers a handle of DLM lock in
 151  * osc_lock::ols_handle and a pointer to that lock in osc_lock::ols_lock.
 152  *
 153  * This pointer is protected through a reference, acquired by
 154  * osc_lock_upcall0(). Also, an additional reference is acquired by
 155  * ldlm_lock_addref() call protecting the lock from cancellation, until
 156  * osc_lock_unuse() releases it.
 157  *
 158  * Below is a description of how lock references are acquired and released
 159  * inside of DLM.
 160  *
 161  * - When new lock is created and enqueued to the server (ldlm_cli_enqueue())
 162  *      - ldlm_lock_create()
 163  *          - ldlm_lock_new(): initializes a lock with 2 references. One for
 164  *            the caller (released when reply from the server is received, or on
 165  *            error), and another for the hash table.
 166  *      - ldlm_lock_addref_internal(): protects the lock from cancellation.
 167  *
 168  * - When reply is received from the server (osc_enqueue_interpret())
 169  *      - ldlm_cli_enqueue_fini()
 170  *          - LDLM_LOCK_PUT(): releases caller reference acquired by
 171  *            ldlm_lock_new().
 172  *          - if (rc != 0)
 173  *                ldlm_lock_decref(): error case: matches ldlm_cli_enqueue().
 174  *      - ldlm_lock_decref(): for async locks, matches ldlm_cli_enqueue().
 175  *
 176  * - When lock is being cancelled (ldlm_lock_cancel())
 177  *      - ldlm_lock_destroy()
 178  *          - LDLM_LOCK_PUT(): releases hash-table reference acquired by
 179  *            ldlm_lock_new().
 180  *
 181  * osc_lock is detached from ldlm_lock by osc_lock_detach() that is called
 182  * either when lock is cancelled (osc_lock_blocking()), or when locks is
 183  * deleted without cancellation (e.g., from cl_locks_prune()). In the latter
 184  * case ldlm lock remains in memory, and can be re-attached to osc_lock in the
 185  * future.
 186  */
 187 struct osc_lock {
 188         struct cl_lock_slice     ols_cl;
 189         /** underlying DLM lock */
 190         struct ldlm_lock        *ols_lock;
 191         /** lock value block */
 192         struct ost_lvb           ols_lvb;
 193         /** DLM flags with which osc_lock::ols_lock was enqueued */
 194         int                      ols_flags;
 195         /** osc_lock::ols_lock handle */
 196         struct lustre_handle     ols_handle;
 197         struct ldlm_enqueue_info ols_einfo;
 198         enum osc_lock_state      ols_state;
 199         /**
 200          * true, if ldlm_lock_addref() was called against
 201          * osc_lock::ols_lock. This is used for sanity checking.
 202          *
 203          * \see osc_lock::ols_has_ref
 204          */
 205         unsigned                  ols_hold :1,
 206         /**
 207          * this is much like osc_lock::ols_hold, except that this bit is
 208          * cleared _after_ reference in released in osc_lock_unuse(). This
 209          * fine distinction is needed because:
 210          *
 211          *     - if ldlm lock still has a reference, osc_ast_data_get() needs
 212          *       to return associated cl_lock (so that a flag is needed that is
 213          *       cleared after ldlm_lock_decref() returned), and
 214          *
 215          *     - ldlm_lock_decref() can invoke blocking ast (for a
 216          *       LDLM_FL_CBPENDING lock), and osc_lock functions like
 217          *       osc_lock_cancel() called from there need to know whether to
 218          *       release lock reference (so that a flag is needed that is
 219          *       cleared before ldlm_lock_decref() is called).
 220          */
 221                                  ols_has_ref:1,
 222         /**
 223          * inherit the lockless attribute from top level cl_io.
 224          * If true, osc_lock_enqueue is able to tolerate the -EUSERS error.
 225          */
 226                                  ols_locklessable:1,
 227         /**
 228          * set by osc_lock_use() to wait until blocking AST enters into
 229          * osc_ldlm_blocking_ast0(), so that cl_lock mutex can be used for
 230          * further synchronization.
 231          */
 232                                  ols_ast_wait:1,
 233         /**
 234          * If the data of this lock has been flushed to server side.
 235          */
 236                                  ols_flush:1,
 237         /**
 238          * if set, the osc_lock is a glimpse lock. For glimpse locks, we treat
 239          * the EVAVAIL error as torerable, this will make upper logic happy
 240          * to wait all glimpse locks to each OSTs to be completed.
 241          * Glimpse lock converts to normal lock if the server lock is
 242          * granted.
 243          * Glimpse lock should be destroyed immediately after use.
 244          */
 245                                  ols_glimpse:1;
 246         /**
 247          * IO that owns this lock. This field is used for a dead-lock
 248          * avoidance by osc_lock_enqueue().
 249          *
 250          * \see osc_deadlock_is_possible()
 251          */
 252         struct osc_io           *ols_owner;
 253 };
 254
 255
 256 /**
 257  * Page state private for osc layer.
 258  */
 259 struct osc_page {
 260         struct cl_page_slice  ops_cl;
 261         /**
 262          * Page queues used by osc to detect when RPC can be formed.
 263          */
 264         struct osc_async_page ops_oap;
 265         /**
 266          * An offset within page from which next transfer starts. This is used
 267          * by cl_page_clip() to submit partial page transfers.
 268          */
 269         int                   ops_from;
 270         /**
 271          * An offset within page at which next transfer ends.
 272          *
 273          * \see osc_page::ops_from.
 274          */
 275         int                   ops_to;
 276         /**
 277          * Boolean, true iff page is under transfer. Used for sanity checking.
 278          */
 279         unsigned              ops_transfer_pinned:1,
 280         /**
 281          * True for a `temporary page' created by read-ahead code, probably
 282          * outside of any DLM lock.
 283          */
 284                               ops_temp:1,
 285         /**
 286          * Set if the page must be transferred with OBD_BRW_SRVLOCK.
 287          */
 288                               ops_srvlock:1;
 289         /**
 290          * Linkage into a per-osc_object list of pages in flight. For
 291          * debugging.
 292          */
 293         struct list_head      ops_inflight;
 294         /**
 295          * Thread that submitted this page for transfer. For debugging.
 296          */
 297         cfs_task_t           *ops_submitter;
 298         /**
 299          * Submit time - the time when the page is starting RPC. For debugging.
 300          */
 301         cfs_time_t            ops_submit_time;
 302 };
 303
 304 extern cfs_mem_cache_t *osc_page_kmem;
 305 extern cfs_mem_cache_t *osc_lock_kmem;
 306 extern cfs_mem_cache_t *osc_object_kmem;
 307 extern cfs_mem_cache_t *osc_thread_kmem;
 308 extern cfs_mem_cache_t *osc_session_kmem;
 309 extern cfs_mem_cache_t *osc_req_kmem;
 310
 311 extern struct lu_device_type osc_device_type;
 312 extern struct lu_context_key osc_key;
 313 extern struct lu_context_key osc_session_key;
 314
 315 #define OSC_FLAGS (ASYNC_URGENT|ASYNC_READY)
 316
 317 int osc_lock_init(const struct lu_env *env,
 318                   struct cl_object *obj, struct cl_lock *lock,
 319                   const struct cl_io *io);
 320 int osc_io_init  (const struct lu_env *env,
 321                   struct cl_object *obj, struct cl_io *io);
 322 int osc_req_init (const struct lu_env *env, struct cl_device *dev,
 323                   struct cl_req *req);
 324 struct lu_object *osc_object_alloc(const struct lu_env *env,
 325                                    const struct lu_object_header *hdr,
 326                                    struct lu_device *dev);
 327 struct cl_page   *osc_page_init   (const struct lu_env *env,
 328                                    struct cl_object *obj,
 329                                    struct cl_page *page, cfs_page_t *vmpage);
 330
 331 void osc_lock_build_res(const struct lu_env *env, const struct osc_object *obj,
 332                         struct ldlm_res_id *resname);
 333 void osc_index2policy  (ldlm_policy_data_t *policy, const struct cl_object *obj,
 334                         pgoff_t start, pgoff_t end);
 335 int  osc_lvb_print     (const struct lu_env *env, void *cookie,
 336                         lu_printer_t p, const struct ost_lvb *lvb);
 337 void osc_io_submit_page(const struct lu_env *env,
 338                         struct osc_io *oio, struct osc_page *opg,
 339                         enum cl_req_type crt);
 340
 341 void osc_object_set_contended  (struct osc_object *obj);
 342 void osc_object_clear_contended(struct osc_object *obj);
 343 int  osc_object_is_contended   (struct osc_object *obj);
 344
 345 int  osc_lock_is_lockless      (const struct osc_lock *olck);
 346
 347 /*****************************************************************************
 348  *
 349  * Accessors.
 350  *
 351  */
 352
 353 static inline struct osc_thread_info *osc_env_info(const struct lu_env *env)
 354 {
 355         struct osc_thread_info *info;
 356
 357         info = lu_context_key_get(&env->le_ctx, &osc_key);
 358         LASSERT(info != NULL);
 359         return info;
 360 }
 361
 362 static inline struct osc_session *osc_env_session(const struct lu_env *env)
 363 {
 364         struct osc_session *ses;
 365
 366         ses = lu_context_key_get(env->le_ses, &osc_session_key);
 367         LASSERT(ses != NULL);
 368         return ses;
 369 }
 370
 371 static inline struct osc_io *osc_env_io(const struct lu_env *env)
 372 {
 373         return &osc_env_session(env)->os_io;
 374 }
 375
 376 static inline int osc_is_object(const struct lu_object *obj)
 377 {
 378         return obj->lo_dev->ld_type == &osc_device_type;
 379 }
 380
 381 static inline struct osc_device *lu2osc_dev(const struct lu_device *d)
 382 {
 383         LINVRNT(d->ld_type == &osc_device_type);
 384         return container_of0(d, struct osc_device, od_cl.cd_lu_dev);
 385 }
 386
 387 static inline struct obd_export *osc_export(const struct osc_object *obj)
 388 {
 389         return lu2osc_dev(obj->oo_cl.co_lu.lo_dev)->od_exp;
 390 }
 391
 392 static inline struct osc_object *cl2osc(const struct cl_object *obj)
 393 {
 394         LINVRNT(osc_is_object(&obj->co_lu));
 395         return container_of0(obj, struct osc_object, oo_cl);
 396 }
 397
 398 static inline ldlm_mode_t osc_cl_lock2ldlm(enum cl_lock_mode mode)
 399 {
 400         LASSERT(mode == CLM_READ || mode == CLM_WRITE || mode == CLM_GROUP);
 401         if (mode == CLM_READ)
 402                 return LCK_PR;
 403         else if (mode == CLM_WRITE)
 404                 return LCK_PW;
 405         else
 406                 return LCK_GROUP;
 407 }
 408
 409 static inline enum cl_lock_mode osc_ldlm2cl_lock(ldlm_mode_t mode)
 410 {
 411         LASSERT(mode == LCK_PR || mode == LCK_PW || mode == LCK_GROUP);
 412         if (mode == LCK_PR)
 413                 return CLM_READ;
 414         else if (mode == LCK_PW)
 415                 return CLM_WRITE;
 416         else
 417                 return CLM_GROUP;
 418 }
 419
 420 static inline struct osc_page *cl2osc_page(const struct cl_page_slice *slice)
 421 {
 422         LINVRNT(osc_is_object(&slice->cpl_obj->co_lu));
 423         return container_of0(slice, struct osc_page, ops_cl);
 424 }
 425
 426 static inline struct osc_lock *cl2osc_lock(const struct cl_lock_slice *slice)
 427 {
 428         LINVRNT(osc_is_object(&slice->cls_obj->co_lu));
 429         return container_of0(slice, struct osc_lock, ols_cl);
 430 }
 431
 432 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
 433 {
 434         return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
 435 }
 436
 437 static inline int osc_io_srvlock(struct osc_io *oio)
 438 {
 439         return (oio->oi_lockless && !oio->oi_cl.cis_io->ci_no_srvlock);
 440 }
 441
 442 /** @} osc */
 443
 444 #endif /* OSC_CL_INTERNAL_H */