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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2013, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * Internal definitions for VVP layer.
34 * Author: Nikita Danilov <nikita.danilov@sun.com>
37 #ifndef VVP_INTERNAL_H
38 #define VVP_INTERNAL_H
40 #include <lustre/lustre_idl.h>
41 #include <cl_object.h>
43 enum obd_notify_event;
53 /** io started from splice_{read|write} */
58 * IO state private to VVP layer.
62 struct cl_io_slice vui_cl;
63 struct cl_io_lock_link vui_link;
65 * I/O vector information to or from which read/write is going.
67 struct iov_iter *vui_iter;
69 * Total size for the left IO.
76 * Inode modification time that is checked across DLM
80 struct vm_area_struct *ft_vma;
82 * locked page returned from vvp_io
84 struct page *ft_vmpage;
88 struct vm_fault *ft_vmf;
90 * fault API used bitflags for return code.
92 unsigned int ft_flags;
94 * check that flags are from filemap_fault
99 struct pipe_inode_info *vui_pipe;
100 unsigned int vui_flags;
103 struct cl_page_list vui_queue;
104 unsigned long vui_written;
110 enum vvp_io_subtype vui_io_subtype;
113 * Layout version when this IO is initialized
115 __u32 vui_layout_gen;
117 * File descriptor against which IO is done.
119 struct ll_file_data *vui_fd;
120 struct kiocb *vui_iocb;
122 /* Readahead state. */
123 pgoff_t vui_ra_start;
124 pgoff_t vui_ra_count;
125 /* Set when vui_ra_{start,count} have been initialized. */
129 extern struct lu_device_type vvp_device_type;
131 extern struct lu_context_key vvp_session_key;
132 extern struct lu_context_key vvp_thread_key;
134 extern struct kmem_cache *vvp_lock_kmem;
135 extern struct kmem_cache *vvp_object_kmem;
137 struct vvp_thread_info {
138 struct cl_lock vti_lock;
139 struct cl_lock_descr vti_descr;
141 struct cl_attr vti_attr;
144 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
146 struct vvp_thread_info *vti;
148 vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
149 LASSERT(vti != NULL);
154 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
156 struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
158 memset(lock, 0, sizeof(*lock));
163 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
165 struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
167 memset(attr, 0, sizeof(*attr));
172 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
174 struct cl_io *io = &vvp_env_info(env)->vti_io;
176 memset(io, 0, sizeof(*io));
182 struct vvp_io vs_ios;
185 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
187 struct vvp_session *ses;
189 ses = lu_context_key_get(env->le_ses, &vvp_session_key);
190 LASSERT(ses != NULL);
195 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
197 return &vvp_env_session(env)->vs_ios;
201 * VPP-private object state.
204 struct cl_object_header vob_header;
205 struct cl_object vob_cl;
206 struct inode *vob_inode;
209 * Number of transient pages. This is no longer protected by i_sem,
210 * and needs to be atomic. This is not actually used for anything,
211 * and can probably be removed.
213 atomic_t vob_transient_pages;
215 * Number of outstanding mmaps on this file.
217 * \see ll_vm_open(), ll_vm_close().
219 atomic_t vob_mmap_cnt;
223 * vob_discard_page_warned
224 * if pages belonging to this object are discarded when a client
225 * is evicted, some debug info will be printed, this flag will be set
226 * during processing the first discarded page, then avoid flooding
227 * debug message for lots of discarded pages.
229 * \see ll_dirty_page_discard_warn.
231 unsigned int vob_discard_page_warned:1;
235 * VVP-private page state.
238 struct cl_page_slice vpg_cl;
239 unsigned vpg_defer_uptodate:1,
243 struct page *vpg_page;
246 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
248 return container_of(slice, struct vvp_page, vpg_cl);
251 static inline pgoff_t vvp_index(struct vvp_page *vpg)
253 return vpg->vpg_cl.cpl_index;
257 struct cl_device vdv_cl;
258 struct cl_device *vdv_next;
262 struct cl_lock_slice vlk_cl;
265 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
267 return &vdv->vdv_cl.cd_lu_dev;
270 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
272 return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
275 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
277 return container_of0(d, struct vvp_device, vdv_cl);
280 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
282 return container_of0(obj, struct vvp_object, vob_cl);
285 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
287 return container_of0(obj, struct vvp_object, vob_cl.co_lu);
290 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
292 return cl2vvp(obj)->vob_inode;
295 int vvp_object_invariant(const struct cl_object *obj);
296 struct vvp_object *cl_inode2vvp(struct inode *inode);
298 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
300 return cl2vvp_page(slice)->vpg_page;
303 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
305 return container_of(slice, struct vvp_lock, vlk_cl);
308 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
309 # define CLOBINVRNT(env, clob, expr) \
311 if (unlikely(!(expr))) { \
312 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
317 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
318 # define CLOBINVRNT(env, clob, expr) \
319 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
320 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
322 int lov_read_and_clear_async_rc(struct cl_object *clob);
324 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
326 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
327 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
328 struct cl_lock *lock, const struct cl_io *io);
329 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
330 struct cl_page *page, pgoff_t index);
331 struct lu_object *vvp_object_alloc(const struct lu_env *env,
332 const struct lu_object_header *hdr,
333 struct lu_device *dev);
335 int vvp_global_init(void);
336 void vvp_global_fini(void);
338 extern const struct file_operations vvp_dump_pgcache_file_ops;
340 #endif /* VVP_INTERNAL_H */