Ruby: internal/array.h Source File

Ruby 3.4.1p0 (2024-12-25 revision 48d4efcb85000e1ebae42004e963b5d0cedddcf2)

array.h
1#ifndef INTERNAL_ARRAY_H /*-*-C-*-vi:se ft=c:*/
2#define INTERNAL_ARRAY_H
11#include "ruby/internal/config.h"
12#include <stddef.h> /* for size_t */
13#include "internal/static_assert.h" /* for STATIC_ASSERT */
14#include "ruby/internal/stdbool.h" /* for bool */
15#include "ruby/ruby.h" /* for RARRAY_LEN */
16
17#ifndef ARRAY_DEBUG
18# define ARRAY_DEBUG (0+RUBY_DEBUG)
19#endif
20
21#define RARRAY_SHARED_FLAG ELTS_SHARED
22#define RARRAY_SHARED_ROOT_FLAG FL_USER12
23#define RARRAY_PTR_IN_USE_FLAG FL_USER14
24
25/* array.c */
26 VALUE rb_ary_hash_values(long len, const VALUE *elements);
27 VALUE rb_ary_last(int, const VALUE *, VALUE);
28void rb_ary_set_len(VALUE, long);
29void rb_ary_delete_same(VALUE, VALUE);
30 VALUE rb_ary_hidden_new_fill(long capa);
31 VALUE rb_ary_at(VALUE, VALUE);
32size_t rb_ary_memsize(VALUE);
33 VALUE rb_to_array_type(VALUE obj);
34 VALUE rb_to_array(VALUE obj);
35void rb_ary_cancel_sharing(VALUE ary);
36size_t rb_ary_size_as_embedded(VALUE ary);
37void rb_ary_make_embedded(VALUE ary);
38bool rb_ary_embeddable_p(VALUE ary);
39 VALUE rb_ary_diff(VALUE ary1, VALUE ary2);
40 RUBY_EXTERN VALUE rb_cArray_empty_frozen;
41
42static inline VALUE rb_ary_entry_internal(VALUE ary, long offset);
43static inline bool ARY_PTR_USING_P(VALUE ary);
44
45 VALUE rb_ary_tmp_new_from_values(VALUE, long, const VALUE *);
46 VALUE rb_check_to_array(VALUE ary);
47 VALUE rb_ary_behead(VALUE, long);
48 VALUE rb_ary_aref1(VALUE ary, VALUE i);
49
50struct rb_execution_context_struct;
51 VALUE rb_ec_ary_new_from_values(struct rb_execution_context_struct *ec, long n, const VALUE *elts);
52
53// YJIT needs this function to never allocate and never raise
54static inline VALUE
55rb_ary_entry_internal(VALUE ary, long offset)
56{
57 long len = RARRAY_LEN(ary);
58 const VALUE *ptr = RARRAY_CONST_PTR(ary);
59 if (len == 0) return Qnil;
60 if (offset < 0) {
61 offset += len;
62 if (offset < 0) return Qnil;
63 }
64 else if (len <= offset) {
65 return Qnil;
66 }
67 return ptr[offset];
68}
69
70static inline bool
71ARY_PTR_USING_P(VALUE ary)
72{
73 return FL_TEST_RAW(ary, RARRAY_PTR_IN_USE_FLAG);
74}
75
76 RBIMPL_ATTR_MAYBE_UNUSED()
77static inline int
78ary_should_not_be_shared_and_embedded(VALUE ary)
79{
80 return !FL_ALL_RAW(ary, RARRAY_SHARED_FLAG|RARRAY_EMBED_FLAG);
81}
82
83static inline bool
84ARY_SHARED_P(VALUE ary)
85{
86 assert(RB_TYPE_P(ary, T_ARRAY));
87 assert(ary_should_not_be_shared_and_embedded(ary));
88 return FL_TEST_RAW(ary, RARRAY_SHARED_FLAG);
89}
90
91static inline bool
92ARY_EMBED_P(VALUE ary)
93{
94 assert(RB_TYPE_P(ary, T_ARRAY));
95 assert(ary_should_not_be_shared_and_embedded(ary));
96 return FL_TEST_RAW(ary, RARRAY_EMBED_FLAG);
97}
98
99static inline VALUE
100ARY_SHARED_ROOT(VALUE ary)
101{
102 assert(ARY_SHARED_P(ary));
103 return RARRAY(ary)->as.heap.aux.shared_root;
104}
105
106static inline bool
107ARY_SHARED_ROOT_P(VALUE ary)
108{
109 assert(RB_TYPE_P(ary, T_ARRAY));
110 return FL_TEST_RAW(ary, RARRAY_SHARED_ROOT_FLAG);
111}
112
113static inline long
114ARY_SHARED_ROOT_REFCNT(VALUE ary)
115{
116 assert(ARY_SHARED_ROOT_P(ary));
117 return RARRAY(ary)->as.heap.aux.capa;
118}
119
120#undef rb_ary_new_from_args
121#if RBIMPL_HAS_WARNING("-Wgnu-zero-variadic-macro-arguments")
122# /* Skip it; clang -pedantic doesn't like the following */
123#elif defined(__GNUC__) && defined(HAVE_VA_ARGS_MACRO)
124#define rb_ary_new_from_args(n, ...) \
125 __extension__ ({ \
126 const VALUE args_to_new_ary[] = {__VA_ARGS__}; \
127 if (__builtin_constant_p(n)) { \
128 STATIC_ASSERT(rb_ary_new_from_args, numberof(args_to_new_ary) == (n)); \
129 } \
130 rb_ary_new_from_values(numberof(args_to_new_ary), args_to_new_ary); \
131 })
132#endif
133
134#undef RARRAY_AREF
135 RBIMPL_ATTR_PURE_UNLESS_DEBUG()
136 RBIMPL_ATTR_ARTIFICIAL()
137static inline VALUE
138 RARRAY_AREF(VALUE ary, long i)
139{
140 VALUE val;
141 RBIMPL_ASSERT_TYPE(ary, RUBY_T_ARRAY);
142
143 RBIMPL_WARNING_PUSH();
144#if defined(__GNUC__) && !defined(__clang__) && __GNUC__ == 13
145 RBIMPL_WARNING_IGNORED(-Warray-bounds);
146#endif
147 val = RARRAY_CONST_PTR(ary)[i];
148 RBIMPL_WARNING_POP();
149 return val;
150}
151
152#endif /* INTERNAL_ARRAY_H */
RBIMPL_ATTR_ARTIFICIAL
#define RBIMPL_ATTR_ARTIFICIAL()
Wraps (or simulates) __attribute__((artificial))
Definition artificial.h:43
RUBY_EXTERN
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:45
FL_TEST_RAW
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:132
Qnil
#define Qnil
Old name of RUBY_Qnil.
Definition special_consts.h:60
T_ARRAY
#define T_ARRAY
Old name of RUBY_T_ARRAY.
Definition value_type.h:56
FL_ALL_RAW
#define FL_ALL_RAW
Old name of RB_FL_ALL_RAW.
Definition fl_type.h:124
capa
int capa
Designed capacity of the buffer.
Definition io.h:11
len
int len
Length of the buffer.
Definition io.h:8
RBIMPL_ATTR_MAYBE_UNUSED
#define RBIMPL_ATTR_MAYBE_UNUSED()
Wraps (or simulates) [[maybe_unused]]
Definition maybe_unused.h:35
inline
#define inline
Old Visual Studio versions do not support the inline keyword, so we need to define it to be __inline.
Definition defines.h:88
RBIMPL_ATTR_PURE_UNLESS_DEBUG
#define RBIMPL_ATTR_PURE_UNLESS_DEBUG()
Enables RBIMPL_ATTR_PURE if and only if.
Definition pure.h:38
RARRAY_LEN
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
RARRAY
#define RARRAY(obj)
Convenient casting macro.
Definition rarray.h:44
RARRAY_AREF
#define RARRAY_AREF(a, i)
Definition rarray.h:403
RARRAY_CONST_PTR
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
Definition rarray.h:52
ruby.h
stdbool.h
C99 shim for <stdbool.h>
rb_execution_context_struct
Definition vm_core.h:1022
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
RB_TYPE_P
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
RUBY_T_ARRAY
@ RUBY_T_ARRAY
Definition value_type.h:122
RBIMPL_WARNING_IGNORED
#define RBIMPL_WARNING_IGNORED(flag)
Suppresses a warning.
Definition warning_push.h:80
RBIMPL_WARNING_PUSH
#define RBIMPL_WARNING_PUSH()
Pushes compiler warning state.
Definition warning_push.h:55
RBIMPL_WARNING_POP
#define RBIMPL_WARNING_POP()
Pops compiler warning state.
Definition warning_push.h:62