diff options
Diffstat (limited to 'src/lib/util/memory_segment_local.h')
-rw-r--r-- | src/lib/util/memory_segment_local.h | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/src/lib/util/memory_segment_local.h b/src/lib/util/memory_segment_local.h new file mode 100644 index 0000000..2c0ee53 --- /dev/null +++ b/src/lib/util/memory_segment_local.h @@ -0,0 +1,100 @@ +// Copyright (C) 2012-2015 Internet Systems Consortium, Inc. ("ISC") +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +#ifndef MEMORY_SEGMENT_LOCAL_H +#define MEMORY_SEGMENT_LOCAL_H + +#include <util/memory_segment.h> + +#include <string> +#include <map> + +namespace isc { +namespace util { + +/// \brief malloc/free based Memory Segment class +/// +/// This class specifies a concrete implementation for a malloc/free +/// based MemorySegment. Please see the MemorySegment class +/// documentation for usage. +class MemorySegmentLocal : public MemorySegment { +public: + /// \brief Constructor + /// + /// Creates a local memory segment object + MemorySegmentLocal() : allocated_size_(0) { + } + + /// \brief Destructor + virtual ~MemorySegmentLocal() {} + + /// \brief Allocate/acquire a segment of memory. The source of the + /// memory is libc's malloc(). + /// + /// Throws <code>std::bad_alloc</code> if the implementation cannot + /// allocate the requested storage. + /// + /// \param size The size of the memory requested in bytes. + /// \return Returns pointer to the memory allocated. + virtual void* allocate(size_t size); + + /// \brief Free/release a segment of memory. + /// + /// This method may throw <code>isc::OutOfRange</code> if \c size is + /// not equal to the originally allocated size. + /// + /// \param ptr Pointer to the block of memory to free/release. This + /// should be equal to a value returned by <code>allocate()</code>. + /// \param size The size of the memory to be freed in bytes. This + /// should be equal to the number of bytes originally allocated. + virtual void deallocate(void* ptr, size_t size); + + /// \brief Check if all allocated memory was deallocated. + /// + /// \return Returns <code>true</code> if all allocated memory was + /// deallocated, <code>false</code> otherwise. + virtual bool allMemoryDeallocated() const; + + /// \brief Local segment version of getNamedAddress. + /// + /// There's a small chance this method could throw std::bad_alloc. + /// It should be considered a fatal error. + virtual NamedAddressResult getNamedAddressImpl(const char* name) const; + + /// \brief Local segment version of setNamedAddress. + /// + /// This version does not validate the given address to see whether it + /// belongs to this segment. + /// + /// This implementation of this method always returns \c false (but the + /// application should expect a return value of \c true unless it knows + /// the memory segment class is \c MemorySegmentLocal and needs to + /// exploit the fact). + virtual bool setNamedAddressImpl(const char* name, void* addr); + + /// \brief Local segment version of clearNamedAddress. + /// + /// There's a small chance this method could throw std::bad_alloc. + /// It should be considered a fatal error. + virtual bool clearNamedAddressImpl(const char* name); + +private: + // allocated_size_ can underflow, wrap around to max size_t (which + // is unsigned). But because we only do a check against 0 and not a + // relation comparison, this is okay. + size_t allocated_size_; + + std::map<std::string, void*> named_addrs_; +}; + +} // namespace util +} // namespace isc + +#endif // MEMORY_SEGMENT_LOCAL_H + +// Local Variables: +// mode: c++ +// End: |