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