• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
OnAlloc(size_t suggested_size,uv_buf_t * buf) const53 void SyncProcessOutputBuffer::OnAlloc(size_t suggested_size,
54                                       uv_buf_t* buf) const {
55   if (used() == kBufferSize)
56     *buf = uv_buf_init(nullptr, 0);
57   else
58     *buf = uv_buf_init(data_ + used(), available());
59 }
60 
61 
OnRead(const uv_buf_t * buf,size_t nread)62 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   CHECK_EQ(buf->base, data_ + used());
65   used_ += static_cast<unsigned int>(nread);
66 }
67 
68 
Copy(char * dest) const69 size_t SyncProcessOutputBuffer::Copy(char* dest) const {
70   memcpy(dest, data_, used());
71   return used();
72 }
73 
74 
available() const75 unsigned int SyncProcessOutputBuffer::available() const {
76   return sizeof data_ - used();
77 }
78 
79 
used() const80 unsigned int SyncProcessOutputBuffer::used() const {
81   return used_;
82 }
83 
84 
next() const85 SyncProcessOutputBuffer* SyncProcessOutputBuffer::next() const {
86   return next_;
87 }
88 
89 
set_next(SyncProcessOutputBuffer * next)90 void SyncProcessOutputBuffer::set_next(SyncProcessOutputBuffer* next) {
91   next_ = next;
92 }
93 
94 
SyncProcessStdioPipe(SyncProcessRunner * process_handler,bool readable,bool writable,uv_buf_t input_buffer)95 SyncProcessStdioPipe::SyncProcessStdioPipe(SyncProcessRunner* process_handler,
96                                            bool readable,
97                                            bool writable,
98                                            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       lifecycle_(kUninitialized) {
112   CHECK(readable || writable);
113 }
114 
115 
~SyncProcessStdioPipe()116 SyncProcessStdioPipe::~SyncProcessStdioPipe() {
117   CHECK(lifecycle_ == kUninitialized || lifecycle_ == kClosed);
118 
119   SyncProcessOutputBuffer* buf;
120   SyncProcessOutputBuffer* next;
121 
122   for (buf = first_output_buffer_; buf != nullptr; buf = next) {
123     next = buf->next();
124     delete buf;
125   }
126 }
127 
128 
Initialize(uv_loop_t * loop)129 int SyncProcessStdioPipe::Initialize(uv_loop_t* loop) {
130   CHECK_EQ(lifecycle_, kUninitialized);
131 
132   int r = uv_pipe_init(loop, uv_pipe(), 0);
133   if (r < 0)
134     return r;
135 
136   uv_pipe()->data = this;
137 
138   lifecycle_ = kInitialized;
139   return 0;
140 }
141 
142 
Start()143 int SyncProcessStdioPipe::Start() {
144   CHECK_EQ(lifecycle_, kInitialized);
145 
146   // Set the busy flag already. If this function fails no recovery is
147   // possible.
148   lifecycle_ = kStarted;
149 
150   if (readable()) {
151     if (input_buffer_.len > 0) {
152       CHECK_NOT_NULL(input_buffer_.base);
153 
154       int r = uv_write(&write_req_,
155                        uv_stream(),
156                        &input_buffer_,
157                        1,
158                        WriteCallback);
159       if (r < 0)
160         return r;
161     }
162 
163     int r = uv_shutdown(&shutdown_req_, uv_stream(), ShutdownCallback);
164     if (r < 0)
165       return r;
166   }
167 
168   if (writable()) {
169     int r = uv_read_start(uv_stream(), AllocCallback, ReadCallback);
170     if (r < 0)
171       return r;
172   }
173 
174   return 0;
175 }
176 
177 
Close()178 void SyncProcessStdioPipe::Close() {
179   CHECK(lifecycle_ == kInitialized || lifecycle_ == kStarted);
180 
181   uv_close(uv_handle(), CloseCallback);
182 
183   lifecycle_ = kClosing;
184 }
185 
186 
GetOutputAsBuffer(Environment * env) const187 Local<Object> SyncProcessStdioPipe::GetOutputAsBuffer(Environment* env) const {
188   size_t length = OutputLength();
189   Local<Object> js_buffer = Buffer::New(env, length).ToLocalChecked();
190   CopyOutput(Buffer::Data(js_buffer));
191   return js_buffer;
192 }
193 
194 
readable() const195 bool SyncProcessStdioPipe::readable() const {
196   return readable_;
197 }
198 
199 
writable() const200 bool SyncProcessStdioPipe::writable() const {
201   return writable_;
202 }
203 
204 
uv_flags() const205 uv_stdio_flags SyncProcessStdioPipe::uv_flags() const {
206   unsigned int flags;
207 
208   flags = UV_CREATE_PIPE;
209   if (readable())
210     flags |= UV_READABLE_PIPE;
211   if (writable())
212     flags |= UV_WRITABLE_PIPE;
213 
214   return static_cast<uv_stdio_flags>(flags);
215 }
216 
217 
uv_pipe() const218 uv_pipe_t* SyncProcessStdioPipe::uv_pipe() const {
219   CHECK_LT(lifecycle_, kClosing);
220   return &uv_pipe_;
221 }
222 
223 
uv_stream() const224 uv_stream_t* SyncProcessStdioPipe::uv_stream() const {
225   return reinterpret_cast<uv_stream_t*>(uv_pipe());
226 }
227 
228 
uv_handle() const229 uv_handle_t* SyncProcessStdioPipe::uv_handle() const {
230   return reinterpret_cast<uv_handle_t*>(uv_pipe());
231 }
232 
233 
OutputLength() const234 size_t SyncProcessStdioPipe::OutputLength() const {
235   SyncProcessOutputBuffer* buf;
236   size_t size = 0;
237 
238   for (buf = first_output_buffer_; buf != nullptr; buf = buf->next())
239     size += buf->used();
240 
241   return size;
242 }
243 
244 
CopyOutput(char * dest) const245 void SyncProcessStdioPipe::CopyOutput(char* dest) const {
246   SyncProcessOutputBuffer* buf;
247   size_t offset = 0;
248 
249   for (buf = first_output_buffer_; buf != nullptr; buf = buf->next())
250     offset += buf->Copy(dest + offset);
251 }
252 
253 
OnAlloc(size_t suggested_size,uv_buf_t * buf)254 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   if (last_output_buffer_ == nullptr) {
261     // Allocate the first capture buffer.
262     first_output_buffer_ = new SyncProcessOutputBuffer();
263     last_output_buffer_ = first_output_buffer_;
264 
265   } else if (last_output_buffer_->available() == 0) {
266     // The current capture buffer is full so get us a new one.
267     SyncProcessOutputBuffer* buf = new SyncProcessOutputBuffer();
268     last_output_buffer_->set_next(buf);
269     last_output_buffer_ = buf;
270   }
271 
272   last_output_buffer_->OnAlloc(suggested_size, buf);
273 }
274 
275 
OnRead(const uv_buf_t * buf,ssize_t nread)276 void SyncProcessStdioPipe::OnRead(const uv_buf_t* buf, ssize_t nread) {
277   if (nread == UV_EOF) {
278     // Libuv implicitly stops reading on EOF.
279 
280   } 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     last_output_buffer_->OnRead(buf, nread);
287     process_handler_->IncrementBufferSizeAndCheckOverflow(nread);
288   }
289 }
290 
291 
OnWriteDone(int result)292 void SyncProcessStdioPipe::OnWriteDone(int result) {
293   if (result < 0)
294     SetError(result);
295 }
296 
297 
OnShutdownDone(int result)298 void SyncProcessStdioPipe::OnShutdownDone(int result) {
299   if (result < 0)
300     SetError(result);
301 }
302 
303 
OnClose()304 void SyncProcessStdioPipe::OnClose() {
305   lifecycle_ = kClosed;
306 }
307 
308 
SetError(int error)309 void SyncProcessStdioPipe::SetError(int error) {
310   CHECK_NE(error, 0);
311   process_handler_->SetPipeError(error);
312 }
313 
314 
AllocCallback(uv_handle_t * handle,size_t suggested_size,uv_buf_t * buf)315 void SyncProcessStdioPipe::AllocCallback(uv_handle_t* handle,
316                                          size_t suggested_size,
317                                          uv_buf_t* buf) {
318   SyncProcessStdioPipe* self =
319       reinterpret_cast<SyncProcessStdioPipe*>(handle->data);
320   self->OnAlloc(suggested_size, buf);
321 }
322 
323 
ReadCallback(uv_stream_t * stream,ssize_t nread,const uv_buf_t * buf)324 void SyncProcessStdioPipe::ReadCallback(uv_stream_t* stream,
325                                         ssize_t nread,
326                                         const uv_buf_t* buf) {
327   SyncProcessStdioPipe* self =
328         reinterpret_cast<SyncProcessStdioPipe*>(stream->data);
329   self->OnRead(buf, nread);
330 }
331 
332 
WriteCallback(uv_write_t * req,int result)333 void SyncProcessStdioPipe::WriteCallback(uv_write_t* req, int result) {
334   SyncProcessStdioPipe* self =
335       reinterpret_cast<SyncProcessStdioPipe*>(req->handle->data);
336   self->OnWriteDone(result);
337 }
338 
339 
ShutdownCallback(uv_shutdown_t * req,int result)340 void SyncProcessStdioPipe::ShutdownCallback(uv_shutdown_t* req, int result) {
341   SyncProcessStdioPipe* self =
342       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   if (result == UV_ENOTCONN)
349     result = 0;
350 
351   self->OnShutdownDone(result);
352 }
353 
354 
CloseCallback(uv_handle_t * handle)355 void SyncProcessStdioPipe::CloseCallback(uv_handle_t* handle) {
356   SyncProcessStdioPipe* self =
357       reinterpret_cast<SyncProcessStdioPipe*>(handle->data);
358   self->OnClose();
359 }
360 
361 
Initialize(Local<Object> target,Local<Value> unused,Local<Context> context,void * priv)362 void SyncProcessRunner::Initialize(Local<Object> target,
363                                    Local<Value> unused,
364                                    Local<Context> context,
365                                    void* priv) {
366   Environment* env = Environment::GetCurrent(context);
367   env->SetMethod(target, "spawn", Spawn);
368 }
369 
370 
Spawn(const FunctionCallbackInfo<Value> & args)371 void SyncProcessRunner::Spawn(const FunctionCallbackInfo<Value>& args) {
372   Environment* env = Environment::GetCurrent(args);
373   env->PrintSyncTrace();
374   SyncProcessRunner p(env);
375   Local<Value> result;
376   if (!p.Run(args[0]).ToLocal(&result)) return;
377   args.GetReturnValue().Set(result);
378 }
379 
380 
SyncProcessRunner(Environment * env)381 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       env_(env) {
414 }
415 
416 
~SyncProcessRunner()417 SyncProcessRunner::~SyncProcessRunner() {
418   CHECK_EQ(lifecycle_, kHandlesClosed);
419 
420   stdio_pipes_.clear();
421   delete[] file_buffer_;
422   delete[] args_buffer_;
423   delete[] cwd_buffer_;
424   delete[] env_buffer_;
425   delete[] uv_stdio_containers_;
426 }
427 
428 
env() const429 Environment* SyncProcessRunner::env() const {
430   return env_;
431 }
432 
Run(Local<Value> options)433 MaybeLocal<Object> SyncProcessRunner::Run(Local<Value> options) {
434   EscapableHandleScope scope(env()->isolate());
435 
436   CHECK_EQ(lifecycle_, kUninitialized);
437 
438   Maybe<bool> r = TryInitializeAndRunLoop(options);
439   CloseHandlesAndDeleteLoop();
440   if (r.IsNothing()) return MaybeLocal<Object>();
441 
442   Local<Object> result = BuildResultObject();
443 
444   return scope.Escape(result);
445 }
446 
TryInitializeAndRunLoop(Local<Value> options)447 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   CHECK_EQ(lifecycle_, kUninitialized);
453   lifecycle_ = kInitialized;
454 
455   uv_loop_ = new uv_loop_t;
456   if (uv_loop_ == nullptr) {
457     SetError(UV_ENOMEM);
458     return Just(false);
459   }
460 
461   r = uv_loop_init(uv_loop_);
462   if (r < 0) {
463     delete uv_loop_;
464     uv_loop_ = nullptr;
465     SetError(r);
466     return Just(false);
467   }
468 
469   if (!ParseOptions(options).To(&r)) return Nothing<bool>();
470 
471   if (r < 0) {
472     SetError(r);
473     return Just(false);
474   }
475 
476   if (timeout_ > 0) {
477     r = uv_timer_init(uv_loop_, &uv_timer_);
478     if (r < 0) {
479       SetError(r);
480       return Just(false);
481     }
482 
483     uv_unref(reinterpret_cast<uv_handle_t*>(&uv_timer_));
484 
485     uv_timer_.data = this;
486     kill_timer_initialized_ = true;
487 
488     // Start the timer immediately. If uv_spawn fails then
489     // CloseHandlesAndDeleteLoop() will immediately close the timer handle
490     // which implicitly stops it, so there is no risk that the timeout callback
491     // runs when the process didn't start.
492     r = uv_timer_start(&uv_timer_, KillTimerCallback, timeout_, 0);
493     if (r < 0) {
494       SetError(r);
495       return Just(false);
496     }
497   }
498 
499   uv_process_options_.exit_cb = ExitCallback;
500   r = uv_spawn(uv_loop_, &uv_process_, &uv_process_options_);
501   if (r < 0) {
502     SetError(r);
503     return Just(false);
504   }
505   uv_process_.data = this;
506 
507   for (const auto& pipe : stdio_pipes_) {
508     if (pipe != nullptr) {
509       r = pipe->Start();
510       if (r < 0) {
511         SetPipeError(r);
512         return Just(false);
513       }
514     }
515   }
516 
517   r = uv_run(uv_loop_, UV_RUN_DEFAULT);
518   if (r < 0)
519     // We can't handle uv_run failure.
520     ABORT();
521 
522   // If we get here the process should have exited.
523   CHECK_GE(exit_status_, 0);
524   return Just(true);
525 }
526 
527 
CloseHandlesAndDeleteLoop()528 void SyncProcessRunner::CloseHandlesAndDeleteLoop() {
529   CHECK_LT(lifecycle_, kHandlesClosed);
530 
531   if (uv_loop_ != nullptr) {
532     CloseStdioPipes();
533     CloseKillTimer();
534     // Close the process handle when ExitCallback was not called.
535     uv_handle_t* uv_process_handle =
536         reinterpret_cast<uv_handle_t*>(&uv_process_);
537 
538     // Close the process handle if it is still open. The handle type also
539     // needs to be checked because TryInitializeAndRunLoop() won't spawn a
540     // process if input validation fails.
541     if (uv_process_handle->type == UV_PROCESS &&
542         !uv_is_closing(uv_process_handle))
543       uv_close(uv_process_handle, nullptr);
544 
545     // Give closing watchers a chance to finish closing and get their close
546     // callbacks called.
547     int r = uv_run(uv_loop_, UV_RUN_DEFAULT);
548     if (r < 0)
549       ABORT();
550 
551     CheckedUvLoopClose(uv_loop_);
552     delete uv_loop_;
553     uv_loop_ = nullptr;
554 
555   } else {
556     // If the loop doesn't exist, neither should any pipes or timers.
557     CHECK_EQ(false, stdio_pipes_initialized_);
558     CHECK_EQ(false, kill_timer_initialized_);
559   }
560 
561   lifecycle_ = kHandlesClosed;
562 }
563 
564 
CloseStdioPipes()565 void SyncProcessRunner::CloseStdioPipes() {
566   CHECK_LT(lifecycle_, kHandlesClosed);
567 
568   if (stdio_pipes_initialized_) {
569     CHECK(!stdio_pipes_.empty());
570     CHECK_NOT_NULL(uv_loop_);
571 
572     for (const auto& pipe : stdio_pipes_) {
573       if (pipe)
574         pipe->Close();
575     }
576 
577     stdio_pipes_initialized_ = false;
578   }
579 }
580 
581 
CloseKillTimer()582 void SyncProcessRunner::CloseKillTimer() {
583   CHECK_LT(lifecycle_, kHandlesClosed);
584 
585   if (kill_timer_initialized_) {
586     CHECK_GT(timeout_, 0);
587     CHECK_NOT_NULL(uv_loop_);
588 
589     uv_handle_t* uv_timer_handle = reinterpret_cast<uv_handle_t*>(&uv_timer_);
590     uv_ref(uv_timer_handle);
591     uv_close(uv_timer_handle, KillTimerCloseCallback);
592 
593     kill_timer_initialized_ = false;
594   }
595 }
596 
597 
Kill()598 void SyncProcessRunner::Kill() {
599   // Only attempt to kill once.
600   if (killed_)
601     return;
602   killed_ = true;
603 
604   // We might get here even if the process we spawned has already exited. This
605   // could happen when our child process spawned another process which
606   // inherited (one of) the stdio pipes. In this case we won't attempt to send
607   // a signal to the process, however we will still close our end of the stdio
608   // pipes so this situation won't make us hang.
609   if (exit_status_ < 0) {
610     int r = uv_process_kill(&uv_process_, kill_signal_);
611 
612     // If uv_kill failed with an error that isn't ESRCH, the user probably
613     // specified an invalid or unsupported signal. Signal this to the user as
614     // and error and kill the process with SIGKILL instead.
615     if (r < 0 && r != UV_ESRCH) {
616       SetError(r);
617 
618       // Deliberately ignore the return value, we might not have
619       // sufficient privileges to signal the child process.
620       USE(uv_process_kill(&uv_process_, SIGKILL));
621     }
622   }
623 
624   // Close all stdio pipes.
625   CloseStdioPipes();
626 
627   // Stop the timeout timer immediately.
628   CloseKillTimer();
629 }
630 
631 
IncrementBufferSizeAndCheckOverflow(ssize_t length)632 void SyncProcessRunner::IncrementBufferSizeAndCheckOverflow(ssize_t length) {
633   buffered_output_size_ += length;
634 
635   if (max_buffer_ > 0 && buffered_output_size_ > max_buffer_) {
636     SetError(UV_ENOBUFS);
637     Kill();
638   }
639 }
640 
641 
OnExit(int64_t exit_status,int term_signal)642 void SyncProcessRunner::OnExit(int64_t exit_status, int term_signal) {
643   if (exit_status < 0)
644     return SetError(static_cast<int>(exit_status));
645 
646   exit_status_ = exit_status;
647   term_signal_ = term_signal;
648 }
649 
650 
OnKillTimerTimeout()651 void SyncProcessRunner::OnKillTimerTimeout() {
652   SetError(UV_ETIMEDOUT);
653   Kill();
654 }
655 
656 
GetError()657 int SyncProcessRunner::GetError() {
658   if (error_ != 0)
659     return error_;
660   else
661     return pipe_error_;
662 }
663 
664 
SetError(int error)665 void SyncProcessRunner::SetError(int error) {
666   if (error_ == 0)
667     error_ = error;
668 }
669 
670 
SetPipeError(int pipe_error)671 void SyncProcessRunner::SetPipeError(int pipe_error) {
672   if (pipe_error_ == 0)
673     pipe_error_ = pipe_error;
674 }
675 
676 
BuildResultObject()677 Local<Object> SyncProcessRunner::BuildResultObject() {
678   EscapableHandleScope scope(env()->isolate());
679   Local<Context> context = env()->context();
680 
681   Local<Object> js_result = Object::New(env()->isolate());
682 
683   if (GetError() != 0) {
684     js_result->Set(context, env()->error_string(),
685                    Integer::New(env()->isolate(), GetError())).Check();
686   }
687 
688   if (exit_status_ >= 0) {
689     if (term_signal_ > 0) {
690       js_result->Set(context, env()->status_string(),
691                      Null(env()->isolate())).Check();
692     } else {
693       js_result->Set(context, env()->status_string(),
694                      Number::New(env()->isolate(),
695                                  static_cast<double>(exit_status_))).Check();
696     }
697   } else {
698     // If exit_status_ < 0 the process was never started because of some error.
699     js_result->Set(context, env()->status_string(),
700                    Null(env()->isolate())).Check();
701   }
702 
703   if (term_signal_ > 0)
704     js_result->Set(context, env()->signal_string(),
705                    String::NewFromUtf8(env()->isolate(),
706                                        signo_string(term_signal_))
707                        .ToLocalChecked())
708         .Check();
709   else
710     js_result->Set(context, env()->signal_string(),
711                    Null(env()->isolate())).Check();
712 
713   if (exit_status_ >= 0)
714     js_result->Set(context, env()->output_string(),
715                    BuildOutputArray()).Check();
716   else
717     js_result->Set(context, env()->output_string(),
718                    Null(env()->isolate())).Check();
719 
720   js_result->Set(context, env()->pid_string(),
721                  Number::New(env()->isolate(), uv_process_.pid)).Check();
722 
723   return scope.Escape(js_result);
724 }
725 
726 
BuildOutputArray()727 Local<Array> SyncProcessRunner::BuildOutputArray() {
728   CHECK_GE(lifecycle_, kInitialized);
729   CHECK(!stdio_pipes_.empty());
730 
731   EscapableHandleScope scope(env()->isolate());
732   MaybeStackBuffer<Local<Value>, 8> js_output(stdio_pipes_.size());
733 
734   for (uint32_t i = 0; i < stdio_pipes_.size(); i++) {
735     SyncProcessStdioPipe* h = stdio_pipes_[i].get();
736     if (h != nullptr && h->writable())
737       js_output[i] = h->GetOutputAsBuffer(env());
738     else
739       js_output[i] = Null(env()->isolate());
740   }
741 
742   return scope.Escape(
743       Array::New(env()->isolate(), js_output.out(), js_output.length()));
744 }
745 
ParseOptions(Local<Value> js_value)746 Maybe<int> SyncProcessRunner::ParseOptions(Local<Value> js_value) {
747   Isolate* isolate = env()->isolate();
748   HandleScope scope(isolate);
749   int r;
750 
751   if (!js_value->IsObject()) return Just<int>(UV_EINVAL);
752 
753   Local<Context> context = env()->context();
754   Local<Object> js_options = js_value.As<Object>();
755 
756   Local<Value> js_file =
757       js_options->Get(context, env()->file_string()).ToLocalChecked();
758   if (!CopyJsString(js_file, &file_buffer_).To(&r)) return Nothing<int>();
759   if (r < 0) return Just(r);
760   uv_process_options_.file = file_buffer_;
761 
762   Local<Value> js_args =
763       js_options->Get(context, env()->args_string()).ToLocalChecked();
764   if (!CopyJsStringArray(js_args, &args_buffer_).To(&r)) return Nothing<int>();
765   if (r < 0) return Just(r);
766   uv_process_options_.args = reinterpret_cast<char**>(args_buffer_);
767 
768   Local<Value> js_cwd =
769       js_options->Get(context, env()->cwd_string()).ToLocalChecked();
770   if (IsSet(js_cwd)) {
771     if (!CopyJsString(js_cwd, &cwd_buffer_).To(&r)) return Nothing<int>();
772     if (r < 0) return Just(r);
773     uv_process_options_.cwd = cwd_buffer_;
774   }
775 
776   Local<Value> js_env_pairs =
777       js_options->Get(context, env()->env_pairs_string()).ToLocalChecked();
778   if (IsSet(js_env_pairs)) {
779     if (!CopyJsStringArray(js_env_pairs, &env_buffer_).To(&r))
780       return Nothing<int>();
781     if (r < 0) return Just(r);
782 
783     uv_process_options_.env = reinterpret_cast<char**>(env_buffer_);
784   }
785   Local<Value> js_uid =
786       js_options->Get(context, env()->uid_string()).ToLocalChecked();
787   if (IsSet(js_uid)) {
788     CHECK(js_uid->IsInt32());
789     const int32_t uid = js_uid.As<Int32>()->Value();
790     uv_process_options_.uid = static_cast<uv_uid_t>(uid);
791     uv_process_options_.flags |= UV_PROCESS_SETUID;
792   }
793 
794   Local<Value> js_gid =
795       js_options->Get(context, env()->gid_string()).ToLocalChecked();
796   if (IsSet(js_gid)) {
797     CHECK(js_gid->IsInt32());
798     const int32_t gid = js_gid.As<Int32>()->Value();
799     uv_process_options_.gid = static_cast<uv_gid_t>(gid);
800     uv_process_options_.flags |= UV_PROCESS_SETGID;
801   }
802 
803   Local<Value> js_detached =
804       js_options->Get(context, env()->detached_string()).ToLocalChecked();
805   if (js_detached->BooleanValue(isolate))
806     uv_process_options_.flags |= UV_PROCESS_DETACHED;
807 
808   Local<Value> js_win_hide =
809       js_options->Get(context, env()->windows_hide_string()).ToLocalChecked();
810   if (js_win_hide->BooleanValue(isolate))
811     uv_process_options_.flags |= UV_PROCESS_WINDOWS_HIDE;
812 
813   Local<Value> js_wva =
814       js_options->Get(context, env()->windows_verbatim_arguments_string())
815           .ToLocalChecked();
816 
817   if (js_wva->BooleanValue(isolate))
818     uv_process_options_.flags |= UV_PROCESS_WINDOWS_VERBATIM_ARGUMENTS;
819 
820   Local<Value> js_timeout =
821       js_options->Get(context, env()->timeout_string()).ToLocalChecked();
822   if (IsSet(js_timeout)) {
823     CHECK(js_timeout->IsNumber());
824     int64_t timeout = js_timeout->IntegerValue(context).FromJust();
825     timeout_ = static_cast<uint64_t>(timeout);
826   }
827 
828   Local<Value> js_max_buffer =
829       js_options->Get(context, env()->max_buffer_string()).ToLocalChecked();
830   if (IsSet(js_max_buffer)) {
831     CHECK(js_max_buffer->IsNumber());
832     max_buffer_ = js_max_buffer->NumberValue(context).FromJust();
833   }
834 
835   Local<Value> js_kill_signal =
836       js_options->Get(context, env()->kill_signal_string()).ToLocalChecked();
837   if (IsSet(js_kill_signal)) {
838     CHECK(js_kill_signal->IsInt32());
839     kill_signal_ = js_kill_signal.As<Int32>()->Value();
840   }
841 
842   Local<Value> js_stdio =
843       js_options->Get(context, env()->stdio_string()).ToLocalChecked();
844   r = ParseStdioOptions(js_stdio);
845   if (r < 0) return Just(r);
846 
847   return Just(0);
848 }
849 
850 
ParseStdioOptions(Local<Value> js_value)851 int SyncProcessRunner::ParseStdioOptions(Local<Value> js_value) {
852   HandleScope scope(env()->isolate());
853   Local<Array> js_stdio_options;
854 
855   if (!js_value->IsArray())
856     return UV_EINVAL;
857 
858   Local<Context> context = env()->context();
859   js_stdio_options = js_value.As<Array>();
860 
861   stdio_count_ = js_stdio_options->Length();
862   uv_stdio_containers_ = new uv_stdio_container_t[stdio_count_];
863 
864   stdio_pipes_.clear();
865   stdio_pipes_.resize(stdio_count_);
866   stdio_pipes_initialized_ = true;
867 
868   for (uint32_t i = 0; i < stdio_count_; i++) {
869     Local<Value> js_stdio_option =
870         js_stdio_options->Get(context, i).ToLocalChecked();
871 
872     if (!js_stdio_option->IsObject())
873       return UV_EINVAL;
874 
875     int r = ParseStdioOption(i, js_stdio_option.As<Object>());
876     if (r < 0)
877       return r;
878   }
879 
880   uv_process_options_.stdio = uv_stdio_containers_;
881   uv_process_options_.stdio_count = stdio_count_;
882 
883   return 0;
884 }
885 
886 
ParseStdioOption(int child_fd,Local<Object> js_stdio_option)887 int SyncProcessRunner::ParseStdioOption(int child_fd,
888                                         Local<Object> js_stdio_option) {
889   Local<Context> context = env()->context();
890   Local<Value> js_type =
891       js_stdio_option->Get(context, env()->type_string()).ToLocalChecked();
892 
893   if (js_type->StrictEquals(env()->ignore_string())) {
894     return AddStdioIgnore(child_fd);
895 
896   } else if (js_type->StrictEquals(env()->pipe_string())) {
897     Isolate* isolate = env()->isolate();
898     Local<String> rs = env()->readable_string();
899     Local<String> ws = env()->writable_string();
900 
901     bool readable = js_stdio_option->Get(context, rs)
902         .ToLocalChecked()->BooleanValue(isolate);
903     bool writable =
904         js_stdio_option->Get(context, ws)
905         .ToLocalChecked()->BooleanValue(isolate);
906 
907     uv_buf_t buf = uv_buf_init(nullptr, 0);
908 
909     if (readable) {
910       Local<Value> input =
911           js_stdio_option->Get(context, env()->input_string()).ToLocalChecked();
912       if (Buffer::HasInstance(input)) {
913         buf = uv_buf_init(Buffer::Data(input),
914                           static_cast<unsigned int>(Buffer::Length(input)));
915       } else if (!input->IsUndefined() && !input->IsNull()) {
916         // Strings, numbers etc. are currently unsupported. It's not possible
917         // to create a buffer for them here because there is no way to free
918         // them afterwards.
919         return UV_EINVAL;
920       }
921     }
922 
923     return AddStdioPipe(child_fd, readable, writable, buf);
924 
925   } else if (js_type->StrictEquals(env()->inherit_string()) ||
926              js_type->StrictEquals(env()->fd_string())) {
927     int inherit_fd = js_stdio_option->Get(context, env()->fd_string())
928         .ToLocalChecked()->Int32Value(context).FromJust();
929     return AddStdioInheritFD(child_fd, inherit_fd);
930 
931   } else {
932     CHECK(0 && "invalid child stdio type");
933     return UV_EINVAL;
934   }
935 }
936 
937 
AddStdioIgnore(uint32_t child_fd)938 int SyncProcessRunner::AddStdioIgnore(uint32_t child_fd) {
939   CHECK_LT(child_fd, stdio_count_);
940   CHECK(!stdio_pipes_[child_fd]);
941 
942   uv_stdio_containers_[child_fd].flags = UV_IGNORE;
943 
944   return 0;
945 }
946 
947 
AddStdioPipe(uint32_t child_fd,bool readable,bool writable,uv_buf_t input_buffer)948 int SyncProcessRunner::AddStdioPipe(uint32_t child_fd,
949                                     bool readable,
950                                     bool writable,
951                                     uv_buf_t input_buffer) {
952   CHECK_LT(child_fd, stdio_count_);
953   CHECK(!stdio_pipes_[child_fd]);
954 
955   std::unique_ptr<SyncProcessStdioPipe> h(
956       new SyncProcessStdioPipe(this, readable, writable, input_buffer));
957 
958   int r = h->Initialize(uv_loop_);
959   if (r < 0) {
960     h.reset();
961     return r;
962   }
963 
964   uv_stdio_containers_[child_fd].flags = h->uv_flags();
965   uv_stdio_containers_[child_fd].data.stream = h->uv_stream();
966 
967   stdio_pipes_[child_fd] = std::move(h);
968 
969   return 0;
970 }
971 
972 
AddStdioInheritFD(uint32_t child_fd,int inherit_fd)973 int SyncProcessRunner::AddStdioInheritFD(uint32_t child_fd, int inherit_fd) {
974   CHECK_LT(child_fd, stdio_count_);
975   CHECK(!stdio_pipes_[child_fd]);
976 
977   uv_stdio_containers_[child_fd].flags = UV_INHERIT_FD;
978   uv_stdio_containers_[child_fd].data.fd = inherit_fd;
979 
980   return 0;
981 }
982 
983 
IsSet(Local<Value> value)984 bool SyncProcessRunner::IsSet(Local<Value> value) {
985   return !value->IsUndefined() && !value->IsNull();
986 }
987 
CopyJsString(Local<Value> js_value,const char ** target)988 Maybe<int> SyncProcessRunner::CopyJsString(Local<Value> js_value,
989                                            const char** target) {
990   Isolate* isolate = env()->isolate();
991   Local<String> js_string;
992   size_t size, written;
993   char* buffer;
994 
995   if (js_value->IsString())
996     js_string = js_value.As<String>();
997   else if (!js_value->ToString(env()->isolate()->GetCurrentContext())
998                 .ToLocal(&js_string))
999     return Nothing<int>();
1000 
1001   // Include space for null terminator byte.
1002   if (!StringBytes::StorageSize(isolate, js_string, UTF8).To(&size))
1003     return Nothing<int>();
1004   size += 1;
1005 
1006   buffer = new char[size];
1007 
1008   written = StringBytes::Write(isolate, buffer, -1, js_string, UTF8);
1009   buffer[written] = '\0';
1010 
1011   *target = buffer;
1012   return Just(0);
1013 }
1014 
CopyJsStringArray(Local<Value> js_value,char ** target)1015 Maybe<int> SyncProcessRunner::CopyJsStringArray(Local<Value> js_value,
1016                                                 char** target) {
1017   Isolate* isolate = env()->isolate();
1018   Local<Array> js_array;
1019   uint32_t length;
1020   size_t list_size, data_size, data_offset;
1021   char** list;
1022   char* buffer;
1023 
1024   if (!js_value->IsArray()) return Just<int>(UV_EINVAL);
1025 
1026   Local<Context> context = env()->context();
1027   js_array = js_value.As<Array>()->Clone().As<Array>();
1028   length = js_array->Length();
1029   data_size = 0;
1030 
1031   // Index has a pointer to every string element, plus one more for a final
1032   // null pointer.
1033   list_size = (length + 1) * sizeof *list;
1034 
1035   // Convert all array elements to string. Modify the js object itself if
1036   // needed - it's okay since we cloned the original object. Also compute the
1037   // length of all strings, including room for a null terminator after every
1038   // string. Align strings to cache lines.
1039   for (uint32_t i = 0; i < length; i++) {
1040     auto value = js_array->Get(context, i).ToLocalChecked();
1041 
1042     if (!value->IsString()) {
1043       Local<String> string;
1044       if (!value->ToString(env()->isolate()->GetCurrentContext())
1045                .ToLocal(&string))
1046         return Nothing<int>();
1047       js_array
1048           ->Set(context,
1049                 i,
1050                 string)
1051           .Check();
1052     }
1053 
1054     Maybe<size_t> maybe_size = StringBytes::StorageSize(isolate, value, UTF8);
1055     if (maybe_size.IsNothing()) return Nothing<int>();
1056     data_size += maybe_size.FromJust() + 1;
1057     data_size = RoundUp(data_size, sizeof(void*));
1058   }
1059 
1060   buffer = new char[list_size + data_size];
1061 
1062   list = reinterpret_cast<char**>(buffer);
1063   data_offset = list_size;
1064 
1065   for (uint32_t i = 0; i < length; i++) {
1066     list[i] = buffer + data_offset;
1067     auto value = js_array->Get(context, i).ToLocalChecked();
1068     data_offset += StringBytes::Write(isolate,
1069                                       buffer + data_offset,
1070                                       -1,
1071                                       value,
1072                                       UTF8);
1073     buffer[data_offset++] = '\0';
1074     data_offset = RoundUp(data_offset, sizeof(void*));
1075   }
1076 
1077   list[length] = nullptr;
1078 
1079   *target = buffer;
1080   return Just(0);
1081 }
1082 
1083 
ExitCallback(uv_process_t * handle,int64_t exit_status,int term_signal)1084 void SyncProcessRunner::ExitCallback(uv_process_t* handle,
1085                                      int64_t exit_status,
1086                                      int term_signal) {
1087   SyncProcessRunner* self = reinterpret_cast<SyncProcessRunner*>(handle->data);
1088   uv_close(reinterpret_cast<uv_handle_t*>(handle), nullptr);
1089   self->OnExit(exit_status, term_signal);
1090 }
1091 
1092 
KillTimerCallback(uv_timer_t * handle)1093 void SyncProcessRunner::KillTimerCallback(uv_timer_t* handle) {
1094   SyncProcessRunner* self = reinterpret_cast<SyncProcessRunner*>(handle->data);
1095   self->OnKillTimerTimeout();
1096 }
1097 
1098 
KillTimerCloseCallback(uv_handle_t * handle)1099 void SyncProcessRunner::KillTimerCloseCallback(uv_handle_t* handle) {
1100   // No-op.
1101 }
1102 
1103 }  // namespace node
1104 
1105 NODE_MODULE_CONTEXT_AWARE_INTERNAL(spawn_sync,
1106   node::SyncProcessRunner::Initialize)
1107