ucx: src/buffer.c@2e73456e5f84

     1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

     3  *

     4  * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.

     5  *

     6  * Redistribution and use in source and binary forms, with or without

     7  * modification, are permitted provided that the following conditions are met:

     8  *

     9  *   1. Redistributions of source code must retain the above copyright

    10  *      notice, this list of conditions and the following disclaimer.

    11  *

    12  *   2. Redistributions in binary form must reproduce the above copyright

    13  *      notice, this list of conditions and the following disclaimer in the

    14  *      documentation and/or other materials provided with the distribution.

    15  *

    16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

    19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE

    20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

    21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

    23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

    24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

    25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

    26  * POSSIBILITY OF SUCH DAMAGE.

    27  */

    29 #include "cx/buffer.h"

    30 #include "cx/utils.h"

    32 #include <stdlib.h>

    33 #include <stdio.h>

    34 #include <string.h>

    35 #include <stdint.h>

    37 int cxBufferInit(

    38         CxBuffer *buffer,

    39         void *space,

    40         size_t capacity,

    41         CxAllocator const *allocator,

    42         int flags

    43 ) {

    44     buffer->allocator = allocator;

    45     buffer->flags = flags;

    46     if (!space) {

    47         buffer->bytes = cxMalloc(allocator, capacity);

    48         if (buffer->bytes == NULL) {

    49             return 1;

    50         }

    51         buffer->flags |= CX_BUFFER_FREE_CONTENTS;

    52     } else {

    53         buffer->bytes = space;

    54     }

    55     buffer->capacity = capacity;

    56     buffer->size = 0;

    57     buffer->pos = 0;

    59     buffer->flush_func = NULL;

    60     buffer->flush_target = NULL;

    61     buffer->flush_blkmax = 0;

    62     buffer->flush_blksize = 4096;

    63     buffer->flush_threshold = SIZE_MAX;

    65     return 0;

    66 }

    68 void cxBufferDestroy(CxBuffer *buffer) {

    69     if ((buffer->flags & CX_BUFFER_FREE_CONTENTS) == CX_BUFFER_FREE_CONTENTS) {

    70         cxFree(buffer->allocator, buffer->bytes);

    71     }

    72 }

    74 int cxBufferSeek(

    75         CxBuffer *buffer,

    76         off_t offset,

    77         int whence

    78 ) {

    79     size_t npos;

    80     switch (whence) {

    81         case SEEK_CUR:

    82             npos = buffer->pos;

    83             break;

    84         case SEEK_END:

    85             npos = buffer->size;

    86             break;

    87         case SEEK_SET:

    88             npos = 0;

    89             break;

    90         default:

    91             return -1;

    92     }

    94     size_t opos = npos;

    95     npos += offset;

    97     if ((offset > 0 && npos < opos) || (offset < 0 && npos > opos)) {

    98         return -1;

    99     }

   101     if (npos >= buffer->size) {

   102         return -1;

   103     } else {

   104         buffer->pos = npos;

   105         return 0;

   106     }

   108 }

   110 void cxBufferClear(CxBuffer *buffer) {

   111     memset(buffer->bytes, 0, buffer->size);

   112     buffer->size = 0;

   113     buffer->pos = 0;

   114 }

   116 int cxBufferEof(CxBuffer const *buffer) {

   117     return buffer->pos >= buffer->size;

   118 }

   120 int cxBufferMinimumCapacity(

   121         CxBuffer *buffer,

   122         size_t newcap

   123 ) {

   124     if (newcap <= buffer->capacity) {

   125         return 0;

   126     }

   128     if (cxReallocate(buffer->allocator,

   129                      (void **) &buffer->bytes, newcap) == 0) {

   130         buffer->capacity = newcap;

   131         return 0;

   132     } else {

   133         return -1;

   134     }

   135 }

   137 /**

   138  * Helps flushing data to the flush target of a buffer.

   139  *

   140  * @param buffer the buffer containing the config

   141  * @param space the data to flush

   142  * @param size the element size

   143  * @param nitems the number of items

   144  * @return the number of items flushed

   145  */

   146 static size_t cx_buffer_write_flush_helper(

   147         CxBuffer *buffer,

   148         unsigned char const *space,

   149         size_t size,

   150         size_t nitems

   151 ) {

   152     size_t pos = 0;

   153     size_t remaining = nitems;

   154     size_t max_items = buffer->flush_blksize / size;

   155     while (remaining > 0) {

   156         size_t items = remaining > max_items ? max_items : remaining;

   157         size_t flushed = buffer->flush_func(

   158                 space + pos,

   159                 size, items,

   160                 buffer->flush_target);

   161         if (flushed > 0) {

   162             pos += (flushed * size);

   163             remaining -= flushed;

   164         } else {

   165             // if no bytes can be flushed out anymore, we give up

   166             break;

   167         }

   168     }

   169     return nitems - remaining;

   170 }

   172 size_t cxBufferWrite(

   173         void const *ptr,

   174         size_t size,

   175         size_t nitems,

   176         CxBuffer *buffer

   177 ) {

   178     // optimize for easy case

   179     if (size == 1 && (buffer->capacity - buffer->pos) >= nitems) {

   180         memcpy(buffer->bytes + buffer->pos, ptr, nitems);

   181         buffer->pos += nitems;

   182         if (buffer->pos > buffer->size) {

   183             buffer->size = buffer->pos;

   184         }

   185         return nitems;

   186     }

   188     size_t len;

   189     size_t nitems_out = nitems;

   190     if (cx_szmul(size, nitems, &len)) {

   191         return 0;

   192     }

   193     size_t required = buffer->pos + len;

   194     if (buffer->pos > required) {

   195         return 0;

   196     }

   198     bool perform_flush = false;

   199     if (required > buffer->capacity) {

   200         if ((buffer->flags & CX_BUFFER_AUTO_EXTEND) == CX_BUFFER_AUTO_EXTEND && required) {

   201             if (buffer->flush_blkmax > 0 && required > buffer->flush_threshold) {

   202                 perform_flush = true;

   203             } else {

   204                 if (cxBufferMinimumCapacity(buffer, required)) {

   205                     return 0;

   206                 }

   207             }

   208         } else {

   209             if (buffer->flush_blkmax > 0) {

   210                 perform_flush = true;

   211             } else {

   212                 // truncate data to be written, if we can neither extend nor flush

   213                 len = buffer->capacity - buffer->pos;

   214                 if (size > 1) {

   215                     len -= len % size;

   216                 }

   217                 nitems_out = len / size;

   218             }

   219         }

   220     }

   222     if (len == 0) {

   223         return len;

   224     }

   226     if (perform_flush) {

   227         size_t flush_max;

   228         if (cx_szmul(buffer->flush_blkmax, buffer->flush_blksize, &flush_max)) {

   229             return 0;

   230         }

   231         size_t flush_pos = buffer->flush_func == NULL || buffer->flush_target == NULL

   232                            ? buffer->pos

   233                            : cx_buffer_write_flush_helper(buffer, buffer->bytes, 1, buffer->pos);

   234         if (flush_pos == buffer->pos) {

   235             // entire buffer has been flushed, we can reset

   236             buffer->size = buffer->pos = 0;

   238             size_t items_flush; // how many items can also be directly flushed

   239             size_t items_keep; // how many items have to be written to the buffer

   241             items_flush = flush_max >= required ? nitems : (flush_max - flush_pos) / size;

   242             if (items_flush > 0) {

   243                 items_flush = cx_buffer_write_flush_helper(buffer, ptr, size, items_flush / size);

   244                 // in case we could not flush everything, keep the rest

   245             }

   246             items_keep = nitems - items_flush;

   247             if (items_keep > 0) {

   248                 // try again with the remaining stuff

   249                 unsigned char const *new_ptr = ptr;

   250                 new_ptr += items_flush * size;

   251                 return cxBufferWrite(new_ptr, size, items_keep, buffer);

   252             } else {

   253                 // all items have been flushed - report them as written

   254                 return nitems;

   255             }

   256         } else if (flush_pos == 0) {

   257             // nothing could be flushed at all, we immediately give up without writing any data

   258             return 0;

   259         } else {

   260             // we were partially successful, we have shift left and try again

   261             cxBufferShiftLeft(buffer, flush_pos);

   262             return cxBufferWrite(ptr, size, nitems, buffer);

   263         }

   264     } else {

   265         memcpy(buffer->bytes + buffer->pos, ptr, len);

   266         buffer->pos += len;

   267         if (buffer->pos > buffer->size) {

   268             buffer->size = buffer->pos;

   269         }

   270         return nitems_out;

   271     }

   273 }

   275 int cxBufferPut(

   276         CxBuffer *buffer,

   277         int c

   278 ) {

   279     c &= 0xFF;

   280     unsigned char const ch = c;

   281     if (cxBufferWrite(&ch, 1, 1, buffer) == 1) {

   282         return c;

   283     } else {

   284         return EOF;

   285     }

   286 }

   288 size_t cxBufferPutString(

   289         CxBuffer *buffer,

   290         const char *str

   291 ) {

   292     return cxBufferWrite(str, 1, strlen(str), buffer);

   293 }

   295 size_t cxBufferRead(

   296         void *ptr,

   297         size_t size,

   298         size_t nitems,

   299         CxBuffer *buffer

   300 ) {

   301     size_t len;

   302     if (cx_szmul(size, nitems, &len)) {

   303         return 0;

   304     }

   305     if (buffer->pos + len > buffer->size) {

   306         len = buffer->size - buffer->pos;

   307         if (size > 1) len -= len % size;

   308     }

   310     if (len <= 0) {

   311         return len;

   312     }

   314     memcpy(ptr, buffer->bytes + buffer->pos, len);

   315     buffer->pos += len;

   317     return len / size;

   318 }

   320 int cxBufferGet(CxBuffer *buffer) {

   321     if (cxBufferEof(buffer)) {

   322         return EOF;

   323     } else {

   324         int c = buffer->bytes[buffer->pos];

   325         buffer->pos++;

   326         return c;

   327     }

   328 }

   330 int cxBufferShiftLeft(

   331         CxBuffer *buffer,

   332         size_t shift

   333 ) {

   334     if (shift >= buffer->size) {

   335         buffer->pos = buffer->size = 0;

   336     } else {

   337         memmove(buffer->bytes, buffer->bytes + shift, buffer->size - shift);

   338         buffer->size -= shift;

   340         if (buffer->pos >= shift) {

   341             buffer->pos -= shift;

   342         } else {

   343             buffer->pos = 0;

   344         }

   345     }

   346     return 0;

   347 }

   349 int cxBufferShiftRight(

   350         CxBuffer *buffer,

   351         size_t shift

   352 ) {

   353     size_t req_capacity = buffer->size + shift;

   354     size_t movebytes;

   356     // auto extend buffer, if required and enabled

   357     if (buffer->capacity < req_capacity) {

   358         if ((buffer->flags & CX_BUFFER_AUTO_EXTEND) == CX_BUFFER_AUTO_EXTEND) {

   359             if (cxBufferMinimumCapacity(buffer, req_capacity)) {

   360                 return 1;

   361             }

   362             movebytes = buffer->size;

   363         } else {

   364             movebytes = buffer->capacity - shift;

   365         }

   366     } else {

   367         movebytes = buffer->size;

   368     }

   370     memmove(buffer->bytes + shift, buffer->bytes, movebytes);

   371     buffer->size = shift + movebytes;

   373     buffer->pos += shift;

   374     if (buffer->pos > buffer->size) {

   375         buffer->pos = buffer->size;

   376     }

   378     return 0;

   379 }

   381 int cxBufferShift(

   382         CxBuffer *buffer,

   383         off_t shift

   384 ) {

   385     if (shift < 0) {

   386         return cxBufferShiftLeft(buffer, (size_t) (-shift));

   387     } else if (shift > 0) {

   388         return cxBufferShiftRight(buffer, (size_t) shift);

   389     } else {

   390         return 0;

   391     }

   392 }

Mercurial > hg > ucx / file revision

src/buffer.c@2e73456e5f84

src/buffer.c