include/nfsc/libnfs.h

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