Namespaces
Variants
Views
Actions

std::malloc

From cppreference.com
< cpp‎ | memory‎ | c
Revision as of 10:32, 24 May 2018 by Cubbi (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 <cstdlib>
void* malloc( std::size_t size );

Allocates size bytes of uninitialized storage.

If allocation succeeds, returns a pointer to the lowest (first) byte in the allocated memory block that is suitably aligned for any scalar type.

If size is zero, the behavior is implementation defined (null pointer may be returned, or some non-null pointer may be returned that may not be used to access storage, but has to be passed to std::free)

The following functions are required to be thread-safe:

Calls to these functions that allocate or deallocate a particular unit of storage occur in a single total order, and each such deallocation call happens-before the next allocation (if any) in this order.

(since C++11)

Contents

Parameters

size - number of bytes to allocate

Return value

On success, returns the pointer to the beginning of newly allocated memory. To avoid a memory leak, the returned pointer must be deallocated with std::free() or std::realloc().

On failure, returns a null pointer.

Notes

This function does not call constructors or initialize memory in any way. There are no ready-to-use smart pointers that could guarantee that the matching deallocation function is called. The preferred method of memory allocation in C++ is using RAII-ready functions std::make_unique, std::make_shared, container constructors, etc, and, in low-level library code, new-expression.

Example

#include <iostream>   
#include <cstdlib> 
#include <string>
 
int main() 
{
    // allocates enough for an array of 4 strings
    if(auto p = (std::string*)std::malloc(4 * sizeof(std::string)))
    {
        for(int n=0; n!=4; ++n) // populate the array
            new(p+n) std::string(5, 'a' + n);
 
        for(int n=0; n!=4; ++n) // print it back out
            std::cout << "p[" << n << "] == " << p[n] << '\n';
 
        for(int n=0; n!=4; ++n) // clean up
            p[n].~basic_string();
 
        std::free(p);
    }
}

Output:

p[0] == aaaaa
p[1] == bbbbb
p[2] == ccccc
p[3] == ddddd


See also

allocation functions
(function) [edit]
(deprecated in C++17)(removed in C++20)
obtains uninitialized storage
(function template) [edit]
C documentation for malloc