1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2017 Dave Love <fx@gnu.org>
3 ;;; Copyright © 2018 Tobias Geerinckx-Rice <me@tobias.gr>
5 ;;; This file is part of GNU Guix.
7 ;;; GNU Guix is free software; you can redistribute it and/or modify it
8 ;;; under the terms of the GNU General Public License as published by
9 ;;; the Free Software Foundation; either version 3 of the License, or (at
10 ;;; your option) any later version.
12 ;;; GNU Guix is distributed in the hope that it will be useful, but
13 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;;; GNU General Public License for more details.
17 ;;; You should have received a copy of the GNU General Public License
18 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
20 (define-module (gnu packages profiling)
21 #:use-module (guix packages)
22 #:use-module ((guix licenses) #:prefix license:) ; avoid zlib, expat clashes
23 #:use-module (guix download)
24 #:use-module (guix utils)
25 #:use-module (guix build-system gnu)
26 #:use-module (gnu packages)
27 #:use-module (gnu packages autotools)
28 #:use-module (gnu packages base) ;for "which"
29 #:use-module (gnu packages bison)
30 #:use-module (gnu packages compression)
31 #:use-module (gnu packages documentation)
32 #:use-module (gnu packages fabric-management)
33 #:use-module (gnu packages flex)
34 #:use-module (gnu packages gawk)
35 #:use-module (gnu packages gcc)
36 #:use-module (gnu packages glib)
37 #:use-module (gnu packages libunwind)
38 #:use-module (gnu packages linux)
39 #:use-module (gnu packages mpi)
40 #:use-module (gnu packages ncurses)
41 #:use-module (gnu packages perl)
42 #:use-module (gnu packages perl)
43 #:use-module (gnu packages python)
44 #:use-module (gnu packages qt))
46 ;; Fixme: Separate out lib and fix resulting cycle errors; separate libpfm
47 ;; output(?); build libmsr and add that component.
55 (uri (string-append "http://icl.utk.edu/projects/papi/downloads/papi-"
57 (sha256 (base32 "1m62s8fkjjgq04ayf18jcxc33rqfd7nrkdw1gr54q5pn4cijrp29"))))
58 (build-system gnu-build-system)
60 `(("ncurses" ,ncurses)
61 ("lm-sensors" ,lm-sensors "lib")
62 ("rdma-core" ,rdma-core)
63 ("infiniband-diags" ,infiniband-diags "lib")
64 ("net-tools" ,net-tools)))
66 `(("autoconf" ,autoconf)
67 ("gfortran" ,gfortran)))
69 `(#:tests? #f ; no check target
71 ;; These are roughly per Fedora, but elide mx (assumed to be dead, even
72 ;; Open-MX) and add and powercap -- I don't know the pros/cons of
73 ;; infiniband and infiniband_mad, but you can't use them together, and
74 ;; the umad version needs at least one patch.
75 ;; Implicit enabled components: perf_event perf_event_uncore
76 `("--with-perf-events" "--with-shared-lib=yes" "--with-shlib"
77 "--with-static-lib=no"
78 "--with-components=appio coretemp example lustre micpower net rapl \
79 stealtime lmsensors infiniband powercap"
80 ;; So utils get rpath set correctly:
81 ,(string-append "LDFLAGS=-Xlinker -rpath -Xlinker "
82 (assoc-ref %outputs "out") "/lib"))
84 (modify-phases %standard-phases
85 (add-before 'configure 'autoconf
90 ;; Amalgamating with the following clause gives double substitution.
91 (add-before 'patch-source-shebangs 'patch-components
93 (with-directory-excursion "src/components"
94 (substitute* '("lmsensors/configure" "infiniband_umad/configure")
95 (("/bin/sh") (which "sh"))))
97 (add-after 'configure 'components
98 (lambda* (#:key inputs #:allow-other-keys)
99 (with-directory-excursion "components"
100 (with-directory-excursion "infiniband_umad"
101 (invoke "./configure"))
102 (with-directory-excursion "lmsensors"
103 (let ((base (assoc-ref inputs "lm-sensors")))
104 (invoke "./configure"
105 (string-append "--with-sensors_incdir="
106 base "/include/sensors")
107 (string-append "--with-sensors_libdir="
110 (add-after 'install 'extra-doc
111 (lambda* (#:key outputs #:allow-other-keys)
112 (let ((doc (string-append (assoc-ref outputs "out")
113 "/share/doc/" ,name "-" ,version)))
114 (chdir "..") ; we went into src above
115 (for-each (lambda (file)
116 (install-file file doc))
117 '("README" "RELEASENOTES.txt"))
119 (home-page "http://icl.cs.utk.edu/papi/")
120 (synopsis "Performance Application Programming Interface")
122 "PAPI provides the tool designer and application engineer with a consistent
123 interface and methodology for use of the performance counter hardware found in
124 most major microprocessors. PAPI enables software engineers to see, in near
125 real time, the relation between software performance and processor events.
127 In addition, PAPI provides access to a collection of components that expose
128 performance measurement opportunites across the hardware and software stack.")
129 ;; See Debian papi copyright file.
130 (license (list license:bsd-3
131 license:lgpl2.1+ ;src/components/infiniband/pscanf.h
132 ;; not used in output
133 license:gpl2+ ;src/components/appio/tests/iozone/gengnuplot.sh
134 ;src/libpfm-3.y/*/multiplex*
135 ;; "BSD-like": src/libpfm-3.y/*, src/libpfm4/*
136 ;; lgpl2.1+: src/perfctr-2.*/*
139 ;; NB. there's a potential name clash with libotf.
147 (uri (string-append "http://www.vi-hps.org/upload/packages/otf2/otf2-"
149 (sha256 (base32 "1lyaqhdfaqm1kd23yk71g71vkscw83s7m57j017y768h8sh8xlwa"))))
150 (native-inputs `(("python" ,python)))
151 (outputs '("doc" ; 18MB
154 (build-system gnu-build-system)
156 `(#:configure-flags '("--enable-shared" "--disable-static")
158 (modify-phases %standard-phases
159 (add-after 'install 'licence
160 (lambda* (#:key outputs #:allow-other-keys)
161 (for-each (lambda (output)
162 (let ((doc (string-append (assoc-ref outputs output)
164 (install-file "COPYING" doc)))
167 (home-page "http://www.vi-hps.org/projects/score-p/")
168 (synopsis "Open Trace Format 2 library")
169 (description "The Open Trace Format 2 (OTF2) is a scalable, memory
170 efficient event trace data format plus support library.")
171 (license license:bsd-3)))
173 (define-public opari2
180 (uri (let* ((parts (string-split version #\.) )
182 (minor (cadr parts)))
183 (string-append "http://www.vi-hps.org/upload/packages/opari2/opari2-"
185 (sha256 (base32 "1ph8l5c646bm9l5vcn8rrbjvkyi7y8yvn2ny95r6kmlzs766g3q8"))))
186 (build-system gnu-build-system)
187 (inputs `(("gfortran" ,gfortran)))
188 (native-inputs `(("gawk" ,gawk) ;for tests
192 (modify-phases %standard-phases
193 (add-after 'install 'licence
194 (lambda* (#:key outputs #:allow-other-keys)
195 (let ((doc (string-append (assoc-ref outputs "out")
196 "/share/doc/opari2")))
197 (install-file "COPYING" doc)
199 (home-page "http://www.vi-hps.org/projects/score-p")
200 (synopsis "OpenMP runtime performance measurement instrumenter")
201 (description "OPARI2 is a source-to-source instrumentation tool for OpenMP
202 and hybrid codes. It surrounds OpenMP directives and runtime library calls
203 with calls to the POMP2 measurement interface.")
204 (license license:bsd-3)))
214 "http://apps.fz-juelich.de/scalasca/releases/cube/4.3/dist/cube-"
216 (sha256 (base32 "04irflia4rfw02093w9nx7rr98r640y4q8hisjywvd4b7r3nzhhx"))
217 (patches (search-patches "cube-nocheck.patch"))))
218 (inputs `(("dbus" ,dbus)
220 (native-inputs `(("perl" ,perl)
221 ("qtbase" ,qtbase) ; native because of qmake
224 ;; FIXME: The doc is 14MB, but adding a doc output results in a cycle.
225 (outputs '("out" ;"doc"
228 (build-system gnu-build-system)
231 `("--enable-shared" "--disable-static" "--disable-silent-rules"
232 ,(string-append "LDFLAGS=-L" (assoc-ref %outputs "lib") "/lib"))
235 (modify-phases %standard-phases
236 (add-after 'configure 'rpath
237 ;; Account for moving GUI stuff
238 (lambda* (#:key outputs #:allow-other-keys)
239 (let ((wl (string-append "-Wl,-rpath=" (assoc-ref outputs "out")
241 (substitute* "build-backend/Makefile"
242 (("^cube_LDFLAGS =") (string-append "cube_LDFLAGS = " wl))
243 (("^libheatmap_plugin_la_LDFLAGS =")
244 (string-append "libheatmap_plugin_la_LDFLAGS = " wl))
245 (("^libbarplot_plugin_la_LDFLAGS =")
246 (string-append "libbarplot_plugin_la_LDFLAGS = " wl)))
248 (add-before 'install 'includes-cube
249 ;; It tries to install here before include exists.
250 (lambda* (#:key outputs #:allow-other-keys)
251 (let ((inc (string-append (assoc-ref outputs "lib") "/include")))
252 (mkdir-p (string-append inc "/cube"))
253 (mkdir-p (string-append inc "/cubew"))
255 (add-after 'install 'licence
256 (lambda* (#:key outputs #:allow-other-keys)
257 (let ((doc (string-append (assoc-ref outputs "lib")
259 (install-file "COPYING" doc)
261 ;; XXX: Commented due to cycle (see comment above.)
262 ;; (add-after 'install 'doc
264 ;; (let ((share (string-append (assoc-ref %outputs "doc")
267 ;; (rename-file (string-append %output "/share/doc")
268 ;; (string-append share "/doc")))))
269 (add-after 'install 'gui-stuff
270 ;; Get the Qt horror dependencies out of the lib closure
272 (let ((outlib (string-append (assoc-ref %outputs "out") "/lib"))
273 (lib (string-append (assoc-ref %outputs "lib") "/lib")))
275 (rename-file (string-append lib "/cube-plugins")
276 (string-append outlib "/cube-plugins"))
277 (for-each (lambda (file)
279 file (string-append outlib "/" (basename file))))
280 (append (find-files lib "libgraphwidgetcommon-plugin\\..*")
281 (find-files lib "libcube4gui\\.so.*")))
283 (add-after 'install 'move-include
284 ;; Most of the headers end up under %output for some reason,
285 ;; despite --includedir in configure.
286 (lambda* (#:key outputs #:allow-other-keys)
287 (let ((outinc (string-append (assoc-ref outputs "out")
289 (libinc (string-append (assoc-ref outputs "lib")
291 (for-each (lambda (file)
292 (let ((from (string-append outinc "/" file)))
293 (copy-recursively from libinc)
294 (delete-file-recursively from)))
298 ;; XXX: This doesn't work because cube-config, which is needed for
299 ;; building stuff, sources cube-config-frontend. We don't want that
300 ;; in the lib output because it pulls in >1GB via QT.
302 ;; (add-after 'install 'cube-config
304 ;; (let* ((lib (assoc-ref %outputs "lib"))
305 ;; (libbin (string-append lib "/bin")))
307 ;; (system (string-append "mv " (assoc-ref %outputs "out")
308 ;; "/bin/cube-config* " libbin))
309 ;; (substitute* (list (string-append libbin "/cube-config"))
310 ;; (("^prefix=.*") (string-append "prefix=" lib))
311 ;; (("^exec_prefix=\"\\$\\{prefix\\}\"")
312 ;; (string-append "exec_prefix=" lib))))))
313 (add-after 'install 'cube-config
314 (lambda* (#:key outputs #:allow-other-keys)
315 (let* ((lib (assoc-ref outputs "lib"))
316 (libbin (string-append lib "/bin")))
318 (install-file (string-append %output "/bin/cube-config") libbin)
319 (install-file (string-append %output "/bin/cube-config-backend")
321 (substitute* (list (string-append libbin "/cube-config"))
322 (("^source .*frontend.*$") "")
323 (((assoc-ref outputs "out")) lib))
325 (home-page "http://www.scalasca.org/software/cube-4.x/download.html")
326 (synopsis "Performance report explorer for parallel programs")
328 "CUBE (CUBE Uniform Behavioral Encoding) is a tool to display a variety
329 of performance metrics for parallel programs including MPI and OpenMP
330 applications. CUBE allows interactive exploration of a multidimensional
331 performance space in a scalable fashion. Scalability is achieved in two ways:
332 hierarchical decomposition of individual dimensions and aggregation across
333 different dimensions. All performance metrics are uniformly accommodated in
334 the same display and thus provide the ability to easily compare the effects of
335 different kinds of performance behavior.")
336 (license license:bsd-3)))
338 (define (make-scorep mpi)
340 (name (string-append "scorep-" (package-name mpi)))
345 "http://www.vi-hps.org/upload/packages/scorep/scorep-"
349 "0h45357djna4dn9jyxx0n36fhhms3jrf22988m9agz1aw2jfivs9"))
350 (modules '((guix build utils)))
352 ;; Remove bundled software.
353 '(for-each delete-file-recursively
354 '("vendor/opari2" "vendor/cube")))))
355 (build-system gnu-build-system)
360 ("libunwind" ,libunwind)
362 ("cubelib" ,cube "lib") ;for lib, include
366 `(("gfortran" ,gfortran)
368 ("cube" ,cube) ;for cube-config
375 (list "--enable-shared" "--disable-static"
376 (string-append "--with-opari2="
377 (assoc-ref %build-inputs "opari2"))
378 (string-append "--with-cube="
379 (assoc-ref %build-inputs "cube")))
381 #:make-flags '("V=1")
383 (modify-phases %standard-phases
384 (add-after 'install 'licence
385 (lambda* (#:key outputs #:allow-other-keys)
386 (let ((doc (string-append (assoc-ref outputs "out")
387 "/share/doc/scorep")))
388 (install-file "COPYING" doc)
390 (home-page "http://www.vi-hps.org/projects/score-p/")
391 (synopsis "Performance measurement infrastructure for parallel code")
393 "The Score-P (Scalable Performance Measurement Infrastructure for
394 Parallel Codes) measurement infrastructure is a scalable and easy-to-use tool
395 suite for profiling, event trace recording, and online analysis of
396 high-performance computing (HPC) applications.")
397 (license license:cpl1.0)))
399 (define-public scorep-openmpi (make-scorep openmpi))