GNUnet 0.24.1-15-gab6ed22f1
Disk library

Disk IO APIs. More...

Collaboration diagram for Disk library:

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...
 
enum  GNUNET_DISK_PipeFlags { GNUNET_DISK_PF_NONE , GNUNET_DISK_PF_BLOCKING_READ = 1 , GNUNET_DISK_PF_BLOCKING_WRITE = 2 , GNUNET_DISK_PF_BLOCKING_RW }
 Flags for GNUNET_DISK_pipe(). More...
 

Functions

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_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...
 
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...
 
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...
 
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_FileHandleGNUNET_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_handle_size (struct GNUNET_DISK_FileHandle *fh, off_t *size)
 Get the size of an open file. More...
 
struct GNUNET_DISK_PipeHandleGNUNET_DISK_pipe (enum GNUNET_DISK_PipeFlags pf)
 Creates an interprocess channel. More...
 
struct GNUNET_DISK_PipeHandleGNUNET_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 (struct GNUNET_DISK_PipeHandle *p)
 Closes an interprocess channel. 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_FileHandleGNUNET_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_file_close (struct GNUNET_DISK_FileHandle *h)
 Close an open file. More...
 
const struct GNUNET_DISK_FileHandleGNUNET_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_FileHandleGNUNET_DISK_get_handle_from_int_fd (int fno)
 Get a handle from a native integer FD. More...
 
struct GNUNET_DISK_FileHandleGNUNET_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_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...
 
enum GNUNET_GenericReturnValue 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_glob (const char *glob_pattern, GNUNET_FileNameCallback callback, void *callback_cls)
 Find all files matching a glob pattern. More...
 
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create_for_file (const char *filename)
 Create the directory structure for storing a file. More...
 
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_test (const char *fil, int is_readable)
 Test if fil is a directory and listable. More...
 
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_remove (const char *filename)
 Remove all files in a directory (rm -rf). 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...
 
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create (const char *dir)
 Implementation of "mkdir -p". 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...
 
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...
 

Detailed Description

Disk IO APIs.

Enumeration Type Documentation

◆ 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 50 of file gnunet_disk_lib.h.

51{
56
61
66};
@ GNUNET_DISK_HANLDE_TYPE_FILE
Handle represents a file.
@ GNUNET_DISK_HANLDE_TYPE_PIPE
Handle represents a pipe.
@ GNUNET_DISK_HANLDE_TYPE_EVENT
Handle represents an event.

◆ 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 101 of file gnunet_disk_lib.h.

102{
107
112
117
122
127
132
137};
@ GNUNET_DISK_OPEN_READ
Open the file for reading.
@ GNUNET_DISK_OPEN_FAILIFEXISTS
Fail if file already exists.
@ GNUNET_DISK_OPEN_WRITE
Open the file for writing.
@ 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.
@ GNUNET_DISK_OPEN_READWRITE
Open the file for both reading and writing.

◆ 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 142 of file gnunet_disk_lib.h.

143{
148
153
158};
@ GNUNET_DISK_MAP_TYPE_WRITE
Write-able memory map.
@ GNUNET_DISK_MAP_TYPE_READ
Read-only memory map.
@ GNUNET_DISK_MAP_TYPE_READWRITE
Read-write memory map.

◆ 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 164 of file gnunet_disk_lib.h.

165{
170
175
180
185
190
195
200
205
210
215};
@ GNUNET_DISK_PERM_OTHER_EXEC
Everybody can execute.
@ GNUNET_DISK_PERM_USER_EXEC
Owner can execute.
@ GNUNET_DISK_PERM_USER_READ
Owner can read.
@ GNUNET_DISK_PERM_NONE
Nobody is allowed to do anything to the file.
@ GNUNET_DISK_PERM_GROUP_READ
Group can read.
@ GNUNET_DISK_PERM_GROUP_EXEC
Group can execute.
@ GNUNET_DISK_PERM_GROUP_WRITE
Group can write.
@ GNUNET_DISK_PERM_USER_WRITE
Owner can write.
@ GNUNET_DISK_PERM_OTHER_READ
Everybody can read.
@ GNUNET_DISK_PERM_OTHER_WRITE
Everybody can write.

◆ 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 222 of file gnunet_disk_lib.h.

223{
228
233
238};
@ 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.

◆ 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 244 of file gnunet_disk_lib.h.

245{
250
255};
@ GNUNET_DISK_PIPE_END_WRITE
The writing-end of a pipe.
@ GNUNET_DISK_PIPE_END_READ
The reading-end of a pipe.

◆ GNUNET_DISK_PipeFlags

Flags for GNUNET_DISK_pipe().

Enumerator
GNUNET_DISK_PF_NONE 

No special options, use non-blocking read/write operations.

GNUNET_DISK_PF_BLOCKING_READ 

Configure read end to block when reading if set.

GNUNET_DISK_PF_BLOCKING_WRITE 

Configure write end to block when writing if set.

GNUNET_DISK_PF_BLOCKING_RW 

Configure both pipe ends for blocking operations if set.

Definition at line 419 of file gnunet_disk_lib.h.

420{
421
426
431
436
442
443};
@ GNUNET_DISK_PF_NONE
No special options, use non-blocking read/write operations.
@ GNUNET_DISK_PF_BLOCKING_WRITE
Configure write end to block when writing if set.
@ GNUNET_DISK_PF_BLOCKING_RW
Configure both pipe ends for blocking operations if set.
@ GNUNET_DISK_PF_BLOCKING_READ
Configure read end to block when reading if set.

Function Documentation

◆ GNUNET_DISK_handle_invalid()

enum GNUNET_GenericReturnValue GNUNET_DISK_handle_invalid ( const struct GNUNET_DISK_FileHandle h)

Checks whether a handle is invalid.

Parameters
hhandle to check
Returns
GNUNET_YES if invalid, GNUNET_NO if valid

Definition at line 189 of file disk.c.

190{
191 return ((! h) || (h->fd == -1)) ? GNUNET_YES : GNUNET_NO;
192}
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:98
@ GNUNET_YES
@ GNUNET_NO

References GNUNET_NO, GNUNET_YES, and h.

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

Here is the caller graph for this function:

◆ GNUNET_DISK_file_test()

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

Parameters
filfilename 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 523 of file disk.c.

524{
525 return file_test_internal (fil, F_OK);
526}
static enum GNUNET_GenericReturnValue file_test_internal(const char *fil, int amode)
Check if fil can be accessed using amode.
Definition: disk.c:484

References file_test_internal().

Referenced by callback_scan_for_operations(), create_download_context(), create_unique_cfgs(), database_connect(), database_setup(), ego_callback(), get_path_from_PATH(), get_topo_string_from_file(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_DISK_file_open(), GNUNET_FS_download_start_task_(), GNUNET_HOSTLIST_client_start(), GNUNET_PROGRAM_conf_and_options(), GNUNET_PROGRAM_run2(), GNUNET_SERVICE_run_(), GNUNET_TRANSPORT_TESTING_start_peer(), hosts_directory_scan_callback(), load_hostlist_file(), load_list_messages(), load_list_tunnels(), load_member(), load_member_session(), load_member_session_history(), load_member_session_next(), load_message_store(), load_peer_store(), load_search_strings(), main(), PABC_load_public_parameters(), print_key(), read_file(), read_index_list(), read_update_information_graph(), restore_valid_peers(), run(), and start_peer_run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_file_test_read()

enum GNUNET_GenericReturnValue GNUNET_DISK_file_test_read ( const char *  fil)

Check that fil corresponds to a filename and the file has read permissions.

Parameters
filfilename to check
Returns
GNUNET_YES if yes, GNUNET_NO if file doesn't exist or has no read permissions, GNUNET_SYSERR if something else (will print an error message in that case, too).

Definition at line 530 of file disk.c.

531{
532 return file_test_internal (fil, R_OK);
533}

References file_test_internal().

Referenced by GNUNET_CONFIGURATION_default_filename(), GNUNET_PQ_exec_sql(), and handle_inline().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_file_backup()

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.

Parameters
filname of the file to back up
Returns
the backup file name (must be freed by caller)

Definition at line 363 of file disk.c.

364{
365 size_t slen;
366 char *target;
367 unsigned int num;
368
369 slen = strlen (fil) + 20;
370 target = GNUNET_malloc (slen);
371 num = 0;
372
373#if HAVE_RENAMEAT2
374 {
375 int fd;
376
377 do
378 {
379 GNUNET_snprintf (target,
380 slen,
381 "%s.%u~",
382 fil,
383 num++);
384 fd = open (target,
385 O_CREAT | O_EXCL,
387 } while (-1 == fd);
388 if (0 != renameat2 (AT_FDCWD,
389 fil,
390 AT_FDCWD,
391 target,
392 RENAME_EXCHANGE))
393 {
395 "renameat2",
396 fil);
397 GNUNET_break (0 ==
398 close (fd));
399 return NULL;
400 }
401 GNUNET_break (0 ==
402 close (fd));
403 }
404#else
405 do
406 {
407 GNUNET_snprintf (target, slen, "%s.%u~", fil, num++);
408 }
409 while (0 == access (target, F_OK));
410 if (0 != rename (fil, target))
411 {
413 return NULL;
414 }
415#endif
416 return target;
417}
static int translate_unix_perms(enum GNUNET_DISK_AccessPermissions perm)
Translate GNUnet-internal permission bitmap to UNIX file access permission bitmap.
Definition: disk.c:109
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
@ GNUNET_ERROR_TYPE_ERROR
int GNUNET_snprintf(char *buf, size_t size, const char *format,...) __attribute__((format(printf
Like snprintf, just aborts if the buffer is of insufficient size.
#define GNUNET_malloc(size)
Wrapper around malloc.

References GNUNET_break, GNUNET_DISK_PERM_USER_WRITE, GNUNET_ERROR_TYPE_ERROR, GNUNET_log_strerror_file, GNUNET_malloc, GNUNET_snprintf(), and translate_unix_perms().

Here is the call 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
hhandle of an open file
offsetposition to move to
whencespecification to which position the offset parameter relates to
Returns
the new position on success, GNUNET_SYSERR otherwise

Definition at line 209 of file disk.c.

212{
213 static int t[] = { SEEK_SET, SEEK_CUR, SEEK_END };
214
215 if (h == NULL)
216 {
217 errno = EINVAL;
218 return GNUNET_SYSERR;
219 }
220 return lseek (h->fd, offset, t[whence]);
221}
static struct GNUNET_SCHEDULER_Task * t
Main task.
@ GNUNET_SYSERR

References GNUNET_SYSERR, h, and t.

Referenced by decrementBit(), delete_store_message(), fh_reader(), get_store_message(), GNUNET_FS_data_reader_file_(), GNUNET_FS_handle_on_demand_block(), incrementBit(), iterate_save_messages(), load_list_messages(), load_list_tunnels(), load_member_session_history(), load_peer_store(), process_result_with_request(), read_file(), save_list_messages(), save_list_tunnels(), save_member_session_history(), save_message_store(), save_peer_store(), try_top_down_reconstruction(), and unindex_reader().

Here is the caller graph for this function:

◆ GNUNET_DISK_file_size()

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

Parameters
filenamename of the file or directory
sizeset to the size of the file (or, in the case of directories, the sum of all sizes of files in the directory)
include_symbolic_linksshould symbolic links be included?
single_file_modeGNUNET_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 225 of file disk.c.

229{
230 struct GetFileSizeData gfsd;
232
233 GNUNET_assert (size != NULL);
234 gfsd.total = 0;
235 gfsd.include_sym_links = include_symbolic_links;
236 gfsd.single_file_mode = single_file_mode;
237 ret = get_size_rec (&gfsd, filename);
238 *size = gfsd.total;
239 return ret;
240}
static enum GNUNET_GenericReturnValue get_size_rec(void *cls, const char *fn)
Iterate over all files in the given directory and accumulate their size.
Definition: disk.c:146
static int ret
Final status code.
Definition: gnunet-arm.c:93
static char * filename
GNUNET_GenericReturnValue
Named constants for return values.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static unsigned int size
Size of the "table".
Definition: peer.c:68
Closure for the recursion to determine the file size of a directory.
Definition: disk.c:83
int single_file_mode
GNUNET_YES if mode is file-only (return total == -1 for directories).
Definition: disk.c:97

References filename, get_size_rec(), GNUNET_assert, GetFileSizeData::include_sym_links, ret, GetFileSizeData::single_file_mode, size, and GetFileSizeData::total.

Referenced by create_download_context(), database_setup(), get_topo_string_from_file(), GNUNET_CONFIGURATION_parse(), GNUNET_CRYPTO_hash_file(), GNUNET_DISK_file_copy(), GNUNET_FS_file_information_create_from_file(), GNUNET_FS_unindex_start(), load(), load_file(), load_search_strings(), preprocess_file(), print_key(), and run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_file_get_identifiers()

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.

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
filenamename of the file
devset to the device ID
inoset to the inode ID
Returns
GNUNET_OK on success

Definition at line 244 of file disk.c.

247{
248#if HAVE_STAT
249 {
250 struct stat sbuf;
251
252 if (0 != stat (filename, &sbuf))
253 {
254 return GNUNET_SYSERR;
255 }
256 *ino = (uint64_t) sbuf.st_ino;
257 }
258#else
259 *ino = 0;
260#endif
261#if HAVE_STATVFS
262 {
263 struct statvfs fbuf;
264
265 if (0 != statvfs (filename, &fbuf))
266 {
267 return GNUNET_SYSERR;
268 }
269 *dev = (uint64_t) fbuf.f_fsid;
270 }
271#elif HAVE_STATFS
272 {
273 struct statfs fbuf;
274
275 if (0 != statfs (filename, &fbuf))
276 {
277 return GNUNET_SYSERR;
278 }
279 *dev =
280 ((uint64_t) fbuf.f_fsid.val[0]) << 32 || ((uint64_t) fbuf.f_fsid.val[1]);
281 }
282#else
283 *dev = 0;
284#endif
285 return GNUNET_OK;
286}
@ GNUNET_OK

References filename, GNUNET_OK, and GNUNET_SYSERR.

Referenced by handle_client_index_start(), and hash_for_index_cb().

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
tcomponent 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 421 of file disk.c.

422{
423 int fd;
424 char *fn;
425 mode_t omask;
426
427 omask = umask (S_IWGRP | S_IWOTH | S_IRGRP | S_IROTH);
428 fn = mktemp_name (t);
429 if (-1 == (fd = mkstemp (fn)))
430 {
432 GNUNET_free (fn);
433 umask (omask);
434 return NULL;
435 }
436 umask (omask);
437 if (0 != close (fd))
439 return fn;
440}
#define LOG_STRERROR_FILE(kind, syscall, filename)
Definition: disk.c:36
static char * mktemp_name(const char *t)
Create the name for a temporary file or directory from a template.
Definition: disk.c:296
@ GNUNET_ERROR_TYPE_WARNING
#define GNUNET_free(ptr)
Wrapper around free.

References GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, LOG_STRERROR_FILE, mktemp_name(), and t.

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

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
tcomponent to use for the name; does NOT contain "XXXXXX" or "/tmp/".
Returns
NULL on error, otherwise name of freshly created directory

Definition at line 343 of file disk.c.

344{
345 char *fn;
346 mode_t omask;
347
348 omask = umask (S_IWGRP | S_IWOTH | S_IRGRP | S_IROTH);
349 fn = mktemp_name (t);
350 if (fn != mkdtemp (fn))
351 {
353 GNUNET_free (fn);
354 umask (omask);
355 return NULL;
356 }
357 umask (omask);
358 return fn;
359}

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

Referenced by create_response(), and GNUNET_TESTBED_system_create_with_portrange().

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
fnfile name to be opened
flagsopening flags, a combination of GNUNET_DISK_OPEN_xxx bit flags
permpermissions 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 1248 of file disk.c.

1251{
1252 char *expfn;
1254
1255 int oflags;
1256 int mode;
1257 int fd;
1258
1259 expfn = GNUNET_STRINGS_filename_expand (fn);
1260 if (NULL == expfn)
1261 return NULL;
1262
1263 mode = 0;
1265 oflags = O_RDWR; /* note: O_RDWR is NOT always O_RDONLY | O_WRONLY */
1266 else if (flags & GNUNET_DISK_OPEN_READ)
1267 oflags = O_RDONLY;
1268 else if (flags & GNUNET_DISK_OPEN_WRITE)
1269 oflags = O_WRONLY;
1270 else
1271 {
1272 GNUNET_break (0);
1273 GNUNET_free (expfn);
1274 return NULL;
1275 }
1277 oflags |= (O_CREAT | O_EXCL);
1278 if (flags & GNUNET_DISK_OPEN_TRUNCATE)
1279 oflags |= O_TRUNC;
1280 if (flags & GNUNET_DISK_OPEN_APPEND)
1281 oflags |= O_APPEND;
1282 if (GNUNET_NO == GNUNET_DISK_file_test (fn))
1283 {
1284 if (flags & GNUNET_DISK_OPEN_CREATE)
1285 {
1287 oflags |= O_CREAT;
1288 mode = translate_unix_perms (perm);
1289 }
1290 }
1291
1292 // Setting O_CLOEXEC after pipe() may introduce
1293 // race conditions: https://bugs.gnunet.org/view.php?id=9311
1294 // This is no problem if the platform supports pipe2
1295 fd = open (expfn,
1296 oflags
1297#if O_CLOEXEC
1298 | O_CLOEXEC
1299#endif
1300 | O_LARGEFILE,
1301 mode);
1302 if (fd == -1)
1303 {
1304 if (0 == (flags & GNUNET_DISK_OPEN_FAILIFEXISTS))
1306 else
1308 GNUNET_free (expfn);
1309 return NULL;
1310 }
1311
1313
1314 ret->fd = fd;
1315
1316 GNUNET_free (expfn);
1317 return ret;
1318}
static enum @44 mode
Should we do a PUT (mode = 0) or GET (mode = 1);.
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).
Definition: disk.c:523
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create_for_file(const char *filename)
Create the directory structure for storing a file.
Definition: disk.c:623
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_new(type)
Allocate a struct or union of the given type.
char * GNUNET_STRINGS_filename_expand(const char *fil)
Complete filename (a la shell) from abbrevition.
Definition: strings.c:504
#define O_LARGEFILE
Definition: platform.h:213
Handle used to access files (and pipes).
int fd
File handle on Unix-like systems.

References GNUNET_DISK_FileHandle::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 database_setup(), database_shutdown(), full_recursive_download(), get_file_handle(), GNUNET_BIO_read_open_file(), GNUNET_BIO_write_open_file(), GNUNET_CONFIGURATION_write(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_CRYPTO_hash_file(), GNUNET_DISK_file_copy(), GNUNET_DISK_fn_read(), GNUNET_FS_data_reader_file_(), GNUNET_FS_download_start_task_(), GNUNET_FS_handle_on_demand_block(), GNUNET_FS_unindex_do_remove_(), GNUNET_TIME_absolute_get_monotonic(), load_etc_hosts(), load_list_messages(), load_list_tunnels(), load_member_session_history(), load_message_store(), load_message_store_entries(), load_message_store_links(), load_peer_store(), lookup_dns_servers(), open_static_resource(), print_key(), process_result_with_request(), read_file(), read_from_log(), REGEX_TEST_read_from_file(), restore_valid_peers(), run(), save_list_messages(), save_list_tunnels(), save_member_session_history(), save_message_store(), save_peer_store(), start_dump(), start_insert(), store_valid_peers(), to_file_raw(), try_match_block(), write_benchmark_data(), and write_file().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_file_handle_size()

enum GNUNET_GenericReturnValue GNUNET_DISK_file_handle_size ( struct GNUNET_DISK_FileHandle fh,
off_t *  size 
)

Get the size of an open file.

Parameters
fhopen file handle
sizewhere to write size of the file
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 196 of file disk.c.

198{
199 struct stat sbuf;
200
201 if (0 != fstat (fh->fd, &sbuf))
202 return GNUNET_SYSERR;
203 *size = sbuf.st_size;
204 return GNUNET_OK;
205}

References GNUNET_DISK_FileHandle::fd, GNUNET_OK, GNUNET_SYSERR, and size.

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

Here is the caller graph for this function:

◆ GNUNET_DISK_pipe()

struct GNUNET_DISK_PipeHandle * GNUNET_DISK_pipe ( enum GNUNET_DISK_PipeFlags  pf)

Creates an interprocess channel.

Parameters
pfhow to configure the pipe
Returns
handle to the new pipe, NULL on error

Definition at line 1458 of file disk.c.

1459{
1460 int fd[2];
1461
1462#if HAVE_PIPE2 && O_CLOEXEC
1463 if (-1 == pipe2 (fd, O_CLOEXEC))
1464#else
1465 if (-1 == pipe (fd))
1466#endif
1467 {
1468 int eno = errno;
1469
1471 errno = eno;
1472 return NULL;
1473 }
1474 return GNUNET_DISK_pipe_from_fd (pf, fd);
1475}
#define LOG_STRERROR(kind, syscall)
Definition: disk.c:33
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.
Definition: disk.c:1479

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

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

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 ( enum GNUNET_DISK_PipeFlags  pf,
int  fd[2] 
)

Creates a pipe object from a couple of file descriptors.

Useful for wrapping existing pipe FDs.

Parameters
pfhow to configure the pipe
fdan 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 1479 of file disk.c.

1481{
1482 struct GNUNET_DISK_PipeHandle *p;
1483 int ret = 0;
1484 int flags;
1485 int eno = 0; /* make gcc happy */
1486
1488 if (fd[0] >= 0)
1489 {
1490 p->fd[0] = GNUNET_new (struct GNUNET_DISK_FileHandle);
1491 p->fd[0]->fd = fd[0];
1492 if (0 == (GNUNET_DISK_PF_BLOCKING_READ & pf))
1493 {
1494 flags = fcntl (fd[0], F_GETFL);
1495 flags |= O_NONBLOCK;
1496 if (0 > fcntl (fd[0], F_SETFL, flags))
1497 {
1498 ret = -1;
1499 eno = errno;
1500 }
1501 }
1502 flags = fcntl (fd[0], F_GETFD);
1503 flags |= FD_CLOEXEC;
1504 if (0 > fcntl (fd[0], F_SETFD, flags))
1505 {
1506 ret = -1;
1507 eno = errno;
1508 }
1509 }
1510
1511 if (fd[1] >= 0)
1512 {
1513 p->fd[1] = GNUNET_new (struct GNUNET_DISK_FileHandle);
1514 p->fd[1]->fd = fd[1];
1515 if (0 == (GNUNET_DISK_PF_BLOCKING_WRITE & pf))
1516 {
1517 flags = fcntl (fd[1], F_GETFL);
1518 flags |= O_NONBLOCK;
1519 if (0 > fcntl (fd[1], F_SETFL, flags))
1520 {
1521 ret = -1;
1522 eno = errno;
1523 }
1524 }
1525 flags = fcntl (fd[1], F_GETFD);
1526 flags |= FD_CLOEXEC;
1527 if (0 > fcntl (fd[1], F_SETFD, flags))
1528 {
1529 ret = -1;
1530 eno = errno;
1531 }
1532 }
1533 if (ret == -1)
1534 {
1535 errno = eno;
1537 if (p->fd[0]->fd >= 0)
1538 GNUNET_break (0 == close (p->fd[0]->fd));
1539 if (p->fd[1]->fd >= 0)
1540 GNUNET_break (0 == close (p->fd[1]->fd));
1541 GNUNET_free (p->fd[0]);
1542 GNUNET_free (p->fd[1]);
1543 GNUNET_free (p);
1544 errno = eno;
1545 return NULL;
1546 }
1547 return p;
1548}
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-uri.c:38
Handle used to manage a pipe.
Definition: disk.c:69
struct GNUNET_DISK_FileHandle * fd[2]
File descriptors for the pipe.
Definition: disk.c:74

References GNUNET_DISK_PipeHandle::fd, GNUNET_break, GNUNET_DISK_PF_BLOCKING_READ, GNUNET_DISK_PF_BLOCKING_WRITE, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_new, LOG_STRERROR, p, and ret.

Referenced by GNUNET_DISK_pipe().

Here is the caller graph for this function:

◆ GNUNET_DISK_pipe_close()

enum GNUNET_GenericReturnValue GNUNET_DISK_pipe_close ( struct GNUNET_DISK_PipeHandle p)

Closes an interprocess channel.

Parameters
ppipe
Returns
GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1605 of file disk.c.

1606{
1608 enum GNUNET_GenericReturnValue read_end_close;
1609 enum GNUNET_GenericReturnValue write_end_close;
1610 int read_end_close_errno;
1611 int write_end_close_errno;
1612
1614 read_end_close_errno = errno;
1616 write_end_close_errno = errno;
1617 GNUNET_free (p);
1618
1619 if (GNUNET_OK != read_end_close)
1620 {
1621 errno = read_end_close_errno;
1622 ret = read_end_close;
1623 }
1624 else if (GNUNET_OK != write_end_close)
1625 {
1626 errno = write_end_close_errno;
1627 ret = write_end_close;
1628 }
1629
1630 return ret;
1631}
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.
Definition: disk.c:1552

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

Referenced by child_management_done(), 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(), shutdown_task(), and start_process().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_pipe_close_end()

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.

Parameters
ppipe to close end of
endwhich end of the pipe to close
Returns
GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1552 of file disk.c.

1554{
1556
1558 {
1559 if (p->fd[0])
1560 {
1561 ret = GNUNET_DISK_file_close (p->fd[0]);
1562 p->fd[0] = NULL;
1563 }
1564 }
1565 else if (end == GNUNET_DISK_PIPE_END_WRITE)
1566 {
1567 if (p->fd[1])
1568 {
1569 ret = GNUNET_DISK_file_close (p->fd[1]);
1570 p->fd[1] = NULL;
1571 }
1572 }
1573 return ret;
1574}
static int end
Set if we are to shutdown all services (including ARM).
Definition: gnunet-arm.c:33
enum GNUNET_GenericReturnValue GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1322

References end, GNUNET_DISK_file_close(), GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_PIPE_END_WRITE, GNUNET_OK, p, and ret.

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

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
ppipe to detach an end from
endwhich 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 1578 of file disk.c.

1580{
1581 struct GNUNET_DISK_FileHandle *ret = NULL;
1582
1584 {
1585 if (p->fd[0])
1586 {
1587 ret = p->fd[0];
1588 p->fd[0] = NULL;
1589 }
1590 }
1591 else if (end == GNUNET_DISK_PIPE_END_WRITE)
1592 {
1593 if (p->fd[1])
1594 {
1595 ret = p->fd[1];
1596 p->fd[1] = NULL;
1597 }
1598 }
1599
1600 return ret;
1601}

References end, GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_PIPE_END_WRITE, p, and ret.

Referenced by GNUNET_ARM_request_service_start(), and start_process().

Here is the caller graph for this function:

◆ GNUNET_DISK_file_close()

enum GNUNET_GenericReturnValue GNUNET_DISK_file_close ( struct GNUNET_DISK_FileHandle h)

Close an open file.

Parameters
hfile handle
Returns
GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1322 of file disk.c.

1323{
1325
1326 if (NULL == h)
1327 {
1328 errno = EINVAL;
1329 return GNUNET_SYSERR;
1330 }
1331
1332 ret = GNUNET_OK;
1333 if (0 != close (h->fd))
1334 {
1337 }
1338 GNUNET_free (h);
1339 return ret;
1340}

References GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_OK, GNUNET_SYSERR, h, LOG_STRERROR, and ret.

Referenced by check_completed(), clear_message_store(), close_files_iter(), database_setup(), database_shutdown(), do_shutdown(), file_hash_finish(), full_recursive_download(), get_cb(), GNUNET_ARM_operation_cancel(), GNUNET_ARM_request_service_start(), GNUNET_BIO_flush(), GNUNET_BIO_read_close(), GNUNET_BIO_write_close(), GNUNET_CONFIGURATION_write(), GNUNET_CONTAINER_bloomfilter_free(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_CRYPTO_hash_file_cancel(), GNUNET_DISK_file_copy(), GNUNET_DISK_fn_read(), GNUNET_DISK_pipe_close_end(), 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_TIME_absolute_get_monotonic(), load_etc_hosts(), load_list_messages(), load_list_tunnels(), load_member_session_history(), load_message_store(), load_message_store_entries(), load_message_store_links(), load_peer_store(), lookup_dns_servers(), notify_starting(), open_static_resource(), parent_control_handler(), print_key(), process_result_with_request(), read_file(), reconstruct_cont(), REGEX_TEST_read_from_file(), restore_valid_peers(), run(), save_list_messages(), save_list_tunnels(), save_member_session_history(), save_message_store(), save_peer_store(), shutdown_pch(), shutdown_task(), start_process(), store_valid_peers(), to_file_raw(), try_match_block(), unindex_finish(), write_benchmark_data(), and write_file().

◆ 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
ppipe
nend to access
Returns
handle for the respective end

Definition at line 1635 of file disk.c.

1637{
1638 switch (n)
1639 {
1642 return p->fd[n];
1643
1644 default:
1645 GNUNET_break (0);
1646 return NULL;
1647 }
1648}

References GNUNET_break, GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_PIPE_END_WRITE, and p.

Referenced by GNUNET_NAT_mini_get_external_ipv4_(), GNUNET_OS_command_run(), GNUNET_SCHEDULER_driver_init(), GNUNET_wait_child(), initiate_put_from_pipe_trigger(), maint_child_death(), restart_nat_server(), run(), shutdown_pipe_cb(), sighandler_child_death(), sighandler_shutdown(), sign_worker(), start_helper(), start_process(), and work().

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 arguments are GNUNET_NO, the file is made world-read-write-executable (777). Does nothing on W32.

Parameters
fnname of the file to update
require_uid_matchGNUNET_YES means 700
require_gid_matchGNUNET_YES means 770 unless require_uid_match is set

Definition at line 324 of file disk.c.

327{
328 mode_t mode;
329
330 if (GNUNET_YES == require_uid_match)
331 mode = S_IRUSR | S_IWUSR | S_IXUSR;
332 else if (GNUNET_YES == require_gid_match)
333 mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP;
334 else
335 mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH
336 | S_IWOTH | S_IXOTH;
337 if (0 != chmod (fn, mode))
339}

References GNUNET_ERROR_TYPE_WARNING, GNUNET_log_strerror_file, GNUNET_YES, and mode.

Referenced by create_listen_socket().

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
fnonative integer file descriptor
Returns
file handle corresponding to the descriptor

Definition at line 1344 of file disk.c.

1345{
1346 struct GNUNET_DISK_FileHandle *fh;
1347
1348 if ((((off_t) -1) == lseek (fno, 0, SEEK_CUR)) && (EBADF == errno))
1349 return NULL; /* invalid FD */
1350
1351 fh = GNUNET_new (struct GNUNET_DISK_FileHandle);
1352
1353 fh->fd = fno;
1354
1355 return fh;
1356}

References GNUNET_DISK_FileHandle::fd, 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().

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
fdnative file descriptor
Returns
file handle corresponding to the descriptor

Definition at line 1360 of file disk.c.

1361{
1362 int fno;
1363
1364 fno = fileno (fd);
1365 if (-1 == fno)
1366 return NULL;
1368}
struct GNUNET_DISK_FileHandle * GNUNET_DISK_get_handle_from_int_fd(int fno)
Get a handle from a native integer FD.
Definition: disk.c:1344

References GNUNET_DISK_FileHandle::fd, and GNUNET_DISK_get_handle_from_int_fd().

Referenced by run().

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
hhandle to an open file
resultthe buffer to write the result to
lenthe maximum number of bytes to read
Returns
the number of bytes read on success, GNUNET_SYSERR on failure

Definition at line 663 of file disk.c.

666{
667 if (NULL == h)
668 {
669 errno = EINVAL;
670 return GNUNET_SYSERR;
671 }
672 return read (h->fd, result, len);
673}
static int result
Global testing status.

References GNUNET_SYSERR, h, and result.

Referenced by cmd_read(), database_setup(), decrementBit(), fh_reader(), file_hash_task(), get_store_message(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_DISK_file_copy(), GNUNET_DISK_fn_read(), GNUNET_FS_data_reader_file_(), GNUNET_FS_handle_on_demand_block(), helper_read(), incrementBit(), initiate_put_from_pipe_trigger(), load_list_messages(), load_list_tunnels(), load_member_session_history(), load_peer_store(), maint_child_death(), nat_server_read(), parent_control_handler(), print_key(), put_cb(), read_external_ipv4(), read_file(), read_from_file(), read_task(), REGEX_TEST_read_from_file(), restore_valid_peers(), run(), shutdown_pipe_cb(), start_insert(), try_top_down_reconstruction(), and unindex_reader().

Here is the caller graph for this function:

◆ 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
fnfile name
resultthe buffer to write the result to
lenthe maximum number of bytes to read
Returns
number of bytes read, GNUNET_SYSERR on failure

Definition at line 677 of file disk.c.

680{
681 struct GNUNET_DISK_FileHandle *fh;
682 ssize_t ret;
683 int eno;
684
685 fh = GNUNET_DISK_file_open (fn,
688 if (NULL == fh)
689 return GNUNET_SYSERR;
690 ret = GNUNET_DISK_file_read (fh, result, len);
691 eno = errno;
694 errno = eno;
695 return ret;
696}
struct GNUNET_DISK_FileHandle * GNUNET_DISK_file_open(const char *fn, enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm)
Open a file.
Definition: disk.c:1248
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.
Definition: disk.c:663

References 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, result, and ret.

Referenced by ego_callback(), get_topo_string_from_file(), GNUNET_CONFIGURATION_parse(), hosts_directory_scan_callback(), load_file(), load_search_strings(), and run().

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
hhandle to open file
bufferthe data to write
nnumber of bytes to write
Returns
number of bytes written on success, GNUNET_SYSERR on error

Definition at line 700 of file disk.c.

703{
704 if (NULL == h)
705 {
706 errno = EINVAL;
707 return GNUNET_SYSERR;
708 }
709 return write (h->fd,
710 buffer,
711 n);
712}

References GNUNET_SYSERR, and h.

Referenced by database_shutdown(), decrementBit(), delete_store_message(), do_shutdown(), get_cb(), GNUNET_BIO_flush(), GNUNET_CONFIGURATION_write(), GNUNET_DISK_file_copy(), GNUNET_OS_process_kill(), GNUNET_TIME_absolute_get_monotonic(), helper_write(), incrementBit(), iterate_save_member_session_history_hentries(), iterate_save_messages(), iterate_save_peers(), process_result_with_request(), publicize_rm(), regex_found_handler(), save_list_messages(), save_list_tunnels(), sighandler_child_death(), sighandler_shutdown(), sign_worker(), start_dump(), stats_iterator(), store_and_free_entries(), store_peer_presistently_iterator(), to_file_raw(), try_match_block(), write_file(), and write_task().

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
hhandle to open file
bufferthe data to write
nnumber of bytes to write
Returns
number of bytes written on success, GNUNET_SYSERR on error

Definition at line 716 of file disk.c.

719{
720 int flags;
721 ssize_t ret;
722
723 if (NULL == h)
724 {
725 errno = EINVAL;
726 return GNUNET_SYSERR;
727 }
728 /* set to blocking, write, then set back */
729 flags = fcntl (h->fd, F_GETFL);
730 if (0 != (flags & O_NONBLOCK))
731 (void) fcntl (h->fd, F_SETFL, flags - O_NONBLOCK);
732 ret = write (h->fd, buffer, n);
733 if (0 == (flags & O_NONBLOCK))
734 (void) fcntl (h->fd, F_SETFL, flags);
735 return ret;
736}

References GNUNET_SYSERR, h, and ret.

Referenced by write_benchmark_data().

Here is the caller graph for this function:

◆ GNUNET_DISK_fn_write()

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.

The directory is created if necessary. Fail if filename already exists or if not exactly buf with buf_size bytes could be written to filename.

Parameters
fnfile name
bufthe data to write
buf_sizenumber of bytes to write from buf
modefile permissions
Returns
GNUNET_OK on success, GNUNET_NO if a file existed under filename GNUNET_SYSERR on failure

Definition at line 740 of file disk.c.

744{
745 char *tmpl;
746 int fd;
747
748 if (GNUNET_OK !=
750 {
752 "mkstemp",
753 fn);
754 return GNUNET_SYSERR;
755 }
756 {
757 char *dname;
758
759 dname = GNUNET_strdup (fn);
760 GNUNET_asprintf (&tmpl,
761 "%s/XXXXXX",
762 dirname (dname));
763 GNUNET_free (dname);
764 }
765 fd = mkstemp (tmpl);
766 if (-1 == fd)
767 {
769 "mkstemp",
770 tmpl);
771 GNUNET_free (tmpl);
772 return GNUNET_SYSERR;
773 }
774
775 if (0 != fchmod (fd,
777 {
779 "chmod",
780 tmpl);
781 GNUNET_assert (0 == close (fd));
782 if (0 != unlink (tmpl))
784 "unlink",
785 tmpl);
786 GNUNET_free (tmpl);
787 return GNUNET_SYSERR;
788 }
789 if (buf_size !=
790 write (fd,
791 buf,
792 buf_size))
793 {
795 "write",
796 tmpl);
797 GNUNET_assert (0 == close (fd));
798 if (0 != unlink (tmpl))
800 "unlink",
801 tmpl);
802 GNUNET_free (tmpl);
803 return GNUNET_SYSERR;
804 }
805 GNUNET_assert (0 == close (fd));
806
807 if (0 != link (tmpl,
808 fn))
809 {
810 if (0 != unlink (tmpl))
812 "unlink",
813 tmpl);
814 GNUNET_free (tmpl);
815 return GNUNET_NO;
816 }
817 if (0 != unlink (tmpl))
819 "unlink",
820 tmpl);
821 GNUNET_free (tmpl);
822 return GNUNET_OK;
823
824
825}
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.

References GNUNET_DISK_FileHandle::fd, GNUNET_asprintf(), GNUNET_assert, GNUNET_DISK_directory_create_for_file(), GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log_strerror_file, GNUNET_NO, GNUNET_OK, GNUNET_strdup, GNUNET_SYSERR, mode, and translate_unix_perms().

Referenced by calculate_pow(), clean_task(), GNUNET_CRYPTO_ecdsa_key_from_file(), GNUNET_CRYPTO_eddsa_key_from_file(), handle_create_message(), run(), shutdown_task(), sync_pow(), and write_proof().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_file_copy()

enum GNUNET_GenericReturnValue GNUNET_DISK_file_copy ( const char *  src,
const char *  dst 
)

Copy a file.

Parameters
srcfile to copy
dstdestination file name
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1133 of file disk.c.

1135{
1136 char *buf;
1137 uint64_t pos;
1138 uint64_t size;
1139 size_t len;
1140 ssize_t sret;
1141 struct GNUNET_DISK_FileHandle *in;
1142 struct GNUNET_DISK_FileHandle *out;
1143
1145 {
1147 return GNUNET_SYSERR;
1148 }
1149 pos = 0;
1150 in =
1152 if (! in)
1153 {
1155 return GNUNET_SYSERR;
1156 }
1157 out =
1165 if (! out)
1166 {
1169 return GNUNET_SYSERR;
1170 }
1172 while (pos < size)
1173 {
1174 len = COPY_BLK_SIZE;
1175 if (len > size - pos)
1176 len = size - pos;
1177 sret = GNUNET_DISK_file_read (in, buf, len);
1178 if ((sret < 0) || (len != (size_t) sret))
1179 goto FAIL;
1180 sret = GNUNET_DISK_file_write (out, buf, len);
1181 if ((sret < 0) || (len != (size_t) sret))
1182 goto FAIL;
1183 pos += len;
1184 }
1185 GNUNET_free (buf);
1190 return GNUNET_OK;
1191FAIL:
1192 GNUNET_free (buf);
1197 return GNUNET_SYSERR;
1198}
#define COPY_BLK_SIZE
Block size for IO for copying files.
Definition: disk.c:42
@ FAIL
ssize_t GNUNET_DISK_file_write(const struct GNUNET_DISK_FileHandle *h, const void *buffer, size_t n)
Write a buffer to a file.
Definition: disk.c:700
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).
Definition: disk.c:225

References COPY_BLK_SIZE, FAIL, GNUNET_break, 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, and size.

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_namethe name of the directory
callbackthe method to call for each file
callback_clsclosure for callback
Returns
the number of files found, -1 on error

Definition at line 829 of file disk.c.

832{
833 DIR *dinfo;
834 struct dirent *finfo;
835 int count = 0;
837 char *name;
838 char *dname;
839 unsigned int name_len;
840 unsigned int n_size;
841
842 GNUNET_assert (NULL != dir_name);
844 if (NULL == dname)
845 return GNUNET_SYSERR;
846 while ( (strlen (dname) > 0) &&
847 (dname[strlen (dname) - 1] == DIR_SEPARATOR) )
848 dname[strlen (dname) - 1] = '\0';
849 dinfo = opendir (dname);
850 if (NULL == dinfo)
851 {
853 "opendir",
854 dname);
855 GNUNET_free (dname);
856 return GNUNET_SYSERR;
857 }
858 name_len = 256;
859 n_size = strlen (dname) + name_len + strlen (DIR_SEPARATOR_STR) + 1;
860 name = GNUNET_malloc (n_size);
861 while (NULL != (finfo = readdir (dinfo)))
862 {
863 if ((0 == strcmp (finfo->d_name, ".")) ||
864 (0 == strcmp (finfo->d_name, "..")))
865 continue;
866 if (NULL != callback)
867 {
868 if (name_len < strlen (finfo->d_name))
869 {
871 name_len = strlen (finfo->d_name);
872 n_size = strlen (dname) + name_len + strlen (DIR_SEPARATOR_STR) + 1;
873 name = GNUNET_malloc (n_size);
874 }
875 /* dname can end in "/" only if dname == "/";
876 * if dname does not end in "/", we need to add
877 * a "/" (otherwise, we must not!) */
879 n_size,
880 "%s%s%s",
881 dname,
882 (0 == strcmp (dname,
884 ? ""
886 finfo->d_name);
887 ret = callback (callback_cls,
888 name);
889 if (GNUNET_OK != ret)
890 {
891 closedir (dinfo);
893 GNUNET_free (dname);
894 if (GNUNET_NO == ret)
895 return count;
896 return GNUNET_SYSERR;
897 }
898 }
899 count++;
900 }
901 closedir (dinfo);
903 GNUNET_free (dname);
904 return count;
905}
static const char * dir_name
Top-level directory we monitor to auto-publish.
static char * name
Name (label) of the records to list.
#define DIR_SEPARATOR
Definition: platform.h:166
#define DIR_SEPARATOR_STR
Definition: platform.h:167

References dir_name, 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_STRERROR_FILE, name, and ret.

Referenced by deserialization_master(), deserialize_download(), deserialize_search(), determine_id(), discover_testbed_nodes(), get_size_rec(), GNUNET_CONFIGURATION_load_from(), GNUNET_DISK_directory_remove(), GNUNET_DISK_glob(), GNUNET_PLUGIN_load_all(), iter_testbed_path(), load_member(), load_member_store(), load_operation_store(), preprocess_file(), run(), and scan().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_glob()

int GNUNET_DISK_glob ( const char *  glob_pattern,
GNUNET_FileNameCallback  callback,
void *  callback_cls 
)

Find all files matching a glob pattern.

Currently, the glob_pattern only supports asterisks in the last path component.

Parameters
glob_patternthe glob pattern to search for
callbackthe method to call for each file
callback_clsclosure for callback
Returns
the number of files found, -1 on error

Definition at line 1011 of file disk.c.

1014{
1015 char *mypat = GNUNET_strdup (glob_pattern);
1016 char *sep;
1017 int ret;
1018
1019 if ( (NULL != strrchr (glob_pattern, '+')) ||
1020 (NULL != strrchr (glob_pattern, '[')) ||
1021 (NULL != strrchr (glob_pattern, '~')) )
1022 {
1024 "unsupported glob pattern: '%s'\n",
1025 glob_pattern);
1026 GNUNET_free (mypat);
1027 return -1;
1028 }
1029
1030 sep = strrchr (mypat, DIR_SEPARATOR);
1031 if (NULL == sep)
1032 {
1033 GNUNET_free (mypat);
1034 return -1;
1035 }
1036
1037 *sep = '\0';
1038
1039 if (NULL != strchr (mypat, '*'))
1040 {
1041 GNUNET_free (mypat);
1042 GNUNET_break (0);
1044 "glob pattern may only contain '*' in the final path component\n");
1045 return -1;
1046 }
1047
1048 {
1049 struct GlobClosure gc = {
1050 .glob = sep + 1,
1051 .cb = callback,
1052 .cls = callback_cls,
1053 .nres = 0,
1054 };
1056 "scanning directory '%s' for glob matches on '%s'\n",
1057 mypat,
1058 gc.glob);
1060 glob_cb,
1061 &gc
1062 );
1063 GNUNET_free (mypat);
1064 return (ret < 0) ? ret : gc.nres;
1065 }
1066}
static enum GNUNET_GenericReturnValue glob_cb(void *cls, const char *filename)
Function called with a filename.
Definition: disk.c:980
#define LOG(kind,...)
Definition: disk.c:31
int GNUNET_DISK_directory_scan(const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
Scan a directory for files.
Definition: disk.c:829
int nres
Number of files that actually matched the glob pattern.
Definition: disk.c:967
const char * glob
Definition: disk.c:960

References DIR_SEPARATOR, GlobClosure::glob, glob_cb(), GNUNET_break, GNUNET_DISK_directory_scan(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_strdup, LOG, GlobClosure::nres, and ret.

Referenced by handle_inline().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_directory_create_for_file()

enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create_for_file ( const char *  filename)

Create the directory structure for storing a file.

Parameters
filenamename of a file in the directory
Returns
GNUNET_OK on success, GNUNET_SYSERR on failure, GNUNET_NO if directory exists but is not writeable

Definition at line 623 of file disk.c.

624{
625 char *rdir;
626 size_t len;
627 int eno;
629
631 if (NULL == rdir)
632 {
633 errno = EINVAL;
634 return GNUNET_SYSERR;
635 }
636 if (0 == access (rdir, W_OK))
637 {
638 GNUNET_free (rdir);
639 return GNUNET_OK;
640 }
641 len = strlen (rdir);
642 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
643 len--;
644 rdir[len] = '\0';
645 /* The empty path is invalid and in this case refers to / */
646 if (0 == len)
647 {
648 GNUNET_free (rdir);
649 rdir = GNUNET_strdup ("/");
650 }
652 if ( (GNUNET_OK == res) &&
653 (0 != access (rdir, W_OK)) )
654 res = GNUNET_NO;
655 eno = errno;
656 GNUNET_free (rdir);
657 errno = eno;
658 return res;
659}
static char * res
Currently read line or NULL on EOF.
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create(const char *dir)
Implementation of "mkdir -p".
Definition: disk.c:537

References DIR_SEPARATOR, filename, GNUNET_DISK_directory_create(), GNUNET_free, GNUNET_NO, GNUNET_OK, GNUNET_strdup, GNUNET_STRINGS_filename_expand(), GNUNET_SYSERR, and res.

Referenced by database_connect(), database_setup(), get_server_addresses(), GNUNET_CONFIGURATION_write(), GNUNET_DISK_file_open(), GNUNET_DISK_fn_write(), GNUNET_FS_download_sync_(), make_serialization_file_name(), make_serialization_file_name_in_dir(), run(), save(), save_hostlist_file(), setup_log_file(), store_valid_peers(), and trigger_recursive_download().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_DISK_directory_test()

enum GNUNET_GenericReturnValue 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
filfilename to test
is_readableGNUNET_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

Definition at line 444 of file disk.c.

445{
446 struct stat filestat;
447 int ret;
448
449 ret = stat (fil, &filestat);
450 if (ret != 0)
451 {
452 if (errno != ENOENT)
454 return GNUNET_SYSERR;
455 }
456 if (! S_ISDIR (filestat.st_mode))
457 {
459 "A file already exits with the same name %s\n",
460 fil);
461 return GNUNET_NO;
462 }
463 if (GNUNET_YES == is_readable)
464 ret = access (fil, R_OK | X_OK);
465 else
466 ret = access (fil, X_OK);
467 if (ret < 0)
468 {
470 return GNUNET_NO;
471 }
472 return GNUNET_YES;
473}
@ GNUNET_ERROR_TYPE_INFO

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

Referenced by callback_scan_for_members(), callback_scan_for_sessions(), create_service(), deserialization_master(), deserialize_download(), deserialize_search(), GNUNET_CONFIGURATION_load(), GNUNET_DISK_directory_create(), GNUNET_DISK_directory_remove(), GNUNET_FS_remove_sync_dir_(), GNUNET_OS_installation_get_path(), iterate_load_next_member_sessions(), iterate_load_next_session(), iterate_save_members(), iterate_save_session(), load_member(), load_member_store(), load_operation_store(), load_srv_room(), PABC_load_public_parameters(), remove_srv_room(), run(), save_member(), save_member_store(), save_operation_store(), and save_srv_room().

Here is the caller graph for this function:

◆ GNUNET_DISK_directory_remove()

enum GNUNET_GenericReturnValue GNUNET_DISK_directory_remove ( const char *  filename)

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

Call with caution.

Parameters
filenamethe file to remove
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1088 of file disk.c.

1089{
1090 struct stat istat;
1091
1092 if (NULL == filename)
1093 {
1094 GNUNET_break (0);
1095 return GNUNET_SYSERR;
1096 }
1097 if (0 != lstat (filename, &istat))
1098 return GNUNET_NO; /* file may not exist... */
1099 (void) chmod (filename,
1100 S_IWUSR | S_IRUSR | S_IXUSR);
1101 if (0 == unlink (filename))
1102 return GNUNET_OK;
1103 if ( (errno != EISDIR) &&
1104 /* EISDIR is not sufficient in all cases, e.g.
1105 * sticky /tmp directory may result in EPERM on BSD.
1106 * So we also explicitly check "isDirectory" */
1107 (GNUNET_YES !=
1109 GNUNET_YES)) )
1110 {
1112 "rmdir",
1113 filename);
1114 return GNUNET_SYSERR;
1115 }
1116 if (GNUNET_SYSERR ==
1119 NULL))
1120 return GNUNET_SYSERR;
1121 if (0 != rmdir (filename))
1122 {
1124 "rmdir",
1125 filename);
1126 return GNUNET_SYSERR;
1127 }
1128 return GNUNET_OK;
1129}
static enum GNUNET_GenericReturnValue remove_helper(void *unused, const char *fn)
Function that removes the given directory by calling GNUNET_DISK_directory_remove().
Definition: disk.c:1078
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_test(const char *fil, int is_readable)
Test if fil is a directory and listable.
Definition: disk.c:444

References filename, 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 calculate_pow(), clean_task(), create_response(), delete_files(), GNUNET_CONFIGURATION_write(), GNUNET_FS_remove_sync_dir_(), GNUNET_TESTBED_system_destroy(), purge_cfg_dir(), remove_helper(), remove_room_member_session(), remove_srv_room(), and write_proof().

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

Parameters
pdproject data to use to determine paths
cfg_filenameconfiguration file to parse
optionoption with the dir name to purge

Definition at line 1702 of file disk.c.

1705{
1710 (void *) option));
1711}
static enum GNUNET_GenericReturnValue purge_cfg_dir(void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
Helper function for GNUNET_DISK_purge_cfg_dir.
Definition: disk.c:1670
static char * cfg_filename
Name of the configuration file.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_parse_and_run(const struct GNUNET_OS_ProjectData *pd, const char *filename, GNUNET_CONFIGURATION_Callback cb, void *cb_cls)
Parse a configuration file filename and run the function cb with the resulting configuration object.

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

Here is the call graph for this function:

◆ GNUNET_DISK_directory_create()

enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create ( const char *  dir)

Implementation of "mkdir -p".

Parameters
dirthe directory to create
Returns
GNUNET_SYSERR on failure, GNUNET_OK otherwise

Definition at line 537 of file disk.c.

538{
539 char *rdir;
540 unsigned int len;
541 unsigned int pos;
542 unsigned int pos2;
543 int ret = GNUNET_OK;
544
546 if (rdir == NULL)
547 {
548 GNUNET_break (0);
549 return GNUNET_SYSERR;
550 }
551
552 len = strlen (rdir);
553
554 pos = 1; /* skip heading '/' */
555
556 /* Check which low level directories already exist */
557 pos2 = len;
558 rdir[len] = DIR_SEPARATOR;
559 while (pos <= pos2)
560 {
561 if (DIR_SEPARATOR == rdir[pos2])
562 {
563 rdir[pos2] = '\0';
565 if (GNUNET_NO == ret)
566 {
568 "Creating directory `%s' failed\n",
569 rdir);
570 GNUNET_free (rdir);
571 return GNUNET_SYSERR;
572 }
573 rdir[pos2] = DIR_SEPARATOR;
574 if (GNUNET_YES == ret)
575 {
576 pos2++;
577 break;
578 }
579 }
580 pos2--;
581 }
582 rdir[len] = '\0';
583 if (pos < pos2)
584 pos = pos2;
585 /* Start creating directories */
586 while (pos <= len)
587 {
588 if ((rdir[pos] == DIR_SEPARATOR) || (pos == len))
589 {
590 rdir[pos] = '\0';
592 if (GNUNET_NO == ret)
593 {
595 "Creating directory `%s' failed\n",
596 rdir);
597 GNUNET_free (rdir);
598 return GNUNET_SYSERR;
599 }
600 if (GNUNET_SYSERR == ret)
601 {
602 ret = mkdir (rdir,
603 S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH
604 | S_IXOTH); /* 755 */
605
606 if ((ret != 0) && (errno != EEXIST))
607 {
609 GNUNET_free (rdir);
610 return GNUNET_SYSERR;
611 }
612 }
613 rdir[pos] = DIR_SEPARATOR;
614 }
615 pos++;
616 }
617 GNUNET_free (rdir);
618 return GNUNET_OK;
619}
static char * dir
Set to the directory where runtime files are stored.
Definition: gnunet-arm.c:88
#define GNUNET_log(kind,...)

References dir, 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, LOG_STRERROR_FILE, and ret.

Referenced by create_service(), ensure_folder_exist(), GNUNET_DISK_directory_create_for_file(), init_pabc_dir(), iterate_save_members(), iterate_save_session(), jwks_endpoint(), run(), save_member(), save_member_store(), save_operation_store(), save_srv_room(), token_endpoint(), and write_benchmark_data().

Here is the call graph for this function:
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
fnthe filename to canonicalize

Definition at line 1202 of file disk.c.

1203{
1204 char *idx;
1205 char c;
1206
1207 for (idx = fn; *idx; idx++)
1208 {
1209 c = *idx;
1210
1211 if ((c == '/') || (c == '\\') || (c == ':') || (c == '*') || (c == '?') ||
1212 (c ==
1213 '"')
1214 ||
1215 (c == '<') || (c == '>') || (c == '|') )
1216 {
1217 *idx = '_';
1218 }
1219 }
1220}

Referenced by progress_cb().

Here is the caller graph for this function:

◆ GNUNET_DISK_file_change_owner()

enum GNUNET_GenericReturnValue GNUNET_DISK_file_change_owner ( const char *  filename,
const char *  user 
)

Change owner of a file.

Parameters
filenamefile to change
usernew owner of the file
Returns
GNUNET_OK on success, GNUNET_SYSERR on failure

Definition at line 1224 of file disk.c.

1226{
1227 struct passwd *pws;
1228
1229 pws = getpwnam (user);
1230 if (NULL == pws)
1231 {
1233 _ ("Cannot obtain information about user `%s': %s\n"),
1234 user,
1235 strerror (errno));
1236 return GNUNET_SYSERR;
1237 }
1238 if (0 != chown (filename, pws->pw_uid, pws->pw_gid))
1239 {
1241 return GNUNET_SYSERR;
1242 }
1243 return GNUNET_OK;
1244}
#define _(String)
GNU gettext support macro.
Definition: platform.h:179

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

◆ 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
hopen file handle
mhandle to the new mapping (will be set)
accessaccess specification, GNUNET_DISK_MAP_TYPE_xxx
lensize of the mapping
Returns
pointer to the mapped memory region, NULL on failure

Definition at line 1394 of file disk.c.

1398{
1399 int prot;
1400
1401 if (NULL == h)
1402 {
1403 errno = EINVAL;
1404 return NULL;
1405 }
1406 prot = 0;
1407 if (access & GNUNET_DISK_MAP_TYPE_READ)
1408 prot = PROT_READ;
1409 if (access & GNUNET_DISK_MAP_TYPE_WRITE)
1410 prot |= PROT_WRITE;
1412 (*m)->addr = mmap (NULL, len, prot, MAP_SHARED, h->fd, 0);
1413 GNUNET_assert (NULL != (*m)->addr);
1414 if (MAP_FAILED == (*m)->addr)
1415 {
1416 GNUNET_free (*m);
1417 return NULL;
1418 }
1419 (*m)->len = len;
1420 return (*m)->addr;
1421}
#define MAP_FAILED
Definition: disk.c:1389
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:103
Handle for a memory-mapping operation.
Definition: disk.c:1375

References GNUNET_assert, GNUNET_DISK_MAP_TYPE_READ, GNUNET_DISK_MAP_TYPE_WRITE, GNUNET_free, GNUNET_new, h, m, and MAP_FAILED.

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

Here is the caller graph for this function:

◆ GNUNET_DISK_file_unmap()

enum GNUNET_GenericReturnValue GNUNET_DISK_file_unmap ( struct GNUNET_DISK_MapHandle h)

Unmap a file.

Parameters
hmapping handle
Returns
GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1425 of file disk.c.

1426{
1428
1429 if (NULL == h)
1430 {
1431 errno = EINVAL;
1432 return GNUNET_SYSERR;
1433 }
1434 ret = munmap (h->addr, h->len) != -1 ? GNUNET_OK : GNUNET_SYSERR;
1435 GNUNET_free (h);
1436 return ret;
1437}

References GNUNET_free, GNUNET_OK, GNUNET_SYSERR, h, and ret.

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

Here is the caller graph for this function:

◆ GNUNET_DISK_file_sync()

enum GNUNET_GenericReturnValue GNUNET_DISK_file_sync ( const struct GNUNET_DISK_FileHandle h)

Write file changes to disk.

Parameters
hhandle to an open file
Returns
GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1441 of file disk.c.

1442{
1443 if (h == NULL)
1444 {
1445 errno = EINVAL;
1446 return GNUNET_SYSERR;
1447 }
1448
1449#if ! defined(__linux__) || ! defined(GNU)
1450 return fsync (h->fd) == -1 ? GNUNET_SYSERR : GNUNET_OK;
1451#else
1452 return fdatasync (h->fd) == -1 ? GNUNET_SYSERR : GNUNET_OK;
1453#endif
1454}

References GNUNET_OK, GNUNET_SYSERR, and h.

Referenced by delete_store_message(), publicize_rm(), save_list_messages(), save_list_tunnels(), save_member_session_history(), save_message_store(), and save_peer_store().

Here is the caller graph for this function: