Placement new is a variation new operator in C++. Normal new operator does two things : (1) Allocates memory (2) Constructs an object in allocated memory.
Placement new allows us to separate above two things. In placement new, we can pass a preallocated memory and construct an object in the passed memory.
new vs placement new
- Normal new allocates memory in heap and constructs objects there whereas using placement new, object construction can be done at known address.
- With normal new, it is not known that, at what address or memory location it’s pointing to, whereas the address or memory location that it’s pointing is known while using placement new.
- The deallocation is done using delete operation when allocation is done by new but there is no placement delete, but if it is needed one can write it with the help of destructor
Syntax:
new (address) (type) initializer As we can see, we can specify an address where we want a new object of given type to be constructed.
When to prefer using placement new?
As it allows to construct an object on memory that is already allocated, it is required for optimizations as it is faster not to re-allocate all the time. There may be cases when it is required to re-construct an object multiple times so, placement new operator might be more efficient in these cases.
// C++ program to illustrate the placement new operator #include<iostream> using namespace std;
int main()
{ // buffer on stack
unsigned char buf[sizeof(int)*2] ;
// placement new in buf
int *pInt = new (buf) int(3);
int *qInt = new (buf + sizeof (int)) int(5);
int *pBuf = (int*)(buf+0) ;
int *qBuf = (int*) (buf + sizeof(int));
cout << "Buff Addr Int Addr" << endl;
cout << pBuf <<" " << pInt << endl;
cout << qBuf <<" " << qInt << endl;
cout << "------------------------------" << endl;
cout << "1st Int 2nd Int" << endl;
cout << *pBuf << " "
<< *qBuf << endl;
return 0;
} |
Output:
Buff Addr Int Addr 0x69fed8 0x69fed8 0x69fedc 0x69fedc ------------------------------ 1st Int 2nd Int 3 5
The diagram below pictorially shows what is actually happening in above C++ program.
Below is a another simple implementation in C++ to illustrate the use of placement new in C++ :
// C++ program to illustrate the placement new operator #include<iostream> using namespace std;
int main()
{ // initial value of X
int X = 10;
cout << "Before placement new :" << endl;
cout << "X : " << X << endl;
cout << "&X : " << &X << endl;
// Placement new changes the value of X to 100
int *mem = new (&X) int(100);
cout << "\nAfter placement new :" << endl;
cout << "X : " << X << endl;
cout << "mem : " << mem << endl;
cout << "&X : " << &X << endl;
return 0;
} |
Output:
Before placement new : X : 10 &X : 0x69fee8 After placement new : X : 100 mem : 0x69fee8 &X : 0x69fee8
Explanation: Here, it is clear that a new value of x is assigned at the address of x with the help of placement new operator. This is clear by the fact that the value of &X and mem is equal.
The diagram below pictorially shows what is actually happening in above C++ program.
How to delete the memory allocated by placement new ?
The operator delete can only delete the storage created in heap, so when placement new is used delete operator cannot be used to delete the storage. In the case of memory allocation using placement new operator , since it is created in stack the compiler knows when to delete it and it will handle deallocation of the memory automatically. If required, one can write it with the help of destructor as shown below.
// C++ program to illustrate using destructor for // deleting memory allocated by placement new #include<iostream> #include<cstdlib> #include<cmath> using namespace std;
class Complex
{ private:
double re_, im_;
public:
// Constructor
Complex(double re = 0, double im = 0): re_(re), im_(im)
{
cout << "Constructor : (" << re_
<< ", " << im_ << ")" << endl;
}
// Destructor
~Complex()
{
cout << "Destructor : (" << re_ << ", "
<< im_ << ")" << endl;
}
double normal()
{
return sqrt(re_*re_ + im_*im_);
}
void print()
{
cout << "|" << re_ <<" +j" << im_
<< " | = " << normal() << endl;
}
}; // Driver code int main()
{ // buffer on stack
unsigned char buf[100];
Complex* pc = new Complex(4.2, 5.3);
Complex* pd = new Complex[2];
// using placement new
Complex *pe = new (buf) Complex(2.6, 3.9);
// use objects
pc -> print();
pd[0].print();
pd[1].print();
pe->print();
// Release objects
// calls destructor and then release memory
delete pc;
// Calls the destructor for object pd[0]
// and then release memory
// and it does same for pd[1]
delete [] pd;
// No delete : Explicit call to Destructor.
pe->~Complex();
return 0;
} |
Output:
Constructor : (4.2, 5.3) Constructor : (0, 0) Constructor : (0, 0) Constructor : (2.6, 3.9) |4.2 +j5.3 | = 6.7624 |0 +j0 | = 0 |0 +j0 | = 0 |2.6 +j3.9 | = 4.68722 Destructor : (4.2, 5.3) Destructor : (0, 0) Destructor : (0, 0) Destructor : (2.6, 3.9)
Explanation: Here the destructor is explicitly called because here it cannot be packaged within the delete operator because delete will need to release the memory which you do not have here and it cannot be implicit as it is a dynamic process which we want to manage yourself.
When will placement new operator show segmentation fault?
The placement new operator should be used with care. The address which is passed can be a reference or a pointer pointing to a valid memory location. It may show an error when the address passed is :
- A pointer such as NULL pointer.
- A pointer that is not pointing to any location.
- It cannot be a void pointer unless it points to some location.
// C++ program to illustrate segmentation fault // while using placement new operator #include<iostream> using namespace std;
int main()
{ // Fine
int i = 10;
int *ipt = &i ;
int *i1 = new(ipt) int(9) ;
// Incorrect as ip may not
// be a valid address
int *ip;
int *i2 = new(ip) int(4) ;
// Fine
void *vd = &i;
int *i3 = new(vd) int(34) ;
// Incorrect as x is not an address
int x;
int *i5 = new(x) int(3) ;
return 0;
} |
Segmentation fault
Advantages of placement new operator over new operator
- The address of memory allocation is known before hand.
- Useful when building a memory pool, a garbage collector or simply when performance and exception safety are paramount.
- There’s no danger of allocation failure since the memory has already been allocated, and constructing an object on a pre-allocated buffer takes less time.
- This feature becomes useful while working in an environment with limited resources.