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