X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_disk_lib.h;h=340c35a4e5cb8019cc0639b098f3042f230f2f4d;hb=f9b7adcad3cc030a800cbc9a96709454c45ae06f;hp=f4fd6f36b6f1cf71df4021372aee5b27bda63e01;hpb=da7cc55488f90b3294dbb7aa186184e6e8501d7e;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_disk_lib.h b/src/include/gnunet_disk_lib.h index f4fd6f36b..340c35a4e 100644 --- a/src/include/gnunet_disk_lib.h +++ b/src/include/gnunet_disk_lib.h @@ -22,18 +22,27 @@ * @file include/gnunet_disk_lib.h * @brief disk IO apis */ - #ifndef GNUNET_DISK_LIB_H #define GNUNET_DISK_LIB_H -#include "gnunet_configuration_lib.h" -#include "gnunet_scheduler_lib.h" +/** + * Opaque handle used to access files. + */ +struct GNUNET_DISK_FileHandle; + +/** + * Handle used to manage a pipe. + */ +struct GNUNET_DISK_PipeHandle; + /* we need size_t, and since it can be both unsigned int or unsigned long long, this IS platform dependent; but "stdlib.h" should be portable 'enough' to be unconditionally available... */ #include +#include "gnunet_configuration_lib.h" +#include "gnunet_scheduler_lib.h" #ifdef __cplusplus extern "C" @@ -43,45 +52,165 @@ extern "C" #endif #endif -/* Open the file for reading */ -#define GNUNET_DISK_OPEN_READ 1 -/* Open the file for writing */ -#define GNUNET_DISK_OPEN_WRITE 2 -/* Open the file for both reading and writing */ -#define GNUNET_DISK_OPEN_READWRITE 3 -/* Fail if file already exists */ -#define GNUNET_DISK_OPEN_FAILIFEXISTS 4 -/* Truncate file if it exists */ -#define GNUNET_DISK_OPEN_TRUNCATE 8 -/* Create file if it doesn't exist */ -#define GNUNET_DISK_OPEN_CREATE 16 -/* Append to the file */ -#define GNUNET_DISK_OPEN_APPEND 32 - -#define GNUNET_DISK_MAP_READ 1 -#define GNUNET_DISK_MAP_WRITE 2 -#define GNUNET_DISK_MAP_READWRITE 3 - -#define GNUNET_DISK_PERM_USER_READ 1 -#define GNUNET_DISK_PERM_USER_WRITE 2 -#define GNUNET_DISK_PERM_USER_EXEC 4 -#define GNUNET_DISK_PERM_GROUP_READ 8 -#define GNUNET_DISK_PERM_GROUP_WRITE 16 -#define GNUNET_DISK_PERM_GROUP_EXEC 32 -#define GNUNET_DISK_PERM_OTHER_READ 64 -#define GNUNET_DISK_PERM_OTHER_WRITE 128 -#define GNUNET_DISK_PERM_OTHER_EXEC 256 +/** + * Specifies how a file should be opened. + */ +enum GNUNET_DISK_OpenFlags + { + + /** + * Open the file for reading + */ + GNUNET_DISK_OPEN_READ = 1, + + /** + * Open the file for writing + */ + GNUNET_DISK_OPEN_WRITE = 2, + + /** + * Open the file for both reading and writing + */ + GNUNET_DISK_OPEN_READWRITE = 3, + + /** + * Fail if file already exists + */ + GNUNET_DISK_OPEN_FAILIFEXISTS = 4, + + /** + * Truncate file if it exists + */ + GNUNET_DISK_OPEN_TRUNCATE = 8, + + /** + * Create file if it doesn't exist + */ + GNUNET_DISK_OPEN_CREATE = 16, + + /** + * Append to the file + */ + GNUNET_DISK_OPEN_APPEND = 32 + }; + +/** + * Specifies what type of memory map is desired. + */ +enum GNUNET_DISK_MapType + { + /** + * Read-only memory map. + */ + GNUNET_DISK_MAP_TYPE_READ = 1, + + /** + * Write-able memory map. + */ + GNUNET_DISK_MAP_TYPE_WRITE = 2, + /** + * Read-write memory map. + */ + GNUNET_DISK_MAP_TYPE_READWRITE = 3 + }; + + +/** + * File access permissions, UNIX-style. + */ +enum GNUNET_DISK_AccessPermissions + { + /** + * Nobody is allowed to do anything to the file. + */ + GNUNET_DISK_PERM_NONE = 0, + + /** + * Owner can read. + */ + GNUNET_DISK_PERM_USER_READ = 1, + + /** + * Owner can write. + */ + GNUNET_DISK_PERM_USER_WRITE = 2, + + /** + * Owner can execute. + */ + GNUNET_DISK_PERM_USER_EXEC = 4, + + /** + * Group can read. + */ + GNUNET_DISK_PERM_GROUP_READ = 8, + + /** + * Group can write. + */ + GNUNET_DISK_PERM_GROUP_WRITE = 16, + + /** + * Group can execute. + */ + GNUNET_DISK_PERM_GROUP_EXEC = 32, + + /** + * Everybody can read. + */ + GNUNET_DISK_PERM_OTHER_READ = 64, + + /** + * Everybody can write. + */ + GNUNET_DISK_PERM_OTHER_WRITE = 128, + + /** + * Everybody can execute. + */ + GNUNET_DISK_PERM_OTHER_EXEC = 256 + }; + + +/** + * Constants for specifying how to seek. + */ 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 }; -struct GNUNET_DISK_FileHandle; -struct GNUNET_DISK_PipeHandle; +/** + * Enumeration identifying the two ends of a pipe. + */ +enum GNUNET_DISK_PipeEnd + { + /** + * The reading-end of a pipe. + */ + GNUNET_DISK_PIPE_END_READ = 0, + + /** + * The writing-end of a pipe. + */ + GNUNET_DISK_PIPE_END_WRITE = 1 + }; + /** * Get the number of blocks that are left on the partition that @@ -95,6 +224,7 @@ 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 */ @@ -105,7 +235,8 @@ int GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h); * Check that fil corresponds to a filename * (of a file that exists and that is not a directory). * - * @returns GNUNET_YES if yes, GNUNET_NO if not a file, GNUNET_SYSERR if something + * @param fil filename to check + * @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); @@ -119,43 +250,78 @@ int GNUNET_DISK_file_test (const char *fil); * @return the new position on success, GNUNET_SYSERR otherwise */ off_t -GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, off_t offset, - enum GNUNET_DISK_Seek whence); +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). * + * @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 * included? - * * @return GNUNET_OK on success, GNUNET_SYSERR on error */ int GNUNET_DISK_file_size (const char *filename, - unsigned long long *size, int includeSymLinks); + uint64_t *size, + int includeSymLinks); + +/** + * Obtain some unique identifiers for the given file + * that can be used to identify it in the local system. + * This function is used between GNUnet processes to + * quickly check if two files with the same absolute path + * are actually identical. The two processes represent + * the same peer but may communicate over the network + * (and the file may be on an NFS volume). This function + * may not be supported on all operating systems. + * + * @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 + */ +int GNUNET_DISK_file_get_identifiers (const char *filename, + uint64_t *dev, + uint64_t *ino); + /** - * Create an (empty) temporary file on disk. + * Create an (empty) temporary file 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 + * filename. * - * @param template component to use for the name; + * @param t component to use for the name; * does NOT contain "XXXXXX" or "/tmp/". * @return NULL on error, otherwise name of fresh * file on disk in directory for temporary files */ char * -GNUNET_DISK_mktemp (const char *template); +GNUNET_DISK_mktemp (const char *t); /** - * Open a file + * Open a file. Note that the access permissions will only be + * used if a new file is created and if the underlying operating + * system supports the given permissions. + * * @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 + * @param perm permissions for the newly created file, use + * 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, int flags, ...); +struct GNUNET_DISK_FileHandle *GNUNET_DISK_file_open (const char *fn, + enum GNUNET_DISK_OpenFlags flags, + enum GNUNET_DISK_AccessPermissions perm); /** * Creates an interprocess channel @@ -164,6 +330,7 @@ struct GNUNET_DISK_FileHandle *GNUNET_DISK_file_open (const char *fn, int flags, */ struct GNUNET_DISK_PipeHandle *GNUNET_DISK_pipe (int blocking); + /** * Closes an interprocess channel * @param p pipe @@ -171,6 +338,17 @@ struct GNUNET_DISK_PipeHandle *GNUNET_DISK_pipe (int blocking); */ 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 + */ +int +GNUNET_DISK_pipe_close_end (struct GNUNET_DISK_PipeHandle *p, + enum GNUNET_DISK_PipeEnd end); + /** * Close an open file. * @@ -179,14 +357,19 @@ int GNUNET_DISK_pipe_close (struct GNUNET_DISK_PipeHandle *p); */ int GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h); + /** * Get the handle to a particular pipe end + * * @param p pipe - * @param n number of the end + * @param n end to access + * @return handle for the respective end */ -const struct GNUNET_DISK_FileHandle *GNUNET_DISK_pipe_handle (const struct - GNUNET_DISK_PipeHandle - *p, int n); +const struct GNUNET_DISK_FileHandle * +GNUNET_DISK_pipe_handle (const struct + GNUNET_DISK_PipeHandle + *p, + enum GNUNET_DISK_PipeEnd n); /** * Read the contents of a binary file into a buffer. @@ -201,12 +384,14 @@ ssize_t GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h, void *res /** * Read the contents of a binary file into a buffer. + * * @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 */ -ssize_t GNUNET_DISK_fn_read (const char * const fn, void *result, +ssize_t GNUNET_DISK_fn_read (const char *fn, + void *result, size_t len); @@ -216,7 +401,7 @@ ssize_t GNUNET_DISK_fn_read (const char * const fn, void *result, * @param h handle to open file * @param buffer the data to write * @param n number of bytes to write - * @return GNUNET_OK 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, @@ -230,33 +415,36 @@ ssize_t GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle *h, * @param fn file name * @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 */ -ssize_t GNUNET_DISK_fn_write (const char * fn, +ssize_t GNUNET_DISK_fn_write (const char *fn, const void *buffer, size_t n, - int mode); + enum GNUNET_DISK_AccessPermissions mode); /** * Copy a file. + * + * @param src file to copy + * @param dst destination file name * @return GNUNET_OK on success, GNUNET_SYSERR on error */ int GNUNET_DISK_file_copy (const char *src, const char *dst); /** - * Scan a directory for files. The name of the directory - * must be expanded first (!). + * Scan a directory for files. * * @param dirName the name of the directory * @param callback the method to call for each file - * @param data argument to pass to callback + * @param callback_cls closure for callback * @return the number of files found, -1 on error */ int GNUNET_DISK_directory_scan (const char *dirName, GNUNET_FileNameCallback callback, - void *data); + void *callback_cls); /** @@ -270,7 +458,8 @@ struct GNUNET_DISK_DirectoryIterator; * * @param cls closure * @param di argument to pass to "GNUNET_DISK_directory_iterator_next" to - * get called on the next entry (or finish cleanly) + * 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) */ @@ -329,11 +518,12 @@ int GNUNET_DISK_directory_create_for_file (const char *filename); /** - * Test if fil is a directory that can be accessed. + * 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. * + * @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 */ @@ -360,15 +550,29 @@ int GNUNET_DISK_directory_create (const char *dir); /** - * Lock a part of a file + * 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 + */ +int +GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, off_t lockStart, + off_t lockEnd, int excl); + + +/** + * Unlock a part of a file * @param fh file handle - * @lockStart absolute position from where to lock - * @lockEnd absolute position until where to lock + * @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 */ int -GNUNET_DISK_file_lock(struct GNUNET_DISK_FileHandle *fh, off_t lockStart, - off_t lockEnd); +GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, off_t unlockStart, + off_t unlockEnd); /** @@ -394,8 +598,9 @@ int GNUNET_DISK_file_change_owner (const char *filename, const char *user); * 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 varargs is NULL-terminated list of + * @param ... is NULL-terminated list of * path components to append to the * private directory name. * @return the constructed filename @@ -413,13 +618,13 @@ struct GNUNET_DISK_MapHandle; * Map a file into memory * @param h open file handle * @param m handle to the new mapping (will be set) - * @param access access specification, GNUNET_DISK_MAP_xxx + * @param access access specification, GNUNET_DISK_MAP_TYPE_xxx * @param len size of the mapping * @return pointer to the mapped memory region, NULL on failure */ void *GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle *h, struct GNUNET_DISK_MapHandle **m, - int access, size_t len); + enum GNUNET_DISK_MapType access, size_t len); /** * Unmap a file