[linux-block.git] / fs / smb / server / vfs.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *   Copyright (C) 2016 Namjae Jeon <linkinjeon@kernel.org>
 *   Copyright (C) 2018 Samsung Electronics Co., Ltd.
 */

#ifndef __KSMBD_VFS_H__
#define __KSMBD_VFS_H__

#include <linux/file.h>
#include <linux/fs.h>
#include <linux/namei.h>
#include <uapi/linux/xattr.h>
#include <linux/posix_acl.h>
#include <linux/unicode.h>

#include "smbacl.h"
#include "xattr.h"

/*
 * Enumeration for stream type.
 */
enum {
	DATA_STREAM	= 1,	/* type $DATA */
	DIR_STREAM		/* type $INDEX_ALLOCATION */
};

/* CreateOptions */
#define CREATE_TREE_CONNECTION			cpu_to_le32(0x00000080)
#define FILE_RESERVE_OPFILTER_LE		cpu_to_le32(0x00100000)

#define CREATE_OPTION_READONLY			0x10000000
/* system. NB not sent over wire */
#define CREATE_OPTION_SPECIAL			0x20000000

struct ksmbd_work;
struct ksmbd_file;
struct ksmbd_conn;

struct ksmbd_dir_info {
	const char	*name;
	char		*wptr;
	char		*rptr;
	int		name_len;
	int		out_buf_len;
	int		num_entry;
	int		data_count;
	int		last_entry_offset;
	bool		hide_dot_file;
	int		flags;
	int		last_entry_off_align;
};

struct ksmbd_readdir_data {
	struct dir_context	ctx;
	union {
		void		*private;
		char		*dirent;
	};

	unsigned int		used;
	unsigned int		dirent_count;
	unsigned int		file_attr;
	struct unicode_map	*um;
};

/* ksmbd kstat wrapper to get valid create time when reading dir entry */
struct ksmbd_kstat {
	struct kstat		*kstat;
	unsigned long long	create_time;
	__le32			file_attributes;
};

int ksmbd_vfs_lock_parent(struct dentry *parent, struct dentry *child);
void ksmbd_vfs_query_maximal_access(struct mnt_idmap *idmap,
				   struct dentry *dentry, __le32 *daccess);
int ksmbd_vfs_create(struct ksmbd_work *work, const char *name, umode_t mode);
int ksmbd_vfs_mkdir(struct ksmbd_work *work, const char *name, umode_t mode);
int ksmbd_vfs_read(struct ksmbd_work *work, struct ksmbd_file *fp, size_t count,
		   loff_t *pos, char *rbuf);
int ksmbd_vfs_write(struct ksmbd_work *work, struct ksmbd_file *fp,
		    char *buf, size_t count, loff_t *pos, bool sync,
		    ssize_t *written);
int ksmbd_vfs_fsync(struct ksmbd_work *work, u64 fid, u64 p_id);
int ksmbd_vfs_remove_file(struct ksmbd_work *work, const struct path *path);
int ksmbd_vfs_link(struct ksmbd_work *work,
		   const char *oldname, const char *newname);
int ksmbd_vfs_getattr(const struct path *path, struct kstat *stat);
int ksmbd_vfs_rename(struct ksmbd_work *work, const struct path *old_path,
		     char *newname, int flags);
int ksmbd_vfs_truncate(struct ksmbd_work *work,
		       struct ksmbd_file *fp, loff_t size);
struct srv_copychunk;
int ksmbd_vfs_copy_file_ranges(struct ksmbd_work *work,
			       struct ksmbd_file *src_fp,
			       struct ksmbd_file *dst_fp,
			       struct srv_copychunk *chunks,
			       unsigned int chunk_count,
			       unsigned int *chunk_count_written,
			       unsigned int *chunk_size_written,
			       loff_t  *total_size_written);
ssize_t ksmbd_vfs_listxattr(struct dentry *dentry, char **list);
ssize_t ksmbd_vfs_getxattr(struct mnt_idmap *idmap,
			   struct dentry *dentry,
			   char *xattr_name,
			   char **xattr_buf);
ssize_t ksmbd_vfs_casexattr_len(struct mnt_idmap *idmap,
				struct dentry *dentry, char *attr_name,
				int attr_name_len);
int ksmbd_vfs_setxattr(struct mnt_idmap *idmap,
		       const struct path *path, const char *attr_name,
		       void *attr_value, size_t attr_size, int flags);
int ksmbd_vfs_xattr_stream_name(char *stream_name, char **xattr_stream_name,
				size_t *xattr_stream_name_size, int s_type);
int ksmbd_vfs_remove_xattr(struct mnt_idmap *idmap,
			   const struct path *path, char *attr_name);
int ksmbd_vfs_kern_path_locked(struct ksmbd_work *work, char *name,
			       unsigned int flags, struct path *parent_path,
			       struct path *path, bool caseless);
struct dentry *ksmbd_vfs_kern_path_create(struct ksmbd_work *work,
					  const char *name,
					  unsigned int flags,
					  struct path *path);
int ksmbd_vfs_empty_dir(struct ksmbd_file *fp);
void ksmbd_vfs_set_fadvise(struct file *filp, __le32 option);
int ksmbd_vfs_zero_data(struct ksmbd_work *work, struct ksmbd_file *fp,
			loff_t off, loff_t len);
struct file_allocated_range_buffer;
int ksmbd_vfs_fqar_lseek(struct ksmbd_file *fp, loff_t start, loff_t length,
			 struct file_allocated_range_buffer *ranges,
			 unsigned int in_count, unsigned int *out_count);
int ksmbd_vfs_unlink(struct file *filp);
void *ksmbd_vfs_init_kstat(char **p, struct ksmbd_kstat *ksmbd_kstat);
int ksmbd_vfs_fill_dentry_attrs(struct ksmbd_work *work,
				struct mnt_idmap *idmap,
				struct dentry *dentry,
				struct ksmbd_kstat *ksmbd_kstat);
void ksmbd_vfs_posix_lock_wait(struct file_lock *flock);
int ksmbd_vfs_posix_lock_wait_timeout(struct file_lock *flock, long timeout);
void ksmbd_vfs_posix_lock_unblock(struct file_lock *flock);
int ksmbd_vfs_remove_acl_xattrs(struct mnt_idmap *idmap,
				const struct path *path);
int ksmbd_vfs_remove_sd_xattrs(struct mnt_idmap *idmap, const struct path *path);
int ksmbd_vfs_set_sd_xattr(struct ksmbd_conn *conn,
			   struct mnt_idmap *idmap,
			   const struct path *path,
			   struct smb_ntsd *pntsd, int len);
int ksmbd_vfs_get_sd_xattr(struct ksmbd_conn *conn,
			   struct mnt_idmap *idmap,
			   struct dentry *dentry,
			   struct smb_ntsd **pntsd);
int ksmbd_vfs_set_dos_attrib_xattr(struct mnt_idmap *idmap,
				   const struct path *path,
				   struct xattr_dos_attrib *da);
int ksmbd_vfs_get_dos_attrib_xattr(struct mnt_idmap *idmap,
				   struct dentry *dentry,
				   struct xattr_dos_attrib *da);
int ksmbd_vfs_set_init_posix_acl(struct mnt_idmap *idmap,
				 struct path *path);
int ksmbd_vfs_inherit_posix_acl(struct mnt_idmap *idmap,
				struct path *path,
				struct inode *parent_inode);
#endif /* __KSMBD_VFS_H__ */
Commit	Line	Data
f4415848 NJ	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
	2	/*
	3	* Copyright (C) 2016 Namjae Jeon <linkinjeon@kernel.org>
	4	* Copyright (C) 2018 Samsung Electronics Co., Ltd.
	5	*/
	6
	7	#ifndef __KSMBD_VFS_H__
	8	#define __KSMBD_VFS_H__
	9
	10	#include <linux/file.h>
	11	#include <linux/fs.h>
	12	#include <linux/namei.h>
	13	#include <uapi/linux/xattr.h>
	14	#include <linux/posix_acl.h>
dbab80e2	15	#include <linux/unicode.h>
f4415848 NJ	16
f4415848 NJ	17	#include "smbacl.h"
8b758859	18	#include "xattr.h"
f4415848	19
ee2033e9 NJ	20	/*
	21	* Enumeration for stream type.
	22	*/
	23	enum {
	24	DATA_STREAM = 1, /* type $DATA */
	25	DIR_STREAM /* type $INDEX_ALLOCATION */
	26	};
	27
f4415848	28	/* CreateOptions */
f4415848	29	#define CREATE_TREE_CONNECTION cpu_to_le32(0x00000080)
f4415848	30	#define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
f4415848	31
f4415848 NJ	32	#define CREATE_OPTION_READONLY 0x10000000
	33	/* system. NB not sent over wire */
	34	#define CREATE_OPTION_SPECIAL 0x20000000
	35
	36	struct ksmbd_work;
	37	struct ksmbd_file;
	38	struct ksmbd_conn;
	39
	40	struct ksmbd_dir_info {
	41	const char *name;
	42	char *wptr;
	43	char *rptr;
	44	int name_len;
	45	int out_buf_len;
	46	int num_entry;
	47	int data_count;
	48	int last_entry_offset;
	49	bool hide_dot_file;
	50	int flags;
04e26094	51	int last_entry_off_align;
f4415848 NJ	52	};
	53
	54	struct ksmbd_readdir_data {
	55	struct dir_context ctx;
	56	union {
	57	void *private;
	58	char *dirent;
	59	};
	60
	61	unsigned int used;
	62	unsigned int dirent_count;
	63	unsigned int file_attr;
dbab80e2	64	struct unicode_map *um;
f4415848 NJ	65	};
	66
	67	/* ksmbd kstat wrapper to get valid create time when reading dir entry */
	68	struct ksmbd_kstat {
	69	struct kstat *kstat;
	70	unsigned long long create_time;
	71	__le32 file_attributes;
	72	};
	73
74d7970f	74	int ksmbd_vfs_lock_parent(struct dentry parent, struct dentry child);
ccb5889a	75	void ksmbd_vfs_query_maximal_access(struct mnt_idmap *idmap,
af34983e	76	struct dentry dentry, __le32 daccess);
f4415848 NJ	77	int ksmbd_vfs_create(struct ksmbd_work work, const char name, umode_t mode);
f4415848 NJ	78	int ksmbd_vfs_mkdir(struct ksmbd_work work, const char name, umode_t mode);
e2b76ab8 NJ	79	int ksmbd_vfs_read(struct ksmbd_work work, struct ksmbd_file fp, size_t count,
e2b76ab8 NJ	80	loff_t pos, char rbuf);
f4415848	81	int ksmbd_vfs_write(struct ksmbd_work work, struct ksmbd_file fp,
070fb21e NJ	82	char buf, size_t count, loff_t pos, bool sync,
070fb21e NJ	83	ssize_t *written);
64b39f4a	84	int ksmbd_vfs_fsync(struct ksmbd_work *work, u64 fid, u64 p_id);
74d7970f	85	int ksmbd_vfs_remove_file(struct ksmbd_work work, const struct path path);
f4415848	86	int ksmbd_vfs_link(struct ksmbd_work *work,
070fb21e	87	const char oldname, const char newname);
c22180a5	88	int ksmbd_vfs_getattr(const struct path path, struct kstat stat);
74d7970f NJ	89	int ksmbd_vfs_rename(struct ksmbd_work work, const struct path old_path,
74d7970f NJ	90	char *newname, int flags);
265fd199	91	int ksmbd_vfs_truncate(struct ksmbd_work *work,
070fb21e	92	struct ksmbd_file *fp, loff_t size);
f4415848 NJ	93	struct srv_copychunk;
f4415848 NJ	94	int ksmbd_vfs_copy_file_ranges(struct ksmbd_work *work,
070fb21e NJ	95	struct ksmbd_file *src_fp,
	96	struct ksmbd_file *dst_fp,
	97	struct srv_copychunk *chunks,
	98	unsigned int chunk_count,
	99	unsigned int *chunk_count_written,
	100	unsigned int *chunk_size_written,
	101	loff_t *total_size_written);
f4415848	102	ssize_t ksmbd_vfs_listxattr(struct dentry dentry, char *list);
4609e1f1	103	ssize_t ksmbd_vfs_getxattr(struct mnt_idmap *idmap,
af34983e HL	104	struct dentry *dentry,
af34983e HL	105	char *xattr_name,
070fb21e	106	char **xattr_buf);
4609e1f1	107	ssize_t ksmbd_vfs_casexattr_len(struct mnt_idmap *idmap,
af34983e	108	struct dentry dentry, char attr_name,
070fb21e	109	int attr_name_len);
4609e1f1	110	int ksmbd_vfs_setxattr(struct mnt_idmap *idmap,
40b268d3	111	const struct path path, const char attr_name,
0c5fd887	112	void *attr_value, size_t attr_size, int flags);
64b39f4a	113	int ksmbd_vfs_xattr_stream_name(char stream_name, char *xattr_stream_name,
070fb21e	114	size_t *xattr_stream_name_size, int s_type);
4609e1f1	115	int ksmbd_vfs_remove_xattr(struct mnt_idmap *idmap,
40b268d3	116	const struct path path, char attr_name);
74d7970f	117	int ksmbd_vfs_kern_path_locked(struct ksmbd_work work, char name,
2b57a432 NJ	118	unsigned int flags, struct path *parent_path,
2b57a432 NJ	119	struct path *path, bool caseless);
265fd199 HL	120	struct dentry ksmbd_vfs_kern_path_create(struct ksmbd_work work,
	121	const char *name,
	122	unsigned int flags,
	123	struct path *path);
f4415848 NJ	124	int ksmbd_vfs_empty_dir(struct ksmbd_file *fp);
f4415848 NJ	125	void ksmbd_vfs_set_fadvise(struct file *filp, __le32 option);
64b39f4a	126	int ksmbd_vfs_zero_data(struct ksmbd_work work, struct ksmbd_file fp,
070fb21e	127	loff_t off, loff_t len);
f4415848 NJ	128	struct file_allocated_range_buffer;
f4415848 NJ	129	int ksmbd_vfs_fqar_lseek(struct ksmbd_file *fp, loff_t start, loff_t length,
070fb21e	130	struct file_allocated_range_buffer *ranges,
f7db8fd0	131	unsigned int in_count, unsigned int *out_count);
74d7970f	132	int ksmbd_vfs_unlink(struct file *filp);
f4415848	133	void ksmbd_vfs_init_kstat(char p, struct ksmbd_kstat ksmbd_kstat);
af34983e	134	int ksmbd_vfs_fill_dentry_attrs(struct ksmbd_work *work,
b74d24f7	135	struct mnt_idmap *idmap,
af34983e	136	struct dentry *dentry,
070fb21e	137	struct ksmbd_kstat *ksmbd_kstat);
45a64e8b	138	void ksmbd_vfs_posix_lock_wait(struct file_lock *flock);
f4415848 NJ	139	int ksmbd_vfs_posix_lock_wait_timeout(struct file_lock *flock, long timeout);
f4415848 NJ	140	void ksmbd_vfs_posix_lock_unblock(struct file_lock *flock);
13e83a49	141	int ksmbd_vfs_remove_acl_xattrs(struct mnt_idmap *idmap,
40b268d3 NJ	142	const struct path *path);
40b268d3 NJ	143	int ksmbd_vfs_remove_sd_xattrs(struct mnt_idmap idmap, const struct path path);
af34983e	144	int ksmbd_vfs_set_sd_xattr(struct ksmbd_conn *conn,
4609e1f1	145	struct mnt_idmap *idmap,
40b268d3	146	const struct path *path,
070fb21e	147	struct smb_ntsd *pntsd, int len);
af34983e	148	int ksmbd_vfs_get_sd_xattr(struct ksmbd_conn *conn,
4609e1f1	149	struct mnt_idmap *idmap,
af34983e	150	struct dentry *dentry,
070fb21e	151	struct smb_ntsd **pntsd);
4609e1f1	152	int ksmbd_vfs_set_dos_attrib_xattr(struct mnt_idmap *idmap,
40b268d3	153	const struct path *path,
070fb21e	154	struct xattr_dos_attrib *da);
4609e1f1	155	int ksmbd_vfs_get_dos_attrib_xattr(struct mnt_idmap *idmap,
af34983e	156	struct dentry *dentry,
070fb21e	157	struct xattr_dos_attrib *da);
13e83a49	158	int ksmbd_vfs_set_init_posix_acl(struct mnt_idmap *idmap,
40b268d3	159	struct path *path);
13e83a49	160	int ksmbd_vfs_inherit_posix_acl(struct mnt_idmap *idmap,
40b268d3	161	struct path *path,
070fb21e	162	struct inode *parent_inode);
f4415848	163	#endif /* __KSMBD_VFS_H__ */