1 // Created on: 2005-03-15
2 // Created by: Peter KURNEV
3 // Copyright (c) 1998-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #include <Standard.ixx>
21 #include <Standard_MMgrOpt.hxx>
22 #include <Standard_MMgrRaw.hxx>
23 #include <Standard_MMgrTBBalloc.hxx>
25 #if(defined(_WIN32) || defined(__WIN32__))
31 #if defined(_MSC_VER) || defined(__ANDROID__)
33 #elif (defined(__GNUC__) && __GNUC__ >= 4 && __GNUC_MINOR__ >= 1)
34 #include <mm_malloc.h>
36 extern "C" int posix_memalign (void** thePtr, size_t theAlign, size_t theSize);
39 #ifndef OCCT_MMGT_OPT_DEFAULT
40 #define OCCT_MMGT_OPT_DEFAULT 0
43 //=======================================================================
44 //class : Standard_MMgrFactory
45 //purpose : Container for pointer to memory manager;
46 // used to construct appropriate memory manager according
47 // to environment settings, and to ensure destruction upon exit
48 //=======================================================================
50 class Standard_MMgrFactory {
52 Standard_MMgrFactory();
53 ~Standard_MMgrFactory();
55 Standard_MMgrRoot* myFMMgr;
58 //=======================================================================
59 //function : Standard_MMgrFactory
60 //purpose : Check environment variables and create appropriate memory manager
61 //=======================================================================
63 Standard_MMgrFactory::Standard_MMgrFactory()
66 /*#if defined(_MSC_VER) && (_MSC_VER > 1400)
67 // Turn ON thread-safe C locale globally to avoid side effects by setlocale() calls between threads.
68 // After this call all following _configthreadlocale() will be ignored assuming
69 // Notice that this is MSVCRT feature - on POSIX systems xlocale API (uselocale instead of setlocale)
70 // should be used explicitly to ensure thread-safety!
72 // This is not well documented call because _ENABLE_PER_THREAD_LOCALE_GLOBAL flag is defined but not implemented for some reason.
73 // -1 will set global locale flag to force _ENABLE_PER_THREAD_LOCALE_GLOBAL + _ENABLE_PER_THREAD_LOCALE_NEW behaviour
74 // although there NO way to turn it off again and following calls will have no effect (locale will be changed only for current thread).
75 _configthreadlocale (-1);
79 aVar = getenv ("MMGT_OPT");
80 Standard_Integer anAllocId = (aVar ? atoi (aVar): OCCT_MMGT_OPT_DEFAULT);
81 aVar = getenv ("MMGT_CLEAR");
82 Standard_Boolean toClear = (aVar ? (atoi (aVar) != 0) : Standard_True);
84 // on Windows (actual for XP and 2000) activate low fragmentation heap
85 // for CRT heap in order to get best performance.
86 // Environment variable MMGT_LFH can be used to switch off this action (if set to 0)
88 aVar = getenv ("MMGT_LFH");
89 if ( aVar == NULL || atoi (aVar) != 0 )
92 HANDLE aCRTHeap = (HANDLE)_get_heap_handle();
93 HeapSetInformation (aCRTHeap, HeapCompatibilityInformation, &aHeapInfo, sizeof(aHeapInfo));
99 case 1: // OCCT optimized memory allocator
101 aVar = getenv ("MMGT_MMAP");
102 Standard_Boolean bMMap = (aVar ? (atoi (aVar) != 0) : Standard_True);
103 aVar = getenv ("MMGT_CELLSIZE");
104 Standard_Integer aCellSize = (aVar ? atoi (aVar) : 200);
105 aVar = getenv ("MMGT_NBPAGES");
106 Standard_Integer aNbPages = (aVar ? atoi (aVar) : 1000);
107 aVar = getenv ("MMGT_THRESHOLD");
108 Standard_Integer aThreshold = (aVar ? atoi (aVar) : 40000);
109 myFMMgr = new Standard_MMgrOpt (toClear, bMMap, aCellSize, aNbPages, aThreshold);
112 case 2: // TBB memory allocator
113 myFMMgr = new Standard_MMgrTBBalloc (toClear);
116 default: // system default memory allocator
117 myFMMgr = new Standard_MMgrRaw (toClear);
121 //=======================================================================
122 //function : ~Standard_MMgrFactory
124 //=======================================================================
126 Standard_MMgrFactory::~Standard_MMgrFactory()
129 myFMMgr->Purge(Standard_True);
135 //=======================================================================
138 // This static function has a purpose to wrap static holder for memory
141 // Wrapping holder inside a function is needed to ensure that it will
142 // be initialized not later than the first call to memory manager (that
143 // would be impossible to guarantee if holder was static variable on
144 // global or file scope, because memory manager may be called from
145 // constructors of other static objects).
147 // Note that at the same time we could not guarantee that the holder
148 // object is destroyed after last call to memory manager, since that
149 // last call may be from static Handle() object which has been initialized
150 // dynamically during program execution rather than in its constructor.
152 // Therefore holder currently does not call destructor of the memory manager
153 // but only its method Purge() with Standard_True.
155 // To free the memory completely, we probably could use compiler-specific
156 // pragmas (such as '#pragma fini' on SUN Solaris and '#pragma init_seg' on
157 // WNT MSVC++) to put destructing function in code segment that is called
158 // after destructors of other (even static) objects. However, this is not
159 // done by the moment since it is compiler-dependent and there is no guarantee
160 // thatsome other object calling memory manager is not placed also in that segment...
162 // Note that C runtime function atexit() could not help in this problem
163 // since its behaviour is the same as for destructors of static objects
164 // (see ISO 14882:1998 "Programming languages -- C++" 3.6.3)
166 // The correct approach to deal with the problem would be to have memory manager
167 // to properly control its memory allocation and caching free blocks so
168 // as to release all memory as soon as it is returned to it, and probably
169 // even delete itself if all memory it manages has been released and
170 // last call to method Purge() was with True.
172 // Note that one possible method to control memory allocations could
173 // be counting calls to Allocate() and Free()...
175 //=======================================================================
177 static Standard_MMgrRoot* GetMMgr()
179 static Standard_MMgrFactory aFactory;
180 return aFactory.myFMMgr;
183 //=======================================================================
184 //function : Allocate
186 //=======================================================================
188 Standard_Address Standard::Allocate(const Standard_Size size)
190 return GetMMgr()->Allocate(size);
193 //=======================================================================
196 //=======================================================================
198 void Standard::Free (Standard_Address theStorage)
200 GetMMgr()->Free(theStorage);
203 //=======================================================================
204 //function : Reallocate
206 //=======================================================================
208 Standard_Address Standard::Reallocate (Standard_Address theStorage,
209 const Standard_Size theSize)
211 return GetMMgr()->Reallocate (theStorage, theSize);
214 //=======================================================================
217 //=======================================================================
219 Standard_Integer Standard::Purge()
221 return GetMMgr()->Purge();
224 //=======================================================================
225 //function : AllocateAligned
227 //=======================================================================
229 Standard_Address Standard::AllocateAligned (const Standard_Size theSize,
230 const Standard_Size theAlign)
232 #if defined(_MSC_VER)
233 return _aligned_malloc (theSize, theAlign);
234 #elif defined(__ANDROID__)
235 return memalign (theAlign, theSize);
236 #elif (defined(__GNUC__) && __GNUC__ >= 4 && __GNUC_MINOR__ >= 1)
237 return _mm_malloc (theSize, theAlign);
240 if (posix_memalign (&aPtr, theAlign, theSize))
248 //=======================================================================
249 //function : FreeAligned
251 //=======================================================================
253 void Standard::FreeAligned (Standard_Address thePtrAligned)
255 #if defined(_MSC_VER)
256 _aligned_free (thePtrAligned);
257 #elif defined(__ANDROID__)
258 free (thePtrAligned);
259 #elif (defined(__GNUC__) && __GNUC__ >= 4 && __GNUC_MINOR__ >= 1)
260 _mm_free (thePtrAligned);
262 free (thePtrAligned);