Ruby 3.3.5p100 (2024-09-03 revision ef084cc8f4958c1b6e4ead99136631bef6d8ddba)
artificial.h File Reference

Defines RBIMPL_ATTR_ARTIFICIAL. More...

Go to the source code of this file.

Macros

#define RBIMPL_ATTR_ARTIFICIAL()
 Wraps (or simulates) __attribute__((artificial))
 

Detailed Description

Defines RBIMPL_ATTR_ARTIFICIAL.

Author
Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org
Warning
Symbols prefixed with either RBIMPL or rbimpl are implementation details. Don't take them as canon. They could rapidly appear then vanish. The name (path) of this header file is also an implementation detail. Do not expect it to persist at the place it is now. Developers are free to move it anywhere anytime at will.
Note
To ruby-core: remember that this header can be possibly recursively included from extension libraries written in C++. Do not expect for instance __VA_ARGS__ is always available. We assume C99 for ruby itself but we don't assume languages of extension libraries. They could be written in C++98.

Q&A

  • Q: What is this attribute? I don't get what GCC manual is talking about.
  • A: In short it is an attribute to manipulate GDB backtraces. The attribute makes the best sense when it comes with attribute((always_inline)). When a function annotated with this attribute gets inlined, and when you somehow look at a backtrace which includes such inlined call site, then the backtrace shows the caller and not the callee. This is handy for instance when an identical function is inlined more than once in a single big function. On such case it gets vital to know where the inlining happened in the callee. See also https://stackoverflow.com/a/21936099

Definition in file artificial.h.

Macro Definition Documentation

◆ RBIMPL_ATTR_ARTIFICIAL

#define RBIMPL_ATTR_ARTIFICIAL ( )
Value:
/* void */

Wraps (or simulates) __attribute__((artificial))

Definition at line 43 of file artificial.h.