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