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;
64 /** Total size for the left IO. */
70 * Inode modification time that is checked across DLM
74 struct vm_area_struct *ft_vma;
76 * locked page returned from vvp_io
78 struct page *ft_vmpage;
82 struct vm_fault *ft_vmf;
84 * fault API used bitflags for return code.
86 unsigned int ft_flags;
88 * check that flags are from filemap_fault
93 struct pipe_inode_info *vui_pipe;
94 unsigned int vui_flags;
97 struct cl_page_list vui_queue;
98 unsigned long vui_written;
104 enum vvp_io_subtype vui_io_subtype;
107 * Layout version when this IO is initialized
109 __u32 vui_layout_gen;
111 * File descriptor against which IO is done.
113 struct ll_file_data *vui_fd;
115 /* Readahead state. */
116 pgoff_t vui_ra_start;
117 pgoff_t vui_ra_count;
118 /* Set when vui_ra_{start,count} have been initialized. */
122 extern struct lu_device_type vvp_device_type;
124 extern struct lu_context_key vvp_session_key;
125 extern struct lu_context_key vvp_thread_key;
127 extern struct kmem_cache *vvp_lock_kmem;
128 extern struct kmem_cache *vvp_object_kmem;
130 struct vvp_thread_info {
131 struct cl_lock vti_lock;
132 struct cl_lock_descr vti_descr;
134 struct cl_attr vti_attr;
137 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
139 struct vvp_thread_info *vti;
141 vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
142 LASSERT(vti != NULL);
147 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
149 struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
151 memset(lock, 0, sizeof(*lock));
156 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
158 struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
160 memset(attr, 0, sizeof(*attr));
165 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
167 struct cl_io *io = &vvp_env_info(env)->vti_io;
169 memset(io, 0, sizeof(*io));
175 struct vvp_io vs_ios;
178 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
180 struct vvp_session *ses;
182 ses = lu_context_key_get(env->le_ses, &vvp_session_key);
183 LASSERT(ses != NULL);
188 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
190 return &vvp_env_session(env)->vs_ios;
194 * VPP-private object state.
197 struct cl_object_header vob_header;
198 struct cl_object vob_cl;
199 struct inode *vob_inode;
202 * Number of transient pages. This is no longer protected by i_sem,
203 * and needs to be atomic. This is not actually used for anything,
204 * and can probably be removed.
206 atomic_t vob_transient_pages;
208 * Number of outstanding mmaps on this file.
210 * \see ll_vm_open(), ll_vm_close().
212 atomic_t vob_mmap_cnt;
216 * vob_discard_page_warned
217 * if pages belonging to this object are discarded when a client
218 * is evicted, some debug info will be printed, this flag will be set
219 * during processing the first discarded page, then avoid flooding
220 * debug message for lots of discarded pages.
222 * \see ll_dirty_page_discard_warn.
224 unsigned int vob_discard_page_warned:1;
228 * VVP-private page state.
231 struct cl_page_slice vpg_cl;
232 unsigned vpg_defer_uptodate:1,
236 struct page *vpg_page;
239 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
241 return container_of(slice, struct vvp_page, vpg_cl);
244 static inline pgoff_t vvp_index(struct vvp_page *vpg)
246 return vpg->vpg_cl.cpl_index;
250 struct cl_device vdv_cl;
251 struct cl_device *vdv_next;
255 struct cl_lock_slice vlk_cl;
258 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
260 return &vdv->vdv_cl.cd_lu_dev;
263 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
265 return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
268 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
270 return container_of0(d, struct vvp_device, vdv_cl);
273 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
275 return container_of0(obj, struct vvp_object, vob_cl);
278 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
280 return container_of0(obj, struct vvp_object, vob_cl.co_lu);
283 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
285 return cl2vvp(obj)->vob_inode;
288 int vvp_object_invariant(const struct cl_object *obj);
289 struct vvp_object *cl_inode2vvp(struct inode *inode);
291 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
293 return cl2vvp_page(slice)->vpg_page;
296 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
298 return container_of(slice, struct vvp_lock, vlk_cl);
301 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
302 # define CLOBINVRNT(env, clob, expr) \
304 if (unlikely(!(expr))) { \
305 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
310 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
311 # define CLOBINVRNT(env, clob, expr) \
312 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
313 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
315 int lov_read_and_clear_async_rc(struct cl_object *clob);
317 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
319 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
320 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
321 struct cl_lock *lock, const struct cl_io *io);
322 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
323 struct cl_page *page, pgoff_t index);
324 struct lu_object *vvp_object_alloc(const struct lu_env *env,
325 const struct lu_object_header *hdr,
326 struct lu_device *dev);
328 int vvp_global_init(void);
329 void vvp_global_fini(void);
331 extern const struct file_operations vvp_dump_pgcache_file_ops;
333 #endif /* VVP_INTERNAL_H */