2 This file is part of GNUnet.
3 (C) 2001--2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 * @brief disk IO convenience methods
24 * @author Christian Grothoff
29 #include "gnunet_directories.h"
30 #include "gnunet_util_lib.h"
33 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
35 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
37 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
40 * Block size for IO for copying files.
42 #define COPY_BLK_SIZE 65536
44 #include <sys/types.h>
49 #include <sys/param.h>
52 #include <sys/mount.h>
54 #if HAVE_SYS_STATVFS_H
55 #include <sys/statvfs.h>
59 #define _IFMT 0170000 /* type of file */
60 #define _IFLNK 0120000 /* symbolic link */
61 #define S_ISLNK(m) (((m)&_IFMT) == _IFLNK)
66 * Handle used to manage a pipe.
68 struct GNUNET_DISK_PipeHandle
71 * File descriptors for the pipe.
72 * One or both of them could be NULL.
74 struct GNUNET_DISK_FileHandle *fd[2];
79 * Closure for the recursion to determine the file size
82 struct GetFileSizeData
85 * Set to the total file size.
90 * GNUNET_YES if symbolic links should be included.
92 int include_sym_links;
95 * GNUNET_YES if mode is file-only (return total == -1 for directories).
103 * Translate GNUnet-internal permission bitmap to UNIX file
104 * access permission bitmap.
106 * @param perm file permissions, GNUnet style
107 * @return file permissions, UNIX style
110 translate_unix_perms (enum GNUNET_DISK_AccessPermissions perm)
115 if (perm & GNUNET_DISK_PERM_USER_READ)
117 if (perm & GNUNET_DISK_PERM_USER_WRITE)
119 if (perm & GNUNET_DISK_PERM_USER_EXEC)
121 if (perm & GNUNET_DISK_PERM_GROUP_READ)
123 if (perm & GNUNET_DISK_PERM_GROUP_WRITE)
125 if (perm & GNUNET_DISK_PERM_GROUP_EXEC)
127 if (perm & GNUNET_DISK_PERM_OTHER_READ)
129 if (perm & GNUNET_DISK_PERM_OTHER_WRITE)
131 if (perm & GNUNET_DISK_PERM_OTHER_EXEC)
140 * Iterate over all files in the given directory and
141 * accumulate their size.
143 * @param cls closure of type `struct GetFileSizeData`
144 * @param fn current filename we are looking at
145 * @return #GNUNET_SYSERR on serious errors, otherwise #GNUNET_OK
148 getSizeRec (void *cls, const char *fn)
150 struct GetFileSizeData *gfsd = cls;
152 #if defined (HAVE_STAT64) && !(defined (_FILE_OFFSET_BITS) && _FILE_OFFSET_BITS == 64)
155 if (0 != STAT64 (fn, &buf))
157 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "stat64", fn);
158 return GNUNET_SYSERR;
163 if (0 != STAT (fn, &buf))
165 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "stat", fn);
166 return GNUNET_SYSERR;
169 if ((S_ISDIR (buf.st_mode)) && (gfsd->single_file_mode == GNUNET_YES))
172 return GNUNET_SYSERR;
174 if ((!S_ISLNK (buf.st_mode)) || (gfsd->include_sym_links == GNUNET_YES))
175 gfsd->total += buf.st_size;
176 if ((S_ISDIR (buf.st_mode)) && (0 == ACCESS (fn, X_OK)) &&
177 ((!S_ISLNK (buf.st_mode)) || (gfsd->include_sym_links == GNUNET_YES)))
179 if (GNUNET_SYSERR == GNUNET_DISK_directory_scan (fn, &getSizeRec, gfsd))
180 return GNUNET_SYSERR;
187 * Checks whether a handle is invalid
189 * @param h handle to check
190 * @return #GNUNET_YES if invalid, #GNUNET_NO if valid
193 GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h)
196 return ((!h) || (h->h == INVALID_HANDLE_VALUE)) ? GNUNET_YES : GNUNET_NO;
198 return ((!h) || (h->fd == -1)) ? GNUNET_YES : GNUNET_NO;
203 * Get the size of an open file.
205 * @param fh open file handle
206 * @param size where to write size of the file
207 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
210 GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle *fh,
216 b = GetFileSizeEx (fh->h, &li);
219 SetErrnoFromWinError (GetLastError ());
220 return GNUNET_SYSERR;
222 *size = (off_t) li.QuadPart;
226 if (0 != FSTAT (fh->fd, &sbuf))
227 return GNUNET_SYSERR;
228 *size = sbuf.st_size;
235 * Move the read/write pointer in a file
237 * @param h handle of an open file
238 * @param offset position to move to
239 * @param whence specification to which position the offset parameter relates to
240 * @return the new position on success, #GNUNET_SYSERR otherwise
243 GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle * h, off_t offset,
244 enum GNUNET_DISK_Seek whence)
249 return GNUNET_SYSERR;
254 LARGE_INTEGER new_pos;
257 static DWORD t[] = { FILE_BEGIN, FILE_CURRENT, FILE_END };
258 li.QuadPart = offset;
260 b = SetFilePointerEx (h->h, li, &new_pos, t[whence]);
263 SetErrnoFromWinError (GetLastError ());
264 return GNUNET_SYSERR;
266 return (off_t) new_pos.QuadPart;
268 static int t[] = { SEEK_SET, SEEK_CUR, SEEK_END };
270 return lseek (h->fd, offset, t[whence]);
276 * Get the size of the file (or directory) of the given file (in
279 * @param filename name of the file or directory
280 * @param size set to the size of the file (or,
281 * in the case of directories, the sum
282 * of all sizes of files in the directory)
283 * @param include_symbolic_links should symbolic links be
285 * @param single_file_mode #GNUNET_YES to only get size of one file
286 * and return #GNUNET_SYSERR for directories.
287 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
290 GNUNET_DISK_file_size (const char *filename,
292 int include_symbolic_links,
293 int single_file_mode)
295 struct GetFileSizeData gfsd;
298 GNUNET_assert (size != NULL);
300 gfsd.include_sym_links = include_symbolic_links;
301 gfsd.single_file_mode = single_file_mode;
302 ret = getSizeRec (&gfsd, filename);
309 * Obtain some unique identifiers for the given file
310 * that can be used to identify it in the local system.
311 * This function is used between GNUnet processes to
312 * quickly check if two files with the same absolute path
313 * are actually identical. The two processes represent
314 * the same peer but may communicate over the network
315 * (and the file may be on an NFS volume). This function
316 * may not be supported on all operating systems.
318 * @param filename name of the file
319 * @param dev set to the device ID
320 * @param ino set to the inode ID
321 * @return #GNUNET_OK on success
324 GNUNET_DISK_file_get_identifiers (const char *filename, uint64_t * dev,
329 // FIXME NILS: test this
330 struct GNUNET_DISK_FileHandle *fh;
331 BY_HANDLE_FILE_INFORMATION info;
334 fh = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ, 0);
336 return GNUNET_SYSERR;
337 succ = GetFileInformationByHandle (fh->h, &info);
338 GNUNET_DISK_file_close (fh);
341 return GNUNET_SYSERR;
343 *dev = info.dwVolumeSerialNumber;
344 *ino = ((((uint64_t) info.nFileIndexHigh) << (sizeof (DWORD) * 8)) | info.nFileIndexLow);
351 if (0 != stat (filename, &sbuf))
353 return GNUNET_SYSERR;
355 *ino = (uint64_t) sbuf.st_ino;
364 if (0 != statvfs (filename, &fbuf))
366 return GNUNET_SYSERR;
368 *dev = (uint64_t) fbuf.f_fsid;
374 if (0 != statfs (filename, &fbuf))
376 return GNUNET_SYSERR;
378 *dev = ((uint64_t) fbuf.f_fsid.val[0]) << 32 ||
379 ((uint64_t) fbuf.f_fsid.val[1]);
384 #endif /* !WINDOWS */
390 * Create the name for a temporary file or directory from a template.
392 * @param t template (without XXXXX or "/tmp/")
393 * @return name ready for passing to 'mktemp' or 'mkdtemp', NULL on error
396 mktemp_name (const char *t)
402 if ((t[0] != '/') && (t[0] != '\\')
404 && !(isalpha ((int) t[0]) && (t[0] != '\0') && (t[1] == ':'))
408 /* FIXME: This uses system codepage on W32, not UTF-8 */
409 tmpdir = getenv ("TMPDIR");
411 tmpdir = getenv ("TMP");
413 tmpdir = getenv ("TEMP");
416 GNUNET_asprintf (&tmpl, "%s/%s%s", tmpdir, t, "XXXXXX");
420 GNUNET_asprintf (&tmpl, "%s%s", t, "XXXXXX");
423 fn = (char *) GNUNET_malloc (MAX_PATH + 1);
424 if (ERROR_SUCCESS != plibc_conv_to_win_path (tmpl, fn))
447 tfn = GNUNET_strdup (fn);
448 random_fn = _mktemp (tfn);
449 if (NULL == random_fn)
454 /* FIXME: assume fn to be UTF-8-encoded and do the right thing */
455 if (0 == CreateDirectoryA (tfn, NULL))
457 DWORD error = GetLastError ();
459 if (ERROR_ALREADY_EXISTS == error)
471 * Update POSIX permissions mask of a file on disk. If both argumets
472 * are #GNUNET_NO, the file is made world-read-write-executable (777).
474 * @param fn name of the file to update
475 * @param require_uid_match #GNUNET_YES means 700
476 * @param require_gid_match #GNUNET_YES means 770 unless @a require_uid_match is set
479 GNUNET_DISK_fix_permissions (const char *fn,
480 int require_uid_match,
481 int require_gid_match)
485 if (GNUNET_YES == require_uid_match)
486 mode = S_IRUSR | S_IWUSR | S_IXUSR;
487 else if (GNUNET_YES == require_gid_match)
488 mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP;
490 mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH;
491 if (0 != chmod (fn, mode))
492 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
500 * Create an (empty) temporary directory on disk. If the given name is not
501 * an absolute path, the current 'TMPDIR' will be prepended. In any case,
502 * 6 random characters will be appended to the name to create a unique
505 * @param t component to use for the name;
506 * does NOT contain "XXXXXX" or "/tmp/".
507 * @return NULL on error, otherwise name of fresh
508 * file on disk in directory for temporary files
511 GNUNET_DISK_mkdtemp (const char *t)
515 fn = mktemp_name (t);
516 if (fn != mkdtemp (fn))
518 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkstemp", fn);
527 * Move a file out of the way (create a backup) by
528 * renaming it to "orig.NUM~" where NUM is the smallest
529 * number that is not used yet.
531 * @param fil name of the file to back up
534 GNUNET_DISK_file_backup (const char *fil)
540 slen = strlen (fil) + 20;
541 target = GNUNET_malloc (slen);
545 GNUNET_snprintf (target, slen,
549 } while (0 == access (target, F_OK));
550 if (0 != rename (fil, target))
551 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
554 GNUNET_free (target);
559 * Create an (empty) temporary file on disk. If the given name is not
560 * an absolute path, the current 'TMPDIR' will be prepended. In any case,
561 * 6 random characters will be appended to the name to create a unique
564 * @param t component to use for the name;
565 * does NOT contain "XXXXXX" or "/tmp/".
566 * @return NULL on error, otherwise name of fresh
567 * file on disk in directory for temporary files
570 GNUNET_DISK_mktemp (const char *t)
575 fn = mktemp_name (t);
576 if (-1 == (fd = mkstemp (fn)))
578 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkstemp", fn);
583 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "close", fn);
589 * Test if @a fil is a directory and listable. Optionally, also check if the
590 * directory is readable. Will not print an error message if the directory does
591 * not exist. Will log errors if #GNUNET_SYSERR is returned (i.e., a file exists
592 * with the same name).
594 * @param fil filename to test
595 * @param is_readable GNUNET_YES to additionally check if @a fil is readable;
596 * #GNUNET_NO to disable this check
597 * @return #GNUNET_YES if yes, #GNUNET_NO if not; #GNUNET_SYSERR if it
598 * does not exist or stat'ed
601 GNUNET_DISK_directory_test (const char *fil, int is_readable)
603 struct stat filestat;
606 ret = STAT (fil, &filestat);
610 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "stat", fil);
611 return GNUNET_SYSERR;
613 if (!S_ISDIR (filestat.st_mode))
615 LOG (GNUNET_ERROR_TYPE_DEBUG,
616 "A file already exits with the same name %s\n", fil);
619 if (GNUNET_YES == is_readable)
620 ret = ACCESS (fil, R_OK | X_OK);
622 ret = ACCESS (fil, X_OK);
625 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "access", fil);
633 * Check that fil corresponds to a filename
634 * (of a file that exists and that is not a directory).
636 * @param fil filename to check
637 * @return #GNUNET_YES if yes, #GNUNET_NO if not a file, #GNUNET_SYSERR if something
638 * else (will print an error message in that case, too).
641 GNUNET_DISK_file_test (const char *fil)
643 struct stat filestat;
647 rdir = GNUNET_STRINGS_filename_expand (fil);
649 return GNUNET_SYSERR;
651 ret = STAT (rdir, &filestat);
656 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "stat", rdir);
658 return GNUNET_SYSERR;
663 if (!S_ISREG (filestat.st_mode))
668 if (ACCESS (rdir, F_OK) < 0)
670 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "access", rdir);
672 return GNUNET_SYSERR;
680 * Implementation of "mkdir -p"
682 * @param dir the directory to create
683 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
686 GNUNET_DISK_directory_create (const char *dir)
694 rdir = GNUNET_STRINGS_filename_expand (dir);
696 return GNUNET_SYSERR;
700 pos = 1; /* skip heading '/' */
702 /* Local or Network path? */
703 if (strncmp (rdir, "\\\\", 2) == 0)
708 if (rdir[pos] == '\\')
718 pos = 3; /* strlen("C:\\") */
721 /* Check which low level directories already exist */
723 rdir[len] = DIR_SEPARATOR;
726 if (DIR_SEPARATOR == rdir[pos2])
729 ret = GNUNET_DISK_directory_test (rdir, GNUNET_NO);
730 if (GNUNET_NO == ret)
733 return GNUNET_SYSERR;
735 rdir[pos2] = DIR_SEPARATOR;
736 if (GNUNET_YES == ret)
747 /* Start creating directories */
750 if ((rdir[pos] == DIR_SEPARATOR) || (pos == len))
753 ret = GNUNET_DISK_directory_test (rdir, GNUNET_NO);
754 if (GNUNET_NO == ret)
757 return GNUNET_SYSERR;
759 if (GNUNET_SYSERR == ret)
762 ret = mkdir (rdir, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH); /* 755 */
764 wchar_t wrdir[MAX_PATH + 1];
765 if (ERROR_SUCCESS == plibc_conv_to_win_pathwconv(rdir, wrdir))
766 ret = !CreateDirectoryW (wrdir, NULL);
770 if ((ret != 0) && (errno != EEXIST))
772 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkdir", rdir);
774 return GNUNET_SYSERR;
777 rdir[pos] = DIR_SEPARATOR;
787 * Create the directory structure for storing
790 * @param filename name of a file in the directory
791 * @returns #GNUNET_OK on success,
792 * #GNUNET_SYSERR on failure,
793 * #GNUNET_NO if the directory
794 * exists but is not writeable for us
797 GNUNET_DISK_directory_create_for_file (const char *filename)
803 rdir = GNUNET_STRINGS_filename_expand (filename);
805 return GNUNET_SYSERR;
807 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
810 ret = GNUNET_DISK_directory_create (rdir);
811 if ((ret == GNUNET_OK) && (0 != ACCESS (rdir, W_OK)))
819 * Read the contents of a binary file into a buffer.
821 * @param h handle to an open file
822 * @param result the buffer to write the result to
823 * @param len the maximum number of bytes to read
824 * @return the number of bytes read on success, #GNUNET_SYSERR on failure
827 GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h,
834 return GNUNET_SYSERR;
840 if (h->type != GNUNET_DISK_HANLDE_TYPE_PIPE)
842 if (!ReadFile (h->h, result, len, &bytes_read, NULL))
844 SetErrnoFromWinError (GetLastError ());
845 return GNUNET_SYSERR;
850 if (!ReadFile (h->h, result, len, &bytes_read, h->oOverlapRead))
852 if (GetLastError () != ERROR_IO_PENDING)
854 LOG (GNUNET_ERROR_TYPE_DEBUG, "Error reading from pipe: %u\n", GetLastError ());
855 SetErrnoFromWinError (GetLastError ());
856 return GNUNET_SYSERR;
858 LOG (GNUNET_ERROR_TYPE_DEBUG, "Will get overlapped result\n");
859 GetOverlappedResult (h->h, h->oOverlapRead, &bytes_read, TRUE);
861 LOG (GNUNET_ERROR_TYPE_DEBUG, "Read %u bytes from pipe\n", bytes_read);
865 return read (h->fd, result, len);
871 * Read the contents of a binary file into a buffer.
872 * Guarantees not to block (returns GNUNET_SYSERR and sets errno to EAGAIN
873 * when no data can be read).
875 * @param h handle to an open file
876 * @param result the buffer to write the result to
877 * @param len the maximum number of bytes to read
878 * @return the number of bytes read on success, #GNUNET_SYSERR on failure
881 GNUNET_DISK_file_read_non_blocking (const struct GNUNET_DISK_FileHandle *h,
888 return GNUNET_SYSERR;
894 if (h->type != GNUNET_DISK_HANLDE_TYPE_PIPE)
896 if (!ReadFile (h->h, result, len, &bytes_read, NULL))
898 SetErrnoFromWinError (GetLastError ());
899 return GNUNET_SYSERR;
904 if (!ReadFile (h->h, result, len, &bytes_read, h->oOverlapRead))
906 if (GetLastError () != ERROR_IO_PENDING)
908 LOG (GNUNET_ERROR_TYPE_DEBUG, "Error reading from pipe: %u\n", GetLastError ());
909 SetErrnoFromWinError (GetLastError ());
910 return GNUNET_SYSERR;
914 LOG (GNUNET_ERROR_TYPE_DEBUG,
915 "ReadFile() queued a read, cancelling\n");
918 return GNUNET_SYSERR;
921 LOG (GNUNET_ERROR_TYPE_DEBUG, "Read %u bytes\n", bytes_read);
928 /* set to non-blocking, read, then set back */
929 flags = fcntl (h->fd, F_GETFL);
930 if (0 == (flags & O_NONBLOCK))
931 (void) fcntl (h->fd, F_SETFL, flags | O_NONBLOCK);
932 ret = read (h->fd, result, len);
933 if (0 == (flags & O_NONBLOCK))
936 (void) fcntl (h->fd, F_SETFL, flags);
945 * Read the contents of a binary file into a buffer.
947 * @param fn file name
948 * @param result the buffer to write the result to
949 * @param len the maximum number of bytes to read
950 * @return number of bytes read, #GNUNET_SYSERR on failure
953 GNUNET_DISK_fn_read (const char *fn,
957 struct GNUNET_DISK_FileHandle *fh;
960 fh = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE);
962 return GNUNET_SYSERR;
963 ret = GNUNET_DISK_file_read (fh, result, len);
964 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
971 * Write a buffer to a file.
973 * @param h handle to open file
974 * @param buffer the data to write
975 * @param n number of bytes to write
976 * @return number of bytes written on success, #GNUNET_SYSERR on error
979 GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle * h,
980 const void *buffer, size_t n)
985 return GNUNET_SYSERR;
991 if (h->type != GNUNET_DISK_HANLDE_TYPE_PIPE)
993 if (!WriteFile (h->h, buffer, n, &bytes_written, NULL))
995 SetErrnoFromWinError (GetLastError ());
996 return GNUNET_SYSERR;
1001 LOG (GNUNET_ERROR_TYPE_DEBUG, "It is a pipe trying to write %u bytes\n", n);
1002 if (!WriteFile (h->h, buffer, n, &bytes_written, h->oOverlapWrite))
1004 if (GetLastError () != ERROR_IO_PENDING)
1006 SetErrnoFromWinError (GetLastError ());
1007 LOG (GNUNET_ERROR_TYPE_DEBUG, "Error writing to pipe: %u\n",
1009 return GNUNET_SYSERR;
1011 LOG (GNUNET_ERROR_TYPE_DEBUG, "Will get overlapped result\n");
1012 if (!GetOverlappedResult (h->h, h->oOverlapWrite, &bytes_written, TRUE))
1014 SetErrnoFromWinError (GetLastError ());
1015 LOG (GNUNET_ERROR_TYPE_DEBUG,
1016 "Error getting overlapped result while writing to pipe: %u\n",
1018 return GNUNET_SYSERR;
1024 if (!GetOverlappedResult (h->h, h->oOverlapWrite, &ovr, TRUE))
1026 LOG (GNUNET_ERROR_TYPE_DEBUG,
1027 "Error getting control overlapped result while writing to pipe: %u\n",
1032 LOG (GNUNET_ERROR_TYPE_DEBUG,
1033 "Wrote %u bytes (ovr says %u), picking the greatest\n",
1034 bytes_written, ovr);
1037 if (bytes_written == 0)
1041 LOG (GNUNET_ERROR_TYPE_DEBUG, "Wrote %u bytes, returning -1 with EAGAIN\n", bytes_written);
1043 return GNUNET_SYSERR;
1046 LOG (GNUNET_ERROR_TYPE_DEBUG, "Wrote %u bytes\n", bytes_written);
1048 return bytes_written;
1050 return write (h->fd, buffer, n);
1056 * Write a buffer to a file, blocking, if necessary.
1058 * @param h handle to open file
1059 * @param buffer the data to write
1060 * @param n number of bytes to write
1061 * @return number of bytes written on success, #GNUNET_SYSERR on error
1064 GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle * h,
1071 return GNUNET_SYSERR;
1075 DWORD bytes_written;
1076 /* We do a non-overlapped write, which is as blocking as it gets */
1077 LOG (GNUNET_ERROR_TYPE_DEBUG, "Writing %u bytes\n", n);
1078 if (!WriteFile (h->h, buffer, n, &bytes_written, NULL))
1080 SetErrnoFromWinError (GetLastError ());
1081 LOG (GNUNET_ERROR_TYPE_DEBUG, "Error writing to pipe: %u\n",
1083 return GNUNET_SYSERR;
1085 if (bytes_written == 0 && n > 0)
1087 LOG (GNUNET_ERROR_TYPE_DEBUG, "Waiting for pipe to clean\n");
1088 WaitForSingleObject (h->h, INFINITE);
1089 if (!WriteFile (h->h, buffer, n, &bytes_written, NULL))
1091 SetErrnoFromWinError (GetLastError ());
1092 LOG (GNUNET_ERROR_TYPE_DEBUG, "Error writing to pipe: %u\n",
1094 return GNUNET_SYSERR;
1097 LOG (GNUNET_ERROR_TYPE_DEBUG,
1100 return bytes_written;
1105 /* set to blocking, write, then set back */
1106 flags = fcntl (h->fd, F_GETFL);
1107 if (0 != (flags & O_NONBLOCK))
1108 (void) fcntl (h->fd, F_SETFL, flags - O_NONBLOCK);
1109 ret = write (h->fd, buffer, n);
1110 if (0 == (flags & O_NONBLOCK))
1111 (void) fcntl (h->fd, F_SETFL, flags);
1118 * Write a buffer to a file. If the file is longer than the
1119 * number of bytes that will be written, it will be truncated.
1121 * @param fn file name
1122 * @param buffer the data to write
1123 * @param n number of bytes to write
1124 * @param mode file permissions
1125 * @return number of bytes written on success, #GNUNET_SYSERR on error
1128 GNUNET_DISK_fn_write (const char *fn, const void *buffer, size_t n,
1129 enum GNUNET_DISK_AccessPermissions mode)
1131 struct GNUNET_DISK_FileHandle *fh;
1134 fh = GNUNET_DISK_file_open (fn,
1135 GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_TRUNCATE
1136 | GNUNET_DISK_OPEN_CREATE, mode);
1138 return GNUNET_SYSERR;
1139 ret = GNUNET_DISK_file_write (fh, buffer, n);
1140 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
1146 * Scan a directory for files.
1148 * @param dir_name the name of the directory
1149 * @param callback the method to call for each file,
1150 * can be NULL, in that case, we only count
1151 * @param callback_cls closure for @a callback
1152 * @return the number of files found, #GNUNET_SYSERR on error or
1153 * ieration aborted by callback returning #GNUNET_SYSERR
1156 GNUNET_DISK_directory_scan (const char *dir_name,
1157 GNUNET_FileNameCallback callback,
1161 struct dirent *finfo;
1167 unsigned int name_len;
1168 unsigned int n_size;
1170 GNUNET_assert (dir_name != NULL);
1171 dname = GNUNET_STRINGS_filename_expand (dir_name);
1173 return GNUNET_SYSERR;
1174 while ((strlen (dname) > 0) && (dname[strlen (dname) - 1] == DIR_SEPARATOR))
1175 dname[strlen (dname) - 1] = '\0';
1176 if (0 != STAT (dname, &istat))
1178 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "stat", dname);
1179 GNUNET_free (dname);
1180 return GNUNET_SYSERR;
1182 if (!S_ISDIR (istat.st_mode))
1184 LOG (GNUNET_ERROR_TYPE_WARNING,
1185 _("Expected `%s' to be a directory!\n"),
1187 GNUNET_free (dname);
1188 return GNUNET_SYSERR;
1191 dinfo = OPENDIR (dname);
1192 if ((errno == EACCES) || (dinfo == NULL))
1194 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "opendir", dname);
1197 GNUNET_free (dname);
1198 return GNUNET_SYSERR;
1201 n_size = strlen (dname) + name_len + 2;
1202 name = GNUNET_malloc (n_size);
1203 while ((finfo = READDIR (dinfo)) != NULL)
1205 if ((0 == strcmp (finfo->d_name, ".")) ||
1206 (0 == strcmp (finfo->d_name, "..")))
1208 if (callback != NULL)
1210 if (name_len < strlen (finfo->d_name))
1213 name_len = strlen (finfo->d_name);
1214 n_size = strlen (dname) + name_len + 2;
1215 name = GNUNET_malloc (n_size);
1217 /* dname can end in "/" only if dname == "/";
1218 * if dname does not end in "/", we need to add
1219 * a "/" (otherwise, we must not!) */
1220 GNUNET_snprintf (name, n_size, "%s%s%s", dname,
1221 (strcmp (dname, DIR_SEPARATOR_STR) ==
1222 0) ? "" : DIR_SEPARATOR_STR, finfo->d_name);
1223 ret = callback (callback_cls, name);
1224 if (GNUNET_OK != ret)
1228 GNUNET_free (dname);
1229 if (GNUNET_NO == ret)
1231 return GNUNET_SYSERR;
1238 GNUNET_free (dname);
1244 * Opaque handle used for iterating over a directory.
1246 struct GNUNET_DISK_DirectoryIterator
1250 * Function to call on directory entries.
1252 GNUNET_DISK_DirectoryIteratorCallback callback;
1255 * Closure for callback.
1260 * Reference to directory.
1270 * Next filename to process.
1277 enum GNUNET_SCHEDULER_Priority priority;
1283 * Task used by the directory iterator.
1286 directory_iterator_task (void *cls,
1287 const struct GNUNET_SCHEDULER_TaskContext *tc)
1289 struct GNUNET_DISK_DirectoryIterator *iter = cls;
1292 name = iter->next_name;
1293 GNUNET_assert (name != NULL);
1294 iter->next_name = NULL;
1295 iter->callback (iter->callback_cls, iter, name, iter->dirname);
1301 * This function must be called during the DiskIteratorCallback
1302 * (exactly once) to schedule the task to process the next
1303 * filename in the directory (if there is one).
1305 * @param iter opaque handle for the iterator
1306 * @param can set to GNUNET_YES to terminate the iteration early
1307 * @return GNUNET_YES if iteration will continue,
1308 * GNUNET_NO if this was the last entry (and iteration is complete),
1309 * GNUNET_SYSERR if abort was YES
1312 GNUNET_DISK_directory_iterator_next (struct GNUNET_DISK_DirectoryIterator *iter,
1315 struct dirent *finfo;
1317 GNUNET_assert (iter->next_name == NULL);
1318 if (can == GNUNET_YES)
1320 CLOSEDIR (iter->directory);
1321 GNUNET_free (iter->dirname);
1323 return GNUNET_SYSERR;
1325 while (NULL != (finfo = READDIR (iter->directory)))
1327 if ((0 == strcmp (finfo->d_name, ".")) ||
1328 (0 == strcmp (finfo->d_name, "..")))
1330 GNUNET_asprintf (&iter->next_name, "%s%s%s", iter->dirname,
1331 DIR_SEPARATOR_STR, finfo->d_name);
1336 GNUNET_DISK_directory_iterator_next (iter, GNUNET_YES);
1339 GNUNET_SCHEDULER_add_with_priority (iter->priority, &directory_iterator_task,
1346 * Scan a directory for files using the scheduler to run a task for
1347 * each entry. The name of the directory must be expanded first (!).
1348 * If a scheduler does not need to be used, GNUNET_DISK_directory_scan
1349 * may provide a simpler API.
1351 * @param prio priority to use
1352 * @param dir_name the name of the directory
1353 * @param callback the method to call for each file
1354 * @param callback_cls closure for callback
1355 * @return GNUNET_YES if directory is not empty and 'callback'
1356 * will be called later, GNUNET_NO otherwise, GNUNET_SYSERR on error.
1359 GNUNET_DISK_directory_iterator_start (enum GNUNET_SCHEDULER_Priority prio,
1360 const char *dir_name,
1361 GNUNET_DISK_DirectoryIteratorCallback
1362 callback, void *callback_cls)
1364 struct GNUNET_DISK_DirectoryIterator *di;
1366 di = GNUNET_new (struct GNUNET_DISK_DirectoryIterator);
1367 di->callback = callback;
1368 di->callback_cls = callback_cls;
1369 di->directory = OPENDIR (dir_name);
1370 if (di->directory == NULL)
1373 callback (callback_cls, NULL, NULL, NULL);
1374 return GNUNET_SYSERR;
1376 di->dirname = GNUNET_strdup (dir_name);
1377 di->priority = prio;
1378 return GNUNET_DISK_directory_iterator_next (di, GNUNET_NO);
1383 * Function that removes the given directory by calling
1384 * "GNUNET_DISK_directory_remove".
1386 * @param unused not used
1387 * @param fn directory to remove
1391 remove_helper (void *unused, const char *fn)
1393 (void) GNUNET_DISK_directory_remove (fn);
1399 * Remove all files in a directory (rm -rf). Call with
1403 * @param filename the file to remove
1404 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1407 GNUNET_DISK_directory_remove (const char *filename)
1411 if (0 != LSTAT (filename, &istat))
1412 return GNUNET_NO; /* file may not exist... */
1413 (void) CHMOD (filename, S_IWUSR | S_IRUSR | S_IXUSR);
1414 if (UNLINK (filename) == 0)
1416 if ((errno != EISDIR) &&
1417 /* EISDIR is not sufficient in all cases, e.g.
1418 * sticky /tmp directory may result in EPERM on BSD.
1419 * So we also explicitly check "isDirectory" */
1420 (GNUNET_YES != GNUNET_DISK_directory_test (filename, GNUNET_YES)))
1422 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "rmdir", filename);
1423 return GNUNET_SYSERR;
1425 if (GNUNET_SYSERR ==
1426 GNUNET_DISK_directory_scan (filename, &remove_helper, NULL))
1427 return GNUNET_SYSERR;
1428 if (0 != RMDIR (filename))
1430 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "rmdir", filename);
1431 return GNUNET_SYSERR;
1440 * @param src file to copy
1441 * @param dst destination file name
1442 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1445 GNUNET_DISK_file_copy (const char *src,
1452 struct GNUNET_DISK_FileHandle *in;
1453 struct GNUNET_DISK_FileHandle *out;
1455 if (GNUNET_OK != GNUNET_DISK_file_size (src, &size, GNUNET_YES, GNUNET_YES))
1456 return GNUNET_SYSERR;
1458 in = GNUNET_DISK_file_open (src, GNUNET_DISK_OPEN_READ,
1459 GNUNET_DISK_PERM_NONE);
1461 return GNUNET_SYSERR;
1463 GNUNET_DISK_file_open (dst,
1464 GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_CREATE |
1465 GNUNET_DISK_OPEN_FAILIFEXISTS,
1466 GNUNET_DISK_PERM_USER_READ |
1467 GNUNET_DISK_PERM_USER_WRITE |
1468 GNUNET_DISK_PERM_GROUP_READ |
1469 GNUNET_DISK_PERM_GROUP_WRITE);
1472 GNUNET_DISK_file_close (in);
1473 return GNUNET_SYSERR;
1475 buf = GNUNET_malloc (COPY_BLK_SIZE);
1478 len = COPY_BLK_SIZE;
1479 if (len > size - pos)
1481 if (len != GNUNET_DISK_file_read (in, buf, len))
1483 if (len != GNUNET_DISK_file_write (out, buf, len))
1488 GNUNET_DISK_file_close (in);
1489 GNUNET_DISK_file_close (out);
1493 GNUNET_DISK_file_close (in);
1494 GNUNET_DISK_file_close (out);
1495 return GNUNET_SYSERR;
1500 * @brief Removes special characters as ':' from a filename.
1501 * @param fn the filename to canonicalize
1504 GNUNET_DISK_filename_canonicalize (char *fn)
1514 if (c == '/' || c == '\\' || c == ':' || c == '*' || c == '?' || c == '"' ||
1515 c == '<' || c == '>' || c == '|')
1527 * @brief Change owner of a file
1529 * @param filename name of file to change the owner of
1530 * @param user name of the new owner
1531 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1534 GNUNET_DISK_file_change_owner (const char *filename, const char *user)
1539 pws = getpwnam (user);
1542 LOG (GNUNET_ERROR_TYPE_ERROR,
1543 _("Cannot obtain information about user `%s': %s\n"), user,
1545 return GNUNET_SYSERR;
1547 if (0 != chown (filename, pws->pw_uid, pws->pw_gid))
1548 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "chown", filename);
1555 * Lock a part of a file
1556 * @param fh file handle
1557 * @param lock_start absolute position from where to lock
1558 * @param lock_end absolute position until where to lock
1559 * @param excl GNUNET_YES for an exclusive lock
1560 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1563 GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, off_t lock_start,
1564 off_t lock_end, int excl)
1569 return GNUNET_SYSERR;
1575 memset (&fl, 0, sizeof (struct flock));
1576 fl.l_type = excl ? F_WRLCK : F_RDLCK;
1577 fl.l_whence = SEEK_SET;
1578 fl.l_start = lock_start;
1579 fl.l_len = lock_end;
1581 return fcntl (fh->fd, F_SETLK, &fl) != 0 ? GNUNET_SYSERR : GNUNET_OK;
1584 off_t diff = lock_end - lock_start;
1585 DWORD diff_low, diff_high;
1586 diff_low = (DWORD) (diff & 0xFFFFFFFF);
1587 diff_high = (DWORD) ((diff >> (sizeof (DWORD) * 8)) & 0xFFFFFFFF);
1589 memset (&o, 0, sizeof (OVERLAPPED));
1590 o.Offset = (DWORD) (lock_start & 0xFFFFFFFF);;
1591 o.OffsetHigh = (DWORD) (((lock_start & ~0xFFFFFFFF) >> (sizeof (DWORD) * 8)) & 0xFFFFFFFF);
1594 (fh->h, (excl ? LOCKFILE_EXCLUSIVE_LOCK : 0) | LOCKFILE_FAIL_IMMEDIATELY,
1595 0, diff_low, diff_high, &o))
1597 SetErrnoFromWinError (GetLastError ());
1598 return GNUNET_SYSERR;
1607 * Unlock a part of a file
1608 * @param fh file handle
1609 * @param unlock_start absolute position from where to unlock
1610 * @param unlock_end absolute position until where to unlock
1611 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1614 GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, off_t unlock_start,
1620 return GNUNET_SYSERR;
1626 memset (&fl, 0, sizeof (struct flock));
1627 fl.l_type = F_UNLCK;
1628 fl.l_whence = SEEK_SET;
1629 fl.l_start = unlock_start;
1630 fl.l_len = unlock_end;
1632 return fcntl (fh->fd, F_SETLK, &fl) != 0 ? GNUNET_SYSERR : GNUNET_OK;
1635 off_t diff = unlock_end - unlock_start;
1636 DWORD diff_low, diff_high;
1637 diff_low = (DWORD) (diff & 0xFFFFFFFF);
1638 diff_high = (DWORD) ((diff >> (sizeof (DWORD) * 8)) & 0xFFFFFFFF);
1640 memset (&o, 0, sizeof (OVERLAPPED));
1641 o.Offset = (DWORD) (unlock_start & 0xFFFFFFFF);;
1642 o.OffsetHigh = (DWORD) (((unlock_start & ~0xFFFFFFFF) >> (sizeof (DWORD) * 8)) & 0xFFFFFFFF);
1644 if (!UnlockFileEx (fh->h, 0, diff_low, diff_high, &o))
1646 SetErrnoFromWinError (GetLastError ());
1647 return GNUNET_SYSERR;
1656 * Open a file. Note that the access permissions will only be
1657 * used if a new file is created and if the underlying operating
1658 * system supports the given permissions.
1660 * @param fn file name to be opened
1661 * @param flags opening flags, a combination of GNUNET_DISK_OPEN_xxx bit flags
1662 * @param perm permissions for the newly created file, use
1663 * #GNUNET_DISK_PERM_NONE if a file could not be created by this
1664 * call (because of flags)
1665 * @return IO handle on success, NULL on error
1667 struct GNUNET_DISK_FileHandle *
1668 GNUNET_DISK_file_open (const char *fn,
1669 enum GNUNET_DISK_OpenFlags flags,
1670 enum GNUNET_DISK_AccessPermissions perm)
1673 struct GNUNET_DISK_FileHandle *ret;
1679 wchar_t wexpfn[MAX_PATH + 1];
1686 expfn = GNUNET_STRINGS_filename_expand (fn);
1691 if (GNUNET_DISK_OPEN_READWRITE == (flags & GNUNET_DISK_OPEN_READWRITE))
1692 oflags = O_RDWR; /* note: O_RDWR is NOT always O_RDONLY | O_WRONLY */
1693 else if (flags & GNUNET_DISK_OPEN_READ)
1695 else if (flags & GNUNET_DISK_OPEN_WRITE)
1700 GNUNET_free (expfn);
1703 if (flags & GNUNET_DISK_OPEN_FAILIFEXISTS)
1704 oflags |= (O_CREAT | O_EXCL);
1705 if (flags & GNUNET_DISK_OPEN_TRUNCATE)
1707 if (flags & GNUNET_DISK_OPEN_APPEND)
1709 if (flags & GNUNET_DISK_OPEN_CREATE)
1711 (void) GNUNET_DISK_directory_create_for_file (expfn);
1713 mode = translate_unix_perms (perm);
1716 fd = open (expfn, oflags
1720 | O_LARGEFILE, mode);
1723 if (0 == (flags & GNUNET_DISK_OPEN_FAILIFEXISTS))
1724 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "open", expfn);
1726 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_DEBUG, "open", expfn);
1727 GNUNET_free (expfn);
1734 if (GNUNET_DISK_OPEN_READWRITE == (flags & GNUNET_DISK_OPEN_READWRITE))
1735 access = FILE_READ_DATA | FILE_WRITE_DATA;
1736 else if (flags & GNUNET_DISK_OPEN_READ)
1737 access = FILE_READ_DATA;
1738 else if (flags & GNUNET_DISK_OPEN_WRITE)
1739 access = FILE_WRITE_DATA;
1741 if (flags & GNUNET_DISK_OPEN_FAILIFEXISTS)
1745 else if (flags & GNUNET_DISK_OPEN_CREATE)
1747 (void) GNUNET_DISK_directory_create_for_file (expfn);
1748 if (flags & GNUNET_DISK_OPEN_TRUNCATE)
1749 disp = CREATE_ALWAYS;
1753 else if (flags & GNUNET_DISK_OPEN_TRUNCATE)
1755 disp = TRUNCATE_EXISTING;
1759 disp = OPEN_EXISTING;
1762 if (ERROR_SUCCESS == plibc_conv_to_win_pathwconv(expfn, wexpfn))
1763 h = CreateFileW (wexpfn, access,
1764 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
1765 disp, FILE_ATTRIBUTE_NORMAL, NULL);
1767 h = INVALID_HANDLE_VALUE;
1768 if (h == INVALID_HANDLE_VALUE)
1771 SetErrnoFromWinError (GetLastError ());
1773 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_INFO, "open", expfn);
1774 GNUNET_free (expfn);
1779 if (flags & GNUNET_DISK_OPEN_APPEND)
1780 if (SetFilePointer (h, 0, 0, FILE_END) == INVALID_SET_FILE_POINTER)
1782 SetErrnoFromWinError (GetLastError ());
1783 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "SetFilePointer", expfn);
1785 GNUNET_free (expfn);
1790 ret = GNUNET_new (struct GNUNET_DISK_FileHandle);
1793 ret->type = GNUNET_DISK_HANLDE_TYPE_FILE;
1797 GNUNET_free (expfn);
1803 * Close an open file
1804 * @param h file handle
1805 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
1808 GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h)
1814 return GNUNET_SYSERR;
1820 if (!CloseHandle (h->h))
1822 SetErrnoFromWinError (GetLastError ());
1823 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "close");
1824 ret = GNUNET_SYSERR;
1826 if (h->oOverlapRead)
1828 if (!CloseHandle (h->oOverlapRead->hEvent))
1830 SetErrnoFromWinError (GetLastError ());
1831 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "close");
1832 ret = GNUNET_SYSERR;
1834 GNUNET_free (h->oOverlapRead);
1836 if (h->oOverlapWrite)
1838 if (!CloseHandle (h->oOverlapWrite->hEvent))
1840 SetErrnoFromWinError (GetLastError ());
1841 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "close");
1842 ret = GNUNET_SYSERR;
1844 GNUNET_free (h->oOverlapWrite);
1847 if (close (h->fd) != 0)
1849 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "close");
1850 ret = GNUNET_SYSERR;
1859 * Get a GNUnet file handle from a W32 handle.
1861 * @param handle native handle
1862 * @return GNUnet file handle corresponding to the W32 handle
1864 struct GNUNET_DISK_FileHandle *
1865 GNUNET_DISK_get_handle_from_w32_handle (HANDLE osfh)
1867 struct GNUNET_DISK_FileHandle *fh;
1870 enum GNUNET_FILE_Type ftype;
1872 dwret = GetFileType (osfh);
1875 case FILE_TYPE_DISK:
1876 ftype = GNUNET_DISK_HANLDE_TYPE_FILE;
1878 case FILE_TYPE_PIPE:
1879 ftype = GNUNET_DISK_HANLDE_TYPE_PIPE;
1885 fh = GNUNET_new (struct GNUNET_DISK_FileHandle);
1889 if (ftype == GNUNET_DISK_HANLDE_TYPE_PIPE)
1892 * Note that we can't make it overlapped if it isn't already.
1893 * (ReOpenFile() is only available in 2003/Vista).
1894 * The process that opened this file in the first place (usually a parent
1895 * process, if this is stdin/stdout/stderr) must make it overlapped,
1896 * otherwise we're screwed, as selecting on non-overlapped handle
1899 fh->oOverlapRead = GNUNET_malloc (sizeof (OVERLAPPED));
1900 fh->oOverlapWrite = GNUNET_malloc (sizeof (OVERLAPPED));
1901 fh->oOverlapRead->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
1902 fh->oOverlapWrite->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
1910 * Get a handle from a native integer FD.
1912 * @param fno native integer file descriptor
1913 * @return file handle corresponding to the descriptor, NULL on error
1915 struct GNUNET_DISK_FileHandle *
1916 GNUNET_DISK_get_handle_from_int_fd (int fno)
1918 struct GNUNET_DISK_FileHandle *fh;
1920 if ( (((off_t) -1) == lseek (fno, 0, SEEK_CUR)) &&
1922 return NULL; /* invalid FD */
1925 fh = GNUNET_new (struct GNUNET_DISK_FileHandle);
1931 osfh = _get_osfhandle (fno);
1932 if (INVALID_HANDLE_VALUE == (HANDLE) osfh)
1935 fh = GNUNET_DISK_get_handle_from_w32_handle ((HANDLE) osfh);
1943 * Get a handle from a native streaming FD.
1945 * @param fd native streaming file descriptor
1946 * @return file handle corresponding to the descriptor
1948 struct GNUNET_DISK_FileHandle *
1949 GNUNET_DISK_get_handle_from_native (FILE *fd)
1957 return GNUNET_DISK_get_handle_from_int_fd (fno);
1962 * Handle for a memory-mapping operation.
1964 struct GNUNET_DISK_MapHandle
1967 * Address where the map is in memory.
1973 * Underlying OS handle.
1978 * Number of bytes mapped.
1986 #define MAP_FAILED ((void *) -1)
1990 * Map a file into memory
1992 * @param h open file handle
1993 * @param m handle to the new mapping
1994 * @param access access specification, GNUNET_DISK_MAP_TYPE_xxx
1995 * @param len size of the mapping
1996 * @return pointer to the mapped memory region, NULL on failure
1999 GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle *h,
2000 struct GNUNET_DISK_MapHandle **m,
2001 enum GNUNET_DISK_MapType access, size_t len)
2010 DWORD mapAccess, protect;
2012 if ((access & GNUNET_DISK_MAP_TYPE_READ) &&
2013 (access & GNUNET_DISK_MAP_TYPE_WRITE))
2015 protect = PAGE_READWRITE;
2016 mapAccess = FILE_MAP_ALL_ACCESS;
2018 else if (access & GNUNET_DISK_MAP_TYPE_READ)
2020 protect = PAGE_READONLY;
2021 mapAccess = FILE_MAP_READ;
2023 else if (access & GNUNET_DISK_MAP_TYPE_WRITE)
2025 protect = PAGE_READWRITE;
2026 mapAccess = FILE_MAP_WRITE;
2034 *m = GNUNET_new (struct GNUNET_DISK_MapHandle);
2035 (*m)->h = CreateFileMapping (h->h, NULL, protect, 0, 0, NULL);
2036 if ((*m)->h == INVALID_HANDLE_VALUE)
2038 SetErrnoFromWinError (GetLastError ());
2043 (*m)->addr = MapViewOfFile ((*m)->h, mapAccess, 0, 0, len);
2046 SetErrnoFromWinError (GetLastError ());
2047 CloseHandle ((*m)->h);
2056 if (access & GNUNET_DISK_MAP_TYPE_READ)
2058 if (access & GNUNET_DISK_MAP_TYPE_WRITE)
2060 *m = GNUNET_new (struct GNUNET_DISK_MapHandle);
2061 (*m)->addr = mmap (NULL, len, prot, MAP_SHARED, h->fd, 0);
2062 GNUNET_assert (NULL != (*m)->addr);
2063 if (MAP_FAILED == (*m)->addr)
2075 * @param h mapping handle
2076 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
2079 GNUNET_DISK_file_unmap (struct GNUNET_DISK_MapHandle *h)
2086 return GNUNET_SYSERR;
2090 ret = UnmapViewOfFile (h->addr) ? GNUNET_OK : GNUNET_SYSERR;
2091 if (ret != GNUNET_OK)
2092 SetErrnoFromWinError (GetLastError ());
2093 if (!CloseHandle (h->h) && (ret == GNUNET_OK))
2095 ret = GNUNET_SYSERR;
2096 SetErrnoFromWinError (GetLastError ());
2099 ret = munmap (h->addr, h->len) != -1 ? GNUNET_OK : GNUNET_SYSERR;
2107 * Write file changes to disk
2108 * @param h handle to an open file
2109 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
2112 GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h)
2117 return GNUNET_SYSERR;
2123 ret = FlushFileBuffers (h->h) ? GNUNET_OK : GNUNET_SYSERR;
2124 if (ret != GNUNET_OK)
2125 SetErrnoFromWinError (GetLastError ());
2127 #elif defined(FREEBSD) || defined(OPENBSD) || defined(DARWIN)
2128 return fsync (h->fd) == -1 ? GNUNET_SYSERR : GNUNET_OK;
2130 return fdatasync (h->fd) == -1 ? GNUNET_SYSERR : GNUNET_OK;
2137 #define PIPE_BUF 512
2139 /* Copyright Bob Byrnes <byrnes <at> curl.com>
2140 http://permalink.gmane.org/gmane.os.cygwin.patches/2121
2142 /* Create a pipe, and return handles to the read and write ends,
2143 just like CreatePipe, but ensure that the write end permits
2144 FILE_READ_ATTRIBUTES access, on later versions of win32 where
2145 this is supported. This access is needed by NtQueryInformationFile,
2146 which is used to implement select and nonblocking writes.
2147 Note that the return value is either NO_ERROR or GetLastError,
2148 unlike CreatePipe, which returns a bool for success or failure. */
2150 create_selectable_pipe (PHANDLE read_pipe_ptr, PHANDLE write_pipe_ptr,
2151 LPSECURITY_ATTRIBUTES sa_ptr, DWORD psize,
2152 DWORD dwReadMode, DWORD dwWriteMode)
2154 /* Default to error. */
2155 *read_pipe_ptr = *write_pipe_ptr = INVALID_HANDLE_VALUE;
2160 /* Ensure that there is enough pipe buffer space for atomic writes. */
2161 if (psize < PIPE_BUF)
2164 char pipename[MAX_PATH];
2166 /* Retry CreateNamedPipe as long as the pipe name is in use.
2167 * Retrying will probably never be necessary, but we want
2168 * to be as robust as possible. */
2171 static volatile LONG pipe_unique_id;
2173 snprintf (pipename, sizeof pipename, "\\\\.\\pipe\\gnunet-%d-%ld",
2174 getpid (), InterlockedIncrement ((LONG *) & pipe_unique_id));
2175 LOG (GNUNET_ERROR_TYPE_DEBUG, "CreateNamedPipe: name = %s, size = %lu\n",
2177 /* Use CreateNamedPipe instead of CreatePipe, because the latter
2178 * returns a write handle that does not permit FILE_READ_ATTRIBUTES
2179 * access, on versions of win32 earlier than WinXP SP2.
2180 * CreatePipe also stupidly creates a full duplex pipe, which is
2181 * a waste, since only a single direction is actually used.
2182 * It's important to only allow a single instance, to ensure that
2183 * the pipe was not created earlier by some other process, even if
2184 * the pid has been reused. */
2185 read_pipe = CreateNamedPipeA (pipename, PIPE_ACCESS_INBOUND | FILE_FLAG_FIRST_PIPE_INSTANCE | dwReadMode, PIPE_TYPE_BYTE | PIPE_READMODE_BYTE, 1, /* max instances */
2186 psize, /* output buffer size */
2187 psize, /* input buffer size */
2188 NMPWAIT_USE_DEFAULT_WAIT, sa_ptr);
2190 if (read_pipe != INVALID_HANDLE_VALUE)
2192 LOG (GNUNET_ERROR_TYPE_DEBUG, "pipe read handle = %p\n", read_pipe);
2196 DWORD err = GetLastError ();
2200 case ERROR_PIPE_BUSY:
2201 /* The pipe is already open with compatible parameters.
2202 * Pick a new name and retry. */
2203 LOG (GNUNET_ERROR_TYPE_DEBUG, "pipe busy, retrying\n");
2205 case ERROR_ACCESS_DENIED:
2206 /* The pipe is already open with incompatible parameters.
2207 * Pick a new name and retry. */
2208 LOG (GNUNET_ERROR_TYPE_DEBUG, "pipe access denied, retrying\n");
2210 case ERROR_CALL_NOT_IMPLEMENTED:
2211 /* We are on an older Win9x platform without named pipes.
2212 * Return an anonymous pipe as the best approximation. */
2213 LOG (GNUNET_ERROR_TYPE_DEBUG,
2214 "CreateNamedPipe not implemented, resorting to "
2215 "CreatePipe: size = %lu\n", psize);
2216 if (CreatePipe (read_pipe_ptr, write_pipe_ptr, sa_ptr, psize))
2218 LOG (GNUNET_ERROR_TYPE_DEBUG, "pipe read handle = %p, write handle = %p\n",
2223 err = GetLastError ();
2224 LOG (GNUNET_ERROR_TYPE_ERROR, "CreatePipe failed: %d\n", err);
2227 LOG (GNUNET_ERROR_TYPE_ERROR, "CreateNamedPipe failed: %d\n", err);
2232 LOG (GNUNET_ERROR_TYPE_DEBUG, "CreateFile: name = %s\n", pipename);
2234 /* Open the named pipe for writing.
2235 * Be sure to permit FILE_READ_ATTRIBUTES access. */
2236 write_pipe = CreateFileA (pipename, GENERIC_WRITE | FILE_READ_ATTRIBUTES, 0, /* share mode */
2237 sa_ptr, OPEN_EXISTING, dwWriteMode, /* flags and attributes */
2238 0); /* handle to template file */
2240 if (write_pipe == INVALID_HANDLE_VALUE)
2243 DWORD err = GetLastError ();
2245 LOG (GNUNET_ERROR_TYPE_DEBUG, "CreateFile failed: %d\n", err);
2246 CloseHandle (read_pipe);
2249 LOG (GNUNET_ERROR_TYPE_DEBUG, "pipe write handle = %p\n", write_pipe);
2251 *read_pipe_ptr = read_pipe;
2252 *write_pipe_ptr = write_pipe;
2259 * Creates an interprocess channel
2261 * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO
2262 * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO
2263 * @param inherit_read inherit the parent processes stdin (only for windows)
2264 * @param inherit_write inherit the parent processes stdout (only for windows)
2265 * @return handle to the new pipe, NULL on error
2267 struct GNUNET_DISK_PipeHandle *
2268 GNUNET_DISK_pipe (int blocking_read, int blocking_write, int inherit_read, int inherit_write)
2279 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "pipe");
2283 return GNUNET_DISK_pipe_from_fd (blocking_read,
2287 struct GNUNET_DISK_PipeHandle *p;
2292 p = GNUNET_new (struct GNUNET_DISK_PipeHandle);
2293 p->fd[0] = GNUNET_new (struct GNUNET_DISK_FileHandle);
2294 p->fd[1] = GNUNET_new (struct GNUNET_DISK_FileHandle);
2296 /* All pipes are overlapped. If you want them to block - just
2297 * call WriteFile() and ReadFile() with NULL overlapped pointer.
2298 * NOTE: calling with NULL overlapped pointer works only
2299 * for pipes, and doesn't seem to be a documented feature.
2300 * It will NOT work for files, because overlapped files need
2301 * to read offsets from the overlapped structure, regardless.
2302 * Pipes are not seekable, and need no offsets, which is
2303 * probably why it works for them.
2306 create_selectable_pipe (&p->fd[0]->h, &p->fd[1]->h, NULL, 0,
2307 FILE_FLAG_OVERLAPPED,
2308 FILE_FLAG_OVERLAPPED);
2311 SetErrnoFromWinError (GetLastError ());
2313 GNUNET_free (p->fd[0]);
2314 GNUNET_free (p->fd[1]);
2319 if (!DuplicateHandle
2320 (GetCurrentProcess (), p->fd[0]->h, GetCurrentProcess (), &tmp_handle, 0,
2321 inherit_read == GNUNET_YES ? TRUE : FALSE, DUPLICATE_SAME_ACCESS))
2323 SetErrnoFromWinError (GetLastError ());
2325 CloseHandle (p->fd[0]->h);
2326 CloseHandle (p->fd[1]->h);
2327 GNUNET_free (p->fd[0]);
2328 GNUNET_free (p->fd[1]);
2333 CloseHandle (p->fd[0]->h);
2334 p->fd[0]->h = tmp_handle;
2336 if (!DuplicateHandle
2337 (GetCurrentProcess (), p->fd[1]->h, GetCurrentProcess (), &tmp_handle, 0,
2338 inherit_write == GNUNET_YES ? TRUE : FALSE, DUPLICATE_SAME_ACCESS))
2340 SetErrnoFromWinError (GetLastError ());
2342 CloseHandle (p->fd[0]->h);
2343 CloseHandle (p->fd[1]->h);
2344 GNUNET_free (p->fd[0]);
2345 GNUNET_free (p->fd[1]);
2350 CloseHandle (p->fd[1]->h);
2351 p->fd[1]->h = tmp_handle;
2353 p->fd[0]->type = GNUNET_DISK_HANLDE_TYPE_PIPE;
2354 p->fd[1]->type = GNUNET_DISK_HANLDE_TYPE_PIPE;
2356 p->fd[0]->oOverlapRead = GNUNET_malloc (sizeof (OVERLAPPED));
2357 p->fd[0]->oOverlapWrite = GNUNET_malloc (sizeof (OVERLAPPED));
2358 p->fd[1]->oOverlapRead = GNUNET_malloc (sizeof (OVERLAPPED));
2359 p->fd[1]->oOverlapWrite = GNUNET_malloc (sizeof (OVERLAPPED));
2361 p->fd[0]->oOverlapRead->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
2362 p->fd[0]->oOverlapWrite->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
2364 p->fd[1]->oOverlapRead->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
2365 p->fd[1]->oOverlapWrite->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
2373 * Creates a pipe object from a couple of file descriptors.
2374 * Useful for wrapping existing pipe FDs.
2376 * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO
2377 * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO
2378 * @param fd an array of two fd values. One of them may be -1 for read-only or write-only pipes
2380 * @return handle to the new pipe, NULL on error
2382 struct GNUNET_DISK_PipeHandle *
2383 GNUNET_DISK_pipe_from_fd (int blocking_read, int blocking_write, int fd[2])
2385 struct GNUNET_DISK_PipeHandle *p;
2387 p = GNUNET_new (struct GNUNET_DISK_PipeHandle);
2392 int eno = 0; /* make gcc happy */
2397 p->fd[0] = GNUNET_new (struct GNUNET_DISK_FileHandle);
2398 p->fd[0]->fd = fd[0];
2401 flags = fcntl (fd[0], F_GETFL);
2402 flags |= O_NONBLOCK;
2403 if (0 > fcntl (fd[0], F_SETFL, flags))
2409 flags = fcntl (fd[0], F_GETFD);
2410 flags |= FD_CLOEXEC;
2411 if (0 > fcntl (fd[0], F_SETFD, flags))
2420 p->fd[1] = GNUNET_new (struct GNUNET_DISK_FileHandle);
2421 p->fd[1]->fd = fd[1];
2422 if (!blocking_write)
2424 flags = fcntl (fd[1], F_GETFL);
2425 flags |= O_NONBLOCK;
2426 if (0 > fcntl (fd[1], F_SETFL, flags))
2432 flags = fcntl (fd[1], F_GETFD);
2433 flags |= FD_CLOEXEC;
2434 if (0 > fcntl (fd[1], F_SETFD, flags))
2443 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "fcntl");
2444 if (p->fd[0]->fd >= 0)
2445 GNUNET_break (0 == close (p->fd[0]->fd));
2446 if (p->fd[1]->fd >= 0)
2447 GNUNET_break (0 == close (p->fd[1]->fd));
2448 GNUNET_free_non_null (p->fd[0]);
2449 GNUNET_free_non_null (p->fd[1]);
2457 p->fd[0] = GNUNET_new (struct GNUNET_DISK_FileHandle);
2458 p->fd[0]->h = (HANDLE) _get_osfhandle (fd[0]);
2459 if (p->fd[0]->h != INVALID_HANDLE_VALUE)
2461 p->fd[0]->type = GNUNET_DISK_HANLDE_TYPE_PIPE;
2462 p->fd[0]->oOverlapRead = GNUNET_malloc (sizeof (OVERLAPPED));
2463 p->fd[0]->oOverlapWrite = GNUNET_malloc (sizeof (OVERLAPPED));
2464 p->fd[0]->oOverlapRead->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
2465 p->fd[0]->oOverlapWrite->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
2469 GNUNET_free (p->fd[0]);
2475 p->fd[1] = GNUNET_new (struct GNUNET_DISK_FileHandle);
2476 p->fd[1]->h = (HANDLE) _get_osfhandle (fd[1]);
2477 if (p->fd[1]->h != INVALID_HANDLE_VALUE)
2479 p->fd[1]->type = GNUNET_DISK_HANLDE_TYPE_PIPE;
2480 p->fd[1]->oOverlapRead = GNUNET_malloc (sizeof (OVERLAPPED));
2481 p->fd[1]->oOverlapWrite = GNUNET_malloc (sizeof (OVERLAPPED));
2482 p->fd[1]->oOverlapRead->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
2483 p->fd[1]->oOverlapWrite->hEvent = CreateEvent (NULL, FALSE, FALSE, NULL);
2487 GNUNET_free (p->fd[1]);
2498 * Closes an interprocess channel
2500 * @param p pipe to close
2501 * @param end which end of the pipe to close
2502 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
2505 GNUNET_DISK_pipe_close_end (struct GNUNET_DISK_PipeHandle *p,
2506 enum GNUNET_DISK_PipeEnd end)
2508 int ret = GNUNET_OK;
2510 if (end == GNUNET_DISK_PIPE_END_READ)
2514 ret = GNUNET_DISK_file_close (p->fd[0]);
2518 else if (end == GNUNET_DISK_PIPE_END_WRITE)
2522 ret = GNUNET_DISK_file_close (p->fd[1]);
2531 * Detaches one of the ends from the pipe.
2532 * Detached end is a fully-functional FileHandle, it will
2533 * not be affected by anything you do with the pipe afterwards.
2534 * Each end of a pipe can only be detched from it once (i.e.
2535 * it is not duplicated).
2537 * @param p pipe to detach an end from
2538 * @param end which end of the pipe to detach
2539 * @return Detached end on success, NULL on failure
2540 * (or if that end is not present or is closed).
2542 struct GNUNET_DISK_FileHandle *
2543 GNUNET_DISK_pipe_detach_end (struct GNUNET_DISK_PipeHandle *p,
2544 enum GNUNET_DISK_PipeEnd end)
2546 struct GNUNET_DISK_FileHandle *ret = NULL;
2548 if (end == GNUNET_DISK_PIPE_END_READ)
2556 else if (end == GNUNET_DISK_PIPE_END_WRITE)
2570 * Closes an interprocess channel
2572 * @param p pipe to close
2573 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
2576 GNUNET_DISK_pipe_close (struct GNUNET_DISK_PipeHandle *p)
2578 int ret = GNUNET_OK;
2581 int write_end_close;
2582 int read_end_close_errno;
2583 int write_end_close_errno;
2585 read_end_close = GNUNET_DISK_pipe_close_end (p, GNUNET_DISK_PIPE_END_READ);
2586 read_end_close_errno = errno;
2587 write_end_close = GNUNET_DISK_pipe_close_end (p, GNUNET_DISK_PIPE_END_WRITE);
2588 write_end_close_errno = errno;
2591 if (GNUNET_OK != read_end_close)
2593 errno = read_end_close_errno;
2594 ret = read_end_close;
2596 else if (GNUNET_OK != write_end_close)
2598 errno = write_end_close_errno;
2599 ret = write_end_close;
2607 * Get the handle to a particular pipe end
2610 * @param n end to access
2611 * @return handle for the respective end
2613 const struct GNUNET_DISK_FileHandle *
2614 GNUNET_DISK_pipe_handle (const struct GNUNET_DISK_PipeHandle *p,
2615 enum GNUNET_DISK_PipeEnd n)
2619 case GNUNET_DISK_PIPE_END_READ:
2620 case GNUNET_DISK_PIPE_END_WRITE:
2630 * Retrieve OS file handle
2632 * @param fh GNUnet file descriptor
2633 * @param dst destination buffer
2634 * @param dst_len length of dst
2635 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
2638 GNUNET_DISK_internal_file_handle_ (const struct GNUNET_DISK_FileHandle *fh,
2639 void *dst, size_t dst_len)
2642 if (dst_len < sizeof (HANDLE))
2643 return GNUNET_SYSERR;
2644 *((HANDLE *) dst) = fh->h;
2646 if (dst_len < sizeof (int))
2647 return GNUNET_SYSERR;
2648 *((int *) dst) = fh->fd;