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