0025616: Avoid Classes using "new" to allocate Instances but not defining a copy...
[occt.git] / src / Standard / Standard.cxx
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
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
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.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #include <Standard.ixx>
18
19 #include <stdlib.h>
20
21 #include <Standard_MMgrOpt.hxx>
22 #include <Standard_MMgrRaw.hxx>
23 #include <Standard_MMgrTBBalloc.hxx>
24
25 #if(defined(_WIN32) || defined(__WIN32__))
26   #include <windows.h>
27   #include <malloc.h>
28   #include <locale.h>
29 #endif
30
31 #if defined(_MSC_VER) || defined(__ANDROID__)
32   #include <malloc.h>
33 #elif (defined(__GNUC__) && __GNUC__ >= 4 && __GNUC_MINOR__ >= 1)
34   #include <mm_malloc.h>
35 #else
36   extern "C" int posix_memalign (void** thePtr, size_t theAlign, size_t theSize);
37 #endif
38
39 #ifndef OCCT_MMGT_OPT_DEFAULT
40 #define OCCT_MMGT_OPT_DEFAULT 0
41 #endif
42
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 //=======================================================================
49 class Standard_MMgrFactory
50 {
51 public:
52   static Standard_MMgrRoot* GetMMgr();
53   ~Standard_MMgrFactory();
54
55 private:
56   Standard_MMgrFactory();
57   Standard_MMgrFactory (const Standard_MMgrFactory&);
58   Standard_MMgrFactory& operator= (const Standard_MMgrFactory&);
59
60 private:
61   Standard_MMgrRoot* myFMMgr;
62 };
63
64 //=======================================================================
65 //function : Standard_MMgrFactory
66 //purpose  : Check environment variables and create appropriate memory manager
67 //=======================================================================
68
69 Standard_MMgrFactory::Standard_MMgrFactory()
70 : myFMMgr (NULL)
71 {
72 /*#if defined(_MSC_VER) && (_MSC_VER > 1400)
73   // Turn ON thread-safe C locale globally to avoid side effects by setlocale() calls between threads.
74   // After this call all following _configthreadlocale() will be ignored assuming
75   // Notice that this is MSVCRT feature - on POSIX systems xlocale API (uselocale instead of setlocale)
76   // should be used explicitly to ensure thread-safety!
77
78   // This is not well documented call because _ENABLE_PER_THREAD_LOCALE_GLOBAL flag is defined but not implemented for some reason.
79   // -1 will set global locale flag to force _ENABLE_PER_THREAD_LOCALE_GLOBAL + _ENABLE_PER_THREAD_LOCALE_NEW behaviour
80   // although there NO way to turn it off again and following calls will have no effect (locale will be changed only for current thread).
81   _configthreadlocale (-1);
82 #endif*/
83
84   char* aVar;
85   aVar = getenv ("MMGT_OPT");
86   Standard_Integer anAllocId   = (aVar ?  atoi (aVar): OCCT_MMGT_OPT_DEFAULT);
87
88 #if defined(_WIN32) && !defined(_WIN64)
89   static const DWORD _SSE2_FEATURE_BIT(0x04000000);
90   if ( anAllocId == 2 )
91   {
92     // CR25396: Check if SSE2 instructions are supported, if not then use MMgrRaw
93     // instead of MMgrTBBalloc. It is to avoid runtime crash when running on a 
94     // CPU that supports SSE but does not support SSE2 (some modifications of
95     // AMD Sempron).
96     DWORD volatile dwFeature;
97     _asm
98     {
99       push eax
100       push ebx
101       push ecx
102       push edx
103
104       // get the CPU feature bits
105       mov eax, 1
106       cpuid
107       mov dwFeature, edx
108
109       pop edx
110       pop ecx
111       pop ebx
112       pop eax
113     }
114     if ((dwFeature & _SSE2_FEATURE_BIT) == 0)
115       anAllocId = 0;
116   }
117 #endif
118
119   aVar = getenv ("MMGT_CLEAR");
120   Standard_Boolean toClear     = (aVar ? (atoi (aVar) != 0) : Standard_True);
121
122   // on Windows (actual for XP and 2000) activate low fragmentation heap
123   // for CRT heap in order to get best performance.
124   // Environment variable MMGT_LFH can be used to switch off this action (if set to 0)
125 #if defined(_MSC_VER)
126   aVar = getenv ("MMGT_LFH");
127   if ( aVar == NULL || atoi (aVar) != 0 )
128   {
129     ULONG aHeapInfo = 2;
130     HANDLE aCRTHeap = (HANDLE)_get_heap_handle();
131     HeapSetInformation (aCRTHeap, HeapCompatibilityInformation, &aHeapInfo, sizeof(aHeapInfo));
132   }
133 #endif
134
135   switch (anAllocId)
136   {
137     case 1:  // OCCT optimized memory allocator
138     {
139       aVar = getenv ("MMGT_MMAP");
140       Standard_Boolean bMMap       = (aVar ? (atoi (aVar) != 0) : Standard_True);
141       aVar = getenv ("MMGT_CELLSIZE");
142       Standard_Integer aCellSize   = (aVar ?  atoi (aVar) : 200);
143       aVar = getenv ("MMGT_NBPAGES");
144       Standard_Integer aNbPages    = (aVar ?  atoi (aVar) : 1000);
145       aVar = getenv ("MMGT_THRESHOLD");
146       Standard_Integer aThreshold  = (aVar ?  atoi (aVar) : 40000);
147       myFMMgr = new Standard_MMgrOpt (toClear, bMMap, aCellSize, aNbPages, aThreshold);
148       break;
149     }
150     case 2:  // TBB memory allocator
151       myFMMgr = new Standard_MMgrTBBalloc (toClear);
152       break;
153     case 0:
154     default: // system default memory allocator
155       myFMMgr = new Standard_MMgrRaw (toClear);
156   }
157 }
158
159 //=======================================================================
160 //function : ~Standard_MMgrFactory
161 //purpose  : 
162 //=======================================================================
163
164 Standard_MMgrFactory::~Standard_MMgrFactory()
165 {
166   if (  myFMMgr )
167     myFMMgr->Purge(Standard_True);
168 }
169
170 //=======================================================================
171 // function: GetMMgr
172 //
173 // This static function has a purpose to wrap static holder for memory 
174 // manager instance. 
175 //
176 // Wrapping holder inside a function is needed to ensure that it will
177 // be initialized not later than the first call to memory manager (that
178 // would be impossible to guarantee if holder was static variable on 
179 // global or file scope, because memory manager may be called from 
180 // constructors of other static objects).
181 //
182 // Note that at the same time we could not guarantee that the holder 
183 // object is destroyed after last call to memory manager, since that 
184 // last call may be from static Handle() object which has been initialized
185 // dynamically during program execution rather than in its constructor.
186 //
187 // Therefore holder currently does not call destructor of the memory manager 
188 // but only its method Purge() with Standard_True.
189 //
190 // To free the memory completely, we probably could use compiler-specific 
191 // pragmas (such as '#pragma fini' on SUN Solaris and '#pragma init_seg' on 
192 // WNT MSVC++) to put destructing function in code segment that is called
193 // after destructors of other (even static) objects. However, this is not 
194 // done by the moment since it is compiler-dependent and there is no guarantee 
195 // thatsome other object calling memory manager is not placed also in that segment...
196 //
197 // Note that C runtime function atexit() could not help in this problem 
198 // since its behaviour is the same as for destructors of static objects 
199 // (see ISO 14882:1998 "Programming languages -- C++" 3.6.3)
200 //
201 // The correct approach to deal with the problem would be to have memory manager 
202 // to properly control its memory allocation and caching free blocks so 
203 // as to release all memory as soon as it is returned to it, and probably
204 // even delete itself if all memory it manages has been released and 
205 // last call to method Purge() was with True.
206 //
207 // Note that one possible method to control memory allocations could
208 // be counting calls to Allocate() and Free()...
209 //
210 //=======================================================================
211 Standard_MMgrRoot* Standard_MMgrFactory::GetMMgr()
212 {
213   static Standard_MMgrFactory aFactory;
214   return aFactory.myFMMgr;
215 }
216
217 //=======================================================================
218 //function : Allocate
219 //purpose  : 
220 //=======================================================================
221
222 Standard_Address Standard::Allocate(const Standard_Size size)
223 {
224   return Standard_MMgrFactory::GetMMgr()->Allocate(size);
225 }
226
227 //=======================================================================
228 //function : Free
229 //purpose  : 
230 //=======================================================================
231
232 void Standard::Free (Standard_Address theStorage)
233 {
234   Standard_MMgrFactory::GetMMgr()->Free(theStorage);
235 }
236
237 //=======================================================================
238 //function : Reallocate
239 //purpose  : 
240 //=======================================================================
241
242 Standard_Address Standard::Reallocate (Standard_Address theStorage,
243                                        const Standard_Size theSize)
244 {
245   return Standard_MMgrFactory::GetMMgr()->Reallocate (theStorage, theSize);
246 }
247
248 //=======================================================================
249 //function : Purge
250 //purpose  : 
251 //=======================================================================
252
253 Standard_Integer Standard::Purge()
254 {
255   return Standard_MMgrFactory::GetMMgr()->Purge();
256 }
257
258 //=======================================================================
259 //function : AllocateAligned
260 //purpose  :
261 //=======================================================================
262
263 Standard_Address Standard::AllocateAligned (const Standard_Size theSize,
264                                             const Standard_Size theAlign)
265 {
266 #if defined(_MSC_VER)
267   return _aligned_malloc (theSize, theAlign);
268 #elif defined(__ANDROID__)
269   return memalign (theAlign, theSize);
270 #elif (defined(__GNUC__) && __GNUC__ >= 4 && __GNUC_MINOR__ >= 1)
271   return _mm_malloc (theSize, theAlign);
272 #else
273   void* aPtr;
274   if (posix_memalign (&aPtr, theAlign, theSize))
275   {
276     return NULL;
277   }
278   return aPtr;
279 #endif
280 }
281
282 //=======================================================================
283 //function : FreeAligned
284 //purpose  :
285 //=======================================================================
286
287 void Standard::FreeAligned (Standard_Address thePtrAligned)
288 {
289 #if defined(_MSC_VER)
290   _aligned_free (thePtrAligned);
291 #elif defined(__ANDROID__)
292   free (thePtrAligned);
293 #elif (defined(__GNUC__) && __GNUC__ >= 4 && __GNUC_MINOR__ >= 1)
294   _mm_free (thePtrAligned);
295 #else
296   free (thePtrAligned);
297 #endif
298 }