r9091: Fix #2954, aix 5.1 compile. Stupid aix aio.h header defines aio_error and
[nivanova/samba-autobuild/.git] / source3 / include / vfs.h
index 852e926e6da4a48b75a2624365b9c65bd13e0bf8..c7c7575d904c3299bf1d273157ed87c1e1a83a38 100644 (file)
@@ -1,6 +1,7 @@
 /* 
    Unix SMB/CIFS implementation.
    VFS structures and parameters
+   Copyright (C) Jeremy Allison                         1999-2005
    Copyright (C) Tim Potter                            1999
    Copyright (C) Alexander Bokovoy                     2002
    Copyright (C) Stefan (metze) Metzmacher             2003
@@ -40,6 +41,9 @@
  * This next constant specifies the version number of the VFS interface
  * this smbd will load. Increment this if *ANY* changes are made to the
  * vfs_ops below. JRA.
+ *
+ * If you change anything here, please also update modules/vfs_full_audit.c.
+ * VL.
  */
 
 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
 /* Changed to version 5 for sendfile addition. JRA. */
 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
-#define SMB_VFS_INTERFACE_VERSION 6
-
-
-/* to bug old modules witch are trying to compile with the old functions */
-#define vfs_init __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_6(void) { __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_6 };
+/* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
+/* Changed to version 8 includes EA calls. JRA. */
+/* Changed to version 9 to include the get_shadow_data call. --metze */
+/* Changed to version 10 to include pread/pwrite calls. */
+/* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
+/* Changed to version 12 to add mask and attributes to opendir(). JRA 
+   Also include aio calls. JRA. */
+/* Changed to version 13 as the internal structure of files_struct has changed. JRA */
+#define SMB_VFS_INTERFACE_VERSION 13
+
+
+/* to bug old modules which are trying to compile with the old functions */
+#define vfs_init __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore(void) { __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore };
 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
   __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
@@ -87,11 +99,16 @@ typedef enum _vfs_op_type {
        SMB_VFS_OP_DISK_FREE,
        SMB_VFS_OP_GET_QUOTA,
        SMB_VFS_OP_SET_QUOTA,
+       SMB_VFS_OP_GET_SHADOW_COPY_DATA,
+
 
        /* Directory operations */
 
        SMB_VFS_OP_OPENDIR,
        SMB_VFS_OP_READDIR,
+       SMB_VFS_OP_SEEKDIR,
+       SMB_VFS_OP_TELLDIR,
+       SMB_VFS_OP_REWINDDIR,
        SMB_VFS_OP_MKDIR,
        SMB_VFS_OP_RMDIR,
        SMB_VFS_OP_CLOSEDIR,
@@ -101,7 +118,9 @@ typedef enum _vfs_op_type {
        SMB_VFS_OP_OPEN,
        SMB_VFS_OP_CLOSE,
        SMB_VFS_OP_READ,
+       SMB_VFS_OP_PREAD,
        SMB_VFS_OP_WRITE,
+       SMB_VFS_OP_PWRITE,
        SMB_VFS_OP_LSEEK,
        SMB_VFS_OP_SENDFILE,
        SMB_VFS_OP_RENAME,
@@ -160,6 +179,29 @@ typedef enum _vfs_op_type {
        SMB_VFS_OP_SYS_ACL_FREE_ACL,
        SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
        
+       /* EA operations. */
+       SMB_VFS_OP_GETXATTR,
+       SMB_VFS_OP_LGETXATTR,
+       SMB_VFS_OP_FGETXATTR,
+       SMB_VFS_OP_LISTXATTR,
+       SMB_VFS_OP_LLISTXATTR,
+       SMB_VFS_OP_FLISTXATTR,
+       SMB_VFS_OP_REMOVEXATTR,
+       SMB_VFS_OP_LREMOVEXATTR,
+       SMB_VFS_OP_FREMOVEXATTR,
+       SMB_VFS_OP_SETXATTR,
+       SMB_VFS_OP_LSETXATTR,
+       SMB_VFS_OP_FSETXATTR,
+
+       /* aio operations */
+       SMB_VFS_OP_AIO_READ,
+       SMB_VFS_OP_AIO_WRITE,
+       SMB_VFS_OP_AIO_RETURN,
+       SMB_VFS_OP_AIO_CANCEL,
+       SMB_VFS_OP_AIO_ERROR,
+       SMB_VFS_OP_AIO_FSYNC,
+       SMB_VFS_OP_AIO_SUSPEND,
+
        /* This should always be last enum value */
        
        SMB_VFS_OP_LAST
@@ -172,17 +214,21 @@ struct vfs_ops {
        struct vfs_fn_pointers {
                /* Disk operations */
                
-               int (*connect)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *service, const char *user);
+               int (*connect_fn)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *service, const char *user);
                void (*disconnect)(struct vfs_handle_struct *handle, struct connection_struct *conn);
                SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, BOOL small_query, SMB_BIG_UINT *bsize, 
                        SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
                int (*get_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
                int (*set_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
+               int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, BOOL labels);
                
                /* Directory operations */
                
-               DIR *(*opendir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname);
-               struct dirent *(*readdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
+               DIR *(*opendir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, const char *mask, uint32 attributes);
+               SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
+               void (*seekdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp, long offset);
+               long (*telldir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
+               void (*rewind_dir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
                int (*mkdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
                int (*rmdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
                int (*closedir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dir);
@@ -190,12 +236,14 @@ struct vfs_ops {
                /* File operations */
                
                int (*open)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, int flags, mode_t mode);
-               int (*close)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
+               int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
                ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
+               ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_OFF_T offset);
                ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
+               ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_OFF_T offset);
                SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
                ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fsp, int fromfd, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
-               int (*rename)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *old, const char *new);
+               int (*rename)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldname, const char *newname);
                int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
                int (*stat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, SMB_STRUCT_STAT *sbuf);
                int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
@@ -218,8 +266,8 @@ struct vfs_ops {
                
                /* NT ACL operations. */
                
-               size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, struct security_descriptor_info **ppdesc);
-               size_t (*get_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, struct security_descriptor_info **ppdesc);
+               size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd,  uint32 security_info, struct security_descriptor_info **ppdesc);
+               size_t (*get_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name,  uint32 security_info, struct security_descriptor_info **ppdesc);
                BOOL (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor_info *psd);
                BOOL (*set_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor_info *psd);
                
@@ -250,21 +298,49 @@ struct vfs_ops {
                int (*sys_acl_free_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *text);
                int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T posix_acl);
                int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, void *qualifier, SMB_ACL_TAG_T tagtype);
+
+               /* EA operations. */
+               ssize_t (*getxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
+               ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
+               ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
+               ssize_t (*listxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
+               ssize_t (*llistxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
+               ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
+               int (*removexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
+               int (*lremovexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
+               int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
+               int (*setxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
+               int (*lsetxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
+               int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
+
+               /* aio operations */
+               int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
+               int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
+               ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
+               int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_AIOCB *aiocb);
+               int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
+               int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
+               int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
+
        } ops;
 
        struct vfs_handles_pointers {
                /* Disk operations */
 
-               struct vfs_handle_struct *connect;
+               struct vfs_handle_struct *connect_hnd;
                struct vfs_handle_struct *disconnect;
                struct vfs_handle_struct *disk_free;
                struct vfs_handle_struct *get_quota;
                struct vfs_handle_struct *set_quota;
+               struct vfs_handle_struct *get_shadow_copy_data;
 
                /* Directory operations */
 
                struct vfs_handle_struct *opendir;
                struct vfs_handle_struct *readdir;
+               struct vfs_handle_struct *seekdir;
+               struct vfs_handle_struct *telldir;
+               struct vfs_handle_struct *rewind_dir;
                struct vfs_handle_struct *mkdir;
                struct vfs_handle_struct *rmdir;
                struct vfs_handle_struct *closedir;
@@ -272,9 +348,11 @@ struct vfs_ops {
                /* File operations */
 
                struct vfs_handle_struct *open;
-               struct vfs_handle_struct *close;
+               struct vfs_handle_struct *close_hnd;
                struct vfs_handle_struct *read;
+               struct vfs_handle_struct *pread;
                struct vfs_handle_struct *write;
+               struct vfs_handle_struct *pwrite;
                struct vfs_handle_struct *lseek;
                struct vfs_handle_struct *sendfile;
                struct vfs_handle_struct *rename;
@@ -332,6 +410,29 @@ struct vfs_ops {
                struct vfs_handle_struct *sys_acl_free_text;
                struct vfs_handle_struct *sys_acl_free_acl;
                struct vfs_handle_struct *sys_acl_free_qualifier;
+
+               /* EA operations. */
+               struct vfs_handle_struct *getxattr;
+               struct vfs_handle_struct *lgetxattr;
+               struct vfs_handle_struct *fgetxattr;
+               struct vfs_handle_struct *listxattr;
+               struct vfs_handle_struct *llistxattr;
+               struct vfs_handle_struct *flistxattr;
+               struct vfs_handle_struct *removexattr;
+               struct vfs_handle_struct *lremovexattr;
+               struct vfs_handle_struct *fremovexattr;
+               struct vfs_handle_struct *setxattr;
+               struct vfs_handle_struct *lsetxattr;
+               struct vfs_handle_struct *fsetxattr;
+
+               /* aio operations */
+               struct vfs_handle_struct *aio_read;
+               struct vfs_handle_struct *aio_write;
+               struct vfs_handle_struct *aio_return;
+               struct vfs_handle_struct *aio_cancel;
+               struct vfs_handle_struct *aio_error;
+               struct vfs_handle_struct *aio_fsync;
+               struct vfs_handle_struct *aio_suspend;
        } handles;
 };
 
@@ -393,14 +494,14 @@ typedef struct vfs_handle_struct {
 } vfs_handle_struct;
 
 
-#define VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
+#define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
        if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
                DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
                ret; \
        } \
 }
 
-#define VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
+#define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
        if (!(handle)) { \
                DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
                ret; \
@@ -413,13 +514,16 @@ typedef struct vfs_handle_struct {
        } \
 }
 
-#define VFS_HANDLE_FREE_DATA(handle) { \
+#define SMB_VFS_HANDLE_FREE_DATA(handle) { \
        if ((handle) && (handle)->free_data) { \
                (handle)->free_data(&(handle)->data); \
        } \
 }
 
-#define VFS_OP(x) ((void *) x)
+/* Check whether module-specific data handle was already allocated or not */
+#define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
+
+#define SMB_VFS_OP(x) ((void *) x)
 
 
 #include "vfs_macros.h"