xref: /kernel/linux/linux-5.10/fs/ocfs2/uptodate.h (revision 8c2ecf20)
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/* -*- mode: c; c-basic-offset: 8; -*-
3 * vim: noexpandtab sw=8 ts=8 sts=0:
4 *
5 * uptodate.h
6 *
7 * Cluster uptodate tracking
8 *
9 * Copyright (C) 2002, 2004, 2005 Oracle.  All rights reserved.
10 */
11
12#ifndef OCFS2_UPTODATE_H
13#define OCFS2_UPTODATE_H
14
15/*
16 * The caching code relies on locking provided by the user of
17 * struct ocfs2_caching_info.  These operations connect that up.
18 */
19struct ocfs2_caching_operations {
20	/*
21	 * A u64 representing the owning structure.  Usually this
22	 * is the block number (i_blkno or whatnot).  This is used so
23	 * that caching log messages can identify the owning structure.
24	 */
25	u64	(*co_owner)(struct ocfs2_caching_info *ci);
26
27	/* The superblock is needed during I/O. */
28	struct super_block *(*co_get_super)(struct ocfs2_caching_info *ci);
29	/*
30	 * Lock and unlock the caching data.  These will not sleep, and
31	 * should probably be spinlocks.
32	 */
33	void	(*co_cache_lock)(struct ocfs2_caching_info *ci);
34	void	(*co_cache_unlock)(struct ocfs2_caching_info *ci);
35
36	/*
37	 * Lock and unlock for disk I/O.  These will sleep, and should
38	 * be mutexes.
39	 */
40	void	(*co_io_lock)(struct ocfs2_caching_info *ci);
41	void	(*co_io_unlock)(struct ocfs2_caching_info *ci);
42};
43
44int __init init_ocfs2_uptodate_cache(void);
45void exit_ocfs2_uptodate_cache(void);
46
47void ocfs2_metadata_cache_init(struct ocfs2_caching_info *ci,
48			       const struct ocfs2_caching_operations *ops);
49void ocfs2_metadata_cache_purge(struct ocfs2_caching_info *ci);
50void ocfs2_metadata_cache_exit(struct ocfs2_caching_info *ci);
51
52u64 ocfs2_metadata_cache_owner(struct ocfs2_caching_info *ci);
53void ocfs2_metadata_cache_io_lock(struct ocfs2_caching_info *ci);
54void ocfs2_metadata_cache_io_unlock(struct ocfs2_caching_info *ci);
55
56int ocfs2_buffer_uptodate(struct ocfs2_caching_info *ci,
57			  struct buffer_head *bh);
58void ocfs2_set_buffer_uptodate(struct ocfs2_caching_info *ci,
59			       struct buffer_head *bh);
60void ocfs2_set_new_buffer_uptodate(struct ocfs2_caching_info *ci,
61				   struct buffer_head *bh);
62void ocfs2_remove_from_cache(struct ocfs2_caching_info *ci,
63			     struct buffer_head *bh);
64void ocfs2_remove_xattr_clusters_from_cache(struct ocfs2_caching_info *ci,
65					    sector_t block,
66					    u32 c_len);
67int ocfs2_buffer_read_ahead(struct ocfs2_caching_info *ci,
68			    struct buffer_head *bh);
69
70#endif /* OCFS2_UPTODATE_H */
71