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 struct ksmbd_inode *ksmbd_inode_lookup_lock(struct dentry *d)
92 struct ksmbd_inode *ci;
94 read_lock(&inode_hash_lock);
95 ci = __ksmbd_inode_lookup(d);
96 read_unlock(&inode_hash_lock);
101 int ksmbd_query_inode_status(struct dentry *dentry)
103 struct ksmbd_inode *ci;
104 int ret = KSMBD_INODE_STATUS_UNKNOWN;
106 read_lock(&inode_hash_lock);
107 ci = __ksmbd_inode_lookup(dentry);
109 ret = KSMBD_INODE_STATUS_OK;
110 if (ci->m_flags & (S_DEL_PENDING | S_DEL_ON_CLS))
111 ret = KSMBD_INODE_STATUS_PENDING_DELETE;
112 atomic_dec(&ci->m_count);
114 read_unlock(&inode_hash_lock);
118 bool ksmbd_inode_pending_delete(struct ksmbd_file *fp)
120 return (fp->f_ci->m_flags & (S_DEL_PENDING | S_DEL_ON_CLS));
123 void ksmbd_set_inode_pending_delete(struct ksmbd_file *fp)
125 fp->f_ci->m_flags |= S_DEL_PENDING;
128 void ksmbd_clear_inode_pending_delete(struct ksmbd_file *fp)
130 fp->f_ci->m_flags &= ~S_DEL_PENDING;
133 void ksmbd_fd_set_delete_on_close(struct ksmbd_file *fp,
136 if (ksmbd_stream_fd(fp)) {
137 fp->f_ci->m_flags |= S_DEL_ON_CLS_STREAM;
141 fp->f_ci->m_flags |= S_DEL_ON_CLS;
144 static void ksmbd_inode_hash(struct ksmbd_inode *ci)
146 struct hlist_head *b = inode_hashtable +
147 inode_hash(d_inode(ci->m_de)->i_sb, (unsigned long)ci->m_de);
149 hlist_add_head(&ci->m_hash, b);
152 static void ksmbd_inode_unhash(struct ksmbd_inode *ci)
154 write_lock(&inode_hash_lock);
155 hlist_del_init(&ci->m_hash);
156 write_unlock(&inode_hash_lock);
159 static int ksmbd_inode_init(struct ksmbd_inode *ci, struct ksmbd_file *fp)
161 atomic_set(&ci->m_count, 1);
162 atomic_set(&ci->op_count, 0);
163 atomic_set(&ci->sop_count, 0);
166 INIT_LIST_HEAD(&ci->m_fp_list);
167 INIT_LIST_HEAD(&ci->m_op_list);
168 rwlock_init(&ci->m_lock);
169 ci->m_de = fp->filp->f_path.dentry;
173 static struct ksmbd_inode *ksmbd_inode_get(struct ksmbd_file *fp)
175 struct ksmbd_inode *ci, *tmpci;
178 read_lock(&inode_hash_lock);
179 ci = ksmbd_inode_lookup(fp);
180 read_unlock(&inode_hash_lock);
184 ci = kmalloc(sizeof(struct ksmbd_inode), GFP_KERNEL);
188 rc = ksmbd_inode_init(ci, fp);
190 pr_err("inode initialized failed\n");
195 write_lock(&inode_hash_lock);
196 tmpci = ksmbd_inode_lookup(fp);
198 ksmbd_inode_hash(ci);
203 write_unlock(&inode_hash_lock);
207 static void ksmbd_inode_free(struct ksmbd_inode *ci)
209 ksmbd_inode_unhash(ci);
213 void ksmbd_inode_put(struct ksmbd_inode *ci)
215 if (atomic_dec_and_test(&ci->m_count))
216 ksmbd_inode_free(ci);
219 int __init ksmbd_inode_hash_init(void)
222 unsigned long numentries = 16384;
223 unsigned long bucketsize = sizeof(struct hlist_head);
226 inode_hash_shift = ilog2(numentries);
227 inode_hash_mask = (1 << inode_hash_shift) - 1;
229 size = bucketsize << inode_hash_shift;
231 /* init master fp hash table */
232 inode_hashtable = vmalloc(size);
233 if (!inode_hashtable)
236 for (loop = 0; loop < (1U << inode_hash_shift); loop++)
237 INIT_HLIST_HEAD(&inode_hashtable[loop]);
241 void ksmbd_release_inode_hash(void)
243 vfree(inode_hashtable);
246 static void __ksmbd_inode_close(struct ksmbd_file *fp)
248 struct ksmbd_inode *ci = fp->f_ci;
253 if (ksmbd_stream_fd(fp) && (ci->m_flags & S_DEL_ON_CLS_STREAM)) {
254 ci->m_flags &= ~S_DEL_ON_CLS_STREAM;
255 err = ksmbd_vfs_remove_xattr(file_mnt_idmap(filp),
259 pr_err("remove xattr failed : %s\n",
263 if (atomic_dec_and_test(&ci->m_count)) {
264 write_lock(&ci->m_lock);
265 if (ci->m_flags & (S_DEL_ON_CLS | S_DEL_PENDING)) {
266 ci->m_flags &= ~(S_DEL_ON_CLS | S_DEL_PENDING);
267 write_unlock(&ci->m_lock);
268 ksmbd_vfs_unlink(filp);
269 write_lock(&ci->m_lock);
271 write_unlock(&ci->m_lock);
273 ksmbd_inode_free(ci);
277 static void __ksmbd_remove_durable_fd(struct ksmbd_file *fp)
279 if (!has_file_id(fp->persistent_id))
282 write_lock(&global_ft.lock);
283 idr_remove(global_ft.idr, fp->persistent_id);
284 write_unlock(&global_ft.lock);
287 static void __ksmbd_remove_fd(struct ksmbd_file_table *ft, struct ksmbd_file *fp)
289 if (!has_file_id(fp->volatile_id))
292 write_lock(&fp->f_ci->m_lock);
293 list_del_init(&fp->node);
294 write_unlock(&fp->f_ci->m_lock);
296 write_lock(&ft->lock);
297 idr_remove(ft->idr, fp->volatile_id);
298 write_unlock(&ft->lock);
301 static void __ksmbd_close_fd(struct ksmbd_file_table *ft, struct ksmbd_file *fp)
304 struct ksmbd_lock *smb_lock, *tmp_lock;
307 __ksmbd_remove_durable_fd(fp);
308 __ksmbd_remove_fd(ft, fp);
310 close_id_del_oplock(fp);
313 __ksmbd_inode_close(fp);
314 if (!IS_ERR_OR_NULL(filp))
317 /* because the reference count of fp is 0, it is guaranteed that
318 * there are not accesses to fp->lock_list.
320 list_for_each_entry_safe(smb_lock, tmp_lock, &fp->lock_list, flist) {
321 spin_lock(&fp->conn->llist_lock);
322 list_del(&smb_lock->clist);
323 spin_unlock(&fp->conn->llist_lock);
325 list_del(&smb_lock->flist);
326 locks_free_lock(smb_lock->fl);
330 if (ksmbd_stream_fd(fp))
331 kfree(fp->stream.name);
332 kmem_cache_free(filp_cache, fp);
335 static struct ksmbd_file *ksmbd_fp_get(struct ksmbd_file *fp)
337 if (fp->f_state != FP_INITED)
340 if (!atomic_inc_not_zero(&fp->refcount))
345 static struct ksmbd_file *__ksmbd_lookup_fd(struct ksmbd_file_table *ft,
348 struct ksmbd_file *fp;
350 if (!has_file_id(id))
353 read_lock(&ft->lock);
354 fp = idr_find(ft->idr, id);
356 fp = ksmbd_fp_get(fp);
357 read_unlock(&ft->lock);
361 static void __put_fd_final(struct ksmbd_work *work, struct ksmbd_file *fp)
363 __ksmbd_close_fd(&work->sess->file_table, fp);
364 atomic_dec(&work->conn->stats.open_files_count);
367 static void set_close_state_blocked_works(struct ksmbd_file *fp)
369 struct ksmbd_work *cancel_work;
371 spin_lock(&fp->f_lock);
372 list_for_each_entry(cancel_work, &fp->blocked_works,
374 cancel_work->state = KSMBD_WORK_CLOSED;
375 cancel_work->cancel_fn(cancel_work->cancel_argv);
377 spin_unlock(&fp->f_lock);
380 int ksmbd_close_fd(struct ksmbd_work *work, u64 id)
382 struct ksmbd_file *fp;
383 struct ksmbd_file_table *ft;
385 if (!has_file_id(id))
388 ft = &work->sess->file_table;
389 write_lock(&ft->lock);
390 fp = idr_find(ft->idr, id);
392 set_close_state_blocked_works(fp);
394 if (fp->f_state != FP_INITED)
397 fp->f_state = FP_CLOSED;
398 if (!atomic_dec_and_test(&fp->refcount))
402 write_unlock(&ft->lock);
407 __put_fd_final(work, fp);
411 void ksmbd_fd_put(struct ksmbd_work *work, struct ksmbd_file *fp)
416 if (!atomic_dec_and_test(&fp->refcount))
418 __put_fd_final(work, fp);
421 static bool __sanity_check(struct ksmbd_tree_connect *tcon, struct ksmbd_file *fp)
425 if (fp->tcon != tcon)
430 struct ksmbd_file *ksmbd_lookup_foreign_fd(struct ksmbd_work *work, u64 id)
432 return __ksmbd_lookup_fd(&work->sess->file_table, id);
435 struct ksmbd_file *ksmbd_lookup_fd_fast(struct ksmbd_work *work, u64 id)
437 struct ksmbd_file *fp = __ksmbd_lookup_fd(&work->sess->file_table, id);
439 if (__sanity_check(work->tcon, fp))
442 ksmbd_fd_put(work, fp);
446 struct ksmbd_file *ksmbd_lookup_fd_slow(struct ksmbd_work *work, u64 id,
449 struct ksmbd_file *fp;
451 if (!has_file_id(id)) {
452 id = work->compound_fid;
453 pid = work->compound_pfid;
456 fp = __ksmbd_lookup_fd(&work->sess->file_table, id);
457 if (!__sanity_check(work->tcon, fp)) {
458 ksmbd_fd_put(work, fp);
461 if (fp->persistent_id != pid) {
462 ksmbd_fd_put(work, fp);
468 struct ksmbd_file *ksmbd_lookup_durable_fd(unsigned long long id)
470 return __ksmbd_lookup_fd(&global_ft, id);
473 struct ksmbd_file *ksmbd_lookup_fd_cguid(char *cguid)
475 struct ksmbd_file *fp = NULL;
478 read_lock(&global_ft.lock);
479 idr_for_each_entry(global_ft.idr, fp, id) {
480 if (!memcmp(fp->create_guid,
482 SMB2_CREATE_GUID_SIZE)) {
483 fp = ksmbd_fp_get(fp);
487 read_unlock(&global_ft.lock);
492 struct ksmbd_file *ksmbd_lookup_fd_inode(struct dentry *dentry)
494 struct ksmbd_file *lfp;
495 struct ksmbd_inode *ci;
496 struct inode *inode = d_inode(dentry);
498 read_lock(&inode_hash_lock);
499 ci = __ksmbd_inode_lookup(dentry);
500 read_unlock(&inode_hash_lock);
504 read_lock(&ci->m_lock);
505 list_for_each_entry(lfp, &ci->m_fp_list, node) {
506 if (inode == file_inode(lfp->filp)) {
507 atomic_dec(&ci->m_count);
508 lfp = ksmbd_fp_get(lfp);
509 read_unlock(&ci->m_lock);
513 atomic_dec(&ci->m_count);
514 read_unlock(&ci->m_lock);
518 #define OPEN_ID_TYPE_VOLATILE_ID (0)
519 #define OPEN_ID_TYPE_PERSISTENT_ID (1)
521 static void __open_id_set(struct ksmbd_file *fp, u64 id, int type)
523 if (type == OPEN_ID_TYPE_VOLATILE_ID)
524 fp->volatile_id = id;
525 if (type == OPEN_ID_TYPE_PERSISTENT_ID)
526 fp->persistent_id = id;
529 static int __open_id(struct ksmbd_file_table *ft, struct ksmbd_file *fp,
535 if (type == OPEN_ID_TYPE_VOLATILE_ID && fd_limit_depleted()) {
536 __open_id_set(fp, KSMBD_NO_FID, type);
540 idr_preload(GFP_KERNEL);
541 write_lock(&ft->lock);
542 ret = idr_alloc_cyclic(ft->idr, fp, 0, INT_MAX - 1, GFP_NOWAIT);
551 __open_id_set(fp, id, type);
552 write_unlock(&ft->lock);
557 unsigned int ksmbd_open_durable_fd(struct ksmbd_file *fp)
559 __open_id(&global_ft, fp, OPEN_ID_TYPE_PERSISTENT_ID);
560 return fp->persistent_id;
563 struct ksmbd_file *ksmbd_open_fd(struct ksmbd_work *work, struct file *filp)
565 struct ksmbd_file *fp;
568 fp = kmem_cache_zalloc(filp_cache, GFP_KERNEL);
570 pr_err("Failed to allocate memory\n");
571 return ERR_PTR(-ENOMEM);
574 INIT_LIST_HEAD(&fp->blocked_works);
575 INIT_LIST_HEAD(&fp->node);
576 INIT_LIST_HEAD(&fp->lock_list);
577 spin_lock_init(&fp->f_lock);
578 atomic_set(&fp->refcount, 1);
581 fp->conn = work->conn;
582 fp->tcon = work->tcon;
583 fp->volatile_id = KSMBD_NO_FID;
584 fp->persistent_id = KSMBD_NO_FID;
585 fp->f_state = FP_NEW;
586 fp->f_ci = ksmbd_inode_get(fp);
593 ret = __open_id(&work->sess->file_table, fp, OPEN_ID_TYPE_VOLATILE_ID);
595 ksmbd_inode_put(fp->f_ci);
599 atomic_inc(&work->conn->stats.open_files_count);
603 kmem_cache_free(filp_cache, fp);
607 void ksmbd_update_fstate(struct ksmbd_file_table *ft, struct ksmbd_file *fp,
613 write_lock(&ft->lock);
615 write_unlock(&ft->lock);
619 __close_file_table_ids(struct ksmbd_file_table *ft,
620 struct ksmbd_tree_connect *tcon,
621 bool (*skip)(struct ksmbd_tree_connect *tcon,
622 struct ksmbd_file *fp))
625 struct ksmbd_file *fp;
628 idr_for_each_entry(ft->idr, fp, id) {
632 set_close_state_blocked_works(fp);
634 if (!atomic_dec_and_test(&fp->refcount))
636 __ksmbd_close_fd(ft, fp);
642 static bool tree_conn_fd_check(struct ksmbd_tree_connect *tcon,
643 struct ksmbd_file *fp)
645 return fp->tcon != tcon;
648 static bool session_fd_check(struct ksmbd_tree_connect *tcon,
649 struct ksmbd_file *fp)
654 void ksmbd_close_tree_conn_fds(struct ksmbd_work *work)
656 int num = __close_file_table_ids(&work->sess->file_table,
660 atomic_sub(num, &work->conn->stats.open_files_count);
663 void ksmbd_close_session_fds(struct ksmbd_work *work)
665 int num = __close_file_table_ids(&work->sess->file_table,
669 atomic_sub(num, &work->conn->stats.open_files_count);
672 int ksmbd_init_global_file_table(void)
674 return ksmbd_init_file_table(&global_ft);
677 void ksmbd_free_global_file_table(void)
679 struct ksmbd_file *fp = NULL;
682 idr_for_each_entry(global_ft.idr, fp, id) {
683 __ksmbd_remove_durable_fd(fp);
684 kmem_cache_free(filp_cache, fp);
687 ksmbd_destroy_file_table(&global_ft);
690 int ksmbd_init_file_table(struct ksmbd_file_table *ft)
692 ft->idr = kzalloc(sizeof(struct idr), GFP_KERNEL);
697 rwlock_init(&ft->lock);
701 void ksmbd_destroy_file_table(struct ksmbd_file_table *ft)
706 __close_file_table_ids(ft, NULL, session_fd_check);
707 idr_destroy(ft->idr);
712 int ksmbd_init_file_cache(void)
714 filp_cache = kmem_cache_create("ksmbd_file_cache",
715 sizeof(struct ksmbd_file), 0,
716 SLAB_HWCACHE_ALIGN, NULL);
723 pr_err("failed to allocate file cache\n");
727 void ksmbd_exit_file_cache(void)
729 kmem_cache_destroy(filp_cache);