disk IO convenience methods More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "disk.h"
#include <sys/types.h>

Include dependency graph for disk.c:

Data Structures
struct	GNUNET_DISK_PipeHandle
	Handle used to manage a pipe. More...

struct	GetFileSizeData
	Closure for the recursion to determine the file size of a directory. More...

struct	GlobClosure

struct	GNUNET_DISK_MapHandle
	Handle for a memory-mapping operation. More...

Macros
#define	LOG(kind, ...) GNUNET_log_from (kind, "util-disk", __VA_ARGS__)

#define	LOG_STRERROR(kind, syscall) GNUNET_log_from_strerror (kind, "util-disk", syscall)

#define	LOG_STRERROR_FILE(kind, syscall, filename) GNUNET_log_from_strerror_file (kind, "util-disk", syscall, filename)

#define	COPY_BLK_SIZE 65536
	Block size for IO for copying files. More...

#define	_IFMT 0170000 /* type of file */

#define	_IFLNK 0120000 /* symbolic link */

#define	S_ISLNK(m) (((m)&_IFMT) == _IFLNK)

#define	MAP_FAILED ((void *) -1)

Functions
static int	translate_unix_perms (enum GNUNET_DISK_AccessPermissions perm)
	Translate GNUnet-internal permission bitmap to UNIX file access permission bitmap. More...

static enum GNUNET_GenericReturnValue	get_size_rec (void cls, const char fn)
	Iterate over all files in the given directory and accumulate their size. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h)
	Checks whether a handle is invalid. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle fh, off_t size)
	Get the size of an open file. More...

off_t	GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, off_t offset, enum GNUNET_DISK_Seek whence)
	Move the read/write pointer in a file. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_size (const char filename, uint64_t size, int include_symbolic_links, int single_file_mode)
	Get the size of the file (or directory) of the given file (in bytes). More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_get_identifiers (const char filename, uint64_t dev, uint64_t *ino)
	Obtain some unique identifiers for the given file that can be used to identify it in the local system. More...

static char *	mktemp_name (const char *t)
	Create the name for a temporary file or directory from a template. More...

void	GNUNET_DISK_fix_permissions (const char *fn, int require_uid_match, int require_gid_match)
	Update POSIX permissions mask of a file on disk. More...

char *	GNUNET_DISK_mkdtemp (const char *t)
	Create an (empty) temporary directory on disk. More...

char *	GNUNET_DISK_file_backup (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. More...

char *	GNUNET_DISK_mktemp (const char *t)
	Create an (empty) temporary file on disk. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_directory_test (const char *fil, int is_readable)
	Test if fil is a directory and listable. More...

static enum GNUNET_GenericReturnValue	file_test_internal (const char *fil, int amode)
	Check if fil can be accessed using amode. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_test (const char *fil)
	Check that fil corresponds to a filename (of a file that exists and that is not a directory). More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_test_read (const char *fil)
	Check that fil corresponds to a filename and the file has read permissions. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_directory_create (const char *dir)
	Implementation of "mkdir -p". More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_directory_create_for_file (const char *filename)
	Create the directory structure for storing a file. More...

ssize_t	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. More...

ssize_t	GNUNET_DISK_fn_read (const char fn, void result, size_t len)
	Read the contents of a binary file into a buffer. More...

ssize_t	GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle h, const void buffer, size_t n)
	Write a buffer to a file. More...

ssize_t	GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle h, const void buffer, size_t n)
	Write a buffer to a file, blocking, if necessary. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_fn_write (const char fn, const void buf, size_t buf_size, enum GNUNET_DISK_AccessPermissions mode)
	Write a buffer to a file atomically. More...

int	GNUNET_DISK_directory_scan (const char dir_name, GNUNET_FileNameCallback callback, void callback_cls)
	Scan a directory for files. More...

static bool	glob_match (const char pattern, const char str)
	Check for a simple wildcard match. More...

static enum GNUNET_GenericReturnValue	glob_cb (void cls, const char filename)
	Function called with a filename. More...

int	GNUNET_DISK_glob (const char glob_pattern, GNUNET_FileNameCallback callback, void callback_cls)
	Find all files matching a glob pattern. More...

static enum GNUNET_GenericReturnValue	remove_helper (void unused, const char fn)
	Function that removes the given directory by calling GNUNET_DISK_directory_remove(). More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_directory_remove (const char *filename)
	Remove all files in a directory (rm -rf). More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_copy (const char src, const char dst)
	Copy a file. More...

void	GNUNET_DISK_filename_canonicalize (char *fn)
	Removes special characters as ':' from a filename. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_change_owner (const char filename, const char user)
	Change owner of a file. More...

struct GNUNET_DISK_FileHandle *	GNUNET_DISK_file_open (const char *fn, enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm)
	Open a file. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h)
	Close an open file. More...

struct GNUNET_DISK_FileHandle *	GNUNET_DISK_get_handle_from_int_fd (int fno)
	Get a handle from a native integer FD. More...

struct GNUNET_DISK_FileHandle *	GNUNET_DISK_get_handle_from_native (FILE *fd)
	Get a handle from a native FD. More...

void *	GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle h, struct GNUNET_DISK_MapHandle *m, enum GNUNET_DISK_MapType access, size_t len)
	Map a file into memory. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_unmap (struct GNUNET_DISK_MapHandle *h)
	Unmap a file. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h)
	Write file changes to disk. More...

struct GNUNET_DISK_PipeHandle *	GNUNET_DISK_pipe (enum GNUNET_DISK_PipeFlags pf)
	Creates an interprocess channel. More...

struct GNUNET_DISK_PipeHandle *	GNUNET_DISK_pipe_from_fd (enum GNUNET_DISK_PipeFlags pf, int fd[2])
	Creates a pipe object from a couple of file descriptors. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_pipe_close_end (struct GNUNET_DISK_PipeHandle *p, enum GNUNET_DISK_PipeEnd end)
	Closes one half of an interprocess channel. More...

struct GNUNET_DISK_FileHandle *	GNUNET_DISK_pipe_detach_end (struct GNUNET_DISK_PipeHandle *p, enum GNUNET_DISK_PipeEnd end)
	Detaches one of the ends from the pipe. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_pipe_close (struct GNUNET_DISK_PipeHandle *p)
	Closes an interprocess channel. More...

const struct GNUNET_DISK_FileHandle *	GNUNET_DISK_pipe_handle (const struct GNUNET_DISK_PipeHandle *p, enum GNUNET_DISK_PipeEnd n)
	Get the handle to a particular pipe end. More...

enum GNUNET_GenericReturnValue	GNUNET_DISK_internal_file_handle_ (const struct GNUNET_DISK_FileHandle fh, int dst)
	Retrieve OS file handle. More...

static enum GNUNET_GenericReturnValue	purge_cfg_dir (void cls, const struct GNUNET_CONFIGURATION_Handle cfg)
	Helper function for GNUNET_DISK_purge_cfg_dir. More...

void	GNUNET_DISK_purge_cfg_dir (const struct GNUNET_OS_ProjectData pd, const char cfg_filename, const char *option)
	Remove the directory given under option in section [PATHS] in configuration under cfg_filename. More...

Detailed Description

disk IO convenience methods

Author: Christian Grothoff; Nils Durner

Definition in file disk.c.

Macro Definition Documentation

◆ LOG

#define LOG	(	kind,
		...
	)	GNUNET_log_from (kind, "util-disk", __VA_ARGS__)

Definition at line 31 of file disk.c.

◆ LOG_STRERROR

#define LOG_STRERROR	(	kind,
		syscall
	)	GNUNET_log_from_strerror (kind, "util-disk", syscall)

Definition at line 33 of file disk.c.

◆ LOG_STRERROR_FILE

#define LOG_STRERROR_FILE	(	kind,
		syscall,
		filename
	)	GNUNET_log_from_strerror_file (kind, "util-disk", syscall, filename)

Definition at line 36 of file disk.c.

◆ COPY_BLK_SIZE

#define COPY_BLK_SIZE 65536

Block size for IO for copying files.

Definition at line 42 of file disk.c.

◆ _IFMT

#define _IFMT 0170000 /* type of file */

Definition at line 59 of file disk.c.

◆ _IFLNK

#define _IFLNK 0120000 /* symbolic link */

Definition at line 60 of file disk.c.

◆ S_ISLNK

#define S_ISLNK ( m ) (((m)&_IFMT) == _IFLNK)

Definition at line 61 of file disk.c.

◆ MAP_FAILED

#define MAP_FAILED ((void *) -1)

Definition at line 1399 of file disk.c.

Function Documentation

◆ translate_unix_perms()

static int translate_unix_perms ( enum GNUNET_DISK_AccessPermissions perm )

static

Translate GNUnet-internal permission bitmap to UNIX file access permission bitmap.

Parameters

perm	file permissions, GNUnet style

Returns: file permissions, UNIX style

Definition at line 109 of file disk.c.

{
  int mode;
 
  mode = 0;
  if (perm & GNUNET_DISK_PERM_USER_READ)
    mode |= S_IRUSR;
  if (perm & GNUNET_DISK_PERM_USER_WRITE)
    mode |= S_IWUSR;
  if (perm & GNUNET_DISK_PERM_USER_EXEC)
    mode |= S_IXUSR;
  if (perm & GNUNET_DISK_PERM_GROUP_READ)
    mode |= S_IRGRP;
  if (perm & GNUNET_DISK_PERM_GROUP_WRITE)
    mode |= S_IWGRP;
  if (perm & GNUNET_DISK_PERM_GROUP_EXEC)
    mode |= S_IXGRP;
  if (perm & GNUNET_DISK_PERM_OTHER_READ)
    mode |= S_IROTH;
  if (perm & GNUNET_DISK_PERM_OTHER_WRITE)
    mode |= S_IWOTH;
  if (perm & GNUNET_DISK_PERM_OTHER_EXEC)
    mode |= S_IXOTH;
 
  return mode;
}

References GNUNET_DISK_PERM_GROUP_EXEC, GNUNET_DISK_PERM_GROUP_READ, GNUNET_DISK_PERM_GROUP_WRITE, GNUNET_DISK_PERM_OTHER_EXEC, GNUNET_DISK_PERM_OTHER_READ, GNUNET_DISK_PERM_OTHER_WRITE, GNUNET_DISK_PERM_USER_EXEC, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, and mode.

Referenced by GNUNET_DISK_file_backup(), GNUNET_DISK_file_open(), and GNUNET_DISK_fn_write().

Here is the caller graph for this function:

◆ get_size_rec()

static enum GNUNET_GenericReturnValue get_size_rec	(	void *	cls,
		const char *	fn
	)

static

Iterate over all files in the given directory and accumulate their size.

Parameters

cls	closure of type `struct GetFileSizeData`
fn	current filename we are looking at

Returns: GNUNET_SYSERR on serious errors, otherwise GNUNET_OK

Definition at line 146 of file disk.c.

{
  struct GetFileSizeData *gfsd = cls;
 
#if defined(HAVE_STAT64) && \
  ! (defined(_FILE_OFFSET_BITS) && _FILE_OFFSET_BITS == 64)
  struct stat64 buf;
 
  if (0 != lstat64 (fn, &buf))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "lstat64", fn);
    return GNUNET_SYSERR;
  }
#else
  struct stat buf;
 
  if (0 != lstat (fn, &buf))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "lstat", fn);
    return GNUNET_SYSERR;
  }
#endif
  if ((S_ISDIR (buf.st_mode)) && (gfsd->single_file_mode == GNUNET_YES))
  {
    errno = EISDIR;
    return GNUNET_SYSERR;
  }
  if ((S_ISLNK (buf.st_mode)) && (gfsd->include_sym_links == GNUNET_NO))
  {
    char linkdst[PATH_MAX];
    if (NULL == realpath (fn, linkdst))
    {
      LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "realpath", fn);
      return GNUNET_SYSERR;
    }
    return get_size_rec(gfsd, linkdst);
  }
  if ((! S_ISLNK (buf.st_mode)) || (gfsd->include_sym_links == GNUNET_YES))
    gfsd->total += buf.st_size;
  if ((S_ISDIR (buf.st_mode)) && (0 == access (fn, X_OK)) &&
      ((! S_ISLNK (buf.st_mode)) || (gfsd->include_sym_links == GNUNET_YES)))
  {
    if (GNUNET_SYSERR ==
        GNUNET_DISK_directory_scan (fn,
                                    &get_size_rec,
                                    gfsd))
      return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References get_size_rec(), GNUNET_DISK_directory_scan(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, GetFileSizeData::include_sym_links, LOG_STRERROR_FILE, PATH_MAX, S_ISLNK, GetFileSizeData::single_file_mode, and GetFileSizeData::total.

Referenced by get_size_rec(), and GNUNET_DISK_file_size().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mktemp_name()

static char * mktemp_name ( const char * t )

static

Create the name for a temporary file or directory from a template.

Parameters

t	template (without XXXXX or "/tmp/")

Returns: name ready for passing to 'mktemp' or 'mkdtemp', NULL on error

Definition at line 306 of file disk.c.

{
  const char *tmpdir;
  char *tmpl;
  char *fn;
 
  if ((t[0] != '/') && (t[0] != '\\'))
  {
    /* FIXME: This uses system codepage on W32, not UTF-8 */
    tmpdir = getenv ("TMPDIR");
    if (NULL == tmpdir)
      tmpdir = getenv ("TMP");
    if (NULL == tmpdir)
      tmpdir = getenv ("TEMP");
    if (NULL == tmpdir)
      tmpdir = "/tmp";
    GNUNET_asprintf (&tmpl, "%s/%s%s", tmpdir, t, "XXXXXX");
  }
  else
  {
    GNUNET_asprintf (&tmpl, "%s%s", t, "XXXXXX");
  }
  fn = tmpl;
  return fn;
}

References getenv(), GNUNET_asprintf(), and t.

Referenced by GNUNET_DISK_mkdtemp(), and GNUNET_DISK_mktemp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_test_internal()

static enum GNUNET_GenericReturnValue file_test_internal	(	const char *	fil,
		int	amode
	)

static

Check if fil can be accessed using amode.

Parameters

fil	file to check for
amode	access mode

Returns: GNUnet error code

Definition at line 494 of file disk.c.

{
  struct stat filestat;
  int ret;
  char *rdir;
 
  rdir = GNUNET_STRINGS_filename_expand (fil);
  if (rdir == NULL)
    return GNUNET_SYSERR;
 
  ret = stat (rdir, &filestat);
  if (0 != ret)
  {
    if (errno != ENOENT)
    {
      LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "stat", rdir);
      GNUNET_free (rdir);
      return GNUNET_SYSERR;
    }
    GNUNET_free (rdir);
    return GNUNET_NO;
  }
  if (! S_ISREG (filestat.st_mode))
  {
    GNUNET_free (rdir);
    return GNUNET_NO;
  }
  if (access (rdir, amode) < 0)
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "access", rdir);
    GNUNET_free (rdir);
    return GNUNET_SYSERR;
  }
  GNUNET_free (rdir);
  return GNUNET_YES;
}

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_NO, GNUNET_STRINGS_filename_expand(), GNUNET_SYSERR, GNUNET_YES, LOG_STRERROR_FILE, and ret.

Referenced by GNUNET_DISK_file_test(), and GNUNET_DISK_file_test_read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ glob_match()

static bool glob_match	(	const char *	pattern,
		const char *	str
	)

static

Check for a simple wildcard match.

Only asterisks are allowed. Asterisks match everything, including slashes.

Parameters

pattern	pattern with wildcards
str	string to match against

Returns: true on match, false otherwise

Definition at line 928 of file disk.c.

{
  /* Position in the input string */
  const char *str_pos = str;
  /* Position in the pattern */
  const char *pat_pos = pattern;
  /* Backtrack position in string */
  const char *str_bt = NULL;
  /* Backtrack position in pattern */
  const char *pat_bt = NULL;
 
  for (;;)
  {
    if (*pat_pos == '*')
    {
      str_bt = str_pos;
      pat_bt = pat_pos++;
    }
    else if (*pat_pos == *str_pos)
    {
      if ('\0' == *pat_pos)
        return true;
      str_pos++;
      pat_pos++;
    }
    else
    {
      if (NULL == str_bt)
        return false;
      /* Backtrack to match one more
         character as part of the asterisk. */
      str_pos = str_bt + 1;
      if ('\0' == *str_pos)
        return false;
      pat_pos = pat_bt;
    }
  }
}

Referenced by glob_cb().

Here is the caller graph for this function:

◆ glob_cb()

static enum GNUNET_GenericReturnValue glob_cb	(	void *	cls,
		const char *	filename
	)

static

Function called with a filename.

Parameters

cls	closure
filename	complete filename (absolute path)

Returns: GNUNET_OK to continue to iterate, GNUNET_NO to stop iteration with no error, GNUNET_SYSERR to abort iteration with error!

Definition at line 990 of file disk.c.

{
  struct GlobClosure *gc = cls;
  const char *fn;
 
  fn = strrchr (filename, DIR_SEPARATOR);
  fn = (NULL == fn) ? filename : (fn + 1);
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "checking glob '%s' against '%s'\n",
       gc->glob,
       fn);
 
  if (glob_match (gc->glob, fn))
  {
    enum GNUNET_GenericReturnValue cbret;
 
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "found glob match '%s'\n",
         filename);
    gc->nres++;
    cbret = gc->cb (gc->cls, filename);
    if (GNUNET_OK != cbret)
      return cbret;
  }
  return GNUNET_OK;
}

References GlobClosure::cb, GlobClosure::cls, DIR_SEPARATOR, filename, GlobClosure::glob, glob_match(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_OK, LOG, and GlobClosure::nres.

Referenced by GNUNET_DISK_glob().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove_helper()

static enum GNUNET_GenericReturnValue remove_helper	(	void *	unused,
		const char *	fn
	)

static

Function that removes the given directory by calling GNUNET_DISK_directory_remove().

Parameters

unused	not used
fn	directory to remove

Returns: GNUNET_OK

Definition at line 1088 of file disk.c.

{
  (void) unused;
  (void) GNUNET_DISK_directory_remove (fn);
  return GNUNET_OK;
}

References GNUNET_DISK_directory_remove(), and GNUNET_OK.

Referenced by GNUNET_DISK_directory_remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_DISK_internal_file_handle_()

enum GNUNET_GenericReturnValue GNUNET_DISK_internal_file_handle_	(	const struct GNUNET_DISK_FileHandle *	fh,
		int *	dst
	)

Retrieve OS file handle.

Parameters

fh	GNUnet file descriptor
dst	destination buffer

Returns: GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1662 of file disk.c.

{
  if (NULL == fh)
    return GNUNET_SYSERR;
  *dst = fh->fd;
  return GNUNET_OK;
}

References GNUNET_DISK_FileHandle::fd, GNUNET_OK, and GNUNET_SYSERR.

Referenced by GNUNET_NETWORK_fdset_handle_set(), and start_process().

Here is the caller graph for this function:

◆ purge_cfg_dir()

static enum GNUNET_GenericReturnValue purge_cfg_dir	(	void *	cls,
		const struct GNUNET_CONFIGURATION_Handle *	cfg
	)

static

Helper function for GNUNET_DISK_purge_cfg_dir.

Parameters

cls	a `const char *` with the option to purge
cfg	our configuration

Returns: GNUNET_OK on success

Definition at line 1680 of file disk.c.

{
  const char *option = cls;
  char *tmpname;
 
  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_filename (cfg,
                                               "PATHS",
                                               option,
                                               &tmpname))
  {
    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
                               "PATHS",
                               option);
    return GNUNET_NO;
  }
  if (GNUNET_SYSERR ==
      GNUNET_DISK_directory_remove (tmpname))
  {
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
                              "remove",
                              tmpname);
    GNUNET_free (tmpname);
    return GNUNET_OK;
  }
  GNUNET_free (tmpname);
  return GNUNET_OK;
}

References cfg, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_DISK_directory_remove(), GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log_config_missing(), GNUNET_log_strerror_file, GNUNET_NO, GNUNET_OK, and GNUNET_SYSERR.

Referenced by GNUNET_DISK_purge_cfg_dir().

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ LOG

◆ LOG_STRERROR

◆ LOG_STRERROR_FILE

◆ COPY_BLK_SIZE

◆ _IFMT

◆ _IFLNK

◆ S_ISLNK

◆ MAP_FAILED

Function Documentation

◆ translate_unix_perms()

◆ get_size_rec()

◆ mktemp_name()

◆ file_test_internal()

◆ glob_match()

◆ glob_cb()

◆ remove_helper()

◆ GNUNET_DISK_internal_file_handle_()

◆ purge_cfg_dir()