src/ObjectVisitor.h
author David Anderson <dvander@alliedmods.net>
Sat Sep 15 13:32:01 2012 -0700 (2012-09-15)
changeset 183 05571208642f
parent 168 4d0fff61d65e
child 188 bab29bcec7fe
permissions -rw-r--r--
Fix bug in error reporting for array assignment dimension mismatches.
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@45
    50
        visitField(obj, Type::offsetOfReturnType());
dvander@45
    51
        visitField(obj, Type::offsetOfParameters());
dvander@145
    52
        visitField(obj, Type::offsetOfName());
dvander@146
    53
        visitField(obj, Type::offsetOfFields());
dvander@168
    54
        visitField(obj, Type::offsetOfDefaults());
dvander@168
    55
        visitField(obj, Type::offsetOfNewMap());
dvander@45
    56
        return sizeof(Type);
dvander@45
    57
    }
dvander@45
    58
dvander@45
    59
    size_t iterateFixedArray(FixedArray *array) {
dvander@45
    60
        unsigned length = array->length();
dvander@45
    61
        Object **ptr = reinterpret_cast<Object **>(array + 1);
dvander@45
    62
        for (unsigned i = 0; i < length; i++)
dvander@45
    63
            this->visit(ptr + i);
dvander@161
    64
        return array->objSize();
dvander@45
    65
    }
dvander@45
    66
dvander@45
    67
    size_t iterateByteArray(ByteArray *array) {
dvander@161
    68
        return array->objSize();
dvander@45
    69
    }
dvander@45
    70
dvander@45
    71
    size_t iterateCode(Object *obj) {
dvander@45
    72
        visitField(obj, Code::offsetOfModule());
dvander@45
    73
        visitField(obj, Code::offsetOfBytecode());
dvander@45
    74
        visitField(obj, Code::offsetOfLocals());
dvander@45
    75
        visitField(obj, Code::offsetOfObjects());
dvander@53
    76
        visitField(obj, Code::offsetOfSafepoints());
dvander@70
    77
        visitField(obj, Code::offsetOfSourceMap());
dvander@45
    78
        return sizeof(Code);
dvander@45
    79
    }
dvander@45
    80
dvander@45
    81
    size_t iterateReference(Object *obj) {
dvander@45
    82
        visitField(obj, Reference::offsetOfBase());
dvander@45
    83
        return sizeof(Reference);
dvander@45
    84
    }
dvander@45
    85
dvander@45
    86
    size_t iterateModule(Object *obj) {
dvander@45
    87
        visitField(obj, Module::offsetOfFunctions());
dvander@64
    88
        visitField(obj, Module::offsetOfPublics());
dvander@68
    89
        visitField(obj, Module::offsetOfNatives());
dvander@70
    90
        visitField(obj, Module::offsetOfFile());
dvander@85
    91
        visitField(obj, Module::offsetOfEnvironment());
dvander@85
    92
        visitField(obj, Module::offsetOfCode());
dvander@45
    93
        return sizeof(Module);
dvander@45
    94
    }
dvander@45
    95
dvander@45
    96
    size_t iterateFunction(Object *obj) {
dvander@52
    97
        visitField(obj, Function::offsetOfCode());
dvander@52
    98
        visitField(obj, Function::offsetOfType());
dvander@68
    99
        visitField(obj, Function::offsetOfName());
dvander@45
   100
        return sizeof(Function);
dvander@45
   101
    }
dvander@45
   102
dvander@146
   103
    size_t iterateDescriptor(Object *obj) {
dvander@146
   104
        visitField(obj, Descriptor::offsetOfName());
dvander@146
   105
        visitField(obj, Descriptor::offsetOfType());
dvander@146
   106
        return sizeof(Descriptor);
dvander@146
   107
    }
dvander@146
   108
dvander@68
   109
    size_t iterateNative(Object *obj) {
dvander@68
   110
        visitField(obj, Native::offsetOfType());
dvander@68
   111
        visitField(obj, Native::offsetOfName());
dvander@68
   112
        return sizeof(Native);
dvander@68
   113
    }
dvander@68
   114
dvander@54
   115
    size_t iterateString(Object *obj) {
dvander@161
   116
        return String::cast(obj)->objSize();
dvander@54
   117
    }
dvander@54
   118
dvander@45
   119
    size_t iterateArray(Array *array, ArrayMap *map) {
dvander@72
   120
        assert(map->type()->isArray());
dvander@154
   121
        if (map->type()->contained()->isTraceable()) {
dvander@155
   122
            unsigned length = array->length();
dvander@45
   123
            Object **vec = array->objVec();
dvander@45
   124
            for (unsigned i = 0; i < length; i++)
dvander@45
   125
                this->visit(vec + i);
dvander@45
   126
        }
dvander@45
   127
        return Array::SizeOf(array);
dvander@45
   128
    }
dvander@45
   129
dvander@168
   130
    size_t iterateBox(Box *obj) {
dvander@168
   131
        visitField(obj, Box::offsetOfType());
dvander@168
   132
        if (obj->type()->isTraceable())
dvander@168
   133
            visitField(obj, Box::offsetOfObj());
dvander@168
   134
        return sizeof(Box);
dvander@168
   135
    }
dvander@168
   136
dvander@45
   137
    size_t iterateArrayMap(ArrayMap *map) {
dvander@52
   138
        visitField(map, ArrayMap::offsetOfType());
dvander@45
   139
        return sizeof(ArrayMap);
dvander@45
   140
    }
dvander@45
   141
dvander@85
   142
    size_t iterateEnvironmentSlotDescriptorArray(EnvironmentSlotDescriptorArray *env) {
dvander@85
   143
        unsigned length = env->length();
dvander@85
   144
        EnvironmentSlotDescriptor *desc = env->slots();
dvander@85
   145
        for (unsigned i = 0; i < length; i++)
dvander@85
   146
            this->visit(desc->type.addr());
dvander@161
   147
        return env->objSize();
dvander@85
   148
    }
dvander@85
   149
dvander@85
   150
    size_t iterateEnvironmentMap(EnvironmentMap *map) {
dvander@85
   151
        visitField(map, EnvironmentMap::offsetOfSlots());
dvander@161
   152
        return map->objSize();
dvander@85
   153
    }
dvander@85
   154
dvander@147
   155
    size_t iterateStructMap(StructMap *map) {
dvander@147
   156
        visitField(map, StructMap::offsetOfType());
dvander@153
   157
        visitField(map, StructMap::offsetOfComposed());
dvander@161
   158
        return map->objSize();
dvander@147
   159
    }
dvander@147
   160
dvander@85
   161
    size_t iterateEnvironment(Environment *env) {
dvander@85
   162
        EnvironmentMap *map = env->map();
dvander@85
   163
        const unsigned *offsets = map->traceOffsets();
dvander@85
   164
        unsigned noffsets = map->traceOffsetCount();
dvander@85
   165
        for (unsigned i = 0; i < noffsets; i++)
dvander@85
   166
            visitField(env, Environment::offsetOfSlotOffset(offsets[i]));
dvander@161
   167
        return env->objSize();
dvander@85
   168
    }
dvander@85
   169
dvander@147
   170
    size_t iterateStruct(Struct *obj) {
dvander@147
   171
        StructMap *map = obj->map();
dvander@147
   172
        const unsigned *offsets = map->traceOffsets();
dvander@147
   173
        unsigned noffsets = map->traceOffsetCount();
dvander@147
   174
        for (unsigned i = 0; i < noffsets; i++)
dvander@147
   175
            visitField(obj, Struct::offsetOfSlotOffset(offsets[i]));
dvander@161
   176
        return obj->objSize();
dvander@147
   177
    }
dvander@147
   178
dvander@161
   179
  private:
dvander@161
   180
    size_t iterateObject(Object *obj) {
dvander@52
   181
        visitField(obj, Object::offsetOfMap());
dvander@52
   182
        return iterate(obj, obj->map());
dvander@52
   183
    }
dvander@52
   184
dvander@161
   185
    size_t iterateObject(Object *obj, Map *map) {
dvander@45
   186
        switch (map->kind()) {
dvander@45
   187
          case MapKind_Type:
dvander@45
   188
            return iterateType(obj);
dvander@45
   189
dvander@45
   190
          case MapKind_FixedArray:
dvander@45
   191
            return iterateFixedArray(FixedArray::cast(obj));
dvander@45
   192
dvander@45
   193
          case MapKind_ByteArray:
dvander@54
   194
            return iterateByteArray(ByteArray::cast(obj));
dvander@45
   195
dvander@45
   196
          case MapKind_Code:
dvander@45
   197
            return iterateCode(obj);
dvander@45
   198
dvander@45
   199
          case MapKind_Reference:
dvander@45
   200
            return iterateReference(obj);
dvander@45
   201
dvander@45
   202
          case MapKind_Module:
dvander@45
   203
            return iterateModule(obj);
dvander@45
   204
dvander@45
   205
          case MapKind_Function:
dvander@45
   206
            return iterateFunction(obj);
dvander@45
   207
dvander@146
   208
          case MapKind_Descriptor:
dvander@146
   209
            return iterateDescriptor(obj);
dvander@146
   210
dvander@54
   211
          case MapKind_String:
dvander@54
   212
            return iterateString(obj);
dvander@54
   213
dvander@45
   214
          case MapKind_Array:
dvander@53
   215
            return Align(iterateArray(Array::cast(obj), ArrayMap::cast(map)), kObjectAlignment);
dvander@45
   216
dvander@168
   217
          case MapKind_Box:
dvander@168
   218
            return iterateBox(Box::cast(obj));
dvander@168
   219
dvander@147
   220
          case MapKind_Struct:
dvander@147
   221
            return iterateStruct(Struct::cast(obj));
dvander@147
   222
dvander@85
   223
          case MapKind_EnvironmentSlotDescriptorArray:
dvander@85
   224
            return iterateEnvironmentSlotDescriptorArray(EnvironmentSlotDescriptorArray::cast(obj));
dvander@85
   225
dvander@85
   226
          case MapKind_Environment:
dvander@85
   227
            return iterateEnvironment(Environment::cast(obj));
dvander@85
   228
dvander@68
   229
          case MapKind_Native:
dvander@68
   230
            return iterateNative(obj);
dvander@68
   231
dvander@45
   232
          case MapKind_MetaArray:
dvander@52
   233
            return iterateArrayMap(ArrayMap::cast(obj));
dvander@45
   234
dvander@85
   235
          case MapKind_MetaEnvironment:
dvander@85
   236
            return iterateEnvironmentMap(EnvironmentMap::cast(obj));
dvander@85
   237
dvander@147
   238
          case MapKind_MetaStruct:
dvander@147
   239
            return iterateStructMap(StructMap::cast(obj));
dvander@147
   240
dvander@45
   241
          default:
dvander@45
   242
            assert(map->kind() == MapKind_Meta);
dvander@52
   243
            return sizeof(Map);
dvander@45
   244
        }
dvander@45
   245
    }
dvander@161
   246
dvander@161
   247
  public:
dvander@161
   248
    size_t iterate(Object *obj) {
dvander@161
   249
        return Align(iterateObject(obj), kObjectAlignment);
dvander@161
   250
    }
dvander@161
   251
dvander@161
   252
    size_t iterate(Object *obj, Map *map) {
dvander@161
   253
        return Align(iterateObject(obj, map), kObjectAlignment);
dvander@161
   254
    }
dvander@45
   255
};
dvander@45
   256
dvander@53
   257
static inline size_t
dvander@161
   258
SizeOfObjectRaw(Object *obj, Map *map)
dvander@53
   259
{
dvander@53
   260
    switch (map->kind()) {
dvander@53
   261
      case MapKind_Type:
dvander@53
   262
        return sizeof(Type);
dvander@53
   263
dvander@53
   264
      case MapKind_FixedArray:
dvander@161
   265
        return FixedArray::cast(obj)->objSize();
dvander@53
   266
dvander@53
   267
      case MapKind_ByteArray:
dvander@161
   268
        return ByteArray::cast(obj)->objSize();
dvander@53
   269
dvander@53
   270
      case MapKind_Code:
dvander@53
   271
        return sizeof(Code);
dvander@53
   272
dvander@53
   273
      case MapKind_Reference:
dvander@53
   274
        return sizeof(Reference);
dvander@53
   275
dvander@53
   276
      case MapKind_Module:
dvander@53
   277
        return sizeof(Module);
dvander@53
   278
dvander@146
   279
      case MapKind_Descriptor:
dvander@146
   280
        return sizeof(Descriptor);
dvander@146
   281
dvander@53
   282
      case MapKind_Function:
dvander@53
   283
        return sizeof(Function);
dvander@53
   284
dvander@54
   285
      case MapKind_String:
dvander@161
   286
        return String::cast(obj)->objSize();
dvander@54
   287
dvander@68
   288
      case MapKind_Native:
dvander@68
   289
        return sizeof(Native);
dvander@68
   290
dvander@53
   291
      case MapKind_Array:
dvander@53
   292
        return Align(Array::SizeOf(Array::cast(obj)), kObjectAlignment);
dvander@53
   293
dvander@168
   294
      case MapKind_Box:
dvander@168
   295
        return sizeof(Box);
dvander@168
   296
dvander@147
   297
      case MapKind_Struct:
dvander@161
   298
        return Struct::cast(obj)->objSize();
dvander@147
   299
dvander@85
   300
      case MapKind_EnvironmentSlotDescriptorArray:
dvander@161
   301
        return EnvironmentSlotDescriptorArray::cast(obj)->objSize();
dvander@85
   302
dvander@85
   303
      case MapKind_Environment:
dvander@161
   304
        return Environment::cast(obj)->objSize();
dvander@85
   305
dvander@53
   306
      case MapKind_MetaArray:
dvander@53
   307
        return sizeof(ArrayMap);
dvander@53
   308
dvander@85
   309
      case MapKind_MetaEnvironment:
dvander@161
   310
        return EnvironmentMap::cast(obj)->objSize();
dvander@85
   311
dvander@147
   312
      case MapKind_MetaStruct:
dvander@161
   313
        return StructMap::cast(obj)->objSize();
dvander@147
   314
dvander@53
   315
      case MapKind_FreeRegion:
dvander@53
   316
        return *reinterpret_cast<size_t *>(reinterpret_cast<Address>(obj + 1));
dvander@53
   317
dvander@53
   318
      default:
dvander@53
   319
        assert(map->kind() == MapKind_Meta);
dvander@53
   320
        return sizeof(Map);
dvander@53
   321
    }
dvander@53
   322
}
dvander@53
   323
dvander@161
   324
static inline size_t
dvander@161
   325
SizeOfObject(Object *obj, Map *map)
dvander@161
   326
{
dvander@161
   327
    return Align(SizeOfObjectRaw(obj, map), kObjectAlignment);
dvander@161
   328
}
dvander@161
   329
dvander@53
   330
class ObjectSizeEvaluator
dvander@53
   331
{
dvander@53
   332
  public:
dvander@53
   333
    size_t operator()(Object *obj, Map *map) {
dvander@53
   334
        return SizeOfObject(obj, map);
dvander@53
   335
    }
dvander@53
   336
};
dvander@53
   337
dvander@45
   338
}
dvander@45
   339
dvander@45
   340
#endif // _include_jc_object_visitor_h_