Move to kernel style SPDX license identifiers

[lttng-ust.git] / include / lttng / align.h

diff --git a/include/lttng/align.h b/include/lttng/align.h
index 0a5363ea3e7161897465b469c52617f32dd2adc7..e46c03015b39aa712024d45111ef93d44d8278b8 100644 (file)
--- a/include/lttng/align.h
+++ b/include/lttng/align.h
@@ -1,59 +1,95 @@
-#ifndef _UST_ALIGN_H
-#define _UST_ALIGN_H
-
 /*
- * lttng/align.h
- *
- * (C) Copyright 2010-2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
- * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
- * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
+ * SPDX-License-Identifier: MIT
  *
- * Permission is hereby granted to use or copy this program
- * for any purpose,  provided the above notices are retained on all copies.
- * Permission to modify the code and to distribute modified code is granted,
- * provided the above notices are retained, and a notice that the code was
- * modified is included with the above copyright notice.
+ * Copyright (C) 2010-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  */
 
+#ifndef _UST_ALIGN_H
+#define _UST_ALIGN_H
+
 #include <lttng/bug.h>
 #include <unistd.h>
+#include <limits.h>
+
+#ifdef __FreeBSD__
+#include <machine/param.h>
+#endif
+
+#ifdef _SC_PAGE_SIZE
+#define LTTNG_UST_PAGE_SIZE    sysconf(_SC_PAGE_SIZE)
+#elif defined(PAGE_SIZE)
+#define LTTNG_UST_PAGE_SIZE    PAGE_SIZE
+#else
+#error "Please add page size detection for your OS."
+#endif
 
-#define PAGE_SIZE              sysconf(_SC_PAGE_SIZE)
-#define PAGE_MASK              (~(PAGE_SIZE - 1))
-#define __ALIGN_MASK(v, mask)  (((v) + (mask)) & ~(mask))
-#define ALIGN(v, align)                __ALIGN_MASK(v, (typeof(v)) (align) - 1)
-#define PAGE_ALIGN(addr)       ALIGN(addr, PAGE_SIZE)
+#define LTTNG_UST_PAGE_MASK    (~(LTTNG_UST_PAGE_SIZE - 1))
+
+#define __LTTNG_UST_ALIGN_MASK(v, mask)        (((v) + (mask)) & ~(mask))
+#define LTTNG_UST_ALIGN(v, align)      __LTTNG_UST_ALIGN_MASK(v, (__typeof__(v)) (align) - 1)
+#define LTTNG_UST_PAGE_ALIGN(addr)     LTTNG_UST_ALIGN(addr, LTTNG_UST_PAGE_SIZE)
 
 /**
- * offset_align - Calculate the offset needed to align an object on its natural
- *                alignment towards higher addresses.
+ * lttng_ust_offset_align - Calculate the offset needed to align an object on
+ *                its natural alignment towards higher addresses.
  * @align_drift:  object offset from an "alignment"-aligned address.
  * @alignment:    natural object alignment. Must be non-zero, power of 2.
  *
  * Returns the offset that must be added to align towards higher
  * addresses.
  */
-#define offset_align(align_drift, alignment)                                  \
+#define lttng_ust_offset_align(align_drift, alignment)                        \
        ({                                                                     \
-               BUILD_RUNTIME_BUG_ON((alignment) == 0                          \
+               LTTNG_BUILD_RUNTIME_BUG_ON((alignment) == 0                    \
                                   || ((alignment) & ((alignment) - 1)));      \
                (((alignment) - (align_drift)) & ((alignment) - 1));           \
        })
 
 /**
- * offset_align_floor - Calculate the offset needed to align an object
- *                      on its natural alignment towards lower addresses.
+ * lttng_ust_offset_align_floor - Calculate the offset needed to align an
+ *                object on its natural alignment towards lower addresses.
  * @align_drift:  object offset from an "alignment"-aligned address.
  * @alignment:    natural object alignment. Must be non-zero, power of 2.
  *
  * Returns the offset that must be substracted to align towards lower addresses.
  */
-#define offset_align_floor(align_drift, alignment)                            \
+#define lttng_ust_offset_align_floor(align_drift, alignment)                  \
        ({                                                                     \
-               BUILD_RUNTIME_BUG_ON((alignment) == 0                          \
+               LTTNG_BUILD_RUNTIME_BUG_ON((alignment) == 0                    \
                                   || ((alignment) & ((alignment) - 1)));      \
-               (((align_drift) - (alignment)) & ((alignment) - 1);            \
+               (((align_drift) - (alignment)) & ((alignment) - 1));           \
        })
 
+/*
+ * Non-namespaced defines for backwards compatibility,
+ * introduced in 2.13, should be removed in the future.
+ */
+
+/* Cygwin limits.h defines its own PAGE_SIZE */
+#ifndef PAGE_SIZE
+#define PAGE_SIZE      LTTNG_UST_PAGE_SIZE
+#endif
+
+/* FreeBSD and macOS defines their own PAGE_MASK. */
+#ifndef PAGE_MASK
+#define PAGE_MASK      LTTNG_UST_PAGE_MASK
+#endif
+
+/* FreeBSD machine/param.h defines its own ALIGN */
+#ifndef ALIGN
+#define ALIGN          LTTNG_UST_ALIGN
+#endif
+
+#ifndef PAGE_ALIGN
+#define PAGE_ALIGN     LTTNG_UST_PAGE_ALIGN
+#endif
+
+#ifndef offset_align
+#define offset_align lttng_ust_offset_align
+#endif
+
+#ifndef offset_align_floor
+#define offset_align_floor lttng_ust_offset_align_floor
+#endif
+
 #endif /* _UST_ALIGN_H */