blob: 468c1adae90d43325f221f796015ed7c613a6b46 [file] [log] [blame]
// Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
#ifndef VM_ALLOCATION_H_
#define VM_ALLOCATION_H_
#include "platform/assert.h"
#include "vm/base_isolate.h"
#include "vm/globals.h"
namespace dart {
// Forward declarations.
class Isolate;
class Thread;
// Stack allocated objects subclass from this base class. Objects of this type
// cannot be allocated on either the C or object heaps. Destructors for objects
// of this type will not be run unless the stack is unwound through normal
// program control flow.
class ValueObject {
public:
ValueObject() { }
~ValueObject() { }
private:
DISALLOW_ALLOCATION();
DISALLOW_COPY_AND_ASSIGN(ValueObject);
};
// Stack resources subclass from this base class. The VM will ensure that the
// destructors of these objects are called before the stack is unwound past the
// objects location on the stack. Use stack resource objects if objects
// need to be destroyed even in the case of exceptions when a Longjump is done
// to a stack frame above the frame where these objects were allocated.
class StackResource {
public:
// DEPRECATED: Use Thread-based interface. During migration, this defaults
// to using the mutator thread (which must also be the current thread).
explicit StackResource(Isolate* isolate) : thread_(NULL), previous_(NULL) {
Init((isolate == NULL) ?
NULL : reinterpret_cast<BaseIsolate*>(isolate)->mutator_thread_);
}
explicit StackResource(Thread* thread) : thread_(NULL), previous_(NULL) {
Init(thread);
}
virtual ~StackResource();
// Convenient access to the isolate of the thread of this resource.
Isolate* isolate() const;
// The thread that owns this resource.
Thread* thread() const { return thread_; }
// Destroy stack resources of thread until top exit frame.
static void Unwind(Thread* thread) { UnwindAbove(thread, NULL); }
// Destroy stack resources of thread above new_top, exclusive.
static void UnwindAbove(Thread* thread, StackResource* new_top);
private:
void Init(Thread* thread);
Thread* thread_;
StackResource* previous_;
DISALLOW_ALLOCATION();
DISALLOW_IMPLICIT_CONSTRUCTORS(StackResource);
};
// Static allocated classes only contain static members and can never
// be instantiated in the heap or on the stack.
class AllStatic {
private:
DISALLOW_ALLOCATION();
DISALLOW_IMPLICIT_CONSTRUCTORS(AllStatic);
};
// Zone allocated objects cannot be individually deallocated, but have
// to rely on the destructor of Zone which is called when the Zone
// goes out of scope to reclaim memory.
class ZoneAllocated {
public:
ZoneAllocated() { }
// Implicitly allocate the object in the current zone.
void* operator new(uword size);
// Allocate the object in the given zone, which must be the current zone.
void* operator new(uword size, Zone* zone);
// Ideally, the delete operator should be protected instead of
// public, but unfortunately the compiler sometimes synthesizes
// (unused) destructors for classes derived from ZoneObject, which
// require the operator to be visible. MSVC requires the delete
// operator to be public.
// Disallow explicit deallocation of nodes. Nodes can only be
// deallocated by invoking DeleteAll() on the zone they live in.
void operator delete(void* pointer) { UNREACHABLE(); }
private:
DISALLOW_COPY_AND_ASSIGN(ZoneAllocated);
};
// Within a NoSafepointScope, the thread must not reach any safepoint. Used
// around code that manipulates raw object pointers directly without handles.
#if defined(DEBUG)
class NoSafepointScope : public StackResource {
public:
NoSafepointScope();
~NoSafepointScope();
private:
DISALLOW_COPY_AND_ASSIGN(NoSafepointScope);
};
#else // defined(DEBUG)
class NoSafepointScope : public ValueObject {
public:
NoSafepointScope() {}
private:
DISALLOW_COPY_AND_ASSIGN(NoSafepointScope);
};
#endif // defined(DEBUG)
} // namespace dart
#endif // VM_ALLOCATION_H_