|
| 1 | +// Copyright 2014-2025 Bloomberg Finance L.P. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | +// |
| 4 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +// you may not use this file except in compliance with the License. |
| 6 | +// You may obtain a copy of the License at |
| 7 | +// |
| 8 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +// |
| 10 | +// Unless required by applicable law or agreed to in writing, software |
| 11 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +// See the License for the specific language governing permissions and |
| 14 | +// limitations under the License. |
| 15 | + |
| 16 | +// bmqtst_loggingallocator.h -*-C++-*- |
| 17 | +#ifndef INCLUDED_BMQTST_LOGGINGALLOCATOR |
| 18 | +#define INCLUDED_BMQTST_LOGGINGALLOCATOR |
| 19 | + |
| 20 | +//@PURPOSE: Provide a 'bslma::Allocator' caching allocation stack traces. |
| 21 | +// |
| 22 | +//@CLASSES: |
| 23 | +// bmqtst::LoggingAllocator : allocator adaptor. |
| 24 | +// |
| 25 | +//@DESCRIPTION: This component defines a mechanism, 'bmqtst::LoggingAllocator' |
| 26 | +// which implements the 'bslma::Allocator' protocol and which logs stack traces |
| 27 | +// on any allocation. |
| 28 | + |
| 29 | +// BDE |
| 30 | +#include <bsl_string.h> |
| 31 | +#include <bsl_vector.h> |
| 32 | +#include <bslma_allocator.h> |
| 33 | +#include <bsls_keyword.h> |
| 34 | + |
| 35 | +namespace BloombergLP { |
| 36 | + |
| 37 | +namespace bmqtst { |
| 38 | + |
| 39 | +// ====================== |
| 40 | +// class LoggingAllocator |
| 41 | +// ====================== |
| 42 | + |
| 43 | +/// An allocator caching allocation stack traces. |
| 44 | +class LoggingAllocator BSLS_KEYWORD_FINAL : public bslma::Allocator { |
| 45 | + public: |
| 46 | + // PUBLIC TYPES |
| 47 | + |
| 48 | + /// Alias for a signed integral type capable of representing the number |
| 49 | + /// of bytes in this platform's virtual address space. |
| 50 | + typedef bsls::Types::size_type size_type; |
| 51 | + |
| 52 | + private: |
| 53 | + // DATA |
| 54 | + /// @brief Base allocator to use. |
| 55 | + bslma::Allocator* d_allocator_p; |
| 56 | + |
| 57 | + /// @brief The recorded stack traces. |
| 58 | + bsl::vector<bsl::string> d_stacks; |
| 59 | + |
| 60 | + /// @brief The flag indicaing that the allocator must fail instantly if any |
| 61 | + /// undesired allocation happens. |
| 62 | + bool d_failFast; |
| 63 | + |
| 64 | + private: |
| 65 | + // NOT IMPLEMENTED |
| 66 | + LoggingAllocator(const LoggingAllocator&) BSLS_KEYWORD_DELETED; |
| 67 | + LoggingAllocator& operator=(const LoggingAllocator&) BSLS_KEYWORD_DELETED; |
| 68 | + |
| 69 | + public: |
| 70 | + // CREATORS |
| 71 | + |
| 72 | + /// @brief Construct a logging allocator. |
| 73 | + /// @param failFast The flag indicating whether this allocator must raise |
| 74 | + /// an exception instantly on any undesired allocation. |
| 75 | + /// @param allocator The base allocator to use, or use the default |
| 76 | + /// allocator if this arg is null. |
| 77 | + explicit LoggingAllocator(bool failFast = false, |
| 78 | + bslma::Allocator* allocator = 0); |
| 79 | + |
| 80 | + /// Destroy this object. |
| 81 | + ~LoggingAllocator() BSLS_KEYWORD_OVERRIDE; |
| 82 | + |
| 83 | + // MANIPULATORS |
| 84 | + |
| 85 | + // (virtual bslma::Allocator) |
| 86 | + |
| 87 | + /// @brief Return a newly allocated block of memory. If this allocator |
| 88 | + /// cannot return the requested number of bytes, then it will |
| 89 | + /// throw a `bsl::bad_alloc` exception in an exception-enabled |
| 90 | + /// build, or else will abort the program in a non-exception build. |
| 91 | + /// The behavior is undefined unless `0 <= size`. Note that the |
| 92 | + /// alignment of the address returned conforms to the platform |
| 93 | + /// requirement for any object of the specified `size`. |
| 94 | + /// @param size The minimum size of the newly allocated block (in bytes). |
| 95 | + /// If `size` is 0, a null pointer is returned with no other |
| 96 | + /// effect. |
| 97 | + /// @return The memory address of the allocated block or a null pointer. |
| 98 | + void* allocate(size_type size) BSLS_KEYWORD_OVERRIDE; |
| 99 | + |
| 100 | + /// @brief Return the memory block at the specified `address` back to this |
| 101 | + /// allocator. The behavior is undefined unless `address` was |
| 102 | + /// allocated using this allocator object and has not already been |
| 103 | + /// deallocated. |
| 104 | + /// @param address The address of the memory block to deallocate. If this |
| 105 | + /// argument is a null pointer, the function doesn't have an effect. |
| 106 | + void deallocate(void* address) BSLS_KEYWORD_OVERRIDE; |
| 107 | + |
| 108 | + /// @brief Check whether the undesired allocations were recorded and raise |
| 109 | + /// an exception if any. |
| 110 | + void checkNoAllocations(); |
| 111 | +}; |
| 112 | + |
| 113 | +} // close package namespace |
| 114 | +} // close enterprise namespace |
| 115 | + |
| 116 | +#endif |
0 commit comments