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 receive 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 children 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 recommended 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 spawn = require('child_process').spawn,
 270         ls    = spawn('ls', ['-lh', '/usr']);
 271
 272     ls.stdout.on('data', function (data) {
 273       console.log('stdout: ' + data);
 274     });
 275
 276     ls.stderr.on('data', function (data) {
 277       console.log('stderr: ' + data);
 278     });
 279
 280     ls.on('exit', function (code) {
 281       console.log('child process exited with code ' + code);
 282     });
 283
 284
 285 Example: A very elaborate way to run 'ps ax | grep ssh'
 286
 287     var spawn = require('child_process').spawn,
 288         ps    = spawn('ps', ['ax']),
 289         grep  = spawn('grep', ['ssh']);
 290
 291     ps.stdout.on('data', function (data) {
 292       grep.stdin.write(data);
 293     });
 294
 295     ps.stderr.on('data', function (data) {
 296       console.log('ps stderr: ' + data);
 297     });
 298
 299     ps.on('exit', function (code) {
 300       if (code !== 0) {
 301         console.log('ps process exited with code ' + code);
 302       }
 303       grep.stdin.end();
 304     });
 305
 306     grep.stdout.on('data', function (data) {
 307       console.log('' + data);
 308     });
 309
 310     grep.stderr.on('data', function (data) {
 311       console.log('grep stderr: ' + data);
 312     });
 313
 314     grep.on('exit', function (code) {
 315       if (code !== 0) {
 316         console.log('grep process exited with code ' + code);
 317       }
 318     });
 319
 320
 321 Example of checking for failed exec:
 322
 323     var spawn = require('child_process').spawn,
 324         child = spawn('bad_command');
 325
 326     child.stderr.setEncoding('utf8');
 327     child.stderr.on('data', function (data) {
 328       if (/^execvp\(\)/.test(data)) {
 329         console.log('Failed to start child process.');
 330       }
 331     });
 332
 333 Note that if spawn receives an empty options object, it will result in
 334 spawning the process with an empty environment rather than using
 335 `process.env`. This due to backwards compatibility issues with a deprecated
 336 API.
 337
 338 The 'stdio' option to `child_process.spawn()` is an array where each
 339 index corresponds to a fd in the child.  The value is one of the following:
 340
 341 1. `'pipe'` - Create a pipe between the child process and the parent process.
 342    The parent end of the pipe is exposed to the parent as a property on the
 343    `child_process` object as `ChildProcess.stdio[fd]`. Pipes created for
 344    fds 0 - 2 are also available as ChildProcess.stdin, ChildProcess.stdout
 345    and ChildProcess.stderr, respectively.
 346 2. `'ipc'` - Create an IPC channel for passing messages/file descriptors
 347    between parent and child. A ChildProcess may have at most *one* IPC stdio
 348    file descriptor. Setting this option enables the ChildProcess.send() method.
 349    If the child writes JSON messages to this file descriptor, then this will
 350    trigger ChildProcess.on('message').  If the child is a Node.js program, then
 351    the presence of an IPC channel will enable process.send() and
 352    process.on('message').
 353 3. `'ignore'` - Do not set this file descriptor in the child. Note that Node
 354    will always open fd 0 - 2 for the processes it spawns. When any of these is
 355    ignored node will open `/dev/null` and attach it to the child's fd.
 356 4. `Stream` object - Share a readable or writable stream that refers to a tty,
 357    file, socket, or a pipe with the child process. The stream's underlying
 358    file descriptor is duplicated in the child process to the fd that
 359    corresponds to the index in the `stdio` array.
 360 5. Positive integer - The integer value is interpreted as a file descriptor
 361    that is is currently open in the parent process. It is shared with the child
 362    process, similar to how `Stream` objects can be shared.
 363 6. `null`, `undefined` - Use default value. For stdio fds 0, 1 and 2 (in other
 364    words, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the
 365    default is `'ignore'`.
 366
 367 As a shorthand, the `stdio` argument may also be one of the following
 368 strings, rather than an array:
 369
 370 * `ignore` - `['ignore', 'ignore', 'ignore']`
 371 * `pipe` - `['pipe', 'pipe', 'pipe']`
 372 * `inherit` - `[process.stdin, process.stdout, process.stderr]` or `[0,1,2]`
 373
 374 Example:
 375
 376     var spawn = require('child_process').spawn;
 377
 378     // Child will use parent's stdios
 379     spawn('prg', [], { stdio: 'inherit' });
 380
 381     // Spawn child sharing only stderr
 382     spawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });
 383
 384     // Open an extra fd=4, to interact with programs present a
 385     // startd-style interface.
 386     spawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });
 387
 388 If the `detached` option is set, the child process will be made the leader of a
 389 new process group.  This makes it possible for the child to continue running
 390 after the parent exits.
 391
 392 By default, the parent will wait for the detached child to exit.  To prevent
 393 the parent from waiting for a given `child`, use the `child.unref()` method,
 394 and the parent's event loop will not include the child in its reference count.
 395
 396 Example of detaching a long-running process and redirecting its output to a
 397 file:
 398
 399      var fs = require('fs'),
 400          spawn = require('child_process').spawn,
 401          out = fs.openSync('./out.log', 'a'),
 402          err = fs.openSync('./out.log', 'a');
 403
 404      var child = spawn('prg', [], {
 405        detached: true,
 406        stdio: [ 'ignore', out, err ]
 407      });
 408
 409      child.unref();
 410
 411 When using the `detached` option to start a long-running process, the process
 412 will not stay running in the background unless it is provided with a `stdio`
 413 configuration that is not connected to the parent.  If the parent's `stdio` is
 414 inherited, the child will remain attached to the controlling terminal.
 415
 416 There is a deprecated option called `customFds` which allows one to specify
 417 specific file descriptors for the stdio of the child process. This API was
 418 not portable to all platforms and therefore removed.
 419 With `customFds` it was possible to hook up the new process' `[stdin, stdout,
 420 stderr]` to existing streams; `-1` meant that a new stream should be created.
 421 Use at your own risk.
 422
 423 There are several internal options. In particular `stdinStream`,
 424 `stdoutStream`, `stderrStream`. They are for INTERNAL USE ONLY. As with all
 425 undocumented APIs in Node, they should not be used.
 426
 427 See also: `child_process.exec()` and `child_process.fork()`
 428
 429 ## child_process.exec(command, [options], callback)
 430
 431 * `command` {String} The command to run, with space-separated arguments
 432 * `options` {Object}
 433   * `cwd` {String} Current working directory of the child process
 434   * `stdio` {Array|String} Child's stdio configuration. (See above)
 435   * `customFds` {Array} **Deprecated** File descriptors for the child to use
 436     for stdio.  (See above)
 437   * `env` {Object} Environment key-value pairs
 438   * `encoding` {String} (Default: 'utf8')
 439   * `timeout` {Number} (Default: 0)
 440   * `maxBuffer` {Number} (Default: 200*1024)
 441   * `killSignal` {String} (Default: 'SIGTERM')
 442 * `callback` {Function} called with the output when process terminates
 443   * `error` {Error}
 444   * `stdout` {Buffer}
 445   * `stderr` {Buffer}
 446 * Return: ChildProcess object
 447
 448 Runs a command in a shell and buffers the output.
 449
 450     var exec = require('child_process').exec,
 451         child;
 452
 453     child = exec('cat *.js bad_file | wc -l',
 454       function (error, stdout, stderr) {
 455         console.log('stdout: ' + stdout);
 456         console.log('stderr: ' + stderr);
 457         if (error !== null) {
 458           console.log('exec error: ' + error);
 459         }
 460     });
 461
 462 The callback gets the arguments `(error, stdout, stderr)`. On success, `error`
 463 will be `null`.  On error, `error` will be an instance of `Error` and `err.code`
 464 will be the exit code of the child process, and `err.signal` will be set to the
 465 signal that terminated the process.
 466
 467 There is a second optional argument to specify several options. The
 468 default options are
 469
 470     { encoding: 'utf8',
 471       timeout: 0,
 472       maxBuffer: 200*1024,
 473       killSignal: 'SIGTERM',
 474       cwd: null,
 475       env: null }
 476
 477 If `timeout` is greater than 0, then it will kill the child process
 478 if it runs longer than `timeout` milliseconds. The child process is killed with
 479 `killSignal` (default: `'SIGTERM'`). `maxBuffer` specifies the largest
 480 amount of data allowed on stdout or stderr - if this value is exceeded then
 481 the child process is killed.
 482
 483
 484 ## child_process.execFile(file, args, options, callback)
 485
 486 * `file` {String} The filename of the program to run
 487 * `args` {Array} List of string arguments
 488 * `options` {Object}
 489   * `cwd` {String} Current working directory of the child process
 490   * `stdio` {Array|String} Child's stdio configuration. (See above)
 491   * `customFds` {Array} **Deprecated** File descriptors for the child to use
 492     for stdio.  (See above)
 493   * `env` {Object} Environment key-value pairs
 494   * `encoding` {String} (Default: 'utf8')
 495   * `timeout` {Number} (Default: 0)
 496   * `maxBuffer` {Number} (Default: 200\*1024)
 497   * `killSignal` {String} (Default: 'SIGTERM')
 498 * `callback` {Function} called with the output when process terminates
 499   * `error` {Error}
 500   * `stdout` {Buffer}
 501   * `stderr` {Buffer}
 502 * Return: ChildProcess object
 503
 504 This is similar to `child_process.exec()` except it does not execute a
 505 subshell but rather the specified file directly. This makes it slightly
 506 leaner than `child_process.exec`. It has the same options.
 507
 508
 509 ## child\_process.fork(modulePath, [args], [options])
 510
 511 * `modulePath` {String} The module to run in the child
 512 * `args` {Array} List of string arguments
 513 * `options` {Object}
 514   * `cwd` {String} Current working directory of the child process
 515   * `env` {Object} Environment key-value pairs
 516   * `encoding` {String} (Default: 'utf8')
 517 * Return: ChildProcess object
 518
 519 This is a special case of the `spawn()` functionality for spawning Node
 520 processes. In addition to having all the methods in a normal ChildProcess
 521 instance, the returned object has a communication channel built-in. See
 522 `child.send(message, [sendHandle])` for details.
 523
 524 By default the spawned Node process will have the stdout, stderr associated
 525 with the parent's. To change this behavior set the `silent` property in the
 526 `options` object to `true`.
 527
 528 The child process does not automatically exit once it's done, you need to call
 529 `process.exit()` explicitly. This limitation may be lifted in the future.
 530
 531 These child Nodes are still whole new instances of V8. Assume at least 30ms
 532 startup and 10mb memory for each new Node. That is, you cannot create many
 533 thousands of them.
 534
 535 [EventEmitter]: events.html#events_class_events_eventemitter