projects
/
oweals
/
gnunet.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
-fix the fix
[oweals/gnunet.git]
/
src
/
util
/
bio.c
diff --git
a/src/util/bio.c
b/src/util/bio.c
index dd2a182b157ef41844dcaf9adabc0fb0ba3b47b5..522c28cf811ed2e908daf9c916b08bf4f4045eba 100644
(file)
--- a/
src/util/bio.c
+++ b/
src/util/bio.c
@@
-1,6
+1,6
@@
/*
This file is part of GNUnet.
/*
This file is part of GNUnet.
- (C) 2006, 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2006, 2009, 2013 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
@@
-14,8
+14,8
@@
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 5
9 Temple Place - Suite 330
,
- Boston, MA 0211
1-1307
, USA.
+ Free Software Foundation, Inc., 5
1 Franklin Street, Fifth Floor
,
+ Boston, MA 0211
0-1301
, USA.
*/
/**
* @file util/bio.c
*/
/**
* @file util/bio.c
@@
-28,20
+28,51
@@
#define LOG(kind,...) GNUNET_log_from (kind, "util",__VA_ARGS__)
#define LOG(kind,...) GNUNET_log_from (kind, "util",__VA_ARGS__)
+/**
+ * Size for I/O buffers.
+ */
#define BIO_BUFFER_SIZE 65536
#define BIO_BUFFER_SIZE 65536
+/**
+ * Maximum size allowed for meta data written/read from disk.
+ * File-sharing limits to 64k, so this should be rather generous.
+ */
#define MAX_META_DATA (1024 * 1024)
#define MAX_META_DATA (1024 * 1024)
+
/**
* Handle for buffered reading.
*/
struct GNUNET_BIO_ReadHandle
{
/**
* Handle for buffered reading.
*/
struct GNUNET_BIO_ReadHandle
{
+ /**
+ * Underlying file abstraction.
+ */
struct GNUNET_DISK_FileHandle *fd;
struct GNUNET_DISK_FileHandle *fd;
+
+ /**
+ * Error message, NULL if there were no errors.
+ */
char *emsg;
char *emsg;
+
+ /**
+ * I/O buffer. Allocated at the end of the struct, do not free!
+ */
char *buffer;
char *buffer;
+
+ /**
+ * Number of bytes available in read @e buffer.
+ */
size_t have;
size_t have;
+
+ /**
+ * Total size of @e buffer.
+ */
size_t size;
size_t size;
+
+ /**
+ * Current read offset in @e buffer.
+ */
off_t pos;
};
off_t pos;
};
@@
-75,10
+106,11
@@
GNUNET_BIO_read_open (const char *fn)
*
* @param h file handle
* @param emsg set to the error message
*
* @param h file handle
* @param emsg set to the error message
- * @return
GNUNET_OK on success,
GNUNET_SYSERR otherwise
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR otherwise
*/
int
*/
int
-GNUNET_BIO_read_close (struct GNUNET_BIO_ReadHandle *h, char **emsg)
+GNUNET_BIO_read_close (struct GNUNET_BIO_ReadHandle *h,
+ char **emsg)
{
int err;
{
int err;
@@
-100,10
+132,11
@@
GNUNET_BIO_read_close (struct GNUNET_BIO_ReadHandle *h, char **emsg)
* @param what describes what is being read (for error message creation)
* @param result the buffer to write the result to
* @param len the number of bytes to read
* @param what describes what is being read (for error message creation)
* @param result the buffer to write the result to
* @param len the number of bytes to read
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on failure
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on failure
*/
int
*/
int
-GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what,
+GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h,
+ const char *what,
void *result, size_t len)
{
char *dst = result;
void *result, size_t len)
{
char *dst = result;
@@
-111,7
+144,7
@@
GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what,
size_t pos;
ssize_t ret;
size_t pos;
ssize_t ret;
- if (
h->emsg != NULL
)
+ if (
NULL != h->emsg
)
return GNUNET_SYSERR;
pos = 0;
do
return GNUNET_SYSERR;
pos = 0;
do
@@
-131,15
+164,19
@@
GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what,
GNUNET_assert (h->have == h->pos);
/* fill buffer */
ret = GNUNET_DISK_file_read (h->fd, h->buffer, h->size);
GNUNET_assert (h->have == h->pos);
/* fill buffer */
ret = GNUNET_DISK_file_read (h->fd, h->buffer, h->size);
- if (
ret == -1
)
+ if (
-1 == ret
)
{
{
- GNUNET_asprintf (&h->emsg, _("Error reading `%s': %s"), what,
+ GNUNET_asprintf (&h->emsg,
+ _("Error reading `%s': %s"),
+ what,
STRERROR (errno));
return GNUNET_SYSERR;
}
STRERROR (errno));
return GNUNET_SYSERR;
}
- if (
ret == 0
)
+ if (
0 == ret
)
{
{
- GNUNET_asprintf (&h->emsg, _("Error reading `%s': %s"), what,
+ GNUNET_asprintf (&h->emsg,
+ _("Error reading `%s': %s"),
+ what,
_("End of file"));
return GNUNET_SYSERR;
}
_("End of file"));
return GNUNET_SYSERR;
}
@@
-159,11
+196,14
@@
GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h, const char *what,
* @param line line number in the source file
* @param result the buffer to write the result to
* @param len the number of bytes to read
* @param line line number in the source file
* @param result the buffer to write the result to
* @param len the number of bytes to read
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on failure
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on failure
*/
int
*/
int
-GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h, const char *file, int line,
- void *result, size_t len)
+GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h,
+ const char *file,
+ int line,
+ void *result,
+ size_t len)
{
char what[1024];
{
char what[1024];
@@
-179,12
+219,14
@@
GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h, const char *file, int line,
* @param what describes what is being read (for error message creation)
* @param result the buffer to store a pointer to the (allocated) string to
* (note that *result could be set to NULL as well)
* @param what describes what is being read (for error message creation)
* @param result the buffer to store a pointer to the (allocated) string to
* (note that *result could be set to NULL as well)
- * @param max
Len
maximum allowed length for the string
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on failure
+ * @param max
_length
maximum allowed length for the string
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on failure
*/
int
*/
int
-GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what,
- char **result, size_t maxLen)
+GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h,
+ const char *what,
+ char **result,
+ size_t max_length)
{
char *buf;
uint32_t big;
{
char *buf;
uint32_t big;
@@
-195,21
+237,21
@@
GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what,
GNUNET_asprintf (&h->emsg, _("Error reading length of string `%s'"), what);
return GNUNET_SYSERR;
}
GNUNET_asprintf (&h->emsg, _("Error reading length of string `%s'"), what);
return GNUNET_SYSERR;
}
- if (
big == 0
)
+ if (
0 == big
)
{
*result = NULL;
return GNUNET_OK;
}
{
*result = NULL;
return GNUNET_OK;
}
- if (big > max
Len
)
+ if (big > max
_length
)
{
GNUNET_asprintf (&h->emsg, _("String `%s' longer than allowed (%u > %u)"),
{
GNUNET_asprintf (&h->emsg, _("String `%s' longer than allowed (%u > %u)"),
- what, big, max
Len
);
+ what, big, max
_length
);
return GNUNET_SYSERR;
}
buf = GNUNET_malloc (big);
*result = buf;
buf[--big] = '\0';
return GNUNET_SYSERR;
}
buf = GNUNET_malloc (big);
*result = buf;
buf[--big] = '\0';
- if (
big == 0
)
+ if (
0 == big
)
return GNUNET_OK;
if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, big))
{
return GNUNET_OK;
if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, big))
{
@@
-227,10
+269,11
@@
GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what,
* @param h handle to an open file
* @param what describes what is being read (for error message creation)
* @param result the buffer to store a pointer to the (allocated) metadata
* @param h handle to an open file
* @param what describes what is being read (for error message creation)
* @param result the buffer to store a pointer to the (allocated) metadata
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on failure
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on failure
*/
int
*/
int
-GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h, const char *what,
+GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h,
+ const char *what,
struct GNUNET_CONTAINER_MetaData **result)
{
uint32_t size;
struct GNUNET_CONTAINER_MetaData **result)
{
uint32_t size;
@@
-277,7
+320,7
@@
GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h, const char *what,
* @param file name of the source file
* @param line line number in the source file
* @param i address of 32-bit integer to read
* @param file name of the source file
* @param line line number in the source file
* @param i address of 32-bit integer to read
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on error
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on error
*/
int
GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
*/
int
GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
@@
-299,11
+342,13
@@
GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
* @param file name of the source file
* @param line line number in the source file
* @param i address of 64-bit integer to read
* @param file name of the source file
* @param line line number in the source file
* @param i address of 64-bit integer to read
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on error
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on error
*/
int
*/
int
-GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
- int line, int64_t * i)
+GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h,
+ const char *file,
+ int line,
+ int64_t *i)
{
int64_t big;
{
int64_t big;
@@
-319,9
+364,24
@@
GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h, const char *file,
*/
struct GNUNET_BIO_WriteHandle
{
*/
struct GNUNET_BIO_WriteHandle
{
+ /**
+ * Underlying file handle.
+ */
struct GNUNET_DISK_FileHandle *fd;
struct GNUNET_DISK_FileHandle *fd;
+
+ /**
+ * I/O buffer. Do not free, allocated at the end of the struct.
+ */
char *buffer;
char *buffer;
+
+ /**
+ * Number of bytes already in @e buffer.
+ */
size_t have;
size_t have;
+
+ /**
+ * Total size of @e buffer.
+ */
size_t size;
};
size_t size;
};
@@
-357,7
+417,7
@@
GNUNET_BIO_write_open (const char *fn)
* Close an open file for writing.
*
* @param h file handle
* Close an open file for writing.
*
* @param h file handle
- * @return
GNUNET_OK on success,
GNUNET_SYSERR otherwise
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR otherwise
*/
int
GNUNET_BIO_write_close (struct GNUNET_BIO_WriteHandle *h)
*/
int
GNUNET_BIO_write_close (struct GNUNET_BIO_WriteHandle *h)
@@
-376,7
+436,7
@@
GNUNET_BIO_write_close (struct GNUNET_BIO_WriteHandle *h)
* Force a buffered writer to flush its buffer
*
* @param h the writer handle
* Force a buffered writer to flush its buffer
*
* @param h the writer handle
- * @return
GNUNET_OK upon success. Upon failure
GNUNET_SYSERR is returned and
+ * @return
#GNUNET_OK upon success. Upon failure #
GNUNET_SYSERR is returned and
* the file is closed
*/
int
* the file is closed
*/
int
@@
-402,7
+462,7
@@
GNUNET_BIO_flush (struct GNUNET_BIO_WriteHandle *h)
* @param h handle to open file
* @param buffer the data to write
* @param n number of bytes to write
* @param h handle to open file
* @param buffer the data to write
* @param n number of bytes to write
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on error
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on error
*/
int
GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h, const void *buffer,
*/
int
GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h, const void *buffer,
@@
-441,10
+501,11
@@
GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h, const void *buffer,
*
* @param h handle to open file
* @param s string to write (can be NULL)
*
* @param h handle to open file
* @param s string to write (can be NULL)
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on error
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on error
*/
int
*/
int
-GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h, const char *s)
+GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h,
+ const char *s)
{
uint32_t slen;
{
uint32_t slen;
@@
-462,7
+523,7
@@
GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h, const char *s)
*
* @param h handle to open file
* @param m metadata to write
*
* @param h handle to open file
* @param m metadata to write
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on error
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on error
*/
int
GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h,
*/
int
GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h,
@@
-498,10
+559,11
@@
GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h,
*
* @param h hande to open file
* @param i 32-bit integer to write
*
* @param h hande to open file
* @param i 32-bit integer to write
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on error
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on error
*/
int
*/
int
-GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h, int32_t i)
+GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h,
+ int32_t i)
{
int32_t big;
{
int32_t big;
@@
-515,10
+577,11
@@
GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h, int32_t i)
*
* @param h hande to open file
* @param i 64-bit integer to write
*
* @param h hande to open file
* @param i 64-bit integer to write
- * @return
GNUNET_OK on success,
GNUNET_SYSERR on error
+ * @return
#GNUNET_OK on success, #
GNUNET_SYSERR on error
*/
int
*/
int
-GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h, int64_t i)
+GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h,
+ int64_t i)
{
int64_t big;
{
int64_t big;