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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Definitions shared between vvp and liblustre, and other clients in the
39 * Author: Oleg Drokin <oleg.drokin@sun.com>
40 * Author: Nikita Danilov <nikita.danilov@sun.com>
46 blkcnt_t dirty_cnt(struct inode *inode);
48 int cl_glimpse_size0(struct inode *inode, int agl);
49 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
50 struct inode *inode, struct cl_object *clob, int agl);
52 static inline int cl_glimpse_size(struct inode *inode)
54 return cl_glimpse_size0(inode, 0);
57 static inline int cl_agl(struct inode *inode)
59 return cl_glimpse_size0(inode, 1);
63 * Locking policy for setattr.
65 enum ccc_setattr_lock_type {
66 /** Locking is done by server */
68 /** Extent lock is enqueued */
70 /** Existing local extent lock is used */
76 * IO state private to vvp or slp layers.
80 struct cl_io_slice cui_cl;
81 struct cl_io_lock_link cui_link;
83 * I/O vector information to or from which read/write is going.
85 struct iovec *cui_iov;
86 unsigned long cui_nrsegs;
88 * Total iov count for left IO.
90 unsigned long cui_tot_nrsegs;
92 * Old length for iov that was truncated partially.
96 * Total size for the left IO.
102 enum ccc_setattr_lock_type cui_local_lock;
106 * True iff io is processing glimpse right now.
110 * Layout version when this IO is initialized
112 __u32 cui_layout_gen;
114 * File descriptor against which IO is done.
116 struct ll_file_data *cui_fd;
117 #ifndef HAVE_FILE_WRITEV
118 struct kiocb *cui_iocb;
123 * True, if \a io is a normal io, False for other (sendfile, splice*).
124 * must be impementated in arch specific code.
126 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
128 extern struct lu_context_key ccc_key;
129 extern struct lu_context_key ccc_session_key;
131 struct ccc_thread_info {
132 struct cl_lock_descr cti_descr;
134 struct cl_attr cti_attr;
137 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
139 struct ccc_thread_info *info;
141 info = lu_context_key_get(&env->le_ctx, &ccc_key);
142 LASSERT(info != NULL);
146 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
148 struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
149 memset(attr, 0, sizeof(*attr));
153 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
155 struct cl_io *io = &ccc_env_info(env)->cti_io;
156 memset(io, 0, sizeof(*io));
161 struct ccc_io cs_ios;
164 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
166 struct ccc_session *ses;
168 ses = lu_context_key_get(env->le_ses, &ccc_session_key);
169 LASSERT(ses != NULL);
173 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
175 return &ccc_env_session(env)->cs_ios;
179 * ccc-private object state.
182 struct cl_object_header cob_header;
183 struct cl_object cob_cl;
184 struct inode *cob_inode;
187 * A list of dirty pages pending IO in the cache. Used by
188 * SOM. Protected by ll_inode_info::lli_lock.
190 * \see ccc_page::cpg_pending_linkage
192 cfs_list_t cob_pending_list;
195 * Access this counter is protected by inode->i_sem. Now that
196 * the lifetime of transient pages must be covered by inode sem,
197 * we don't need to hold any lock..
199 int cob_transient_pages;
201 * Number of outstanding mmaps on this file.
203 * \see ll_vm_open(), ll_vm_close().
205 cfs_atomic_t cob_mmap_cnt;
209 * cob_discard_page_warned
210 * if pages belonging to this object are discarded when a client
211 * is evicted, some debug info will be printed, this flag will be set
212 * during processing the first discarded page, then avoid flooding
213 * debug message for lots of discarded pages.
215 * \see ll_dirty_page_discard_warn.
217 unsigned int cob_discard_page_warned:1;
221 * ccc-private page state.
224 struct cl_page_slice cpg_cl;
225 int cpg_defer_uptodate;
227 int cpg_write_queued;
229 * Non-empty iff this page is already counted in
230 * ccc_object::cob_pending_list. Protected by
231 * ccc_object::cob_pending_guard. This list is only used as a flag,
232 * that is, never iterated through, only checked for list_empty(), but
233 * having a list is useful for debugging.
235 cfs_list_t cpg_pending_linkage;
237 struct page *cpg_page;
240 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
242 return container_of(slice, struct ccc_page, cpg_cl);
245 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
248 struct cl_device cdv_cl;
249 struct super_block *cdv_sb;
250 struct cl_device *cdv_next;
254 struct cl_lock_slice clk_cl;
258 struct cl_req_slice crq_cl;
261 void *ccc_key_init (const struct lu_context *ctx,
262 struct lu_context_key *key);
263 void ccc_key_fini (const struct lu_context *ctx,
264 struct lu_context_key *key, void *data);
265 void *ccc_session_key_init(const struct lu_context *ctx,
266 struct lu_context_key *key);
267 void ccc_session_key_fini(const struct lu_context *ctx,
268 struct lu_context_key *key, void *data);
270 int ccc_device_init (const struct lu_env *env,
272 const char *name, struct lu_device *next);
273 struct lu_device *ccc_device_fini (const struct lu_env *env,
274 struct lu_device *d);
275 struct lu_device *ccc_device_alloc(const struct lu_env *env,
276 struct lu_device_type *t,
277 struct lustre_cfg *cfg,
278 const struct lu_device_operations *luops,
279 const struct cl_device_operations *clops);
280 struct lu_device *ccc_device_free (const struct lu_env *env,
281 struct lu_device *d);
282 struct lu_object *ccc_object_alloc(const struct lu_env *env,
283 const struct lu_object_header *hdr,
284 struct lu_device *dev,
285 const struct cl_object_operations *clops,
286 const struct lu_object_operations *luops);
288 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
290 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
291 int ccc_global_init(struct lu_device_type *device_type);
292 void ccc_global_fini(struct lu_device_type *device_type);
293 int ccc_object_init0(const struct lu_env *env,struct ccc_object *vob,
294 const struct cl_object_conf *conf);
295 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
296 const struct lu_object_conf *conf);
297 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
298 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
299 struct cl_lock *lock, const struct cl_io *io,
300 const struct cl_lock_operations *lkops);
301 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
302 const struct cl_attr *attr, unsigned valid);
303 int ccc_object_glimpse(const struct lu_env *env,
304 const struct cl_object *obj, struct ost_lvb *lvb);
305 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
306 const struct cl_object_conf *conf);
307 struct page *ccc_page_vmpage(const struct lu_env *env,
308 const struct cl_page_slice *slice);
309 int ccc_page_is_under_lock(const struct lu_env *env,
310 const struct cl_page_slice *slice, struct cl_io *io);
311 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
312 void ccc_transient_page_verify(const struct cl_page *page);
313 int ccc_transient_page_own(const struct lu_env *env,
314 const struct cl_page_slice *slice,
315 struct cl_io *io, int nonblock);
316 void ccc_transient_page_assume(const struct lu_env *env,
317 const struct cl_page_slice *slice,
319 void ccc_transient_page_unassume(const struct lu_env *env,
320 const struct cl_page_slice *slice,
322 void ccc_transient_page_disown(const struct lu_env *env,
323 const struct cl_page_slice *slice,
325 void ccc_transient_page_discard(const struct lu_env *env,
326 const struct cl_page_slice *slice,
328 int ccc_transient_page_prep(const struct lu_env *env,
329 const struct cl_page_slice *slice,
331 void ccc_lock_delete(const struct lu_env *env,
332 const struct cl_lock_slice *slice);
333 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
334 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
335 struct cl_io *io, __u32 enqflags);
336 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
337 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
338 int ccc_lock_fits_into(const struct lu_env *env,
339 const struct cl_lock_slice *slice,
340 const struct cl_lock_descr *need,
341 const struct cl_io *io);
342 void ccc_lock_state(const struct lu_env *env,
343 const struct cl_lock_slice *slice,
344 enum cl_lock_state state);
346 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
347 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
348 __u32 enqflags, enum cl_lock_mode mode,
349 pgoff_t start, pgoff_t end);
350 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
351 __u32 enqflags, enum cl_lock_mode mode,
352 loff_t start, loff_t end);
353 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
354 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
356 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
358 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
359 struct cl_io *io, loff_t start, size_t count, int *exceed);
360 void ccc_req_completion(const struct lu_env *env,
361 const struct cl_req_slice *slice, int ioret);
362 void ccc_req_attr_set(const struct lu_env *env,const struct cl_req_slice *slice,
363 const struct cl_object *obj,
364 struct cl_req_attr *oa, obd_valid flags);
366 struct lu_device *ccc2lu_dev (struct ccc_device *vdv);
367 struct lu_object *ccc2lu (struct ccc_object *vob);
368 struct ccc_device *lu2ccc_dev (const struct lu_device *d);
369 struct ccc_device *cl2ccc_dev (const struct cl_device *d);
370 struct ccc_object *lu2ccc (const struct lu_object *obj);
371 struct ccc_object *cl2ccc (const struct cl_object *obj);
372 struct ccc_lock *cl2ccc_lock (const struct cl_lock_slice *slice);
373 struct ccc_io *cl2ccc_io (const struct lu_env *env,
374 const struct cl_io_slice *slice);
375 struct ccc_req *cl2ccc_req (const struct cl_req_slice *slice);
376 struct page *cl2vm_page (const struct cl_page_slice *slice);
377 struct inode *ccc_object_inode(const struct cl_object *obj);
378 struct ccc_object *cl_inode2ccc (struct inode *inode);
380 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
381 struct obd_capa *capa);
383 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
384 int ccc_object_invariant(const struct cl_object *obj);
385 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
386 void cl_inode_fini(struct inode *inode);
387 int cl_local_size(struct inode *inode);
389 __u16 ll_dirent_type_get(struct lu_dirent *ent);
390 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
391 __u32 cl_fid_build_gen(const struct lu_fid *fid);
393 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
394 # define CLOBINVRNT(env, clob, expr) \
396 if (unlikely(!(expr))) { \
397 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, #expr "\n"); \
401 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
402 # define CLOBINVRNT(env, clob, expr) \
403 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
404 #endif /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
406 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
407 int cl_ocd_update(struct obd_device *host,
408 struct obd_device *watched,
409 enum obd_notify_event ev, void *owner, void *data);
411 struct ccc_grouplock {
412 struct lu_env *cg_env;
414 struct cl_lock *cg_lock;
415 unsigned long cg_gid;
418 int cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
419 struct ccc_grouplock *cg);
420 void cl_put_grouplock(struct ccc_grouplock *cg);
423 * New interfaces to get and put lov_stripe_md from lov layer. This violates
424 * layering because lov_stripe_md is supposed to be a private data in lov.
426 * NB: If you find you have to use these interfaces for your new code, please
427 * think about it again. These interfaces may be removed in the future for
428 * better layering. */
429 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
430 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
431 int lov_read_and_clear_async_rc(struct cl_object *clob);
433 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
434 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
437 * Data structure managing a client's cached clean pages. An LRU of
438 * pages is maintained, along with other statistics.
440 struct cl_client_cache {
441 cfs_atomic_t ccc_users; /* # of users (OSCs) of this data */
442 cfs_list_t ccc_lru; /* LRU list of cached clean pages */
443 spinlock_t ccc_lru_lock; /* lock for list */
444 cfs_atomic_t ccc_lru_left; /* # of LRU entries available */
445 unsigned long ccc_lru_max; /* Max # of LRU entries possible */
446 unsigned int ccc_lru_shrinkers; /* # of threads reclaiming */
449 #endif /*LCLIENT_H */