lib/libcryptsetup_macros.h

   1 /*
   2  * Definitions of common constant and generic macros of libcryptsetup
   3  *
   4  * Copyright (C) 2009-2023 Red Hat, Inc. All rights reserved.
   5  * Copyright (C) 2009-2023 Milan Broz
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef _LIBCRYPTSETUP_MACROS_H
  23 #define _LIBCRYPTSETUP_MACROS_H
  24
  25 /* to silent gcc -Wcast-qual for const cast */
  26 #define CONST_CAST(x) (x)(uintptr_t)
  27
  28 /* to silent clang -Wcast-align when working with byte arrays */
  29 #define VOIDP_CAST(x) (x)(void*)
  30
  31 #define UNUSED(x) (void)(x)
  32
  33 #ifndef ARRAY_SIZE
  34 # define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
  35 #endif
  36
  37 #define BITFIELD_SIZE(BF_PTR) (sizeof(*(BF_PTR)) * 8)
  38
  39 #define MOVE_REF(x, y) \
  40         do { \
  41                 __typeof__(x) *_px = &(x), *_py = &(y); \
  42                 *_px = *_py; \
  43                 *_py = NULL; \
  44         } while (0)
  45
  46 #define FREE_AND_NULL(x) do { free(x); x = NULL; } while (0)
  47
  48 #define AT_LEAST(a, b) ({ __typeof__(a) __at_least = (a); (__at_least >= (b))?__at_least:(b); })
  49
  50 #define SHIFT_4K          12
  51 #define SECTOR_SHIFT       9
  52 #define SECTOR_SIZE     (1 << SECTOR_SHIFT)
  53 #define MAX_SECTOR_SIZE 4096 /* min page size among all platforms */
  54 #define ROUND_SECTOR(x) (((x) + SECTOR_SIZE - 1) / SECTOR_SIZE)
  55
  56 #define MISALIGNED(a, b)        ((a) & ((b) - 1))
  57 #define MISALIGNED_4K(a)        MISALIGNED((a), 1 << SHIFT_4K)
  58 #define MISALIGNED_512(a)       MISALIGNED((a), 1 << SECTOR_SHIFT)
  59 #define NOTPOW2(a)              MISALIGNED((a), (a))
  60
  61 #define DEFAULT_DISK_ALIGNMENT  1048576 /* 1MiB */
  62 #define DEFAULT_MEM_ALIGNMENT   4096
  63
  64 #define DM_UUID_LEN             129
  65 #define DM_BY_ID_PREFIX         "dm-uuid-"
  66 #define DM_BY_ID_PREFIX_LEN     8
  67 #define DM_UUID_PREFIX          "CRYPT-"
  68 #define DM_UUID_PREFIX_LEN      6
  69
  70 #endif /* _LIBCRYPTSETUP_MACROS_H */