src/Utility.h
author David Anderson <dvander@alliedmods.net>
Sun Sep 16 23:15:13 2012 -0700 (2012-09-16)
changeset 192 23a804fa1d3e
parent 115 133bf2d87aa9
child 195 c1ba166f3fc4
permissions -rw-r--r--
Allow structs to contain arrays.
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@105
    24
#include "../include/keima_util.h"
dvander@28
    25
#ifdef _MSC_VER
dvander@28
    26
# include <intrin.h>
dvander@28
    27
#endif
dvander@28
    28
dvander@28
    29
#ifdef _MSC_VER
dvander@28
    30
# pragma warning(disable:4355)
dvander@28
    31
#endif
dvander@28
    32
dvander@59
    33
namespace ke {
dvander@28
    34
dvander@28
    35
static const size_t kMallocAlignment = sizeof(void *) * 2;
dvander@28
    36
dvander@28
    37
typedef uint8_t uint8;
dvander@28
    38
typedef int32_t int32;
dvander@28
    39
typedef uint32_t uint32;
dvander@28
    40
dvander@28
    41
typedef uint8 * Address;
dvander@28
    42
dvander@28
    43
static const size_t kKB = 1024;
dvander@28
    44
static const size_t kMB = 1024 * kKB;
dvander@28
    45
static const size_t kGB = 1024 * kMB;
dvander@28
    46
dvander@28
    47
template <typename T>
dvander@28
    48
class AutoVec
dvander@28
    49
{
dvander@28
    50
    T *t_;
dvander@28
    51
dvander@28
    52
  public:
dvander@28
    53
    AutoVec()
dvander@28
    54
      : t_(NULL)
dvander@28
    55
    {
dvander@28
    56
    }
dvander@28
    57
    AutoVec(T *t)
dvander@28
    58
      : t_(t)
dvander@28
    59
    {
dvander@28
    60
    }
dvander@28
    61
    ~AutoVec() {
dvander@28
    62
        delete [] t_;
dvander@28
    63
    }
dvander@28
    64
    operator T *() {
dvander@28
    65
        return t_;
dvander@28
    66
    }
dvander@28
    67
    void operator =(T *t) {
dvander@28
    68
        if (t_)
dvander@28
    69
            delete [] t_;
dvander@28
    70
        t_ = t;
dvander@28
    71
    }
dvander@28
    72
};
dvander@28
    73
dvander@54
    74
// Bob Jenkin's one-at-a-time hash function[1].
dvander@54
    75
//
dvander@54
    76
// [1] http://burtleburtle.net/bob/hash/doobs.html
dvander@54
    77
class CharacterStreamHasher
dvander@54
    78
{
dvander@54
    79
    uint32 hash;
dvander@54
    80
dvander@54
    81
  public:
dvander@54
    82
    CharacterStreamHasher()
dvander@54
    83
      : hash(0)
dvander@54
    84
    { }
dvander@54
    85
dvander@54
    86
    void add(char c) {
dvander@54
    87
        hash += c;
dvander@54
    88
        hash += (hash << 10);
dvander@54
    89
        hash ^= (hash >> 6);
dvander@54
    90
    }
dvander@54
    91
dvander@54
    92
    void add(const char *s, size_t length) {
dvander@54
    93
        for (size_t i = 0; i < length; i++)
dvander@54
    94
            add(s[i]);
dvander@54
    95
    }
dvander@54
    96
dvander@54
    97
    uint32 result() {
dvander@54
    98
        hash += (hash << 3);
dvander@54
    99
        hash ^= (hash >> 11);
dvander@54
   100
        hash += (hash << 15);
dvander@54
   101
        return hash;
dvander@54
   102
    }
dvander@54
   103
};
dvander@54
   104
dvander@54
   105
static inline uint32
dvander@54
   106
HashCharSequence(const char *s, size_t length)
dvander@54
   107
{
dvander@54
   108
    CharacterStreamHasher hasher;
dvander@54
   109
    hasher.add(s, length);
dvander@54
   110
    return hasher.result();
dvander@54
   111
}
dvander@54
   112
dvander@28
   113
static inline size_t
dvander@28
   114
Log2(size_t number)
dvander@28
   115
{
dvander@28
   116
    assert(number != 0);
dvander@28
   117
dvander@53
   118
#ifdef _MSC_VER
dvander@28
   119
    unsigned long rval;
dvander@86
   120
# ifdef _M_IX86
dvander@28
   121
    _BitScanReverse(&rval, number);
dvander@86
   122
# elif _M_X64
dvander@86
   123
    _BitScanReverse64(&rval, number);
dvander@86
   124
# endif
dvander@28
   125
    return rval;
dvander@28
   126
#else
dvander@28
   127
	size_t bit;
dvander@28
   128
	asm("bsr %1, %0\n"
dvander@28
   129
		: "=r" (bit)
dvander@28
   130
		: "rm" (number));
dvander@28
   131
	return bit;
dvander@28
   132
#endif
dvander@28
   133
}
dvander@28
   134
dvander@53
   135
static inline size_t
dvander@53
   136
FindRightmostBit(size_t number)
dvander@53
   137
{
dvander@53
   138
    assert(number != 0);
dvander@53
   139
dvander@53
   140
#ifdef _MSC_VER
dvander@53
   141
    unsigned long rval;
dvander@86
   142
# ifdef _M_IX86
dvander@53
   143
    _BitScanForward(&rval, number);
dvander@86
   144
# elif _M_X64
dvander@86
   145
    _BitScanForward64(&rval, number);
dvander@86
   146
# endif
dvander@53
   147
    return rval;
dvander@53
   148
#else
dvander@53
   149
	size_t bit;
dvander@53
   150
	asm("bsf %1, %0\n"
dvander@53
   151
		: "=r" (bit)
dvander@53
   152
		: "rm" (number));
dvander@53
   153
	return bit;
dvander@53
   154
#endif
dvander@53
   155
}
dvander@53
   156
dvander@28
   157
static inline bool
dvander@28
   158
IsPowerOfTwo(size_t value)
dvander@28
   159
{
dvander@28
   160
    if (value == 0)
dvander@28
   161
        return false;
dvander@28
   162
    return !(value & (value - 1));
dvander@28
   163
}
dvander@28
   164
dvander@28
   165
static inline size_t
dvander@28
   166
Align(size_t count, size_t alignment)
dvander@28
   167
{
dvander@28
   168
    assert(IsPowerOfTwo(alignment));
dvander@28
   169
    return count + (alignment - (count % alignment)) % alignment;
dvander@28
   170
}
dvander@28
   171
dvander@28
   172
static inline bool
dvander@28
   173
IsUint32AddSafe(unsigned a, unsigned b)
dvander@28
   174
{
dvander@55
   175
    if (!a || !b)
dvander@55
   176
        return true;
dvander@86
   177
    size_t log2_a = Log2(a);
dvander@86
   178
    size_t log2_b = Log2(b);
dvander@28
   179
    return (log2_a < sizeof(unsigned) * 8) &&
dvander@28
   180
           (log2_b < sizeof(unsigned) * 8);
dvander@28
   181
}
dvander@28
   182
dvander@28
   183
static inline bool
dvander@55
   184
IsUintPtrAddSafe(size_t a, size_t b)
dvander@55
   185
{
dvander@55
   186
    if (!a || !b)
dvander@55
   187
        return true;
dvander@55
   188
    size_t log2_a = Log2(a);
dvander@55
   189
    size_t log2_b = Log2(b);
dvander@55
   190
    return (log2_a < sizeof(size_t) * 8) &&
dvander@55
   191
           (log2_b < sizeof(size_t) * 8);
dvander@55
   192
}
dvander@55
   193
dvander@55
   194
static inline bool
dvander@28
   195
IsUint32MultiplySafe(unsigned a, unsigned b)
dvander@28
   196
{
dvander@28
   197
    if (a <= 1 || b <= 1)
dvander@28
   198
        return true;
dvander@28
   199
dvander@86
   200
    size_t log2_a = Log2(a);
dvander@86
   201
    size_t log2_b = Log2(b);
dvander@28
   202
    return log2_a + log2_b <= sizeof(unsigned) * 8;
dvander@28
   203
}
dvander@28
   204
dvander@55
   205
static inline bool
dvander@55
   206
IsUintPtrMultiplySafe(size_t a, size_t b)
dvander@55
   207
{
dvander@55
   208
    if (a <= 1 || b <= 1)
dvander@55
   209
        return true;
dvander@55
   210
dvander@55
   211
    size_t log2_a = Log2(a);
dvander@55
   212
    size_t log2_b = Log2(b);
dvander@55
   213
    return log2_a + log2_b <= sizeof(size_t) * 8;
dvander@55
   214
}
dvander@55
   215
dvander@28
   216
#define ARRAY_LENGTH(array) (sizeof(array) / sizeof(array[0]))
dvander@28
   217
#define STATIC_ASSERT(cond) extern int static_assert_f(int a[(cond) ? 1 : -1])
dvander@28
   218
dvander@49
   219
#define IS_ALIGNED(addr, alignment)	(!(uintptr_t(addr) & ((alignment) - 1)))
dvander@49
   220
dvander@11
   221
template <typename T>
dvander@11
   222
static inline bool
dvander@11
   223
IsAligned(T addr, size_t alignment)
dvander@11
   224
{
dvander@11
   225
    assert(IsPowerOfTwo(alignment));
dvander@11
   226
    return !(uintptr_t(addr) & (alignment - 1));
dvander@28
   227
}
dvander@28
   228
dvander@11
   229
static inline Address
dvander@11
   230
AlignedBase(Address addr, size_t alignment)
dvander@11
   231
{
dvander@11
   232
    assert(IsPowerOfTwo(alignment));
dvander@11
   233
    return Address(uintptr_t(addr) & ~(alignment - 1));
dvander@28
   234
}
dvander@28
   235
dvander@28
   236
template <typename T> static inline T
dvander@28
   237
Min(const T &t1, const T &t2)
dvander@28
   238
{
dvander@28
   239
    return t1 < t2 ? t1 : t2;
dvander@28
   240
}
dvander@28
   241
danderson@91
   242
#define OFFSETOF(Class, Member) reinterpret_cast<size_t>(&((Class *)NULL)->Member)
danderson@91
   243
dvander@28
   244
}
dvander@28
   245
dvander@28
   246
#endif // _include_jitcraft_utility_h_