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 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.
22 * @brief functions for buffering IO
23 * @author Christian Grothoff
26 #include "gnunet_bio_lib.h"
27 #include "gnunet_disk_lib.h"
29 #define LOG(kind,...) GNUNET_log_from (kind, "util",__VA_ARGS__)
31 #define BIO_BUFFER_SIZE 65536
33 #define MAX_META_DATA (1024 * 1024)
36 * Handle for buffered reading.
38 struct GNUNET_BIO_ReadHandle
40 struct GNUNET_DISK_FileHandle *fd;
50 * Open a file for reading.
52 * @param fn file name to be opened
53 * @return IO handle on success, NULL on error
55 struct GNUNET_BIO_ReadHandle *
56 GNUNET_BIO_read_open (const char *fn)
58 struct GNUNET_DISK_FileHandle *fd;
59 struct GNUNET_BIO_ReadHandle *h;
61 fd = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE);
64 h = GNUNET_malloc (sizeof (struct GNUNET_BIO_ReadHandle) + BIO_BUFFER_SIZE);
65 h->buffer = (char *) &h[1];
66 h->size = BIO_BUFFER_SIZE;
73 * Close an open file. Reports if any errors reading
74 * from the file were encountered.
76 * @param h file handle
77 * @param emsg set to the error message
78 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
81 GNUNET_BIO_read_close (struct GNUNET_BIO_ReadHandle *h, char **emsg)
85 err = (NULL == h->emsg) ? GNUNET_OK : GNUNET_SYSERR;
89 GNUNET_free_non_null (h->emsg);
90 GNUNET_DISK_file_close (h->fd);
97 * Read the contents of a binary file into a buffer.
99 * @param h handle to an open file
100 * @param what describes what is being read (for error message creation)
101 * @param result the buffer to write the result to
102 * @param len the number of bytes to read
103 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
106 GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what,
107 void *result, size_t len)
115 return GNUNET_SYSERR;
119 /* first, use buffer */
120 min = h->have - h->pos;
125 memcpy (&dst[pos], &h->buffer[h->pos], min);
130 return GNUNET_OK; /* done! */
131 GNUNET_assert (h->have == h->pos);
133 ret = GNUNET_DISK_file_read (h->fd, h->buffer, h->size);
136 GNUNET_asprintf (&h->emsg,
137 _("Error reading `%s': %s"),
140 return GNUNET_SYSERR;
144 GNUNET_asprintf (&h->emsg,
145 _("Error reading `%s': %s"),
148 return GNUNET_SYSERR;
153 while (pos < len); /* should always be true */
159 * Read the contents of a binary file into a buffer.
161 * @param h handle to an open file
162 * @param file name of the source file
163 * @param line line number in the source file
164 * @param result the buffer to write the result to
165 * @param len the number of bytes to read
166 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
169 GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h, const char *file, int line,
170 void *result, size_t len)
174 GNUNET_snprintf (what, sizeof (what), "%s:%d", file, line);
175 return GNUNET_BIO_read (h, what, result, len);
180 * Read 0-terminated string from a file.
182 * @param h handle to an open file
183 * @param what describes what is being read (for error message creation)
184 * @param result the buffer to store a pointer to the (allocated) string to
185 * (note that *result could be set to NULL as well)
186 * @param maxLen maximum allowed length for the string
187 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
190 GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what,
191 char **result, size_t maxLen)
196 if (GNUNET_OK != GNUNET_BIO_read_int32 (h, &big))
198 GNUNET_free_non_null (h->emsg);
199 GNUNET_asprintf (&h->emsg, _("Error reading length of string `%s'"), what);
200 return GNUNET_SYSERR;
209 GNUNET_asprintf (&h->emsg, _("String `%s' longer than allowed (%u > %u)"),
211 return GNUNET_SYSERR;
213 buf = GNUNET_malloc (big);
218 if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, big))
222 return GNUNET_SYSERR;
229 * Read metadata container from a file.
231 * @param h handle to an open file
232 * @param what describes what is being read (for error message creation)
233 * @param result the buffer to store a pointer to the (allocated) metadata
234 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
237 GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h, const char *what,
238 struct GNUNET_CONTAINER_MetaData **result)
242 struct GNUNET_CONTAINER_MetaData *meta;
244 if (GNUNET_BIO_read_int32 (h, (int32_t *) & size) != GNUNET_OK)
245 return GNUNET_SYSERR;
251 if (size > MAX_META_DATA)
253 GNUNET_asprintf (&h->emsg,
254 _("Serialized metadata `%s' larger than allowed (%u>%u)"),
255 what, size, MAX_META_DATA);
256 return GNUNET_SYSERR;
258 buf = GNUNET_malloc (size);
259 if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, size))
262 return GNUNET_SYSERR;
264 meta = GNUNET_CONTAINER_meta_data_deserialize (buf, size);
268 GNUNET_asprintf (&h->emsg, _("Metadata `%s' failed to deserialize"), what);
269 return GNUNET_SYSERR;
278 * Read an (u)int32_t.
280 * @param h hande to open file
281 * @param file name of the source file
282 * @param line line number in the source file
283 * @param i address of 32-bit integer to read
284 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
287 GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
288 int line, int32_t * i)
292 if (GNUNET_OK != GNUNET_BIO_read_fn (h, file, line, &big, sizeof (int32_t)))
293 return GNUNET_SYSERR;
300 * Read an (u)int64_t.
302 * @param h hande to open file
303 * @param file name of the source file
304 * @param line line number in the source file
305 * @param i address of 64-bit integer to read
306 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
309 GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
310 int line, int64_t * i)
314 if (GNUNET_OK != GNUNET_BIO_read_fn (h, file, line, &big, sizeof (int64_t)))
315 return GNUNET_SYSERR;
316 *i = GNUNET_ntohll (big);
322 * Handle for buffered writing.
324 struct GNUNET_BIO_WriteHandle
326 struct GNUNET_DISK_FileHandle *fd;
334 * Open a file for writing.
336 * @param fn file name to be opened
337 * @return IO handle on success, NULL on error
339 struct GNUNET_BIO_WriteHandle *
340 GNUNET_BIO_write_open (const char *fn)
342 struct GNUNET_DISK_FileHandle *fd;
343 struct GNUNET_BIO_WriteHandle *h;
345 fd = GNUNET_DISK_file_open (fn,
346 GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_TRUNCATE
347 | GNUNET_DISK_OPEN_CREATE,
348 GNUNET_DISK_PERM_USER_READ |
349 GNUNET_DISK_PERM_USER_WRITE);
352 h = GNUNET_malloc (sizeof (struct GNUNET_BIO_WriteHandle) + BIO_BUFFER_SIZE);
353 h->buffer = (char *) &h[1];
354 h->size = BIO_BUFFER_SIZE;
361 * Close an open file for writing.
363 * @param h file handle
364 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
367 GNUNET_BIO_write_close (struct GNUNET_BIO_WriteHandle *h)
372 if ( (NULL != h->fd) && (GNUNET_OK == (ret = GNUNET_BIO_flush (h))) )
373 GNUNET_DISK_file_close (h->fd);
380 * Force a buffered writer to flush its buffer
382 * @param h the writer handle
383 * @return #GNUNET_OK upon success. Upon failure #GNUNET_SYSERR is returned and
387 GNUNET_BIO_flush (struct GNUNET_BIO_WriteHandle *h)
391 ret = GNUNET_DISK_file_write (h->fd, h->buffer, h->have);
394 GNUNET_DISK_file_close (h->fd);
396 return GNUNET_SYSERR; /* error */
404 * Write a buffer to a file.
406 * @param h handle to open file
407 * @param buffer the data to write
408 * @param n number of bytes to write
409 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
412 GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h, const void *buffer,
415 const char *src = buffer;
420 return GNUNET_SYSERR;
424 /* first, just use buffer */
425 min = h->size - h->have;
428 memcpy (&h->buffer[h->have], &src[pos], min);
432 return GNUNET_OK; /* done */
433 GNUNET_assert (h->have == h->size);
434 if (GNUNET_OK != GNUNET_BIO_flush (h))
435 return GNUNET_SYSERR; /* error */
437 while (pos < n); /* should always be true */
444 * Write a string to a file.
446 * @param h handle to open file
447 * @param s string to write (can be NULL)
448 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
451 GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h,
456 slen = (uint32_t) ((s == NULL) ? 0 : strlen (s) + 1);
457 if (GNUNET_OK != GNUNET_BIO_write_int32 (h, slen))
458 return GNUNET_SYSERR;
460 return GNUNET_BIO_write (h, s, slen - 1);
466 * Write metadata container to a file.
468 * @param h handle to open file
469 * @param m metadata to write
470 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
473 GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h,
474 const struct GNUNET_CONTAINER_MetaData *m)
480 return GNUNET_BIO_write_int32 (h, 0);
483 GNUNET_CONTAINER_meta_data_serialize (m, &buf, MAX_META_DATA,
484 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
488 return GNUNET_SYSERR;
490 if ((GNUNET_OK != GNUNET_BIO_write_int32 (h, (uint32_t) size)) ||
491 (GNUNET_OK != GNUNET_BIO_write (h, buf, size)))
494 return GNUNET_SYSERR;
502 * Write an (u)int32_t.
504 * @param h hande to open file
505 * @param i 32-bit integer to write
506 * @return GNUNET_OK on success, GNUNET_SYSERR on error
509 GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h, int32_t i)
514 return GNUNET_BIO_write (h, &big, sizeof (int32_t));
519 * Write an (u)int64_t.
521 * @param h hande to open file
522 * @param i 64-bit integer to write
523 * @return GNUNET_OK on success, GNUNET_SYSERR on error
526 GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h, int64_t i)
530 big = GNUNET_htonll (i);
531 return GNUNET_BIO_write (h, &big, sizeof (int64_t));