Files
xtensa_dsp/test/test_utility/include/CppUTest/TestMemoryAllocator.h
2022-09-13 10:33:44 +08:00

262 lines
8.7 KiB
C++

/*
* Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the <organization> nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef D_TestMemoryAllocator_h
#define D_TestMemoryAllocator_h
struct MemoryLeakNode;
class TestMemoryAllocator;
extern void setCurrentNewAllocator(TestMemoryAllocator* allocator);
extern TestMemoryAllocator* getCurrentNewAllocator();
extern void setCurrentNewAllocatorToDefault();
extern TestMemoryAllocator* defaultNewAllocator();
extern void setCurrentNewArrayAllocator(TestMemoryAllocator* allocator);
extern TestMemoryAllocator* getCurrentNewArrayAllocator();
extern void setCurrentNewArrayAllocatorToDefault();
extern TestMemoryAllocator* defaultNewArrayAllocator();
extern void setCurrentMallocAllocator(TestMemoryAllocator* allocator);
extern TestMemoryAllocator* getCurrentMallocAllocator();
extern void setCurrentMallocAllocatorToDefault();
extern TestMemoryAllocator* defaultMallocAllocator();
class GlobalMemoryAllocatorStash
{
public:
GlobalMemoryAllocatorStash();
void save();
void restore();
private:
TestMemoryAllocator* originalMallocAllocator;
TestMemoryAllocator* originalNewAllocator;
TestMemoryAllocator* originalNewArrayAllocator;
};
class TestMemoryAllocator
{
public:
TestMemoryAllocator(const char* name_str = "generic", const char* alloc_name_str = "alloc", const char* free_name_str = "free");
virtual ~TestMemoryAllocator();
bool hasBeenDestroyed();
virtual char* alloc_memory(size_t size, const char* file, size_t line);
virtual void free_memory(char* memory, size_t size, const char* file, size_t line);
virtual const char* name() const;
virtual const char* alloc_name() const;
virtual const char* free_name() const;
virtual bool isOfEqualType(TestMemoryAllocator* allocator);
virtual char* allocMemoryLeakNode(size_t size);
virtual void freeMemoryLeakNode(char* memory);
virtual TestMemoryAllocator* actualAllocator();
protected:
const char* name_;
const char* alloc_name_;
const char* free_name_;
bool hasBeenDestroyed_;
};
class MemoryLeakAllocator : public TestMemoryAllocator
{
public:
MemoryLeakAllocator(TestMemoryAllocator* originalAllocator);
virtual ~MemoryLeakAllocator() _destructor_override;
virtual char* alloc_memory(size_t size, const char* file, size_t line) _override;
virtual void free_memory(char* memory, size_t size, const char* file, size_t line) _override;
virtual const char* name() const _override;
virtual const char* alloc_name() const _override;
virtual const char* free_name() const _override;
virtual TestMemoryAllocator* actualAllocator() _override;
private:
TestMemoryAllocator* originalAllocator_;
};
class CrashOnAllocationAllocator : public TestMemoryAllocator
{
unsigned allocationToCrashOn_;
public:
CrashOnAllocationAllocator();
virtual ~CrashOnAllocationAllocator() _destructor_override;
virtual void setNumberToCrashOn(unsigned allocationToCrashOn);
virtual char* alloc_memory(size_t size, const char* file, size_t line) _override;
};
class NullUnknownAllocator: public TestMemoryAllocator
{
public:
NullUnknownAllocator();
virtual ~NullUnknownAllocator() _destructor_override;
virtual char* alloc_memory(size_t size, const char* file, size_t line) _override;
virtual void free_memory(char* memory, size_t size, const char* file, size_t line) _override;
static TestMemoryAllocator* defaultAllocator();
};
class LocationToFailAllocNode;
class FailableMemoryAllocator: public TestMemoryAllocator
{
public:
FailableMemoryAllocator(const char* name_str = "failable alloc", const char* alloc_name_str = "alloc", const char* free_name_str = "free");
virtual ~FailableMemoryAllocator() _destructor_override;
virtual char* alloc_memory(size_t size, const char* file, size_t line) _override;
virtual char* allocMemoryLeakNode(size_t size) _override;
virtual void failAllocNumber(int number);
virtual void failNthAllocAt(int allocationNumber, const char* file, size_t line);
virtual void checkAllFailedAllocsWereDone();
virtual void clearFailedAllocs();
protected:
LocationToFailAllocNode* head_;
int currentAllocNumber_;
};
struct MemoryAccountantAllocationNode;
class MemoryAccountant
{
public:
MemoryAccountant();
~MemoryAccountant();
void useCacheSizes(size_t sizes[], size_t length);
void clear();
void alloc(size_t size);
void dealloc(size_t size);
size_t totalAllocationsOfSize(size_t size) const;
size_t totalDeallocationsOfSize(size_t size) const;
size_t maximumAllocationAtATimeOfSize(size_t size) const;
size_t totalAllocations() const;
size_t totalDeallocations() const;
SimpleString report() const;
void setAllocator(TestMemoryAllocator* allocator);
private:
MemoryAccountantAllocationNode* findOrCreateNodeOfSize(size_t size);
MemoryAccountantAllocationNode* findNodeOfSize(size_t size) const;
MemoryAccountantAllocationNode* createNewAccountantAllocationNode(size_t size, MemoryAccountantAllocationNode* next) const;
void destroyAccountantAllocationNode(MemoryAccountantAllocationNode* node) const;
void createCacheSizeNodes(size_t sizes[], size_t length);
MemoryAccountantAllocationNode* head_;
TestMemoryAllocator* allocator_;
bool useCacheSizes_;
SimpleString reportNoAllocations() const;
SimpleString reportTitle() const;
SimpleString reportHeader() const;
SimpleString reportFooter() const;
SimpleString stringSize(size_t size) const;
};
struct AccountingTestMemoryAllocatorMemoryNode;
class AccountingTestMemoryAllocator : public TestMemoryAllocator
{
public:
AccountingTestMemoryAllocator(MemoryAccountant& accountant, TestMemoryAllocator* originalAllocator);
virtual ~AccountingTestMemoryAllocator() _destructor_override;
virtual char* alloc_memory(size_t size, const char* file, size_t line) _override;
virtual void free_memory(char* memory, size_t size, const char* file, size_t line) _override;
virtual TestMemoryAllocator* actualAllocator() _override;
TestMemoryAllocator* originalAllocator();
virtual const char* alloc_name() const _override;
virtual const char* free_name() const _override;
private:
void addMemoryToMemoryTrackingToKeepTrackOfSize(char* memory, size_t size);
size_t removeMemoryFromTrackingAndReturnAllocatedSize(char* memory);
size_t removeNextNodeAndReturnSize(AccountingTestMemoryAllocatorMemoryNode* node);
size_t removeHeadAndReturnSize();
MemoryAccountant& accountant_;
TestMemoryAllocator* originalAllocator_;
AccountingTestMemoryAllocatorMemoryNode* head_;
};
class GlobalMemoryAccountant
{
public:
GlobalMemoryAccountant();
~GlobalMemoryAccountant();
void useCacheSizes(size_t sizes[], size_t length);
void start();
void stop();
SimpleString report();
SimpleString reportWithCacheSizes(size_t sizes[], size_t length);
TestMemoryAllocator* getMallocAllocator();
TestMemoryAllocator* getNewAllocator();
TestMemoryAllocator* getNewArrayAllocator();
private:
void restoreMemoryAllocators();
MemoryAccountant accountant_;
AccountingTestMemoryAllocator* mallocAllocator_;
AccountingTestMemoryAllocator* newAllocator_;
AccountingTestMemoryAllocator* newArrayAllocator_;
};
#endif