coap_mem.h

Go to the documentation of this file.

/*
 * coap_mem.h -- CoAP memory handling
 *
 * Copyright (C) 2010-2011,2014-2015 Olaf Bergmann <bergmann@tzi.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_MEM_H_
#define COAP_MEM_H_
 
#include "coap3/coap_oscore.h"
#include "coap3/coap_proxy.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
  COAP_STRING,
  COAP_ATTRIBUTE_NAME,
  COAP_ATTRIBUTE_VALUE,
  COAP_PACKET,
  COAP_NODE,
  COAP_CONTEXT,
  COAP_ENDPOINT,
  COAP_PDU,
  COAP_PDU_BUF,
  COAP_RESOURCE,
  COAP_RESOURCEATTR,
  COAP_DTLS_SESSION,
  COAP_SESSION,
  COAP_OPTLIST,
  COAP_CACHE_KEY,
  COAP_CACHE_ENTRY,
  COAP_LG_XMIT,
  COAP_LG_CRCV,
  COAP_LG_SRCV,
  COAP_DIGEST_CTX,
  COAP_SUBSCRIPTION,
  COAP_DTLS_CONTEXT,
  COAP_OSCORE_COM,
  COAP_OSCORE_SEN,
  COAP_OSCORE_REC,
  COAP_OSCORE_EX,
  COAP_OSCORE_EP,
  COAP_OSCORE_BUF,
  COAP_COSE,
  COAP_MEM_TAG_LAST
} coap_memory_tag_t;
 
void coap_dump_memory_type_counts(coap_log_t log_level);
 
#if ! defined(WITH_LWIP) || (defined(WITH_LWIP) && ! MEMP_USE_CUSTOM_POOLS && ! MEM_USE_POOLS)
 
void coap_memory_init(void);
 
void *coap_malloc_type(coap_memory_tag_t type, size_t size);
 
void *coap_realloc_type(coap_memory_tag_t type, void *p, size_t size);
 
void coap_free_type(coap_memory_tag_t type, void *p);
 
COAP_STATIC_INLINE void *
coap_malloc(size_t size) {
  return coap_malloc_type(COAP_STRING, size);
}
 
COAP_STATIC_INLINE void
coap_free(void *object) {
  coap_free_type(COAP_STRING, object);
}
 
#else /* WITH_LWIP && (MEMP_USE_CUSTOM_POOLS || MEM_USE_POOLS) */
 
#include <lwip/memp.h>
 
/* no initialization needed with lwip (or, more precisely: lwip must be
 * completely initialized anyway by the time coap gets active)  */
COAP_STATIC_INLINE void
coap_memory_init(void) {}
 
#if MEMP_STATS
COAP_STATIC_INLINE void *
coap_malloc_error(uint16_t *err) {
  (*err)++;
  return NULL;
}
#endif /* MEMP_STATS */
/*
 * It would be nice to check that size equals the size given at the memp
 * declaration, but I currently don't see a standard way to check that without
 * sourcing the custom memp pools and becoming dependent of its syntax
 */
#if MEM_USE_POOLS
 
void *coap_malloc_type_string(size_t size);
 
void *coap_realloc_type_string(void *p, size_t size);
 
void coap_free_type_string(void *p);
 
#if MEMP_STATS
 
#define coap_malloc_type(type, asize) \
  (type == COAP_STRING) ? coap_malloc_type_string(asize) : \
  (((asize) <= memp_pools[MEMP_ ## type]->size) ? \
   memp_malloc(MEMP_ ## type) : coap_malloc_error(&memp_pools[MEMP_ ## type]->stats->err))
 
#else /* ! MEMP_STATS */
 
#define coap_malloc_type(type, asize) \
  (type == COAP_STRING) ? coap_malloc_type_string(asize) : \
  (((asize) <= memp_pools[MEMP_ ## type]->size) ? \
   memp_malloc(MEMP_ ## type) : NULL)
#endif /* ! MEMP_STATS */
 
#define coap_free_type(type, p) \
  (type == COAP_STRING) ? coap_free_type_string(p) : \
  memp_free(MEMP_ ## type, p)
 
/* As these are fixed size, return value if already defined */
#define coap_realloc_type(type, p, asize) \
  (type == COAP_STRING) ? coap_realloc_type_string(p, asize) : \
  ((p) ? ((asize) <= memp_pools[MEMP_ ## type]->size) ? (p) : NULL : coap_malloc_type(type, asize))
 
#else /* ! MEM_USE_POOLS */
 
#if MEMP_STATS
 
#define coap_malloc_type(type, asize) \
  (((asize) <= memp_pools[MEMP_ ## type]->size) ? \
   memp_malloc(MEMP_ ## type) : coap_malloc_error(&memp_pools[MEMP_ ## type]->stats->err))
 
#else /* ! MEMP_STATS */
 
#define coap_malloc_type(type, asize) \
  (((asize) <= memp_pools[MEMP_ ## type]->size) ? \
   memp_malloc(MEMP_ ## type) : NULL)
#endif /* ! MEMP_STATS */
 
#define coap_free_type(type, p) memp_free(MEMP_ ## type, p)
 
/* As these are fixed size, return value if already defined */
#define coap_realloc_type(type, p, asize) \
  ((p) ? ((asize) <= memp_pools[MEMP_ ## type]->size) ? (p) : NULL : coap_malloc_type(type, asize))
#endif /* MEM_USE_POOLS */
 
/* Those are just here to make uri.c happy where string allocation has not been
 * made conditional.
 */
COAP_STATIC_INLINE void *
coap_malloc(size_t size) {
  (void)size;
  LWIP_ASSERT("coap_malloc must not be used in lwIP", 0);
  return NULL;
}
 
COAP_STATIC_INLINE void
coap_free(void *pointer) {
  (void)pointer;
  LWIP_ASSERT("coap_free must not be used in lwIP", 0);
}
 
#endif /* WITH_LWIP && (MEMP_USE_CUSTOM_POOLS || MEM_USE_POOLS) */
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_MEM_H_ */