2 Unix SMB/Netbios implementation.
4 VFS initialisation and support functions
5 Copyright (C) Tim Potter 1999
6 Copyright (C) Alexander Bokovoy 2002
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 This work was sponsored by Optifacio Software Services, Inc.
28 #define DBGC_CLASS DBGC_VFS
30 struct vfs_init_function_entry {
32 vfs_op_tuple *vfs_op_tuples;
33 struct vfs_init_function_entry *prev, *next;
36 static struct vfs_init_function_entry *backends = NULL;
38 /* Some structures to help us initialise the vfs operations table */
45 /* Default vfs hooks. WARNING: The order of these initialisers is
46 very important. They must be in the same order as defined in
47 vfs.h. Change at your own peril. */
49 static struct vfs_ops default_vfs = {
54 vfswrap_dummy_connect,
55 vfswrap_dummy_disconnect,
60 /* Directory operations */
102 /* POSIX ACL operations. */
106 vfswrap_sys_acl_get_entry,
107 vfswrap_sys_acl_get_tag_type,
108 vfswrap_sys_acl_get_permset,
109 vfswrap_sys_acl_get_qualifier,
110 vfswrap_sys_acl_get_file,
111 vfswrap_sys_acl_get_fd,
112 vfswrap_sys_acl_clear_perms,
113 vfswrap_sys_acl_add_perm,
114 vfswrap_sys_acl_to_text,
115 vfswrap_sys_acl_init,
116 vfswrap_sys_acl_create_entry,
117 vfswrap_sys_acl_set_tag_type,
118 vfswrap_sys_acl_set_qualifier,
119 vfswrap_sys_acl_set_permset,
120 vfswrap_sys_acl_valid,
121 vfswrap_sys_acl_set_file,
122 vfswrap_sys_acl_set_fd,
123 vfswrap_sys_acl_delete_def_file,
124 vfswrap_sys_acl_get_perm,
125 vfswrap_sys_acl_free_text,
126 vfswrap_sys_acl_free_acl,
127 vfswrap_sys_acl_free_qualifier
131 /****************************************************************************
132 maintain the list of available backends
133 ****************************************************************************/
135 static struct vfs_init_function_entry *vfs_find_backend_entry(const char *name)
137 struct vfs_init_function_entry *entry = backends;
140 module_path_get_name(name, stripped);
143 if (strequal(entry->name, stripped)) return entry;
150 NTSTATUS smb_register_vfs(int version, const char *name, vfs_op_tuple *vfs_op_tuples)
152 struct vfs_init_function_entry *entry = backends;
154 if ((version != SMB_VFS_INTERFACE_VERSION)) {
155 DEBUG(0, ("Failed to register vfs module.\n"
156 "The module was compiled against SMB_VFS_INTERFACE_VERSION %d,\n"
157 "current SMB_VFS_INTERFACE_VERSION is %d.\n"
158 "Please recompile against the current Samba Version!\n",
159 version, SMB_VFS_INTERFACE_VERSION));
160 return NT_STATUS_OBJECT_TYPE_MISMATCH;
163 if (!name || !name[0] || !vfs_op_tuples) {
164 DEBUG(0,("smb_register_vfs() called with NULL pointer or empty name!\n"));
165 return NT_STATUS_INVALID_PARAMETER;
168 if (vfs_find_backend_entry(name)) {
169 DEBUG(0,("VFS module %s already loaded!\n", name));
170 return NT_STATUS_OBJECT_NAME_COLLISION;
173 entry = smb_xmalloc(sizeof(struct vfs_init_function_entry));
174 entry->name = smb_xstrdup(name);
175 entry->vfs_op_tuples = vfs_op_tuples;
177 DLIST_ADD(backends, entry);
178 DEBUG(5, ("Successfully added vfs backend '%s'\n", name));
182 /****************************************************************************
183 initialise default vfs hooks
184 ****************************************************************************/
186 static void vfs_init_default(connection_struct *conn)
188 DEBUG(3, ("Initialising default vfs hooks\n"));
190 memcpy(&conn->vfs.ops, &default_vfs.ops, sizeof(default_vfs.ops));
191 memcpy(&conn->vfs_opaque.ops, &default_vfs.ops, sizeof(default_vfs.ops));
194 /****************************************************************************
195 initialise custom vfs hooks
196 ****************************************************************************/
198 BOOL vfs_init_custom(connection_struct *conn, const char *vfs_object)
201 char *module_name = NULL;
202 char *module_param = NULL, *p;
204 vfs_handle_struct *handle;
205 struct vfs_init_function_entry *entry;
207 if (!conn||!vfs_object||!vfs_object[0]) {
208 DEBUG(0,("vfs_init_custon() called with NULL pointer or emtpy vfs_object!\n"));
212 if(!backends) static_init_vfs;
214 DEBUG(3, ("Initialising custom vfs hooks from [%s]\n", vfs_object));
216 module_name = smb_xstrdup(vfs_object);
218 p = strchr(module_name, ':');
223 trim_string(module_param, " ", " ");
226 trim_string(module_name, " ", " ");
228 /* First, try to load the module with the new module system */
229 if((entry = vfs_find_backend_entry(module_name)) ||
230 (NT_STATUS_IS_OK(smb_probe_module("vfs", module_name)) &&
231 (entry = vfs_find_backend_entry(module_name)))) {
233 DEBUGADD(5,("Successfully loaded vfs module [%s] with the new modules system\n", vfs_object));
235 if ((ops = entry->vfs_op_tuples) == NULL) {
236 DEBUG(0, ("entry->vfs_op_tuples==NULL for [%s] failed\n", vfs_object));
237 SAFE_FREE(module_name);
241 DEBUG(0,("Can't find a vfs module [%s]\n",vfs_object));
242 SAFE_FREE(module_name);
246 handle = (vfs_handle_struct *)talloc_zero(conn->mem_ctx,sizeof(vfs_handle_struct));
248 DEBUG(0,("talloc_zero() failed!\n"));
249 SAFE_FREE(module_name);
252 memcpy(&handle->vfs_next, &conn->vfs, sizeof(struct vfs_ops));
255 handle->param = talloc_strdup(conn->mem_ctx, module_param);
257 DLIST_ADD(conn->vfs_handles, handle);
259 for(i=0; ops[i].op != NULL; i++) {
260 DEBUG(5, ("Checking operation #%d (type %d, layer %d)\n", i, ops[i].type, ops[i].layer));
261 if(ops[i].layer == SMB_VFS_LAYER_OPAQUE) {
262 /* Check whether this operation was already made opaque by different module */
263 if(((void**)&conn->vfs_opaque.ops)[ops[i].type] == ((void**)&default_vfs.ops)[ops[i].type]) {
264 /* No, it isn't overloaded yet. Overload. */
265 DEBUGADD(5, ("Making operation type %d opaque [module %s]\n", ops[i].type, vfs_object));
266 ((void**)&conn->vfs_opaque.ops)[ops[i].type] = ops[i].op;
267 ((vfs_handle_struct **)&conn->vfs_opaque.handles)[ops[i].type] = handle;
270 /* Change current VFS disposition*/
271 DEBUGADD(5, ("Accepting operation type %d from module %s\n", ops[i].type, vfs_object));
272 ((void**)&conn->vfs.ops)[ops[i].type] = ops[i].op;
273 ((vfs_handle_struct **)&conn->vfs.handles)[ops[i].type] = handle;
276 SAFE_FREE(module_name);
280 /*****************************************************************
282 ******************************************************************/
284 BOOL smbd_vfs_init(connection_struct *conn)
286 const char **vfs_objects;
290 /* Normal share - initialise with disk access functions */
291 vfs_init_default(conn);
292 vfs_objects = lp_vfs_objects(SNUM(conn));
294 /* Override VFS functions if 'vfs object' was not specified*/
295 if (!vfs_objects || !vfs_objects[0])
298 for (i=0; vfs_objects[i] ;) {
302 for (j=i-1; j >= 0; j--) {
303 if (!vfs_init_custom(conn, vfs_objects[j])) {
304 DEBUG(0, ("smbd_vfs_init: vfs_init_custom failed for %s\n", vfs_objects[j]));
311 /*******************************************************************
312 Check if directory exists.
313 ********************************************************************/
315 BOOL vfs_directory_exist(connection_struct *conn, const char *dname, SMB_STRUCT_STAT *st)
323 if (VFS_STAT(conn,dname,st) != 0)
326 ret = S_ISDIR(st->st_mode);
333 /*******************************************************************
335 ********************************************************************/
337 int vfs_MkDir(connection_struct *conn, const char *name, mode_t mode)
340 SMB_STRUCT_STAT sbuf;
342 if(!(ret=VFS_MKDIR(conn, name, mode))) {
344 inherit_access_acl(conn, name, mode);
347 * Check if high bits should have been set,
348 * then (if bits are missing): add them.
349 * Consider bits automagically set by UNIX, i.e. SGID bit from parent dir.
351 if(mode & ~(S_IRWXU|S_IRWXG|S_IRWXO) &&
352 !VFS_STAT(conn,name,&sbuf) && (mode & ~sbuf.st_mode))
353 VFS_CHMOD(conn,name,sbuf.st_mode | (mode & ~sbuf.st_mode));
358 /*******************************************************************
359 Check if an object exists in the vfs.
360 ********************************************************************/
362 BOOL vfs_object_exist(connection_struct *conn,const char *fname,SMB_STRUCT_STAT *sbuf)
371 if (VFS_STAT(conn,fname,sbuf) == -1)
376 /*******************************************************************
377 Check if a file exists in the vfs.
378 ********************************************************************/
380 BOOL vfs_file_exist(connection_struct *conn, const char *fname,SMB_STRUCT_STAT *sbuf)
389 if (VFS_STAT(conn,fname,sbuf) == -1)
391 return(S_ISREG(sbuf->st_mode));
394 /****************************************************************************
395 Read data from fsp on the vfs. (note: EINTR re-read differs from vfs_write_data)
396 ****************************************************************************/
398 ssize_t vfs_read_data(files_struct *fsp, char *buf, size_t byte_count)
402 while (total < byte_count)
404 ssize_t ret = VFS_READ(fsp, fsp->fd, buf + total,
407 if (ret == 0) return total;
416 return (ssize_t)total;
419 /****************************************************************************
420 Write data to a fd on the vfs.
421 ****************************************************************************/
423 ssize_t vfs_write_data(files_struct *fsp,const char *buffer,size_t N)
429 ret = VFS_WRITE(fsp,fsp->fd,buffer + total,N - total);
438 return (ssize_t)total;
441 /****************************************************************************
442 An allocate file space call using the vfs interface.
443 Allocates space for a file from a filedescriptor.
444 Returns 0 on success, -1 on failure.
445 ****************************************************************************/
447 int vfs_allocate_file_space(files_struct *fsp, SMB_BIG_UINT len)
451 connection_struct *conn = fsp->conn;
452 SMB_BIG_UINT space_avail;
453 SMB_BIG_UINT bsize,dfree,dsize;
455 release_level_2_oplocks_on_change(fsp);
458 * Actually try and commit the space on disk....
461 DEBUG(10,("vfs_allocate_file_space: file %s, len %.0f\n", fsp->fsp_name, (double)len ));
463 if (((SMB_OFF_T)len) < 0) {
464 DEBUG(0,("vfs_allocate_file_space: %s negative len requested.\n", fsp->fsp_name ));
468 ret = VFS_FSTAT(fsp,fsp->fd,&st);
472 if (len == (SMB_BIG_UINT)st.st_size)
475 if (len < (SMB_BIG_UINT)st.st_size) {
476 /* Shrink - use ftruncate. */
478 DEBUG(10,("vfs_allocate_file_space: file %s, shrink. Current size %.0f\n",
479 fsp->fsp_name, (double)st.st_size ));
481 flush_write_cache(fsp, SIZECHANGE_FLUSH);
482 if ((ret = VFS_FTRUNCATE(fsp, fsp->fd, (SMB_OFF_T)len)) != -1) {
483 set_filelen_write_cache(fsp, len);
488 /* Grow - we need to test if we have enough space. */
490 if (!lp_strict_allocate(SNUM(fsp->conn)))
494 len /= 1024; /* Len is now number of 1k blocks needed. */
495 space_avail = VFS_DISK_FREE(conn,fsp->fsp_name,False,&bsize,&dfree,&dsize);
497 DEBUG(10,("vfs_allocate_file_space: file %s, grow. Current size %.0f, needed blocks = %.0f, space avail = %.0f\n",
498 fsp->fsp_name, (double)st.st_size, (double)len, (double)space_avail ));
500 if (len > space_avail) {
508 /****************************************************************************
509 A vfs set_filelen call.
510 set the length of a file from a filedescriptor.
511 Returns 0 on success, -1 on failure.
512 ****************************************************************************/
514 int vfs_set_filelen(files_struct *fsp, SMB_OFF_T len)
518 release_level_2_oplocks_on_change(fsp);
519 DEBUG(10,("vfs_set_filelen: ftruncate %s to len %.0f\n", fsp->fsp_name, (double)len));
520 flush_write_cache(fsp, SIZECHANGE_FLUSH);
521 if ((ret = VFS_FTRUNCATE(fsp, fsp->fd, len)) != -1)
522 set_filelen_write_cache(fsp, len);
527 /****************************************************************************
528 Transfer some data (n bytes) between two file_struct's.
529 ****************************************************************************/
531 static files_struct *in_fsp;
532 static files_struct *out_fsp;
534 static ssize_t read_fn(int fd, void *buf, size_t len)
536 return VFS_READ(in_fsp, fd, buf, len);
539 static ssize_t write_fn(int fd, const void *buf, size_t len)
541 return VFS_WRITE(out_fsp, fd, buf, len);
544 SMB_OFF_T vfs_transfer_file(files_struct *in, files_struct *out, SMB_OFF_T n)
549 return transfer_file_internal(in_fsp->fd, out_fsp->fd, n, read_fn, write_fn);
552 /*******************************************************************
553 A vfs_readdir wrapper which just returns the file name.
554 ********************************************************************/
556 char *vfs_readdirname(connection_struct *conn, void *p)
558 struct dirent *ptr= NULL;
564 ptr = (struct dirent *)VFS_READDIR(conn,p);
575 #ifdef HAVE_BROKEN_READDIR
576 /* using /usr/ucb/cc is BAD */
583 /*******************************************************************
584 A wrapper for vfs_chdir().
585 ********************************************************************/
587 int vfs_ChDir(connection_struct *conn, const char *path)
590 static pstring LastDir="";
592 if (strcsequal(path,"."))
595 if (*path == '/' && strcsequal(LastDir,path))
598 DEBUG(4,("vfs_ChDir to %s\n",path));
600 res = VFS_CHDIR(conn,path);
602 pstrcpy(LastDir,path);
606 /* number of list structures for a caching GetWd function. */
607 #define MAX_GETWDCACHE (50)
610 SMB_DEV_T dev; /* These *must* be compatible with the types returned in a stat() call. */
611 SMB_INO_T inode; /* These *must* be compatible with the types returned in a stat() call. */
612 char *dos_path; /* The pathname in DOS format. */
614 } ino_list[MAX_GETWDCACHE];
616 extern BOOL use_getwd_cache;
618 /****************************************************************************
619 Prompte a ptr (to make it recently used)
620 ****************************************************************************/
622 static void array_promote(char *array,int elsize,int element)
628 p = (char *)malloc(elsize);
631 DEBUG(5,("array_promote: malloc fail\n"));
635 memcpy(p,array + element * elsize, elsize);
636 memmove(array + elsize,array,elsize*element);
637 memcpy(array,p,elsize);
641 /*******************************************************************
642 Return the absolute current directory path - given a UNIX pathname.
643 Note that this path is returned in DOS format, not UNIX
644 format. Note this can be called with conn == NULL.
645 ********************************************************************/
647 char *vfs_GetWd(connection_struct *conn, char *path)
650 static BOOL getwd_cache_init = False;
651 SMB_STRUCT_STAT st, st2;
656 if (!use_getwd_cache)
657 return(VFS_GETWD(conn,path));
660 if (!getwd_cache_init) {
661 getwd_cache_init = True;
662 for (i=0;i<MAX_GETWDCACHE;i++) {
663 string_set(&ino_list[i].dos_path,"");
664 ino_list[i].valid = False;
668 /* Get the inode of the current directory, if this doesn't work we're
671 if (VFS_STAT(conn, ".",&st) == -1) {
672 DEBUG(0,("Very strange, couldn't stat \".\" path=%s\n", path));
673 return(VFS_GETWD(conn,path));
677 for (i=0; i<MAX_GETWDCACHE; i++) {
678 if (ino_list[i].valid) {
680 /* If we have found an entry with a matching inode and dev number
681 then find the inode number for the directory in the cached string.
682 If this agrees with that returned by the stat for the current
683 directory then all is o.k. (but make sure it is a directory all
686 if (st.st_ino == ino_list[i].inode && st.st_dev == ino_list[i].dev) {
687 if (VFS_STAT(conn,ino_list[i].dos_path,&st2) == 0) {
688 if (st.st_ino == st2.st_ino && st.st_dev == st2.st_dev &&
689 (st2.st_mode & S_IFMT) == S_IFDIR) {
690 pstrcpy (path, ino_list[i].dos_path);
692 /* promote it for future use */
693 array_promote((char *)&ino_list[0],sizeof(ino_list[0]),i);
696 /* If the inode is different then something's changed,
697 scrub the entry and start from scratch. */
698 ino_list[i].valid = False;
705 /* We don't have the information to hand so rely on traditional methods.
706 The very slow getcwd, which spawns a process on some systems, or the
707 not quite so bad getwd. */
709 if (!VFS_GETWD(conn,s)) {
710 DEBUG(0,("vfs_GetWd: VFS_GETWD call failed, errno %s\n",strerror(errno)));
716 DEBUG(5,("vfs_GetWd %s, inode %.0f, dev %.0f\n",s,(double)st.st_ino,(double)st.st_dev));
718 /* add it to the cache */
719 i = MAX_GETWDCACHE - 1;
720 string_set(&ino_list[i].dos_path,s);
721 ino_list[i].dev = st.st_dev;
722 ino_list[i].inode = st.st_ino;
723 ino_list[i].valid = True;
725 /* put it at the top of the list */
726 array_promote((char *)&ino_list[0],sizeof(ino_list[0]),i);
732 /* check if the file 'nmae' is a symlink, in that case check that it point to
733 a file that reside under the 'dir' tree */
735 static BOOL readlink_check(connection_struct *conn, const char *dir, char *name)
744 if (!vfs_GetWd(conn, savedir)) {
745 DEBUG(0,("couldn't vfs_GetWd for %s %s\n", name, dir));
749 if (vfs_ChDir(conn, dir) != 0) {
750 DEBUG(0,("couldn't vfs_ChDir to %s\n", dir));
754 if (!vfs_GetWd(conn, realdir)) {
755 DEBUG(0,("couldn't vfs_GetWd for %s\n", dir));
756 vfs_ChDir(conn, savedir);
760 reallen = strlen(realdir);
761 if (realdir[reallen -1] == '/') {
763 realdir[reallen] = 0;
766 if (VFS_READLINK(conn, name, flink, sizeof(pstring) -1) != -1) {
767 DEBUG(3,("reduce_name: file path name %s is a symlink\nChecking it's path\n", name));
769 pstrcpy(cleanlink, flink);
771 pstrcpy(cleanlink, realdir);
772 pstrcat(cleanlink, "/");
773 pstrcat(cleanlink, flink);
775 unix_clean_name(cleanlink);
777 if (strncmp(cleanlink, realdir, reallen) != 0) {
778 DEBUG(2,("Bad access attempt? s=%s dir=%s newname=%s l=%d\n", name, realdir, cleanlink, (int)reallen));
783 vfs_ChDir(conn, savedir);
788 /*******************************************************************
789 Reduce a file name, removing .. elements and checking that
790 it is below dir in the heirachy. This uses vfs_GetWd() and so must be run
791 on the system that has the referenced file system.
792 Widelinks are allowed if widelinks is true.
793 ********************************************************************/
795 BOOL reduce_name(connection_struct *conn, pstring s, const char *dir,BOOL widelinks)
805 BOOL relative = (*s != '/');
807 *dir2 = *wd = *base_name = *newname = 0;
811 /* can't have a leading .. */
812 if (strncmp(s,"..",2) == 0 && (s[2]==0 || s[2]=='/')) {
813 DEBUG(3,("Illegal file name? (%s)\n",s));
823 DEBUG(3,("reduce_name [%s] [%s]\n",s,dir));
825 /* remove any double slashes */
826 all_string_sub(s,"//","/",0);
828 pstrcpy(base_name,s);
829 p = strrchr_m(base_name,'/');
832 return readlink_check(conn, dir, s);
834 if (!vfs_GetWd(conn,wd)) {
835 DEBUG(0,("couldn't vfs_GetWd for %s %s\n",s,dir));
839 if (vfs_ChDir(conn,dir) != 0) {
840 DEBUG(0,("couldn't vfs_ChDir to %s\n",dir));
844 if (!vfs_GetWd(conn,dir2)) {
845 DEBUG(0,("couldn't vfs_GetWd for %s\n",dir));
850 if (p && (p != base_name)) {
852 if (strcmp(p+1,".")==0)
854 if (strcmp(p+1,"..")==0)
858 if (vfs_ChDir(conn,base_name) != 0) {
860 DEBUG(3,("couldn't vfs_ChDir for %s %s basename=%s\n",s,dir,base_name));
864 if (!vfs_GetWd(conn,newname)) {
866 DEBUG(2,("couldn't get vfs_GetWd for %s %s\n",s,base_name));
870 if (p && (p != base_name)) {
871 pstrcat(newname,"/");
872 pstrcat(newname,p+1);
876 size_t l = strlen(dir2);
877 if (dir2[l-1] == '/')
880 if (strncmp(newname,dir2,l) != 0) {
882 DEBUG(2,("Bad access attempt? s=%s dir=%s newname=%s l=%d\n",s,dir2,newname,(int)l));
886 if (!readlink_check(conn, dir, newname)) {
887 DEBUG(2, ("Bad access attemt? %s is a symlink outside the share path", s));
892 if (newname[l] == '/')
893 pstrcpy(s,newname + l + 1);
895 pstrcpy(s,newname+l);
905 DEBUG(3,("reduced to %s\n",s));