path: root/zjit/src/cruby_methods.rs

/*! This module contains assertions we make about runtime properties of core library methods.
 * Some properties that influence codegen:
 *  - Whether the method has been redefined since boot
 *  - Whether the C method can yield to the GC
 *  - Whether the C method makes any method calls
 *
 * For Ruby methods, many of these properties can be inferred through analyzing the
 * bytecode, but for C methods we resort to annotation and validation in debug builds.
 */

use crate::cruby::*;
use std::collections::HashMap;
use std::ffi::c_void;
use crate::hir_type::{types, Type};
use crate::hir;

pub struct Annotations {
    cfuncs: HashMap<*mut c_void, FnProperties>,
    builtin_funcs: HashMap<*mut c_void, FnProperties>,
}

/// Runtime behaviors of C functions that implement a Ruby method
#[derive(Clone, Copy)]
pub struct FnProperties {
    /// Whether it's possible for the function to yield to the GC
    pub no_gc: bool,
    /// Whether it's possible for the function to make a ruby call
    pub leaf: bool,
    /// What Type the C function returns
    pub return_type: Type,
    /// Whether it's legal to remove the call if the result is unused
    pub elidable: bool,
    pub inline: fn(&mut hir::Function, hir::BlockId, hir::InsnId, &[hir::InsnId], hir::InsnId) -> Option<hir::InsnId>,
}

/// A safe default for un-annotated Ruby methods: we can't optimize them or their returned values.
impl Default for FnProperties {
    fn default() -> Self {
        Self {
            no_gc: false,
            leaf: false,
            return_type: types::BasicObject,
            elidable: false,
            inline: no_inline,
        }
    }
}

impl Annotations {
    /// Query about properties of a C method
    pub fn get_cfunc_properties(&self, method: *const rb_callable_method_entry_t) -> Option<FnProperties> {
        let fn_ptr = unsafe {
            if VM_METHOD_TYPE_CFUNC != get_cme_def_type(method) {
                return None;
            }
            get_mct_func(get_cme_def_body_cfunc(method.cast()))
        };
        self.cfuncs.get(&fn_ptr).copied()
    }

    /// Query about properties of a builtin function by its pointer
    pub fn get_builtin_properties(&self, bf: *const rb_builtin_function) -> Option<FnProperties> {
        let func_ptr = unsafe { (*bf).func_ptr as *mut c_void };
        self.builtin_funcs.get(&func_ptr).copied()
    }
}

fn annotate_c_method(props_map: &mut HashMap<*mut c_void, FnProperties>, class: VALUE, method_name: &'static str, props: FnProperties) {
    // Lookup function pointer of the C method
    let fn_ptr = unsafe {
        // TODO(alan): (side quest) make rust methods and clean up glue code for rb_method_cfunc_t and
        // rb_method_definition_t.
        let method_id = rb_intern2(method_name.as_ptr().cast(), method_name.len() as _);
        let method = rb_method_entry_at(class, method_id);
        assert!(!method.is_null());
        // ME-to-CME cast is fine due to identical layout
        debug_assert_eq!(VM_METHOD_TYPE_CFUNC, get_cme_def_type(method.cast()));
        get_mct_func(get_cme_def_body_cfunc(method.cast()))
    };

    props_map.insert(fn_ptr, props);
}

/// Look up a method and find its builtin function pointer by parsing its ISEQ
/// We currently only support methods with exactly one invokebuiltin instruction
fn annotate_builtin_method(props_map: &mut HashMap<*mut c_void, FnProperties>, class: VALUE, method_name: &'static str, props: FnProperties) {
    unsafe {
        let method_id = rb_intern2(method_name.as_ptr().cast(), method_name.len().try_into().unwrap());
        let method = rb_method_entry_at(class, method_id);
        if method.is_null() {
            panic!("Method {}#{} not found", std::ffi::CStr::from_ptr(rb_class2name(class)).to_str().unwrap_or("?"), method_name);
        }

        // Cast ME to CME - they have identical layout
        let cme = method.cast::<rb_callable_method_entry_t>();
        let def_type = get_cme_def_type(cme);

        if def_type != VM_METHOD_TYPE_ISEQ {
            panic!("Method {}#{} is not an ISEQ method (type: {})",
                std::ffi::CStr::from_ptr(rb_class2name(class)).to_str().unwrap_or("?"),
                method_name, def_type);
        }

        // Get the ISEQ from the method definition
        let iseq = get_def_iseq_ptr((*cme).def);
        if iseq.is_null() {
            panic!("Failed to get ISEQ for {}#{}",
                std::ffi::CStr::from_ptr(rb_class2name(class)).to_str().unwrap_or("?"),
                method_name);
        }

        // Get the size of the ISEQ in instruction units
        let encoded_size = rb_iseq_encoded_size(iseq);

        // Scan through the ISEQ to find invokebuiltin instructions
        let mut insn_idx: u32 = 0;
        let mut func_ptr = std::ptr::null_mut::<c_void>();

        while insn_idx < encoded_size {
            // Get the PC for this instruction index
            let pc = rb_iseq_pc_at_idx(iseq, insn_idx);

            // Get the opcode using the proper decoder
            let opcode = rb_iseq_opcode_at_pc(iseq, pc);

            if opcode == YARVINSN_invokebuiltin as i32 ||
               opcode == YARVINSN_opt_invokebuiltin_delegate as i32 ||
               opcode == YARVINSN_opt_invokebuiltin_delegate_leave as i32 {
                // The first operand is the builtin function pointer
                let bf_value = *pc.add(1);
                let bf_ptr: *const rb_builtin_function = bf_value.as_ptr();

                if func_ptr.is_null() {
                    func_ptr = (*bf_ptr).func_ptr as *mut c_void;
                } else {
                    panic!("Multiple invokebuiltin instructions found in ISEQ for {}#{}",
                        std::ffi::CStr::from_ptr(rb_class2name(class)).to_str().unwrap_or("?"),
                        method_name);
                }
            }

            // Move to the next instruction using the proper length
            insn_idx = insn_idx.saturating_add(rb_insn_len(VALUE(opcode as usize)).try_into().unwrap());
        }

        // Only insert the properties if its iseq has exactly one invokebuiltin instruction
        props_map.insert(func_ptr, props);
    }
}

/// Gather annotations. Run this right after boot since the annotations
/// are about the stock versions of methods.
pub fn init() -> Annotations {
    let cfuncs = &mut HashMap::new();
    let builtin_funcs = &mut HashMap::new();

    macro_rules! annotate {
        ($module:ident, $method_name:literal, $inline:ident) => {
            let mut props = FnProperties::default();
            props.inline = $inline;
            #[allow(unused_unsafe)]
            annotate_c_method(cfuncs, unsafe { $module }, $method_name, props);
        };
        ($module:ident, $method_name:literal, $inline:ident, $return_type:expr $(, $properties:ident)*) => {
            let mut props = FnProperties::default();
            props.return_type = $return_type;
            props.inline = $inline;
            $(
                props.$properties = true;
            )*
            #[allow(unused_unsafe)]
            annotate_c_method(cfuncs, unsafe { $module }, $method_name, props);
        };
        ($module:ident, $method_name:literal, $return_type:expr $(, $properties:ident)*) => {
            let mut props = FnProperties::default();
            props.return_type = $return_type;
            $(
                props.$properties = true;
            )*
            #[allow(unused_unsafe)]
            annotate_c_method(cfuncs, unsafe { $module }, $method_name, props);
        }
    }

    macro_rules! annotate_builtin {
        ($module:ident, $method_name:literal, $return_type:expr) => {
            annotate_builtin!($module, $method_name, $return_type, no_gc, leaf, elidable)
        };
        ($module:ident, $method_name:literal, $return_type:expr $(, $properties:ident)*) => {
            let mut props = FnProperties::default();
            props.return_type = $return_type;
            $(props.$properties = true;)+
            annotate_builtin_method(builtin_funcs, unsafe { $module }, $method_name, props);
        };
        ($module:ident, $method_name:literal, $inline:ident, $return_type:expr $(, $properties:ident)*) => {
            let mut props = FnProperties::default();
            props.return_type = $return_type;
            props.inline = $inline;
            $(props.$properties = true;)+
            annotate_builtin_method(builtin_funcs, unsafe { $module }, $method_name, props);
        }
    }

    annotate!(rb_mKernel, "itself", inline_kernel_itself);
    annotate!(rb_mKernel, "block_given?", inline_kernel_block_given_p);
    annotate!(rb_mKernel, "===", inline_eqq);
    annotate!(rb_mKernel, "is_a?", inline_kernel_is_a_p);
    annotate!(rb_cString, "bytesize", inline_string_bytesize);
    annotate!(rb_cString, "size", types::Fixnum, no_gc, leaf, elidable);
    annotate!(rb_cString, "length", types::Fixnum, no_gc, leaf, elidable);
    annotate!(rb_cString, "getbyte", inline_string_getbyte);
    annotate!(rb_cString, "setbyte", inline_string_setbyte);
    annotate!(rb_cString, "empty?", inline_string_empty_p, types::BoolExact, no_gc, leaf, elidable);
    annotate!(rb_cString, "<<", inline_string_append);
    annotate!(rb_cString, "==", inline_string_eq);
    // Not elidable; has a side effect of setting the encoding if ENC_CODERANGE_UNKNOWN.
    // TOOD(max): Turn this into a load/compare. Will need to side-exit or do the full call if
    // ENC_CODERANGE_UNKNOWN.
    annotate!(rb_cString, "ascii_only?", types::BoolExact, no_gc, leaf);
    annotate!(rb_cModule, "name", types::StringExact.union(types::NilClass), no_gc, leaf, elidable);
    annotate!(rb_cModule, "===", inline_module_eqq, types::BoolExact, no_gc, leaf);
    annotate!(rb_cArray, "length", inline_array_length, types::Fixnum, no_gc, leaf, elidable);
    annotate!(rb_cArray, "empty?", inline_array_empty_p, types::BoolExact, no_gc, leaf, elidable);
    annotate!(rb_cArray, "reverse", types::ArrayExact, leaf, elidable);
    annotate!(rb_cArray, "join", types::StringExact);
    annotate!(rb_cArray, "[]", inline_array_aref);
    annotate!(rb_cArray, "[]=", inline_array_aset);
    annotate!(rb_cArray, "<<", inline_array_push);
    annotate!(rb_cArray, "push", inline_array_push);
    annotate!(rb_cArray, "pop", inline_array_pop);
    annotate!(rb_cHash, "[]", inline_hash_aref);
    annotate!(rb_cHash, "[]=", inline_hash_aset);
    annotate!(rb_cHash, "size", types::Fixnum, no_gc, leaf, elidable);
    annotate!(rb_cHash, "empty?", types::BoolExact, no_gc, leaf, elidable);
    annotate!(rb_cNilClass, "nil?", inline_nilclass_nil_p);
    annotate!(rb_mKernel, "nil?", inline_kernel_nil_p);
    annotate!(rb_mKernel, "respond_to?", inline_kernel_respond_to_p);
    annotate!(rb_cBasicObject, "==", inline_basic_object_eq, types::BoolExact, no_gc, leaf, elidable);
    annotate!(rb_cBasicObject, "!", inline_basic_object_not, types::BoolExact, no_gc, leaf, elidable);
    annotate!(rb_cBasicObject, "!=", inline_basic_object_neq, types::BoolExact);
    annotate!(rb_cBasicObject, "initialize", inline_basic_object_initialize);
    annotate!(rb_cInteger, "succ", inline_integer_succ);
    annotate!(rb_cInteger, "^", inline_integer_xor);
    annotate!(rb_cInteger, "==", inline_integer_eq);
    annotate!(rb_cInteger, "+", inline_integer_plus);
    annotate!(rb_cInteger, "-", inline_integer_minus);
    annotate!(rb_cInteger, "*", inline_integer_mult);
    annotate!(rb_cInteger, "/", inline_integer_div);
    annotate!(rb_cInteger, "%", inline_integer_mod);
    annotate!(rb_cInteger, "&", inline_integer_and);
    annotate!(rb_cInteger, "|", inline_integer_or);
    annotate!(rb_cInteger, ">", inline_integer_gt);
    annotate!(rb_cInteger, ">=", inline_integer_ge);
    annotate!(rb_cInteger, "<", inline_integer_lt);
    annotate!(rb_cInteger, "<=", inline_integer_le);
    annotate!(rb_cInteger, "<<", inline_integer_lshift);
    annotate!(rb_cInteger, ">>", inline_integer_rshift);
    annotate!(rb_cInteger, "[]", inline_integer_aref);
    annotate!(rb_cInteger, "to_s", types::StringExact);
    annotate!(rb_cString, "to_s", inline_string_to_s, types::StringExact);
    let thread_singleton = unsafe { rb_singleton_class(rb_cThread) };
    annotate!(thread_singleton, "current", inline_thread_current, types::BasicObject, no_gc, leaf);

    annotate_builtin!(rb_mKernel, "Float", types::Float);
    annotate_builtin!(rb_mKernel, "Integer", types::Integer);
    // TODO(max): Annotate rb_mKernel#class as returning types::Class. Right now there is a subtle
    // type system bug that causes an issue if we make it return types::Class.
    annotate_builtin!(rb_mKernel, "class", inline_kernel_class, types::HeapObject, leaf);
    annotate_builtin!(rb_mKernel, "frozen?", types::BoolExact);
    annotate_builtin!(rb_cSymbol, "name", types::StringExact);
    annotate_builtin!(rb_cSymbol, "to_s", types::StringExact);

    Annotations {
        cfuncs: std::mem::take(cfuncs),
        builtin_funcs: std::mem::take(builtin_funcs),
    }
}

fn no_inline(_fun: &mut hir::Function, _block: hir::BlockId, _recv: hir::InsnId, _args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    None
}

fn inline_string_to_s(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    if args.is_empty() && fun.likely_a(recv, types::StringExact, state) {
        let recv = fun.coerce_to(block, recv, types::StringExact, state);
        return Some(recv);
    }
    None
}

fn inline_thread_current(fun: &mut hir::Function, block: hir::BlockId, _recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    let &[] = args else { return None; };
    let ec = fun.push_insn(block, hir::Insn::LoadEC);
    let thread_ptr = fun.push_insn(block, hir::Insn::LoadField {
        recv: ec,
        id: ID!(thread_ptr),
        offset: RUBY_OFFSET_EC_THREAD_PTR as i32,
        return_type: types::CPtr,
    });
    let thread_self = fun.push_insn(block, hir::Insn::LoadField {
        recv: thread_ptr,
        id: ID!(self_),
        offset: RUBY_OFFSET_THREAD_SELF as i32,
        // TODO(max): Add Thread type. But Thread.current is not guaranteed to be an exact Thread.
        // You can make subclasses...
        return_type: types::BasicObject,
    });
    Some(thread_self)
}

fn inline_kernel_itself(_fun: &mut hir::Function, _block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    if args.is_empty() {
        // No need to coerce the receiver; that is done by the SendWithoutBlock rewriting.
        return Some(recv);
    }
    None
}

fn inline_kernel_block_given_p(fun: &mut hir::Function, block: hir::BlockId, _recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    let &[] = args else { return None; };
    // TODO(max): In local iseq types that are not ISEQ_TYPE_METHOD, rewrite to Constant false.
    Some(fun.push_insn(block, hir::Insn::IsBlockGiven))
}

fn inline_array_aref(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    if let &[index] = args {
        if fun.likely_a(index, types::Fixnum, state) {
            let index = fun.coerce_to(block, index, types::Fixnum, state);
            let result = fun.push_insn(block, hir::Insn::ArrayArefFixnum { array: recv, index });
            return Some(result);
        }
    }
    None
}

fn inline_array_aset(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    if let &[index, val] = args {
        if fun.likely_a(recv, types::ArrayExact, state)
            && fun.likely_a(index, types::Fixnum, state)
        {
            let recv = fun.coerce_to(block, recv, types::ArrayExact, state);
            let index = fun.coerce_to(block, index, types::Fixnum, state);
            let recv = fun.push_insn(block, hir::Insn::GuardNotFrozen { recv, state });
            let recv = fun.push_insn(block, hir::Insn::GuardNotShared { recv, state });

            // Bounds check: unbox Fixnum index and guard 0 <= idx < length.
            let index = fun.push_insn(block, hir::Insn::UnboxFixnum { val: index });
            let length = fun.push_insn(block, hir::Insn::ArrayLength { array: recv });
            let index = fun.push_insn(block, hir::Insn::GuardLess { left: index, right: length, state });
            let zero = fun.push_insn(block, hir::Insn::Const { val: hir::Const::CInt64(0) });
            let index = fun.push_insn(block, hir::Insn::GuardGreaterEq { left: index, right: zero, state });

            let _ = fun.push_insn(block, hir::Insn::ArrayAset { array: recv, index, val });
            fun.push_insn(block, hir::Insn::WriteBarrier { recv, val });
            return Some(val);
        }
    }
    None
}

fn inline_array_push(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    // Inline only the case of `<<` or `push` when called with a single argument.
    if let &[val] = args {
        let _ = fun.push_insn(block, hir::Insn::ArrayPush { array: recv, val, state });
        return Some(recv);
    }
    None
}

fn inline_array_pop(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    // Only inline the case of no arguments.
    let &[] = args else { return None; };
    // We know that all Array are HeapObject, so no need to insert a GuardType(HeapObject).
    let arr = fun.push_insn(block, hir::Insn::GuardNotFrozen { recv, state });
    Some(fun.push_insn(block, hir::Insn::ArrayPop { array: arr, state }))
}

fn inline_hash_aref(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[key] = args else { return None; };

    // Only optimize exact Hash, not subclasses
    if fun.likely_a(recv, types::HashExact, state) {
        let recv = fun.coerce_to(block, recv, types::HashExact, state);
        let result = fun.push_insn(block, hir::Insn::HashAref { hash: recv, key, state });
        Some(result)
    } else {
        None
    }
}

fn inline_hash_aset(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[key, val] = args else { return None; };

    // Only optimize exact Hash, not subclasses
    if fun.likely_a(recv, types::HashExact, state) {
        let recv = fun.coerce_to(block, recv, types::HashExact, state);
        let _ = fun.push_insn(block, hir::Insn::HashAset { hash: recv, key, val, state });
        // Hash#[]= returns the value, not the hash
        Some(val)
    } else {
        None
    }
}

fn inline_string_bytesize(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    if args.is_empty() && fun.likely_a(recv, types::String, state) {
        let recv = fun.coerce_to(block, recv, types::String, state);
        let len = fun.push_insn(block, hir::Insn::LoadField {
            recv,
            id: ID!(len),
            offset: RUBY_OFFSET_RSTRING_LEN as i32,
            return_type: types::CInt64,
        });

        let result = fun.push_insn(block, hir::Insn::BoxFixnum {
            val: len,
            state,
        });

        return Some(result);
    }
    None
}

fn inline_string_getbyte(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[index] = args else { return None; };
    if fun.likely_a(index, types::Fixnum, state) {
        // String#getbyte with a Fixnum is leaf and nogc; otherwise it may run arbitrary Ruby code
        // when converting the index to a C integer.
        let index = fun.coerce_to(block, index, types::Fixnum, state);
        let unboxed_index = fun.push_insn(block, hir::Insn::UnboxFixnum { val: index });
        let len = fun.push_insn(block, hir::Insn::LoadField {
            recv,
            id: ID!(len),
            offset: RUBY_OFFSET_RSTRING_LEN as i32,
            return_type: types::CInt64,
        });
        // TODO(max): Find a way to mark these guards as not needed for correctness... as in, once
        // the data dependency is gone (say, the StringGetbyte is elided), they can also be elided.
        //
        // This is unlike most other guards.
        let unboxed_index = fun.push_insn(block, hir::Insn::GuardLess { left: unboxed_index, right: len, state });
        let zero = fun.push_insn(block, hir::Insn::Const { val: hir::Const::CInt64(0) });
        let _ = fun.push_insn(block, hir::Insn::GuardGreaterEq { left: unboxed_index, right: zero, state });
        let result = fun.push_insn(block, hir::Insn::StringGetbyte { string: recv, index: unboxed_index });
        return Some(result);
    }
    None
}

fn inline_string_setbyte(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[index, value] = args else { return None; };
    if fun.likely_a(index, types::Fixnum, state) && fun.likely_a(value, types::Fixnum, state) {
        let index = fun.coerce_to(block, index, types::Fixnum, state);
        let value = fun.coerce_to(block, value, types::Fixnum, state);

        let unboxed_index = fun.push_insn(block, hir::Insn::UnboxFixnum { val: index });
        let len = fun.push_insn(block, hir::Insn::LoadField {
            recv,
            id: ID!(len),
            offset: RUBY_OFFSET_RSTRING_LEN as i32,
            return_type: types::CInt64,
        });
        let unboxed_index = fun.push_insn(block, hir::Insn::GuardLess { left: unboxed_index, right: len, state });
        let zero = fun.push_insn(block, hir::Insn::Const { val: hir::Const::CInt64(0) });
        let _ = fun.push_insn(block, hir::Insn::GuardGreaterEq { left: unboxed_index, right: zero, state });
        // We know that all String are HeapObject, so no need to insert a GuardType(HeapObject).
        let recv = fun.push_insn(block, hir::Insn::GuardNotFrozen { recv, state });
        let _ = fun.push_insn(block, hir::Insn::StringSetbyteFixnum { string: recv, index, value });
        // String#setbyte returns the fixnum provided as its `value` argument back to the caller.
        Some(value)
    } else {
        None
    }
}

fn inline_string_empty_p(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    let &[] = args else { return None; };
    let len = fun.push_insn(block, hir::Insn::LoadField {
        recv,
        id: ID!(len),
        offset: RUBY_OFFSET_RSTRING_LEN as i32,
        return_type: types::CInt64,
    });
    let zero = fun.push_insn(block, hir::Insn::Const { val: hir::Const::CInt64(0) });
    let is_zero = fun.push_insn(block, hir::Insn::IsBitEqual { left: len, right: zero });
    let result = fun.push_insn(block, hir::Insn::BoxBool { val: is_zero });
    Some(result)
}

fn inline_string_append(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    // Inline only StringExact << String, which matches original type check from
    // `vm_opt_ltlt`, which checks `RB_TYPE_P(obj, T_STRING)`.
    if fun.likely_a(recv, types::StringExact, state) && fun.likely_a(other, types::String, state) {
        let recv = fun.coerce_to(block, recv, types::StringExact, state);
        let other = fun.coerce_to(block, other, types::String, state);
        let _ = fun.push_insn(block, hir::Insn::StringAppend { recv, other, state });
        return Some(recv);
    }
    if fun.likely_a(recv, types::StringExact, state) && fun.likely_a(other, types::Fixnum, state) {
        let recv = fun.coerce_to(block, recv, types::StringExact, state);
        let other = fun.coerce_to(block, other, types::Fixnum, state);
        let _ = fun.push_insn(block, hir::Insn::StringAppendCodepoint { recv, other, state });
        return Some(recv);
    }
    None
}

fn inline_string_eq(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    if fun.likely_a(recv, types::String, state) && fun.likely_a(other, types::String, state) {
        let recv = fun.coerce_to(block, recv, types::String, state);
        let other = fun.coerce_to(block, other, types::String, state);
        let return_type = types::BoolExact;
        let elidable = true;
        // TODO(max): Make StringEqual its own opcode so that we can later constant-fold StringEqual(a, a) => true
        let result = fun.push_insn(block, hir::Insn::CCall {
            cfunc: rb_yarv_str_eql_internal as *const u8,
            recv,
            args: vec![other],
            name: ID!(string_eq),
            return_type,
            elidable,
        });
        return Some(result);
    }
    None
}

fn inline_module_eqq(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    if fun.is_a(recv, types::Class) {
        let result = fun.push_insn(block, hir::Insn::IsA { val: other, class: recv });
        return Some(result);
    }
    None
}

fn inline_array_length(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[] = args else { return None; };
    if fun.likely_a(recv, types::Array, state) {
        let recv = fun.coerce_to(block, recv, types::Array, state);
        let length_cint = fun.push_insn(block, hir::Insn::ArrayLength { array: recv });
        let result = fun.push_insn(block, hir::Insn::BoxFixnum { val: length_cint, state });
        return Some(result);
    }
    None
}

fn inline_array_empty_p(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[] = args else { return None; };
    if fun.likely_a(recv, types::Array, state) {
        let recv = fun.coerce_to(block, recv, types::Array, state);
        let length_cint = fun.push_insn(block, hir::Insn::ArrayLength { array: recv });
        let zero = fun.push_insn(block, hir::Insn::Const { val: hir::Const::CInt64(0) });
        let result_c = fun.push_insn(block, hir::Insn::IsBitEqual { left: length_cint, right: zero });
        let result = fun.push_insn(block, hir::Insn::BoxBool { val: result_c });
        return Some(result);
    }
    None
}

fn inline_integer_succ(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    if !args.is_empty() { return None; }
    if fun.likely_a(recv, types::Fixnum, state) {
        let left = fun.coerce_to(block, recv, types::Fixnum, state);
        let right = fun.push_insn(block, hir::Insn::Const { val: hir::Const::Value(VALUE::fixnum_from_usize(1)) });
        let result = fun.push_insn(block, hir::Insn::FixnumAdd { left, right, state });
        return Some(result);
    }
    None
}

fn inline_integer_xor(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[right] = args else { return None; };
    if fun.likely_a(recv, types::Fixnum, state) && fun.likely_a(right, types::Fixnum, state) {
        let left = fun.coerce_to(block, recv, types::Fixnum, state);
        let right = fun.coerce_to(block, right, types::Fixnum, state);
        let result = fun.push_insn(block, hir::Insn::FixnumXor { left, right });
        return Some(result);
    }
    None
}

fn try_inline_fixnum_op(fun: &mut hir::Function, block: hir::BlockId, f: &dyn Fn(hir::InsnId, hir::InsnId) -> hir::Insn, bop: u32, left: hir::InsnId, right: hir::InsnId, state: hir::InsnId) -> Option<hir::InsnId> {
    if !unsafe { rb_BASIC_OP_UNREDEFINED_P(bop, INTEGER_REDEFINED_OP_FLAG) } {
        // If the basic operation is already redefined, we cannot optimize it.
        return None;
    }
    if fun.likely_a(left, types::Fixnum, state) && fun.likely_a(right, types::Fixnum, state) {
        if bop == BOP_NEQ {
            // For opt_neq, the interpreter checks that both neq and eq are unchanged.
            fun.push_insn(block, hir::Insn::PatchPoint { invariant: hir::Invariant::BOPRedefined { klass: INTEGER_REDEFINED_OP_FLAG, bop: BOP_EQ }, state });
        }
        // Rely on the MethodRedefined PatchPoint for other bops.
        let left = fun.coerce_to(block, left, types::Fixnum, state);
        let right = fun.coerce_to(block, right, types::Fixnum, state);
        return Some(fun.push_insn(block, f(left, right)));
    }
    None
}

fn inline_integer_eq(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumEq { left, right }, BOP_EQ, recv, other, state)
}

fn inline_integer_plus(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumAdd { left, right, state }, BOP_PLUS, recv, other, state)
}

fn inline_integer_minus(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumSub { left, right, state }, BOP_MINUS, recv, other, state)
}

fn inline_integer_mult(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumMult { left, right, state }, BOP_MULT, recv, other, state)
}

fn inline_integer_div(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumDiv { left, right, state }, BOP_DIV, recv, other, state)
}

fn inline_integer_mod(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumMod { left, right, state }, BOP_MOD, recv, other, state)
}

fn inline_integer_and(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumAnd { left, right, }, BOP_AND, recv, other, state)
}

fn inline_integer_or(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumOr { left, right, }, BOP_OR, recv, other, state)
}

fn inline_integer_gt(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumGt { left, right }, BOP_GT, recv, other, state)
}

fn inline_integer_ge(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumGe { left, right }, BOP_GE, recv, other, state)
}

fn inline_integer_lt(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumLt { left, right }, BOP_LT, recv, other, state)
}

fn inline_integer_le(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumLe { left, right }, BOP_LE, recv, other, state)
}

fn inline_integer_lshift(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    // Only convert to FixnumLShift if we know the shift amount is known at compile-time and could
    // plausibly create a fixnum.
    let Some(other_value) = fun.type_of(other).fixnum_value() else { return None; };
    if other_value < 0 || other_value > 63 { return None; }
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumLShift { left, right, state }, BOP_LTLT, recv, other, state)
}

fn inline_integer_rshift(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    // Only convert to FixnumLShift if we know the shift amount is known at compile-time and could
    // plausibly create a fixnum.
    let Some(other_value) = fun.type_of(other).fixnum_value() else { return None; };
    // TODO(max): If other_value > 63, rewrite to constant zero.
    if other_value < 0 || other_value > 63 { return None; }
    try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumRShift { left, right }, BOP_GTGT, recv, other, state)
}

fn inline_integer_aref(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[index] = args else { return None; };
    if fun.likely_a(recv, types::Fixnum, state) && fun.likely_a(index, types::Fixnum, state) {
        let recv = fun.coerce_to(block, recv, types::Fixnum, state);
        let index = fun.coerce_to(block, index, types::Fixnum, state);
        let result = fun.push_insn(block, hir::Insn::FixnumAref { recv, index });
        return Some(result);
    }
    None
}

fn inline_basic_object_eq(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    let c_result = fun.push_insn(block, hir::Insn::IsBitEqual { left: recv, right: other });
    let result = fun.push_insn(block, hir::Insn::BoxBool { val: c_result });
    Some(result)
}

fn inline_basic_object_not(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    let &[] = args else { return None; };
    if fun.type_of(recv).is_known_truthy() {
        let result = fun.push_insn(block, hir::Insn::Const { val: hir::Const::Value(Qfalse) });
        return Some(result);
    }
    if fun.type_of(recv).is_known_falsy() {
        let result = fun.push_insn(block, hir::Insn::Const { val: hir::Const::Value(Qtrue) });
        return Some(result);
    }
    None
}

fn inline_basic_object_neq(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    let result = try_inline_fixnum_op(fun, block, &|left, right| hir::Insn::FixnumNeq { left, right }, BOP_NEQ, recv, other, state);
    if result.is_some() {
        return result;
    }
    let recv_class = fun.type_of(recv).runtime_exact_ruby_class()?;
    if !fun.assume_expected_cfunc(block, recv_class, ID!(eq), rb_obj_equal as _, state) {
        return None;
    }
    let c_result = fun.push_insn(block, hir::Insn::IsBitNotEqual { left: recv, right: other });
    let result = fun.push_insn(block, hir::Insn::BoxBool { val: c_result });
    Some(result)
}

fn inline_basic_object_initialize(fun: &mut hir::Function, block: hir::BlockId, _recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    if !args.is_empty() { return None; }
    let result = fun.push_insn(block, hir::Insn::Const { val: hir::Const::Value(Qnil) });
    Some(result)
}

fn inline_nilclass_nil_p(fun: &mut hir::Function, block: hir::BlockId, _recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    if !args.is_empty() { return None; }
    Some(fun.push_insn(block, hir::Insn::Const { val: hir::Const::Value(Qtrue) }))
}

fn inline_eqq(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    let recv_class = fun.type_of(recv).runtime_exact_ruby_class()?;
    if !fun.assume_expected_cfunc(block, recv_class, ID!(eq), rb_obj_equal as _, state) {
        return None;
    }
    let c_result = fun.push_insn(block, hir::Insn::IsBitEqual { left: recv, right: other });
    let result = fun.push_insn(block, hir::Insn::BoxBool { val: c_result });
    Some(result)
}

fn inline_kernel_is_a_p(fun: &mut hir::Function, block: hir::BlockId, recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    let &[other] = args else { return None; };
    if fun.is_a(other, types::Class) {
        let result = fun.push_insn(block, hir::Insn::IsA { val: recv, class: other });
        return Some(result);
    }
    None
}

fn inline_kernel_nil_p(fun: &mut hir::Function, block: hir::BlockId, _recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    if !args.is_empty() { return None; }
    Some(fun.push_insn(block, hir::Insn::Const { val: hir::Const::Value(Qfalse) }))
}

fn inline_kernel_respond_to_p(
    fun: &mut hir::Function,
    block: hir::BlockId,
    recv: hir::InsnId,
    args: &[hir::InsnId],
    state: hir::InsnId,
) -> Option<hir::InsnId> {
    // Parse arguments: respond_to?(method_name, allow_priv = false)
    let (method_name, allow_priv) = match *args {
        [method_name] => (method_name, false),
        [method_name, arg] => match fun.type_of(arg) {
            t if t.is_known_truthy() => (method_name, true),
            t if t.is_known_falsy() => (method_name, false),
            // Unknown type; bail out
            _ => return None,
        },
        // Unknown args; bail out
        _ => return None,
    };

    // Method name must be a static symbol
    let method_name = fun.type_of(method_name).ruby_object()?;
    if !method_name.static_sym_p() {
        return None;
    }

    // The receiver must have a known class to call `respond_to?` on
    // TODO: This is technically overly strict. This would also work if all of the
    // observed objects at this point agree on `respond_to?` and we can add many patchpoints.
    let recv_class = fun.type_of(recv).runtime_exact_ruby_class()?;

    // Get the method ID and its corresponding callable method entry
    let mid = unsafe { rb_sym2id(method_name) };
    let target_cme = unsafe { rb_callable_method_entry_or_negative(recv_class, mid) };
    assert!(
        !target_cme.is_null(),
        "Should never be null, as in that case we will be returned a \"negative CME\""
    );

    let cme_def_type = unsafe { get_cme_def_type(target_cme) };

    // Cannot inline a refined method, since their refinement depends on lexical scope
    if cme_def_type == VM_METHOD_TYPE_REFINED {
        return None;
    }

    let visibility = match cme_def_type {
        VM_METHOD_TYPE_UNDEF => METHOD_VISI_UNDEF,
        _ => unsafe { METHOD_ENTRY_VISI(target_cme) },
    };

    let result = match (visibility, allow_priv) {
        // Method undefined; check `respond_to_missing?`
        (METHOD_VISI_UNDEF, _) => {
            let respond_to_missing = ID!(respond_to_missing);
            if unsafe { rb_method_basic_definition_p(recv_class, respond_to_missing) } == 0 {
                return None; // Custom definition of respond_to_missing?, so cannot inline
            }
            let respond_to_missing_cme =
                unsafe { rb_callable_method_entry(recv_class, respond_to_missing) };
            // Protect against redefinition of `respond_to_missing?`
            fun.push_insn(
                block,
                hir::Insn::PatchPoint {
                    invariant: hir::Invariant::NoTracePoint,
                    state,
                },
            );
            fun.push_insn(
                block,
                hir::Insn::PatchPoint {
                    invariant: hir::Invariant::MethodRedefined {
                        klass: recv_class,
                        method: respond_to_missing,
                        cme: respond_to_missing_cme,
                    },
                    state,
                },
            );
            Qfalse
        }
        // Private method with allow priv=false, so `respond_to?` returns false
        (METHOD_VISI_PRIVATE, false) => Qfalse,
        // Public method or allow_priv=true: check if implemented
        (METHOD_VISI_PUBLIC, _) | (_, true) => {
            if cme_def_type == VM_METHOD_TYPE_NOTIMPLEMENTED {
                // C method with rb_f_notimplement(). `respond_to?` returns false
                // without consulting `respond_to_missing?`. See also: rb_add_method_cfunc()
                Qfalse
            } else {
                Qtrue
            }
        }
        (_, _) => return None, // not public and include_all not known, can't compile
    };
    // Check singleton class assumption first, before emitting other patchpoints
    if !fun.assume_no_singleton_classes(block, recv_class, state) {
        return None;
    }
    fun.push_insn(block, hir::Insn::PatchPoint { invariant: hir::Invariant::NoTracePoint, state });
    fun.push_insn(block, hir::Insn::PatchPoint {
        invariant: hir::Invariant::MethodRedefined {
            klass: recv_class,
            method: mid,
            cme: target_cme
        }, state
    });
    Some(fun.push_insn(block, hir::Insn::Const { val: hir::Const::Value(result) }))
}

fn inline_kernel_class(fun: &mut hir::Function, block: hir::BlockId, _recv: hir::InsnId, args: &[hir::InsnId], _state: hir::InsnId) -> Option<hir::InsnId> {
    let &[recv] = args else { return None; };
    let recv_class = fun.type_of(recv).runtime_exact_ruby_class()?;
    let real_class = unsafe { rb_class_real(recv_class) };
    Some(fun.push_insn(block, hir::Insn::Const { val: hir::Const::Value(real_class) }))
}