src/include/gnunet_disk_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2012 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file include/gnunet_disk_lib.h
  22  * @brief disk IO apis
  23  * @author Christian Grothoff
  24  */
  25 #ifndef GNUNET_DISK_LIB_H
  26 #define GNUNET_DISK_LIB_H
  27
  28 #if WINDOWS
  29 #define OFF_T uint64_t
  30 #else
  31 #define OFF_T off_t
  32 #endif
  33
  34 /**
  35  * Handle used to manage a pipe.
  36  */
  37 struct GNUNET_DISK_PipeHandle;
  38
  39 /**
  40  * Type of a handle.
  41  */
  42 enum GNUNET_FILE_Type
  43 {
  44   /**
  45    * Handle represents a file.
  46    */
  47   GNUNET_DISK_HANLDE_TYPE_FILE,
  48
  49   /**
  50    * Handle represents a pipe.
  51    */
  52   GNUNET_DISK_HANLDE_TYPE_PIPE
  53 };
  54
  55 /**
  56  * Handle used to access files (and pipes).
  57  */
  58 struct GNUNET_DISK_FileHandle
  59 {
  60
  61 #if WINDOWS
  62   /**
  63    * File handle under W32.
  64    */
  65   HANDLE h;
  66
  67   /**
  68    * Type
  69    */
  70   enum GNUNET_FILE_Type type;
  71
  72   /**
  73    * Structure for overlapped reading (for pipes)
  74    */
  75   OVERLAPPED *oOverlapRead;
  76
  77   /**
  78    * Structure for overlapped writing (for pipes)
  79    */
  80   OVERLAPPED *oOverlapWrite;
  81 #else
  82
  83   /**
  84    * File handle on other OSes.
  85    */
  86   int fd;
  87
  88 #endif
  89 };
  90
  91
  92 /* we need size_t, and since it can be both unsigned int
  93    or unsigned long long, this IS platform dependent;
  94    but "stdlib.h" should be portable 'enough' to be
  95    unconditionally available... */
  96 #include <stdlib.h>
  97 #include "gnunet_configuration_lib.h"
  98 #include "gnunet_scheduler_lib.h"
  99
 100 #ifdef __cplusplus
 101 extern "C"
 102 {
 103 #if 0                           /* keep Emacsens' auto-indent happy */
 104 }
 105 #endif
 106 #endif
 107
 108
 109 /**
 110  * Specifies how a file should be opened.
 111  */
 112 enum GNUNET_DISK_OpenFlags
 113 {
 114
 115   /**
 116    * Open the file for reading
 117    */
 118   GNUNET_DISK_OPEN_READ = 1,
 119
 120   /**
 121    * Open the file for writing
 122    */
 123   GNUNET_DISK_OPEN_WRITE = 2,
 124
 125   /**
 126    * Open the file for both reading and writing
 127    */
 128   GNUNET_DISK_OPEN_READWRITE = 3,
 129
 130   /**
 131    * Fail if file already exists
 132    */
 133   GNUNET_DISK_OPEN_FAILIFEXISTS = 4,
 134
 135   /**
 136    * Truncate file if it exists
 137    */
 138   GNUNET_DISK_OPEN_TRUNCATE = 8,
 139
 140   /**
 141    * Create file if it doesn't exist
 142    */
 143   GNUNET_DISK_OPEN_CREATE = 16,
 144
 145   /**
 146    * Append to the file
 147    */
 148   GNUNET_DISK_OPEN_APPEND = 32
 149 };
 150
 151 /**
 152  * Specifies what type of memory map is desired.
 153  */
 154 enum GNUNET_DISK_MapType
 155 {
 156   /**
 157    * Read-only memory map.
 158    */
 159   GNUNET_DISK_MAP_TYPE_READ = 1,
 160
 161   /**
 162    * Write-able memory map.
 163    */
 164   GNUNET_DISK_MAP_TYPE_WRITE = 2,
 165
 166   /**
 167    * Read-write memory map.
 168    */
 169   GNUNET_DISK_MAP_TYPE_READWRITE = 3
 170 };
 171
 172
 173 /**
 174  * File access permissions, UNIX-style.
 175  */
 176 enum GNUNET_DISK_AccessPermissions
 177 {
 178   /**
 179    * Nobody is allowed to do anything to the file.
 180    */
 181   GNUNET_DISK_PERM_NONE = 0,
 182
 183   /**
 184    * Owner can read.
 185    */
 186   GNUNET_DISK_PERM_USER_READ = 1,
 187
 188   /**
 189    * Owner can write.
 190    */
 191   GNUNET_DISK_PERM_USER_WRITE = 2,
 192
 193   /**
 194    * Owner can execute.
 195    */
 196   GNUNET_DISK_PERM_USER_EXEC = 4,
 197
 198   /**
 199    * Group can read.
 200    */
 201   GNUNET_DISK_PERM_GROUP_READ = 8,
 202
 203   /**
 204    * Group can write.
 205    */
 206   GNUNET_DISK_PERM_GROUP_WRITE = 16,
 207
 208   /**
 209    * Group can execute.
 210    */
 211   GNUNET_DISK_PERM_GROUP_EXEC = 32,
 212
 213   /**
 214    * Everybody can read.
 215    */
 216   GNUNET_DISK_PERM_OTHER_READ = 64,
 217
 218   /**
 219    * Everybody can write.
 220    */
 221   GNUNET_DISK_PERM_OTHER_WRITE = 128,
 222
 223   /**
 224    * Everybody can execute.
 225    */
 226   GNUNET_DISK_PERM_OTHER_EXEC = 256
 227 };
 228
 229
 230 /**
 231  * Constants for specifying how to seek.  Do not change values or order,
 232  * some of the code depends on the specific numeric values!
 233  */
 234 enum GNUNET_DISK_Seek
 235 {
 236   /**
 237    * Seek an absolute position (from the start of the file).
 238    */
 239   GNUNET_DISK_SEEK_SET = 0,
 240
 241   /**
 242    * Seek a relative position (from the current offset).
 243    */
 244   GNUNET_DISK_SEEK_CUR = 1,
 245
 246   /**
 247    * Seek an absolute position from the end of the file.
 248    */
 249   GNUNET_DISK_SEEK_END = 2
 250 };
 251
 252
 253 /**
 254  * Enumeration identifying the two ends of a pipe.
 255  */
 256 enum GNUNET_DISK_PipeEnd
 257 {
 258   /**
 259    * The reading-end of a pipe.
 260    */
 261   GNUNET_DISK_PIPE_END_READ = 0,
 262
 263   /**
 264    * The writing-end of a pipe.
 265    */
 266   GNUNET_DISK_PIPE_END_WRITE = 1
 267 };
 268
 269
 270 /**
 271  * Checks whether a handle is invalid
 272  *
 273  * @param h handle to check
 274  * @return GNUNET_YES if invalid, GNUNET_NO if valid
 275  */
 276 int
 277 GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h);
 278
 279
 280 /**
 281  * Check that fil corresponds to a filename
 282  * (of a file that exists and that is not a directory).
 283  *
 284  * @param fil filename to check
 285  * @return GNUNET_YES if yes, GNUNET_NO if not a file, GNUNET_SYSERR if something
 286  * else (will print an error message in that case, too).
 287  */
 288 int
 289 GNUNET_DISK_file_test (const char *fil);
 290
 291
 292 /**
 293  * Move a file out of the way (create a backup) by
 294  * renaming it to "orig.NUM~" where NUM is the smallest
 295  * number that is not used yet.
 296  *
 297  * @param fil name of the file to back up
 298  */
 299 void
 300 GNUNET_DISK_file_backup (const char *fil);
 301
 302
 303 /**
 304  * Move the read/write pointer in a file
 305  * @param h handle of an open file
 306  * @param offset position to move to
 307  * @param whence specification to which position the offset parameter relates to
 308  * @return the new position on success, GNUNET_SYSERR otherwise
 309  */
 310 OFF_T
 311 GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, OFF_T offset,
 312                        enum GNUNET_DISK_Seek whence);
 313
 314
 315 /**
 316  * Get the size of the file (or directory) of the given file (in
 317  * bytes).
 318  *
 319  * @param filename name of the file or directory
 320  * @param size set to the size of the file (or,
 321  *             in the case of directories, the sum
 322  *             of all sizes of files in the directory)
 323  * @param includeSymLinks should symbolic links be
 324  *        included?
 325  * @param singleFileMode GNUNET_YES to only get size of one file
 326  *        and return GNUNET_SYSERR for directories.
 327  * @return GNUNET_SYSERR on error, GNUNET_OK on success
 328  */
 329 int
 330 GNUNET_DISK_file_size (const char *filename, uint64_t * size,
 331                        int includeSymLinks, int singleFileMode);
 332
 333
 334 /**
 335  * Obtain some unique identifiers for the given file
 336  * that can be used to identify it in the local system.
 337  * This function is used between GNUnet processes to
 338  * quickly check if two files with the same absolute path
 339  * are actually identical.  The two processes represent
 340  * the same peer but may communicate over the network
 341  * (and the file may be on an NFS volume).  This function
 342  * may not be supported on all operating systems.
 343  *
 344  * @param filename name of the file
 345  * @param dev set to the device ID
 346  * @param ino set to the inode ID
 347  * @return GNUNET_OK on success
 348  */
 349 int
 350 GNUNET_DISK_file_get_identifiers (const char *filename, uint64_t * dev,
 351                                   uint64_t * ino);
 352
 353
 354 /**
 355  * Create an (empty) temporary file on disk.  If the given name is not
 356  * an absolute path, the current 'TMPDIR' will be prepended.  In any case,
 357  * 6 random characters will be appended to the name to create a unique
 358  * filename.
 359  *
 360  * @param t component to use for the name;
 361  *        does NOT contain "XXXXXX" or "/tmp/".
 362  * @return NULL on error, otherwise name of fresh
 363  *         file on disk in directory for temporary files
 364  */
 365 char *
 366 GNUNET_DISK_mktemp (const char *t);
 367
 368
 369 /**
 370  * Create an (empty) temporary directory on disk.  If the given name is not an
 371  * absolute path, the current 'TMPDIR' will be prepended.  In any case, 6
 372  * random characters will be appended to the name to create a unique name.
 373  *
 374  * @param t component to use for the name;
 375  *        does NOT contain "XXXXXX" or "/tmp/".
 376  * @return NULL on error, otherwise name of freshly created directory
 377  */
 378 char *
 379 GNUNET_DISK_mkdtemp (const char *t);
 380
 381
 382 /**
 383  * Open a file.  Note that the access permissions will only be
 384  * used if a new file is created and if the underlying operating
 385  * system supports the given permissions.
 386  *
 387  * @param fn file name to be opened
 388  * @param flags opening flags, a combination of GNUNET_DISK_OPEN_xxx bit flags
 389  * @param perm permissions for the newly created file, use
 390  *             GNUNET_DISK_PERM_NONE if a file could not be created by this
 391  *             call (because of flags)
 392  * @return IO handle on success, NULL on error
 393  */
 394 struct GNUNET_DISK_FileHandle *
 395 GNUNET_DISK_file_open (const char *fn, enum GNUNET_DISK_OpenFlags flags,
 396                        enum GNUNET_DISK_AccessPermissions perm);
 397
 398
 399 /**
 400  * Get the size of an open file.
 401  *
 402  * @param fh open file handle
 403  * @param size where to write size of the file
 404  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 405  */
 406 int
 407 GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle *fh,
 408                               OFF_T *size);
 409
 410
 411 /**
 412  * Creates an interprocess channel
 413  *
 414  * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO
 415  * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO
 416  * @param inherit_read 1 to make read handle inheritable, 0 otherwise (NT only)
 417  * @param inherit_write 1 to make write handle inheritable, 0 otherwise (NT only)
 418  * @return handle to the new pipe, NULL on error
 419  */
 420 struct GNUNET_DISK_PipeHandle *
 421 GNUNET_DISK_pipe (int blocking_read, int blocking_write, int inherit_read, int inherit_write);
 422
 423
 424 /**
 425  * Creates a pipe object from a couple of file descriptors.
 426  * Useful for wrapping existing pipe FDs.
 427  *
 428  * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO
 429  * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO
 430  * @param fd an array of two fd values. One of them may be -1 for read-only or write-only pipes
 431  *
 432  * @return handle to the new pipe, NULL on error
 433  */
 434 struct GNUNET_DISK_PipeHandle *
 435 GNUNET_DISK_pipe_from_fd (int blocking_read, int blocking_write, int fd[2]);
 436
 437
 438 /**
 439  * Closes an interprocess channel
 440  * @param p pipe
 441  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 442  */
 443 int
 444 GNUNET_DISK_pipe_close (struct GNUNET_DISK_PipeHandle *p);
 445
 446
 447 /**
 448  * Closes one half of an interprocess channel
 449  *
 450  * @param p pipe to close end of
 451  * @param end which end of the pipe to close
 452  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 453  */
 454 int
 455 GNUNET_DISK_pipe_close_end (struct GNUNET_DISK_PipeHandle *p,
 456                             enum GNUNET_DISK_PipeEnd end);
 457
 458 /**
 459  * Detaches one of the ends from the pipe.
 460  * Detached end is a fully-functional FileHandle, it will
 461  * not be affected by anything you do with the pipe afterwards.
 462  * Each end of a pipe can only be detched from it once (i.e.
 463  * it is not duplicated).
 464  *
 465  * @param p pipe to detach an end from
 466  * @param end which end of the pipe to detach
 467  * @return Detached end on success, NULL on failure
 468  * (or if that end is not present or is closed).
 469  */
 470 struct GNUNET_DISK_FileHandle *
 471 GNUNET_DISK_pipe_detach_end (struct GNUNET_DISK_PipeHandle *p,
 472                              enum GNUNET_DISK_PipeEnd end);
 473
 474 /**
 475  * Close an open file.
 476  *
 477  * @param h file handle
 478  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 479  */
 480 int
 481 GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h);
 482
 483
 484 /**
 485  * Get the handle to a particular pipe end
 486  *
 487  * @param p pipe
 488  * @param n end to access
 489  * @return handle for the respective end
 490  */
 491 const struct GNUNET_DISK_FileHandle *
 492 GNUNET_DISK_pipe_handle (const struct GNUNET_DISK_PipeHandle *p,
 493                          enum GNUNET_DISK_PipeEnd n);
 494
 495
 496 #if WINDOWS
 497 /**
 498  * Get a GNUnet file handle from a W32 handle (W32-only).
 499  * Do not call on non-W32 platforms (returns NULL).
 500  *
 501  * @param handle native handle
 502  * @return GNUnet file handle corresponding to the W32 handle
 503  */
 504 struct GNUNET_DISK_FileHandle *
 505 GNUNET_DISK_get_handle_from_w32_handle (HANDLE osfh);
 506 #endif
 507
 508 /**
 509  * Get a handle from a native integer FD.
 510  *
 511  * @param fno native integer file descriptor
 512  * @return file handle corresponding to the descriptor
 513  */
 514 struct GNUNET_DISK_FileHandle *
 515 GNUNET_DISK_get_handle_from_int_fd (int fno);
 516
 517 /**
 518  * Get a handle from a native FD.
 519  *
 520  * @param fd native file descriptor
 521  * @return file handle corresponding to the descriptor
 522  */
 523 struct GNUNET_DISK_FileHandle *
 524 GNUNET_DISK_get_handle_from_native (FILE *fd);
 525
 526
 527 /**
 528  * Read the contents of a binary file into a buffer.
 529  * @param h handle to an open file
 530  * @param result the buffer to write the result to
 531  * @param len the maximum number of bytes to read
 532  * @return the number of bytes read on success, GNUNET_SYSERR on failure
 533  */
 534 ssize_t
 535 GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h, void *result,
 536                        size_t len);
 537
 538
 539 /**
 540  * Read the contents of a binary file into a buffer.
 541  * Guarantees not to block (returns GNUNET_SYSERR and sets errno to EAGAIN
 542  * when no data can be read).
 543  *
 544  * @param h handle to an open file
 545  * @param result the buffer to write the result to
 546  * @param len the maximum number of bytes to read
 547  * @return the number of bytes read on success, GNUNET_SYSERR on failure
 548  */
 549 ssize_t
 550 GNUNET_DISK_file_read_non_blocking (const struct GNUNET_DISK_FileHandle * h,
 551                                     void *result, size_t len);
 552
 553
 554 /**
 555  * Read the contents of a binary file into a buffer.
 556  *
 557  * @param fn file name
 558  * @param result the buffer to write the result to
 559  * @param len the maximum number of bytes to read
 560  * @return number of bytes read, GNUNET_SYSERR on failure
 561  */
 562 ssize_t
 563 GNUNET_DISK_fn_read (const char *fn, void *result, size_t len);
 564
 565
 566 /**
 567  * Write a buffer to a file.
 568  *
 569  * @param h handle to open file
 570  * @param buffer the data to write
 571  * @param n number of bytes to write
 572  * @return number of bytes written on success, GNUNET_SYSERR on error
 573  */
 574 ssize_t
 575 GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle *h,
 576                         const void *buffer, size_t n);
 577
 578
 579 /**
 580  * Write a buffer to a file, blocking, if necessary.
 581  * @param h handle to open file
 582  * @param buffer the data to write
 583  * @param n number of bytes to write
 584  * @return number of bytes written on success, GNUNET_SYSERR on error
 585  */
 586 ssize_t
 587 GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle * h,
 588                                  const void *buffer,
 589                                  size_t n);
 590
 591
 592 /**
 593  * Write a buffer to a file.  If the file is longer than
 594  * the given buffer size, it will be truncated.
 595  *
 596  * @param fn file name
 597  * @param buffer the data to write
 598  * @param n number of bytes to write
 599  * @param mode file permissions
 600  * @return number of bytes written on success, GNUNET_SYSERR on error
 601  */
 602 ssize_t
 603 GNUNET_DISK_fn_write (const char *fn, const void *buffer, size_t n,
 604                       enum GNUNET_DISK_AccessPermissions mode);
 605
 606
 607 /**
 608  * Copy a file.
 609  *
 610  * @param src file to copy
 611  * @param dst destination file name
 612  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 613  */
 614 int
 615 GNUNET_DISK_file_copy (const char *src, const char *dst);
 616
 617
 618 /**
 619  * Scan a directory for files.
 620  *
 621  * @param dirName the name of the directory
 622  * @param callback the method to call for each file
 623  * @param callback_cls closure for callback
 624  * @return the number of files found, -1 on error
 625  */
 626 int
 627 GNUNET_DISK_directory_scan (const char *dirName,
 628                             GNUNET_FileNameCallback callback,
 629                             void *callback_cls);
 630
 631
 632 /**
 633  * Opaque handle used for iterating over a directory.
 634  */
 635 struct GNUNET_DISK_DirectoryIterator;
 636
 637
 638 /**
 639  * Function called to iterate over a directory.
 640  *
 641  * @param cls closure
 642  * @param di argument to pass to "GNUNET_DISK_directory_iterator_next" to
 643  *           get called on the next entry (or finish cleanly);
 644  *           NULL on error (will be the last call in that case)
 645  * @param filename complete filename (absolute path)
 646  * @param dirname directory name (absolute path)
 647  */
 648 typedef void (*GNUNET_DISK_DirectoryIteratorCallback) (void *cls,
 649                                                        struct
 650                                                        GNUNET_DISK_DirectoryIterator
 651                                                        * di,
 652                                                        const char *filename,
 653                                                        const char *dirname);
 654
 655
 656 /**
 657  * This function must be called during the DiskIteratorCallback
 658  * (exactly once) to schedule the task to process the next
 659  * filename in the directory (if there is one).
 660  *
 661  * @param iter opaque handle for the iterator
 662  * @param can set to GNUNET_YES to terminate the iteration early
 663  * @return GNUNET_YES if iteration will continue,
 664  *         GNUNET_NO if this was the last entry (and iteration is complete),
 665  *         GNUNET_SYSERR if "can" was YES
 666  */
 667 int
 668 GNUNET_DISK_directory_iterator_next (struct GNUNET_DISK_DirectoryIterator *iter,
 669                                      int can);
 670
 671
 672 /**
 673  * Scan a directory for files using the scheduler to run a task for
 674  * each entry.  The name of the directory must be expanded first (!).
 675  * If a scheduler does not need to be used, GNUNET_DISK_directory_scan
 676  * may provide a simpler API.
 677  *
 678  * @param prio priority to use
 679  * @param dirName the name of the directory
 680  * @param callback the method to call for each file
 681  * @param callback_cls closure for callback
 682  * @return GNUNET_YES if directory is not empty and 'callback'
 683  *         will be called later, GNUNET_NO otherwise, GNUNET_SYSERR on error.
 684  */
 685 int
 686 GNUNET_DISK_directory_iterator_start (enum GNUNET_SCHEDULER_Priority prio,
 687                                       const char *dirName,
 688                                       GNUNET_DISK_DirectoryIteratorCallback
 689                                       callback, void *callback_cls);
 690
 691
 692 /**
 693  * Create the directory structure for storing
 694  * a file.
 695  *
 696  * @param filename name of a file in the directory
 697  * @returns GNUNET_OK on success, GNUNET_SYSERR on failure,
 698  *          GNUNET_NO if directory exists but is not writeable
 699  */
 700 int
 701 GNUNET_DISK_directory_create_for_file (const char *filename);
 702
 703
 704 /**
 705  * Test if "fil" is a directory and listable. Optionally, also check if the
 706  * directory is readable.  Will not print an error message if the directory does
 707  * not exist.  Will log errors if GNUNET_SYSERR is returned (i.e., a file exists
 708  * with the same name).
 709  *
 710  * @param fil filename to test
 711  * @param is_readable GNUNET_YES to additionally check if "fil" is readable;
 712  *          GNUNET_NO to disable this check
 713  * @return GNUNET_YES if yes, GNUNET_NO if not; GNUNET_SYSERR if it
 714  *           does not exist or stat'ed
 715  */
 716 int
 717 GNUNET_DISK_directory_test (const char *fil, int is_readable);
 718
 719
 720 /**
 721  * Remove all files in a directory (rm -rf). Call with
 722  * caution.
 723  *
 724  * @param filename the file to remove
 725  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 726  */
 727 int
 728 GNUNET_DISK_directory_remove (const char *filename);
 729
 730
 731 /**
 732  * Implementation of "mkdir -p"
 733  *
 734  * @param dir the directory to create
 735  * @returns GNUNET_SYSERR on failure, GNUNET_OK otherwise
 736  */
 737 int
 738 GNUNET_DISK_directory_create (const char *dir);
 739
 740
 741 /**
 742  * Lock a part of a file.
 743  *
 744  * @param fh file handle
 745  * @param lockStart absolute position from where to lock
 746  * @param lockEnd absolute position until where to lock
 747  * @param excl GNUNET_YES for an exclusive lock
 748  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 749  */
 750 int
 751 GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, OFF_T lockStart,
 752                        OFF_T lockEnd, int excl);
 753
 754
 755 /**
 756  * Unlock a part of a file
 757  * @param fh file handle
 758  * @param unlockStart absolute position from where to unlock
 759  * @param unlockEnd absolute position until where to unlock
 760  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 761  */
 762 int
 763 GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, OFF_T unlockStart,
 764                          OFF_T unlockEnd);
 765
 766
 767 /**
 768  * @brief Removes special characters as ':' from a filename.
 769  * @param fn the filename to canonicalize
 770  */
 771 void
 772 GNUNET_DISK_filename_canonicalize (char *fn);
 773
 774
 775 /**
 776  * @brief Change owner of a file
 777  * @param filename file to change
 778  * @param user new owner of the file
 779  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 780  */
 781 int
 782 GNUNET_DISK_file_change_owner (const char *filename, const char *user);
 783
 784
 785 /**
 786  * Construct full path to a file inside of the private
 787  * directory used by GNUnet.  Also creates the corresponding
 788  * directory.  If the resulting name is supposed to be
 789  * a directory, end the last argument in '/' (or pass
 790  * DIR_SEPARATOR_STR as the last argument before NULL).
 791  *
 792  * @param cfg configuration to use
 793  * @param serviceName name of the service asking
 794  * @param ... is NULL-terminated list of
 795  *                path components to append to the
 796  *                private directory name.
 797  * @return the constructed filename
 798  */
 799 char *
 800 GNUNET_DISK_get_home_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
 801                                const char *serviceName, ...);
 802
 803
 804 /**
 805  * Opaque handle for a memory-mapping operation.
 806  */
 807 struct GNUNET_DISK_MapHandle;
 808
 809 /**
 810  * Map a file into memory
 811  * @param h open file handle
 812  * @param m handle to the new mapping (will be set)
 813  * @param access access specification, GNUNET_DISK_MAP_TYPE_xxx
 814  * @param len size of the mapping
 815  * @return pointer to the mapped memory region, NULL on failure
 816  */
 817 void *
 818 GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle *h,
 819                       struct GNUNET_DISK_MapHandle **m,
 820                       enum GNUNET_DISK_MapType access, size_t len);
 821
 822 /**
 823  * Unmap a file
 824  *
 825  * @param h mapping handle
 826  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 827  */
 828 int
 829 GNUNET_DISK_file_unmap (struct GNUNET_DISK_MapHandle *h);
 830
 831 /**
 832  * Write file changes to disk
 833  * @param h handle to an open file
 834  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 835  */
 836 int
 837 GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h);
 838
 839
 840 #if 0                           /* keep Emacsens' auto-indent happy */
 841 {
 842 #endif
 843 #ifdef __cplusplus
 844 }
 845 #endif
 846
 847
 848 /* ifndef GNUNET_DISK_LIB_H */
 849 #endif
 850 /* end of gnunet_disk_lib.h */