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