[linux-block.git] / fs / ksmbd / 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 "smbacl.h"
#include "xattr.h"

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

/* CreateOptions */
/* Flag is set, it must not be a file , valid for directory only */
#define FILE_DIRECTORY_FILE_LE			cpu_to_le32(0x00000001)
#define FILE_WRITE_THROUGH_LE			cpu_to_le32(0x00000002)
#define FILE_SEQUENTIAL_ONLY_LE			cpu_to_le32(0x00000004)

/* Should not buffer on server*/
#define FILE_NO_INTERMEDIATE_BUFFERING_LE	cpu_to_le32(0x00000008)
/* MBZ */
#define FILE_SYNCHRONOUS_IO_ALERT_LE		cpu_to_le32(0x00000010)
/* MBZ */
#define FILE_SYNCHRONOUS_IO_NONALERT_LE		cpu_to_le32(0x00000020)

/* Flaf must not be set for directory */
#define FILE_NON_DIRECTORY_FILE_LE		cpu_to_le32(0x00000040)

/* Should be zero */
#define CREATE_TREE_CONNECTION			cpu_to_le32(0x00000080)
#define FILE_COMPLETE_IF_OPLOCKED_LE		cpu_to_le32(0x00000100)
#define FILE_NO_EA_KNOWLEDGE_LE			cpu_to_le32(0x00000200)
#define FILE_OPEN_REMOTE_INSTANCE		cpu_to_le32(0x00000400)

/**
 * Doc says this is obsolete "open for recovery" flag should be zero
 * in any case.
 */
#define CREATE_OPEN_FOR_RECOVERY		cpu_to_le32(0x00000400)
#define FILE_RANDOM_ACCESS_LE			cpu_to_le32(0x00000800)
#define FILE_DELETE_ON_CLOSE_LE			cpu_to_le32(0x00001000)
#define FILE_OPEN_BY_FILE_ID_LE			cpu_to_le32(0x00002000)
#define FILE_OPEN_FOR_BACKUP_INTENT_LE		cpu_to_le32(0x00004000)
#define FILE_NO_COMPRESSION_LE			cpu_to_le32(0x00008000)

/* Should be zero*/
#define FILE_OPEN_REQUIRING_OPLOCK		cpu_to_le32(0x00010000)
#define FILE_DISALLOW_EXCLUSIVE			cpu_to_le32(0x00020000)
#define FILE_RESERVE_OPFILTER_LE		cpu_to_le32(0x00100000)
#define FILE_OPEN_REPARSE_POINT_LE		cpu_to_le32(0x00200000)
#define FILE_OPEN_NO_RECALL_LE			cpu_to_le32(0x00400000)

/* Should be zero */
#define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE	cpu_to_le32(0x00800000)
#define CREATE_OPTIONS_MASK			cpu_to_le32(0x00FFFFFF)
#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;
};

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

	unsigned int		used;
	unsigned int		dirent_count;
	unsigned int		file_attr;
};

/* 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);
int ksmbd_vfs_may_delete(struct dentry *dentry);
int ksmbd_vfs_query_maximal_access(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);
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, char *name);
int ksmbd_vfs_link(struct ksmbd_work *work,
		   const char *oldname, const char *newname);
int ksmbd_vfs_getattr(struct path *path, struct kstat *stat);
int ksmbd_vfs_fp_rename(struct ksmbd_work *work, struct ksmbd_file *fp,
			char *newname);
int ksmbd_vfs_truncate(struct ksmbd_work *work, const char *name,
		       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 dentry *dentry, char *xattr_name,
			   char **xattr_buf);
ssize_t ksmbd_vfs_casexattr_len(struct dentry *dentry, char *attr_name,
				int attr_name_len);
int ksmbd_vfs_setxattr(struct dentry *dentry, const char *attr_name,
		       const 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 dentry *dentry, char *attr_name);
int ksmbd_vfs_kern_path(char *name, unsigned int flags, struct path *path,
			bool caseless);
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,
			 int in_count, int *out_count);
int ksmbd_vfs_unlink(struct dentry *dir, struct dentry *dentry);
void *ksmbd_vfs_init_kstat(char **p, struct ksmbd_kstat *ksmbd_kstat);
int ksmbd_vfs_fill_dentry_attrs(struct ksmbd_work *work, struct dentry *dentry,
				struct ksmbd_kstat *ksmbd_kstat);
int 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 dentry *dentry);
int ksmbd_vfs_remove_sd_xattrs(struct dentry *dentry);
int ksmbd_vfs_set_sd_xattr(struct ksmbd_conn *conn, struct dentry *dentry,
			   struct smb_ntsd *pntsd, int len);
int ksmbd_vfs_get_sd_xattr(struct ksmbd_conn *conn, struct dentry *dentry,
			   struct smb_ntsd **pntsd);
int ksmbd_vfs_set_dos_attrib_xattr(struct dentry *dentry,
				   struct xattr_dos_attrib *da);
int ksmbd_vfs_get_dos_attrib_xattr(struct dentry *dentry,
				   struct xattr_dos_attrib *da);
int ksmbd_vfs_set_init_posix_acl(struct inode *inode);
int ksmbd_vfs_inherit_posix_acl(struct inode *inode,
				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>
	15
	16	#include "smbacl.h"
8b758859	17	#include "xattr.h"
f4415848	18
ee2033e9 NJ	19	/*
	20	* Enumeration for stream type.
	21	*/
	22	enum {
	23	DATA_STREAM = 1, /* type $DATA */
	24	DIR_STREAM /* type $INDEX_ALLOCATION */
	25	};
	26
f4415848 NJ	27	/* CreateOptions */
	28	/* Flag is set, it must not be a file , valid for directory only */
	29	#define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
	30	#define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
	31	#define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
	32
	33	/* Should not buffer on server*/
	34	#define FILE_NO_INTERMEDIATE_BUFFERING_LE cpu_to_le32(0x00000008)
	35	/* MBZ */
	36	#define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
	37	/* MBZ */
	38	#define FILE_SYNCHRONOUS_IO_NONALERT_LE cpu_to_le32(0x00000020)
	39
	40	/* Flaf must not be set for directory */
	41	#define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
	42
	43	/* Should be zero */
	44	#define CREATE_TREE_CONNECTION cpu_to_le32(0x00000080)
	45	#define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
	46	#define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
	47	#define FILE_OPEN_REMOTE_INSTANCE cpu_to_le32(0x00000400)
	48
	49	/**
	50	* Doc says this is obsolete "open for recovery" flag should be zero
	51	* in any case.
	52	*/
	53	#define CREATE_OPEN_FOR_RECOVERY cpu_to_le32(0x00000400)
	54	#define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
	55	#define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
	56	#define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
	57	#define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
	58	#define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
	59
	60	/* Should be zero*/
	61	#define FILE_OPEN_REQUIRING_OPLOCK cpu_to_le32(0x00010000)
	62	#define FILE_DISALLOW_EXCLUSIVE cpu_to_le32(0x00020000)
	63	#define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
	64	#define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
	65	#define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
	66
	67	/* Should be zero */
	68	#define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
	69	#define CREATE_OPTIONS_MASK cpu_to_le32(0x00FFFFFF)
	70	#define CREATE_OPTION_READONLY 0x10000000
	71	/* system. NB not sent over wire */
	72	#define CREATE_OPTION_SPECIAL 0x20000000
	73
	74	struct ksmbd_work;
	75	struct ksmbd_file;
	76	struct ksmbd_conn;
	77
	78	struct ksmbd_dir_info {
	79	const char *name;
	80	char *wptr;
	81	char *rptr;
	82	int name_len;
	83	int out_buf_len;
	84	int num_entry;
	85	int data_count;
	86	int last_entry_offset;
	87	bool hide_dot_file;
	88	int flags;
	89	};
	90
91	struct ksmbd_readdir_data {
92	struct dir_context ctx;
93	union {
94	void *private;
95	char *dirent;
96	};
97
98	unsigned int used;
99	unsigned int dirent_count;
100	unsigned int file_attr;
101	};
102
103	/* ksmbd kstat wrapper to get valid create time when reading dir entry */
104	struct ksmbd_kstat {
105	struct kstat *kstat;
106	unsigned long long create_time;
107	__le32 file_attributes;
108	};
109
12202c05	110	int ksmbd_vfs_lock_parent(struct dentry parent, struct dentry child);
6c5e36d1	111	int ksmbd_vfs_may_delete(struct dentry *dentry);
f4415848 NJ	112	int ksmbd_vfs_query_maximal_access(struct dentry dentry, __le32 daccess);
	113	int ksmbd_vfs_create(struct ksmbd_work work, const char name, umode_t mode);
	114	int ksmbd_vfs_mkdir(struct ksmbd_work work, const char name, umode_t mode);
	115	int ksmbd_vfs_read(struct ksmbd_work work, struct ksmbd_file fp,
070fb21e	116	size_t count, loff_t *pos);
f4415848	117	int ksmbd_vfs_write(struct ksmbd_work work, struct ksmbd_file fp,
070fb21e NJ	118	char buf, size_t count, loff_t pos, bool sync,
070fb21e NJ	119	ssize_t *written);
64b39f4a	120	int ksmbd_vfs_fsync(struct ksmbd_work *work, u64 fid, u64 p_id);
f4415848 NJ	121	int ksmbd_vfs_remove_file(struct ksmbd_work work, char name);
f4415848 NJ	122	int ksmbd_vfs_link(struct ksmbd_work *work,
070fb21e	123	const char oldname, const char newname);
f4415848	124	int ksmbd_vfs_getattr(struct path path, struct kstat stat);
f4415848	125	int ksmbd_vfs_fp_rename(struct ksmbd_work work, struct ksmbd_file fp,
070fb21e	126	char *newname);
f4415848	127	int ksmbd_vfs_truncate(struct ksmbd_work work, const char name,
070fb21e	128	struct ksmbd_file *fp, loff_t size);
f4415848 NJ	129	struct srv_copychunk;
f4415848 NJ	130	int ksmbd_vfs_copy_file_ranges(struct ksmbd_work *work,
070fb21e NJ	131	struct ksmbd_file *src_fp,
	132	struct ksmbd_file *dst_fp,
	133	struct srv_copychunk *chunks,
	134	unsigned int chunk_count,
	135	unsigned int *chunk_count_written,
	136	unsigned int *chunk_size_written,
	137	loff_t *total_size_written);
f4415848	138	ssize_t ksmbd_vfs_listxattr(struct dentry dentry, char *list);
64b39f4a	139	ssize_t ksmbd_vfs_getxattr(struct dentry dentry, char xattr_name,
070fb21e	140	char **xattr_buf);
64b39f4a	141	ssize_t ksmbd_vfs_casexattr_len(struct dentry dentry, char attr_name,
070fb21e	142	int attr_name_len);
64b39f4a	143	int ksmbd_vfs_setxattr(struct dentry dentry, const char attr_name,
070fb21e	144	const void *attr_value, size_t attr_size, int flags);
64b39f4a	145	int ksmbd_vfs_xattr_stream_name(char stream_name, char *xattr_stream_name,
070fb21e	146	size_t *xattr_stream_name_size, int s_type);
f4415848	147	int ksmbd_vfs_remove_xattr(struct dentry dentry, char attr_name);
f4415848	148	int ksmbd_vfs_kern_path(char name, unsigned int flags, struct path path,
070fb21e	149	bool caseless);
f4415848 NJ	150	int ksmbd_vfs_empty_dir(struct ksmbd_file *fp);
f4415848 NJ	151	void ksmbd_vfs_set_fadvise(struct file *filp, __le32 option);
64b39f4a	152	int ksmbd_vfs_zero_data(struct ksmbd_work work, struct ksmbd_file fp,
070fb21e	153	loff_t off, loff_t len);
f4415848 NJ	154	struct file_allocated_range_buffer;
f4415848 NJ	155	int ksmbd_vfs_fqar_lseek(struct ksmbd_file *fp, loff_t start, loff_t length,
070fb21e NJ	156	struct file_allocated_range_buffer *ranges,
070fb21e NJ	157	int in_count, int *out_count);
f4415848	158	int ksmbd_vfs_unlink(struct dentry dir, struct dentry dentry);
f4415848	159	void ksmbd_vfs_init_kstat(char p, struct ksmbd_kstat ksmbd_kstat);
64b39f4a	160	int ksmbd_vfs_fill_dentry_attrs(struct ksmbd_work work, struct dentry dentry,
070fb21e	161	struct ksmbd_kstat *ksmbd_kstat);
f4415848 NJ	162	int ksmbd_vfs_posix_lock_wait(struct file_lock *flock);
	163	int ksmbd_vfs_posix_lock_wait_timeout(struct file_lock *flock, long timeout);
	164	void ksmbd_vfs_posix_lock_unblock(struct file_lock *flock);
f4415848 NJ	165	int ksmbd_vfs_remove_acl_xattrs(struct dentry *dentry);
	166	int ksmbd_vfs_remove_sd_xattrs(struct dentry *dentry);
	167	int ksmbd_vfs_set_sd_xattr(struct ksmbd_conn conn, struct dentry dentry,
070fb21e	168	struct smb_ntsd *pntsd, int len);
f4415848	169	int ksmbd_vfs_get_sd_xattr(struct ksmbd_conn conn, struct dentry dentry,
070fb21e	170	struct smb_ntsd **pntsd);
f4415848	171	int ksmbd_vfs_set_dos_attrib_xattr(struct dentry *dentry,
070fb21e	172	struct xattr_dos_attrib *da);
f4415848	173	int ksmbd_vfs_get_dos_attrib_xattr(struct dentry *dentry,
070fb21e	174	struct xattr_dos_attrib *da);
f4415848 NJ	175	int ksmbd_vfs_set_init_posix_acl(struct inode *inode);
f4415848 NJ	176	int ksmbd_vfs_inherit_posix_acl(struct inode *inode,
070fb21e	177	struct inode *parent_inode);
f4415848	178	#endif /* __KSMBD_VFS_H__ */