src/Utility.h
author David Anderson <dvander@alliedmods.net>
Sun Jan 06 13:56:56 2013 -0800 (2013-01-06)
changeset 257 9db4cc815ebc
parent 256 3c184218462d
permissions -rw-r--r--
Fix gcc and clang builds.
dvander@49
     1
/* vim: set ts=4 sw=4 tw=99 et:
dvander@49
     2
 *
dvander@28
     3
 * Copyright (C) 2012 David Anderson
dvander@28
     4
 *
dvander@115
     5
 * This file is part of SourcePawn.
dvander@28
     6
 *
dvander@115
     7
 * SourcePawn is free software: you can redistribute it and/or modify it under
dvander@28
     8
 * the terms of the GNU General Public License as published by the Free
dvander@28
     9
 * Software Foundation, either version 3 of the License, or (at your option)
dvander@28
    10
 * any later version.
dvander@28
    11
 * 
dvander@115
    12
 * SourcePawn is distributed in the hope that it will be useful, but WITHOUT ANY
dvander@28
    13
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@28
    14
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
dvander@28
    15
 *
dvander@28
    16
 * You should have received a copy of the GNU General Public License along with
dvander@115
    17
 * SourcePawn. If not, see http://www.gnu.org/licenses/.
dvander@28
    18
 */
dvander@28
    19
#ifndef _include_jitcraft_utility_h_
dvander@28
    20
#define _include_jitcraft_utility_h_
dvander@28
    21
dvander@28
    22
#include <assert.h>
danderson@92
    23
#include <stddef.h>
dvander@251
    24
#include <stdlib.h>
dvander@105
    25
#include "../include/keima_util.h"
dvander@28
    26
#ifdef _MSC_VER
dvander@28
    27
# include <intrin.h>
dvander@28
    28
#endif
dvander@28
    29
dvander@28
    30
#ifdef _MSC_VER
dvander@28
    31
# pragma warning(disable:4355)
dvander@28
    32
#endif
dvander@28
    33
dvander@59
    34
namespace ke {
dvander@28
    35
dvander@28
    36
static const size_t kMallocAlignment = sizeof(void *) * 2;
dvander@28
    37
dvander@28
    38
typedef uint8_t uint8;
dvander@28
    39
typedef int32_t int32;
dvander@28
    40
typedef uint32_t uint32;
dvander@195
    41
typedef int64_t int64;
dvander@195
    42
typedef uint64_t uint64;
dvander@28
    43
dvander@28
    44
typedef uint8 * Address;
dvander@28
    45
dvander@28
    46
static const size_t kKB = 1024;
dvander@28
    47
static const size_t kMB = 1024 * kKB;
dvander@28
    48
static const size_t kGB = 1024 * kMB;
dvander@28
    49
dvander@28
    50
template <typename T>
dvander@251
    51
class AutoFree
dvander@28
    52
{
dvander@28
    53
    T *t_;
dvander@28
    54
dvander@28
    55
  public:
dvander@251
    56
    AutoFree()
dvander@28
    57
      : t_(NULL)
dvander@28
    58
    {
dvander@28
    59
    }
dvander@251
    60
    AutoFree(T *t)
dvander@28
    61
      : t_(t)
dvander@28
    62
    {
dvander@28
    63
    }
dvander@251
    64
    ~AutoFree() {
dvander@251
    65
        free(t_);
dvander@28
    66
    }
dvander@251
    67
    T *take() {
dvander@251
    68
        T *t = t_;
dvander@251
    69
        t_ = NULL;
dvander@251
    70
        return t;
dvander@251
    71
    }
dvander@251
    72
    T *operator *() const {
dvander@28
    73
        return t_;
dvander@28
    74
    }
dvander@28
    75
    void operator =(T *t) {
dvander@28
    76
        if (t_)
dvander@251
    77
            free(t_);
dvander@28
    78
        t_ = t;
dvander@28
    79
    }
dvander@28
    80
};
dvander@28
    81
dvander@54
    82
// Bob Jenkin's one-at-a-time hash function[1].
dvander@54
    83
//
dvander@54
    84
// [1] http://burtleburtle.net/bob/hash/doobs.html
dvander@54
    85
class CharacterStreamHasher
dvander@54
    86
{
dvander@54
    87
    uint32 hash;
dvander@54
    88
dvander@54
    89
  public:
dvander@54
    90
    CharacterStreamHasher()
dvander@54
    91
      : hash(0)
dvander@54
    92
    { }
dvander@54
    93
dvander@54
    94
    void add(char c) {
dvander@54
    95
        hash += c;
dvander@54
    96
        hash += (hash << 10);
dvander@54
    97
        hash ^= (hash >> 6);
dvander@54
    98
    }
dvander@54
    99
dvander@54
   100
    void add(const char *s, size_t length) {
dvander@54
   101
        for (size_t i = 0; i < length; i++)
dvander@54
   102
            add(s[i]);
dvander@54
   103
    }
dvander@54
   104
dvander@54
   105
    uint32 result() {
dvander@54
   106
        hash += (hash << 3);
dvander@54
   107
        hash ^= (hash >> 11);
dvander@54
   108
        hash += (hash << 15);
dvander@54
   109
        return hash;
dvander@54
   110
    }
dvander@54
   111
};
dvander@54
   112
dvander@54
   113
static inline uint32
dvander@54
   114
HashCharSequence(const char *s, size_t length)
dvander@54
   115
{
dvander@54
   116
    CharacterStreamHasher hasher;
dvander@54
   117
    hasher.add(s, length);
dvander@54
   118
    return hasher.result();
dvander@54
   119
}
dvander@54
   120
dvander@195
   121
// From http://burtleburtle.net/bob/hash/integer.html
dvander@195
   122
static inline uint32
dvander@195
   123
HashInt32(int32 a)
dvander@195
   124
{
dvander@251
   125
    a = (a ^ 61) ^ (a >> 16);
dvander@251
   126
    a = a + (a << 3);
dvander@251
   127
    a = a ^ (a >> 4);
dvander@251
   128
    a = a * 0x27d4eb2d;
dvander@251
   129
    a = a ^ (a >> 15);
dvander@195
   130
    return a;
dvander@195
   131
}
dvander@195
   132
dvander@195
   133
// From http://www.cris.com/~Ttwang/tech/inthash.htm
dvander@195
   134
static inline uint32
dvander@195
   135
HashInt64(int64 key)
dvander@195
   136
{
dvander@251
   137
  key = (~key) + (key << 18); // key = (key << 18) - key - 1;
dvander@251
   138
  key = key ^ (uint64(key) >> 31);
dvander@251
   139
  key = key * 21; // key = (key + (key << 2)) + (key << 4);
dvander@251
   140
  key = key ^ (uint64(key) >> 11);
dvander@251
   141
  key = key + (key << 6);
dvander@251
   142
  key = key ^ (uint64(key) >> 22);
dvander@195
   143
  return uint32(key);
dvander@195
   144
}
dvander@195
   145
dvander@195
   146
static inline uint32
dvander@195
   147
HashPointer(void *p)
dvander@195
   148
{
dvander@195
   149
#if defined(KE_32BIT)
dvander@195
   150
    return HashInt32(reinterpret_cast<int32>(p));
dvander@195
   151
#elif defined(KE_64BIT)
dvander@195
   152
    return HashInt64(reinterpret_cast<int64>(p));
dvander@195
   153
#endif
dvander@195
   154
}
dvander@195
   155
dvander@28
   156
static inline size_t
dvander@28
   157
Log2(size_t number)
dvander@28
   158
{
dvander@28
   159
    assert(number != 0);
dvander@28
   160
dvander@53
   161
#ifdef _MSC_VER
dvander@28
   162
    unsigned long rval;
dvander@86
   163
# ifdef _M_IX86
dvander@28
   164
    _BitScanReverse(&rval, number);
dvander@86
   165
# elif _M_X64
dvander@86
   166
    _BitScanReverse64(&rval, number);
dvander@86
   167
# endif
dvander@28
   168
    return rval;
dvander@28
   169
#else
dvander@251
   170
    size_t bit;
dvander@251
   171
    asm("bsr %1, %0\n"
dvander@251
   172
        : "=r" (bit)
dvander@251
   173
        : "rm" (number));
dvander@251
   174
    return bit;
dvander@28
   175
#endif
dvander@28
   176
}
dvander@28
   177
dvander@53
   178
static inline size_t
dvander@53
   179
FindRightmostBit(size_t number)
dvander@53
   180
{
dvander@53
   181
    assert(number != 0);
dvander@53
   182
dvander@53
   183
#ifdef _MSC_VER
dvander@53
   184
    unsigned long rval;
dvander@86
   185
# ifdef _M_IX86
dvander@53
   186
    _BitScanForward(&rval, number);
dvander@86
   187
# elif _M_X64
dvander@86
   188
    _BitScanForward64(&rval, number);
dvander@86
   189
# endif
dvander@53
   190
    return rval;
dvander@53
   191
#else
dvander@251
   192
    size_t bit;
dvander@251
   193
    asm("bsf %1, %0\n"
dvander@251
   194
        : "=r" (bit)
dvander@251
   195
        : "rm" (number));
dvander@251
   196
    return bit;
dvander@53
   197
#endif
dvander@53
   198
}
dvander@53
   199
dvander@28
   200
static inline bool
dvander@28
   201
IsPowerOfTwo(size_t value)
dvander@28
   202
{
dvander@28
   203
    if (value == 0)
dvander@28
   204
        return false;
dvander@28
   205
    return !(value & (value - 1));
dvander@28
   206
}
dvander@28
   207
dvander@28
   208
static inline size_t
dvander@28
   209
Align(size_t count, size_t alignment)
dvander@28
   210
{
dvander@28
   211
    assert(IsPowerOfTwo(alignment));
dvander@28
   212
    return count + (alignment - (count % alignment)) % alignment;
dvander@28
   213
}
dvander@28
   214
dvander@28
   215
static inline bool
dvander@28
   216
IsUint32AddSafe(unsigned a, unsigned b)
dvander@28
   217
{
dvander@55
   218
    if (!a || !b)
dvander@55
   219
        return true;
dvander@86
   220
    size_t log2_a = Log2(a);
dvander@86
   221
    size_t log2_b = Log2(b);
dvander@28
   222
    return (log2_a < sizeof(unsigned) * 8) &&
dvander@28
   223
           (log2_b < sizeof(unsigned) * 8);
dvander@28
   224
}
dvander@28
   225
dvander@28
   226
static inline bool
dvander@55
   227
IsUintPtrAddSafe(size_t a, size_t b)
dvander@55
   228
{
dvander@55
   229
    if (!a || !b)
dvander@55
   230
        return true;
dvander@55
   231
    size_t log2_a = Log2(a);
dvander@55
   232
    size_t log2_b = Log2(b);
dvander@55
   233
    return (log2_a < sizeof(size_t) * 8) &&
dvander@55
   234
           (log2_b < sizeof(size_t) * 8);
dvander@55
   235
}
dvander@55
   236
dvander@55
   237
static inline bool
dvander@28
   238
IsUint32MultiplySafe(unsigned a, unsigned b)
dvander@28
   239
{
dvander@28
   240
    if (a <= 1 || b <= 1)
dvander@28
   241
        return true;
dvander@28
   242
dvander@86
   243
    size_t log2_a = Log2(a);
dvander@86
   244
    size_t log2_b = Log2(b);
dvander@28
   245
    return log2_a + log2_b <= sizeof(unsigned) * 8;
dvander@28
   246
}
dvander@28
   247
dvander@55
   248
static inline bool
dvander@55
   249
IsUintPtrMultiplySafe(size_t a, size_t b)
dvander@55
   250
{
dvander@55
   251
    if (a <= 1 || b <= 1)
dvander@55
   252
        return true;
dvander@55
   253
dvander@55
   254
    size_t log2_a = Log2(a);
dvander@55
   255
    size_t log2_b = Log2(b);
dvander@55
   256
    return log2_a + log2_b <= sizeof(size_t) * 8;
dvander@55
   257
}
dvander@55
   258
dvander@28
   259
#define ARRAY_LENGTH(array) (sizeof(array) / sizeof(array[0]))
dvander@28
   260
#define STATIC_ASSERT(cond) extern int static_assert_f(int a[(cond) ? 1 : -1])
dvander@28
   261
dvander@251
   262
#define IS_ALIGNED(addr, alignment)    (!(uintptr_t(addr) & ((alignment) - 1)))
dvander@49
   263
dvander@11
   264
template <typename T>
dvander@11
   265
static inline bool
dvander@11
   266
IsAligned(T addr, size_t alignment)
dvander@11
   267
{
dvander@11
   268
    assert(IsPowerOfTwo(alignment));
dvander@11
   269
    return !(uintptr_t(addr) & (alignment - 1));
dvander@28
   270
}
dvander@28
   271
dvander@11
   272
static inline Address
dvander@11
   273
AlignedBase(Address addr, size_t alignment)
dvander@11
   274
{
dvander@11
   275
    assert(IsPowerOfTwo(alignment));
dvander@11
   276
    return Address(uintptr_t(addr) & ~(alignment - 1));
dvander@28
   277
}
dvander@28
   278
dvander@28
   279
template <typename T> static inline T
dvander@28
   280
Min(const T &t1, const T &t2)
dvander@28
   281
{
dvander@28
   282
    return t1 < t2 ? t1 : t2;
dvander@28
   283
}
dvander@28
   284
dvander@256
   285
template <typename T> static inline T
dvander@256
   286
Max(const T &t1, const T &t2)
dvander@256
   287
{
dvander@256
   288
    return t1 > t2 ? t1 : t2;
dvander@256
   289
}
dvander@256
   290
danderson@91
   291
#define OFFSETOF(Class, Member) reinterpret_cast<size_t>(&((Class *)NULL)->Member)
danderson@91
   292
dvander@28
   293
}
dvander@28
   294
dvander@28
   295
#endif // _include_jitcraft_utility_h_