73062521a4
Upcoming V8 changes will make it impossible to keep supporting the smalloc functionality so deprecate the functions in smalloc.h now and tell people to switch to typed arrays. This commit shuffles code around in smalloc.cc to avoid generating the deprecation warnings when building io.js itself. PR-URL: https://github.com/iojs/io.js/pull/1565 Reviewed-By: Trevor Norris <trev.norris@gmail.com>
147 lines
4.9 KiB
C++
147 lines
4.9 KiB
C++
#ifndef SRC_SMALLOC_H_
|
|
#define SRC_SMALLOC_H_
|
|
|
|
#include "node.h"
|
|
#include "v8.h"
|
|
|
|
namespace node {
|
|
|
|
// Forward declaration
|
|
class Environment;
|
|
|
|
/**
|
|
* Simple memory allocator.
|
|
*
|
|
* Utilities for external memory allocation management. Is an abstraction for
|
|
* v8's external array data handling to simplify and centralize how this is
|
|
* managed.
|
|
*/
|
|
namespace smalloc {
|
|
|
|
// mirrors deps/v8/src/objects.h
|
|
static const unsigned int kMaxLength = 0x3fffffff;
|
|
|
|
NODE_EXTERN typedef void (*FreeCallback)(char* data, void* hint);
|
|
|
|
/**
|
|
* Return byte size of external array type.
|
|
*/
|
|
NODE_DEPRECATED(
|
|
"Use typed arrays",
|
|
NODE_EXTERN size_t ExternalArraySize(enum v8::ExternalArrayType type));
|
|
|
|
/**
|
|
* Allocate external array data onto obj.
|
|
*
|
|
* Passed data transfers ownership, and if no callback is passed then memory
|
|
* will automatically be free'd using free() (not delete[]).
|
|
*
|
|
* length is always the byte size of the data. Not the length of the external
|
|
* array. This intentionally differs from the JS API so users always know
|
|
* exactly how much memory is being allocated, regardless of the external array
|
|
* type. For this reason the helper function ExternalArraySize is provided to
|
|
* help determine the appropriate byte size to be allocated.
|
|
*
|
|
* In the following example we're allocating a Float array and setting the
|
|
* "length" property on the Object:
|
|
*
|
|
* \code
|
|
* size_t array_length = 8;
|
|
* size_t byte_length = node::smalloc::ExternalArraySize(
|
|
* v8::kExternalFloatArray);
|
|
* v8::Local<v8::Object> obj = v8::Object::New();
|
|
* char* data = static_cast<char*>(malloc(byte_length * array_length));
|
|
* node::smalloc::Alloc(isolate, obj, data, byte_length,
|
|
* v8::kExternalFloatArray);
|
|
* obj->Set(v8::String::NewFromUtf8("length"),
|
|
* v8::Integer::NewFromUnsigned(array_length));
|
|
* \code
|
|
*/
|
|
NODE_DEPRECATED(
|
|
"Use typed arrays",
|
|
NODE_EXTERN void Alloc(v8::Isolate* isolate,
|
|
v8::Handle<v8::Object> obj,
|
|
size_t length,
|
|
enum v8::ExternalArrayType type =
|
|
v8::kExternalUnsignedByteArray));
|
|
NODE_DEPRECATED(
|
|
"Use typed arrays",
|
|
NODE_EXTERN void Alloc(v8::Isolate* isolate,
|
|
v8::Handle<v8::Object> obj,
|
|
char* data,
|
|
size_t length,
|
|
enum v8::ExternalArrayType type =
|
|
v8::kExternalUnsignedByteArray));
|
|
NODE_DEPRECATED(
|
|
"Use typed arrays",
|
|
NODE_EXTERN void Alloc(v8::Isolate* isolate,
|
|
v8::Handle<v8::Object> obj,
|
|
size_t length,
|
|
FreeCallback fn,
|
|
void* hint,
|
|
enum v8::ExternalArrayType type =
|
|
v8::kExternalUnsignedByteArray));
|
|
NODE_DEPRECATED(
|
|
"Use typed arrays",
|
|
NODE_EXTERN void Alloc(v8::Isolate* isolate,
|
|
v8::Handle<v8::Object> obj,
|
|
char* data,
|
|
size_t length,
|
|
FreeCallback fn,
|
|
void* hint,
|
|
enum v8::ExternalArrayType type =
|
|
v8::kExternalUnsignedByteArray));
|
|
|
|
/**
|
|
* Free memory associated with an externally allocated object. If no external
|
|
* memory is allocated to the object then nothing will happen.
|
|
*/
|
|
NODE_DEPRECATED(
|
|
"Use typed arrays",
|
|
NODE_EXTERN void AllocDispose(v8::Isolate* isolate,
|
|
v8::Handle<v8::Object> obj));
|
|
|
|
|
|
/**
|
|
* Check if the Object has externally allocated memory.
|
|
*/
|
|
NODE_DEPRECATED(
|
|
"Use typed arrays",
|
|
NODE_EXTERN bool HasExternalData(v8::Isolate* isolate,
|
|
v8::Local<v8::Object> obj));
|
|
|
|
|
|
// Internal use
|
|
void Alloc(Environment* env,
|
|
v8::Handle<v8::Object> obj,
|
|
size_t length,
|
|
enum v8::ExternalArrayType type =
|
|
v8::kExternalUnsignedByteArray);
|
|
void Alloc(Environment* env,
|
|
v8::Handle<v8::Object> obj,
|
|
char* data,
|
|
size_t length,
|
|
enum v8::ExternalArrayType type =
|
|
v8::kExternalUnsignedByteArray);
|
|
void Alloc(Environment* env,
|
|
v8::Handle<v8::Object> obj,
|
|
size_t length,
|
|
FreeCallback fn,
|
|
void* hint,
|
|
enum v8::ExternalArrayType type =
|
|
v8::kExternalUnsignedByteArray);
|
|
void Alloc(Environment* env,
|
|
v8::Handle<v8::Object> obj,
|
|
char* data,
|
|
size_t length,
|
|
FreeCallback fn,
|
|
void* hint,
|
|
enum v8::ExternalArrayType type =
|
|
v8::kExternalUnsignedByteArray);
|
|
void AllocDispose(Environment* env, v8::Handle<v8::Object> obj);
|
|
bool HasExternalData(Environment* env, v8::Local<v8::Object> obj);
|
|
|
|
} // namespace smalloc
|
|
} // namespace node
|
|
|
|
#endif // SRC_SMALLOC_H_
|