1 #ifndef RBIMPL_MEMORY_H
2 #define RBIMPL_MEMORY_H
23 #include "ruby/internal/config.h"
41 #if defined(_MSC_VER) && defined(_M_AMD64)
43 # pragma intrinsic(_umul128)
54 #include "ruby/internal/cast.h"
59 #include "ruby/internal/stdckdint.h"
61 #include "ruby/backward/2/limits.h"
71 #elif RBIMPL_HAS_BUILTIN(__builtin_alloca)
72 # define alloca __builtin_alloca
75 #elif defined(__cplusplus)
76 extern "C" void *alloca(
size_t);
78 extern void *alloca();
83 #if defined(__DOXYGEN__)
91 typedef uint128_t DSIZE_T;
92 #elif defined(HAVE_INT128_T) && SIZEOF_SIZE_T <= 8
93 # define DSIZE_T uint128_t
94 #elif SIZEOF_SIZE_T * 2 <= SIZEOF_LONG_LONG
95 # define DSIZE_T unsigned LONG_LONG
106 # define RUBY_ALLOCV_LIMIT 0
108 # define RUBY_ALLOCV_LIMIT 1024
162 #define RB_GC_GUARD(v) \
164 volatile VALUE *rb_gc_guarded_ptr = &(v); \
165 __asm__("" : : "m"(rb_gc_guarded_ptr)); \
168 #elif defined _MSC_VER
169 #define RB_GC_GUARD(v) (*rb_gc_guarded_ptr(&(v)))
171 #define HAVE_RB_GC_GUARDED_PTR_VAL 1
172 #define RB_GC_GUARD(v) (*rb_gc_guarded_ptr_val(&(v),(v)))
194 #define RB_ALLOC_N(type,n) RBIMPL_CAST((type *)ruby_xmalloc2((n), sizeof(type)))
208 #define RB_ALLOC(type) RBIMPL_CAST((type *)ruby_xmalloc(sizeof(type)))
229 #define RB_ZALLOC_N(type,n) RBIMPL_CAST((type *)ruby_xcalloc((n), sizeof(type)))
244 #define RB_ZALLOC(type) (RB_ZALLOC_N(type, 1))
277 #define RB_REALLOC_N(var,type,n) \
278 ((var) = RBIMPL_CAST((type *)ruby_xrealloc2((void *)(var), (n), sizeof(type))))
287 #define ALLOCA_N(type,n) \
288 RBIMPL_CAST((type *)alloca(rbimpl_size_mul_or_raise(sizeof(type), (n))))
299 #define RB_ALLOCV(v, n) \
300 ((n) < RUBY_ALLOCV_LIMIT ? \
301 ((v) = 0, alloca(n)) : \
302 rb_alloc_tmp_buffer(&(v), (n)))
331 #define RB_ALLOCV_N(type, v, n) \
332 RBIMPL_CAST((type *) \
333 (((size_t)(n) < RUBY_ALLOCV_LIMIT / sizeof(type)) ? \
334 ((v) = 0, alloca((n) * sizeof(type))) : \
335 rb_alloc_tmp_buffer2(&(v), (n), sizeof(type))))
344 #define RB_ALLOCV_END(v) rb_free_tmp_buffer(&(v))
355 #define MEMZERO(p,type,n) memset((p), 0, rbimpl_size_mul_or_raise(sizeof(type), (n)))
367 #define MEMCPY(p1,p2,type,n) ruby_nonempty_memcpy((p1), (p2), rbimpl_size_mul_or_raise(sizeof(type), (n)))
379 #define MEMMOVE(p1,p2,type,n) memmove((p1), (p2), rbimpl_size_mul_or_raise(sizeof(type), (n)))
392 #define MEMCMP(p1,p2,type,n) memcmp((p1), (p2), rbimpl_size_mul_or_raise(sizeof(type), (n)))
394 #define ALLOC_N RB_ALLOC_N
395 #define ALLOC RB_ALLOC
396 #define ZALLOC_N RB_ZALLOC_N
397 #define ZALLOC RB_ZALLOC
398 #define REALLOC_N RB_REALLOC_N
399 #define ALLOCV RB_ALLOCV
400 #define ALLOCV_N RB_ALLOCV_N
401 #define ALLOCV_END RB_ALLOCV_END
414 struct rbimpl_size_mul_overflow_tag {
435 void *rb_alloc_tmp_buffer(volatile
VALUE *store,
long len);
458 void *rb_alloc_tmp_buffer_with_count(volatile
VALUE *store,
size_t len,
size_t count);
471 void rb_free_tmp_buffer(volatile
VALUE *store);
484 void ruby_malloc_size_overflow(
size_t x,
size_t y);
486 #ifdef HAVE_RB_GC_GUARDED_PTR_VAL
492 # pragma optimize("", off)
503 static inline volatile VALUE *
504 rb_gc_guarded_ptr(
volatile VALUE *
ptr)
509 # pragma optimize("", on)
533 if (c2 > max)
return 1;
534 *c = RBIMPL_CAST((
size_t)c2);
536 if (b != 0 && a > max / b)
return 1;
542 #if defined(__DOXYGEN__)
544 #elif RBIMPL_COMPILER_SINCE(GCC, 7, 0, 0)
546 #elif RBIMPL_COMPILER_SINCE(Clang, 7, 0, 0)
566 static
inline struct rbimpl_size_mul_overflow_tag
567 rbimpl_size_mul_overflow(
size_t x,
size_t y)
569 struct rbimpl_size_mul_overflow_tag ret = {
false, 0, };
572 ret.left = ckd_mul(&ret.right, x, y);
574 #elif RBIMPL_HAS_BUILTIN(__builtin_mul_overflow)
575 ret.left = __builtin_mul_overflow(x, y, &ret.right);
577 #elif defined(DSIZE_T)
581 ret.left = dz > SIZE_MAX;
582 ret.right = RBIMPL_CAST((
size_t)dz);
584 #elif defined(_MSC_VER) && defined(_WIN64)
585 unsigned __int64 dp = 0;
586 unsigned __int64 dz = _umul128(x, y, &dp);
587 ret.left = RBIMPL_CAST((
bool)dp);
588 ret.right = RBIMPL_CAST((
size_t)dz);
592 ret.left = (y != 0) && (x > SIZE_MAX / y);
615 rbimpl_size_mul_or_raise(
size_t x,
size_t y)
617 struct rbimpl_size_mul_overflow_tag size =
618 rbimpl_size_mul_overflow(x, y);
624 ruby_malloc_size_overflow(x, y);
646 const size_t total_size = rbimpl_size_mul_or_raise(RBIMPL_CAST((
size_t)count), elsize);
647 const size_t cnt = (total_size +
sizeof(
VALUE) - 1) /
sizeof(
VALUE);
648 return rb_alloc_tmp_buffer_with_count(store, total_size, cnt);
659 ruby_nonempty_memcpy(
void *dest, const
void *src,
size_t n)
662 return memcpy(dest, src, n);
Defines RBIMPL_ATTR_ALLOC_SIZE.
#define RBIMPL_ATTR_ALLOC_SIZE(tuple)
Wraps (or simulates) __attribute__((alloc_size))
Defines ASSUME / RB_LIKELY / UNREACHABLE.
#define RB_LIKELY(x)
Asserts that the given Boolean expression likely holds.
Defines RBIMPL_ATTR_CONST.
#define RBIMPL_ATTR_CONSTEXPR(_)
Wraps (or simulates) C++11 constexpr.
Tweaking visibility of C variables/functions.
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
#define RB_GNUC_EXTENSION
This is expanded to nothing for non-GCC compilers.
Defines RBIMPL_HAS_BUILTIN.
RBIMPL_ATTR_CONST() int rb_io_oflags_fmode(int oflags)
Converts an oflags (that rb_io_modestr_oflags() returns) to a fmode (that rb_io_mode_flags() returns)...
RBIMPL_ATTR_NORETURN() void rb_eof_error(void)
Utility function to raise rb_eEOFError.
char * ptr
Pointer to the underlying memory region, of at least capa bytes.
int len
Length of the buffer.
#define RBIMPL_UNREACHABLE_RETURN(_)
Wraps (or simulates) __builtin_unreachable.
Defines RBIMPL_ALIGNAS / RBIMPL_ALIGNOF.
static void * rb_alloc_tmp_buffer2(volatile VALUE *store, long count, size_t elsize)
This is an implementation detail of RB_ALLOCV_N().
static int rb_mul_size_overflow(size_t a, size_t b, size_t max, size_t *c)
Defines RBIMPL_ATTR_NOALIAS.
#define RBIMPL_ATTR_NOALIAS()
Wraps (or simulates) __declspec((noalias))
Defines RBIMPL_ATTR_NONNULL.
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Defines RBIMPL_ATTR_NORETURN.
#define inline
Old Visual Studio versions do not support the inline keyword, so we need to define it to be __inline.
Defines RBIMPL_ATTR_RESTRICT.
#define RBIMPL_ATTR_RESTRICT()
Wraps (or simulates) __declspec(restrict)
Defines RBIMPL_ATTR_RETURNS_NONNULL.
#define RBIMPL_ATTR_RETURNS_NONNULL()
Wraps (or simulates) __attribute__((returns_nonnull))
uintptr_t VALUE
Type that represents a Ruby object.