Head

GCC Code Coverage Report

Directory:	.		Exec	Total	Coverage
File:	src/prop/minisat/mtl/Alloc.h	Lines:	45	47	95.7 %
Date:	2021-11-07	Branches:	21	108	19.4 %


/*****************************************************************************************[Alloc.h]
Copyright (c) 2008-2010, Niklas Sorensson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**************************************************************************************************/


#ifndef Minisat_Alloc_h
#define Minisat_Alloc_h

#include "base/check.h"
#include "prop/minisat/mtl/Vec.h"
#include "prop/minisat/mtl/XAlloc.h"

namespace cvc5 {
namespace Minisat {

//=================================================================================================
// Simple Region-based memory allocator:

template<class T>
class RegionAllocator
{
    T*        memory;
    uint32_t  sz;
    uint32_t  cap;
    uint32_t  wasted_;

    void capacity(uint32_t min_cap);

 public:
    // TODO: make this a class for better type-checking?
    typedef uint32_t Ref;
    enum { Ref_Undef = UINT32_MAX };
    enum { Unit_Size = sizeof(uint32_t) };

    explicit RegionAllocator(uint32_t start_cap = 1024*1024) : memory(NULL), sz(0), cap(0), wasted_(0){ capacity(start_cap); }
    ~RegionAllocator()
    {
        if (memory != NULL)
            ::free(memory);
    }


    uint32_t size      () const      { return sz; }
    uint32_t wasted    () const      { return wasted_; }

    Ref      alloc     (int size);
    void     free      (int size)    { wasted_ += size; }

    // Deref, Load Effective Address (LEA), Inverse of LEA (AEL):
    T& operator[](Ref r)
    {
      Assert(r >= 0 && r < sz);
      return memory[r];
    }
    const T& operator[](Ref r) const
    {
      Assert(r >= 0 && r < sz);
      return memory[r];
    }

    T* lea(Ref r)
    {
      Assert(r >= 0 && r < sz);
      return &memory[r];
    }
    const T* lea(Ref r) const
    {
      Assert(r >= 0 && r < sz);
      return &memory[r];
    }
    Ref ael(const T* t)
    {
      Assert((void*)t >= (void*)&memory[0]
             && (void*)t < (void*)&memory[sz - 1]);
      return (Ref)(t - &memory[0]);
    }

    void     moveTo(RegionAllocator& to) {
        if (to.memory != NULL) ::free(to.memory);
        to.memory = memory;
        to.sz = sz;
        to.cap = cap;
        to.wasted_ = wasted_;

        memory = NULL;
        sz = cap = wasted_ = 0;
    }


};

template<class T>
void RegionAllocator<T>::capacity(uint32_t min_cap)
{
    if (cap >= min_cap) return;

    uint32_t prev_cap = cap;
    while (cap < min_cap){
        // NOTE: Multiply by a factor (13/8) without causing overflow, then add 2 and make the
        // result even by clearing the least significant bit. The resulting sequence of capacities
        // is carefully chosen to hit a maximum capacity that is close to the '2^32-1' limit when
        // using 'uint32_t' as indices so that as much as possible of this space can be used.
        uint32_t delta = ((cap >> 1) + (cap >> 3) + 2) & ~1;
        cap += delta;

        if (cap <= prev_cap)
            throw OutOfMemoryException();
    }
    // printf(" .. (%p) cap = %u\n", this, cap);

    Assert(cap > 0);
    memory = (T*)xrealloc(memory, sizeof(T)*cap);
}


template<class T>
typename RegionAllocator<T>::Ref
RegionAllocator<T>::alloc(int size)
{
    // printf("ALLOC called (this = %p, size = %d)\n", this, size); fflush(stdout);
    Assert(size > 0);
    capacity(sz + size);

    uint32_t prev_sz = sz;
    sz += size;

    // Handle overflow:
    if (sz < prev_sz)
        throw OutOfMemoryException();

    return prev_sz;
}


//=================================================================================================
}
}  // namespace cvc5

#endif


Generated by: GCOVR (Version 3.2)

Line	Exec	Source
1		/*****************************************************************************************[Alloc.h]
2		Copyright (c) 2008-2010, Niklas Sorensson
3
4		Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
5		associated documentation files (the "Software"), to deal in the Software without restriction,
6		including without limitation the rights to use, copy, modify, merge, publish, distribute,
7		sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
8		furnished to do so, subject to the following conditions:
9
10		The above copyright notice and this permission notice shall be included in all copies or
11		substantial portions of the Software.
12
13		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
14		NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15		NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
16		DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
17		OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
18		**************************************************************************************************/
19
20
21		#ifndef Minisat_Alloc_h
22		#define Minisat_Alloc_h
23
24		#include "base/check.h"
25		#include "prop/minisat/mtl/Vec.h"
26		#include "prop/minisat/mtl/XAlloc.h"
27
28		namespace cvc5 {
29		namespace Minisat {
30
31		//=================================================================================================
32		// Simple Region-based memory allocator:
33
34		template<class T>
35		class RegionAllocator
36		{
37		T* memory;
38		uint32_t sz;
39		uint32_t cap;
40		uint32_t wasted_;
41
42		void capacity(uint32_t min_cap);
43
44		public:
45		// TODO: make this a class for better type-checking?
46		typedef uint32_t Ref;
47		enum { Ref_Undef = UINT32_MAX };
48		enum { Unit_Size = sizeof(uint32_t) };
49
50	18390	explicit RegionAllocator(uint32_t start_cap = 1024*1024) : memory(NULL), sz(0), cap(0), wasted_(0){ capacity(start_cap); }
51	18385	~RegionAllocator()
52		{
53	18385	if (memory != NULL)
54	15333	::free(memory);
55	18385	}
56
57
58	171073	uint32_t size () const { return sz; }
59	82138	uint32_t wasted () const { return wasted_; }
60
61		Ref alloc (int size);
62	707486	void free (int size) { wasted_ += size; }
63
64		// Deref, Load Effective Address (LEA), Inverse of LEA (AEL):
65	654733300	T& operator[](Ref r)
66		{
67	654733300	Assert(r >= 0 && r < sz);
68	654733300	return memory[r];
69		}
70	14949520	const T& operator[](Ref r) const
71		{
72	14949520	Assert(r >= 0 && r < sz);
73	14949520	return memory[r];
74		}
75
76	5786274	T* lea(Ref r)
77		{
78	5786274	Assert(r >= 0 && r < sz);
79	5786274	return &memory[r];
80		}
81	92251	const T* lea(Ref r) const
82		{
83	92251	Assert(r >= 0 && r < sz);
84	92251	return &memory[r];
85		}
86		Ref ael(const T* t)
87		{
88		Assert((void)t >= (void)&memory[0]
89		&& (void)t < (void)&memory[sz - 1]);
90		return (Ref)(t - &memory[0]);
91		}
92
93	3050	void moveTo(RegionAllocator& to) {
94	3050	if (to.memory != NULL) ::free(to.memory);
95	3050	to.memory = memory;
96	3050	to.sz = sz;
97	3050	to.cap = cap;
98	3050	to.wasted_ = wasted_;
99
100	3050	memory = NULL;
101	3050	sz = cap = wasted_ = 0;
102	3050	}
103
104
105		};
106
107		template<class T>
108	5804664	void RegionAllocator<T>::capacity(uint32_t min_cap)
109		{
110	5804664	if (cap >= min_cap) return;
111
112	21687	uint32_t prev_cap = cap;
113	930899	while (cap < min_cap){
114		// NOTE: Multiply by a factor (13/8) without causing overflow, then add 2 and make the
115		// result even by clearing the least significant bit. The resulting sequence of capacities
116		// is carefully chosen to hit a maximum capacity that is close to the '2^32-1' limit when
117		// using 'uint32_t' as indices so that as much as possible of this space can be used.
118	454606	uint32_t delta = ((cap >> 1) + (cap >> 3) + 2) & ~1;
119	454606	cap += delta;
120
121	454606	if (cap <= prev_cap)
122		throw OutOfMemoryException();
123		}
124		// printf(" .. (%p) cap = %u\n", this, cap);
125
126	21687	Assert(cap > 0);
127	21687	memory = (T)xrealloc(memory, sizeof(T)cap);
128		}
129
130
131		template<class T>
132		typename RegionAllocator<T>::Ref
133	5786274	RegionAllocator<T>::alloc(int size)
134		{
135		// printf("ALLOC called (this = %p, size = %d)\n", this, size); fflush(stdout);
136	5786274	Assert(size > 0);
137	5786274	capacity(sz + size);
138
139	5786274	uint32_t prev_sz = sz;
140	5786274	sz += size;
141
142		// Handle overflow:
143	5786274	if (sz < prev_sz)
144		throw OutOfMemoryException();
145
146	5786274	return prev_sz;
147		}
148
149
150		//=================================================================================================
151		}
152		} // namespace cvc5
153
154		#endif