xref: /openbmc/linux/fs/ocfs2/uptodate.h (revision 8be98d2f2a0a262f8bf8a0bc1fdf522b3c7aab17)
1328970deSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
2*fa60ce2cSMasahiro Yamada /*
3ccd979bdSMark Fasheh  * uptodate.h
4ccd979bdSMark Fasheh  *
5ccd979bdSMark Fasheh  * Cluster uptodate tracking
6ccd979bdSMark Fasheh  *
7ccd979bdSMark Fasheh  * Copyright (C) 2002, 2004, 2005 Oracle.  All rights reserved.
8ccd979bdSMark Fasheh  */
9ccd979bdSMark Fasheh 
10ccd979bdSMark Fasheh #ifndef OCFS2_UPTODATE_H
11ccd979bdSMark Fasheh #define OCFS2_UPTODATE_H
12ccd979bdSMark Fasheh 
136e5a3d75SJoel Becker /*
146e5a3d75SJoel Becker  * The caching code relies on locking provided by the user of
156e5a3d75SJoel Becker  * struct ocfs2_caching_info.  These operations connect that up.
166e5a3d75SJoel Becker  */
176e5a3d75SJoel Becker struct ocfs2_caching_operations {
186e5a3d75SJoel Becker 	/*
196e5a3d75SJoel Becker 	 * A u64 representing the owning structure.  Usually this
206e5a3d75SJoel Becker 	 * is the block number (i_blkno or whatnot).  This is used so
216e5a3d75SJoel Becker 	 * that caching log messages can identify the owning structure.
226e5a3d75SJoel Becker 	 */
236e5a3d75SJoel Becker 	u64	(*co_owner)(struct ocfs2_caching_info *ci);
246e5a3d75SJoel Becker 
258cb471e8SJoel Becker 	/* The superblock is needed during I/O. */
268cb471e8SJoel Becker 	struct super_block *(*co_get_super)(struct ocfs2_caching_info *ci);
276e5a3d75SJoel Becker 	/*
286e5a3d75SJoel Becker 	 * Lock and unlock the caching data.  These will not sleep, and
296e5a3d75SJoel Becker 	 * should probably be spinlocks.
306e5a3d75SJoel Becker 	 */
316e5a3d75SJoel Becker 	void	(*co_cache_lock)(struct ocfs2_caching_info *ci);
326e5a3d75SJoel Becker 	void	(*co_cache_unlock)(struct ocfs2_caching_info *ci);
336e5a3d75SJoel Becker 
346e5a3d75SJoel Becker 	/*
356e5a3d75SJoel Becker 	 * Lock and unlock for disk I/O.  These will sleep, and should
366e5a3d75SJoel Becker 	 * be mutexes.
376e5a3d75SJoel Becker 	 */
386e5a3d75SJoel Becker 	void	(*co_io_lock)(struct ocfs2_caching_info *ci);
396e5a3d75SJoel Becker 	void	(*co_io_unlock)(struct ocfs2_caching_info *ci);
406e5a3d75SJoel Becker };
416e5a3d75SJoel Becker 
42ccd979bdSMark Fasheh int __init init_ocfs2_uptodate_cache(void);
430c6c98fbSAdrian Bunk void exit_ocfs2_uptodate_cache(void);
44ccd979bdSMark Fasheh 
4547460d65SJoel Becker void ocfs2_metadata_cache_init(struct ocfs2_caching_info *ci,
466e5a3d75SJoel Becker 			       const struct ocfs2_caching_operations *ops);
478cb471e8SJoel Becker void ocfs2_metadata_cache_purge(struct ocfs2_caching_info *ci);
4866fb345dSJoel Becker void ocfs2_metadata_cache_exit(struct ocfs2_caching_info *ci);
49ccd979bdSMark Fasheh 
508cb471e8SJoel Becker u64 ocfs2_metadata_cache_owner(struct ocfs2_caching_info *ci);
518cb471e8SJoel Becker void ocfs2_metadata_cache_io_lock(struct ocfs2_caching_info *ci);
528cb471e8SJoel Becker void ocfs2_metadata_cache_io_unlock(struct ocfs2_caching_info *ci);
538cb471e8SJoel Becker 
548cb471e8SJoel Becker int ocfs2_buffer_uptodate(struct ocfs2_caching_info *ci,
55ccd979bdSMark Fasheh 			  struct buffer_head *bh);
568cb471e8SJoel Becker void ocfs2_set_buffer_uptodate(struct ocfs2_caching_info *ci,
57ccd979bdSMark Fasheh 			       struct buffer_head *bh);
588cb471e8SJoel Becker void ocfs2_set_new_buffer_uptodate(struct ocfs2_caching_info *ci,
59ccd979bdSMark Fasheh 				   struct buffer_head *bh);
608cb471e8SJoel Becker void ocfs2_remove_from_cache(struct ocfs2_caching_info *ci,
61ccd979bdSMark Fasheh 			     struct buffer_head *bh);
628cb471e8SJoel Becker void ocfs2_remove_xattr_clusters_from_cache(struct ocfs2_caching_info *ci,
63ac11c827STao Ma 					    sector_t block,
64ac11c827STao Ma 					    u32 c_len);
658cb471e8SJoel Becker int ocfs2_buffer_read_ahead(struct ocfs2_caching_info *ci,
66aa958874SMark Fasheh 			    struct buffer_head *bh);
67ccd979bdSMark Fasheh 
68ccd979bdSMark Fasheh #endif /* OCFS2_UPTODATE_H */
69