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 /**
  29  * Opaque handle used to access files.
  30  */
  31 struct GNUNET_DISK_FileHandle;
  32
  33 /**
  34  * Handle used to manage a pipe.
  35  */
  36 struct GNUNET_DISK_PipeHandle;
  37
  38
  39 /* we need size_t, and since it can be both unsigned int
  40    or unsigned long long, this IS platform dependent;
  41    but "stdlib.h" should be portable 'enough' to be
  42    unconditionally available... */
  43 #include <stdlib.h>
  44 #include "gnunet_configuration_lib.h"
  45 #include "gnunet_scheduler_lib.h"
  46
  47 #ifdef __cplusplus
  48 extern "C"
  49 {
  50 #if 0                           /* keep Emacsens' auto-indent happy */
  51 }
  52 #endif
  53 #endif
  54
  55
  56 /**
  57  * Specifies how a file should be opened.
  58  */
  59 enum GNUNET_DISK_OpenFlags
  60   {
  61
  62     /**
  63      * Open the file for reading
  64      */
  65     GNUNET_DISK_OPEN_READ = 1,
  66
  67     /**
  68      * Open the file for writing
  69      */
  70     GNUNET_DISK_OPEN_WRITE = 2,
  71
  72     /**
  73      * Open the file for both reading and writing
  74      */
  75     GNUNET_DISK_OPEN_READWRITE = 3,
  76
  77     /**
  78      * Fail if file already exists
  79      */
  80     GNUNET_DISK_OPEN_FAILIFEXISTS = 4,
  81
  82     /**
  83      * Truncate file if it exists
  84      */
  85     GNUNET_DISK_OPEN_TRUNCATE = 8,
  86
  87     /**
  88      * Create file if it doesn't exist
  89      */
  90     GNUNET_DISK_OPEN_CREATE = 16,
  91
  92     /**
  93      * Append to the file
  94      */
  95     GNUNET_DISK_OPEN_APPEND = 32
  96   };
  97
  98 /**
  99  * Specifies what type of memory map is desired.
 100  */
 101 enum GNUNET_DISK_MapType
 102   {
 103     /**
 104      * Read-only memory map.
 105      */
 106     GNUNET_DISK_MAP_TYPE_READ = 1,
 107
 108     /**
 109      * Write-able memory map.
 110      */
 111     GNUNET_DISK_MAP_TYPE_WRITE = 2,
 112     /**
 113      * Read-write memory map.
 114      */
 115     GNUNET_DISK_MAP_TYPE_READWRITE = 3
 116   };
 117
 118
 119 /**
 120  * File access permissions, UNIX-style.
 121  */
 122 enum GNUNET_DISK_AccessPermissions
 123   {
 124     /**
 125      * Nobody is allowed to do anything to the file.
 126      */
 127     GNUNET_DISK_PERM_NONE = 0,
 128
 129     /**
 130      * Owner can read.
 131      */
 132     GNUNET_DISK_PERM_USER_READ = 1,
 133
 134     /**
 135      * Owner can write.
 136      */
 137     GNUNET_DISK_PERM_USER_WRITE = 2,
 138
 139     /**
 140      * Owner can execute.
 141      */
 142     GNUNET_DISK_PERM_USER_EXEC = 4,
 143
 144     /**
 145      * Group can read.
 146      */
 147     GNUNET_DISK_PERM_GROUP_READ = 8,
 148
 149     /**
 150      * Group can write.
 151      */
 152     GNUNET_DISK_PERM_GROUP_WRITE = 16,
 153
 154     /**
 155      * Group can execute.
 156      */
 157     GNUNET_DISK_PERM_GROUP_EXEC = 32,
 158
 159     /**
 160      * Everybody can read.
 161      */
 162     GNUNET_DISK_PERM_OTHER_READ = 64,
 163
 164     /**
 165      * Everybody can write.
 166      */
 167     GNUNET_DISK_PERM_OTHER_WRITE = 128,
 168
 169     /**
 170      * Everybody can execute.
 171      */
 172     GNUNET_DISK_PERM_OTHER_EXEC = 256
 173   };
 174
 175
 176 /**
 177  * Constants for specifying how to seek.
 178  */
 179 enum GNUNET_DISK_Seek
 180   {
 181     /**
 182      * Seek an absolute position (from the start of the file).
 183      */
 184     GNUNET_DISK_SEEK_SET,
 185
 186     /**
 187      * Seek a relative position (from the current offset).
 188      */
 189     GNUNET_DISK_SEEK_CUR,
 190
 191     /**
 192      * Seek an absolute position from the end of the file.
 193      */
 194     GNUNET_DISK_SEEK_END
 195   };
 196
 197
 198 /**
 199  * Enumeration identifying the two ends of a pipe.
 200  */
 201 enum GNUNET_DISK_PipeEnd
 202   {
 203     /**
 204      * The reading-end of a pipe.
 205      */
 206     GNUNET_DISK_PIPE_END_READ = 0,
 207
 208     /**
 209      * The writing-end of a pipe.
 210      */
 211     GNUNET_DISK_PIPE_END_WRITE = 1
 212   };
 213
 214
 215 /**
 216  * Get the number of blocks that are left on the partition that
 217  * contains the given file (for normal users).
 218  *
 219  * @param part a file on the partition to check
 220  * @return -1 on errors, otherwise the number of free blocks
 221  */
 222 long GNUNET_DISK_get_blocks_available (const char *part);
 223
 224
 225 /**
 226  * Checks whether a handle is invalid
 227  *
 228  * @param h handle to check
 229  * @return GNUNET_YES if invalid, GNUNET_NO if valid
 230  */
 231 int GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h);
 232
 233
 234 /**
 235  * Check that fil corresponds to a filename
 236  * (of a file that exists and that is not a directory).
 237  *
 238  * @param fil filename to check
 239  * @return GNUNET_YES if yes, GNUNET_NO if not a file, GNUNET_SYSERR if something
 240  * else (will print an error message in that case, too).
 241  */
 242 int GNUNET_DISK_file_test (const char *fil);
 243
 244
 245 /**
 246  * Move the read/write pointer in a file
 247  * @param h handle of an open file
 248  * @param offset position to move to
 249  * @param whence specification to which position the offset parameter relates to
 250  * @return the new position on success, GNUNET_SYSERR otherwise
 251  */
 252 off_t
 253 GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h,
 254                        off_t offset,
 255                        enum GNUNET_DISK_Seek whence);
 256
 257
 258 /**
 259  * Get the size of the file (or directory)
 260  * of the given file (in bytes).
 261  *
 262  * @param filename name of the file or directory
 263  * @param size set to the size of the file (or,
 264  *             in the case of directories, the sum
 265  *             of all sizes of files in the directory)
 266  * @param includeSymLinks should symbolic links be
 267  *        included?
 268  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 269  */
 270 int GNUNET_DISK_file_size (const char *filename,
 271                            uint64_t *size,
 272                            int includeSymLinks);
 273
 274
 275 /**
 276  * Obtain some unique identifiers for the given file
 277  * that can be used to identify it in the local system.
 278  * This function is used between GNUnet processes to
 279  * quickly check if two files with the same absolute path
 280  * are actually identical.  The two processes represent
 281  * the same peer but may communicate over the network
 282  * (and the file may be on an NFS volume).  This function
 283  * may not be supported on all operating systems.
 284  *
 285  * @param filename name of the file
 286  * @param dev set to the device ID
 287  * @param ino set to the inode ID
 288  * @return GNUNET_OK on success
 289  */
 290 int GNUNET_DISK_file_get_identifiers (const char *filename,
 291                                       uint64_t *dev,
 292                                       uint64_t *ino);
 293
 294
 295 /**
 296  * Create an (empty) temporary file on disk.  If the given name is not
 297  * an absolute path, the current 'TMPDIR' will be prepended.  In any case,
 298  * 6 random characters will be appended to the name to create a unique
 299  * filename.
 300  *
 301  * @param t component to use for the name;
 302  *        does NOT contain "XXXXXX" or "/tmp/".
 303  * @return NULL on error, otherwise name of fresh
 304  *         file on disk in directory for temporary files
 305  */
 306 char *
 307 GNUNET_DISK_mktemp (const char *t);
 308
 309
 310 /**
 311  * Open a file.  Note that the access permissions will only be
 312  * used if a new file is created and if the underlying operating
 313  * system supports the given permissions.
 314  *
 315  * @param fn file name to be opened
 316  * @param flags opening flags, a combination of GNUNET_DISK_OPEN_xxx bit flags
 317  * @param perm permissions for the newly created file, use
 318  *             GNUNET_DISK_PERM_NONE if a file could not be created by this
 319  *             call (because of flags)
 320  * @return IO handle on success, NULL on error
 321  */
 322 struct GNUNET_DISK_FileHandle *GNUNET_DISK_file_open (const char *fn,
 323                                                       enum GNUNET_DISK_OpenFlags flags,
 324                                                       enum GNUNET_DISK_AccessPermissions perm);
 325
 326 /**
 327  * Creates an interprocess channel
 328  * @param blocking creates an asynchronous pipe if set to GNUNET_NO
 329  * @param inherit_read 1 to make read handle inheritable, 0 otherwise (NT only)
 330  * @param inherit_write 1 to make write handle inheritable, 0 otherwise (NT only)
 331  * @return handle to the new pipe, NULL on error
 332  */
 333 struct GNUNET_DISK_PipeHandle *GNUNET_DISK_pipe (int blocking,
 334                                                  int inherit_read,
 335                                                  int inherit_write);
 336
 337
 338 /**
 339  * Closes an interprocess channel
 340  * @param p pipe
 341  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 342  */
 343 int GNUNET_DISK_pipe_close (struct GNUNET_DISK_PipeHandle *p);
 344
 345 /**
 346  * Closes one half of an interprocess channel
 347  *
 348  * @param p pipe to close end of
 349  * @param end which end of the pipe to close
 350  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 351  */
 352 int
 353 GNUNET_DISK_pipe_close_end (struct GNUNET_DISK_PipeHandle *p,
 354                             enum GNUNET_DISK_PipeEnd end);
 355
 356 /**
 357  * Close an open file.
 358  *
 359  * @param h file handle
 360  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 361  */
 362 int GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h);
 363
 364
 365 /**
 366  * Get the handle to a particular pipe end
 367  *
 368  * @param p pipe
 369  * @param n end to access
 370  * @return handle for the respective end
 371  */
 372 const struct GNUNET_DISK_FileHandle *
 373 GNUNET_DISK_pipe_handle (const struct
 374                          GNUNET_DISK_PipeHandle
 375                          *p,
 376                          enum GNUNET_DISK_PipeEnd n);
 377
 378 /**
 379  * Read the contents of a binary file into a buffer.
 380  * @param h handle to an open file
 381  * @param result the buffer to write the result to
 382  * @param len the maximum number of bytes to read
 383  * @return the number of bytes read on success, GNUNET_SYSERR on failure
 384  */
 385 ssize_t GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h, void *result,
 386                                size_t len);
 387
 388
 389 /**
 390  * Read the contents of a binary file into a buffer.
 391  *
 392  * @param fn file name
 393  * @param result the buffer to write the result to
 394  * @param len the maximum number of bytes to read
 395  * @return number of bytes read, GNUNET_SYSERR on failure
 396  */
 397 ssize_t GNUNET_DISK_fn_read (const char *fn,
 398                              void *result,
 399                              size_t len);
 400
 401
 402 /**
 403  * Write a buffer to a file.
 404  *
 405  * @param h handle to open file
 406  * @param buffer the data to write
 407  * @param n number of bytes to write
 408  * @return number of bytes written on success, GNUNET_SYSERR on error
 409  */
 410 ssize_t GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle *h,
 411                                 const void *buffer,
 412                                 size_t n);
 413
 414
 415 /**
 416  * Write a buffer to a file.  If the file is longer than
 417  * the given buffer size, it will be truncated.
 418  *
 419  * @param fn file name
 420  * @param buffer the data to write
 421  * @param n number of bytes to write
 422  * @param mode file permissions
 423  * @return number of bytes written on success, GNUNET_SYSERR on error
 424  */
 425 ssize_t GNUNET_DISK_fn_write (const char *fn,
 426                               const void *buffer,
 427                               size_t n,
 428                               enum GNUNET_DISK_AccessPermissions mode);
 429
 430
 431 /**
 432  * Copy a file.
 433  *
 434  * @param src file to copy
 435  * @param dst destination file name
 436  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 437  */
 438 int GNUNET_DISK_file_copy (const char *src, const char *dst);
 439
 440
 441 /**
 442  * Scan a directory for files.
 443  *
 444  * @param dirName the name of the directory
 445  * @param callback the method to call for each file
 446  * @param callback_cls closure for callback
 447  * @return the number of files found, -1 on error
 448  */
 449 int GNUNET_DISK_directory_scan (const char *dirName,
 450                                 GNUNET_FileNameCallback callback,
 451                                 void *callback_cls);
 452
 453
 454 /**
 455  * Opaque handle used for iterating over a directory.
 456  */
 457 struct GNUNET_DISK_DirectoryIterator;
 458
 459
 460 /**
 461  * Function called to iterate over a directory.
 462  *
 463  * @param cls closure
 464  * @param di argument to pass to "GNUNET_DISK_directory_iterator_next" to
 465  *           get called on the next entry (or finish cleanly);
 466  *           NULL on error (will be the last call in that case)
 467  * @param filename complete filename (absolute path)
 468  * @param dirname directory name (absolute path)
 469  */
 470 typedef void (*GNUNET_DISK_DirectoryIteratorCallback) (void *cls,
 471                                                        struct
 472                                                        GNUNET_DISK_DirectoryIterator
 473                                                        * di,
 474                                                        const char *filename,
 475                                                        const char *dirname);
 476
 477
 478 /**
 479  * This function must be called during the DiskIteratorCallback
 480  * (exactly once) to schedule the task to process the next
 481  * filename in the directory (if there is one).
 482  *
 483  * @param iter opaque handle for the iterator
 484  * @param can set to GNUNET_YES to terminate the iteration early
 485  * @return GNUNET_YES if iteration will continue,
 486  *         GNUNET_NO if this was the last entry (and iteration is complete),
 487  *         GNUNET_SYSERR if "can" was YES
 488  */
 489 int GNUNET_DISK_directory_iterator_next (struct GNUNET_DISK_DirectoryIterator
 490                                          *iter, int can);
 491
 492
 493 /**
 494  * Scan a directory for files using the scheduler to run a task for
 495  * each entry.  The name of the directory must be expanded first (!).
 496  * If a scheduler does not need to be used, GNUNET_DISK_directory_scan
 497  * may provide a simpler API.
 498  *
 499  * @param prio priority to use
 500  * @param dirName the name of the directory
 501  * @param callback the method to call for each file
 502  * @param callback_cls closure for callback
 503  */
 504 void GNUNET_DISK_directory_iterator_start (enum GNUNET_SCHEDULER_Priority
 505                                            prio, const char *dirName,
 506                                            GNUNET_DISK_DirectoryIteratorCallback
 507                                            callback, void *callback_cls);
 508
 509
 510 /**
 511  * Create the directory structure for storing
 512  * a file.
 513  *
 514  * @param filename name of a file in the directory
 515  * @returns GNUNET_OK on success, GNUNET_SYSERR on failure,
 516  *          GNUNET_NO if directory exists but is not writeable
 517  */
 518 int GNUNET_DISK_directory_create_for_file (const char *filename);
 519
 520
 521 /**
 522  * Test if "fil" is a directory that can be accessed.
 523  * Will not print an error message if the directory
 524  * does not exist.  Will log errors if GNUNET_SYSERR is
 525  * returned.
 526  *
 527  * @param fil filename to test
 528  * @return GNUNET_YES if yes, GNUNET_NO if does not exist, GNUNET_SYSERR
 529  *   on any error and if exists but not directory
 530  */
 531 int GNUNET_DISK_directory_test (const char *fil);
 532
 533
 534 /**
 535  * Remove all files in a directory (rm -rf). Call with
 536  * caution.
 537  *
 538  * @param fileName the file to remove
 539  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 540  */
 541 int GNUNET_DISK_directory_remove (const char *fileName);
 542
 543
 544 /**
 545  * Implementation of "mkdir -p"
 546  *
 547  * @param dir the directory to create
 548  * @returns GNUNET_SYSERR on failure, GNUNET_OK otherwise
 549  */
 550 int GNUNET_DISK_directory_create (const char *dir);
 551
 552
 553 /**
 554  * Lock a part of a file.
 555  *
 556  * @param fh file handle
 557  * @param lockStart absolute position from where to lock
 558  * @param lockEnd absolute position until where to lock
 559  * @param excl GNUNET_YES for an exclusive lock
 560  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 561  */
 562 int
 563 GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, off_t lockStart,
 564     off_t lockEnd, int excl);
 565
 566
 567 /**
 568  * Unlock a part of a file
 569  * @param fh file handle
 570  * @param unlockStart absolute position from where to unlock
 571  * @param unlockEnd absolute position until where to unlock
 572  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 573  */
 574 int
 575 GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh,
 576                          off_t unlockStart,
 577                          off_t unlockEnd);
 578
 579
 580 /**
 581  * @brief Removes special characters as ':' from a filename.
 582  * @param fn the filename to canonicalize
 583  */
 584 void GNUNET_DISK_filename_canonicalize (char *fn);
 585
 586
 587 /**
 588  * @brief Change owner of a file
 589  * @param filename file to change
 590  * @param user new owner of the file
 591  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 592  */
 593 int GNUNET_DISK_file_change_owner (const char *filename, const char *user);
 594
 595
 596 /**
 597  * Construct full path to a file inside of the private
 598  * directory used by GNUnet.  Also creates the corresponding
 599  * directory.  If the resulting name is supposed to be
 600  * a directory, end the last argument in '/' (or pass
 601  * DIR_SEPARATOR_STR as the last argument before NULL).
 602  *
 603  * @param cfg configuration to use
 604  * @param serviceName name of the service asking
 605  * @param ... is NULL-terminated list of
 606  *                path components to append to the
 607  *                private directory name.
 608  * @return the constructed filename
 609  */
 610 char *GNUNET_DISK_get_home_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
 611                                      const char *serviceName, ...);
 612
 613
 614 /**
 615  * Opaque handle for a memory-mapping operation.
 616  */
 617 struct GNUNET_DISK_MapHandle;
 618
 619 /**
 620  * Map a file into memory
 621  * @param h open file handle
 622  * @param m handle to the new mapping (will be set)
 623  * @param access access specification, GNUNET_DISK_MAP_TYPE_xxx
 624  * @param len size of the mapping
 625  * @return pointer to the mapped memory region, NULL on failure
 626  */
 627 void *GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle *h,
 628                             struct GNUNET_DISK_MapHandle **m,
 629                             enum GNUNET_DISK_MapType access, size_t len);
 630
 631 /**
 632  * Unmap a file
 633  *
 634  * @param h mapping handle
 635  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 636  */
 637 int GNUNET_DISK_file_unmap (struct GNUNET_DISK_MapHandle *h);
 638
 639 /**
 640  * Write file changes to disk
 641  * @param h handle to an open file
 642  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 643  */
 644 int GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h);
 645
 646 /**
 647  * Creates a named pipe/FIFO and opens it
 648  * @param fn pointer to the name of the named pipe or to NULL
 649  * @param flags open flags
 650  * @param perm access permissions
 651  * @return pipe handle on success, NULL on error
 652  */
 653 struct GNUNET_DISK_FileHandle *GNUNET_DISK_npipe_create (char **fn,
 654     enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm);
 655
 656 /**
 657  * Opens already existing named pipe/FIFO
 658  *
 659  * @param fn name of an existing named pipe
 660  * @param flags open flags
 661  * @param perm access permissions
 662  * @return pipe handle on success, NULL on error
 663  */
 664 struct GNUNET_DISK_FileHandle *GNUNET_DISK_npipe_open (const char *fn,
 665     enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm);
 666
 667 /**
 668  * Closes a named pipe/FIFO
 669  * @param pipe named pipe
 670  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 671  */
 672 int GNUNET_DISK_npipe_close (struct GNUNET_DISK_FileHandle *pipe);
 673
 674 #if 0                           /* keep Emacsens' auto-indent happy */
 675 {
 676 #endif
 677 #ifdef __cplusplus
 678 }
 679 #endif
 680
 681
 682 /* ifndef GNUNET_DISK_LIB_H */
 683 #endif
 684 /* end of gnunet_disk_lib.h */