fragpool.h

Go to the documentation of this file.

/* Copyright 2012-2017, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the software nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef FRAGPOOL_H_
#define FRAGPOOL_H_

#include <stdint.h>

#define FP_VERSION 20170302

typedef uint16_t fp_size_t;

typedef int16_t fp_ssize_t;

#define FP_MAX_FRAGMENT_SIZE INT16_MAX

#define FP_EINVAL 1

typedef struct fp_fragment_t {
  uint8_t* start;

  fp_ssize_t length;
} *fp_fragment_t;

#define FP_POOL_STRUCT_COMMON                   \
  uint8_t* pool_start;                          \
  uint8_t* pool_end;                            \
  uint8_t pool_alignment;                       \
  uint8_t fragment_count

#ifdef FP_DOXYGEN

struct FP_POOL_STRUCT_COMMON_ {
  uint8_t* pool_start;

  uint8_t* pool_end;

  uint8_t pool_alignment;

  uint8_t fragment_count;
};
#endif /* FP_DOXYGEN */

typedef struct fp_pool_t {
  FP_POOL_STRUCT_COMMON;

  struct fp_fragment_t fragment[];
} *fp_pool_t;

void fp_reset (fp_pool_t pool);

uint8_t* fp_request (fp_pool_t pool,
                     fp_size_t min_size,
                     fp_size_t max_size,
                     uint8_t** fragment_endp);

uint8_t* fp_resize (fp_pool_t pool,
                    uint8_t* bp,
                    fp_size_t new_size,
                    uint8_t** fragment_endp);

uint8_t* fp_reallocate (fp_pool_t pool,
                        uint8_t* bp,
                        fp_size_t min_size,
                        fp_size_t max_size,
                        uint8_t** fragment_endp);

int fp_release (fp_pool_t pool,
                const uint8_t* bp);

int fp_validate (const fp_pool_t pool);

#endif /* FRAGPOOL_H_ */