lib.rs

#![allow(clippy::missing_safety_doc)]

extern crate libc;
extern crate log;
extern crate mmtk;
#[macro_use]
extern crate lazy_static;

use mmtk::util::opaque_pointer::*;
use mmtk::util::Address;
use mmtk::vm::VMBinding;
use mmtk::MMTKBuilder;
use mmtk::MMTK;

use std::collections::HashMap;
use std::sync::atomic::AtomicIsize;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Condvar, Mutex, RwLock};

pub mod active_plan;
pub mod api;
mod build_info;
pub mod collection;
pub mod gc_trigger;
pub mod object_model;
pub mod reference_glue;
pub mod scanning;
pub mod slots;
pub mod util;

pub mod julia_finalizer;
pub mod julia_scanning;
#[allow(non_camel_case_types)]
#[allow(improper_ctypes_definitions)]
#[allow(non_upper_case_globals)]
#[allow(non_snake_case)]
#[allow(clippy::all)]
pub mod julia_types;

#[derive(Default)]
pub struct JuliaVM;

use crate::slots::JuliaVMSlot;

impl VMBinding for JuliaVM {
    const MAX_ALIGNMENT: usize = 64;
    const MIN_ALIGNMENT: usize = 4;
    type VMObjectModel = object_model::VMObjectModel;
    type VMScanning = scanning::VMScanning;
    type VMCollection = collection::VMCollection;
    type VMActivePlan = active_plan::VMActivePlan;
    type VMReferenceGlue = reference_glue::VMReferenceGlue;
    type VMMemorySlice = slots::JuliaMemorySlice;
    type VMSlot = JuliaVMSlot;
}

/// This is used to ensure we initialize MMTk at a specified timing.
pub static MMTK_INITIALIZED: AtomicBool = AtomicBool::new(false);

lazy_static! {
    pub static ref BUILDER: Mutex<MMTKBuilder> = Mutex::new(MMTKBuilder::new());
    pub static ref SINGLETON: MMTK<JuliaVM> = {
        let builder = BUILDER.lock().unwrap();
        debug_assert!(!MMTK_INITIALIZED.load(Ordering::SeqCst));
        let ret = mmtk::memory_manager::mmtk_init(&builder);
        MMTK_INITIALIZED.store(true, std::sync::atomic::Ordering::Relaxed);
        *ret
    };
}

pub static mut JULIA_HEADER_SIZE: usize = 0;
pub static mut JULIA_BUFF_TAG: usize = 0;

#[no_mangle]
pub static BLOCK_FOR_GC: AtomicBool = AtomicBool::new(false);

#[no_mangle]
pub static WORLD_HAS_STOPPED: AtomicBool = AtomicBool::new(false);

#[no_mangle]
pub static DISABLED_GC: AtomicBool = AtomicBool::new(false);

#[no_mangle]
pub static USER_TRIGGERED_GC: AtomicIsize = AtomicIsize::new(0);

lazy_static! {
    pub static ref STW_COND: Arc<(Mutex<usize>, Condvar)> =
        Arc::new((Mutex::new(0), Condvar::new()));
    pub static ref STOP_MUTATORS: Arc<(Mutex<usize>, Condvar)> =
        Arc::new((Mutex::new(0), Condvar::new()));

    // We create a boxed mutator with MMTk core, and we mem copy its content to jl_tls_state_t (shallow copy).
    // This map stores the pair of the mutator address in jl_tls_state_t and the original boxed mutator.
    // As we only do a shallow copy, we should not free the original boxed mutator, until the thread is getting destroyed.
    // Otherwise, we will have dangling pointers.
    pub static ref MUTATORS: RwLock<HashMap<Address, Address>> = RwLock::new(HashMap::new());
}

type ProcessSlotFn = *const extern "C" fn(closure: Address, slot: Address);

#[allow(improper_ctypes)]
extern "C" {
    pub fn jl_gc_scan_julia_exc_obj(obj: Address, closure: Address, process_slot: ProcessSlotFn);
    pub fn jl_gc_get_stackbase(tid: i16) -> usize;
    pub fn jl_throw_out_of_memory_error();
    pub fn jl_get_gc_disable_counter() -> u32;
    pub fn jl_gc_mmtk_sweep_malloced_memory();
    pub fn jl_gc_sweep_stack_pools_and_mtarraylist_buffers();
    pub fn jl_hrtime() -> u64;
    pub fn jl_gc_update_stats(t: u64, mmtk_live_bytes: usize, is_nursery: bool);
    pub fn jl_gc_get_abi_structs_checksum_c() -> usize;
    pub fn jl_gc_get_thread_finalizer_list(tls: OpaquePointer) -> Address;
    pub fn jl_gc_get_to_finalize_list() -> Address;
    pub fn jl_gc_get_marked_finalizers_list() -> Address;
    pub fn arraylist_grow(a: Address, n: usize);
    pub fn jl_gc_get_have_pending_finalizers() -> *mut i32;
    pub fn jl_gc_scan_vm_specific_roots(closure: *mut crate::slots::RootsWorkClosure);
    pub fn jl_gc_update_inlined_array(to: Address, from: Address);
    pub fn jl_gc_prepare_to_collect();
    pub fn jl_gc_get_owner_address_to_mmtk(m: Address) -> Address;
    pub fn jl_gc_genericmemory_how(m: Address) -> usize;
    pub fn jl_gc_get_max_memory() -> usize;
}

pub(crate) fn set_panic_hook() {
    let old_hook = std::panic::take_hook();

    std::panic::set_hook(Box::new(move |panic_info| {
        if crate::collection::is_gc_thread() {
            eprintln!("ERROR: An MMTk GC thread panicked.  This is a bug.");
            eprintln!("{panic_info}");

            let bt = std::backtrace::Backtrace::capture();
            match bt.status() {
                std::backtrace::BacktraceStatus::Unsupported => {
                    eprintln!("Backtrace is unsupported.")
                }
                std::backtrace::BacktraceStatus::Disabled => {
                    eprintln!("Backtrace is disabled.");
                    eprintln!(
                        "run with `RUST_BACKTRACE=1` environment variable to display a backtrace"
                    );
                }
                std::backtrace::BacktraceStatus::Captured => {
                    eprintln!("{bt}");
                }
                s => {
                    eprintln!("Unknown backtrace status: {s:?}");
                }
            }

            std::process::abort();
        } else {
            old_hook(panic_info);
        }
    }));
}