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