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, 2015, 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 lustre_md;
  50 struct obd_device;
  51 struct obd_export;
  52 struct page;
  53
  54 enum vvp_io_subtype {
  55         /** normal IO */
  56         IO_NORMAL,
  57         /** io started from splice_{read|write} */
  58         IO_SPLICE,
  59 };
  60
  61 /**
  62  * IO state private to VVP layer.
  63  */
  64 struct vvp_io {
  65         /** super class */
  66         struct cl_io_slice     vui_cl;
  67         struct cl_io_lock_link vui_link;
  68         /**
  69          * I/O vector information to or from which read/write is going.
  70          */
  71         struct iov_iter *vui_iter;
  72         /**
  73          * Total size for the left IO.
  74          */
  75         size_t vui_tot_count;
  76
  77         union {
  78                 struct vvp_fault_io {
  79                         /**
  80                          * Inode modification time that is checked across DLM
  81                          * lock request.
  82                          */
  83                         time_t                   ft_mtime;
  84                         struct vm_area_struct   *ft_vma;
  85                         /**
  86                          *  locked page returned from vvp_io
  87                          */
  88                         struct page             *ft_vmpage;
  89                         /**
  90                          * kernel fault info
  91                          */
  92                         struct vm_fault         *ft_vmf;
  93                         /**
  94                          * fault API used bitflags for return code.
  95                          */
  96                         unsigned int             ft_flags;
  97                         /**
  98                          * check that flags are from filemap_fault
  99                          */
 100                         bool                     ft_flags_valid;
 101                 } fault;
 102                 struct {
 103                         struct pipe_inode_info  *vui_pipe;
 104                         unsigned int             vui_flags;
 105                 } splice;
 106                 struct {
 107                         struct cl_page_list vui_queue;
 108                         unsigned long vui_written;
 109                         int vui_from;
 110                         int vui_to;
 111                 } write;
 112         } u;
 113
 114         enum vvp_io_subtype     vui_io_subtype;
 115
 116         /**
 117          * Layout version when this IO is initialized
 118          */
 119         __u32                   vui_layout_gen;
 120         /**
 121         * File descriptor against which IO is done.
 122         */
 123         struct ll_file_data     *vui_fd;
 124         struct kiocb            *vui_iocb;
 125
 126         /* Readahead state. */
 127         pgoff_t vui_ra_start;
 128         pgoff_t vui_ra_count;
 129         /* Set when vui_ra_{start,count} have been initialized. */
 130         bool            vui_ra_valid;
 131 };
 132
 133 extern struct lu_device_type vvp_device_type;
 134
 135 extern struct lu_context_key vvp_session_key;
 136 extern struct lu_context_key vvp_thread_key;
 137
 138 extern struct kmem_cache *vvp_lock_kmem;
 139 extern struct kmem_cache *vvp_object_kmem;
 140
 141 struct vvp_thread_info {
 142         struct cl_lock          vti_lock;
 143         struct cl_lock_descr    vti_descr;
 144         struct cl_io            vti_io;
 145         struct cl_attr          vti_attr;
 146 };
 147
 148 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
 149 {
 150         struct vvp_thread_info *vti;
 151
 152         vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
 153         LASSERT(vti != NULL);
 154
 155         return vti;
 156 }
 157
 158 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
 159 {
 160         struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
 161
 162         memset(lock, 0, sizeof(*lock));
 163
 164         return lock;
 165 }
 166
 167 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
 168 {
 169         struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
 170
 171         memset(attr, 0, sizeof(*attr));
 172
 173         return attr;
 174 }
 175
 176 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
 177 {
 178         struct cl_io *io = &vvp_env_info(env)->vti_io;
 179
 180         memset(io, 0, sizeof(*io));
 181
 182         return io;
 183 }
 184
 185 struct vvp_session {
 186         struct vvp_io vs_ios;
 187 };
 188
 189 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
 190 {
 191         struct vvp_session *ses;
 192
 193         ses = lu_context_key_get(env->le_ses, &vvp_session_key);
 194         LASSERT(ses != NULL);
 195
 196         return ses;
 197 }
 198
 199 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
 200 {
 201         return &vvp_env_session(env)->vs_ios;
 202 }
 203
 204 /**
 205  * VPP-private object state.
 206  */
 207 struct vvp_object {
 208         struct cl_object_header vob_header;
 209         struct cl_object        vob_cl;
 210         struct inode           *vob_inode;
 211
 212         /**
 213          * Number of transient pages.  This is no longer protected by i_sem,
 214          * and needs to be atomic.  This is not actually used for anything,
 215          * and can probably be removed.
 216          */
 217         atomic_t                vob_transient_pages;
 218         /**
 219          * Number of outstanding mmaps on this file.
 220          *
 221          * \see ll_vm_open(), ll_vm_close().
 222          */
 223         atomic_t                vob_mmap_cnt;
 224
 225         /**
 226          * various flags
 227          * vob_discard_page_warned
 228          *     if pages belonging to this object are discarded when a client
 229          * is evicted, some debug info will be printed, this flag will be set
 230          * during processing the first discarded page, then avoid flooding
 231          * debug message for lots of discarded pages.
 232          *
 233          * \see ll_dirty_page_discard_warn.
 234          */
 235         unsigned int            vob_discard_page_warned:1;
 236 };
 237
 238 /**
 239  * VVP-private page state.
 240  */
 241 struct vvp_page {
 242         struct cl_page_slice vpg_cl;
 243         unsigned        vpg_defer_uptodate:1,
 244                         vpg_ra_updated:1,
 245                         vpg_ra_used:1;
 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 *vpg)
 256 {
 257         return vpg->vpg_cl.cpl_index;
 258 }
 259
 260 struct vvp_device {
 261         struct cl_device    vdv_cl;
 262         struct cl_device   *vdv_next;
 263 };
 264
 265 struct vvp_lock {
 266         struct cl_lock_slice vlk_cl;
 267 };
 268
 269 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
 270 {
 271         return &vdv->vdv_cl.cd_lu_dev;
 272 }
 273
 274 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
 275 {
 276         return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
 277 }
 278
 279 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
 280 {
 281         return container_of0(d, struct vvp_device, vdv_cl);
 282 }
 283
 284 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
 285 {
 286         return container_of0(obj, struct vvp_object, vob_cl);
 287 }
 288
 289 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
 290 {
 291         return container_of0(obj, struct vvp_object, vob_cl.co_lu);
 292 }
 293
 294 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
 295 {
 296         return cl2vvp(obj)->vob_inode;
 297 }
 298
 299 int vvp_object_invariant(const struct cl_object *obj);
 300 struct vvp_object *cl_inode2vvp(struct inode *inode);
 301
 302 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
 303 {
 304         return cl2vvp_page(slice)->vpg_page;
 305 }
 306
 307 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
 308 {
 309         return container_of(slice, struct vvp_lock, vlk_cl);
 310 }
 311
 312 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 313 # define CLOBINVRNT(env, clob, expr)                                    \
 314         do {                                                            \
 315                 if (unlikely(!(expr))) {                                \
 316                         LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
 317                                         #expr);                         \
 318                         LINVRNT(0);                                     \
 319                 }                                                       \
 320         } while (0)
 321 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 322 # define CLOBINVRNT(env, clob, expr)                                    \
 323         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 324 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 325
 326 int lov_read_and_clear_async_rc(struct cl_object *clob);
 327
 328 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
 329                 struct cl_io *io);
 330 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
 331 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
 332                   struct cl_lock *lock, const struct cl_io *io);
 333 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
 334                   struct cl_page *page, pgoff_t index);
 335 struct lu_object *vvp_object_alloc(const struct lu_env *env,
 336                                    const struct lu_object_header *hdr,
 337                                    struct lu_device *dev);
 338
 339 int vvp_global_init(void);
 340 void vvp_global_fini(void);
 341
 342 extern const struct file_operations vvp_dump_pgcache_file_ops;
 343
 344 #endif /* VVP_INTERNAL_H */