You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/software/devtools/index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
[](){#ref-software-devtools}
2
2
# Debugging and Performance Analysis tools
3
3
4
-
Debugging and Performance Analysis tools can assist users in developing and optimizing scientific parallel applications, especially in a high-performance computing (HPC) environment.
5
-
Efficient tools can significantly improve workflows and save valuable computational resources.
4
+
Debugging and performance analysis tools can assist users in developing and optimizing scientific parallel applications, especially in a high-performance computing (HPC) environment.
5
+
These tools can significantly improve workflows and save valuable computational resources.
6
6
7
-
CSCS provides debuggers and performance analysis tools on Alps Clusters.
7
+
CSCS provides debuggers and performance analysis tools on [Alps][ref-alps] clusters.
8
8
9
-
!!! note "get in touch"
9
+
!!! note "Get in touch"
10
10
If you have issues or questions about debugging or performance analysis tools, please do not hesitate to [contact us][ref-get-in-touch].
Copy file name to clipboardExpand all lines: docs/software/devtools/linaro-ddt.md
+20-14Lines changed: 20 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
# Linaro DDT
3
3
4
4
DDT allows source-level debugging of Fortran, C, C++ and Python codes.
5
-
It can be used for debugging serial, multi-threaded (OpenMP), multi-process (MPI) and accelerated (CUDA, OpenACC) programs running on research and production systems, including the CSCS Alps system.
5
+
It can be used for debugging serial, multi-threaded (OpenMP), multi-process (MPI), and accelerated (CUDA, OpenACC) programs running on research and production systems, including the CSCS [Alps][ref-alps] system.
6
6
DDT can be executed either with its graphical user interface or from the command-line.
7
7
8
8
!!! note
9
-
Linaro DDT is provided in the `linaro-forge` uenv.
10
-
Before using DDT, please read the [`linaro-forge` documentation][ref-uenv-linaro], which explains how to download and set up the latest version and set it up.
9
+
Linaro DDT is provided in the `linaro-forge`[uenv][ref-uenv].
10
+
Before using DDT, please read the [`linaro-forge`uenv documentation][ref-uenv-linaro], which explains how to download and set up the latest version.
Copy file name to clipboardExpand all lines: docs/software/devtools/linaro-map.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,8 @@ In the first case, the user can set the profiling configuration using the GUI an
7
7
In the latter (recommended) case, the user can use the MAP executable to launch the application they want to profile which will generate a report file that can then be opened from the locally installed [client](https://docs.linaroforge.com/latest/html/forge/forge/installing/mac_install.html).
8
8
9
9
!!! note
10
-
Linaro Map is provided in the `linaro-forge` uenv.
11
-
Before using Map, please read the [`linaro-forge` documentation][ref-uenv-linaro], which explains how to download and set up the latest version and set it up.
10
+
Linaro MAP is provided in the `linaro-forge`[uenv][ref-uenv].
11
+
Before using MAP, please read the [`linaro-forge`uenv documentation][ref-uenv-linaro], which explains how to download and set up the latest version.
[Linaro Forge](https://docs.linaroforge.com/latest/html/forge/index.html) is a suite of profiling and debugging tools, that includes the DDT debugger and the MAP profiler.
4
+
[Linaro Forge](https://docs.linaroforge.com/latest/html/forge/index.html) is a suite of profiling and debugging tools, that includes the DDT debugger and the MAP performance analysis tool.
The Linaro uenv is named `linaro-forge`, and the available versions can be determined using the `uenv image find` command:
17
+
The Linaro [uenv][ref-uenv] is named `linaro-forge`, and the available versions can be determined using the `uenv image find` command, as explained in the [uenv documentation][ref-uenv].
18
18
19
-
!!! example "finding available linaro-forge versions"
19
+
??? example "Finding available `linaro-forge` versions"
20
20
21
21
```console
22
22
$ uenv image find linaro-forge
@@ -32,21 +32,22 @@ This uenv is configured to be mounted in the `/user-tools` path so that they can
32
32
When using alongside another uenv, start a uenv session with both uenv.
33
33
In the following example, the `prgenv-gnu` and `linaro-forge` uenv will be mounted at `/user-environment` and `/user-tools` respectively:
Copyright (c) 2023-2024 Linaro Limited. All rights reserved.
47
44
Version: 24.1.1
48
45
```
49
46
47
+
1. Test that everything has been mounted correctly by looking at `uenv status`.
48
+
There will be warnings if there are problems.
49
+
2. Check that the [DDT debugger][ref-devtools-ddt] is in the path.
50
+
50
51
!!! note
51
52
The `linaro-forge` uenv is always mounted at the `/user-tools` mount point, and a script `/user-tools/activate` is provided to load both ddt and map into your environment, without needing to use a view.
52
53
@@ -61,64 +62,108 @@ Version: 24.1.1
61
62
62
63
### Install and configure the Linaro client on your local machine
63
64
64
-
We recommend installing the [desktop client](https://www.linaroforge.com/downloadForge) on your local workstation/laptop.
65
+
We recommend installing the [Linaro desktop client] on your local workstation or laptop.
65
66
It can be downloaded for a selection of operating systems.
66
-
The client can be configured to connect with the debug jobs running on Alps, offering a better user experience compared to running with X11 forwarding.
67
+
68
+
!!! warning
69
+
70
+
Make sure you download the [Linaro desktop client] matching the version of the `linaro-forge` uenv you are planning to use.
71
+
72
+
!!! example "Mismatched desktop client and uenv versions"
73
+
Mismatches between the client and the uenv version will lead to the following error when trying to establish a remote connection:
74
+
75
+
```
76
+
The local version of Linaro DDT (24.0.6) is not compatible with the remote version (24.1.1).
77
+
```
78
+
79
+
The client can be configured to connect with the debug jobs running on [Alps][ref-alps], offering a better user experience compared to running with X11 forwarding.
67
80
Once installed, the client needs to be configured to connect to the vCluster on which you are working.
68
81
69
82
First, start the client on your laptop:
70
83
71
84
=== "Linux"
72
85
73
-
The path will change if you have installed a different version, or if it has been installed in a non-standard installation location.
86
+
!!! warning
87
+
88
+
The path will change if you have installed a different version, or if it has been installed in a non-standard installation location.
74
89
75
90
```bash
76
91
$HOME/linaro/forge/24.1.1/bin/ddt
77
92
```
78
93
79
-
=== "MacOS"
94
+
=== "macOS"
80
95
81
-
The path will change if you have installed a different version, or if it has been installed in a non-standard installation location.
96
+
!!! warning
97
+
98
+
The path will change if you have installed a different version, or if it has been installed in a non-standard installation location.
99
+
Please use the appropriate path and version for your installation.
82
100
83
101
```bash
84
102
open /Applications/Linaro\ Forge\ Client\ 24.1.1.app/
85
103
```
86
104
87
105
Next, configure a connection to the target system.
88
-
Open the *Remote Launch* menu and click on *configure* then *Add*.
106
+
Open the `Remote Launch` menu and click on `Configure...` then `Add`.
89
107
Examples of the settings are below.
90
108
91
109
=== "Daint"
110
+
111
+
!!! warning
112
+
113
+
The `Remote Installation Directory` will change if you are using a different version of the `linaro-forge` uenv.
114
+
Please use the appropriate version for your setup.
@@ -129,16 +174,16 @@ Some notes on the examples above:
129
174
130
175
* SSH forwarding via `ela.cscs.ch` is used to access the cluster;
131
176
* replace the username `cscsusername` with your CSCS user name that you would normally use to open an SSH connection to CSCS;
132
-
*`Remote Installation Path` is pointing to the install directory of ddt inside the image;
177
+
*`Remote Installation Directory` is pointing to the install directory of DDT inside the uenv image;
133
178
* private keys should be the ones generated for CSCS MFA, and this field does not need to be set if you have added the key to your [SSH agent][ref-ssh-agent].
134
179
135
180
Once configured, test and save the configuration:
136
181
137
-
1. check whether the configuration is correct, click `Test Remote Launch`.
138
-
2.Click on `ok` and `close` to save the configuration.
139
-
3. You can now connect by going to `Remote Launch` and choose the `Alps` entry.
182
+
1. check whether the configuration is correct by clicking `Test Remote Launch` (and then `OK` when the test is successful),
183
+
2.click on `OK` and then `Close` to save the configuration.
184
+
3. You can now connect by going to `Remote Launch` and choose the entry (`Connection` name) you added.
140
185
If the client fails to connect, look at the error message, check your SSH
141
-
configuration and make sure you can ssh without the client.
186
+
configuration and make sure you can SSH without the client.
142
187
143
188
[](){#ref-uenv-linaro-troubleshooting}
144
189
## Troubleshooting
@@ -149,12 +194,16 @@ Notes about known issues.
149
194
150
195
If the tool fails to launch with the following error message:
151
196
152
-
Error communicating with Licence Server velan.cscs.ch:
153
-
The proxy type is invalid for this operation
154
-
Attempting again while ignoring proxies.
197
+
```
198
+
Error communicating with Licence Server velan.cscs.ch:
199
+
The proxy type is invalid for this operation
200
+
Attempting again while ignoring proxies.
201
+
```
155
202
156
203
Proxy environment variables need to be set to let the tool connect to the license server, as explained in [Compute node proxy configuration][ref-guides-internet-access].
157
204
158
205
!!! note "AMD GPU support"
159
206
160
-
CSCS does not currently have a Linaro license for AMD gpus.
207
+
CSCS does not currently have a Linaro license for AMD GPUs.
0 commit comments