1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
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
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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408 | -----------------------------------------------------------------------
-- util-processes -- Process creation and control
-- Copyright (C) 2011, 2016, 2018, 2021, 2022 Stephane Carrez
-- Written by Stephane Carrez (Stephane.Carrez@gmail.com)
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
-----------------------------------------------------------------------
with Ada.Unchecked_Deallocation;
with Ada.Environment_Variables;
with Util.Log.Loggers;
with Util.Strings;
with Util.Processes.Os;
package body Util.Processes is
use Util.Log;
use Ada.Strings.Unbounded;
-- The logger
Log : constant Loggers.Logger := Loggers.Create ("Util.Processes");
procedure Free is
new Ada.Unchecked_Deallocation (Object => Util.Processes.System_Process'Class,
Name => Util.Processes.System_Process_Access);
procedure Free is
new Ada.Unchecked_Deallocation (Object => File_Type_Array,
Name => File_Type_Array_Access);
-- ------------------------------
-- Before launching the process, redirect the input stream of the process
-- to the specified file.
-- ------------------------------
procedure Set_Input_Stream (Proc : in out Process;
File : in String) is
begin
if Proc.Is_Running then
Log.Error ("Cannot set input stream to {0} while process is running", File);
raise Invalid_State with "Process is running";
end if;
Proc.In_File := To_Unbounded_String (File);
end Set_Input_Stream;
-- ------------------------------
-- Set the output stream of the process.
-- ------------------------------
procedure Set_Output_Stream (Proc : in out Process;
File : in String;
Append : in Boolean := False) is
begin
if Proc.Is_Running then
Log.Error ("Cannot set output stream to {0} while process is running", File);
raise Invalid_State with "Process is running";
end if;
Proc.Out_File := To_Unbounded_String (File);
Proc.Out_Append := Append;
end Set_Output_Stream;
-- ------------------------------
-- Set the error stream of the process.
-- ------------------------------
procedure Set_Error_Stream (Proc : in out Process;
File : in String;
Append : in Boolean := False) is
begin
if Proc.Is_Running then
Log.Error ("Cannot set error stream to {0} while process is running", File);
raise Invalid_State with "Process is running";
end if;
Proc.Err_File := To_Unbounded_String (File);
Proc.Err_Append := Append;
end Set_Error_Stream;
-- ------------------------------
-- Set the working directory that the process will use once it is created.
-- The directory must exist or the <b>Invalid_Directory</b> exception will be raised.
-- ------------------------------
procedure Set_Working_Directory (Proc : in out Process;
Path : in String) is
begin
if Proc.Is_Running then
Log.Error ("Cannot set working directory to {0} while process is running", Path);
raise Invalid_State with "Process is running";
end if;
Proc.Dir := To_Unbounded_String (Path);
end Set_Working_Directory;
-- ------------------------------
-- Set the shell executable path to use to launch a command. The default on Unix is
-- the /bin/sh command. Argument splitting is done by the /bin/sh -c command.
-- When setting an empty shell command, the argument splitting is done by the
-- <tt>Spawn</tt> procedure.
-- ------------------------------
procedure Set_Shell (Proc : in out Process;
Shell : in String) is
begin
if Proc.Is_Running then
Log.Error ("Cannot set shell to {0} while process is running", Shell);
raise Invalid_State with "Process is running";
end if;
Proc.Shell := To_Unbounded_String (Shell);
end Set_Shell;
-- ------------------------------
-- Closes the given file descriptor in the child process before executing the command.
-- ------------------------------
procedure Add_Close (Proc : in out Process;
Fd : in File_Type) is
List : File_Type_Array_Access;
begin
if Proc.To_Close /= null then
List := new File_Type_Array (1 .. Proc.To_Close'Last + 1);
List (1 .. Proc.To_Close'Last) := Proc.To_Close.all;
List (List'Last) := Fd;
Free (Proc.To_Close);
else
List := new File_Type_Array (1 .. 1);
List (1) := Fd;
end if;
Proc.To_Close := List;
end Add_Close;
-- ------------------------------
-- Append the argument to the current process argument list.
-- Raises <b>Invalid_State</b> if the process is running.
-- ------------------------------
procedure Append_Argument (Proc : in out Process;
Arg : in String) is
begin
if Proc.Is_Running then
Log.Error ("Cannot add argument '{0}' while process is running", Arg);
raise Invalid_State with "Process is running";
end if;
Proc.Sys.Append_Argument (Arg);
end Append_Argument;
-- ------------------------------
-- Set the environment variable to be used by the process before its creation.
-- ------------------------------
procedure Set_Environment (Proc : in out Process;
Name : in String;
Value : in String) is
begin
if Proc.Is_Running then
Log.Error ("Cannot set environment '{0}' while process is running", Name);
raise Invalid_State with "Process is running";
end if;
Proc.Sys.Set_Environment (Name, Value);
end Set_Environment;
procedure Set_Environment (Proc : in out Process;
Iterate : not null access
procedure
(Process : not null access procedure
(Name : in String;
Value : in String))) is
procedure Process (Name, Value : in String);
procedure Process (Name, Value : in String) is
begin
Proc.Sys.Set_Environment (Name, Value);
end Process;
begin
if Proc.Is_Running then
Log.Error ("Cannot set environment while process is running");
raise Invalid_State with "Process is running";
end if;
Iterate (Process'Access);
end Set_Environment;
-- ------------------------------
-- Import the default environment variables from the current process.
-- ------------------------------
procedure Set_Default_Environment (Proc : in out Process) is
begin
Set_Environment (Proc, Ada.Environment_Variables.Iterate'Access);
end Set_Default_Environment;
-- ------------------------------
-- Spawn a new process with the given command and its arguments. The standard input, output
-- and error streams are either redirected to a file or to a stream object.
-- ------------------------------
procedure Spawn (Proc : in out Process;
Command : in String;
Arguments : in Argument_List;
Mode : in Pipe_Mode := NONE) is
begin
if Is_Running (Proc) then
raise Invalid_State with "A process is running";
end if;
Log.Info ("Starting process {0}", Command);
Proc.Sys.Clear_Arguments;
-- Build the argc/argv table, terminated by NULL
Proc.Sys.Append_Argument (Command);
for I in Arguments'Range loop
Proc.Sys.Append_Argument (Arguments (I).all);
end loop;
Spawn (Proc, Mode);
end Spawn;
procedure Spawn (Proc : in out Process;
Arguments : in Util.Strings.Vectors.Vector;
Mode : in Pipe_Mode := NONE) is
Command : constant String := Arguments.First_Element;
begin
if Is_Running (Proc) then
raise Invalid_State with "A process is running";
end if;
Log.Info ("Starting process {0}", Command);
Proc.Sys.Clear_Arguments;
-- Build the argc/argv table, terminated by NULL
for Argument of Arguments loop
Proc.Sys.Append_Argument (Argument);
end loop;
Spawn (Proc, Mode);
end Spawn;
-- ------------------------------
-- Spawn a new process with the given command and its arguments. The standard input, output
-- and error streams are either redirected to a file or to a stream object.
-- ------------------------------
procedure Spawn (Proc : in out Process;
Command : in String;
Mode : in Pipe_Mode := NONE) is
begin
if Is_Running (Proc) then
raise Invalid_State with "A process is running";
end if;
Log.Info ("Starting process {0}", Command);
Proc.Sys.Clear_Arguments;
if Length (Proc.Shell) > 0 then
Proc.Sys.Append_Argument (To_String (Proc.Shell));
Proc.Sys.Append_Argument ("-c");
Proc.Sys.Append_Argument (Command);
else
declare
Pos : Natural := Command'First;
N : Natural;
begin
-- Build the argc/argv table
while Pos <= Command'Last loop
N := Util.Strings.Index (Command, ' ', Pos);
if N = 0 then
N := Command'Last + 1;
end if;
Proc.Sys.Append_Argument (Command (Pos .. N - 1));
Pos := N + 1;
end loop;
end;
end if;
Spawn (Proc, Mode);
end Spawn;
-- ------------------------------
-- Spawn a new process with the given command and its arguments. The standard input, output
-- and error streams are either redirected to a file or to a stream object.
-- ------------------------------
procedure Spawn (Proc : in out Process;
Mode : in Pipe_Mode := NONE) is
begin
if Is_Running (Proc) then
raise Invalid_State with "A process is running";
end if;
-- Prepare to redirect the input/output/error streams.
-- The pipe mode takes precedence and will override these redirections.
Proc.Sys.Set_Streams (Input => To_String (Proc.In_File),
Output => To_String (Proc.Out_File),
Error => To_String (Proc.Err_File),
Append_Output => Proc.Out_Append,
Append_Error => Proc.Err_Append,
To_Close => Proc.To_Close);
-- System specific spawn
Proc.Exit_Value := -1;
Proc.Sys.Spawn (Proc, Mode);
end Spawn;
-- ------------------------------
-- Wait for the process to terminate.
-- ------------------------------
procedure Wait (Proc : in out Process) is
begin
if not Is_Running (Proc) then
return;
end if;
Log.Info ("Waiting for process {0}", Process_Identifier'Image (Proc.Pid));
Proc.Sys.Wait (Proc, -1.0);
end Wait;
-- ------------------------------
-- Terminate the process by sending a signal on Unix and exiting the process on Windows.
-- This operation is not portable and has a different behavior between Unix and Windows.
-- Its intent is to stop the process.
-- ------------------------------
procedure Stop (Proc : in out Process;
Signal : in Positive := 15) is
begin
if Is_Running (Proc) then
Proc.Sys.Stop (Proc, Signal);
end if;
end Stop;
-- ------------------------------
-- Get the process exit status.
-- ------------------------------
function Get_Exit_Status (Proc : in Process) return Integer is
begin
return Proc.Exit_Value;
end Get_Exit_Status;
-- ------------------------------
-- Get the process identifier.
-- ------------------------------
function Get_Pid (Proc : in Process) return Process_Identifier is
begin
return Proc.Pid;
end Get_Pid;
-- ------------------------------
-- Returns True if the process is running.
-- ------------------------------
function Is_Running (Proc : in Process) return Boolean is
begin
return Proc.Pid > 0 and then Proc.Exit_Value < 0;
end Is_Running;
-- ------------------------------
-- Get the process input stream allowing to write on the process standard input.
-- ------------------------------
function Get_Input_Stream (Proc : in Process) return Util.Streams.Output_Stream_Access is
begin
return Proc.Input;
end Get_Input_Stream;
-- ------------------------------
-- Get the process output stream allowing to read the process standard output.
-- ------------------------------
function Get_Output_Stream (Proc : in Process) return Util.Streams.Input_Stream_Access is
begin
return Proc.Output;
end Get_Output_Stream;
-- ------------------------------
-- Get the process error stream allowing to read the process standard output.
-- ------------------------------
function Get_Error_Stream (Proc : in Process) return Util.Streams.Input_Stream_Access is
begin
return Proc.Error;
end Get_Error_Stream;
-- ------------------------------
-- Initialize the process instance.
-- ------------------------------
overriding
procedure Initialize (Proc : in out Process) is
begin
Proc.Sys := new Util.Processes.Os.System_Process;
Proc.Shell := To_Unbounded_String (Util.Processes.Os.SHELL);
end Initialize;
-- ------------------------------
-- Deletes the process instance.
-- ------------------------------
overriding
procedure Finalize (Proc : in out Process) is
procedure Free is
new Ada.Unchecked_Deallocation (Object => Util.Streams.Input_Stream'Class,
Name => Util.Streams.Input_Stream_Access);
procedure Free is
new Ada.Unchecked_Deallocation (Object => Util.Streams.Output_Stream'Class,
Name => Util.Streams.Output_Stream_Access);
begin
if Proc.Sys /= null then
Proc.Sys.Finalize;
Free (Proc.Sys);
end if;
Free (Proc.Input);
Free (Proc.Output);
Free (Proc.Error);
Free (Proc.To_Close);
end Finalize;
end Util.Processes;
|