GNUnet  0.11.x
gnunet_disk_lib.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2001-2012 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
30 #ifndef GNUNET_DISK_LIB_H
31 #define GNUNET_DISK_LIB_H
32 
37 
42 {
47 
52 
57 };
58 
63 {
67  int fd;
68 };
69 
70 
71 /* we need size_t, and since it can be both unsigned int
72  or unsigned long long, this IS platform dependent;
73  but "stdlib.h" should be portable 'enough' to be
74  unconditionally available... */
75 #include <stdlib.h>
77 #include "gnunet_scheduler_lib.h"
78 
79 #ifdef __cplusplus
80 extern "C"
81 {
82 #if 0 /* keep Emacsens' auto-indent happy */
83 }
84 #endif
85 #endif
86 
87 
92 {
97 
102 
107 
112 
117 
122 
127 };
128 
133 {
138 
143 
148 };
149 
150 
155 {
160 
165 
170 
175 
180 
185 
190 
195 
200 
205 };
206 
207 
213 {
218 
223 
228 };
229 
230 
235 {
240 
245 };
246 
247 
256 
257 
267 GNUNET_DISK_file_test (const char *fil);
268 
269 
276 void
277 GNUNET_DISK_file_backup (const char *fil);
278 
279 
287 off_t
289  off_t offset,
290  enum GNUNET_DISK_Seek whence);
291 
292 
308 GNUNET_DISK_file_size (const char *filename,
309  uint64_t *size,
310  int include_symbolic_links,
311  int single_file_mode);
312 
313 
331  uint64_t *dev,
332  uint64_t *ino);
333 
334 
346 char *
347 GNUNET_DISK_mktemp (const char *t);
348 
349 
359 char *
360 GNUNET_DISK_mkdtemp (const char *t);
361 
362 
375 struct GNUNET_DISK_FileHandle *
376 GNUNET_DISK_file_open (const char *fn,
377  enum GNUNET_DISK_OpenFlags flags,
379 
380 
390  off_t *size);
391 
392 
397 {
398 
403 
408 
413 
419 
420 };
421 
422 
429 struct GNUNET_DISK_PipeHandle *
431 
432 
441 struct GNUNET_DISK_PipeHandle *
443  int fd[2]);
444 
445 
453 
454 
464  enum GNUNET_DISK_PipeEnd end);
465 
466 
479 struct GNUNET_DISK_FileHandle *
481  enum GNUNET_DISK_PipeEnd end);
482 
491 
492 
500 const struct GNUNET_DISK_FileHandle *
502  enum GNUNET_DISK_PipeEnd n);
503 
504 
514 void
515 GNUNET_DISK_fix_permissions (const char *fn,
516  int require_uid_match,
517  int require_gid_match);
518 
519 
526 struct GNUNET_DISK_FileHandle *
528 
529 
536 struct GNUNET_DISK_FileHandle *
538 
539 
548 ssize_t
550  void *result,
551  size_t len);
552 
553 
564 ssize_t
566  void *result,
567  size_t len);
568 
569 
578 ssize_t
579 GNUNET_DISK_fn_read (const char *fn,
580  void *result,
581  size_t len);
582 
583 
592 ssize_t
594  const void *buffer,
595  size_t n);
596 
597 
606 ssize_t
608  const void *buffer,
609  size_t n);
610 
611 
626 GNUNET_DISK_fn_write (const char *fn,
627  const void *buf,
628  size_t buf_size,
630 
631 
640 GNUNET_DISK_file_copy (const char *src,
641  const char *dst);
642 
643 
652 int
654  GNUNET_FileNameCallback callback,
655  void *callback_cls);
656 
657 
668 
669 
683 GNUNET_DISK_directory_test (const char *fil,
684  int is_readable);
685 
686 
695 
696 
704 void
706  const char *option);
707 
708 
716 GNUNET_DISK_directory_create (const char *dir);
717 
718 
723 void
725 
726 
735  const char *user);
736 
737 
741 struct GNUNET_DISK_MapHandle;
742 
743 
753 void *
755  struct GNUNET_DISK_MapHandle **m,
756  enum GNUNET_DISK_MapType access,
757  size_t len);
758 
759 
768 
769 
778 
779 
780 #if 0 /* keep Emacsens' auto-indent happy */
781 {
782 #endif
783 #ifdef __cplusplus
784 }
785 #endif
786 
787 /* ifndef GNUNET_DISK_LIB_H */
788 #endif
789  /* end of group */
791 
792 /* end of gnunet_disk_lib.h */
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...
Definition: disk.c:1498
enum GNUNET_GenericReturnValue GNUNET_DISK_file_handle_size(struct GNUNET_DISK_FileHandle *fh, off_t *size)
Get the size of an open file.
Definition: disk.c:193
Open the file for reading.
static char * cfg_filename
Name of the configuration file.
static char * dir
Set to the directory where runtime files are stored.
Definition: gnunet-arm.c:89
No special options, use non-blocking read/write operations.
Create file if it doesn&#39;t exist.
GNUNET_DISK_MapType
Specifies what type of memory map is desired.
static const char * dir_name
Top-level directory we monitor to auto-publish.
static int end
Set if we are to shutdown all services (including ARM).
Definition: gnunet-arm.c:34
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...
Definition: disk.c:241
enum GNUNET_GenericReturnValue GNUNET_DISK_file_unmap(struct GNUNET_DISK_MapHandle *h)
Unmap a file.
Definition: disk.c:1229
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:602
Read-write memory map.
Seek a relative position (from the current offset).
enum GNUNET_GenericReturnValue GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1126
GNUNET_FILE_Type
Type of a handle.
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.
Definition: disk.c:1198
Handle represents a file.
Everybody can execute.
Nobody is allowed to do anything to the file.
GNUNET_DISK_Seek
Constants for specifying how to seek.
GNUNET_GenericReturnValue
Named constants for return values.
Definition: gnunet_common.h:83
Append to the file.
int GNUNET_DISK_directory_scan(const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
Scan a directory for files.
Definition: disk.c:794
static struct GNUNET_SCHEDULER_Task * t
Main task.
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.
Definition: disk.c:206
static enum @8 mode
Should we do a PUT (mode = 0) or GET (mode = 1);.
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.
Definition: disk.c:1436
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:104
char * GNUNET_DISK_mktemp(const char *t)
Create an (empty) temporary file on disk.
Definition: disk.c:381
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
enum GNUNET_GenericReturnValue GNUNET_DISK_file_copy(const char *src, const char *dst)
Copy a file.
Definition: disk.c:944
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.
Definition: disk.c:1378
static char * fn
Filename of the unique file.
Truncate file if it exists.
enum GNUNET_GenericReturnValue GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:1405
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:666
Read-only memory map.
static char * option
Name of the option.
Definition: gnunet-config.c:38
static char buf[2048]
static char * filename
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:1279
static int result
Global testing status.
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:1352
GNUNET_DISK_AccessPermissions
File access permissions, UNIX-style.
The writing-end of a pipe.
The reading-end of a pipe.
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create(const char *dir)
Implementation of "mkdir -p".
Definition: disk.c:476
static int fh
Handle to the unique file.
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 ...
Definition: disk.c:360
enum GNUNET_GenericReturnValue GNUNET_DISK_file_change_owner(const char *filename, const char *user)
Change owner of a file.
Definition: disk.c:1031
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.
Definition: disk.c:681
struct GNUNET_DISK_PipeHandle * GNUNET_DISK_pipe(enum GNUNET_DISK_PipeFlags pf)
Creates an interprocess channel.
Definition: disk.c:1262
Handle represents a pipe.
GNUNET_DISK_PipeFlags
Flags for GNUNET_DISK_pipe().
static unsigned int size
Size of the "table".
Definition: peer.c:67
Seek an absolute position from the end of the file.
Everybody can write.
Open the file for writing.
char * GNUNET_DISK_mkdtemp(const char *t)
Create an (empty) temporary directory on disk.
Definition: disk.c:340
Configure write end to block when writing if set.
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.
Definition: disk.c:705
enum GNUNET_GenericReturnValue GNUNET_DISK_handle_invalid(const struct GNUNET_DISK_FileHandle *h)
Checks whether a handle is invalid.
Definition: disk.c:186
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:222
Everybody can read.
struct GNUNET_DISK_FileHandle * GNUNET_DISK_get_handle_from_int_fd(int fno)
Get a handle from a native integer FD.
Definition: disk.c:1148
Seek an absolute position (from the start of the file).
enum GNUNET_GenericReturnValue GNUNET_DISK_file_sync(const struct GNUNET_DISK_FileHandle *h)
Write file changes to disk.
Definition: disk.c:1245
enum GNUNET_GenericReturnValue(* GNUNET_FileNameCallback)(void *cls, const char *filename)
Function called with a filename.
GNUNET_DISK_OpenFlags
Specifies how a file should be opened.
Configure both pipe ends for blocking operations if set.
Handle represents an event.
Open the file for both reading and writing.
Write-able memory map.
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.
Definition: disk.c:321
int fd
File handle on Unix-like systems.
Fail if file already exists.
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_remove(const char *filename)
Remove all files in a directory (rm -rf).
Definition: disk.c:905
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.
Definition: disk.c:616
struct GNUNET_DISK_FileHandle * GNUNET_DISK_get_handle_from_native(FILE *fd)
Get a handle from a native FD.
Definition: disk.c:1164
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create_for_file(const char *filename)
Create the directory structure for storing a file.
Definition: disk.c:562
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:1055
GNUNET_DISK_PipeEnd
Enumeration identifying the two ends of a pipe.
Handle used to access files (and pipes).
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_test(const char *fil, int is_readable)
Test if fil is a directory and listable.
Definition: disk.c:404
Handle used to manage a pipe.
Definition: disk.c:68
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:437
ssize_t GNUNET_DISK_fn_read(const char *fn, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:644
void GNUNET_DISK_filename_canonicalize(char *fn)
Removes special characters as &#39;:&#39; from a filename.
Definition: disk.c:1009
Handle for a memory-mapping operation.
Definition: disk.c:1178
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...
Configure read end to block when reading if set.