heavy-pico/test-pico-io/lib/Heavy/HvMessagePool.c

/**
 * Copyright (c) 2014-2018 Enzien Audio Ltd.
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

#include "HvMessagePool.h"
#include "HvMessage.h"

// the number of bytes reserved at a time from the pool
#define MP_BLOCK_SIZE_BYTES 512

#if HV_APPLE
#pragma mark - MessageList
#endif

typedef struct MessageListNode {
  char *p;
  struct MessageListNode *next;
} MessageListNode;

static inline bool ml_hasAvailable(HvMessagePoolList *ml) {
  return (ml->head != NULL);
}

static char *ml_pop(HvMessagePoolList *ml) {
  MessageListNode *n = ml->head;
  ml->head = n->next;
  n->next = ml->pool;
  ml->pool = n;
  char *const p = n->p;
  n->p = NULL; // set to NULL to make it clear that this node does not have a valid buffer
  return p;
}

/** Push a MessageListNode with the given pointer onto the head of the queue. */
static void ml_push(HvMessagePoolList *ml, void *p) {
  MessageListNode *n = NULL;
  if (ml->pool != NULL) {
    // take an empty MessageListNode from the pool
    n = ml->pool;
    ml->pool = n->next;
  } else {
    // a MessageListNode is not available, allocate one
    n = (MessageListNode *) hv_malloc(sizeof(MessageListNode));
    hv_assert(n != NULL);
  }
  n->p = (char *) p;
  n->next = ml->head;
  ml->head = n; // push to the front of the queue
}

static void ml_free(HvMessagePoolList *ml) {
  if (ml != NULL) {
    while (ml_hasAvailable(ml)) {
      ml_pop(ml);
    }
    while (ml->pool != NULL) {
      MessageListNode *n = ml->pool;
      ml->pool = n->next;
      hv_free(n);
    }
  }
}

#if HV_APPLE
#pragma mark - HvMessagePool
#endif

static hv_size_t mp_messagelistIndexForSize(hv_size_t byteSize) {
  return (hv_size_t) hv_max_i((hv_min_max_log2((hv_uint32_t) byteSize) - 5), 0);
}

hv_size_t mp_init(HvMessagePool *mp, hv_size_t numKB) {
  mp->bufferSize = numKB * 1024;
  mp->buffer = (char *) hv_malloc(mp->bufferSize);
  hv_assert(mp->buffer != NULL);
  mp->bufferIndex = 0;

  // initialise all message lists
  for (int i = 0; i < MP_NUM_MESSAGE_LISTS; i++) {
    mp->lists[i].head = NULL;
    mp->lists[i].pool = NULL;
  }

  return mp->bufferSize;
}

void mp_free(HvMessagePool *mp) {
  hv_free(mp->buffer);
  for (int i = 0; i < MP_NUM_MESSAGE_LISTS; i++) {
    ml_free(&mp->lists[i]);
  }
}

void mp_freeMessage(HvMessagePool *mp, HvMessage *m) {
  const hv_size_t b = msg_getSize(m); // the number of bytes that a message occupies in memory
  const hv_size_t i = mp_messagelistIndexForSize(b); // the HvMessagePoolList index in the pool
  HvMessagePoolList *ml = &mp->lists[i];
  const hv_size_t chunkSize = 32 << i;
  hv_memclear(m, chunkSize); // clear the chunk, just in case
  ml_push(ml, m);
}

HvMessage *mp_addMessage(HvMessagePool *mp, const HvMessage *m) {
  const hv_size_t b = msg_getSize(m);
  // determine the message list index to allocate data from based on the msg size
  // smallest chunk size is 32 bytes
  const hv_size_t i = mp_messagelistIndexForSize(b);

  hv_assert(i < MP_NUM_MESSAGE_LISTS); // how many chunk sizes do we want to support? 32, 64, 128, 256 at the moment
  HvMessagePoolList *ml = &mp->lists[i];
  const hv_size_t chunkSize = 32 << i;

  if (ml_hasAvailable(ml)) {
    char *buf = ml_pop(ml);
    msg_copyToBuffer(m, buf, chunkSize);
    return (HvMessage *) buf;
  } else {
    // if no appropriately sized buffer is immediately available, increase the size of the used buffer
    const hv_size_t newIndex = mp->bufferIndex + MP_BLOCK_SIZE_BYTES;
    hv_assert((newIndex <= mp->bufferSize) &&
        "The message pool buffer size has been exceeded. The context cannot store more messages. "
        "Try using the new_with_options() initialiser with a larger pool size (default is 10KB).");

    for (hv_size_t j = mp->bufferIndex; j < newIndex; j += chunkSize) {
      ml_push(ml, mp->buffer + j); // push new nodes onto the list with chunk pointers
    }
    mp->bufferIndex = newIndex;
    char *buf = ml_pop(ml);
    msg_copyToBuffer(m, buf, chunkSize);
    return (HvMessage *) buf;
  }
}