fs/ksmbd/vfs_cache.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  *   Copyright (C) 2019 Samsung Electronics Co., Ltd.
0004  */
0005
0006 #ifndef __VFS_CACHE_H__
0007 #define __VFS_CACHE_H__
0008
0009 #include <linux/file.h>
0010 #include <linux/fs.h>
0011 #include <linux/rwsem.h>
0012 #include <linux/spinlock.h>
0013 #include <linux/idr.h>
0014 #include <linux/workqueue.h>
0015
0016 #include "vfs.h"
0017
0018 /* Windows style file permissions for extended response */
0019 #define FILE_GENERIC_ALL    0x1F01FF
0020 #define FILE_GENERIC_READ   0x120089
0021 #define FILE_GENERIC_WRITE  0x120116
0022 #define FILE_GENERIC_EXECUTE    0X1200a0
0023
0024 #define KSMBD_START_FID     0
0025 #define KSMBD_NO_FID        (INT_MAX)
0026 #define SMB2_NO_FID     (0xFFFFFFFFFFFFFFFFULL)
0027
0028 struct ksmbd_conn;
0029 struct ksmbd_session;
0030
0031 struct ksmbd_lock {
0032     struct file_lock *fl;
0033     struct list_head clist;
0034     struct list_head flist;
0035     struct list_head llist;
0036     unsigned int flags;
0037     int cmd;
0038     int zero_len;
0039     unsigned long long start;
0040     unsigned long long end;
0041 };
0042
0043 struct stream {
0044     char *name;
0045     ssize_t size;
0046 };
0047
0048 struct ksmbd_inode {
0049     rwlock_t            m_lock;
0050     atomic_t            m_count;
0051     atomic_t            op_count;
0052     /* opinfo count for streams */
0053     atomic_t            sop_count;
0054     struct inode            *m_inode;
0055     unsigned int            m_flags;
0056     struct hlist_node       m_hash;
0057     struct list_head        m_fp_list;
0058     struct list_head        m_op_list;
0059     struct oplock_info      *m_opinfo;
0060     __le32              m_fattr;
0061 };
0062
0063 struct ksmbd_file {
0064     struct file         *filp;
0065     u64             persistent_id;
0066     u64             volatile_id;
0067
0068     spinlock_t          f_lock;
0069
0070     struct ksmbd_inode      *f_ci;
0071     struct ksmbd_inode      *f_parent_ci;
0072     struct oplock_info __rcu    *f_opinfo;
0073     struct ksmbd_conn       *conn;
0074     struct ksmbd_tree_connect   *tcon;
0075
0076     atomic_t            refcount;
0077     __le32              daccess;
0078     __le32              saccess;
0079     __le32              coption;
0080     __le32              cdoption;
0081     __u64               create_time;
0082     __u64               itime;
0083
0084     bool                is_nt_open;
0085     bool                attrib_only;
0086
0087     char                client_guid[16];
0088     char                create_guid[16];
0089     char                app_instance_id[16];
0090
0091     struct stream           stream;
0092     struct list_head        node;
0093     struct list_head        blocked_works;
0094     struct list_head        lock_list;
0095
0096     int             durable_timeout;
0097
0098     /* if ls is happening on directory, below is valid*/
0099     struct ksmbd_readdir_data   readdir_data;
0100     int             dot_dotdot[2];
0101 };
0102
0103 static inline void set_ctx_actor(struct dir_context *ctx,
0104                  filldir_t actor)
0105 {
0106     ctx->actor = actor;
0107 }
0108
0109 #define KSMBD_NR_OPEN_DEFAULT BITS_PER_LONG
0110
0111 struct ksmbd_file_table {
0112     rwlock_t        lock;
0113     struct idr      *idr;
0114 };
0115
0116 static inline bool has_file_id(u64 id)
0117 {
0118     return id < KSMBD_NO_FID;
0119 }
0120
0121 static inline bool ksmbd_stream_fd(struct ksmbd_file *fp)
0122 {
0123     return fp->stream.name != NULL;
0124 }
0125
0126 int ksmbd_init_file_table(struct ksmbd_file_table *ft);
0127 void ksmbd_destroy_file_table(struct ksmbd_file_table *ft);
0128 int ksmbd_close_fd(struct ksmbd_work *work, u64 id);
0129 struct ksmbd_file *ksmbd_lookup_fd_fast(struct ksmbd_work *work, u64 id);
0130 struct ksmbd_file *ksmbd_lookup_foreign_fd(struct ksmbd_work *work, u64 id);
0131 struct ksmbd_file *ksmbd_lookup_fd_slow(struct ksmbd_work *work, u64 id,
0132                     u64 pid);
0133 void ksmbd_fd_put(struct ksmbd_work *work, struct ksmbd_file *fp);
0134 struct ksmbd_file *ksmbd_lookup_durable_fd(unsigned long long id);
0135 struct ksmbd_file *ksmbd_lookup_fd_cguid(char *cguid);
0136 struct ksmbd_file *ksmbd_lookup_fd_inode(struct inode *inode);
0137 unsigned int ksmbd_open_durable_fd(struct ksmbd_file *fp);
0138 struct ksmbd_file *ksmbd_open_fd(struct ksmbd_work *work, struct file *filp);
0139 void ksmbd_close_tree_conn_fds(struct ksmbd_work *work);
0140 void ksmbd_close_session_fds(struct ksmbd_work *work);
0141 int ksmbd_close_inode_fds(struct ksmbd_work *work, struct inode *inode);
0142 int ksmbd_init_global_file_table(void);
0143 void ksmbd_free_global_file_table(void);
0144 void ksmbd_set_fd_limit(unsigned long limit);
0145
0146 /*
0147  * INODE hash
0148  */
0149 int __init ksmbd_inode_hash_init(void);
0150 void ksmbd_release_inode_hash(void);
0151
0152 enum KSMBD_INODE_STATUS {
0153     KSMBD_INODE_STATUS_OK,
0154     KSMBD_INODE_STATUS_UNKNOWN,
0155     KSMBD_INODE_STATUS_PENDING_DELETE,
0156 };
0157
0158 int ksmbd_query_inode_status(struct inode *inode);
0159 bool ksmbd_inode_pending_delete(struct ksmbd_file *fp);
0160 void ksmbd_set_inode_pending_delete(struct ksmbd_file *fp);
0161 void ksmbd_clear_inode_pending_delete(struct ksmbd_file *fp);
0162 void ksmbd_fd_set_delete_on_close(struct ksmbd_file *fp,
0163                   int file_info);
0164 int ksmbd_init_file_cache(void);
0165 void ksmbd_exit_file_cache(void);
0166 #endif /* __VFS_CACHE_H__ */