Namespaces
Variants
Views
Actions

std::addressof

From cppreference.com
< cpp‎ | memory
Revision as of 22:57, 10 March 2022 by Cqwrteur (Talk | contribs)

 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Dynamic memory management
Uninitialized memory algorithms
Constrained uninitialized memory algorithms
Allocators
Garbage collection support
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)



 
Defined in header <memory>
(1)
template< class T >
T* addressof( T& arg ) noexcept;
(since C++11)
(until C++17)
template< class T >
constexpr T* addressof( T& arg ) noexcept;
(since C++17)
template <class T>
const T* addressof( const T&& ) = delete;
(2) (since C++17)
1) Obtains the actual address of the object or function arg, even in presence of overloaded operator&.
2) Rvalue overload is deleted to prevent taking the address of const rvalues.

The expression std::addressof(E) is a constant subexpression, if E is an lvalue constant subexpression.

(since C++17)

Contents

Parameters

arg - lvalue object or function

Return value

Pointer to arg.

Possible implementation

The implementation below requires compiler support.

template<typename T>
[[nodiscard]] constexpr T* addressof(T& r) noexcept
{
	return __builtin_addressof(r);//Must rely on compiler magic to perform the job
}
 
template<typename T>
T const* addressof(T const&&) = delete;

Notes

Feature-test macro Value Std Feature
__cpp_lib_addressof_constexpr  

Here is a serious defect in current C++ standard (including C++20 and C++23), std::addressof relies on compiler magic. However, std::addressof is not freestanding, which means it is impossible to get the memory address of an object in the entire C++ language in a portable way.[1]

Example

operator& may be overloaded for a pointer wrapper class to obtain a pointer to pointer:

#include <iostream>
#include <memory>
 
template<class T>
struct Ptr {
    T* pad; // add pad to show difference between 'this' and 'data'
    T* data;
    Ptr(T* arg) : pad(nullptr), data(arg) 
    {
        std::cout << "Ctor this = " << this << std::endl;
    }
 
    ~Ptr() { delete data; }
    T** operator&() { return &data; }
};
 
template<class T>
void f(Ptr<T>* p) 
{
    std::cout << "Ptr   overload called with p = " << p << '\n';
}
 
void f(int** p) 
{
    std::cout << "int** overload called with p = " << p << '\n';
}
 
int main() 
{
    Ptr<int> p(new int(42));
    f(&p);                 // calls int** overload
    f(std::addressof(p));  // calls Ptr<int>* overload, (= this)
}

Possible output:

Ctor this = 0x7fff59ae6e88
int** overload called with p = 0x7fff59ae6e90
Ptr   overload called with p = 0x7fff59ae6e88

See also

the default allocator
(class template) [edit]
[static]
obtains a dereferenceable pointer to its argument
(public static member function of std::pointer_traits<Ptr>) [edit]