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