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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2013, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * Internal definitions for VVP layer.
  37  *
  38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  39  */
  40
  41 #ifndef VVP_INTERNAL_H
  42 #define VVP_INTERNAL_H
  43
  44 #include <lustre/lustre_idl.h>
  45 #include <cl_object.h>
  46
  47 enum obd_notify_event;
  48 struct inode;
  49 struct lov_stripe_md;
  50 struct lustre_md;
  51 struct obd_capa;
  52 struct obd_device;
  53 struct obd_export;
  54 struct page;
  55
  56 enum vvp_io_subtype {
  57         /** normal IO */
  58         IO_NORMAL,
  59         /** io started from splice_{read|write} */
  60         IO_SPLICE,
  61 };
  62
  63 /**
  64  * IO state private to VVP layer.
  65  */
  66 struct vvp_io {
  67         /** super class */
  68         struct cl_io_slice     vui_cl;
  69         struct cl_io_lock_link vui_link;
  70         /**
  71          * I/O vector information to or from which read/write is going.
  72          */
  73         struct iovec *vui_iov;
  74         unsigned long vui_nrsegs;
  75         /**
  76          * Total iov count for left IO.
  77          */
  78         unsigned long vui_tot_nrsegs;
  79         /**
  80          * Old length for iov that was truncated partially.
  81          */
  82         size_t vui_iov_olen;
  83         /**
  84          * Total size for the left IO.
  85          */
  86         size_t vui_tot_count;
  87
  88         union {
  89                 struct vvp_fault_io {
  90                         /**
  91                          * Inode modification time that is checked across DLM
  92                          * lock request.
  93                          */
  94                         time_t                   ft_mtime;
  95                         struct vm_area_struct   *ft_vma;
  96                         /**
  97                          *  locked page returned from vvp_io
  98                          */
  99                         struct page             *ft_vmpage;
 100                         /**
 101                          * kernel fault info
 102                          */
 103                         struct vm_fault         *ft_vmf;
 104                         /**
 105                          * fault API used bitflags for return code.
 106                          */
 107                         unsigned int             ft_flags;
 108                         /**
 109                          * check that flags are from filemap_fault
 110                          */
 111                         bool                     ft_flags_valid;
 112                 } fault;
 113                 struct {
 114                         struct pipe_inode_info  *vui_pipe;
 115                         unsigned int             vui_flags;
 116                 } splice;
 117                 struct {
 118                         struct cl_page_list vui_queue;
 119                         unsigned long vui_written;
 120                         int vui_from;
 121                         int vui_to;
 122                 } write;
 123         } u;
 124
 125         enum vvp_io_subtype     vui_io_subtype;
 126
 127         /**
 128          * Layout version when this IO is initialized
 129          */
 130         __u32                   vui_layout_gen;
 131         /**
 132         * File descriptor against which IO is done.
 133         */
 134         struct ll_file_data     *vui_fd;
 135         struct kiocb            *vui_iocb;
 136
 137         /* Readahead state. */
 138         pgoff_t vui_ra_start;
 139         pgoff_t vui_ra_count;
 140         /* Set when vui_ra_{start,count} have been initialized. */
 141         bool            vui_ra_valid;
 142 };
 143
 144 extern struct lu_device_type vvp_device_type;
 145
 146 extern struct lu_context_key vvp_session_key;
 147 extern struct lu_context_key vvp_thread_key;
 148
 149 extern struct kmem_cache *vvp_lock_kmem;
 150 extern struct kmem_cache *vvp_object_kmem;
 151 extern struct kmem_cache *vvp_req_kmem;
 152
 153 struct vvp_thread_info {
 154         struct cl_lock          vti_lock;
 155         struct cl_lock_descr    vti_descr;
 156         struct cl_io            vti_io;
 157         struct cl_attr          vti_attr;
 158 };
 159
 160 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
 161 {
 162         struct vvp_thread_info *vti;
 163
 164         vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
 165         LASSERT(vti != NULL);
 166
 167         return vti;
 168 }
 169
 170 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
 171 {
 172         struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
 173
 174         memset(lock, 0, sizeof(*lock));
 175
 176         return lock;
 177 }
 178
 179 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
 180 {
 181         struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
 182
 183         memset(attr, 0, sizeof(*attr));
 184
 185         return attr;
 186 }
 187
 188 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
 189 {
 190         struct cl_io *io = &vvp_env_info(env)->vti_io;
 191
 192         memset(io, 0, sizeof(*io));
 193
 194         return io;
 195 }
 196
 197 struct vvp_session {
 198         struct vvp_io vs_ios;
 199 };
 200
 201 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
 202 {
 203         struct vvp_session *ses;
 204
 205         ses = lu_context_key_get(env->le_ses, &vvp_session_key);
 206         LASSERT(ses != NULL);
 207
 208         return ses;
 209 }
 210
 211 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
 212 {
 213         return &vvp_env_session(env)->vs_ios;
 214 }
 215
 216 /**
 217  * VPP-private object state.
 218  */
 219 struct vvp_object {
 220         struct cl_object_header vob_header;
 221         struct cl_object        vob_cl;
 222         struct inode           *vob_inode;
 223
 224         /**
 225          * Number of transient pages.  This is no longer protected by i_sem,
 226          * and needs to be atomic.  This is not actually used for anything,
 227          * and can probably be removed.
 228          */
 229         atomic_t                vob_transient_pages;
 230         /**
 231          * Number of outstanding mmaps on this file.
 232          *
 233          * \see ll_vm_open(), ll_vm_close().
 234          */
 235         atomic_t                vob_mmap_cnt;
 236
 237         /**
 238          * various flags
 239          * vob_discard_page_warned
 240          *     if pages belonging to this object are discarded when a client
 241          * is evicted, some debug info will be printed, this flag will be set
 242          * during processing the first discarded page, then avoid flooding
 243          * debug message for lots of discarded pages.
 244          *
 245          * \see ll_dirty_page_discard_warn.
 246          */
 247         unsigned int            vob_discard_page_warned:1;
 248 };
 249
 250 /**
 251  * VVP-private page state.
 252  */
 253 struct vvp_page {
 254         struct cl_page_slice vpg_cl;
 255         unsigned        vpg_defer_uptodate:1,
 256                         vpg_ra_used:1;
 257         /** VM page */
 258         struct page     *vpg_page;
 259 };
 260
 261 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
 262 {
 263         return container_of(slice, struct vvp_page, vpg_cl);
 264 }
 265
 266 static inline pgoff_t vvp_index(struct vvp_page *vpg)
 267 {
 268         return vpg->vpg_cl.cpl_index;
 269 }
 270
 271 struct vvp_device {
 272         struct cl_device    vdv_cl;
 273         struct super_block *vdv_sb;
 274         struct cl_device   *vdv_next;
 275 };
 276
 277 struct vvp_lock {
 278         struct cl_lock_slice vlk_cl;
 279 };
 280
 281 struct vvp_req {
 282         struct cl_req_slice vrq_cl;
 283 };
 284
 285 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
 286 {
 287         return &vdv->vdv_cl.cd_lu_dev;
 288 }
 289
 290 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
 291 {
 292         return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
 293 }
 294
 295 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
 296 {
 297         return container_of0(d, struct vvp_device, vdv_cl);
 298 }
 299
 300 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
 301 {
 302         return container_of0(obj, struct vvp_object, vob_cl);
 303 }
 304
 305 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
 306 {
 307         return container_of0(obj, struct vvp_object, vob_cl.co_lu);
 308 }
 309
 310 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
 311 {
 312         return cl2vvp(obj)->vob_inode;
 313 }
 314
 315 int vvp_object_invariant(const struct cl_object *obj);
 316 struct vvp_object *cl_inode2vvp(struct inode *inode);
 317
 318 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
 319 {
 320         return cl2vvp_page(slice)->vpg_page;
 321 }
 322
 323 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
 324 {
 325         return container_of(slice, struct vvp_lock, vlk_cl);
 326 }
 327
 328 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 329 # define CLOBINVRNT(env, clob, expr)                                    \
 330         do {                                                            \
 331                 if (unlikely(!(expr))) {                                \
 332                         LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
 333                                         #expr "\n");                    \
 334                         LINVRNT(0);                                     \
 335                 }                                                       \
 336         } while (0)
 337 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 338 # define CLOBINVRNT(env, clob, expr)                                    \
 339         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 340 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 341
 342 /**
 343  * New interfaces to get and put lov_stripe_md from lov layer. This violates
 344  * layering because lov_stripe_md is supposed to be a private data in lov.
 345  *
 346  * NB: If you find you have to use these interfaces for your new code, please
 347  * think about it again. These interfaces may be removed in the future for
 348  * better layering. */
 349 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
 350 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
 351 int lov_read_and_clear_async_rc(struct cl_object *clob);
 352
 353 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
 354 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
 355
 356 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
 357                 struct cl_io *io);
 358 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
 359 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
 360                   struct cl_lock *lock, const struct cl_io *io);
 361 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
 362                   struct cl_page *page, pgoff_t index);
 363 int vvp_req_init(const struct lu_env *env, struct cl_device *dev,
 364                  struct cl_req *req);
 365 struct lu_object *vvp_object_alloc(const struct lu_env *env,
 366                                    const struct lu_object_header *hdr,
 367                                    struct lu_device *dev);
 368
 369 int vvp_global_init(void);
 370 void vvp_global_fini(void);
 371
 372 extern const struct file_operations vvp_dump_pgcache_file_ops;
 373
 374 #endif /* VVP_INTERNAL_H */