GNUnet  0.10.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 
46 
51 
56 };
57 
65  int fd;
66 };
67 
68 
69 /* we need size_t, and since it can be both unsigned int
70  or unsigned long long, this IS platform dependent;
71  but "stdlib.h" should be portable 'enough' to be
72  unconditionally available... */
73 #include <stdlib.h>
75 #include "gnunet_scheduler_lib.h"
76 
77 #ifdef __cplusplus
78 extern "C"
79 {
80 #if 0 /* keep Emacsens' auto-indent happy */
81 }
82 #endif
83 #endif
84 
85 
94 
99 
104 
109 
114 
119 
124 };
125 
134 
139 
144 };
145 
146 
155 
160 
165 
170 
175 
180 
185 
190 
195 
200 };
201 
202 
212 
217 
222 };
223 
224 
233 
238 };
239 
240 
247 int
249 
250 
259 int
260 GNUNET_DISK_file_test(const char *fil);
261 
262 
270 void
271 GNUNET_DISK_file_backup(const char *fil);
272 
273 
281 off_t
282 GNUNET_DISK_file_seek(const struct GNUNET_DISK_FileHandle *h, off_t offset,
283  enum GNUNET_DISK_Seek whence);
284 
285 
300 int
301 GNUNET_DISK_file_size(const char *filename,
302  uint64_t *size,
303  int include_symbolic_links,
304  int single_file_mode);
305 
306 
322 int
324  uint64_t *dev,
325  uint64_t *ino);
326 
327 
339 char *
340 GNUNET_DISK_mktemp(const char *t);
341 
342 
352 char *
353 GNUNET_DISK_mkdtemp(const char *t);
354 
355 
368 struct GNUNET_DISK_FileHandle *
369 GNUNET_DISK_file_open(const char *fn,
370  enum GNUNET_DISK_OpenFlags flags,
372 
373 
381 int
383  off_t *size);
384 
385 
395 struct GNUNET_DISK_PipeHandle *
396 GNUNET_DISK_pipe(int blocking_read,
397  int blocking_write,
398  int inherit_read,
399  int inherit_write);
400 
401 
412 struct GNUNET_DISK_PipeHandle *
413 GNUNET_DISK_pipe_from_fd(int blocking_read,
414  int blocking_write,
415  int fd[2]);
416 
417 
423 int
425 
426 
434 int
436  enum GNUNET_DISK_PipeEnd end);
437 
438 
451 struct GNUNET_DISK_FileHandle *
453  enum GNUNET_DISK_PipeEnd end);
454 
461 int
463 
464 
472 const struct GNUNET_DISK_FileHandle *
474  enum GNUNET_DISK_PipeEnd n);
475 
485 void
486 GNUNET_DISK_fix_permissions(const char *fn,
487  int require_uid_match,
488  int require_gid_match);
489 
490 
497 struct GNUNET_DISK_FileHandle *
499 
500 
507 struct GNUNET_DISK_FileHandle *
509 
510 
519 ssize_t
521  void *result,
522  size_t len);
523 
524 
535 ssize_t
537  void *result,
538  size_t len);
539 
540 
549 ssize_t
550 GNUNET_DISK_fn_read(const char *fn,
551  void *result,
552  size_t len);
553 
554 
563 ssize_t
565  const void *buffer,
566  size_t n);
567 
568 
577 ssize_t
579  const void *buffer,
580  size_t n);
581 
582 
593 ssize_t
594 GNUNET_DISK_fn_write(const char *fn,
595  const void *buffer,
596  size_t n,
598 
599 
607 int
608 GNUNET_DISK_file_copy(const char *src,
609  const char *dst);
610 
611 
620 int
622  GNUNET_FileNameCallback callback,
623  void *callback_cls);
624 
625 
634 int
636 
637 
650 int
651 GNUNET_DISK_directory_test(const char *fil, int is_readable);
652 
653 
661 int
663 
664 
672 void
674  const char *option);
675 
676 
683 int
684 GNUNET_DISK_directory_create(const char *dir);
685 
686 
696 int
698  off_t lock_start,
699  off_t lock_end, int excl);
700 
701 
710 int
712  off_t unlock_start,
713  off_t unlock_end);
714 
715 
720 void
722 
723 
730 int
732  const char *user);
733 
734 
738 struct GNUNET_DISK_MapHandle;
739 
740 
749 void *
751  struct GNUNET_DISK_MapHandle **m,
752  enum GNUNET_DISK_MapType access,
753  size_t len);
754 
755 
762 int
764 
765 
772 int
774 
775 
776 #if 0 /* keep Emacsens' auto-indent happy */
777 {
778 #endif
779 #ifdef __cplusplus
780 }
781 #endif
782 
783 /* ifndef GNUNET_DISK_LIB_H */
784 #endif
785  /* end of group */
787 
788 /* 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:1822
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)...
Definition: disk.c:541
Open the file for reading.
int GNUNET_DISK_file_sync(const struct GNUNET_DISK_FileHandle *h)
Write file changes to disk.
Definition: disk.c:1492
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:84
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.
int GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1339
int GNUNET_DISK_file_copy(const char *src, const char *dst)
Copy a file.
Definition: disk.c:1069
static int end
Set if we are to shutdown all services (including ARM).
Definition: gnunet-arm.c:34
int GNUNET_DISK_file_unlock(struct GNUNET_DISK_FileHandle *fh, off_t unlock_start, off_t unlock_end)
Unlock a part of a file.
Definition: disk.c:1227
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:729
int GNUNET_DISK_directory_create(const char *dir)
Implementation of "mkdir -p".
Definition: disk.c:586
Read-write memory map.
Seek a relative position (from the current offset).
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:1433
Handle represents a file.
Everybody can execute.
int GNUNET_DISK_directory_test(const char *fil, int is_readable)
Test if fil is a directory and listable.
Definition: disk.c:500
Nobody is allowed to do anything to the file.
GNUNET_DISK_Seek
Constants for specifying how to seek.
int GNUNET_DISK_directory_create_for_file(const char *filename)
Create the directory structure for storing a file.
Definition: disk.c:681
Append to the file.
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...
Definition: disk.c:288
int GNUNET_DISK_directory_scan(const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
Scan a directory for files.
Definition: disk.c:909
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:223
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.
Definition: disk.c:877
int GNUNET_DISK_handle_invalid(const struct GNUNET_DISK_FileHandle *h)
Checks whether a handle is invalid.
Definition: disk.c:190
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:1744
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:99
char * GNUNET_DISK_mktemp(const char *t)
Create an (empty) temporary file on disk.
Definition: disk.c:465
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
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:1673
static char * fn
Filename of the unique file.
Truncate file if it exists.
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:817
int GNUNET_DISK_directory_remove(const char *filename)
Remove all files in a directory (rm -rf).
Definition: disk.c:1026
Read-only memory map.
static char * option
Name of the option.
Definition: gnunet-config.c:38
static char * filename
static int result
Global testing status.
GNUNET_DISK_AccessPermissions
File access permissions, UNIX-style.
The writing-end of a pipe.
The reading-end of a pipe.
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:433
int(* GNUNET_FileNameCallback)(void *cls, const char *filename)
Function called with a filename.
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:841
struct GNUNET_DISK_PipeHandle * GNUNET_DISK_pipe(int blocking_read, int blocking_write, int inherit_read, int inherit_write)
Creates an interprocess channel.
Definition: disk.c:1518
Handle represents a pipe.
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.
Definition: disk.c:1195
static unsigned int size
Size of the "table".
Definition: peer.c:66
Seek an absolute position from the end of the file.
Everybody can write.
int GNUNET_DISK_file_unmap(struct GNUNET_DISK_MapHandle *h)
Unmap a file.
Definition: disk.c:1469
Open the file for writing.
char * GNUNET_DISK_mkdtemp(const char *t)
Create an (empty) temporary directory on disk.
Definition: disk.c:406
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).
Definition: disk.c:254
int GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:1706
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.
Definition: disk.c:1552
Everybody can read.
int 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:1635
struct GNUNET_DISK_FileHandle * GNUNET_DISK_get_handle_from_int_fd(int fno)
Get a handle from a native integer FD.
Definition: disk.c:1369
Seek an absolute position (from the start of the file).
int GNUNET_DISK_file_handle_size(struct GNUNET_DISK_FileHandle *fh, off_t *size)
Get the size of an open file.
Definition: disk.c:203
GNUNET_DISK_OpenFlags
Specifies how a file should be opened.
Handle represents an event.
Open the file for both reading and writing.
int GNUNET_DISK_file_change_owner(const char *filename, const char *user)
Change owner of a file.
Definition: disk.c:1163
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:376
int fd
File handle on Unix-like systems.
Fail if file already exists.
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:754
struct GNUNET_DISK_FileHandle * GNUNET_DISK_get_handle_from_native(FILE *fd)
Get a handle from a native FD.
Definition: disk.c:1391
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:1262
GNUNET_DISK_PipeEnd
Enumeration identifying the two ends of a pipe.
Handle used to access files (and pipes).
Handle used to manage a pipe.
Definition: disk.c:68
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:791
void GNUNET_DISK_filename_canonicalize(char *fn)
Removes special characters as &#39;:&#39; from a filename.
Definition: disk.c:1137
static enum @11 mode
Should we do a PUT (mode = 0) or GET (mode = 1);.
Handle for a memory-mapping operation.
Definition: disk.c:1406
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...