Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
481 lines (359 sloc) 10.6 KB
#ifndef RBX_VM_H
#define RBX_VM_H
#include "missing/time.h"
#include "globals.hpp"
#include "gc/object_mark.hpp"
#include "gc/managed.hpp"
#include "thread_state.hpp"
#include "util/refcount.hpp"
#include "util/thread.hpp"
#include "call_frame_list.hpp"
#include "gc/variable_buffer.hpp"
#include "gc/root_buffer.hpp"
#include "gc/slab.hpp"
#include "shared_state.hpp"
#include <vector>
#include <setjmp.h>
namespace llvm {
class Module;
namespace rbxti {
class Env;
namespace rubinius {
class Exception;
class LLVMState;
namespace event {
class Loop;
namespace gc {
class WriteBarrier;
class Channel;
class GlobalCache;
class Primitives;
class ObjectMemory;
class TypeInfo;
class String;
class Symbol;
class ConfigParser;
class TypeError;
class Assertion;
struct CallFrame;
class Object;
class Configuration;
struct Interrupts;
class VMManager;
class LookupTable;
class SymbolTable;
class SharedState;
class Fiber;
enum MethodMissingReason {
eNone, ePrivate, eProtected, eSuper, eVCall, eNormal
* Represents an execution context for running Ruby code.
* Each Ruby thread is backed by an instance of this class, as well as an
* instance of the Thread class. Thread manages the (Ruby visible) thread-
* related state, while this class manages the execution machinery for
* running Ruby code.
class VM : public ManagedThread {
CallFrame* saved_call_frame_;
uintptr_t stack_start_;
uintptr_t stack_limit_;
int stack_size_;
bool run_signals_;
MethodMissingReason method_missing_reason_;
void* young_start_;
void* young_end_;
bool thread_step_;
rbxti::Env* tooling_env_;
bool tooling_;
/* Data members */
SharedState& shared;
TypedRoot<Channel*> waiting_channel_;
TypedRoot<Exception*> interrupted_exception_;
bool interrupt_with_signal_;
InflatedHeader* waiting_header_;
void (*custom_wakeup_)(void*);
void* custom_wakeup_data_;
ObjectMemory* om;
Interrupts& interrupts;
bool check_local_interrupts;
ThreadState thread_state_;
/// The Thread object for this VM state
TypedRoot<Thread*> thread;
/// The current fiber running on this thread
TypedRoot<Fiber*> current_fiber;
/// Root fiber, if any (lazily initialized)
TypedRoot<Fiber*> root_fiber;
static unsigned long cStackDepthMax;
public: /* Inline methods */
uint32_t thread_id() {
return id_;
bool run_signals_p() {
return run_signals_;
void set_run_signals(bool val) {
run_signals_ = val;
ThreadState* thread_state() {
return &thread_state_;
CallFrame** call_frame_location() {
return &saved_call_frame_;
void set_call_frame(CallFrame* frame) {
saved_call_frame_ = frame;
CallFrame* saved_call_frame() {
return saved_call_frame_;
GlobalCache* global_cache() {
return shared.global_cache;
Globals& globals() {
return shared.globals;
void* stack_start() {
return reinterpret_cast<void*>(stack_start_);
int stack_size() {
return stack_size_;
void reset_stack_limit() {
// @TODO assumes stack growth direction
stack_limit_ = (stack_start_ - stack_size_) + (4096 * 3);
void set_stack_bounds(uintptr_t start, int length) {
stack_start_ = start;
stack_size_ = length;
void set_stack_start(void* s) {
set_stack_bounds(reinterpret_cast<uintptr_t>(s), stack_size_);
void set_stack_size(int s) {
set_stack_bounds(stack_start_, s);
void get_attention() {
stack_limit_ = stack_start_;
bool detect_stack_condition(void* end) {
// @TODO assumes stack growth direction
return reinterpret_cast<uintptr_t>(end) < stack_limit_;
bool check_stack(CallFrame* call_frame, void* end) {
// @TODO assumes stack growth direction
if(unlikely(reinterpret_cast<uintptr_t>(end) < stack_limit_)) {
return false;
return true;
bool check_interrupts(CallFrame* call_frame, void* end);
MethodMissingReason method_missing_reason() {
return method_missing_reason_;
void set_method_missing_reason(MethodMissingReason reason) {
method_missing_reason_ = reason;
bool young_object_p(Object* obj) {
return obj >= young_start_ && obj <= young_end_;
bool thread_step() {
return thread_step_;
void clear_thread_step() {
thread_step_ = false;
void set_thread_step() {
thread_step_ = true;
Exception* interrupted_exception() {
return interrupted_exception_.get();
void clear_interrupted_exception() {
rbxti::Env* tooling_env() {
return tooling_env_;
bool tooling() {
return tooling_;
void enable_tooling() {
tooling_ = true;
void disable_tooling() {
tooling_ = false;
static void init_stack_size();
static VM* current();
static void set_current(VM* vm);
static void discard(STATE, VM*);
/* Prototypes */
VM(uint32_t id, SharedState& shared);
void check_exception(CallFrame* call_frame);
void initialize_as_root();
void bootstrap_class();
void bootstrap_ontology();
void bootstrap_symbol();
void initialize_config();
void setup_errno(int num, const char* name, Class* sce, Module* ern);
void bootstrap_exceptions();
void initialize_fundamental_constants();
void initialize_builtin_classes();
void initialize_platform_data();
void set_current_fiber(Fiber* fib);
void raise_stack_error(CallFrame* call_frame);
Object* new_object_typed(Class* cls, size_t bytes, object_type type);
Object* new_object_typed_mature(Class* cls, size_t bytes, object_type type);
Object* new_object_from_type(Class* cls, TypeInfo* ti);
template <class T>
T* new_object(Class *cls) {
return reinterpret_cast<T*>(new_object_typed(cls, sizeof(T), T::type));
template <class T>
T* new_struct(Class* cls, size_t bytes = 0) {
T* obj = reinterpret_cast<T*>(new_object_typed(cls, sizeof(T) + bytes, T::type));
return obj;
template <class T>
T* new_object_mature(Class *cls) {
return reinterpret_cast<T*>(new_object_typed_mature(cls, sizeof(T), T::type));
template <class T>
T* new_object_bytes(Class* cls, size_t& bytes) {
bytes = ObjectHeader::align(sizeof(T) + bytes);
T* obj = reinterpret_cast<T*>(new_object_typed(cls, bytes, T::type));
return obj;
template <class T>
T* new_object_variable(Class* cls, size_t fields, size_t& bytes) {
bytes = sizeof(T) + (fields * sizeof(Object*));
return reinterpret_cast<T*>(new_object_typed(cls, bytes, T::type));
/// Create a Tuple in the young GC space, return NULL if not possible.
Tuple* new_young_tuple_dirty(size_t fields);
/// Create an uninitialized Class object
Class* new_basic_class(Class* sup);
/// Create a Class of name +name+ as an Object subclass
Class* new_class(const char* name);
/// Create a Class of name +name+ as a subclass of +super_class+
Class* new_class(const char* name, Class* super_class);
/// Create a Class of name +name+ as a subclass of +sup+
/// under Module +under+
Class* new_class(const char* name, Class* sup, Module* under);
/// Create a Class of name +name+ under +under+
Class* new_class_under(const char* name, Module* under);
Module* new_module(const char* name, Module* under = NULL);
Symbol* symbol(const char* str);
Symbol* symbol(std::string str);
Symbol* symbol(String* str);
TypeInfo* find_type(int type);
void init_ffi();
void init_native_libraries();
Thread* current_thread();
void collect(CallFrame* call_frame);
/// Check the GC flags in ObjectMemory and collect if we need to.
void collect_maybe(CallFrame* call_frame);
void raise_from_errno(const char* reason);
void raise_exception(Exception* exc);
Exception* new_exception(Class* cls, const char* msg);
Object* current_block();
void set_const(const char* name, Object* val);
void set_const(Module* mod, const char* name, Object* val);
llvm::Module* llvm_module();
void llvm_cleanup();
void print_backtrace();
/// Run the garbage collectors as soon as you can
void run_gc_soon();
void wait_on_channel(Channel* channel);
void wait_on_inflated_lock(InflatedHeader* ih);
void wait_on_custom_function(void (*func)(void*), void* data);
void clear_waiter();
bool wakeup(STATE);
bool waiting_p();
void set_sleeping();
void clear_sleeping();
void interrupt_with_signal();
bool should_interrupt_with_signal() {
return interrupt_with_signal_;
void register_raise(STATE, Exception* exc);
bool process_async(CallFrame* call_frame);
bool check_async(CallFrame* call_frame) {
if(check_local_interrupts) {
return process_async(call_frame);
return true;
// For thread-local roots
static std::list<Roots*>* roots;
* Instantiation of an instance of this class causes Ruby execution on all
* threads to be suspended. Upon destruction of the instance, Ruby execution
* is resumed.
class StopTheWorld {
VM* vm_;
StopTheWorld(STATE) :
~StopTheWorld() {
class NativeMethodEnvironment;
class GCIndependent {
VM* vm_;
GCIndependent(STATE, CallFrame* call_frame)
: vm_(state)
: vm_(state)
GCIndependent(NativeMethodEnvironment* env);
~GCIndependent() {
template <class T>
class GCIndependentLockGuard : public thread::LockGuardTemplate<T> {
VM* vm_;
GCIndependentLockGuard(STATE, T& in_lock)
: thread::LockGuardTemplate<T>(in_lock, false)
, vm_(state)
~GCIndependentLockGuard() {
typedef GCIndependentLockGuard<thread::Mutex> GCLockGuard;
Something went wrong with that request. Please try again.