Disk library

Disk IO APIs. More...

Data Structures
struct	GNUNET_DISK_FileHandle
	Handle used to access files (and pipes). More...

Enumerations
enum	GNUNET_FILE_Type { GNUNET_DISK_HANLDE_TYPE_EVENT, GNUNET_DISK_HANLDE_TYPE_FILE, GNUNET_DISK_HANLDE_TYPE_PIPE }
	Type of a handle. More...
enum	GNUNET_DISK_OpenFlags {   GNUNET_DISK_OPEN_READ = 1, GNUNET_DISK_OPEN_WRITE = 2, GNUNET_DISK_OPEN_READWRITE = 3, GNUNET_DISK_OPEN_FAILIFEXISTS = 4,   GNUNET_DISK_OPEN_TRUNCATE = 8, GNUNET_DISK_OPEN_CREATE = 16, GNUNET_DISK_OPEN_APPEND = 32 }
	Specifies how a file should be opened. More...
enum	GNUNET_DISK_MapType { GNUNET_DISK_MAP_TYPE_READ = 1, GNUNET_DISK_MAP_TYPE_WRITE = 2, GNUNET_DISK_MAP_TYPE_READWRITE = 3 }
	Specifies what type of memory map is desired. More...
enum	GNUNET_DISK_AccessPermissions {   GNUNET_DISK_PERM_NONE = 0, GNUNET_DISK_PERM_USER_READ = 1, GNUNET_DISK_PERM_USER_WRITE = 2, GNUNET_DISK_PERM_USER_EXEC = 4,   GNUNET_DISK_PERM_GROUP_READ = 8, GNUNET_DISK_PERM_GROUP_WRITE = 16, GNUNET_DISK_PERM_GROUP_EXEC = 32, GNUNET_DISK_PERM_OTHER_READ = 64,   GNUNET_DISK_PERM_OTHER_WRITE = 128, GNUNET_DISK_PERM_OTHER_EXEC = 256 }
	File access permissions, UNIX-style. More...
enum	GNUNET_DISK_Seek { GNUNET_DISK_SEEK_SET = 0, GNUNET_DISK_SEEK_CUR = 1, GNUNET_DISK_SEEK_END = 2 }
	Constants for specifying how to seek. More...
enum	GNUNET_DISK_PipeEnd { GNUNET_DISK_PIPE_END_READ = 0, GNUNET_DISK_PIPE_END_WRITE = 1 }
	Enumeration identifying the two ends of a pipe. More...

Functions
int	GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h)
	Checks whether a handle is invalid. More...
int	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...
void	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...
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...
int	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...
int	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...
char *	GNUNET_DISK_mktemp (const char *t)
	Create an (empty) temporary file on disk. More...
char *	GNUNET_DISK_mkdtemp (const char *t)
	Create an (empty) temporary directory on disk. 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...
int	GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle *fh, off_t *size)
	Get the size of an open file. More...
struct GNUNET_DISK_PipeHandle *	GNUNET_DISK_pipe (int blocking_read, int blocking_write, int inherit_read, int inherit_write)
	Creates an interprocess channel. More...
struct GNUNET_DISK_PipeHandle *	GNUNET_DISK_pipe_from_fd (int blocking_read, int blocking_write, int fd[2])
	Creates a pipe object from a couple of file descriptors. More...
int	GNUNET_DISK_pipe_close (struct GNUNET_DISK_PipeHandle *p)
	Closes an interprocess channel. More...
int	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...
int	GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h)
	Close an open file. 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...
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...
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...
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_file_read_non_blocking (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...
ssize_t	GNUNET_DISK_fn_write (const char *fn, const void *buffer, size_t n, enum GNUNET_DISK_AccessPermissions mode)
	Write a buffer to a file. More...
int	GNUNET_DISK_file_copy (const char *src, const char *dst)
	Copy a file. More...
int	GNUNET_DISK_directory_scan (const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
	Scan a directory for files. More...
int	GNUNET_DISK_directory_create_for_file (const char *filename)
	Create the directory structure for storing a file. More...
int	GNUNET_DISK_directory_test (const char *fil, int is_readable)
	Test if fil is a directory and listable. More...
int	GNUNET_DISK_directory_remove (const char *filename)
	Remove all files in a directory (rm -rf). More...
void	GNUNET_DISK_purge_cfg_dir (const char *cfg_filename, const char *option)
	Remove the directory given under option in section [PATHS] in configuration under cfg_filename. More...
int	GNUNET_DISK_directory_create (const char *dir)
	Implementation of "mkdir -p". More...
int	GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, off_t lock_start, off_t lock_end, int excl)
	Lock a part of a file. More...
int	GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, off_t unlock_start, off_t unlock_end)
	Unlock a part of a file. More...
void	GNUNET_DISK_filename_canonicalize (char *fn)
	Removes special characters as ':' from a filename. More...
int	GNUNET_DISK_file_change_owner (const char *filename, const char *user)
	Change owner of a file. 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...
int	GNUNET_DISK_file_unmap (struct GNUNET_DISK_MapHandle *h)
	Unmap a file. More...
int	GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h)
	Write file changes to disk. More...

Detailed Description

Disk IO APIs.

Enumeration Type Documentation

GNUNET_FILE_Type

enum GNUNET_FILE_Type

Type of a handle.

Enumerator
GNUNET_DISK_HANLDE_TYPE_EVENT	Handle represents an event.
GNUNET_DISK_HANLDE_TYPE_FILE	Handle represents a file.
GNUNET_DISK_HANLDE_TYPE_PIPE	Handle represents a pipe.

Definition at line 41 of file gnunet_disk_lib.h.

{
  GNUNET_DISK_HANLDE_TYPE_EVENT,

  GNUNET_DISK_HANLDE_TYPE_FILE,

  GNUNET_DISK_HANLDE_TYPE_PIPE
};

GNUNET_DISK_OpenFlags

enum GNUNET_DISK_OpenFlags

Specifies how a file should be opened.

Enumerator
GNUNET_DISK_OPEN_READ	Open the file for reading.
GNUNET_DISK_OPEN_WRITE	Open the file for writing.
GNUNET_DISK_OPEN_READWRITE	Open the file for both reading and writing.
GNUNET_DISK_OPEN_FAILIFEXISTS	Fail if file already exists.
GNUNET_DISK_OPEN_TRUNCATE	Truncate file if it exists.
GNUNET_DISK_OPEN_CREATE	Create file if it doesn't exist.
GNUNET_DISK_OPEN_APPEND	Append to the file.

Definition at line 91 of file gnunet_disk_lib.h.

{
  GNUNET_DISK_OPEN_READ = 1,

  GNUNET_DISK_OPEN_WRITE = 2,

  GNUNET_DISK_OPEN_READWRITE = 3,

  GNUNET_DISK_OPEN_FAILIFEXISTS = 4,

  GNUNET_DISK_OPEN_TRUNCATE = 8,

  GNUNET_DISK_OPEN_CREATE = 16,

  GNUNET_DISK_OPEN_APPEND = 32
};

GNUNET_DISK_MapType

enum GNUNET_DISK_MapType

Specifies what type of memory map is desired.

Enumerator
GNUNET_DISK_MAP_TYPE_READ	Read-only memory map.
GNUNET_DISK_MAP_TYPE_WRITE	Write-able memory map.
GNUNET_DISK_MAP_TYPE_READWRITE	Read-write memory map.

Definition at line 132 of file gnunet_disk_lib.h.

{
  GNUNET_DISK_MAP_TYPE_READ = 1,

  GNUNET_DISK_MAP_TYPE_WRITE = 2,

  GNUNET_DISK_MAP_TYPE_READWRITE = 3
};

GNUNET_DISK_AccessPermissions

enum GNUNET_DISK_AccessPermissions

File access permissions, UNIX-style.

Enumerator
GNUNET_DISK_PERM_NONE	Nobody is allowed to do anything to the file.
GNUNET_DISK_PERM_USER_READ	Owner can read.
GNUNET_DISK_PERM_USER_WRITE	Owner can write.
GNUNET_DISK_PERM_USER_EXEC	Owner can execute.
GNUNET_DISK_PERM_GROUP_READ	Group can read.
GNUNET_DISK_PERM_GROUP_WRITE	Group can write.
GNUNET_DISK_PERM_GROUP_EXEC	Group can execute.
GNUNET_DISK_PERM_OTHER_READ	Everybody can read.
GNUNET_DISK_PERM_OTHER_WRITE	Everybody can write.
GNUNET_DISK_PERM_OTHER_EXEC	Everybody can execute.

Definition at line 154 of file gnunet_disk_lib.h.

{
  GNUNET_DISK_PERM_NONE = 0,

  GNUNET_DISK_PERM_USER_READ = 1,

  GNUNET_DISK_PERM_USER_WRITE = 2,

  GNUNET_DISK_PERM_USER_EXEC = 4,

  GNUNET_DISK_PERM_GROUP_READ = 8,

  GNUNET_DISK_PERM_GROUP_WRITE = 16,

  GNUNET_DISK_PERM_GROUP_EXEC = 32,

  GNUNET_DISK_PERM_OTHER_READ = 64,

  GNUNET_DISK_PERM_OTHER_WRITE = 128,

  GNUNET_DISK_PERM_OTHER_EXEC = 256
};

GNUNET_DISK_Seek

enum GNUNET_DISK_Seek

Constants for specifying how to seek.

Do not change values or order, some of the code depends on the specific numeric values!

Enumerator
GNUNET_DISK_SEEK_SET	Seek an absolute position (from the start of the file).
GNUNET_DISK_SEEK_CUR	Seek a relative position (from the current offset).
GNUNET_DISK_SEEK_END	Seek an absolute position from the end of the file.

Definition at line 212 of file gnunet_disk_lib.h.

{
  GNUNET_DISK_SEEK_SET = 0,

  GNUNET_DISK_SEEK_CUR = 1,

  GNUNET_DISK_SEEK_END = 2
};

GNUNET_DISK_PipeEnd

enum GNUNET_DISK_PipeEnd

Enumeration identifying the two ends of a pipe.

Enumerator
GNUNET_DISK_PIPE_END_READ	The reading-end of a pipe.
GNUNET_DISK_PIPE_END_WRITE	The writing-end of a pipe.

Definition at line 234 of file gnunet_disk_lib.h.

{
  GNUNET_DISK_PIPE_END_READ = 0,

  GNUNET_DISK_PIPE_END_WRITE = 1
};

Function Documentation

GNUNET_DISK_handle_invalid()

int GNUNET_DISK_handle_invalid

(

const struct GNUNET_DISK_FileHandle *

h

)

Checks whether a handle is invalid.

Parameters

h	handle to check

Returns

GNUNET_YES if invalid, GNUNET_NO if valid

Definition at line 192 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_NO, and GNUNET_YES.

Referenced by decrementBit(), file_hash_finish(), incrementBit(), make_empty_file(), and shutdown_pipe_cb().

{
  return ((! h) || (h->fd == -1)) ? GNUNET_YES : GNUNET_NO;
}

Here is the caller graph for this function:

GNUNET_DISK_file_test()

int 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).

Parameters

fil	filename to check

Returns

GNUNET_YES if yes, GNUNET_NO if not a file, GNUNET_SYSERR if something else (will print an error message in that case, too).

Definition at line 544 of file disk.c.

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

Referenced by create_download_context(), create_unique_cfgs(), database_setup(), ego_callback(), gen_topo_from_file(), get_path_from_PATH(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_CRYPTO_ecdsa_key_create_from_file(), GNUNET_CRYPTO_eddsa_key_create_from_file(), GNUNET_DISK_file_open(), GNUNET_FRIENDS_parse(), GNUNET_FRIENDS_write_start(), GNUNET_FS_download_start_task_(), GNUNET_HOSTLIST_client_start(), GNUNET_PROGRAM_run2(), GNUNET_SERVICE_run_(), GNUNET_TESTBED_hosts_load_from_file(), GNUNET_TRANSPORT_TESTING_start_peer(), hostkeys_load(), hosts_directory_scan_callback(), LEGACY_SERVICE_run(), load_hostlist_file(), load_search_strings(), policy_filename_cb(), print_key(), read_host_file(), read_index_list(), read_update_information_graph(), restore_valid_peers(), and run().

{
  struct stat filestat;
  int ret;
  char *rdir;

  rdir = GNUNET_STRINGS_filename_expand (fil);
  if (rdir == NULL)
    return GNUNET_SYSERR;

  ret = stat (rdir, &filestat);
  if (ret != 0)
  {
    if (errno != ENOENT)
    {
      LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "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, F_OK) < 0)
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "access", rdir);
    GNUNET_free (rdir);
    return GNUNET_SYSERR;
  }
  GNUNET_free (rdir);
  return GNUNET_YES;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_backup()

void 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.

Parameters

fil	name of the file to back up

Definition at line 436 of file disk.c.

References GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log_strerror_file, GNUNET_malloc, and GNUNET_snprintf().

Referenced by GNUNET_FRIENDS_write_start().

{
  size_t slen;
  char *target;
  unsigned int num;

  slen = strlen (fil) + 20;
  target = GNUNET_malloc (slen);
  num = 0;
  do
  {
    GNUNET_snprintf (target, slen, "%s.%u~", fil, num++);
  }
  while (0 == access (target, F_OK));
  if (0 != rename (fil, target))
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "rename", fil);
  GNUNET_free (target);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_seek()

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.

Parameters

h	handle of an open file
offset	position to move to
whence	specification to which position the offset parameter relates to

Returns

the new position on success, GNUNET_SYSERR otherwise

Parameters

h	handle of an open file
offset	position to move to
whence	specification to which position the offset parameter relates to

Returns

the new position on success, GNUNET_SYSERR otherwise

Definition at line 226 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_SYSERR, and t.

Referenced by decrementBit(), fh_reader(), GNUNET_FS_data_reader_file_(), GNUNET_FS_handle_on_demand_block(), incrementBit(), make_empty_file(), process_result_with_request(), try_top_down_reconstruction(), and unindex_reader().

{
  if (h == NULL)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }

  static int t[] = { SEEK_SET, SEEK_CUR, SEEK_END };

  return lseek (h->fd, offset, t[whence]);
}

Here is the caller graph for this function:

GNUNET_DISK_file_size()

int 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).

Parameters

filename	name of the file or directory
size	set to the size of the file (or, in the case of directories, the sum of all sizes of files in the directory)
include_symbolic_links	should symbolic links be included?
single_file_mode	GNUNET_YES to only get size of one file and return GNUNET_SYSERR for directories.

Returns

GNUNET_SYSERR on error, GNUNET_OK on success

Definition at line 257 of file disk.c.

References getSizeRec(), GNUNET_assert, GetFileSizeData::include_sym_links, ret, GetFileSizeData::single_file_mode, and GetFileSizeData::total.

Referenced by create_download_context(), database_setup(), discard_hosts_helper(), gen_topo_from_file(), GNUNET_CONFIGURATION_parse(), GNUNET_CRYPTO_ecdsa_key_create_from_file(), GNUNET_CRYPTO_eddsa_key_create_from_file(), GNUNET_CRYPTO_hash_file(), GNUNET_DISK_file_copy(), GNUNET_FRIENDS_parse(), GNUNET_FS_file_information_create_from_file(), GNUNET_FS_unindex_start(), GNUNET_TESTBED_hosts_load_from_file(), hostkeys_load(), load(), load_file(), load_keys(), load_search_strings(), main(), policy_filename_cb(), preprocess_file(), print_key(), run(), server_log(), and setup_ac().

{
  struct GetFileSizeData gfsd;
  int ret;

  GNUNET_assert (size != NULL);
  gfsd.total = 0;
  gfsd.include_sym_links = include_symbolic_links;
  gfsd.single_file_mode = single_file_mode;
  ret = getSizeRec (&gfsd, filename);
  *size = gfsd.total;
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_get_identifiers()

int 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.

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.

Parameters

filename	name of the file
dev	set to the device ID
ino	set to the inode ID

Returns

GNUNET_OK on success

Definition at line 291 of file disk.c.

References GNUNET_OK, and GNUNET_SYSERR.

Referenced by handle_client_index_start(), and hash_for_index_cb().

{
#if HAVE_STAT
  {
    struct stat sbuf;

    if (0 != stat (filename, &sbuf))
    {
      return GNUNET_SYSERR;
    }
    *ino = (uint64_t) sbuf.st_ino;
  }
#else
  *ino = 0;
#endif
#if HAVE_STATVFS
  {
    struct statvfs fbuf;

    if (0 != statvfs (filename, &fbuf))
    {
      return GNUNET_SYSERR;
    }
    *dev = (uint64_t) fbuf.f_fsid;
  }
#elif HAVE_STATFS
  {
    struct statfs fbuf;

    if (0 != statfs (filename, &fbuf))
    {
      return GNUNET_SYSERR;
    }
    *dev =
      ((uint64_t) fbuf.f_fsid.val[0]) << 32 || ((uint64_t) fbuf.f_fsid.val[1]);
  }
#else
  *dev = 0;
#endif
  return GNUNET_OK;
}

Here is the caller graph for this function:

GNUNET_DISK_mktemp()

char* GNUNET_DISK_mktemp

(

const char *

t

)

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.

Parameters

t	component to use for the name; does NOT contain "XXXXXX" or "/tmp/".

Returns

NULL on error, otherwise name of fresh file on disk in directory for temporary files

Definition at line 468 of file disk.c.

References GNUNET_DISK_PipeHandle::fd, fn, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, LOG_STRERROR_FILE, and mktemp_name().

Referenced by create_download_context(), GNUNET_DATACACHE_create(), GNUNET_FS_download_sync_(), libgnunet_plugin_datacache_sqlite_init(), make_serialization_file_name(), make_serialization_file_name_in_dir(), publish_fs_connect_complete_cb(), and testing_main().

{
  int fd;
  char *fn;
  mode_t omask;

  omask = umask (S_IWGRP | S_IWOTH | S_IRGRP | S_IROTH);
  fn = mktemp_name (t);
  if (-1 == (fd = mkstemp (fn)))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkstemp", fn);
    GNUNET_free (fn);
    umask (omask);
    return NULL;
  }
  umask (omask);
  if (0 != close (fd))
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "close", fn);
  return fn;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_mkdtemp()

char* GNUNET_DISK_mkdtemp

(

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.

Parameters

t	component to use for the name; does NOT contain "XXXXXX" or "/tmp/".

Returns

NULL on error, otherwise name of freshly created directory

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.

Parameters

t	component to use for the name; does NOT contain "XXXXXX" or "/tmp/".

Returns

NULL on error, otherwise name of fresh file on disk in directory for temporary files

Definition at line 409 of file disk.c.

References fn, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, LOG_STRERROR_FILE, and mktemp_name().

Referenced by access_handler_callback(), and GNUNET_TESTING_system_create_with_portrange().

{
  char *fn;
  mode_t omask;

  omask = umask (S_IWGRP | S_IWOTH | S_IRGRP | S_IROTH);
  fn = mktemp_name (t);
  if (fn != mkdtemp (fn))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkdtemp", fn);
    GNUNET_free (fn);
    umask (omask);
    return NULL;
  }
  umask (omask);
  return fn;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_open()

struct GNUNET_DISK_FileHandle* GNUNET_DISK_file_open	(	const char *	fn,
		enum GNUNET_DISK_OpenFlags	flags,
		enum GNUNET_DISK_AccessPermissions	perm
	)

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.

Parameters

fn	file name to be opened
flags	opening flags, a combination of GNUNET_DISK_OPEN_xxx bit flags
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)

Returns

IO handle on success, NULL on error

Definition at line 1268 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_DISK_PipeHandle::fd, GNUNET_break, GNUNET_DISK_directory_create_for_file(), GNUNET_DISK_file_test(), GNUNET_DISK_OPEN_APPEND, GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_FAILIFEXISTS, GNUNET_DISK_OPEN_READ, GNUNET_DISK_OPEN_READWRITE, GNUNET_DISK_OPEN_TRUNCATE, GNUNET_DISK_OPEN_WRITE, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_new, GNUNET_NO, GNUNET_STRINGS_filename_expand(), LOG_STRERROR_FILE, mode, O_LARGEFILE, ret, and translate_unix_perms().

Referenced by create_hostkeys(), database_setup(), database_shutdown(), full_recursive_download(), get_file_handle(), GNUNET_ATS_solver_logging_write_to_disk(), GNUNET_ATS_TEST_logging_write_to_file(), GNUNET_BIO_read_open(), GNUNET_BIO_write_open(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_CRYPTO_ecdsa_key_create_from_file(), GNUNET_CRYPTO_eddsa_key_create_from_file(), GNUNET_CRYPTO_hash_file(), GNUNET_DISK_file_copy(), GNUNET_DISK_fn_read(), GNUNET_DISK_fn_write(), GNUNET_FRIENDS_write_start(), GNUNET_FS_data_reader_file_(), GNUNET_FS_download_start_task_(), GNUNET_FS_handle_on_demand_block(), GNUNET_FS_unindex_do_remove_(), GNUNET_TESTING_peer_configure(), GNUNET_TIME_absolute_get_monotonic(), hostkeys_load(), iface_proc(), load_etc_hosts(), load_keys(), lookup_dns_servers(), main(), print_key(), process_result_with_request(), publish_fs_connect_complete_cb(), REGEX_TEST_read_from_file(), restore_valid_peers(), run(), server_log(), start_dump(), start_insert(), store_valid_peers(), to_file_raw(), tofile_(), try_match_block(), write_benchmark_data(), write_bw_gnuplot_script(), write_rtt_gnuplot_script(), and write_throughput_gnuplot_script().

{
  char *expfn;
  struct GNUNET_DISK_FileHandle *ret;

  int oflags;
  int mode;
  int fd;

  expfn = GNUNET_STRINGS_filename_expand (fn);
  if (NULL == expfn)
    return NULL;

  mode = 0;
  if (GNUNET_DISK_OPEN_READWRITE == (flags & GNUNET_DISK_OPEN_READWRITE))
    oflags = O_RDWR; /* note: O_RDWR is NOT always O_RDONLY | O_WRONLY */
  else if (flags & GNUNET_DISK_OPEN_READ)
    oflags = O_RDONLY;
  else if (flags & GNUNET_DISK_OPEN_WRITE)
    oflags = O_WRONLY;
  else
  {
    GNUNET_break (0);
    GNUNET_free (expfn);
    return NULL;
  }
  if (flags & GNUNET_DISK_OPEN_FAILIFEXISTS)
    oflags |= (O_CREAT | O_EXCL);
  if (flags & GNUNET_DISK_OPEN_TRUNCATE)
    oflags |= O_TRUNC;
  if (flags & GNUNET_DISK_OPEN_APPEND)
    oflags |= O_APPEND;
  if (GNUNET_NO == GNUNET_DISK_file_test (fn))
  {
    if (flags & GNUNET_DISK_OPEN_CREATE)
    {
      (void) GNUNET_DISK_directory_create_for_file (expfn);
      oflags |= O_CREAT;
      mode = translate_unix_perms (perm);
    }
  }

  fd = open (expfn,
             oflags
#if O_CLOEXEC
             | O_CLOEXEC
#endif
             | O_LARGEFILE,
             mode);
  if (fd == -1)
  {
    if (0 == (flags & GNUNET_DISK_OPEN_FAILIFEXISTS))
      LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "open", expfn);
    else
      LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "open", expfn);
    GNUNET_free (expfn);
    return NULL;
  }

  ret = GNUNET_new (struct GNUNET_DISK_FileHandle);

  ret->fd = fd;

  GNUNET_free (expfn);
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_handle_size()

int GNUNET_DISK_file_handle_size	(	struct GNUNET_DISK_FileHandle *	fh,
		off_t *	size
	)

Get the size of an open file.

Parameters

fh	open file handle
size	where to write size of the file

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 206 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_OK, and GNUNET_SYSERR.

Referenced by GNUNET_CONTAINER_bloomfilter_load(), GNUNET_TIME_absolute_get_monotonic(), load_etc_hosts(), lookup_dns_servers(), REGEX_TEST_read_from_file(), and restore_valid_peers().

{
  struct stat sbuf;

  if (0 != fstat (fh->fd, &sbuf))
    return GNUNET_SYSERR;
  *size = sbuf.st_size;
  return GNUNET_OK;
}

Here is the caller graph for this function:

GNUNET_DISK_pipe()

struct GNUNET_DISK_PipeHandle* GNUNET_DISK_pipe	(	int	blocking_read,
		int	blocking_write,
		int	inherit_read,
		int	inherit_write
	)

Creates an interprocess channel.

Parameters

blocking_read	creates an asynchronous pipe for reading if set to GNUNET_NO
blocking_write	creates an asynchronous pipe for writing if set to GNUNET_NO
inherit_read	1 to make read handle inheritable, 0 otherwise (NT only)
inherit_write	1 to make write handle inheritable, 0 otherwise (NT only)

Returns

handle to the new pipe, NULL on error

Parameters

blocking_read	creates an asynchronous pipe for reading if set to GNUNET_NO
blocking_write	creates an asynchronous pipe for writing if set to GNUNET_NO
inherit_read	inherit the parent processes stdin (only for windows)
inherit_write	inherit the parent processes stdout (only for windows)

Returns

handle to the new pipe, NULL on error

Definition at line 1526 of file disk.c.

References GNUNET_DISK_PipeHandle::fd, GNUNET_DISK_pipe_from_fd(), GNUNET_ERROR_TYPE_ERROR, LOG_STRERROR, and ret.

Referenced by GNUNET_ARM_request_service_start(), GNUNET_NAT_mini_get_external_ipv4_(), GNUNET_OS_command_run(), GNUNET_SCHEDULER_driver_init(), main(), restart_nat_server(), start_helper(), and start_process().

{
  int fd[2];
  int ret;
  int eno;

  (void) inherit_read;
  (void) inherit_write;
  ret = pipe (fd);
  if (ret == -1)
  {
    eno = errno;
    LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "pipe");
    errno = eno;
    return NULL;
  }
  return GNUNET_DISK_pipe_from_fd (blocking_read, blocking_write, fd);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_pipe_from_fd()

struct GNUNET_DISK_PipeHandle* GNUNET_DISK_pipe_from_fd	(	int	blocking_read,
		int	blocking_write,
		int	fd[2]
	)

Creates a pipe object from a couple of file descriptors.

Useful for wrapping existing pipe FDs.

Parameters

blocking_read	creates an asynchronous pipe for reading if set to GNUNET_NO
blocking_write	creates an asynchronous pipe for writing if set to GNUNET_NO
fd	an array of two fd values. One of them may be -1 for read-only or write-only pipes

Returns

handle to the new pipe, NULL on error

Useful for wrapping existing pipe FDs.

Parameters

blocking_read	creates an asynchronous pipe for reading if set to GNUNET_NO
blocking_write	creates an asynchronous pipe for writing if set to GNUNET_NO
fd	an array of two fd values. One of them may be -1 for read-only or write-only pipes

Returns

handle to the new pipe, NULL on error

Definition at line 1560 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_DISK_PipeHandle::fd, GNUNET_break, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_free_non_null, GNUNET_new, LOG_STRERROR, p, and ret.

Referenced by GNUNET_DISK_pipe().

{
  struct GNUNET_DISK_PipeHandle *p;

  p = GNUNET_new (struct GNUNET_DISK_PipeHandle);

  int ret;
  int flags;
  int eno = 0; /* make gcc happy */

  ret = 0;
  if (fd[0] >= 0)
  {
    p->fd[0] = GNUNET_new (struct GNUNET_DISK_FileHandle);
    p->fd[0]->fd = fd[0];
    if (! blocking_read)
    {
      flags = fcntl (fd[0], F_GETFL);
      flags |= O_NONBLOCK;
      if (0 > fcntl (fd[0], F_SETFL, flags))
      {
        ret = -1;
        eno = errno;
      }
    }
    flags = fcntl (fd[0], F_GETFD);
    flags |= FD_CLOEXEC;
    if (0 > fcntl (fd[0], F_SETFD, flags))
    {
      ret = -1;
      eno = errno;
    }
  }

  if (fd[1] >= 0)
  {
    p->fd[1] = GNUNET_new (struct GNUNET_DISK_FileHandle);
    p->fd[1]->fd = fd[1];
    if (! blocking_write)
    {
      flags = fcntl (fd[1], F_GETFL);
      flags |= O_NONBLOCK;
      if (0 > fcntl (fd[1], F_SETFL, flags))
      {
        ret = -1;
        eno = errno;
      }
    }
    flags = fcntl (fd[1], F_GETFD);
    flags |= FD_CLOEXEC;
    if (0 > fcntl (fd[1], F_SETFD, flags))
    {
      ret = -1;
      eno = errno;
    }
  }
  if (ret == -1)
  {
    errno = eno;
    LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "fcntl");
    if (p->fd[0]->fd >= 0)
      GNUNET_break (0 == close (p->fd[0]->fd));
    if (p->fd[1]->fd >= 0)
      GNUNET_break (0 == close (p->fd[1]->fd));
    GNUNET_free_non_null (p->fd[0]);
    GNUNET_free_non_null (p->fd[1]);
    GNUNET_free (p);
    errno = eno;
    return NULL;
  }

  return p;
}

Here is the caller graph for this function:

GNUNET_DISK_pipe_close()

int GNUNET_DISK_pipe_close

(

struct GNUNET_DISK_PipeHandle *

p

)

Closes an interprocess channel.

Parameters

p

pipe

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Parameters

p	pipe to close

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1715 of file disk.c.

References GNUNET_DISK_pipe_close_end(), GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_PIPE_END_WRITE, GNUNET_free, GNUNET_OK, and ret.

Referenced by GN_stop_gnunet_nat_server_(), GNUNET_ARM_request_service_start(), GNUNET_HELPER_kill(), GNUNET_HELPER_wait(), GNUNET_NAT_mini_get_external_ipv4_(), GNUNET_NAT_mini_get_external_ipv4_cancel_(), GNUNET_OS_command_run(), GNUNET_OS_command_stop(), GNUNET_SCHEDULER_driver_done(), main(), nat_server_read(), restart_nat_server(), and start_process().

{
  int ret = GNUNET_OK;

  int read_end_close;
  int write_end_close;
  int read_end_close_errno;
  int write_end_close_errno;

  read_end_close = GNUNET_DISK_pipe_close_end (p, GNUNET_DISK_PIPE_END_READ);
  read_end_close_errno = errno;
  write_end_close = GNUNET_DISK_pipe_close_end (p, GNUNET_DISK_PIPE_END_WRITE);
  write_end_close_errno = errno;
  GNUNET_free (p);

  if (GNUNET_OK != read_end_close)
  {
    errno = read_end_close_errno;
    ret = read_end_close;
  }
  else if (GNUNET_OK != write_end_close)
  {
    errno = write_end_close_errno;
    ret = write_end_close;
  }

  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_pipe_close_end()

int GNUNET_DISK_pipe_close_end	(	struct GNUNET_DISK_PipeHandle *	p,
		enum GNUNET_DISK_PipeEnd	end
	)

Closes one half of an interprocess channel.

Parameters

p	pipe to close end of
end	which end of the pipe to close

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Closes one half of an interprocess channel.

Parameters

p	pipe to close
end	which end of the pipe to close

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1643 of file disk.c.

References GNUNET_DISK_PipeHandle::fd, GNUNET_DISK_file_close(), GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_PIPE_END_WRITE, GNUNET_OK, and ret.

Referenced by GNUNET_DISK_pipe_close(), GNUNET_NAT_mini_get_external_ipv4_(), GNUNET_OS_command_run(), restart_nat_server(), and start_helper().

{
  int ret = GNUNET_OK;

  if (end == GNUNET_DISK_PIPE_END_READ)
  {
    if (p->fd[0])
    {
      ret = GNUNET_DISK_file_close (p->fd[0]);
      p->fd[0] = NULL;
    }
  }
  else if (end == GNUNET_DISK_PIPE_END_WRITE)
  {
    if (p->fd[1])
    {
      ret = GNUNET_DISK_file_close (p->fd[1]);
      p->fd[1] = NULL;
    }
  }

  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_pipe_detach_end()

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.

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).

Parameters

p	pipe to detach an end from
end	which end of the pipe to detach

Returns

Detached end on success, NULL on failure (or if that end is not present or is closed).

Definition at line 1682 of file disk.c.

References GNUNET_DISK_PipeHandle::fd, GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_PIPE_END_WRITE, and ret.

Referenced by GNUNET_ARM_request_service_start(), and start_process().

{
  struct GNUNET_DISK_FileHandle *ret = NULL;

  if (end == GNUNET_DISK_PIPE_END_READ)
  {
    if (p->fd[0])
    {
      ret = p->fd[0];
      p->fd[0] = NULL;
    }
  }
  else if (end == GNUNET_DISK_PIPE_END_WRITE)
  {
    if (p->fd[1])
    {
      ret = p->fd[1];
      p->fd[1] = NULL;
    }
  }

  return ret;
}

Here is the caller graph for this function:

GNUNET_DISK_file_close()

int GNUNET_DISK_file_close

(

struct GNUNET_DISK_FileHandle *

h

)

Close an open file.

Parameters

h	file handle

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1345 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_OK, GNUNET_SYSERR, LOG_STRERROR, and ret.

Referenced by check_completed(), cleanup(), close_files_iter(), create_hostkeys(), database_setup(), database_shutdown(), do_shutdown(), file_hash_finish(), full_recursive_download(), get_cb(), GNUNET_ARM_operation_cancel(), GNUNET_ARM_request_service_start(), GNUNET_ATS_solver_logging_write_to_disk(), GNUNET_ATS_TEST_logging_write_to_file(), GNUNET_BIO_flush(), GNUNET_BIO_read_close(), GNUNET_BIO_write_close(), GNUNET_CONTAINER_bloomfilter_free(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_CRYPTO_ecdsa_key_create_from_file(), GNUNET_CRYPTO_eddsa_key_create_from_file(), GNUNET_CRYPTO_hash_file_cancel(), GNUNET_DISK_file_copy(), GNUNET_DISK_fn_read(), GNUNET_DISK_fn_write(), GNUNET_DISK_pipe_close_end(), GNUNET_FRIENDS_write_stop(), GNUNET_FS_data_reader_file_(), GNUNET_FS_download_signal_suspend_(), GNUNET_FS_download_start_task_(), GNUNET_FS_handle_on_demand_block(), GNUNET_FS_unindex_signal_suspend_(), GNUNET_FS_unindex_stop(), GNUNET_OS_process_destroy(), GNUNET_TESTING_peer_configure(), GNUNET_TIME_absolute_get_monotonic(), hostkeys_load(), load_etc_hosts(), lookup_dns_servers(), main(), parent_control_handler(), print_key(), process_result_with_request(), publish_fs_connect_complete_cb(), reconstruct_cont(), REGEX_TEST_read_from_file(), restore_valid_peers(), run(), server_log(), shutdown_pch(), shutdown_task(), start_process(), stop_broadcast(), store_valid_peers(), to_file_raw(), tofile_(), try_match_block(), unindex_finish(), unload_keys(), write_benchmark_data(), write_bw_gnuplot_script(), write_rtt_gnuplot_script(), and write_throughput_gnuplot_script().

{
  int ret;

  if (h == NULL)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }

  ret = GNUNET_OK;

  if (close (h->fd) != 0)
  {
    LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "close");
    ret = GNUNET_SYSERR;
  }

  GNUNET_free (h);
  return ret;
}

GNUNET_DISK_pipe_handle()

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.

Parameters

p	pipe
n	end to access

Returns

handle for the respective end

Definition at line 1753 of file disk.c.

References GNUNET_DISK_PipeHandle::fd, GNUNET_break, GNUNET_DISK_PIPE_END_READ, and GNUNET_DISK_PIPE_END_WRITE.

Referenced by child_death_task(), GNUNET_NAT_mini_get_external_ipv4_(), GNUNET_OS_command_run(), GNUNET_SCHEDULER_driver_init(), gnunet_uri(), maint_child_death(), restart_nat_server(), run(), shutdown_pipe_cb(), sighandler_child_death(), sighandler_shutdown(), start_helper(), start_process(), tokenizer_cb(), and work().

{
  switch (n)
  {
  case GNUNET_DISK_PIPE_END_READ:
  case GNUNET_DISK_PIPE_END_WRITE:
    return p->fd[n];

  default:
    GNUNET_break (0);
    return NULL;
  }
}

Here is the caller graph for this function:

GNUNET_DISK_fix_permissions()

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.

If both argumets are GNUNET_NO, the file is made world-read-write-executable (777). Does nothing on W32.

Parameters

fn	name of the file to update
require_uid_match	GNUNET_YES means 700
require_gid_match	GNUNET_YES means 770 unless require_uid_match is set

If both argumets are GNUNET_NO, the file is made world-read-write-executable (777).

Parameters

fn	name of the file to update
require_uid_match	GNUNET_YES means 700
require_gid_match	GNUNET_YES means 770 unless require_uid_match is set

Definition at line 379 of file disk.c.

References GNUNET_ERROR_TYPE_WARNING, GNUNET_log_strerror_file, GNUNET_YES, and mode.

Referenced by create_listen_socket(), LEGACY_SERVICE_start(), and service_task().

{
  mode_t mode;

  if (GNUNET_YES == require_uid_match)
    mode = S_IRUSR | S_IWUSR | S_IXUSR;
  else if (GNUNET_YES == require_gid_match)
    mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP;
  else
    mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH
           | S_IWOTH | S_IXOTH;
  if (0 != chmod (fn, mode))
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "chmod", fn);
}

Here is the caller graph for this function:

GNUNET_DISK_get_handle_from_int_fd()

struct GNUNET_DISK_FileHandle* GNUNET_DISK_get_handle_from_int_fd

(

int

fno

)

Get a handle from a native integer FD.

Parameters

fno	native integer file descriptor

Returns

file handle corresponding to the descriptor

Parameters

fno	native integer file descriptor

Returns

file handle corresponding to the descriptor, NULL on error

Definition at line 1375 of file disk.c.

References GNUNET_DISK_FileHandle::fd, fh, and GNUNET_new.

Referenced by extract_handles(), GNUNET_DISK_get_handle_from_native(), GNUNET_OS_install_parent_control_handler(), main(), start_dump(), and start_insert().

{
  struct GNUNET_DISK_FileHandle *fh;

  if ((((off_t) -1) == lseek (fno, 0, SEEK_CUR)) && (EBADF == errno))
    return NULL; /* invalid FD */

  fh = GNUNET_new (struct GNUNET_DISK_FileHandle);

  fh->fd = fno;

  return fh;
}

Here is the caller graph for this function:

GNUNET_DISK_get_handle_from_native()

struct GNUNET_DISK_FileHandle* GNUNET_DISK_get_handle_from_native

(

FILE *

fd

)

Get a handle from a native FD.

Parameters

fd	native file descriptor

Returns

file handle corresponding to the descriptor

Get a handle from a native FD.

Parameters

fd	native streaming file descriptor

Returns

file handle corresponding to the descriptor

Definition at line 1397 of file disk.c.

References GNUNET_DISK_get_handle_from_int_fd().

Referenced by run(), and testing_main().

{
  int fno;

  fno = fileno (fd);
  if (-1 == fno)
    return NULL;

  return GNUNET_DISK_get_handle_from_int_fd (fno);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_read()

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.

Parameters

h	handle to an open file
result	the buffer to write the result to
len	the maximum number of bytes to read

Returns

the number of bytes read on success, GNUNET_SYSERR on failure

Definition at line 732 of file disk.c.

References GNUNET_DISK_FileHandle::fd, and GNUNET_SYSERR.

Referenced by child_death_task(), cmd_read(), database_setup(), decrementBit(), fh_reader(), file_hash_task(), GNUNET_BIO_read(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_CRYPTO_ecdsa_key_create_from_file(), GNUNET_CRYPTO_eddsa_key_create_from_file(), GNUNET_DISK_file_copy(), GNUNET_DISK_fn_read(), GNUNET_FS_data_reader_file_(), GNUNET_FS_handle_on_demand_block(), helper_read(), incrementBit(), main(), maint_child_death(), nat_server_read(), parent_control_handler(), print_key(), put_cb(), read_external_ipv4(), read_task(), REGEX_TEST_read_from_file(), restore_valid_peers(), run(), server_log(), shutdown_pipe_cb(), start_insert(), try_top_down_reconstruction(), and unindex_reader().

{
  if (NULL == h)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }

  return read (h->fd, result, len);
}

Here is the caller graph for this function:

GNUNET_DISK_file_read_non_blocking()

ssize_t GNUNET_DISK_file_read_non_blocking	(	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 when no data can be read).

Parameters

h	handle to an open file
result	the buffer to write the result to
len	the maximum number of bytes to read

Returns

the number of bytes read on success, GNUNET_SYSERR on failure

Definition at line 757 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_SYSERR, and ret.

{
  if (NULL == h)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }

  int flags;
  ssize_t ret;

  /* set to non-blocking, read, then set back */
  flags = fcntl (h->fd, F_GETFL);
  if (0 == (flags & O_NONBLOCK))
    (void) fcntl (h->fd, F_SETFL, flags | O_NONBLOCK);
  ret = read (h->fd, result, len);
  if (0 == (flags & O_NONBLOCK))
  {
    int eno = errno;
    (void) fcntl (h->fd, F_SETFL, flags);
    errno = eno;
  }
  return ret;
}

GNUNET_DISK_fn_read()

ssize_t GNUNET_DISK_fn_read	(	const char *	fn,
		void *	result,
		size_t	len
	)

Read the contents of a binary file into a buffer.

Parameters

fn	file name
result	the buffer to write the result to
len	the maximum number of bytes to read

Returns

number of bytes read, GNUNET_SYSERR on failure

Definition at line 794 of file disk.c.

References fh, GNUNET_assert, GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_read(), GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE, GNUNET_OK, GNUNET_SYSERR, and ret.

Referenced by discard_hosts_helper(), ego_callback(), gen_topo_from_file(), GNUNET_CONFIGURATION_parse(), GNUNET_FRIENDS_parse(), GNUNET_TESTBED_hosts_load_from_file(), load_file(), load_search_strings(), policy_filename_cb(), read_host_file(), run(), and setup_ac().

{
  struct GNUNET_DISK_FileHandle *fh;
  ssize_t ret;
  int eno;

  fh = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE);
  if (NULL == fh)
    return GNUNET_SYSERR;
  ret = GNUNET_DISK_file_read (fh, result, len);
  eno = errno;
  GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
  errno = eno;
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_write()

ssize_t GNUNET_DISK_file_write	(	const struct GNUNET_DISK_FileHandle *	h,
		const void *	buffer,
		size_t	n
	)

Write a buffer to a file.

Parameters

h	handle to open file
buffer	the data to write
n	number of bytes to write

Returns

number of bytes written on success, GNUNET_SYSERR on error

Definition at line 820 of file disk.c.

References GNUNET_DISK_FileHandle::fd, and GNUNET_SYSERR.

Referenced by create_hostkeys(), database_shutdown(), decrementBit(), do_shutdown(), get_cb(), GNUNET_ATS_solver_logging_write_to_disk(), GNUNET_ATS_TEST_logging_write_to_file(), GNUNET_BIO_flush(), GNUNET_CRYPTO_ecdsa_key_create_from_file(), GNUNET_CRYPTO_eddsa_key_create_from_file(), GNUNET_DISK_file_copy(), GNUNET_DISK_fn_write(), GNUNET_FRIENDS_write(), GNUNET_OS_process_kill(), GNUNET_TESTING_peer_configure(), GNUNET_TIME_absolute_get_monotonic(), handle_estimate(), helper_write(), incrementBit(), main(), make_empty_file(), process_result_with_request(), publicize_rm(), publish_fs_connect_complete_cb(), regex_found_handler(), sighandler_child_death(), sighandler_shutdown(), start_dump(), stat_iterator(), stats_iterator(), store_and_free_entries(), store_peer_presistently_iterator(), to_file_raw(), tofile_(), try_match_block(), write_bw_gnuplot_script(), write_rtt_gnuplot_script(), write_task(), and write_throughput_gnuplot_script().

{
  if (NULL == h)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }


  return write (h->fd, buffer, n);
}

Here is the caller graph for this function:

GNUNET_DISK_file_write_blocking()

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.

Parameters

h	handle to open file
buffer	the data to write
n	number of bytes to write

Returns

number of bytes written on success, GNUNET_SYSERR on error

Definition at line 844 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_SYSERR, and ret.

Referenced by write_benchmark_data().

{
  if (NULL == h)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }


  int flags;
  ssize_t ret;

  /* set to blocking, write, then set back */
  flags = fcntl (h->fd, F_GETFL);
  if (0 != (flags & O_NONBLOCK))
    (void) fcntl (h->fd, F_SETFL, flags - O_NONBLOCK);
  ret = write (h->fd, buffer, n);
  if (0 == (flags & O_NONBLOCK))
    (void) fcntl (h->fd, F_SETFL, flags);
  return ret;
}

Here is the caller graph for this function:

GNUNET_DISK_fn_write()

ssize_t GNUNET_DISK_fn_write	(	const char *	fn,
		const void *	buffer,
		size_t	n,
		enum GNUNET_DISK_AccessPermissions	mode
	)

Write a buffer to a file.

If the file is longer than the given buffer size, it will be truncated.

Parameters

fn	file name
buffer	the data to write
n	number of bytes to write
mode	file permissions

Returns

number of bytes written on success, GNUNET_SYSERR on error

If the file is longer than the number of bytes that will be written, it will be truncated.

Parameters

fn	file name
buffer	the data to write
n	number of bytes to write
mode	file permissions

Returns

number of bytes written on success, GNUNET_SYSERR on error

Definition at line 880 of file disk.c.

References fh, GNUNET_assert, GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_write(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_TRUNCATE, GNUNET_DISK_OPEN_WRITE, GNUNET_OK, GNUNET_SYSERR, and ret.

Referenced by calculate_pow(), clean_task(), discard_hosts_helper(), dump_my_hello(), GNUNET_CONFIGURATION_write(), GNUNET_FRIENDS_parse(), handle_create_message(), main(), shutdown_task(), sync_rd(), update_hello(), and write_proof().

{
  struct GNUNET_DISK_FileHandle *fh;
  ssize_t ret;

  fh =
    GNUNET_DISK_file_open (fn,
                           GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_TRUNCATE
                           | GNUNET_DISK_OPEN_CREATE,
                           mode);
  if (! fh)
    return GNUNET_SYSERR;
  ret = GNUNET_DISK_file_write (fh, buffer, n);
  GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_copy()

int GNUNET_DISK_file_copy	(	const char *	src,
		const char *	dst
	)

Copy a file.

Parameters

src	file to copy
dst	destination file name

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1072 of file disk.c.

References buf, COPY_BLK_SIZE, FAIL, GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_read(), GNUNET_DISK_file_size(), GNUNET_DISK_file_write(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_FAILIFEXISTS, GNUNET_DISK_OPEN_READ, GNUNET_DISK_OPEN_WRITE, GNUNET_DISK_PERM_GROUP_READ, GNUNET_DISK_PERM_GROUP_WRITE, GNUNET_DISK_PERM_NONE, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log_strerror_file, GNUNET_malloc, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, len, and size.

{
  char *buf;
  uint64_t pos;
  uint64_t size;
  size_t len;
  ssize_t sret;
  struct GNUNET_DISK_FileHandle *in;
  struct GNUNET_DISK_FileHandle *out;

  if (GNUNET_OK != GNUNET_DISK_file_size (src, &size, GNUNET_YES, GNUNET_YES))
  {
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "stat", src);
    return GNUNET_SYSERR;
  }
  pos = 0;
  in =
    GNUNET_DISK_file_open (src, GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE);
  if (! in)
  {
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", src);
    return GNUNET_SYSERR;
  }
  out =
    GNUNET_DISK_file_open (dst,
                           GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_CREATE
                           | GNUNET_DISK_OPEN_FAILIFEXISTS,
                           GNUNET_DISK_PERM_USER_READ
                           | GNUNET_DISK_PERM_USER_WRITE
                           | GNUNET_DISK_PERM_GROUP_READ
                           | GNUNET_DISK_PERM_GROUP_WRITE);
  if (! out)
  {
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", dst);
    GNUNET_DISK_file_close (in);
    return GNUNET_SYSERR;
  }
  buf = GNUNET_malloc (COPY_BLK_SIZE);
  while (pos < size)
  {
    len = COPY_BLK_SIZE;
    if (len > size - pos)
      len = size - pos;
    sret = GNUNET_DISK_file_read (in, buf, len);
    if ((sret < 0) || (len != (size_t) sret))
      goto FAIL;
    sret = GNUNET_DISK_file_write (out, buf, len);
    if ((sret < 0) || (len != (size_t) sret))
      goto FAIL;
    pos += len;
  }
  GNUNET_free (buf);
  GNUNET_DISK_file_close (in);
  GNUNET_DISK_file_close (out);
  return GNUNET_OK;
FAIL:
  GNUNET_free (buf);
  GNUNET_DISK_file_close (in);
  GNUNET_DISK_file_close (out);
  return GNUNET_SYSERR;
}

Here is the call graph for this function:

GNUNET_DISK_directory_scan()

int GNUNET_DISK_directory_scan	(	const char *	dir_name,
		GNUNET_FileNameCallback	callback,
		void *	callback_cls
	)

Scan a directory for files.

Parameters

dir_name	the name of the directory
callback	the method to call for each file
callback_cls	closure for callback

Returns

the number of files found, -1 on error

Parameters

dir_name	the name of the directory
callback	the method to call for each file, can be NULL, in that case, we only count
callback_cls	closure for callback

Returns

the number of files found, GNUNET_SYSERR on error or ieration aborted by callback returning GNUNET_SYSERR

Definition at line 912 of file disk.c.

References _, DIR_SEPARATOR, DIR_SEPARATOR_STR, GNUNET_assert, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_malloc, GNUNET_NO, GNUNET_OK, GNUNET_snprintf(), GNUNET_STRINGS_filename_expand(), GNUNET_SYSERR, LOG, LOG_STRERROR_FILE, name, and ret.

Referenced by cron_clean_data_hosts(), cron_scan_directory_data_hosts(), deserialization_master(), deserialize_download(), deserialize_search(), determine_id(), discover_testbed_nodes(), do_directory_scan(), getSizeRec(), GNUNET_CONFIGURATION_load_from(), GNUNET_DISK_directory_remove(), GNUNET_PLUGIN_load_all(), iter_testbed_path(), preprocess_file(), profiler_eval(), run(), and scan().

{
  DIR *dinfo;
  struct dirent *finfo;
  struct stat istat;
  int count = 0;
  int ret;
  char *name;
  char *dname;
  unsigned int name_len;
  unsigned int n_size;

  GNUNET_assert (NULL != dir_name);
  dname = GNUNET_STRINGS_filename_expand (dir_name);
  if (NULL == dname)
    return GNUNET_SYSERR;
  while ((strlen (dname) > 0) && (dname[strlen (dname) - 1] == DIR_SEPARATOR))
    dname[strlen (dname) - 1] = '\0';
  if (0 != stat (dname, &istat))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "stat", dname);
    GNUNET_free (dname);
    return GNUNET_SYSERR;
  }
  if (! S_ISDIR (istat.st_mode))
  {
    LOG (GNUNET_ERROR_TYPE_WARNING,
         _ ("Expected `%s' to be a directory!\n"),
         dir_name);
    GNUNET_free (dname);
    return GNUNET_SYSERR;
  }
  errno = 0;
  dinfo = opendir (dname);
  if ((EACCES == errno) || (NULL == dinfo))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "opendir", dname);
    if (NULL != dinfo)
      closedir (dinfo);
    GNUNET_free (dname);
    return GNUNET_SYSERR;
  }
  name_len = 256;
  n_size = strlen (dname) + name_len + strlen (DIR_SEPARATOR_STR) + 1;
  name = GNUNET_malloc (n_size);
  while (NULL != (finfo = readdir (dinfo)))
  {
    if ((0 == strcmp (finfo->d_name, ".")) ||
        (0 == strcmp (finfo->d_name, "..")))
      continue;
    if (NULL != callback)
    {
      if (name_len < strlen (finfo->d_name))
      {
        GNUNET_free (name);
        name_len = strlen (finfo->d_name);
        n_size = strlen (dname) + name_len + strlen (DIR_SEPARATOR_STR) + 1;
        name = GNUNET_malloc (n_size);
      }
      /* dname can end in "/" only if dname == "/";
       * if dname does not end in "/", we need to add
       * a "/" (otherwise, we must not!) */
      GNUNET_snprintf (name,
                       n_size,
                       "%s%s%s",
                       dname,
                       (0 == strcmp (dname, DIR_SEPARATOR_STR))
                       ? ""
                       : DIR_SEPARATOR_STR,
                       finfo->d_name);
      ret = callback (callback_cls, name);
      if (GNUNET_OK != ret)
      {
        closedir (dinfo);
        GNUNET_free (name);
        GNUNET_free (dname);
        if (GNUNET_NO == ret)
          return count;
        return GNUNET_SYSERR;
      }
    }
    count++;
  }
  closedir (dinfo);
  GNUNET_free (name);
  GNUNET_free (dname);
  return count;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_directory_create_for_file()

int GNUNET_DISK_directory_create_for_file

(

const char *

filename

)

Create the directory structure for storing a file.

Parameters

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

Parameters

filename

name of a file in the directory

Returns

GNUNET_OK on success, GNUNET_SYSERR on failure, GNUNET_NO if the directory exists but is not writeable for us

Definition at line 684 of file disk.c.

References DIR_SEPARATOR, GNUNET_DISK_directory_create(), GNUNET_free, GNUNET_NO, GNUNET_OK, GNUNET_strdup, GNUNET_STRINGS_filename_expand(), GNUNET_SYSERR, len, and ret.

Referenced by create_hostkeys(), database_setup(), get_server_addresses(), GNUNET_ATS_solver_logging_write_to_disk(), GNUNET_CONFIGURATION_write(), GNUNET_CRYPTO_ecdsa_key_create_from_file(), GNUNET_CRYPTO_eddsa_key_create_from_file(), GNUNET_DISK_file_open(), GNUNET_FRIENDS_parse(), GNUNET_FRIENDS_write_start(), GNUNET_FS_download_sync_(), handle_create_message(), LEGACY_SERVICE_get_server_addresses(), main(), make_serialization_file_name(), make_serialization_file_name_in_dir(), run(), save(), save_hostlist_file(), setup_log_file(), store_valid_peers(), trigger_recursive_download(), unix_transport_server_start(), and update_hello().

{
  char *rdir;
  size_t len;
  int ret;
  int eno;

  rdir = GNUNET_STRINGS_filename_expand (filename);
  if (NULL == rdir)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }
  if (0 == access (rdir, W_OK))
  {
    GNUNET_free (rdir);
    return GNUNET_OK;
  }

  len = strlen (rdir);
  while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
    len--;
  rdir[len] = '\0';
  /* The empty path is invalid and in this case refers to / */
  if (0 == len)
  {
    GNUNET_free (rdir);
    rdir = GNUNET_strdup ("/");
  }
  ret = GNUNET_DISK_directory_create (rdir);
  if ((GNUNET_OK == ret) && (0 != access (rdir, W_OK)))
    ret = GNUNET_NO;
  eno = errno;
  GNUNET_free (rdir);
  errno = eno;
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_directory_test()

int GNUNET_DISK_directory_test	(	const char *	fil,
		int	is_readable
	)

Test if 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).

Parameters

fil	filename to test
is_readable	GNUNET_YES to additionally check if fil is readable; GNUNET_NO to disable this check

Returns

GNUNET_YES if yes, GNUNET_NO if not; GNUNET_SYSERR if it does not exist or stated

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).

Parameters

fil	filename to test
is_readable	GNUNET_YES to additionally check if fil is readable; GNUNET_NO to disable this check

Returns

GNUNET_YES if yes, GNUNET_NO if not; GNUNET_SYSERR if it does not exist or stat'ed

Definition at line 503 of file disk.c.

References GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_NO, GNUNET_SYSERR, GNUNET_YES, LOG, LOG_STRERROR_FILE, and ret.

Referenced by deserialization_master(), deserialize_download(), deserialize_search(), GNUNET_DISK_directory_create(), GNUNET_DISK_directory_remove(), GNUNET_FS_remove_sync_dir_(), GNUNET_OS_installation_get_path(), and run().

{
  struct stat filestat;
  int ret;

  ret = stat (fil, &filestat);
  if (ret != 0)
  {
    if (errno != ENOENT)
      LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "stat", fil);
    return GNUNET_SYSERR;
  }
  if (! S_ISDIR (filestat.st_mode))
  {
    LOG (GNUNET_ERROR_TYPE_INFO,
         "A file already exits with the same name %s\n",
         fil);
    return GNUNET_NO;
  }
  if (GNUNET_YES == is_readable)
    ret = access (fil, R_OK | X_OK);
  else
    ret = access (fil, X_OK);
  if (ret < 0)
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "access", fil);
    return GNUNET_NO;
  }
  return GNUNET_YES;
}

Here is the caller graph for this function:

GNUNET_DISK_directory_remove()

int GNUNET_DISK_directory_remove

(

const char *

filename

)

Remove all files in a directory (rm -rf).

Call with caution.

Parameters

filename

the file to remove

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Remove all files in a directory (rm -rf).

Call with caution.

Parameters

filename

the file to remove

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1029 of file disk.c.

References GNUNET_break, GNUNET_DISK_directory_scan(), GNUNET_DISK_directory_test(), GNUNET_ERROR_TYPE_WARNING, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, LOG_STRERROR_FILE, and remove_helper().

Referenced by access_handler_callback(), delete_files(), GNUNET_FS_remove_sync_dir_(), GNUNET_TESTING_system_destroy(), publish_timeout(), purge_cfg_dir(), remove_helper(), report_uri(), and run().

{
  struct stat istat;

  if (NULL == filename)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  if (0 != lstat (filename, &istat))
    return GNUNET_NO; /* file may not exist... */
  (void) chmod (filename, S_IWUSR | S_IRUSR | S_IXUSR);
  if (0 == unlink (filename))
    return GNUNET_OK;
  if ((errno != EISDIR) &&
      /* EISDIR is not sufficient in all cases, e.g.
      * sticky /tmp directory may result in EPERM on BSD.
      * So we also explicitly check "isDirectory" */
      (GNUNET_YES != GNUNET_DISK_directory_test (filename, GNUNET_YES)))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "rmdir", filename);
    return GNUNET_SYSERR;
  }
  if (GNUNET_SYSERR ==
      GNUNET_DISK_directory_scan (filename, &remove_helper, NULL))
    return GNUNET_SYSERR;
  if (0 != rmdir (filename))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "rmdir", filename);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_purge_cfg_dir()

void GNUNET_DISK_purge_cfg_dir	(	const char *	cfg_filename,
		const char *	option
	)

Remove the directory given under option in section [PATHS] in configuration under cfg_filename.

Parameters

cfg_filename	configuration file to parse
option	option with the dir name to purge

Definition at line 1831 of file disk.c.

References GNUNET_break, GNUNET_CONFIGURATION_parse_and_run(), GNUNET_OK, and purge_cfg_dir().

{
  GNUNET_break (GNUNET_OK ==
                GNUNET_CONFIGURATION_parse_and_run (cfg_filename,
                                                    &purge_cfg_dir,
                                                    (void *) option));
}

Here is the call graph for this function:

GNUNET_DISK_directory_create()

int GNUNET_DISK_directory_create

(

const char *

dir

)

Implementation of "mkdir -p".

Parameters

dir	the directory to create

Returns

GNUNET_SYSERR on failure, GNUNET_OK otherwise

Parameters

dir	the directory to create

Returns

GNUNET_OK on success, GNUNET_SYSERR on failure

Definition at line 589 of file disk.c.

References DIR_SEPARATOR, GNUNET_break, GNUNET_DISK_directory_test(), GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log, GNUNET_NO, GNUNET_OK, GNUNET_STRINGS_filename_expand(), GNUNET_SYSERR, GNUNET_YES, len, LOG_STRERROR_FILE, and ret.

Referenced by cron_scan_directory_data_hosts(), ensure_folder_exist(), GNUNET_DISK_directory_create_for_file(), run(), write_benchmark_data(), and write_pid_file().

{
  char *rdir;
  unsigned int len;
  unsigned int pos;
  unsigned int pos2;
  int ret = GNUNET_OK;

  rdir = GNUNET_STRINGS_filename_expand (dir);
  if (rdir == NULL)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }

  len = strlen (rdir);

  pos = 1; /* skip heading '/' */

  /* Check which low level directories already exist */
  pos2 = len;
  rdir[len] = DIR_SEPARATOR;
  while (pos <= pos2)
  {
    if (DIR_SEPARATOR == rdir[pos2])
    {
      rdir[pos2] = '\0';
      ret = GNUNET_DISK_directory_test (rdir, GNUNET_NO);
      if (GNUNET_NO == ret)
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    "Creating directory `%s' failed",
                    rdir);
        GNUNET_free (rdir);
        return GNUNET_SYSERR;
      }
      rdir[pos2] = DIR_SEPARATOR;
      if (GNUNET_YES == ret)
      {
        pos2++;
        break;
      }
    }
    pos2--;
  }
  rdir[len] = '\0';
  if (pos < pos2)
    pos = pos2;
  /* Start creating directories */
  while (pos <= len)
  {
    if ((rdir[pos] == DIR_SEPARATOR) || (pos == len))
    {
      rdir[pos] = '\0';
      ret = GNUNET_DISK_directory_test (rdir, GNUNET_NO);
      if (GNUNET_NO == ret)
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    "Creating directory `%s' failed",
                    rdir);
        GNUNET_free (rdir);
        return GNUNET_SYSERR;
      }
      if (GNUNET_SYSERR == ret)
      {
        ret = mkdir (rdir,
                     S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH
                     | S_IXOTH);    /* 755 */

        if ((ret != 0) && (errno != EEXIST))
        {
          LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkdir", rdir);
          GNUNET_free (rdir);
          return GNUNET_SYSERR;
        }
      }
      rdir[pos] = DIR_SEPARATOR;
    }
    pos++;
  }
  GNUNET_free (rdir);
  return GNUNET_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_DISK_file_lock()

int GNUNET_DISK_file_lock	(	struct GNUNET_DISK_FileHandle *	fh,
		off_t	lock_start,
		off_t	lock_end,
		int	excl
	)

Lock a part of a file.

Parameters

fh	file handle
lock_start	absolute position from where to lock
lock_end	absolute position until where to lock
excl	GNUNET_YES for an exclusive lock

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1201 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_OK, and GNUNET_SYSERR.

Referenced by GNUNET_CRYPTO_ecdsa_key_create_from_file(), and GNUNET_CRYPTO_eddsa_key_create_from_file().

{
  if (fh == NULL)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }

  struct flock fl;

  memset (&fl, 0, sizeof(struct flock));
  fl.l_type = excl ? F_WRLCK : F_RDLCK;
  fl.l_whence = SEEK_SET;
  fl.l_start = lock_start;
  fl.l_len = lock_end;

  return fcntl (fh->fd, F_SETLK, &fl) != 0 ? GNUNET_SYSERR : GNUNET_OK;
}

Here is the caller graph for this function:

GNUNET_DISK_file_unlock()

int GNUNET_DISK_file_unlock	(	struct GNUNET_DISK_FileHandle *	fh,
		off_t	unlock_start,
		off_t	unlock_end
	)

Unlock a part of a file.

Parameters

fh	file handle
unlock_start	absolute position from where to unlock
unlock_end	absolute position until where to unlock

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1233 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_OK, and GNUNET_SYSERR.

Referenced by GNUNET_CRYPTO_ecdsa_key_create_from_file(), and GNUNET_CRYPTO_eddsa_key_create_from_file().

{
  if (fh == NULL)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }

  struct flock fl;

  memset (&fl, 0, sizeof(struct flock));
  fl.l_type = F_UNLCK;
  fl.l_whence = SEEK_SET;
  fl.l_start = unlock_start;
  fl.l_len = unlock_end;

  return fcntl (fh->fd, F_SETLK, &fl) != 0 ? GNUNET_SYSERR : GNUNET_OK;
}

Here is the caller graph for this function:

GNUNET_DISK_filename_canonicalize()

void GNUNET_DISK_filename_canonicalize

(

char *

fn

)

Removes special characters as ':' from a filename.

Parameters

fn	the filename to canonicalize

Definition at line 1140 of file disk.c.

Referenced by progress_cb().

{
  char *idx;
  char c;

  for (idx = fn; *idx; idx++)
  {
    c = *idx;

    if ((c == '/') || (c == '\\') || (c == ':') || (c == '*') || (c == '?') ||
        (c ==
         '"')
        ||
        (c == '<') || (c == '>') || (c == '|') )
    {
      *idx = '_';
    }
  }
}

Here is the caller graph for this function:

GNUNET_DISK_file_change_owner()

int GNUNET_DISK_file_change_owner	(	const char *	filename,
		const char *	user
	)

Change owner of a file.

Parameters

filename	file to change
user	new owner of the file

Returns

GNUNET_OK on success, GNUNET_SYSERR on failure

Parameters

filename	name of file to change the owner of
user	name of the new owner

Returns

GNUNET_OK on success, GNUNET_SYSERR on failure

Definition at line 1169 of file disk.c.

References _, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_OK, GNUNET_SYSERR, LOG, and LOG_STRERROR_FILE.

Referenced by write_pid_file().

{
  struct passwd *pws;

  pws = getpwnam (user);
  if (NULL == pws)
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         _ ("Cannot obtain information about user `%s': %s\n"),
         user,
         strerror (errno));
    return GNUNET_SYSERR;
  }
  if (0 != chown (filename, pws->pw_uid, pws->pw_gid))
  {
    LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "chown", filename);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

Here is the caller graph for this function:

GNUNET_DISK_file_map()

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.

Parameters

h	open file handle
m	handle to the new mapping (will be set)
access	access specification, GNUNET_DISK_MAP_TYPE_xxx
len	size of the mapping

Returns

pointer to the mapped memory region, NULL on failure

Parameters

h	open file handle
m	handle to the new mapping
access	access specification, GNUNET_DISK_MAP_TYPE_xxx
len	size of the mapping

Returns

pointer to the mapped memory region, NULL on failure

Definition at line 1440 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_assert, GNUNET_DISK_MAP_TYPE_READ, GNUNET_DISK_MAP_TYPE_WRITE, GNUNET_free, GNUNET_new, len, and MAP_FAILED.

Referenced by database_setup(), full_recursive_download(), GNUNET_TIME_absolute_get_monotonic(), hostkeys_load(), load_etc_hosts(), load_keys(), lookup_dns_servers(), and run().

{
  if (NULL == h)
  {
    errno = EINVAL;
    return NULL;
  }

  int prot;

  prot = 0;
  if (access & GNUNET_DISK_MAP_TYPE_READ)
    prot = PROT_READ;
  if (access & GNUNET_DISK_MAP_TYPE_WRITE)
    prot |= PROT_WRITE;
  *m = GNUNET_new (struct GNUNET_DISK_MapHandle);
  (*m)->addr = mmap (NULL, len, prot, MAP_SHARED, h->fd, 0);
  GNUNET_assert (NULL != (*m)->addr);
  if (MAP_FAILED == (*m)->addr)
  {
    GNUNET_free (*m);
    return NULL;
  }
  (*m)->len = len;
  return (*m)->addr;
}

Here is the caller graph for this function:

GNUNET_DISK_file_unmap()

int GNUNET_DISK_file_unmap

(

struct GNUNET_DISK_MapHandle *

h

)

Unmap a file.

Parameters

h	mapping handle

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Parameters

h	mapping handle

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1477 of file disk.c.

References GNUNET_DISK_MapHandle::addr, GNUNET_free, GNUNET_OK, GNUNET_SYSERR, GNUNET_DISK_MapHandle::len, and ret.

Referenced by database_setup(), full_recursive_download(), GNUNET_TIME_absolute_get_monotonic(), hostkeys_unload(), load_etc_hosts(), lookup_dns_servers(), run(), and unload_keys().

{
  int ret;

  if (h == NULL)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }

  ret = munmap (h->addr, h->len) != -1 ? GNUNET_OK : GNUNET_SYSERR;

  GNUNET_free (h);
  return ret;
}

Here is the caller graph for this function:

GNUNET_DISK_file_sync()

int GNUNET_DISK_file_sync

(

const struct GNUNET_DISK_FileHandle *

h

)

Write file changes to disk.

Parameters

h	handle to an open file

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Parameters

h	handle to an open file

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1500 of file disk.c.

References GNUNET_DISK_FileHandle::fd, GNUNET_OK, and GNUNET_SYSERR.

Referenced by GNUNET_CRYPTO_ecdsa_key_create_from_file(), GNUNET_CRYPTO_eddsa_key_create_from_file(), and publicize_rm().

{
  if (h == NULL)
  {
    errno = EINVAL;
    return GNUNET_SYSERR;
  }

#if defined(FREEBSD) || defined(OPENBSD) || defined(DARWIN)
  return fsync (h->fd) == -1 ? GNUNET_SYSERR : GNUNET_OK;
#else
  return fdatasync (h->fd) == -1 ? GNUNET_SYSERR : GNUNET_OK;
#endif
}

Here is the caller graph for this function: