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         } u;
 105         /**
 106          * True iff io is processing glimpse right now.
 107          */
 108         int                  cui_glimpse;
 109         /**
 110          * Layout version when this IO is initialized
 111          */
 112         __u32                cui_layout_gen;
 113         /**
 114          * File descriptor against which IO is done.
 115          */
 116         struct ll_file_data *cui_fd;
 117         struct kiocb *cui_iocb;
 118 };
 119
 120 /**
 121  * True, if \a io is a normal io, False for other (sendfile, splice*).
 122  * must be impementated in arch specific code.
 123  */
 124 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
 125
 126 extern struct lu_context_key ccc_key;
 127 extern struct lu_context_key ccc_session_key;
 128
 129 struct ccc_thread_info {
 130         struct cl_lock_descr cti_descr;
 131         struct cl_io         cti_io;
 132         struct cl_attr       cti_attr;
 133 };
 134
 135 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
 136 {
 137         struct ccc_thread_info      *info;
 138
 139         info = lu_context_key_get(&env->le_ctx, &ccc_key);
 140         LASSERT(info != NULL);
 141         return info;
 142 }
 143
 144 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
 145 {
 146         struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
 147         memset(attr, 0, sizeof(*attr));
 148         return attr;
 149 }
 150
 151 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
 152 {
 153         struct cl_io *io = &ccc_env_info(env)->cti_io;
 154         memset(io, 0, sizeof(*io));
 155         return io;
 156 }
 157
 158 struct ccc_session {
 159         struct ccc_io cs_ios;
 160 };
 161
 162 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
 163 {
 164         struct ccc_session *ses;
 165
 166         ses = lu_context_key_get(env->le_ses, &ccc_session_key);
 167         LASSERT(ses != NULL);
 168         return ses;
 169 }
 170
 171 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
 172 {
 173         return &ccc_env_session(env)->cs_ios;
 174 }
 175
 176 /**
 177  * ccc-private object state.
 178  */
 179 struct ccc_object {
 180         struct cl_object_header cob_header;
 181         struct cl_object        cob_cl;
 182         struct inode           *cob_inode;
 183
 184         /**
 185          * A list of dirty pages pending IO in the cache. Used by
 186          * SOM. Protected by ll_inode_info::lli_lock.
 187          *
 188          * \see ccc_page::cpg_pending_linkage
 189          */
 190         cfs_list_t             cob_pending_list;
 191
 192         /**
 193          * Access this counter is protected by inode->i_sem. Now that
 194          * the lifetime of transient pages must be covered by inode sem,
 195          * we don't need to hold any lock..
 196          */
 197         int                     cob_transient_pages;
 198         /**
 199          * Number of outstanding mmaps on this file.
 200          *
 201          * \see ll_vm_open(), ll_vm_close().
 202          */
 203         cfs_atomic_t            cob_mmap_cnt;
 204
 205         /**
 206          * various flags
 207          * cob_discard_page_warned
 208          *     if pages belonging to this object are discarded when a client
 209          * is evicted, some debug info will be printed, this flag will be set
 210          * during processing the first discarded page, then avoid flooding
 211          * debug message for lots of discarded pages.
 212          *
 213          * \see ll_dirty_page_discard_warn.
 214          */
 215         unsigned int            cob_discard_page_warned:1;
 216 };
 217
 218 /**
 219  * ccc-private page state.
 220  */
 221 struct ccc_page {
 222         struct cl_page_slice cpg_cl;
 223         int                  cpg_defer_uptodate;
 224         int                  cpg_ra_used;
 225         int                  cpg_write_queued;
 226         /**
 227          * Non-empty iff this page is already counted in
 228          * ccc_object::cob_pending_list. Protected by
 229          * ccc_object::cob_pending_guard. This list is only used as a flag,
 230          * that is, never iterated through, only checked for list_empty(), but
 231          * having a list is useful for debugging.
 232          */
 233         cfs_list_t           cpg_pending_linkage;
 234         /** VM page */
 235         struct page          *cpg_page;
 236 };
 237
 238 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
 239 {
 240         return container_of(slice, struct ccc_page, cpg_cl);
 241 }
 242
 243 struct cl_page    *ccc_vmpage_page_transient(struct page *vmpage);
 244
 245 struct ccc_device {
 246         struct cl_device    cdv_cl;
 247         struct super_block *cdv_sb;
 248         struct cl_device   *cdv_next;
 249 };
 250
 251 struct ccc_lock {
 252         struct cl_lock_slice clk_cl;
 253 };
 254
 255 struct ccc_req {
 256         struct cl_req_slice  crq_cl;
 257 };
 258
 259 void *ccc_key_init        (const struct lu_context *ctx,
 260                            struct lu_context_key *key);
 261 void  ccc_key_fini        (const struct lu_context *ctx,
 262                            struct lu_context_key *key, void *data);
 263 void *ccc_session_key_init(const struct lu_context *ctx,
 264                            struct lu_context_key *key);
 265 void  ccc_session_key_fini(const struct lu_context *ctx,
 266                            struct lu_context_key *key, void *data);
 267
 268 int              ccc_device_init  (const struct lu_env *env,
 269                                    struct lu_device *d,
 270                                    const char *name, struct lu_device *next);
 271 struct lu_device *ccc_device_fini (const struct lu_env *env,
 272                                    struct lu_device *d);
 273 struct lu_device *ccc_device_alloc(const struct lu_env *env,
 274                                    struct lu_device_type *t,
 275                                    struct lustre_cfg *cfg,
 276                                    const struct lu_device_operations *luops,
 277                                    const struct cl_device_operations *clops);
 278 struct lu_device *ccc_device_free (const struct lu_env *env,
 279                                    struct lu_device *d);
 280 struct lu_object *ccc_object_alloc(const struct lu_env *env,
 281                                    const struct lu_object_header *hdr,
 282                                    struct lu_device *dev,
 283                                    const struct cl_object_operations *clops,
 284                                    const struct lu_object_operations *luops);
 285
 286 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 287                  struct cl_req *req);
 288 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 289 int ccc_global_init(struct lu_device_type *device_type);
 290 void ccc_global_fini(struct lu_device_type *device_type);
 291 int ccc_object_init0(const struct lu_env *env,struct ccc_object *vob,
 292                      const struct cl_object_conf *conf);
 293 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
 294                     const struct lu_object_conf *conf);
 295 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
 296 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
 297                   struct cl_lock *lock, const struct cl_io *io,
 298                   const struct cl_lock_operations *lkops);
 299 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
 300                  const struct cl_attr *attr, unsigned valid);
 301 int ccc_object_glimpse(const struct lu_env *env,
 302                        const struct cl_object *obj, struct ost_lvb *lvb);
 303 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
 304                  const struct cl_object_conf *conf);
 305 struct page *ccc_page_vmpage(const struct lu_env *env,
 306                             const struct cl_page_slice *slice);
 307 int ccc_page_is_under_lock(const struct lu_env *env,
 308                            const struct cl_page_slice *slice, struct cl_io *io);
 309 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
 310 void ccc_transient_page_verify(const struct cl_page *page);
 311 int  ccc_transient_page_own(const struct lu_env *env,
 312                             const struct cl_page_slice *slice,
 313                             struct cl_io *io, int nonblock);
 314 void ccc_transient_page_assume(const struct lu_env *env,
 315                                const struct cl_page_slice *slice,
 316                                struct cl_io *io);
 317 void ccc_transient_page_unassume(const struct lu_env *env,
 318                                  const struct cl_page_slice *slice,
 319                                  struct cl_io *io);
 320 void ccc_transient_page_disown(const struct lu_env *env,
 321                                const struct cl_page_slice *slice,
 322                                struct cl_io *io);
 323 void ccc_transient_page_discard(const struct lu_env *env,
 324                                 const struct cl_page_slice *slice,
 325                                 struct cl_io *io);
 326 int ccc_transient_page_prep(const struct lu_env *env,
 327                             const struct cl_page_slice *slice,
 328                             struct cl_io *io);
 329 void ccc_lock_delete(const struct lu_env *env,
 330                      const struct cl_lock_slice *slice);
 331 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
 332 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
 333                      struct cl_io *io, __u32 enqflags);
 334 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
 335 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
 336 int ccc_lock_fits_into(const struct lu_env *env,
 337                        const struct cl_lock_slice *slice,
 338                        const struct cl_lock_descr *need,
 339                        const struct cl_io *io);
 340 void ccc_lock_state(const struct lu_env *env,
 341                     const struct cl_lock_slice *slice,
 342                     enum cl_lock_state state);
 343
 344 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
 345 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
 346                           __u32 enqflags, enum cl_lock_mode mode,
 347                           pgoff_t start, pgoff_t end);
 348 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
 349                     __u32 enqflags, enum cl_lock_mode mode,
 350                     loff_t start, loff_t end);
 351 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
 352 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 353                     size_t nob);
 354 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
 355                        struct cl_io *io);
 356 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
 357                   struct cl_io *io, loff_t start, size_t count, int *exceed);
 358 void ccc_req_completion(const struct lu_env *env,
 359                         const struct cl_req_slice *slice, int ioret);
 360 void ccc_req_attr_set(const struct lu_env *env,const struct cl_req_slice *slice,
 361                       const struct cl_object *obj,
 362                       struct cl_req_attr *oa, obd_valid flags);
 363
 364 struct lu_device   *ccc2lu_dev      (struct ccc_device *vdv);
 365 struct lu_object   *ccc2lu          (struct ccc_object *vob);
 366 struct ccc_device  *lu2ccc_dev      (const struct lu_device *d);
 367 struct ccc_device  *cl2ccc_dev      (const struct cl_device *d);
 368 struct ccc_object  *lu2ccc          (const struct lu_object *obj);
 369 struct ccc_object  *cl2ccc          (const struct cl_object *obj);
 370 struct ccc_lock    *cl2ccc_lock     (const struct cl_lock_slice *slice);
 371 struct ccc_io      *cl2ccc_io       (const struct lu_env *env,
 372                                      const struct cl_io_slice *slice);
 373 struct ccc_req     *cl2ccc_req      (const struct cl_req_slice *slice);
 374 struct page         *cl2vm_page      (const struct cl_page_slice *slice);
 375 struct inode       *ccc_object_inode(const struct cl_object *obj);
 376 struct ccc_object  *cl_inode2ccc    (struct inode *inode);
 377
 378 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
 379                    struct obd_capa *capa);
 380
 381 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
 382 int ccc_object_invariant(const struct cl_object *obj);
 383 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
 384 void cl_inode_fini(struct inode *inode);
 385 int cl_local_size(struct inode *inode);
 386
 387 __u16 ll_dirent_type_get(struct lu_dirent *ent);
 388 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
 389 __u32 cl_fid_build_gen(const struct lu_fid *fid);
 390
 391 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 392 # define CLOBINVRNT(env, clob, expr)                                    \
 393   do {                                                                  \
 394           if (unlikely(!(expr))) {                                      \
 395                   LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, #expr "\n"); \
 396                   LINVRNT(0);                                           \
 397           }                                                             \
 398   } while (0)
 399 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 400 # define CLOBINVRNT(env, clob, expr)                                    \
 401          ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 402 #endif /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 403
 404 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 405 int cl_ocd_update(struct obd_device *host,
 406                   struct obd_device *watched,
 407                   enum obd_notify_event ev, void *owner, void *data);
 408
 409 struct ccc_grouplock {
 410         struct lu_env   *cg_env;
 411         struct cl_io    *cg_io;
 412         struct cl_lock  *cg_lock;
 413         unsigned long    cg_gid;
 414 };
 415
 416 int  cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
 417                       struct ccc_grouplock *cg);
 418 void cl_put_grouplock(struct ccc_grouplock *cg);
 419
 420 /**
 421  * New interfaces to get and put lov_stripe_md from lov layer. This violates
 422  * layering because lov_stripe_md is supposed to be a private data in lov.
 423  *
 424  * NB: If you find you have to use these interfaces for your new code, please
 425  * think about it again. These interfaces may be removed in the future for
 426  * better layering. */
 427 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
 428 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
 429 int lov_read_and_clear_async_rc(struct cl_object *clob);
 430
 431 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
 432 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
 433
 434 /**
 435  * Data structure managing a client's cached clean pages. An LRU of
 436  * pages is maintained, along with other statistics.
 437  */
 438 struct cl_client_cache {
 439         cfs_atomic_t    ccc_users;    /* # of users (OSCs) of this data */
 440         cfs_list_t      ccc_lru;      /* LRU list of cached clean pages */
 441         spinlock_t      ccc_lru_lock; /* lock for list */
 442         cfs_atomic_t    ccc_lru_left; /* # of LRU entries available */
 443         unsigned long   ccc_lru_max;  /* Max # of LRU entries possible */
 444         unsigned int    ccc_lru_shrinkers; /* # of threads reclaiming */
 445 };
 446
 447 #endif /*LCLIENT_H */