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.sun.com/software/products/lustre/docs/GPLv2.pdf
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
27 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2013, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Internal definitions for VVP layer.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
41 #ifndef VVP_INTERNAL_H
42 #define VVP_INTERNAL_H
44 #include <lustre/lustre_idl.h>
45 #include <cl_object.h>
47 enum obd_notify_event;
56 blkcnt_t dirty_cnt(struct inode *inode);
58 int cl_glimpse_size0(struct inode *inode, int agl);
59 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
60 struct inode *inode, struct cl_object *clob, int agl);
62 static inline int cl_glimpse_size(struct inode *inode)
64 return cl_glimpse_size0(inode, 0);
67 static inline int cl_agl(struct inode *inode)
69 return cl_glimpse_size0(inode, 1);
73 * Locking policy for setattr.
75 enum ccc_setattr_lock_type {
76 /** Locking is done by server */
78 /** Extent lock is enqueued */
80 /** Existing local extent lock is used */
87 /** io started from splice_{read|write} */
92 * IO state private to VVP layer.
96 struct cl_io_slice vui_cl;
97 struct cl_io_lock_link vui_link;
99 * I/O vector information to or from which read/write is going.
101 struct iovec *vui_iov;
102 unsigned long vui_nrsegs;
104 * Total iov count for left IO.
106 unsigned long vui_tot_nrsegs;
108 * Old length for iov that was truncated partially.
112 * Total size for the left IO.
114 size_t vui_tot_count;
117 struct vvp_fault_io {
119 * Inode modification time that is checked across DLM
123 struct vm_area_struct *ft_vma;
125 * locked page returned from vvp_io
127 struct page *ft_vmpage;
131 struct vm_fault *ft_vmf;
133 * fault API used bitflags for return code.
135 unsigned int ft_flags;
137 * check that flags are from filemap_fault
142 enum ccc_setattr_lock_type vui_local_lock;
145 struct pipe_inode_info *vui_pipe;
146 unsigned int vui_flags;
149 struct cl_page_list vui_queue;
150 unsigned long vui_written;
156 enum vvp_io_subtype vui_io_subtype;
159 * Layout version when this IO is initialized
161 __u32 vui_layout_gen;
163 * File descriptor against which IO is done.
165 struct ll_file_data *vui_fd;
166 struct kiocb *vui_iocb;
168 /* Readahead state. */
169 pgoff_t vui_ra_start;
170 pgoff_t vui_ra_count;
171 /* Set when vui_ra_{start,count} have been initialized. */
176 * True, if \a io is a normal io, False for other splice_{read,write}.
177 * must be impementated in arch specific code.
179 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
181 extern struct lu_context_key ccc_key;
182 extern struct lu_context_key vvp_session_key;
184 extern struct kmem_cache *vvp_lock_kmem;
185 extern struct kmem_cache *vvp_object_kmem;
187 struct ccc_thread_info {
188 struct cl_lock cti_lock;
189 struct cl_lock_descr cti_descr;
191 struct cl_attr cti_attr;
194 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
196 struct ccc_thread_info *info;
198 info = lu_context_key_get(&env->le_ctx, &ccc_key);
199 LASSERT(info != NULL);
204 static inline struct cl_lock *ccc_env_lock(const struct lu_env *env)
206 struct cl_lock *lock = &ccc_env_info(env)->cti_lock;
208 memset(lock, 0, sizeof(*lock));
213 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
215 struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
217 memset(attr, 0, sizeof(*attr));
222 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
224 struct cl_io *io = &ccc_env_info(env)->cti_io;
226 memset(io, 0, sizeof(*io));
232 struct vvp_io cs_ios;
235 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
237 struct vvp_session *ses;
239 ses = lu_context_key_get(env->le_ses, &vvp_session_key);
240 LASSERT(ses != NULL);
245 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
247 return &vvp_env_session(env)->cs_ios;
251 * ccc-private object state.
254 struct cl_object_header vob_header;
255 struct cl_object vob_cl;
256 struct inode *vob_inode;
259 * A list of dirty pages pending IO in the cache. Used by
260 * SOM. Protected by ll_inode_info::lli_lock.
262 * \see vvp_page::vpg_pending_linkage
264 struct list_head vob_pending_list;
267 * Number of transient pages. This is no longer protected by i_sem,
268 * and needs to be atomic. This is not actually used for anything,
269 * and can probably be removed.
271 atomic_t vob_transient_pages;
273 * Number of outstanding mmaps on this file.
275 * \see ll_vm_open(), ll_vm_close().
277 atomic_t vob_mmap_cnt;
281 * vob_discard_page_warned
282 * if pages belonging to this object are discarded when a client
283 * is evicted, some debug info will be printed, this flag will be set
284 * during processing the first discarded page, then avoid flooding
285 * debug message for lots of discarded pages.
287 * \see ll_dirty_page_discard_warn.
289 unsigned int vob_discard_page_warned:1;
293 * VVP-private page state.
296 struct cl_page_slice vpg_cl;
297 unsigned vpg_defer_uptodate:1,
301 * Non-empty iff this page is already counted in
302 * vvp_object::vob_pending_list. This list is only used as a flag,
303 * that is, never iterated through, only checked for list_empty(), but
304 * having a list is useful for debugging.
306 struct list_head vpg_pending_linkage;
308 struct page *vpg_page;
311 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
313 return container_of(slice, struct vvp_page, vpg_cl);
316 static inline pgoff_t vvp_index(struct vvp_page *vpg)
318 return vpg->vpg_cl.cpl_index;
322 struct cl_device vdv_cl;
323 struct super_block *vdv_sb;
324 struct cl_device *vdv_next;
328 struct cl_lock_slice vlk_cl;
332 struct cl_req_slice crq_cl;
335 void *ccc_key_init(const struct lu_context *ctx, struct lu_context_key *key);
336 void ccc_key_fini(const struct lu_context *ctx, struct lu_context_key *key,
339 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
341 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
342 int ccc_global_init(struct lu_device_type *device_type);
343 void ccc_global_fini(struct lu_device_type *device_type);
345 int vvp_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
346 __u32 enqflags, enum cl_lock_mode mode,
347 pgoff_t start, pgoff_t end);
348 int vvp_io_one_lock(const struct lu_env *env, struct cl_io *io,
349 __u32 enqflags, enum cl_lock_mode mode,
350 loff_t start, loff_t end);
351 void vvp_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
352 void vvp_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
354 void vvp_io_update_iov(const struct lu_env *env, struct vvp_io *cio,
356 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
357 struct cl_io *io, loff_t start, size_t count, int *exceed);
358 void ccc_req_completion(const struct lu_env *env,
359 const struct cl_req_slice *slice, int ioret);
360 void ccc_req_attr_set(const struct lu_env *env,
361 const struct cl_req_slice *slice,
362 const struct cl_object *obj,
363 struct cl_req_attr *oa, obd_valid flags);
365 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
367 return &vdv->vdv_cl.cd_lu_dev;
370 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
372 return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
375 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
377 return container_of0(d, struct vvp_device, vdv_cl);
380 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
382 return container_of0(obj, struct vvp_object, vob_cl);
385 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
387 return container_of0(obj, struct vvp_object, vob_cl.co_lu);
390 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
392 return cl2vvp(obj)->vob_inode;
395 int vvp_object_invariant(const struct cl_object *obj);
396 struct vvp_object *cl_inode2vvp(struct inode *inode);
398 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
400 return cl2vvp_page(slice)->vpg_page;
403 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
405 return container_of(slice, struct vvp_lock, vlk_cl);
408 struct vvp_io *cl2vvp_io(const struct lu_env *env,
409 const struct cl_io_slice *slice);
410 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice);
412 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
413 struct obd_capa *capa);
415 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
416 void cl_inode_fini(struct inode *inode);
417 int cl_local_size(struct inode *inode);
419 __u16 ll_dirent_type_get(struct lu_dirent *ent);
420 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
421 __u32 cl_fid_build_gen(const struct lu_fid *fid);
423 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
424 # define CLOBINVRNT(env, clob, expr) \
426 if (unlikely(!(expr))) { \
427 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
432 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
433 # define CLOBINVRNT(env, clob, expr) \
434 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
435 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
437 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
438 int cl_ocd_update(struct obd_device *host,
439 struct obd_device *watched,
440 enum obd_notify_event ev, void *owner, void *data);
442 struct ccc_grouplock {
443 struct lu_env *cg_env;
445 struct cl_lock *cg_lock;
446 unsigned long cg_gid;
449 int cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
450 struct ccc_grouplock *cg);
451 void cl_put_grouplock(struct ccc_grouplock *cg);
454 * New interfaces to get and put lov_stripe_md from lov layer. This violates
455 * layering because lov_stripe_md is supposed to be a private data in lov.
457 * NB: If you find you have to use these interfaces for your new code, please
458 * think about it again. These interfaces may be removed in the future for
459 * better layering. */
460 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
461 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
462 int lov_read_and_clear_async_rc(struct cl_object *clob);
464 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
465 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
468 LUSTRE_OPC_MKDIR = 0,
469 LUSTRE_OPC_SYMLINK = 1,
470 LUSTRE_OPC_MKNOD = 2,
471 LUSTRE_OPC_CREATE = 3,
475 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
477 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
478 struct cl_lock *lock, const struct cl_io *io);
479 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
480 struct cl_page *page, pgoff_t index);
481 struct lu_object *vvp_object_alloc(const struct lu_env *env,
482 const struct lu_object_header *hdr,
483 struct lu_device *dev);
485 extern const struct file_operations vvp_dump_pgcache_file_ops;
487 #endif /* VVP_INTERNAL_H */