[linux-block.git] / fs / readdir.c

// SPDX-License-Identifier: GPL-2.0
/*
 *  linux/fs/readdir.c
 *
 *  Copyright (C) 1995  Linus Torvalds
 */

#include <linux/stddef.h>
#include <linux/kernel.h>
#include <linux/export.h>
#include <linux/time.h>
#include <linux/mm.h>
#include <linux/errno.h>
#include <linux/stat.h>
#include <linux/file.h>
#include <linux/fs.h>
#include <linux/fsnotify.h>
#include <linux/dirent.h>
#include <linux/security.h>
#include <linux/syscalls.h>
#include <linux/unistd.h>
#include <linux/compat.h>
#include <linux/uaccess.h>

#include <asm/unaligned.h>

/*
 * Note the "unsafe_put_user() semantics: we goto a
 * label for errors.
 */
#define unsafe_copy_dirent_name(_dst, _src, _len, label) do {	\
	char __user *dst = (_dst);				\
	const char *src = (_src);				\
	size_t len = (_len);					\
	unsafe_put_user(0, dst+len, label);			\
	unsafe_copy_to_user(dst, src, len, label);		\
} while (0)


int iterate_dir(struct file *file, struct dir_context *ctx)
{
	struct inode *inode = file_inode(file);
	bool shared = false;
	int res = -ENOTDIR;
	if (file->f_op->iterate_shared)
		shared = true;
	else if (!file->f_op->iterate)
		goto out;

	res = security_file_permission(file, MAY_READ);
	if (res)
		goto out;

	if (shared)
		res = down_read_killable(&inode->i_rwsem);
	else
		res = down_write_killable(&inode->i_rwsem);
	if (res)
		goto out;

	res = -ENOENT;
	if (!IS_DEADDIR(inode)) {
		ctx->pos = file->f_pos;
		if (shared)
			res = file->f_op->iterate_shared(file, ctx);
		else
			res = file->f_op->iterate(file, ctx);
		file->f_pos = ctx->pos;
		fsnotify_access(file);
		file_accessed(file);
	}
	if (shared)
		inode_unlock_shared(inode);
	else
		inode_unlock(inode);
out:
	return res;
}
EXPORT_SYMBOL(iterate_dir);

/*
 * POSIX says that a dirent name cannot contain NULL or a '/'.
 *
 * It's not 100% clear what we should really do in this case.
 * The filesystem is clearly corrupted, but returning a hard
 * error means that you now don't see any of the other names
 * either, so that isn't a perfect alternative.
 *
 * And if you return an error, what error do you use? Several
 * filesystems seem to have decided on EUCLEAN being the error
 * code for EFSCORRUPTED, and that may be the error to use. Or
 * just EIO, which is perhaps more obvious to users.
 *
 * In order to see the other file names in the directory, the
 * caller might want to make this a "soft" error: skip the
 * entry, and return the error at the end instead.
 *
 * Note that this should likely do a "memchr(name, 0, len)"
 * check too, since that would be filesystem corruption as
 * well. However, that case can't actually confuse user space,
 * which has to do a strlen() on the name anyway to find the
 * filename length, and the above "soft error" worry means
 * that it's probably better left alone until we have that
 * issue clarified.
 *
 * Note the PATH_MAX check - it's arbitrary but the real
 * kernel limit on a possible path component, not NAME_MAX,
 * which is the technical standard limit.
 */
static int verify_dirent_name(const char *name, int len)
{
	if (len <= 0 || len >= PATH_MAX)
		return -EIO;
	if (memchr(name, '/', len))
		return -EIO;
	return 0;
}

/*
 * Traditional linux readdir() handling..
 *
 * "count=1" is a special case, meaning that the buffer is one
 * dirent-structure in size and that the code can't handle more
 * anyway. Thus the special "fillonedir()" function for that
 * case (the low-level handlers don't need to care about this).
 */

#ifdef __ARCH_WANT_OLD_READDIR

struct old_linux_dirent {
	unsigned long	d_ino;
	unsigned long	d_offset;
	unsigned short	d_namlen;
	char		d_name[1];
};

struct readdir_callback {
	struct dir_context ctx;
	struct old_linux_dirent __user * dirent;
	int result;
};

static int fillonedir(struct dir_context *ctx, const char *name, int namlen,
		      loff_t offset, u64 ino, unsigned int d_type)
{
	struct readdir_callback *buf =
		container_of(ctx, struct readdir_callback, ctx);
	struct old_linux_dirent __user * dirent;
	unsigned long d_ino;

	if (buf->result)
		return -EINVAL;
	d_ino = ino;
	if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
		buf->result = -EOVERFLOW;
		return -EOVERFLOW;
	}
	buf->result++;
	dirent = buf->dirent;
	if (!user_write_access_begin(dirent,
			(unsigned long)(dirent->d_name + namlen + 1) -
				(unsigned long)dirent))
		goto efault;
	unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
	unsafe_put_user(offset, &dirent->d_offset, efault_end);
	unsafe_put_user(namlen, &dirent->d_namlen, efault_end);
	unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
	user_write_access_end();
	return 0;
efault_end:
	user_write_access_end();
efault:
	buf->result = -EFAULT;
	return -EFAULT;
}

SYSCALL_DEFINE3(old_readdir, unsigned int, fd,
		struct old_linux_dirent __user *, dirent, unsigned int, count)
{
	int error;
	struct fd f = fdget_pos(fd);
	struct readdir_callback buf = {
		.ctx.actor = fillonedir,
		.dirent = dirent
	};

	if (!f.file)
		return -EBADF;

	error = iterate_dir(f.file, &buf.ctx);
	if (buf.result)
		error = buf.result;

	fdput_pos(f);
	return error;
}

#endif /* __ARCH_WANT_OLD_READDIR */

/*
 * New, all-improved, singing, dancing, iBCS2-compliant getdents()
 * interface. 
 */
struct linux_dirent {
	unsigned long	d_ino;
	unsigned long	d_off;
	unsigned short	d_reclen;
	char		d_name[1];
};

struct getdents_callback {
	struct dir_context ctx;
	struct linux_dirent __user * current_dir;
	int prev_reclen;
	int count;
	int error;
};

static int filldir(struct dir_context *ctx, const char *name, int namlen,
		   loff_t offset, u64 ino, unsigned int d_type)
{
	struct linux_dirent __user *dirent, *prev;
	struct getdents_callback *buf =
		container_of(ctx, struct getdents_callback, ctx);
	unsigned long d_ino;
	int reclen = ALIGN(offsetof(struct linux_dirent, d_name) + namlen + 2,
		sizeof(long));
	int prev_reclen;

	buf->error = verify_dirent_name(name, namlen);
	if (unlikely(buf->error))
		return buf->error;
	buf->error = -EINVAL;	/* only used if we fail.. */
	if (reclen > buf->count)
		return -EINVAL;
	d_ino = ino;
	if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
		buf->error = -EOVERFLOW;
		return -EOVERFLOW;
	}
	prev_reclen = buf->prev_reclen;
	if (prev_reclen && signal_pending(current))
		return -EINTR;
	dirent = buf->current_dir;
	prev = (void __user *) dirent - prev_reclen;
	if (!user_write_access_begin(prev, reclen + prev_reclen))
		goto efault;

	/* This might be 'dirent->d_off', but if so it will get overwritten */
	unsafe_put_user(offset, &prev->d_off, efault_end);
	unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
	unsafe_put_user(reclen, &dirent->d_reclen, efault_end);
	unsafe_put_user(d_type, (char __user *) dirent + reclen - 1, efault_end);
	unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
	user_write_access_end();

	buf->current_dir = (void __user *)dirent + reclen;
	buf->prev_reclen = reclen;
	buf->count -= reclen;
	return 0;
efault_end:
	user_write_access_end();
efault:
	buf->error = -EFAULT;
	return -EFAULT;
}

SYSCALL_DEFINE3(getdents, unsigned int, fd,
		struct linux_dirent __user *, dirent, unsigned int, count)
{
	struct fd f;
	struct getdents_callback buf = {
		.ctx.actor = filldir,
		.count = count,
		.current_dir = dirent
	};
	int error;

	f = fdget_pos(fd);
	if (!f.file)
		return -EBADF;

	error = iterate_dir(f.file, &buf.ctx);
	if (error >= 0)
		error = buf.error;
	if (buf.prev_reclen) {
		struct linux_dirent __user * lastdirent;
		lastdirent = (void __user *)buf.current_dir - buf.prev_reclen;

		if (put_user(buf.ctx.pos, &lastdirent->d_off))
			error = -EFAULT;
		else
			error = count - buf.count;
	}
	fdput_pos(f);
	return error;
}

struct getdents_callback64 {
	struct dir_context ctx;
	struct linux_dirent64 __user * current_dir;
	int prev_reclen;
	int count;
	int error;
};

static int filldir64(struct dir_context *ctx, const char *name, int namlen,
		     loff_t offset, u64 ino, unsigned int d_type)
{
	struct linux_dirent64 __user *dirent, *prev;
	struct getdents_callback64 *buf =
		container_of(ctx, struct getdents_callback64, ctx);
	int reclen = ALIGN(offsetof(struct linux_dirent64, d_name) + namlen + 1,
		sizeof(u64));
	int prev_reclen;

	buf->error = verify_dirent_name(name, namlen);
	if (unlikely(buf->error))
		return buf->error;
	buf->error = -EINVAL;	/* only used if we fail.. */
	if (reclen > buf->count)
		return -EINVAL;
	prev_reclen = buf->prev_reclen;
	if (prev_reclen && signal_pending(current))
		return -EINTR;
	dirent = buf->current_dir;
	prev = (void __user *)dirent - prev_reclen;
	if (!user_write_access_begin(prev, reclen + prev_reclen))
		goto efault;

	/* This might be 'dirent->d_off', but if so it will get overwritten */
	unsafe_put_user(offset, &prev->d_off, efault_end);
	unsafe_put_user(ino, &dirent->d_ino, efault_end);
	unsafe_put_user(reclen, &dirent->d_reclen, efault_end);
	unsafe_put_user(d_type, &dirent->d_type, efault_end);
	unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
	user_write_access_end();

	buf->prev_reclen = reclen;
	buf->current_dir = (void __user *)dirent + reclen;
	buf->count -= reclen;
	return 0;

efault_end:
	user_write_access_end();
efault:
	buf->error = -EFAULT;
	return -EFAULT;
}

int ksys_getdents64(unsigned int fd, struct linux_dirent64 __user *dirent,
		    unsigned int count)
{
	struct fd f;
	struct getdents_callback64 buf = {
		.ctx.actor = filldir64,
		.count = count,
		.current_dir = dirent
	};
	int error;

	f = fdget_pos(fd);
	if (!f.file)
		return -EBADF;

	error = iterate_dir(f.file, &buf.ctx);
	if (error >= 0)
		error = buf.error;
	if (buf.prev_reclen) {
		struct linux_dirent64 __user * lastdirent;
		typeof(lastdirent->d_off) d_off = buf.ctx.pos;

		lastdirent = (void __user *) buf.current_dir - buf.prev_reclen;
		if (put_user(d_off, &lastdirent->d_off))
			error = -EFAULT;
		else
			error = count - buf.count;
	}
	fdput_pos(f);
	return error;
}


SYSCALL_DEFINE3(getdents64, unsigned int, fd,
		struct linux_dirent64 __user *, dirent, unsigned int, count)
{
	return ksys_getdents64(fd, dirent, count);
}

#ifdef CONFIG_COMPAT
struct compat_old_linux_dirent {
	compat_ulong_t	d_ino;
	compat_ulong_t	d_offset;
	unsigned short	d_namlen;
	char		d_name[1];
};

struct compat_readdir_callback {
	struct dir_context ctx;
	struct compat_old_linux_dirent __user *dirent;
	int result;
};

static int compat_fillonedir(struct dir_context *ctx, const char *name,
			     int namlen, loff_t offset, u64 ino,
			     unsigned int d_type)
{
	struct compat_readdir_callback *buf =
		container_of(ctx, struct compat_readdir_callback, ctx);
	struct compat_old_linux_dirent __user *dirent;
	compat_ulong_t d_ino;

	if (buf->result)
		return -EINVAL;
	d_ino = ino;
	if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
		buf->result = -EOVERFLOW;
		return -EOVERFLOW;
	}
	buf->result++;
	dirent = buf->dirent;
	if (!user_write_access_begin(dirent,
			(unsigned long)(dirent->d_name + namlen + 1) -
				(unsigned long)dirent))
		goto efault;
	unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
	unsafe_put_user(offset, &dirent->d_offset, efault_end);
	unsafe_put_user(namlen, &dirent->d_namlen, efault_end);
	unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
	user_write_access_end();
	return 0;
efault_end:
	user_write_access_end();
efault:
	buf->result = -EFAULT;
	return -EFAULT;
}

COMPAT_SYSCALL_DEFINE3(old_readdir, unsigned int, fd,
		struct compat_old_linux_dirent __user *, dirent, unsigned int, count)
{
	int error;
	struct fd f = fdget_pos(fd);
	struct compat_readdir_callback buf = {
		.ctx.actor = compat_fillonedir,
		.dirent = dirent
	};

	if (!f.file)
		return -EBADF;

	error = iterate_dir(f.file, &buf.ctx);
	if (buf.result)
		error = buf.result;

	fdput_pos(f);
	return error;
}

struct compat_linux_dirent {
	compat_ulong_t	d_ino;
	compat_ulong_t	d_off;
	unsigned short	d_reclen;
	char		d_name[1];
};

struct compat_getdents_callback {
	struct dir_context ctx;
	struct compat_linux_dirent __user *current_dir;
	int prev_reclen;
	int count;
	int error;
};

static int compat_filldir(struct dir_context *ctx, const char *name, int namlen,
		loff_t offset, u64 ino, unsigned int d_type)
{
	struct compat_linux_dirent __user *dirent, *prev;
	struct compat_getdents_callback *buf =
		container_of(ctx, struct compat_getdents_callback, ctx);
	compat_ulong_t d_ino;
	int reclen = ALIGN(offsetof(struct compat_linux_dirent, d_name) +
		namlen + 2, sizeof(compat_long_t));
	int prev_reclen;

	buf->error = verify_dirent_name(name, namlen);
	if (unlikely(buf->error))
		return buf->error;
	buf->error = -EINVAL;	/* only used if we fail.. */
	if (reclen > buf->count)
		return -EINVAL;
	d_ino = ino;
	if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
		buf->error = -EOVERFLOW;
		return -EOVERFLOW;
	}
	prev_reclen = buf->prev_reclen;
	if (prev_reclen && signal_pending(current))
		return -EINTR;
	dirent = buf->current_dir;
	prev = (void __user *) dirent - prev_reclen;
	if (!user_write_access_begin(prev, reclen + prev_reclen))
		goto efault;

	unsafe_put_user(offset, &prev->d_off, efault_end);
	unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
	unsafe_put_user(reclen, &dirent->d_reclen, efault_end);
	unsafe_put_user(d_type, (char __user *) dirent + reclen - 1, efault_end);
	unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
	user_write_access_end();

	buf->prev_reclen = reclen;
	buf->current_dir = (void __user *)dirent + reclen;
	buf->count -= reclen;
	return 0;
efault_end:
	user_write_access_end();
efault:
	buf->error = -EFAULT;
	return -EFAULT;
}

COMPAT_SYSCALL_DEFINE3(getdents, unsigned int, fd,
		struct compat_linux_dirent __user *, dirent, unsigned int, count)
{
	struct fd f;
	struct compat_getdents_callback buf = {
		.ctx.actor = compat_filldir,
		.current_dir = dirent,
		.count = count
	};
	int error;

	f = fdget_pos(fd);
	if (!f.file)
		return -EBADF;

	error = iterate_dir(f.file, &buf.ctx);
	if (error >= 0)
		error = buf.error;
	if (buf.prev_reclen) {
		struct compat_linux_dirent __user * lastdirent;
		lastdirent = (void __user *)buf.current_dir - buf.prev_reclen;

		if (put_user(buf.ctx.pos, &lastdirent->d_off))
			error = -EFAULT;
		else
			error = count - buf.count;
	}
	fdput_pos(f);
	return error;
}
#endif
Commit	Line	Data
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); \
c512c691 LT	36	unsafe_copy_to_user(dst, src, len, label); \
9f79b78e LT	37	} while (0)
	38
	39
5c0ba4e0	40	int 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)
0dc208b5 KT	59	goto out;
da784511	60
1da177e4 LT	61	res = -ENOENT;
1da177e4 LT	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);
1da177e4 LT	71	}
61922694 AV	72	if (shared)
	73	inode_unlock_shared(inode);
	74	else
	75	inode_unlock(inode);
1da177e4 LT	76	out:
	77	return res;
	78	}
5c0ba4e0	79	EXPORT_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	*/
	110	static 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
	130	struct 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
	137	struct readdir_callback {
5c0ba4e0	138	struct dir_context ctx;
1da177e4 LT	139	struct old_linux_dirent __user * dirent;
	140	int result;
	141	};
	142
ac7576f4 MS	143	static int fillonedir(struct dir_context ctx, const char name, int namlen,
ac7576f4 MS	144	loff_t offset, u64 ino, unsigned int d_type)
1da177e4	145	{
ac7576f4 MS	146	struct readdir_callback *buf =
ac7576f4 MS	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) {
8f3f655d AV	155	buf->result = -EOVERFLOW;
afefdbb2	156	return -EOVERFLOW;
8f3f655d	157	}
1da177e4 LT	158	buf->result++;
1da177e4 LT	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	170	efault_end:
391b7461 AV	171	user_write_access_end();
1da177e4 LT	172	efault:
	173	buf->result = -EFAULT;
	174	return -EFAULT;
	175	}
	176
d4e82042 HC	177	SYSCALL_DEFINE3(old_readdir, unsigned int, fd,
d4e82042 HC	178	struct old_linux_dirent __user *, dirent, unsigned int, count)
1da177e4 LT	179	{
1da177e4 LT	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;
1da177e4 LT	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	*/
	204	struct linux_dirent {
	205	unsigned long d_ino;
	206	unsigned long d_off;
	207	unsigned short d_reclen;
	208	char d_name[1];
	209	};
	210
	211	struct 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	219	static int filldir(struct dir_context ctx, const char name, int namlen,
ac7576f4 MS	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 =
ac7576f4 MS	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,
85c9fe8f KW	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) {
8f3f655d AV	238	buf->error = -EOVERFLOW;
afefdbb2	239	return -EOVERFLOW;
8f3f655d	240	}
3c2659bd LT	241	prev_reclen = buf->prev_reclen;
3c2659bd LT	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;
3c2659bd LT	258	buf->prev_reclen = reclen;
1da177e4 LT	259	buf->count -= reclen;
1da177e4 LT	260	return 0;
9f79b78e	261	efault_end:
41cd7805	262	user_write_access_end();
1da177e4 LT	263	efault:
	264	buf->error = -EFAULT;
	265	return -EFAULT;
	266	}
	267
20f37034 HC	268	SYSCALL_DEFINE3(getdents, unsigned int, fd,
20f37034 HC	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;
1da177e4 LT	278
63b6df14	279	f = fdget_pos(fd);
2903ff01	280	if (!f.file)
863ced7f	281	return -EBADF;
1da177e4	282
5c0ba4e0	283	error = iterate_dir(f.file, &buf.ctx);
53c9c5c0 AV	284	if (error >= 0)
53c9c5c0 AV	285	error = buf.error;
3c2659bd LT	286	if (buf.prev_reclen) {
	287	struct linux_dirent __user * lastdirent;
	288	lastdirent = (void __user *)buf.current_dir - buf.prev_reclen;
	289
bb6f619b	290	if (put_user(buf.ctx.pos, &lastdirent->d_off))
1da177e4 LT	291	error = -EFAULT;
	292	else
	293	error = count - buf.count;
	294	}
63b6df14	295	fdput_pos(f);
1da177e4 LT	296	return error;
	297	}
	298
1da177e4	299	struct getdents_callback64 {
5c0ba4e0	300	struct dir_context ctx;
1da177e4	301	struct linux_dirent64 __user * current_dir;
3c2659bd	302	int prev_reclen;
1da177e4 LT	303	int count;
	304	int error;
	305	};
	306
ac7576f4 MS	307	static int filldir64(struct dir_context ctx, const char name, int namlen,
ac7576f4 MS	308	loff_t offset, u64 ino, unsigned int d_type)
1da177e4	309	{
3c2659bd	310	struct linux_dirent64 __user dirent, prev;
ac7576f4 MS	311	struct getdents_callback64 *buf =
ac7576f4 MS	312	container_of(ctx, struct getdents_callback64, ctx);
85c9fe8f KW	313	int reclen = ALIGN(offsetof(struct linux_dirent64, d_name) + namlen + 1,
85c9fe8f KW	314	sizeof(u64));
3c2659bd	315	int prev_reclen;
1da177e4	316
8a23eb80 LT	317	buf->error = verify_dirent_name(name, namlen);
	318	if (unlikely(buf->error))
	319	return buf->error;
1da177e4 LT	320	buf->error = -EINVAL; /* only used if we fail.. */
	321	if (reclen > buf->count)
	322	return -EINVAL;
3c2659bd LT	323	prev_reclen = buf->prev_reclen;
3c2659bd LT	324	if (prev_reclen && signal_pending(current))
9f79b78e	325	return -EINTR;
9f79b78e	326	dirent = buf->current_dir;
3c2659bd	327	prev = (void __user *)dirent - prev_reclen;
41cd7805	328	if (!user_write_access_begin(prev, reclen + prev_reclen))
3c2659bd LT	329	goto efault;
	330
	331	/* This might be 'dirent->d_off', but if so it will get overwritten */
	332	unsafe_put_user(offset, &prev->d_off, efault_end);
9f79b78e LT	333	unsafe_put_user(ino, &dirent->d_ino, efault_end);
	334	unsafe_put_user(reclen, &dirent->d_reclen, efault_end);
	335	unsafe_put_user(d_type, &dirent->d_type, efault_end);
	336	unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
41cd7805	337	user_write_access_end();
9f79b78e	338
3c2659bd LT	339	buf->prev_reclen = reclen;
3c2659bd LT	340	buf->current_dir = (void __user *)dirent + reclen;
1da177e4 LT	341	buf->count -= reclen;
1da177e4 LT	342	return 0;
3c2659bd	343
9f79b78e	344	efault_end:
41cd7805	345	user_write_access_end();
1da177e4 LT	346	efault:
	347	buf->error = -EFAULT;
	348	return -EFAULT;
	349	}
	350
454dab3f DB	351	int ksys_getdents64(unsigned int fd, struct linux_dirent64 __user *dirent,
454dab3f DB	352	unsigned int count)
1da177e4	353	{
2903ff01	354	struct fd f;
ac6614b7 AV	355	struct getdents_callback64 buf = {
	356	.ctx.actor = filldir64,
	357	.count = count,
	358	.current_dir = dirent
	359	};
1da177e4 LT	360	int error;
1da177e4 LT	361
63b6df14	362	f = fdget_pos(fd);
2903ff01	363	if (!f.file)
863ced7f	364	return -EBADF;
1da177e4	365
5c0ba4e0	366	error = iterate_dir(f.file, &buf.ctx);
53c9c5c0 AV	367	if (error >= 0)
53c9c5c0 AV	368	error = buf.error;
3c2659bd LT	369	if (buf.prev_reclen) {
3c2659bd LT	370	struct linux_dirent64 __user * lastdirent;
bb6f619b	371	typeof(lastdirent->d_off) d_off = buf.ctx.pos;
3c2659bd LT	372
3c2659bd LT	373	lastdirent = (void __user *) buf.current_dir - buf.prev_reclen;
5fb15141	374	if (put_user(d_off, &lastdirent->d_off))
53c9c5c0 AV	375	error = -EFAULT;
	376	else
	377	error = count - buf.count;
1da177e4	378	}
63b6df14	379	fdput_pos(f);
1da177e4 LT	380	return error;
1da177e4 LT	381	}
0460b2a2	382
454dab3f DB	383
	384	SYSCALL_DEFINE3(getdents64, unsigned int, fd,
	385	struct linux_dirent64 __user *, dirent, unsigned int, count)
	386	{
	387	return ksys_getdents64(fd, dirent, count);
	388	}
	389
0460b2a2 AV	390	#ifdef CONFIG_COMPAT
	391	struct compat_old_linux_dirent {
	392	compat_ulong_t d_ino;
	393	compat_ulong_t d_offset;
	394	unsigned short d_namlen;
	395	char d_name[1];
	396	};
	397
	398	struct compat_readdir_callback {
	399	struct dir_context ctx;
	400	struct compat_old_linux_dirent __user *dirent;
	401	int result;
	402	};
	403
	404	static int compat_fillonedir(struct dir_context ctx, const char name,
	405	int namlen, loff_t offset, u64 ino,
	406	unsigned int d_type)
	407	{
	408	struct compat_readdir_callback *buf =
	409	container_of(ctx, struct compat_readdir_callback, ctx);
	410	struct compat_old_linux_dirent __user *dirent;
	411	compat_ulong_t d_ino;
	412
	413	if (buf->result)
	414	return -EINVAL;
	415	d_ino = ino;
	416	if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
	417	buf->result = -EOVERFLOW;
	418	return -EOVERFLOW;
	419	}
	420	buf->result++;
	421	dirent = buf->dirent;
391b7461	422	if (!user_write_access_begin(dirent,
0460b2a2 AV	423	(unsigned long)(dirent->d_name + namlen + 1) -
	424	(unsigned long)dirent))
	425	goto efault;
391b7461 AV	426	unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
	427	unsafe_put_user(offset, &dirent->d_offset, efault_end);
	428	unsafe_put_user(namlen, &dirent->d_namlen, efault_end);
	429	unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
	430	user_write_access_end();
0460b2a2	431	return 0;
391b7461 AV	432	efault_end:
391b7461 AV	433	user_write_access_end();
0460b2a2 AV	434	efault:
	435	buf->result = -EFAULT;
	436	return -EFAULT;
	437	}
	438
	439	COMPAT_SYSCALL_DEFINE3(old_readdir, unsigned int, fd,
	440	struct compat_old_linux_dirent __user *, dirent, unsigned int, count)
	441	{
	442	int error;
	443	struct fd f = fdget_pos(fd);
	444	struct compat_readdir_callback buf = {
	445	.ctx.actor = compat_fillonedir,
	446	.dirent = dirent
	447	};
	448
	449	if (!f.file)
	450	return -EBADF;
	451
	452	error = iterate_dir(f.file, &buf.ctx);
	453	if (buf.result)
	454	error = buf.result;
	455
	456	fdput_pos(f);
	457	return error;
	458	}
	459
	460	struct compat_linux_dirent {
	461	compat_ulong_t d_ino;
	462	compat_ulong_t d_off;
	463	unsigned short d_reclen;
	464	char d_name[1];
	465	};
	466
	467	struct compat_getdents_callback {
	468	struct dir_context ctx;
	469	struct compat_linux_dirent __user *current_dir;
82af599b	470	int prev_reclen;
0460b2a2 AV	471	int count;
	472	int error;
	473	};
	474
	475	static int compat_filldir(struct dir_context ctx, const char name, int namlen,
	476	loff_t offset, u64 ino, unsigned int d_type)
	477	{
82af599b	478	struct compat_linux_dirent __user dirent, prev;
0460b2a2 AV	479	struct compat_getdents_callback *buf =
	480	container_of(ctx, struct compat_getdents_callback, ctx);
	481	compat_ulong_t d_ino;
	482	int reclen = ALIGN(offsetof(struct compat_linux_dirent, d_name) +
	483	namlen + 2, sizeof(compat_long_t));
82af599b	484	int prev_reclen;
0460b2a2	485
82af599b AV	486	buf->error = verify_dirent_name(name, namlen);
	487	if (unlikely(buf->error))
	488	return buf->error;
0460b2a2 AV	489	buf->error = -EINVAL; /* only used if we fail.. */
	490	if (reclen > buf->count)
	491	return -EINVAL;
	492	d_ino = ino;
	493	if (sizeof(d_ino) < sizeof(ino) && d_ino != ino) {
	494	buf->error = -EOVERFLOW;
	495	return -EOVERFLOW;
	496	}
82af599b AV	497	prev_reclen = buf->prev_reclen;
	498	if (prev_reclen && signal_pending(current))
	499	return -EINTR;
0460b2a2	500	dirent = buf->current_dir;
82af599b AV	501	prev = (void __user *) dirent - prev_reclen;
82af599b AV	502	if (!user_write_access_begin(prev, reclen + prev_reclen))
0460b2a2	503	goto efault;
82af599b AV	504
	505	unsafe_put_user(offset, &prev->d_off, efault_end);
	506	unsafe_put_user(d_ino, &dirent->d_ino, efault_end);
	507	unsafe_put_user(reclen, &dirent->d_reclen, efault_end);
	508	unsafe_put_user(d_type, (char __user *) dirent + reclen - 1, efault_end);
	509	unsafe_copy_dirent_name(dirent->d_name, name, namlen, efault_end);
	510	user_write_access_end();
	511
	512	buf->prev_reclen = reclen;
	513	buf->current_dir = (void __user *)dirent + reclen;
0460b2a2 AV	514	buf->count -= reclen;
0460b2a2 AV	515	return 0;
82af599b AV	516	efault_end:
82af599b AV	517	user_write_access_end();
0460b2a2 AV	518	efault:
	519	buf->error = -EFAULT;
	520	return -EFAULT;
	521	}
	522
	523	COMPAT_SYSCALL_DEFINE3(getdents, unsigned int, fd,
	524	struct compat_linux_dirent __user *, dirent, unsigned int, count)
	525	{
	526	struct fd f;
0460b2a2 AV	527	struct compat_getdents_callback buf = {
	528	.ctx.actor = compat_filldir,
	529	.current_dir = dirent,
	530	.count = count
	531	};
	532	int error;
	533
0460b2a2 AV	534	f = fdget_pos(fd);
	535	if (!f.file)
	536	return -EBADF;
	537
	538	error = iterate_dir(f.file, &buf.ctx);
	539	if (error >= 0)
	540	error = buf.error;
82af599b AV	541	if (buf.prev_reclen) {
	542	struct compat_linux_dirent __user * lastdirent;
	543	lastdirent = (void __user *)buf.current_dir - buf.prev_reclen;
	544
0460b2a2 AV	545	if (put_user(buf.ctx.pos, &lastdirent->d_off))
	546	error = -EFAULT;
	547	else
	548	error = count - buf.count;
	549	}
	550	fdput_pos(f);
	551	return error;
	552	}
	553	#endif