mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00

The motivation of this change is to make sure rb_funcall or GC-related functions are not called on worker-related code. Currently such functions are used in some places and I believe it's partly because it's hard to identify which part is called on MJIT worker thread. Now, mjit.c is safe to use them but we know we need to safely deal with mjit_compile.c, mjit_worker.c and mjit_internal.h. mjit_compile.c: update the comment about it git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@64285 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
129 lines
4.4 KiB
C
129 lines
4.4 KiB
C
/**********************************************************************
|
|
|
|
mjit.h - Interface to MRI method JIT compiler for Ruby's main thread
|
|
|
|
Copyright (C) 2017 Vladimir Makarov <vmakarov@redhat.com>.
|
|
|
|
**********************************************************************/
|
|
|
|
#ifndef RUBY_MJIT_H
|
|
#define RUBY_MJIT_H 1
|
|
|
|
#include "ruby.h"
|
|
|
|
/* Special address values of a function generated from the
|
|
corresponding iseq by MJIT: */
|
|
enum rb_mjit_iseq_func {
|
|
/* ISEQ was not queued yet for the machine code generation */
|
|
NOT_ADDED_JIT_ISEQ_FUNC = 0,
|
|
/* ISEQ is already queued for the machine code generation but the
|
|
code is not ready yet for the execution */
|
|
NOT_READY_JIT_ISEQ_FUNC = 1,
|
|
/* ISEQ included not compilable insn, some internal assertion failed
|
|
or the unit is unloaded */
|
|
NOT_COMPILED_JIT_ISEQ_FUNC = 2,
|
|
/* End mark */
|
|
LAST_JIT_ISEQ_FUNC = 3
|
|
};
|
|
|
|
/* MJIT options which can be defined on the MRI command line. */
|
|
struct mjit_options {
|
|
/* Converted from "jit" feature flag to tell the enablement
|
|
information to ruby_show_version(). */
|
|
char on;
|
|
/* Save temporary files after MRI finish. The temporary files
|
|
include the pre-compiled header, C code file generated for ISEQ,
|
|
and the corresponding object file. */
|
|
char save_temps;
|
|
/* Print MJIT warnings to stderr. */
|
|
char warnings;
|
|
/* Disable compiler optimization and add debug symbols. It can be
|
|
very slow. */
|
|
char debug;
|
|
/* If not 0, all ISeqs are synchronously compiled. For testing. */
|
|
unsigned int wait;
|
|
/* Number of calls to trigger JIT compilation. For testing. */
|
|
unsigned int min_calls;
|
|
/* Force printing info about MJIT work of level VERBOSE or
|
|
less. 0=silence, 1=medium, 2=verbose. */
|
|
int verbose;
|
|
/* Maximal permitted number of iseq JIT codes in a MJIT memory
|
|
cache. */
|
|
int max_cache_size;
|
|
};
|
|
|
|
typedef VALUE (*mjit_func_t)(rb_execution_context_t *, rb_control_frame_t *);
|
|
|
|
RUBY_SYMBOL_EXPORT_BEGIN
|
|
RUBY_EXTERN struct mjit_options mjit_opts;
|
|
RUBY_EXTERN int mjit_call_p;
|
|
|
|
extern void mjit_add_iseq_to_process(const rb_iseq_t *iseq);
|
|
extern mjit_func_t mjit_get_iseq_func(struct rb_iseq_constant_body *body);
|
|
RUBY_SYMBOL_EXPORT_END
|
|
|
|
extern int mjit_compile(FILE *f, const struct rb_iseq_constant_body *body, const char *funcname);
|
|
extern void mjit_init(struct mjit_options *opts);
|
|
extern void mjit_finish(void);
|
|
extern void mjit_gc_start_hook(void);
|
|
extern void mjit_gc_finish_hook(void);
|
|
extern void mjit_free_iseq(const rb_iseq_t *iseq);
|
|
extern void mjit_mark(void);
|
|
extern struct mjit_cont *mjit_cont_new(rb_execution_context_t *ec);
|
|
extern void mjit_cont_free(struct mjit_cont *cont);
|
|
extern void mjit_add_class_serial(rb_serial_t class_serial);
|
|
extern void mjit_remove_class_serial(rb_serial_t class_serial);
|
|
extern int mjit_valid_class_serial_p(rb_serial_t class_serial);
|
|
|
|
/* A threshold used to reject long iseqs from JITting as such iseqs
|
|
takes too much time to be compiled. */
|
|
#define JIT_ISEQ_SIZE_THRESHOLD 1000
|
|
|
|
/* Return TRUE if given ISeq body should be compiled by MJIT */
|
|
static inline int
|
|
mjit_target_iseq_p(struct rb_iseq_constant_body *body)
|
|
{
|
|
return (body->type == ISEQ_TYPE_METHOD || body->type == ISEQ_TYPE_BLOCK)
|
|
&& body->iseq_size < JIT_ISEQ_SIZE_THRESHOLD;
|
|
}
|
|
|
|
/* Try to execute the current iseq in ec. Use JIT code if it is ready.
|
|
If it is not, add ISEQ to the compilation queue and return Qundef. */
|
|
static inline VALUE
|
|
mjit_exec(rb_execution_context_t *ec)
|
|
{
|
|
const rb_iseq_t *iseq;
|
|
struct rb_iseq_constant_body *body;
|
|
long unsigned total_calls;
|
|
mjit_func_t func;
|
|
|
|
if (!mjit_call_p)
|
|
return Qundef;
|
|
|
|
iseq = ec->cfp->iseq;
|
|
body = iseq->body;
|
|
total_calls = ++body->total_calls;
|
|
|
|
func = body->jit_func;
|
|
if (UNLIKELY((uintptr_t)func <= (uintptr_t)LAST_JIT_ISEQ_FUNC)) {
|
|
switch ((enum rb_mjit_iseq_func)func) {
|
|
case NOT_ADDED_JIT_ISEQ_FUNC:
|
|
if (total_calls == mjit_opts.min_calls && mjit_target_iseq_p(body)) {
|
|
mjit_add_iseq_to_process(iseq);
|
|
if (UNLIKELY(mjit_opts.wait)) {
|
|
func = mjit_get_iseq_func(body);
|
|
}
|
|
}
|
|
return Qundef;
|
|
case NOT_READY_JIT_ISEQ_FUNC:
|
|
case NOT_COMPILED_JIT_ISEQ_FUNC:
|
|
return Qundef;
|
|
default: /* to avoid warning with LAST_JIT_ISEQ_FUNC */
|
|
break;
|
|
}
|
|
}
|
|
|
|
return func(ec, ec->cfp);
|
|
}
|
|
|
|
#endif /* RUBY_MJIT_H */
|