fs/adfs: dir: add more efficient iterate() per-format method
[linux-block.git] / fs / adfs / dir_f.c
CommitLineData
d2912cb1 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * linux/fs/adfs/dir_f.c
4 *
5 * Copyright (C) 1997-1999 Russell King
6 *
1da177e4
LT
7 * E and F format directory handling
8 */
1da177e4
LT
9#include "adfs.h"
10#include "dir_f.h"
11
1da177e4
LT
12/*
13 * Read an (unaligned) value of length 1..4 bytes
14 */
15static inline unsigned int adfs_readval(unsigned char *p, int len)
16{
17 unsigned int val = 0;
18
19 switch (len) {
20 case 4: val |= p[3] << 24;
74f79099 21 /* fall through */
1da177e4 22 case 3: val |= p[2] << 16;
74f79099 23 /* fall through */
1da177e4 24 case 2: val |= p[1] << 8;
74f79099 25 /* fall through */
1da177e4
LT
26 default: val |= p[0];
27 }
28 return val;
29}
30
31static inline void adfs_writeval(unsigned char *p, int len, unsigned int val)
32{
33 switch (len) {
34 case 4: p[3] = val >> 24;
74f79099 35 /* fall through */
1da177e4 36 case 3: p[2] = val >> 16;
74f79099 37 /* fall through */
1da177e4 38 case 2: p[1] = val >> 8;
74f79099 39 /* fall through */
1da177e4
LT
40 default: p[0] = val;
41 }
42}
43
1da177e4
LT
44#define ror13(v) ((v >> 13) | (v << 19))
45
46#define dir_u8(idx) \
47 ({ int _buf = idx >> blocksize_bits; \
48 int _off = idx - (_buf << blocksize_bits);\
49 *(u8 *)(bh[_buf]->b_data + _off); \
50 })
51
52#define dir_u32(idx) \
53 ({ int _buf = idx >> blocksize_bits; \
54 int _off = idx - (_buf << blocksize_bits);\
55 *(__le32 *)(bh[_buf]->b_data + _off); \
56 })
57
58#define bufoff(_bh,_idx) \
59 ({ int _buf = _idx >> blocksize_bits; \
60 int _off = _idx - (_buf << blocksize_bits);\
61 (u8 *)(_bh[_buf]->b_data + _off); \
62 })
63
64/*
65 * There are some algorithms that are nice in
66 * assembler, but a bitch in C... This is one
67 * of them.
68 */
69static u8
70adfs_dir_checkbyte(const struct adfs_dir *dir)
71{
72 struct buffer_head * const *bh = dir->bh;
73 const int blocksize_bits = dir->sb->s_blocksize_bits;
74 union { __le32 *ptr32; u8 *ptr8; } ptr, end;
75 u32 dircheck = 0;
76 int last = 5 - 26;
77 int i = 0;
78
79 /*
80 * Accumulate each word up to the last whole
81 * word of the last directory entry. This
82 * can spread across several buffer heads.
83 */
84 do {
85 last += 26;
86 do {
87 dircheck = le32_to_cpu(dir_u32(i)) ^ ror13(dircheck);
88
89 i += sizeof(u32);
90 } while (i < (last & ~3));
91 } while (dir_u8(last) != 0);
92
93 /*
94 * Accumulate the last few bytes. These
95 * bytes will be within the same bh.
96 */
97 if (i != last) {
98 ptr.ptr8 = bufoff(bh, i);
99 end.ptr8 = ptr.ptr8 + last - i;
100
e5949050 101 do {
1da177e4 102 dircheck = *ptr.ptr8++ ^ ror13(dircheck);
e5949050 103 } while (ptr.ptr8 < end.ptr8);
1da177e4
LT
104 }
105
106 /*
107 * The directory tail is in the final bh
108 * Note that contary to the RISC OS PRMs,
109 * the first few bytes are NOT included
110 * in the check. All bytes are in the
111 * same bh.
112 */
113 ptr.ptr8 = bufoff(bh, 2008);
114 end.ptr8 = ptr.ptr8 + 36;
115
116 do {
117 __le32 v = *ptr.ptr32++;
118 dircheck = le32_to_cpu(v) ^ ror13(dircheck);
119 } while (ptr.ptr32 < end.ptr32);
120
121 return (dircheck ^ (dircheck >> 8) ^ (dircheck >> 16) ^ (dircheck >> 24)) & 0xff;
122}
123
5ed70bb4
RK
124/* Read and check that a directory is valid */
125static int adfs_dir_read(struct super_block *sb, u32 indaddr,
126 unsigned int size, struct adfs_dir *dir)
1da177e4
LT
127{
128 const unsigned int blocksize_bits = sb->s_blocksize_bits;
419a6e5e 129 int ret;
1da177e4
LT
130
131 /*
132 * Directories which are not a multiple of 2048 bytes
133 * are considered bad v2 [3.6]
134 */
135 if (size & 2047)
136 goto bad_dir;
137
419a6e5e
RK
138 ret = adfs_dir_read_buffers(sb, indaddr, size, dir);
139 if (ret)
140 return ret;
1da177e4
LT
141
142 memcpy(&dir->dirhead, bufoff(dir->bh, 0), sizeof(dir->dirhead));
143 memcpy(&dir->dirtail, bufoff(dir->bh, 2007), sizeof(dir->dirtail));
144
145 if (dir->dirhead.startmasseq != dir->dirtail.new.endmasseq ||
146 memcmp(&dir->dirhead.startname, &dir->dirtail.new.endname, 4))
147 goto bad_dir;
148
149 if (memcmp(&dir->dirhead.startname, "Nick", 4) &&
150 memcmp(&dir->dirhead.startname, "Hugo", 4))
151 goto bad_dir;
152
153 if (adfs_dir_checkbyte(dir) != dir->dirtail.new.dircheckbyte)
154 goto bad_dir;
155
1da177e4
LT
156 return 0;
157
158bad_dir:
5ed70bb4 159 adfs_error(sb, "dir %06x is corrupted", indaddr);
1dd9f5ba 160 adfs_dir_relse(dir);
1da177e4
LT
161
162 return -EIO;
163}
164
165/*
166 * convert a disk-based directory entry to a Linux ADFS directory entry
167 */
168static inline void
da23ef05
SS
169adfs_dir2obj(struct adfs_dir *dir, struct object_info *obj,
170 struct adfs_direntry *de)
1da177e4 171{
adb514a4
RK
172 unsigned int name_len;
173
174 for (name_len = 0; name_len < ADFS_F_NAME_LEN; name_len++) {
175 if (de->dirobname[name_len] < ' ')
176 break;
177
178 obj->name[name_len] = de->dirobname[name_len];
179 }
180
181 obj->name_len = name_len;
5ed70bb4 182 obj->indaddr = adfs_readval(de->dirinddiscadd, 3);
1da177e4
LT
183 obj->loadaddr = adfs_readval(de->dirload, 4);
184 obj->execaddr = adfs_readval(de->direxec, 4);
185 obj->size = adfs_readval(de->dirlen, 4);
186 obj->attr = de->newdiratts;
da23ef05 187
411c49bc 188 adfs_object_fixup(dir, obj);
1da177e4
LT
189}
190
191/*
192 * convert a Linux ADFS directory entry to a disk-based directory entry
193 */
194static inline void
195adfs_obj2dir(struct adfs_direntry *de, struct object_info *obj)
196{
5ed70bb4 197 adfs_writeval(de->dirinddiscadd, 3, obj->indaddr);
1da177e4
LT
198 adfs_writeval(de->dirload, 4, obj->loadaddr);
199 adfs_writeval(de->direxec, 4, obj->execaddr);
200 adfs_writeval(de->dirlen, 4, obj->size);
201 de->newdiratts = obj->attr;
202}
203
204/*
205 * get a directory entry. Note that the caller is responsible
206 * for holding the relevant locks.
207 */
208static int
209__adfs_dir_get(struct adfs_dir *dir, int pos, struct object_info *obj)
210{
1da177e4 211 struct adfs_direntry de;
a317120b 212 int ret;
1da177e4 213
a317120b
RK
214 ret = adfs_dir_copyfrom(&de, dir, pos, 26);
215 if (ret)
216 return ret;
1da177e4
LT
217
218 if (!de.dirobname[0])
219 return -ENOENT;
220
da23ef05 221 adfs_dir2obj(dir, obj, &de);
1da177e4
LT
222
223 return 0;
224}
225
226static int
227__adfs_dir_put(struct adfs_dir *dir, int pos, struct object_info *obj)
228{
1da177e4 229 struct adfs_direntry de;
a317120b 230 int ret;
1da177e4 231
a317120b
RK
232 ret = adfs_dir_copyfrom(&de, dir, pos, 26);
233 if (ret)
234 return ret;
1da177e4 235
1da177e4
LT
236 adfs_obj2dir(&de, obj);
237
a317120b 238 return adfs_dir_copyto(dir, pos, &de, 26);
1da177e4
LT
239}
240
241/*
242 * the caller is responsible for holding the necessary
243 * locks.
244 */
5ed70bb4 245static int adfs_dir_find_entry(struct adfs_dir *dir, u32 indaddr)
1da177e4
LT
246{
247 int pos, ret;
248
249 ret = -ENOENT;
250
251 for (pos = 5; pos < ADFS_NUM_DIR_ENTRIES * 26 + 5; pos += 26) {
252 struct object_info obj;
253
254 if (!__adfs_dir_get(dir, pos, &obj))
255 break;
256
5ed70bb4 257 if (obj.indaddr == indaddr) {
1da177e4
LT
258 ret = pos;
259 break;
260 }
261 }
262
263 return ret;
264}
265
5ed70bb4
RK
266static int adfs_f_read(struct super_block *sb, u32 indaddr, unsigned int size,
267 struct adfs_dir *dir)
1da177e4
LT
268{
269 int ret;
270
5ed70bb4 271 if (size != ADFS_NEWDIR_SIZE)
1da177e4
LT
272 return -EIO;
273
5ed70bb4 274 ret = adfs_dir_read(sb, indaddr, size, dir);
1da177e4
LT
275 if (ret)
276 adfs_error(sb, "unable to read directory");
277 else
278 dir->parent_id = adfs_readval(dir->dirtail.new.dirparent, 3);
279
280 return ret;
281}
282
283static int
284adfs_f_setpos(struct adfs_dir *dir, unsigned int fpos)
285{
286 if (fpos >= ADFS_NUM_DIR_ENTRIES)
287 return -ENOENT;
288
289 dir->pos = 5 + fpos * 26;
290 return 0;
291}
292
293static int
294adfs_f_getnext(struct adfs_dir *dir, struct object_info *obj)
295{
296 unsigned int ret;
297
298 ret = __adfs_dir_get(dir, dir->pos, obj);
299 if (ret == 0)
300 dir->pos += 26;
301
302 return ret;
303}
304
4287e4de
RK
305static int adfs_f_iterate(struct adfs_dir *dir, struct dir_context *ctx)
306{
307 struct object_info obj;
308 int pos = 5 + (ctx->pos - 2) * 26;
309
310 while (ctx->pos < 2 + ADFS_NUM_DIR_ENTRIES) {
311 if (__adfs_dir_get(dir, pos, &obj))
312 break;
313 if (!dir_emit(ctx, obj.name, obj.name_len,
314 obj.indaddr, DT_UNKNOWN))
315 break;
316 pos += 26;
317 ctx->pos++;
318 }
319 return 0;
320}
321
1da177e4
LT
322static int
323adfs_f_update(struct adfs_dir *dir, struct object_info *obj)
324{
325 struct super_block *sb = dir->sb;
c3c8149b 326 int ret;
1da177e4 327
5ed70bb4 328 ret = adfs_dir_find_entry(dir, obj->indaddr);
1da177e4
LT
329 if (ret < 0) {
330 adfs_error(dir->sb, "unable to locate entry to update");
331 goto out;
332 }
333
334 __adfs_dir_put(dir, ret, obj);
335
336 /*
337 * Increment directory sequence number
338 */
339 dir->bh[0]->b_data[0] += 1;
340 dir->bh[dir->nr_buffers - 1]->b_data[sb->s_blocksize - 6] += 1;
341
342 ret = adfs_dir_checkbyte(dir);
343 /*
344 * Update directory check byte
345 */
346 dir->bh[dir->nr_buffers - 1]->b_data[sb->s_blocksize - 1] = ret;
347
348#if 1
349 {
350 const unsigned int blocksize_bits = sb->s_blocksize_bits;
351
352 memcpy(&dir->dirhead, bufoff(dir->bh, 0), sizeof(dir->dirhead));
353 memcpy(&dir->dirtail, bufoff(dir->bh, 2007), sizeof(dir->dirtail));
354
355 if (dir->dirhead.startmasseq != dir->dirtail.new.endmasseq ||
356 memcmp(&dir->dirhead.startname, &dir->dirtail.new.endname, 4))
357 goto bad_dir;
358
359 if (memcmp(&dir->dirhead.startname, "Nick", 4) &&
360 memcmp(&dir->dirhead.startname, "Hugo", 4))
361 goto bad_dir;
362
363 if (adfs_dir_checkbyte(dir) != dir->dirtail.new.dircheckbyte)
364 goto bad_dir;
365 }
366#endif
1da177e4
LT
367 ret = 0;
368out:
369 return ret;
370#if 1
371bad_dir:
372 adfs_error(dir->sb, "whoops! I broke a directory!");
373 return -EIO;
374#endif
375}
376
0125f504 377const struct adfs_dir_ops adfs_f_dir_ops = {
1da177e4 378 .read = adfs_f_read,
4287e4de 379 .iterate = adfs_f_iterate,
1da177e4
LT
380 .setpos = adfs_f_setpos,
381 .getnext = adfs_f_getnext,
382 .update = adfs_f_update,
1da177e4 383};