gzwrite.c

   1 /* gzwrite.c -- zlib functions for writing gzip files
   2  * Copyright (C) 2004, 2005, 2010, 2011, 2012 Mark Adler
   3  * For conditions of distribution and use, see copyright notice in zlib.h
   4  */
   5
   6 #include "gzguts.h"
   7
   8 /* Local functions */
   9 local int gz_init OF((gz_statep));
  10 local int gz_comp OF((gz_statep, int));
  11 local int gz_zero OF((gz_statep, z_off64_t));
  12
  13 /* Initialize state for writing a gzip file.  Mark initialization by setting
  14    state->size to non-zero.  Return -1 on failure or 0 on success. */
  15 local int gz_init(state)
  16     gz_statep state;
  17 {
  18     int ret;
  19     z_streamp strm = &(state->strm);
  20
  21     /* allocate input buffer */
  22     state->in = malloc(state->want);
  23     if (state->in == NULL) {
  24         gz_error(state, Z_MEM_ERROR, "out of memory");
  25         return -1;
  26     }
  27
  28     /* only need output buffer and deflate state if compressing */
  29     if (!state->direct) {
  30         /* allocate output buffer */
  31         state->out = malloc(state->want);
  32         if (state->out == NULL) {
  33             free(state->in);
  34             gz_error(state, Z_MEM_ERROR, "out of memory");
  35             return -1;
  36         }
  37
  38         /* allocate deflate memory, set up for gzip compression */
  39         strm->zalloc = Z_NULL;
  40         strm->zfree = Z_NULL;
  41         strm->opaque = Z_NULL;
  42         ret = deflateInit2(strm, state->level, Z_DEFLATED,
  43                            MAX_WBITS + 16, DEF_MEM_LEVEL, state->strategy);
  44         if (ret != Z_OK) {
  45             free(state->out);
  46             free(state->in);
  47             gz_error(state, Z_MEM_ERROR, "out of memory");
  48             return -1;
  49         }
  50     }
  51
  52     /* mark state as initialized */
  53     state->size = state->want;
  54
  55     /* initialize write buffer if compressing */
  56     if (!state->direct) {
  57         strm->avail_out = state->size;
  58         strm->next_out = state->out;
  59         state->x.next = strm->next_out;
  60     }
  61     return 0;
  62 }
  63
  64 /* Compress whatever is at avail_in and next_in and write to the output file.
  65    Return -1 if there is an error writing to the output file, otherwise 0.
  66    flush is assumed to be a valid deflate() flush value.  If flush is Z_FINISH,
  67    then the deflate() state is reset to start a new gzip stream.  If gz->direct
  68    is true, then simply write to the output file without compressing, and
  69    ignore flush. */
  70 local int gz_comp(state, flush)
  71     gz_statep state;
  72     int flush;
  73 {
  74     int ret, got;
  75     unsigned have;
  76     z_streamp strm = &(state->strm);
  77
  78     /* allocate memory if this is the first time through */
  79     if (state->size == 0 && gz_init(state) == -1)
  80         return -1;
  81
  82     /* write directly if requested */
  83     if (state->direct) {
  84         got = write(state->fd, strm->next_in, strm->avail_in);
  85         if (got < 0 || (unsigned)got != strm->avail_in) {
  86             gz_error(state, Z_ERRNO, zstrerror());
  87             return -1;
  88         }
  89         strm->avail_in = 0;
  90         return 0;
  91     }
  92
  93     /* run deflate() on provided input until it produces no more output */
  94     ret = Z_OK;
  95     do {
  96         /* write out current buffer contents if full, or if flushing, but if
  97            doing Z_FINISH then don't write until we get to Z_STREAM_END */
  98         if (strm->avail_out == 0 || (flush != Z_NO_FLUSH &&
  99             (flush != Z_FINISH || ret == Z_STREAM_END))) {
 100             have = (unsigned)(strm->next_out - state->x.next);
 101             if (have && ((got = write(state->fd, state->x.next, have)) < 0 ||
 102                          (unsigned)got != have)) {
 103                 gz_error(state, Z_ERRNO, zstrerror());
 104                 return -1;
 105             }
 106             if (strm->avail_out == 0) {
 107                 strm->avail_out = state->size;
 108                 strm->next_out = state->out;
 109             }
 110             state->x.next = strm->next_out;
 111         }
 112
 113         /* compress */
 114         have = strm->avail_out;
 115         ret = deflate(strm, flush);
 116         if (ret == Z_STREAM_ERROR) {
 117             gz_error(state, Z_STREAM_ERROR,
 118                       "internal error: deflate stream corrupt");
 119             return -1;
 120         }
 121         have -= strm->avail_out;
 122     } while (have);
 123
 124     /* if that completed a deflate stream, allow another to start */
 125     if (flush == Z_FINISH)
 126         deflateReset(strm);
 127
 128     /* all done, no errors */
 129     return 0;
 130 }
 131
 132 /* Compress len zeros to output.  Return -1 on error, 0 on success. */
 133 local int gz_zero(state, len)
 134     gz_statep state;
 135     z_off64_t len;
 136 {
 137     int first;
 138     unsigned n;
 139     z_streamp strm = &(state->strm);
 140
 141     /* consume whatever's left in the input buffer */
 142     if (strm->avail_in && gz_comp(state, Z_NO_FLUSH) == -1)
 143         return -1;
 144
 145     /* compress len zeros (len guaranteed > 0) */
 146     first = 1;
 147     while (len) {
 148         n = GT_OFF(state->size) || (z_off64_t)state->size > len ?
 149             (unsigned)len : state->size;
 150         if (first) {
 151             memset(state->in, 0, n);
 152             first = 0;
 153         }
 154         strm->avail_in = n;
 155         strm->next_in = state->in;
 156         state->x.pos += n;
 157         if (gz_comp(state, Z_NO_FLUSH) == -1)
 158             return -1;
 159         len -= n;
 160     }
 161     return 0;
 162 }
 163
 164 /* -- see zlib.h -- */
 165 int ZEXPORT gzwrite(file, buf, len)
 166     gzFile file;
 167     voidpc buf;
 168     unsigned len;
 169 {
 170     unsigned put = len;
 171     gz_statep state;
 172     z_streamp strm;
 173
 174     /* get internal structure */
 175     if (file == NULL)
 176         return 0;
 177     state = (gz_statep)file;
 178     strm = &(state->strm);
 179
 180     /* check that we're writing and that there's no error */
 181     if (state->mode != GZ_WRITE || state->err != Z_OK)
 182         return 0;
 183
 184     /* since an int is returned, make sure len fits in one, otherwise return
 185        with an error (this avoids the flaw in the interface) */
 186     if ((int)len < 0) {
 187         gz_error(state, Z_DATA_ERROR, "requested length does not fit in int");
 188         return 0;
 189     }
 190
 191     /* if len is zero, avoid unnecessary operations */
 192     if (len == 0)
 193         return 0;
 194
 195     /* allocate memory if this is the first time through */
 196     if (state->size == 0 && gz_init(state) == -1)
 197         return 0;
 198
 199     /* check for seek request */
 200     if (state->seek) {
 201         state->seek = 0;
 202         if (gz_zero(state, state->skip) == -1)
 203             return 0;
 204     }
 205
 206     /* for small len, copy to input buffer, otherwise compress directly */
 207     if (len < state->size) {
 208         /* copy to input buffer, compress when full */
 209         do {
 210             unsigned have, copy;
 211
 212             if (strm->avail_in == 0)
 213                 strm->next_in = state->in;
 214             have = strm->next_in + strm->avail_in - state->in;
 215             copy = state->size - have;
 216             if (copy > len)
 217                 copy = len;
 218             memcpy(state->in + have, buf, copy);
 219             strm->avail_in += copy;
 220             state->x.pos += copy;
 221             buf = (const char *)buf + copy;
 222             len -= copy;
 223             if (len && gz_comp(state, Z_NO_FLUSH) == -1)
 224                 return 0;
 225         } while (len);
 226     }
 227     else {
 228         /* consume whatever's left in the input buffer */
 229         if (strm->avail_in && gz_comp(state, Z_NO_FLUSH) == -1)
 230             return 0;
 231
 232         /* directly compress user buffer to file */
 233         strm->avail_in = len;
 234         strm->next_in = (z_const Bytef *)buf;
 235         state->x.pos += len;
 236         if (gz_comp(state, Z_NO_FLUSH) == -1)
 237             return 0;
 238     }
 239
 240     /* input was all buffered or compressed (put will fit in int) */
 241     return (int)put;
 242 }
 243
 244 /* -- see zlib.h -- */
 245 int ZEXPORT gzputc(file, c)
 246     gzFile file;
 247     int c;
 248 {
 249     unsigned have;
 250     unsigned char buf[1];
 251     gz_statep state;
 252     z_streamp strm;
 253
 254     /* get internal structure */
 255     if (file == NULL)
 256         return -1;
 257     state = (gz_statep)file;
 258     strm = &(state->strm);
 259
 260     /* check that we're writing and that there's no error */
 261     if (state->mode != GZ_WRITE || state->err != Z_OK)
 262         return -1;
 263
 264     /* check for seek request */
 265     if (state->seek) {
 266         state->seek = 0;
 267         if (gz_zero(state, state->skip) == -1)
 268             return -1;
 269     }
 270
 271     /* try writing to input buffer for speed (state->size == 0 if buffer not
 272        initialized) */
 273     if (strm->avail_in == 0)
 274         strm->next_in = state->in;
 275     have = strm->next_in + strm->avail_in - state->in;
 276     if (have < state->size) {
 277         state->in[have] = c;
 278         strm->avail_in++;
 279         state->x.pos++;
 280         return c & 0xff;
 281     }
 282
 283     /* no room in buffer or not initialized, use gz_write() */
 284     buf[0] = c;
 285     if (gzwrite(file, buf, 1) != 1)
 286         return -1;
 287     return c & 0xff;
 288 }
 289
 290 /* -- see zlib.h -- */
 291 int ZEXPORT gzputs(file, str)
 292     gzFile file;
 293     const char *str;
 294 {
 295     int ret;
 296     unsigned len;
 297
 298     /* write string */
 299     len = (unsigned)strlen(str);
 300     ret = gzwrite(file, str, len);
 301     return ret == 0 && len != 0 ? -1 : ret;
 302 }
 303
 304 #if defined(STDC) || defined(Z_HAVE_STDARG_H)
 305 #include <stdarg.h>
 306
 307 /* -- see zlib.h -- */
 308 int ZEXPORTVA gzprintf (gzFile file, const char *format, ...)
 309 {
 310     int size, len;
 311     gz_statep state;
 312     z_streamp strm;
 313     va_list va;
 314
 315     /* get internal structure */
 316     if (file == NULL)
 317         return -1;
 318     state = (gz_statep)file;
 319     strm = &(state->strm);
 320
 321     /* check that we're writing and that there's no error */
 322     if (state->mode != GZ_WRITE || state->err != Z_OK)
 323         return 0;
 324
 325     /* make sure we have some buffer space */
 326     if (state->size == 0 && gz_init(state) == -1)
 327         return 0;
 328
 329     /* check for seek request */
 330     if (state->seek) {
 331         state->seek = 0;
 332         if (gz_zero(state, state->skip) == -1)
 333             return 0;
 334     }
 335
 336     /* consume whatever's left in the input buffer */
 337     if (strm->avail_in && gz_comp(state, Z_NO_FLUSH) == -1)
 338         return 0;
 339
 340     /* do the printf() into the input buffer, put length in len */
 341     size = (int)(state->size);
 342     state->in[size - 1] = 0;
 343     va_start(va, format);
 344 #ifdef NO_vsnprintf
 345 #  ifdef HAS_vsprintf_void
 346     (void)vsprintf((char *)(state->in), format, va);
 347     va_end(va);
 348     for (len = 0; len < size; len++)
 349         if (state->in[len] == 0) break;
 350 #  else
 351     len = vsprintf((char *)(state->in), format, va);
 352     va_end(va);
 353 #  endif
 354 #else
 355 #  ifdef HAS_vsnprintf_void
 356     (void)vsnprintf((char *)(state->in), size, format, va);
 357     va_end(va);
 358     len = strlen((char *)(state->in));
 359 #  else
 360     len = vsnprintf((char *)(state->in), size, format, va);
 361     va_end(va);
 362 #  endif
 363 #endif
 364
 365     /* check that printf() results fit in buffer */
 366     if (len <= 0 || len >= (int)size || state->in[size - 1] != 0)
 367         return 0;
 368
 369     /* update buffer and position, defer compression until needed */
 370     strm->avail_in = (unsigned)len;
 371     strm->next_in = state->in;
 372     state->x.pos += len;
 373     return len;
 374 }
 375
 376 #else /* !STDC && !Z_HAVE_STDARG_H */
 377
 378 /* -- see zlib.h -- */
 379 int ZEXPORTVA gzprintf (file, format, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10,
 380                        a11, a12, a13, a14, a15, a16, a17, a18, a19, a20)
 381     gzFile file;
 382     const char *format;
 383     int a1, a2, a3, a4, a5, a6, a7, a8, a9, a10,
 384         a11, a12, a13, a14, a15, a16, a17, a18, a19, a20;
 385 {
 386     int size, len;
 387     gz_statep state;
 388     z_streamp strm;
 389
 390     /* get internal structure */
 391     if (file == NULL)
 392         return -1;
 393     state = (gz_statep)file;
 394     strm = &(state->strm);
 395
 396     /* check that can really pass pointer in ints */
 397     if (sizeof(int) != sizeof(void *))
 398         return 0;
 399
 400     /* check that we're writing and that there's no error */
 401     if (state->mode != GZ_WRITE || state->err != Z_OK)
 402         return 0;
 403
 404     /* make sure we have some buffer space */
 405     if (state->size == 0 && gz_init(state) == -1)
 406         return 0;
 407
 408     /* check for seek request */
 409     if (state->seek) {
 410         state->seek = 0;
 411         if (gz_zero(state, state->skip) == -1)
 412             return 0;
 413     }
 414
 415     /* consume whatever's left in the input buffer */
 416     if (strm->avail_in && gz_comp(state, Z_NO_FLUSH) == -1)
 417         return 0;
 418
 419     /* do the printf() into the input buffer, put length in len */
 420     size = (int)(state->size);
 421     state->in[size - 1] = 0;
 422 #ifdef NO_snprintf
 423 #  ifdef HAS_sprintf_void
 424     sprintf((char *)(state->in), format, a1, a2, a3, a4, a5, a6, a7, a8,
 425             a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20);
 426     for (len = 0; len < size; len++)
 427         if (state->in[len] == 0) break;
 428 #  else
 429     len = sprintf((char *)(state->in), format, a1, a2, a3, a4, a5, a6, a7, a8,
 430                   a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20);
 431 #  endif
 432 #else
 433 #  ifdef HAS_snprintf_void
 434     snprintf((char *)(state->in), size, format, a1, a2, a3, a4, a5, a6, a7, a8,
 435              a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20);
 436     len = strlen((char *)(state->in));
 437 #  else
 438     len = snprintf((char *)(state->in), size, format, a1, a2, a3, a4, a5, a6,
 439                    a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18,
 440                    a19, a20);
 441 #  endif
 442 #endif
 443
 444     /* check that printf() results fit in buffer */
 445     if (len <= 0 || len >= (int)size || state->in[size - 1] != 0)
 446         return 0;
 447
 448     /* update buffer and position, defer compression until needed */
 449     strm->avail_in = (unsigned)len;
 450     strm->next_in = state->in;
 451     state->x.pos += len;
 452     return len;
 453 }
 454
 455 #endif
 456
 457 /* -- see zlib.h -- */
 458 int ZEXPORT gzflush(file, flush)
 459     gzFile file;
 460     int flush;
 461 {
 462     gz_statep state;
 463
 464     /* get internal structure */
 465     if (file == NULL)
 466         return -1;
 467     state = (gz_statep)file;
 468
 469     /* check that we're writing and that there's no error */
 470     if (state->mode != GZ_WRITE || state->err != Z_OK)
 471         return Z_STREAM_ERROR;
 472
 473     /* check flush parameter */
 474     if (flush < 0 || flush > Z_FINISH)
 475         return Z_STREAM_ERROR;
 476
 477     /* check for seek request */
 478     if (state->seek) {
 479         state->seek = 0;
 480         if (gz_zero(state, state->skip) == -1)
 481             return -1;
 482     }
 483
 484     /* compress remaining data with requested flush */
 485     gz_comp(state, flush);
 486     return state->err;
 487 }
 488
 489 /* -- see zlib.h -- */
 490 int ZEXPORT gzsetparams(file, level, strategy)
 491     gzFile file;
 492     int level;
 493     int strategy;
 494 {
 495     gz_statep state;
 496     z_streamp strm;
 497
 498     /* get internal structure */
 499     if (file == NULL)
 500         return Z_STREAM_ERROR;
 501     state = (gz_statep)file;
 502     strm = &(state->strm);
 503
 504     /* check that we're writing and that there's no error */
 505     if (state->mode != GZ_WRITE || state->err != Z_OK)
 506         return Z_STREAM_ERROR;
 507
 508     /* if no change is requested, then do nothing */
 509     if (level == state->level && strategy == state->strategy)
 510         return Z_OK;
 511
 512     /* check for seek request */
 513     if (state->seek) {
 514         state->seek = 0;
 515         if (gz_zero(state, state->skip) == -1)
 516             return -1;
 517     }
 518
 519     /* change compression parameters for subsequent input */
 520     if (state->size) {
 521         /* flush previous input with previous parameters before changing */
 522         if (strm->avail_in && gz_comp(state, Z_PARTIAL_FLUSH) == -1)
 523             return state->err;
 524         deflateParams(strm, level, strategy);
 525     }
 526     state->level = level;
 527     state->strategy = strategy;
 528     return Z_OK;
 529 }
 530
 531 /* -- see zlib.h -- */
 532 int ZEXPORT gzclose_w(file)
 533     gzFile file;
 534 {
 535     int ret = Z_OK;
 536     gz_statep state;
 537
 538     /* get internal structure */
 539     if (file == NULL)
 540         return Z_STREAM_ERROR;
 541     state = (gz_statep)file;
 542
 543     /* check that we're writing */
 544     if (state->mode != GZ_WRITE)
 545         return Z_STREAM_ERROR;
 546
 547     /* check for seek request */
 548     if (state->seek) {
 549         state->seek = 0;
 550         if (gz_zero(state, state->skip) == -1)
 551             ret = state->err;
 552     }
 553
 554     /* flush, free memory, and close file */
 555     if (state->size) {
 556         if (gz_comp(state, Z_FINISH) == -1)
 557             ret = state->err;
 558         if (!state->direct) {
 559             (void)deflateEnd(&(state->strm));
 560             free(state->out);
 561         }
 562         free(state->in);
 563     }
 564     gz_error(state, Z_OK, NULL);
 565     free(state->path);
 566     if (close(state->fd) == -1)
 567         ret = Z_ERRNO;
 568     free(state);
 569     return ret;
 570 }