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 struct ccc_thread_info {
142 struct cl_lock cti_lock;
143 struct cl_lock_descr cti_descr;
145 struct cl_attr cti_attr;
148 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
150 struct ccc_thread_info *info;
152 info = lu_context_key_get(&env->le_ctx, &ccc_key);
153 LASSERT(info != NULL);
158 static inline struct cl_lock *ccc_env_lock(const struct lu_env *env)
160 struct cl_lock *lock = &ccc_env_info(env)->cti_lock;
162 memset(lock, 0, sizeof(*lock));
167 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
169 struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
171 memset(attr, 0, sizeof(*attr));
176 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
178 struct cl_io *io = &ccc_env_info(env)->cti_io;
180 memset(io, 0, sizeof(*io));
186 struct ccc_io cs_ios;
189 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
191 struct ccc_session *ses;
193 ses = lu_context_key_get(env->le_ses, &ccc_session_key);
194 LASSERT(ses != NULL);
199 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
201 return &ccc_env_session(env)->cs_ios;
205 * ccc-private object state.
208 struct cl_object_header cob_header;
209 struct cl_object cob_cl;
210 struct inode *cob_inode;
213 * A list of dirty pages pending IO in the cache. Used by
214 * SOM. Protected by ll_inode_info::lli_lock.
216 * \see ccc_page::cpg_pending_linkage
218 struct list_head cob_pending_list;
221 * Number of transient pages. This is no longer protected by i_sem,
222 * and needs to be atomic. This is not actually used for anything,
223 * and can probably be removed.
225 atomic_t cob_transient_pages;
227 * Number of outstanding mmaps on this file.
229 * \see ll_vm_open(), ll_vm_close().
231 atomic_t cob_mmap_cnt;
235 * cob_discard_page_warned
236 * if pages belonging to this object are discarded when a client
237 * is evicted, some debug info will be printed, this flag will be set
238 * during processing the first discarded page, then avoid flooding
239 * debug message for lots of discarded pages.
241 * \see ll_dirty_page_discard_warn.
243 unsigned int cob_discard_page_warned:1;
247 * ccc-private page state.
250 struct cl_page_slice cpg_cl;
251 unsigned cpg_defer_uptodate:1,
255 * Non-empty iff this page is already counted in
256 * ccc_object::cob_pending_list. Protected by
257 * ccc_object::cob_pending_guard. This list is only used as a flag,
258 * that is, never iterated through, only checked for list_empty(), but
259 * having a list is useful for debugging.
261 struct list_head cpg_pending_linkage;
263 struct page *cpg_page;
266 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
268 return container_of(slice, struct ccc_page, cpg_cl);
271 static inline pgoff_t ccc_index(struct ccc_page *ccc)
273 return ccc->cpg_cl.cpl_index;
276 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
279 struct cl_device cdv_cl;
280 struct super_block *cdv_sb;
281 struct cl_device *cdv_next;
285 struct cl_lock_slice clk_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_device_init(const struct lu_env *env, struct lu_device *d,
301 const char *name, struct lu_device *next);
302 struct lu_device *ccc_device_fini(const struct lu_env *env,
303 struct lu_device *d);
304 struct lu_device *ccc_device_alloc(const struct lu_env *env,
305 struct lu_device_type *t,
306 struct lustre_cfg *cfg,
307 const struct lu_device_operations *luops,
308 const struct cl_device_operations *clops);
309 struct lu_device *ccc_device_free(const struct lu_env *env,
310 struct lu_device *d);
311 struct lu_object *ccc_object_alloc(const struct lu_env *env,
312 const struct lu_object_header *hdr,
313 struct lu_device *dev,
314 const struct cl_object_operations *clops,
315 const struct lu_object_operations *luops);
317 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
319 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
320 int ccc_global_init(struct lu_device_type *device_type);
321 void ccc_global_fini(struct lu_device_type *device_type);
322 int ccc_object_init0(const struct lu_env *env, struct ccc_object *vob,
323 const struct cl_object_conf *conf);
324 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
325 const struct lu_object_conf *conf);
326 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
327 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
328 struct cl_lock *lock, const struct cl_io *io,
329 const struct cl_lock_operations *lkops);
330 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
331 const struct cl_attr *attr, unsigned valid);
332 int ccc_object_glimpse(const struct lu_env *env,
333 const struct cl_object *obj, struct ost_lvb *lvb);
334 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
335 const struct cl_object_conf *conf);
336 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
337 void ccc_transient_page_verify(const struct cl_page *page);
338 int ccc_transient_page_own(const struct lu_env *env,
339 const struct cl_page_slice *slice,
340 struct cl_io *io, int nonblock);
341 void ccc_transient_page_assume(const struct lu_env *env,
342 const struct cl_page_slice *slice,
344 void ccc_transient_page_unassume(const struct lu_env *env,
345 const struct cl_page_slice *slice,
347 void ccc_transient_page_disown(const struct lu_env *env,
348 const struct cl_page_slice *slice,
350 void ccc_transient_page_discard(const struct lu_env *env,
351 const struct cl_page_slice *slice,
353 int ccc_transient_page_prep(const struct lu_env *env,
354 const struct cl_page_slice *slice,
356 void ccc_lock_delete(const struct lu_env *env,
357 const struct cl_lock_slice *slice);
358 void ccc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice);
359 int ccc_lock_enqueue(const struct lu_env *env,
360 const struct cl_lock_slice *slice,
361 struct cl_io *io, struct cl_sync_io *anchor);
362 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
363 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
364 __u32 enqflags, enum cl_lock_mode mode,
365 pgoff_t start, pgoff_t end);
366 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
367 __u32 enqflags, enum cl_lock_mode mode,
368 loff_t start, loff_t end);
369 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
370 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
372 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
374 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
375 struct cl_io *io, loff_t start, size_t count, int *exceed);
376 void ccc_req_completion(const struct lu_env *env,
377 const struct cl_req_slice *slice, int ioret);
378 void ccc_req_attr_set(const struct lu_env *env,
379 const struct cl_req_slice *slice,
380 const struct cl_object *obj,
381 struct cl_req_attr *oa, obd_valid flags);
383 struct lu_device *ccc2lu_dev(struct ccc_device *vdv);
384 struct lu_object *ccc2lu(struct ccc_object *vob);
385 struct ccc_device *lu2ccc_dev(const struct lu_device *d);
386 struct ccc_device *cl2ccc_dev(const struct cl_device *d);
387 struct ccc_object *lu2ccc(const struct lu_object *obj);
388 struct ccc_object *cl2ccc(const struct cl_object *obj);
389 struct ccc_lock *cl2ccc_lock(const struct cl_lock_slice *slice);
390 struct ccc_io *cl2ccc_io(const struct lu_env *env,
391 const struct cl_io_slice *slice);
392 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice);
393 struct page *cl2vm_page(const struct cl_page_slice *slice);
394 struct inode *ccc_object_inode(const struct cl_object *obj);
395 struct ccc_object *cl_inode2ccc(struct inode *inode);
397 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
398 struct obd_capa *capa);
400 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
401 int ccc_object_invariant(const struct cl_object *obj);
402 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
403 void cl_inode_fini(struct inode *inode);
404 int cl_local_size(struct inode *inode);
406 __u16 ll_dirent_type_get(struct lu_dirent *ent);
407 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
408 __u32 cl_fid_build_gen(const struct lu_fid *fid);
410 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
411 # define CLOBINVRNT(env, clob, expr) \
413 if (unlikely(!(expr))) { \
414 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
419 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
420 # define CLOBINVRNT(env, clob, expr) \
421 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
422 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
424 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
425 int cl_ocd_update(struct obd_device *host,
426 struct obd_device *watched,
427 enum obd_notify_event ev, void *owner, void *data);
429 struct ccc_grouplock {
430 struct lu_env *cg_env;
432 struct cl_lock *cg_lock;
433 unsigned long cg_gid;
436 int cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
437 struct ccc_grouplock *cg);
438 void cl_put_grouplock(struct ccc_grouplock *cg);
441 * New interfaces to get and put lov_stripe_md from lov layer. This violates
442 * layering because lov_stripe_md is supposed to be a private data in lov.
444 * NB: If you find you have to use these interfaces for your new code, please
445 * think about it again. These interfaces may be removed in the future for
446 * better layering. */
447 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
448 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
449 int lov_read_and_clear_async_rc(struct cl_object *clob);
451 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
452 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
455 LUSTRE_OPC_MKDIR = 0,
456 LUSTRE_OPC_SYMLINK = 1,
457 LUSTRE_OPC_MKNOD = 2,
458 LUSTRE_OPC_CREATE = 3,
462 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
464 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
465 struct cl_lock *lock, const struct cl_io *io);
466 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
467 struct cl_page *page, pgoff_t index);
468 struct lu_object *vvp_object_alloc(const struct lu_env *env,
469 const struct lu_object_header *hdr,
470 struct lu_device *dev);
471 struct ccc_object *cl_inode2ccc(struct inode *inode);
473 extern const struct file_operations vvp_dump_pgcache_file_ops;
475 #endif /* VVP_INTERNAL_H */