https://github.com/carstenbauer/threadpinning.jl

Readily pin Julia threads to CPU-threads
https://github.com/carstenbauer/threadpinning.jl

high-performance-computing julia multithreading thread-affinities

Last synced: 3 days ago
JSON representation

Readily pin Julia threads to CPU-threads

• Host: GitHub
• URL: https://github.com/carstenbauer/threadpinning.jl
• Owner: carstenbauer
• License: mit
• Created: 2021-10-13T09:30:43.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-01T18:44:32.000Z (24 days ago)
• Last Synced: 2024-12-15T06:06:55.386Z (10 days ago)
• Topics: high-performance-computing, julia, multithreading, thread-affinities
• Language: Julia
• Homepage: https://carstenbauer.github.io/ThreadPinning.jl/
• Size: 21 MB
• Stars: 112
• Watchers: 3
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ThreadPinning.jl

[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg

[docs-dev-url]: https://carstenbauer.github.io/ThreadPinning.jl/dev

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg

[docs-stable-url]: https://carstenbauer.github.io/ThreadPinning.jl/stable

[ci-img]: https://github.com/carstenbauer/ThreadPinning.jl/actions/workflows/CI.yml/badge.svg?branch=main

[ci-url]: https://github.com/carstenbauer/ThreadPinning.jl/actions/workflows/CI.yml?query=branch%3Amain

[cov-img]: https://codecov.io/gh/carstenbauer/ThreadPinning.jl/branch/main/graph/badge.svg?token=Ze61CbGoO5

[cov-url]: https://codecov.io/gh/carstenbauer/ThreadPinning.jl

[lifecycle-img]: https://img.shields.io/badge/lifecycle-stable-black.svg

[code-style-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg

[code-style-url]: https://github.com/invenia/BlueStyle

*Readily pin Julia threads of multithreaded and distributed Julia applications to CPU-threads*

| **Documentation**                                                               | **Build Status**                                                                                |  **Quality**                                                                                |

|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|

| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![][ci-img]][ci-url] [![][cov-img]][cov-url] | ![][lifecycle-img] [![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle) |

Most notably, [ThreadPinning.jl](https://github.com/carstenbauer/ThreadPinning.jl/) allows you

* to pin Julia threads to specific CPU-threads ("hardware threads") with [`pinthreads`](https://carstenbauer.github.io/ThreadPinning.jl/stable/refs/api_pinning/#ThreadPinning.pinthreads) and

* to obtain a visual overview of the system topology with [`threadinfo`](https://carstenbauer.github.io/ThreadPinning.jl/stable/refs/api_querying/#ThreadPinning.threadinfo).

There is dedicated support for pinning Julia threads in distributed Julia applications that use MPI.jl or Distributed.jl.

## What is this about? (10 minutes)

Check out my lightning talk that I gave as part of [JuliaCon 2023](https://juliacon.org/2023/) at MIT.

[![](https://img.youtube.com/vi/6Whc9XtlCC0/0.jpg)](https://youtu.be/6Whc9XtlCC0)

## Quick Demo

```julia-repl

julia> using ThreadPinning

julia> pinthreads(:cores)

julia> threadinfo(; color=false)

Hostname:       PerlmutterComputeNode

CPU(s):         2 x AMD EPYC 7763 64-Core Processor

CPU target:     znver3

Cores:          128 (256 CPU-threads due to 2-way SMT)

NUMA domains:   8 (16 cores each)

Julia threads:  16

CPU socket 1

  0,_, 1,_, 2,_, 3,_, 4,_, 5,_, 6,_, 7,_, 

  8,_, 9,_, 10,_, 11,_, 12,_, 13,_, 14,_, 15,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_

CPU socket 2

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_, 

  _,_, _,_, _,_, _,_, _,_, _,_, _,_, _,_

# = Julia thread, # = Julia thread on HT, # = >1 Julia thread

(Mapping: 1 => 0, 2 => 1, 3 => 2, 4 => 3, 5 => 4, ...)

```



## Installation

The package is registered. Hence, you can simply use

```

] add ThreadPinning

```

to add the package to your Julia environment.

Note that **only Linux is fully supported**. On other operating systems, all pinning calls (e.g. `pinthreads`) will turn into no-ops but things like `threadinfo()` should work (with limitations).

## Documentation

For more information, please find the [documentation](https://carstenbauer.github.io/ThreadPinning.jl/stable) here.