path: root/support/dktools/dk4mem.h

/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4mem.ctr
*/

#ifndef DK4MEM_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4MEM_H_INCLUDED 1


#line 9 "dk4mem.ctr"

/**	@file	dk4mem.h Memory operations.

	Memory allocation and deallocation;
	copy, reset and compare memory regions.

	The functions provided by the C runtime libraries are used by
	default. On Windows you can decide to use Windows API functions
	instead, define DK4_WIN_AVOID_CRT or DK4_WIN_DENY_CRT to 1.
	
	When using Windows API functions dynamic memory allocations use
	the global heap. Define DK4_USE_WINDOWS_LOCAL_ALLOC to 1 to
	use the local heap instead.
*/

#ifndef DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif

#if	DK4_HAVE_STRING_H
#ifndef	STRING_H_INCLUDED
#include <string.h>
#define	STRING_H_INCLUDED 1
#endif
#endif

#if	DK4_HAVE_STRINGS_H
#ifndef	STRINGS_H_INCLUDED
#include <strings.h>
#define	STRINGS_H_INCLUDED 1
#endif
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if	((!(DK4_ON_WINDOWS)) && (!(DK4_HAVE_MEMCPY)) && (!(DK4_HAVE_BCOPY)))

/**	Fallback function to use if no suitable memory copy function is found.
	This function does not do any error checking.
	The caller is responsible to provide valid arguments.
	If dst and src overlap, src must be right from dst.

	CRT on Windows: Not used.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
void
dk4mem_fallback_cpy(void *dst, const void *src, size_t sz);

#endif



#if	((!(DK4_ON_WINDOWS)) && (!(DK4_HAVE_MEMSET)) && (!(DK4_HAVE_BZERO)))

/**	Fallback function to use if no suitable memory reseet function is found.
	This function does not do any error checking.
	The caller is responsible to provide valid arguments.

	CRT on Windows: Not used.
	@param	bptr	Address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
void
dk4mem_fallback_reset(void *bptr, size_t sz);

#endif

#if	(DK4_ON_WINDOWS && (DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT)) \
|| ((!(DK4_ON_WINDOWS)) && (!(DK4_HAVE_MEMCMP)) && (!(DK4_HAVE_BCMP)))

/**	Fallback function to use if no suitable memory comparison function
	is found.
	This function does not do any error checking.
	The caller is responsible to provide valid arguments.

	CRT on Windows: Not used.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Buffer size (number of bytes).
	@return	Positive value if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
int
dk4mem_fallback_cmp(const void *s1, const void *s2, size_t sz);

#endif

/**	Reset memory range.
	Do not use dk4mem_reset() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	bptr	Pointer to start of buffer.
	@param	sz	Buffer size (number of bytes).
	@param	erp	Error report for diagnostics, may be NULL.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if bptr is NULL or sz is 0.
*/
void
dk4mem_reset(void *bptr, size_t sz, dk4_er_t *erp);

/**	Set memory range to specified value.

	This function uses self-made fallback code if memset() is not
	available or use of the CRT is disabled on Windows.
	To reset memory, the recommended function is dk4mem_reset().

	CRT on Windows:	Optional, disabling CRT degrades performance.
	@param	bptr	Pointer to start of buffer.
	@param	sz	Buffer size (number of bytes).
	@param	uc	Byte value to write.
	@param	erp	Error report for diagnostics, may be NULL.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if bptr is NULL or sz is 0.
*/
void
dk4mem_set(void *bptr, size_t sz, unsigned char uc, dk4_er_t *erp);

/**	Copy memory range, source and destination must not overlap.

	CRT on Windows: Optional.
	@param	dst	Destination address.
	@param	src	Source address.
	@param	sz	Range size (number of bytes).
	@param	erp	Error report, may be NULL.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dst or src is NULL or sz is 0.
*/
void
dk4mem_cpy(void *dst, void const *src, size_t sz, dk4_er_t *erp);

/**	Compare two memory ranges.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Left memory range.
	@param	s2	Right memory range.
	@param	sz	Number of bytes to compare.
	@param	erp	Error report, may be NULL.
	@return	1 if s1>s2, -1 if s1<s2, 0 if s1==s2.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if s1 or s2 is NULL or sz is 0.
*/
int
dk4mem_cmp(const void *s1, const void *s2, size_t sz, dk4_er_t *erp);

#if (DK4_ON_WINDOWS) || (DK4_HAVE_MALLOC && DK4_HAVE_FREE)

/**	Dynamically allocate memory. The memory range is not initialized.

	CRT on Windows: Optional.
	@param	bytes	Number of bytes to allocate.
	@param	erp	Error report, may be NULL.
	@return	Pointer to memory on success, NULL on error.
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if bytes is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  if the specified size is too large,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory
	  available.
*/
void *
dk4mem_malloc_bytes(size_t bytes, dk4_er_t *erp);

/**	Dynamically allocate memory. The memory range is not initialized.

	CRT on Windows: Optional.
	@param	elsize	Size of each element.
	@param	nelem	Number of elements.
	@param	erp	Error report, may be NULL.
	@return	Pointer to memory on success, NULL on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if elsize or nelem is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  on numeric overflow when calculating the
	  product of elsize and nelem,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory available.
*/
void *
dk4mem_malloc(size_t elsize, size_t nelem, dk4_er_t *erp);

/**	Dynamically allocate memory and initialize memory range.

	CRT on Windows: Optional.
	@param	elsize	Size of each element.
	@param	nelem	Number of elements.
	@param	erp	Error report, may be NULL.
	@return	Pointer to memory on success, NULL on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if elsize or nelem is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  on numeric overflow when calculating the
	  product of elsize and nelem,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory available.
*/
void *
dk4mem_calloc(size_t elsize, size_t nelem, dk4_er_t *erp);

/**	Release memory allocated by dk4mem_malloc() or dk4mem_calloc().
	The function checks whether the pointer is NULL and frees
	the memory only for non-NULL pointers.

	CRT on Windows: Optional.
	@param	ptr	Pointer to start address of memory to release.
*/
void
dk4mem_free(void *ptr);

#endif

#ifdef __cplusplus
}
#endif


/**	Allocate and initialize memory.

	CRT on Windows: Optional.
	@param	tp	Type to allocate.
	@param	ne	Number of elements to allocate.
	@param	er	Error report, may be NULL.
	@return	Pointer to a new tp on success, NULL on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if elsize or nelem is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  on numeric overflow when calculating the product of elsize and nelem,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem set if there is not enough memory
	  available.
*/
#define	dk4mem_new(tp,ne,er) 	(tp *)dk4mem_calloc(sizeof(tp),ne,er)



/**	Free memory previously allocated.

	CRT on Windows: Optional.
	@param	ptr	Start address of memory range to free.
*/
#define	dk4mem_release(ptr) \
do { if (NULL != ptr) { dk4mem_free(ptr); }  ptr = NULL; } while (0)


/**	Find number of elements in array.

	CRT on Windows: Not used.
	@param	v	Variable.
	@param	t	Type.
	@return	The size of the variable divided by the size of the type.
*/
#define	DK4_SIZEOF(v,t)	(sizeof(v)/sizeof(t))



/**	Increase byte number to alignment size.

	CRT on Windows: Not used.
	@param	sz	Original byte number.
	@param	al	Alignment size, typically 16.
	@return	Size corrected for alignment.
*/
#define	DK4_MEM_ALIGN(sz,al) ((0 == (sz % al)) ? (sz) : (al * (1 + (sz/al))))






#if DK4_HAVE_INLINE && DK4_USE_INLINE
/* +++ DK4_HAVE_INLINE */
#if	DK4_ON_WINDOWS
/* +++ DK4_HAVE_INLINE, Windows */
#if		DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT
/* +++ DK4_HAVE_INLINE, Windows, ! crt */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
static
inline
void
DK4_MEMCPY(void *dst, const void *src, size_t sz)
{
  CopyMemory(dst, src, sz);
}

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
static
inline
void
DK4_MEMRES(void *dst, size_t sz)
{
  ZeroMemory(dst, sz);
}

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT probably degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
static
inline
int
DK4_MEMCMP(const void *s1, const void *s2, size_t sz)
{
  return ( dk4mem_fallback_cmp(s1, s2, sz) );
}

/* --- DK4_HAVE_INLINE, Windows, ! crt */
#else
/* +++ DK4_HAVE_INLINE, Windows, crt */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
static
inline
void
DK4_MEMCPY(void *dst, const void *src, size_t sz)
{
  memcpy(dst, src, sz);
}

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
static
inline
void
DK4_MEMRES(void *dst, size_t sz)
{
  memset(dst, 0, sz);
}

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
static
inline
int
DK4_MEMCMP(const void *s1, const void *s2, size_t sz)
{
  return (memcmp(s1, s2, sz));
}

/* --- DK4_HAVE_INLINE, Windows, crt */
#endif
/* --- DK4_HAVE_INLINE, Windows */
#else
/* +++ DK4_HAVE_INLINE, ! Windows */
#if		DK4_HAVE_MEMSET
/* +++ DK4_HAVE_INLINE, ! Windows, memset */

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
static
inline
void
DK4_MEMRES(void *dst, size_t sz)
{
  memset(dst, 0, sz);
}

/* --- DK4_HAVE_INLINE, ! Windows, memset */
#else
/* +++ DK4_HAVE_INLINE, ! Windows, ! memset */
#if			DK4_HAVE_BZERO
/* +++ DK4_HAVE_INLINE, ! Windows, ! memset, bzero */

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
static
inline
void
DK4_MEMRES(void *dst, size_t sz)
{
  bzero(dst, sz);
}

/* --- DK4_HAVE_INLINE, ! Windows, ! memset, bzero */
#else
/* +++ DK4_HAVE_INLINE, ! Windows, ! memset, ! bzero */

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
static
inline
void
DK4_MEMRES(void *dst, size_t sz)
{
  dk4mem_fallback_reset(dst, sz);
}

/* --- DK4_HAVE_INLINE, ! Windows, ! memset, ! bzero */
#endif
/* --- DK4_HAVE_INLINE, ! Windows, ! memset */
#endif
#if		DK4_HAVE_MEMCPY
/* +++ DK4_HAVE_INLINE, ! Windows, memcpy */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
static
inline
void
DK4_MEMCPY(void *dst, const void *src, size_t sz)
{
  memcpy(dst, src, sz);
}

/* --- DK4_HAVE_INLINE, ! Windows, memcpy */
#else
/* +++ DK4_HAVE_INLINE, ! Windows, ! memcpy */
#if			DK4_HAVE_BCOPY
/* +++ DK4_HAVE_INLINE, ! Windows, ! memcpy, bcopy */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
static
inline
void
DK4_MEMCPY(void *dst, const void *src, size_t sz)
{
  bcopy(src, dst, sz);
}

/* --- DK4_HAVE_INLINE, ! Windows, ! memcpy, bcopy */
#else
/* +++ DK4_HAVE_INLINE, ! Windows, ! memcpy, ! bcopy */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
static
inline
void
DK4_MEMCPY(void *dst, const void *src, size_t sz)
{
  dk4mem_fallback_cpy(dst, src, sz);
}

/* --- DK4_HAVE_INLINE, ! Windows, ! memcpy, ! bcopy */
#endif
/* --- DK4_HAVE_INLINE, ! Windows, ! memcpy */
#endif
#if		DK4_HAVE_MEMCMP
/* +++ DK4_HAVE_INLINE, ! Windows, memcmp */

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
static
inline
int
DK4_MEMCMP(const void *s1, const void *s2, size_t sz)
{
  return (memcmp(s1, s2, sz));
}

/* --- DK4_HAVE_INLINE, ! Windows, memcmp */
#else
/* +++ DK4_HAVE_INLINE, ! Windows, ! memcmp */
#if			DK4_HAVE_BCMP
/* +++ DK4_HAVE_INLINE, ! Windows, ! memcmp, bcmp */

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
static
inline
int
DK4_MEMCMP(const void *s1, const void *s2, size_t sz)
{
  return (bcmp(s1, s2, sz));
}

/* --- DK4_HAVE_INLINE, ! Windows, ! memcmp, bcmp */
#else
/* +++ DK4_HAVE_INLINE, ! Windows, ! memcmp, ! bcmp */

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
static
inline
int
DK4_MEMCMP(const void *s1, const void *s2, size_t sz)
{
  return ( dk4mem_fallback_cmp(s1, s2, sz) );
}

/* --- DK4_HAVE_INLINE, ! Windows, ! memcmp, ! bcmp */
#endif
/* --- DK4_HAVE_INLINE, ! Windows, ! memcmp */
#endif
/* --- DK4_HAVE_INLINE, ! Windows */
#endif
/* --- DK4_HAVE_INLINE */
#else
/* +++ ! DK4_HAVE_INLINE */
#if	DK4_ON_WINDOWS
/* +++ ! DK4_HAVE_INLINE, Windows */
#if		DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT
/* +++ ! DK4_HAVE_INLINE, Windows, ! crt */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
#define	DK4_MEMCPY(dst,src,sz)	CopyMemory(dst, src, sz)

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
#define	DK4_MEMRES(dst,sz)	ZeroMemory(dst, sz)

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
#define	DK4_MEMCMP(s1,s2,sz) dk4mem_fallback_cmp(s1, s2, sz)

/* --- ! DK4_HAVE_INLINE, Windows, ! crt */
#else
/* +++ ! DK4_HAVE_INLINE, Windows, crt */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
#define	DK4_MEMCPY(dst,src,sz)	memcpy(dst, src, sz)

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
#define	DK4_MEMRES(dst,sz)	memset(dst, 0, sz)

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
#define	DK4_MEMCMP(s1,s2,sz)	memcmp(s1, s2, sz)

/* --- ! DK4_HAVE_INLINE, Windows, crt */
#endif
/* --- ! DK4_HAVE_INLINE, Windows */
#else
/* +++ ! DK4_HAVE_INLINE, ! Windows */
#if		DK4_HAVE_MEMSET
/* +++ ! DK4_HAVE_INLINE, ! Windows, memset */

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
#define	DK4_MEMRES(dst,sz)	memset(dst, 0, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, memset */
#else
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memset */
#if			DK4_HAVE_BZERO
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memset, bzero */

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
#define	DK4_MEMRES(dst,sz)	bzero(dst, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, ! memset, bzero */
#else
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memset, ! bzero */

/**	Pure memory reset. All arguments must be checked by the caller
	before calling this function.
	Do not use DK4_MEMRES() to sanitize memory (overwrite sensitive
	data before memory is freed or the program exits),
	use dk4mem_reset_secure() from dk4memrs.h instead.

	CRT on Windows: Optional.
	@param	dst	Start address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
#define	DK4_MEMRES(dst,sz) dk4mem_fallback_reset(dst, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, ! memset, ! bzero */
#endif
/* --- ! DK4_HAVE_INLINE, ! Windows, ! memset */
#endif
#if		DK4_HAVE_MEMCPY
/* +++ ! DK4_HAVE_INLINE, ! Windows, memcpy */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
#define	DK4_MEMCPY(dst,src,sz)	memcpy(dst, src, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, memcpy */
#else
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memcpy */
#if			DK4_HAVE_BCOPY
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memcpy, bcopy */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
#define	DK4_MEMCPY(dst,src,sz)	bcopy(src, dst, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, ! memcpy, bcopy */
#else
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memcpy, ! bcopy */

/**	Pure memory copy operation. All arguments must be checked
	by the caller before calling this function.

	CRT on Windows: Optional.
	@param	dst	Destination buffer address.
	@param	src	Source buffer address.
	@param	sz	Number of bytes to copy.
*/
#define	DK4_MEMCPY(dst,src,sz) dk4mem_fallback_cpy(dst, src, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, ! memcpy, ! bcopy */
#endif
/* --- ! DK4_HAVE_INLINE, ! Windows, ! memcpy */
#endif
#if		DK4_HAVE_MEMCMP
/* +++ ! DK4_HAVE_INLINE, ! Windows, memcmp */

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
#define	DK4_MEMCMP(s1,s2,sz)	memcmp(s1, s2, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, memcmp */
#else
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memcmp */
#if			DK4_HAVE_BCMP
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memcmp, bcmp */

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
#define	DK4_MEMCMP(s1,s2,sz)	bcmp(s1, s2, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, ! memcmp, bcmp */
#else
/* +++ ! DK4_HAVE_INLINE, ! Windows, ! memcmp, ! bcmp */

/**	Pure memory comparison.
	All arguments must be checked by the caller before calling this
	function.

	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	s1	Address of left buffer in comparison.
	@param	s2	Address of right buffer in comparison.
	@param	sz	Number of bytes to compare.
	@return	1 if s1>s2, 0 for equal buffers, -1 if s1<s2.
*/
#define	DK4_MEMCMP(s1,s2,sz) dk4mem_fallback_cmp(s1, s2, sz)

/* --- ! DK4_HAVE_INLINE, ! Windows, ! memcmp, ! bcmp */
#endif
/* --- ! DK4_HAVE_INLINE, ! Windows, ! memcmp */
#endif
/* --- ! DK4_HAVE_INLINE, ! Windows */
#endif
/* --- ! DK4_HAVE_INLINE */
#endif



#endif