Whamcloud - gitweb
LU-7988 hsm: run HSM coordinator once per second at most
[fs/lustre-release.git] / lustre / llite / vvp_internal.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2013, 2016, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * Internal definitions for VVP layer.
33  *
34  *   Author: Nikita Danilov <nikita.danilov@sun.com>
35  */
36
37 #ifndef VVP_INTERNAL_H
38 #define VVP_INTERNAL_H
39
40 #include <lustre/lustre_idl.h>
41 #include <cl_object.h>
42
43 enum obd_notify_event;
44 struct inode;
45 struct lustre_md;
46 struct obd_device;
47 struct obd_export;
48 struct page;
49
50 enum vvp_io_subtype {
51         /** normal IO */
52         IO_NORMAL,
53         /** io started from splice_{read|write} */
54         IO_SPLICE,
55 };
56
57 /**
58  * IO state private to VVP layer.
59  */
60 struct vvp_io {
61         /** super class */
62         struct cl_io_slice     vui_cl;
63         struct cl_io_lock_link vui_link;
64         /** Total size for the left IO. */
65         size_t vui_tot_count;
66
67         union {
68                 struct vvp_fault_io {
69                         /**
70                          * Inode modification time that is checked across DLM
71                          * lock request.
72                          */
73                         time64_t                 ft_mtime;
74                         struct vm_area_struct   *ft_vma;
75                         /**
76                          *  locked page returned from vvp_io
77                          */
78                         struct page             *ft_vmpage;
79                         /**
80                          * kernel fault info
81                          */
82                         struct vm_fault         *ft_vmf;
83                         /**
84                          * fault API used bitflags for return code.
85                          */
86                         unsigned int             ft_flags;
87                         /**
88                          * check that flags are from filemap_fault
89                          */
90                         bool                     ft_flags_valid;
91                 } fault;
92                 struct {
93                         struct pipe_inode_info  *vui_pipe;
94                         unsigned int             vui_flags;
95                 } splice;
96                 struct {
97                         struct cl_page_list vui_queue;
98                         unsigned long vui_written;
99                         int vui_from;
100                         int vui_to;
101                 } write;
102         } u;
103
104         enum vvp_io_subtype     vui_io_subtype;
105
106         /**
107          * Layout version when this IO is initialized
108          */
109         __u32                   vui_layout_gen;
110         /**
111         * File descriptor against which IO is done.
112         */
113         struct ll_file_data     *vui_fd;
114
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. */
119         bool            vui_ra_valid;
120 };
121
122 extern struct lu_device_type vvp_device_type;
123
124 extern struct lu_context_key vvp_session_key;
125 extern struct lu_context_key vvp_thread_key;
126
127 extern struct kmem_cache *vvp_lock_kmem;
128 extern struct kmem_cache *vvp_object_kmem;
129
130 struct vvp_thread_info {
131         struct cl_lock          vti_lock;
132         struct cl_lock_descr    vti_descr;
133         struct cl_io            vti_io;
134         struct cl_attr          vti_attr;
135 };
136
137 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
138 {
139         struct vvp_thread_info *vti;
140
141         vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
142         LASSERT(vti != NULL);
143
144         return vti;
145 }
146
147 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
148 {
149         struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
150
151         memset(lock, 0, sizeof(*lock));
152
153         return lock;
154 }
155
156 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
157 {
158         struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
159
160         memset(attr, 0, sizeof(*attr));
161
162         return attr;
163 }
164
165 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
166 {
167         struct cl_io *io = &vvp_env_info(env)->vti_io;
168
169         memset(io, 0, sizeof(*io));
170
171         return io;
172 }
173
174 struct vvp_session {
175         struct vvp_io vs_ios;
176 };
177
178 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
179 {
180         struct vvp_session *ses;
181
182         ses = lu_context_key_get(env->le_ses, &vvp_session_key);
183         LASSERT(ses != NULL);
184
185         return ses;
186 }
187
188 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
189 {
190         return &vvp_env_session(env)->vs_ios;
191 }
192
193 /**
194  * VPP-private object state.
195  */
196 struct vvp_object {
197         struct cl_object_header vob_header;
198         struct cl_object        vob_cl;
199         struct inode           *vob_inode;
200
201         /**
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.
205          */
206         atomic_t                vob_transient_pages;
207         /**
208          * Number of outstanding mmaps on this file.
209          *
210          * \see ll_vm_open(), ll_vm_close().
211          */
212         atomic_t                vob_mmap_cnt;
213
214         /**
215          * various flags
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.
221          *
222          * \see ll_dirty_page_discard_warn.
223          */
224         unsigned int            vob_discard_page_warned:1;
225 };
226
227 /**
228  * VVP-private page state.
229  */
230 struct vvp_page {
231         struct cl_page_slice vpg_cl;
232         unsigned        vpg_defer_uptodate:1,
233                         vpg_ra_updated:1,
234                         vpg_ra_used:1;
235         /** VM page */
236         struct page     *vpg_page;
237 };
238
239 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
240 {
241         return container_of(slice, struct vvp_page, vpg_cl);
242 }
243
244 static inline pgoff_t vvp_index(struct vvp_page *vpg)
245 {
246         return vpg->vpg_cl.cpl_index;
247 }
248
249 struct vvp_device {
250         struct cl_device    vdv_cl;
251         struct cl_device   *vdv_next;
252 };
253
254 struct vvp_lock {
255         struct cl_lock_slice vlk_cl;
256 };
257
258 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
259 {
260         return &vdv->vdv_cl.cd_lu_dev;
261 }
262
263 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
264 {
265         return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
266 }
267
268 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
269 {
270         return container_of0(d, struct vvp_device, vdv_cl);
271 }
272
273 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
274 {
275         return container_of0(obj, struct vvp_object, vob_cl);
276 }
277
278 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
279 {
280         return container_of0(obj, struct vvp_object, vob_cl.co_lu);
281 }
282
283 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
284 {
285         return cl2vvp(obj)->vob_inode;
286 }
287
288 int vvp_object_invariant(const struct cl_object *obj);
289 struct vvp_object *cl_inode2vvp(struct inode *inode);
290
291 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
292 {
293         return cl2vvp_page(slice)->vpg_page;
294 }
295
296 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
297 {
298         return container_of(slice, struct vvp_lock, vlk_cl);
299 }
300
301 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
302 # define CLOBINVRNT(env, clob, expr)                                    \
303         do {                                                            \
304                 if (unlikely(!(expr))) {                                \
305                         LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
306                                         #expr);                         \
307                         LINVRNT(0);                                     \
308                 }                                                       \
309         } while (0)
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 */
314
315 int lov_read_and_clear_async_rc(struct cl_object *clob);
316
317 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
318                 struct cl_io *io);
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);
327
328 int vvp_global_init(void);
329 void vvp_global_fini(void);
330
331 extern const struct file_operations vvp_dump_pgcache_file_ops;
332
333 #endif /* VVP_INTERNAL_H */