X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_disk_lib.h;h=be28854600c1f6c27deaff9ba55118d643b67415;hb=ca391c48238c36462ca11be9299cc7c9a09e6bbe;hp=25f972b5b39380c9e9f07c0d796571271f4bd7bb;hpb=6f8eede98c272b7312ff0e08b182f0a39b2846b9;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_disk_lib.h b/src/include/gnunet_disk_lib.h index 25f972b5b..be2885460 100644 --- a/src/include/gnunet_disk_lib.h +++ b/src/include/gnunet_disk_lib.h @@ -1,10 +1,10 @@ /* This file is part of GNUnet. - (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009 Christian Grothoff (and other contributing authors) + Copyright (C) 2001-2012 GNUnet e.V. GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 2, or (at your + by the Free Software Foundation; either version 3, or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but @@ -14,37 +14,46 @@ You should have received a copy of the GNU General Public License along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. */ - /** - * @file include/gnunet_disk_lib.h - * @brief disk IO apis + * @author Christian Grothoff + * + * @file + * Disk IO APIs + * + * @defgroup disk Disk library + * Disk IO APIs + * @{ */ #ifndef GNUNET_DISK_LIB_H #define GNUNET_DISK_LIB_H -#if WINDOWS -#define OFF_T uint64_t -#else -#define OFF_T off_t -#endif - -/** - * Opaque handle used to access files. - */ -struct GNUNET_DISK_FileHandle; - /** * Handle used to manage a pipe. */ struct GNUNET_DISK_PipeHandle; - +/** + * Type of a handle. + */ enum GNUNET_FILE_Type { - GNUNET_DISK_FILE, GNUNET_PIPE + /** + * Handle represents an event. + */ + GNUNET_DISK_HANLDE_TYPE_EVENT, + + /** + * Handle represents a file. + */ + GNUNET_DISK_HANLDE_TYPE_FILE, + + /** + * Handle represents a pipe. + */ + GNUNET_DISK_HANLDE_TYPE_PIPE }; /** @@ -80,8 +89,7 @@ struct GNUNET_DISK_FileHandle */ int fd; -#endif /* - */ +#endif }; @@ -108,39 +116,39 @@ extern "C" enum GNUNET_DISK_OpenFlags { - /** - * Open the file for reading - */ + /** + * Open the file for reading + */ GNUNET_DISK_OPEN_READ = 1, - /** - * Open the file for writing - */ + /** + * Open the file for writing + */ GNUNET_DISK_OPEN_WRITE = 2, - /** - * Open the file for both reading and writing - */ + /** + * Open the file for both reading and writing + */ GNUNET_DISK_OPEN_READWRITE = 3, - /** - * Fail if file already exists - */ + /** + * Fail if file already exists + */ GNUNET_DISK_OPEN_FAILIFEXISTS = 4, - /** - * Truncate file if it exists - */ + /** + * Truncate file if it exists + */ GNUNET_DISK_OPEN_TRUNCATE = 8, - /** - * Create file if it doesn't exist - */ + /** + * Create file if it doesn't exist + */ GNUNET_DISK_OPEN_CREATE = 16, - /** - * Append to the file - */ + /** + * Append to the file + */ GNUNET_DISK_OPEN_APPEND = 32 }; @@ -149,18 +157,19 @@ enum GNUNET_DISK_OpenFlags */ enum GNUNET_DISK_MapType { - /** - * Read-only memory map. - */ + /** + * Read-only memory map. + */ GNUNET_DISK_MAP_TYPE_READ = 1, - /** - * Write-able memory map. - */ + /** + * Write-able memory map. + */ GNUNET_DISK_MAP_TYPE_WRITE = 2, - /** - * Read-write memory map. - */ + + /** + * Read-write memory map. + */ GNUNET_DISK_MAP_TYPE_READWRITE = 3 }; @@ -170,77 +179,78 @@ enum GNUNET_DISK_MapType */ enum GNUNET_DISK_AccessPermissions { - /** - * Nobody is allowed to do anything to the file. - */ + /** + * Nobody is allowed to do anything to the file. + */ GNUNET_DISK_PERM_NONE = 0, - /** - * Owner can read. - */ + /** + * Owner can read. + */ GNUNET_DISK_PERM_USER_READ = 1, - /** - * Owner can write. - */ + /** + * Owner can write. + */ GNUNET_DISK_PERM_USER_WRITE = 2, - /** - * Owner can execute. - */ + /** + * Owner can execute. + */ GNUNET_DISK_PERM_USER_EXEC = 4, - /** - * Group can read. - */ + /** + * Group can read. + */ GNUNET_DISK_PERM_GROUP_READ = 8, - /** - * Group can write. - */ + /** + * Group can write. + */ GNUNET_DISK_PERM_GROUP_WRITE = 16, - /** - * Group can execute. - */ + /** + * Group can execute. + */ GNUNET_DISK_PERM_GROUP_EXEC = 32, - /** - * Everybody can read. - */ + /** + * Everybody can read. + */ GNUNET_DISK_PERM_OTHER_READ = 64, - /** - * Everybody can write. - */ + /** + * Everybody can write. + */ GNUNET_DISK_PERM_OTHER_WRITE = 128, - /** - * Everybody can execute. - */ + /** + * Everybody can execute. + */ GNUNET_DISK_PERM_OTHER_EXEC = 256 }; /** - * Constants for specifying how to seek. + * Constants for specifying how to seek. Do not change values or order, + * some of the code depends on the specific numeric values! */ enum GNUNET_DISK_Seek { - /** - * Seek an absolute position (from the start of the file). - */ - GNUNET_DISK_SEEK_SET, - - /** - * Seek a relative position (from the current offset). - */ - GNUNET_DISK_SEEK_CUR, - - /** - * Seek an absolute position from the end of the file. - */ - GNUNET_DISK_SEEK_END + /** + * Seek an absolute position (from the start of the file). + */ + GNUNET_DISK_SEEK_SET = 0, + + /** + * Seek a relative position (from the current offset). + */ + GNUNET_DISK_SEEK_CUR = 1, + + /** + * Seek an absolute position from the end of the file. + */ + GNUNET_DISK_SEEK_END = 2 }; @@ -249,34 +259,23 @@ enum GNUNET_DISK_Seek */ enum GNUNET_DISK_PipeEnd { - /** - * The reading-end of a pipe. - */ + /** + * The reading-end of a pipe. + */ GNUNET_DISK_PIPE_END_READ = 0, - /** - * The writing-end of a pipe. - */ + /** + * The writing-end of a pipe. + */ GNUNET_DISK_PIPE_END_WRITE = 1 }; -/** - * Get the number of blocks that are left on the partition that - * contains the given file (for normal users). - * - * @param part a file on the partition to check - * @return -1 on errors, otherwise the number of free blocks - */ -long -GNUNET_DISK_get_blocks_available (const char *part); - - /** * Checks whether a handle is invalid * * @param h handle to check - * @return GNUNET_YES if invalid, GNUNET_NO if valid + * @return #GNUNET_YES if invalid, #GNUNET_NO if valid */ int GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h); @@ -287,13 +286,24 @@ GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h); * (of a file that exists and that is not a directory). * * @param fil filename to check - * @return GNUNET_YES if yes, GNUNET_NO if not a file, GNUNET_SYSERR if something + * @return #GNUNET_YES if yes, #GNUNET_NO if not a file, #GNUNET_SYSERR if something * else (will print an error message in that case, too). */ int GNUNET_DISK_file_test (const char *fil); +/** + * Move a file out of the way (create a backup) by + * renaming it to "orig.NUM~" where NUM is the smallest + * number that is not used yet. + * + * @param fil name of the file to back up + */ +void +GNUNET_DISK_file_backup (const char *fil); + + /** * Move the read/write pointer in a file * @param h handle of an open file @@ -301,26 +311,30 @@ GNUNET_DISK_file_test (const char *fil); * @param whence specification to which position the offset parameter relates to * @return the new position on success, GNUNET_SYSERR otherwise */ -OFF_T -GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, OFF_T offset, +off_t +GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, off_t offset, enum GNUNET_DISK_Seek whence); /** - * Get the size of the file (or directory) - * of the given file (in bytes). + * Get the size of the file (or directory) of the given file (in + * bytes). * * @param filename name of the file or directory * @param size set to the size of the file (or, * in the case of directories, the sum * of all sizes of files in the directory) - * @param includeSymLinks should symbolic links be + * @param include_symbolic_links should symbolic links be * included? - * @return GNUNET_OK on success, GNUNET_SYSERR on error + * @param single_file_mode #GNUNET_YES to only get size of one file + * and return #GNUNET_SYSERR for directories. + * @return #GNUNET_SYSERR on error, #GNUNET_OK on success */ int -GNUNET_DISK_file_size (const char *filename, uint64_t * size, - int includeSymLinks); +GNUNET_DISK_file_size (const char *filename, + uint64_t *size, + int include_symbolic_links, + int single_file_mode); /** @@ -336,11 +350,12 @@ GNUNET_DISK_file_size (const char *filename, uint64_t * size, * @param filename name of the file * @param dev set to the device ID * @param ino set to the inode ID - * @return GNUNET_OK on success + * @return #GNUNET_OK on success */ int -GNUNET_DISK_file_get_identifiers (const char *filename, uint64_t * dev, - uint64_t * ino); +GNUNET_DISK_file_get_identifiers (const char *filename, + uint64_t *dev, + uint64_t *ino); /** @@ -358,6 +373,19 @@ char * GNUNET_DISK_mktemp (const char *t); +/** + * Create an (empty) temporary directory on disk. If the given name is not an + * absolute path, the current 'TMPDIR' will be prepended. In any case, 6 + * random characters will be appended to the name to create a unique name. + * + * @param t component to use for the name; + * does NOT contain "XXXXXX" or "/tmp/". + * @return NULL on error, otherwise name of freshly created directory + */ +char * +GNUNET_DISK_mkdtemp (const char *t); + + /** * Open a file. Note that the access permissions will only be * used if a new file is created and if the underlying operating @@ -366,12 +394,13 @@ GNUNET_DISK_mktemp (const char *t); * @param fn file name to be opened * @param flags opening flags, a combination of GNUNET_DISK_OPEN_xxx bit flags * @param perm permissions for the newly created file, use - * GNUNET_DISK_PERM_NONE if a file could not be created by this + * #GNUNET_DISK_PERM_NONE if a file could not be created by this * call (because of flags) * @return IO handle on success, NULL on error */ struct GNUNET_DISK_FileHandle * -GNUNET_DISK_file_open (const char *fn, enum GNUNET_DISK_OpenFlags flags, +GNUNET_DISK_file_open (const char *fn, + enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm); @@ -380,62 +409,87 @@ GNUNET_DISK_file_open (const char *fn, enum GNUNET_DISK_OpenFlags flags, * * @param fh open file handle * @param size where to write size of the file - * @return GNUNET_OK on success, GNUNET_SYSERR on error + * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle *fh, - OFF_T *size); + off_t *size); /** * Creates an interprocess channel * - * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO - * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO + * @param blocking_read creates an asynchronous pipe for reading if set to #GNUNET_NO + * @param blocking_write creates an asynchronous pipe for writing if set to #GNUNET_NO * @param inherit_read 1 to make read handle inheritable, 0 otherwise (NT only) * @param inherit_write 1 to make write handle inheritable, 0 otherwise (NT only) * @return handle to the new pipe, NULL on error */ struct GNUNET_DISK_PipeHandle * -GNUNET_DISK_pipe (int blocking_read, int blocking_write, int inherit_read, int inherit_write); +GNUNET_DISK_pipe (int blocking_read, + int blocking_write, + int inherit_read, + int inherit_write); /** * Creates a pipe object from a couple of file descriptors. * Useful for wrapping existing pipe FDs. * - * @param blocking creates an asynchronous pipe if set to GNUNET_NO + * @param blocking_read creates an asynchronous pipe for reading if set to #GNUNET_NO + * @param blocking_write creates an asynchronous pipe for writing if set to #GNUNET_NO * @param fd an array of two fd values. One of them may be -1 for read-only or write-only pipes * * @return handle to the new pipe, NULL on error */ struct GNUNET_DISK_PipeHandle * -GNUNET_DISK_pipe_from_fd (int blocking_read, int blocking_write, int fd[2]); +GNUNET_DISK_pipe_from_fd (int blocking_read, + int blocking_write, + int fd[2]); + /** * Closes an interprocess channel * @param p pipe - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_DISK_pipe_close (struct GNUNET_DISK_PipeHandle *p); + /** * Closes one half of an interprocess channel * * @param p pipe to close end of * @param end which end of the pipe to close - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_DISK_pipe_close_end (struct GNUNET_DISK_PipeHandle *p, enum GNUNET_DISK_PipeEnd end); + +/** + * Detaches one of the ends from the pipe. + * Detached end is a fully-functional FileHandle, it will + * not be affected by anything you do with the pipe afterwards. + * Each end of a pipe can only be detched from it once (i.e. + * it is not duplicated). + * + * @param p pipe to detach an end from + * @param end which end of the pipe to detach + * @return Detached end on success, NULL on failure + * (or if that end is not present or is closed). + */ +struct GNUNET_DISK_FileHandle * +GNUNET_DISK_pipe_detach_end (struct GNUNET_DISK_PipeHandle *p, + enum GNUNET_DISK_PipeEnd end); + /** * Close an open file. * * @param h file handle - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h); @@ -452,17 +506,68 @@ const struct GNUNET_DISK_FileHandle * GNUNET_DISK_pipe_handle (const struct GNUNET_DISK_PipeHandle *p, enum GNUNET_DISK_PipeEnd n); + +#if WINDOWS +/** + * Get a GNUnet file handle from a W32 handle (W32-only). + * Do not call on non-W32 platforms (returns NULL). + * + * @param handle native handle + * @return GNUnet file handle corresponding to the W32 handle + */ +struct GNUNET_DISK_FileHandle * +GNUNET_DISK_get_handle_from_w32_handle (HANDLE osfh); +#endif + +/** + * Update POSIX permissions mask of a file on disk. If both argumets + * are #GNUNET_NO, the file is made world-read-write-executable (777). + * Does nothing on W32. + * + * @param fn name of the file to update + * @param require_uid_match #GNUNET_YES means 700 + * @param require_gid_match #GNUNET_YES means 770 unless @a require_uid_match is set + */ +void +GNUNET_DISK_fix_permissions (const char *fn, + int require_uid_match, + int require_gid_match); + + +/** + * Get a handle from a native integer FD. + * + * @param fno native integer file descriptor + * @return file handle corresponding to the descriptor + */ +struct GNUNET_DISK_FileHandle * +GNUNET_DISK_get_handle_from_int_fd (int fno); + + +/** + * Get a handle from a native FD. + * + * @param fd native file descriptor + * @return file handle corresponding to the descriptor + */ +struct GNUNET_DISK_FileHandle * +GNUNET_DISK_get_handle_from_native (FILE *fd); + + /** * Read the contents of a binary file into a buffer. + * * @param h handle to an open file * @param result the buffer to write the result to * @param len the maximum number of bytes to read - * @return the number of bytes read on success, GNUNET_SYSERR on failure + * @return the number of bytes read on success, #GNUNET_SYSERR on failure */ ssize_t -GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h, void *result, +GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h, + void *result, size_t len); + /** * Read the contents of a binary file into a buffer. * Guarantees not to block (returns GNUNET_SYSERR and sets errno to EAGAIN @@ -471,11 +576,13 @@ GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h, void *result, * @param h handle to an open file * @param result the buffer to write the result to * @param len the maximum number of bytes to read - * @return the number of bytes read on success, GNUNET_SYSERR on failure + * @return the number of bytes read on success, #GNUNET_SYSERR on failure */ ssize_t GNUNET_DISK_file_read_non_blocking (const struct GNUNET_DISK_FileHandle * h, - void *result, size_t len); + void *result, + size_t len); + /** * Read the contents of a binary file into a buffer. @@ -483,10 +590,12 @@ GNUNET_DISK_file_read_non_blocking (const struct GNUNET_DISK_FileHandle * h, * @param fn file name * @param result the buffer to write the result to * @param len the maximum number of bytes to read - * @return number of bytes read, GNUNET_SYSERR on failure + * @return number of bytes read, #GNUNET_SYSERR on failure */ ssize_t -GNUNET_DISK_fn_read (const char *fn, void *result, size_t len); +GNUNET_DISK_fn_read (const char *fn, + void *result, + size_t len); /** @@ -495,23 +604,27 @@ GNUNET_DISK_fn_read (const char *fn, void *result, size_t len); * @param h handle to open file * @param buffer the data to write * @param n number of bytes to write - * @return number of bytes written on success, GNUNET_SYSERR on error + * @return number of bytes written on success, #GNUNET_SYSERR on error */ ssize_t GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle *h, - const void *buffer, size_t n); + const void *buffer, + size_t n); /** * Write a buffer to a file, blocking, if necessary. + * * @param h handle to open file * @param buffer the data to write * @param n number of bytes to write - * @return number of bytes written on success, GNUNET_SYSERR on error + * @return number of bytes written on success, #GNUNET_SYSERR on error */ ssize_t -GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle * h, - const void *buffer, size_t n); +GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle *h, + const void *buffer, + size_t n); + /** * Write a buffer to a file. If the file is longer than @@ -521,10 +634,12 @@ GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle * h, * @param buffer the data to write * @param n number of bytes to write * @param mode file permissions - * @return number of bytes written on success, GNUNET_SYSERR on error + * @return number of bytes written on success, #GNUNET_SYSERR on error */ ssize_t -GNUNET_DISK_fn_write (const char *fn, const void *buffer, size_t n, +GNUNET_DISK_fn_write (const char *fn, + const void *buffer, + size_t n, enum GNUNET_DISK_AccessPermissions mode); @@ -533,128 +648,71 @@ GNUNET_DISK_fn_write (const char *fn, const void *buffer, size_t n, * * @param src file to copy * @param dst destination file name - * @return GNUNET_OK on success, GNUNET_SYSERR on error + * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int -GNUNET_DISK_file_copy (const char *src, const char *dst); +GNUNET_DISK_file_copy (const char *src, + const char *dst); /** * Scan a directory for files. * - * @param dirName the name of the directory + * @param dir_name the name of the directory * @param callback the method to call for each file - * @param callback_cls closure for callback + * @param callback_cls closure for @a callback * @return the number of files found, -1 on error */ int -GNUNET_DISK_directory_scan (const char *dirName, +GNUNET_DISK_directory_scan (const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls); -/** - * Opaque handle used for iterating over a directory. - */ -struct GNUNET_DISK_DirectoryIterator; - - -/** - * Function called to iterate over a directory. - * - * @param cls closure - * @param di argument to pass to "GNUNET_DISK_directory_iterator_next" to - * get called on the next entry (or finish cleanly); - * NULL on error (will be the last call in that case) - * @param filename complete filename (absolute path) - * @param dirname directory name (absolute path) - */ -typedef void (*GNUNET_DISK_DirectoryIteratorCallback) (void *cls, - struct - GNUNET_DISK_DirectoryIterator - * di, - const char *filename, - const char *dirname); - - -/** - * This function must be called during the DiskIteratorCallback - * (exactly once) to schedule the task to process the next - * filename in the directory (if there is one). - * - * @param iter opaque handle for the iterator - * @param can set to GNUNET_YES to terminate the iteration early - * @return GNUNET_YES if iteration will continue, - * GNUNET_NO if this was the last entry (and iteration is complete), - * GNUNET_SYSERR if "can" was YES - */ -int -GNUNET_DISK_directory_iterator_next (struct GNUNET_DISK_DirectoryIterator *iter, - int can); - - -/** - * Scan a directory for files using the scheduler to run a task for - * each entry. The name of the directory must be expanded first (!). - * If a scheduler does not need to be used, GNUNET_DISK_directory_scan - * may provide a simpler API. - * - * @param prio priority to use - * @param dirName the name of the directory - * @param callback the method to call for each file - * @param callback_cls closure for callback - * @return GNUNET_YES if directory is not empty and @callback - * will be called later, GNUNET_NO otherwise, GNUNET_SYSERR on error. - */ -int -GNUNET_DISK_directory_iterator_start (enum GNUNET_SCHEDULER_Priority prio, - const char *dirName, - GNUNET_DISK_DirectoryIteratorCallback - callback, void *callback_cls); - - /** * Create the directory structure for storing * a file. * * @param filename name of a file in the directory - * @returns GNUNET_OK on success, GNUNET_SYSERR on failure, - * GNUNET_NO if directory exists but is not writeable + * @returns #GNUNET_OK on success, #GNUNET_SYSERR on failure, + * #GNUNET_NO if directory exists but is not writeable */ int GNUNET_DISK_directory_create_for_file (const char *filename); /** - * Test if "fil" is a directory that can be accessed. - * Will not print an error message if the directory - * does not exist. Will log errors if GNUNET_SYSERR is - * returned. + * Test if @a fil is a directory and listable. Optionally, also check if the + * directory is readable. Will not print an error message if the directory does + * not exist. Will log errors if #GNUNET_SYSERR is returned (i.e., a file exists + * with the same name). * * @param fil filename to test - * @return GNUNET_YES if yes, GNUNET_NO if does not exist, GNUNET_SYSERR - * on any error and if exists but not directory + * @param is_readable #GNUNET_YES to additionally check if @a fil is readable; + * #GNUNET_NO to disable this check + * @return #GNUNET_YES if yes, #GNUNET_NO if not; #GNUNET_SYSERR if it + * does not exist or `stat`ed */ int -GNUNET_DISK_directory_test (const char *fil); +GNUNET_DISK_directory_test (const char *fil, int is_readable); /** * Remove all files in a directory (rm -rf). Call with * caution. * - * @param fileName the file to remove - * @return GNUNET_OK on success, GNUNET_SYSERR on error + * @param filename the file to remove + * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int -GNUNET_DISK_directory_remove (const char *fileName); +GNUNET_DISK_directory_remove (const char *filename); /** * Implementation of "mkdir -p" * * @param dir the directory to create - * @returns GNUNET_SYSERR on failure, GNUNET_OK otherwise + * @returns #GNUNET_SYSERR on failure, #GNUNET_OK otherwise */ int GNUNET_DISK_directory_create (const char *dir); @@ -664,26 +722,29 @@ GNUNET_DISK_directory_create (const char *dir); * Lock a part of a file. * * @param fh file handle - * @param lockStart absolute position from where to lock - * @param lockEnd absolute position until where to lock - * @param excl GNUNET_YES for an exclusive lock - * @return GNUNET_OK on success, GNUNET_SYSERR on error + * @param lock_start absolute position from where to lock + * @param lock_end absolute position until where to lock + * @param excl #GNUNET_YES for an exclusive lock + * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int -GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, OFF_T lockStart, - OFF_T lockEnd, int excl); +GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, + off_t lock_start, + off_t lock_end, int excl); /** - * Unlock a part of a file + * Unlock a part of a file. + * * @param fh file handle - * @param unlockStart absolute position from where to unlock - * @param unlockEnd absolute position until where to unlock - * @return GNUNET_OK on success, GNUNET_SYSERR on error + * @param unlock_start absolute position from where to unlock + * @param unlock_end absolute position until where to unlock + * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int -GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, OFF_T unlockStart, - OFF_T unlockEnd); +GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, + off_t unlock_start, + off_t unlock_end); /** @@ -698,29 +759,11 @@ GNUNET_DISK_filename_canonicalize (char *fn); * @brief Change owner of a file * @param filename file to change * @param user new owner of the file - * @return GNUNET_OK on success, GNUNET_SYSERR on failure + * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure */ int -GNUNET_DISK_file_change_owner (const char *filename, const char *user); - - -/** - * Construct full path to a file inside of the private - * directory used by GNUnet. Also creates the corresponding - * directory. If the resulting name is supposed to be - * a directory, end the last argument in '/' (or pass - * DIR_SEPARATOR_STR as the last argument before NULL). - * - * @param cfg configuration to use - * @param serviceName name of the service asking - * @param ... is NULL-terminated list of - * path components to append to the - * private directory name. - * @return the constructed filename - */ -char * -GNUNET_DISK_get_home_filename (const struct GNUNET_CONFIGURATION_Handle *cfg, - const char *serviceName, ...); +GNUNET_DISK_file_change_owner (const char *filename, + const char *user); /** @@ -739,55 +782,29 @@ struct GNUNET_DISK_MapHandle; void * GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle *h, struct GNUNET_DISK_MapHandle **m, - enum GNUNET_DISK_MapType access, size_t len); + enum GNUNET_DISK_MapType access, + size_t len); + /** * Unmap a file * * @param h mapping handle - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_DISK_file_unmap (struct GNUNET_DISK_MapHandle *h); + /** * Write file changes to disk + * * @param h handle to an open file - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h); -/** - * Creates a named pipe/FIFO and opens it - * @param fn pointer to the name of the named pipe or to NULL - * @param flags open flags - * @param perm access permissions - * @return pipe handle on success, NULL on error - */ -struct GNUNET_DISK_FileHandle * -GNUNET_DISK_npipe_create (char **fn, enum GNUNET_DISK_OpenFlags flags, - enum GNUNET_DISK_AccessPermissions perm); - -/** - * Opens already existing named pipe/FIFO - * - * @param fn name of an existing named pipe - * @param flags open flags - * @param perm access permissions - * @return pipe handle on success, NULL on error - */ -struct GNUNET_DISK_FileHandle * -GNUNET_DISK_npipe_open (const char *fn, enum GNUNET_DISK_OpenFlags flags, - enum GNUNET_DISK_AccessPermissions perm); - -/** - * Closes a named pipe/FIFO - * @param pipe named pipe - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise - */ -int -GNUNET_DISK_npipe_close (struct GNUNET_DISK_FileHandle *pipe); #if 0 /* keep Emacsens' auto-indent happy */ { @@ -796,7 +813,9 @@ GNUNET_DISK_npipe_close (struct GNUNET_DISK_FileHandle *pipe); } #endif - /* ifndef GNUNET_DISK_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_disk_lib.h */