r23785: use the GPLv3 boilerplate as recommended by the FSF and the license text
[samba.git] / examples / libsmbclient / smbwrapper / smbw.h
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 2.0
4    SMB wrapper functions - definitions
5    Copyright (C) Andrew Tridgell 1998
6    Copyright (C) Derrell Lipman 2003-2005
7    
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 3 of the License, or
11    (at your option) any later version.
12    
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.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #ifndef _SMBW_H
23 #define _SMBW_H
24
25 #include <sys/types.h>
26 #include <errno.h>
27 #include <malloc.h>
28 #include <limits.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include <time.h>
32 #include "config.h"             /* must come before libsmbclient.h */
33 #include "libsmbclient.h"
34 #include "wrapper.h"
35
36 #ifndef __restrict
37 #  define __restrict
38 #endif
39
40 #undef DEBUG
41 #define DEBUG(level, s) do { if (level <= debug_level) printf s; } while (0)
42
43
44 #define SMBW_PREFIX "/smb"
45 #define SMBW_DUMMY "/dev/null"
46
47 extern int smbw_initialized;
48 #define SMBW_INIT()     do { if (! smbw_initialized) smbw_init(); } while (0)
49
50 #if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)
51 #  define SMBW_OFF_T off64_t
52 #else
53 #  define SMBW_OFF_T off_t
54 #endif
55
56
57 /* The following definitions come from  smbwrapper/smbw.c  */
58
59 typedef enum {
60         SMBW_RCT_Increment,
61         SMBW_RCT_Decrement,
62         SMBW_RCT_Get,
63         SMBW_RCT_Set
64 } Ref_Count_Type;
65
66 int smbw_ref(int client_fd, Ref_Count_Type type, ...);
67 void smbw_init(void);
68 int smbw_fd(int fd);
69 int smbw_path(const char *path);
70 void smbw_clean_fname(char *name);
71 void smbw_fix_path(const char *src, char *dest);
72 void smbw_set_auth_data_fn(smbc_get_auth_data_fn fn);
73 int smbw_open(const char *fname, int flags, mode_t mode);
74 ssize_t smbw_pread(int fd, void *buf, size_t count, SMBW_OFF_T ofs);
75 ssize_t smbw_read(int fd, void *buf, size_t count);
76 ssize_t smbw_write(int fd, void *buf, size_t count);
77 ssize_t smbw_pwrite(int fd, void *buf, size_t count, SMBW_OFF_T ofs);
78 int smbw_close(int fd);
79 int smbw_fcntl(int fd, int cmd, long arg);
80 int smbw_access(const char *name, int mode);
81 int smbw_readlink(const char *path, char *buf, size_t bufsize);
82 int smbw_unlink(const char *fname);
83 int smbw_rename(const char *oldname, const char *newname);
84 int smbw_utime(const char *fname, void *buf);
85 int smbw_utimes(const char *fname, void *buf);
86 int smbw_chown(const char *fname, uid_t owner, gid_t group);
87 int smbw_chmod(const char *fname, mode_t newmode);
88 SMBW_OFF_T smbw_lseek(int smbw_fd, SMBW_OFF_T offset, int whence);
89 int smbw_dup(int fd);
90 int smbw_dup2(int fd, int fd2);
91 int smbw_fork(void);
92
93 /* The following definitions come from  smbwrapper/smbw_dir.c  */
94
95 int smbw_dirp(DIR * dirp);
96 int smbw_dir_open(const char *fname);
97 int smbw_dir_fstat(int fd, SMBW_stat *st);
98 int smbw_dir_close(int fd);
99 int smbw_getdents(unsigned int fd, SMBW_dirent *dirp, int count);
100 int smbw_chdir(const char *name);
101 int smbw_mkdir(const char *fname, mode_t mode);
102 int smbw_rmdir(const char *fname);
103 char *smbw_getcwd(char *buf, size_t size);
104 int smbw_fchdir(int fd);
105 DIR *smbw_opendir(const char *fname);
106 SMBW_dirent *smbw_readdir(DIR *dirp);
107 int smbw_readdir_r(DIR *dirp,
108                    struct SMBW_dirent *__restrict entry,
109                    struct SMBW_dirent **__restrict result);
110 int smbw_closedir(DIR *dirp);
111 void smbw_seekdir(DIR *dirp, long long offset);
112 long long smbw_telldir(DIR *dirp);
113 int smbw_setxattr(const char *fname,
114                   const char *name,
115                   const void *value,
116                   size_t size,
117                   int flags);
118 int smbw_lsetxattr(const char *fname,
119                    const char *name,
120                    const void *value,
121                    size_t size,
122                    int flags);
123 int smbw_fsetxattr(int smbw_fd,
124                    const char *name,
125                    const void *value,
126                    size_t size,
127                    int flags);
128 int smbw_getxattr(const char *fname,
129                   const char *name,
130                   const void *value,
131                   size_t size);
132 int smbw_lgetxattr(const char *fname,
133                    const char *name,
134                    const void *value,
135                    size_t size);
136 int smbw_fgetxattr(int smbw_fd,
137                    const char *name,
138                    const void *value,
139                    size_t size);
140 int smbw_removexattr(const char *fname,
141                      const char *name);
142 int smbw_lremovexattr(const char *fname,
143                       const char *name);
144 int smbw_fremovexattr(int smbw_fd,
145                       const char *name);
146 int smbw_listxattr(const char *fname,
147                    char *list,
148                    size_t size);
149 int smbw_llistxattr(const char *fname,
150                     char *list,
151                     size_t size);
152 int smbw_flistxattr(int smbw_fd,
153                     char *list,
154                     size_t size);
155
156 /* The following definitions come from  smbwrapper/smbw_stat.c  */
157
158 int smbw_fstat(int fd, SMBW_stat *st);
159 int smbw_stat(const char *fname, SMBW_stat *st);
160
161 /* The following definitions come from smbwrapper/cache.c */
162 int
163 smbw_cache_functions(SMBCCTX * context);
164
165
166 #endif /* _SMBW_H */