# Timings and parallelization

This section summarizes the options DFTK offers to monitor and influence performance of the code.

## Timing measurements

By default DFTK uses TimerOutputs.jl to record timings, memory allocations and the number of calls for selected routines inside the code. These numbers are accessible in the object DFTK.timer. Since the timings are automatically accumulated inside this datastructure, any timing measurement should first reset this timer before running the calculation of interest.

For example to measure the timing of an SCF:

DFTK.reset_timer!(DFTK.timer)
scfres = self_consistent_field(basis, tol=1e-8)

DFTK.timer
 ──────────────────────────────────────────────────────────────────────────────
Time                   Allocations
──────────────────────   ───────────────────────
Tot / % measured:            1.09s / 19.8%           88.3MiB / 39.7%

Section               ncalls     time   %tot     avg     alloc   %tot      avg
──────────────────────────────────────────────────────────────────────────────
self_consistent_field      1    214ms   100%   214ms   34.7MiB  99.0%  34.7MiB
compute_density          6    105ms  48.9%  17.5ms   6.15MiB  17.5%  1.02MiB
LOBPCG                  12   77.8ms  36.2%  6.48ms   10.6MiB  30.3%   906KiB
Hamiltonian mu...     42   56.4ms  26.3%  1.34ms   3.49MiB  10.0%  85.1KiB
kinetic+local       42   53.5ms  24.9%  1.27ms    755KiB  2.10%  18.0KiB
nonlocal            42   1.19ms  0.55%  28.3μs    831KiB  2.32%  19.8KiB
rayleigh_ritz         30   4.69ms  2.18%   156μs   1.04MiB  2.95%  35.3KiB
ortho!               111   3.85ms  1.79%  34.7μs    922KiB  2.57%  8.30KiB
energy_hamiltonian      13   27.5ms  12.8%  2.12ms   14.1MiB  40.2%  1.08MiB
ene_ops               13   25.3ms  11.8%  1.95ms   10.4MiB  29.7%   821KiB
ene_ops: xc         13   18.9ms  8.79%  1.45ms   3.07MiB  8.76%   242KiB
ene_ops: har...     13   3.72ms  1.73%   286μs   5.84MiB  16.7%   460KiB
ene_ops: local      13    754μs  0.35%  58.0μs   1.22MiB  3.49%  96.5KiB
ene_ops: non...     13    729μs  0.34%  56.1μs    152KiB  0.42%  11.7KiB
ene_ops: kin...     13    416μs  0.19%  32.0μs   94.4KiB  0.26%  7.26KiB
QR orthonormaliz...     12    193μs  0.09%  16.0μs    160KiB  0.45%  13.3KiB
guess_density              1    648μs  0.30%   648μs    370KiB  1.03%   370KiB
──────────────────────────────────────────────────────────────────────────────

The output produced when printing or displaying the DFTK.timer now shows a nice table summarising total time and allocations as well as a breakdown over individual routines.

Timing measurements and stack traces

Timing measurements have the unfortunate disadvantage that they alter the way stack traces look making it sometimes harder to find errors when debugging. For this reason timing measurements can be disabled completely (i.e. not even compiled into the code) by setting the environment variable DFTK_TIMING to "0" or "false". For this to take effect recompiling all DFTK (including the precompile cache) is needed.

Unfortunately measuring timings in TimerOutputs is not yet thread-safe. Therefore taking timings of threaded parts of the code will be disabled unless you set DFTK_TIMING to "all". In this case you must not use Julia threading (see section below) or otherwise undefined behaviour results.

## Options for parallelization

At the moment DFTK offers two ways to parallelize a calculation, firstly shared-memory parallelism using threading and secondly multiprocessing using MPI (via the MPI.jl Julia interface). MPI-based parallelism is currently only over k-Points, such that it cannot be used for calculations with only a single k-Point. Otherwise combining both forms of parallelism is possible as well.

The scaling of both forms of parallelism for a number of test cases is demonstrated in the following figure. These values were obtained using DFTK version 0.1.17 and Julia 1.6 and the precise scalings will likely be different depending on architecture, DFTK or Julia version. The rough trends should, however, be similar.

The MPI-based parallelization strategy clearly shows a superior scaling and should be preferred if available.

## MPI-based parallelism

Currently DFTK uses MPI to distribute on k-Points only. This implies that calculations with only a single k-Point cannot use make use of this. For details on setting up and configuring MPI with Julia see the MPI.jl documentation.

1. First disable all threading inside DFTK, by adding the following to your script running the DFTK calculation:

using DFTK
disable_threading()
2. Run Julia in parallel using the mpiexecjl wrapper script from MPI.jl:

mpiexecjl -np 16 julia myscript.jl

In this -np 16 tells MPI to use 16 processes and -t 1 tells Julia to use one thread only. Notice that we use mpiexecjl to automatically select the mpiexec compatible with the MPI version used by MPI.jl.

As usual with MPI printing will be garbled. You can use

DFTK.mpi_master() || (redirect_stdout(); redirect_stderr())

at the top of your script to disable printing on all processes but one.

MPI-based parallelism not fully supported

While standard procedures (such as the SCF or band structure calculations) fully support MPI, not all routines of DFTK are compatible with MPI yet and will throw an error when being called in an MPI-parallel run. In most cases there is no intrinsic limitation it just has not yet been implemented. If you require MPI in one of our routines, where this is not yet supported, feel free to open an issue on github or otherwise get in touch.

Threading in DFTK currently happens on multiple layers distributing the workload over different $k$-Points, bands or within an FFT or BLAS call between threads. At its current stage our scaling for thread-based parallelism is worse compared MPI-based and therefore the parallelism described here should only be used if no other option exists. To use thread-based parallelism proceed as follows:

1. Ensure that threading is properly setup inside DFTK by adding to the script running the DFTK calculation:

using DFTK
setup_threading()

This disables FFT threading and sets the number of BLAS threads to the number of Julia threads.

2. Run Julia passing the desired number of threads using the flag -t:

julia -t 8 myscript.jl

For some cases (e.g. a single k-Point, fewish bands and a large FFT grid) it can be advantageous to add threading inside the FFTs as well. One example is the Caffeine calculation in the above scaling plot. In order to do so just call setup_threading(n_fft=2), which will select two FFT threads. More than two FFT threads is rarely useful.

The default threading setup done by setup_threading is to select one FFT thread and the same number of BLAS and Julia threads. This section provides some info in case you want to change these defaults.

All BLAS calls in Julia go through a parallelized OpenBlas or MKL (with MKL.jl. Generally threading in BLAS calls is far from optimal and the default settings can be pretty bad. For example for CPUs with hyper threading enabled, the default number of threads seems to equal the number of virtual cores. Still, BLAS calls typically take second place in terms of the share of runtime they make up (between 10% and 20%). Of note many of these do not take place on matrices of the size of the full FFT grid, but rather only in a subspace (e.g. orthogonalization, Rayleigh-Ritz, ...) such that parallelization is either anyway disabled by the BLAS library or not very effective. To set the number of BLAS threads use

using LinearAlgebra
BLAS.set_num_threads(N)

where N is the number of threads you desire. To check the number of BLAS threads currently used, you can use

Int(ccall((BLAS.@blasfunc(openblas_get_num_threads), BLAS.libblas), Cint, ()))

or (from Julia 1.6) simply BLAS.get_num_threads().

On top of BLAS threading DFTK uses Julia threads (Thread.@threads) in a couple of places to parallelize over k-Points (density computation) or bands (Hamiltonian application). The number of threads used for these aspects is controlled by the flag -t passed to Julia or the environment variable JULIA_NUM_THREADS. To check the number of Julia threads use Threads.nthreads().
Since FFT threading is only used in DFTK inside the regions already parallelized by Julia threads, setting FFT threads to something larger than 1 is rarely useful if a sensible number of Julia threads has been chosen. Still, to explicitly set the FFT threads use
using FFTW
FFTW.set_num_threads(N)
where N is the number of threads you desire. By default no FFT threads are used, which is almost always the best choice.