1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* 2 /*
3 * Simple zone file system for zoned block dev 3 * Simple zone file system for zoned block devices.
4 * 4 *
5 * Copyright (C) 2019 Western Digital Corporat 5 * Copyright (C) 2019 Western Digital Corporation or its affiliates.
6 */ 6 */
7 #ifndef __ZONEFS_H__ 7 #ifndef __ZONEFS_H__
8 #define __ZONEFS_H__ 8 #define __ZONEFS_H__
9 9
10 #include <linux/fs.h> 10 #include <linux/fs.h>
11 #include <linux/magic.h> 11 #include <linux/magic.h>
12 #include <linux/uuid.h> 12 #include <linux/uuid.h>
13 #include <linux/mutex.h> 13 #include <linux/mutex.h>
14 #include <linux/rwsem.h> 14 #include <linux/rwsem.h>
15 #include <linux/kobject.h> 15 #include <linux/kobject.h>
16 16
17 /* 17 /*
18 * Maximum length of file names: this only nee 18 * Maximum length of file names: this only needs to be large enough to fit
19 * the zone group directory names and a decima 19 * the zone group directory names and a decimal zone number for file names.
20 * 16 characters is plenty. 20 * 16 characters is plenty.
21 */ 21 */
22 #define ZONEFS_NAME_MAX 16 22 #define ZONEFS_NAME_MAX 16
23 23
24 /* 24 /*
25 * Zone types: ZONEFS_ZTYPE_SEQ is used for al 25 * Zone types: ZONEFS_ZTYPE_SEQ is used for all sequential zone types
26 * defined in linux/blkzoned.h, that is, BLK_Z 26 * defined in linux/blkzoned.h, that is, BLK_ZONE_TYPE_SEQWRITE_REQ and
27 * BLK_ZONE_TYPE_SEQWRITE_PREF. 27 * BLK_ZONE_TYPE_SEQWRITE_PREF.
28 */ 28 */
29 enum zonefs_ztype { 29 enum zonefs_ztype {
30 ZONEFS_ZTYPE_CNV, 30 ZONEFS_ZTYPE_CNV,
31 ZONEFS_ZTYPE_SEQ, 31 ZONEFS_ZTYPE_SEQ,
32 ZONEFS_ZTYPE_MAX, 32 ZONEFS_ZTYPE_MAX,
33 }; 33 };
34 34
35 static inline enum zonefs_ztype zonefs_zone_ty 35 static inline enum zonefs_ztype zonefs_zone_type(struct blk_zone *zone)
36 { 36 {
37 if (zone->type == BLK_ZONE_TYPE_CONVEN 37 if (zone->type == BLK_ZONE_TYPE_CONVENTIONAL)
38 return ZONEFS_ZTYPE_CNV; 38 return ZONEFS_ZTYPE_CNV;
39 return ZONEFS_ZTYPE_SEQ; 39 return ZONEFS_ZTYPE_SEQ;
40 } 40 }
41 41
42 #define ZONEFS_ZONE_INIT_MODE (1U << 0) 42 #define ZONEFS_ZONE_INIT_MODE (1U << 0)
43 #define ZONEFS_ZONE_OPEN (1U << 1) 43 #define ZONEFS_ZONE_OPEN (1U << 1)
44 #define ZONEFS_ZONE_ACTIVE (1U << 2) 44 #define ZONEFS_ZONE_ACTIVE (1U << 2)
45 #define ZONEFS_ZONE_OFFLINE (1U << 3) 45 #define ZONEFS_ZONE_OFFLINE (1U << 3)
46 #define ZONEFS_ZONE_READONLY (1U << 4) 46 #define ZONEFS_ZONE_READONLY (1U << 4)
47 #define ZONEFS_ZONE_CNV (1U << 31) 47 #define ZONEFS_ZONE_CNV (1U << 31)
48 48
49 /* 49 /*
50 * In-memory per-file inode zone data. 50 * In-memory per-file inode zone data.
51 */ 51 */
52 struct zonefs_zone { 52 struct zonefs_zone {
53 /* Zone state flags */ 53 /* Zone state flags */
54 unsigned int z_flags; 54 unsigned int z_flags;
55 55
56 /* Zone start sector (512B unit) */ 56 /* Zone start sector (512B unit) */
57 sector_t z_sector; 57 sector_t z_sector;
58 58
59 /* Zone size (bytes) */ 59 /* Zone size (bytes) */
60 loff_t z_size; 60 loff_t z_size;
61 61
62 /* Zone capacity (file maximum size, b 62 /* Zone capacity (file maximum size, bytes) */
63 loff_t z_capacity; 63 loff_t z_capacity;
64 64
65 /* Write pointer offset in the zone (s 65 /* Write pointer offset in the zone (sequential zones only, bytes) */
66 loff_t z_wpoffset; 66 loff_t z_wpoffset;
67 <<
68 /* Saved inode uid, gid and access rig <<
69 umode_t z_mode; <<
70 kuid_t z_uid; <<
71 kgid_t z_gid; <<
72 }; 67 };
73 68
74 /* 69 /*
75 * In memory zone group information: all zones 70 * In memory zone group information: all zones of a group are exposed
76 * as files, one file per zone. 71 * as files, one file per zone.
77 */ 72 */
78 struct zonefs_zone_group { 73 struct zonefs_zone_group {
79 struct inode *g_inode; <<
80 unsigned int g_nr_zones; 74 unsigned int g_nr_zones;
81 struct zonefs_zone *g_zones; 75 struct zonefs_zone *g_zones;
82 }; 76 };
83 77
84 /* 78 /*
85 * In-memory inode data. 79 * In-memory inode data.
86 */ 80 */
87 struct zonefs_inode_info { 81 struct zonefs_inode_info {
88 struct inode i_vnode; 82 struct inode i_vnode;
89 83
90 /* 84 /*
91 * To serialise fully against both sys 85 * To serialise fully against both syscall and mmap based IO and
92 * sequential file truncation, two loc 86 * sequential file truncation, two locks are used. For serializing
93 * zonefs_seq_file_truncate() against 87 * zonefs_seq_file_truncate() against zonefs_iomap_begin(), that is,
94 * file truncate operations against bl 88 * file truncate operations against block mapping, i_truncate_mutex is
95 * used. i_truncate_mutex also protect 89 * used. i_truncate_mutex also protects against concurrent accesses
96 * and changes to the inode private da 90 * and changes to the inode private data, and in particular changes to
97 * a sequential file size on completio 91 * a sequential file size on completion of direct IO writes.
98 * Serialization of mmap read IOs with 92 * Serialization of mmap read IOs with truncate and syscall IO
99 * operations is done with invalidate_ 93 * operations is done with invalidate_lock in addition to
100 * i_truncate_mutex. Only zonefs_seq_ 94 * i_truncate_mutex. Only zonefs_seq_file_truncate() takes both lock
101 * (invalidate_lock first, i_truncate_ 95 * (invalidate_lock first, i_truncate_mutex second).
102 */ 96 */
103 struct mutex i_truncate_mut 97 struct mutex i_truncate_mutex;
104 98
105 /* guarded by i_truncate_mutex */ 99 /* guarded by i_truncate_mutex */
106 unsigned int i_wr_refcnt; 100 unsigned int i_wr_refcnt;
107 }; 101 };
108 102
109 static inline struct zonefs_inode_info *ZONEFS 103 static inline struct zonefs_inode_info *ZONEFS_I(struct inode *inode)
110 { 104 {
111 return container_of(inode, struct zone 105 return container_of(inode, struct zonefs_inode_info, i_vnode);
112 } 106 }
113 107
114 static inline bool zonefs_zone_is_cnv(struct z 108 static inline bool zonefs_zone_is_cnv(struct zonefs_zone *z)
115 { 109 {
116 return z->z_flags & ZONEFS_ZONE_CNV; 110 return z->z_flags & ZONEFS_ZONE_CNV;
117 } 111 }
118 112
119 static inline bool zonefs_zone_is_seq(struct z 113 static inline bool zonefs_zone_is_seq(struct zonefs_zone *z)
120 { 114 {
121 return !zonefs_zone_is_cnv(z); 115 return !zonefs_zone_is_cnv(z);
122 } 116 }
123 117
124 static inline struct zonefs_zone *zonefs_inode 118 static inline struct zonefs_zone *zonefs_inode_zone(struct inode *inode)
125 { 119 {
126 return inode->i_private; 120 return inode->i_private;
127 } 121 }
128 122
129 static inline bool zonefs_inode_is_cnv(struct 123 static inline bool zonefs_inode_is_cnv(struct inode *inode)
130 { 124 {
131 return zonefs_zone_is_cnv(zonefs_inode 125 return zonefs_zone_is_cnv(zonefs_inode_zone(inode));
132 } 126 }
133 127
134 static inline bool zonefs_inode_is_seq(struct 128 static inline bool zonefs_inode_is_seq(struct inode *inode)
135 { 129 {
136 return zonefs_zone_is_seq(zonefs_inode 130 return zonefs_zone_is_seq(zonefs_inode_zone(inode));
137 } 131 }
138 132
139 /* 133 /*
140 * On-disk super block (block 0). 134 * On-disk super block (block 0).
141 */ 135 */
142 #define ZONEFS_LABEL_LEN 64 136 #define ZONEFS_LABEL_LEN 64
143 #define ZONEFS_UUID_SIZE 16 137 #define ZONEFS_UUID_SIZE 16
144 #define ZONEFS_SUPER_SIZE 4096 138 #define ZONEFS_SUPER_SIZE 4096
145 139
146 struct zonefs_super { 140 struct zonefs_super {
147 141
148 /* Magic number */ 142 /* Magic number */
149 __le32 s_magic; 143 __le32 s_magic;
150 144
151 /* Checksum */ 145 /* Checksum */
152 __le32 s_crc; 146 __le32 s_crc;
153 147
154 /* Volume label */ 148 /* Volume label */
155 char s_label[ZONEFS_LABEL_L 149 char s_label[ZONEFS_LABEL_LEN];
156 150
157 /* 128-bit uuid */ 151 /* 128-bit uuid */
158 __u8 s_uuid[ZONEFS_UUID_SIZ 152 __u8 s_uuid[ZONEFS_UUID_SIZE];
159 153
160 /* Features */ 154 /* Features */
161 __le64 s_features; 155 __le64 s_features;
162 156
163 /* UID/GID to use for files */ 157 /* UID/GID to use for files */
164 __le32 s_uid; 158 __le32 s_uid;
165 __le32 s_gid; 159 __le32 s_gid;
166 160
167 /* File permissions */ 161 /* File permissions */
168 __le32 s_perm; 162 __le32 s_perm;
169 163
170 /* Padding to ZONEFS_SUPER_SIZE bytes 164 /* Padding to ZONEFS_SUPER_SIZE bytes */
171 __u8 s_reserved[3988]; 165 __u8 s_reserved[3988];
172 166
173 } __packed; 167 } __packed;
174 168
175 /* 169 /*
176 * Feature flags: specified in the s_features 170 * Feature flags: specified in the s_features field of the on-disk super
177 * block struct zonefs_super and in-memory in 171 * block struct zonefs_super and in-memory in the s_feartures field of
178 * struct zonefs_sb_info. 172 * struct zonefs_sb_info.
179 */ 173 */
180 enum zonefs_features { 174 enum zonefs_features {
181 /* 175 /*
182 * Aggregate contiguous conventional z 176 * Aggregate contiguous conventional zones into a single file.
183 */ 177 */
184 ZONEFS_F_AGGRCNV = 1ULL << 0, 178 ZONEFS_F_AGGRCNV = 1ULL << 0,
185 /* 179 /*
186 * Use super block specified UID for f 180 * Use super block specified UID for files instead of default 0.
187 */ 181 */
188 ZONEFS_F_UID = 1ULL << 1, 182 ZONEFS_F_UID = 1ULL << 1,
189 /* 183 /*
190 * Use super block specified GID for f 184 * Use super block specified GID for files instead of default 0.
191 */ 185 */
192 ZONEFS_F_GID = 1ULL << 2, 186 ZONEFS_F_GID = 1ULL << 2,
193 /* 187 /*
194 * Use super block specified file perm 188 * Use super block specified file permissions instead of default 640.
195 */ 189 */
196 ZONEFS_F_PERM = 1ULL << 3, 190 ZONEFS_F_PERM = 1ULL << 3,
197 }; 191 };
198 192
199 #define ZONEFS_F_DEFINED_FEATURES \ 193 #define ZONEFS_F_DEFINED_FEATURES \
200 (ZONEFS_F_AGGRCNV | ZONEFS_F_UID | ZON 194 (ZONEFS_F_AGGRCNV | ZONEFS_F_UID | ZONEFS_F_GID | ZONEFS_F_PERM)
201 195
202 /* 196 /*
203 * Mount options for zone write pointer error 197 * Mount options for zone write pointer error handling.
204 */ 198 */
205 #define ZONEFS_MNTOPT_ERRORS_RO (1 << 199 #define ZONEFS_MNTOPT_ERRORS_RO (1 << 0) /* Make zone file readonly */
206 #define ZONEFS_MNTOPT_ERRORS_ZRO (1 << 200 #define ZONEFS_MNTOPT_ERRORS_ZRO (1 << 1) /* Make zone file offline */
207 #define ZONEFS_MNTOPT_ERRORS_ZOL (1 << 201 #define ZONEFS_MNTOPT_ERRORS_ZOL (1 << 2) /* Make zone file offline */
208 #define ZONEFS_MNTOPT_ERRORS_REPAIR (1 << 202 #define ZONEFS_MNTOPT_ERRORS_REPAIR (1 << 3) /* Remount read-only */
209 #define ZONEFS_MNTOPT_ERRORS_MASK \ 203 #define ZONEFS_MNTOPT_ERRORS_MASK \
210 (ZONEFS_MNTOPT_ERRORS_RO | ZONEFS_MNTO 204 (ZONEFS_MNTOPT_ERRORS_RO | ZONEFS_MNTOPT_ERRORS_ZRO | \
211 ZONEFS_MNTOPT_ERRORS_ZOL | ZONEFS_MNT 205 ZONEFS_MNTOPT_ERRORS_ZOL | ZONEFS_MNTOPT_ERRORS_REPAIR)
212 #define ZONEFS_MNTOPT_EXPLICIT_OPEN (1 << 206 #define ZONEFS_MNTOPT_EXPLICIT_OPEN (1 << 4) /* Explicit open/close of zones on open/close */
213 207
214 /* 208 /*
215 * In-memory Super block information. 209 * In-memory Super block information.
216 */ 210 */
217 struct zonefs_sb_info { 211 struct zonefs_sb_info {
218 212
219 unsigned long s_mount_opts; 213 unsigned long s_mount_opts;
220 214
221 spinlock_t s_lock; 215 spinlock_t s_lock;
222 216
223 unsigned long long s_features; 217 unsigned long long s_features;
224 kuid_t s_uid; 218 kuid_t s_uid;
225 kgid_t s_gid; 219 kgid_t s_gid;
226 umode_t s_perm; 220 umode_t s_perm;
227 uuid_t s_uuid; 221 uuid_t s_uuid;
228 unsigned int s_zone_sectors 222 unsigned int s_zone_sectors_shift;
229 223
230 struct zonefs_zone_group s_zgroup[ZONE 224 struct zonefs_zone_group s_zgroup[ZONEFS_ZTYPE_MAX];
231 225
232 loff_t s_blocks; 226 loff_t s_blocks;
233 loff_t s_used_blocks; 227 loff_t s_used_blocks;
234 228
235 unsigned int s_max_wro_seq_ 229 unsigned int s_max_wro_seq_files;
236 atomic_t s_wro_seq_file 230 atomic_t s_wro_seq_files;
237 231
238 unsigned int s_max_active_s 232 unsigned int s_max_active_seq_files;
239 atomic_t s_active_seq_f 233 atomic_t s_active_seq_files;
240 234
241 bool s_sysfs_regist 235 bool s_sysfs_registered;
242 struct kobject s_kobj; 236 struct kobject s_kobj;
243 struct completion s_kobj_unregis 237 struct completion s_kobj_unregister;
244 }; 238 };
245 239
246 static inline struct zonefs_sb_info *ZONEFS_SB 240 static inline struct zonefs_sb_info *ZONEFS_SB(struct super_block *sb)
247 { 241 {
248 return sb->s_fs_info; 242 return sb->s_fs_info;
249 } 243 }
250 244
251 #define zonefs_info(sb, format, args...) 245 #define zonefs_info(sb, format, args...) \
252 pr_info("zonefs (%s): " format, sb->s_ 246 pr_info("zonefs (%s): " format, sb->s_id, ## args)
253 #define zonefs_err(sb, format, args...) 247 #define zonefs_err(sb, format, args...) \
254 pr_err("zonefs (%s) ERROR: " format, s 248 pr_err("zonefs (%s) ERROR: " format, sb->s_id, ## args)
255 #define zonefs_warn(sb, format, args...) 249 #define zonefs_warn(sb, format, args...) \
256 pr_warn("zonefs (%s) WARNING: " format 250 pr_warn("zonefs (%s) WARNING: " format, sb->s_id, ## args)
257 251
258 /* In super.c */ 252 /* In super.c */
259 void zonefs_inode_account_active(struct inode 253 void zonefs_inode_account_active(struct inode *inode);
260 int zonefs_inode_zone_mgmt(struct inode *inode 254 int zonefs_inode_zone_mgmt(struct inode *inode, enum req_op op);
261 void zonefs_i_size_write(struct inode *inode, 255 void zonefs_i_size_write(struct inode *inode, loff_t isize);
262 void zonefs_update_stats(struct inode *inode, 256 void zonefs_update_stats(struct inode *inode, loff_t new_isize);
263 void __zonefs_io_error(struct inode *inode, bo 257 void __zonefs_io_error(struct inode *inode, bool write);
264 258
265 static inline void zonefs_io_error(struct inod 259 static inline void zonefs_io_error(struct inode *inode, bool write)
266 { 260 {
267 struct zonefs_inode_info *zi = ZONEFS_ 261 struct zonefs_inode_info *zi = ZONEFS_I(inode);
268 262
269 mutex_lock(&zi->i_truncate_mutex); 263 mutex_lock(&zi->i_truncate_mutex);
270 __zonefs_io_error(inode, write); 264 __zonefs_io_error(inode, write);
271 mutex_unlock(&zi->i_truncate_mutex); 265 mutex_unlock(&zi->i_truncate_mutex);
272 } 266 }
273 <<
274 /* In super.c */ <<
275 extern const struct inode_operations zonefs_di <<
276 extern const struct file_operations zonefs_dir <<
277 267
278 /* In file.c */ 268 /* In file.c */
279 extern const struct address_space_operations z 269 extern const struct address_space_operations zonefs_file_aops;
280 extern const struct file_operations zonefs_fil 270 extern const struct file_operations zonefs_file_operations;
281 int zonefs_file_truncate(struct inode *inode, 271 int zonefs_file_truncate(struct inode *inode, loff_t isize);
282 272
283 /* In sysfs.c */ 273 /* In sysfs.c */
284 int zonefs_sysfs_register(struct super_block * 274 int zonefs_sysfs_register(struct super_block *sb);
285 void zonefs_sysfs_unregister(struct super_bloc 275 void zonefs_sysfs_unregister(struct super_block *sb);
286 int zonefs_sysfs_init(void); 276 int zonefs_sysfs_init(void);
287 void zonefs_sysfs_exit(void); 277 void zonefs_sysfs_exit(void);
288 278
289 #endif 279 #endif
290 280
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.