fs/ksmbd/vfs.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *   Copyright (C) 2016 Namjae Jeon <[email protected]>
   4  *   Copyright (C) 2018 Samsung Electronics Co., Ltd.
   5  */
   6
   7 #ifndef __KSMBD_VFS_H__
   8 #define __KSMBD_VFS_H__
   9
  10 #include <linux/file.h>
  11 #include <linux/fs.h>
  12 #include <linux/namei.h>
  13 #include <uapi/linux/xattr.h>
  14 #include <linux/posix_acl.h>
  15 #include <linux/unicode.h>
  16
  17 #include "smbacl.h"
  18 #include "xattr.h"
  19
  20 /*
  21  * Enumeration for stream type.
  22  */
  23 enum {
  24         DATA_STREAM     = 1,    /* type $DATA */
  25         DIR_STREAM              /* type $INDEX_ALLOCATION */
  26 };
  27
  28 /* CreateOptions */
  29 #define CREATE_TREE_CONNECTION                  cpu_to_le32(0x00000080)
  30 #define FILE_RESERVE_OPFILTER_LE                cpu_to_le32(0x00100000)
  31
  32 #define CREATE_OPTION_READONLY                  0x10000000
  33 /* system. NB not sent over wire */
  34 #define CREATE_OPTION_SPECIAL                   0x20000000
  35
  36 struct ksmbd_work;
  37 struct ksmbd_file;
  38 struct ksmbd_conn;
  39
  40 struct ksmbd_dir_info {
  41         const char      *name;
  42         char            *wptr;
  43         char            *rptr;
  44         int             name_len;
  45         int             out_buf_len;
  46         int             num_entry;
  47         int             data_count;
  48         int             last_entry_offset;
  49         bool            hide_dot_file;
  50         int             flags;
  51         int             last_entry_off_align;
  52 };
  53
  54 struct ksmbd_readdir_data {
  55         struct dir_context      ctx;
  56         union {
  57                 void            *private;
  58                 char            *dirent;
  59         };
  60
  61         unsigned int            used;
  62         unsigned int            dirent_count;
  63         unsigned int            file_attr;
  64         struct unicode_map      *um;
  65 };
  66
  67 /* ksmbd kstat wrapper to get valid create time when reading dir entry */
  68 struct ksmbd_kstat {
  69         struct kstat            *kstat;
  70         unsigned long long      create_time;
  71         __le32                  file_attributes;
  72 };
  73
  74 int ksmbd_vfs_lock_parent(struct user_namespace *user_ns, struct dentry *parent,
  75                           struct dentry *child);
  76 int ksmbd_vfs_may_delete(struct user_namespace *user_ns, struct dentry *dentry);
  77 int ksmbd_vfs_query_maximal_access(struct user_namespace *user_ns,
  78                                    struct dentry *dentry, __le32 *daccess);
  79 int ksmbd_vfs_create(struct ksmbd_work *work, const char *name, umode_t mode);
  80 int ksmbd_vfs_mkdir(struct ksmbd_work *work, const char *name, umode_t mode);
  81 int ksmbd_vfs_read(struct ksmbd_work *work, struct ksmbd_file *fp,
  82                    size_t count, loff_t *pos);
  83 int ksmbd_vfs_write(struct ksmbd_work *work, struct ksmbd_file *fp,
  84                     char *buf, size_t count, loff_t *pos, bool sync,
  85                     ssize_t *written);
  86 int ksmbd_vfs_fsync(struct ksmbd_work *work, u64 fid, u64 p_id);
  87 int ksmbd_vfs_remove_file(struct ksmbd_work *work, char *name);
  88 int ksmbd_vfs_link(struct ksmbd_work *work,
  89                    const char *oldname, const char *newname);
  90 int ksmbd_vfs_getattr(const struct path *path, struct kstat *stat);
  91 int ksmbd_vfs_fp_rename(struct ksmbd_work *work, struct ksmbd_file *fp,
  92                         char *newname);
  93 int ksmbd_vfs_truncate(struct ksmbd_work *work,
  94                        struct ksmbd_file *fp, loff_t size);
  95 struct srv_copychunk;
  96 int ksmbd_vfs_copy_file_ranges(struct ksmbd_work *work,
  97                                struct ksmbd_file *src_fp,
  98                                struct ksmbd_file *dst_fp,
  99                                struct srv_copychunk *chunks,
 100                                unsigned int chunk_count,
 101                                unsigned int *chunk_count_written,
 102                                unsigned int *chunk_size_written,
 103                                loff_t  *total_size_written);
 104 ssize_t ksmbd_vfs_listxattr(struct dentry *dentry, char **list);
 105 ssize_t ksmbd_vfs_getxattr(struct user_namespace *user_ns,
 106                            struct dentry *dentry,
 107                            char *xattr_name,
 108                            char **xattr_buf);
 109 ssize_t ksmbd_vfs_casexattr_len(struct user_namespace *user_ns,
 110                                 struct dentry *dentry, char *attr_name,
 111                                 int attr_name_len);
 112 int ksmbd_vfs_setxattr(struct user_namespace *user_ns,
 113                        struct dentry *dentry, const char *attr_name,
 114                        void *attr_value, size_t attr_size, int flags);
 115 int ksmbd_vfs_xattr_stream_name(char *stream_name, char **xattr_stream_name,
 116                                 size_t *xattr_stream_name_size, int s_type);
 117 int ksmbd_vfs_remove_xattr(struct user_namespace *user_ns,
 118                            struct dentry *dentry, char *attr_name);
 119 int ksmbd_vfs_kern_path(struct ksmbd_work *work,
 120                         char *name, unsigned int flags, struct path *path,
 121                         bool caseless);
 122 struct dentry *ksmbd_vfs_kern_path_create(struct ksmbd_work *work,
 123                                           const char *name,
 124                                           unsigned int flags,
 125                                           struct path *path);
 126 int ksmbd_vfs_empty_dir(struct ksmbd_file *fp);
 127 void ksmbd_vfs_set_fadvise(struct file *filp, __le32 option);
 128 int ksmbd_vfs_zero_data(struct ksmbd_work *work, struct ksmbd_file *fp,
 129                         loff_t off, loff_t len);
 130 struct file_allocated_range_buffer;
 131 int ksmbd_vfs_fqar_lseek(struct ksmbd_file *fp, loff_t start, loff_t length,
 132                          struct file_allocated_range_buffer *ranges,
 133                          unsigned int in_count, unsigned int *out_count);
 134 int ksmbd_vfs_unlink(struct user_namespace *user_ns,
 135                      struct dentry *dir, struct dentry *dentry);
 136 void *ksmbd_vfs_init_kstat(char **p, struct ksmbd_kstat *ksmbd_kstat);
 137 int ksmbd_vfs_fill_dentry_attrs(struct ksmbd_work *work,
 138                                 struct user_namespace *user_ns,
 139                                 struct dentry *dentry,
 140                                 struct ksmbd_kstat *ksmbd_kstat);
 141 void ksmbd_vfs_posix_lock_wait(struct file_lock *flock);
 142 int ksmbd_vfs_posix_lock_wait_timeout(struct file_lock *flock, long timeout);
 143 void ksmbd_vfs_posix_lock_unblock(struct file_lock *flock);
 144 int ksmbd_vfs_remove_acl_xattrs(struct user_namespace *user_ns,
 145                                 struct dentry *dentry);
 146 int ksmbd_vfs_remove_sd_xattrs(struct user_namespace *user_ns,
 147                                struct dentry *dentry);
 148 int ksmbd_vfs_set_sd_xattr(struct ksmbd_conn *conn,
 149                            struct user_namespace *user_ns,
 150                            struct dentry *dentry,
 151                            struct smb_ntsd *pntsd, int len);
 152 int ksmbd_vfs_get_sd_xattr(struct ksmbd_conn *conn,
 153                            struct user_namespace *user_ns,
 154                            struct dentry *dentry,
 155                            struct smb_ntsd **pntsd);
 156 int ksmbd_vfs_set_dos_attrib_xattr(struct user_namespace *user_ns,
 157                                    struct dentry *dentry,
 158                                    struct xattr_dos_attrib *da);
 159 int ksmbd_vfs_get_dos_attrib_xattr(struct user_namespace *user_ns,
 160                                    struct dentry *dentry,
 161                                    struct xattr_dos_attrib *da);
 162 int ksmbd_vfs_set_init_posix_acl(struct user_namespace *user_ns,
 163                                  struct inode *inode);
 164 int ksmbd_vfs_inherit_posix_acl(struct user_namespace *user_ns,
 165                                 struct inode *inode,
 166                                 struct inode *parent_inode);
 167 #endif /* __KSMBD_VFS_H__ */