NetBurner 3.1
MemoryLeakWarningPlugin.h
1 /*
2  * Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of the <organization> nor the
13  * names of its contributors may be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef D_MemoryLeakWarningPlugin_h
29 #define D_MemoryLeakWarningPlugin_h
30 
31 #include "TestPlugin.h"
32 #include "MemoryLeakDetectorNewMacros.h"
33 
34 #define IGNORE_ALL_LEAKS_IN_TEST() MemoryLeakWarningPlugin::getFirstPlugin()->ignoreAllLeaksInTest();
35 #define EXPECT_N_LEAKS(n) MemoryLeakWarningPlugin::getFirstPlugin()->expectLeaksInTest(n);
36 
37 extern void crash_on_allocation_number(unsigned alloc_number);
38 
39 class MemoryLeakDetector;
40 class MemoryLeakFailure;
41 
42 class MemoryLeakWarningPlugin: public TestPlugin
43 {
44 public:
45  MemoryLeakWarningPlugin(const SimpleString& name, MemoryLeakDetector* localDetector = 0);
46  virtual ~MemoryLeakWarningPlugin();
47 
48  virtual void preTestAction(UtestShell& test, TestResult& result) _override;
49  virtual void postTestAction(UtestShell& test, TestResult& result) _override;
50 
51  virtual const char* FinalReport(int toBeDeletedLeaks = 0);
52 
53  void ignoreAllLeaksInTest();
54  void expectLeaksInTest(int n);
55 
56  void destroyGlobalDetectorAndTurnOffMemoryLeakDetectionInDestructor(bool des);
57 
58  MemoryLeakDetector* getMemoryLeakDetector();
59 
60  static MemoryLeakWarningPlugin* getFirstPlugin();
61 
62  static MemoryLeakDetector* getGlobalDetector();
63  static MemoryLeakFailure* getGlobalFailureReporter();
64  static void setGlobalDetector(MemoryLeakDetector* detector, MemoryLeakFailure* reporter);
65  static void destroyGlobalDetector();
66 
67  static void turnOffNewDeleteOverloads();
68  static void turnOnNewDeleteOverloads();
69  static void turnOnThreadSafeNewDeleteOverloads();
70  static bool areNewDeleteOverloaded();
71 private:
72  MemoryLeakDetector* memLeakDetector_;
73  bool ignoreAllWarnings_;
74  bool destroyGlobalDetectorAndTurnOfMemoryLeakDetectionInDestructor_;
75  int expectedLeaks_;
76  int failureCount_;
77 
78  static MemoryLeakWarningPlugin* firstPlugin_;
79 };
80 
81 extern void* cpputest_malloc_location_with_leak_detection(size_t size, const char* file, int line);
82 extern void* cpputest_realloc_location_with_leak_detection(void* memory, size_t size, const char* file, int line);
83 extern void cpputest_free_location_with_leak_detection(void* buffer, const char* file, int line);
84 
85 #endif