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 */
86 * IO state private to vvp or slp layers.
90 struct cl_io_slice cui_cl;
91 struct cl_io_lock_link cui_link;
93 * I/O vector information to or from which read/write is going.
95 struct iovec *cui_iov;
96 unsigned long cui_nrsegs;
98 * Total iov count for left IO.
100 unsigned long cui_tot_nrsegs;
102 * Old length for iov that was truncated partially.
106 * Total size for the left IO.
108 size_t cui_tot_count;
112 enum ccc_setattr_lock_type cui_local_lock;
115 struct cl_page_list cui_queue;
116 unsigned long cui_written;
122 * Layout version when this IO is initialized
124 __u32 cui_layout_gen;
126 * File descriptor against which IO is done.
128 struct ll_file_data *cui_fd;
129 struct kiocb *cui_iocb;
133 * True, if \a io is a normal io, False for other splice_{read,write}.
134 * must be impementated in arch specific code.
136 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
138 extern struct lu_context_key ccc_key;
139 extern struct lu_context_key ccc_session_key;
141 extern struct kmem_cache *vvp_lock_kmem;
142 extern struct kmem_cache *vvp_object_kmem;
144 struct ccc_thread_info {
145 struct cl_lock cti_lock;
146 struct cl_lock_descr cti_descr;
148 struct cl_attr cti_attr;
151 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
153 struct ccc_thread_info *info;
155 info = lu_context_key_get(&env->le_ctx, &ccc_key);
156 LASSERT(info != NULL);
161 static inline struct cl_lock *ccc_env_lock(const struct lu_env *env)
163 struct cl_lock *lock = &ccc_env_info(env)->cti_lock;
165 memset(lock, 0, sizeof(*lock));
170 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
172 struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
174 memset(attr, 0, sizeof(*attr));
179 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
181 struct cl_io *io = &ccc_env_info(env)->cti_io;
183 memset(io, 0, sizeof(*io));
189 struct ccc_io cs_ios;
192 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
194 struct ccc_session *ses;
196 ses = lu_context_key_get(env->le_ses, &ccc_session_key);
197 LASSERT(ses != NULL);
202 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
204 return &ccc_env_session(env)->cs_ios;
208 * ccc-private object state.
211 struct cl_object_header vob_header;
212 struct cl_object vob_cl;
213 struct inode *vob_inode;
216 * A list of dirty pages pending IO in the cache. Used by
217 * SOM. Protected by ll_inode_info::lli_lock.
219 * \see vvp_page::vpg_pending_linkage
221 struct list_head vob_pending_list;
224 * Number of transient pages. This is no longer protected by i_sem,
225 * and needs to be atomic. This is not actually used for anything,
226 * and can probably be removed.
228 atomic_t vob_transient_pages;
230 * Number of outstanding mmaps on this file.
232 * \see ll_vm_open(), ll_vm_close().
234 atomic_t vob_mmap_cnt;
238 * vob_discard_page_warned
239 * if pages belonging to this object are discarded when a client
240 * is evicted, some debug info will be printed, this flag will be set
241 * during processing the first discarded page, then avoid flooding
242 * debug message for lots of discarded pages.
244 * \see ll_dirty_page_discard_warn.
246 unsigned int vob_discard_page_warned:1;
250 * VVP-private page state.
253 struct cl_page_slice vpg_cl;
254 unsigned vpg_defer_uptodate:1,
258 * Non-empty iff this page is already counted in
259 * vvp_object::vob_pending_list. This list is only used as a flag,
260 * that is, never iterated through, only checked for list_empty(), but
261 * having a list is useful for debugging.
263 struct list_head vpg_pending_linkage;
265 struct page *vpg_page;
268 static inline struct vvp_page *cl2vvp_page(const struct cl_page_slice *slice)
270 return container_of(slice, struct vvp_page, vpg_cl);
273 static inline pgoff_t vvp_index(struct vvp_page *vpg)
275 return vpg->vpg_cl.cpl_index;
279 struct cl_device vdv_cl;
280 struct super_block *vdv_sb;
281 struct cl_device *vdv_next;
285 struct cl_lock_slice vlk_cl;
289 struct cl_req_slice crq_cl;
292 void *ccc_key_init(const struct lu_context *ctx, struct lu_context_key *key);
293 void ccc_key_fini(const struct lu_context *ctx, struct lu_context_key *key,
295 void *ccc_session_key_init(const struct lu_context *ctx,
296 struct lu_context_key *key);
297 void ccc_session_key_fini(const struct lu_context *ctx,
298 struct lu_context_key *key, void *data);
300 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
302 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
303 int ccc_global_init(struct lu_device_type *device_type);
304 void ccc_global_fini(struct lu_device_type *device_type);
305 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
306 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
307 __u32 enqflags, enum cl_lock_mode mode,
308 pgoff_t start, pgoff_t end);
309 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
310 __u32 enqflags, enum cl_lock_mode mode,
311 loff_t start, loff_t end);
312 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
313 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
315 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
317 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
318 struct cl_io *io, loff_t start, size_t count, int *exceed);
319 void ccc_req_completion(const struct lu_env *env,
320 const struct cl_req_slice *slice, int ioret);
321 void ccc_req_attr_set(const struct lu_env *env,
322 const struct cl_req_slice *slice,
323 const struct cl_object *obj,
324 struct cl_req_attr *oa, obd_valid flags);
326 static inline struct lu_device *vvp2lu_dev(struct vvp_device *vdv)
328 return &vdv->vdv_cl.cd_lu_dev;
331 static inline struct vvp_device *lu2vvp_dev(const struct lu_device *d)
333 return container_of0(d, struct vvp_device, vdv_cl.cd_lu_dev);
336 static inline struct vvp_device *cl2vvp_dev(const struct cl_device *d)
338 return container_of0(d, struct vvp_device, vdv_cl);
341 static inline struct vvp_object *cl2vvp(const struct cl_object *obj)
343 return container_of0(obj, struct vvp_object, vob_cl);
346 static inline struct vvp_object *lu2vvp(const struct lu_object *obj)
348 return container_of0(obj, struct vvp_object, vob_cl.co_lu);
351 static inline struct inode *vvp_object_inode(const struct cl_object *obj)
353 return cl2vvp(obj)->vob_inode;
356 int vvp_object_invariant(const struct cl_object *obj);
357 struct vvp_object *cl_inode2vvp(struct inode *inode);
359 static inline struct page *cl2vm_page(const struct cl_page_slice *slice)
361 return cl2vvp_page(slice)->vpg_page;
364 static inline struct vvp_lock *cl2vvp_lock(const struct cl_lock_slice *slice)
366 return container_of(slice, struct vvp_lock, vlk_cl);
369 struct ccc_io *cl2ccc_io(const struct lu_env *env,
370 const struct cl_io_slice *slice);
371 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice);
373 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
374 struct obd_capa *capa);
376 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
377 void cl_inode_fini(struct inode *inode);
378 int cl_local_size(struct inode *inode);
380 __u16 ll_dirent_type_get(struct lu_dirent *ent);
381 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
382 __u32 cl_fid_build_gen(const struct lu_fid *fid);
384 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
385 # define CLOBINVRNT(env, clob, expr) \
387 if (unlikely(!(expr))) { \
388 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
393 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
394 # define CLOBINVRNT(env, clob, expr) \
395 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
396 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
398 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
399 int cl_ocd_update(struct obd_device *host,
400 struct obd_device *watched,
401 enum obd_notify_event ev, void *owner, void *data);
403 struct ccc_grouplock {
404 struct lu_env *cg_env;
406 struct cl_lock *cg_lock;
407 unsigned long cg_gid;
410 int cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
411 struct ccc_grouplock *cg);
412 void cl_put_grouplock(struct ccc_grouplock *cg);
415 * New interfaces to get and put lov_stripe_md from lov layer. This violates
416 * layering because lov_stripe_md is supposed to be a private data in lov.
418 * NB: If you find you have to use these interfaces for your new code, please
419 * think about it again. These interfaces may be removed in the future for
420 * better layering. */
421 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
422 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
423 int lov_read_and_clear_async_rc(struct cl_object *clob);
425 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
426 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
429 LUSTRE_OPC_MKDIR = 0,
430 LUSTRE_OPC_SYMLINK = 1,
431 LUSTRE_OPC_MKNOD = 2,
432 LUSTRE_OPC_CREATE = 3,
436 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
438 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
439 struct cl_lock *lock, const struct cl_io *io);
440 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
441 struct cl_page *page, pgoff_t index);
442 struct lu_object *vvp_object_alloc(const struct lu_env *env,
443 const struct lu_object_header *hdr,
444 struct lu_device *dev);
446 extern const struct file_operations vvp_dump_pgcache_file_ops;
448 #endif /* VVP_INTERNAL_H */