xref: /linux/fs/ocfs2/quota.h (revision ab52c59103002b49f2455371e4b9c56ba3ef1781)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * quota.h for OCFS2
4  *
5  * On disk quota structures for local and global quota file, in-memory
6  * structures.
7  *
8  */
9 
10 #ifndef _OCFS2_QUOTA_H
11 #define _OCFS2_QUOTA_H
12 
13 #include <linux/types.h>
14 #include <linux/slab.h>
15 #include <linux/quota.h>
16 #include <linux/list.h>
17 #include <linux/dqblk_qtree.h>
18 
19 #include "ocfs2.h"
20 
21 /* Number of quota types we support */
22 #define OCFS2_MAXQUOTAS 2
23 
24 /*
25  * In-memory structures
26  */
27 struct ocfs2_dquot {
28 	struct dquot dq_dquot;	/* Generic VFS dquot */
29 	loff_t dq_local_off;	/* Offset in the local quota file */
30 	u64 dq_local_phys_blk;	/* Physical block carrying quota structure */
31 	struct ocfs2_quota_chunk *dq_chunk;	/* Chunk dquot is in */
32 	unsigned int dq_use_count;	/* Number of nodes having reference to this entry in global quota file */
33 	s64 dq_origspace;	/* Last globally synced space usage */
34 	s64 dq_originodes;	/* Last globally synced inode usage */
35 	struct llist_node list;	/* Member of list of dquots to drop */
36 };
37 
38 /* Description of one chunk to recover in memory */
39 struct ocfs2_recovery_chunk {
40 	struct list_head rc_list;	/* List of chunks */
41 	int rc_chunk;			/* Chunk number */
42 	unsigned long *rc_bitmap;	/* Bitmap of entries to recover */
43 };
44 
45 struct ocfs2_quota_recovery {
46 	struct list_head r_list[OCFS2_MAXQUOTAS];	/* List of chunks to recover */
47 };
48 
49 /* In-memory structure with quota header information */
50 struct ocfs2_mem_dqinfo {
51 	unsigned int dqi_type;		/* Quota type this structure describes */
52 	unsigned int dqi_flags;		/* Flags OLQF_* */
53 	unsigned int dqi_chunks;	/* Number of chunks in local quota file */
54 	unsigned int dqi_blocks;	/* Number of blocks allocated for local quota file */
55 	unsigned int dqi_syncms;	/* How often should we sync with other nodes */
56 	struct list_head dqi_chunk;	/* List of chunks */
57 	struct inode *dqi_gqinode;	/* Global quota file inode */
58 	struct ocfs2_lock_res dqi_gqlock;	/* Lock protecting quota information structure */
59 	struct buffer_head *dqi_gqi_bh;	/* Buffer head with global quota file inode - set only if inode lock is obtained */
60 	int dqi_gqi_count;		/* Number of holders of dqi_gqi_bh */
61 	u64 dqi_giblk;			/* Number of block with global information header */
62 	struct buffer_head *dqi_lqi_bh;	/* Buffer head with local quota file inode */
63 	struct buffer_head *dqi_libh;	/* Buffer with local information header */
64 	struct qtree_mem_dqinfo dqi_gi;	/* Info about global file */
65 	struct delayed_work dqi_sync_work;	/* Work for syncing dquots */
66 	struct ocfs2_quota_recovery *dqi_rec;	/* Pointer to recovery
67 						 * information, in case we
68 						 * enable quotas on file
69 						 * needing it */
70 };
71 
72 static inline struct ocfs2_dquot *OCFS2_DQUOT(struct dquot *dquot)
73 {
74 	return container_of(dquot, struct ocfs2_dquot, dq_dquot);
75 }
76 
77 struct ocfs2_quota_chunk {
78 	struct list_head qc_chunk;	/* List of quotafile chunks */
79 	int qc_num;			/* Number of quota chunk */
80 	struct buffer_head *qc_headerbh;	/* Buffer head with chunk header */
81 };
82 
83 extern struct kmem_cache *ocfs2_dquot_cachep;
84 extern struct kmem_cache *ocfs2_qf_chunk_cachep;
85 
86 extern const struct qtree_fmt_operations ocfs2_global_ops;
87 
88 struct ocfs2_quota_recovery *ocfs2_begin_quota_recovery(
89 				struct ocfs2_super *osb, int slot_num);
90 int ocfs2_finish_quota_recovery(struct ocfs2_super *osb,
91 				struct ocfs2_quota_recovery *rec,
92 				int slot_num);
93 void ocfs2_free_quota_recovery(struct ocfs2_quota_recovery *rec);
94 ssize_t ocfs2_quota_read(struct super_block *sb, int type, char *data,
95 			 size_t len, loff_t off);
96 ssize_t ocfs2_quota_write(struct super_block *sb, int type,
97 			  const char *data, size_t len, loff_t off);
98 int ocfs2_global_read_info(struct super_block *sb, int type);
99 int ocfs2_global_write_info(struct super_block *sb, int type);
100 int ocfs2_global_read_dquot(struct dquot *dquot);
101 int __ocfs2_sync_dquot(struct dquot *dquot, int freeing);
102 static inline int ocfs2_sync_dquot(struct dquot *dquot)
103 {
104 	return __ocfs2_sync_dquot(dquot, 0);
105 }
106 static inline int ocfs2_global_release_dquot(struct dquot *dquot)
107 {
108 	return __ocfs2_sync_dquot(dquot, 1);
109 }
110 
111 int ocfs2_lock_global_qf(struct ocfs2_mem_dqinfo *oinfo, int ex);
112 void ocfs2_unlock_global_qf(struct ocfs2_mem_dqinfo *oinfo, int ex);
113 int ocfs2_validate_quota_block(struct super_block *sb, struct buffer_head *bh);
114 int ocfs2_read_quota_phys_block(struct inode *inode, u64 p_block,
115 				struct buffer_head **bh);
116 int ocfs2_create_local_dquot(struct dquot *dquot);
117 int ocfs2_local_release_dquot(handle_t *handle, struct dquot *dquot);
118 int ocfs2_local_write_dquot(struct dquot *dquot);
119 void ocfs2_drop_dquot_refs(struct work_struct *work);
120 
121 extern const struct dquot_operations ocfs2_quota_operations;
122 extern struct quota_format_type ocfs2_quota_format;
123 
124 #endif /* _OCFS2_QUOTA_H */
125