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/rwsem.h>
12 #include <linux/spinlock.h>
13 #include <linux/idr.h>
14 #include <linux/workqueue.h>
15
16 #include "vfs.h"
17
18 /* Windows style file permissions for extended response */
19 #define FILE_GENERIC_ALL 0x1F01FF
20 #define FILE_GENERIC_READ 0x120089
21 #define FILE_GENERIC_WRITE 0x120116
22 #define FILE_GENERIC_EXECUTE 0X1200a0
23
24 #define KSMBD_START_FID 0
25 #define KSMBD_NO_FID (INT_MAX)
26 #define SMB2_NO_FID (0xFFFFFFFFFFFFFFFFULL)
27
28 struct ksmbd_conn;
29 struct ksmbd_session;
30
31 struct ksmbd_lock {
32 struct file_lock *fl;
33 struct list_head clist;
34 struct list_head flist;
35 struct list_head llist;
36 unsigned int flags;
37 int cmd;
38 int zero_len;
39 unsigned long long start;
40 unsigned long long end;
41 };
42
43 struct stream {
44 char *name;
45 ssize_t size;
46 };
47
48 struct ksmbd_inode {
49 rwlock_t m_lock;
50 atomic_t m_count;
51 atomic_t op_count;
52 /* opinfo count for streams */
53 atomic_t sop_count;
54 struct inode *m_inode;
55 unsigned int m_flags;
56 struct hlist_node m_hash;
57 struct list_head m_fp_list;
58 struct list_head m_op_list;
59 struct oplock_info *m_opinfo;
60 __le32 m_fattr;
61 };
62
63 struct ksmbd_file {
64 struct file *filp;
65 char *filename;
66 u64 persistent_id;
67 u64 volatile_id;
68
69 spinlock_t f_lock;
70
71 struct ksmbd_inode *f_ci;
72 struct ksmbd_inode *f_parent_ci;
73 struct oplock_info __rcu *f_opinfo;
74 struct ksmbd_conn *conn;
75 struct ksmbd_tree_connect *tcon;
76
77 atomic_t refcount;
78 __le32 daccess;
79 __le32 saccess;
80 __le32 coption;
81 __le32 cdoption;
82 __u64 create_time;
83 __u64 itime;
84
85 bool is_nt_open;
86 bool attrib_only;
87
88 char client_guid[16];
89 char create_guid[16];
90 char app_instance_id[16];
91
92 struct stream stream;
93 struct list_head node;
94 struct list_head blocked_works;
95 struct list_head lock_list;
96
97 int durable_timeout;
98
99 /* for SMB1 */
100 int pid;
101
102 /* conflict lock fail count for SMB1 */
103 unsigned int cflock_cnt;
104 /* last lock failure start offset for SMB1 */
105 unsigned long long llock_fstart;
106
107 int dirent_offset;
108
109 /* if ls is happening on directory, below is valid*/
110 struct ksmbd_readdir_data readdir_data;
111 int dot_dotdot[2];
112 };
113
set_ctx_actor(struct dir_context * ctx,filldir_t actor)114 static inline void set_ctx_actor(struct dir_context *ctx,
115 filldir_t actor)
116 {
117 ctx->actor = actor;
118 }
119
120 #define KSMBD_NR_OPEN_DEFAULT BITS_PER_LONG
121
122 struct ksmbd_file_table {
123 rwlock_t lock;
124 struct idr *idr;
125 };
126
has_file_id(u64 id)127 static inline bool has_file_id(u64 id)
128 {
129 return id < KSMBD_NO_FID;
130 }
131
ksmbd_stream_fd(struct ksmbd_file * fp)132 static inline bool ksmbd_stream_fd(struct ksmbd_file *fp)
133 {
134 return fp->stream.name != NULL;
135 }
136
137 int ksmbd_init_file_table(struct ksmbd_file_table *ft);
138 void ksmbd_destroy_file_table(struct ksmbd_file_table *ft);
139 int ksmbd_close_fd(struct ksmbd_work *work, u64 id);
140 struct ksmbd_file *ksmbd_lookup_fd_fast(struct ksmbd_work *work, u64 id);
141 struct ksmbd_file *ksmbd_lookup_foreign_fd(struct ksmbd_work *work, u64 id);
142 struct ksmbd_file *ksmbd_lookup_fd_slow(struct ksmbd_work *work, u64 id,
143 u64 pid);
144 void ksmbd_fd_put(struct ksmbd_work *work, struct ksmbd_file *fp);
145 struct ksmbd_file *ksmbd_lookup_durable_fd(unsigned long long id);
146 struct ksmbd_file *ksmbd_lookup_fd_cguid(char *cguid);
147 struct ksmbd_file *ksmbd_lookup_fd_inode(struct inode *inode);
148 unsigned int ksmbd_open_durable_fd(struct ksmbd_file *fp);
149 struct ksmbd_file *ksmbd_open_fd(struct ksmbd_work *work, struct file *filp);
150 void ksmbd_close_tree_conn_fds(struct ksmbd_work *work);
151 void ksmbd_close_session_fds(struct ksmbd_work *work);
152 int ksmbd_close_inode_fds(struct ksmbd_work *work, struct inode *inode);
153 int ksmbd_init_global_file_table(void);
154 void ksmbd_free_global_file_table(void);
155 void ksmbd_set_fd_limit(unsigned long limit);
156
157 /*
158 * INODE hash
159 */
160 int __init ksmbd_inode_hash_init(void);
161 void ksmbd_release_inode_hash(void);
162
163 enum KSMBD_INODE_STATUS {
164 KSMBD_INODE_STATUS_OK,
165 KSMBD_INODE_STATUS_UNKNOWN,
166 KSMBD_INODE_STATUS_PENDING_DELETE,
167 };
168
169 int ksmbd_query_inode_status(struct inode *inode);
170 bool ksmbd_inode_pending_delete(struct ksmbd_file *fp);
171 void ksmbd_set_inode_pending_delete(struct ksmbd_file *fp);
172 void ksmbd_clear_inode_pending_delete(struct ksmbd_file *fp);
173 void ksmbd_fd_set_delete_on_close(struct ksmbd_file *fp,
174 int file_info);
175 int ksmbd_init_file_cache(void);
176 void ksmbd_exit_file_cache(void);
177 #endif /* __VFS_CACHE_H__ */
178