drivers/staging/lustre/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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2013, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * Internal definitions for VVP layer.
  33  *
  34  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  35  */
  36
  37 #ifndef VVP_INTERNAL_H
  38 #define VVP_INTERNAL_H
  39
  40 #include "../include/lustre/lustre_idl.h"
  41 #include "../include/cl_object.h"
  42
  43 enum obd_notify_event;
  44 struct inode;
  45 struct lov_stripe_md;
  46 struct lustre_md;
  47 struct obd_capa;
  48 struct obd_device;
  49 struct obd_export;
  50 struct page;
  51
  52 /**
  53  * IO state private to IO state private to VVP layer.
  54  */
  55 struct vvp_io {
  56         /** super class */
  57         struct cl_io_slice     vui_cl;
  58         struct cl_io_lock_link vui_link;
  59         /**
  60          * I/O vector information to or from which read/write is going.
  61          */
  62         struct iov_iter *vui_iter;
  63         /**
  64          * Total size for the left IO.
  65          */
  66         size_t vui_tot_count;
  67
  68         union {
  69                 struct vvp_fault_io {
  70                         /**
  71                          * Inode modification time that is checked across DLM
  72                          * lock request.
  73                          */
  74                         time64_t            ft_mtime;
  75                         struct vm_area_struct *ft_vma;
  76                         /**
  77                          *  locked page returned from vvp_io
  78                          */
  79                         struct page         *ft_vmpage;
  80                         /**
  81                          * kernel fault info
  82                          */
  83                         struct vm_fault *ft_vmf;
  84                         /**
  85                          * fault API used bitflags for return code.
  86                          */
  87                         unsigned int    ft_flags;
  88                         /**
  89                          * check that flags are from filemap_fault
  90                          */
  91                         bool            ft_flags_valid;
  92                 } fault;
  93                 struct {
  94                         struct cl_page_list vui_queue;
  95                         unsigned long vui_written;
  96                         int vui_from;
  97                         int vui_to;
  98                 } write;
  99         } u;
 100
 101         /**
 102          * Layout version when this IO is initialized
 103          */
 104         __u32                   vui_layout_gen;
 105         /**
 106          * File descriptor against which IO is done.
 107          */
 108         struct ll_file_data     *vui_fd;
 109         struct kiocb            *vui_iocb;
 110
 111         /* Readahead state. */
 112         pgoff_t vui_ra_start;
 113         pgoff_t vui_ra_count;
 114         /* Set when vui_ra_{start,count} have been initialized. */
 115         bool            vui_ra_valid;
 116 };
 117
 118 extern struct lu_device_type vvp_device_type;
 119
 120 extern struct lu_context_key vvp_session_key;
 121 extern struct lu_context_key vvp_thread_key;
 122
 123 extern struct kmem_cache *vvp_lock_kmem;
 124 extern struct kmem_cache *vvp_object_kmem;
 125 extern struct kmem_cache *vvp_req_kmem;
 126
 127 struct vvp_thread_info {
 128         struct cl_lock          vti_lock;
 129         struct cl_lock_descr    vti_descr;
 130         struct cl_io            vti_io;
 131         struct cl_attr          vti_attr;
 132 };
 133
 134 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
 135 {
 136         struct vvp_thread_info      *vti;
 137
 138         vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
 139         LASSERT(vti);
 140
 141         return vti;
 142 }
 143
 144 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
 145 {
 146         struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
 147
 148         memset(lock, 0, sizeof(*lock));
 149         return lock;
 150 }
 151
 152 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
 153 {
 154         struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
 155
 156         memset(attr, 0, sizeof(*attr));
 157
 158         return attr;
 159 }
 160
 161 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
 162 {
 163         struct cl_io *io = &vvp_env_info(env)->vti_io;
 164
 165         memset(io, 0, sizeof(*io));
 166
 167         return io;
 168 }
 169
 170 struct vvp_session {
 171         struct vvp_io cs_ios;
 172 };
 173
 174 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
 175 {
 176         struct vvp_session *ses;
 177
 178         ses = lu_context_key_get(env->le_ses, &vvp_session_key);
 179         LASSERT(ses);
 180
 181         return ses;
 182 }
 183
 184 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
 185 {
 186         return &vvp_env_session(env)->cs_ios;
 187 }
 188
 189 /**
 190  * ccc-private object state.
 191  */
 192 struct vvp_object {
 193         struct cl_object_header vob_header;
 194         struct cl_object        vob_cl;
 195         struct inode           *vob_inode;
 196
 197         /**
 198          * A list of dirty pages pending IO in the cache. Used by
 199          * SOM. Protected by ll_inode_info::lli_lock.
 200          *
 201          * \see vvp_page::vpg_pending_linkage
 202          */
 203         struct list_head        vob_pending_list;
 204
 205         /**
 206          * Access this counter is protected by inode->i_sem. Now that
 207          * the lifetime of transient pages must be covered by inode sem,
 208          * we don't need to hold any lock..
 209          */
 210         int                     vob_transient_pages;
 211         /**
 212          * Number of outstanding mmaps on this file.
 213          *
 214          * \see ll_vm_open(), ll_vm_close().
 215          */
 216         atomic_t                vob_mmap_cnt;
 217
 218         /**
 219          * various flags
 220          * vob_discard_page_warned
 221          *     if pages belonging to this object are discarded when a client
 222          * is evicted, some debug info will be printed, this flag will be set
 223          * during processing the first discarded page, then avoid flooding
 224          * debug message for lots of discarded pages.
 225          *
 226          * \see ll_dirty_page_discard_warn.
 227          */
 228         unsigned int            vob_discard_page_warned:1;
 229 };
 230
 231 /**
 232  * VVP-private page state.
 233  */
 234 struct vvp_page {
 235         struct cl_page_slice vpg_cl;
 236         int               vpg_defer_uptodate;
 237         int               vpg_ra_used;
 238         int               vpg_write_queued;
 239         /**
 240          * Non-empty iff this page is already counted in
 241          * vvp_object::vob_pending_list. This list is only used as a flag,
 242          * that is, never iterated through, only checked for list_empty(), but
 243          * having a list is useful for debugging.
 244          */
 245         struct list_head           vpg_pending_linkage;
 246         /** VM page */
 247         struct page       *vpg_page;
 248 };
 249
 250 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
 251 {
 252         return container_of(slice, struct vvp_page, vpg_cl);
 253 }
 254
 255 static inline pgoff_t vvp_index(struct vvp_page *vvp)
 256 {
 257         return vvp->vpg_cl.cpl_index;
 258 }
 259
 260 struct vvp_device {
 261         struct cl_device    vdv_cl;
 262         struct super_block *vdv_sb;
 263         struct cl_device   *vdv_next;
 264 };
 265
 266 struct vvp_lock {
 267         struct cl_lock_slice vlk_cl;
 268 };
 269
 270 struct vvp_req {
 271         struct cl_req_slice  vrq_cl;
 272 };
 273
 274 void *ccc_key_init(const struct lu_context *ctx,
 275                    struct lu_context_key *key);
 276 void ccc_key_fini(const struct lu_context *ctx,
 277                   struct lu_context_key *key, void *data);
 278
 279 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 280
 281 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
 282 {
 283         return &vdv->vdv_cl.cd_lu_dev;
 284 }
 285
 286 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
 287 {
 288         return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
 289 }
 290
 291 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
 292 {
 293         return container_of0(d, struct vvp_device, vdv_cl);
 294 }
 295
 296 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
 297 {
 298         return container_of0(obj, struct vvp_object, vob_cl);
 299 }
 300
 301 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
 302 {
 303         return container_of0(obj, struct vvp_object, vob_cl.co_lu);
 304 }
 305
 306 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
 307 {
 308         return cl2vvp(obj)->vob_inode;
 309 }
 310
 311 int vvp_object_invariant(const struct cl_object *obj);
 312 struct vvp_object *cl_inode2vvp(struct inode *inode);
 313
 314 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
 315 {
 316         return cl2vvp_page(slice)->vpg_page;
 317 }
 318
 319 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
 320 {
 321         return container_of(slice, struct vvp_lock, vlk_cl);
 322 }
 323
 324 # define CLOBINVRNT(env, clob, expr)                                    \
 325         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof(!!(expr)))
 326
 327 /**
 328  * New interfaces to get and put lov_stripe_md from lov layer. This violates
 329  * layering because lov_stripe_md is supposed to be a private data in lov.
 330  *
 331  * NB: If you find you have to use these interfaces for your new code, please
 332  * think about it again. These interfaces may be removed in the future for
 333  * better layering.
 334  */
 335 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
 336 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
 337 int lov_read_and_clear_async_rc(struct cl_object *clob);
 338
 339 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
 340 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
 341
 342 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
 343                 struct cl_io *io);
 344 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
 345 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
 346                   struct cl_lock *lock, const struct cl_io *io);
 347 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
 348                   struct cl_page *page, pgoff_t index);
 349 int vvp_req_init(const struct lu_env *env, struct cl_device *dev,
 350                  struct cl_req *req);
 351 struct lu_object *vvp_object_alloc(const struct lu_env *env,
 352                                    const struct lu_object_header *hdr,
 353                                    struct lu_device *dev);
 354
 355 int vvp_global_init(void);
 356 void vvp_global_fini(void);
 357
 358 extern const struct file_operations vvp_dump_pgcache_file_ops;
 359
 360 #endif /* VVP_INTERNAL_H */