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 the contents of a binary file into a buffer.
 151  *
 152  * @param h handle to an open file
 153  * @param file name of the source file
 154  * @param line line number in the source file
 155  * @param result the buffer to write the result to
 156  * @param len the number of bytes to read
 157  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 158  */
 159 int GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h,
 160                         const char *file, int line,
 161                         void *result,
 162                         size_t len)
 163 {
 164   char what[1024];
 165   GNUNET_snprintf (what,
 166                    sizeof(what),
 167                    "%s:%d",
 168                    file, line);
 169   return GNUNET_BIO_read (h, what, result, len);
 170 }
 171
 172
 173 /**
 174  * Read 0-terminated string from a file.
 175  *
 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
 182  */
 183 int
 184 GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h,
 185                         const char *what, char **result, size_t maxLen)
 186 {
 187   char *buf;
 188   uint32_t big;
 189
 190   if (GNUNET_OK != GNUNET_BIO_read_int32 (h, &big))
 191     return GNUNET_SYSERR;
 192   if (big == 0)
 193     {
 194       *result = NULL;
 195       return GNUNET_OK;
 196     }
 197   if (big > maxLen)
 198     {
 199       GNUNET_asprintf (&h->emsg,
 200                        _("String `%s' longer than allowed (%u > %u)"),
 201                        what, big, maxLen);
 202       return GNUNET_SYSERR;
 203     }
 204   buf = GNUNET_malloc (big);
 205   *result = buf;
 206   buf[--big] = '\0';
 207   if (big == 0)
 208     return GNUNET_OK;
 209   if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, big))
 210     {
 211       GNUNET_free (buf);
 212       *result = NULL;
 213       return GNUNET_SYSERR;
 214     }
 215   return GNUNET_OK;
 216 }
 217
 218
 219 /**
 220  * Read metadata container from a file.
 221  *
 222  * @param h handle to an open file
 223  * @param what describes what is being read (for error message creation)
 224  * @param result the buffer to store a pointer to the (allocated) metadata
 225  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 226  */
 227 int
 228 GNUNET_BIO_read_meta_data (struct GNUNET_BIO_ReadHandle *h,
 229                            const char *what,
 230                            struct GNUNET_CONTAINER_MetaData **result)
 231 {
 232   uint32_t size;
 233   char *buf;
 234   struct GNUNET_CONTAINER_MetaData *meta;
 235
 236   if (GNUNET_BIO_read_int32 (h, (int32_t *) &size) != GNUNET_OK)
 237     return GNUNET_SYSERR;
 238   if (size > MAX_META_DATA)
 239     {
 240       GNUNET_asprintf (&h->emsg,
 241                        _("Serialized metadata `%s' larger than allowed (%u>%u)"),
 242                        what, size, MAX_META_DATA);
 243       return GNUNET_SYSERR;
 244     }
 245   buf = GNUNET_malloc (size);
 246   if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, size))
 247     {
 248       GNUNET_free (buf);
 249       return GNUNET_SYSERR;
 250     }
 251   meta = GNUNET_CONTAINER_meta_data_deserialize (buf, size);
 252   if (meta == NULL)
 253     {
 254       GNUNET_free (buf);
 255       GNUNET_asprintf (&h->emsg,
 256                        _("Metadata `%s' failed to deserialize"), what);
 257       return GNUNET_SYSERR;
 258     }
 259   GNUNET_free (buf);
 260   *result = meta;
 261   return GNUNET_OK;
 262 }
 263
 264
 265 /**
 266  * Read an (u)int32_t.
 267  *
 268  * @param h hande to open file
 269  * @param file name of the source file
 270  * @param line line number in the source file
 271  * @param i address of 32-bit integer to read
 272  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 273  */
 274 int
 275 GNUNET_BIO_read_int32__ (struct GNUNET_BIO_ReadHandle *h,
 276                          const char *file,
 277                          int line,
 278                          int32_t * i)
 279 {
 280   int32_t big;
 281
 282   if (GNUNET_OK != GNUNET_BIO_read_fn (h, file, line, &big, sizeof (int32_t)))
 283     return GNUNET_SYSERR;
 284   *i = ntohl (big);
 285   return GNUNET_OK;
 286 }
 287
 288
 289 /**
 290  * Read an (u)int64_t.
 291  *
 292  * @param h hande to open file
 293  * @param file name of the source file
 294  * @param line line number in the source file
 295  * @param i address of 64-bit integer to read
 296  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 297  */
 298 int
 299 GNUNET_BIO_read_int64__ (struct GNUNET_BIO_ReadHandle *h,
 300                          const char *file,
 301                          int line,
 302                          int64_t * i)
 303 {
 304   int64_t big;
 305
 306   if (GNUNET_OK != GNUNET_BIO_read_fn (h, file, line, &big, sizeof (int64_t)))
 307     return GNUNET_SYSERR;
 308   *i = GNUNET_ntohll (big);
 309   return GNUNET_OK;
 310 }
 311
 312
 313 /**
 314  * Handle for buffered writing.
 315  */
 316 struct GNUNET_BIO_WriteHandle
 317 {
 318   struct GNUNET_DISK_FileHandle *fd;
 319   char *buffer;
 320   size_t have;
 321   size_t size;
 322 };
 323
 324
 325 /**
 326  * Open a file for writing.
 327  *
 328  * @param fn file name to be opened
 329  * @return IO handle on success, NULL on error
 330  */
 331 struct GNUNET_BIO_WriteHandle *
 332 GNUNET_BIO_write_open (const char *fn)
 333 {
 334   struct GNUNET_DISK_FileHandle *fd;
 335   struct GNUNET_BIO_WriteHandle *h;
 336
 337   fd = GNUNET_DISK_file_open (fn,
 338                               GNUNET_DISK_OPEN_WRITE |
 339                               GNUNET_DISK_OPEN_TRUNCATE |
 340                               GNUNET_DISK_OPEN_CREATE,
 341                               GNUNET_DISK_PERM_USER_READ |
 342                               GNUNET_DISK_PERM_USER_WRITE);
 343   if (NULL == fd)
 344     return NULL;
 345   h =
 346     GNUNET_malloc (sizeof (struct GNUNET_BIO_WriteHandle) + BIO_BUFFER_SIZE);
 347   h->buffer = (char *) &h[1];
 348   h->size = BIO_BUFFER_SIZE;
 349   h->fd = fd;
 350
 351   return h;
 352 }
 353
 354
 355 /**
 356  * Close an open file for writing.
 357  *
 358  * @param h file handle
 359  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 360  */
 361 int
 362 GNUNET_BIO_write_close (struct GNUNET_BIO_WriteHandle *h)
 363 {
 364   ssize_t wrt;
 365   int ret;
 366
 367   if (NULL == h->fd)
 368     {
 369       ret = GNUNET_SYSERR;
 370     }
 371   else
 372     {
 373       wrt = GNUNET_DISK_file_write (h->fd, h->buffer, h->have);
 374       if (wrt == h->have)
 375         ret = GNUNET_OK;
 376       else
 377         ret = GNUNET_SYSERR;
 378       GNUNET_DISK_file_close (h->fd);
 379     }
 380   GNUNET_free (h);
 381   return ret;
 382 }
 383
 384
 385 /**
 386  * Write a buffer to a file.
 387  *
 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
 392  */
 393 int
 394 GNUNET_BIO_write (struct GNUNET_BIO_WriteHandle *h,
 395                   const void *buffer, size_t n)
 396 {
 397   const char *src = buffer;
 398   size_t min;
 399   size_t pos;
 400   ssize_t ret;
 401
 402   if (NULL == h->fd)
 403     return GNUNET_SYSERR;
 404   pos = 0;
 405   do
 406     {
 407       /* first, just use buffer */
 408       min = h->size - h->have;
 409       if (min > n - pos)
 410         min = n - pos;
 411       memcpy (&h->buffer[h->have], &src[pos], min);
 412       pos += min;
 413       h->have += min;
 414       if (pos == n)
 415         return GNUNET_OK;       /* done */
 416       GNUNET_assert (h->have == h->size);
 417       ret = GNUNET_DISK_file_write (h->fd, h->buffer, h->size);
 418       if (ret != h->size)
 419         {
 420           GNUNET_DISK_file_close (h->fd);
 421           h->fd = NULL;
 422           return GNUNET_SYSERR; /* error */
 423         }
 424       h->have = 0;
 425     }
 426   while (pos < n);              /* should always be true */
 427   GNUNET_break (0);
 428   return GNUNET_OK;
 429 }
 430
 431
 432 /**
 433  * Write a string to a file.
 434  *
 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
 438  */
 439 int
 440 GNUNET_BIO_write_string (struct GNUNET_BIO_WriteHandle *h, const char *s)
 441 {
 442   uint32_t slen;
 443
 444   slen = (uint32_t) ((s == NULL) ? 0 : strlen (s) + 1);
 445   if (GNUNET_OK != GNUNET_BIO_write_int32 (h, slen))
 446     return GNUNET_SYSERR;
 447   if (0 != slen)
 448     return GNUNET_BIO_write (h, s, slen - 1);
 449   return GNUNET_OK;
 450 }
 451
 452
 453 /**
 454  * Write metadata container to a file.
 455  *
 456  * @param h handle to open file
 457  * @param m metadata to write
 458  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 459  */
 460 int
 461 GNUNET_BIO_write_meta_data (struct GNUNET_BIO_WriteHandle *h,
 462                             const struct GNUNET_CONTAINER_MetaData *m)
 463 {
 464   ssize_t size;
 465   char *buf;
 466
 467   buf = NULL;
 468   size = GNUNET_CONTAINER_meta_data_serialize (m,
 469                                                &buf,
 470                                                MAX_META_DATA,
 471                                                GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
 472   if (size == -1)
 473     {
 474       GNUNET_free (buf);
 475       return GNUNET_SYSERR;
 476     }
 477   if ( (GNUNET_OK != GNUNET_BIO_write_int32 (h, (uint32_t) size)) ||
 478        (GNUNET_OK != GNUNET_BIO_write (h, buf, size)) )
 479     {
 480       GNUNET_free (buf);
 481       return GNUNET_SYSERR;
 482     }
 483   GNUNET_free (buf);
 484   return GNUNET_OK;
 485 }
 486
 487
 488 /**
 489  * Write an (u)int32_t.
 490  *
 491  * @param h hande to open file
 492  * @param i address of 32-bit integer to write
 493  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 494  */
 495 int
 496 GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h, int32_t i)
 497 {
 498   int32_t big;
 499   big = htonl (i);
 500   return GNUNET_BIO_write (h, &big, sizeof (int32_t));
 501 }
 502
 503
 504 /**
 505  * Write an (u)int64_t.
 506  *
 507  * @param h hande to open file
 508  * @param i address of 64-bit integer to write
 509  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 510  */
 511 int
 512 GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h, int64_t i)
 513 {
 514   int64_t big;
 515   big = GNUNET_htonll (i);
 516   return GNUNET_BIO_write (h, &big, sizeof (int64_t));
 517 }
 518
 519
 520 /* end of bio.c */