1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * Copyright (C) 2019 Samsung Electronics Co., Ltd. 4 */ 5 6 #ifndef __VFS_CACHE_H__ 7 #define __VFS_CACHE_H__ 8 9 #include <linux/file.h> 10 #include <linux/fs.h> 11 #include <linux/mutex.h> 12 #include <linux/rwsem.h> 13 #include <linux/spinlock.h> 14 #include <linux/idr.h> 15 #include <linux/workqueue.h> 16 17 #include "vfs.h" 18 #include "mgmt/share_config.h" 19 20 /* Windows style file permissions for extended response */ 21 #define FILE_GENERIC_ALL 0x1F01FF 22 #define FILE_GENERIC_READ 0x120089 23 #define FILE_GENERIC_WRITE 0x120116 24 #define FILE_GENERIC_EXECUTE 0X1200a0 25 26 /* 27 * Start volatile/persistent file id allocation at 1. A file id of 0 yields an 28 * SMB2 FileId of {0, 0}, which clients (e.g. Windows, Samba) treat as a null 29 * handle and never close, leaking the open on the server. 30 */ 31 #define KSMBD_START_FID 1 32 #define KSMBD_NO_FID (INT_MAX) 33 #define SMB2_NO_FID (0xFFFFFFFFFFFFFFFFULL) 34 35 struct ksmbd_conn; 36 struct ksmbd_session; 37 38 struct ksmbd_lock { 39 struct file_lock *fl; 40 struct ksmbd_conn *conn; 41 struct list_head clist; 42 struct list_head flist; 43 struct list_head llist; 44 unsigned int flags; 45 int cmd; 46 int zero_len; 47 unsigned long long start; 48 unsigned long long end; 49 }; 50 51 struct stream { 52 char *name; 53 ssize_t size; 54 loff_t pos; 55 }; 56 57 struct ksmbd_inode { 58 struct rw_semaphore m_lock; 59 atomic_t m_count; 60 atomic_t op_count; 61 /* opinfo count for streams */ 62 atomic_t sop_count; 63 struct dentry *m_de; 64 unsigned int m_flags; 65 struct hlist_node m_hash; 66 struct list_head m_fp_list; 67 struct list_head m_op_list; 68 struct oplock_info *m_opinfo; 69 __le32 m_fattr; 70 }; 71 72 enum { 73 FP_NEW = 0, 74 FP_INITED, 75 FP_CLOSED 76 }; 77 78 /* Owner information for durable handle reconnect */ 79 struct durable_owner { 80 unsigned int uid; 81 unsigned int gid; 82 char *name; 83 }; 84 85 struct ksmbd_file { 86 struct file *filp; 87 u64 persistent_id; 88 u64 volatile_id; 89 u64 durable_volatile_id; 90 91 spinlock_t f_lock; 92 93 struct ksmbd_inode *f_ci; 94 struct ksmbd_inode *f_parent_ci; 95 struct oplock_info __rcu *f_opinfo; 96 struct ksmbd_conn *conn; 97 struct ksmbd_tree_connect *tcon; 98 99 atomic_t refcount; 100 __le32 daccess; 101 __le32 saccess; 102 __le32 coption; 103 __le32 cdoption; 104 __u64 create_time; 105 __u64 change_time; 106 __u64 allocation_size; 107 __u64 itime; 108 __u64 open_mtime; 109 110 bool is_nt_open; 111 bool attrib_only; 112 113 char client_guid[16]; 114 char create_guid[16]; 115 char app_instance_id[16]; 116 117 struct stream stream; 118 struct list_head node; 119 struct list_head blocked_works; 120 struct list_head lock_list; 121 /* 122 * Per-handle FileDispositionInformation delete-pending state for a 123 * stream handle -- separate from ksmbd_inode's inode-wide m_flags, 124 * which have no way to record which stream on a multi-stream file 125 * was actually marked for deletion. See ksmbd_fd_set_delete_pending(). 126 */ 127 bool stream_del_pending; 128 129 unsigned int durable_timeout; 130 unsigned int durable_scavenger_timeout; 131 132 /* if ls is happening on directory, below is valid*/ 133 struct ksmbd_readdir_data readdir_data; 134 struct mutex readdir_lock; 135 int dot_dotdot[2]; 136 unsigned int f_state; 137 bool reserve_lease_break; 138 bool is_durable; 139 bool is_persistent; 140 bool is_resilient; 141 bool durable_reconnect_disabled; 142 143 bool is_posix_ctxt; 144 struct durable_owner owner; 145 146 /* 147 * Pending CHANGE_NOTIFY completions for this handle, sent with 148 * STATUS_NOTIFY_CLEANUP when the handle is closed. 149 */ 150 struct list_head notify_pendings; 151 }; 152 153 static inline void set_ctx_actor(struct dir_context *ctx, 154 filldir_t actor) 155 { 156 ctx->actor = actor; 157 } 158 159 #define KSMBD_NR_OPEN_DEFAULT BITS_PER_LONG 160 161 struct ksmbd_file_table { 162 rwlock_t lock; 163 struct idr *idr; 164 }; 165 166 static inline bool has_file_id(u64 id) 167 { 168 return id < KSMBD_NO_FID; 169 } 170 171 static inline bool ksmbd_stream_fd(struct ksmbd_file *fp) 172 { 173 return fp->stream.name != NULL; 174 } 175 176 int ksmbd_init_file_table(struct ksmbd_file_table *ft); 177 void ksmbd_destroy_file_table(struct ksmbd_session *sess); 178 int ksmbd_close_fd(struct ksmbd_work *work, u64 id); 179 struct ksmbd_file *ksmbd_lookup_fd_fast(struct ksmbd_work *work, u64 id); 180 struct ksmbd_file *ksmbd_lookup_foreign_fd(struct ksmbd_work *work, u64 id); 181 struct ksmbd_file *ksmbd_lookup_fd_slow(struct ksmbd_work *work, u64 id, 182 u64 pid); 183 void ksmbd_fd_put(struct ksmbd_work *work, struct ksmbd_file *fp); 184 struct ksmbd_inode *ksmbd_inode_lookup_lock(struct dentry *d); 185 void ksmbd_inode_put(struct ksmbd_inode *ci); 186 bool ksmbd_close_disconnected_durable_delete_on_close(struct dentry *dentry); 187 struct ksmbd_file *ksmbd_lookup_global_fd(unsigned long long id); 188 struct ksmbd_file *ksmbd_lookup_durable_fd(unsigned long long id); 189 void ksmbd_put_durable_fd(struct ksmbd_file *fp); 190 int ksmbd_invalidate_durable_fd(unsigned long long id); 191 bool ksmbd_has_other_active_fd(struct ksmbd_file *fp); 192 bool ksmbd_has_stream_without_delete_share(struct ksmbd_file *fp); 193 int ksmbd_close_fd_app_instance_id(char *app_instance_id); 194 struct ksmbd_file *ksmbd_lookup_fd_cguid(char *cguid); 195 struct ksmbd_file *ksmbd_lookup_fd_inode(struct dentry *dentry); 196 bool ksmbd_has_open_files(struct dentry *dentry); 197 unsigned int ksmbd_open_durable_fd(struct ksmbd_file *fp); 198 struct ksmbd_file *ksmbd_open_fd(struct ksmbd_work *work, struct file *filp); 199 void ksmbd_launch_ksmbd_durable_scavenger(void); 200 void ksmbd_stop_durable_scavenger(void); 201 void ksmbd_close_tree_conn_fds(struct ksmbd_work *work); 202 void ksmbd_close_session_fds(struct ksmbd_work *work); 203 int ksmbd_close_inode_fds(struct ksmbd_work *work, struct inode *inode); 204 int ksmbd_init_global_file_table(void); 205 void ksmbd_free_global_file_table(void); 206 void ksmbd_set_fd_limit(unsigned long limit); 207 int ksmbd_update_fstate(struct ksmbd_file_table *ft, struct ksmbd_file *fp, 208 unsigned int state); 209 bool ksmbd_vfs_compare_durable_owner(struct ksmbd_file *fp, 210 struct ksmbd_user *user); 211 212 /* 213 * INODE hash 214 */ 215 int __init ksmbd_inode_hash_init(void); 216 void ksmbd_release_inode_hash(void); 217 218 enum KSMBD_INODE_STATUS { 219 KSMBD_INODE_STATUS_OK, 220 KSMBD_INODE_STATUS_UNKNOWN, 221 KSMBD_INODE_STATUS_PENDING_DELETE, 222 }; 223 224 int ksmbd_query_inode_status(struct dentry *dentry); 225 bool ksmbd_inode_pending_delete(struct ksmbd_file *fp); 226 void ksmbd_set_inode_pending_delete(struct ksmbd_file *fp); 227 void ksmbd_clear_inode_pending_delete(struct ksmbd_file *fp); 228 void ksmbd_fd_set_delete_on_close(struct ksmbd_file *fp, 229 int file_info); 230 void ksmbd_fd_set_delete_pending(struct ksmbd_file *fp); 231 void ksmbd_fd_clear_delete_pending(struct ksmbd_file *fp); 232 int ksmbd_reopen_durable_fd(struct ksmbd_work *work, struct ksmbd_file *fp); 233 int ksmbd_validate_name_reconnect(struct ksmbd_share_config *share, 234 struct ksmbd_file *fp, char *name); 235 int ksmbd_init_file_cache(void); 236 void ksmbd_exit_file_cache(void); 237 #endif /* __VFS_CACHE_H__ */ 238