include/ust/kernelcompat.h

   1 /* Copyright (C) 2009  Pierre-Marc Fournier
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  16  */
  17
  18 #ifndef KERNELCOMPAT_H
  19 #define KERNELCOMPAT_H
  20
  21 #include <ust/kcompat/kcompat.h>
  22 #include <urcu/list.h>
  23
  24 /* FIXME: libkcompat must not define arch-specific local ops, as ust *must*
  25  * fallback to the normal atomic ops. Fix things so we don't add them and
  26  * break things accidentally.
  27  */
  28
  29 #define container_of(ptr, type, member) ({                      \
  30         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
  31         (type *)( (char *)__mptr - offsetof(type,member) );})
  32
  33 /* ERROR OPS */
  34 #define MAX_ERRNO       4095
  35
  36 #define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO)
  37
  38 static inline void *ERR_PTR(long error)
  39 {
  40         return (void *) error;
  41 }
  42
  43 static inline long PTR_ERR(const void *ptr)
  44 {
  45         return (long) ptr;
  46 }
  47
  48 static inline long IS_ERR(const void *ptr)
  49 {
  50         return IS_ERR_VALUE((unsigned long)ptr);
  51 }
  52
  53
  54 /* Min / Max */
  55
  56 #define min_t(type, x, y) ({                    \
  57         type __min1 = (x);                      \
  58         type __min2 = (y);                      \
  59         __min1 < __min2 ? __min1: __min2; })
  60
  61 #define max_t(type, x, y) ({                    \
  62         type __max1 = (x);                      \
  63         type __max2 = (y);                      \
  64         __max1 > __max2 ? __max1: __max2; })
  65
  66
  67 /* MUTEXES */
  68
  69 #include <pthread.h>
  70
  71 #define DEFINE_MUTEX(m) pthread_mutex_t (m) = PTHREAD_MUTEX_INITIALIZER;
  72 #define DECLARE_MUTEX(m) extern pthread_mutex_t (m);
  73
  74 #define mutex_lock(m) pthread_mutex_lock(m)
  75
  76 #define mutex_unlock(m) pthread_mutex_unlock(m)
  77
  78
  79 /* MALLOCATION */
  80
  81 #define zmalloc(s) calloc(1, s)
  82
  83 /* ATTRIBUTES */
  84
  85 /* FIXME: define this */
  86 #define ____cacheline_aligned
  87
  88 /* MATH */
  89
  90 #include <ust/processor.h>
  91 static inline unsigned int hweight32(unsigned int w)
  92 {
  93         unsigned int res = w - ((w >> 1) & 0x55555555);
  94         res = (res & 0x33333333) + ((res >> 2) & 0x33333333);
  95         res = (res + (res >> 4)) & 0x0F0F0F0F;
  96         res = res + (res >> 8);
  97         return (res + (res >> 16)) & 0x000000FF;
  98 }
  99
 100 static __inline__ int get_count_order(unsigned int count)
 101 {
 102         int order;
 103
 104         order = fls(count) - 1;
 105         if (count & (count - 1))
 106                 order++;
 107         return order;
 108 }
 109
 110
 111
 112
 113 #include <unistd.h>
 114
 115 #define ALIGN(x,a)              __ALIGN_MASK(x,(typeof(x))(a)-1)
 116 #define __ALIGN_MASK(x,mask)    (((x)+(mask))&~(mask))
 117 #define PAGE_ALIGN(addr) ALIGN(addr, PAGE_SIZE)
 118 #define PAGE_SIZE sysconf(_SC_PAGE_SIZE)
 119 #define PAGE_MASK (~(PAGE_SIZE-1))
 120
 121
 122
 123
 124 /* ARRAYS */
 125
 126 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 127
 128 /* TRACE CLOCK */
 129
 130 /* There are two types of clocks that can be used.
 131    - TSC based clock
 132    - gettimeofday() clock
 133
 134    Microbenchmarks on Linux 2.6.30 on Core2 Duo 3GHz (functions are inlined):
 135      Calls (100000000) to tsc(): 4004035641 cycles or 40 cycles/call
 136      Calls (100000000) to gettimeofday(): 9723158352 cycles or 97 cycles/call
 137
 138    For merging traces with the kernel, a time source compatible with that of
 139    the kernel is necessary.
 140
 141 */
 142
 143 #if 0
 144 /* WARNING: Make sure to set frequency and scaling functions that will not
 145  * result in lttv timestamps (sec.nsec) with seconds greater than 2**32-1.
 146  */
 147 static inline u64 trace_clock_read64(void)
 148 {
 149         uint32_t low;
 150         uint32_t high;
 151         uint64_t retval;
 152         __asm__ volatile ("rdtsc\n" : "=a" (low), "=d" (high));
 153
 154         retval = high;
 155         retval <<= 32;
 156         return retval | low;
 157 }
 158 #endif
 159
 160 #include <sys/time.h>
 161
 162 static inline u64 trace_clock_read64(void)
 163 {
 164         struct timeval tv;
 165         u64 retval;
 166
 167         gettimeofday(&tv, NULL);
 168         retval = tv.tv_sec;
 169         retval *= 1000000;
 170         retval += tv.tv_usec;
 171
 172         return retval;
 173 }
 174
 175 static inline u64 trace_clock_frequency(void)
 176 {
 177         return 1000000LL;
 178 }
 179
 180 static inline u32 trace_clock_freq_scale(void)
 181 {
 182         return 1;
 183 }
 184
 185 #endif /* KERNELCOMPAT_H */