#include #include #include #include "node.h" #include "node_buffer.h" #include "nan.h" #ifdef _WIN32 #define __alignof__ __alignof #define snprintf(buf, bufSize, format, arg) _snprintf_s(buf, bufSize, _TRUNCATE, format, arg) #define strtoll _strtoi64 #define strtoull _strtoui64 #define PRId64 "lld" #define PRIu64 "llu" #else #define __STDC_FORMAT_MACROS #include #endif using namespace v8; using namespace node; namespace { // used by the Int64 functions to determine whether to return a Number // or String based on whether or not a Number will lose precision. // http://stackoverflow.com/q/307179/376773 #define JS_MAX_INT +9007199254740992LL #define JS_MIN_INT -9007199254740992LL // mirrors deps/v8/src/objects.h. // we could use `node::Buffer::kMaxLength`, but it's not defined on node v0.6.x static const unsigned int kMaxLength = 0x3fffffff; // get int64 from a value inline int64_t GetInt64(Local value) { return value->IsNumber() ? Nan::To(value).FromJust() : 0; } /* * Returns the pointer address as a Number of the given Buffer instance. * It's recommended to use `hexAddress()` in most cases instead of this function. * * WARNING: a JavaScript Number cannot precisely store a full 64-bit memory * address, so there's a possibility of an inaccurate value being returned * on 64-bit systems. * * info[0] - Buffer - the Buffer instance get the memory address of * info[1] - Number - optional (0) - the offset of the Buffer start at */ NAN_METHOD(Address) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("address: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; uintptr_t intptr = (uintptr_t)ptr; Local rtn = Nan::New(static_cast(intptr)); info.GetReturnValue().Set(rtn); } /** * Returns the pointer address as a hexadecimal String. This function * is safe to use for displaying memory addresses, as compared to the * `address()` function which could overflow since it returns a Number. * * info[0] - Buffer - the Buffer instance get the memory address of * info[1] - Number - optional (0) - the offset of the Buffer start at */ NAN_METHOD(HexAddress) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("hexAddress: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; char strbuf[30]; /* should be plenty... */ snprintf(strbuf, 30, "%p", ptr); Local val; if (strbuf[0] == '0' && strbuf[1] == 'x') { /* strip the leading "0x" from the address */ val = Nan::New(strbuf + 2).ToLocalChecked(); } else { val = Nan::New(strbuf).ToLocalChecked(); } info.GetReturnValue().Set(val); } /* * Returns "true" if the given Buffer points to NULL, "false" otherwise. * * info[0] - Buffer - the Buffer instance to check for NULL * info[1] - Number - optional (0) - the offset of the Buffer start at */ NAN_METHOD(IsNull) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("isNull: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; Local rtn = Nan::New(ptr == NULL); info.GetReturnValue().Set(rtn); } /** * Returns the machine endianness as C String; either "BE" or "LE". */ const char *CheckEndianness() { int i = 1; bool is_bigendian = (*(char *)&i) == 0; if (is_bigendian) { return "BE"; } else { return "LE"; } } /* * Converts an arbitrary pointer to a node Buffer with specified length */ void wrap_pointer_cb(char *data, void *hint) { } inline Local WrapPointer(char *ptr, size_t length) { Nan::EscapableHandleScope scope; if (ptr == NULL) length = 0; return scope.Escape(Nan::NewBuffer(ptr, length, wrap_pointer_cb, NULL).ToLocalChecked()); } /* * Creates the "null_pointer_buffer" Buffer instance that points to NULL. * It has a length of 0 so that you don't accidentally try to deref the NULL * pointer in JS-land by doing something like: `ref.NULL[0]`. */ inline Local WrapNullPointer() { return WrapPointer((char*)NULL, 0); } /* * Retreives a JS Object instance that was previously stored in * the given Buffer instance at the given offset. * * info[0] - Buffer - the "buf" Buffer instance to read from * info[1] - Number - the offset from the "buf" buffer's address to read from */ NAN_METHOD(ReadObject) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("readObject: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; if (ptr == NULL) { return Nan::ThrowError("readObject: Cannot read from NULL pointer"); } Persistent* prtn = reinterpret_cast*>(ptr); Local rtn = Nan::New(*prtn); info.GetReturnValue().Set(rtn); } /* * Callback function for when the weak persistent object from WriteObject * gets garbage collected. We just have to dispose of our weak reference now. */ void write_object_cb(const Nan::WeakCallbackInfo& data) { //fprintf(stderr, "write_object_cb\n"); //NanDisposePersistent(data.GetValue()); } /* * Writes a Persistent reference to given Object to the given Buffer * instance and offset. * * info[0] - Buffer - the "buf" Buffer instance to write to * info[1] - Number - the offset from the "buf" buffer's address to write to * info[2] - Object - the "obj" Object which will have a new Persistent reference * created for the obj, who'se memory address will be written * info[3] - Boolean - `false` by default. if `true` is passed in then a * persistent reference will be written to the Buffer instance. * A weak reference gets written by default. */ NAN_METHOD(WriteObject) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("writeObject: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; Nan::Persistent* pptr = reinterpret_cast*>(ptr); Local val = info[2].As(); bool persistent = info[3]->BooleanValue(); if (persistent) { (*pptr).Reset(val); } else { void *user_data = NULL; Nan::Persistent p2(val); p2.SetWeak(user_data, write_object_cb, Nan::WeakCallbackType::kParameter); memcpy(pptr, &p2, sizeof(Nan::Persistent)); } info.GetReturnValue().SetUndefined(); } /* * Reads the memory address of the given "buf" pointer Buffer at the specified * offset, and returns a new SlowBuffer instance from the memory address stored. * * info[0] - Buffer - the "buf" Buffer instance to read from * info[1] - Number - the offset from the "buf" buffer's address to read from * info[2] - Number - the length in bytes of the returned SlowBuffer instance */ NAN_METHOD(ReadPointer) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("readPointer: Buffer instance expected as first argument"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; size_t size = info[2]->Uint32Value(); if (ptr == NULL) { return Nan::ThrowError("readPointer: Cannot read from NULL pointer"); } char *val = *reinterpret_cast(ptr); info.GetReturnValue().Set(WrapPointer(val, size)); } /* * Writes the memory address of the "input" buffer (and optional offset) to the * specified "buf" buffer and offset. Essentially making "buf" hold a reference * to the "input" Buffer. * * info[0] - Buffer - the "buf" Buffer instance to write to * info[1] - Number - the offset from the "buf" buffer's address to write to * info[2] - Buffer - the "input" Buffer whose memory address will be written */ NAN_METHOD(WritePointer) { Local buf = info[0]; Local input = info[2]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("writePointer: Buffer instance expected as first argument"); } if (!(input->IsNull() || Buffer::HasInstance(input))) { return Nan::ThrowTypeError("writePointer: Buffer instance expected as third argument"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; if (input->IsNull()) { *reinterpret_cast(ptr) = NULL; } else { char *input_ptr = Buffer::Data(input.As()); *reinterpret_cast(ptr) = input_ptr; } info.GetReturnValue().SetUndefined(); } /* * Reads a machine-endian int64_t from the given Buffer at the given offset. * * info[0] - Buffer - the "buf" Buffer instance to read from * info[1] - Number - the offset from the "buf" buffer's address to read from */ NAN_METHOD(ReadInt64) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("readInt64: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; if (ptr == NULL) { return Nan::ThrowTypeError("readInt64: Cannot read from NULL pointer"); } int64_t val = *reinterpret_cast(ptr); Local rtn; if (val < JS_MIN_INT || val > JS_MAX_INT) { // return a String char strbuf[128]; snprintf(strbuf, 128, "%" PRId64, val); rtn = Nan::New(strbuf).ToLocalChecked(); } else { // return a Number rtn = Nan::New(static_cast(val)); } info.GetReturnValue().Set(rtn); } /* * Writes the input Number/String int64 value as a machine-endian int64_t to * the given Buffer at the given offset. * * info[0] - Buffer - the "buf" Buffer instance to write to * info[1] - Number - the offset from the "buf" buffer's address to write to * info[2] - String/Number - the "input" String or Number which will be written */ NAN_METHOD(WriteInt64) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("writeInt64: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; Local in = info[2]; int64_t val; if (in->IsNumber()) { val = GetInt64(in); } else if (in->IsString()) { char *endptr, *str; int base = 0; String::Utf8Value _str(in); str = *_str; errno = 0; /* To distinguish success/failure after call */ val = strtoll(str, &endptr, base); if (endptr == str) { return Nan::ThrowTypeError("writeInt64: no digits we found in input String"); } else if (errno == ERANGE && (val == LLONG_MAX || val == LLONG_MIN)) { return Nan::ThrowTypeError("writeInt64: input String numerical value out of range"); } else if (errno != 0 && val == 0) { char errmsg[200]; snprintf(errmsg, sizeof(errmsg), "writeInt64: %s", strerror(errno)); return Nan::ThrowTypeError(errmsg); } } else { return Nan::ThrowTypeError("writeInt64: Number/String 64-bit value required"); } *reinterpret_cast(ptr) = val; info.GetReturnValue().SetUndefined(); } /* * Reads a machine-endian uint64_t from the given Buffer at the given offset. * * info[0] - Buffer - the "buf" Buffer instance to read from * info[1] - Number - the offset from the "buf" buffer's address to read from */ NAN_METHOD(ReadUInt64) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("readUInt64: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; if (ptr == NULL) { return Nan::ThrowTypeError("readUInt64: Cannot read from NULL pointer"); } uint64_t val = *reinterpret_cast(ptr); Local rtn; if (val > JS_MAX_INT) { // return a String char strbuf[128]; snprintf(strbuf, 128, "%" PRIu64, val); rtn = Nan::New(strbuf).ToLocalChecked(); } else { // return a Number rtn = Nan::New(static_cast(val)); } info.GetReturnValue().Set(rtn); } /* * Writes the input Number/String uint64 value as a machine-endian uint64_t to * the given Buffer at the given offset. * * info[0] - Buffer - the "buf" Buffer instance to write to * info[1] - Number - the offset from the "buf" buffer's address to write to * info[2] - String/Number - the "input" String or Number which will be written */ NAN_METHOD(WriteUInt64) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("writeUInt64: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; Local in = info[2]; uint64_t val; if (in->IsNumber()) { val = GetInt64(in); } else if (in->IsString()) { char *endptr, *str; int base = 0; String::Utf8Value _str(in); str = *_str; errno = 0; /* To distinguish success/failure after call */ val = strtoull(str, &endptr, base); if (endptr == str) { return Nan::ThrowTypeError("writeUInt64: no digits we found in input String"); } else if (errno == ERANGE && val == ULLONG_MAX) { return Nan::ThrowTypeError("writeUInt64: input String numerical value out of range"); } else if (errno != 0 && val == 0) { char errmsg[200]; snprintf(errmsg, sizeof(errmsg), "writeUInt64: %s", strerror(errno)); return Nan::ThrowTypeError(errmsg); } } else { return Nan::ThrowTypeError("writeUInt64: Number/String 64-bit value required"); } *reinterpret_cast(ptr) = val; info.GetReturnValue().SetUndefined(); } /* * Reads a Utf8 C String from the given pointer at the given offset (or 0). * I didn't want to add this function but it ends up being necessary for reading * past a 0 or 1 length Buffer's boundary in node-ffi :\ * * info[0] - Buffer - the "buf" Buffer instance to read from * info[1] - Number - the offset from the "buf" buffer's address to read from */ NAN_METHOD(ReadCString) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("readCString: Buffer instance expected"); } int64_t offset = GetInt64(info[1]); char *ptr = Buffer::Data(buf.As()) + offset; if (ptr == NULL) { return Nan::ThrowError("readCString: Cannot read from NULL pointer"); } Local rtn = Nan::New(ptr).ToLocalChecked(); info.GetReturnValue().Set(rtn); } /* * Returns a new Buffer instance that has the same memory address * as the given buffer, but with the specified size. * * info[0] - Buffer - the "buf" Buffer instance to read the address from * info[1] - Number - the size in bytes that the returned Buffer should be * info[2] - Number - the offset from the "buf" buffer's address to read from */ NAN_METHOD(ReinterpretBuffer) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("reinterpret: Buffer instance expected"); } int64_t offset = GetInt64(info[2]); char *ptr = Buffer::Data(buf.As()) + offset; if (ptr == NULL) { return Nan::ThrowError("reinterpret: Cannot reinterpret from NULL pointer"); } size_t size = info[1]->Uint32Value(); info.GetReturnValue().Set(WrapPointer(ptr, size)); } /* * Returns a new Buffer instance that has the same memory address * as the given buffer, but with a length up to the first aligned set of values of * 0 in a row for the given length. * * info[0] - Buffer - the "buf" Buffer instance to read the address from * info[1] - Number - the number of sequential 0-byte values that need to be read * info[2] - Number - the offset from the "buf" buffer's address to read from */ NAN_METHOD(ReinterpretBufferUntilZeros) { Local buf = info[0]; if (!Buffer::HasInstance(buf)) { return Nan::ThrowTypeError("reinterpretUntilZeros: Buffer instance expected"); } int64_t offset = GetInt64(info[2]); char *ptr = Buffer::Data(buf.As()) + offset; if (ptr == NULL) { return Nan::ThrowError("reinterpretUntilZeros: Cannot reinterpret from NULL pointer"); } uint32_t numZeros = info[1]->Uint32Value(); uint32_t i = 0; size_t size = 0; bool end = false; while (!end && size < kMaxLength) { end = true; for (i = 0; i < numZeros; i++) { if (ptr[size + i] != 0) { end = false; break; } } if (!end) { size += numZeros; } } info.GetReturnValue().Set(WrapPointer(ptr, size)); } } // anonymous namespace NAN_MODULE_INIT(init) { Nan::HandleScope scope; // "sizeof" map Local smap = Nan::New(); // fixed sizes #define SET_SIZEOF(name, type) \ smap->Set(Nan::New( #name ).ToLocalChecked(), Nan::New(static_cast(sizeof(type)))); SET_SIZEOF(int8, int8_t); SET_SIZEOF(uint8, uint8_t); SET_SIZEOF(int16, int16_t); SET_SIZEOF(uint16, uint16_t); SET_SIZEOF(int32, int32_t); SET_SIZEOF(uint32, uint32_t); SET_SIZEOF(int64, int64_t); SET_SIZEOF(uint64, uint64_t); SET_SIZEOF(float, float); SET_SIZEOF(double, double); // (potentially) variable sizes SET_SIZEOF(bool, bool); SET_SIZEOF(byte, unsigned char); SET_SIZEOF(char, char); SET_SIZEOF(uchar, unsigned char); SET_SIZEOF(short, short); SET_SIZEOF(ushort, unsigned short); SET_SIZEOF(int, int); SET_SIZEOF(uint, unsigned int); SET_SIZEOF(long, long); SET_SIZEOF(ulong, unsigned long); SET_SIZEOF(longlong, long long); SET_SIZEOF(ulonglong, unsigned long long); SET_SIZEOF(pointer, char *); SET_SIZEOF(size_t, size_t); // size of a Persistent handle to a JS object SET_SIZEOF(Object, Nan::Persistent); // "alignof" map Local amap = Nan::New(); #define SET_ALIGNOF(name, type) \ struct s_##name { type a; }; \ amap->Set(Nan::New( #name ).ToLocalChecked(), Nan::New(static_cast(__alignof__(struct s_##name)))); SET_ALIGNOF(int8, int8_t); SET_ALIGNOF(uint8, uint8_t); SET_ALIGNOF(int16, int16_t); SET_ALIGNOF(uint16, uint16_t); SET_ALIGNOF(int32, int32_t); SET_ALIGNOF(uint32, uint32_t); SET_ALIGNOF(int64, int64_t); SET_ALIGNOF(uint64, uint64_t); SET_ALIGNOF(float, float); SET_ALIGNOF(double, double); SET_ALIGNOF(bool, bool); SET_ALIGNOF(char, char); SET_ALIGNOF(uchar, unsigned char); SET_ALIGNOF(short, short); SET_ALIGNOF(ushort, unsigned short); SET_ALIGNOF(int, int); SET_ALIGNOF(uint, unsigned int); SET_ALIGNOF(long, long); SET_ALIGNOF(ulong, unsigned long); SET_ALIGNOF(longlong, long long); SET_ALIGNOF(ulonglong, unsigned long long); SET_ALIGNOF(pointer, char *); SET_ALIGNOF(size_t, size_t); SET_ALIGNOF(Object, Nan::Persistent); // exports target->Set(Nan::New("sizeof").ToLocalChecked(), smap); target->Set(Nan::New("alignof").ToLocalChecked(), amap); Nan::ForceSet(target, Nan::New("endianness").ToLocalChecked(), Nan::New(CheckEndianness()).ToLocalChecked(), static_cast(ReadOnly|DontDelete)); Nan::ForceSet(target, Nan::New("NULL").ToLocalChecked(), WrapNullPointer(), static_cast(ReadOnly|DontDelete)); Nan::SetMethod(target, "address", Address); Nan::SetMethod(target, "hexAddress", HexAddress); Nan::SetMethod(target, "isNull", IsNull); Nan::SetMethod(target, "readObject", ReadObject); Nan::SetMethod(target, "writeObject", WriteObject); Nan::SetMethod(target, "readPointer", ReadPointer); Nan::SetMethod(target, "writePointer", WritePointer); Nan::SetMethod(target, "readInt64", ReadInt64); Nan::SetMethod(target, "writeInt64", WriteInt64); Nan::SetMethod(target, "readUInt64", ReadUInt64); Nan::SetMethod(target, "writeUInt64", WriteUInt64); Nan::SetMethod(target, "readCString", ReadCString); Nan::SetMethod(target, "reinterpret", ReinterpretBuffer); Nan::SetMethod(target, "reinterpretUntilZeros", ReinterpretBufferUntilZeros); } NODE_MODULE(binding, init);