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 <stdlib.h> // malloc, free
30
#include <string.h> // memcpy
33
# include "platform.h"
34
# include <platform_win32_winsock.h> // htons, htonl
38
# include <arpa/inet.h> // htons, htonl
42
#define MIN(a,b) ((a) < (b) ? (a) : (b))
48
#define SLICE_ARGS(start_arg, end_arg) \
49
if (!start_arg->IsInt32() || !end_arg->IsInt32()) { \
50
return ThrowException(Exception::TypeError( \
51
String::New("Bad argument."))); \
53
int32_t start = start_arg->Int32Value(); \
54
int32_t end = end_arg->Int32Value(); \
55
if (start < 0 || end < 0) { \
56
return ThrowException(Exception::TypeError( \
57
String::New("Bad argument."))); \
59
if (!(start <= end)) { \
60
return ThrowException(Exception::Error( \
61
String::New("Must have start <= end"))); \
63
if ((size_t)end > parent->length_) { \
64
return ThrowException(Exception::Error( \
65
String::New("end cannot be longer than parent.length"))); \
69
static Persistent<String> length_symbol;
70
static Persistent<String> chars_written_sym;
71
static Persistent<String> write_sym;
72
Persistent<FunctionTemplate> Buffer::constructor_template;
75
static inline size_t base64_decoded_size(const char *src, size_t size) {
76
const char *const end = src + size;
77
const int remainder = size % 4;
79
size = (size / 4) * 3;
81
if (size == 0 && remainder == 1) {
82
// special case: 1-byte input cannot be decoded
85
// non-padded input, add 1 or 2 extra bytes
86
size += 1 + (remainder == 3);
90
// check for trailing padding (1 or 2 bytes)
92
if (end[-1] == '=') size--;
93
if (end[-2] == '=') size--;
100
static size_t ByteLength (Handle<String> string, enum encoding enc) {
104
return string->Utf8Length();
105
} else if (enc == BASE64) {
106
String::Utf8Value v(string);
107
return base64_decoded_size(*v, v.length());
108
} else if (enc == UCS2) {
109
return string->Length() * 2;
111
return string->Length();
116
Handle<Object> Buffer::New(Handle<String> string) {
119
// get Buffer from global scope.
120
Local<Object> global = v8::Context::GetCurrent()->Global();
121
Local<Value> bv = global->Get(String::NewSymbol("Buffer"));
122
assert(bv->IsFunction());
123
Local<Function> b = Local<Function>::Cast(bv);
125
Local<Value> argv[1] = { Local<Value>::New(string) };
126
Local<Object> instance = b->NewInstance(1, argv);
128
return scope.Close(instance);
132
Buffer* Buffer::New(size_t length) {
135
Local<Value> arg = Integer::NewFromUnsigned(length);
136
Local<Object> b = constructor_template->GetFunction()->NewInstance(1, &arg);
137
if (b.IsEmpty()) return NULL;
139
return ObjectWrap::Unwrap<Buffer>(b);
143
Buffer* Buffer::New(char* data, size_t length) {
146
Local<Value> arg = Integer::NewFromUnsigned(0);
147
Local<Object> obj = constructor_template->GetFunction()->NewInstance(1, &arg);
149
Buffer *buffer = ObjectWrap::Unwrap<Buffer>(obj);
150
buffer->Replace(data, length, NULL, NULL);
156
Buffer* Buffer::New(char *data, size_t length,
157
free_callback callback, void *hint) {
160
Local<Value> arg = Integer::NewFromUnsigned(0);
161
Local<Object> obj = constructor_template->GetFunction()->NewInstance(1, &arg);
163
Buffer *buffer = ObjectWrap::Unwrap<Buffer>(obj);
164
buffer->Replace(data, length, callback, hint);
170
Handle<Value> Buffer::New(const Arguments &args) {
171
if (!args.IsConstructCall()) {
172
return FromConstructorTemplate(constructor_template, args);
178
if (args[0]->IsInt32()) {
179
// var buffer = new Buffer(1024);
180
size_t length = args[0]->Uint32Value();
181
buffer = new Buffer(args.This(), length);
183
return ThrowException(Exception::TypeError(String::New("Bad argument")));
189
Buffer::Buffer(Handle<Object> wrapper, size_t length) : ObjectWrap() {
195
Replace(NULL, length, NULL, NULL);
200
Replace(NULL, 0, NULL, NULL);
204
void Buffer::Replace(char *data, size_t length,
205
free_callback callback, void *hint) {
209
callback_(data_, callback_hint_);
210
} else if (length_) {
212
V8::AdjustAmountOfExternalAllocatedMemory(-(sizeof(Buffer) + length_));
216
callback_ = callback;
217
callback_hint_ = hint;
221
} else if (length_) {
222
data_ = new char[length_];
224
memcpy(data_, data, length_);
225
V8::AdjustAmountOfExternalAllocatedMemory(sizeof(Buffer) + length_);
230
handle_->SetIndexedPropertiesToExternalArrayData(data_,
231
kExternalUnsignedByteArray,
233
handle_->Set(length_symbol, Integer::NewFromUnsigned(length_));
237
Handle<Value> Buffer::BinarySlice(const Arguments &args) {
239
Buffer *parent = ObjectWrap::Unwrap<Buffer>(args.This());
240
SLICE_ARGS(args[0], args[1])
242
char *data = parent->data_ + start;
243
//Local<String> string = String::New(data, end - start);
245
Local<Value> b = Encode(data, end - start, BINARY);
247
return scope.Close(b);
251
Handle<Value> Buffer::AsciiSlice(const Arguments &args) {
253
Buffer *parent = ObjectWrap::Unwrap<Buffer>(args.This());
254
SLICE_ARGS(args[0], args[1])
256
char* data = parent->data_ + start;
257
Local<String> string = String::New(data, end - start);
259
return scope.Close(string);
263
Handle<Value> Buffer::Utf8Slice(const Arguments &args) {
265
Buffer *parent = ObjectWrap::Unwrap<Buffer>(args.This());
266
SLICE_ARGS(args[0], args[1])
267
char *data = parent->data_ + start;
268
Local<String> string = String::New(data, end - start);
269
return scope.Close(string);
272
Handle<Value> Buffer::Ucs2Slice(const Arguments &args) {
274
Buffer *parent = ObjectWrap::Unwrap<Buffer>(args.This());
275
SLICE_ARGS(args[0], args[1])
276
uint16_t *data = (uint16_t*)(parent->data_ + start);
277
Local<String> string = String::New(data, (end - start) / 2);
278
return scope.Close(string);
281
static const char *base64_table = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
282
"abcdefghijklmnopqrstuvwxyz"
284
static const int unbase64_table[] =
285
{-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-2,-1,-1,-2,-1,-1
286
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
287
,-2,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,62,-1,-1,-1,63
288
,52,53,54,55,56,57,58,59,60,61,-1,-1,-1,-1,-1,-1
289
,-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11,12,13,14
290
,15,16,17,18,19,20,21,22,23,24,25,-1,-1,-1,-1,-1
291
,-1,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40
292
,41,42,43,44,45,46,47,48,49,50,51,-1,-1,-1,-1,-1
293
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
294
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
295
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
296
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
297
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
298
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
299
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
300
,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
302
#define unbase64(x) unbase64_table[(uint8_t)(x)]
305
Handle<Value> Buffer::Base64Slice(const Arguments &args) {
307
Buffer *parent = ObjectWrap::Unwrap<Buffer>(args.This());
308
SLICE_ARGS(args[0], args[1])
311
int out_len = (n + 2 - ((n + 2) % 3)) / 3 * 4;
312
char *out = new char[out_len];
315
int i = start; // data() index
316
int j = 0; // out index
321
bitbuf[0] = parent->data_[i++];
324
bitbuf[1] = parent->data_[i];
333
bitbuf[2] = parent->data_[i];
344
out[j++] = base64_table[(int)c];
347
c = ((bitbuf[0] & 0x03) << 4) | (bitbuf[1] >> 4);
349
out[j++] = base64_table[(int)c];
355
c = ((bitbuf[1] & 0x0F) << 2) | (bitbuf[2] >> 6);
357
out[j++] = base64_table[(int)c];
364
c = bitbuf[2] & 0x3F;
366
out[j++] = base64_table[(int)c];
368
assert(j <= out_len);
371
Local<String> string = String::New(out, out_len);
373
return scope.Close(string);
377
// var bytesCopied = buffer.copy(target, targetStart, sourceStart, sourceEnd);
378
Handle<Value> Buffer::Copy(const Arguments &args) {
381
Buffer *source = ObjectWrap::Unwrap<Buffer>(args.This());
383
if (!Buffer::HasInstance(args[0])) {
384
return ThrowException(Exception::TypeError(String::New(
385
"First arg should be a Buffer")));
388
Local<Object> target = args[0]->ToObject();
389
char *target_data = Buffer::Data(target);
390
ssize_t target_length = Buffer::Length(target);
392
ssize_t target_start = args[1]->Int32Value();
393
ssize_t source_start = args[2]->Int32Value();
394
ssize_t source_end = args[3]->IsInt32() ? args[3]->Int32Value()
397
if (source_end < source_start) {
398
return ThrowException(Exception::Error(String::New(
399
"sourceEnd < sourceStart")));
402
// Copy 0 bytes; we're done
403
if (source_end == source_start) {
404
return scope.Close(Integer::New(0));
407
if (target_start < 0 || target_start >= target_length) {
408
return ThrowException(Exception::Error(String::New(
409
"targetStart out of bounds")));
412
if (source_start < 0 || source_start >= source->length_) {
413
return ThrowException(Exception::Error(String::New(
414
"sourceStart out of bounds")));
417
if (source_end < 0 || source_end > source->length_) {
418
return ThrowException(Exception::Error(String::New(
419
"sourceEnd out of bounds")));
422
ssize_t to_copy = MIN(MIN(source_end - source_start,
423
target_length - target_start),
424
source->length_ - source_start);
427
// need to use slightly slower memmove is the ranges might overlap
428
memmove((void *)(target_data + target_start),
429
(const void*)(source->data_ + source_start),
432
return scope.Close(Integer::New(to_copy));
436
// var charsWritten = buffer.utf8Write(string, offset, [maxLength]);
437
Handle<Value> Buffer::Utf8Write(const Arguments &args) {
439
Buffer *buffer = ObjectWrap::Unwrap<Buffer>(args.This());
441
if (!args[0]->IsString()) {
442
return ThrowException(Exception::TypeError(String::New(
443
"Argument must be a string")));
446
Local<String> s = args[0]->ToString();
448
size_t offset = args[1]->Uint32Value();
450
int length = s->Length();
453
constructor_template->GetFunction()->Set(chars_written_sym,
455
return scope.Close(Integer::New(0));
458
if (length > 0 && offset >= buffer->length_) {
459
return ThrowException(Exception::TypeError(String::New(
460
"Offset is out of bounds")));
463
size_t max_length = args[2]->IsUndefined() ? buffer->length_ - offset
464
: args[2]->Uint32Value();
465
max_length = MIN(buffer->length_ - offset, max_length);
467
char* p = buffer->data_ + offset;
471
int written = s->WriteUtf8(p,
474
String::HINT_MANY_WRITES_EXPECTED);
476
constructor_template->GetFunction()->Set(chars_written_sym,
477
Integer::New(char_written));
479
if (written > 0 && p[written-1] == '\0' && char_written == length) {
481
s->Write(&last_char, length - 1, 1, String::NO_HINTS);
482
if (last_char != 0 || written > s->Utf8Length()) {
487
return scope.Close(Integer::New(written));
491
// var charsWritten = buffer.ucs2Write(string, offset, [maxLength]);
492
Handle<Value> Buffer::Ucs2Write(const Arguments &args) {
494
Buffer *buffer = ObjectWrap::Unwrap<Buffer>(args.This());
496
if (!args[0]->IsString()) {
497
return ThrowException(Exception::TypeError(String::New(
498
"Argument must be a string")));
501
Local<String> s = args[0]->ToString();
503
size_t offset = args[1]->Uint32Value();
505
if (s->Length() > 0 && offset >= buffer->length_) {
506
return ThrowException(Exception::TypeError(String::New(
507
"Offset is out of bounds")));
510
size_t max_length = args[2]->IsUndefined() ? buffer->length_ - offset
511
: args[2]->Uint32Value();
512
max_length = MIN(buffer->length_ - offset, max_length) / 2;
514
uint16_t* p = (uint16_t*)(buffer->data_ + offset);
516
int written = s->Write(p,
519
String::HINT_MANY_WRITES_EXPECTED);
521
constructor_template->GetFunction()->Set(chars_written_sym,
522
Integer::New(written));
524
return scope.Close(Integer::New(written * 2));
528
// var charsWritten = buffer.asciiWrite(string, offset);
529
Handle<Value> Buffer::AsciiWrite(const Arguments &args) {
532
Buffer *buffer = ObjectWrap::Unwrap<Buffer>(args.This());
534
if (!args[0]->IsString()) {
535
return ThrowException(Exception::TypeError(String::New(
536
"Argument must be a string")));
539
Local<String> s = args[0]->ToString();
541
size_t offset = args[1]->Int32Value();
543
if (s->Length() > 0 && offset >= buffer->length_) {
544
return ThrowException(Exception::TypeError(String::New(
545
"Offset is out of bounds")));
548
size_t max_length = args[2]->IsUndefined() ? buffer->length_ - offset
549
: args[2]->Uint32Value();
550
max_length = MIN(s->Length(), MIN(buffer->length_ - offset, max_length));
552
char *p = buffer->data_ + offset;
554
int written = s->WriteAscii(p,
557
String::HINT_MANY_WRITES_EXPECTED);
559
constructor_template->GetFunction()->Set(chars_written_sym,
560
Integer::New(written));
562
return scope.Close(Integer::New(written));
566
// var bytesWritten = buffer.base64Write(string, offset, [maxLength]);
567
Handle<Value> Buffer::Base64Write(const Arguments &args) {
570
assert(unbase64('/') == 63);
571
assert(unbase64('+') == 62);
572
assert(unbase64('T') == 19);
573
assert(unbase64('Z') == 25);
574
assert(unbase64('t') == 45);
575
assert(unbase64('z') == 51);
577
assert(unbase64(' ') == -2);
578
assert(unbase64('\n') == -2);
579
assert(unbase64('\r') == -2);
581
Buffer *buffer = ObjectWrap::Unwrap<Buffer>(args.This());
583
if (!args[0]->IsString()) {
584
return ThrowException(Exception::TypeError(String::New(
585
"Argument must be a string")));
588
String::AsciiValue s(args[0]->ToString());
589
size_t offset = args[1]->Int32Value();
591
// handle zero-length buffers graciously
592
if (offset == 0 && buffer->length_ == 0) {
593
return scope.Close(Integer::New(0));
596
if (offset >= buffer->length_) {
597
return ThrowException(Exception::TypeError(String::New(
598
"Offset is out of bounds")));
601
const size_t size = base64_decoded_size(*s, s.length());
602
if (size > buffer->length_ - offset) {
603
// throw exception, don't silently truncate
604
return ThrowException(Exception::TypeError(String::New(
605
"Buffer too small")));
609
char* start = buffer->data_ + offset;
611
const char *src = *s;
612
const char *const srcEnd = src + s.length();
614
while (src < srcEnd) {
615
int remaining = srcEnd - src;
617
while (unbase64(*src) < 0 && src < srcEnd) {
621
if (remaining == 0 || *src == '=') break;
622
a = unbase64(*src++);
624
while (unbase64(*src) < 0 && src < srcEnd) {
628
if (remaining <= 1 || *src == '=') break;
629
b = unbase64(*src++);
630
*dst++ = (a << 2) | ((b & 0x30) >> 4);
632
while (unbase64(*src) < 0 && src < srcEnd) {
636
if (remaining <= 2 || *src == '=') break;
637
c = unbase64(*src++);
638
*dst++ = ((b & 0x0F) << 4) | ((c & 0x3C) >> 2);
640
while (unbase64(*src) < 0 && src < srcEnd) {
644
if (remaining <= 3 || *src == '=') break;
645
d = unbase64(*src++);
646
*dst++ = ((c & 0x03) << 6) | (d & 0x3F);
649
constructor_template->GetFunction()->Set(chars_written_sym,
650
Integer::New(s.length()));
652
return scope.Close(Integer::New(dst - start));
656
Handle<Value> Buffer::BinaryWrite(const Arguments &args) {
659
Buffer *buffer = ObjectWrap::Unwrap<Buffer>(args.This());
661
if (!args[0]->IsString()) {
662
return ThrowException(Exception::TypeError(String::New(
663
"Argument must be a string")));
666
Local<String> s = args[0]->ToString();
668
size_t offset = args[1]->Int32Value();
670
if (s->Length() > 0 && offset >= buffer->length_) {
671
return ThrowException(Exception::TypeError(String::New(
672
"Offset is out of bounds")));
675
char *p = (char*)buffer->data_ + offset;
677
size_t max_length = args[2]->IsUndefined() ? buffer->length_ - offset
678
: args[2]->Uint32Value();
679
max_length = MIN(s->Length(), MIN(buffer->length_ - offset, max_length));
681
int written = DecodeWrite(p, max_length, s, BINARY);
683
constructor_template->GetFunction()->Set(chars_written_sym,
684
Integer::New(written));
686
return scope.Close(Integer::New(written));
690
// var nbytes = Buffer.byteLength("string", "utf8")
691
Handle<Value> Buffer::ByteLength(const Arguments &args) {
694
if (!args[0]->IsString()) {
695
return ThrowException(Exception::TypeError(String::New(
696
"Argument must be a string")));
699
Local<String> s = args[0]->ToString();
700
enum encoding e = ParseEncoding(args[1], UTF8);
702
return scope.Close(Integer::New(node::ByteLength(s, e)));
706
Handle<Value> Buffer::MakeFastBuffer(const Arguments &args) {
709
if (!Buffer::HasInstance(args[0])) {
710
return ThrowException(Exception::TypeError(String::New(
711
"First argument must be a Buffer")));
714
Buffer *buffer = ObjectWrap::Unwrap<Buffer>(args[0]->ToObject());
715
Local<Object> fast_buffer = args[1]->ToObject();;
716
uint32_t offset = args[2]->Uint32Value();
717
uint32_t length = args[3]->Uint32Value();
719
fast_buffer->SetIndexedPropertiesToExternalArrayData(buffer->data_ + offset,
720
kExternalUnsignedByteArray,
727
bool Buffer::HasInstance(v8::Handle<v8::Value> val) {
728
if (!val->IsObject()) return false;
729
v8::Local<v8::Object> obj = val->ToObject();
731
if (obj->GetIndexedPropertiesExternalArrayDataType() == kExternalUnsignedByteArray)
734
// Also check for SlowBuffers that are empty.
735
if (constructor_template->HasInstance(obj))
742
void Buffer::Initialize(Handle<Object> target) {
745
length_symbol = Persistent<String>::New(String::NewSymbol("length"));
746
chars_written_sym = Persistent<String>::New(String::NewSymbol("_charsWritten"));
748
Local<FunctionTemplate> t = FunctionTemplate::New(Buffer::New);
749
constructor_template = Persistent<FunctionTemplate>::New(t);
750
constructor_template->InstanceTemplate()->SetInternalFieldCount(1);
751
constructor_template->SetClassName(String::NewSymbol("SlowBuffer"));
754
NODE_SET_PROTOTYPE_METHOD(constructor_template, "binarySlice", Buffer::BinarySlice);
755
NODE_SET_PROTOTYPE_METHOD(constructor_template, "asciiSlice", Buffer::AsciiSlice);
756
NODE_SET_PROTOTYPE_METHOD(constructor_template, "base64Slice", Buffer::Base64Slice);
757
NODE_SET_PROTOTYPE_METHOD(constructor_template, "ucs2Slice", Buffer::Ucs2Slice);
758
// TODO NODE_SET_PROTOTYPE_METHOD(t, "utf16Slice", Utf16Slice);
760
NODE_SET_PROTOTYPE_METHOD(constructor_template, "utf8Slice", Buffer::Utf8Slice);
762
NODE_SET_PROTOTYPE_METHOD(constructor_template, "utf8Write", Buffer::Utf8Write);
763
NODE_SET_PROTOTYPE_METHOD(constructor_template, "asciiWrite", Buffer::AsciiWrite);
764
NODE_SET_PROTOTYPE_METHOD(constructor_template, "binaryWrite", Buffer::BinaryWrite);
765
NODE_SET_PROTOTYPE_METHOD(constructor_template, "base64Write", Buffer::Base64Write);
766
NODE_SET_PROTOTYPE_METHOD(constructor_template, "ucs2Write", Buffer::Ucs2Write);
767
NODE_SET_PROTOTYPE_METHOD(constructor_template, "copy", Buffer::Copy);
769
NODE_SET_METHOD(constructor_template->GetFunction(),
772
NODE_SET_METHOD(constructor_template->GetFunction(),
774
Buffer::MakeFastBuffer);
776
target->Set(String::NewSymbol("SlowBuffer"), constructor_template->GetFunction());
782
NODE_MODULE(node_buffer, node::Buffer::Initialize);