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;
63 /** Total size for the left IO. */
69 * Inode modification time that is checked across DLM
73 struct vm_area_struct *ft_vma;
75 * locked page returned from vvp_io
77 struct page *ft_vmpage;
81 struct vm_fault *ft_vmf;
83 * fault API used bitflags for return code.
85 unsigned int ft_flags;
87 * check that flags are from filemap_fault
92 struct pipe_inode_info *vui_pipe;
93 unsigned int vui_flags;
96 struct cl_page_list vui_queue;
97 unsigned long vui_written;
103 enum vvp_io_subtype vui_io_subtype;
106 * Layout version when this IO is initialized
108 __u32 vui_layout_gen;
110 * File descriptor against which IO is done.
112 struct ll_file_data *vui_fd;
114 /* Readahead state. */
115 pgoff_t vui_ra_start;
116 pgoff_t vui_ra_count;
117 /* Set when vui_ra_{start,count} have been initialized. */
121 extern struct lu_device_type vvp_device_type;
123 extern struct lu_context_key vvp_session_key;
124 extern struct lu_context_key vvp_thread_key;
126 extern struct kmem_cache *vvp_object_kmem;
128 struct vvp_thread_info {
129 struct cl_lock vti_lock;
130 struct cl_lock_descr vti_descr;
132 struct cl_attr vti_attr;
133 struct cl_sync_io vti_anchor;
136 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
138 struct vvp_thread_info *vti;
140 vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
141 LASSERT(vti != NULL);
146 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
148 struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
150 memset(lock, 0, sizeof(*lock));
155 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
157 struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
159 memset(attr, 0, sizeof(*attr));
164 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
166 struct cl_io *io = &vvp_env_info(env)->vti_io;
168 memset(io, 0, sizeof(*io));
174 struct vvp_io vs_ios;
177 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
179 struct vvp_session *ses;
181 ses = lu_context_key_get(env->le_ses, &vvp_session_key);
182 LASSERT(ses != NULL);
187 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
189 return &vvp_env_session(env)->vs_ios;
193 * VPP-private object state.
196 struct cl_object_header vob_header;
197 struct cl_object vob_cl;
198 struct inode *vob_inode;
201 * Number of transient pages. This is no longer protected by i_sem,
202 * and needs to be atomic. This is not actually used for anything,
203 * and can probably be removed.
205 atomic_t vob_transient_pages;
207 * Number of outstanding mmaps on this file.
209 * \see ll_vm_open(), ll_vm_close().
211 atomic_t vob_mmap_cnt;
215 * vob_discard_page_warned
216 * if pages belonging to this object are discarded when a client
217 * is evicted, some debug info will be printed, this flag will be set
218 * during processing the first discarded page, then avoid flooding
219 * debug message for lots of discarded pages.
221 * \see ll_dirty_page_discard_warn.
223 unsigned int vob_discard_page_warned:1;
227 * VVP-private page state.
230 struct cl_page_slice vpg_cl;
231 unsigned vpg_defer_uptodate:1,
235 struct page *vpg_page;
238 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
240 return container_of(slice, struct vvp_page, vpg_cl);
243 static inline pgoff_t vvp_index(struct vvp_page *vpg)
245 return vpg->vpg_cl.cpl_index;
249 struct cl_device vdv_cl;
250 struct cl_device *vdv_next;
253 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
255 return &vdv->vdv_cl.cd_lu_dev;
258 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
260 return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
263 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
265 return container_of0(d, struct vvp_device, vdv_cl);
268 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
270 return container_of0(obj, struct vvp_object, vob_cl);
273 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
275 return container_of0(obj, struct vvp_object, vob_cl.co_lu);
278 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
280 return cl2vvp(obj)->vob_inode;
283 int vvp_object_invariant(const struct cl_object *obj);
284 struct vvp_object *cl_inode2vvp(struct inode *inode);
286 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
288 return cl2vvp_page(slice)->vpg_page;
291 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
292 # define CLOBINVRNT(env, clob, expr) \
294 if (unlikely(!(expr))) { \
295 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
300 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
301 # define CLOBINVRNT(env, clob, expr) \
302 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
303 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
305 int lov_read_and_clear_async_rc(struct cl_object *clob);
307 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
309 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
310 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
311 struct cl_page *page, pgoff_t index);
312 struct lu_object *vvp_object_alloc(const struct lu_env *env,
313 const struct lu_object_header *hdr,
314 struct lu_device *dev);
316 int vvp_global_init(void);
317 void vvp_global_fini(void);
319 extern const struct file_operations vvp_dump_pgcache_file_ops;
321 #endif /* VVP_INTERNAL_H */