src/ObjectVisitor.h
author David Anderson <dvander@alliedmods.net>
Sun Aug 05 00:31:20 2012 -0700 (2012-08-05)
changeset 154 a85a0303bcb8
parent 153 fc91c4a3dfe2
child 155 7926a7921fa3
permissions -rw-r--r--
Refactory array maps to allow arrays of structs.
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@45
    33
dvander@59
    34
namespace ke {
dvander@45
    35
dvander@45
    36
// An ObjectVisitor is used for traversing object references in the heap. Since
dvander@45
    37
// this pattern must be lightning fast, we avoid virtual dispatch by forcing
dvander@45
    38
// visitors to compose themselves with the visiting logic.
dvander@45
    39
template <typename T>
dvander@45
    40
class ObjectVisitor : public T
dvander@45
    41
{
dvander@45
    42
  private:
dvander@45
    43
    void visitField(Object *obj, size_t offset) {
dvander@45
    44
        this->visit(reinterpret_cast<Object **>(Address(obj) + offset));
dvander@45
    45
    }
dvander@45
    46
dvander@45
    47
    size_t iterateType(Object *obj) {
dvander@45
    48
        visitField(obj, Type::offsetOfContained());
dvander@45
    49
        visitField(obj, Type::offsetOfReturnType());
dvander@45
    50
        visitField(obj, Type::offsetOfParameters());
dvander@145
    51
        visitField(obj, Type::offsetOfName());
dvander@146
    52
        visitField(obj, Type::offsetOfFields());
dvander@45
    53
        return sizeof(Type);
dvander@45
    54
    }
dvander@45
    55
dvander@45
    56
    size_t iterateFixedArray(FixedArray *array) {
dvander@45
    57
        unsigned length = array->length();
dvander@45
    58
        Object **ptr = reinterpret_cast<Object **>(array + 1);
dvander@45
    59
        for (unsigned i = 0; i < length; i++)
dvander@45
    60
            this->visit(ptr + i);
dvander@45
    61
        return FixedArray::SizeFor(length);
dvander@45
    62
    }
dvander@45
    63
dvander@45
    64
    size_t iterateByteArray(ByteArray *array) {
dvander@45
    65
        return ByteArray::SizeFor(array->length());
dvander@45
    66
    }
dvander@45
    67
dvander@45
    68
    size_t iterateCode(Object *obj) {
dvander@45
    69
        visitField(obj, Code::offsetOfModule());
dvander@45
    70
        visitField(obj, Code::offsetOfBytecode());
dvander@45
    71
        visitField(obj, Code::offsetOfLocals());
dvander@45
    72
        visitField(obj, Code::offsetOfObjects());
dvander@53
    73
        visitField(obj, Code::offsetOfSafepoints());
dvander@70
    74
        visitField(obj, Code::offsetOfSourceMap());
dvander@45
    75
        return sizeof(Code);
dvander@45
    76
    }
dvander@45
    77
dvander@45
    78
    size_t iterateReference(Object *obj) {
dvander@45
    79
        visitField(obj, Reference::offsetOfBase());
dvander@45
    80
        return sizeof(Reference);
dvander@45
    81
    }
dvander@45
    82
dvander@45
    83
    size_t iterateModule(Object *obj) {
dvander@45
    84
        visitField(obj, Module::offsetOfFunctions());
dvander@64
    85
        visitField(obj, Module::offsetOfPublics());
dvander@68
    86
        visitField(obj, Module::offsetOfNatives());
dvander@70
    87
        visitField(obj, Module::offsetOfFile());
dvander@85
    88
        visitField(obj, Module::offsetOfEnvironment());
dvander@85
    89
        visitField(obj, Module::offsetOfCode());
dvander@45
    90
        return sizeof(Module);
dvander@45
    91
    }
dvander@45
    92
dvander@45
    93
    size_t iterateFunction(Object *obj) {
dvander@52
    94
        visitField(obj, Function::offsetOfCode());
dvander@52
    95
        visitField(obj, Function::offsetOfType());
dvander@68
    96
        visitField(obj, Function::offsetOfName());
dvander@45
    97
        return sizeof(Function);
dvander@45
    98
    }
dvander@45
    99
dvander@146
   100
    size_t iterateDescriptor(Object *obj) {
dvander@146
   101
        visitField(obj, Descriptor::offsetOfName());
dvander@146
   102
        visitField(obj, Descriptor::offsetOfType());
dvander@146
   103
        return sizeof(Descriptor);
dvander@146
   104
    }
dvander@146
   105
dvander@68
   106
    size_t iterateNative(Object *obj) {
dvander@68
   107
        visitField(obj, Native::offsetOfType());
dvander@68
   108
        visitField(obj, Native::offsetOfName());
dvander@68
   109
        return sizeof(Native);
dvander@68
   110
    }
dvander@68
   111
dvander@54
   112
    size_t iterateString(Object *obj) {
dvander@54
   113
        return String::SizeFor(String::cast(obj)->length());
dvander@54
   114
    }
dvander@54
   115
dvander@45
   116
    size_t iterateArray(Array *array, ArrayMap *map) {
dvander@72
   117
        assert(map->type()->isArray());
dvander@154
   118
        if (map->type()->contained()->isTraceable()) {
dvander@45
   119
            unsigned length = array->nelements();
dvander@45
   120
            Object **vec = array->objVec();
dvander@45
   121
            for (unsigned i = 0; i < length; i++)
dvander@45
   122
                this->visit(vec + i);
dvander@45
   123
        }
dvander@45
   124
        return Array::SizeOf(array);
dvander@45
   125
    }
dvander@45
   126
dvander@45
   127
    size_t iterateArrayMap(ArrayMap *map) {
dvander@52
   128
        visitField(map, ArrayMap::offsetOfType());
dvander@45
   129
        return sizeof(ArrayMap);
dvander@45
   130
    }
dvander@45
   131
dvander@85
   132
    size_t iterateEnvironmentSlotDescriptorArray(EnvironmentSlotDescriptorArray *env) {
dvander@85
   133
        unsigned length = env->length();
dvander@85
   134
        EnvironmentSlotDescriptor *desc = env->slots();
dvander@85
   135
        for (unsigned i = 0; i < length; i++)
dvander@85
   136
            this->visit(desc->type.addr());
dvander@85
   137
        return env->size();
dvander@85
   138
    }
dvander@85
   139
dvander@85
   140
    size_t iterateEnvironmentMap(EnvironmentMap *map) {
dvander@85
   141
        visitField(map, EnvironmentMap::offsetOfSlots());
dvander@85
   142
        return map->size();
dvander@85
   143
    }
dvander@85
   144
dvander@147
   145
    size_t iterateStructMap(StructMap *map) {
dvander@147
   146
        visitField(map, StructMap::offsetOfType());
dvander@153
   147
        visitField(map, StructMap::offsetOfComposed());
dvander@147
   148
        return map->size();
dvander@147
   149
    }
dvander@147
   150
dvander@85
   151
    size_t iterateEnvironment(Environment *env) {
dvander@85
   152
        EnvironmentMap *map = env->map();
dvander@85
   153
        const unsigned *offsets = map->traceOffsets();
dvander@85
   154
        unsigned noffsets = map->traceOffsetCount();
dvander@85
   155
        for (unsigned i = 0; i < noffsets; i++)
dvander@85
   156
            visitField(env, Environment::offsetOfSlotOffset(offsets[i]));
dvander@85
   157
        return env->size();
dvander@85
   158
    }
dvander@85
   159
dvander@147
   160
    size_t iterateStruct(Struct *obj) {
dvander@147
   161
        StructMap *map = obj->map();
dvander@147
   162
        const unsigned *offsets = map->traceOffsets();
dvander@147
   163
        unsigned noffsets = map->traceOffsetCount();
dvander@147
   164
        for (unsigned i = 0; i < noffsets; i++)
dvander@147
   165
            visitField(obj, Struct::offsetOfSlotOffset(offsets[i]));
dvander@147
   166
        return obj->size();
dvander@147
   167
    }
dvander@147
   168
dvander@45
   169
  public:
dvander@52
   170
    size_t iterate(Object *obj) {
dvander@52
   171
        visitField(obj, Object::offsetOfMap());
dvander@52
   172
        return iterate(obj, obj->map());
dvander@52
   173
    }
dvander@52
   174
dvander@45
   175
    size_t iterate(Object *obj, Map *map) {
dvander@45
   176
        switch (map->kind()) {
dvander@45
   177
          case MapKind_Type:
dvander@45
   178
            return iterateType(obj);
dvander@45
   179
dvander@45
   180
          case MapKind_FixedArray:
dvander@45
   181
            return iterateFixedArray(FixedArray::cast(obj));
dvander@45
   182
dvander@45
   183
          case MapKind_ByteArray:
dvander@54
   184
            return iterateByteArray(ByteArray::cast(obj));
dvander@45
   185
dvander@45
   186
          case MapKind_Code:
dvander@45
   187
            return iterateCode(obj);
dvander@45
   188
dvander@45
   189
          case MapKind_Reference:
dvander@45
   190
            return iterateReference(obj);
dvander@45
   191
dvander@45
   192
          case MapKind_Module:
dvander@45
   193
            return iterateModule(obj);
dvander@45
   194
dvander@45
   195
          case MapKind_Function:
dvander@45
   196
            return iterateFunction(obj);
dvander@45
   197
dvander@146
   198
          case MapKind_Descriptor:
dvander@146
   199
            return iterateDescriptor(obj);
dvander@146
   200
dvander@54
   201
          case MapKind_String:
dvander@54
   202
            return iterateString(obj);
dvander@54
   203
dvander@45
   204
          case MapKind_Array:
dvander@53
   205
            return Align(iterateArray(Array::cast(obj), ArrayMap::cast(map)), kObjectAlignment);
dvander@45
   206
dvander@147
   207
          case MapKind_Struct:
dvander@147
   208
            return iterateStruct(Struct::cast(obj));
dvander@147
   209
dvander@85
   210
          case MapKind_EnvironmentSlotDescriptorArray:
dvander@85
   211
            return iterateEnvironmentSlotDescriptorArray(EnvironmentSlotDescriptorArray::cast(obj));
dvander@85
   212
dvander@85
   213
          case MapKind_Environment:
dvander@85
   214
            return iterateEnvironment(Environment::cast(obj));
dvander@85
   215
dvander@68
   216
          case MapKind_Native:
dvander@68
   217
            return iterateNative(obj);
dvander@68
   218
dvander@45
   219
          case MapKind_MetaArray:
dvander@52
   220
            return iterateArrayMap(ArrayMap::cast(obj));
dvander@45
   221
dvander@85
   222
          case MapKind_MetaEnvironment:
dvander@85
   223
            return iterateEnvironmentMap(EnvironmentMap::cast(obj));
dvander@85
   224
dvander@147
   225
          case MapKind_MetaStruct:
dvander@147
   226
            return iterateStructMap(StructMap::cast(obj));
dvander@147
   227
dvander@45
   228
          default:
dvander@45
   229
            assert(map->kind() == MapKind_Meta);
dvander@52
   230
            return sizeof(Map);
dvander@45
   231
        }
dvander@45
   232
    }
dvander@45
   233
};
dvander@45
   234
dvander@53
   235
static inline size_t
dvander@53
   236
SizeOfObject(Object *obj, Map *map)
dvander@53
   237
{
dvander@53
   238
    switch (map->kind()) {
dvander@53
   239
      case MapKind_Type:
dvander@53
   240
        return sizeof(Type);
dvander@53
   241
dvander@53
   242
      case MapKind_FixedArray:
dvander@53
   243
        return FixedArray::SizeFor(FixedArray::cast(obj)->length());
dvander@53
   244
dvander@53
   245
      case MapKind_ByteArray:
dvander@54
   246
        return ByteArray::SizeFor(ByteArray::cast(obj)->length());
dvander@53
   247
dvander@53
   248
      case MapKind_Code:
dvander@53
   249
        return sizeof(Code);
dvander@53
   250
dvander@53
   251
      case MapKind_Reference:
dvander@53
   252
        return sizeof(Reference);
dvander@53
   253
dvander@53
   254
      case MapKind_Module:
dvander@53
   255
        return sizeof(Module);
dvander@53
   256
dvander@146
   257
      case MapKind_Descriptor:
dvander@146
   258
        return sizeof(Descriptor);
dvander@146
   259
dvander@53
   260
      case MapKind_Function:
dvander@53
   261
        return sizeof(Function);
dvander@53
   262
dvander@54
   263
      case MapKind_String:
dvander@54
   264
        return String::SizeFor(String::cast(obj)->length());
dvander@54
   265
dvander@68
   266
      case MapKind_Native:
dvander@68
   267
        return sizeof(Native);
dvander@68
   268
dvander@53
   269
      case MapKind_Array:
dvander@53
   270
        return Align(Array::SizeOf(Array::cast(obj)), kObjectAlignment);
dvander@53
   271
dvander@147
   272
      case MapKind_Struct:
dvander@147
   273
        return Struct::cast(obj)->size();
dvander@147
   274
dvander@85
   275
      case MapKind_EnvironmentSlotDescriptorArray:
dvander@85
   276
        return EnvironmentSlotDescriptorArray::cast(obj)->size();
dvander@85
   277
dvander@85
   278
      case MapKind_Environment:
dvander@85
   279
        return Environment::cast(obj)->size();
dvander@85
   280
dvander@53
   281
      case MapKind_MetaArray:
dvander@53
   282
        return sizeof(ArrayMap);
dvander@53
   283
dvander@85
   284
      case MapKind_MetaEnvironment:
dvander@85
   285
        return EnvironmentMap::cast(obj)->size();
dvander@85
   286
dvander@147
   287
      case MapKind_MetaStruct:
dvander@147
   288
        return StructMap::cast(obj)->size();
dvander@147
   289
dvander@53
   290
      case MapKind_FreeRegion:
dvander@53
   291
        return *reinterpret_cast<size_t *>(reinterpret_cast<Address>(obj + 1));
dvander@53
   292
dvander@53
   293
      default:
dvander@53
   294
        assert(map->kind() == MapKind_Meta);
dvander@53
   295
        return sizeof(Map);
dvander@53
   296
    }
dvander@53
   297
}
dvander@53
   298
dvander@53
   299
class ObjectSizeEvaluator
dvander@53
   300
{
dvander@53
   301
  public:
dvander@53
   302
    size_t operator()(Object *obj, Map *map) {
dvander@53
   303
        return SizeOfObject(obj, map);
dvander@53
   304
    }
dvander@53
   305
};
dvander@53
   306
dvander@45
   307
}
dvander@45
   308
dvander@45
   309
#endif // _include_jc_object_visitor_h_