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, 2017, 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 <cl_object.h>
42 enum obd_notify_event;
52 /** io started from splice_{read|write} */
57 * IO state private to VVP layer.
61 struct cl_io_slice vui_cl;
62 struct cl_io_lock_link vui_link;
64 * I/O vector information to or from which read/write is going.
66 struct iov_iter *vui_iter;
68 * Total size for the left IO.
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
91 struct cl_page_list ft_queue;
94 struct pipe_inode_info *vui_pipe;
95 unsigned int vui_flags;
98 struct cl_page_list vui_queue;
99 unsigned long vui_written;
105 enum vvp_io_subtype vui_io_subtype;
108 * Layout version when this IO is initialized
110 __u32 vui_layout_gen;
112 * File descriptor against which IO is done.
114 struct ll_file_data *vui_fd;
115 struct kiocb *vui_iocb;
117 /* Readahead state. */
118 pgoff_t vui_ra_start_idx;
119 pgoff_t vui_ra_pages;
120 /* Set when vui_ra_{start,count} have been initialized. */
124 extern struct lu_device_type vvp_device_type;
126 extern struct lu_context_key vvp_session_key;
127 extern struct lu_context_key vvp_thread_key;
129 extern struct kmem_cache *vvp_object_kmem;
131 struct vvp_thread_info {
132 struct cl_lock vti_lock;
133 struct cl_lock_descr vti_descr;
135 struct cl_attr vti_attr;
136 struct cl_sync_io vti_anchor;
139 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
141 struct vvp_thread_info *vti;
143 vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
144 LASSERT(vti != NULL);
149 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
151 struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
153 memset(lock, 0, sizeof(*lock));
158 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
160 struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
162 memset(attr, 0, sizeof(*attr));
167 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
169 struct cl_io *io = &vvp_env_info(env)->vti_io;
171 memset(io, 0, sizeof(*io));
177 struct vvp_io vs_ios;
180 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
182 struct vvp_session *ses;
184 ses = lu_context_key_get(env->le_ses, &vvp_session_key);
185 LASSERT(ses != NULL);
190 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
192 return &vvp_env_session(env)->vs_ios;
196 * VPP-private object state.
199 struct cl_object_header vob_header;
200 struct cl_object vob_cl;
201 struct inode *vob_inode;
204 * Number of transient pages. This is no longer protected by i_sem,
205 * and needs to be atomic. This is not actually used for anything,
206 * and can probably be removed.
208 atomic_t vob_transient_pages;
210 * Number of outstanding mmaps on this file.
212 * \see ll_vm_open(), ll_vm_close().
214 atomic_t vob_mmap_cnt;
218 * vob_discard_page_warned
219 * if pages belonging to this object are discarded when a client
220 * is evicted, some debug info will be printed, this flag will be set
221 * during processing the first discarded page, then avoid flooding
222 * debug message for lots of discarded pages.
224 * \see ll_dirty_page_discard_warn.
226 unsigned int vob_discard_page_warned:1;
230 * VVP-private page state.
233 struct cl_page_slice vpg_cl;
234 unsigned vpg_defer_uptodate:1,
238 struct page *vpg_page;
241 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
243 return container_of(slice, struct vvp_page, vpg_cl);
246 static inline pgoff_t vvp_index(struct vvp_page *vpg)
248 return vpg->vpg_page->index;
252 struct cl_device vdv_cl;
253 struct cl_device *vdv_next;
256 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
258 return &vdv->vdv_cl.cd_lu_dev;
261 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
263 return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
266 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
268 return container_of0(d, struct vvp_device, vdv_cl);
271 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
273 return container_of0(obj, struct vvp_object, vob_cl);
276 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
278 return container_of0(obj, struct vvp_object, vob_cl.co_lu);
281 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
283 return cl2vvp(obj)->vob_inode;
286 int vvp_object_invariant(const struct cl_object *obj);
287 struct vvp_object *cl_inode2vvp(struct inode *inode);
289 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
291 return cl2vvp_page(slice)->vpg_page;
294 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
295 # define CLOBINVRNT(env, clob, expr) \
297 if (unlikely(!(expr))) { \
298 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
303 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
304 # define CLOBINVRNT(env, clob, expr) \
305 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
306 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
308 int lov_read_and_clear_async_rc(struct cl_object *clob);
310 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
312 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
313 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
314 struct cl_page *page, pgoff_t index);
315 struct lu_object *vvp_object_alloc(const struct lu_env *env,
316 const struct lu_object_header *hdr,
317 struct lu_device *dev);
319 int vvp_global_init(void);
320 void vvp_global_fini(void);
322 #ifndef HAVE_ACCOUNT_PAGE_DIRTIED_EXPORT
323 extern unsigned int (*vvp_account_page_dirtied)(struct page *page,
324 struct address_space *mapping);
327 extern const struct file_operations vvp_dump_pgcache_file_ops;
329 #endif /* VVP_INTERNAL_H */