1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2016 Namjae Jeon <linkinjeon@kernel.org>
4 * Copyright (C) 2019 Samsung Electronics Co., Ltd.
8 #include <linux/filelock.h>
9 #include <linux/slab.h>
10 #include <linux/vmalloc.h>
13 #include "vfs_cache.h"
16 #include "connection.h"
17 #include "mgmt/tree_connect.h"
18 #include "mgmt/user_session.h"
19 #include "smb_common.h"
21 #define S_DEL_PENDING 1
22 #define S_DEL_ON_CLS 2
23 #define S_DEL_ON_CLS_STREAM 8
25 static unsigned int inode_hash_mask __read_mostly;
26 static unsigned int inode_hash_shift __read_mostly;
27 static struct hlist_head *inode_hashtable __read_mostly;
28 static DEFINE_RWLOCK(inode_hash_lock);
30 static struct ksmbd_file_table global_ft;
31 static atomic_long_t fd_limit;
32 static struct kmem_cache *filp_cache;
34 void ksmbd_set_fd_limit(unsigned long limit)
36 limit = min(limit, get_max_files());
37 atomic_long_set(&fd_limit, limit);
40 static bool fd_limit_depleted(void)
42 long v = atomic_long_dec_return(&fd_limit);
46 atomic_long_inc(&fd_limit);
50 static void fd_limit_close(void)
52 atomic_long_inc(&fd_limit);
59 static unsigned long inode_hash(struct super_block *sb, unsigned long hashval)
63 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
65 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> inode_hash_shift);
66 return tmp & inode_hash_mask;
69 static struct ksmbd_inode *__ksmbd_inode_lookup(struct dentry *de)
71 struct hlist_head *head = inode_hashtable +
72 inode_hash(d_inode(de)->i_sb, (unsigned long)de);
73 struct ksmbd_inode *ci = NULL, *ret_ci = NULL;
75 hlist_for_each_entry(ci, head, m_hash) {
77 if (atomic_inc_not_zero(&ci->m_count))
85 static struct ksmbd_inode *ksmbd_inode_lookup(struct ksmbd_file *fp)
87 return __ksmbd_inode_lookup(fp->filp->f_path.dentry);
90 int ksmbd_query_inode_status(struct dentry *dentry)
92 struct ksmbd_inode *ci;
93 int ret = KSMBD_INODE_STATUS_UNKNOWN;
95 read_lock(&inode_hash_lock);
96 ci = __ksmbd_inode_lookup(dentry);
98 ret = KSMBD_INODE_STATUS_OK;
99 if (ci->m_flags & (S_DEL_PENDING | S_DEL_ON_CLS))
100 ret = KSMBD_INODE_STATUS_PENDING_DELETE;
101 atomic_dec(&ci->m_count);
103 read_unlock(&inode_hash_lock);
107 bool ksmbd_inode_pending_delete(struct ksmbd_file *fp)
109 return (fp->f_ci->m_flags & (S_DEL_PENDING | S_DEL_ON_CLS));
112 void ksmbd_set_inode_pending_delete(struct ksmbd_file *fp)
114 fp->f_ci->m_flags |= S_DEL_PENDING;
117 void ksmbd_clear_inode_pending_delete(struct ksmbd_file *fp)
119 fp->f_ci->m_flags &= ~S_DEL_PENDING;
122 void ksmbd_fd_set_delete_on_close(struct ksmbd_file *fp,
125 if (ksmbd_stream_fd(fp)) {
126 fp->f_ci->m_flags |= S_DEL_ON_CLS_STREAM;
130 fp->f_ci->m_flags |= S_DEL_ON_CLS;
133 static void ksmbd_inode_hash(struct ksmbd_inode *ci)
135 struct hlist_head *b = inode_hashtable +
136 inode_hash(d_inode(ci->m_de)->i_sb, (unsigned long)ci->m_de);
138 hlist_add_head(&ci->m_hash, b);
141 static void ksmbd_inode_unhash(struct ksmbd_inode *ci)
143 write_lock(&inode_hash_lock);
144 hlist_del_init(&ci->m_hash);
145 write_unlock(&inode_hash_lock);
148 static int ksmbd_inode_init(struct ksmbd_inode *ci, struct ksmbd_file *fp)
150 atomic_set(&ci->m_count, 1);
151 atomic_set(&ci->op_count, 0);
152 atomic_set(&ci->sop_count, 0);
155 INIT_LIST_HEAD(&ci->m_fp_list);
156 INIT_LIST_HEAD(&ci->m_op_list);
157 rwlock_init(&ci->m_lock);
158 ci->m_de = fp->filp->f_path.dentry;
162 static struct ksmbd_inode *ksmbd_inode_get(struct ksmbd_file *fp)
164 struct ksmbd_inode *ci, *tmpci;
167 read_lock(&inode_hash_lock);
168 ci = ksmbd_inode_lookup(fp);
169 read_unlock(&inode_hash_lock);
173 ci = kmalloc(sizeof(struct ksmbd_inode), GFP_KERNEL);
177 rc = ksmbd_inode_init(ci, fp);
179 pr_err("inode initialized failed\n");
184 write_lock(&inode_hash_lock);
185 tmpci = ksmbd_inode_lookup(fp);
187 ksmbd_inode_hash(ci);
192 write_unlock(&inode_hash_lock);
196 static void ksmbd_inode_free(struct ksmbd_inode *ci)
198 ksmbd_inode_unhash(ci);
202 static void ksmbd_inode_put(struct ksmbd_inode *ci)
204 if (atomic_dec_and_test(&ci->m_count))
205 ksmbd_inode_free(ci);
208 int __init ksmbd_inode_hash_init(void)
211 unsigned long numentries = 16384;
212 unsigned long bucketsize = sizeof(struct hlist_head);
215 inode_hash_shift = ilog2(numentries);
216 inode_hash_mask = (1 << inode_hash_shift) - 1;
218 size = bucketsize << inode_hash_shift;
220 /* init master fp hash table */
221 inode_hashtable = vmalloc(size);
222 if (!inode_hashtable)
225 for (loop = 0; loop < (1U << inode_hash_shift); loop++)
226 INIT_HLIST_HEAD(&inode_hashtable[loop]);
230 void ksmbd_release_inode_hash(void)
232 vfree(inode_hashtable);
235 static void __ksmbd_inode_close(struct ksmbd_file *fp)
237 struct ksmbd_inode *ci = fp->f_ci;
242 if (ksmbd_stream_fd(fp) && (ci->m_flags & S_DEL_ON_CLS_STREAM)) {
243 ci->m_flags &= ~S_DEL_ON_CLS_STREAM;
244 err = ksmbd_vfs_remove_xattr(file_mnt_idmap(filp),
248 pr_err("remove xattr failed : %s\n",
252 if (atomic_dec_and_test(&ci->m_count)) {
253 write_lock(&ci->m_lock);
254 if (ci->m_flags & (S_DEL_ON_CLS | S_DEL_PENDING)) {
255 ci->m_flags &= ~(S_DEL_ON_CLS | S_DEL_PENDING);
256 write_unlock(&ci->m_lock);
257 ksmbd_vfs_unlink(filp);
258 write_lock(&ci->m_lock);
260 write_unlock(&ci->m_lock);
262 ksmbd_inode_free(ci);
266 static void __ksmbd_remove_durable_fd(struct ksmbd_file *fp)
268 if (!has_file_id(fp->persistent_id))
271 write_lock(&global_ft.lock);
272 idr_remove(global_ft.idr, fp->persistent_id);
273 write_unlock(&global_ft.lock);
276 static void __ksmbd_remove_fd(struct ksmbd_file_table *ft, struct ksmbd_file *fp)
278 if (!has_file_id(fp->volatile_id))
281 write_lock(&fp->f_ci->m_lock);
282 list_del_init(&fp->node);
283 write_unlock(&fp->f_ci->m_lock);
285 write_lock(&ft->lock);
286 idr_remove(ft->idr, fp->volatile_id);
287 write_unlock(&ft->lock);
290 static void __ksmbd_close_fd(struct ksmbd_file_table *ft, struct ksmbd_file *fp)
293 struct ksmbd_lock *smb_lock, *tmp_lock;
296 __ksmbd_remove_durable_fd(fp);
297 __ksmbd_remove_fd(ft, fp);
299 close_id_del_oplock(fp);
302 __ksmbd_inode_close(fp);
303 if (!IS_ERR_OR_NULL(filp))
306 /* because the reference count of fp is 0, it is guaranteed that
307 * there are not accesses to fp->lock_list.
309 list_for_each_entry_safe(smb_lock, tmp_lock, &fp->lock_list, flist) {
310 spin_lock(&fp->conn->llist_lock);
311 list_del(&smb_lock->clist);
312 spin_unlock(&fp->conn->llist_lock);
314 list_del(&smb_lock->flist);
315 locks_free_lock(smb_lock->fl);
319 if (ksmbd_stream_fd(fp))
320 kfree(fp->stream.name);
321 kmem_cache_free(filp_cache, fp);
324 static struct ksmbd_file *ksmbd_fp_get(struct ksmbd_file *fp)
326 if (fp->f_state != FP_INITED)
329 if (!atomic_inc_not_zero(&fp->refcount))
334 static struct ksmbd_file *__ksmbd_lookup_fd(struct ksmbd_file_table *ft,
337 struct ksmbd_file *fp;
339 if (!has_file_id(id))
342 read_lock(&ft->lock);
343 fp = idr_find(ft->idr, id);
345 fp = ksmbd_fp_get(fp);
346 read_unlock(&ft->lock);
350 static void __put_fd_final(struct ksmbd_work *work, struct ksmbd_file *fp)
352 __ksmbd_close_fd(&work->sess->file_table, fp);
353 atomic_dec(&work->conn->stats.open_files_count);
356 static void set_close_state_blocked_works(struct ksmbd_file *fp)
358 struct ksmbd_work *cancel_work;
360 spin_lock(&fp->f_lock);
361 list_for_each_entry(cancel_work, &fp->blocked_works,
363 cancel_work->state = KSMBD_WORK_CLOSED;
364 cancel_work->cancel_fn(cancel_work->cancel_argv);
366 spin_unlock(&fp->f_lock);
369 int ksmbd_close_fd(struct ksmbd_work *work, u64 id)
371 struct ksmbd_file *fp;
372 struct ksmbd_file_table *ft;
374 if (!has_file_id(id))
377 ft = &work->sess->file_table;
378 write_lock(&ft->lock);
379 fp = idr_find(ft->idr, id);
381 set_close_state_blocked_works(fp);
383 if (fp->f_state != FP_INITED)
386 fp->f_state = FP_CLOSED;
387 if (!atomic_dec_and_test(&fp->refcount))
391 write_unlock(&ft->lock);
396 __put_fd_final(work, fp);
400 void ksmbd_fd_put(struct ksmbd_work *work, struct ksmbd_file *fp)
405 if (!atomic_dec_and_test(&fp->refcount))
407 __put_fd_final(work, fp);
410 static bool __sanity_check(struct ksmbd_tree_connect *tcon, struct ksmbd_file *fp)
414 if (fp->tcon != tcon)
419 struct ksmbd_file *ksmbd_lookup_foreign_fd(struct ksmbd_work *work, u64 id)
421 return __ksmbd_lookup_fd(&work->sess->file_table, id);
424 struct ksmbd_file *ksmbd_lookup_fd_fast(struct ksmbd_work *work, u64 id)
426 struct ksmbd_file *fp = __ksmbd_lookup_fd(&work->sess->file_table, id);
428 if (__sanity_check(work->tcon, fp))
431 ksmbd_fd_put(work, fp);
435 struct ksmbd_file *ksmbd_lookup_fd_slow(struct ksmbd_work *work, u64 id,
438 struct ksmbd_file *fp;
440 if (!has_file_id(id)) {
441 id = work->compound_fid;
442 pid = work->compound_pfid;
445 fp = __ksmbd_lookup_fd(&work->sess->file_table, id);
446 if (!__sanity_check(work->tcon, fp)) {
447 ksmbd_fd_put(work, fp);
450 if (fp->persistent_id != pid) {
451 ksmbd_fd_put(work, fp);
457 struct ksmbd_file *ksmbd_lookup_durable_fd(unsigned long long id)
459 return __ksmbd_lookup_fd(&global_ft, id);
462 struct ksmbd_file *ksmbd_lookup_fd_cguid(char *cguid)
464 struct ksmbd_file *fp = NULL;
467 read_lock(&global_ft.lock);
468 idr_for_each_entry(global_ft.idr, fp, id) {
469 if (!memcmp(fp->create_guid,
471 SMB2_CREATE_GUID_SIZE)) {
472 fp = ksmbd_fp_get(fp);
476 read_unlock(&global_ft.lock);
481 struct ksmbd_file *ksmbd_lookup_fd_inode(struct dentry *dentry)
483 struct ksmbd_file *lfp;
484 struct ksmbd_inode *ci;
485 struct inode *inode = d_inode(dentry);
487 read_lock(&inode_hash_lock);
488 ci = __ksmbd_inode_lookup(dentry);
489 read_unlock(&inode_hash_lock);
493 read_lock(&ci->m_lock);
494 list_for_each_entry(lfp, &ci->m_fp_list, node) {
495 if (inode == file_inode(lfp->filp)) {
496 atomic_dec(&ci->m_count);
497 lfp = ksmbd_fp_get(lfp);
498 read_unlock(&ci->m_lock);
502 atomic_dec(&ci->m_count);
503 read_unlock(&ci->m_lock);
507 #define OPEN_ID_TYPE_VOLATILE_ID (0)
508 #define OPEN_ID_TYPE_PERSISTENT_ID (1)
510 static void __open_id_set(struct ksmbd_file *fp, u64 id, int type)
512 if (type == OPEN_ID_TYPE_VOLATILE_ID)
513 fp->volatile_id = id;
514 if (type == OPEN_ID_TYPE_PERSISTENT_ID)
515 fp->persistent_id = id;
518 static int __open_id(struct ksmbd_file_table *ft, struct ksmbd_file *fp,
524 if (type == OPEN_ID_TYPE_VOLATILE_ID && fd_limit_depleted()) {
525 __open_id_set(fp, KSMBD_NO_FID, type);
529 idr_preload(GFP_KERNEL);
530 write_lock(&ft->lock);
531 ret = idr_alloc_cyclic(ft->idr, fp, 0, INT_MAX - 1, GFP_NOWAIT);
540 __open_id_set(fp, id, type);
541 write_unlock(&ft->lock);
546 unsigned int ksmbd_open_durable_fd(struct ksmbd_file *fp)
548 __open_id(&global_ft, fp, OPEN_ID_TYPE_PERSISTENT_ID);
549 return fp->persistent_id;
552 struct ksmbd_file *ksmbd_open_fd(struct ksmbd_work *work, struct file *filp)
554 struct ksmbd_file *fp;
557 fp = kmem_cache_zalloc(filp_cache, GFP_KERNEL);
559 pr_err("Failed to allocate memory\n");
560 return ERR_PTR(-ENOMEM);
563 INIT_LIST_HEAD(&fp->blocked_works);
564 INIT_LIST_HEAD(&fp->node);
565 INIT_LIST_HEAD(&fp->lock_list);
566 spin_lock_init(&fp->f_lock);
567 atomic_set(&fp->refcount, 1);
570 fp->conn = work->conn;
571 fp->tcon = work->tcon;
572 fp->volatile_id = KSMBD_NO_FID;
573 fp->persistent_id = KSMBD_NO_FID;
574 fp->f_state = FP_NEW;
575 fp->f_ci = ksmbd_inode_get(fp);
582 ret = __open_id(&work->sess->file_table, fp, OPEN_ID_TYPE_VOLATILE_ID);
584 ksmbd_inode_put(fp->f_ci);
588 atomic_inc(&work->conn->stats.open_files_count);
592 kmem_cache_free(filp_cache, fp);
596 void ksmbd_update_fstate(struct ksmbd_file_table *ft, struct ksmbd_file *fp,
602 write_lock(&ft->lock);
604 write_unlock(&ft->lock);
608 __close_file_table_ids(struct ksmbd_file_table *ft,
609 struct ksmbd_tree_connect *tcon,
610 bool (*skip)(struct ksmbd_tree_connect *tcon,
611 struct ksmbd_file *fp))
614 struct ksmbd_file *fp;
617 idr_for_each_entry(ft->idr, fp, id) {
621 set_close_state_blocked_works(fp);
623 if (!atomic_dec_and_test(&fp->refcount))
625 __ksmbd_close_fd(ft, fp);
631 static bool tree_conn_fd_check(struct ksmbd_tree_connect *tcon,
632 struct ksmbd_file *fp)
634 return fp->tcon != tcon;
637 static bool session_fd_check(struct ksmbd_tree_connect *tcon,
638 struct ksmbd_file *fp)
643 void ksmbd_close_tree_conn_fds(struct ksmbd_work *work)
645 int num = __close_file_table_ids(&work->sess->file_table,
649 atomic_sub(num, &work->conn->stats.open_files_count);
652 void ksmbd_close_session_fds(struct ksmbd_work *work)
654 int num = __close_file_table_ids(&work->sess->file_table,
658 atomic_sub(num, &work->conn->stats.open_files_count);
661 int ksmbd_init_global_file_table(void)
663 return ksmbd_init_file_table(&global_ft);
666 void ksmbd_free_global_file_table(void)
668 struct ksmbd_file *fp = NULL;
671 idr_for_each_entry(global_ft.idr, fp, id) {
672 __ksmbd_remove_durable_fd(fp);
673 kmem_cache_free(filp_cache, fp);
676 ksmbd_destroy_file_table(&global_ft);
679 int ksmbd_init_file_table(struct ksmbd_file_table *ft)
681 ft->idr = kzalloc(sizeof(struct idr), GFP_KERNEL);
686 rwlock_init(&ft->lock);
690 void ksmbd_destroy_file_table(struct ksmbd_file_table *ft)
695 __close_file_table_ids(ft, NULL, session_fd_check);
696 idr_destroy(ft->idr);
701 int ksmbd_init_file_cache(void)
703 filp_cache = kmem_cache_create("ksmbd_file_cache",
704 sizeof(struct ksmbd_file), 0,
705 SLAB_HWCACHE_ALIGN, NULL);
712 pr_err("failed to allocate file cache\n");
716 void ksmbd_exit_file_cache(void)
718 kmem_cache_destroy(filp_cache);