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"
17 #include "xattr.h"
18 
19 /*
20  * Enumeration for stream type.
21  */
22 enum {
23 	DATA_STREAM	= 1,	/* type $DATA */
24 	DIR_STREAM		/* type $INDEX_ALLOCATION */
25 };
26 
27 /* CreateOptions */
28 #define CREATE_TREE_CONNECTION			cpu_to_le32(0x00000080)
29 #define FILE_RESERVE_OPFILTER_LE		cpu_to_le32(0x00100000)
30 
31 #define CREATE_OPTION_READONLY			0x10000000
32 /* system. NB not sent over wire */
33 #define CREATE_OPTION_SPECIAL			0x20000000
34 
35 struct ksmbd_work;
36 struct ksmbd_file;
37 struct ksmbd_conn;
38 
39 struct ksmbd_dir_info {
40 	const char	*name;
41 	char		*wptr;
42 	char		*rptr;
43 	int		name_len;
44 	int		out_buf_len;
45 	int		num_entry;
46 	int		data_count;
47 	int		last_entry_offset;
48 	bool		hide_dot_file;
49 	int		flags;
50 };
51 
52 struct ksmbd_readdir_data {
53 	struct dir_context	ctx;
54 	union {
55 		void		*private;
56 		char		*dirent;
57 	};
58 
59 	unsigned int		used;
60 	unsigned int		dirent_count;
61 	unsigned int		file_attr;
62 };
63 
64 /* ksmbd kstat wrapper to get valid create time when reading dir entry */
65 struct ksmbd_kstat {
66 	struct kstat		*kstat;
67 	unsigned long long	create_time;
68 	__le32			file_attributes;
69 };
70 
71 int ksmbd_vfs_lock_parent(struct user_namespace *user_ns, struct dentry *parent,
72 			  struct dentry *child);
73 int ksmbd_vfs_may_delete(struct user_namespace *user_ns, struct dentry *dentry);
74 int ksmbd_vfs_query_maximal_access(struct user_namespace *user_ns,
75 				   struct dentry *dentry, __le32 *daccess);
76 int ksmbd_vfs_create(struct ksmbd_work *work, const char *name, umode_t mode);
77 int ksmbd_vfs_mkdir(struct ksmbd_work *work, const char *name, umode_t mode);
78 int ksmbd_vfs_read(struct ksmbd_work *work, struct ksmbd_file *fp,
79 		   size_t count, loff_t *pos);
80 int ksmbd_vfs_write(struct ksmbd_work *work, struct ksmbd_file *fp,
81 		    char *buf, size_t count, loff_t *pos, bool sync,
82 		    ssize_t *written);
83 int ksmbd_vfs_fsync(struct ksmbd_work *work, u64 fid, u64 p_id);
84 int ksmbd_vfs_remove_file(struct ksmbd_work *work, char *name);
85 int ksmbd_vfs_link(struct ksmbd_work *work,
86 		   const char *oldname, const char *newname);
87 int ksmbd_vfs_getattr(struct path *path, struct kstat *stat);
88 int ksmbd_vfs_fp_rename(struct ksmbd_work *work, struct ksmbd_file *fp,
89 			char *newname);
90 int ksmbd_vfs_truncate(struct ksmbd_work *work,
91 		       struct ksmbd_file *fp, loff_t size);
92 struct srv_copychunk;
93 int ksmbd_vfs_copy_file_ranges(struct ksmbd_work *work,
94 			       struct ksmbd_file *src_fp,
95 			       struct ksmbd_file *dst_fp,
96 			       struct srv_copychunk *chunks,
97 			       unsigned int chunk_count,
98 			       unsigned int *chunk_count_written,
99 			       unsigned int *chunk_size_written,
100 			       loff_t  *total_size_written);
101 ssize_t ksmbd_vfs_listxattr(struct dentry *dentry, char **list);
102 ssize_t ksmbd_vfs_getxattr(struct user_namespace *user_ns,
103 			   struct dentry *dentry,
104 			   char *xattr_name,
105 			   char **xattr_buf);
106 ssize_t ksmbd_vfs_casexattr_len(struct user_namespace *user_ns,
107 				struct dentry *dentry, char *attr_name,
108 				int attr_name_len);
109 int ksmbd_vfs_setxattr(struct user_namespace *user_ns,
110 		       struct dentry *dentry, const char *attr_name,
111 		       const void *attr_value, size_t attr_size, int flags);
112 int ksmbd_vfs_xattr_stream_name(char *stream_name, char **xattr_stream_name,
113 				size_t *xattr_stream_name_size, int s_type);
114 int ksmbd_vfs_remove_xattr(struct user_namespace *user_ns,
115 			   struct dentry *dentry, char *attr_name);
116 int ksmbd_vfs_kern_path(struct ksmbd_work *work,
117 			char *name, unsigned int flags, struct path *path,
118 			bool caseless);
119 struct dentry *ksmbd_vfs_kern_path_create(struct ksmbd_work *work,
120 					  const char *name,
121 					  unsigned int flags,
122 					  struct path *path);
123 int ksmbd_vfs_empty_dir(struct ksmbd_file *fp);
124 void ksmbd_vfs_set_fadvise(struct file *filp, __le32 option);
125 int ksmbd_vfs_zero_data(struct ksmbd_work *work, struct ksmbd_file *fp,
126 			loff_t off, loff_t len);
127 struct file_allocated_range_buffer;
128 int ksmbd_vfs_fqar_lseek(struct ksmbd_file *fp, loff_t start, loff_t length,
129 			 struct file_allocated_range_buffer *ranges,
130 			 unsigned int in_count, unsigned int *out_count);
131 int ksmbd_vfs_unlink(struct user_namespace *user_ns,
132 		     struct dentry *dir, struct dentry *dentry);
133 void *ksmbd_vfs_init_kstat(char **p, struct ksmbd_kstat *ksmbd_kstat);
134 int ksmbd_vfs_fill_dentry_attrs(struct ksmbd_work *work,
135 				struct user_namespace *user_ns,
136 				struct dentry *dentry,
137 				struct ksmbd_kstat *ksmbd_kstat);
138 void ksmbd_vfs_posix_lock_wait(struct file_lock *flock);
139 int ksmbd_vfs_posix_lock_wait_timeout(struct file_lock *flock, long timeout);
140 void ksmbd_vfs_posix_lock_unblock(struct file_lock *flock);
141 int ksmbd_vfs_remove_acl_xattrs(struct user_namespace *user_ns,
142 				struct dentry *dentry);
143 int ksmbd_vfs_remove_sd_xattrs(struct user_namespace *user_ns,
144 			       struct dentry *dentry);
145 int ksmbd_vfs_set_sd_xattr(struct ksmbd_conn *conn,
146 			   struct user_namespace *user_ns,
147 			   struct dentry *dentry,
148 			   struct smb_ntsd *pntsd, int len);
149 int ksmbd_vfs_get_sd_xattr(struct ksmbd_conn *conn,
150 			   struct user_namespace *user_ns,
151 			   struct dentry *dentry,
152 			   struct smb_ntsd **pntsd);
153 int ksmbd_vfs_set_dos_attrib_xattr(struct user_namespace *user_ns,
154 				   struct dentry *dentry,
155 				   struct xattr_dos_attrib *da);
156 int ksmbd_vfs_get_dos_attrib_xattr(struct user_namespace *user_ns,
157 				   struct dentry *dentry,
158 				   struct xattr_dos_attrib *da);
159 int ksmbd_vfs_set_init_posix_acl(struct user_namespace *user_ns,
160 				 struct inode *inode);
161 int ksmbd_vfs_inherit_posix_acl(struct user_namespace *user_ns,
162 				struct inode *inode,
163 				struct inode *parent_inode);
164 #endif /* __KSMBD_VFS_H__ */
165