src/util/bio.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2006, 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   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      General Public License for more details.
  14
  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.
  19 */
  20 /**
  21  * @file util/bio.c
  22  * @brief functions for buffering IO
  23  * @author Christian Grothoff
  24  */
  25 #include "platform.h"
  26 #include "gnunet_bio_lib.h"
  27 #include "gnunet_disk_lib.h"
  28
  29 #define BIO_BUFFER_SIZE 65536
  30
  31 #define MAX_META_DATA (1024 * 1024)
  32
  33 /**
  34  * Handle for buffered reading.
  35  */
  36 struct GNUNET_BIO_ReadHandle
  37 {
  38   struct GNUNET_DISK_FileHandle *fd;
  39   char *emsg;
  40   char *buffer;
  41   size_t have;
  42   size_t size;
  43   off_t pos;
  44 };
  45
  46
  47 /**
  48  * Open a file for reading.
  49  *
  50  * @param fn file name to be opened
  51  * @return IO handle on success, NULL on error
  52  */
  53 struct GNUNET_BIO_ReadHandle *
  54 GNUNET_BIO_read_open (const char *fn)
  55 {
  56   struct GNUNET_DISK_FileHandle *fd;
  57   struct GNUNET_BIO_ReadHandle *h;
  58
  59   fd = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_READ,
  60                               GNUNET_DISK_PERM_NONE);
  61   if (NULL == fd)
  62     return NULL;
  63   h = GNUNET_malloc (sizeof (struct GNUNET_BIO_ReadHandle) + BIO_BUFFER_SIZE);
  64   h->buffer = (char *) &h[1];
  65   h->size = BIO_BUFFER_SIZE;
  66   h->fd = fd;
  67   return h;
  68 }
  69
  70
  71 /**
  72  * Close an open file.  Reports if any errors reading
  73  * from the file were encountered.
  74  *
  75  * @param h file handle
  76  * @param emsg set to the error message
  77  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
  78  */
  79 int
  80 GNUNET_BIO_read_close (struct GNUNET_BIO_ReadHandle *h, char **emsg)
  81 {
  82   *emsg = h->emsg;
  83   GNUNET_DISK_file_close (h->fd);
  84   GNUNET_free (h);
  85   return (NULL == *emsg) ? GNUNET_OK : GNUNET_SYSERR;
  86 }
  87
  88
  89 /**
  90  * Read the contents of a binary file into a buffer.
  91  *
  92  * @param h handle to an open file
  93  * @param what describes what is being read (for error message creation)
  94  * @param result the buffer to write the result to
  95  * @param len the number of bytes to read
  96  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
  97  */
  98 int
  99 GNUNET_BIO_read (struct GNUNET_BIO_ReadHandle *h,
 100                  const char *what, void *result, size_t len)
 101 {
 102   char *dst = result;
 103   size_t min;
 104   size_t pos;
 105   ssize_t ret;
 106
 107   if (h->emsg != NULL)
 108     return GNUNET_SYSERR;
 109   pos = 0;
 110   do
 111     {
 112       /* first, use buffer */
 113       min = h->have - h->pos;
 114       if (min > 0)
 115         {
 116           if (min > len - pos)
 117             min = len - pos;
 118           memcpy (&dst[pos], &h->buffer[h->pos], min);
 119           h->pos += min;
 120           pos += min;
 121         }
 122       if (pos == len)
 123         return GNUNET_OK;       /* done! */
 124       GNUNET_assert (h->have == h->pos);
 125       /* fill buffer */
 126       ret = GNUNET_DISK_file_read (h->fd, h->buffer, h->size);
 127       if (ret == -1)
 128         {
 129           GNUNET_asprintf (&h->emsg,
 130                            _("Error reading `%s': %s"),
 131                            what, STRERROR (errno));
 132           return GNUNET_SYSERR;
 133         }
 134       if (ret == 0)
 135         {
 136           GNUNET_asprintf (&h->emsg,
 137                            _("Error reading `%s': %s"),
 138                            what, _("End of file"));
 139           return GNUNET_SYSERR;
 140         }
 141       h->pos = 0;
 142       h->have = ret;
 143     }
 144   while (pos < len);            /* should always be true */
 145   return GNUNET_OK;
 146 }
 147
 148
 149 /**
 150  * Read 0-terminated string from a file.
 151  *
 152  * @param h handle to an open file
 153  * @param what describes what is being read (for error message creation)
 154  * @param result the buffer to store a pointer to the (allocated) string to
 155  *        (note that *result could be set to NULL as well)
 156  * @param maxLen maximum allowed length for the string
 157  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 158  */
 159 int
 160 GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h,
 161                         const char *what, char **result, size_t maxLen)
 162 {
 163   char *buf;
 164   uint32_t big;
 165
 166   if (GNUNET_OK != GNUNET_BIO_read_int32 (h, &big))
 167     return GNUNET_SYSERR;
 168   if (big == 0)
 169     {
 170       *result = NULL;
 171       return GNUNET_OK;
 172     }
 173   if (big > maxLen)
 174     {
 175       GNUNET_asprintf (&h->emsg,
 176                        _("String `%s' longer than allowed (%u > %u)"),
 177                        what, big, maxLen);
 178       return GNUNET_SYSERR;
 179     }
 180   buf = GNUNET_malloc (big);
 181   *result = buf;
 182   buf[--big] = '\0';
 183   if (big == 0)
 184     return GNUNET_OK;
 185   if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, big))
 186     {
 187       GNUNET_free (buf);
 188       *result = NULL;
 189       return GNUNET_SYSERR;
 190     }
 191   return GNUNET_OK;
 192 }
 193
 194
 195 /**
 196  * Read metadata container from a file.
 197  *
 198  * @param h handle to an open file
 199  * @param what describes what is being read (for error message creation)
 200  * @param result the buffer to store a pointer to the (allocated) metadata
 201  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 202  */
 203 int
 204 GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h,
 205                            const char *what,
 206                            struct GNUNET_CONTAINER_MetaData **result)
 207 {
 208   uint32_t size;
 209   char *buf;
 210   struct GNUNET_CONTAINER_MetaData *meta;
 211
 212   if (GNUNET_BIO_read_int32__ (h, what, (int32_t *) &size) != GNUNET_OK)
 213     return GNUNET_SYSERR;
 214   if (size > MAX_META_DATA)
 215     {
 216       GNUNET_asprintf (&h->emsg,
 217                        _("Serialized metadata `%s' larger than allowed (%u>%u)"),
 218                        what, size, MAX_META_DATA);
 219       return GNUNET_SYSERR;
 220     }
 221   buf = GNUNET_malloc (size);
 222   if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, size))
 223     {
 224       GNUNET_free (buf);
 225       return GNUNET_SYSERR;
 226     }
 227   meta = GNUNET_CONTAINER_meta_data_deserialize (buf, size);
 228   if (meta == NULL)
 229     {
 230       GNUNET_free (buf);
 231       GNUNET_asprintf (&h->emsg,
 232                        _("Metadata `%s' failed to deserialize"), what);
 233       return GNUNET_SYSERR;
 234     }
 235   GNUNET_free (buf);
 236   *result = meta;
 237   return GNUNET_OK;
 238 }
 239
 240
 241 /**
 242  * Read an (u)int32_t.
 243  *
 244  * @param h hande to open file
 245  * @param what describes what is being read (for error message creation)
 246  * @param i address of 32-bit integer to read
 247  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 248  */
 249 int
 250 GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h,
 251                          const char *what, int32_t * i)
 252 {
 253   int32_t big;
 254
 255   if (GNUNET_OK != GNUNET_BIO_read (h, what, &big, sizeof (int32_t)))
 256     return GNUNET_SYSERR;
 257   *i = ntohl (big);
 258   return GNUNET_OK;
 259 }
 260
 261
 262 /**
 263  * Read an (u)int64_t.
 264  *
 265  * @param h hande to open file
 266  * @param what describes what is being read (for error message creation)
 267  * @param i address of 64-bit integer to read
 268  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 269  */
 270 int
 271 GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h,
 272                          const char *what, int64_t * i)
 273 {
 274   int64_t big;
 275
 276   if (GNUNET_OK != GNUNET_BIO_read (h, what, &big, sizeof (int64_t)))
 277     return GNUNET_SYSERR;
 278   *i = GNUNET_ntohll (big);
 279   return GNUNET_OK;
 280 }
 281
 282
 283 /**
 284  * Handle for buffered writing.
 285  */
 286 struct GNUNET_BIO_WriteHandle
 287 {
 288   struct GNUNET_DISK_FileHandle *fd;
 289   char *buffer;
 290   size_t have;
 291   size_t size;
 292 };
 293
 294
 295 /**
 296  * Open a file for writing.
 297  *
 298  * @param fn file name to be opened
 299  * @return IO handle on success, NULL on error
 300  */
 301 struct GNUNET_BIO_WriteHandle *
 302 GNUNET_BIO_write_open (const char *fn)
 303 {
 304   struct GNUNET_DISK_FileHandle *fd;
 305   struct GNUNET_BIO_WriteHandle *h;
 306
 307   fd = GNUNET_DISK_file_open (fn,
 308                               GNUNET_DISK_OPEN_WRITE |
 309                               GNUNET_DISK_OPEN_TRUNCATE |
 310                               GNUNET_DISK_OPEN_CREATE,
 311                               GNUNET_DISK_PERM_USER_READ |
 312                               GNUNET_DISK_PERM_USER_WRITE);
 313   if (NULL == fd)
 314     return NULL;
 315   h =
 316     GNUNET_malloc (sizeof (struct GNUNET_BIO_WriteHandle) + BIO_BUFFER_SIZE);
 317   h->buffer = (char *) &h[1];
 318   h->size = BIO_BUFFER_SIZE;
 319   h->fd = fd;
 320
 321   return h;
 322 }
 323
 324
 325 /**
 326  * Close an open file for writing.
 327  *
 328  * @param h file handle
 329  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 330  */
 331 int
 332 GNUNET_BIO_write_close (struct GNUNET_BIO_WriteHandle *h)
 333 {
 334   ssize_t wrt;
 335   int ret;
 336
 337   if (NULL == h->fd)
 338     {
 339       ret = GNUNET_SYSERR;
 340     }
 341   else
 342     {
 343       wrt = GNUNET_DISK_file_write (h->fd, h->buffer, h->have);
 344       if (wrt == h->have)
 345         ret = GNUNET_OK;
 346       else
 347         ret = GNUNET_SYSERR;
 348       GNUNET_DISK_file_close (h->fd);
 349     }
 350   GNUNET_free (h);
 351   return ret;
 352 }
 353
 354
 355 /**
 356  * Write a buffer to a file.
 357  *
 358  * @param h handle to open file
 359  * @param buffer the data to write
 360  * @param n number of bytes to write
 361  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 362  */
 363 int
 364 GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h,
 365                   const void *buffer, size_t n)
 366 {
 367   const char *src = buffer;
 368   size_t min;
 369   size_t pos;
 370   ssize_t ret;
 371
 372   if (NULL == h->fd)
 373     return GNUNET_SYSERR;
 374   pos = 0;
 375   do
 376     {
 377       /* first, just use buffer */
 378       min = h->size - h->have;
 379       if (min > n - pos)
 380         min = n - pos;
 381       memcpy (&h->buffer[h->have], &src[pos], min);
 382       pos += min;
 383       h->have += min;
 384       if (pos == n)
 385         return GNUNET_OK;       /* done */
 386       GNUNET_assert (h->have == h->size);
 387       ret = GNUNET_DISK_file_write (h->fd, h->buffer, h->size);
 388       if (ret != h->size)
 389         {
 390           GNUNET_DISK_file_close (h->fd);
 391           h->fd = NULL;
 392           return GNUNET_SYSERR; /* error */
 393         }
 394       h->have = 0;
 395     }
 396   while (pos < n);              /* should always be true */
 397   GNUNET_break (0);
 398   return GNUNET_OK;
 399 }
 400
 401
 402 /**
 403  * Write a string to a file.
 404  *
 405  * @param h handle to open file
 406  * @param s string to write (can be NULL)
 407  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 408  */
 409 int
 410 GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h, const char *s)
 411 {
 412   uint32_t slen;
 413
 414   slen = (uint32_t) ((s == NULL) ? 0 : strlen (s) + 1);
 415   if (GNUNET_OK != GNUNET_BIO_write_int32 (h, slen))
 416     return GNUNET_SYSERR;
 417   if (0 != slen)
 418     return GNUNET_BIO_write (h, s, slen - 1);
 419   return GNUNET_OK;
 420 }
 421
 422
 423 /**
 424  * Write metadata container to a file.
 425  *
 426  * @param h handle to open file
 427  * @param m metadata to write
 428  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 429  */
 430 int
 431 GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h,
 432                             const struct GNUNET_CONTAINER_MetaData *m)
 433 {
 434   ssize_t size;
 435   char *buf;
 436
 437   buf = NULL;
 438   size = GNUNET_CONTAINER_meta_data_serialize (m,
 439                                                &buf,
 440                                                MAX_META_DATA,
 441                                                GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
 442   if (size == -1)
 443     {
 444       GNUNET_free (buf);
 445       return GNUNET_SYSERR;
 446     }
 447   if ( (GNUNET_OK != GNUNET_BIO_write_int32 (h, (uint32_t) size)) ||
 448        (GNUNET_OK != GNUNET_BIO_write (h, buf, size)) )
 449     {
 450       GNUNET_free (buf);
 451       return GNUNET_SYSERR;
 452     }
 453   GNUNET_free (buf);
 454   return GNUNET_OK;
 455 }
 456
 457
 458 /**
 459  * Write an (u)int32_t.
 460  *
 461  * @param h hande to open file
 462  * @param i address of 32-bit integer to write
 463  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 464  */
 465 int
 466 GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h, int32_t i)
 467 {
 468   int32_t big;
 469   big = htonl (i);
 470   return GNUNET_BIO_write (h, &big, sizeof (int32_t));
 471 }
 472
 473
 474 /**
 475  * Write an (u)int64_t.
 476  *
 477  * @param h hande to open file
 478  * @param i address of 64-bit integer to write
 479  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 480  */
 481 int
 482 GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h, int64_t i)
 483 {
 484   int64_t big;
 485   big = GNUNET_htonll (i);
 486   return GNUNET_BIO_write (h, &big, sizeof (int64_t));
 487 }
 488
 489
 490 /* end of bio.c */