0024836: Stack overflow when raising exception in low memory condition
[occt.git] / src / Standard / Standard_OutOfMemory.hxx
1 // Created on: 1991-09-05
2 // Created by: J.P. TIRAUlt
3 // Copyright (c) 1991-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 #ifndef _Standard_OutOfMemory_HeaderFile
18 #define _Standard_OutOfMemory_HeaderFile
19
20 #include <Standard_Type.hxx>
21 #include <Standard_DefineException.hxx>
22 #include <Standard_SStream.hxx>
23 #include <Standard_ProgramError.hxx>
24
25 class Standard_OutOfMemory;
26 DEFINE_STANDARD_HANDLE(Standard_OutOfMemory, Standard_ProgramError)
27
28 #if !defined No_Exception && !defined No_Standard_OutOfMemory
29   #define Standard_OutOfMemory_Raise_if(CONDITION, MESSAGE) \
30   if (CONDITION) Standard_OutOfMemory::Raise(MESSAGE);
31 #else
32   #define Standard_OutOfMemory_Raise_if(CONDITION, MESSAGE)
33 #endif
34
35 //! Standard_OutOfMemory exception is defined explicitly and not by
36 //! macro DEFINE_STANDARD_EXCEPTION, to avoid necessity of dynamic
37 //! memory allocations during throwing and stack unwinding:
38 //! 
39 //! - method NewInstance() returns static instance (singleton)
40 //! - method Raise() raises copy of that singleton, resetting 
41 //!   its message string
42 //! - message string is stored as field, not allocated dynamically
43 //!   (storable message length is limited by buffer size)
44 //!
45 //! The reason is that in out-of-memory condition any memory allocation can 
46 //! fail, thus use of operator new for allocation of new exception instance 
47 //! is dangerous (can cause recursion until stack overflow, see #24836).
48
49 class Standard_OutOfMemory : public Standard_ProgramError
50 {
51   void Throw () const Standard_OVERRIDE;
52
53 public:
54
55   //! Constructor is kept public for backward compatibility
56   Standard_EXPORT Standard_OutOfMemory(const Standard_CString theMessage = 0);
57
58   //! Returns error message
59   Standard_EXPORT Standard_CString GetMessageString() const Standard_OVERRIDE;
60   
61   //! Sets error message
62   Standard_EXPORT void SetMessageString (const Standard_CString aMessage) Standard_OVERRIDE;
63
64   //! Raises exception with specified message string
65   Standard_EXPORT static void Raise(const Standard_CString theMessage = "");
66
67   //! Raises exception with specified message string
68   Standard_EXPORT static void Raise(Standard_SStream& theMessage);
69
70   //! Returns global instance of exception
71   Standard_EXPORT static Handle(Standard_OutOfMemory) NewInstance(const Standard_CString theMessage = "");
72
73   DEFINE_STANDARD_RTTIEXT(Standard_OutOfMemory,Standard_ProgramError)
74
75 protected:
76   char myBuffer[1024];
77 };
78
79 #endif // _Standard_OutOfMemory_HeaderFile