/usr/include/gecode/kernel/region.hpp is in libgecode-dev 4.4.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 | /* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
* Main authors:
* Christian Schulte <schulte@gecode.org>
*
* Contributing authors:
* Filip Konvicka <filip.konvicka@logis.cz>
*
* Copyright:
* Christian Schulte, 2008
* LOGIS, s.r.o., 2009
*
* Last modified:
* $Date: 2013-02-20 18:27:38 +0100 (Wed, 20 Feb 2013) $ by $Author: schulte $
* $Revision: 13347 $
*
* This file is part of Gecode, the generic constraint
* development environment:
* http://www.gecode.org
*
* 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.
*
*/
namespace Gecode {
/**
* \defgroup FuncMemRegion Region memory management
*
* A region provides a handle to temporary memory owned by
* a space. The memory will be managed in a stack fashion, that is,
* the memory allocated through a region will be released
* only after the region is deleted and all other regions
* created later also have been deleted.
*
* In case a memory request cannot be fulfilled from a space's region,
* heap memory is allocated and returned to the operating system
* as soon as the region is deleted.
*
* \ingroup FuncMem
*/
//@{
/// Handle to region
class Region {
private:
/// Location to space
Space& home;
/// Free memory to reset
size_t free_reset;
/// Heap information data structure
class HeapInfo {
public:
/// Number of allocated heap blocks
unsigned int n;
/// Limit of allocated heap blocks
unsigned int size;
/// Pointers to allocated heap blocks (more entries)
void* blocks[1];
};
/**
* \brief Heap allocation information
*
* If NULL, no heap memory has been allocated. If the pointer
* is marked, it points to a single heap allocated block. Otherwise,
* it points to a HeapInfo data structure.
*/
void* hi;
/// Allocate memory from heap
GECODE_KERNEL_EXPORT void* heap_alloc(size_t s);
/// Free memory previously allocated from heap
GECODE_KERNEL_EXPORT void heap_free(void);
public:
/// Initialize region from space
Region(const Space& home);
/// \name Typed allocation routines
//@{
/**
* \brief Allocate block of \a n objects of type \a T from region
*
* Note that this function implements C++ semantics: the default
* constructor of \a T is run for all \a n objects.
*/
template<class T>
T* alloc(long unsigned int n);
/**
* \brief Allocate block of \a n objects of type \a T from region
*
* Note that this function implements C++ semantics: the default
* constructor of \a T is run for all \a n objects.
*/
template<class T>
T* alloc(long int n);
/**
* \brief Allocate block of \a n objects of type \a T from region
*
* Note that this function implements C++ semantics: the default
* constructor of \a T is run for all \a n objects.
*/
template<class T>
T* alloc(unsigned int n);
/**
* \brief Allocate block of \a n objects of type \a T from region
*
* Note that this function implements C++ semantics: the default
* constructor of \a T is run for all \a n objects.
*/
template<class T>
T* alloc(int n);
/**
* \brief Delete \a n objects allocated from the region starting at \a b
*
* Note that this function implements C++ semantics: the destructor
* of \a T is run for all \a n objects.
*
* Note that the memory is not freed, the only effect is running the
* destructors.
*/
template<class T>
void free(T* b, long unsigned int n);
/**
* \brief Delete \a n objects allocated from the region starting at \a b
*
* Note that this function implements C++ semantics: the destructor
* of \a T is run for all \a n objects.
*
* Note that the memory is not freed, the only effect is running the
* destructors.
*/
template<class T>
void free(T* b, long int n);
/**
* \brief Delete \a n objects allocated from the region starting at \a b
*
* Note that this function implements C++ semantics: the destructor
* of \a T is run for all \a n objects.
*
* Note that the memory is not freed, the only effect is running the
* destructors.
*/
template<class T>
void free(T* b, unsigned int n);
/**
* \brief Delete \a n objects allocated from the region starting at \a b
*
* Note that this function implements C++ semantics: the destructor
* of \a T is run for all \a n objects.
*
* Note that the memory is not freed, the only effect is running the
* destructors.
*/
template<class T>
void free(T* b, int n);
/**
* \brief Reallocate block of \a n objects starting at \a b to \a m objects of type \a T from the region
*
* Note that this function implements C++ semantics: the copy constructor
* of \a T is run for all \f$\min(n,m)\f$ objects, the default
* constructor of \a T is run for all remaining
* \f$\max(n,m)-\min(n,m)\f$ objects, and the destrucor of \a T is
* run for all \a n objects in \a b.
*
* Returns the address of the new block.
*/
template<class T>
T* realloc(T* b, long unsigned int n, long unsigned int m);
/**
* \brief Reallocate block of \a n objects starting at \a b to \a m objects of type \a T from the region
*
* Note that this function implements C++ semantics: the copy constructor
* of \a T is run for all \f$\min(n,m)\f$ objects, the default
* constructor of \a T is run for all remaining
* \f$\max(n,m)-\min(n,m)\f$ objects, and the destrucor of \a T is
* run for all \a n objects in \a b.
*
* Returns the address of the new block.
*/
template<class T>
T* realloc(T* b, long int n, long int m);
/**
* \brief Reallocate block of \a n objects starting at \a b to \a m objects of type \a T from the region
*
* Note that this function implements C++ semantics: the copy constructor
* of \a T is run for all \f$\min(n,m)\f$ objects, the default
* constructor of \a T is run for all remaining
* \f$\max(n,m)-\min(n,m)\f$ objects, and the destrucor of \a T is
* run for all \a n objects in \a b.
*
* Returns the address of the new block.
*/
template<class T>
T* realloc(T* b, unsigned int n, unsigned int m);
/**
* \brief Reallocate block of \a n objects starting at \a b to \a m objects of type \a T from the region
*
* Note that this function implements C++ semantics: the copy constructor
* of \a T is run for all \f$\min(n,m)\f$ objects, the default
* constructor of \a T is run for all remaining
* \f$\max(n,m)-\min(n,m)\f$ objects, and the destrucor of \a T is
* run for all \a n objects in \a b.
*
* Returns the address of the new block.
*/
template<class T>
T* realloc(T* b, int n, int m);
//@}
/// \name Raw allocation routines
//@{
/// Allocate memory from region
void* ralloc(size_t s);
/**
* \brief Free memory previously allocated
*
* Note that the memory is only guaranteed to be freed after the
* region object itself gets deleted.
*/
void rfree(void* p, size_t s);
//@}
/// \name Construction routines
//@{
/**
* \brief Constructs a single object of type \a T from region using the default constructor.
*/
template<class T>
T& construct(void);
/**
* \brief Constructs a single object of type \a T from region using a unary constructor.
*
* The parameter is passed as a const reference.
*/
template<class T, typename A1>
T& construct(A1 const& a1);
/**
* \brief Constructs a single object of type \a T from region using a binary constructor.
*
* The parameters are passed as const references.
*/
template<class T, typename A1, typename A2>
T& construct(A1 const& a1, A2 const& a2);
/**
* \brief Constructs a single object of type \a T from region using a ternary constructor.
*
* The parameters are passed as const references.
*/
template<class T, typename A1, typename A2, typename A3>
T& construct(A1 const& a1, A2 const& a2, A3 const& a3);
/**
* \brief Constructs a single object of type \a T from region using a quaternary constructor.
*
* The parameters are passed as const references.
*/
template<class T, typename A1, typename A2, typename A3, typename A4>
T& construct(A1 const& a1, A2 const& a2, A3 const& a3, A4 const& a4);
/**
* \brief Constructs a single object of type \a T from region using a quinary constructor.
*
* The parameters are passed as const references.
*/
template<class T, typename A1, typename A2, typename A3, typename A4, typename A5>
T& construct(A1 const& a1, A2 const& a2, A3 const& a3, A4 const& a4, A5 const& a5);
//@}
/// Return memory
~Region(void);
private:
/// Allocate memory from heap (disabled)
static void* operator new(size_t s) throw() { (void) s; return NULL; }
/// Free memory allocated from heap (disabled)
static void operator delete(void* p) { (void) p; };
/// Copy constructor (disabled)
Region(const Region& r) : home(r.home) {}
/// Assignment operator (disabled)
const Region& operator =(const Region&) { return *this; }
};
//@}
/*
* Implementation
*
*/
forceinline
Region::Region(const Space& h)
: home(const_cast<Space&>(h)), free_reset(home.sm->region.free), hi(0) {}
forceinline void*
Region::ralloc(size_t s) {
void* p;
if (home.sm->region_alloc(s,p))
return p;
return heap_alloc(s);
}
forceinline void
Region::rfree(void*, size_t) {}
forceinline
Region::~Region(void) {
home.sm->region.free = free_reset;
if (hi != NULL)
heap_free();
}
/*
* Typed allocation routines
*
*/
template<class T>
forceinline T*
Region::alloc(long unsigned int n) {
T* p = static_cast<T*>(ralloc(sizeof(T)*n));
for (long unsigned int i=n; i--; )
(void) new (p+i) T();
return p;
}
template<class T>
forceinline T*
Region::alloc(long int n) {
assert(n >= 0);
return alloc<T>(static_cast<long unsigned int>(n));
}
template<class T>
forceinline T*
Region::alloc(unsigned int n) {
return alloc<T>(static_cast<long unsigned int>(n));
}
template<class T>
forceinline T*
Region::alloc(int n) {
assert(n >= 0);
return alloc<T>(static_cast<long unsigned int>(n));
}
template<class T>
forceinline void
Region::free(T* b, long unsigned int n) {
for (long unsigned int i=n; i--; )
b[i].~T();
rfree(b,n*sizeof(T));
}
template<class T>
forceinline void
Region::free(T* b, long int n) {
assert(n >= 0);
free<T>(b,static_cast<long unsigned int>(n));
}
template<class T>
forceinline void
Region::free(T* b, unsigned int n) {
free<T>(b,static_cast<long unsigned int>(n));
}
template<class T>
forceinline void
Region::free(T* b, int n) {
assert(n >= 0);
free<T>(b,static_cast<long unsigned int>(n));
}
template<class T>
forceinline T*
Region::realloc(T* b, long unsigned int n, long unsigned int m) {
if (n < m) {
T* p = static_cast<T*>(ralloc(sizeof(T)*m));
for (long unsigned int i=n; i--; )
(void) new (p+i) T(b[i]);
for (long unsigned int i=n; i<m; i++)
(void) new (p+i) T();
free<T>(b,n);
return p;
} else {
free<T>(b+m,m-n);
return b;
}
}
template<class T>
forceinline T*
Region::realloc(T* b, long int n, long int m) {
assert((n >= 0) && (m >= 0));
return realloc<T>(b,static_cast<long unsigned int>(n),
static_cast<long unsigned int>(m));
}
template<class T>
forceinline T*
Region::realloc(T* b, unsigned int n, unsigned int m) {
return realloc<T>(b,static_cast<long unsigned int>(n),
static_cast<long unsigned int>(m));
}
template<class T>
forceinline T*
Region::realloc(T* b, int n, int m) {
assert((n >= 0) && (m >= 0));
return realloc<T>(b,static_cast<long unsigned int>(n),
static_cast<long unsigned int>(m));
}
/*
* Region construction support
*
*/
template<class T>
forceinline T&
Region::construct(void) {
return alloc<T>(1);
}
template<class T, typename A1>
forceinline T&
Region::construct(A1 const& a1) {
T& t = *static_cast<T*>(ralloc(sizeof(T)));
new (&t) T(a1);
return t;
}
template<class T, typename A1, typename A2>
forceinline T&
Region::construct(A1 const& a1, A2 const& a2) {
T& t = *static_cast<T*>(ralloc(sizeof(T)));
new (&t) T(a1,a2);
return t;
}
template<class T, typename A1, typename A2, typename A3>
forceinline T&
Region::construct(A1 const& a1, A2 const& a2, A3 const& a3) {
T& t = *static_cast<T*>(ralloc(sizeof(T)));
new (&t) T(a1,a2,a3);
return t;
}
template<class T, typename A1, typename A2, typename A3, typename A4>
forceinline T&
Region::construct(A1 const& a1, A2 const& a2, A3 const& a3, A4 const& a4) {
T& t = *static_cast<T*>(ralloc(sizeof(T)));
new (&t) T(a1,a2,a3,a4);
return t;
}
template<class T, typename A1, typename A2, typename A3, typename A4, typename A5>
forceinline T&
Region::construct(A1 const& a1, A2 const& a2, A3 const& a3, A4 const& a4, A5 const& a5) {
T& t = *static_cast<T*>(ralloc(sizeof(T)));
new (&t) T(a1,a2,a3,a4,a5);
return t;
}
}
// STATISTICS: kernel-memory
|