Class: Shell::ProcessController

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/shell/process-controller.rb

Constant Summary

USING_AT_EXIT_WHEN_PROCESS_EXIT =

for shell-command complete finish at this process exit.

true

Constants included from Forwardable

Forwardable::FORWARDABLE_VERSION

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Forwardable

def_instance_delegator, def_instance_delegators, instance_delegate

Constructor Details

- (ProcessController) initialize(shell)

A new instance of ProcessController



93
94
95
96
97
98
99
100
101
# File 'lib/shell/process-controller.rb', line 93

def initialize(shell)
  @shell = shell
  @waiting_jobs = []
  @active_jobs = []
  @jobs_sync = Sync.new

  @job_monitor = Mutex.new
  @job_condition = ConditionVariable.new
end

Instance Attribute Details

- (Object) shell (readonly)

Returns the value of attribute shell



103
104
105
# File 'lib/shell/process-controller.rb', line 103

def shell
  @shell
end

Class Method Details

+ (Object) activate(pc)



38
39
40
41
42
43
# File 'lib/shell/process-controller.rb', line 38

def activate(pc)
	process_controllers_exclusive do
	  @ProcessControllers[pc] ||= 0
	  @ProcessControllers[pc] += 1
	end
end

+ (Object) active_process_controllers



32
33
34
35
36
# File 'lib/shell/process-controller.rb', line 32

def active_process_controllers
	process_controllers_exclusive do
	  @ProcessControllers.dup
	end
end

+ (Object) block_output_synchronize(&b)



64
65
66
# File 'lib/shell/process-controller.rb', line 64

def block_output_synchronize(&b)
	@BlockOutputMonitor.synchronize(&b)
end

+ (Object) each_active_object



56
57
58
59
60
61
62
# File 'lib/shell/process-controller.rb', line 56

def each_active_object
	process_controllers_exclusive do
	  for ref in @ProcessControllers.keys
	    yield ref
	  end
	end
end

+ (Object) inactivate(pc)



45
46
47
48
49
50
51
52
53
54
# File 'lib/shell/process-controller.rb', line 45

def inactivate(pc)
	process_controllers_exclusive do
	  if @ProcessControllers[pc]
	    if (@ProcessControllers[pc] -= 1) == 0
 @ProcessControllers.delete(pc)
 @ProcessControllersCV.signal
	    end
	  end
	end
end

+ (Object) wait_to_finish_all_process_controllers



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/shell/process-controller.rb', line 68

def wait_to_finish_all_process_controllers
	process_controllers_exclusive do
	  while !@ProcessControllers.empty?
	    Shell::notify("Process finishing, but active shell exists",
			  "You can use Shell#transact or Shell#check_point for more safe execution.")
	    if Shell.debug?
 for pc in @ProcessControllers.keys
		Shell::notify(" Not finished jobs in "+pc.shell.to_s)
 		for com in pc.jobs
 		  com.notify("  Jobs: %id")
 		end
 end
	    end
	    @ProcessControllersCV.wait(@ProcessControllersMonitor)
	  end
	end
end

Instance Method Details

- (Boolean) active_job?(job)

Returns:

  • (Boolean)


182
183
184
185
186
# File 'lib/shell/process-controller.rb', line 182

def active_job?(job)
  @jobs_sync.synchronize(:SH) do
	@active_jobs.include?(job)
  end
end

- (Object) active_jobs



114
115
116
# File 'lib/shell/process-controller.rb', line 114

def active_jobs
  @active_jobs
end

- (Boolean) active_jobs_exist?

Returns:

  • (Boolean)


128
129
130
131
132
# File 'lib/shell/process-controller.rb', line 128

def active_jobs_exist?
  @jobs_sync.synchronize(:SH) do
	@active_jobs.empty?
  end
end

- (Object) add_schedule(command)

schedule a command



141
142
143
144
145
146
147
148
149
150
# File 'lib/shell/process-controller.rb', line 141

def add_schedule(command)
  @jobs_sync.synchronize(:EX) do
	ProcessController.activate(self)
	if @active_jobs.empty?
	  start_job command
	else
	  @waiting_jobs.push(command)
	end
  end
end

- (Object) jobs



105
106
107
108
109
110
111
112
# File 'lib/shell/process-controller.rb', line 105

def jobs
  jobs = []
  @jobs_sync.synchronize(:SH) do
	jobs.concat @waiting_jobs
	jobs.concat @active_jobs
  end
  jobs
end

- (Boolean) jobs_exist?

Returns:

  • (Boolean)


122
123
124
125
126
# File 'lib/shell/process-controller.rb', line 122

def jobs_exist?
  @jobs_sync.synchronize(:SH) do
	@active_jobs.empty? or @waiting_jobs.empty?
  end
end

- (Object) kill_job(sig, command)

kill a job



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/shell/process-controller.rb', line 201

def kill_job(sig, command)
  @jobs_sync.synchronize(:EX) do
	if @waiting_jobs.delete command
	  ProcessController.inactivate(self)
	  return
	elsif @active_jobs.include?(command)
	  begin
 r = command.kill(sig)
 ProcessController.inactivate(self)
	  rescue
 print "Shell: Warn: $!\n" if @shell.verbose?
 return nil
	  end
	  @active_jobs.delete command
	  r
	end
  end
end

- (Object) sfork(command, &block)

simple fork



237
238
239
240
241
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
291
292
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
# File 'lib/shell/process-controller.rb', line 237

def sfork(command, &block)
  pipe_me_in, pipe_peer_out = IO.pipe
  pipe_peer_in, pipe_me_out = IO.pipe


  pid = nil
  pid_mutex = Mutex.new
  pid_cv = ConditionVariable.new

  Thread.start do
	ProcessController.block_output_synchronize do
	  STDOUT.flush
	  ProcessController.each_active_object do |pc|
 for jobs in pc.active_jobs
   jobs.flush
 end
	  end

	  pid = fork {
 Thread.list.each do |th|
#	      th.kill unless [Thread.main, Thread.current].include?(th)
   th.kill unless Thread.current == th
 end

 STDIN.reopen(pipe_peer_in)
 STDOUT.reopen(pipe_peer_out)

 ObjectSpace.each_object(IO) do |io|
   if ![STDIN, STDOUT, STDERR].include?(io)
		io.close unless io.closed?
   end
 end

 yield
	  }
	end
	pid_cv.signal

	pipe_peer_in.close
	pipe_peer_out.close
	command.notify "job(%name:##{pid}) start", @shell.debug?

	begin
	  _pid = nil
	  command.notify("job(%id) start to waiting finish.", @shell.debug?)
	  _pid = Process.waitpid(pid, nil)
	rescue Errno::ECHILD
	  command.notify "warn: job(%id) was done already waitpid."
	  _pid = true
	  #	rescue
	  #	  STDERR.puts $!
	ensure
	  command.notify("Job(%id): Wait to finish when Process finished.", @shell.debug?)
	  # when the process ends, wait until the command terminates
	  if USING_AT_EXIT_WHEN_PROCESS_EXIT or _pid
	  else
 command.notify("notice: Process finishing...",
  "wait for Job[%id] to finish.",
  "You can use Shell#transact or Shell#check_point for more safe execution.")
 redo
	  end

#	  command.notify "job(%id) pre-pre-finish.", @shell.debug?
	  @job_monitor.synchronize do
#	    command.notify "job(%id) pre-finish.", @shell.debug?
 terminate_job(command)
#	    command.notify "job(%id) pre-finish2.", @shell.debug?
 @job_condition.signal
 command.notify "job(%id) finish.", @shell.debug?
	  end
	end
  end

  pid_mutex.synchronize do
	while !pid
	  pid_cv.wait(pid_mutex)
	end
  end

  return pid, pipe_me_in, pipe_me_out
end

- (Object) start_job(command = nil)

start a job



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/shell/process-controller.rb', line 153

def start_job(command = nil)
  @jobs_sync.synchronize(:EX) do
	if command
	  return if command.active?
	  @waiting_jobs.delete command
	else
	  command = @waiting_jobs.shift
#	  command.notify "job(%id) pre-start.", @shell.debug?

	  return unless command
	end
	@active_jobs.push command
	command.start
#	command.notify "job(%id) post-start.", @shell.debug?

	# start all jobs that input from the job
	for job in @waiting_jobs.dup
	  start_job(job) if job.input == command
	end
#	command.notify "job(%id) post2-start.", @shell.debug?
  end
end

- (Object) terminate_job(command)

terminate a job



189
190
191
192
193
194
195
196
197
198
# File 'lib/shell/process-controller.rb', line 189

def terminate_job(command)
  @jobs_sync.synchronize(:EX) do
	@active_jobs.delete command
	ProcessController.inactivate(self)
	if @active_jobs.empty?
	  command.notify("start_job in terminate_job(%id)", Shell::debug?)
	  start_job
	end
  end
end

- (Object) wait_all_jobs_execution

wait for all jobs to terminate



221
222
223
224
225
226
227
228
229
230
231
232
233
234
# File 'lib/shell/process-controller.rb', line 221

def wait_all_jobs_execution
  @job_monitor.synchronize do
	begin
	  while !jobs.empty?
 @job_condition.wait(@job_monitor)
 for job in jobs
   job.notify("waiting job(%id)", Shell::debug?)
 end
	  end
	ensure
	  redo unless jobs.empty?
	end
  end
end

- (Boolean) waiting_job?(job)

Returns:

  • (Boolean)


176
177
178
179
180
# File 'lib/shell/process-controller.rb', line 176

def waiting_job?(job)
  @jobs_sync.synchronize(:SH) do
	@waiting_jobs.include?(job)
  end
end

- (Object) waiting_jobs



118
119
120
# File 'lib/shell/process-controller.rb', line 118

def waiting_jobs
  @waiting_jobs
end

- (Boolean) waiting_jobs_exist?

Returns:

  • (Boolean)


134
135
136
137
138
# File 'lib/shell/process-controller.rb', line 134

def waiting_jobs_exist?
  @jobs_sync.synchronize(:SH) do
	@waiting_jobs.empty?
  end
end