src/include/gnunet_disk_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009 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 /**
  22  * @file include/gnunet_disk_lib.h
  23  * @brief disk IO apis
  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
  93 /* we need size_t, and since it can be both unsigned int
  94    or unsigned long long, this IS platform dependent;
  95    but "stdlib.h" should be portable 'enough' to be
  96    unconditionally available... */
  97 #include <stdlib.h>
  98 #include "gnunet_configuration_lib.h"
  99 #include "gnunet_scheduler_lib.h"
 100
 101 #ifdef __cplusplus
 102 extern "C"
 103 {
 104 #if 0                           /* keep Emacsens' auto-indent happy */
 105 }
 106 #endif
 107 #endif
 108
 109
 110 /**
 111  * Specifies how a file should be opened.
 112  */
 113 enum GNUNET_DISK_OpenFlags
 114 {
 115
 116     /**
 117      * Open the file for reading
 118      */
 119   GNUNET_DISK_OPEN_READ = 1,
 120
 121     /**
 122      * Open the file for writing
 123      */
 124   GNUNET_DISK_OPEN_WRITE = 2,
 125
 126     /**
 127      * Open the file for both reading and writing
 128      */
 129   GNUNET_DISK_OPEN_READWRITE = 3,
 130
 131     /**
 132      * Fail if file already exists
 133      */
 134   GNUNET_DISK_OPEN_FAILIFEXISTS = 4,
 135
 136     /**
 137      * Truncate file if it exists
 138      */
 139   GNUNET_DISK_OPEN_TRUNCATE = 8,
 140
 141     /**
 142      * Create file if it doesn't exist
 143      */
 144   GNUNET_DISK_OPEN_CREATE = 16,
 145
 146     /**
 147      * Append to the file
 148      */
 149   GNUNET_DISK_OPEN_APPEND = 32
 150 };
 151
 152 /**
 153  * Specifies what type of memory map is desired.
 154  */
 155 enum GNUNET_DISK_MapType
 156 {
 157     /**
 158      * Read-only memory map.
 159      */
 160   GNUNET_DISK_MAP_TYPE_READ = 1,
 161
 162     /**
 163      * Write-able memory map.
 164      */
 165   GNUNET_DISK_MAP_TYPE_WRITE = 2,
 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  * Get the number of blocks that are left on the partition that
 272  * contains the given file (for normal users).
 273  *
 274  * @param part a file on the partition to check
 275  * @return -1 on errors, otherwise the number of free blocks
 276  */
 277 long
 278 GNUNET_DISK_get_blocks_available (const char *part);
 279
 280
 281 /**
 282  * Checks whether a handle is invalid
 283  *
 284  * @param h handle to check
 285  * @return GNUNET_YES if invalid, GNUNET_NO if valid
 286  */
 287 int
 288 GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h);
 289
 290
 291 /**
 292  * Check that fil corresponds to a filename
 293  * (of a file that exists and that is not a directory).
 294  *
 295  * @param fil filename to check
 296  * @return GNUNET_YES if yes, GNUNET_NO if not a file, GNUNET_SYSERR if something
 297  * else (will print an error message in that case, too).
 298  */
 299 int
 300 GNUNET_DISK_file_test (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  * Close an open file.
 460  *
 461  * @param h file handle
 462  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 463  */
 464 int
 465 GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h);
 466
 467
 468 /**
 469  * Get the handle to a particular pipe end
 470  *
 471  * @param p pipe
 472  * @param n end to access
 473  * @return handle for the respective end
 474  */
 475 const struct GNUNET_DISK_FileHandle *
 476 GNUNET_DISK_pipe_handle (const struct GNUNET_DISK_PipeHandle *p,
 477                          enum GNUNET_DISK_PipeEnd n);
 478
 479
 480 /**
 481  * Get a handle from a native FD.
 482  *
 483  * @param fd native file descriptor
 484  * @return file handle corresponding to the descriptor
 485  */
 486 struct GNUNET_DISK_FileHandle *
 487 GNUNET_DISK_get_handle_from_native (FILE *fd);
 488
 489
 490 /**
 491  * Read the contents of a binary file into a buffer.
 492  * @param h handle to an open file
 493  * @param result the buffer to write the result to
 494  * @param len the maximum number of bytes to read
 495  * @return the number of bytes read on success, GNUNET_SYSERR on failure
 496  */
 497 ssize_t
 498 GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h, void *result,
 499                        size_t len);
 500
 501
 502 /**
 503  * Read the contents of a binary file into a buffer.
 504  * Guarantees not to block (returns GNUNET_SYSERR and sets errno to EAGAIN
 505  * when no data can be read).
 506  *
 507  * @param h handle to an open file
 508  * @param result the buffer to write the result to
 509  * @param len the maximum number of bytes to read
 510  * @return the number of bytes read on success, GNUNET_SYSERR on failure
 511  */
 512 ssize_t
 513 GNUNET_DISK_file_read_non_blocking (const struct GNUNET_DISK_FileHandle * h,
 514                                     void *result, size_t len);
 515
 516
 517 /**
 518  * Read the contents of a binary file into a buffer.
 519  *
 520  * @param fn file name
 521  * @param result the buffer to write the result to
 522  * @param len the maximum number of bytes to read
 523  * @return number of bytes read, GNUNET_SYSERR on failure
 524  */
 525 ssize_t
 526 GNUNET_DISK_fn_read (const char *fn, void *result, size_t len);
 527
 528
 529 /**
 530  * Write a buffer to a file.
 531  *
 532  * @param h handle to open file
 533  * @param buffer the data to write
 534  * @param n number of bytes to write
 535  * @return number of bytes written on success, GNUNET_SYSERR on error
 536  */
 537 ssize_t
 538 GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle *h,
 539                         const void *buffer, size_t n);
 540
 541
 542 /**
 543  * Write a buffer to a file, blocking, if necessary.
 544  * @param h handle to open file
 545  * @param buffer the data to write
 546  * @param n number of bytes to write
 547  * @return number of bytes written on success, GNUNET_SYSERR on error
 548  */
 549 ssize_t
 550 GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle * h,
 551     const void *buffer, size_t n);
 552
 553 /**
 554  * Write a buffer to a file.  If the file is longer than
 555  * the given buffer size, it will be truncated.
 556  *
 557  * @param fn file name
 558  * @param buffer the data to write
 559  * @param n number of bytes to write
 560  * @param mode file permissions
 561  * @return number of bytes written on success, GNUNET_SYSERR on error
 562  */
 563 ssize_t
 564 GNUNET_DISK_fn_write (const char *fn, const void *buffer, size_t n,
 565                       enum GNUNET_DISK_AccessPermissions mode);
 566
 567
 568 /**
 569  * Copy a file.
 570  *
 571  * @param src file to copy
 572  * @param dst destination file name
 573  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 574  */
 575 int
 576 GNUNET_DISK_file_copy (const char *src, const char *dst);
 577
 578
 579 /**
 580  * Scan a directory for files.
 581  *
 582  * @param dirName the name of the directory
 583  * @param callback the method to call for each file
 584  * @param callback_cls closure for callback
 585  * @return the number of files found, -1 on error
 586  */
 587 int
 588 GNUNET_DISK_directory_scan (const char *dirName,
 589                             GNUNET_FileNameCallback callback,
 590                             void *callback_cls);
 591
 592
 593 /**
 594  * Opaque handle used for iterating over a directory.
 595  */
 596 struct GNUNET_DISK_DirectoryIterator;
 597
 598
 599 /**
 600  * Function called to iterate over a directory.
 601  *
 602  * @param cls closure
 603  * @param di argument to pass to "GNUNET_DISK_directory_iterator_next" to
 604  *           get called on the next entry (or finish cleanly);
 605  *           NULL on error (will be the last call in that case)
 606  * @param filename complete filename (absolute path)
 607  * @param dirname directory name (absolute path)
 608  */
 609 typedef void (*GNUNET_DISK_DirectoryIteratorCallback) (void *cls,
 610                                                        struct
 611                                                        GNUNET_DISK_DirectoryIterator
 612                                                        * di,
 613                                                        const char *filename,
 614                                                        const char *dirname);
 615
 616
 617 /**
 618  * This function must be called during the DiskIteratorCallback
 619  * (exactly once) to schedule the task to process the next
 620  * filename in the directory (if there is one).
 621  *
 622  * @param iter opaque handle for the iterator
 623  * @param can set to GNUNET_YES to terminate the iteration early
 624  * @return GNUNET_YES if iteration will continue,
 625  *         GNUNET_NO if this was the last entry (and iteration is complete),
 626  *         GNUNET_SYSERR if "can" was YES
 627  */
 628 int
 629 GNUNET_DISK_directory_iterator_next (struct GNUNET_DISK_DirectoryIterator *iter,
 630                                      int can);
 631
 632
 633 /**
 634  * Scan a directory for files using the scheduler to run a task for
 635  * each entry.  The name of the directory must be expanded first (!).
 636  * If a scheduler does not need to be used, GNUNET_DISK_directory_scan
 637  * may provide a simpler API.
 638  *
 639  * @param prio priority to use
 640  * @param dirName the name of the directory
 641  * @param callback the method to call for each file
 642  * @param callback_cls closure for callback
 643  * @return GNUNET_YES if directory is not empty and 'callback'
 644  *         will be called later, GNUNET_NO otherwise, GNUNET_SYSERR on error.
 645  */
 646 int
 647 GNUNET_DISK_directory_iterator_start (enum GNUNET_SCHEDULER_Priority prio,
 648                                       const char *dirName,
 649                                       GNUNET_DISK_DirectoryIteratorCallback
 650                                       callback, void *callback_cls);
 651
 652
 653 /**
 654  * Create the directory structure for storing
 655  * a file.
 656  *
 657  * @param filename name of a file in the directory
 658  * @returns GNUNET_OK on success, GNUNET_SYSERR on failure,
 659  *          GNUNET_NO if directory exists but is not writeable
 660  */
 661 int
 662 GNUNET_DISK_directory_create_for_file (const char *filename);
 663
 664
 665 /**
 666  * Test if "fil" is a directory and readable. Also check if the directory is
 667  * listable.  Will not print an error message if the directory does not exist.
 668  * Will log errors if GNUNET_SYSERR is returned (i.e., a file exists with the
 669  * same name).
 670  *
 671  * @param fil filename to test
 672  * @param is_listable GNUNET_YES to additionally check if "fil" is listable
 673  * @return GNUNET_YES if yes, GNUNET_NO if not, GNUNET_SYSERR if it
 674  *   does not exist
 675  */
 676 int
 677 GNUNET_DISK_directory_test (const char *fil, int is_listable);
 678
 679
 680 /**
 681  * Remove all files in a directory (rm -rf). Call with
 682  * caution.
 683  *
 684  * @param filename the file to remove
 685  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 686  */
 687 int
 688 GNUNET_DISK_directory_remove (const char *filename);
 689
 690
 691 /**
 692  * Implementation of "mkdir -p"
 693  *
 694  * @param dir the directory to create
 695  * @returns GNUNET_SYSERR on failure, GNUNET_OK otherwise
 696  */
 697 int
 698 GNUNET_DISK_directory_create (const char *dir);
 699
 700
 701 /**
 702  * Lock a part of a file.
 703  *
 704  * @param fh file handle
 705  * @param lockStart absolute position from where to lock
 706  * @param lockEnd absolute position until where to lock
 707  * @param excl GNUNET_YES for an exclusive lock
 708  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 709  */
 710 int
 711 GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, OFF_T lockStart,
 712                        OFF_T lockEnd, int excl);
 713
 714
 715 /**
 716  * Unlock a part of a file
 717  * @param fh file handle
 718  * @param unlockStart absolute position from where to unlock
 719  * @param unlockEnd absolute position until where to unlock
 720  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 721  */
 722 int
 723 GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, OFF_T unlockStart,
 724                          OFF_T unlockEnd);
 725
 726
 727 /**
 728  * @brief Removes special characters as ':' from a filename.
 729  * @param fn the filename to canonicalize
 730  */
 731 void
 732 GNUNET_DISK_filename_canonicalize (char *fn);
 733
 734
 735 /**
 736  * @brief Change owner of a file
 737  * @param filename file to change
 738  * @param user new owner of the file
 739  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 740  */
 741 int
 742 GNUNET_DISK_file_change_owner (const char *filename, const char *user);
 743
 744
 745 /**
 746  * Construct full path to a file inside of the private
 747  * directory used by GNUnet.  Also creates the corresponding
 748  * directory.  If the resulting name is supposed to be
 749  * a directory, end the last argument in '/' (or pass
 750  * DIR_SEPARATOR_STR as the last argument before NULL).
 751  *
 752  * @param cfg configuration to use
 753  * @param serviceName name of the service asking
 754  * @param ... is NULL-terminated list of
 755  *                path components to append to the
 756  *                private directory name.
 757  * @return the constructed filename
 758  */
 759 char *
 760 GNUNET_DISK_get_home_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
 761                                const char *serviceName, ...);
 762
 763
 764 /**
 765  * Opaque handle for a memory-mapping operation.
 766  */
 767 struct GNUNET_DISK_MapHandle;
 768
 769 /**
 770  * Map a file into memory
 771  * @param h open file handle
 772  * @param m handle to the new mapping (will be set)
 773  * @param access access specification, GNUNET_DISK_MAP_TYPE_xxx
 774  * @param len size of the mapping
 775  * @return pointer to the mapped memory region, NULL on failure
 776  */
 777 void *
 778 GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle *h,
 779                       struct GNUNET_DISK_MapHandle **m,
 780                       enum GNUNET_DISK_MapType access, size_t len);
 781
 782 /**
 783  * Unmap a file
 784  *
 785  * @param h mapping handle
 786  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 787  */
 788 int
 789 GNUNET_DISK_file_unmap (struct GNUNET_DISK_MapHandle *h);
 790
 791 /**
 792  * Write file changes to disk
 793  * @param h handle to an open file
 794  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 795  */
 796 int
 797 GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h);
 798
 799
 800 #if 0                           /* keep Emacsens' auto-indent happy */
 801 {
 802 #endif
 803 #ifdef __cplusplus
 804 }
 805 #endif
 806
 807
 808 /* ifndef GNUNET_DISK_LIB_H */
 809 #endif
 810 /* end of gnunet_disk_lib.h */