80215b0036b99269a0d402b8517b0c4b5364b1ed
[samba.git] / source / include / vfs.h
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    VFS structures and parameters
5    Copyright (C) Tim Potter 1999
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 2 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, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 #ifndef _VFS_H
23 #define _VFS_H
24
25 /* Types used in the definition of VFS operations.  These are included
26    here so the vfs.h file can be included by VFS modules without
27    having to pull in unnecessary amounts of other stuff.  Note to VFS
28    writers: you must include config.h before including this file.
29    The following type definitions reference the HAVE_* symbols which
30    are defined in config.h */
31
32 #ifndef SMB_OFF_T
33 #  ifdef HAVE_OFF64_T
34 #    define SMB_OFF_T off64_t
35 #  else
36 #    define SMB_OFF_T off_t
37 #  endif
38 #endif
39
40 #ifndef SMB_STRUCT_STAT
41 #  if defined(HAVE_STAT64) && defined(HAVE_OFF64_T)
42 #    define SMB_STRUCT_STAT struct stat64
43 #  else
44 #    define SMB_STRUCT_STAT struct stat
45 #  endif
46 #endif
47
48 #ifndef _BOOL
49 typedef int BOOL;
50 #endif
51
52 #ifndef _PSTRING
53 #define PSTRING_LEN 1024
54 #define FSTRING_LEN 128
55
56 typedef char pstring[PSTRING_LEN];
57 typedef char fstring[FSTRING_LEN];
58 #define _PSTRING
59 #endif
60
61 #if defined(HAVE_LONGLONG)
62 #define SMB_BIG_UINT unsigned long long
63 #else
64 #define SMB_BIG_UINT unsigned long
65 #endif
66
67 /* Information from the connection_struct passed to the vfs layer */
68
69 struct vfs_connection_struct {
70
71     /* Connection information */
72
73     BOOL printer;
74     BOOL ipc;
75     BOOL read_only;
76     BOOL admin_user;
77
78     /* Paths */
79
80     pstring dirpath;
81     pstring connectpath;
82     pstring origpath;
83     
84     /* Information on user who *opened* this connection */
85
86     pstring user;
87     uid_t uid;
88     gid_t gid;
89     int ngroups;
90     gid_t *groups;
91 };
92
93 /* VFS operations structure */
94
95 struct vfs_ops {
96
97     /* Disk operations */
98     
99     int (*connect)(struct vfs_connection_struct *conn, char *service, 
100                    char *user);
101     void (*disconnect)(void);
102     SMB_BIG_UINT (*disk_free)(char *path, SMB_BIG_UINT *bsize, 
103                               SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
104     
105     /* Directory operations */
106
107     DIR *(*opendir)(char *fname);
108     struct dirent *(*readdir)(DIR *dirp);
109     int (*mkdir)(char *path, mode_t mode);
110     int (*rmdir)(char *path);
111     int (*closedir)(DIR *dir);
112     
113     /* File operations */
114     
115     int (*open)(char *fname, int flags, mode_t mode);
116     int (*close)(int fd);
117     ssize_t (*read)(int fd, char *data, size_t n);
118     ssize_t (*write)(int fd, char *data, size_t n);
119     SMB_OFF_T (*lseek)(int filedes, SMB_OFF_T offset, int whence);
120     int (*rename)(char *old, char *new);
121     void (*sync)(int fd);
122     int (*stat)(char *fname, SMB_STRUCT_STAT *sbuf);
123     int (*fstat)(int fd, SMB_STRUCT_STAT *sbuf);
124     int (*lstat)(char *path, SMB_STRUCT_STAT *sbuf);
125     BOOL (*lock)(int fd, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
126     int (*unlink)(char *path);
127     int (*chmod)(char *path, mode_t mode);
128     int (*utime)(char *path, struct utimbuf *times);
129 };
130
131 #endif /* _VFS_H */