kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

include/ruby/internal/xmalloc.h: add doxygen

Browse source 
Must not be a bad idea to improve documents. [ci skip]
This commit is contained in:
卜部昌平 2021-01-13 14:38:03 +09:00
parent a300133b4a
commit 28b7b0e13e
Notes: git 2021-09-10 20:01:55 +09:00 
Merged: https://github.com/ruby/ruby/pull/4815
2 changed files with 69 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

105
include/ruby/internal/xmalloc.h
View file

@ -37,16 +37,25 @@
#include "ruby/internal/attr/returns_nonnull.h"
#include "ruby/internal/dllexport.h"
/**
* @private
* @warning Do not touch this macro.
* @warning It is an implementation detail.
* @warning It was a failure at the first place to let you know about it.
* @warning The value of this macro must match for ruby itself and all
* extension libraries, otherwise serious memory corruption shall
* occur.
*/
#ifndef USE_GC_MALLOC_OBJ_INFO_DETAILS
# define USE_GC_MALLOC_OBJ_INFO_DETAILS 0
#endif
#define xmalloc ruby_xmalloc
#define xmalloc2 ruby_xmalloc2
#define xcalloc ruby_xcalloc
#define xrealloc ruby_xrealloc
#define xrealloc2 ruby_xrealloc2
#define xfree ruby_xfree
#define xmalloc ruby_xmalloc /**< @old{ruby_xmalloc} */
#define xmalloc2 ruby_xmalloc2 /**< @old{ruby_xmalloc2} */
#define xcalloc ruby_xcalloc /**< @old{ruby_xcalloc} */
#define xrealloc ruby_xrealloc /**< @old{ruby_xrealloc} */
#define xrealloc2 ruby_xrealloc2 /**< @old{ruby_xrealloc2} */
#define xfree ruby_xfree /**< @old{ruby_xfree} */
RBIMPL_SYMBOL_EXPORT_BEGIN()
@ -114,9 +123,9 @@ RBIMPL_ATTR_RESTRICT()
RBIMPL_ATTR_RETURNS_NONNULL()
RBIMPL_ATTR_ALLOC_SIZE((1,2))
/**
* Identical to ruby_xmalloc2(), except it zero-fills the region before it
* returns. This could also be seen as a routine identical to ruby_xmalloc(),
* except it calls calloc() instead of malloc() internally.
* Identical to ruby_xmalloc2(), except it returns a zero-filled storage
* instance. It can also be seen as a routine identical to ruby_xmalloc(),
* except it calls calloc() instead of malloc().
*
* @param[in] nelems Number of elements.
* @param[in] elemsiz Size of an element.
@ -125,6 +134,7 @@ RBIMPL_ATTR_ALLOC_SIZE((1,2))
* @return A valid pointer to an allocated storage instance; which has at
* least `nelems` * `elemsiz` bytes width, with appropriate
* alignment detected by the underlying calloc() routine.
* @post The returned storage instance is filled with zeros.
* @note It doesn't return NULL.
* @note Unlike some calloc() implementations, it allocates something and
* returns a meaningful value even when `nelems` or `elemsiz` or
@ -145,22 +155,28 @@ RBIMPL_ATTR_ALLOC_SIZE((2))
* Resize the storage instance.
*
* @param[in] ptr A valid pointer to a storage instance that was
* previously returned from either ruby_xmalloc(),
* ruby_xmalloc2(), ruby_xcalloc(),
* ruby_xrealloc(), or ruby_xrealloc2().
* previously returned from either:
* - ruby_xmalloc(),
* - ruby_xmalloc2(),
* - ruby_xcalloc(),
* - ruby_xrealloc(), or
* - ruby_xrealloc2().
* @param[in] newsiz Requested new amount of memory.
* @exception rb_eNoMemError No space left for `newsiz` bytes allocation.
* @retval ptr In case the function returns the passed pointer
* as-is, the storage instance that the pointer
* holds is either grown or shrunken to have at
* least `newsiz` bytes.
* @retval otherwise A valid pointer to a newly allocated storage
* instance which has at least `newsiz` bytes
* width, and holds previous contents of `ptr`. In
* this case `ptr` is invalidated as if it was
* passed to ruby_xfree().
* @return A valid pointer to a (possibly newly allocated) storage
* instance; which has at least `newsiz` bytes width, with
* appropriate alignment detected by the underlying realloc()
* routine.
* @pre The passed pointer must point to a valid live storage instance.
* It is a failure to pass an already freed pointer.
* @post In case the function returns the passed pointer as-is, the
* storage instance that the pointer holds is either grown or
* shrunken to have at least `newsiz` bytes. Otherwise a valid
* pointer to a newly allocated storage instance is returned. In
* this case `ptr` is invalidated as if it was passed to
* ruby_xfree().
* @note It doesn't return NULL.
* @warning Unlike some realloc() implementations, passing zero to `elemsiz`
* @warning Unlike some realloc() implementations, passing zero to `newsiz`
* is not the same as calling ruby_xfree(), because this function
* never returns NULL. Something meaningful still returns then.
* @warning It is a failure not to check the return value. Do not assume
@ -193,22 +209,28 @@ RBIMPL_ATTR_ALLOC_SIZE((2,3))
* etc. provides, but also interacts with our GC.
*
* @param[in] ptr A valid pointer to a storage instance that was
* previously returned from either ruby_xmalloc(),
* ruby_xmalloc2(), ruby_xcalloc(),
* ruby_xrealloc(), or ruby_xrealloc2().
* previously returned from either:
* - ruby_xmalloc(),
* - ruby_xmalloc2(),
* - ruby_xcalloc(),
* - ruby_xrealloc(), or
* - ruby_xrealloc2().
* @param[in] newelems Requested new number of elements.
* @param[in] newsiz Requested new size of each element.
* @exception rb_eNoMemError No space left for allocation.
* @exception rb_eArgError `newelems` * `newsiz` would overflow.
* @retval ptr In case the function returns the passed pointer
* as-is, the storage instance that the pointer
* holds is either grown or shrunken to have at
* least `newelems` * `newsiz` bytes.
* @retval otherwise A valid pointer to a newly allocated storage
* instance which has at least `newelems` *
* `newsiz` bytes width, and holds previous
* contents of `ptr`. In this case `ptr` is
* invalidated as if it was passed to ruby_xfree().
* @return A valid pointer to a (possibly newly allocated) storage
* instance; which has at least `newelems` * `newsiz` bytes width,
* with appropriate alignment detected by the underlying realloc()
* routine.
* @pre The passed pointer must point to a valid live storage instance.
* It is a failure to pass an already freed pointer.
* @post In case the function returns the passed pointer as-is, the
* storage instance that the pointer holds is either grown or
* shrunken to have at least `newelems` * `newsiz` bytes.
* Otherwise a valid pointer to a newly allocated storage instance
* is returned. In this case `ptr` is invalidated as if it was
* passed to ruby_xfree().
* @note It doesn't return NULL.
* @warning Unlike some realloc() implementations, passing zero to either
* `newelems` or `elemsiz` are not the same as calling
@ -232,9 +254,18 @@ RBIMPL_ATTR_NOEXCEPT(realloc(ptr, newelems * newsiz))
/**
* Deallocates a storage instance.
*
* @param[out] ptr Either NULL, or a valid pointer previously returned from
* one of ruby_xmalloc(), ruby_xmalloc2(), ruby_xcalloc(),
* ruby_xrealloc(), or ruby_xrealloc2().
* @param[out] ptr Either
* - NULL, or
* - a valid pointer previously returned from one of:
* - ruby_xmalloc(),
* - ruby_xmalloc2(),
* - ruby_xcalloc(),
* - ruby_xrealloc(), or
* - ruby_xrealloc2().
* @pre The passed pointer must point to a valid live storage instance.
* It is a failure to pass an already freed pointer.
* @post The storage instance pointed by the passed pointer gets
* invalidated; it is no longer addressable.
* @warning Every single storage instance that was previously allocated by
* either ruby_xmalloc(), ruby_xmalloc2(), ruby_xcalloc(),
* ruby_xrealloc(), or ruby_xrealloc2() shall be invalidated

1
template/Doxyfile.tmpl
View file

@ -277,6 +277,7 @@ TAB_SIZE = 8
# a double escape (\\{ and \\})
ALIASES =
ALIASES += "old{1}=Old name of @ref \1.^^@deprecated Use @ref \1 instead.^^@ingroup deprecated_macros"
ALIASES += "shyouhei=\@shyouhei"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources