cds/details/type_padding.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_DETAILS_TYPE_PADDING_H
  32 #define CDSLIB_DETAILS_TYPE_PADDING_H
  33
  34 namespace cds { namespace details {
  35
  36     //@cond none
  37     template <typename T, int Align, int Modulo>
  38     struct type_padding_helper: public T
  39     {
  40         enum {
  41             value = Modulo
  42         };
  43         char _[Align - Modulo]   ;   // padding
  44
  45         type_padding_helper() CDS_NOEXCEPT_( noexcept( T() ))
  46         {}
  47     };
  48     template <typename T, int Align>
  49     struct type_padding_helper<T, Align, 0>: public T
  50     {
  51         enum {
  52             value = 0
  53         };
  54
  55         type_padding_helper() CDS_NOEXCEPT_( noexcept( T()) )
  56         {}
  57     };
  58     //@endcond
  59
  60     /// Automatic alignment type \p T to \p AlignFactor
  61     /**
  62         The class adds appropriate bytes to type T that the following condition is true:
  63         \code
  64         sizeof( type_padding<T,AlignFactor>::type ) % AlignFactor == 0
  65         \endcode
  66         It is guaranteed that count of padding bytes no more than AlignFactor - 1.
  67
  68         \b Applicability: type \p T must not have constructors another that default ctor.
  69         For example, \p T may be any POD type.
  70     */
  71     template <typename T, int AlignFactor>
  72     class type_padding {
  73     public:
  74         /// Result type
  75         typedef type_padding_helper<T, AlignFactor, sizeof(T) % AlignFactor>    type;
  76
  77         /// Padding constant
  78         enum {
  79             value = type::value
  80         };
  81     };
  82
  83 }}   // namespace cds::details
  84 #endif // #ifndef CDSLIB_DETAILS_TYPE_PADDING_H