lustre/include/lclient.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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * Definitions shared between vvp and liblustre, and other clients in the
  37  * future.
  38  *
  39  *   Author: Oleg Drokin <oleg.drokin@sun.com>
  40  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  41  */
  42
  43 #ifndef LCLIENT_H
  44 #define LCLIENT_H
  45
  46 blkcnt_t dirty_cnt(struct inode *inode);
  47
  48 int cl_glimpse_size0(struct inode *inode, int agl);
  49 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
  50                     struct inode *inode, struct cl_object *clob, int agl);
  51
  52 static inline int cl_glimpse_size(struct inode *inode)
  53 {
  54         return cl_glimpse_size0(inode, 0);
  55 }
  56
  57 static inline int cl_agl(struct inode *inode)
  58 {
  59         return cl_glimpse_size0(inode, 1);
  60 }
  61
  62 /**
  63  * Locking policy for setattr.
  64  */
  65 enum ccc_setattr_lock_type {
  66         /** Locking is done by server */
  67         SETATTR_NOLOCK,
  68         /** Extent lock is enqueued */
  69         SETATTR_EXTENT_LOCK,
  70         /** Existing local extent lock is used */
  71         SETATTR_MATCH_LOCK
  72 };
  73
  74
  75 /**
  76  * IO state private to vvp or slp layers.
  77  */
  78 struct ccc_io {
  79         /** super class */
  80         struct cl_io_slice     cui_cl;
  81         struct cl_io_lock_link cui_link;
  82         /**
  83          * I/O vector information to or from which read/write is going.
  84          */
  85         struct iovec *cui_iov;
  86         unsigned long cui_nrsegs;
  87         /**
  88          * Total iov count for left IO.
  89          */
  90         unsigned long cui_tot_nrsegs;
  91         /**
  92          * Old length for iov that was truncated partially.
  93          */
  94         size_t cui_iov_olen;
  95         /**
  96          * Total size for the left IO.
  97          */
  98         size_t cui_tot_count;
  99
 100         union {
 101                 struct {
 102                         enum ccc_setattr_lock_type cui_local_lock;
 103                 } setattr;
 104                 struct {
 105                         struct cl_page_list cui_queue;
 106                         unsigned long cui_written;
 107                         int cui_from;
 108                         int cui_to;
 109                 } write;
 110         } u;
 111         /**
 112          * True iff io is processing glimpse right now.
 113          */
 114         int                  cui_glimpse;
 115         /**
 116          * Layout version when this IO is initialized
 117          */
 118         __u32                cui_layout_gen;
 119         /**
 120          * File descriptor against which IO is done.
 121          */
 122         struct ll_file_data *cui_fd;
 123         struct kiocb *cui_iocb;
 124 };
 125
 126 /**
 127  * True, if \a io is a normal io, False for other (sendfile, splice*).
 128  * must be impementated in arch specific code.
 129  */
 130 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
 131
 132 extern struct lu_context_key ccc_key;
 133 extern struct lu_context_key ccc_session_key;
 134
 135 struct ccc_thread_info {
 136         struct cl_lock_descr cti_descr;
 137         struct cl_io         cti_io;
 138         struct cl_attr       cti_attr;
 139 };
 140
 141 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
 142 {
 143         struct ccc_thread_info      *info;
 144
 145         info = lu_context_key_get(&env->le_ctx, &ccc_key);
 146         LASSERT(info != NULL);
 147         return info;
 148 }
 149
 150 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
 151 {
 152         struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
 153         memset(attr, 0, sizeof(*attr));
 154         return attr;
 155 }
 156
 157 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
 158 {
 159         struct cl_io *io = &ccc_env_info(env)->cti_io;
 160         memset(io, 0, sizeof(*io));
 161         return io;
 162 }
 163
 164 struct ccc_session {
 165         struct ccc_io cs_ios;
 166 };
 167
 168 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
 169 {
 170         struct ccc_session *ses;
 171
 172         ses = lu_context_key_get(env->le_ses, &ccc_session_key);
 173         LASSERT(ses != NULL);
 174         return ses;
 175 }
 176
 177 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
 178 {
 179         return &ccc_env_session(env)->cs_ios;
 180 }
 181
 182 /**
 183  * ccc-private object state.
 184  */
 185 struct ccc_object {
 186         struct cl_object_header cob_header;
 187         struct cl_object        cob_cl;
 188         struct inode           *cob_inode;
 189
 190         /**
 191          * A list of dirty pages pending IO in the cache. Used by
 192          * SOM. Protected by ll_inode_info::lli_lock.
 193          *
 194          * \see ccc_page::cpg_pending_linkage
 195          */
 196         cfs_list_t             cob_pending_list;
 197
 198         /**
 199          * Access this counter is protected by inode->i_sem. Now that
 200          * the lifetime of transient pages must be covered by inode sem,
 201          * we don't need to hold any lock..
 202          */
 203         int                     cob_transient_pages;
 204         /**
 205          * Number of outstanding mmaps on this file.
 206          *
 207          * \see ll_vm_open(), ll_vm_close().
 208          */
 209         cfs_atomic_t            cob_mmap_cnt;
 210
 211         /**
 212          * various flags
 213          * cob_discard_page_warned
 214          *     if pages belonging to this object are discarded when a client
 215          * is evicted, some debug info will be printed, this flag will be set
 216          * during processing the first discarded page, then avoid flooding
 217          * debug message for lots of discarded pages.
 218          *
 219          * \see ll_dirty_page_discard_warn.
 220          */
 221         unsigned int            cob_discard_page_warned:1;
 222 };
 223
 224 /**
 225  * ccc-private page state.
 226  */
 227 struct ccc_page {
 228         struct cl_page_slice cpg_cl;
 229         int                  cpg_defer_uptodate;
 230         int                  cpg_ra_used;
 231         int                  cpg_write_queued;
 232         /**
 233          * Non-empty iff this page is already counted in
 234          * ccc_object::cob_pending_list. Protected by
 235          * ccc_object::cob_pending_guard. This list is only used as a flag,
 236          * that is, never iterated through, only checked for list_empty(), but
 237          * having a list is useful for debugging.
 238          */
 239         cfs_list_t           cpg_pending_linkage;
 240         /** VM page */
 241         struct page          *cpg_page;
 242 };
 243
 244 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
 245 {
 246         return container_of(slice, struct ccc_page, cpg_cl);
 247 }
 248
 249 static inline pgoff_t ccc_index(struct ccc_page *ccc)
 250 {
 251         return ccc->cpg_cl.cpl_index;
 252 }
 253
 254 struct cl_page    *ccc_vmpage_page_transient(struct page *vmpage);
 255
 256 struct ccc_device {
 257         struct cl_device    cdv_cl;
 258         struct super_block *cdv_sb;
 259         struct cl_device   *cdv_next;
 260 };
 261
 262 struct ccc_lock {
 263         struct cl_lock_slice clk_cl;
 264 };
 265
 266 struct ccc_req {
 267         struct cl_req_slice  crq_cl;
 268 };
 269
 270 void *ccc_key_init        (const struct lu_context *ctx,
 271                            struct lu_context_key *key);
 272 void  ccc_key_fini        (const struct lu_context *ctx,
 273                            struct lu_context_key *key, void *data);
 274 void *ccc_session_key_init(const struct lu_context *ctx,
 275                            struct lu_context_key *key);
 276 void  ccc_session_key_fini(const struct lu_context *ctx,
 277                            struct lu_context_key *key, void *data);
 278
 279 int              ccc_device_init  (const struct lu_env *env,
 280                                    struct lu_device *d,
 281                                    const char *name, struct lu_device *next);
 282 struct lu_device *ccc_device_fini (const struct lu_env *env,
 283                                    struct lu_device *d);
 284 struct lu_device *ccc_device_alloc(const struct lu_env *env,
 285                                    struct lu_device_type *t,
 286                                    struct lustre_cfg *cfg,
 287                                    const struct lu_device_operations *luops,
 288                                    const struct cl_device_operations *clops);
 289 struct lu_device *ccc_device_free (const struct lu_env *env,
 290                                    struct lu_device *d);
 291 struct lu_object *ccc_object_alloc(const struct lu_env *env,
 292                                    const struct lu_object_header *hdr,
 293                                    struct lu_device *dev,
 294                                    const struct cl_object_operations *clops,
 295                                    const struct lu_object_operations *luops);
 296
 297 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 298                  struct cl_req *req);
 299 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 300 int ccc_global_init(struct lu_device_type *device_type);
 301 void ccc_global_fini(struct lu_device_type *device_type);
 302 int ccc_object_init0(const struct lu_env *env,struct ccc_object *vob,
 303                      const struct cl_object_conf *conf);
 304 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
 305                     const struct lu_object_conf *conf);
 306 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
 307 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
 308                   struct cl_lock *lock, const struct cl_io *io,
 309                   const struct cl_lock_operations *lkops);
 310 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
 311                  const struct cl_attr *attr, unsigned valid);
 312 int ccc_object_glimpse(const struct lu_env *env,
 313                        const struct cl_object *obj, struct ost_lvb *lvb);
 314 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
 315                  const struct cl_object_conf *conf);
 316 int ccc_page_is_under_lock(const struct lu_env *env,
 317                            const struct cl_page_slice *slice, struct cl_io *io);
 318 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
 319 void ccc_transient_page_verify(const struct cl_page *page);
 320 int  ccc_transient_page_own(const struct lu_env *env,
 321                             const struct cl_page_slice *slice,
 322                             struct cl_io *io, int nonblock);
 323 void ccc_transient_page_assume(const struct lu_env *env,
 324                                const struct cl_page_slice *slice,
 325                                struct cl_io *io);
 326 void ccc_transient_page_unassume(const struct lu_env *env,
 327                                  const struct cl_page_slice *slice,
 328                                  struct cl_io *io);
 329 void ccc_transient_page_disown(const struct lu_env *env,
 330                                const struct cl_page_slice *slice,
 331                                struct cl_io *io);
 332 void ccc_transient_page_discard(const struct lu_env *env,
 333                                 const struct cl_page_slice *slice,
 334                                 struct cl_io *io);
 335 int ccc_transient_page_prep(const struct lu_env *env,
 336                             const struct cl_page_slice *slice,
 337                             struct cl_io *io);
 338 void ccc_lock_delete(const struct lu_env *env,
 339                      const struct cl_lock_slice *slice);
 340 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
 341 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
 342                      struct cl_io *io, __u32 enqflags);
 343 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
 344 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
 345 int ccc_lock_fits_into(const struct lu_env *env,
 346                        const struct cl_lock_slice *slice,
 347                        const struct cl_lock_descr *need,
 348                        const struct cl_io *io);
 349 void ccc_lock_state(const struct lu_env *env,
 350                     const struct cl_lock_slice *slice,
 351                     enum cl_lock_state state);
 352
 353 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
 354 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
 355                           __u32 enqflags, enum cl_lock_mode mode,
 356                           pgoff_t start, pgoff_t end);
 357 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
 358                     __u32 enqflags, enum cl_lock_mode mode,
 359                     loff_t start, loff_t end);
 360 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
 361 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 362                     size_t nob);
 363 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
 364                        struct cl_io *io);
 365 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
 366                   struct cl_io *io, loff_t start, size_t count, int *exceed);
 367 void ccc_req_completion(const struct lu_env *env,
 368                         const struct cl_req_slice *slice, int ioret);
 369 void ccc_req_attr_set(const struct lu_env *env,const struct cl_req_slice *slice,
 370                       const struct cl_object *obj,
 371                       struct cl_req_attr *oa, obd_valid flags);
 372
 373 struct lu_device   *ccc2lu_dev      (struct ccc_device *vdv);
 374 struct lu_object   *ccc2lu          (struct ccc_object *vob);
 375 struct ccc_device  *lu2ccc_dev      (const struct lu_device *d);
 376 struct ccc_device  *cl2ccc_dev      (const struct cl_device *d);
 377 struct ccc_object  *lu2ccc          (const struct lu_object *obj);
 378 struct ccc_object  *cl2ccc          (const struct cl_object *obj);
 379 struct ccc_lock    *cl2ccc_lock     (const struct cl_lock_slice *slice);
 380 struct ccc_io      *cl2ccc_io       (const struct lu_env *env,
 381                                      const struct cl_io_slice *slice);
 382 struct ccc_req     *cl2ccc_req      (const struct cl_req_slice *slice);
 383 struct page         *cl2vm_page      (const struct cl_page_slice *slice);
 384 struct inode       *ccc_object_inode(const struct cl_object *obj);
 385 struct ccc_object  *cl_inode2ccc    (struct inode *inode);
 386
 387 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
 388                    struct obd_capa *capa);
 389
 390 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
 391 int ccc_object_invariant(const struct cl_object *obj);
 392 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
 393 void cl_inode_fini(struct inode *inode);
 394 int cl_local_size(struct inode *inode);
 395
 396 __u16 ll_dirent_type_get(struct lu_dirent *ent);
 397 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
 398 __u32 cl_fid_build_gen(const struct lu_fid *fid);
 399
 400 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 401 # define CLOBINVRNT(env, clob, expr)                                    \
 402   do {                                                                  \
 403           if (unlikely(!(expr))) {                                      \
 404                   LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, #expr "\n"); \
 405                   LINVRNT(0);                                           \
 406           }                                                             \
 407   } while (0)
 408 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 409 # define CLOBINVRNT(env, clob, expr)                                    \
 410          ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 411 #endif /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 412
 413 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 414 int cl_ocd_update(struct obd_device *host,
 415                   struct obd_device *watched,
 416                   enum obd_notify_event ev, void *owner, void *data);
 417
 418 struct ccc_grouplock {
 419         struct lu_env   *cg_env;
 420         struct cl_io    *cg_io;
 421         struct cl_lock  *cg_lock;
 422         unsigned long    cg_gid;
 423 };
 424
 425 int  cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
 426                       struct ccc_grouplock *cg);
 427 void cl_put_grouplock(struct ccc_grouplock *cg);
 428
 429 /**
 430  * New interfaces to get and put lov_stripe_md from lov layer. This violates
 431  * layering because lov_stripe_md is supposed to be a private data in lov.
 432  *
 433  * NB: If you find you have to use these interfaces for your new code, please
 434  * think about it again. These interfaces may be removed in the future for
 435  * better layering. */
 436 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
 437 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
 438 int lov_read_and_clear_async_rc(struct cl_object *clob);
 439
 440 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
 441 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
 442
 443 /**
 444  * Data structure managing a client's cached pages. A count of
 445  * "unstable" pages is maintained, and an LRU of clean pages is
 446  * maintained. "unstable" pages are pages pinned by the ptlrpc
 447  * layer for recovery purposes.
 448  */
 449 struct cl_client_cache {
 450         cfs_atomic_t            ccc_users;    /* # of users (OSCs) */
 451         cfs_list_t              ccc_lru;      /* LRU of cached clean pages */
 452         spinlock_t              ccc_lru_lock; /* lock for list */
 453         cfs_atomic_t            ccc_lru_left; /* # of LRU entries available */
 454         unsigned long           ccc_lru_max;  /* Max # of LRU entries */
 455         unsigned int            ccc_lru_shrinkers;  /* # of threads shrinking */
 456         cfs_atomic_t            ccc_unstable_nr;    /* # of pages pinned */
 457         wait_queue_head_t       ccc_unstable_waitq; /* Signaled on BRW commit */
 458 };
 459
 460 #endif /*LCLIENT_H */