| 1 | import pytest |
| 2 | import os |
| 3 | import shutil |
| 4 | import signal |
| 5 | import subprocess |
| 6 | |
| 7 | import lttng_ivc.utils.ProjectFactory as ProjectFactory |
| 8 | import lttng_ivc.utils.utils as utils |
| 9 | import lttng_ivc.utils.runtime as Run |
| 10 | import lttng_ivc.settings as Settings |
| 11 | |
| 12 | """ |
| 13 | |
| 14 | FC: Fully Compatible |
| 15 | BC: Feature of the smallest version number will works. |
| 16 | TU: Tracing unavailable |
| 17 | |
| 18 | NOTE: tracing between 2.7 and 2.8 should work but a problem with |
| 19 | _ustctl_basic_type prevent event registration. Hence consider in further test |
| 20 | that the event registration is expected to fail. |
| 21 | |
| 22 | +------------------------------------------------------------------------------+ |
| 23 | | LTTng UST control protocol compatibility matrix | |
| 24 | | (between applications and tools linked on LTTng UST and liblttng-ust-ctl) | |
| 25 | +--------------------------+------------+------------+------------+------------+ |
| 26 | | LTTng UST / LTTng Tools | 2.7 (6.0) | 2.8 (6.1) | 2.9 (7.1) | 2.10 (7.2) | |
| 27 | +--------------------------+------------+------------+------------+------------+ |
| 28 | | 2.7 (6.0) | FC | BC | TU | TU | |
| 29 | | 2.8 (6.1) | BC | FC | TU | TU | |
| 30 | | 2.9 (7.1) | TU | TU | FC | BC | |
| 31 | | 2.10 (7.2) | TU | TU | BC | FC | |
| 32 | +--------------------------+------------+------------+------------+------------+ |
| 33 | |
| 34 | Version number of this API is defined in include/lttng/ust-abi.h of lttng-ust project |
| 35 | |
| 36 | """ |
| 37 | |
| 38 | """ |
| 39 | First tuple member: lttng-ust label |
| 40 | Second tuple member: lttng-tool label |
| 41 | Third tuple member: expected scenario |
| 42 | """ |
| 43 | |
| 44 | event_registration_error = "Error: UST app recv reg unsupported version" |
| 45 | |
| 46 | test_matrix_tracing_available = [ |
| 47 | ("lttng-ust-2.7", "lttng-tools-2.7", "Success"), |
| 48 | ("lttng-ust-2.7", "lttng-tools-2.8", "Unsupported version"), |
| 49 | ("lttng-ust-2.7", "lttng-tools-2.9", "Unsupported"), |
| 50 | ("lttng-ust-2.7", "lttng-tools-2.10", "Unsupported"), |
| 51 | ("lttng-ust-2.8", "lttng-tools-2.7", "Unsupported version"), |
| 52 | ("lttng-ust-2.8", "lttng-tools-2.8", "Success"), |
| 53 | ("lttng-ust-2.8", "lttng-tools-2.9", "Unsupported"), |
| 54 | ("lttng-ust-2.8", "lttng-tools-2.10", "Unsupported"), |
| 55 | ("lttng-ust-2.9", "lttng-tools-2.7", "Unsupported"), |
| 56 | ("lttng-ust-2.9", "lttng-tools-2.8", "Unsupported"), |
| 57 | ("lttng-ust-2.9", "lttng-tools-2.9", "Success"), |
| 58 | ("lttng-ust-2.9", "lttng-tools-2.10", "Success"), |
| 59 | ("lttng-ust-2.10", "lttng-tools-2.7", "Unsupported"), |
| 60 | ("lttng-ust-2.10", "lttng-tools-2.8", "Unsupported"), |
| 61 | ("lttng-ust-2.10", "lttng-tools-2.9", "Success"), |
| 62 | ("lttng-ust-2.10", "lttng-tools-2.10", "Success"), |
| 63 | ] |
| 64 | |
| 65 | # Only consider test case for which tracing is valid |
| 66 | test_matrix_app_context = [ |
| 67 | ("lttng-ust-2.7", "lttng-tools-2.7", ""), |
| 68 | ("lttng-ust-2.7", "lttng-tools-2.8", ""), |
| 69 | ("lttng-ust-2.7", "lttng-tools-2.9", ""), |
| 70 | ("lttng-ust-2.7", "lttng-tools-2.10", ""), |
| 71 | ("lttng-ust-2.8", "lttng-tools-2.7", ""), |
| 72 | ("lttng-ust-2.8", "lttng-tools-2.8", ""), |
| 73 | ("lttng-ust-2.8", "lttng-tools-2.9", ""), |
| 74 | ("lttng-ust-2.8", "lttng-tools-2.10", ""), |
| 75 | ("lttng-ust-2.9", "lttng-tools-2.7", ""), |
| 76 | ("lttng-ust-2.9", "lttng-tools-2.8", ""), |
| 77 | ("lttng-ust-2.9", "lttng-tools-2.9", ""), |
| 78 | ("lttng-ust-2.9", "lttng-tools-2.10", ""), |
| 79 | ("lttng-ust-2.10", "lttng-tools-2.7", ""), |
| 80 | ("lttng-ust-2.10", "lttng-tools-2.8", ""), |
| 81 | ("lttng-ust-2.10", "lttng-tools-2.9", ""), |
| 82 | ("lttng-ust-2.10", "lttng-tools-2.10", ""), |
| 83 | ] |
| 84 | |
| 85 | """ |
| 86 | Statedump are supported starting at lttng-ust >= 2.9. |
| 87 | No need to test for prior lttng-ust givent that there is also a bump leading to |
| 88 | loss of tracing for application running under lttng-ust < 2.9. |
| 89 | """ |
| 90 | test_matrix_regen_statedump = [ |
| 91 | ("lttng-ust-2.9", "lttng-tools-2.9", True), |
| 92 | ("lttng-ust-2.9", "lttng-tools-2.10", True), |
| 93 | ("lttng-ust-2.10", "lttng-tools-2.9", True), |
| 94 | ("lttng-ust-2.10", "lttng-tools-2.10", True), |
| 95 | ] |
| 96 | |
| 97 | test_matrix_starglobing_enabler = [ |
| 98 | ("lttng-ust-2.9", "lttng-tools-2.9", "Unsupported by tools"), |
| 99 | ("lttng-ust-2.9", "lttng-tools-2.10", "Unsupported by ust"), |
| 100 | ("lttng-ust-2.10", "lttng-tools-2.9", "Unsupported by tools"), |
| 101 | ("lttng-ust-2.10", "lttng-tools-2.10", "Supported"), |
| 102 | ] |
| 103 | |
| 104 | runtime_matrix_tracing_available = [] |
| 105 | runtime_matrix_regen_statedump = [] |
| 106 | runtime_rix_starglobing_enabler = [] |
| 107 | |
| 108 | if not Settings.test_only: |
| 109 | runtime_matrix_tracing_available = test_matrix_tracing_available |
| 110 | runtime_matrix_regen_statedump = test_matrix_regen_statedump |
| 111 | runtime_matrix_starglobing_enabler = test_matrix_starglobing_enabler |
| 112 | else: |
| 113 | for tup in test_matrix_tracing_available: |
| 114 | if (tup[0] in Settings.test_only or tup[1] in |
| 115 | Settings.test_only): |
| 116 | runtime_matrix_tracing_available.append(tup) |
| 117 | for tup in test_matrix_regen_statedump: |
| 118 | if (tup[0] in Settings.test_only or tup[1] in |
| 119 | Settings.test_only): |
| 120 | runtime_matrix_regen_statedump.append(tup) |
| 121 | for tup in test_matrix_starglobing_enabler: |
| 122 | if (tup[0] in Settings.test_only or tup[1] in |
| 123 | Settings.test_only): |
| 124 | runtime_matrix_starglobing_enabler.append(tup) |
| 125 | |
| 126 | |
| 127 | @pytest.mark.parametrize("ust_label,tools_label,outcome", runtime_matrix_tracing_available) |
| 128 | def test_ust_app_tracing_available(tmpdir, ust_label, tools_label, outcome): |
| 129 | |
| 130 | nb_events = 100 |
| 131 | |
| 132 | # Prepare environment |
| 133 | ust = ProjectFactory.get_precook(ust_label) |
| 134 | tools = ProjectFactory.get_precook(tools_label) |
| 135 | babeltrace = ProjectFactory.get_precook(Settings.default_babeltrace) |
| 136 | |
| 137 | tools_runtime_path = os.path.join(str(tmpdir), "tools") |
| 138 | ust_runtime_path = os.path.join(str(tmpdir), "ust") |
| 139 | app_path = os.path.join(str(tmpdir), "app") |
| 140 | |
| 141 | with Run.get_runtime(ust_runtime_path) as runtime_app, Run.get_runtime(tools_runtime_path) as runtime_tools: |
| 142 | runtime_tools.add_project(tools) |
| 143 | runtime_tools.add_project(babeltrace) |
| 144 | |
| 145 | runtime_app.add_project(ust) |
| 146 | runtime_app.lttng_home = runtime_tools.lttng_home |
| 147 | |
| 148 | trace_path = os.path.join(runtime_tools.lttng_home, 'trace') |
| 149 | |
| 150 | # Make application using the ust runtime |
| 151 | shutil.copytree(Settings.apps_gen_events_folder, app_path) |
| 152 | runtime_app.run("make V=1", cwd=app_path) |
| 153 | |
| 154 | # Start lttng-sessiond |
| 155 | sessiond = utils.sessiond_spawn(runtime_tools) |
| 156 | |
| 157 | # Create session using mi to get path and session name |
| 158 | runtime_tools.run('lttng create trace --output={}'.format(trace_path)) |
| 159 | |
| 160 | runtime_tools.run('lttng enable-event -u tp:tptest') |
| 161 | runtime_tools.run('lttng start') |
| 162 | |
| 163 | # Run application |
| 164 | cmd = './app {}'.format(nb_events) |
| 165 | runtime_app.run(cmd, cwd=app_path) |
| 166 | |
| 167 | # Stop tracing |
| 168 | runtime_tools.run('lttng destroy -a') |
| 169 | cp = runtime_tools.subprocess_terminate(sessiond) |
| 170 | if cp.returncode != 0: |
| 171 | pytest.fail("Sessiond return code") |
| 172 | |
| 173 | |
| 174 | cmd = 'babeltrace {}'.format(trace_path) |
| 175 | if outcome == "Success": |
| 176 | cp_process, cp_out, cp_err = runtime_tools.run(cmd) |
| 177 | assert(utils.line_count(cp_out) == nb_events) |
| 178 | else: |
| 179 | with pytest.raises(subprocess.CalledProcessError): |
| 180 | cp_process, cp_out, cp_err = runtime_tools.run(cmd) |
| 181 | if outcome == "Unsupported version": |
| 182 | assert(utils.file_contains(runtime_tools.get_subprocess_stderr_path(sessiond), |
| 183 | [event_registration_error])) |
| 184 | |
| 185 | @pytest.mark.parametrize("ust_label,tools_label, success", runtime_matrix_regen_statedump) |
| 186 | def test_ust_app_regen_statedump(tmpdir, ust_label, tools_label, success): |
| 187 | nb_events = 100 |
| 188 | |
| 189 | if success: |
| 190 | expected_events = 4 |
| 191 | else: |
| 192 | expected_events = 2 |
| 193 | |
| 194 | ust = ProjectFactory.get_precook(ust_label) |
| 195 | tools = ProjectFactory.get_precook(tools_label) |
| 196 | babeltrace = ProjectFactory.get_precook(Settings.default_babeltrace) |
| 197 | |
| 198 | tools_runtime_path = os.path.join(str(tmpdir), "tools") |
| 199 | ust_runtime_path = os.path.join(str(tmpdir), "ust") |
| 200 | app_path = os.path.join(str(tmpdir), "app") |
| 201 | |
| 202 | |
| 203 | app_sync_start = os.path.join(app_path, 'sync_start') |
| 204 | app_sync_end = os.path.join(app_path, 'sync_end') |
| 205 | |
| 206 | with Run.get_runtime(ust_runtime_path) as runtime_app, Run.get_runtime(tools_runtime_path) as runtime_tools: |
| 207 | runtime_tools.add_project(tools) |
| 208 | runtime_tools.add_project(babeltrace) |
| 209 | |
| 210 | runtime_app.add_project(ust) |
| 211 | runtime_app.lttng_home = runtime_tools.lttng_home |
| 212 | |
| 213 | trace_path = os.path.join(runtime_tools.lttng_home, 'trace') |
| 214 | |
| 215 | # Make application using the ust runtime |
| 216 | shutil.copytree(Settings.apps_gen_events_folder, app_path) |
| 217 | runtime_app.run("make V=1", cwd=app_path) |
| 218 | |
| 219 | # Start lttng-sessiond |
| 220 | sessiond = utils.sessiond_spawn(runtime_tools) |
| 221 | |
| 222 | # Create session using mi to get path and session name |
| 223 | runtime_tools.run('lttng create trace --output={}'.format(trace_path)) |
| 224 | |
| 225 | runtime_tools.run('lttng enable-event -u lttng_ust_statedump:start,lttng_ust_statedump:end') |
| 226 | runtime_tools.run('lttng start') |
| 227 | |
| 228 | # Run application |
| 229 | cmd = './app {} 0 {} {}'.format(nb_events, app_sync_start, app_sync_end) |
| 230 | runtime_app.spawn_subprocess(cmd, cwd=app_path) |
| 231 | |
| 232 | utils.wait_for_file(app_sync_start) |
| 233 | |
| 234 | if not success: |
| 235 | with pytest.raises(subprocess.CalledProcessError): |
| 236 | runtime_tools.run('lttng regenerate statedump') |
| 237 | else: |
| 238 | runtime_tools.run('lttng regenerate statedump') |
| 239 | |
| 240 | utils.create_empty_file(app_sync_end) |
| 241 | |
| 242 | # Stop tracing |
| 243 | runtime_tools.run('lttng destroy -a') |
| 244 | cp = runtime_tools.subprocess_terminate(sessiond) |
| 245 | if cp.returncode != 0: |
| 246 | pytest.fail("Sessiond return code") |
| 247 | |
| 248 | # Read trace with babeltrace and check for event count via number of line |
| 249 | cmd = 'babeltrace {}'.format(trace_path) |
| 250 | cp_process, cp_out, cp_err = runtime_tools.run(cmd) |
| 251 | assert(utils.line_count(cp_out) == expected_events) |
| 252 | |
| 253 | @pytest.mark.parametrize("ust_label,tools_label, scenario", runtime_matrix_starglobing_enabler) |
| 254 | def test_ust_app_starglobing_enabler(tmpdir, ust_label, tools_label, scenario): |
| 255 | |
| 256 | nb_events = 100 |
| 257 | |
| 258 | if scenario == "Unsupported by ust": |
| 259 | expected_events = 0 |
| 260 | else: |
| 261 | expected_events = nb_events |
| 262 | |
| 263 | # Prepare environment |
| 264 | ust = ProjectFactory.get_precook(ust_label) |
| 265 | tools = ProjectFactory.get_precook(tools_label) |
| 266 | babeltrace = ProjectFactory.get_precook(Settings.default_babeltrace) |
| 267 | |
| 268 | tools_runtime_path = os.path.join(str(tmpdir), "tools") |
| 269 | ust_runtime_path = os.path.join(str(tmpdir), "ust") |
| 270 | app_path = os.path.join(str(tmpdir), "app") |
| 271 | |
| 272 | with Run.get_runtime(ust_runtime_path) as runtime_app, Run.get_runtime(tools_runtime_path) as runtime_tools: |
| 273 | runtime_tools.add_project(tools) |
| 274 | runtime_tools.add_project(babeltrace) |
| 275 | |
| 276 | runtime_app.add_project(ust) |
| 277 | runtime_app.lttng_home = runtime_tools.lttng_home |
| 278 | |
| 279 | trace_path = os.path.join(runtime_tools.lttng_home, 'trace') |
| 280 | |
| 281 | # Make application using the ust runtime |
| 282 | shutil.copytree(Settings.apps_gen_events_folder, app_path) |
| 283 | runtime_app.run("make V=1", cwd=app_path) |
| 284 | |
| 285 | # Start lttng-sessiond |
| 286 | sessiond = utils.sessiond_spawn(runtime_tools) |
| 287 | |
| 288 | # Create session using mi to get path and session name |
| 289 | runtime_tools.run('lttng create trace --output={}'.format(trace_path)) |
| 290 | |
| 291 | # If unsupported by tools simply finish early |
| 292 | if scenario == "Unsupported by tools": |
| 293 | with pytest.raises(subprocess.CalledProcessError): |
| 294 | runtime_tools.run('lttng enable-event -u "tp:*te*"') |
| 295 | |
| 296 | # TODO move this to internal runtime... |
| 297 | cp = runtime_tools.subprocess_terminate(sessiond) |
| 298 | if cp.returncode != 0: |
| 299 | pytest.fail("Sessiond return code") |
| 300 | return |
| 301 | else: |
| 302 | runtime_tools.run('lttng enable-event -u "tp:*te*"') |
| 303 | |
| 304 | runtime_tools.run('lttng start') |
| 305 | |
| 306 | # Run application |
| 307 | cmd = './app {}'.format(nb_events) |
| 308 | runtime_app.run(cmd, cwd=app_path) |
| 309 | |
| 310 | # Stop tracing |
| 311 | runtime_tools.run('lttng destroy -a') |
| 312 | cp = runtime_tools.subprocess_terminate(sessiond) |
| 313 | if cp.returncode != 0: |
| 314 | pytest.fail("Sessiond return code") |
| 315 | |
| 316 | # Read trace with babeltrace and check for event count via number of line |
| 317 | cmd = 'babeltrace {}'.format(trace_path) |
| 318 | cp_process, cp_out, cp_err = runtime_tools.run(cmd) |
| 319 | assert(utils.line_count(cp_out) == expected_events) |