include/sys/sysmacros.h

   1 /*****************************************************************************\
   2  *  Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
   3  *  Copyright (C) 2007 The Regents of the University of California.
   4  *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
   5  *  Written by Brian Behlendorf <behlendorf1@llnl.gov>.
   6  *  UCRL-CODE-235197
   7  *
   8  *  This file is part of the SPL, Solaris Porting Layer.
   9  *  For details, see <http://zfsonlinux.org/>.
  10  *
  11  *  The SPL is free software; you can redistribute it and/or modify it
  12  *  under the terms of the GNU General Public License as published by the
  13  *  Free Software Foundation; either version 2 of the License, or (at your
  14  *  option) any later version.
  15  *
  16  *  The SPL is distributed in the hope that it will be useful, but WITHOUT
  17  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19  *  for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License along
  22  *  with the SPL.  If not, see <http://www.gnu.org/licenses/>.
  23 \*****************************************************************************/
  24
  25 #ifndef _SPL_SYSMACROS_H
  26 #define _SPL_SYSMACROS_H
  27
  28 #include <linux/module.h>
  29 #include <linux/sched.h>
  30 #include <linux/cpumask.h>
  31 #include <sys/debug.h>
  32 #include <sys/varargs.h>
  33 #include <sys/zone.h>
  34 #include <sys/signal.h>
  35
  36 #ifdef HAVE_SCHED_RT_HEADER
  37 #include <linux/sched/rt.h>
  38 #endif
  39
  40 #ifndef _KERNEL
  41 #define _KERNEL                         __KERNEL__
  42 #endif
  43
  44 #define FALSE                           0
  45 #define TRUE                            1
  46
  47 #define INT8_MAX                        (127)
  48 #define INT8_MIN                        (-128)
  49 #define UINT8_MAX                       (255)
  50 #define UINT8_MIN                       (0)
  51
  52 #define INT16_MAX                       (32767)
  53 #define INT16_MIN                       (-32768)
  54 #define UINT16_MAX                      (65535)
  55 #define UINT16_MIN                      (0)
  56
  57 #define INT32_MAX                       INT_MAX
  58 #define INT32_MIN                       INT_MIN
  59 #define UINT32_MAX                      UINT_MAX
  60 #define UINT32_MIN                      UINT_MIN
  61
  62 #define INT64_MAX                       LLONG_MAX
  63 #define INT64_MIN                       LLONG_MIN
  64 #define UINT64_MAX                      ULLONG_MAX
  65 #define UINT64_MIN                      ULLONG_MIN
  66
  67 #define NBBY                            8
  68 #define ENOTSUP                         EOPNOTSUPP
  69
  70 #define MAXMSGLEN                       256
  71 #define MAXNAMELEN                      256
  72 #define MAXPATHLEN                      PATH_MAX
  73 #define MAXOFFSET_T                     LLONG_MAX
  74 #define MAXBSIZE                        8192
  75 #define DEV_BSIZE                       512
  76 #define DEV_BSHIFT                      9 /* log2(DEV_BSIZE) */
  77
  78 #define proc_pageout                    NULL
  79 #define curproc                         current
  80 #define max_ncpus                       num_possible_cpus()
  81 #define boot_ncpus                      num_online_cpus()
  82 #define CPU_SEQID                       smp_processor_id()
  83 #define _NOTE(x)
  84 #define is_system_labeled()             0
  85
  86 #ifndef RLIM64_INFINITY
  87 #define RLIM64_INFINITY                 (~0ULL)
  88 #endif
  89
  90 /* 0..MAX_PRIO-1:               Process priority
  91  * 0..MAX_RT_PRIO-1:            RT priority tasks
  92  * MAX_RT_PRIO..MAX_PRIO-1:     SCHED_NORMAL tasks
  93  *
  94  * Treat shim tasks as SCHED_NORMAL tasks
  95  */
  96 #define minclsyspri                     (MAX_PRIO-1)
  97 #define maxclsyspri                     (MAX_RT_PRIO)
  98 #define defclsyspri                     (DEFAULT_PRIO)
  99
 100 #ifndef NICE_TO_PRIO
 101 #define NICE_TO_PRIO(nice)              (MAX_RT_PRIO + (nice) + 20)
 102 #endif
 103 #ifndef PRIO_TO_NICE
 104 #define PRIO_TO_NICE(prio)              ((prio) - MAX_RT_PRIO - 20)
 105 #endif
 106
 107 /*
 108  * Missing macros
 109  */
 110 #ifndef PAGESIZE
 111 #define PAGESIZE                        PAGE_SIZE
 112 #endif
 113
 114 /* from Solaris sys/byteorder.h */
 115 #define BSWAP_8(x)      ((x) & 0xff)
 116 #define BSWAP_16(x)     ((BSWAP_8(x) << 8) | BSWAP_8((x) >> 8))
 117 #define BSWAP_32(x)     ((BSWAP_16(x) << 16) | BSWAP_16((x) >> 16))
 118 #define BSWAP_64(x)     ((BSWAP_32(x) << 32) | BSWAP_32((x) >> 32))
 119
 120 /* Map some simple functions.
 121  */
 122 #define bzero(ptr,size)                 memset(ptr,0,size)
 123 #define bcopy(src,dest,size)            memmove(dest,src,size)
 124 #define bcmp(src,dest,size)             memcmp((src), (dest), (size_t)(size))
 125
 126 /* Dtrace probes do not exist in the linux kernel */
 127 #ifdef DTRACE_PROBE
 128 #undef  DTRACE_PROBE
 129 #endif  /* DTRACE_PROBE */
 130 #define DTRACE_PROBE(a)                                 ((void)0)
 131
 132 #ifdef DTRACE_PROBE1
 133 #undef  DTRACE_PROBE1
 134 #endif  /* DTRACE_PROBE1 */
 135 #define DTRACE_PROBE1(a, b, c)                          ((void)0)
 136
 137 #ifdef DTRACE_PROBE2
 138 #undef  DTRACE_PROBE2
 139 #endif  /* DTRACE_PROBE2 */
 140 #define DTRACE_PROBE2(a, b, c, d, e)                    ((void)0)
 141
 142 #ifdef DTRACE_PROBE3
 143 #undef  DTRACE_PROBE3
 144 #endif  /* DTRACE_PROBE3 */
 145 #define DTRACE_PROBE3(a, b, c, d, e, f, g)              ((void)0)
 146
 147 #ifdef DTRACE_PROBE4
 148 #undef  DTRACE_PROBE4
 149 #endif  /* DTRACE_PROBE4 */
 150 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i)        ((void)0)
 151
 152 /* Missing globals */
 153 extern char spl_version[32];
 154 extern unsigned long spl_hostid;
 155
 156 /* Missing misc functions */
 157 extern uint32_t zone_get_hostid(void *zone);
 158 extern void spl_setup(void);
 159 extern void spl_cleanup(void);
 160
 161 #define highbit(x)              __fls(x)
 162 #define lowbit(x)               __ffs(x)
 163
 164 #define highbit64(x)            fls64(x)
 165 #define makedevice(maj,min)     makedev(maj,min)
 166
 167 /* common macros */
 168 #ifndef MIN
 169 #define MIN(a, b)               ((a) < (b) ? (a) : (b))
 170 #endif
 171 #ifndef MAX
 172 #define MAX(a, b)               ((a) < (b) ? (b) : (a))
 173 #endif
 174 #ifndef ABS
 175 #define ABS(a)                  ((a) < 0 ? -(a) : (a))
 176 #endif
 177 #ifndef DIV_ROUND_UP
 178 #define DIV_ROUND_UP(n,d)       (((n) + (d) - 1) / (d))
 179 #endif
 180 #ifndef roundup
 181 #define roundup(x, y)           ((((x) + ((y) - 1)) / (y)) * (y))
 182 #endif
 183 #ifndef howmany
 184 #define howmany(x, y)           (((x) + ((y) - 1)) / (y))
 185 #endif
 186
 187 /*
 188  * Compatibility macros/typedefs needed for Solaris -> Linux port
 189  */
 190 #define P2ALIGN(x, align)       ((x) & -(align))
 191 #define P2CROSS(x, y, align)    (((x) ^ (y)) > (align) - 1)
 192 #define P2ROUNDUP(x, align)     ((((x) - 1) | ((align) - 1)) + 1)
 193 #define P2PHASE(x, align)       ((x) & ((align) - 1))
 194 #define P2NPHASE(x, align)      (-(x) & ((align) - 1))
 195 #define ISP2(x)                 (((x) & ((x) - 1)) == 0)
 196 #define IS_P2ALIGNED(v, a)      ((((uintptr_t)(v)) & ((uintptr_t)(a) - 1))==0)
 197 #define P2BOUNDARY(off, len, align) \
 198                                 (((off) ^ ((off) + (len) - 1)) > (align) - 1)
 199
 200 /*
 201  * Typed version of the P2* macros.  These macros should be used to ensure
 202  * that the result is correctly calculated based on the data type of (x),
 203  * which is passed in as the last argument, regardless of the data
 204  * type of the alignment.  For example, if (x) is of type uint64_t,
 205  * and we want to round it up to a page boundary using "PAGESIZE" as
 206  * the alignment, we can do either
 207  *
 208  * P2ROUNDUP(x, (uint64_t)PAGESIZE)
 209  * or
 210  * P2ROUNDUP_TYPED(x, PAGESIZE, uint64_t)
 211  */
 212 #define P2ALIGN_TYPED(x, align, type)   \
 213         ((type)(x) & -(type)(align))
 214 #define P2PHASE_TYPED(x, align, type)   \
 215         ((type)(x) & ((type)(align) - 1))
 216 #define P2NPHASE_TYPED(x, align, type)  \
 217         (-(type)(x) & ((type)(align) - 1))
 218 #define P2ROUNDUP_TYPED(x, align, type) \
 219         ((((type)(x) - 1) | ((type)(align) - 1)) + 1)
 220 #define P2END_TYPED(x, align, type)     \
 221         (-(~(type)(x) & -(type)(align)))
 222 #define P2PHASEUP_TYPED(x, align, phase, type)  \
 223         ((type)(phase) - (((type)(phase) - (type)(x)) & -(type)(align)))
 224 #define P2CROSS_TYPED(x, y, align, type)        \
 225         (((type)(x) ^ (type)(y)) > (type)(align) - 1)
 226 #define P2SAMEHIGHBIT_TYPED(x, y, type) \
 227         (((type)(x) ^ (type)(y)) < ((type)(x) & (type)(y)))
 228
 229 #if defined(_KERNEL) && !defined(_KMEMUSER) && !defined(offsetof)
 230
 231 /* avoid any possibility of clashing with <stddef.h> version */
 232
 233 #define offsetof(s, m)  ((size_t)(&(((s *)0)->m)))
 234 #endif
 235
 236 #endif  /* _SPL_SYSMACROS_H */