lustre/llite/vvp_internal.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) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2013, 2014, 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  * Internal definitions for VVP layer.
  37  *
  38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  39  */
  40
  41 #ifndef VVP_INTERNAL_H
  42 #define VVP_INTERNAL_H
  43
  44 #include <lustre/lustre_idl.h>
  45 #include <cl_object.h>
  46
  47 enum obd_notify_event;
  48 struct inode;
  49 struct lov_stripe_md;
  50 struct lustre_md;
  51 struct obd_capa;
  52 struct obd_device;
  53 struct obd_export;
  54 struct page;
  55
  56 blkcnt_t dirty_cnt(struct inode *inode);
  57
  58 int cl_glimpse_size0(struct inode *inode, int agl);
  59 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
  60                     struct inode *inode, struct cl_object *clob, int agl);
  61
  62 static inline int cl_glimpse_size(struct inode *inode)
  63 {
  64         return cl_glimpse_size0(inode, 0);
  65 }
  66
  67 static inline int cl_agl(struct inode *inode)
  68 {
  69         return cl_glimpse_size0(inode, 1);
  70 }
  71
  72 /**
  73  * Locking policy for setattr.
  74  */
  75 enum ccc_setattr_lock_type {
  76         /** Locking is done by server */
  77         SETATTR_NOLOCK,
  78         /** Extent lock is enqueued */
  79         SETATTR_EXTENT_LOCK,
  80         /** Existing local extent lock is used */
  81         SETATTR_MATCH_LOCK
  82 };
  83
  84 enum vvp_io_subtype {
  85         /** normal IO */
  86         IO_NORMAL,
  87         /** io started from splice_{read|write} */
  88         IO_SPLICE,
  89 };
  90
  91 /**
  92  * IO state private to VVP layer.
  93  */
  94 struct vvp_io {
  95         /** super class */
  96         struct cl_io_slice     vui_cl;
  97         struct cl_io_lock_link vui_link;
  98         /**
  99          * I/O vector information to or from which read/write is going.
 100          */
 101         struct iovec *vui_iov;
 102         unsigned long vui_nrsegs;
 103         /**
 104          * Total iov count for left IO.
 105          */
 106         unsigned long vui_tot_nrsegs;
 107         /**
 108          * Old length for iov that was truncated partially.
 109          */
 110         size_t vui_iov_olen;
 111         /**
 112          * Total size for the left IO.
 113          */
 114         size_t vui_tot_count;
 115
 116         union {
 117                 struct vvp_fault_io {
 118                         /**
 119                          * Inode modification time that is checked across DLM
 120                          * lock request.
 121                          */
 122                         time_t                   ft_mtime;
 123                         struct vm_area_struct   *ft_vma;
 124                         /**
 125                          *  locked page returned from vvp_io
 126                          */
 127                         struct page             *ft_vmpage;
 128                         /**
 129                          * kernel fault info
 130                          */
 131                         struct vm_fault         *ft_vmf;
 132                         /**
 133                          * fault API used bitflags for return code.
 134                          */
 135                         unsigned int             ft_flags;
 136                         /**
 137                          * check that flags are from filemap_fault
 138                          */
 139                         bool                     ft_flags_valid;
 140                 } fault;
 141                 struct {
 142                         enum ccc_setattr_lock_type vui_local_lock;
 143                 } setattr;
 144                 struct {
 145                         struct pipe_inode_info  *vui_pipe;
 146                         unsigned int             vui_flags;
 147                 } splice;
 148                 struct {
 149                         struct cl_page_list vui_queue;
 150                         unsigned long vui_written;
 151                         int vui_from;
 152                         int vui_to;
 153                 } write;
 154         } u;
 155
 156         enum vvp_io_subtype     vui_io_subtype;
 157
 158         /**
 159          * Layout version when this IO is initialized
 160          */
 161         __u32                   vui_layout_gen;
 162         /**
 163         * File descriptor against which IO is done.
 164         */
 165         struct ll_file_data     *vui_fd;
 166         struct kiocb            *vui_iocb;
 167
 168         /* Readahead state. */
 169         pgoff_t vui_ra_start;
 170         pgoff_t vui_ra_count;
 171         /* Set when vui_ra_{start,count} have been initialized. */
 172         bool            vui_ra_valid;
 173 };
 174
 175 /**
 176  * True, if \a io is a normal io, False for other splice_{read,write}.
 177  * must be impementated in arch specific code.
 178  */
 179 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
 180
 181 extern struct lu_context_key ccc_key;
 182 extern struct lu_context_key vvp_session_key;
 183
 184 extern struct kmem_cache *vvp_lock_kmem;
 185 extern struct kmem_cache *vvp_object_kmem;
 186
 187 struct ccc_thread_info {
 188         struct cl_lock          cti_lock;
 189         struct cl_lock_descr    cti_descr;
 190         struct cl_io            cti_io;
 191         struct cl_attr          cti_attr;
 192 };
 193
 194 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
 195 {
 196         struct ccc_thread_info      *info;
 197
 198         info = lu_context_key_get(&env->le_ctx, &ccc_key);
 199         LASSERT(info != NULL);
 200
 201         return info;
 202 }
 203
 204 static inline struct cl_lock *ccc_env_lock(const struct lu_env *env)
 205 {
 206         struct cl_lock *lock = &ccc_env_info(env)->cti_lock;
 207
 208         memset(lock, 0, sizeof(*lock));
 209
 210         return lock;
 211 }
 212
 213 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
 214 {
 215         struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
 216
 217         memset(attr, 0, sizeof(*attr));
 218
 219         return attr;
 220 }
 221
 222 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
 223 {
 224         struct cl_io *io = &ccc_env_info(env)->cti_io;
 225
 226         memset(io, 0, sizeof(*io));
 227
 228         return io;
 229 }
 230
 231 struct vvp_session {
 232         struct vvp_io cs_ios;
 233 };
 234
 235 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
 236 {
 237         struct vvp_session *ses;
 238
 239         ses = lu_context_key_get(env->le_ses, &vvp_session_key);
 240         LASSERT(ses != NULL);
 241
 242         return ses;
 243 }
 244
 245 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
 246 {
 247         return &vvp_env_session(env)->cs_ios;
 248 }
 249
 250 /**
 251  * ccc-private object state.
 252  */
 253 struct vvp_object {
 254         struct cl_object_header vob_header;
 255         struct cl_object        vob_cl;
 256         struct inode           *vob_inode;
 257
 258         /**
 259          * A list of dirty pages pending IO in the cache. Used by
 260          * SOM. Protected by ll_inode_info::lli_lock.
 261          *
 262          * \see vvp_page::vpg_pending_linkage
 263          */
 264         struct list_head        vob_pending_list;
 265
 266         /**
 267          * Number of transient pages.  This is no longer protected by i_sem,
 268          * and needs to be atomic.  This is not actually used for anything,
 269          * and can probably be removed.
 270          */
 271         atomic_t                vob_transient_pages;
 272         /**
 273          * Number of outstanding mmaps on this file.
 274          *
 275          * \see ll_vm_open(), ll_vm_close().
 276          */
 277         atomic_t                vob_mmap_cnt;
 278
 279         /**
 280          * various flags
 281          * vob_discard_page_warned
 282          *     if pages belonging to this object are discarded when a client
 283          * is evicted, some debug info will be printed, this flag will be set
 284          * during processing the first discarded page, then avoid flooding
 285          * debug message for lots of discarded pages.
 286          *
 287          * \see ll_dirty_page_discard_warn.
 288          */
 289         unsigned int            vob_discard_page_warned:1;
 290 };
 291
 292 /**
 293  * VVP-private page state.
 294  */
 295 struct vvp_page {
 296         struct cl_page_slice vpg_cl;
 297         unsigned        vpg_defer_uptodate:1,
 298                         vpg_ra_used:1,
 299                         vpg_write_queued:1;
 300         /**
 301          * Non-empty iff this page is already counted in
 302          * vvp_object::vob_pending_list. This list is only used as a flag,
 303          * that is, never iterated through, only checked for list_empty(), but
 304          * having a list is useful for debugging.
 305          */
 306         struct list_head vpg_pending_linkage;
 307         /** VM page */
 308         struct page     *vpg_page;
 309 };
 310
 311 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
 312 {
 313         return container_of(slice, struct vvp_page, vpg_cl);
 314 }
 315
 316 static inline pgoff_t vvp_index(struct vvp_page *vpg)
 317 {
 318         return vpg->vpg_cl.cpl_index;
 319 }
 320
 321 struct vvp_device {
 322         struct cl_device    vdv_cl;
 323         struct super_block *vdv_sb;
 324         struct cl_device   *vdv_next;
 325 };
 326
 327 struct vvp_lock {
 328         struct cl_lock_slice vlk_cl;
 329 };
 330
 331 struct ccc_req {
 332         struct cl_req_slice  crq_cl;
 333 };
 334
 335 void *ccc_key_init(const struct lu_context *ctx, struct lu_context_key *key);
 336 void ccc_key_fini(const struct lu_context *ctx, struct lu_context_key *key,
 337                   void *data);
 338
 339 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 340                  struct cl_req *req);
 341 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 342 int ccc_global_init(struct lu_device_type *device_type);
 343 void ccc_global_fini(struct lu_device_type *device_type);
 344
 345 int vvp_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 vvp_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 vvp_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
 352 void vvp_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 353                     size_t nob);
 354 void vvp_io_update_iov(const struct lu_env *env, struct vvp_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,
 361                       const struct cl_req_slice *slice,
 362                       const struct cl_object *obj,
 363                       struct cl_req_attr *oa, obd_valid flags);
 364
 365 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
 366 {
 367         return &vdv->vdv_cl.cd_lu_dev;
 368 }
 369
 370 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
 371 {
 372         return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
 373 }
 374
 375 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
 376 {
 377         return container_of0(d, struct vvp_device, vdv_cl);
 378 }
 379
 380 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
 381 {
 382         return container_of0(obj, struct vvp_object, vob_cl);
 383 }
 384
 385 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
 386 {
 387         return container_of0(obj, struct vvp_object, vob_cl.co_lu);
 388 }
 389
 390 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
 391 {
 392         return cl2vvp(obj)->vob_inode;
 393 }
 394
 395 int vvp_object_invariant(const struct cl_object *obj);
 396 struct vvp_object *cl_inode2vvp(struct inode *inode);
 397
 398 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
 399 {
 400         return cl2vvp_page(slice)->vpg_page;
 401 }
 402
 403 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
 404 {
 405         return container_of(slice, struct vvp_lock, vlk_cl);
 406 }
 407
 408 struct vvp_io *cl2vvp_io(const struct lu_env *env,
 409                          const struct cl_io_slice *slice);
 410 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice);
 411
 412 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
 413                    struct obd_capa *capa);
 414
 415 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
 416 void cl_inode_fini(struct inode *inode);
 417 int cl_local_size(struct inode *inode);
 418
 419 __u16 ll_dirent_type_get(struct lu_dirent *ent);
 420 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
 421 __u32 cl_fid_build_gen(const struct lu_fid *fid);
 422
 423 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 424 # define CLOBINVRNT(env, clob, expr)                                    \
 425         do {                                                            \
 426                 if (unlikely(!(expr))) {                                \
 427                         LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
 428                                         #expr "\n");                    \
 429                         LINVRNT(0);                                     \
 430                 }                                                       \
 431         } while (0)
 432 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 433 # define CLOBINVRNT(env, clob, expr)                                    \
 434         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 435 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 436
 437 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 438 int cl_ocd_update(struct obd_device *host,
 439                   struct obd_device *watched,
 440                   enum obd_notify_event ev, void *owner, void *data);
 441
 442 struct ccc_grouplock {
 443         struct lu_env   *cg_env;
 444         struct cl_io    *cg_io;
 445         struct cl_lock  *cg_lock;
 446         unsigned long    cg_gid;
 447 };
 448
 449 int cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
 450                      struct ccc_grouplock *cg);
 451 void cl_put_grouplock(struct ccc_grouplock *cg);
 452
 453 /**
 454  * New interfaces to get and put lov_stripe_md from lov layer. This violates
 455  * layering because lov_stripe_md is supposed to be a private data in lov.
 456  *
 457  * NB: If you find you have to use these interfaces for your new code, please
 458  * think about it again. These interfaces may be removed in the future for
 459  * better layering. */
 460 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
 461 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
 462 int lov_read_and_clear_async_rc(struct cl_object *clob);
 463
 464 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
 465 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
 466
 467 enum {
 468         LUSTRE_OPC_MKDIR        = 0,
 469         LUSTRE_OPC_SYMLINK      = 1,
 470         LUSTRE_OPC_MKNOD        = 2,
 471         LUSTRE_OPC_CREATE       = 3,
 472         LUSTRE_OPC_ANY          = 5,
 473 };
 474
 475 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
 476                 struct cl_io *io);
 477 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
 478                   struct cl_lock *lock, const struct cl_io *io);
 479 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
 480                   struct cl_page *page, pgoff_t index);
 481 struct lu_object *vvp_object_alloc(const struct lu_env *env,
 482                                    const struct lu_object_header *hdr,
 483                                    struct lu_device *dev);
 484
 485 extern const struct file_operations vvp_dump_pgcache_file_ops;
 486
 487 #endif /* VVP_INTERNAL_H */