Add myself for packaging copyright and some minor tweaks
[deb_libnfs.git] / include / nfsc / libnfs.h
CommitLineData
dabf4152
AM
1/*
2 Copyright (C) 2010 by Ronnie Sahlberg <ronniesahlberg@gmail.com>
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU Lesser General Public License as published by
6 the Free Software Foundation; either version 2.1 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU Lesser General Public License for more details.
13
14 You should have received a copy of the GNU Lesser General Public License
15 along with this program; if not, see <http://www.gnu.org/licenses/>.
16*/
17/*
18 * This is the highlevel interface to access NFS resources using a posix-like interface
19 */
ee872606
RRS
20
21#ifndef _LIBNFS_H_
22#define _LIBNFS_H_
23
dabf4152 24#include <stdint.h>
ee872606
RRS
25#if defined(ANDROID)
26#include <sys/time.h>
27#endif
28#if defined(AROS)
29#include <sys/time.h>
30#endif
f1f22dbf
RRS
31#if defined(__APPLE__) && defined(__MACH__)
32#include <sys/time.h>
33#endif
ee872606
RRS
34
35#ifdef __cplusplus
36extern "C" {
37#endif
dabf4152 38
f1f22dbf
RRS
39#define LIBNFS_FEATURE_READAHEAD
40#define NFS_BLKSIZE 4096
41
dabf4152
AM
42struct nfs_context;
43struct rpc_context;
44
ee872606
RRS
45struct nfs_url {
46 char *server;
47 char *path;
48 char *file;
49};
50
5670ec6e
AM
51#if defined(WIN32)
52#define EXTERN __declspec( dllexport )
53#else
ee872606 54#define EXTERN
5670ec6e
AM
55#endif
56
57#if defined(WIN32)
58struct statvfs {
59 uint32_t f_bsize;
60 uint32_t f_frsize;
61 uint64_t f_blocks;
62 uint64_t f_bfree;
63 uint64_t f_bavail;
64 uint32_t f_files;
65 uint32_t f_ffree;
66 uint32_t f_favail;
ee872606 67 uint32_t f_fsid;
5670ec6e
AM
68 uint32_t f_flag;
69 uint32_t f_namemax;
70};
71struct utimbuf {
72 time_t actime;
73 time_t modtime;
74};
75#define R_OK 4
76#define W_OK 2
77#define X_OK 1
78#endif
79
dabf4152
AM
80/*
81 * Used for interfacing the async version of the api into an external eventsystem
82 */
5670ec6e
AM
83EXTERN int nfs_get_fd(struct nfs_context *nfs);
84EXTERN int nfs_which_events(struct nfs_context *nfs);
85EXTERN int nfs_service(struct nfs_context *nfs, int revents);
86EXTERN int nfs_queue_length(struct nfs_context *nfs);
dabf4152
AM
87
88/*
89 * Used if you need different credentials than the default for the current user.
90 */
ee872606
RRS
91struct AUTH;
92EXTERN void nfs_set_auth(struct nfs_context *nfs, struct AUTH *auth);
dabf4152
AM
93
94/*
95 * When an operation failed, this function can extract a detailed error string.
96 */
5670ec6e 97EXTERN char *nfs_get_error(struct nfs_context *nfs);
dabf4152
AM
98
99
100/*
101 * Callback for all ASYNC nfs functions
102 */
103typedef void (*nfs_cb)(int err, struct nfs_context *nfs, void *data, void *private_data);
104
105/*
106 * Callback for all ASYNC rpc functions
107 */
108typedef void (*rpc_cb)(struct rpc_context *rpc, int status, void *data, void *private_data);
109
110
111
112/*
113 * NFS CONTEXT.
114 */
115/*
116 * Create an NFS c, the context.
117 * Function returns
118 * NULL : Failed to create a context.
119 * *nfs : A pointer to an nfs context.
120 */
5670ec6e 121EXTERN struct nfs_context *nfs_init_context(void);
dabf4152
AM
122/*
123 * Destroy an nfs context.
124 */
5670ec6e 125EXTERN void nfs_destroy_context(struct nfs_context *nfs);
dabf4152
AM
126
127
ee872606
RRS
128/*
129 * URL parsing functions.
130 * These functions all parse a URL of the form
131 * nfs://server/path/file?argv=val[&arg=val]*
132 * and returns a nfs_url.
133 *
134 * Apart from parsing the URL the functions will also update
135 * the nfs context to reflect settings controlled via url arguments.
136 *
137 * Current URL arguments are :
138 * tcp-syncnt=<int> : Number of SYNs to send during the seccion establish
139 * before failing settin up the tcp connection to the
140 * server.
141 * uid=<int> : UID value to use when talking to the server.
142 * default it 65534 on Windows and getuid() on unixen.
143 * gid=<int> : GID value to use when talking to the server.
144 * default it 65534 on Windows and getgid() on unixen.
145 */
146/*
147 * Parse a complete NFS URL including, server, path and
148 * filename. Fail if any component is missing.
149 */
150EXTERN struct nfs_url *nfs_parse_url_full(struct nfs_context *nfs, const char *url);
151
152/*
153 * Parse an NFS URL, but do not split path and file. File
154 * in the resulting struct remains NULL.
155 */
156EXTERN struct nfs_url *nfs_parse_url_dir(struct nfs_context *nfs, const char *url);
157
158/*
159 * Parse an NFS URL, but do not fail if file, path or even server is missing.
160 * Check elements of the resulting struct for NULL.
161 */
162EXTERN struct nfs_url *nfs_parse_url_incomplete(struct nfs_context *nfs, const char *url);
163
164
165/*
166 * Free the URL struct returned by the nfs_parse_url_* functions.
167 */
168EXTERN void nfs_destroy_url(struct nfs_url *url);
169
170
dabf4152
AM
171struct nfsfh;
172
173/*
174 * Get the maximum supported READ3 size by the server
175 */
5670ec6e 176EXTERN uint64_t nfs_get_readmax(struct nfs_context *nfs);
dabf4152
AM
177
178/*
179 * Get the maximum supported WRITE3 size by the server
180 */
5670ec6e 181EXTERN uint64_t nfs_get_writemax(struct nfs_context *nfs);
dabf4152 182
ee872606
RRS
183/*
184 * MODIFY CONNECT PARAMTERS
185 */
186
187EXTERN void nfs_set_tcp_syncnt(struct nfs_context *nfs, int v);
188EXTERN void nfs_set_uid(struct nfs_context *nfs, int uid);
189EXTERN void nfs_set_gid(struct nfs_context *nfs, int gid);
f1f22dbf 190EXTERN void nfs_set_readahead(struct nfs_context *nfs, uint32_t v);
dabf4152
AM
191
192/*
193 * MOUNT THE EXPORT
194 */
195/*
196 * Async nfs mount.
197 * Function returns
198 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
199 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
200 *
201 * When the callback is invoked, status indicates the result:
202 * 0 : Success.
203 * data is NULL
204 * -errno : An error occured.
205 * data is the error string.
206 */
5670ec6e 207EXTERN int nfs_mount_async(struct nfs_context *nfs, const char *server, const char *exportname, nfs_cb cb, void *private_data);
dabf4152
AM
208/*
209 * Sync nfs mount.
210 * Function returns
211 * 0 : The operation was successfull.
212 * -errno : The command failed.
213 */
5670ec6e 214EXTERN int nfs_mount(struct nfs_context *nfs, const char *server, const char *exportname);
dabf4152
AM
215
216
217
218
219/*
220 * STAT()
221 */
222/*
223 * Async stat(<filename>)
224 * Function returns
225 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
226 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
227 *
228 * When the callback is invoked, status indicates the result:
229 * 0 : Success.
230 * data is struct stat *
231 * -errno : An error occured.
232 * data is the error string.
233 */
ee872606 234/* This function is deprecated. Use nfs_stat64_async() instead */
dabf4152 235struct stat;
5670ec6e 236EXTERN int nfs_stat_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
dabf4152
AM
237/*
238 * Sync stat(<filename>)
239 * Function returns
240 * 0 : The operation was successfull.
241 * -errno : The command failed.
242 */
ee872606
RRS
243/* This function is deprecated. Use nfs_stat64() instead */
244#ifdef WIN32
245EXTERN int nfs_stat(struct nfs_context *nfs, const char *path, struct __stat64 *st);
246#else
5670ec6e 247EXTERN int nfs_stat(struct nfs_context *nfs, const char *path, struct stat *st);
ee872606
RRS
248#endif
249
dabf4152 250
ee872606
RRS
251/* nfs_stat64
252 * 64 bit version if stat. All fields are always 64bit.
253 * Use these functions instead of nfs_stat[_async](), especially if you
254 * have weird stat structures.
255 */
256/*
257 * STAT()
258 */
259struct nfs_stat_64 {
260 uint64_t nfs_dev;
261 uint64_t nfs_ino;
262 uint64_t nfs_mode;
263 uint64_t nfs_nlink;
264 uint64_t nfs_uid;
265 uint64_t nfs_gid;
266 uint64_t nfs_rdev;
267 uint64_t nfs_size;
268 uint64_t nfs_blksize;
269 uint64_t nfs_blocks;
270 uint64_t nfs_atime;
271 uint64_t nfs_mtime;
272 uint64_t nfs_ctime;
273};
274
275/*
276 * Async stat(<filename>)
277 * Function returns
278 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
279 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
280 *
281 * When the callback is invoked, status indicates the result:
282 * 0 : Success.
283 * data is struct nfs_stat_64 *
284 * -errno : An error occured.
285 * data is the error string.
286 */
287EXTERN int nfs_stat64_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
288/*
289 * Sync stat(<filename>)
290 * Function returns
291 * 0 : The operation was successfull.
292 * -errno : The command failed.
293 */
294EXTERN int nfs_stat64(struct nfs_context *nfs, const char *path, struct nfs_stat_64 *st);
dabf4152
AM
295
296/*
297 * FSTAT()
298 */
299/*
300 * Async fstat(nfsfh *)
301 * Function returns
302 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
303 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
304 *
305 * When the callback is invoked, status indicates the result:
306 * 0 : Success.
307 * data is struct stat *
308 * -errno : An error occured.
309 * data is the error string.
310 */
5670ec6e 311EXTERN int nfs_fstat_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb, void *private_data);
dabf4152
AM
312/*
313 * Sync fstat(nfsfh *)
314 * Function returns
315 * 0 : The operation was successfull.
316 * -errno : The command failed.
317 */
ee872606
RRS
318#ifdef WIN32
319EXTERN int nfs_fstat(struct nfs_context *nfs, struct nfsfh *nfsfh, struct __stat64 *st);
320#else
5670ec6e 321EXTERN int nfs_fstat(struct nfs_context *nfs, struct nfsfh *nfsfh, struct stat *st);
ee872606 322#endif
dabf4152
AM
323
324
325
326/*
327 * OPEN()
328 */
329/*
330 * Async open(<filename>)
331 *
f1f22dbf
RRS
332 * mode is a combination of the flags :
333 * O_RDOLNY, O_WRONLY, O_RDWR , O_SYNC, O_APPEND
dabf4152
AM
334 *
335 * Function returns
336 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
337 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
338 *
ee872606 339 * Supported flags are
f1f22dbf 340 * O_APPEND
ee872606
RRS
341 * O_RDONLY
342 * O_WRONLY
343 * O_RDWR
344 * O_TRUNC (Only valid with O_RDWR or O_WRONLY. Ignored otherwise.)
345 *
dabf4152
AM
346 * When the callback is invoked, status indicates the result:
347 * 0 : Success.
348 * data is a struct *nfsfh;
349 * The nfsfh is close using nfs_close().
350 * -errno : An error occured.
351 * data is the error string.
352 */
ee872606 353EXTERN int nfs_open_async(struct nfs_context *nfs, const char *path, int flags, nfs_cb cb, void *private_data);
dabf4152 354/*
ee872606 355 * Sync open(<filename>)
dabf4152
AM
356 * Function returns
357 * 0 : The operation was successfull. *nfsfh is filled in.
358 * -errno : The command failed.
359 */
ee872606 360EXTERN int nfs_open(struct nfs_context *nfs, const char *path, int flags, struct nfsfh **nfsfh);
dabf4152
AM
361
362
363
364
365/*
366 * CLOSE
367 */
368/*
369 * Async close(nfsfh)
370 *
371 * Function returns
372 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
373 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
374 *
375 * When the callback is invoked, status indicates the result:
376 * 0 : Success.
377 * data is NULL.
378 * -errno : An error occured.
379 * data is the error string.
380 */
5670ec6e 381EXTERN int nfs_close_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb, void *private_data);
dabf4152
AM
382/*
383 * Sync close(nfsfh)
384 * Function returns
385 * 0 : The operation was successfull.
386 * -errno : The command failed.
387 */
5670ec6e 388EXTERN int nfs_close(struct nfs_context *nfs, struct nfsfh *nfsfh);
dabf4152
AM
389
390
391/*
392 * PREAD()
393 */
394/*
395 * Async pread()
396 *
397 * Function returns
398 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
399 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
400 *
401 * When the callback is invoked, status indicates the result:
402 * >=0 : Success.
403 * status is numer of bytes read.
404 * data is a pointer to the returned data.
405 * -errno : An error occured.
406 * data is the error string.
407 */
5670ec6e 408EXTERN int nfs_pread_async(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t offset, uint64_t count, nfs_cb cb, void *private_data);
dabf4152
AM
409/*
410 * Sync pread()
411 * Function returns
412 * >=0 : numer of bytes read.
413 * -errno : An error occured.
414 */
5670ec6e 415EXTERN int nfs_pread(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t offset, uint64_t count, char *buf);
dabf4152
AM
416
417
418
419/*
420 * READ()
421 */
422/*
423 * Async read()
424 *
425 * Function returns
426 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
427 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
428 *
429 * When the callback is invoked, status indicates the result:
430 * >=0 : Success.
431 * status is numer of bytes read.
432 * data is a pointer to the returned data.
433 * -errno : An error occured.
434 * data is the error string.
435 */
5670ec6e 436EXTERN int nfs_read_async(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t count, nfs_cb cb, void *private_data);
dabf4152
AM
437/*
438 * Sync read()
439 * Function returns
440 * >=0 : numer of bytes read.
441 * -errno : An error occured.
442 */
5670ec6e 443EXTERN int nfs_read(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t count, char *buf);
dabf4152
AM
444
445
446
447
448/*
449 * PWRITE()
450 */
451/*
452 * Async pwrite()
453 *
454 * Function returns
455 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
456 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
457 *
458 * When the callback is invoked, status indicates the result:
459 * >=0 : Success.
460 * status is numer of bytes written.
461 * -errno : An error occured.
462 * data is the error string.
463 */
5670ec6e 464EXTERN int nfs_pwrite_async(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t offset, uint64_t count, char *buf, nfs_cb cb, void *private_data);
dabf4152
AM
465/*
466 * Sync pwrite()
467 * Function returns
468 * >=0 : numer of bytes written.
469 * -errno : An error occured.
470 */
5670ec6e 471EXTERN int nfs_pwrite(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t offset, uint64_t count, char *buf);
dabf4152
AM
472
473
474/*
475 * WRITE()
476 */
477/*
478 * Async write()
479 *
480 * Function returns
481 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
482 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
483 *
484 * When the callback is invoked, status indicates the result:
485 * >=0 : Success.
486 * status is numer of bytes written.
487 * -errno : An error occured.
488 * data is the error string.
489 */
5670ec6e 490EXTERN int nfs_write_async(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t count, char *buf, nfs_cb cb, void *private_data);
dabf4152
AM
491/*
492 * Sync write()
493 * Function returns
494 * >=0 : numer of bytes written.
495 * -errno : An error occured.
496 */
5670ec6e 497EXTERN int nfs_write(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t count, char *buf);
dabf4152
AM
498
499
500/*
501 * LSEEK()
502 */
503/*
504 * Async lseek()
505 *
506 * Function returns
507 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
508 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
509 *
510 * When the callback is invoked, status indicates the result:
511 * >=0 : Success.
5670ec6e 512 * data is uint64_t * for the current position.
dabf4152
AM
513 * -errno : An error occured.
514 * data is the error string.
515 */
f1f22dbf 516EXTERN int nfs_lseek_async(struct nfs_context *nfs, struct nfsfh *nfsfh, int64_t offset, int whence, nfs_cb cb, void *private_data);
dabf4152
AM
517/*
518 * Sync lseek()
519 * Function returns
520 * >=0 : numer of bytes read.
521 * -errno : An error occured.
522 */
f1f22dbf 523EXTERN int nfs_lseek(struct nfs_context *nfs, struct nfsfh *nfsfh, int64_t offset, int whence, uint64_t *current_offset);
dabf4152
AM
524
525
526/*
527 * FSYNC()
528 */
529/*
530 * Async fsync()
531 *
532 * Function returns
533 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
534 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
535 *
536 * When the callback is invoked, status indicates the result:
537 * 0 : Success.
538 * -errno : An error occured.
539 * data is the error string.
540 */
5670ec6e 541EXTERN int nfs_fsync_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb, void *private_data);
dabf4152
AM
542/*
543 * Sync fsync()
544 * Function returns
545 * 0 : Success
546 * -errno : An error occured.
547 */
5670ec6e 548EXTERN int nfs_fsync(struct nfs_context *nfs, struct nfsfh *nfsfh);
dabf4152
AM
549
550
551
552/*
553 * TRUNCATE()
554 */
555/*
556 * Async truncate()
557 *
558 * Function returns
559 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
560 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
561 *
562 * When the callback is invoked, status indicates the result:
563 * 0 : Success.
564 * -errno : An error occured.
565 * data is the error string.
566 */
5670ec6e 567EXTERN int nfs_truncate_async(struct nfs_context *nfs, const char *path, uint64_t length, nfs_cb cb, void *private_data);
dabf4152
AM
568/*
569 * Sync truncate()
570 * Function returns
571 * 0 : Success
572 * -errno : An error occured.
573 */
5670ec6e 574EXTERN int nfs_truncate(struct nfs_context *nfs, const char *path, uint64_t length);
dabf4152
AM
575
576
577
578/*
579 * FTRUNCATE()
580 */
581/*
582 * Async ftruncate()
583 *
584 * Function returns
585 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
586 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
587 *
588 * When the callback is invoked, status indicates the result:
589 * 0 : Success.
590 * -errno : An error occured.
591 * data is the error string.
592 */
5670ec6e 593EXTERN int nfs_ftruncate_async(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t length, nfs_cb cb, void *private_data);
dabf4152
AM
594/*
595 * Sync ftruncate()
596 * Function returns
597 * 0 : Success
598 * -errno : An error occured.
599 */
5670ec6e 600EXTERN int nfs_ftruncate(struct nfs_context *nfs, struct nfsfh *nfsfh, uint64_t length);
dabf4152
AM
601
602
603
604
605
606
607/*
608 * MKDIR()
609 */
610/*
611 * Async mkdir()
612 *
613 * Function returns
614 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
615 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
616 *
617 * When the callback is invoked, status indicates the result:
618 * 0 : Success.
619 * -errno : An error occured.
620 * data is the error string.
621 */
5670ec6e 622EXTERN int nfs_mkdir_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
dabf4152
AM
623/*
624 * Sync mkdir()
625 * Function returns
626 * 0 : Success
627 * -errno : An error occured.
628 */
5670ec6e 629EXTERN int nfs_mkdir(struct nfs_context *nfs, const char *path);
dabf4152
AM
630
631
632
633/*
634 * RMDIR()
635 */
636/*
637 * Async rmdir()
638 *
639 * Function returns
640 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
641 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
642 *
643 * When the callback is invoked, status indicates the result:
644 * 0 : Success.
645 * -errno : An error occured.
646 * data is the error string.
647 */
5670ec6e 648EXTERN int nfs_rmdir_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
dabf4152
AM
649/*
650 * Sync rmdir()
651 * Function returns
652 * 0 : Success
653 * -errno : An error occured.
654 */
5670ec6e 655EXTERN int nfs_rmdir(struct nfs_context *nfs, const char *path);
dabf4152
AM
656
657
658
659
660/*
661 * CREAT()
662 */
663/*
664 * Async creat()
665 *
666 * Function returns
667 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
668 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
669 *
670 * When the callback is invoked, status indicates the result:
671 * 0 : Success.
672 * data is a struct *nfsfh;
673 * -errno : An error occured.
674 * data is the error string.
675 */
5670ec6e 676EXTERN int nfs_creat_async(struct nfs_context *nfs, const char *path, int mode, nfs_cb cb, void *private_data);
dabf4152
AM
677/*
678 * Sync creat()
679 * Function returns
680 * 0 : Success
681 * -errno : An error occured.
682 */
5670ec6e 683EXTERN int nfs_creat(struct nfs_context *nfs, const char *path, int mode, struct nfsfh **nfsfh);
dabf4152
AM
684
685
5670ec6e
AM
686/*
687 * MKNOD()
688 */
689/*
690 * Async mknod()
691 *
692 * Function returns
693 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
694 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
695 *
696 * When the callback is invoked, status indicates the result:
697 * 0 : Success.
698 * -errno : An error occured.
699 * data is the error string.
700 */
701EXTERN int nfs_mknod_async(struct nfs_context *nfs, const char *path, int mode, int dev, nfs_cb cb, void *private_data);
702/*
703 * Sync mknod()
704 * Function returns
705 * 0 : Success
706 * -errno : An error occured.
707 */
708EXTERN int nfs_mknod(struct nfs_context *nfs, const char *path, int mode, int dev);
dabf4152
AM
709
710
711
712/*
713 * UNLINK()
714 */
715/*
716 * Async unlink()
717 *
718 * Function returns
719 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
720 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
721 *
722 * When the callback is invoked, status indicates the result:
723 * 0 : Success.
724 * data is NULL
725 * -errno : An error occured.
726 * data is the error string.
727 */
5670ec6e 728EXTERN int nfs_unlink_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
dabf4152
AM
729/*
730 * Sync unlink()
731 * Function returns
732 * 0 : Success
733 * -errno : An error occured.
734 */
5670ec6e 735EXTERN int nfs_unlink(struct nfs_context *nfs, const char *path);
dabf4152
AM
736
737
738
739
740/*
741 * OPENDIR()
742 */
743struct nfsdir;
744/*
745 * Async opendir()
746 *
747 * Function returns
748 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
749 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
750 *
751 * When struct nfsdir * is returned, this resource is closed/freed by calling nfs_closedir()
752 *
753 * When the callback is invoked, status indicates the result:
754 * 0 : Success.
755 * data is struct nfsdir *
756 * -errno : An error occured.
757 * data is the error string.
758 */
5670ec6e 759EXTERN int nfs_opendir_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
dabf4152
AM
760/*
761 * Sync opendir()
762 * Function returns
763 * 0 : Success
764 * -errno : An error occured.
765 */
5670ec6e 766EXTERN int nfs_opendir(struct nfs_context *nfs, const char *path, struct nfsdir **nfsdir);
dabf4152
AM
767
768
769
770/*
771 * READDIR()
772 */
773struct nfsdirent {
774 struct nfsdirent *next;
775 char *name;
776 uint64_t inode;
5670ec6e 777
ee872606
RRS
778 /* Some extra fields we get for free through the READDIRPLUS3 call.
779 You need libnfs-raw-nfs.h for type/mode constants */
5670ec6e
AM
780 uint32_t type; /* NF3REG, NF3DIR, NF3BLK, ... */
781 uint32_t mode;
782 uint64_t size;
783 struct timeval atime;
784 struct timeval mtime;
785 struct timeval ctime;
ee872606
RRS
786 uint32_t uid;
787 uint32_t gid;
f1f22dbf 788 uint32_t nlink;
dabf4152
AM
789};
790/*
791 * nfs_readdir() never blocks, so no special sync/async versions are available
792 */
5670ec6e 793EXTERN struct nfsdirent *nfs_readdir(struct nfs_context *nfs, struct nfsdir *nfsdir);
dabf4152
AM
794
795
796
797/*
ee872606 798 * CLOSEDIR()
dabf4152
AM
799 */
800/*
801 * nfs_closedir() never blocks, so no special sync/async versions are available
802 */
5670ec6e 803EXTERN void nfs_closedir(struct nfs_context *nfs, struct nfsdir *nfsdir);
dabf4152
AM
804
805
ee872606
RRS
806/*
807 * CHDIR()
808 */
809/*
810 * Async chdir(<path>)
811 *
812 * Function returns
813 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
814 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
815 *
816 * When the callback is invoked, status indicates the result:
817 * 0 : Success.
818 * data is NULL;
819 * -errno : An error occured.
820 * data is the error string.
821 */
822EXTERN int nfs_chdir_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
823/*
824 * Sync chdir(<path>)
825 * Function returns
826 * 0 : The operation was successfull.
827 * -errno : The command failed.
828 */
829EXTERN int nfs_chdir(struct nfs_context *nfs, const char *path);
830
831/*
832 * GETCWD()
833 */
834/*
835 * nfs_getcwd() never blocks, so no special sync/async versions are available
836 */
837/*
838 * Sync getcwd()
839 * This function returns a pointer to the current working directory.
840 * This pointer is only stable until the next [f]chdir or when the
841 * context is destroyed.
842 *
843 * Function returns
844 * 0 : The operation was successfull and *cwd is filled in.
845 * -errno : The command failed.
846 */
847EXTERN void nfs_getcwd(struct nfs_context *nfs, const char **cwd);
848
dabf4152
AM
849
850/*
851 * STATVFS()
852 */
853/*
854 * Async statvfs(<dirname>)
855 * Function returns
856 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
857 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
858 *
859 * When the callback is invoked, status indicates the result:
860 * 0 : Success.
861 * data is struct statvfs *
862 * -errno : An error occured.
863 * data is the error string.
864 */
865struct statvfs;
5670ec6e 866EXTERN int nfs_statvfs_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
dabf4152
AM
867/*
868 * Sync statvfs(<dirname>)
869 * Function returns
870 * 0 : The operation was successfull.
871 * -errno : The command failed.
872 */
5670ec6e 873EXTERN int nfs_statvfs(struct nfs_context *nfs, const char *path, struct statvfs *svfs);
dabf4152
AM
874
875
876/*
877 * READLINK()
878 */
879/*
880 * Async readlink(<name>)
881 * Function returns
882 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
883 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
884 *
885 * When the callback is invoked, status indicates the result:
886 * 0 : Success.
887 * data is a char *
888 * data is only valid during the callback and is automatically freed when the callback returns.
889 * -errno : An error occured.
890 * data is the error string.
891 */
892struct statvfs;
5670ec6e 893EXTERN int nfs_readlink_async(struct nfs_context *nfs, const char *path, nfs_cb cb, void *private_data);
dabf4152
AM
894/*
895 * Sync readlink(<name>)
896 * Function returns
897 * 0 : The operation was successfull.
898 * -errno : The command failed.
899 */
5670ec6e 900EXTERN int nfs_readlink(struct nfs_context *nfs, const char *path, char *buf, int bufsize);
dabf4152
AM
901
902
903
904/*
905 * CHMOD()
906 */
907/*
908 * Async chmod(<name>)
909 * Function returns
910 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
911 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
912 *
913 * When the callback is invoked, status indicates the result:
914 * 0 : Success.
915 * data is NULL
916 * -errno : An error occured.
917 * data is the error string.
918 */
5670ec6e 919EXTERN int nfs_chmod_async(struct nfs_context *nfs, const char *path, int mode, nfs_cb cb, void *private_data);
dabf4152
AM
920/*
921 * Sync chmod(<name>)
922 * Function returns
923 * 0 : The operation was successfull.
924 * -errno : The command failed.
925 */
5670ec6e 926EXTERN int nfs_chmod(struct nfs_context *nfs, const char *path, int mode);
dabf4152
AM
927
928
929
930/*
931 * FCHMOD()
932 */
933/*
934 * Async fchmod(<handle>)
935 * Function returns
936 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
937 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
938 *
939 * When the callback is invoked, status indicates the result:
940 * 0 : Success.
941 * data is NULL
942 * -errno : An error occured.
943 * data is the error string.
944 */
5670ec6e 945EXTERN int nfs_fchmod_async(struct nfs_context *nfs, struct nfsfh *nfsfh, int mode, nfs_cb cb, void *private_data);
dabf4152
AM
946/*
947 * Sync fchmod(<handle>)
948 * Function returns
949 * 0 : The operation was successfull.
950 * -errno : The command failed.
951 */
5670ec6e 952EXTERN int nfs_fchmod(struct nfs_context *nfs, struct nfsfh *nfsfh, int mode);
dabf4152
AM
953
954
955
956/*
957 * CHOWN()
958 */
959/*
960 * Async chown(<name>)
961 * Function returns
962 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
963 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
964 *
965 * When the callback is invoked, status indicates the result:
966 * 0 : Success.
967 * data is NULL
968 * -errno : An error occured.
969 * data is the error string.
970 */
5670ec6e 971EXTERN int nfs_chown_async(struct nfs_context *nfs, const char *path, int uid, int gid, nfs_cb cb, void *private_data);
dabf4152
AM
972/*
973 * Sync chown(<name>)
974 * Function returns
975 * 0 : The operation was successfull.
976 * -errno : The command failed.
977 */
5670ec6e 978EXTERN int nfs_chown(struct nfs_context *nfs, const char *path, int uid, int gid);
dabf4152
AM
979
980
981
982/*
983 * FCHOWN()
984 */
985/*
986 * Async fchown(<handle>)
987 * Function returns
988 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
989 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
990 *
991 * When the callback is invoked, status indicates the result:
992 * 0 : Success.
993 * data is NULL
994 * -errno : An error occured.
995 * data is the error string.
996 */
5670ec6e 997EXTERN int nfs_fchown_async(struct nfs_context *nfs, struct nfsfh *nfsfh, int uid, int gid, nfs_cb cb, void *private_data);
dabf4152
AM
998/*
999 * Sync fchown(<handle>)
1000 * Function returns
1001 * 0 : The operation was successfull.
1002 * -errno : The command failed.
1003 */
5670ec6e 1004EXTERN int nfs_fchown(struct nfs_context *nfs, struct nfsfh *nfsfh, int uid, int gid);
dabf4152
AM
1005
1006
1007
1008
1009/*
1010 * UTIMES()
1011 */
1012/*
1013 * Async utimes(<path>)
1014 * Function returns
1015 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
1016 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
1017 *
1018 * When the callback is invoked, status indicates the result:
1019 * 0 : Success.
1020 * data is NULL
1021 * -errno : An error occured.
1022 * data is the error string.
1023 */
5670ec6e 1024EXTERN int nfs_utimes_async(struct nfs_context *nfs, const char *path, struct timeval *times, nfs_cb cb, void *private_data);
dabf4152
AM
1025/*
1026 * Sync utimes(<path>)
1027 * Function returns
1028 * 0 : The operation was successfull.
1029 * -errno : The command failed.
1030 */
5670ec6e 1031EXTERN int nfs_utimes(struct nfs_context *nfs, const char *path, struct timeval *times);
dabf4152
AM
1032
1033
1034/*
1035 * UTIME()
1036 */
1037/*
1038 * Async utime(<path>)
1039 * Function returns
1040 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
1041 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
1042 *
1043 * When the callback is invoked, status indicates the result:
1044 * 0 : Success.
1045 * data is NULL
1046 * -errno : An error occured.
1047 * data is the error string.
1048 */
1049struct utimbuf;
5670ec6e 1050EXTERN int nfs_utime_async(struct nfs_context *nfs, const char *path, struct utimbuf *times, nfs_cb cb, void *private_data);
dabf4152
AM
1051/*
1052 * Sync utime(<path>)
1053 * Function returns
1054 * 0 : The operation was successfull.
1055 * -errno : The command failed.
1056 */
5670ec6e 1057EXTERN int nfs_utime(struct nfs_context *nfs, const char *path, struct utimbuf *times);
dabf4152
AM
1058
1059
1060
1061
1062/*
1063 * ACCESS()
1064 */
1065/*
1066 * Async access(<path>)
1067 * Function returns
1068 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
1069 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
1070 *
1071 * When the callback is invoked, status indicates the result:
1072 * 0 : Success.
1073 * data is NULL
1074 * -errno : An error occured.
1075 * data is the error string.
1076 */
5670ec6e 1077EXTERN int nfs_access_async(struct nfs_context *nfs, const char *path, int mode, nfs_cb cb, void *private_data);
dabf4152
AM
1078/*
1079 * Sync access(<path>)
1080 * Function returns
1081 * 0 : The operation was successfull.
1082 * -errno : The command failed.
1083 */
5670ec6e 1084EXTERN int nfs_access(struct nfs_context *nfs, const char *path, int mode);
dabf4152
AM
1085
1086
1087
1088
1089/*
1090 * SYMLINK()
1091 */
1092/*
1093 * Async symlink(<path>)
1094 * Function returns
1095 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
1096 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
1097 *
1098 * When the callback is invoked, status indicates the result:
1099 * 0 : Success.
1100 * data is NULL
1101 * -errno : An error occured.
1102 * data is the error string.
1103 */
5670ec6e 1104EXTERN int nfs_symlink_async(struct nfs_context *nfs, const char *oldpath, const char *newpath, nfs_cb cb, void *private_data);
dabf4152
AM
1105/*
1106 * Sync symlink(<path>)
1107 * Function returns
1108 * 0 : The operation was successfull.
1109 * -errno : The command failed.
1110 */
5670ec6e 1111EXTERN int nfs_symlink(struct nfs_context *nfs, const char *oldpath, const char *newpath);
dabf4152
AM
1112
1113
1114/*
1115 * RENAME()
1116 */
1117/*
1118 * Async rename(<oldpath>, <newpath>)
1119 * Function returns
1120 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
1121 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
1122 *
1123 * When the callback is invoked, status indicates the result:
1124 * 0 : Success.
1125 * data is NULL
1126 * -errno : An error occured.
1127 * data is the error string.
1128 */
5670ec6e 1129EXTERN int nfs_rename_async(struct nfs_context *nfs, const char *oldpath, const char *newpath, nfs_cb cb, void *private_data);
dabf4152
AM
1130/*
1131 * Sync rename(<oldpath>, <newpath>)
1132 * Function returns
1133 * 0 : The operation was successfull.
1134 * -errno : The command failed.
1135 */
5670ec6e 1136EXTERN int nfs_rename(struct nfs_context *nfs, const char *oldpath, const char *newpath);
dabf4152
AM
1137
1138
1139
1140/*
1141 * LINK()
1142 */
1143/*
1144 * Async link(<oldpath>, <newpath>)
1145 * Function returns
1146 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
1147 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
1148 *
1149 * When the callback is invoked, status indicates the result:
1150 * 0 : Success.
1151 * data is NULL
1152 * -errno : An error occured.
1153 * data is the error string.
1154 */
5670ec6e 1155EXTERN int nfs_link_async(struct nfs_context *nfs, const char *oldpath, const char *newpath, nfs_cb cb, void *private_data);
dabf4152
AM
1156/*
1157 * Sync link(<oldpath>, <newpath>)
1158 * Function returns
1159 * 0 : The operation was successfull.
1160 * -errno : The command failed.
1161 */
5670ec6e 1162EXTERN int nfs_link(struct nfs_context *nfs, const char *oldpath, const char *newpath);
dabf4152
AM
1163
1164
1165/*
1166 * GETEXPORTS()
1167 */
1168/*
1169 * Async getexports()
1170 * NOTE: You must include 'libnfs-raw-mount.h' to get the definitions of the
1171 * returned structures.
1172 *
1173 * This function will return the list of exports from an NFS server.
1174 *
1175 * Function returns
1176 * 0 : The operation was initiated. Once the operation finishes, the callback will be invoked.
1177 * <0 : An error occured when trying to set up the operation. The callback will not be invoked.
1178 *
1179 * When the callback is invoked, status indicates the result:
1180 * 0 : Success.
1181 * data is a pointer to an exports pointer:
1182 * exports export = *(exports *)data;
1183 * -errno : An error occured.
1184 * data is the error string.
1185 */
5670ec6e 1186EXTERN int mount_getexports_async(struct rpc_context *rpc, const char *server, rpc_cb cb, void *private_data);
dabf4152
AM
1187/*
1188 * Sync getexports(<server>)
1189 * Function returns
1190 * NULL : something failed
1191 * exports export : a linked list of exported directories
ee872606 1192 *
dabf4152
AM
1193 * returned data must be freed by calling mount_free_export_list(exportnode);
1194 */
5670ec6e 1195EXTERN struct exportnode *mount_getexports(const char *server);
dabf4152 1196
5670ec6e 1197EXTERN void mount_free_export_list(struct exportnode *exports);
dabf4152
AM
1198
1199
1200//qqq replace later with lseek(cur, 0)
5670ec6e 1201uint64_t nfs_get_current_offset(struct nfsfh *nfsfh);
dabf4152
AM
1202
1203
1204
1205
1206
1207struct nfs_server_list {
1208 struct nfs_server_list *next;
1209 char *addr;
1210};
1211
1212/*
1213 * Sync find_local_servers(<server>)
1214 * This function will probe all local networks for NFS server. This function will
1215 * block for one second while awaiting for all nfs servers to respond.
1216 *
1217 * Function returns
1218 * NULL : something failed
1219 *
1220 * struct nfs_server_list : a linked list of all discovered servers
ee872606 1221 *
dabf4152
AM
1222 * returned data must be freed by nfs_free_srvr_list(srv);
1223 */
1224struct nfs_server_list *nfs_find_local_servers(void);
1225void free_nfs_srvr_list(struct nfs_server_list *srv);
ee872606
RRS
1226
1227#ifdef __cplusplus
1228}
1229#endif
1230
1231#endif /* !_LIBNFS_H_ */