1 // Copyright Joyent, Inc. and other Node contributors.
3 // Permission is hereby granted, free of charge, to any person obtaining a
4 // copy of this software and associated documentation files (the
5 // "Software"), to deal in the Software without restriction, including
6 // without limitation the rights to use, copy, modify, merge, publish,
7 // distribute, sublicense, and/or sell copies of the Software, and to permit
8 // persons to whom the Software is furnished to do so, subject to the
9 // following conditions:
11 // The above copyright notice and this permission notice shall be included
12 // in all copies or substantial portions of the Software.
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17 // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19 // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 // USE OR OTHER DEALINGS IN THE SOFTWARE.
24 #include "node_buffer.h"
29 #include "string_bytes.h"
30 #include "v8-profiler.h"
37 #define MIN(a, b) ((a) < (b) ? (a) : (b))
39 #define CHECK_NOT_OOB(r) \
41 if (!(r)) return env->ThrowRangeError("out of range index"); \
44 #define ARGS_THIS(argT) \
45 Local<Object> obj = argT; \
46 size_t obj_length = obj->GetIndexedPropertiesExternalArrayDataLength(); \
47 char* obj_data = static_cast<char*>( \
48 obj->GetIndexedPropertiesExternalArrayData()); \
50 assert(obj_data != NULL);
52 #define SLICE_START_END(start_arg, end_arg, end_max) \
55 CHECK_NOT_OOB(ParseArrayIndex(start_arg, 0, &start)); \
56 CHECK_NOT_OOB(ParseArrayIndex(end_arg, end_max, &end)); \
57 if (end < start) end = start; \
58 CHECK_NOT_OOB(end <= end_max); \
59 size_t length = end - start;
64 using v8::ArrayBuffer;
66 using v8::EscapableHandleScope;
68 using v8::FunctionCallbackInfo;
69 using v8::FunctionTemplate;
71 using v8::HandleScope;
81 bool HasInstance(Handle<Value> val) {
82 return val->IsObject() && HasInstance(val.As<Object>());
86 bool HasInstance(Handle<Object> obj) {
87 if (!obj->HasIndexedPropertiesInExternalArrayData())
89 v8::ExternalArrayType type = obj->GetIndexedPropertiesExternalArrayDataType();
90 return type == v8::kExternalUnsignedByteArray;
94 char* Data(Handle<Value> val) {
95 assert(val->IsObject());
96 // Use a fully qualified name here to work around a bug in gcc 4.2.
97 // It mistakes an unadorned call to Data() for the v8::String::Data type.
98 return node::Buffer::Data(val.As<Object>());
102 char* Data(Handle<Object> obj) {
103 assert(obj->HasIndexedPropertiesInExternalArrayData());
104 return static_cast<char*>(obj->GetIndexedPropertiesExternalArrayData());
108 size_t Length(Handle<Value> val) {
109 assert(val->IsObject());
110 return Length(val.As<Object>());
114 size_t Length(Handle<Object> obj) {
115 assert(obj->HasIndexedPropertiesInExternalArrayData());
116 return obj->GetIndexedPropertiesExternalArrayDataLength();
120 Local<Object> New(Isolate* isolate, Handle<String> string, enum encoding enc) {
121 EscapableHandleScope scope(isolate);
123 size_t length = StringBytes::Size(isolate, string, enc);
125 Local<Object> buf = New(length);
126 char* data = Buffer::Data(buf);
127 StringBytes::Write(isolate, data, length, string, enc);
129 return scope.Escape(buf);
133 Local<Object> New(Isolate* isolate, size_t length) {
134 EscapableHandleScope handle_scope(isolate);
135 Local<Object> obj = Buffer::New(Environment::GetCurrent(isolate), length);
136 return handle_scope.Escape(obj);
140 // TODO(trevnorris): these have a flaw by needing to call the Buffer inst then
141 // Alloc. continue to look for a better architecture.
142 Local<Object> New(Environment* env, size_t length) {
143 EscapableHandleScope scope(env->isolate());
145 assert(length <= kMaxLength);
147 Local<Value> arg = Uint32::NewFromUnsigned(env->isolate(), length);
148 Local<Object> obj = env->buffer_constructor_function()->NewInstance(1, &arg);
150 // TODO(trevnorris): done like this to handle HasInstance since only checks
151 // if external array data has been set, but would like to use a better
152 // approach if v8 provided one.
155 data = static_cast<char*>(malloc(length));
157 FatalError("node::Buffer::New(size_t)", "Out Of Memory");
161 smalloc::Alloc(env, obj, data, length);
163 return scope.Escape(obj);
167 Local<Object> New(Isolate* isolate, const char* data, size_t length) {
168 Environment* env = Environment::GetCurrent(isolate);
169 EscapableHandleScope handle_scope(env->isolate());
170 Local<Object> obj = Buffer::New(env, data, length);
171 return handle_scope.Escape(obj);
175 // TODO(trevnorris): for backwards compatibility this is left to copy the data,
176 // but for consistency w/ the other should use data. And a copy version renamed
177 // to something else.
178 Local<Object> New(Environment* env, const char* data, size_t length) {
179 EscapableHandleScope scope(env->isolate());
181 assert(length <= kMaxLength);
183 Local<Value> arg = Uint32::NewFromUnsigned(env->isolate(), length);
184 Local<Object> obj = env->buffer_constructor_function()->NewInstance(1, &arg);
186 // TODO(trevnorris): done like this to handle HasInstance since only checks
187 // if external array data has been set, but would like to use a better
188 // approach if v8 provided one.
191 new_data = static_cast<char*>(malloc(length));
192 if (new_data == NULL)
193 FatalError("node::Buffer::New(const char*, size_t)", "Out Of Memory");
194 memcpy(new_data, data, length);
199 smalloc::Alloc(env, obj, new_data, length);
201 return scope.Escape(obj);
205 Local<Object> New(Isolate* isolate,
208 smalloc::FreeCallback callback,
210 Environment* env = Environment::GetCurrent(isolate);
211 EscapableHandleScope handle_scope(env->isolate());
212 Local<Object> obj = Buffer::New(env, data, length, callback, hint);
213 return handle_scope.Escape(obj);
217 Local<Object> New(Environment* env,
220 smalloc::FreeCallback callback,
222 EscapableHandleScope scope(env->isolate());
224 assert(length <= kMaxLength);
226 Local<Value> arg = Uint32::NewFromUnsigned(env->isolate(), length);
227 Local<Object> obj = env->buffer_constructor_function()->NewInstance(1, &arg);
229 smalloc::Alloc(env, obj, data, length, callback, hint);
231 return scope.Escape(obj);
235 Local<Object> Use(Isolate* isolate, char* data, uint32_t length) {
236 Environment* env = Environment::GetCurrent(isolate);
237 EscapableHandleScope handle_scope(env->isolate());
238 Local<Object> obj = Buffer::Use(env, data, length);
239 return handle_scope.Escape(obj);
243 Local<Object> Use(Environment* env, char* data, uint32_t length) {
244 EscapableHandleScope scope(env->isolate());
246 assert(length <= kMaxLength);
248 Local<Value> arg = Uint32::NewFromUnsigned(env->isolate(), length);
249 Local<Object> obj = env->buffer_constructor_function()->NewInstance(1, &arg);
251 smalloc::Alloc(env, obj, data, length);
253 return scope.Escape(obj);
257 template <encoding encoding>
258 void StringSlice(const FunctionCallbackInfo<Value>& args) {
259 Environment* env = Environment::GetCurrent(args.GetIsolate());
260 HandleScope scope(env->isolate());
262 ARGS_THIS(args.This())
263 SLICE_START_END(args[0], args[1], obj_length)
265 args.GetReturnValue().Set(
266 StringBytes::Encode(env->isolate(), obj_data + start, length, encoding));
270 void BinarySlice(const FunctionCallbackInfo<Value>& args) {
271 StringSlice<BINARY>(args);
275 void AsciiSlice(const FunctionCallbackInfo<Value>& args) {
276 StringSlice<ASCII>(args);
280 void Utf8Slice(const FunctionCallbackInfo<Value>& args) {
281 StringSlice<UTF8>(args);
285 void Ucs2Slice(const FunctionCallbackInfo<Value>& args) {
286 StringSlice<UCS2>(args);
290 void HexSlice(const FunctionCallbackInfo<Value>& args) {
291 StringSlice<HEX>(args);
295 void Base64Slice(const FunctionCallbackInfo<Value>& args) {
296 StringSlice<BASE64>(args);
300 // bytesCopied = buffer.copy(target[, targetStart][, sourceStart][, sourceEnd]);
301 void Copy(const FunctionCallbackInfo<Value> &args) {
302 Environment* env = Environment::GetCurrent(args.GetIsolate());
303 HandleScope scope(env->isolate());
305 Local<Object> target = args[0]->ToObject();
307 if (!HasInstance(target))
308 return env->ThrowTypeError("first arg should be a Buffer");
310 ARGS_THIS(args.This())
311 size_t target_length = target->GetIndexedPropertiesExternalArrayDataLength();
312 char* target_data = static_cast<char*>(
313 target->GetIndexedPropertiesExternalArrayData());
318 CHECK_NOT_OOB(ParseArrayIndex(args[1], 0, &target_start));
319 CHECK_NOT_OOB(ParseArrayIndex(args[2], 0, &source_start));
320 CHECK_NOT_OOB(ParseArrayIndex(args[3], obj_length, &source_end));
322 // Copy 0 bytes; we're done
323 if (target_start >= target_length || source_start >= source_end)
324 return args.GetReturnValue().Set(0);
326 if (source_start > obj_length)
327 return env->ThrowRangeError("out of range index");
329 if (source_end - source_start > target_length - target_start)
330 source_end = source_start + target_length - target_start;
332 uint32_t to_copy = MIN(MIN(source_end - source_start,
333 target_length - target_start),
334 obj_length - source_start);
336 memmove(target_data + target_start, obj_data + source_start, to_copy);
337 args.GetReturnValue().Set(to_copy);
341 // buffer.fill(value[, start][, end]);
342 void Fill(const FunctionCallbackInfo<Value>& args) {
343 Environment* env = Environment::GetCurrent(args.GetIsolate());
344 HandleScope scope(env->isolate());
346 ARGS_THIS(args.This())
347 SLICE_START_END(args[1], args[2], obj_length)
348 args.GetReturnValue().Set(args.This());
350 if (args[0]->IsNumber()) {
351 int value = args[0]->Uint32Value() & 255;
352 memset(obj_data + start, value, length);
356 String::Utf8Value at(args[0]);
357 size_t at_length = at.length();
359 // optimize single ascii character case
360 if (at_length == 1) {
361 int value = static_cast<int>((*at)[0]);
362 memset(obj_data + start, value, length);
366 size_t in_there = at_length;
367 char* ptr = obj_data + start + at_length;
369 memcpy(obj_data + start, *at, MIN(at_length, length));
371 if (at_length >= length)
374 while (in_there < length - in_there) {
375 memcpy(ptr, obj_data + start, in_there);
380 if (in_there < length) {
381 memcpy(ptr, obj_data + start, length - in_there);
387 template <encoding encoding>
388 void StringWrite(const FunctionCallbackInfo<Value>& args) {
389 Environment* env = Environment::GetCurrent(args.GetIsolate());
390 HandleScope scope(env->isolate());
392 ARGS_THIS(args.This())
394 if (!args[0]->IsString())
395 return env->ThrowTypeError("Argument must be a string");
397 Local<String> str = args[0]->ToString();
399 if (encoding == HEX && str->Length() % 2 != 0)
400 return env->ThrowTypeError("Invalid hex string");
405 CHECK_NOT_OOB(ParseArrayIndex(args[1], 0, &offset));
406 CHECK_NOT_OOB(ParseArrayIndex(args[2], obj_length - offset, &max_length));
408 max_length = MIN(obj_length - offset, max_length);
411 return args.GetReturnValue().Set(0);
413 if (encoding == UCS2)
414 max_length = max_length / 2;
416 if (offset >= obj_length)
417 return env->ThrowRangeError("Offset is out of bounds");
419 uint32_t written = StringBytes::Write(env->isolate(),
425 args.GetReturnValue().Set(written);
429 void Base64Write(const FunctionCallbackInfo<Value>& args) {
430 StringWrite<BASE64>(args);
434 void BinaryWrite(const FunctionCallbackInfo<Value>& args) {
435 StringWrite<BINARY>(args);
439 void Utf8Write(const FunctionCallbackInfo<Value>& args) {
440 StringWrite<UTF8>(args);
444 void Ucs2Write(const FunctionCallbackInfo<Value>& args) {
445 StringWrite<UCS2>(args);
449 void HexWrite(const FunctionCallbackInfo<Value>& args) {
450 StringWrite<HEX>(args);
454 void AsciiWrite(const FunctionCallbackInfo<Value>& args) {
455 StringWrite<ASCII>(args);
459 static inline void Swizzle(char* start, unsigned int len) {
460 char* end = start + len - 1;
461 while (start < end) {
469 template <typename T, enum Endianness endianness>
470 void ReadFloatGeneric(const FunctionCallbackInfo<Value>& args) {
471 Environment* env = Environment::GetCurrent(args.GetIsolate());
472 bool doAssert = !args[1]->BooleanValue();
475 CHECK_NOT_OOB(ParseArrayIndex(args[0], 0, &offset));
478 size_t len = Length(args.This());
479 if (offset + sizeof(T) > len || offset + sizeof(T) < offset)
480 return env->ThrowRangeError("Trying to read beyond buffer length");
485 char bytes[sizeof(T)];
489 const void* data = args.This()->GetIndexedPropertiesExternalArrayData();
490 const char* ptr = static_cast<const char*>(data) + offset;
491 memcpy(na.bytes, ptr, sizeof(na.bytes));
492 if (endianness != GetEndianness())
493 Swizzle(na.bytes, sizeof(na.bytes));
495 args.GetReturnValue().Set(na.val);
499 void ReadFloatLE(const FunctionCallbackInfo<Value>& args) {
500 ReadFloatGeneric<float, kLittleEndian>(args);
504 void ReadFloatBE(const FunctionCallbackInfo<Value>& args) {
505 ReadFloatGeneric<float, kBigEndian>(args);
509 void ReadDoubleLE(const FunctionCallbackInfo<Value>& args) {
510 ReadFloatGeneric<double, kLittleEndian>(args);
514 void ReadDoubleBE(const FunctionCallbackInfo<Value>& args) {
515 ReadFloatGeneric<double, kBigEndian>(args);
519 template <typename T, enum Endianness endianness>
520 uint32_t WriteFloatGeneric(const FunctionCallbackInfo<Value>& args) {
521 Environment* env = Environment::GetCurrent(args.GetIsolate());
522 bool doAssert = !args[2]->BooleanValue();
524 T val = static_cast<T>(args[0]->NumberValue());
527 if (!ParseArrayIndex(args[1], 0, &offset)) {
528 env->ThrowRangeError("out of range index");
533 size_t len = Length(args.This());
534 if (offset + sizeof(T) > len || offset + sizeof(T) < offset) {
535 env->ThrowRangeError("Trying to write beyond buffer length");
542 char bytes[sizeof(T)];
545 union NoAlias na = { val };
546 void* data = args.This()->GetIndexedPropertiesExternalArrayData();
547 char* ptr = static_cast<char*>(data) + offset;
548 if (endianness != GetEndianness())
549 Swizzle(na.bytes, sizeof(na.bytes));
550 memcpy(ptr, na.bytes, sizeof(na.bytes));
551 return offset + sizeof(na.bytes);
555 void WriteFloatLE(const FunctionCallbackInfo<Value>& args) {
556 args.GetReturnValue().Set(WriteFloatGeneric<float, kLittleEndian>(args));
560 void WriteFloatBE(const FunctionCallbackInfo<Value>& args) {
561 args.GetReturnValue().Set(WriteFloatGeneric<float, kBigEndian>(args));
565 void WriteDoubleLE(const FunctionCallbackInfo<Value>& args) {
566 args.GetReturnValue().Set(WriteFloatGeneric<double, kLittleEndian>(args));
570 void WriteDoubleBE(const FunctionCallbackInfo<Value>& args) {
571 args.GetReturnValue().Set(WriteFloatGeneric<double, kBigEndian>(args));
575 void ToArrayBuffer(const FunctionCallbackInfo<Value>& args) {
576 Environment* env = Environment::GetCurrent(args.GetIsolate());
577 HandleScope scope(env->isolate());
579 ARGS_THIS(args.This());
580 void* adata = malloc(obj_length);
583 FatalError("node::Buffer::ToArrayBuffer("
584 "const FunctionCallbackInfo<v8::Value>&)",
588 memcpy(adata, obj_data, obj_length);
590 Local<ArrayBuffer> abuf = ArrayBuffer::New(env->isolate(), adata, obj_length);
591 args.GetReturnValue().Set(abuf);
595 void ByteLength(const FunctionCallbackInfo<Value> &args) {
596 Environment* env = Environment::GetCurrent(args.GetIsolate());
597 HandleScope scope(env->isolate());
599 if (!args[0]->IsString())
600 return env->ThrowTypeError("Argument must be a string");
602 Local<String> s = args[0]->ToString();
603 enum encoding e = ParseEncoding(env->isolate(), args[1], UTF8);
605 uint32_t size = StringBytes::Size(env->isolate(), s, e);
606 args.GetReturnValue().Set(size);
610 // pass Buffer object to load prototype methods
611 void SetupBufferJS(const FunctionCallbackInfo<Value>& args) {
612 Environment* env = Environment::GetCurrent(args.GetIsolate());
613 HandleScope scope(env->isolate());
615 assert(args[0]->IsFunction());
617 Local<Function> bv = args[0].As<Function>();
618 env->set_buffer_constructor_function(bv);
619 Local<Value> proto_v = bv->Get(env->prototype_string());
621 assert(proto_v->IsObject());
623 Local<Object> proto = proto_v.As<Object>();
625 NODE_SET_METHOD(proto, "asciiSlice", AsciiSlice);
626 NODE_SET_METHOD(proto, "base64Slice", Base64Slice);
627 NODE_SET_METHOD(proto, "binarySlice", BinarySlice);
628 NODE_SET_METHOD(proto, "hexSlice", HexSlice);
629 NODE_SET_METHOD(proto, "ucs2Slice", Ucs2Slice);
630 NODE_SET_METHOD(proto, "utf8Slice", Utf8Slice);
632 NODE_SET_METHOD(proto, "asciiWrite", AsciiWrite);
633 NODE_SET_METHOD(proto, "base64Write", Base64Write);
634 NODE_SET_METHOD(proto, "binaryWrite", BinaryWrite);
635 NODE_SET_METHOD(proto, "hexWrite", HexWrite);
636 NODE_SET_METHOD(proto, "ucs2Write", Ucs2Write);
637 NODE_SET_METHOD(proto, "utf8Write", Utf8Write);
639 NODE_SET_METHOD(proto, "readDoubleBE", ReadDoubleBE);
640 NODE_SET_METHOD(proto, "readDoubleLE", ReadDoubleLE);
641 NODE_SET_METHOD(proto, "readFloatBE", ReadFloatBE);
642 NODE_SET_METHOD(proto, "readFloatLE", ReadFloatLE);
644 NODE_SET_METHOD(proto, "writeDoubleBE", WriteDoubleBE);
645 NODE_SET_METHOD(proto, "writeDoubleLE", WriteDoubleLE);
646 NODE_SET_METHOD(proto, "writeFloatBE", WriteFloatBE);
647 NODE_SET_METHOD(proto, "writeFloatLE", WriteFloatLE);
649 NODE_SET_METHOD(proto, "toArrayBuffer", ToArrayBuffer);
651 NODE_SET_METHOD(proto, "copy", Copy);
652 NODE_SET_METHOD(proto, "fill", Fill);
654 // for backwards compatibility
655 proto->Set(env->offset_string(),
656 Uint32::New(env->isolate(), 0),
659 assert(args[1]->IsObject());
661 Local<Object> internal = args[1].As<Object>();
663 internal->Set(env->byte_length_string(),
664 FunctionTemplate::New(
665 env->isolate(), ByteLength)->GetFunction());
669 void Initialize(Handle<Object> target,
670 Handle<Value> unused,
671 Handle<Context> context) {
672 Environment* env = Environment::GetCurrent(context);
673 target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "setupBufferJS"),
674 FunctionTemplate::New(env->isolate(), SetupBufferJS)
679 } // namespace Buffer
682 NODE_MODULE_CONTEXT_AWARE_BUILTIN(buffer, node::Buffer::Initialize)