]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - fs/readdir.c
readdir.c: get compat_filldir() more or less in sync with filldir()
[mirror_ubuntu-hirsute-kernel.git] / fs / readdir.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
1da177e4
LT
2/*
3 * linux/fs/readdir.c
4 *
5 * Copyright (C) 1995 Linus Torvalds
6 */
7
85c9fe8f 8#include <linux/stddef.h>
022a1692 9#include <linux/kernel.h>
630d9c47 10#include <linux/export.h>
1da177e4
LT
11#include <linux/time.h>
12#include <linux/mm.h>
13#include <linux/errno.h>
14#include <linux/stat.h>
15#include <linux/file.h>
1da177e4 16#include <linux/fs.h>
d4c7cf6c 17#include <linux/fsnotify.h>
1da177e4
LT
18#include <linux/dirent.h>
19#include <linux/security.h>
20#include <linux/syscalls.h>
21#include <linux/unistd.h>
0460b2a2 22#include <linux/compat.h>
7c0f6ba6 23#include <linux/uaccess.h>
1da177e4 24
9f79b78e
LT
25#include <asm/unaligned.h>
26
27/*
28 * Note the "unsafe_put_user() semantics: we goto a
29 * label for errors.
9f79b78e
LT
30 */
31#define unsafe_copy_dirent_name(_dst, _src, _len, label) do { \
32 char __user *dst = (_dst); \
33 const char *src = (_src); \
34 size_t len = (_len); \
c512c691
LT
35 unsafe_put_user(0, dst+len, label); \
36 unsafe_copy_to_user(dst, src, len, label); \
9f79b78e
LT
37} while (0)
38
39
5c0ba4e0 40int iterate_dir(struct file *file, struct dir_context *ctx)
1da177e4 41{
496ad9aa 42 struct inode *inode = file_inode(file);
61922694 43 bool shared = false;
1da177e4 44 int res = -ENOTDIR;
61922694
AV
45 if (file->f_op->iterate_shared)
46 shared = true;
47 else if (!file->f_op->iterate)
1da177e4
LT
48 goto out;
49
50 res = security_file_permission(file, MAY_READ);
51 if (res)
52 goto out;
53
0dc208b5
KT
54 if (shared)
55 res = down_read_killable(&inode->i_rwsem);
56 else
00235411 57 res = down_write_killable(&inode->i_rwsem);
0dc208b5
KT
58 if (res)
59 goto out;
da784511 60
1da177e4
LT
61 res = -ENOENT;
62 if (!IS_DEADDIR(inode)) {
2233f31a 63 ctx->pos = file->f_pos;
61922694
AV
64 if (shared)
65 res = file->f_op->iterate_shared(file, ctx);
66 else
67 res = file->f_op->iterate(file, ctx);
2233f31a 68 file->f_pos = ctx->pos;
d4c7cf6c 69 fsnotify_access(file);
1da177e4
LT
70 file_accessed(file);
71 }
61922694
AV
72 if (shared)
73 inode_unlock_shared(inode);
74 else
75 inode_unlock(inode);
1da177e4
LT
76out:
77 return res;
78}
5c0ba4e0 79EXPORT_SYMBOL(iterate_dir);
1da177e4 80
8a23eb80
LT
81/*
82 * POSIX says that a dirent name cannot contain NULL or a '/'.
83 *
84 * It's not 100% clear what we should really do in this case.
85 * The filesystem is clearly corrupted, but returning a hard
86 * error means that you now don't see any of the other names
87 * either, so that isn't a perfect alternative.
88 *
89 * And if you return an error, what error do you use? Several
90 * filesystems seem to have decided on EUCLEAN being the error
91 * code for EFSCORRUPTED, and that may be the error to use. Or
92 * just EIO, which is perhaps more obvious to users.
93 *
94 * In order to see the other file names in the directory, the
95 * caller might want to make this a "soft" error: skip the
96 * entry, and return the error at the end instead.
97 *
98 * Note that this should likely do a "memchr(name, 0, len)"
99 * check too, since that would be filesystem corruption as
100 * well. However, that case can't actually confuse user space,
101 * which has to do a strlen() on the name anyway to find the
102 * filename length, and the above "soft error" worry means
103 * that it's probably better left alone until we have that
104 * issue clarified.
2c6b7bcd
LT
105 *
106 * Note the PATH_MAX check - it's arbitrary but the real
107 * kernel limit on a possible path component, not NAME_MAX,
108 * which is the technical standard limit.
8a23eb80
LT
109 */
110static int verify_dirent_name(const char *name, int len)
111{
2c6b7bcd 112 if (len <= 0 || len >= PATH_MAX)
8a23eb80 113 return -EIO;
b9959c7a 114 if (memchr(name, '/', len))
8a23eb80
LT
115 return -EIO;
116 return 0;
117}
118
1da177e4
LT
119/*
120 * Traditional linux readdir() handling..
121 *
122 * "count=1" is a special case, meaning that the buffer is one
123 * dirent-structure in size and that the code can't handle more
124 * anyway. Thus the special "fillonedir()" function for that
125 * case (the low-level handlers don't need to care about this).
126 */
1da177e4
LT
127
128#ifdef __ARCH_WANT_OLD_READDIR
129
130struct old_linux_dirent {
131 unsigned long d_ino;
132 unsigned long d_offset;
133 unsigned short d_namlen;
134 char d_name[1];
135};
136
137struct readdir_callback {
5c0ba4e0 138 struct dir_context ctx;
1da177e4
LT
139 struct old_linux_dirent __user * dirent;
140 int result;
141};
142
ac7576f4
MS
143static int fillonedir(struct dir_context *ctx, const char *name, int namlen,
144 loff_t offset, u64 ino, unsigned int d_type)
1da177e4 145{
ac7576f4
MS
146 struct readdir_callback *buf =
147 container_of(ctx, struct readdir_callback, ctx);
1da177e4 148 struct old_linux_dirent __user * dirent;
afefdbb2 149 unsigned long d_ino;
1da177e4
LT
150
151 if (buf->result)
152 return -EINVAL;
afefdbb2 153 d_ino = ino;
8f3f655d
AV
154 if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
155 buf->result = -EOVERFLOW;
afefdbb2 156 return -EOVERFLOW;
8f3f655d 157 }
1da177e4
LT
158 buf->result++;
159 dirent = buf->dirent;
391b7461 160 if (!user_write_access_begin(dirent,
1da177e4
LT
161 (unsigned long)(dirent->d_name + namlen + 1) -
162 (unsigned long)dirent))
163 goto efault;
391b7461
AV
164 unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
165 unsafe_put_user(offset, &dirent->d_offset, efault_end);
166 unsafe_put_user(namlen, &dirent->d_namlen, efault_end);
167 unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
168 user_write_access_end();
1da177e4 169 return 0;
391b7461
AV
170efault_end:
171 user_write_access_end();
1da177e4
LT
172efault:
173 buf->result = -EFAULT;
174 return -EFAULT;
175}
176
d4e82042
HC
177SYSCALL_DEFINE3(old_readdir, unsigned int, fd,
178 struct old_linux_dirent __user *, dirent, unsigned int, count)
1da177e4
LT
179{
180 int error;
63b6df14 181 struct fd f = fdget_pos(fd);
ac6614b7
AV
182 struct readdir_callback buf = {
183 .ctx.actor = fillonedir,
184 .dirent = dirent
185 };
1da177e4 186
2903ff01 187 if (!f.file)
863ced7f 188 return -EBADF;
1da177e4 189
5c0ba4e0 190 error = iterate_dir(f.file, &buf.ctx);
53c9c5c0 191 if (buf.result)
1da177e4
LT
192 error = buf.result;
193
63b6df14 194 fdput_pos(f);
1da177e4
LT
195 return error;
196}
197
198#endif /* __ARCH_WANT_OLD_READDIR */
199
200/*
201 * New, all-improved, singing, dancing, iBCS2-compliant getdents()
202 * interface.
203 */
204struct linux_dirent {
205 unsigned long d_ino;
206 unsigned long d_off;
207 unsigned short d_reclen;
208 char d_name[1];
209};
210
211struct getdents_callback {
5c0ba4e0 212 struct dir_context ctx;
1da177e4 213 struct linux_dirent __user * current_dir;
3c2659bd 214 int prev_reclen;
1da177e4
LT
215 int count;
216 int error;
217};
218
ac7576f4
MS
219static int filldir(struct dir_context *ctx, const char *name, int namlen,
220 loff_t offset, u64 ino, unsigned int d_type)
1da177e4 221{
3c2659bd 222 struct linux_dirent __user *dirent, *prev;
ac7576f4
MS
223 struct getdents_callback *buf =
224 container_of(ctx, struct getdents_callback, ctx);
afefdbb2 225 unsigned long d_ino;
85c9fe8f
KW
226 int reclen = ALIGN(offsetof(struct linux_dirent, d_name) + namlen + 2,
227 sizeof(long));
3c2659bd 228 int prev_reclen;
1da177e4 229
8a23eb80
LT
230 buf->error = verify_dirent_name(name, namlen);
231 if (unlikely(buf->error))
232 return buf->error;
1da177e4
LT
233 buf->error = -EINVAL; /* only used if we fail.. */
234 if (reclen > buf->count)
235 return -EINVAL;
afefdbb2 236 d_ino = ino;
8f3f655d
AV
237 if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
238 buf->error = -EOVERFLOW;
afefdbb2 239 return -EOVERFLOW;
8f3f655d 240 }
3c2659bd
LT
241 prev_reclen = buf->prev_reclen;
242 if (prev_reclen && signal_pending(current))
9f79b78e 243 return -EINTR;
9f79b78e 244 dirent = buf->current_dir;
3c2659bd 245 prev = (void __user *) dirent - prev_reclen;
41cd7805 246 if (!user_write_access_begin(prev, reclen + prev_reclen))
3c2659bd
LT
247 goto efault;
248
249 /* This might be 'dirent->d_off', but if so it will get overwritten */
250 unsafe_put_user(offset, &prev->d_off, efault_end);
9f79b78e
LT
251 unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
252 unsafe_put_user(reclen, &dirent->d_reclen, efault_end);
253 unsafe_put_user(d_type, (char __user *) dirent + reclen - 1, efault_end);
254 unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
41cd7805 255 user_write_access_end();
9f79b78e 256
3c2659bd
LT
257 buf->current_dir = (void __user *)dirent + reclen;
258 buf->prev_reclen = reclen;
1da177e4
LT
259 buf->count -= reclen;
260 return 0;
9f79b78e 261efault_end:
41cd7805 262 user_write_access_end();
1da177e4
LT
263efault:
264 buf->error = -EFAULT;
265 return -EFAULT;
266}
267
20f37034
HC
268SYSCALL_DEFINE3(getdents, unsigned int, fd,
269 struct linux_dirent __user *, dirent, unsigned int, count)
1da177e4 270{
2903ff01 271 struct fd f;
ac6614b7
AV
272 struct getdents_callback buf = {
273 .ctx.actor = filldir,
274 .count = count,
275 .current_dir = dirent
276 };
1da177e4
LT
277 int error;
278
96d4f267 279 if (!access_ok(dirent, count))
863ced7f 280 return -EFAULT;
1da177e4 281
63b6df14 282 f = fdget_pos(fd);
2903ff01 283 if (!f.file)
863ced7f 284 return -EBADF;
1da177e4 285
5c0ba4e0 286 error = iterate_dir(f.file, &buf.ctx);
53c9c5c0
AV
287 if (error >= 0)
288 error = buf.error;
3c2659bd
LT
289 if (buf.prev_reclen) {
290 struct linux_dirent __user * lastdirent;
291 lastdirent = (void __user *)buf.current_dir - buf.prev_reclen;
292
bb6f619b 293 if (put_user(buf.ctx.pos, &lastdirent->d_off))
1da177e4
LT
294 error = -EFAULT;
295 else
296 error = count - buf.count;
297 }
63b6df14 298 fdput_pos(f);
1da177e4
LT
299 return error;
300}
301
1da177e4 302struct getdents_callback64 {
5c0ba4e0 303 struct dir_context ctx;
1da177e4 304 struct linux_dirent64 __user * current_dir;
3c2659bd 305 int prev_reclen;
1da177e4
LT
306 int count;
307 int error;
308};
309
ac7576f4
MS
310static int filldir64(struct dir_context *ctx, const char *name, int namlen,
311 loff_t offset, u64 ino, unsigned int d_type)
1da177e4 312{
3c2659bd 313 struct linux_dirent64 __user *dirent, *prev;
ac7576f4
MS
314 struct getdents_callback64 *buf =
315 container_of(ctx, struct getdents_callback64, ctx);
85c9fe8f
KW
316 int reclen = ALIGN(offsetof(struct linux_dirent64, d_name) + namlen + 1,
317 sizeof(u64));
3c2659bd 318 int prev_reclen;
1da177e4 319
8a23eb80
LT
320 buf->error = verify_dirent_name(name, namlen);
321 if (unlikely(buf->error))
322 return buf->error;
1da177e4
LT
323 buf->error = -EINVAL; /* only used if we fail.. */
324 if (reclen > buf->count)
325 return -EINVAL;
3c2659bd
LT
326 prev_reclen = buf->prev_reclen;
327 if (prev_reclen && signal_pending(current))
9f79b78e 328 return -EINTR;
9f79b78e 329 dirent = buf->current_dir;
3c2659bd 330 prev = (void __user *)dirent - prev_reclen;
41cd7805 331 if (!user_write_access_begin(prev, reclen + prev_reclen))
3c2659bd
LT
332 goto efault;
333
334 /* This might be 'dirent->d_off', but if so it will get overwritten */
335 unsafe_put_user(offset, &prev->d_off, efault_end);
9f79b78e
LT
336 unsafe_put_user(ino, &dirent->d_ino, efault_end);
337 unsafe_put_user(reclen, &dirent->d_reclen, efault_end);
338 unsafe_put_user(d_type, &dirent->d_type, efault_end);
339 unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
41cd7805 340 user_write_access_end();
9f79b78e 341
3c2659bd
LT
342 buf->prev_reclen = reclen;
343 buf->current_dir = (void __user *)dirent + reclen;
1da177e4
LT
344 buf->count -= reclen;
345 return 0;
3c2659bd 346
9f79b78e 347efault_end:
41cd7805 348 user_write_access_end();
1da177e4
LT
349efault:
350 buf->error = -EFAULT;
351 return -EFAULT;
352}
353
454dab3f
DB
354int ksys_getdents64(unsigned int fd, struct linux_dirent64 __user *dirent,
355 unsigned int count)
1da177e4 356{
2903ff01 357 struct fd f;
ac6614b7
AV
358 struct getdents_callback64 buf = {
359 .ctx.actor = filldir64,
360 .count = count,
361 .current_dir = dirent
362 };
1da177e4
LT
363 int error;
364
96d4f267 365 if (!access_ok(dirent, count))
863ced7f 366 return -EFAULT;
1da177e4 367
63b6df14 368 f = fdget_pos(fd);
2903ff01 369 if (!f.file)
863ced7f 370 return -EBADF;
1da177e4 371
5c0ba4e0 372 error = iterate_dir(f.file, &buf.ctx);
53c9c5c0
AV
373 if (error >= 0)
374 error = buf.error;
3c2659bd
LT
375 if (buf.prev_reclen) {
376 struct linux_dirent64 __user * lastdirent;
bb6f619b 377 typeof(lastdirent->d_off) d_off = buf.ctx.pos;
3c2659bd
LT
378
379 lastdirent = (void __user *) buf.current_dir - buf.prev_reclen;
1da177e4 380 if (__put_user(d_off, &lastdirent->d_off))
53c9c5c0
AV
381 error = -EFAULT;
382 else
383 error = count - buf.count;
1da177e4 384 }
63b6df14 385 fdput_pos(f);
1da177e4
LT
386 return error;
387}
0460b2a2 388
454dab3f
DB
389
390SYSCALL_DEFINE3(getdents64, unsigned int, fd,
391 struct linux_dirent64 __user *, dirent, unsigned int, count)
392{
393 return ksys_getdents64(fd, dirent, count);
394}
395
0460b2a2
AV
396#ifdef CONFIG_COMPAT
397struct compat_old_linux_dirent {
398 compat_ulong_t d_ino;
399 compat_ulong_t d_offset;
400 unsigned short d_namlen;
401 char d_name[1];
402};
403
404struct compat_readdir_callback {
405 struct dir_context ctx;
406 struct compat_old_linux_dirent __user *dirent;
407 int result;
408};
409
410static int compat_fillonedir(struct dir_context *ctx, const char *name,
411 int namlen, loff_t offset, u64 ino,
412 unsigned int d_type)
413{
414 struct compat_readdir_callback *buf =
415 container_of(ctx, struct compat_readdir_callback, ctx);
416 struct compat_old_linux_dirent __user *dirent;
417 compat_ulong_t d_ino;
418
419 if (buf->result)
420 return -EINVAL;
421 d_ino = ino;
422 if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
423 buf->result = -EOVERFLOW;
424 return -EOVERFLOW;
425 }
426 buf->result++;
427 dirent = buf->dirent;
391b7461 428 if (!user_write_access_begin(dirent,
0460b2a2
AV
429 (unsigned long)(dirent->d_name + namlen + 1) -
430 (unsigned long)dirent))
431 goto efault;
391b7461
AV
432 unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
433 unsafe_put_user(offset, &dirent->d_offset, efault_end);
434 unsafe_put_user(namlen, &dirent->d_namlen, efault_end);
435 unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
436 user_write_access_end();
0460b2a2 437 return 0;
391b7461
AV
438efault_end:
439 user_write_access_end();
0460b2a2
AV
440efault:
441 buf->result = -EFAULT;
442 return -EFAULT;
443}
444
445COMPAT_SYSCALL_DEFINE3(old_readdir, unsigned int, fd,
446 struct compat_old_linux_dirent __user *, dirent, unsigned int, count)
447{
448 int error;
449 struct fd f = fdget_pos(fd);
450 struct compat_readdir_callback buf = {
451 .ctx.actor = compat_fillonedir,
452 .dirent = dirent
453 };
454
455 if (!f.file)
456 return -EBADF;
457
458 error = iterate_dir(f.file, &buf.ctx);
459 if (buf.result)
460 error = buf.result;
461
462 fdput_pos(f);
463 return error;
464}
465
466struct compat_linux_dirent {
467 compat_ulong_t d_ino;
468 compat_ulong_t d_off;
469 unsigned short d_reclen;
470 char d_name[1];
471};
472
473struct compat_getdents_callback {
474 struct dir_context ctx;
475 struct compat_linux_dirent __user *current_dir;
82af599b 476 int prev_reclen;
0460b2a2
AV
477 int count;
478 int error;
479};
480
481static int compat_filldir(struct dir_context *ctx, const char *name, int namlen,
482 loff_t offset, u64 ino, unsigned int d_type)
483{
82af599b 484 struct compat_linux_dirent __user *dirent, *prev;
0460b2a2
AV
485 struct compat_getdents_callback *buf =
486 container_of(ctx, struct compat_getdents_callback, ctx);
487 compat_ulong_t d_ino;
488 int reclen = ALIGN(offsetof(struct compat_linux_dirent, d_name) +
489 namlen + 2, sizeof(compat_long_t));
82af599b 490 int prev_reclen;
0460b2a2 491
82af599b
AV
492 buf->error = verify_dirent_name(name, namlen);
493 if (unlikely(buf->error))
494 return buf->error;
0460b2a2
AV
495 buf->error = -EINVAL; /* only used if we fail.. */
496 if (reclen > buf->count)
497 return -EINVAL;
498 d_ino = ino;
499 if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
500 buf->error = -EOVERFLOW;
501 return -EOVERFLOW;
502 }
82af599b
AV
503 prev_reclen = buf->prev_reclen;
504 if (prev_reclen && signal_pending(current))
505 return -EINTR;
0460b2a2 506 dirent = buf->current_dir;
82af599b
AV
507 prev = (void __user *) dirent - prev_reclen;
508 if (!user_write_access_begin(prev, reclen + prev_reclen))
0460b2a2 509 goto efault;
82af599b
AV
510
511 unsafe_put_user(offset, &prev->d_off, efault_end);
512 unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
513 unsafe_put_user(reclen, &dirent->d_reclen, efault_end);
514 unsafe_put_user(d_type, (char __user *) dirent + reclen - 1, efault_end);
515 unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
516 user_write_access_end();
517
518 buf->prev_reclen = reclen;
519 buf->current_dir = (void __user *)dirent + reclen;
0460b2a2
AV
520 buf->count -= reclen;
521 return 0;
82af599b
AV
522efault_end:
523 user_write_access_end();
0460b2a2
AV
524efault:
525 buf->error = -EFAULT;
526 return -EFAULT;
527}
528
529COMPAT_SYSCALL_DEFINE3(getdents, unsigned int, fd,
530 struct compat_linux_dirent __user *, dirent, unsigned int, count)
531{
532 struct fd f;
0460b2a2
AV
533 struct compat_getdents_callback buf = {
534 .ctx.actor = compat_filldir,
535 .current_dir = dirent,
536 .count = count
537 };
538 int error;
539
96d4f267 540 if (!access_ok(dirent, count))
0460b2a2
AV
541 return -EFAULT;
542
543 f = fdget_pos(fd);
544 if (!f.file)
545 return -EBADF;
546
547 error = iterate_dir(f.file, &buf.ctx);
548 if (error >= 0)
549 error = buf.error;
82af599b
AV
550 if (buf.prev_reclen) {
551 struct compat_linux_dirent __user * lastdirent;
552 lastdirent = (void __user *)buf.current_dir - buf.prev_reclen;
553
0460b2a2
AV
554 if (put_user(buf.ctx.pos, &lastdirent->d_off))
555 error = -EFAULT;
556 else
557 error = count - buf.count;
558 }
559 fdput_pos(f);
560 return error;
561}
562#endif