From 670e288d653853de385798bb31044f9f478d9543 Mon Sep 17 00:00:00 2001 From: Alan Wu Date: Sat, 24 Oct 2020 14:33:46 -0400 Subject: Add warning for str_new_static functions Many functions in string.c assume that capa + termlen to be readable memory. Add comment in header to communicate this to extension authors. See also: comment in str_fill_term() --- include/ruby/internal/intern/string.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'include/ruby/internal/intern/string.h') diff --git a/include/ruby/internal/intern/string.h b/include/ruby/internal/intern/string.h index bfb5c6928a..f2f563ebf9 100644 --- a/include/ruby/internal/intern/string.h +++ b/include/ruby/internal/intern/string.h @@ -66,9 +66,14 @@ VALUE rb_usascii_str_new(const char*, long); VALUE rb_usascii_str_new_cstr(const char*); VALUE rb_utf8_str_new(const char*, long); VALUE rb_utf8_str_new_cstr(const char*); -VALUE rb_str_new_static(const char *, long); -VALUE rb_usascii_str_new_static(const char *, long); -VALUE rb_utf8_str_new_static(const char *, long); +/** + * *_str_new_static functions are intended for C string literals. + * They require memory in the range [ptr, ptr+len] to always be readable. + * Note that this range covers a total of len + 1 bytes. + */ +VALUE rb_str_new_static(const char *ptr, long len); +VALUE rb_usascii_str_new_static(const char *ptr, long len); +VALUE rb_utf8_str_new_static(const char *ptr, long len); void rb_str_free(VALUE); void rb_str_shared_replace(VALUE, VALUE); VALUE rb_str_buf_append(VALUE, VALUE); -- cgit v1.2.3