4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2013, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Internal definitions for VVP layer.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
41 #ifndef VVP_INTERNAL_H
42 #define VVP_INTERNAL_H
44 #include <lustre/lustre_idl.h>
45 #include <cl_object.h>
47 enum obd_notify_event;
57 /** io started from splice_{read|write} */
62 * IO state private to VVP layer.
66 struct cl_io_slice vui_cl;
67 struct cl_io_lock_link vui_link;
69 * I/O vector information to or from which read/write is going.
71 struct iov_iter *vui_iter;
73 * Total size for the left IO.
80 * Inode modification time that is checked across DLM
84 struct vm_area_struct *ft_vma;
86 * locked page returned from vvp_io
88 struct page *ft_vmpage;
92 struct vm_fault *ft_vmf;
94 * fault API used bitflags for return code.
96 unsigned int ft_flags;
98 * check that flags are from filemap_fault
103 struct pipe_inode_info *vui_pipe;
104 unsigned int vui_flags;
107 struct cl_page_list vui_queue;
108 unsigned long vui_written;
114 enum vvp_io_subtype vui_io_subtype;
117 * Layout version when this IO is initialized
119 __u32 vui_layout_gen;
121 * File descriptor against which IO is done.
123 struct ll_file_data *vui_fd;
124 struct kiocb *vui_iocb;
126 /* Readahead state. */
127 pgoff_t vui_ra_start;
128 pgoff_t vui_ra_count;
129 /* Set when vui_ra_{start,count} have been initialized. */
133 extern struct lu_device_type vvp_device_type;
135 extern struct lu_context_key vvp_session_key;
136 extern struct lu_context_key vvp_thread_key;
138 extern struct kmem_cache *vvp_lock_kmem;
139 extern struct kmem_cache *vvp_object_kmem;
141 struct vvp_thread_info {
142 struct cl_lock vti_lock;
143 struct cl_lock_descr vti_descr;
145 struct cl_attr vti_attr;
148 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
150 struct vvp_thread_info *vti;
152 vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
153 LASSERT(vti != NULL);
158 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
160 struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
162 memset(lock, 0, sizeof(*lock));
167 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
169 struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
171 memset(attr, 0, sizeof(*attr));
176 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
178 struct cl_io *io = &vvp_env_info(env)->vti_io;
180 memset(io, 0, sizeof(*io));
186 struct vvp_io vs_ios;
189 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
191 struct vvp_session *ses;
193 ses = lu_context_key_get(env->le_ses, &vvp_session_key);
194 LASSERT(ses != NULL);
199 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
201 return &vvp_env_session(env)->vs_ios;
205 * VPP-private object state.
208 struct cl_object_header vob_header;
209 struct cl_object vob_cl;
210 struct inode *vob_inode;
213 * Number of transient pages. This is no longer protected by i_sem,
214 * and needs to be atomic. This is not actually used for anything,
215 * and can probably be removed.
217 atomic_t vob_transient_pages;
219 * Number of outstanding mmaps on this file.
221 * \see ll_vm_open(), ll_vm_close().
223 atomic_t vob_mmap_cnt;
227 * vob_discard_page_warned
228 * if pages belonging to this object are discarded when a client
229 * is evicted, some debug info will be printed, this flag will be set
230 * during processing the first discarded page, then avoid flooding
231 * debug message for lots of discarded pages.
233 * \see ll_dirty_page_discard_warn.
235 unsigned int vob_discard_page_warned:1;
239 * VVP-private page state.
242 struct cl_page_slice vpg_cl;
243 unsigned vpg_defer_uptodate:1,
247 struct page *vpg_page;
250 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
252 return container_of(slice, struct vvp_page, vpg_cl);
255 static inline pgoff_t vvp_index(struct vvp_page *vpg)
257 return vpg->vpg_cl.cpl_index;
261 struct cl_device vdv_cl;
262 struct cl_device *vdv_next;
266 struct cl_lock_slice vlk_cl;
269 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
271 return &vdv->vdv_cl.cd_lu_dev;
274 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
276 return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
279 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
281 return container_of0(d, struct vvp_device, vdv_cl);
284 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
286 return container_of0(obj, struct vvp_object, vob_cl);
289 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
291 return container_of0(obj, struct vvp_object, vob_cl.co_lu);
294 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
296 return cl2vvp(obj)->vob_inode;
299 int vvp_object_invariant(const struct cl_object *obj);
300 struct vvp_object *cl_inode2vvp(struct inode *inode);
302 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
304 return cl2vvp_page(slice)->vpg_page;
307 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
309 return container_of(slice, struct vvp_lock, vlk_cl);
312 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
313 # define CLOBINVRNT(env, clob, expr) \
315 if (unlikely(!(expr))) { \
316 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
321 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
322 # define CLOBINVRNT(env, clob, expr) \
323 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
324 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
326 int lov_read_and_clear_async_rc(struct cl_object *clob);
328 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
330 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
331 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
332 struct cl_lock *lock, const struct cl_io *io);
333 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
334 struct cl_page *page, pgoff_t index);
335 struct lu_object *vvp_object_alloc(const struct lu_env *env,
336 const struct lu_object_header *hdr,
337 struct lu_device *dev);
339 int vvp_global_init(void);
340 void vvp_global_fini(void);
342 extern const struct file_operations vvp_dump_pgcache_file_ops;
344 #endif /* VVP_INTERNAL_H */