Module: Open4

Defined in:
lib/open4.rb

Defined Under Namespace

Classes: Error, SpawnError, ThreadEnsemble

Constant Summary collapse

VERSION = 
'1.3.4'

Class Method Summary collapse

Class Method Details

.alive(pid) ⇒ Object 



423
424
425
426
427
428
429
430
431
 
# File 'lib/open4.rb', line 423

def alive pid
  pid = Integer pid
  begin
    Process.kill 0, pid
    true
  rescue Errno::ESRCH
    false
  end
end

.alive? ⇒ Object 



432
433
434
435
436
437
438
439
440
 
# File 'lib/open4.rb', line 432

def alive pid
  pid = Integer pid
  begin
    Process.kill 0, pid
    true
  rescue Errno::ESRCH
    false
  end
end

.background(arg, *argv) ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/open4.rb', line 379

def background arg, *argv 
  require 'thread'
  q = Queue.new
  opts = { 'pid' => q, :pid => q }
  case argv.last
    when Hash
      argv.last.update opts
    else
      argv.push opts
  end
  thread = Thread.new(arg, argv){|_arg, _argv| spawn _arg, *_argv}
  sc = class << thread; self; end
  sc.module_eval {
    define_method(:pid){ @pid ||= q.pop }
    define_method(:spawn_status){ @spawn_status ||= value }
    define_method(:exitstatus){ @exitstatus ||= spawn_status.exitstatus }
  }
  thread
end

.bg ⇒ Object 



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/open4.rb', line 398

def background arg, *argv 
  require 'thread'
  q = Queue.new
  opts = { 'pid' => q, :pid => q }
  case argv.last
    when Hash
      argv.last.update opts
    else
      argv.push opts
  end
  thread = Thread.new(arg, argv){|_arg, _argv| spawn _arg, *_argv}
  sc = class << thread; self; end
  sc.module_eval {
    define_method(:pid){ @pid ||= q.pop }
    define_method(:spawn_status){ @spawn_status ||= value }
    define_method(:exitstatus){ @exitstatus ||= spawn_status.exitstatus }
  }
  thread
end

.chdir(cwd, &block) ⇒ Object 



373
374
375
376
 
# File 'lib/open4.rb', line 373

def chdir cwd, &block
  return(block.call Dir.pwd) unless cwd
  Dir.chdir cwd, &block
end

.description ⇒ Object 



10
11
12
 
# File 'lib/open4.rb', line 10

def Open4.description
  'open child process with handles on pid, stdin, stdout, and stderr: manage child processes and their io handles easily.'
end

.do_popen(b = nil, exception_propagation_at = nil, closefds = false, &cmd) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/open4.rb', line 55

def self.do_popen(b = nil, exception_propagation_at = nil, closefds=false, &cmd)
  pw, pr, pe, ps = IO.pipe, IO.pipe, IO.pipe, IO.pipe

  verbose = $VERBOSE
  begin
    $VERBOSE = nil

    cid = fork {
      if closefds
        exlist = [0, 1, 2] | [pw,pr,pe,ps].map{|p| [p.first.fileno, p.last.fileno] }.flatten
        ObjectSpace.each_object(IO){|io|
          io.close if (not io.closed?) and (not exlist.include? io.fileno) rescue nil
        }
      end

      pw.last.close
      STDIN.reopen pw.first
      pw.first.close

      pr.first.close
      STDOUT.reopen pr.last
      pr.last.close

      pe.first.close
      STDERR.reopen pe.last
      pe.last.close

      STDOUT.sync = STDERR.sync = true

      begin
        cmd.call(ps)
      rescue Exception => e
        Marshal.dump(e, ps.last)
        ps.last.flush
      ensure
        ps.last.close unless ps.last.closed?
      end

      exit!
    }
  ensure
    $VERBOSE = verbose
  end

  [ pw.first, pr.last, pe.last, ps.last ].each { |fd| fd.close }

  Open4.propagate_exception cid, ps.first if exception_propagation_at == :init

  pw.last.sync = true

  pi = [ pw.last, pr.first, pe.first ]

  begin
    return [cid, *pi] unless b

    begin
      b.call(cid, *pi)
    ensure
      pi.each { |fd| fd.close unless fd.closed? }
    end

    Open4.propagate_exception cid, ps.first if exception_propagation_at == :block

    Process.waitpid2(cid).last
  ensure
    ps.first.close unless ps.first.closed?
  end
end

.getopts(opts = {}) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/open4.rb', line 227

def getopts opts = {}
  lambda do |*args|
    keys, default, _ = args
    catch(:opt) do
      [keys].flatten.each do |key|
        [key, key.to_s, key.to_s.intern].each do |_key|
          throw :opt, opts[_key] if opts.has_key?(_key)
        end
      end
      default
    end
  end
end

.maim(pid, opts = {}) ⇒ Object 



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/open4.rb', line 402

def maim pid, opts = {}
  getopt = getopts opts
  sigs = getopt[ 'signals', %w(SIGTERM SIGQUIT SIGKILL) ]
  suspend = getopt[ 'suspend', 4 ]
  pid = Integer pid
  existed = false
  sigs.each do |sig|
    begin
      Process.kill sig, pid
      existed = true 
    rescue Errno::ESRCH
      return(existed ? nil : true)
    end
    return true unless alive? pid
    sleep suspend
    return true unless alive? pid
  end
  return(not alive?(pid)) 
end

.new_thread(*a, &b) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/open4.rb', line 215

def new_thread *a, &b
  cur = Thread.current
  Thread.new(*a) do |*_a|
    begin
      b[*_a]
    rescue Exception => e
      cur.raise e
    end
  end
end

.open4 ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'lib/open4.rb', line 41

def popen4(*cmd, &b)
  Open4.do_popen(b, :init) do |ps_read, ps_write|
    ps_read.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
    ps_write.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
    exec(*cmd)
    raise 'forty-two'   # Is this really needed?
  end
end

.pfork4(fun, &b) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/open4.rb', line 16

def pfork4(fun, &b)
  Open4.do_popen(b, :block) do |ps_read, _|
    ps_read.close
    begin
      fun.call
    rescue SystemExit => e
      # Make it seem to the caller that calling Kernel#exit in +fun+ kills
      # the child process normally. Kernel#exit! bypasses this rescue
      # block.
      exit! e.status
    else
      exit! 0
    end
  end
end

.popen4(*cmd, &b) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/open4.rb', line 33

def popen4(*cmd, &b)
  Open4.do_popen(b, :init) do |ps_read, ps_write|
    ps_read.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
    ps_write.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
    exec(*cmd)
    raise 'forty-two'   # Is this really needed?
  end
end

.popen4ext(closefds = false, *cmd, &b) ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'lib/open4.rb', line 45

def popen4ext(closefds=false, *cmd, &b)
  Open4.do_popen(b, :init, closefds) do |ps_read, ps_write|
    ps_read.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
    ps_write.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
    exec(*cmd)
    raise 'forty-two'   # Is this really needed?
  end
end

.propagate_exception(cid, ps_read) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/open4.rb', line 124

def self.propagate_exception(cid, ps_read)
  e = Marshal.load ps_read
  raise Exception === e ? e : "unknown failure!"
rescue EOFError
  # Child process did not raise exception.
rescue
  # Child process raised exception; wait it in order to avoid a zombie.
  Process.waitpid2 cid
  raise
ensure
  ps_read.close
end

.relay(src, dst = nil, t = nil) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/open4.rb', line 242

def relay src, dst = nil, t = nil
  send_dst =
    if dst.respond_to?(:call)
      lambda{|buf| dst.call(buf)}
    elsif dst.respond_to?(:<<)
      lambda{|buf| dst << buf }
    else
      lambda{|buf| buf }
    end

  unless src.nil?
    if src.respond_to? :gets
      while buf = to(t){ src.gets }
        send_dst[buf]
      end

    elsif src.respond_to? :each
      q = Queue.new
      th = nil

      timer_set = lambda do |_t|
        th = new_thread{ to(_t){ q.pop } }
      end

      timer_cancel = lambda do |_t|
        th.kill if th rescue nil
      end

      timer_set[t]
      begin
        src.each do |_buf|
          timer_cancel[t]
          send_dst[_buf]
          timer_set[t]
        end
      ensure
        timer_cancel[t]
      end

    elsif src.respond_to? :read
      buf = to(t){ src.read }
      send_dst[buf]

    else
      buf = to(t){ src.to_s }
      send_dst[buf]
    end
  end
end

.spawn(arg, *argv) ⇒ Object

Raises:



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/open4.rb', line 293

def spawn arg, *argv 
  argv.unshift(arg)
  opts = ((argv.size > 1 and Hash === argv.last) ? argv.pop : {})
  argv.flatten!
  cmd = argv.join(' ')


  getopt = getopts opts

  ignore_exit_failure = getopt[ 'ignore_exit_failure', getopt['quiet', false] ]
  ignore_exec_failure = getopt[ 'ignore_exec_failure', !getopt['raise', true] ]
  exitstatus = getopt[ %w( exitstatus exit_status status ) ]
  stdin = getopt[ %w( stdin in i 0 ) << 0 ]
  stdout = getopt[ %w( stdout out o 1 ) << 1 ]
  stderr = getopt[ %w( stderr err e 2 ) << 2 ]
  pid = getopt[ 'pid' ]
  timeout = getopt[ %w( timeout spawn_timeout ) ]
  stdin_timeout = getopt[ %w( stdin_timeout ) ]
  stdout_timeout = getopt[ %w( stdout_timeout io_timeout ) ]
  stderr_timeout = getopt[ %w( stderr_timeout ) ]
  status = getopt[ %w( status ) ]
  cwd = getopt[ %w( cwd dir ) ]
  closefds = getopt[ %w( close_fds ) ]

  exitstatus =
    case exitstatus
      when TrueClass, FalseClass
        ignore_exit_failure = true if exitstatus
        [0]
      else
        [*(exitstatus || 0)].map{|i| Integer i}
    end

  stdin ||= '' if stdin_timeout
  stdout ||= '' if stdout_timeout
  stderr ||= '' if stderr_timeout

  started = false

  status =
    begin
      chdir(cwd) do
        Timeout::timeout(timeout) do
          popen4ext(closefds, *argv) do |c, i, o, e|
            started = true

            %w( replace pid= << push update ).each do |msg|
              break(pid.send(msg, c)) if pid.respond_to? msg 
            end

            te = ThreadEnsemble.new c

            te.add_thread(i, stdin) do |_i, _stdin|
              relay _stdin, _i, stdin_timeout
              _i.close rescue nil
            end

            te.add_thread(o, stdout) do |_o, _stdout|
              relay _o, _stdout, stdout_timeout
            end

            te.add_thread(e, stderr) do |_o, _stderr| # HACK: I think this is a bug
              relay e, _stderr, stderr_timeout
            end

            te.run
          end
        end
      end
    rescue
      raise unless(not started and ignore_exec_failure)
    end

  raise SpawnError.new(cmd, status) unless
    (ignore_exit_failure or (status.nil? and ignore_exec_failure) or exitstatus.include?(status.exitstatus))

  status
end

.to(timeout = nil) ⇒ Object 



210
211
212
 
# File 'lib/open4.rb', line 210

def to timeout = nil
  Timeout.timeout(timeout){ yield }
end

.version ⇒ Object 



8
 
# File 'lib/open4.rb', line 8

def Open4.version() VERSION end