s3: Added SMB_VFS_INIT_SEARCH_OP to initialize data at the beginning of SMB search...
[ira/wip.git] / source3 / modules / onefs.h
1 /*
2  * Unix SMB/CIFS implementation.
3  * Support for OneFS
4  *
5  * Copyright (C) Steven Danneman, 2008
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef _ONEFS_H
22 #define _ONEFS_H
23
24 #include "includes.h"
25 #include "oplock_onefs.h"
26 #include <sys/isi_acl.h>
27
28 /* OneFS Module smb.conf parameters and defaults */
29
30 /**
31 * Specifies when ACLs presented to Windows should be canonicalized
32 * into the ordering which Explorer expects.
33 */
34 enum onefs_acl_wire_format
35 {
36         ACL_FORMAT_RAW, /**< Never canonicalize */
37         ACL_FORMAT_WINDOWS_SD, /**< Only canonicalize synthetic ACLs */
38         ACL_FORMAT_ALWAYS /**< Always canonicalize */
39 };
40
41 #define PARM_ONEFS_TYPE "onefs"
42 #define PARM_ACL_WIRE_FORMAT "acl wire format"
43 #define PARM_ACL_WIRE_FORMAT_DEFAULT ACL_FORMAT_WINDOWS_SD
44 #define PARM_SIMPLE_FILE_SHARING_COMPATIBILITY_MODE "simple file sharing compatibility mode"
45 #define PARM_SIMPLE_FILE_SHARING_COMPATIBILITY_MODE_DEFAULT false
46 #define PARM_CREATOR_OWNER_GETS_FULL_CONTROL "creator owner gets full control"
47 #define PARM_CREATOR_OWNER_GETS_FULL_CONTROL_DEFAULT true
48 #define PARM_UNMAPPABLE_SIDS_DENY_EVERYONE "unmappable sids deny everyone"
49 #define PARM_UNMAPPABLE_SIDS_DENY_EVERYONE_DEFAULT false
50 #define PARM_UNMAPPABLE_SIDS_IGNORE "ignore unmappable sids"
51 #define PARM_UNMAPPABLE_SIDS_IGNORE_DEFAULT false
52 #define PARM_UNMAPPABLE_SIDS_IGNORE_LIST "unmappable sids ignore list"
53 #define PARM_UNMAPPABLE_SIDS_IGNORE_LIST_DEFAULT NULL
54 #define PARM_IGNORE_SACL "ignore sacl"
55 #define PARM_IGNORE_SACL_DEFAULT false
56 #define PARM_ATIME_NOW          "atime now files"
57 #define PARM_ATIME_SLOP         "atime now slop"
58 #define PARM_CTIME_NOW          "ctime now files"
59 #define PARM_CTIME_SLOP         "ctime now slop"
60 #define PARM_MTIME_NOW          "mtime now files"
61 #define PARM_MTIME_SLOP         "mtime now slop"
62 #define PARM_MTIME_STATIC       "mtime static files"
63 #define PARM_ATIME_STATIC       "atime static files"
64
65 #define IS_CTIME_NOW_PATH(conn,cfg,path)  ((conn) && is_in_path((path),\
66         (cfg)->ctime_now_list,(conn)->case_sensitive))
67 #define IS_MTIME_NOW_PATH(conn,cfg,path)  ((conn) && is_in_path((path),\
68         (cfg)->mtime_now_list,(conn)->case_sensitive))
69 #define IS_ATIME_NOW_PATH(conn,cfg,path)  ((conn) && is_in_path((path),\
70         (cfg)->atime_now_list,(conn)->case_sensitive))
71 #define IS_MTIME_STATIC_PATH(conn,cfg,path)  ((conn) && is_in_path((path),\
72         (cfg)->mtime_static_list,(conn)->case_sensitive))
73 #define IS_ATIME_STATIC_PATH(conn,cfg,path)  ((conn) && is_in_path((path),\
74         (cfg)->atime_static_list,(conn)->case_sensitive))
75
76 /*
77  * Store some commonly evaluated parameters to avoid loadparm pain.
78  */
79
80 #define ONEFS_VFS_CONFIG_INITIALIZED    0x00010000
81
82 #define ONEFS_VFS_CONFIG_FAKETIMESTAMPS 0x00000001
83
84
85 struct onefs_vfs_config
86 {
87         int32 init_flags;
88
89         /* data for fake timestamps */
90         int atime_slop;
91         int ctime_slop;
92         int mtime_slop;
93
94         /* Per-share list of files to fake the create time for. */
95         name_compare_entry *ctime_now_list;
96
97         /* Per-share list of files to fake the modification time for. */
98         name_compare_entry *mtime_now_list;
99
100         /* Per-share list of files to fake the access time for. */
101         name_compare_entry *atime_now_list;
102
103         /* Per-share list of files to fake the modification time for. */
104         name_compare_entry *mtime_static_list;
105
106         /* The access  time  will  equal  the  create  time.  */
107         /* The  modification  time  will  equal  the  create  time.*/
108
109         /* Per-share list of files to fake the access time for. */
110         name_compare_entry *atime_static_list;
111 };
112
113 /*
114  * vfs interface handlers
115  */
116 NTSTATUS onefs_create_file(vfs_handle_struct *handle,
117                            struct smb_request *req,
118                            uint16_t root_dir_fid,
119                            const char *fname,
120                            uint32_t create_file_flags,
121                            uint32_t access_mask,
122                            uint32_t share_access,
123                            uint32_t create_disposition,
124                            uint32_t create_options,
125                            uint32_t file_attributes,
126                            uint32_t oplock_request,
127                            uint64_t allocation_size,
128                            struct security_descriptor *sd,
129                            struct ea_list *ea_list,
130                            files_struct **result,
131                            int *pinfo,
132                            SMB_STRUCT_STAT *psbuf);
133
134 int onefs_close(vfs_handle_struct *handle, struct files_struct *fsp);
135
136 int onefs_rename(vfs_handle_struct *handle, const char *oldname,
137                  const char *newname);
138
139 int onefs_stat(vfs_handle_struct *handle, const char *fname,
140                SMB_STRUCT_STAT *sbuf);
141
142 int onefs_fstat(vfs_handle_struct *handle, struct files_struct *fsp,
143                 SMB_STRUCT_STAT *sbuf);
144
145 int onefs_lstat(vfs_handle_struct *handle, const char *path,
146                 SMB_STRUCT_STAT *sbuf);
147
148 int onefs_unlink(vfs_handle_struct *handle, const char *path);
149
150 int onefs_chflags(vfs_handle_struct *handle, const char *path,
151                   unsigned int flags);
152
153 NTSTATUS onefs_streaminfo(vfs_handle_struct *handle,
154                           struct files_struct *fsp,
155                           const char *fname,
156                           TALLOC_CTX *mem_ctx,
157                           unsigned int *num_streams,
158                           struct stream_struct **streams);
159
160 int onefs_vtimes_streams(vfs_handle_struct *handle, const char *fname,
161                          int flags, struct timespec times[3]);
162
163 NTSTATUS onefs_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
164                            uint32 security_info, SEC_DESC **ppdesc);
165
166 NTSTATUS onefs_get_nt_acl(vfs_handle_struct *handle, const char* name,
167                           uint32 security_info, SEC_DESC **ppdesc);
168
169 NTSTATUS onefs_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
170                            uint32 security_info_sent, SEC_DESC *psd);
171 /*
172  * Utility functions
173  */
174 NTSTATUS onefs_samba_sd_to_sd(uint32 security_info_sent, SEC_DESC *psd,
175                               struct ifs_security_descriptor *sd, int snum);
176
177 NTSTATUS onefs_split_ntfs_stream_name(TALLOC_CTX *mem_ctx, const char *fname,
178                                       char **pbase, char **pstream);
179
180 bool onefs_get_config(int snum, int config_type,
181                       struct onefs_vfs_config *cfg);
182 /*
183  * System Interfaces
184  */
185 int onefs_sys_create_file(connection_struct *conn,
186                           int base_fd,
187                           const char *path,
188                           uint32_t access_mask,
189                           uint32_t open_access_mask,
190                           uint32_t share_access,
191                           uint32_t create_options,
192                           int flags,
193                           mode_t mode,
194                           int oplock_request,
195                           uint64_t id,
196                           struct security_descriptor *sd,
197                           uint32_t ntfs_flags,
198                           int *granted_oplock);
199
200
201
202 #endif /* _ONEFS_H */