src/ObjectVisitor.h
author David Anderson <dvander@alliedmods.net>
Sat Nov 17 19:23:39 2012 -0800 (2012-11-17)
changeset 200 e0a601465746
parent 195 c1ba166f3fc4
child 209 5cbec15fadfe
permissions -rw-r--r--
Fix OS X build.
dvander@45
     1
/* vim: set ts=4 sw=4 tw=99 et:
dvander@45
     2
 *
dvander@45
     3
 * Copyright (C) 2012 David Anderson
dvander@45
     4
 *
dvander@45
     5
 * This file is part of JITCraft.
dvander@45
     6
 *
dvander@45
     7
 * JITCraft is free software: you can redistribute it and/or modify it under
dvander@45
     8
 * the terms of the GNU General Public License as published by the Free
dvander@45
     9
 * Software Foundation, either version 3 of the License, or (at your option)
dvander@45
    10
 * any later version.
dvander@45
    11
 * 
dvander@45
    12
 * Foobar is distributed in the hope that it will be useful, but WITHOUT ANY
dvander@45
    13
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@45
    14
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
dvander@45
    15
 *
dvander@45
    16
 * You should have received a copy of the GNU General Public License along with
dvander@45
    17
 * JITCraft. If not, see http://www.gnu.org/licenses/.
dvander@45
    18
 */
dvander@45
    19
#ifndef _include_jc_object_visitor_h_
dvander@45
    20
#define _include_jc_object_visitor_h_
dvander@45
    21
dvander@45
    22
#include "Objects.h"
dvander@45
    23
#include "Types.h"
dvander@45
    24
#include "FixedArray.h"
dvander@45
    25
#include "Code.h"
dvander@45
    26
#include "Reference.h"
dvander@45
    27
#include "Modules.h"
dvander@45
    28
#include "Functions.h"
dvander@45
    29
#include "Array.h"
dvander@54
    30
#include "Strings.h"
dvander@85
    31
#include "Environments.h"
dvander@146
    32
#include "Structures.h"
dvander@168
    33
#include "Box.h"
dvander@45
    34
dvander@59
    35
namespace ke {
dvander@45
    36
dvander@45
    37
// An ObjectVisitor is used for traversing object references in the heap. Since
dvander@45
    38
// this pattern must be lightning fast, we avoid virtual dispatch by forcing
dvander@45
    39
// visitors to compose themselves with the visiting logic.
dvander@45
    40
template <typename T>
dvander@45
    41
class ObjectVisitor : public T
dvander@45
    42
{
dvander@45
    43
  private:
dvander@45
    44
    void visitField(Object *obj, size_t offset) {
dvander@45
    45
        this->visit(reinterpret_cast<Object **>(Address(obj) + offset));
dvander@45
    46
    }
dvander@45
    47
dvander@45
    48
    size_t iterateType(Object *obj) {
dvander@45
    49
        visitField(obj, Type::offsetOfContained());
dvander@195
    50
        visitField(obj, Type::offsetOfName());
dvander@195
    51
        return sizeof(Type);
dvander@195
    52
    }
dvander@195
    53
dvander@195
    54
    size_t iterateStructType(Object *obj) {
dvander@195
    55
        visitField(obj, Type::offsetOfContained());
dvander@145
    56
        visitField(obj, Type::offsetOfName());
dvander@195
    57
        visitField(obj, StructType::offsetOfFields());
dvander@195
    58
        visitField(obj, StructType::offsetOfNewMap());
dvander@195
    59
        return sizeof(StructType);
dvander@195
    60
    }
dvander@195
    61
dvander@195
    62
    size_t iterateFunctionType(Object *obj) {
dvander@195
    63
        visitField(obj, Type::offsetOfContained());
dvander@195
    64
        visitField(obj, Type::offsetOfName());
dvander@195
    65
        visitField(obj, FunctionType::offsetOfReturnType());
dvander@195
    66
        visitField(obj, FunctionType::offsetOfParameters());      
dvander@195
    67
        visitField(obj, FunctionType::offsetOfDefaults());
dvander@195
    68
        return sizeof(FunctionType);
dvander@45
    69
    }
dvander@45
    70
dvander@45
    71
    size_t iterateFixedArray(FixedArray *array) {
dvander@45
    72
        unsigned length = array->length();
dvander@45
    73
        Object **ptr = reinterpret_cast<Object **>(array + 1);
dvander@45
    74
        for (unsigned i = 0; i < length; i++)
dvander@45
    75
            this->visit(ptr + i);
dvander@161
    76
        return array->objSize();
dvander@45
    77
    }
dvander@45
    78
dvander@45
    79
    size_t iterateByteArray(ByteArray *array) {
dvander@161
    80
        return array->objSize();
dvander@45
    81
    }
dvander@45
    82
dvander@45
    83
    size_t iterateCode(Object *obj) {
dvander@45
    84
        visitField(obj, Code::offsetOfModule());
dvander@45
    85
        visitField(obj, Code::offsetOfBytecode());
dvander@45
    86
        visitField(obj, Code::offsetOfLocals());
dvander@45
    87
        visitField(obj, Code::offsetOfObjects());
dvander@53
    88
        visitField(obj, Code::offsetOfSafepoints());
dvander@70
    89
        visitField(obj, Code::offsetOfSourceMap());
dvander@195
    90
        visitField(obj, Code::offsetOfStrings());
dvander@45
    91
        return sizeof(Code);
dvander@45
    92
    }
dvander@45
    93
dvander@45
    94
    size_t iterateReference(Object *obj) {
dvander@45
    95
        visitField(obj, Reference::offsetOfBase());
dvander@45
    96
        return sizeof(Reference);
dvander@45
    97
    }
dvander@45
    98
dvander@45
    99
    size_t iterateModule(Object *obj) {
dvander@70
   100
        visitField(obj, Module::offsetOfFile());
dvander@195
   101
        visitField(obj, Module::offsetOfGlobals());
dvander@85
   102
        visitField(obj, Module::offsetOfCode());
dvander@45
   103
        return sizeof(Module);
dvander@45
   104
    }
dvander@45
   105
dvander@45
   106
    size_t iterateFunction(Object *obj) {
dvander@52
   107
        visitField(obj, Function::offsetOfCode());
dvander@52
   108
        visitField(obj, Function::offsetOfType());
dvander@68
   109
        visitField(obj, Function::offsetOfName());
dvander@45
   110
        return sizeof(Function);
dvander@45
   111
    }
dvander@45
   112
dvander@146
   113
    size_t iterateDescriptor(Object *obj) {
dvander@146
   114
        visitField(obj, Descriptor::offsetOfName());
dvander@146
   115
        visitField(obj, Descriptor::offsetOfType());
dvander@146
   116
        return sizeof(Descriptor);
dvander@146
   117
    }
dvander@146
   118
dvander@68
   119
    size_t iterateNative(Object *obj) {
dvander@68
   120
        visitField(obj, Native::offsetOfType());
dvander@68
   121
        return sizeof(Native);
dvander@68
   122
    }
dvander@68
   123
dvander@54
   124
    size_t iterateString(Object *obj) {
dvander@161
   125
        return String::cast(obj)->objSize();
dvander@54
   126
    }
dvander@54
   127
dvander@45
   128
    size_t iterateArray(Array *array, ArrayMap *map) {
dvander@188
   129
        if (!map->type()->fixedLength() || map->type()->contained()->isTraceable())
dvander@188
   130
            visitField(array, Array::offsetOfElements());
dvander@188
   131
        return array->objSize(map);
dvander@45
   132
    }
dvander@45
   133
dvander@168
   134
    size_t iterateBox(Box *obj) {
dvander@168
   135
        visitField(obj, Box::offsetOfType());
dvander@168
   136
        if (obj->type()->isTraceable())
dvander@168
   137
            visitField(obj, Box::offsetOfObj());
dvander@168
   138
        return sizeof(Box);
dvander@168
   139
    }
dvander@168
   140
dvander@45
   141
    size_t iterateArrayMap(ArrayMap *map) {
dvander@52
   142
        visitField(map, ArrayMap::offsetOfType());
dvander@45
   143
        return sizeof(ArrayMap);
dvander@45
   144
    }
dvander@45
   145
dvander@85
   146
    size_t iterateEnvironmentSlotDescriptorArray(EnvironmentSlotDescriptorArray *env) {
dvander@85
   147
        unsigned length = env->length();
dvander@85
   148
        EnvironmentSlotDescriptor *desc = env->slots();
dvander@85
   149
        for (unsigned i = 0; i < length; i++)
dvander@85
   150
            this->visit(desc->type.addr());
dvander@161
   151
        return env->objSize();
dvander@85
   152
    }
dvander@85
   153
dvander@85
   154
    size_t iterateEnvironmentMap(EnvironmentMap *map) {
dvander@85
   155
        visitField(map, EnvironmentMap::offsetOfSlots());
dvander@161
   156
        return map->objSize();
dvander@85
   157
    }
dvander@85
   158
dvander@147
   159
    size_t iterateStructMap(StructMap *map) {
dvander@147
   160
        visitField(map, StructMap::offsetOfType());
dvander@153
   161
        visitField(map, StructMap::offsetOfComposed());
dvander@161
   162
        return map->objSize();
dvander@147
   163
    }
dvander@147
   164
dvander@85
   165
    size_t iterateEnvironment(Environment *env) {
dvander@85
   166
        EnvironmentMap *map = env->map();
dvander@85
   167
        const unsigned *offsets = map->traceOffsets();
dvander@85
   168
        unsigned noffsets = map->traceOffsetCount();
dvander@85
   169
        for (unsigned i = 0; i < noffsets; i++)
dvander@85
   170
            visitField(env, Environment::offsetOfSlotOffset(offsets[i]));
dvander@161
   171
        return env->objSize();
dvander@85
   172
    }
dvander@85
   173
dvander@147
   174
    size_t iterateStruct(Struct *obj) {
dvander@147
   175
        StructMap *map = obj->map();
dvander@147
   176
        const unsigned *offsets = map->traceOffsets();
dvander@147
   177
        unsigned noffsets = map->traceOffsetCount();
dvander@147
   178
        for (unsigned i = 0; i < noffsets; i++)
dvander@147
   179
            visitField(obj, Struct::offsetOfSlotOffset(offsets[i]));
dvander@161
   180
        return obj->objSize();
dvander@147
   181
    }
dvander@147
   182
dvander@161
   183
  private:
dvander@161
   184
    size_t iterateObject(Object *obj) {
dvander@52
   185
        visitField(obj, Object::offsetOfMap());
dvander@52
   186
        return iterate(obj, obj->map());
dvander@52
   187
    }
dvander@52
   188
dvander@161
   189
    size_t iterateObject(Object *obj, Map *map) {
dvander@45
   190
        switch (map->kind()) {
dvander@45
   191
          case MapKind_Type:
dvander@45
   192
            return iterateType(obj);
dvander@45
   193
dvander@195
   194
          case MapKind_FunctionType:
dvander@195
   195
            return iterateFunctionType(obj);
dvander@195
   196
dvander@195
   197
          case MapKind_StructType:
dvander@195
   198
            return iterateStructType(obj);
dvander@195
   199
dvander@45
   200
          case MapKind_FixedArray:
dvander@45
   201
            return iterateFixedArray(FixedArray::cast(obj));
dvander@45
   202
dvander@45
   203
          case MapKind_ByteArray:
dvander@54
   204
            return iterateByteArray(ByteArray::cast(obj));
dvander@45
   205
dvander@45
   206
          case MapKind_Code:
dvander@45
   207
            return iterateCode(obj);
dvander@45
   208
dvander@45
   209
          case MapKind_Reference:
dvander@45
   210
            return iterateReference(obj);
dvander@45
   211
dvander@45
   212
          case MapKind_Module:
dvander@45
   213
            return iterateModule(obj);
dvander@45
   214
dvander@45
   215
          case MapKind_Function:
dvander@45
   216
            return iterateFunction(obj);
dvander@45
   217
dvander@146
   218
          case MapKind_Descriptor:
dvander@146
   219
            return iterateDescriptor(obj);
dvander@146
   220
dvander@54
   221
          case MapKind_String:
dvander@54
   222
            return iterateString(obj);
dvander@54
   223
dvander@45
   224
          case MapKind_Array:
dvander@53
   225
            return Align(iterateArray(Array::cast(obj), ArrayMap::cast(map)), kObjectAlignment);
dvander@45
   226
dvander@168
   227
          case MapKind_Box:
dvander@168
   228
            return iterateBox(Box::cast(obj));
dvander@168
   229
dvander@147
   230
          case MapKind_Struct:
dvander@147
   231
            return iterateStruct(Struct::cast(obj));
dvander@147
   232
dvander@85
   233
          case MapKind_EnvironmentSlotDescriptorArray:
dvander@85
   234
            return iterateEnvironmentSlotDescriptorArray(EnvironmentSlotDescriptorArray::cast(obj));
dvander@85
   235
dvander@85
   236
          case MapKind_Environment:
dvander@85
   237
            return iterateEnvironment(Environment::cast(obj));
dvander@85
   238
dvander@68
   239
          case MapKind_Native:
dvander@68
   240
            return iterateNative(obj);
dvander@68
   241
dvander@45
   242
          case MapKind_MetaArray:
dvander@52
   243
            return iterateArrayMap(ArrayMap::cast(obj));
dvander@45
   244
dvander@85
   245
          case MapKind_MetaEnvironment:
dvander@85
   246
            return iterateEnvironmentMap(EnvironmentMap::cast(obj));
dvander@85
   247
dvander@147
   248
          case MapKind_MetaStruct:
dvander@147
   249
            return iterateStructMap(StructMap::cast(obj));
dvander@147
   250
dvander@45
   251
          default:
dvander@45
   252
            assert(map->kind() == MapKind_Meta);
dvander@52
   253
            return sizeof(Map);
dvander@45
   254
        }
dvander@45
   255
    }
dvander@161
   256
dvander@161
   257
  public:
dvander@161
   258
    size_t iterate(Object *obj) {
dvander@161
   259
        return Align(iterateObject(obj), kObjectAlignment);
dvander@161
   260
    }
dvander@161
   261
dvander@161
   262
    size_t iterate(Object *obj, Map *map) {
dvander@161
   263
        return Align(iterateObject(obj, map), kObjectAlignment);
dvander@161
   264
    }
dvander@45
   265
};
dvander@45
   266
dvander@53
   267
static inline size_t
dvander@161
   268
SizeOfObjectRaw(Object *obj, Map *map)
dvander@53
   269
{
dvander@53
   270
    switch (map->kind()) {
dvander@53
   271
      case MapKind_Type:
dvander@53
   272
        return sizeof(Type);
dvander@53
   273
dvander@195
   274
      case MapKind_FunctionType:
dvander@195
   275
        return sizeof(FunctionType);
dvander@195
   276
dvander@195
   277
      case MapKind_StructType:
dvander@195
   278
        return sizeof(StructType);
dvander@195
   279
dvander@53
   280
      case MapKind_FixedArray:
dvander@161
   281
        return FixedArray::cast(obj)->objSize();
dvander@53
   282
dvander@53
   283
      case MapKind_ByteArray:
dvander@161
   284
        return ByteArray::cast(obj)->objSize();
dvander@53
   285
dvander@53
   286
      case MapKind_Code:
dvander@53
   287
        return sizeof(Code);
dvander@53
   288
dvander@53
   289
      case MapKind_Reference:
dvander@53
   290
        return sizeof(Reference);
dvander@53
   291
dvander@53
   292
      case MapKind_Module:
dvander@53
   293
        return sizeof(Module);
dvander@53
   294
dvander@146
   295
      case MapKind_Descriptor:
dvander@146
   296
        return sizeof(Descriptor);
dvander@146
   297
dvander@53
   298
      case MapKind_Function:
dvander@53
   299
        return sizeof(Function);
dvander@53
   300
dvander@54
   301
      case MapKind_String:
dvander@161
   302
        return String::cast(obj)->objSize();
dvander@54
   303
dvander@68
   304
      case MapKind_Native:
dvander@68
   305
        return sizeof(Native);
dvander@68
   306
dvander@53
   307
      case MapKind_Array:
dvander@188
   308
        return Align(Array::cast(obj)->objSize(ArrayMap::cast(map)), kObjectAlignment);
dvander@53
   309
dvander@168
   310
      case MapKind_Box:
dvander@168
   311
        return sizeof(Box);
dvander@168
   312
dvander@147
   313
      case MapKind_Struct:
dvander@161
   314
        return Struct::cast(obj)->objSize();
dvander@147
   315
dvander@85
   316
      case MapKind_EnvironmentSlotDescriptorArray:
dvander@161
   317
        return EnvironmentSlotDescriptorArray::cast(obj)->objSize();
dvander@85
   318
dvander@85
   319
      case MapKind_Environment:
dvander@161
   320
        return Environment::cast(obj)->objSize();
dvander@85
   321
dvander@53
   322
      case MapKind_MetaArray:
dvander@53
   323
        return sizeof(ArrayMap);
dvander@53
   324
dvander@85
   325
      case MapKind_MetaEnvironment:
dvander@161
   326
        return EnvironmentMap::cast(obj)->objSize();
dvander@85
   327
dvander@147
   328
      case MapKind_MetaStruct:
dvander@161
   329
        return StructMap::cast(obj)->objSize();
dvander@147
   330
dvander@53
   331
      case MapKind_FreeRegion:
dvander@53
   332
        return *reinterpret_cast<size_t *>(reinterpret_cast<Address>(obj + 1));
dvander@53
   333
dvander@53
   334
      default:
dvander@53
   335
        assert(map->kind() == MapKind_Meta);
dvander@53
   336
        return sizeof(Map);
dvander@53
   337
    }
dvander@53
   338
}
dvander@53
   339
dvander@161
   340
static inline size_t
dvander@161
   341
SizeOfObject(Object *obj, Map *map)
dvander@161
   342
{
dvander@161
   343
    return Align(SizeOfObjectRaw(obj, map), kObjectAlignment);
dvander@161
   344
}
dvander@161
   345
dvander@53
   346
class ObjectSizeEvaluator
dvander@53
   347
{
dvander@53
   348
  public:
dvander@53
   349
    size_t operator()(Object *obj, Map *map) {
dvander@53
   350
        return SizeOfObject(obj, map);
dvander@53
   351
    }
dvander@53
   352
};
dvander@53
   353
dvander@45
   354
}
dvander@45
   355
dvander@45
   356
#endif // _include_jc_object_visitor_h_