Whamcloud - gitweb
d92dd1ffe6049097ae6b11d592551e464570ca54
[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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2013, 2014, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * Internal definitions for VVP layer.
37  *
38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
39  */
40
41 #ifndef VVP_INTERNAL_H
42 #define VVP_INTERNAL_H
43
44 #include <lustre/lustre_idl.h>
45 #include <cl_object.h>
46
47 enum obd_notify_event;
48 struct inode;
49 struct lustre_md;
50 struct obd_device;
51 struct obd_export;
52 struct page;
53
54 enum vvp_io_subtype {
55         /** normal IO */
56         IO_NORMAL,
57         /** io started from splice_{read|write} */
58         IO_SPLICE,
59 };
60
61 /**
62  * IO state private to VVP layer.
63  */
64 struct vvp_io {
65         /** super class */
66         struct cl_io_slice     vui_cl;
67         struct cl_io_lock_link vui_link;
68         /**
69          * I/O vector information to or from which read/write is going.
70          */
71         struct iovec *vui_iov;
72         unsigned long vui_nrsegs;
73         /**
74          * Total iov count for left IO.
75          */
76         unsigned long vui_tot_nrsegs;
77         /**
78          * Old length for iov that was truncated partially.
79          */
80         size_t vui_iov_olen;
81         /**
82          * Total size for the left IO.
83          */
84         size_t vui_tot_count;
85
86         union {
87                 struct vvp_fault_io {
88                         /**
89                          * Inode modification time that is checked across DLM
90                          * lock request.
91                          */
92                         time_t                   ft_mtime;
93                         struct vm_area_struct   *ft_vma;
94                         /**
95                          *  locked page returned from vvp_io
96                          */
97                         struct page             *ft_vmpage;
98                         /**
99                          * kernel fault info
100                          */
101                         struct vm_fault         *ft_vmf;
102                         /**
103                          * fault API used bitflags for return code.
104                          */
105                         unsigned int             ft_flags;
106                         /**
107                          * check that flags are from filemap_fault
108                          */
109                         bool                     ft_flags_valid;
110                 } fault;
111                 struct {
112                         struct pipe_inode_info  *vui_pipe;
113                         unsigned int             vui_flags;
114                 } splice;
115                 struct {
116                         struct cl_page_list vui_queue;
117                         unsigned long vui_written;
118                         int vui_from;
119                         int vui_to;
120                 } write;
121         } u;
122
123         enum vvp_io_subtype     vui_io_subtype;
124
125         /**
126          * Layout version when this IO is initialized
127          */
128         __u32                   vui_layout_gen;
129         /**
130         * File descriptor against which IO is done.
131         */
132         struct ll_file_data     *vui_fd;
133         struct kiocb            *vui_iocb;
134
135         /* Readahead state. */
136         pgoff_t vui_ra_start;
137         pgoff_t vui_ra_count;
138         /* Set when vui_ra_{start,count} have been initialized. */
139         bool            vui_ra_valid;
140 };
141
142 extern struct lu_device_type vvp_device_type;
143
144 extern struct lu_context_key vvp_session_key;
145 extern struct lu_context_key vvp_thread_key;
146
147 extern struct kmem_cache *vvp_lock_kmem;
148 extern struct kmem_cache *vvp_object_kmem;
149 extern struct kmem_cache *vvp_req_kmem;
150
151 struct vvp_thread_info {
152         struct cl_lock          vti_lock;
153         struct cl_lock_descr    vti_descr;
154         struct cl_io            vti_io;
155         struct cl_attr          vti_attr;
156 };
157
158 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
159 {
160         struct vvp_thread_info *vti;
161
162         vti = lu_context_key_get(&env->le_ctx, &vvp_thread_key);
163         LASSERT(vti != NULL);
164
165         return vti;
166 }
167
168 static inline struct cl_lock *vvp_env_lock(const struct lu_env *env)
169 {
170         struct cl_lock *lock = &vvp_env_info(env)->vti_lock;
171
172         memset(lock, 0, sizeof(*lock));
173
174         return lock;
175 }
176
177 static inline struct cl_attr *vvp_env_thread_attr(const struct lu_env *env)
178 {
179         struct cl_attr *attr = &vvp_env_info(env)->vti_attr;
180
181         memset(attr, 0, sizeof(*attr));
182
183         return attr;
184 }
185
186 static inline struct cl_io *vvp_env_thread_io(const struct lu_env *env)
187 {
188         struct cl_io *io = &vvp_env_info(env)->vti_io;
189
190         memset(io, 0, sizeof(*io));
191
192         return io;
193 }
194
195 struct vvp_session {
196         struct vvp_io vs_ios;
197 };
198
199 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
200 {
201         struct vvp_session *ses;
202
203         ses = lu_context_key_get(env->le_ses, &vvp_session_key);
204         LASSERT(ses != NULL);
205
206         return ses;
207 }
208
209 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
210 {
211         return &vvp_env_session(env)->vs_ios;
212 }
213
214 /**
215  * VPP-private object state.
216  */
217 struct vvp_object {
218         struct cl_object_header vob_header;
219         struct cl_object        vob_cl;
220         struct inode           *vob_inode;
221
222         /**
223          * Number of transient pages.  This is no longer protected by i_sem,
224          * and needs to be atomic.  This is not actually used for anything,
225          * and can probably be removed.
226          */
227         atomic_t                vob_transient_pages;
228         /**
229          * Number of outstanding mmaps on this file.
230          *
231          * \see ll_vm_open(), ll_vm_close().
232          */
233         atomic_t                vob_mmap_cnt;
234
235         /**
236          * various flags
237          * vob_discard_page_warned
238          *     if pages belonging to this object are discarded when a client
239          * is evicted, some debug info will be printed, this flag will be set
240          * during processing the first discarded page, then avoid flooding
241          * debug message for lots of discarded pages.
242          *
243          * \see ll_dirty_page_discard_warn.
244          */
245         unsigned int            vob_discard_page_warned:1;
246 };
247
248 /**
249  * VVP-private page state.
250  */
251 struct vvp_page {
252         struct cl_page_slice vpg_cl;
253         unsigned        vpg_defer_uptodate:1,
254                         vpg_ra_used:1;
255         /** VM page */
256         struct page     *vpg_page;
257 };
258
259 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
260 {
261         return container_of(slice, struct vvp_page, vpg_cl);
262 }
263
264 static inline pgoff_t vvp_index(struct vvp_page *vpg)
265 {
266         return vpg->vpg_cl.cpl_index;
267 }
268
269 struct vvp_device {
270         struct cl_device    vdv_cl;
271         struct super_block *vdv_sb;
272         struct cl_device   *vdv_next;
273 };
274
275 struct vvp_lock {
276         struct cl_lock_slice vlk_cl;
277 };
278
279 struct vvp_req {
280         struct cl_req_slice vrq_cl;
281 };
282
283 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
284 {
285         return &vdv->vdv_cl.cd_lu_dev;
286 }
287
288 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
289 {
290         return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
291 }
292
293 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
294 {
295         return container_of0(d, struct vvp_device, vdv_cl);
296 }
297
298 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
299 {
300         return container_of0(obj, struct vvp_object, vob_cl);
301 }
302
303 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
304 {
305         return container_of0(obj, struct vvp_object, vob_cl.co_lu);
306 }
307
308 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
309 {
310         return cl2vvp(obj)->vob_inode;
311 }
312
313 int vvp_object_invariant(const struct cl_object *obj);
314 struct vvp_object *cl_inode2vvp(struct inode *inode);
315
316 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
317 {
318         return cl2vvp_page(slice)->vpg_page;
319 }
320
321 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
322 {
323         return container_of(slice, struct vvp_lock, vlk_cl);
324 }
325
326 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
327 # define CLOBINVRNT(env, clob, expr)                                    \
328         do {                                                            \
329                 if (unlikely(!(expr))) {                                \
330                         LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
331                                         #expr "\n");                    \
332                         LINVRNT(0);                                     \
333                 }                                                       \
334         } while (0)
335 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
336 # define CLOBINVRNT(env, clob, expr)                                    \
337         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
338 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
339
340 int lov_read_and_clear_async_rc(struct cl_object *clob);
341
342 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
343                 struct cl_io *io);
344 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
345 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
346                   struct cl_lock *lock, const struct cl_io *io);
347 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
348                   struct cl_page *page, pgoff_t index);
349 int vvp_req_init(const struct lu_env *env, struct cl_device *dev,
350                  struct cl_req *req);
351 struct lu_object *vvp_object_alloc(const struct lu_env *env,
352                                    const struct lu_object_header *hdr,
353                                    struct lu_device *dev);
354
355 int vvp_global_init(void);
356 void vvp_global_fini(void);
357
358 extern const struct file_operations vvp_dump_pgcache_file_ops;
359
360 #endif /* VVP_INTERNAL_H */