include/lttng/align.h

   1 #ifndef _UST_ALIGN_H
   2 #define _UST_ALIGN_H
   3
   4 /*
   5  * lttng/align.h
   6  *
   7  * (C) Copyright 2010-2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  */
  27
  28 #include <lttng/bug.h>
  29 #include <unistd.h>
  30 #include <limits.h>
  31
  32 #ifndef PAGE_SIZE       /* Cygwin limits.h defines its own PAGE_SIZE */
  33 #define PAGE_SIZE               sysconf(_SC_PAGE_SIZE)
  34 #endif
  35
  36 #ifndef PAGE_MASK       /* FreeBSD and macOS defines their own PAGE_MASK. */
  37 #define PAGE_MASK               (~(PAGE_SIZE - 1))
  38 #endif
  39 #define __ALIGN_MASK(v, mask)   (((v) + (mask)) & ~(mask))
  40 #ifndef ALIGN           /* FreeBSD and macOS defines their own ALIGN. */
  41 #define ALIGN(v, align)         __ALIGN_MASK(v, (__typeof__(v)) (align) - 1)
  42 #endif
  43 #define PAGE_ALIGN(addr)        ALIGN(addr, PAGE_SIZE)
  44
  45 /**
  46  * offset_align - Calculate the offset needed to align an object on its natural
  47  *                alignment towards higher addresses.
  48  * @align_drift:  object offset from an "alignment"-aligned address.
  49  * @alignment:    natural object alignment. Must be non-zero, power of 2.
  50  *
  51  * Returns the offset that must be added to align towards higher
  52  * addresses.
  53  */
  54 #define offset_align(align_drift, alignment)                                   \
  55         ({                                                                     \
  56                 LTTNG_BUILD_RUNTIME_BUG_ON((alignment) == 0                    \
  57                                    || ((alignment) & ((alignment) - 1)));      \
  58                 (((alignment) - (align_drift)) & ((alignment) - 1));           \
  59         })
  60
  61 /**
  62  * offset_align_floor - Calculate the offset needed to align an object
  63  *                      on its natural alignment towards lower addresses.
  64  * @align_drift:  object offset from an "alignment"-aligned address.
  65  * @alignment:    natural object alignment. Must be non-zero, power of 2.
  66  *
  67  * Returns the offset that must be substracted to align towards lower addresses.
  68  */
  69 #define offset_align_floor(align_drift, alignment)                             \
  70         ({                                                                     \
  71                 LTTNG_BUILD_RUNTIME_BUG_ON((alignment) == 0                    \
  72                                    || ((alignment) & ((alignment) - 1)));      \
  73                 (((align_drift) - (alignment)) & ((alignment) - 1));           \
  74         })
  75
  76 #endif /* _UST_ALIGN_H */