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                         unsigned long vui_read;
 101                         int vui_from;
 102                         int vui_to;
 103                 } readwrite; /* normal io */
 104         } u;
 105
 106         enum vvp_io_subtype     vui_io_subtype;
 107
 108         /**
 109          * Layout version when this IO is initialized
 110          */
 111         __u32                   vui_layout_gen;
 112         /**
 113         * File descriptor against which IO is done.
 114         */
 115         struct ll_file_data     *vui_fd;
 116         struct kiocb            *vui_iocb;
 117
 118         /* Readahead state. */
 119         pgoff_t                 vui_ra_start_idx;
 120         pgoff_t                 vui_ra_pages;
 121         /* Set when vui_ra_{start,count} have been initialized. */
 122         bool                    vui_ra_valid;
 123 };
 124
 125 extern struct lu_device_type vvp_device_type;
 126
 127 extern struct lu_context_key vvp_session_key;
 128 extern struct lu_context_key vvp_thread_key;
 129
 130 extern struct kmem_cache *vvp_object_kmem;
 131
 132 struct vvp_thread_info {
 133         struct cl_lock          vti_lock;
 134         struct cl_lock_descr    vti_descr;
 135         struct cl_io            vti_io;
 136         struct cl_attr          vti_attr;
 137         struct cl_sync_io       vti_anchor;
 138 };
 139
 140 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
 141 {
 142         struct vvp_thread_info *vti;
 143
 144         vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
 145         LASSERT(vti != NULL);
 146
 147         return vti;
 148 }
 149
 150 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
 151 {
 152         struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
 153
 154         memset(lock, 0, sizeof(*lock));
 155
 156         return lock;
 157 }
 158
 159 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
 160 {
 161         struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
 162
 163         memset(attr, 0, sizeof(*attr));
 164
 165         return attr;
 166 }
 167
 168 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
 169 {
 170         struct cl_io *io = &vvp_env_info(env)->vti_io;
 171
 172         memset(io, 0, sizeof(*io));
 173
 174         return io;
 175 }
 176
 177 struct vvp_session {
 178         struct vvp_io vs_ios;
 179 };
 180
 181 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
 182 {
 183         struct vvp_session *ses;
 184
 185         ses = lu_context_key_get(env->le_ses, &vvp_session_key);
 186         LASSERT(ses != NULL);
 187
 188         return ses;
 189 }
 190
 191 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
 192 {
 193         return &vvp_env_session(env)->vs_ios;
 194 }
 195
 196 /**
 197  * VPP-private object state.
 198  */
 199 struct vvp_object {
 200         struct cl_object_header vob_header;
 201         struct cl_object        vob_cl;
 202         struct inode           *vob_inode;
 203
 204         /**
 205          * Number of transient pages.  This is no longer protected by i_sem,
 206          * and needs to be atomic.  This is not actually used for anything,
 207          * and can probably be removed.
 208          */
 209         atomic_t                vob_transient_pages;
 210         /**
 211          * Number of outstanding mmaps on this file.
 212          *
 213          * \see ll_vm_open(), ll_vm_close().
 214          */
 215         atomic_t                vob_mmap_cnt;
 216
 217         /**
 218          * various flags
 219          * vob_discard_page_warned
 220          *     if pages belonging to this object are discarded when a client
 221          * is evicted, some debug info will be printed, this flag will be set
 222          * during processing the first discarded page, then avoid flooding
 223          * debug message for lots of discarded pages.
 224          *
 225          * \see ll_dirty_page_discard_warn.
 226          */
 227         unsigned int            vob_discard_page_warned:1;
 228 };
 229
 230 /**
 231  * VVP-private page state.
 232  */
 233 struct vvp_page {
 234         struct cl_page_slice vpg_cl;
 235         unsigned        vpg_defer_uptodate:1,
 236                         vpg_ra_updated:1,
 237                         vpg_ra_used:1;
 238         /** VM page */
 239         struct page     *vpg_page;
 240 };
 241
 242 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
 243 {
 244         return container_of(slice, struct vvp_page, vpg_cl);
 245 }
 246
 247 static inline pgoff_t vvp_index(struct vvp_page *vpg)
 248 {
 249         return vpg->vpg_page->index;
 250 }
 251
 252 struct vvp_device {
 253         struct cl_device    vdv_cl;
 254         struct cl_device   *vdv_next;
 255 };
 256
 257 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
 258 {
 259         return &vdv->vdv_cl.cd_lu_dev;
 260 }
 261
 262 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
 263 {
 264         return container_of_safe(d, struct vvp_device, vdv_cl.cd_lu_dev);
 265 }
 266
 267 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
 268 {
 269         return container_of_safe(d, struct vvp_device, vdv_cl);
 270 }
 271
 272 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
 273 {
 274         return container_of_safe(obj, struct vvp_object, vob_cl);
 275 }
 276
 277 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
 278 {
 279         return container_of_safe(obj, struct vvp_object, vob_cl.co_lu);
 280 }
 281
 282 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
 283 {
 284         return cl2vvp(obj)->vob_inode;
 285 }
 286
 287 int vvp_object_invariant(const struct cl_object *obj);
 288 struct vvp_object *cl_inode2vvp(struct inode *inode);
 289
 290 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
 291 {
 292         return cl2vvp_page(slice)->vpg_page;
 293 }
 294
 295 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 296 # define CLOBINVRNT(env, clob, expr)                                    \
 297         do {                                                            \
 298                 if (unlikely(!(expr))) {                                \
 299                         LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
 300                                         #expr);                         \
 301                         LINVRNT(0);                                     \
 302                 }                                                       \
 303         } while (0)
 304 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 305 # define CLOBINVRNT(env, clob, expr)                                    \
 306         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 307 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 308
 309 int lov_read_and_clear_async_rc(struct cl_object *clob);
 310
 311 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
 312                 struct cl_io *io);
 313 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
 314 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
 315                   struct cl_page *page, pgoff_t index);
 316 struct lu_object *vvp_object_alloc(const struct lu_env *env,
 317                                    const struct lu_object_header *hdr,
 318                                    struct lu_device *dev);
 319
 320 int vvp_global_init(void);
 321 void vvp_global_fini(void);
 322
 323 #ifndef HAVE_ACCOUNT_PAGE_DIRTIED_EXPORT
 324 extern unsigned int (*vvp_account_page_dirtied)(struct page *page,
 325                                                 struct address_space *mapping);
 326 #endif
 327
 328 extern const struct file_operations vvp_dump_pgcache_file_ops;
 329
 330 #endif /* VVP_INTERNAL_H */