2 This file is part of GNUnet.
3 (C) 2006, 2009 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 2, 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.
22 * @brief functions for buffering IO
23 * @author Christian Grothoff
26 #include "gnunet_bio_lib.h"
27 #include "gnunet_disk_lib.h"
29 #define BIO_BUFFER_SIZE 65536
31 #define MAX_META_DATA (1024 * 1024)
34 * Handle for buffered reading.
36 struct GNUNET_BIO_ReadHandle
38 struct GNUNET_DISK_FileHandle *fd;
48 * Open a file for reading.
50 * @param fn file name to be opened
51 * @return IO handle on success, NULL on error
53 struct GNUNET_BIO_ReadHandle *
54 GNUNET_BIO_read_open (const char *fn)
56 struct GNUNET_DISK_FileHandle *fd;
57 struct GNUNET_BIO_ReadHandle *h;
59 fd = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE);
62 h = GNUNET_malloc (sizeof (struct GNUNET_BIO_ReadHandle) + BIO_BUFFER_SIZE);
63 h->buffer = (char *) &h[1];
64 h->size = BIO_BUFFER_SIZE;
71 * Close an open file. Reports if any errors reading
72 * from the file were encountered.
74 * @param h file handle
75 * @param emsg set to the error message
76 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
79 GNUNET_BIO_read_close (struct GNUNET_BIO_ReadHandle *h, char **emsg)
83 err = (NULL == h->emsg) ? GNUNET_OK : GNUNET_SYSERR;
87 GNUNET_free_non_null (h->emsg);
88 GNUNET_DISK_file_close (h->fd);
95 * Read the contents of a binary file into a buffer.
97 * @param h handle to an open file
98 * @param what describes what is being read (for error message creation)
99 * @param result the buffer to write the result to
100 * @param len the number of bytes to read
101 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
104 GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what,
105 void *result, size_t len)
113 return GNUNET_SYSERR;
117 /* first, use buffer */
118 min = h->have - h->pos;
123 memcpy (&dst[pos], &h->buffer[h->pos], min);
128 return GNUNET_OK; /* done! */
129 GNUNET_assert (h->have == h->pos);
131 ret = GNUNET_DISK_file_read (h->fd, h->buffer, h->size);
134 GNUNET_asprintf (&h->emsg, _("Error reading `%s': %s"), what,
136 return GNUNET_SYSERR;
140 GNUNET_asprintf (&h->emsg, _("Error reading `%s': %s"), what,
142 return GNUNET_SYSERR;
147 while (pos < len); /* should always be true */
153 * Read the contents of a binary file into a buffer.
155 * @param h handle to an open file
156 * @param file name of the source file
157 * @param line line number in the source file
158 * @param result the buffer to write the result to
159 * @param len the number of bytes to read
160 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
163 GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h, const char *file, int line,
164 void *result, size_t len)
168 GNUNET_snprintf (what, sizeof (what), "%s:%d", file, line);
169 return GNUNET_BIO_read (h, what, result, len);
174 * Read 0-terminated string from a file.
176 * @param h handle to an open file
177 * @param what describes what is being read (for error message creation)
178 * @param result the buffer to store a pointer to the (allocated) string to
179 * (note that *result could be set to NULL as well)
180 * @param maxLen maximum allowed length for the string
181 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
184 GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what,
185 char **result, size_t maxLen)
190 if (GNUNET_OK != GNUNET_BIO_read_int32 (h, &big))
192 GNUNET_free_non_null (h->emsg);
193 GNUNET_asprintf (&h->emsg, _("Error reading length of string `%s'"), what);
194 return GNUNET_SYSERR;
203 GNUNET_asprintf (&h->emsg, _("String `%s' longer than allowed (%u > %u)"),
205 return GNUNET_SYSERR;
207 buf = GNUNET_malloc (big);
212 if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, big))
216 return GNUNET_SYSERR;
223 * Read metadata container from a file.
225 * @param h handle to an open file
226 * @param what describes what is being read (for error message creation)
227 * @param result the buffer to store a pointer to the (allocated) metadata
228 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
231 GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h, const char *what,
232 struct GNUNET_CONTAINER_MetaData **result)
236 struct GNUNET_CONTAINER_MetaData *meta;
238 if (GNUNET_BIO_read_int32 (h, (int32_t *) & size) != GNUNET_OK)
239 return GNUNET_SYSERR;
245 if (size > MAX_META_DATA)
247 GNUNET_asprintf (&h->emsg,
248 _("Serialized metadata `%s' larger than allowed (%u>%u)"),
249 what, size, MAX_META_DATA);
250 return GNUNET_SYSERR;
252 buf = GNUNET_malloc (size);
253 if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, size))
256 return GNUNET_SYSERR;
258 meta = GNUNET_CONTAINER_meta_data_deserialize (buf, size);
262 GNUNET_asprintf (&h->emsg, _("Metadata `%s' failed to deserialize"), what);
263 return GNUNET_SYSERR;
272 * Read an (u)int32_t.
274 * @param h hande to open file
275 * @param file name of the source file
276 * @param line line number in the source file
277 * @param i address of 32-bit integer to read
278 * @return GNUNET_OK on success, GNUNET_SYSERR on error
281 GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
282 int line, int32_t * i)
286 if (GNUNET_OK != GNUNET_BIO_read_fn (h, file, line, &big, sizeof (int32_t)))
287 return GNUNET_SYSERR;
294 * Read an (u)int64_t.
296 * @param h hande to open file
297 * @param file name of the source file
298 * @param line line number in the source file
299 * @param i address of 64-bit integer to read
300 * @return GNUNET_OK on success, GNUNET_SYSERR on error
303 GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
304 int line, int64_t * i)
308 if (GNUNET_OK != GNUNET_BIO_read_fn (h, file, line, &big, sizeof (int64_t)))
309 return GNUNET_SYSERR;
310 *i = GNUNET_ntohll (big);
316 * Handle for buffered writing.
318 struct GNUNET_BIO_WriteHandle
320 struct GNUNET_DISK_FileHandle *fd;
328 * Open a file for writing.
330 * @param fn file name to be opened
331 * @return IO handle on success, NULL on error
333 struct GNUNET_BIO_WriteHandle *
334 GNUNET_BIO_write_open (const char *fn)
336 struct GNUNET_DISK_FileHandle *fd;
337 struct GNUNET_BIO_WriteHandle *h;
339 fd = GNUNET_DISK_file_open (fn,
340 GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_TRUNCATE
341 | GNUNET_DISK_OPEN_CREATE,
342 GNUNET_DISK_PERM_USER_READ |
343 GNUNET_DISK_PERM_USER_WRITE);
346 h = GNUNET_malloc (sizeof (struct GNUNET_BIO_WriteHandle) + BIO_BUFFER_SIZE);
347 h->buffer = (char *) &h[1];
348 h->size = BIO_BUFFER_SIZE;
356 * Close an open file for writing.
358 * @param h file handle
359 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
362 GNUNET_BIO_write_close (struct GNUNET_BIO_WriteHandle *h)
373 wrt = GNUNET_DISK_file_write (h->fd, h->buffer, h->have);
378 GNUNET_DISK_file_close (h->fd);
386 * Write a buffer to a file.
388 * @param h handle to open file
389 * @param buffer the data to write
390 * @param n number of bytes to write
391 * @return GNUNET_OK on success, GNUNET_SYSERR on error
394 GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h, const void *buffer,
397 const char *src = buffer;
403 return GNUNET_SYSERR;
407 /* first, just use buffer */
408 min = h->size - h->have;
411 memcpy (&h->buffer[h->have], &src[pos], min);
415 return GNUNET_OK; /* done */
416 GNUNET_assert (h->have == h->size);
417 ret = GNUNET_DISK_file_write (h->fd, h->buffer, h->size);
420 GNUNET_DISK_file_close (h->fd);
422 return GNUNET_SYSERR; /* error */
426 while (pos < n); /* should always be true */
433 * Write a string to a file.
435 * @param h handle to open file
436 * @param s string to write (can be NULL)
437 * @return GNUNET_OK on success, GNUNET_SYSERR on error
440 GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h, const char *s)
444 slen = (uint32_t) ((s == NULL) ? 0 : strlen (s) + 1);
445 if (GNUNET_OK != GNUNET_BIO_write_int32 (h, slen))
446 return GNUNET_SYSERR;
448 return GNUNET_BIO_write (h, s, slen - 1);
454 * Write metadata container to a file.
456 * @param h handle to open file
457 * @param m metadata to write
458 * @return GNUNET_OK on success, GNUNET_SYSERR on error
461 GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h,
462 const struct GNUNET_CONTAINER_MetaData *m)
468 return GNUNET_BIO_write_int32 (h, 0);
471 GNUNET_CONTAINER_meta_data_serialize (m, &buf, MAX_META_DATA,
472 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
476 return GNUNET_SYSERR;
478 if ((GNUNET_OK != GNUNET_BIO_write_int32 (h, (uint32_t) size)) ||
479 (GNUNET_OK != GNUNET_BIO_write (h, buf, size)))
482 return GNUNET_SYSERR;
490 * Write an (u)int32_t.
492 * @param h hande to open file
493 * @param i address of 32-bit integer to write
494 * @return GNUNET_OK on success, GNUNET_SYSERR on error
497 GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h, int32_t i)
502 return GNUNET_BIO_write (h, &big, sizeof (int32_t));
507 * Write an (u)int64_t.
509 * @param h hande to open file
510 * @param i address of 64-bit integer to write
511 * @return GNUNET_OK on success, GNUNET_SYSERR on error
514 GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h, int64_t i)
518 big = GNUNET_htonll (i);
519 return GNUNET_BIO_write (h, &big, sizeof (int64_t));