///\file /****************************************************************************** The MIT License(MIT) Embedded Template Library. https://github.com/ETLCPP/etl https://www.etlcpp.com Copyright(c) 2014 John Wellbelove 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 ETL_ALIGNMENT_INCLUDED #define ETL_ALIGNMENT_INCLUDED #include "platform.h" #include "error_handler.h" #include "exception.h" #include "static_assert.h" #include "type_traits.h" #include "utility.h" #include ///\defgroup alignment alignment /// Creates a variable of the specified type at the specified alignment. /// \ingroup utilities namespace etl { //*************************************************************************** /// Exception base for alignment //*************************************************************************** class alignment_exception : public etl::exception { public: alignment_exception(string_type reason_, string_type file_name_, numeric_type line_number_) : exception(reason_, file_name_, line_number_) { } }; //*************************************************************************** /// Memory misalignment exception. //*************************************************************************** class alignment_error : public alignment_exception { public: alignment_error(string_type file_name_, numeric_type line_number_) : alignment_exception(ETL_ERROR_TEXT("alignment:error", ETL_ALIGNMENT_FILE_ID"A"), file_name_, line_number_) { } }; //*************************************************************************** /// Typed storage exception. //*************************************************************************** class typed_storage_error : public alignment_exception { public: typed_storage_error(string_type file_name_, numeric_type line_number_) : alignment_exception(ETL_ERROR_TEXT("typed_storage:error", ETL_ALIGNMENT_FILE_ID"B"), file_name_, line_number_) { } }; //***************************************************************************** /// Check that 'p' has 'required_alignment'. //***************************************************************************** inline bool is_aligned(const void* p, size_t required_alignment) { uintptr_t address = reinterpret_cast(p); return (address % required_alignment) == 0U; } //***************************************************************************** /// Check that 'p' has 'Alignment'. //***************************************************************************** template bool is_aligned(const void* p) { uintptr_t address = reinterpret_cast(p); return (address % Alignment) == 0U; } //***************************************************************************** /// Check that 'p' has the alignment of 'T'. //***************************************************************************** template bool is_aligned(const void* p) { return is_aligned::value>(p); } namespace private_alignment { #if ETL_USING_CPP11 //*************************************************************************** // Matcher. //*************************************************************************** template class type_with_alignment_matcher; // Matching alignment. template class type_with_alignment_matcher { public: typedef T1 type; }; // Non-matching alignment template class type_with_alignment_matcher { public: typedef typename type_with_alignment_matcher< Alignment <= etl::alignment_of::value, Alignment, T2, TRest... >::type type; }; // Non-matching alignment, none left. template class type_with_alignment_matcher { public: typedef char type; }; //*************************************************************************** // Helper. //*************************************************************************** template class type_with_alignment_helper { public: typedef typename type_with_alignment_matcher::value, Alignment, T1, T...>::type type; }; #else //*************************************************************************** // Matcher. //*************************************************************************** template class type_with_alignment_matcher; // Matching alignment. template class type_with_alignment_matcher { public: typedef T1 type; }; // Non-matching alignment. template class type_with_alignment_matcher { public: typedef typename type_with_alignment_matcher< Alignment <= etl::alignment_of::value, Alignment, T2, T3, T4, T5, T6, T7, T8, void>::type type; }; // Non-matching alignment, none left. template class type_with_alignment_matcher { public: typedef char type; }; //*************************************************************************** // Helper. //*************************************************************************** template class type_with_alignment_helper { public: typedef typename type_with_alignment_matcher< Alignment <= etl::alignment_of::value, Alignment, T1, T2, T3, T4, T5, T6, T7, T8>::type type; }; #endif } // namespace private_alignment //*************************************************************************** /// Gets a type that has the same as the specified alignment. ///\ingroup alignment //*************************************************************************** template class type_with_alignment { public: #if ETL_USING_CPP11 typedef struct { alignas(Alignment) char dummy; } type; #else #if ETL_NOT_USING_64BIT_TYPES typedef typename private_alignment::type_with_alignment_helper< Alignment, int_least8_t, int_least16_t, int32_t, float, double, void*>::type type; #else typedef typename private_alignment::type_with_alignment_helper< Alignment, int_least8_t, int_least16_t, int32_t, int64_t, float, double, void*>::type type; #endif #endif ETL_STATIC_ASSERT(etl::alignment_of::value == Alignment, "Unable to create the type with the specified alignment"); }; #if ETL_USING_CPP11 template using type_with_alignment_t = typename type_with_alignment::type; #endif //*************************************************************************** /// Aligned storage /// Length should be determined in terms of sizeof() ///\ingroup alignment //*************************************************************************** template struct aligned_storage { struct type { /// Convert to T reference. template operator T&() { ETL_STATIC_ASSERT((etl::is_same::value || ((Alignment % etl::alignment_of::value) == 0)), "Incompatible alignment"); T* t = *this; return *t; } /// Convert to const T reference. template operator const T&() const { ETL_STATIC_ASSERT((etl::is_same::value || ((Alignment % etl::alignment_of::value) == 0)), "Incompatible alignment"); const T* t = *this; return *t; } /// Convert to T pointer. template operator T*() { ETL_STATIC_ASSERT((etl::is_same::value || ((Alignment % etl::alignment_of::value) == 0)), "Incompatible alignment"); return reinterpret_cast(data); } /// Convert to const T pointer. template operator const T*() const { ETL_STATIC_ASSERT((etl::is_same::value || ((Alignment % etl::alignment_of::value) == 0)), "Incompatible alignment"); return reinterpret_cast(data); } /// Get address as T reference. template T& get_reference() { ETL_STATIC_ASSERT((etl::is_same::value || ((Alignment % etl::alignment_of::value) == 0)), "Incompatible alignment"); T* t = *this; return *t; } /// Get address as const T reference. template const T& get_reference() const { ETL_STATIC_ASSERT((etl::is_same::value || ((Alignment % etl::alignment_of::value) == 0)), "Incompatible alignment"); const T* t = *this; return *t; } /// Get address as T pointer. template T* get_address() { ETL_STATIC_ASSERT((etl::is_same::value || ((Alignment % etl::alignment_of::value) == 0)), "Incompatible alignment"); return reinterpret_cast(data); } /// Get address as const T pointer. template const T* get_address() const { ETL_STATIC_ASSERT((etl::is_same::value || ((Alignment % etl::alignment_of::value) == 0)), "Incompatible alignment"); return reinterpret_cast(data); } #if ETL_USING_CPP11 && !defined(ETL_COMPILER_ARM5) alignas(Alignment) char data[Length]; #else union { char data[Length]; typename etl::type_with_alignment::type etl_alignment_type; // A POD type that has the same alignment // as Alignment. }; #endif }; }; #if ETL_USING_CPP11 template using aligned_storage_t = typename aligned_storage::type; #endif //*************************************************************************** /// Aligned storage as ///\ingroup alignment //*************************************************************************** template struct aligned_storage_as : public etl::aligned_storage::value> { }; #if ETL_USING_CPP11 template using aligned_storage_as_t = typename aligned_storage_as::type; #endif //*************************************************************************** /// Wrapper class that provides a memory area and lets the user create an /// instance of T in this memory at runtime. This class also erases the /// destructor call of T, i.e. if typed_storage goes out of scope, the /// destructor if the wrapped type will not be called. This can be done /// explicitly by calling destroy(). /// \tparam T Type of element stored in this instance of typed_storage. //*************************************************************************** template class typed_storage { public: typedef T value_type; typedef T& reference; typedef const T& const_reference; typedef T* pointer; typedef const T* const_pointer; //*************************************************************************** // Default constructor //*************************************************************************** ETL_CONSTEXPR typed_storage() ETL_NOEXCEPT : valid(false) { } #if ETL_USING_CPP11 //*************************************************************************** /// Constructs the instance of T forwarding the given \p args to its /// constructor. //*************************************************************************** template typed_storage(TArgs&&... args) ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) : valid(false) { create(etl::forward(args)...); } #else //*************************************************************************** /// Constructs the instance of T with type T1 //*************************************************************************** template typed_storage(const T1& t1) : valid(false) { create(t1); } //*************************************************************************** /// Constructs the instance of T with types T1, T2 //*************************************************************************** template typed_storage(const T1& t1, const T2& t2) : valid(false) { create(t1, t2); } //*************************************************************************** /// Constructs the instance of T with types T1, T2, T3 //*************************************************************************** template typed_storage(const T1& t1, const T2& t2, const T3& t3) : valid(false) { create(t1, t2, t3); } //*************************************************************************** /// Constructs the instance of T with types T1, T2, T3, T4 //*************************************************************************** template typed_storage(const T1& t1, const T2& t2, const T3& t3, const T4& t4) : valid(false) { create(t1, t2, t3, t4); } #endif //*************************************************************************** /// Default destructor which will NOT call the destructor of the object /// which was created by calling create(). //*************************************************************************** ~typed_storage() ETL_NOEXCEPT { // Intentionally empty. } //*************************************************************************** /// \returns true if object has been constructed using create(). /// \returns false otherwise. //*************************************************************************** bool has_value() const ETL_NOEXCEPT { return valid; } #if ETL_USING_CPP11 //*************************************************************************** /// Constructs the instance of T forwarding the given \p args to its /// constructor. \returns the instance of T which has been constructed in /// the internal byte array. //*************************************************************************** template reference create(TArgs&&... args) ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (&storage.value) value_type(etl::forward(args)...); valid = true; return *p; } #else //*************************************************************************** /// Constructs the instance of T with type T1 /// \returns the instance of T which has been constructed in the internal /// byte array. //*************************************************************************** template reference create(const T1& t1) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (&storage.value) value_type(t1); valid = true; return *p; } //*************************************************************************** /// Constructs the instance of T with types T1, T2 /// \returns the instance of T which has been constructed in the internal /// byte array. //*************************************************************************** template reference create(const T1& t1, const T2& t2) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (&storage.value) value_type(t1, t2); valid = true; return *p; } //*************************************************************************** /// Constructs the instance of T with types T1, T2, T3 /// \returns the instance of T which has been constructed in the internal /// byte array. //*************************************************************************** template reference create(const T1& t1, const T2& t2, const T3& t3) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (&storage.value) value_type(t1, t2, t3); valid = true; return *p; } //*************************************************************************** /// Constructs the instance of T with types T1, T2, T3, T4 /// \returns the instance of T which has been constructed in the internal /// byte array. //*************************************************************************** template reference create(const T1& t1, const T2& t2, const T3& t3, const T4& t4) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (&storage.value) value_type(t1, t2, t3, t4); valid = true; return *p; } #endif //*************************************************************************** /// Calls the destructor of the stored object, if created. //*************************************************************************** void destroy() ETL_NOEXCEPT { if (has_value()) { storage.value.~T(); valid = false; } } //*************************************************************************** /// \returns a pointer of type T and asserts if has_value() is false. //*************************************************************************** pointer operator->() ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { ETL_ASSERT(has_value(), ETL_ERROR(etl::typed_storage_error)); return &storage.value; } //*************************************************************************** /// \returns a const pointer of type T and asserts if has_value() is false. //*************************************************************************** const_pointer operator->() const ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { ETL_ASSERT(has_value(), ETL_ERROR(etl::typed_storage_error)); return &storage.value; } //*************************************************************************** /// \returns reference of type T and asserts if has_value() is false. //*************************************************************************** reference operator*() ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { return *operator->(); } //*************************************************************************** /// \returns const_reference of type T and asserts if has_value() is false. //*************************************************************************** const_reference operator*() const ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { return *operator->(); } private: typed_storage(etl::typed_storage&) ETL_DELETE; typed_storage& operator=(etl::typed_storage&) ETL_DELETE; struct dummy_t { }; //******************************* union union_type { ETL_CONSTEXPR union_type() ETL_NOEXCEPT : dummy() { } ~union_type() ETL_NOEXCEPT {} dummy_t dummy; value_type value; } storage; bool valid; }; //*************************************************************************** /// Wrapper class wraps a supplied memory area and lets the user create an /// instance of T in this memory at runtime. This class also erases the /// destructor call of T, i.e. if typed_storage goes out of scope, the /// destructor if the wrapped type will not be called. This can be done /// explicitly by calling destroy(). /// \tparam T Type of element stored in this instance of typed_storage. //*************************************************************************** template class typed_storage_ext { public: typedef T value_type; typedef T& reference; typedef const T& const_reference; typedef T* pointer; typedef const T* const_pointer; template friend ETL_CONSTEXPR14 void swap(typed_storage_ext& lhs, typed_storage_ext& rhs) ETL_NOEXCEPT; //*************************************************************************** /// Constructor. //*************************************************************************** typed_storage_ext(void* pbuffer_) ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) : pbuffer(reinterpret_cast(pbuffer_)) , valid(false) { ETL_ASSERT(etl::is_aligned(pbuffer_, etl::alignment_of::value), ETL_ERROR(etl::alignment_error)); } #if ETL_USING_CPP11 //*************************************************************************** /// Constructs the instance of T forwarding the given \p args to its /// constructor. //*************************************************************************** template typed_storage_ext(void* pbuffer_, TArgs&&... args) ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) : pbuffer(reinterpret_cast(pbuffer_)) , valid(false) { ETL_ASSERT(etl::is_aligned(pbuffer_, etl::alignment_of::value), ETL_ERROR(etl::alignment_error)); create(etl::forward(args)...); } //*************************************************************************** /// Move constructor. /// Transfers ownership of the buffer from \p other to this. //*************************************************************************** typed_storage_ext(typed_storage_ext&& other) ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) : pbuffer(other.pbuffer) , valid(other.valid) { other.pbuffer = ETL_NULLPTR; other.valid = false; } #else //*************************************************************************** /// Constructs the instance of T with type T1 //*************************************************************************** template typed_storage_ext(void* pbuffer_, const T1& t1) : pbuffer(reinterpret_cast(pbuffer_)) , valid(false) { ETL_ASSERT(etl::is_aligned(pbuffer_, etl::alignment_of::value), ETL_ERROR(etl::alignment_error)); create(t1); } //*************************************************************************** /// Constructs the instance of T with types T1, T2 //*************************************************************************** template typed_storage_ext(void* pbuffer_, const T1& t1, const T2& t2) : pbuffer(reinterpret_cast(pbuffer_)) , valid(false) { ETL_ASSERT(etl::is_aligned(pbuffer_, etl::alignment_of::value), ETL_ERROR(etl::alignment_error)); create(t1, t2); } //*************************************************************************** /// Constructs the instance of T with types T1, T2, T3 //*************************************************************************** template typed_storage_ext(void* pbuffer_, const T1& t1, const T2& t2, const T3& t3) : pbuffer(reinterpret_cast(pbuffer_)) , valid(false) { ETL_ASSERT(etl::is_aligned(pbuffer_, etl::alignment_of::value), ETL_ERROR(etl::alignment_error)); create(t1, t2, t3); } //*************************************************************************** /// Constructs the instance of T with types T1, T2, T3, T4 //*************************************************************************** template typed_storage_ext(void* pbuffer_, const T1& t1, const T2& t2, const T3& t3, const T4& t4) : pbuffer(reinterpret_cast(pbuffer_)) , valid(false) { ETL_ASSERT(etl::is_aligned(pbuffer_, etl::alignment_of::value), ETL_ERROR(etl::alignment_error)); create(t1, t2, t3, t4); } #endif //*************************************************************************** /// Default destructor which will NOT call the destructor of the object /// which was created by calling create(). //*************************************************************************** ~typed_storage_ext() ETL_NOEXCEPT { // Intentionally empty. } //*************************************************************************** /// \returns true if object has been constructed using create(). /// \returns false otherwise. //*************************************************************************** bool has_value() const ETL_NOEXCEPT { return valid; } #if ETL_USING_CPP11 //*************************************************************************** /// Constructs the instance of T forwarding the given \p args to its /// constructor. \returns the instance of T which has been constructed in /// the external buffer. //*************************************************************************** template reference create(TArgs&&... args) ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (pbuffer) value_type(etl::forward(args)...); valid = true; return *p; } #else //*************************************************************************** /// Constructs the instance of T with type T1 /// \returns the instance of T which has been constructed in the external /// buffer. //*************************************************************************** template reference create(const T1& t1) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (pbuffer) value_type(t1); valid = true; return *p; } //*************************************************************************** /// Constructs the instance of T with types T1, T2 /// \returns the instance of T which has been constructed in the external /// buffer. //*************************************************************************** template reference create(const T1& t1, const T2& t2) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (pbuffer) value_type(t1, t2); valid = true; return *p; } //*************************************************************************** /// Constructs the instance of T with types T1, T2, T3 /// \returns the instance of T which has been constructed in the external /// buffer. //*************************************************************************** template reference create(const T1& t1, const T2& t2, const T3& t3) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (pbuffer) value_type(t1, t2, t3); valid = true; return *p; } //*************************************************************************** /// Constructs the instance of T with types T1, T2, T3, T4 /// \returns the instance of T which has been constructed in the external /// buffer. //*************************************************************************** template reference create(const T1& t1, const T2& t2, const T3& t3, const T4& t4) { ETL_ASSERT(!has_value(), ETL_ERROR(etl::typed_storage_error)); pointer p = ::new (pbuffer) value_type(t1, t2, t3, t4); valid = true; return *p; } #endif //*************************************************************************** /// Calls the destructor of the stored object, if created. //*************************************************************************** void destroy() ETL_NOEXCEPT { if (has_value()) { pbuffer->~T(); valid = false; } } //*************************************************************************** /// \returns a pointer of type T and asserts if has_value() is false. //*************************************************************************** pointer operator->() ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { ETL_ASSERT(has_value(), ETL_ERROR(etl::typed_storage_error)); return pbuffer; } //*************************************************************************** /// \returns a const pointer of type T and asserts if has_value() is false. //*************************************************************************** const_pointer operator->() const ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { ETL_ASSERT(has_value(), ETL_ERROR(etl::typed_storage_error)); return pbuffer; } //*************************************************************************** /// \returns reference of type T and asserts if has_value() is false. //*************************************************************************** reference operator*() ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { return *operator->(); } //*************************************************************************** /// \returns const_reference of type T and asserts if has_value() is false. //*************************************************************************** const_reference operator*() const ETL_NOEXCEPT_EXPR(ETL_NOT_USING_EXCEPTIONS) { return *operator->(); } private: typed_storage_ext(etl::typed_storage_ext&) ETL_DELETE; typed_storage_ext& operator=(etl::typed_storage_ext&) ETL_DELETE; pointer pbuffer; bool valid; }; //*************************************************************************** /// Swap two etl::typed_storage_ext //*************************************************************************** template ETL_CONSTEXPR14 void swap(etl::typed_storage_ext& lhs, etl::typed_storage_ext& rhs) ETL_NOEXCEPT { using ETL_OR_STD::swap; swap(lhs.pbuffer, rhs.pbuffer); swap(lhs.valid, rhs.valid); } } // namespace etl #endif