Ruby: builtin.h Source File

Ruby 3.4.3p32 (2025-04-14 revision d0b7e5b6a04bde21ca483d20a1546b28b401c2d4)

builtin.h
1#ifndef BUILTIN_H_INCLUDED
2#define BUILTIN_H_INCLUDED
3
4// invoke
5
6 struct rb_builtin_function {
7 // for invocation
8 const void * const func_ptr;
9 const int argc;
10
11 // for load
12 const int index;
13 const char * const name;
14};
15
16#define RB_BUILTIN_FUNCTION(_i, _name, _fname, _arity) {\
17 .name = _i < 0 ? NULL : #_name, \
18 .func_ptr = (void *)(uintptr_t)_fname, \
19 .argc = _arity, \
20 .index = _i, \
21}
22
23void rb_load_with_builtin_functions(const char *feature_name, const struct rb_builtin_function *table);
24
25#ifndef rb_execution_context_t
26typedef struct rb_execution_context_struct rb_execution_context_t;
27#define rb_execution_context_t rb_execution_context_t
28#endif
29
30/* The following code is generated by the following Ruby script:
31
32typedef = proc {|i, args|
33 "typedef VALUE (*rb_builtin_arity#{i}_function_type)(rb_execution_context_t *ec, VALUE self#{args});"
34}
35puts typedef[0, ""]
36(1..15).each {|i|
37 puts typedef[i, ",\n " + (0...i).map{"VALUE"}.join(", ")]
38}
3916.times{|i|
40 puts "static inline void rb_builtin_function_check_arity#{i}(rb_builtin_arity#{i}_function_type f){}"
41}
42*/
43
44typedef VALUE (*rb_builtin_arity0_function_type)(rb_execution_context_t *ec, VALUE self);
45typedef VALUE (*rb_builtin_arity1_function_type)(rb_execution_context_t *ec, VALUE self,
46 VALUE);
47typedef VALUE (*rb_builtin_arity2_function_type)(rb_execution_context_t *ec, VALUE self,
48 VALUE, VALUE);
49typedef VALUE (*rb_builtin_arity3_function_type)(rb_execution_context_t *ec, VALUE self,
50 VALUE, VALUE, VALUE);
51typedef VALUE (*rb_builtin_arity4_function_type)(rb_execution_context_t *ec, VALUE self,
52 VALUE, VALUE, VALUE, VALUE);
53typedef VALUE (*rb_builtin_arity5_function_type)(rb_execution_context_t *ec, VALUE self,
54 VALUE, VALUE, VALUE, VALUE, VALUE);
55typedef VALUE (*rb_builtin_arity6_function_type)(rb_execution_context_t *ec, VALUE self,
56 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
57typedef VALUE (*rb_builtin_arity7_function_type)(rb_execution_context_t *ec, VALUE self,
58 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
59typedef VALUE (*rb_builtin_arity8_function_type)(rb_execution_context_t *ec, VALUE self,
60 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
61typedef VALUE (*rb_builtin_arity9_function_type)(rb_execution_context_t *ec, VALUE self,
62 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
63typedef VALUE (*rb_builtin_arity10_function_type)(rb_execution_context_t *ec, VALUE self,
64 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
65typedef VALUE (*rb_builtin_arity11_function_type)(rb_execution_context_t *ec, VALUE self,
66 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
67typedef VALUE (*rb_builtin_arity12_function_type)(rb_execution_context_t *ec, VALUE self,
68 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
69typedef VALUE (*rb_builtin_arity13_function_type)(rb_execution_context_t *ec, VALUE self,
70 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
71typedef VALUE (*rb_builtin_arity14_function_type)(rb_execution_context_t *ec, VALUE self,
72 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
73typedef VALUE (*rb_builtin_arity15_function_type)(rb_execution_context_t *ec, VALUE self,
74 VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE, VALUE);
75static inline void rb_builtin_function_check_arity0(rb_builtin_arity0_function_type f){}
76static inline void rb_builtin_function_check_arity1(rb_builtin_arity1_function_type f){}
77static inline void rb_builtin_function_check_arity2(rb_builtin_arity2_function_type f){}
78static inline void rb_builtin_function_check_arity3(rb_builtin_arity3_function_type f){}
79static inline void rb_builtin_function_check_arity4(rb_builtin_arity4_function_type f){}
80static inline void rb_builtin_function_check_arity5(rb_builtin_arity5_function_type f){}
81static inline void rb_builtin_function_check_arity6(rb_builtin_arity6_function_type f){}
82static inline void rb_builtin_function_check_arity7(rb_builtin_arity7_function_type f){}
83static inline void rb_builtin_function_check_arity8(rb_builtin_arity8_function_type f){}
84static inline void rb_builtin_function_check_arity9(rb_builtin_arity9_function_type f){}
85static inline void rb_builtin_function_check_arity10(rb_builtin_arity10_function_type f){}
86static inline void rb_builtin_function_check_arity11(rb_builtin_arity11_function_type f){}
87static inline void rb_builtin_function_check_arity12(rb_builtin_arity12_function_type f){}
88static inline void rb_builtin_function_check_arity13(rb_builtin_arity13_function_type f){}
89static inline void rb_builtin_function_check_arity14(rb_builtin_arity14_function_type f){}
90static inline void rb_builtin_function_check_arity15(rb_builtin_arity15_function_type f){}
91
92PUREFUNC(VALUE rb_vm_lvar_exposed(rb_execution_context_t *ec, int index));
93 VALUE rb_vm_lvar_exposed(rb_execution_context_t *ec, int index);
94
95// __builtin_inline!
96
97PUREFUNC(static inline VALUE rb_vm_lvar(rb_execution_context_t *ec, int index));
98
99static inline VALUE
100rb_vm_lvar(rb_execution_context_t *ec, int index)
101{
102#if defined(VM_CORE_H_EC_DEFINED) && VM_CORE_H_EC_DEFINED
103 return ec->cfp->ep[index];
104#else
105 return rb_vm_lvar_exposed(ec, index);
106#endif
107}
108
109static inline VALUE
110rb_builtin_basic_definition_p(rb_execution_context_t *ec, VALUE klass, VALUE id_sym)
111{
112 return rb_method_basic_definition_p(klass, rb_sym2id(id_sym)) ? Qtrue : Qfalse;
113}
114
115#define LOCAL_PTR(local) local ## __ptr
116
117// dump/load
118
119 struct builtin_binary {
120 const char *feature; // feature name
121 const unsigned char *bin; // binary by ISeq#to_binary
122 size_t bin_size;
123};
124
125#endif // BUILTIN_H_INCLUDED
Qtrue
#define Qtrue
Old name of RUBY_Qtrue.
Definition special_consts.h:61
Qfalse
#define Qfalse
Old name of RUBY_Qfalse.
Definition special_consts.h:59
rb_sym2id
ID rb_sym2id(VALUE obj)
Converts an instance of rb_cSymbol into an ID.
Definition symbol.c:917
builtin_binary
Definition builtin.h:119
rb_builtin_function
Definition builtin.h:6
rb_execution_context_struct
Definition vm_core.h:1022
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40