summaryrefslogtreecommitdiffstats
path: root/libglusterfsclient/src/libglusterfsclient.h
blob: 87297ac132ee19428f3764e922313b61ac9eefce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
/*
  Copyright (c) 2008, 2009 Z RESEARCH, Inc. <http://www.zresearch.com>
  This file is part of GlusterFS.

  GlusterFS is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published
  by the Free Software Foundation; either version 3 of the License,
  or (at your option) any later version.

  GlusterFS is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see
  <http://www.gnu.org/licenses/>.
*/

#ifndef _LIBGLUSTERFSCLIENT_H
#define _LIBGLUSTERFSCLIENT_H

#include <sys/cdefs.h>

__BEGIN_DECLS

#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <dirent.h>
#include <sys/vfs.h>
#include <sys/statvfs.h>
#include <utime.h>
#include <sys/time.h>

typedef struct {
        struct iovec *vector;
        int           count;
        void         *iobref;
        void         *dictref;
} glusterfs_iobuf_t;

typedef struct {
        char          *logfile;
        char          *loglevel;
        struct {
                char  *specfile;
                FILE  *specfp;
        }; 
        char          *volume_name;
        unsigned long  lookup_timeout;
        unsigned long  stat_timeout;
} glusterfs_init_params_t;

typedef void * glusterfs_handle_t;

/* FIXME: how is glusterfs_file_t different from glusterfs_dir_t? */
typedef void * glusterfs_file_t;
typedef void * glusterfs_dir_t;

typedef
int (*glusterfs_readv_cbk_t) (int op_ret, int op_errno, glusterfs_iobuf_t *buf,
			      void *cbk_data);

typedef
int (*glusterfs_write_cbk_t) (int op_ret, int op_errno, void *cbk_data);

typedef
int (*glusterfs_get_cbk_t) (int op_ret, int op_errno, glusterfs_iobuf_t *buf,
			    struct stat *stbuf, void *cbk_data);

/* Used to free the glusterfs_read_buf passed to the application from
   glusterfs_read_async_cbk
*/
void
glusterfs_free (glusterfs_iobuf_t *buf);

/* libglusterfsclient initialization function  */
glusterfs_handle_t
glusterfs_init (glusterfs_init_params_t *ctx);

int
glusterfs_fini (glusterfs_handle_t handle);

/* For smaller files, application can use just glusterfs_get/glusterfs_get_async
 * to read the whole content. Limit of the file-sizes to be read in
 * glusterfs_get/glusterfs_get_async is passed in the size argument
 */

/* glusterfs_get:
 * @handle : glusterfs handle
 * @path   : path to be looked upon
 * @size   : upper limit of file-sizes to be read in lookup
 * @stbuf  : attribute buffer
 */

int
glusterfs_glh_get (glusterfs_handle_t handle, const char *path, void *buf,
	       size_t size, struct stat *stbuf);

int
glusterfs_get (const char *path, void *buf, size_t size, struct stat *stbuf);

int
glusterfs_get_async (glusterfs_handle_t handle, const char *path, size_t size,
		     glusterfs_get_cbk_t cbk, void *cbk_data);

glusterfs_file_t
glusterfs_glh_open (glusterfs_handle_t handle, const char *path, int flags,
                        ...);

glusterfs_file_t
glusterfs_open (const char *path, int flags, ...);

glusterfs_file_t
glusterfs_glh_creat (glusterfs_handle_t handle, const char *path, mode_t mode);

glusterfs_file_t
glusterfs_creat (const char *path, mode_t mode);

int
glusterfs_close (glusterfs_file_t fd);

int
glusterfs_glh_stat (glusterfs_handle_t handle, const char *path,
                        struct stat *stbuf);

int
glusterfs_stat (const char *path, struct stat *buf);

int
glusterfs_glh_lstat (glusterfs_handle_t handle, const char *path,
                        struct stat *buf);

int
glusterfs_lstat (const char *path, struct stat *buf);

int
glusterfs_fstat (glusterfs_file_t fd, struct stat *stbuf);

int
glusterfs_glh_setxattr (glusterfs_handle_t handle, const char *path,
                                const char *name, const void *value,
                                size_t size, int flags);

int
glusterfs_setxattr (const char *path, const char *name, const void *value,
                        size_t size, int flags);

int
glusterfs_lsetxattr (glusterfs_handle_t handle, const char *path,
                     const char *name, const void *value, size_t size,
                     int flags);

int
glusterfs_fsetxattr (glusterfs_file_t fd, const char *name, const void *value,
                     size_t size, int flags);

ssize_t
glusterfs_glh_getxattr (glusterfs_handle_t handle, const char *path,
		                const char *name, void *value, size_t size);

ssize_t
glusterfs_getxattr (const char *path, const char *name, void *value,
                        size_t size);

ssize_t
glusterfs_lgetxattr (glusterfs_handle_t handle, const char *path,
                     const char *name, void *value, size_t size);

ssize_t
glusterfs_fgetxattr (glusterfs_file_t fd, const char *name, void *value,
		     size_t size);

ssize_t
glusterfs_listxattr (glusterfs_handle_t handle, const char *path, char *list,
                     size_t size);

ssize_t
glusterfs_llistxattr (glusterfs_handle_t handle, const char *path, char *list,
                      size_t size);

ssize_t
glusterfs_flistxattr (glusterfs_file_t fd, char *list, size_t size);

int
glusterfs_removexattr (glusterfs_handle_t handle, const char *path,
		       const char *name);

int
glusterfs_lremovexattr (glusterfs_handle_t handle, const char *path,
			const char *name);

int
glusterfs_fremovexattr (glusterfs_file_t fd, const char *name);

ssize_t
glusterfs_read (glusterfs_file_t fd, void *buf, size_t nbytes);

ssize_t
glusterfs_readv (glusterfs_file_t fd, const struct iovec *vec, int count);

int
glusterfs_read_async (glusterfs_file_t fd, size_t nbytes, off_t offset,
                      glusterfs_readv_cbk_t readv_cbk, void *cbk_data);

ssize_t
glusterfs_write (glusterfs_file_t fd, const void *buf, size_t nbytes);

ssize_t
glusterfs_writev (glusterfs_file_t fd, const struct iovec *vector, int count);

int
glusterfs_write_async (glusterfs_file_t fd, const void *buf, size_t nbytes,
                       off_t offset, glusterfs_write_cbk_t write_cbk,
		       void *cbk_data);

int
glusterfs_writev_async (glusterfs_file_t fd, const struct iovec *vector,
			int count, off_t offset,
			glusterfs_write_cbk_t write_cbk, void *cbk_data);

ssize_t
glusterfs_pread (glusterfs_file_t fd, void *buf, size_t nbytes, off_t offset);

ssize_t
glusterfs_pwrite (glusterfs_file_t fd, const void *buf, size_t nbytes,
		  off_t offset);

off_t
glusterfs_lseek (glusterfs_file_t fd, off_t offset, int whence);

int
glusterfs_glh_mkdir (glusterfs_handle_t handle, const char *path, mode_t mode);

int
glusterfs_mkdir (const char *path, mode_t mode);

int
glusterfs_glh_rmdir (glusterfs_handle_t handle, const char *path);

int
glusterfs_rmdir (const char *path);
/* FIXME: implement man 3 readdir semantics */
int
glusterfs_readdir (glusterfs_dir_t fd, struct dirent *dirp,
		   unsigned int count);

int
glusterfs_closedir (glusterfs_dir_t dirfd);
/* FIXME: remove getdents */
int
glusterfs_getdents (glusterfs_dir_t fd, struct dirent *dirp,
		    unsigned int count);

int
glusterfs_glh_mknod(glusterfs_handle_t handle, const char *pathname,
                        mode_t mode, dev_t dev);

int
glusterfs_mknod(const char *pathname, mode_t mode, dev_t dev);

char *
glusterfs_glh_realpath (glusterfs_handle_t handle, const char *path,
                        char *resolved_path);

char *
glusterfs_realpath (const char *path, char *resolved_path);

int
glusterfs_mount (char *vmp, glusterfs_init_params_t *ipars);

int
glusterfs_umount (char *vmp);

int
glusterfs_glh_chmod (glusterfs_handle_t handle, const char *path, mode_t mode);

int
glusterfs_chmod (const char *path, mode_t mode);

int
glusterfs_glh_chown (glusterfs_handle_t handle, const char *path, uid_t owner,
                        gid_t group);

int
glusterfs_chown (const char *path, uid_t owner, gid_t group);

int
glusterfs_fchown (glusterfs_file_t fd, uid_t owner, gid_t group);

glusterfs_dir_t
glusterfs_glh_opendir (glusterfs_handle_t handle, const char *path);

glusterfs_dir_t
glusterfs_opendir (const char *path);

int
glusterfs_fchmod (glusterfs_file_t fd, mode_t mode);

int
glusterfs_fsync (glusterfs_file_t *fd);

int
glusterfs_ftruncate (glusterfs_file_t fd, off_t length);

int
glusterfs_glh_link (glusterfs_handle_t handle, const char *oldpath,
                        const char *newpath);

int
glusterfs_link (const char *oldpath, const char *newpath);

int
glusterfs_glh_statfs (glusterfs_handle_t handle, const char *path,
                        struct statfs *buf);

int
glusterfs_statfs (const char *path, struct statfs *buf);

int
glusterfs_glh_statvfs (glusterfs_handle_t handle, const char *path,
                   struct statvfs *buf);

int
glusterfs_statvfs (const char *path, struct statvfs *buf);

int
glusterfs_glh_utimes (glusterfs_handle_t handle, const char *path,
                        const struct timeval times[2]);

int
glusterfs_utimes (const char *path, const struct timeval times[2]);

int
glusterfs_glh_utime (glusterfs_handle_t handle, const char *path,
                        const struct utimbuf *buf);

int
glusterfs_utime (const char *path, const struct utimbuf *buf);

int
glusterfs_glh_mkfifo (glusterfs_handle_t handle, const char *path,
                        mode_t mode);

int
glusterfs_mkfifo (const char *path, mode_t mode);

int
glusterfs_glh_unlink (glusterfs_handle_t handle, const char *path);

int
glusterfs_unlink (const char *path);

int
glusterfs_glh_symlink (glusterfs_handle_t handle, const char *oldpath,
                                const char *newpath);

int
glusterfs_symlink (const char *oldpath, const char *newpath);

ssize_t
glusterfs_glh_readlink (glusterfs_handle_t handle, const char *path, char *buf,
                                size_t bufsize);

ssize_t
glusterfs_readlink (const char *path, char *buf, size_t bufsize);

int
glusterfs_glh_rename (glusterfs_handle_t handle, const char *oldpath,
                      const char *newpath);

int
glusterfs_rename (const char *oldpath, const char *newpath);
/* FIXME: review the need for these apis */
/* added for log related initialization in booster fork implementation */
void
glusterfs_reset (void);

void
glusterfs_log_lock (void);

void
glusterfs_log_unlock (void);

__END_DECLS

#endif /* !_LIBGLUSTERFSCLIENT_H */