12 from tempfile
import TemporaryDirectory
14 import lttng_ivc
.settings
as Settings
15 _logger
= logging
.getLogger("Runtime")
18 @contextlib.contextmanager
19 def get_runtime(runtime_dir
):
20 runtime
= Runtime(runtime_dir
)
27 class Runtime(object):
28 def __init__(self
, runtime_dir
):
30 A dictionary of popen object eg. lttng-sessiond, relayd,
31 anything really. Key is a uuid.
33 self
.__subprocess
= {}
34 self
.__stdout
_stderr
= {}
37 self
.__runtime
_log
= os
.path
.join(runtime_dir
, "log")
38 self
.__runtime
_log
_sub
= os
.path
.join(self
.__runtime
_log
, "subprocess")
41 Path of the copy of lttng_home folder after Runtime.close() is issued. This is
42 to be used for post runtime analysis and mostly debugging on error.
44 self
.__post
_runtime
_lttng
_home
_path
= os
.path
.join(runtime_dir
,
47 self
._runtime
_log
_aggregation
= os
.path
.join(self
.__runtime
_log
, "runtime.log")
49 self
._run
_command
_count
= 0
51 self
.special_env_variables
= {"LTTNG_UST_DEBUG": "1",
52 #"LTTNG_APP_SOCKET_TIMEOUT": "-1",
53 #"LTTNG_UST_REGISTER_TIMEOUT": "-1",
54 "LTTNG_NETWORK_SOCKET_TIMEOUT": "-1"}
56 # Keep a reference on the object to keep it alive. It will close/clean on
58 self
.__lttng
_home
_dir
= TemporaryDirectory(prefix
=Settings
.tmp_object_prefix
)
59 self
.lttng_home
= self
.__lttng
_home
_dir
.name
61 if len(self
.lttng_home
) > 88:
62 raise Exception("TemporaryDirectory for lttng_home is to long. Use a short TMPDIR")
64 os
.makedirs(self
.__runtime
_log
)
65 os
.makedirs(self
.__runtime
_log
_sub
)
67 def add_project(self
, project
):
68 self
.__projects
.append(project
)
70 def subprocess_signal(self
, subprocess_uuid
, signal
):
71 self
.__subproces
[subprocess_uuid
].send_signal(signal
)
73 def subprocess_terminate(self
, subprocess_uuid
, timeout
=60):
74 process
= self
.__subprocess
[subprocess_uuid
]
77 stdout
, stderr
= self
.__stdout
_stderr
[subprocess_uuid
]
82 def subprocess_kill(self
, subprocess_uuid
):
83 process
= self
.__subprocess
[subprocess_uuid
]
86 stdout
, stderr
= self
.__stdout
_stderr
[subprocess_uuid
]
91 def get_subprocess_stdout_path(self
, subprocess_uuid
):
92 stdout
, stderr
= self
.__stdout
_stderr
[subprocess_uuid
]
95 def get_subprocess_stderr_path(self
, subprocess_uuid
):
96 stdout
, stderr
= self
.__stdout
_stderr
[subprocess_uuid
]
99 def spawn_subprocess(self
, command_line
, cwd
=None):
100 args
= shlex
.split(command_line
)
103 if not os
.path
.isdir(self
.lttng_home
):
104 raise Exception("lttng home does not exist")
106 tmp_id
= uuid
.uuid1()
107 out_path
= os
.path
.join(self
.__runtime
_log
_sub
, str(tmp_id
) + ".out")
108 err_path
= os
.path
.join(self
.__runtime
_log
_sub
, str(tmp_id
) + ".err")
110 stdout
= open(out_path
, 'w')
111 stderr
= open(err_path
, 'w')
113 env_path
= os
.path
.join(self
.__runtime
_log
_sub
, str(tmp_id
) + ".env")
114 with
open(env_path
, 'w') as env_out
:
115 pprint
.pprint(env
, stream
=env_out
)
117 p
= subprocess
.Popen(args
, stdout
=stdout
, stderr
=stderr
, env
=env
)
118 self
.__subprocess
[tmp_id
] = p
119 self
.__stdout
_stderr
[tmp_id
] = (stdout
, stderr
)
120 _logger
.debug("Spawned sub pid: {} args: {} stdout: {} stderr{}".format(p
.pid
, p
.args
, out_path
, err_path
))
123 def run(self
, command_line
, cwd
=None, check_return
=True, ld_preload
=""):
125 Run the command and return a tuple of a (CompletedProcess, stdout_path,
126 stderr_path). The subprocess is already executed and returned. The
127 callecaller is responsible for checking for errors.
129 args
= shlex
.split(command_line
)
133 env
['LD_PRELOAD'] = ld_preload
136 tmp_id
= self
._run
_command
_count
137 self
._run
_command
_count
+= 1
139 cmd_map
= os
.path
.join(self
.__runtime
_log
, "cmd.map")
140 with
open(cmd_map
, 'a') as out
:
141 out
.write("{}: {}\n".format(tmp_id
, args
))
143 out_path
= os
.path
.join(self
.__runtime
_log
, str(tmp_id
) + ".out")
144 err_path
= os
.path
.join(self
.__runtime
_log
, str(tmp_id
) + ".err")
145 stdout
= open(out_path
, "w")
146 stderr
= open(err_path
, "w")
148 env_path
= os
.path
.join(self
.__runtime
_log
, str(tmp_id
) + ".env")
149 with
open(env_path
, 'w') as env_out
:
150 for key
, value
in env
.items():
151 env_out
.write('{}={}\n'.format(key
, value
))
153 cp
= subprocess
.run(args
, stdout
=stdout
, stderr
=stderr
, env
=env
, cwd
=cwd
)
154 _logger
.debug("Command #{} args: {} stdout: {} stderr{}".format(tmp_id
, cp
.args
, out_path
, err_path
))
156 # Add to the global log file. This can help a little. Leave the other
157 # file available for per-run analysis
158 with
open(self
._runtime
_log
_aggregation
, "a") as log
:
159 with
open(out_path
, "r") as out
:
160 log
.write("Output for command #{} {}\n".format(tmp_id
, command_line
))
161 log
.write("Start >>>>>>>>>>>>>>>>\n")
162 log
.write(out
.read())
163 log
.write("End <<<<<<<<<<<<<<<<\n")
164 with
open(err_path
, "r") as out
:
165 log
.write("Error for command #{} {}\n".format(tmp_id
, command_line
))
166 log
.write("Start >>>>>>>>>>>>>>>>\n")
167 log
.write(out
.read())
168 log
.write("End <<<<<<<<<<<<<<<<\n")
171 cp
.check_returncode()
173 return (cp
, out_path
, err_path
)
175 def get_cppflags(self
):
177 for project
in self
.__projects
:
178 cppflags
.append(project
.get_cppflags())
179 return " ".join(cppflags
)
181 def get_ldflags(self
):
183 for project
in self
.__projects
:
184 ldflags
.append(project
.get_ldflags())
185 return " ".join(ldflags
)
187 def get_ld_library_path(self
):
189 for project
in self
.__projects
:
190 library_path
.append(project
.get_ld_library_path())
191 return ":".join(library_path
)
193 def get_bin_path(self
):
195 for project
in self
.__projects
:
196 path
.append(project
.get_bin_path())
197 return ":".join(path
)
200 env
= os
.environ
.copy()
202 env
["LTTNG_HOME"] = self
.lttng_home
204 env_fetch
= {"CPPFLAGS": (self
.get_cppflags(), " "),
205 "LDFLAGS": (self
.get_ldflags(), " "),
206 "LD_LIBRARY_PATH": (self
.get_ld_library_path(), ":"),
207 "PATH": (self
.get_bin_path(), ":"),
209 for key
, (value
, delimiter
) in env_fetch
.items():
213 env
[key
] = delimiter
.join([value
, tmp_var
])
215 for var
, value
in self
.special_env_variables
.items():
217 # Raise for now since no special cases is known
218 _logger
.warning("% Special var % is already defined",
220 raise Exception("Multiple definition of a special environment variable")
224 for project
in self
.__projects
:
225 for var
, value
in project
.special_env_variables
.items():
227 # Raise for now since no special cases is known
228 _logger
.warning("% Special var % is already defined",
230 raise Exception("Multiple definition of a special environment variable")
236 for key
, subp
in self
.__subprocess
.items():
238 for key
, subp
in self
.__subprocess
.items():
239 # TODO move timeout to settings
240 subp
.wait(timeout
=60)
241 for key
, (stdout
, stderr
) in self
.__stdout
_stderr
.items():
245 # Copy the lttng_home used at runtime using hardlink to prevent useless
247 shutil
.copytree(self
.lttng_home
, self
.__post
_runtime
_lttng
_home
_path
, copy_function
=os
.link
)
This page took 0.037528 seconds and 5 git commands to generate.