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, 2012, Whamcloud, Inc.
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 int cui_locks_released;
103 enum ccc_setattr_lock_type cui_local_lock;
107 * True iff io is processing glimpse right now.
111 * Layout version when this IO is initialized
113 __u32 cui_layout_gen;
115 * File descriptor against which IO is done.
117 struct ll_file_data *cui_fd;
118 #ifndef HAVE_FILE_WRITEV
119 struct kiocb *cui_iocb;
124 * True, if \a io is a normal io, False for other (sendfile, splice*).
125 * must be impementated in arch specific code.
127 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
129 extern struct lu_context_key ccc_key;
130 extern struct lu_context_key ccc_session_key;
132 struct ccc_thread_info {
133 struct cl_lock_descr cti_descr;
135 struct cl_attr cti_attr;
138 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
140 struct ccc_thread_info *info;
142 info = lu_context_key_get(&env->le_ctx, &ccc_key);
143 LASSERT(info != NULL);
147 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
149 struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
150 memset(attr, 0, sizeof(*attr));
154 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
156 struct cl_io *io = &ccc_env_info(env)->cti_io;
157 memset(io, 0, sizeof(*io));
162 struct ccc_io cs_ios;
165 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
167 struct ccc_session *ses;
169 ses = lu_context_key_get(env->le_ses, &ccc_session_key);
170 LASSERT(ses != NULL);
174 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
176 return &ccc_env_session(env)->cs_ios;
180 * ccc-private object state.
183 struct cl_object_header cob_header;
184 struct cl_object cob_cl;
185 struct inode *cob_inode;
188 * A list of dirty pages pending IO in the cache. Used by
189 * SOM. Protected by ll_inode_info::lli_lock.
191 * \see ccc_page::cpg_pending_linkage
193 cfs_list_t cob_pending_list;
196 * Access this counter is protected by inode->i_sem. Now that
197 * the lifetime of transient pages must be covered by inode sem,
198 * we don't need to hold any lock..
200 int cob_transient_pages;
202 * Number of outstanding mmaps on this file.
204 * \see ll_vm_open(), ll_vm_close().
206 cfs_atomic_t cob_mmap_cnt;
210 * ccc-private page state.
213 struct cl_page_slice cpg_cl;
214 int cpg_defer_uptodate;
216 int cpg_write_queued;
218 * Non-empty iff this page is already counted in
219 * ccc_object::cob_pending_list. Protected by
220 * ccc_object::cob_pending_guard. This list is only used as a flag,
221 * that is, never iterated through, only checked for list_empty(), but
222 * having a list is useful for debugging.
224 cfs_list_t cpg_pending_linkage;
226 cfs_page_t *cpg_page;
229 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
231 return container_of(slice, struct ccc_page, cpg_cl);
234 struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage);
237 struct cl_device cdv_cl;
238 struct super_block *cdv_sb;
239 struct cl_device *cdv_next;
243 struct cl_lock_slice clk_cl;
247 struct cl_req_slice crq_cl;
250 void *ccc_key_init (const struct lu_context *ctx,
251 struct lu_context_key *key);
252 void ccc_key_fini (const struct lu_context *ctx,
253 struct lu_context_key *key, void *data);
254 void *ccc_session_key_init(const struct lu_context *ctx,
255 struct lu_context_key *key);
256 void ccc_session_key_fini(const struct lu_context *ctx,
257 struct lu_context_key *key, void *data);
259 int ccc_device_init (const struct lu_env *env,
261 const char *name, struct lu_device *next);
262 struct lu_device *ccc_device_fini (const struct lu_env *env,
263 struct lu_device *d);
264 struct lu_device *ccc_device_alloc(const struct lu_env *env,
265 struct lu_device_type *t,
266 struct lustre_cfg *cfg,
267 const struct lu_device_operations *luops,
268 const struct cl_device_operations *clops);
269 struct lu_device *ccc_device_free (const struct lu_env *env,
270 struct lu_device *d);
271 struct lu_object *ccc_object_alloc(const struct lu_env *env,
272 const struct lu_object_header *hdr,
273 struct lu_device *dev,
274 const struct cl_object_operations *clops,
275 const struct lu_object_operations *luops);
277 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
279 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
280 int ccc_global_init(struct lu_device_type *device_type);
281 void ccc_global_fini(struct lu_device_type *device_type);
282 int ccc_object_init0(const struct lu_env *env,struct ccc_object *vob,
283 const struct cl_object_conf *conf);
284 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
285 const struct lu_object_conf *conf);
286 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
287 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
288 struct cl_lock *lock, const struct cl_io *io,
289 const struct cl_lock_operations *lkops);
290 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
291 const struct cl_attr *attr, unsigned valid);
292 int ccc_object_glimpse(const struct lu_env *env,
293 const struct cl_object *obj, struct ost_lvb *lvb);
294 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
295 const struct cl_object_conf *conf);
296 cfs_page_t *ccc_page_vmpage(const struct lu_env *env,
297 const struct cl_page_slice *slice);
298 int ccc_page_is_under_lock(const struct lu_env *env,
299 const struct cl_page_slice *slice, struct cl_io *io);
300 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
301 void ccc_transient_page_verify(const struct cl_page *page);
302 int ccc_transient_page_own(const struct lu_env *env,
303 const struct cl_page_slice *slice,
304 struct cl_io *io, int nonblock);
305 void ccc_transient_page_assume(const struct lu_env *env,
306 const struct cl_page_slice *slice,
308 void ccc_transient_page_unassume(const struct lu_env *env,
309 const struct cl_page_slice *slice,
311 void ccc_transient_page_disown(const struct lu_env *env,
312 const struct cl_page_slice *slice,
314 void ccc_transient_page_discard(const struct lu_env *env,
315 const struct cl_page_slice *slice,
317 int ccc_transient_page_prep(const struct lu_env *env,
318 const struct cl_page_slice *slice,
320 void ccc_lock_delete(const struct lu_env *env,
321 const struct cl_lock_slice *slice);
322 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
323 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
324 struct cl_io *io, __u32 enqflags);
325 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
326 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
327 int ccc_lock_fits_into(const struct lu_env *env,
328 const struct cl_lock_slice *slice,
329 const struct cl_lock_descr *need,
330 const struct cl_io *io);
331 void ccc_lock_state(const struct lu_env *env,
332 const struct cl_lock_slice *slice,
333 enum cl_lock_state state);
335 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
336 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
337 __u32 enqflags, enum cl_lock_mode mode,
338 pgoff_t start, pgoff_t end);
339 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
340 __u32 enqflags, enum cl_lock_mode mode,
341 loff_t start, loff_t end);
342 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
343 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
345 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
347 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
348 struct cl_io *io, loff_t start, size_t count, int *exceed);
349 void ccc_req_completion(const struct lu_env *env,
350 const struct cl_req_slice *slice, int ioret);
351 void ccc_req_attr_set(const struct lu_env *env,const struct cl_req_slice *slice,
352 const struct cl_object *obj,
353 struct cl_req_attr *oa, obd_valid flags);
355 struct lu_device *ccc2lu_dev (struct ccc_device *vdv);
356 struct lu_object *ccc2lu (struct ccc_object *vob);
357 struct ccc_device *lu2ccc_dev (const struct lu_device *d);
358 struct ccc_device *cl2ccc_dev (const struct cl_device *d);
359 struct ccc_object *lu2ccc (const struct lu_object *obj);
360 struct ccc_object *cl2ccc (const struct cl_object *obj);
361 struct ccc_lock *cl2ccc_lock (const struct cl_lock_slice *slice);
362 struct ccc_io *cl2ccc_io (const struct lu_env *env,
363 const struct cl_io_slice *slice);
364 struct ccc_req *cl2ccc_req (const struct cl_req_slice *slice);
365 cfs_page_t *cl2vm_page (const struct cl_page_slice *slice);
366 struct inode *ccc_object_inode(const struct cl_object *obj);
367 struct ccc_object *cl_inode2ccc (struct inode *inode);
369 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
370 struct obd_capa *capa);
372 struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage);
373 int ccc_object_invariant(const struct cl_object *obj);
374 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
375 void cl_inode_fini(struct inode *inode);
376 int cl_local_size(struct inode *inode);
378 __u16 ll_dirent_type_get(struct lu_dirent *ent);
379 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
380 __u32 cl_fid_build_gen(const struct lu_fid *fid);
382 #ifdef INVARIANT_CHECK
383 # define CLOBINVRNT(env, clob, expr) \
385 if (unlikely(!(expr))) { \
386 LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, #expr "\n"); \
390 #else /* !INVARIANT_CHECK */
391 # define CLOBINVRNT(env, clob, expr) \
392 ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
393 #endif /* !INVARIANT_CHECK */
395 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
396 int cl_ocd_update(struct obd_device *host,
397 struct obd_device *watched,
398 enum obd_notify_event ev, void *owner, void *data);
400 struct ccc_grouplock {
401 struct lu_env *cg_env;
403 struct cl_lock *cg_lock;
404 unsigned long cg_gid;
407 int cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
408 struct ccc_grouplock *cg);
409 void cl_put_grouplock(struct ccc_grouplock *cg);
412 * New interfaces to get and put lov_stripe_md from lov layer. This violates
413 * layering because lov_stripe_md is supposed to be a private data in lov.
415 * NB: If you find you have to use these interfaces for your new code, please
416 * think about it again. These interfaces may be removed in the future for
417 * better layering. */
418 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
419 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
420 int lov_read_and_clear_async_rc(struct cl_object *clob);
422 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
423 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
425 #endif /*LCLIENT_H */