Ruby 4.0.6p0 (2026-07-14 revision 03b6d3f8898a28604fe6cb00eae3226b821168f4)
yjit.h
1#ifndef YJIT_H
2#define YJIT_H 1
3//
4// This file contains definitions YJIT exposes to the CRuby codebase
5//
6
7#include "ruby/internal/config.h"
8#include "ruby_assert.h" // for RUBY_DEBUG
9#include "vm_core.h"
10#include "method.h"
11
12// YJIT_STATS controls whether to support runtime counters in the interpreter
13#ifndef YJIT_STATS
14# define YJIT_STATS (USE_YJIT && RUBY_DEBUG)
15#endif
16
17#if USE_YJIT
18
19// We generate x86 or arm64 assembly
20#if defined(_WIN32) ? defined(_M_AMD64) : (defined(__x86_64__) || defined(__aarch64__))
21// x86_64 platforms without mingw/msys or x64-mswin
22#else
23# error YJIT unsupported platform
24#endif
25
26// Expose these as declarations since we are building YJIT.
27extern uint64_t rb_yjit_call_threshold;
28extern uint64_t rb_yjit_cold_threshold;
29extern uint64_t rb_yjit_live_iseq_count;
30extern uint64_t rb_yjit_iseq_alloc_count;
31extern bool rb_yjit_enabled_p;
32void rb_yjit_incr_counter(const char *counter_name);
33void rb_yjit_invalidate_all_method_lookup_assumptions(void);
34void rb_yjit_cme_invalidate(rb_callable_method_entry_t *cme);
35void rb_yjit_collect_binding_alloc(void);
36void rb_yjit_collect_binding_set(void);
37void rb_yjit_compile_iseq(const rb_iseq_t *iseq, rb_execution_context_t *ec, bool jit_exception);
38void rb_yjit_init_builtin_cmes(void);
39void rb_yjit_init(bool yjit_enabled);
40void rb_yjit_free_at_exit(void);
41void rb_yjit_bop_redefined(int redefined_flag, enum ruby_basic_operators bop);
42void rb_yjit_constant_state_changed(ID id);
43void rb_yjit_iseq_mark(void *payload);
44void rb_yjit_iseq_update_references(const rb_iseq_t *iseq);
45void rb_yjit_iseq_free(const rb_iseq_t *iseq);
46void rb_yjit_before_ractor_spawn(void);
47void rb_yjit_constant_ic_update(const rb_iseq_t *const iseq, IC ic, unsigned insn_idx);
48void rb_yjit_tracing_invalidate_all(void);
49void rb_yjit_show_usage(int help, int highlight, unsigned int width, int columns);
50void rb_yjit_lazy_push_frame(const VALUE *pc);
51void rb_yjit_invalidate_no_singleton_class(VALUE klass);
52void rb_yjit_invalidate_ep_is_bp(const rb_iseq_t *iseq);
53void rb_yjit_mark_all_writeable(void);
54void rb_yjit_mark_all_executable(void);
55
56#else
57// !USE_YJIT
58// In these builds, YJIT could never be turned on. Provide dummy implementations.
59
60#define rb_yjit_enabled_p false
61static inline void rb_yjit_incr_counter(const char *counter_name) {}
62static inline void rb_yjit_invalidate_all_method_lookup_assumptions(void) {}
63static inline void rb_yjit_cme_invalidate(rb_callable_method_entry_t *cme) {}
64static inline void rb_yjit_collect_binding_alloc(void) {}
65static inline void rb_yjit_collect_binding_set(void) {}
66static inline void rb_yjit_compile_iseq(const rb_iseq_t *iseq, rb_execution_context_t *ec, bool jit_exception) {}
67static inline void rb_yjit_init_builtin_cmes(void) {}
68static inline void rb_yjit_init(bool yjit_enabled) {}
69static inline void rb_yjit_bop_redefined(int redefined_flag, enum ruby_basic_operators bop) {}
70static inline void rb_yjit_constant_state_changed(ID id) {}
71static inline void rb_yjit_iseq_mark(void *payload) {}
72static inline void rb_yjit_iseq_update_references(const rb_iseq_t *iseq) {}
73static inline void rb_yjit_iseq_free(const rb_iseq_t *iseq) {}
74static inline void rb_yjit_before_ractor_spawn(void) {}
75static inline void rb_yjit_constant_ic_update(const rb_iseq_t *const iseq, IC ic, unsigned insn_idx) {}
76static inline void rb_yjit_tracing_invalidate_all(void) {}
77static inline void rb_yjit_lazy_push_frame(const VALUE *pc) {}
78static inline void rb_yjit_invalidate_no_singleton_class(VALUE klass) {}
79static inline void rb_yjit_invalidate_ep_is_bp(const rb_iseq_t *iseq) {}
80
81#endif // #if USE_YJIT
82
83#endif // #ifndef YJIT_H
ID
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
Generated by doxygen 1.17.0