summaryrefslogtreecommitdiff
path: root/support/dktools/dk4mem.ctr
blob: 97d26f5b7b763682f55f28e4830472b7dc50313e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd


%%	header

/**	@file
	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
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#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

/**	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.
	@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);

/**	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.
	@param	bptr	Address of buffer to reset.
	@param	sz	Number of bytes to reset.
*/
void
dk4mem_fallback_reset(void *bptr, size_t sz);

/**	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.
	@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);

/**	Reset memory range.
	
	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.

	CRT on Windows:	Optional.
	@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.
	
	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
/* if defined(_WIN32) ... */

#ifdef __cplusplus
}
#endif


/**	Allocate and initialize memory.
	@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.
	@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.
	@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.
	@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_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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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.
	@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


%%	module

#include "dk4conf.h"

#if DK4_ON_WINDOWS && (DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT)
#ifndef WINDOWS_H_INCLUDED
#include <windows.h>
#define	WINDOWS_H_INCLUDED 1
#endif
#endif

#include "dk4types.h"

#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

#include "dk4mem.h"
#include "dk4numco.h"



$!trace-include



static
void
dk4mem_fallback_i_reset(unsigned char *bptr, size_t sz)
{
  while (0 < sz--) { *(bptr++) = '\0'; }
}



void
dk4mem_fallback_reset(void *bptr, size_t sz)
{
  dk4mem_fallback_i_reset((unsigned char *)bptr, sz);
}



void
dk4mem_reset(void *bptr, size_t sz, dk4_er_t *erp)
{
  $? "+ dk4mem_reset"
  if ((NULL != bptr) && (0 < sz)) {
    DK4_MEMRES(bptr, sz);
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  $? "- dk4mem_reset"
}



void
dk4mem_set(void *bptr, size_t sz, unsigned char uc, dk4_er_t *erp)
{
#if !DK4_HAVE_MEMSET
  unsigned char *ucptr;
#endif
  if ((NULL != bptr) && (0 < sz)) {
#if DK4_HAVE_MEMSET
    memset(bptr, (int)uc, sz);
#else
    ucptr = (unsigned char *)bptr;
    while (0 < sz--) { *(ucptr++) = uc; }
#endif
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
}



static
void
dk4mem_fallback_i_cpy(unsigned char *dst, const unsigned char *src, size_t sz)
{
  while(0 < sz--) { *(dst++) = *(src++); }
}



void
dk4mem_fallback_cpy(void *dst, const void *src, size_t sz)
{
  dk4mem_fallback_i_cpy(
    (unsigned char *)dst,
    (const unsigned char *)src,
    sz
  );
}



void
dk4mem_cpy(void *dst, void const *src, size_t sz, dk4_er_t *erp)
{
  if ((NULL != dst) && (NULL != src) && (0 < sz)) {
    DK4_MEMCPY(dst, src, sz);
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
}


static
int
dk4mem_fallback_i_cmp(
  const unsigned char	*s1,
  const unsigned char	*s2,
  size_t		 sz
)
{
  int		 back	= 0;
  while ((0 < sz--) && (0 == back)) {
    if (*s1 > *s2) {
      back = 1;
    } else {
      if (*s1 < *s2) {
        back = -1;
      }
    }
    s1++; s2++;
  }
  return back;
}



int
dk4mem_fallback_cmp(const void *s1, const void *s2, size_t sz)
{
  return(
    dk4mem_fallback_i_cmp(
      (const unsigned char *)s1,
      (const unsigned char *)s2,
      sz
    )
  );
}



int
dk4mem_cmp(const void *s1, const void *s2, size_t sz, dk4_er_t *erp)
{
  int back = 0;
  if ((NULL != s1) && (NULL != s2) && (0 < sz)) {
    back = DK4_MEMCMP(s1, s2, sz);
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
}




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

void *
dk4mem_malloc_bytes(size_t bytes, dk4_er_t *erp)
{
  void		*back	=	NULL;	/* Function result. */
  if (0 < bytes) {
#if DK4_ON_WINDOWS
    /* +++ Windows */
#if DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT
    if ((dk4_um_t)bytes <= (dk4_um_t)0xFFFFFFFFUL) {
#if DK4_USE_WINDOWS_LOCAL_ALLOC
      back = (void*)LocalAlloc(LMEM_FIXED, (DWORD)bytes);
#else
      back = (void*)GlobalAlloc(GMEM_FIXED, (DWORD)bytes);
#endif
      if (NULL == back) {
        dk4error_set_elsize_nelem(erp,DK4_E_MEMORY_ALLOCATION_FAILED,1,bytes);
      }
    } else {
      dk4error_set_simple_error_code(erp, DK4_E_MATH_OVERFLOW);
    }
#else
    back = malloc(bytes);
    if (NULL == back) {
      dk4error_set_elsize_nelem(erp, DK4_E_MEMORY_ALLOCATION_FAILED, 1, bytes);
    }
#endif
    /* --- Windows */
#else
    /* +++ non-Windows */
    back = malloc(bytes);
    if (NULL == back) {
      dk4error_set_elsize_nelem(erp, DK4_E_MEMORY_ALLOCATION_FAILED, 1, bytes);
    }
    /* --- non-Windows */
#endif
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
}



void *
dk4mem_malloc(size_t elsize, size_t nelem, dk4_er_t *erp)
{
  void		*back	=	NULL;
  size_t	 bytes;
  if ((0 < elsize) && (0 < nelem)) {
    if ((SIZE_MAX / elsize) >= nelem) {
      bytes = elsize * nelem;
      back = dk4mem_malloc_bytes(bytes, erp);
    } else {
      dk4error_set_simple_error_code(erp, DK4_E_MATH_OVERFLOW);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
}



void *
dk4mem_calloc(size_t elsize, size_t nelem, dk4_er_t *erp)
{
  void		*back	=	NULL;

  if ((0 < elsize) && (0 < nelem)) {
    if ((SIZE_MAX / elsize) >= nelem) {
#if DK4_ON_WINDOWS
      /* +++ Windows */
#if DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT
      size_t bytes;
      bytes = elsize * nelem;
      if ((dk4_um_t)bytes <= (dk4_um_t)0xFFFFFFFFUL) {
#if DK4_USE_WINDOWS_LOCAL_ALLOC
	back = (void *)LocalAlloc((LMEM_FIXED | LMEM_ZEROINIT), (DWORD)bytes);
#else
	back = (void *)GlobalAlloc((GMEM_FIXED | GMEM_ZEROINIT), (DWORD)bytes);
#endif
	if (NULL == back) {
	  dk4error_set_elsize_nelem(
	    erp, DK4_E_MEMORY_ALLOCATION_FAILED, elsize, nelem
	  );
	}

      } else {
        dk4error_set_simple_error_code(erp, DK4_E_MATH_OVERFLOW);
      }
#else
      back = calloc(nelem, elsize);
      if (NULL == back) {
        dk4error_set_elsize_nelem(
	  erp, DK4_E_MEMORY_ALLOCATION_FAILED, elsize, nelem
	);
      }
#endif
      /* --- Windows */
#else
      /* +++ non-Windows */
#if DK4_HAVE_CALLOC
      back = calloc(nelem, elsize);
      if (NULL == back) {
        dk4error_set_elsize_nelem(
	  erp, DK4_E_MEMORY_ALLOCATION_FAILED, elsize, nelem
	);
      }
#else
      size_t bytes;
      bytes = elsize * nelem;
      back = malloc(bytes);
      if (NULL != back) {
        dk4mem_reset(back, bytes);
      } else {
        dk4error_set_elsize_nelem(
	  erp, DK4_E_MEMORY_ALLOCATION_FAILED, elsize, nelem
	);
      }
#endif
      /* --- non-Windows */
#endif
    } else {
      dk4error_set_simple_error_code(erp, DK4_E_MATH_OVERFLOW);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
}



void
dk4mem_free(void *ptr)
{
  if (NULL != ptr) {
#if DK4_ON_WINDOWS
    /* +++ Windows */
#if DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT
#if DK4_USE_WINDOWS_LOCAL_ALLOC
    LocalFree((HLOCAL)ptr);
#else
    GlobalFree((HLOCAL)ptr);
#endif
#else
    free(ptr);
#endif
    /* --- Windows */
#else
    /* +++ non-Windows */
    free(ptr);
    /* --- non-Windows */
#endif
  }
}

#endif
/* if defined(_WIN32) ... */