2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % M M EEEEE M M OOO RRRR Y Y %
7 % MM MM E MM MM O O R R Y Y %
8 % M M M EEE M M M O O RRRR Y %
9 % M M E M M O O R R Y %
10 % M M EEEEE M M OOO R R Y %
13 % MagickCore Memory Allocation Methods %
20 % Copyright 1999-2013 ImageMagick Studio LLC, a non-profit organization %
21 % dedicated to making software imaging solutions freely available. %
23 % You may not use this file except in compliance with the License. You may %
24 % obtain a copy of the License at %
26 % http://www.imagemagick.org/script/license.php %
28 % Unless required by applicable law or agreed to in writing, software %
29 % distributed under the License is distributed on an "AS IS" BASIS, %
30 % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31 % See the License for the specific language governing permissions and %
32 % limitations under the License. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
36 % Segregate our memory requirements from any program that calls our API. This
37 % should help reduce the risk of others changing our program state or causing
40 % Our custom memory allocation manager implements a best-fit allocation policy
41 % using segregated free lists. It uses a linear distribution of size classes
42 % for lower sizes and a power of two distribution of size classes at higher
43 % sizes. It is based on the paper, "Fast Memory Allocation using Lazy Fits."
44 % written by Yoo C. Chung.
46 % By default, ANSI memory methods are called (e.g. malloc). Use the
47 % custom memory allocator by defining MAGICKCORE_ZERO_CONFIGURATION_SUPPORT
48 % to allocate memory with private anonymous mapping rather than from the
56 #include "MagickCore/studio.h"
57 #include "MagickCore/blob.h"
58 #include "MagickCore/blob-private.h"
59 #include "MagickCore/exception.h"
60 #include "MagickCore/exception-private.h"
61 #include "MagickCore/memory_.h"
62 #include "MagickCore/memory-private.h"
63 #include "MagickCore/resource_.h"
64 #include "MagickCore/semaphore.h"
65 #include "MagickCore/string_.h"
66 #include "MagickCore/utility-private.h"
71 #define BlockFooter(block,size) \
72 ((size_t *) ((char *) (block)+(size)-2*sizeof(size_t)))
73 #define BlockHeader(block) ((size_t *) (block)-1)
74 #define BlockSize 4096
75 #define BlockThreshold 1024
76 #define MaxBlockExponent 16
77 #define MaxBlocks ((BlockThreshold/(4*sizeof(size_t)))+MaxBlockExponent+1)
78 #define MaxSegments 1024
79 #define MemoryGuard ((0xdeadbeef << 31)+0xdeafdeed)
80 #define NextBlock(block) ((char *) (block)+SizeOfBlock(block))
81 #define NextBlockInList(block) (*(void **) (block))
82 #define PreviousBlock(block) ((char *) (block)-(*((size_t *) (block)-2)))
83 #define PreviousBlockBit 0x01
84 #define PreviousBlockInList(block) (*((void **) (block)+1))
85 #define SegmentSize (2*1024*1024)
86 #define SizeMask (~0x01)
87 #define SizeOfBlock(block) (*BlockHeader(block) & SizeMask)
92 typedef struct _DataSegmentInfo
104 struct _DataSegmentInfo
109 typedef struct _MagickMemoryMethods
112 acquire_memory_handler;
115 resize_memory_handler;
118 destroy_memory_handler;
119 } MagickMemoryMethods;
124 filename[MaxTextExtent];
139 typedef struct _MemoryPool
145 *blocks[MaxBlocks+1];
151 *segments[MaxSegments],
152 segment_pool[MaxSegments];
158 static MagickMemoryMethods
161 (AcquireMemoryHandler) malloc,
162 (ResizeMemoryHandler) realloc,
163 (DestroyMemoryHandler) free
166 #if defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
171 *memory_semaphore = (SemaphoreInfo *) NULL;
173 static volatile DataSegmentInfo
174 *free_segments = (DataSegmentInfo *) NULL;
177 Forward declarations.
179 static MagickBooleanType
184 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
188 % A c q u i r e A l i g n e d M e m o r y %
192 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
194 % AcquireAlignedMemory() returns a pointer to a block of memory at least size
195 % bytes whose address is a multiple of 16*sizeof(void *).
197 % The format of the AcquireAlignedMemory method is:
199 % void *AcquireAlignedMemory(const size_t count,const size_t quantum)
201 % A description of each parameter follows:
203 % o count: the number of quantum elements to allocate.
205 % o quantum: the number of bytes in each quantum.
208 MagickExport void *AcquireAlignedMemory(const size_t count,const size_t quantum)
210 #define AlignedExtent(size,alignment) \
211 (((size)+((alignment)-1)) & ~((alignment)-1))
222 if ((count == 0) || (quantum != (size/count)))
225 return((void *) NULL);
228 alignment=CACHE_LINE_SIZE;
229 extent=AlignedExtent(size,alignment);
230 if ((size == 0) || (alignment < sizeof(void *)) || (extent < size))
231 return((void *) NULL);
232 #if defined(MAGICKCORE_HAVE_POSIX_MEMALIGN)
233 if (posix_memalign(&memory,alignment,extent) != 0)
235 #elif defined(MAGICKCORE_HAVE__ALIGNED_MALLOC)
236 memory=_aligned_malloc(extent,alignment);
242 extent=(size+alignment-1)+sizeof(void *);
248 memory=(void *) AlignedExtent((size_t) p+sizeof(void *),alignment);
249 *((void **) memory-1)=p;
257 #if defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
259 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
263 + A c q u i r e B l o c k %
267 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
269 % AcquireBlock() returns a pointer to a block of memory at least size bytes
270 % suitably aligned for any use.
272 % The format of the AcquireBlock method is:
274 % void *AcquireBlock(const size_t size)
276 % A description of each parameter follows:
278 % o size: the size of the memory in bytes to allocate.
282 static inline size_t AllocationPolicy(size_t size)
288 The linear distribution.
291 assert(size % (4*sizeof(size_t)) == 0);
292 if (size <= BlockThreshold)
293 return(size/(4*sizeof(size_t)));
295 Check for the largest block size.
297 if (size > (size_t) (BlockThreshold*(1L << (MaxBlockExponent-1L))))
298 return(MaxBlocks-1L);
300 Otherwise use a power of two distribution.
302 blocksize=BlockThreshold/(4*sizeof(size_t));
303 for ( ; size > BlockThreshold; size/=2)
305 assert(blocksize > (BlockThreshold/(4*sizeof(size_t))));
306 assert(blocksize < (MaxBlocks-1L));
310 static inline void InsertFreeBlock(void *block,const size_t i)
319 size=SizeOfBlock(block);
320 previous=(void *) NULL;
321 next=memory_pool.blocks[i];
322 while ((next != (void *) NULL) && (SizeOfBlock(next) < size))
325 next=NextBlockInList(next);
327 PreviousBlockInList(block)=previous;
328 NextBlockInList(block)=next;
329 if (previous != (void *) NULL)
330 NextBlockInList(previous)=block;
332 memory_pool.blocks[i]=block;
333 if (next != (void *) NULL)
334 PreviousBlockInList(next)=block;
337 static inline void RemoveFreeBlock(void *block,const size_t i)
343 next=NextBlockInList(block);
344 previous=PreviousBlockInList(block);
345 if (previous == (void *) NULL)
346 memory_pool.blocks[i]=next;
348 NextBlockInList(previous)=next;
349 if (next != (void *) NULL)
350 PreviousBlockInList(next)=previous;
353 static void *AcquireBlock(size_t size)
364 size=(size_t) (size+sizeof(size_t)+6*sizeof(size_t)-1) & -(4U*sizeof(size_t));
365 i=AllocationPolicy(size);
366 block=memory_pool.blocks[i];
367 while ((block != (void *) NULL) && (SizeOfBlock(block) < size))
368 block=NextBlockInList(block);
369 if (block == (void *) NULL)
372 while (memory_pool.blocks[i] == (void *) NULL)
374 block=memory_pool.blocks[i];
376 return((void *) NULL);
378 assert((*BlockHeader(NextBlock(block)) & PreviousBlockBit) == 0);
379 assert(SizeOfBlock(block) >= size);
380 RemoveFreeBlock(block,AllocationPolicy(SizeOfBlock(block)));
381 if (SizeOfBlock(block) > size)
392 next=(char *) block+size;
393 blocksize=SizeOfBlock(block)-size;
394 *BlockHeader(next)=blocksize;
395 *BlockFooter(next,blocksize)=blocksize;
396 InsertFreeBlock(next,AllocationPolicy(blocksize));
397 *BlockHeader(block)=size | (*BlockHeader(block) & ~SizeMask);
399 assert(size == SizeOfBlock(block));
400 *BlockHeader(NextBlock(block))|=PreviousBlockBit;
401 memory_pool.allocation+=size;
407 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
411 % A c q u i r e M a g i c k M e m o r y %
415 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
417 % AcquireMagickMemory() returns a pointer to a block of memory at least size
418 % bytes suitably aligned for any use.
420 % The format of the AcquireMagickMemory method is:
422 % void *AcquireMagickMemory(const size_t size)
424 % A description of each parameter follows:
426 % o size: the size of the memory in bytes to allocate.
429 MagickExport void *AcquireMagickMemory(const size_t size)
434 #if !defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
435 memory=memory_methods.acquire_memory_handler(size == 0 ? 1UL : size);
437 if (memory_semaphore == (SemaphoreInfo *) NULL)
438 AcquireSemaphoreInfo(&memory_semaphore);
439 if (free_segments == (DataSegmentInfo *) NULL)
441 LockSemaphoreInfo(memory_semaphore);
442 if (free_segments == (DataSegmentInfo *) NULL)
447 assert(2*sizeof(size_t) > (size_t) (~SizeMask));
448 (void) ResetMagickMemory(&memory_pool,0,sizeof(memory_pool));
449 memory_pool.allocation=SegmentSize;
450 memory_pool.blocks[MaxBlocks]=(void *) (-1);
451 for (i=0; i < MaxSegments; i++)
454 memory_pool.segment_pool[i].previous=
455 (&memory_pool.segment_pool[i-1]);
456 if (i != (MaxSegments-1))
457 memory_pool.segment_pool[i].next=(&memory_pool.segment_pool[i+1]);
459 free_segments=(&memory_pool.segment_pool[0]);
461 UnlockSemaphoreInfo(memory_semaphore);
463 LockSemaphoreInfo(memory_semaphore);
464 memory=AcquireBlock(size == 0 ? 1UL : size);
465 if (memory == (void *) NULL)
467 if (ExpandHeap(size == 0 ? 1UL : size) != MagickFalse)
468 memory=AcquireBlock(size == 0 ? 1UL : size);
470 UnlockSemaphoreInfo(memory_semaphore);
476 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
480 % A c q u i r e Q u a n t u m M e m o r y %
484 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
486 % AcquireQuantumMemory() returns a pointer to a block of memory at least
487 % count * quantum bytes suitably aligned for any use.
489 % The format of the AcquireQuantumMemory method is:
491 % void *AcquireQuantumMemory(const size_t count,const size_t quantum)
493 % A description of each parameter follows:
495 % o count: the number of quantum elements to allocate.
497 % o quantum: the number of bytes in each quantum.
500 MagickExport void *AcquireQuantumMemory(const size_t count,const size_t quantum)
506 if ((count == 0) || (quantum != (size/count)))
509 return((void *) NULL);
511 return(AcquireMagickMemory(size));
515 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
519 % A c q u i r e V i r t u a l M e m o r y %
523 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
525 % AcquireVirtualMemory() allocates a pointer to a block of memory at least size
526 % bytes suitably aligned for any use.
528 % The format of the AcquireVirtualMemory method is:
530 % MemoryInfo *AcquireVirtualMemory(const size_t count,const size_t quantum)
532 % A description of each parameter follows:
534 % o count: the number of quantum elements to allocate.
536 % o quantum: the number of bytes in each quantum.
539 MagickExport MemoryInfo *AcquireVirtualMemory(const size_t count,
540 const size_t quantum)
548 length=count*quantum;
549 if ((count == 0) || (quantum != (length/count)))
552 return((MemoryInfo *) NULL);
554 memory_info=(MemoryInfo *) MagickAssumeAligned(AcquireAlignedMemory(1,
555 sizeof(*memory_info)));
556 if (memory_info == (MemoryInfo *) NULL)
557 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
558 (void) ResetMagickMemory(memory_info,0,sizeof(*memory_info));
559 memory_info->length=length;
560 memory_info->signature=MagickSignature;
561 if (AcquireMagickResource(MemoryResource,length) != MagickFalse)
563 memory_info->blob=AcquireAlignedMemory(1,length);
564 if (memory_info->blob == NULL)
565 RelinquishMagickResource(MemoryResource,length);
567 if ((memory_info->blob == NULL) &&
568 (AcquireMagickResource(MapResource,length) != MagickFalse))
571 Heap memory failed, try anonymous memory mapping.
573 memory_info->mapped=MagickTrue;
574 memory_info->blob=MapBlob(-1,IOMode,0,length);
575 if (memory_info->blob != NULL)
576 memory_info->mapped=MagickTrue;
578 RelinquishMagickResource(MapResource,length);
580 if (memory_info->blob == NULL)
586 Anonymous memory mapping failed, try file-backed memory mapping.
588 file=AcquireUniqueFileResource(memory_info->filename);
591 if ((lseek(file,length-1,SEEK_SET) >= 0) && (write(file,"",1) == 1))
593 memory_info->blob=MapBlob(file,IOMode,0,length);
594 if (memory_info->blob != NULL)
596 memory_info->mapped=MagickTrue;
597 (void) AcquireMagickResource(MapResource,length);
603 if (memory_info->blob == NULL)
604 memory_info->blob=AcquireAlignedMemory(length);
609 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
613 % C o p y M a g i c k M e m o r y %
617 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
619 % CopyMagickMemory() copies size bytes from memory area source to the
620 % destination. Copying between objects that overlap will take place
621 % correctly. It returns destination.
623 % The format of the CopyMagickMemory method is:
625 % void *CopyMagickMemory(void *destination,const void *source,
628 % A description of each parameter follows:
630 % o destination: the destination.
632 % o source: the source.
634 % o size: the size of the memory in bytes to allocate.
637 MagickExport void *CopyMagickMemory(void *destination,const void *source,
640 register const unsigned char
643 register unsigned char
646 assert(destination != (void *) NULL);
647 assert(source != (const void *) NULL);
648 p=(const unsigned char *) source;
649 q=(unsigned char *) destination;
650 if (((q+size) < p) || (q > (p+size)))
653 default: return(memcpy(destination,source,size));
662 case 0: return(destination);
664 return(memmove(destination,source,size));
668 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
672 + D e s t r o y M a g i c k M e m o r y %
676 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
678 % DestroyMagickMemory() deallocates memory associated with the memory manager.
680 % The format of the DestroyMagickMemory method is:
682 % DestroyMagickMemory(void)
685 MagickExport void DestroyMagickMemory(void)
687 #if defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
691 if (memory_semaphore == (SemaphoreInfo *) NULL)
692 AcquireSemaphoreInfo(&memory_semaphore);
693 LockSemaphoreInfo(memory_semaphore);
694 UnlockSemaphoreInfo(memory_semaphore);
695 for (i=0; i < (ssize_t) memory_pool.number_segments; i++)
696 if (memory_pool.segments[i]->mapped == MagickFalse)
697 memory_methods.destroy_memory_handler(
698 memory_pool.segments[i]->allocation);
700 (void) UnmapBlob(memory_pool.segments[i]->allocation,
701 memory_pool.segments[i]->length);
702 free_segments=(DataSegmentInfo *) NULL;
703 (void) ResetMagickMemory(&memory_pool,0,sizeof(memory_pool));
704 DestroySemaphoreInfo(&memory_semaphore);
708 #if defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
710 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
714 + E x p a n d H e a p %
718 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
720 % ExpandHeap() get more memory from the system. It returns MagickTrue on
721 % success otherwise MagickFalse.
723 % The format of the ExpandHeap method is:
725 % MagickBooleanType ExpandHeap(size_t size)
727 % A description of each parameter follows:
729 % o size: the size of the memory in bytes we require.
732 static MagickBooleanType ExpandHeap(size_t size)
752 blocksize=((size+12*sizeof(size_t))+SegmentSize-1) & -SegmentSize;
753 assert(memory_pool.number_segments < MaxSegments);
754 segment=MapBlob(-1,IOMode,0,blocksize);
755 mapped=segment != (void *) NULL ? MagickTrue : MagickFalse;
756 if (segment == (void *) NULL)
757 segment=(void *) memory_methods.acquire_memory_handler(blocksize);
758 if (segment == (void *) NULL)
760 segment_info=(DataSegmentInfo *) free_segments;
761 free_segments=segment_info->next;
762 segment_info->mapped=mapped;
763 segment_info->length=blocksize;
764 segment_info->allocation=segment;
765 segment_info->bound=(char *) segment+blocksize;
766 i=(ssize_t) memory_pool.number_segments-1;
767 for ( ; (i >= 0) && (memory_pool.segments[i]->allocation > segment); i--)
768 memory_pool.segments[i+1]=memory_pool.segments[i];
769 memory_pool.segments[i+1]=segment_info;
770 memory_pool.number_segments++;
771 size=blocksize-12*sizeof(size_t);
772 block=(char *) segment_info->allocation+4*sizeof(size_t);
773 *BlockHeader(block)=size | PreviousBlockBit;
774 *BlockFooter(block,size)=size;
775 InsertFreeBlock(block,AllocationPolicy(size));
776 block=NextBlock(block);
777 assert(block < segment_info->bound);
778 *BlockHeader(block)=2*sizeof(size_t);
779 *BlockHeader(NextBlock(block))=PreviousBlockBit;
785 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
789 % G e t M a g i c k M e m o r y M e t h o d s %
793 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
795 % GetMagickMemoryMethods() gets the methods to acquire, resize, and destroy
798 % The format of the GetMagickMemoryMethods() method is:
800 % void GetMagickMemoryMethods(AcquireMemoryHandler *acquire_memory_handler,
801 % ResizeMemoryHandler *resize_memory_handler,
802 % DestroyMemoryHandler *destroy_memory_handler)
804 % A description of each parameter follows:
806 % o acquire_memory_handler: method to acquire memory (e.g. malloc).
808 % o resize_memory_handler: method to resize memory (e.g. realloc).
810 % o destroy_memory_handler: method to destroy memory (e.g. free).
813 MagickExport void GetMagickMemoryMethods(
814 AcquireMemoryHandler *acquire_memory_handler,
815 ResizeMemoryHandler *resize_memory_handler,
816 DestroyMemoryHandler *destroy_memory_handler)
818 assert(acquire_memory_handler != (AcquireMemoryHandler *) NULL);
819 assert(resize_memory_handler != (ResizeMemoryHandler *) NULL);
820 assert(destroy_memory_handler != (DestroyMemoryHandler *) NULL);
821 *acquire_memory_handler=memory_methods.acquire_memory_handler;
822 *resize_memory_handler=memory_methods.resize_memory_handler;
823 *destroy_memory_handler=memory_methods.destroy_memory_handler;
827 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
831 % G e t V i r t u a l M e m o r y B l o b %
835 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
837 % GetVirtualMemoryBlob() returns the virtual memory blob associated with the
838 % specified MemoryInfo structure.
840 % The format of the GetVirtualMemoryBlob method is:
842 % void *GetVirtualMemoryBlob(const MemoryInfo *memory_info)
844 % A description of each parameter follows:
846 % o memory_info: The MemoryInfo structure.
848 MagickExport void *GetVirtualMemoryBlob(const MemoryInfo *memory_info)
850 assert(memory_info != (const MemoryInfo *) NULL);
851 assert(memory_info->signature == MagickSignature);
852 return(memory_info->blob);
856 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
860 % R e l i n q u i s h A l i g n e d M e m o r y %
864 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
866 % RelinquishAlignedMemory() frees memory acquired with AcquireAlignedMemory()
869 % The format of the RelinquishAlignedMemory method is:
871 % void *RelinquishAlignedMemory(void *memory)
873 % A description of each parameter follows:
875 % o memory: A pointer to a block of memory to free for reuse.
878 MagickExport void *RelinquishAlignedMemory(void *memory)
880 if (memory == (void *) NULL)
881 return((void *) NULL);
882 #if defined(MAGICKCORE_HAVE_POSIX_MEMALIGN)
884 #elif defined(MAGICKCORE_HAVE__ALIGNED_MALLOC)
885 _aligned_free(memory);
887 free(*((void **) memory-1));
893 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
897 % R e l i n q u i s h M a g i c k M e m o r y %
901 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
903 % RelinquishMagickMemory() frees memory acquired with AcquireMagickMemory()
904 % or AcquireQuantumMemory() for reuse.
906 % The format of the RelinquishMagickMemory method is:
908 % void *RelinquishMagickMemory(void *memory)
910 % A description of each parameter follows:
912 % o memory: A pointer to a block of memory to free for reuse.
915 MagickExport void *RelinquishMagickMemory(void *memory)
917 if (memory == (void *) NULL)
918 return((void *) NULL);
919 #if !defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
920 memory_methods.destroy_memory_handler(memory);
922 LockSemaphoreInfo(memory_semaphore);
923 assert((SizeOfBlock(memory) % (4*sizeof(size_t))) == 0);
924 assert((*BlockHeader(NextBlock(memory)) & PreviousBlockBit) != 0);
925 if ((*BlockHeader(memory) & PreviousBlockBit) == 0)
931 Coalesce with previous adjacent block.
933 previous=PreviousBlock(memory);
934 RemoveFreeBlock(previous,AllocationPolicy(SizeOfBlock(previous)));
935 *BlockHeader(previous)=(SizeOfBlock(previous)+SizeOfBlock(memory)) |
936 (*BlockHeader(previous) & ~SizeMask);
939 if ((*BlockHeader(NextBlock(NextBlock(memory))) & PreviousBlockBit) == 0)
945 Coalesce with next adjacent block.
947 next=NextBlock(memory);
948 RemoveFreeBlock(next,AllocationPolicy(SizeOfBlock(next)));
949 *BlockHeader(memory)=(SizeOfBlock(memory)+SizeOfBlock(next)) |
950 (*BlockHeader(memory) & ~SizeMask);
952 *BlockFooter(memory,SizeOfBlock(memory))=SizeOfBlock(memory);
953 *BlockHeader(NextBlock(memory))&=(~PreviousBlockBit);
954 InsertFreeBlock(memory,AllocationPolicy(SizeOfBlock(memory)));
955 UnlockSemaphoreInfo(memory_semaphore);
957 return((void *) NULL);
961 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
965 % R e l i n q u i s h V i r t u a l M e m o r y %
969 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
971 % RelinquishVirtualMemory() frees memory acquired with AcquireVirtualMemory().
973 % The format of the RelinquishVirtualMemory method is:
975 % MemoryInfo *RelinquishVirtualMemory(MemoryInfo *memory_info)
977 % A description of each parameter follows:
979 % o memory_info: A pointer to a block of memory to free for reuse.
982 MagickExport MemoryInfo *RelinquishVirtualMemory(MemoryInfo *memory_info)
984 assert(memory_info != (MemoryInfo *) NULL);
985 assert(memory_info->signature == MagickSignature);
986 if (memory_info->blob != (void *) NULL)
988 if (memory_info->mapped == MagickFalse)
990 memory_info->blob=RelinquishAlignedMemory(memory_info->blob);
991 RelinquishMagickResource(MemoryResource,memory_info->length);
995 (void) UnmapBlob(memory_info->blob,memory_info->length);
996 RelinquishMagickResource(MapResource,memory_info->length);
997 memory_info->blob=NULL;
998 if (*memory_info->filename != '\0')
999 (void) RelinquishUniqueFileResource(memory_info->filename);
1002 memory_info->signature=(~MagickSignature);
1003 memory_info=(MemoryInfo *) RelinquishAlignedMemory(memory_info);
1004 return(memory_info);
1008 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1012 % R e s e t M a g i c k M e m o r y %
1016 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1018 % ResetMagickMemory() fills the first size bytes of the memory area pointed to
1019 % by memory with the constant byte c.
1021 % The format of the ResetMagickMemory method is:
1023 % void *ResetMagickMemory(void *memory,int byte,const size_t size)
1025 % A description of each parameter follows:
1027 % o memory: a pointer to a memory allocation.
1029 % o byte: set the memory to this value.
1031 % o size: size of the memory to reset.
1034 MagickExport void *ResetMagickMemory(void *memory,int byte,const size_t size)
1036 assert(memory != (void *) NULL);
1037 return(memset(memory,byte,size));
1041 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1045 % R e s i z e M a g i c k M e m o r y %
1049 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1051 % ResizeMagickMemory() changes the size of the memory and returns a pointer to
1052 % the (possibly moved) block. The contents will be unchanged up to the
1053 % lesser of the new and old sizes.
1055 % The format of the ResizeMagickMemory method is:
1057 % void *ResizeMagickMemory(void *memory,const size_t size)
1059 % A description of each parameter follows:
1061 % o memory: A pointer to a memory allocation.
1063 % o size: the new size of the allocated memory.
1067 #if defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
1068 static inline void *ResizeBlock(void *block,size_t size)
1073 if (block == (void *) NULL)
1074 return(AcquireBlock(size));
1075 memory=AcquireBlock(size);
1076 if (memory == (void *) NULL)
1077 return((void *) NULL);
1078 if (size <= (SizeOfBlock(block)-sizeof(size_t)))
1079 (void) memcpy(memory,block,size);
1081 (void) memcpy(memory,block,SizeOfBlock(block)-sizeof(size_t));
1082 memory_pool.allocation+=size;
1087 MagickExport void *ResizeMagickMemory(void *memory,const size_t size)
1092 if (memory == (void *) NULL)
1093 return(AcquireMagickMemory(size));
1094 #if !defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
1095 block=memory_methods.resize_memory_handler(memory,size == 0 ? 1UL : size);
1096 if (block == (void *) NULL)
1097 memory=RelinquishMagickMemory(memory);
1099 LockSemaphoreInfo(memory_semaphore);
1100 block=ResizeBlock(memory,size == 0 ? 1UL : size);
1101 if (block == (void *) NULL)
1103 if (ExpandHeap(size == 0 ? 1UL : size) == MagickFalse)
1105 UnlockSemaphoreInfo(memory_semaphore);
1106 memory=RelinquishMagickMemory(memory);
1107 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1109 block=ResizeBlock(memory,size == 0 ? 1UL : size);
1110 assert(block != (void *) NULL);
1112 UnlockSemaphoreInfo(memory_semaphore);
1113 memory=RelinquishMagickMemory(memory);
1119 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1123 % R e s i z e Q u a n t u m M e m o r y %
1127 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1129 % ResizeQuantumMemory() changes the size of the memory and returns a pointer
1130 % to the (possibly moved) block. The contents will be unchanged up to the
1131 % lesser of the new and old sizes.
1133 % The format of the ResizeQuantumMemory method is:
1135 % void *ResizeQuantumMemory(void *memory,const size_t count,
1136 % const size_t quantum)
1138 % A description of each parameter follows:
1140 % o memory: A pointer to a memory allocation.
1142 % o count: the number of quantum elements to allocate.
1144 % o quantum: the number of bytes in each quantum.
1147 MagickExport void *ResizeQuantumMemory(void *memory,const size_t count,
1148 const size_t quantum)
1154 if ((count == 0) || (quantum != (size/count)))
1156 memory=RelinquishMagickMemory(memory);
1158 return((void *) NULL);
1160 return(ResizeMagickMemory(memory,size));
1164 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1168 % S e t M a g i c k M e m o r y M e t h o d s %
1172 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1174 % SetMagickMemoryMethods() sets the methods to acquire, resize, and destroy
1175 % memory. Your custom memory methods must be set prior to the
1176 % MagickCoreGenesis() method.
1178 % The format of the SetMagickMemoryMethods() method is:
1180 % SetMagickMemoryMethods(AcquireMemoryHandler acquire_memory_handler,
1181 % ResizeMemoryHandler resize_memory_handler,
1182 % DestroyMemoryHandler destroy_memory_handler)
1184 % A description of each parameter follows:
1186 % o acquire_memory_handler: method to acquire memory (e.g. malloc).
1188 % o resize_memory_handler: method to resize memory (e.g. realloc).
1190 % o destroy_memory_handler: method to destroy memory (e.g. free).
1193 MagickExport void SetMagickMemoryMethods(
1194 AcquireMemoryHandler acquire_memory_handler,
1195 ResizeMemoryHandler resize_memory_handler,
1196 DestroyMemoryHandler destroy_memory_handler)
1201 if (acquire_memory_handler != (AcquireMemoryHandler) NULL)
1202 memory_methods.acquire_memory_handler=acquire_memory_handler;
1203 if (resize_memory_handler != (ResizeMemoryHandler) NULL)
1204 memory_methods.resize_memory_handler=resize_memory_handler;
1205 if (destroy_memory_handler != (DestroyMemoryHandler) NULL)
1206 memory_methods.destroy_memory_handler=destroy_memory_handler;