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

source code of linux/fs/smb/server/vfs.h