https://github.com/haskell/threadscope

A graphical tool for profiling parallel Haskell programs
https://github.com/haskell/threadscope

Last synced: about 1 month ago
JSON representation

A graphical tool for profiling parallel Haskell programs

• Host: GitHub
• URL: https://github.com/haskell/threadscope
• Owner: haskell
• License: other
• Created: 2011-08-26T20:27:13.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2024-03-01T12:05:10.000Z (9 months ago)
• Last Synced: 2024-04-16T00:49:07.556Z (7 months ago)
• Language: Haskell
• Homepage: http://www.haskell.org/haskellwiki/ThreadScope
• Size: 45.3 MB
• Stars: 150
• Watchers: 11
• Forks: 33
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ThreadScope

[![Hackage](https://img.shields.io/hackage/v/threadscope.svg)](https://hackage.haskell.org/package/threadscope)

[![Hackage-Deps](https://img.shields.io/hackage-deps/v/threadscope.svg)](http://packdeps.haskellers.com/feed?needle=threadscope)

![CI](https://github.com/haskell/ThreadScope/workflows/CI/badge.svg?branch=master)

## Using pre-built binaries

Currently [pre-built binaries](https://github.com/haskell/ThreadScope/releases) for the following platforms are provided:

* Ubuntu 18.04 (64-bit)

* macOS 10.15

* Windows Server 2019 (x64)

GTK+2 needs to be installed for these binaries to work.

On Windows, the [MSYS2](http://www.msys2.org) is the recommended way to install GTK+2. In MSYS2 MINGW64 shell:

```sh

pacman -S $MINGW_PACKAGE_PREFIX-gtk2

```

then you can run the threadscope binary from the shell.

## Building from source

Use `git clone` or `cabal get threadscope` to get the source and move into the threadscope directory.

### Linux

GTK+2 is required to be installed. On Ubuntu-like systems:

```sh

sudo apt install libgtk2.0-dev

```

Then you can build threadscope using cabal:

```sh

cabal v2-build   # to only build the project, or

cabal v2-install # to build and install the binary

```

Or using stack:

```sh

stack build   # to only build the project, or

stack install # to build and install the binary

```

### macOS

GTK+ is required:

```sh

brew install gtk+

```

Then you can build threadscope using cabal:

```sh

cabal --project-file=cabal.project.osx v2-build   # to only build the project, or

cabal --project-file=cabal.project.osx v2-install # to build and install the binary

```

Or using stack:

```sh

stack --stack-yaml=stack.osx.yaml build   # to only build the project, or

stack --stack-yaml=stack.osx.yaml install # to install the binary

```

### Windows

[Chocolatey](https://chocolatey.org/) can be used to install GHC and [MSYS2](https://www.msys2.org/) is the recommended way to install GTK+.

```sh

choco install ghc

refreshenv

set PATH=C:\\msys64\\mingw64\\bin;C:\\msys64\\usr\\bin;%PATH%

pacman -Sy mingw-w64-x86_64-gtk2

```

then you can build threadscope using cabal:

```sh

cabal v2-build

```

Or you can use stack instead.

CAVEAT: gtk2 needs to be installed twice: one for stack's MSYS2 environment and another for local MSYS2 environment.

In command prompt:

```sh

stack setup

stack exec -- pacman --needed -Sy bash pacman pacman-mirrors msys2-runtime msys2-runtime-devel

stack exec -- pacman -Syu

stack exec -- pacman -Syuu

stack exec -- pacman -S base-devel mingw-w64-x86_64-pkg-config mingw-w64-x86_64-toolchain mingw-w64-x86_64-gtk2

stack install

```

Then in MSYS2 MINGW64 shell:

```sh

pacman -S $MINGW_PACKAGE_PREFIX-gtk2

echo 'export PATH=$APPDATA/local/bin:$PATH' >> .profile

source .profile

threadscope

```

Building using stack is not tested in CI. If you find any issues with building with stack, please update the instructions and send a PR.