GCC Code Coverage Report
Directory: ../ Exec Total Coverage
File: /home/iojs/build/workspace/node-test-commit-linux-coverage-daily/nodes/benchmark/out/../src/spawn_sync.cc Lines: 490 537 91.2 %
Date: 2020-08-22 22:13:06 Branches: 203 310 65.5 %

Line Branch Exec Source
1
// Copyright Joyent, Inc. and other Node contributors.
2
//
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:
10
//
11
// The above copyright notice and this permission notice shall be included
12
// in all copies or substantial portions of the Software.
13
//
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.
21
22
#include "spawn_sync.h"
23
#include "debug_utils-inl.h"
24
#include "env-inl.h"
25
#include "node_internals.h"
26
#include "string_bytes.h"
27
#include "util-inl.h"
28
29
#include <cstring>
30
31
32
namespace node {
33
34
using v8::Array;
35
using v8::Context;
36
using v8::EscapableHandleScope;
37
using v8::FunctionCallbackInfo;
38
using v8::HandleScope;
39
using v8::Int32;
40
using v8::Integer;
41
using v8::Isolate;
42
using v8::Just;
43
using v8::Local;
44
using v8::Maybe;
45
using v8::MaybeLocal;
46
using v8::Nothing;
47
using v8::Null;
48
using v8::Number;
49
using v8::Object;
50
using v8::String;
51
using v8::Value;
52
53
20369
void SyncProcessOutputBuffer::OnAlloc(size_t suggested_size,
54
                                      uv_buf_t* buf) const {
55
20369
  if (used() == kBufferSize)
56
    *buf = uv_buf_init(nullptr, 0);
57
  else
58
20369
    *buf = uv_buf_init(data_ + used(), available());
59
20369
}
60
61
62
19447
void SyncProcessOutputBuffer::OnRead(const uv_buf_t* buf, size_t nread) {
63
  // If we hand out the same chunk twice, this should catch it.
64
19447
  CHECK_EQ(buf->base, data_ + used());
65
19447
  used_ += static_cast<unsigned int>(nread);
66
19447
}
67
68
69
1149
size_t SyncProcessOutputBuffer::Copy(char* dest) const {
70
1149
  memcpy(dest, data_, used());
71
1149
  return used();
72
}
73
74
75
39780
unsigned int SyncProcessOutputBuffer::available() const {
76
39780
  return sizeof data_ - used();
77
}
78
79
80
103412
unsigned int SyncProcessOutputBuffer::used() const {
81
103412
  return used_;
82
}
83
84
85
3447
SyncProcessOutputBuffer* SyncProcessOutputBuffer::next() const {
86
3447
  return next_;
87
}
88
89
90
191
void SyncProcessOutputBuffer::set_next(SyncProcessOutputBuffer* next) {
91
191
  next_ = next;
92
191
}
93
94
95
1889
SyncProcessStdioPipe::SyncProcessStdioPipe(SyncProcessRunner* process_handler,
96
                                           bool readable,
97
                                           bool writable,
98
1889
                                           uv_buf_t input_buffer)
99
    : process_handler_(process_handler),
100
      readable_(readable),
101
      writable_(writable),
102
      input_buffer_(input_buffer),
103
104
      first_output_buffer_(nullptr),
105
      last_output_buffer_(nullptr),
106
107
      uv_pipe_(),
108
      write_req_(),
109
      shutdown_req_(),
110
111
1889
      lifecycle_(kUninitialized) {
112

1889
  CHECK(readable || writable);
113
1889
}
114
115
116
3778
SyncProcessStdioPipe::~SyncProcessStdioPipe() {
117

1889
  CHECK(lifecycle_ == kUninitialized || lifecycle_ == kClosed);
118
119
  SyncProcessOutputBuffer* buf;
120
  SyncProcessOutputBuffer* next;
121
122
3038
  for (buf = first_output_buffer_; buf != nullptr; buf = next) {
123
1149
    next = buf->next();
124
1149
    delete buf;
125
  }
126
1889
}
127
128
129
1889
int SyncProcessStdioPipe::Initialize(uv_loop_t* loop) {
130
1889
  CHECK_EQ(lifecycle_, kUninitialized);
131
132
1889
  int r = uv_pipe_init(loop, uv_pipe(), 0);
133
1889
  if (r < 0)
134
    return r;
135
136
1889
  uv_pipe()->data = this;
137
138
1889
  lifecycle_ = kInitialized;
139
1889
  return 0;
140
}
141
142
143
1454
int SyncProcessStdioPipe::Start() {
144
1454
  CHECK_EQ(lifecycle_, kInitialized);
145
146
  // Set the busy flag already. If this function fails no recovery is
147
  // possible.
148
1454
  lifecycle_ = kStarted;
149
150
1454
  if (readable()) {
151
478
    if (input_buffer_.len > 0) {
152
22
      CHECK_NOT_NULL(input_buffer_.base);
153
154
22
      int r = uv_write(&write_req_,
155
                       uv_stream(),
156
22
                       &input_buffer_,
157
                       1,
158
22
                       WriteCallback);
159
22
      if (r < 0)
160
        return r;
161
    }
162
163
478
    int r = uv_shutdown(&shutdown_req_, uv_stream(), ShutdownCallback);
164
478
    if (r < 0)
165
      return r;
166
  }
167
168
1454
  if (writable()) {
169
976
    int r = uv_read_start(uv_stream(), AllocCallback, ReadCallback);
170
976
    if (r < 0)
171
      return r;
172
  }
173
174
1454
  return 0;
175
}
176
177
178
1889
void SyncProcessStdioPipe::Close() {
179

1889
  CHECK(lifecycle_ == kInitialized || lifecycle_ == kStarted);
180
181
1889
  uv_close(uv_handle(), CloseCallback);
182
183
1889
  lifecycle_ = kClosing;
184
1889
}
185
186
187
976
Local<Object> SyncProcessStdioPipe::GetOutputAsBuffer(Environment* env) const {
188
976
  size_t length = OutputLength();
189
1952
  Local<Object> js_buffer = Buffer::New(env, length).ToLocalChecked();
190
976
  CopyOutput(Buffer::Data(js_buffer));
191
976
  return js_buffer;
192
}
193
194
195
3343
bool SyncProcessStdioPipe::readable() const {
196
3343
  return readable_;
197
}
198
199
200
4797
bool SyncProcessStdioPipe::writable() const {
201
4797
  return writable_;
202
}
203
204
205
1889
uv_stdio_flags SyncProcessStdioPipe::uv_flags() const {
206
  unsigned int flags;
207
208
1889
  flags = UV_CREATE_PIPE;
209
1889
  if (readable())
210
623
    flags |= UV_READABLE_PIPE;
211
1889
  if (writable())
212
1266
    flags |= UV_WRITABLE_PIPE;
213
214
1889
  return static_cast<uv_stdio_flags>(flags);
215
}
216
217
218
9032
uv_pipe_t* SyncProcessStdioPipe::uv_pipe() const {
219
9032
  CHECK_LT(lifecycle_, kClosing);
220
9032
  return &uv_pipe_;
221
}
222
223
224
3365
uv_stream_t* SyncProcessStdioPipe::uv_stream() const {
225
3365
  return reinterpret_cast<uv_stream_t*>(uv_pipe());
226
}
227
228
229
1889
uv_handle_t* SyncProcessStdioPipe::uv_handle() const {
230
1889
  return reinterpret_cast<uv_handle_t*>(uv_pipe());
231
}
232
233
234
976
size_t SyncProcessStdioPipe::OutputLength() const {
235
  SyncProcessOutputBuffer* buf;
236
976
  size_t size = 0;
237
238
2125
  for (buf = first_output_buffer_; buf != nullptr; buf = buf->next())
239
1149
    size += buf->used();
240
241
976
  return size;
242
}
243
244
245
976
void SyncProcessStdioPipe::CopyOutput(char* dest) const {
246
  SyncProcessOutputBuffer* buf;
247
976
  size_t offset = 0;
248
249
2125
  for (buf = first_output_buffer_; buf != nullptr; buf = buf->next())
250
1149
    offset += buf->Copy(dest + offset);
251
976
}
252
253
254
20369
void SyncProcessStdioPipe::OnAlloc(size_t suggested_size, uv_buf_t* buf) {
255
  // This function assumes that libuv will never allocate two buffers for the
256
  // same stream at the same time. There's an assert in
257
  // SyncProcessOutputBuffer::OnRead that would fail if this assumption was
258
  // ever violated.
259
260
20369
  if (last_output_buffer_ == nullptr) {
261
    // Allocate the first capture buffer.
262
958
    first_output_buffer_ = new SyncProcessOutputBuffer();
263
958
    last_output_buffer_ = first_output_buffer_;
264
265
19411
  } else if (last_output_buffer_->available() == 0) {
266
    // The current capture buffer is full so get us a new one.
267
191
    SyncProcessOutputBuffer* buf = new SyncProcessOutputBuffer();
268
191
    last_output_buffer_->set_next(buf);
269
191
    last_output_buffer_ = buf;
270
  }
271
272
20369
  last_output_buffer_->OnAlloc(suggested_size, buf);
273
20369
}
274
275
276
20397
void SyncProcessStdioPipe::OnRead(const uv_buf_t* buf, ssize_t nread) {
277
20397
  if (nread == UV_EOF) {
278
    // Libuv implicitly stops reading on EOF.
279
280
19447
  } else if (nread < 0) {
281
    SetError(static_cast<int>(nread));
282
    // At some point libuv should really implicitly stop reading on error.
283
    uv_read_stop(uv_stream());
284
285
  } else {
286
19447
    last_output_buffer_->OnRead(buf, nread);
287
19447
    process_handler_->IncrementBufferSizeAndCheckOverflow(nread);
288
  }
289
20397
}
290
291
292
22
void SyncProcessStdioPipe::OnWriteDone(int result) {
293
22
  if (result < 0)
294
    SetError(result);
295
22
}
296
297
298
478
void SyncProcessStdioPipe::OnShutdownDone(int result) {
299
478
  if (result < 0)
300
    SetError(result);
301
478
}
302
303
304
1889
void SyncProcessStdioPipe::OnClose() {
305
1889
  lifecycle_ = kClosed;
306
1889
}
307
308
309
void SyncProcessStdioPipe::SetError(int error) {
310
  CHECK_NE(error, 0);
311
  process_handler_->SetPipeError(error);
312
}
313
314
315
20369
void SyncProcessStdioPipe::AllocCallback(uv_handle_t* handle,
316
                                         size_t suggested_size,
317
                                         uv_buf_t* buf) {
318
  SyncProcessStdioPipe* self =
319
20369
      reinterpret_cast<SyncProcessStdioPipe*>(handle->data);
320
20369
  self->OnAlloc(suggested_size, buf);
321
20369
}
322
323
324
20397
void SyncProcessStdioPipe::ReadCallback(uv_stream_t* stream,
325
                                        ssize_t nread,
326
                                        const uv_buf_t* buf) {
327
  SyncProcessStdioPipe* self =
328
20397
        reinterpret_cast<SyncProcessStdioPipe*>(stream->data);
329
20397
  self->OnRead(buf, nread);
330
20397
}
331
332
333
22
void SyncProcessStdioPipe::WriteCallback(uv_write_t* req, int result) {
334
  SyncProcessStdioPipe* self =
335
22
      reinterpret_cast<SyncProcessStdioPipe*>(req->handle->data);
336
22
  self->OnWriteDone(result);
337
22
}
338
339
340
478
void SyncProcessStdioPipe::ShutdownCallback(uv_shutdown_t* req, int result) {
341
  SyncProcessStdioPipe* self =
342
478
      reinterpret_cast<SyncProcessStdioPipe*>(req->handle->data);
343
344
  // On AIX, OS X and the BSDs, calling shutdown() on one end of a pipe
345
  // when the other end has closed the connection fails with ENOTCONN.
346
  // Libuv is not the right place to handle that because it can't tell
347
  // if the error is genuine but we here can.
348
478
  if (result == UV_ENOTCONN)
349
    result = 0;
350
351
478
  self->OnShutdownDone(result);
352
478
}
353
354
355
1889
void SyncProcessStdioPipe::CloseCallback(uv_handle_t* handle) {
356
  SyncProcessStdioPipe* self =
357
1889
      reinterpret_cast<SyncProcessStdioPipe*>(handle->data);
358
1889
  self->OnClose();
359
1889
}
360
361
362
3921
void SyncProcessRunner::Initialize(Local<Object> target,
363
                                   Local<Value> unused,
364
                                   Local<Context> context,
365
                                   void* priv) {
366
3921
  Environment* env = Environment::GetCurrent(context);
367
3921
  env->SetMethod(target, "spawn", Spawn);
368
3921
}
369
370
371
657
void SyncProcessRunner::Spawn(const FunctionCallbackInfo<Value>& args) {
372
657
  Environment* env = Environment::GetCurrent(args);
373
657
  env->PrintSyncTrace();
374
1314
  SyncProcessRunner p(env);
375
  Local<Value> result;
376
1314
  if (!p.Run(args[0]).ToLocal(&result)) return;
377
1314
  args.GetReturnValue().Set(result);
378
}
379
380
381
657
SyncProcessRunner::SyncProcessRunner(Environment* env)
382
    : max_buffer_(0),
383
      timeout_(0),
384
      kill_signal_(SIGTERM),
385
386
      uv_loop_(nullptr),
387
388
      stdio_count_(0),
389
      uv_stdio_containers_(nullptr),
390
      stdio_pipes_initialized_(false),
391
392
      uv_process_options_(),
393
      file_buffer_(nullptr),
394
      args_buffer_(nullptr),
395
      env_buffer_(nullptr),
396
      cwd_buffer_(nullptr),
397
398
      uv_process_(),
399
      killed_(false),
400
401
      buffered_output_size_(0),
402
      exit_status_(-1),
403
      term_signal_(-1),
404
405
      uv_timer_(),
406
      kill_timer_initialized_(false),
407
408
      error_(0),
409
      pipe_error_(0),
410
411
      lifecycle_(kUninitialized),
412
413
657
      env_(env) {
414
657
}
415
416
417
1314
SyncProcessRunner::~SyncProcessRunner() {
418
657
  CHECK_EQ(lifecycle_, kHandlesClosed);
419
420
657
  stdio_pipes_.clear();
421
657
  delete[] file_buffer_;
422
657
  delete[] args_buffer_;
423
657
  delete[] cwd_buffer_;
424
657
  delete[] env_buffer_;
425
657
  delete[] uv_stdio_containers_;
426
657
}
427
428
429
39214
Environment* SyncProcessRunner::env() const {
430
39214
  return env_;
431
}
432
433
657
MaybeLocal<Object> SyncProcessRunner::Run(Local<Value> options) {
434
657
  EscapableHandleScope scope(env()->isolate());
435
436
657
  CHECK_EQ(lifecycle_, kUninitialized);
437
438
657
  Maybe<bool> r = TryInitializeAndRunLoop(options);
439
657
  CloseHandlesAndDeleteLoop();
440
657
  if (r.IsNothing()) return MaybeLocal<Object>();
441
442
657
  Local<Object> result = BuildResultObject();
443
444
657
  return scope.Escape(result);
445
}
446
447
657
Maybe<bool> SyncProcessRunner::TryInitializeAndRunLoop(Local<Value> options) {
448
  int r;
449
450
  // There is no recovery from failure inside TryInitializeAndRunLoop - the
451
  // only option we'd have is to close all handles and destroy the loop.
452
657
  CHECK_EQ(lifecycle_, kUninitialized);
453
657
  lifecycle_ = kInitialized;
454
455
657
  uv_loop_ = new uv_loop_t;
456
657
  if (uv_loop_ == nullptr) {
457
    SetError(UV_ENOMEM);
458
    return Just(false);
459
  }
460
657
  CHECK_EQ(uv_loop_init(uv_loop_), 0);
461
462
1314
  if (!ParseOptions(options).To(&r)) return Nothing<bool>();
463
657
  if (r < 0) {
464
    SetError(r);
465
    return Just(false);
466
  }
467
468
657
  if (timeout_ > 0) {
469
7
    r = uv_timer_init(uv_loop_, &uv_timer_);
470
7
    if (r < 0) {
471
      SetError(r);
472
      return Just(false);
473
    }
474
475
7
    uv_unref(reinterpret_cast<uv_handle_t*>(&uv_timer_));
476
477
7
    uv_timer_.data = this;
478
7
    kill_timer_initialized_ = true;
479
480
    // Start the timer immediately. If uv_spawn fails then
481
    // CloseHandlesAndDeleteLoop() will immediately close the timer handle
482
    // which implicitly stops it, so there is no risk that the timeout callback
483
    // runs when the process didn't start.
484
7
    r = uv_timer_start(&uv_timer_, KillTimerCallback, timeout_, 0);
485
7
    if (r < 0) {
486
      SetError(r);
487
      return Just(false);
488
    }
489
  }
490
491
657
  uv_process_options_.exit_cb = ExitCallback;
492
657
  r = uv_spawn(uv_loop_, &uv_process_, &uv_process_options_);
493
657
  if (r < 0) {
494
145
    SetError(r);
495
145
    return Just(false);
496
  }
497
512
  uv_process_.data = this;
498
499
2048
  for (const auto& pipe : stdio_pipes_) {
500
1536
    if (pipe != nullptr) {
501
1454
      r = pipe->Start();
502
1454
      if (r < 0) {
503
        SetPipeError(r);
504
        return Just(false);
505
      }
506
    }
507
  }
508
509
512
  r = uv_run(uv_loop_, UV_RUN_DEFAULT);
510
512
  if (r < 0)
511
    // We can't handle uv_run failure.
512
    ABORT();
513
514
  // If we get here the process should have exited.
515
512
  CHECK_GE(exit_status_, 0);
516
512
  return Just(true);
517
}
518
519
520
657
void SyncProcessRunner::CloseHandlesAndDeleteLoop() {
521
657
  CHECK_LT(lifecycle_, kHandlesClosed);
522
523
657
  if (uv_loop_ != nullptr) {
524
657
    CloseStdioPipes();
525
657
    CloseKillTimer();
526
    // Close the process handle when ExitCallback was not called.
527
    uv_handle_t* uv_process_handle =
528
657
        reinterpret_cast<uv_handle_t*>(&uv_process_);
529
530
    // Close the process handle if it is still open. The handle type also
531
    // needs to be checked because TryInitializeAndRunLoop() won't spawn a
532
    // process if input validation fails.
533

1314
    if (uv_process_handle->type == UV_PROCESS &&
534
657
        !uv_is_closing(uv_process_handle))
535
145
      uv_close(uv_process_handle, nullptr);
536
537
    // Give closing watchers a chance to finish closing and get their close
538
    // callbacks called.
539
657
    int r = uv_run(uv_loop_, UV_RUN_DEFAULT);
540
657
    if (r < 0)
541
      ABORT();
542
543
657
    CheckedUvLoopClose(uv_loop_);
544
657
    delete uv_loop_;
545
657
    uv_loop_ = nullptr;
546
547
  } else {
548
    // If the loop doesn't exist, neither should any pipes or timers.
549
    CHECK_EQ(false, stdio_pipes_initialized_);
550
    CHECK_EQ(false, kill_timer_initialized_);
551
  }
552
553
657
  lifecycle_ = kHandlesClosed;
554
657
}
555
556
557
670
void SyncProcessRunner::CloseStdioPipes() {
558
670
  CHECK_LT(lifecycle_, kHandlesClosed);
559
560
670
  if (stdio_pipes_initialized_) {
561
657
    CHECK(!stdio_pipes_.empty());
562
657
    CHECK_NOT_NULL(uv_loop_);
563
564
2628
    for (const auto& pipe : stdio_pipes_) {
565
1971
      if (pipe)
566
1889
        pipe->Close();
567
    }
568
569
657
    stdio_pipes_initialized_ = false;
570
  }
571
670
}
572
573
574
670
void SyncProcessRunner::CloseKillTimer() {
575
670
  CHECK_LT(lifecycle_, kHandlesClosed);
576
577
670
  if (kill_timer_initialized_) {
578
7
    CHECK_GT(timeout_, 0);
579
7
    CHECK_NOT_NULL(uv_loop_);
580
581
7
    uv_handle_t* uv_timer_handle = reinterpret_cast<uv_handle_t*>(&uv_timer_);
582
7
    uv_ref(uv_timer_handle);
583
7
    uv_close(uv_timer_handle, KillTimerCloseCallback);
584
585
7
    kill_timer_initialized_ = false;
586
  }
587
670
}
588
589
590
13
void SyncProcessRunner::Kill() {
591
  // Only attempt to kill once.
592
13
  if (killed_)
593
    return;
594
13
  killed_ = true;
595
596
  // We might get here even if the process we spawned has already exited. This
597
  // could happen when our child process spawned another process which
598
  // inherited (one of) the stdio pipes. In this case we won't attempt to send
599
  // a signal to the process, however we will still close our end of the stdio
600
  // pipes so this situation won't make us hang.
601
13
  if (exit_status_ < 0) {
602
13
    int r = uv_process_kill(&uv_process_, kill_signal_);
603
604
    // If uv_kill failed with an error that isn't ESRCH, the user probably
605
    // specified an invalid or unsupported signal. Signal this to the user as
606
    // and error and kill the process with SIGKILL instead.
607

13
    if (r < 0 && r != UV_ESRCH) {
608
      SetError(r);
609
610
      // Deliberately ignore the return value, we might not have
611
      // sufficient privileges to signal the child process.
612
      USE(uv_process_kill(&uv_process_, SIGKILL));
613
    }
614
  }
615
616
  // Close all stdio pipes.
617
13
  CloseStdioPipes();
618
619
  // Stop the timeout timer immediately.
620
13
  CloseKillTimer();
621
}
622
623
624
19447
void SyncProcessRunner::IncrementBufferSizeAndCheckOverflow(ssize_t length) {
625
19447
  buffered_output_size_ += length;
626
627

19447
  if (max_buffer_ > 0 && buffered_output_size_ > max_buffer_) {
628
8
    SetError(UV_ENOBUFS);
629
8
    Kill();
630
  }
631
19447
}
632
633
634
512
void SyncProcessRunner::OnExit(int64_t exit_status, int term_signal) {
635
512
  if (exit_status < 0)
636
    return SetError(static_cast<int>(exit_status));
637
638
512
  exit_status_ = exit_status;
639
512
  term_signal_ = term_signal;
640
}
641
642
643
5
void SyncProcessRunner::OnKillTimerTimeout() {
644
5
  SetError(UV_ETIMEDOUT);
645
5
  Kill();
646
5
}
647
648
649
815
int SyncProcessRunner::GetError() {
650
815
  if (error_ != 0)
651
316
    return error_;
652
  else
653
499
    return pipe_error_;
654
}
655
656
657
158
void SyncProcessRunner::SetError(int error) {
658
158
  if (error_ == 0)
659
158
    error_ = error;
660
158
}
661
662
663
void SyncProcessRunner::SetPipeError(int pipe_error) {
664
  if (pipe_error_ == 0)
665
    pipe_error_ = pipe_error;
666
}
667
668
669
657
Local<Object> SyncProcessRunner::BuildResultObject() {
670
657
  EscapableHandleScope scope(env()->isolate());
671
657
  Local<Context> context = env()->context();
672
673
657
  Local<Object> js_result = Object::New(env()->isolate());
674
675
657
  if (GetError() != 0) {
676
316
    js_result->Set(context, env()->error_string(),
677
632
                   Integer::New(env()->isolate(), GetError())).Check();
678
  }
679
680
657
  if (exit_status_ >= 0) {
681
512
    if (term_signal_ > 0) {
682
60
      js_result->Set(context, env()->status_string(),
683
120
                     Null(env()->isolate())).Check();
684
    } else {
685
964
      js_result->Set(context, env()->status_string(),
686
                     Number::New(env()->isolate(),
687
1928
                                 static_cast<double>(exit_status_))).Check();
688
    }
689
  } else {
690
    // If exit_status_ < 0 the process was never started because of some error.
691
290
    js_result->Set(context, env()->status_string(),
692
580
                   Null(env()->isolate())).Check();
693
  }
694
695
657
  if (term_signal_ > 0)
696
60
    js_result->Set(context, env()->signal_string(),
697
60
                   String::NewFromUtf8(env()->isolate(),
698
30
                                       signo_string(term_signal_))
699
90
                       .ToLocalChecked())
700
        .Check();
701
  else
702
1254
    js_result->Set(context, env()->signal_string(),
703
2508
                   Null(env()->isolate())).Check();
704
705
657
  if (exit_status_ >= 0)
706
1024
    js_result->Set(context, env()->output_string(),
707
2048
                   BuildOutputArray()).Check();
708
  else
709
290
    js_result->Set(context, env()->output_string(),
710
580
                   Null(env()->isolate())).Check();
711
712
1314
  js_result->Set(context, env()->pid_string(),
713
2628
                 Number::New(env()->isolate(), uv_process_.pid)).Check();
714
715
657
  return scope.Escape(js_result);
716
}
717
718
719
512
Local<Array> SyncProcessRunner::BuildOutputArray() {
720
512
  CHECK_GE(lifecycle_, kInitialized);
721
512
  CHECK(!stdio_pipes_.empty());
722
723
512
  EscapableHandleScope scope(env()->isolate());
724
1024
  MaybeStackBuffer<Local<Value>, 8> js_output(stdio_pipes_.size());
725
726
2048
  for (uint32_t i = 0; i < stdio_pipes_.size(); i++) {
727
1536
    SyncProcessStdioPipe* h = stdio_pipes_[i].get();
728

1536
    if (h != nullptr && h->writable())
729
1952
      js_output[i] = h->GetOutputAsBuffer(env());
730
    else
731
1120
      js_output[i] = Null(env()->isolate());
732
  }
733
734
  return scope.Escape(
735
1024
      Array::New(env()->isolate(), js_output.out(), js_output.length()));
736
}
737
738
657
Maybe<int> SyncProcessRunner::ParseOptions(Local<Value> js_value) {
739
657
  Isolate* isolate = env()->isolate();
740
1314
  HandleScope scope(isolate);
741
  int r;
742
743
657
  if (!js_value->IsObject()) return Just<int>(UV_EINVAL);
744
745
657
  Local<Context> context = env()->context();
746
657
  Local<Object> js_options = js_value.As<Object>();
747
748
  Local<Value> js_file =
749
1971
      js_options->Get(context, env()->file_string()).ToLocalChecked();
750
1314
  if (!CopyJsString(js_file, &file_buffer_).To(&r)) return Nothing<int>();
751
657
  if (r < 0) return Just(r);
752
657
  uv_process_options_.file = file_buffer_;
753
754
  Local<Value> js_args =
755
1971
      js_options->Get(context, env()->args_string()).ToLocalChecked();
756
1314
  if (!CopyJsStringArray(js_args, &args_buffer_).To(&r)) return Nothing<int>();
757
657
  if (r < 0) return Just(r);
758
657
  uv_process_options_.args = reinterpret_cast<char**>(args_buffer_);
759
760
  Local<Value> js_cwd =
761
1971
      js_options->Get(context, env()->cwd_string()).ToLocalChecked();
762
657
  if (IsSet(js_cwd)) {
763
200
    if (!CopyJsString(js_cwd, &cwd_buffer_).To(&r)) return Nothing<int>();
764
100
    if (r < 0) return Just(r);
765
100
    uv_process_options_.cwd = cwd_buffer_;
766
  }
767
768
  Local<Value> js_env_pairs =
769
1971
      js_options->Get(context, env()->env_pairs_string()).ToLocalChecked();
770
657
  if (IsSet(js_env_pairs)) {
771
1314
    if (!CopyJsStringArray(js_env_pairs, &env_buffer_).To(&r))
772
      return Nothing<int>();
773
657
    if (r < 0) return Just(r);
774
775
657
    uv_process_options_.env = reinterpret_cast<char**>(env_buffer_);
776
  }
777
  Local<Value> js_uid =
778
1971
      js_options->Get(context, env()->uid_string()).ToLocalChecked();
779
657
  if (IsSet(js_uid)) {
780
1
    CHECK(js_uid->IsInt32());
781
2
    const int32_t uid = js_uid.As<Int32>()->Value();
782
1
    uv_process_options_.uid = static_cast<uv_uid_t>(uid);
783
1
    uv_process_options_.flags |= UV_PROCESS_SETUID;
784
  }
785
786
  Local<Value> js_gid =
787
1971
      js_options->Get(context, env()->gid_string()).ToLocalChecked();
788
657
  if (IsSet(js_gid)) {
789
1
    CHECK(js_gid->IsInt32());
790
2
    const int32_t gid = js_gid.As<Int32>()->Value();
791
1
    uv_process_options_.gid = static_cast<uv_gid_t>(gid);
792
1
    uv_process_options_.flags |= UV_PROCESS_SETGID;
793
  }
794
795
  Local<Value> js_detached =
796
1971
      js_options->Get(context, env()->detached_string()).ToLocalChecked();
797
657
  if (js_detached->BooleanValue(isolate))
798
1
    uv_process_options_.flags |= UV_PROCESS_DETACHED;
799
800
  Local<Value> js_win_hide =
801
1971
      js_options->Get(context, env()->windows_hide_string()).ToLocalChecked();
802
657
  if (js_win_hide->BooleanValue(isolate))
803
2
    uv_process_options_.flags |= UV_PROCESS_WINDOWS_HIDE;
804
805
  Local<Value> js_wva =
806
1971
      js_options->Get(context, env()->windows_verbatim_arguments_string())
807
657
          .ToLocalChecked();
808
809
657
  if (js_wva->BooleanValue(isolate))
810
1
    uv_process_options_.flags |= UV_PROCESS_WINDOWS_VERBATIM_ARGUMENTS;
811
812
  Local<Value> js_timeout =
813
1971
      js_options->Get(context, env()->timeout_string()).ToLocalChecked();
814
657
  if (IsSet(js_timeout)) {
815
8
    CHECK(js_timeout->IsNumber());
816
16
    int64_t timeout = js_timeout->IntegerValue(context).FromJust();
817
8
    timeout_ = static_cast<uint64_t>(timeout);
818
  }
819
820
  Local<Value> js_max_buffer =
821
1971
      js_options->Get(context, env()->max_buffer_string()).ToLocalChecked();
822
657
  if (IsSet(js_max_buffer)) {
823
655
    CHECK(js_max_buffer->IsNumber());
824
1310
    max_buffer_ = js_max_buffer->NumberValue(context).FromJust();
825
  }
826
827
  Local<Value> js_kill_signal =
828
1971
      js_options->Get(context, env()->kill_signal_string()).ToLocalChecked();
829
657
  if (IsSet(js_kill_signal)) {
830
105
    CHECK(js_kill_signal->IsInt32());
831
210
    kill_signal_ = js_kill_signal.As<Int32>()->Value();
832
  }
833
834
  Local<Value> js_stdio =
835
1971
      js_options->Get(context, env()->stdio_string()).ToLocalChecked();
836
657
  r = ParseStdioOptions(js_stdio);
837
657
  if (r < 0) return Just(r);
838
839
657
  return Just(0);
840
}
841
842
843
657
int SyncProcessRunner::ParseStdioOptions(Local<Value> js_value) {
844
1314
  HandleScope scope(env()->isolate());
845
  Local<Array> js_stdio_options;
846
847
657
  if (!js_value->IsArray())
848
    return UV_EINVAL;
849
850
657
  Local<Context> context = env()->context();
851
657
  js_stdio_options = js_value.As<Array>();
852
853
657
  stdio_count_ = js_stdio_options->Length();
854
657
  uv_stdio_containers_ = new uv_stdio_container_t[stdio_count_];
855
856
657
  stdio_pipes_.clear();
857
657
  stdio_pipes_.resize(stdio_count_);
858
657
  stdio_pipes_initialized_ = true;
859
860
2628
  for (uint32_t i = 0; i < stdio_count_; i++) {
861
    Local<Value> js_stdio_option =
862
3942
        js_stdio_options->Get(context, i).ToLocalChecked();
863
864
1971
    if (!js_stdio_option->IsObject())
865
      return UV_EINVAL;
866
867
1971
    int r = ParseStdioOption(i, js_stdio_option.As<Object>());
868
1971
    if (r < 0)
869
      return r;
870
  }
871
872
657
  uv_process_options_.stdio = uv_stdio_containers_;
873
657
  uv_process_options_.stdio_count = stdio_count_;
874
875
657
  return 0;
876
}
877
878
879
1971
int SyncProcessRunner::ParseStdioOption(int child_fd,
880
                                        Local<Object> js_stdio_option) {
881
1971
  Local<Context> context = env()->context();
882
  Local<Value> js_type =
883
5913
      js_stdio_option->Get(context, env()->type_string()).ToLocalChecked();
884
885
3942
  if (js_type->StrictEquals(env()->ignore_string())) {
886
3
    return AddStdioIgnore(child_fd);
887
888
3936
  } else if (js_type->StrictEquals(env()->pipe_string())) {
889
1889
    Isolate* isolate = env()->isolate();
890
1889
    Local<String> rs = env()->readable_string();
891
1889
    Local<String> ws = env()->writable_string();
892
893
3778
    bool readable = js_stdio_option->Get(context, rs)
894
3778
        .ToLocalChecked()->BooleanValue(isolate);
895
    bool writable =
896
3778
        js_stdio_option->Get(context, ws)
897
3778
        .ToLocalChecked()->BooleanValue(isolate);
898
899
1889
    uv_buf_t buf = uv_buf_init(nullptr, 0);
900
901
1889
    if (readable) {
902
      Local<Value> input =
903
1869
          js_stdio_option->Get(context, env()->input_string()).ToLocalChecked();
904
623
      if (Buffer::HasInstance(input)) {
905
        buf = uv_buf_init(Buffer::Data(input),
906
22
                          static_cast<unsigned int>(Buffer::Length(input)));
907

1202
      } else if (!input->IsUndefined() && !input->IsNull()) {
908
        // Strings, numbers etc. are currently unsupported. It's not possible
909
        // to create a buffer for them here because there is no way to free
910
        // them afterwards.
911
        return UV_EINVAL;
912
      }
913
    }
914
915
1889
    return AddStdioPipe(child_fd, readable, writable, buf);
916
917

273
  } else if (js_type->StrictEquals(env()->inherit_string()) ||
918
151
             js_type->StrictEquals(env()->fd_string())) {
919
237
    int inherit_fd = js_stdio_option->Get(context, env()->fd_string())
920
237
        .ToLocalChecked()->Int32Value(context).FromJust();
921
79
    return AddStdioInheritFD(child_fd, inherit_fd);
922
923
  } else {
924
    CHECK(0 && "invalid child stdio type");
925
    return UV_EINVAL;
926
  }
927
}
928
929
930
3
int SyncProcessRunner::AddStdioIgnore(uint32_t child_fd) {
931
3
  CHECK_LT(child_fd, stdio_count_);
932
3
  CHECK(!stdio_pipes_[child_fd]);
933
934
3
  uv_stdio_containers_[child_fd].flags = UV_IGNORE;
935
936
3
  return 0;
937
}
938
939
940
1889
int SyncProcessRunner::AddStdioPipe(uint32_t child_fd,
941
                                    bool readable,
942
                                    bool writable,
943
                                    uv_buf_t input_buffer) {
944
1889
  CHECK_LT(child_fd, stdio_count_);
945
1889
  CHECK(!stdio_pipes_[child_fd]);
946
947
  std::unique_ptr<SyncProcessStdioPipe> h(
948
3778
      new SyncProcessStdioPipe(this, readable, writable, input_buffer));
949
950
1889
  int r = h->Initialize(uv_loop_);
951
1889
  if (r < 0) {
952
    h.reset();
953
    return r;
954
  }
955
956
1889
  uv_stdio_containers_[child_fd].flags = h->uv_flags();
957
1889
  uv_stdio_containers_[child_fd].data.stream = h->uv_stream();
958
959
1889
  stdio_pipes_[child_fd] = std::move(h);
960
961
1889
  return 0;
962
}
963
964
965
79
int SyncProcessRunner::AddStdioInheritFD(uint32_t child_fd, int inherit_fd) {
966
79
  CHECK_LT(child_fd, stdio_count_);
967
79
  CHECK(!stdio_pipes_[child_fd]);
968
969
79
  uv_stdio_containers_[child_fd].flags = UV_INHERIT_FD;
970
79
  uv_stdio_containers_[child_fd].data.fd = inherit_fd;
971
972
79
  return 0;
973
}
974
975
976
4599
bool SyncProcessRunner::IsSet(Local<Value> value) {
977

12262
  return !value->IsUndefined() && !value->IsNull();
978
}
979
980
757
Maybe<int> SyncProcessRunner::CopyJsString(Local<Value> js_value,
981
                                           const char** target) {
982
757
  Isolate* isolate = env()->isolate();
983
  Local<String> js_string;
984
  size_t size, written;
985
  char* buffer;
986
987
1514
  if (js_value->IsString())
988
757
    js_string = js_value.As<String>();
989
  else if (!js_value->ToString(env()->isolate()->GetCurrentContext())
990
                .ToLocal(&js_string))
991
    return Nothing<int>();
992
993
  // Include space for null terminator byte.
994
1514
  if (!StringBytes::StorageSize(isolate, js_string, UTF8).To(&size))
995
    return Nothing<int>();
996
757
  size += 1;
997
998
757
  buffer = new char[size];
999
1000
757
  written = StringBytes::Write(isolate, buffer, -1, js_string, UTF8);
1001
757
  buffer[written] = '\0';
1002
1003
757
  *target = buffer;
1004
757
  return Just(0);
1005
}
1006
1007
1314
Maybe<int> SyncProcessRunner::CopyJsStringArray(Local<Value> js_value,
1008
                                                char** target) {
1009
1314
  Isolate* isolate = env()->isolate();
1010
  Local<Array> js_array;
1011
  uint32_t length;
1012
  size_t list_size, data_size, data_offset;
1013
  char** list;
1014
  char* buffer;
1015
1016
1314
  if (!js_value->IsArray()) return Just<int>(UV_EINVAL);
1017
1018
1314
  Local<Context> context = env()->context();
1019
3942
  js_array = js_value.As<Array>()->Clone().As<Array>();
1020
1314
  length = js_array->Length();
1021
1314
  data_size = 0;
1022
1023
  // Index has a pointer to every string element, plus one more for a final
1024
  // null pointer.
1025
1314
  list_size = (length + 1) * sizeof *list;
1026
1027
  // Convert all array elements to string. Modify the js object itself if
1028
  // needed - it's okay since we cloned the original object. Also compute the
1029
  // length of all strings, including room for a null terminator after every
1030
  // string. Align strings to cache lines.
1031
49992
  for (uint32_t i = 0; i < length; i++) {
1032
97356
    auto value = js_array->Get(context, i).ToLocalChecked();
1033
1034
97356
    if (!value->IsString()) {
1035
      Local<String> string;
1036
141
      if (!value->ToString(env()->isolate()->GetCurrentContext())
1037
47
               .ToLocal(&string))
1038
        return Nothing<int>();
1039
      js_array
1040
94
          ->Set(context,
1041
                i,
1042
47
                string)
1043
          .Check();
1044
    }
1045
1046
48678
    Maybe<size_t> maybe_size = StringBytes::StorageSize(isolate, value, UTF8);
1047
48678
    if (maybe_size.IsNothing()) return Nothing<int>();
1048
48678
    data_size += maybe_size.FromJust() + 1;
1049
48678
    data_size = RoundUp(data_size, sizeof(void*));
1050
  }
1051
1052
1314
  buffer = new char[list_size + data_size];
1053
1054
1314
  list = reinterpret_cast<char**>(buffer);
1055
1314
  data_offset = list_size;
1056
1057
49992
  for (uint32_t i = 0; i < length; i++) {
1058
48678
    list[i] = buffer + data_offset;
1059
97356
    auto value = js_array->Get(context, i).ToLocalChecked();
1060
48678
    data_offset += StringBytes::Write(isolate,
1061
                                      buffer + data_offset,
1062
                                      -1,
1063
                                      value,
1064
                                      UTF8);
1065
48678
    buffer[data_offset++] = '\0';
1066
48678
    data_offset = RoundUp(data_offset, sizeof(void*));
1067
  }
1068
1069
1314
  list[length] = nullptr;
1070
1071
1314
  *target = buffer;
1072
1314
  return Just(0);
1073
}
1074
1075
1076
512
void SyncProcessRunner::ExitCallback(uv_process_t* handle,
1077
                                     int64_t exit_status,
1078
                                     int term_signal) {
1079
512
  SyncProcessRunner* self = reinterpret_cast<SyncProcessRunner*>(handle->data);
1080
512
  uv_close(reinterpret_cast<uv_handle_t*>(handle), nullptr);
1081
512
  self->OnExit(exit_status, term_signal);
1082
512
}
1083
1084
1085
5
void SyncProcessRunner::KillTimerCallback(uv_timer_t* handle) {
1086
5
  SyncProcessRunner* self = reinterpret_cast<SyncProcessRunner*>(handle->data);
1087
5
  self->OnKillTimerTimeout();
1088
5
}
1089
1090
1091
7
void SyncProcessRunner::KillTimerCloseCallback(uv_handle_t* handle) {
1092
  // No-op.
1093
7
}
1094
1095
}  // namespace node
1096
1097

17859
NODE_MODULE_CONTEXT_AWARE_INTERNAL(spawn_sync,
1098
  node::SyncProcessRunner::Initialize)