doc/api/child_process.markdown

   1 # Child Process
   2
   3     Stability: 3 - Stable
   4
   5 Node provides a tri-directional `popen(3)` facility through the
   6 `child_process` module.
   7
   8 It is possible to stream data through a child's `stdin`, `stdout`, and
   9 `stderr` in a fully non-blocking way.
  10
  11 To create a child process use `require('child_process').spawn()` or
  12 `require('child_process').fork()`.  The semantics of each are slightly
  13 different, and explained below.
  14
  15 ## Class: ChildProcess
  16
  17 `ChildProcess` is an [EventEmitter][].
  18
  19 Child processes always have three streams associated with them. `child.stdin`,
  20 `child.stdout`, and `child.stderr`.  These may be shared with the stdio
  21 streams of the parent process, or they may be separate stream objects
  22 which can be piped to and from.
  23
  24 The ChildProcess class is not intended to be used directly.  Use the
  25 `spawn()` or `fork()` methods to create a Child Process instance.
  26
  27 ### Event:  'exit'
  28
  29 * `code` {Number} the exit code, if it exited normally.
  30 * `signal` {String} the signal passed to kill the child process, if it
  31   was killed by the parent.
  32
  33 This event is emitted after the child process ends. If the process terminated
  34 normally, `code` is the final exit code of the process, otherwise `null`. If
  35 the process terminated due to receipt of a signal, `signal` is the string name
  36 of the signal, otherwise `null`.
  37
  38 Note that the child process stdio streams might still be open.
  39
  40 See `waitpid(2)`.
  41
  42 ### Event: 'close'
  43
  44 This event is emitted when the stdio streams of a child process have all
  45 terminated.  This is distinct from 'exit', since multiple processes
  46 might share the same stdio streams.
  47
  48 ### Event: 'disconnect'
  49
  50 This event is emitted after using the `.disconnect()` method in the parent or
  51 in the child. After disconnecting it is no longer possible to send messages.
  52 An alternative way to check if you can send messages is to see if the
  53 `child.connected` property is `true`.
  54
  55 ### Event: 'message'
  56
  57 * `message` {Object} a parsed JSON object or primitive value
  58 * `sendHandle` {Handle object} a Socket or Server object
  59
  60 Messages send by `.send(message, [sendHandle])` are obtained using the
  61 `message` event.
  62
  63 ### child.stdin
  64
  65 * {Stream object}
  66
  67 A `Writable Stream` that represents the child process's `stdin`.
  68 Closing this stream via `end()` often causes the child process to terminate.
  69
  70 If the child stdio streams are shared with the parent, then this will
  71 not be set.
  72
  73 ### child.stdout
  74
  75 * {Stream object}
  76
  77 A `Readable Stream` that represents the child process's `stdout`.
  78
  79 If the child stdio streams are shared with the parent, then this will
  80 not be set.
  81
  82 ### child.stderr
  83
  84 * {Stream object}
  85
  86 A `Readable Stream` that represents the child process's `stderr`.
  87
  88 If the child stdio streams are shared with the parent, then this will
  89 not be set.
  90
  91 ### child.pid
  92
  93 * {Integer}
  94
  95 The PID of the child process.
  96
  97 Example:
  98
  99     var spawn = require('child_process').spawn,
 100         grep  = spawn('grep', ['ssh']);
 101
 102     console.log('Spawned child pid: ' + grep.pid);
 103     grep.stdin.end();
 104
 105 ### child.kill([signal])
 106
 107 * `signal` {String}
 108
 109 Send a signal to the child process. If no argument is given, the process will
 110 be sent `'SIGTERM'`. See `signal(7)` for a list of available signals.
 111
 112     var spawn = require('child_process').spawn,
 113         grep  = spawn('grep', ['ssh']);
 114
 115     grep.on('exit', function (code, signal) {
 116       console.log('child process terminated due to receipt of signal '+signal);
 117     });
 118
 119     // send SIGHUP to process
 120     grep.kill('SIGHUP');
 121
 122 Note that while the function is called `kill`, the signal delivered to the child
 123 process may not actually kill it.  `kill` really just sends a signal to a process.
 124
 125 See `kill(2)`
 126
 127 ### child.send(message, [sendHandle])
 128
 129 * `message` {Object}
 130 * `sendHandle` {Handle object}
 131
 132 When using `child_process.fork()` you can write to the child using
 133 `child.send(message, [sendHandle])` and messages are received by
 134 a `'message'` event on the child.
 135
 136 For example:
 137
 138     var cp = require('child_process');
 139
 140     var n = cp.fork(__dirname + '/sub.js');
 141
 142     n.on('message', function(m) {
 143       console.log('PARENT got message:', m);
 144     });
 145
 146     n.send({ hello: 'world' });
 147
 148 And then the child script, `'sub.js'` might look like this:
 149
 150     process.on('message', function(m) {
 151       console.log('CHILD got message:', m);
 152     });
 153
 154     process.send({ foo: 'bar' });
 155
 156 In the child the `process` object will have a `send()` method, and `process`
 157 will emit objects each time it receives a message on its channel.
 158
 159 There is a special case when sending a `{cmd: 'NODE_foo'}` message. All messages
 160 containing a `NODE_` prefix in its `cmd` property will not be emitted in
 161 the `message` event, since they are internal messages used by node core.
 162 Messages containing the prefix are emitted in the `internalMessage` event, you
 163 should by all means avoid using this feature, it is subject to change without notice.
 164
 165 The `sendHandle` option to `child.send()` is for sending a TCP server or
 166 socket object to another process. The child will receive the object as its
 167 second argument to the `message` event.
 168
 169 **send server object**
 170
 171 Here is an example of sending a server:
 172
 173     var child = require('child_process').fork('child.js');
 174
 175     // Open up the server object and send the handle.
 176     var server = require('net').createServer();
 177     server.on('connection', function (socket) {
 178       socket.end('handled by parent');
 179     });
 180     server.listen(1337, function() {
 181       child.send('server', server);
 182     });
 183
 184 And the child would the recive the server object as:
 185
 186     process.on('message', function(m, server) {
 187       if (m === 'server') {
 188         server.on('connection', function (socket) {
 189           socket.end('handled by child');
 190         });
 191       }
 192     });
 193
 194 Note that the server is now shared between the parent and child, this means
 195 that some connections will be handled by the parent and some by the child.
 196
 197 **send socket object**
 198
 199 Here is an example of sending a socket. It will spawn two childs and handle
 200 connections with the remote address `74.125.127.100` as VIP by sending the
 201 socket to a "special" child process. Other sockets will go to a "normal" process.
 202
 203     var normal = require('child_process').fork('child.js', ['normal']);
 204     var special = require('child_process').fork('child.js', ['special']);
 205
 206     // Open up the server and send sockets to child
 207     var server = require('net').createServer();
 208     server.on('connection', function (socket) {
 209
 210       // if this is a VIP
 211       if (socket.remoteAddress === '74.125.127.100') {
 212         special.send('socket', socket);
 213         return;
 214       }
 215       // just the usual dudes
 216       normal.send('socket', socket);
 217     });
 218     server.listen(1337);
 219
 220 The `child.js` could look like this:
 221
 222     process.on('message', function(m, socket) {
 223       if (m === 'socket') {
 224         socket.end('You where handled as a ' + process.argv[2] + ' person');
 225       }
 226     });
 227
 228 Note that once a single socket has been sent to a child the parent can no
 229 longer keep track of when the socket is destroyed. To indicate this condition
 230 the `.connections` property becomes `null`.
 231 It is also recomended not to use `.maxConnections` in this condition.
 232
 233 ### child.disconnect()
 234
 235 To close the IPC connection between parent and child use the
 236 `child.disconnect()` method. This allows the child to exit gracefully since
 237 there is no IPC channel keeping it alive. When calling this method the
 238 `disconnect` event will be emitted in both parent and child, and the
 239 `connected` flag will be set to `false`. Please note that you can also call
 240 `process.disconnect()` in the child process.
 241
 242 ## child_process.spawn(command, [args], [options])
 243
 244 * `command` {String} The command to run
 245 * `args` {Array} List of string arguments
 246 * `options` {Object}
 247   * `cwd` {String} Current working directory of the child process
 248   * `stdio` {Array|String} Child's stdio configuration. (See below)
 249   * `customFds` {Array} **Deprecated** File descriptors for the child to use
 250     for stdio.  (See below)
 251   * `env` {Object} Environment key-value pairs
 252   * `detached` {Boolean} The child will be a process group leader.  (See below)
 253 * return: {ChildProcess object}
 254
 255 Launches a new process with the given `command`, with  command line arguments in `args`.
 256 If omitted, `args` defaults to an empty Array.
 257
 258 The third argument is used to specify additional options, which defaults to:
 259
 260     { cwd: undefined,
 261       env: process.env
 262     }
 263
 264 `cwd` allows you to specify the working directory from which the process is spawned.
 265 Use `env` to specify environment variables that will be visible to the new process.
 266
 267 Example of running `ls -lh /usr`, capturing `stdout`, `stderr`, and the exit code:
 268
 269     var util  = require('util'),
 270         spawn = require('child_process').spawn,
 271         ls    = spawn('ls', ['-lh', '/usr']);
 272
 273     ls.stdout.on('data', function (data) {
 274       console.log('stdout: ' + data);
 275     });
 276
 277     ls.stderr.on('data', function (data) {
 278       console.log('stderr: ' + data);
 279     });
 280
 281     ls.on('exit', function (code) {
 282       console.log('child process exited with code ' + code);
 283     });
 284
 285
 286 Example: A very elaborate way to run 'ps ax | grep ssh'
 287
 288     var util  = require('util'),
 289         spawn = require('child_process').spawn,
 290         ps    = spawn('ps', ['ax']),
 291         grep  = spawn('grep', ['ssh']);
 292
 293     ps.stdout.on('data', function (data) {
 294       grep.stdin.write(data);
 295     });
 296
 297     ps.stderr.on('data', function (data) {
 298       console.log('ps stderr: ' + data);
 299     });
 300
 301     ps.on('exit', function (code) {
 302       if (code !== 0) {
 303         console.log('ps process exited with code ' + code);
 304       }
 305       grep.stdin.end();
 306     });
 307
 308     grep.stdout.on('data', function (data) {
 309       console.log('' + data);
 310     });
 311
 312     grep.stderr.on('data', function (data) {
 313       console.log('grep stderr: ' + data);
 314     });
 315
 316     grep.on('exit', function (code) {
 317       if (code !== 0) {
 318         console.log('grep process exited with code ' + code);
 319       }
 320     });
 321
 322
 323 Example of checking for failed exec:
 324
 325     var spawn = require('child_process').spawn,
 326         child = spawn('bad_command');
 327
 328     child.stderr.setEncoding('utf8');
 329     child.stderr.on('data', function (data) {
 330       if (/^execvp\(\)/.test(data)) {
 331         console.log('Failed to start child process.');
 332       }
 333     });
 334
 335 Note that if spawn receives an empty options object, it will result in
 336 spawning the process with an empty environment rather than using
 337 `process.env`. This due to backwards compatibility issues with a deprecated
 338 API.
 339
 340 The 'stdio' option to `child_process.spawn()` is an array where each
 341 index corresponds to a fd in the child.  The value is one of the following:
 342
 343 1. `'pipe'` - Create a pipe between the child process and the parent process.
 344    The parent end of the pipe is exposed to the parent as a property on the
 345    `child_process` object as `ChildProcess.stdio[fd]`. Pipes created for
 346    fds 0 - 2 are also available as ChildProcess.stdin, ChildProcess.stdout
 347    and ChildProcess.stderr, respectively.
 348 2. `'ipc'` - Create an IPC channel for passing messages/file descriptors
 349    between parent and child. A ChildProcess may have at most *one* IPC stdio
 350    file descriptor. Setting this option enables the ChildProcess.send() method.
 351    If the child writes JSON messages to this file descriptor, then this will
 352    trigger ChildProcess.on('message').  If the child is a Node.js program, then
 353    the presence of an IPC channel will enable process.send() and
 354    process.on('message').
 355 3. `'ignore'` - Do not set this file descriptor in the child. Note that Node
 356    will always open fd 0 - 2 for the processes it spawns. When any of these is
 357    ignored node will open `/dev/null` and attach it to the child's fd.
 358 4. `Stream` object - Share a readable or writable stream that refers to a tty,
 359    file, socket, or a pipe with the child process. The stream's underlying
 360    file descriptor is duplicated in the child process to the fd that
 361    corresponds to the index in the `stdio` array.
 362 5. Positive integer - The integer value is interpreted as a file descriptor
 363    that is is currently open in the parent process. It is shared with the child
 364    process, similar to how `Stream` objects can be shared.
 365 6. `null`, `undefined` - Use default value. For stdio fds 0, 1 and 2 (in other
 366    words, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the
 367    default is `'ignore'`.
 368
 369 As a shorthand, the `stdio` argument may also be one of the following
 370 strings, rather than an array:
 371
 372 * `ignore` - `['ignore', 'ignore', 'ignore']`
 373 * `pipe` - `['pipe', 'pipe', 'pipe']`
 374 * `inherit` - `[process.stdin, process.stdout, process.stderr]` or `[0,1,2]`
 375
 376 Example:
 377
 378     var spawn = require('child_process').spawn;
 379
 380     // Child will use parent's stdios
 381     spawn('prg', [], { stdio: 'inherit' });
 382
 383     // Spawn child sharing only stderr
 384     spawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });
 385
 386     // Open an extra fd=4, to interact with programs present a
 387     // startd-style interface.
 388     spawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });
 389
 390 If the `detached` option is set, the child process will be made the leader of a
 391 new process group.  This makes it possible for the child to continue running
 392 after the parent exits.
 393
 394 By default, the parent will wait for the detached child to exit.  To prevent
 395 the parent from waiting for a given `child`, use the `child.unref()` method,
 396 and the parent's event loop will not include the child in its reference count.
 397
 398 Example of detaching a long-running process and redirecting its output to a
 399 file:
 400
 401      var fs = require('fs'),
 402          spawn = require('child_process').spawn,
 403          out = fs.openSync('./out.log', 'a'),
 404          err = fs.openSync('./out.log', 'a');
 405
 406      var child = spawn('prg', [], {
 407        detached: true,
 408        stdio: [ 'ignore', out, err ]
 409      });
 410
 411      child.unref();
 412
 413 When using the `detached` option to start a long-running process, the process
 414 will not stay running in the background unless it is provided with a `stdio`
 415 configuration that is not connected to the parent.  If the parent's `stdio` is
 416 inherited, the child will remain attached to the controlling terminal.
 417
 418 There is a deprecated option called `customFds` which allows one to specify
 419 specific file descriptors for the stdio of the child process. This API was
 420 not portable to all platforms and therefore removed.
 421 With `customFds` it was possible to hook up the new process' `[stdin, stdout,
 422 stderr]` to existing streams; `-1` meant that a new stream should be created.
 423 Use at your own risk.
 424
 425 There are several internal options. In particular `stdinStream`,
 426 `stdoutStream`, `stderrStream`. They are for INTERNAL USE ONLY. As with all
 427 undocumented APIs in Node, they should not be used.
 428
 429 See also: `child_process.exec()` and `child_process.fork()`
 430
 431 ## child_process.exec(command, [options], callback)
 432
 433 * `command` {String} The command to run, with space-separated arguments
 434 * `options` {Object}
 435   * `cwd` {String} Current working directory of the child process
 436   * `stdio` {Array|String} Child's stdio configuration. (See above)
 437   * `customFds` {Array} **Deprecated** File descriptors for the child to use
 438     for stdio.  (See above)
 439   * `env` {Object} Environment key-value pairs
 440   * `encoding` {String} (Default: 'utf8')
 441   * `timeout` {Number} (Default: 0)
 442   * `maxBuffer` {Number} (Default: 200*1024)
 443   * `killSignal` {String} (Default: 'SIGTERM')
 444 * `callback` {Function} called with the output when process terminates
 445   * `error` {Error}
 446   * `stdout` {Buffer}
 447   * `stderr` {Buffer}
 448 * Return: ChildProcess object
 449
 450 Runs a command in a shell and buffers the output.
 451
 452     var exec = require('child_process').exec,
 453         child;
 454
 455     child = exec('cat *.js bad_file | wc -l',
 456       function (error, stdout, stderr) {
 457         console.log('stdout: ' + stdout);
 458         console.log('stderr: ' + stderr);
 459         if (error !== null) {
 460           console.log('exec error: ' + error);
 461         }
 462     });
 463
 464 The callback gets the arguments `(error, stdout, stderr)`. On success, `error`
 465 will be `null`.  On error, `error` will be an instance of `Error` and `err.code`
 466 will be the exit code of the child process, and `err.signal` will be set to the
 467 signal that terminated the process.
 468
 469 There is a second optional argument to specify several options. The
 470 default options are
 471
 472     { encoding: 'utf8',
 473       timeout: 0,
 474       maxBuffer: 200*1024,
 475       killSignal: 'SIGTERM',
 476       cwd: null,
 477       env: null }
 478
 479 If `timeout` is greater than 0, then it will kill the child process
 480 if it runs longer than `timeout` milliseconds. The child process is killed with
 481 `killSignal` (default: `'SIGTERM'`). `maxBuffer` specifies the largest
 482 amount of data allowed on stdout or stderr - if this value is exceeded then
 483 the child process is killed.
 484
 485
 486 ## child_process.execFile(file, args, options, callback)
 487
 488 * `file` {String} The filename of the program to run
 489 * `args` {Array} List of string arguments
 490 * `options` {Object}
 491   * `cwd` {String} Current working directory of the child process
 492   * `stdio` {Array|String} Child's stdio configuration. (See above)
 493   * `customFds` {Array} **Deprecated** File descriptors for the child to use
 494     for stdio.  (See above)
 495   * `env` {Object} Environment key-value pairs
 496   * `encoding` {String} (Default: 'utf8')
 497   * `timeout` {Number} (Default: 0)
 498   * `maxBuffer` {Number} (Default: 200\*1024)
 499   * `killSignal` {String} (Default: 'SIGTERM')
 500 * `callback` {Function} called with the output when process terminates
 501   * `error` {Error}
 502   * `stdout` {Buffer}
 503   * `stderr` {Buffer}
 504 * Return: ChildProcess object
 505
 506 This is similar to `child_process.exec()` except it does not execute a
 507 subshell but rather the specified file directly. This makes it slightly
 508 leaner than `child_process.exec`. It has the same options.
 509
 510
 511 ## child\_process.fork(modulePath, [args], [options])
 512
 513 * `modulePath` {String} The module to run in the child
 514 * `args` {Array} List of string arguments
 515 * `options` {Object}
 516   * `cwd` {String} Current working directory of the child process
 517   * `env` {Object} Environment key-value pairs
 518   * `encoding` {String} (Default: 'utf8')
 519 * Return: ChildProcess object
 520
 521 This is a special case of the `spawn()` functionality for spawning Node
 522 processes. In addition to having all the methods in a normal ChildProcess
 523 instance, the returned object has a communication channel built-in. See
 524 `child.send(message, [sendHandle])` for details.
 525
 526 By default the spawned Node process will have the stdout, stderr associated
 527 with the parent's. To change this behavior set the `silent` property in the
 528 `options` object to `true`.
 529
 530 The child process does not automatically exit once it's done, you need to call
 531 `process.exit()` explicitly. This limitation may be lifted in the future.
 532
 533 These child Nodes are still whole new instances of V8. Assume at least 30ms
 534 startup and 10mb memory for each new Node. That is, you cannot create many
 535 thousands of them.
 536
 537 [EventEmitter]: events.html#events_class_events_eventemitter