Skip to main content

Loop Kernel Analysis and Performance Modeling Toolkit

Project description

https://github.com/RRZE-HPC/kerncraft/blob/master/doc/logo/logo-lightbg.svg

kerncraft

Loop Kernel Analysis and Performance Modeling Toolkit

This tool allows automatic analysis of loop kernels using the Execution Cache Memory (ECM) model, the Roofline model and actual benchmarks. kerncraft provides a framework to investigate the data reuse and cache requirements by static code analysis. In combination with the Intel IACA tool kerncraft can give a good overview of both in-core and memory bottlenecks and use that data to apply performance models.

For a detailed documentation see publications in doc/.

https://github.com/RRZE-HPC/kerncraft/actions/workflows/test-n-publish.yml/badge.svg https://codecov.io/github/RRZE-HPC/kerncraft/coverage.svg?branch=master

Installation

On most systems with python pip and setuputils installed, just run:

pip install --user kerncraft

for the latest release. In order to get the Intel Achitecture Code Analyzer (IACA), required by the ECM, ECMCPU and RooflineASM performance models, read this and run:

iaca_get --I-accept-the-Intel-What-If-Pre-Release-License-Agreement-and-please-take-my-soul

Additional requirements are:
  • likwid (used in Benchmark model and by likwid_bench_auto)

Usage

  1. Get an example kernel and machine file from the examples directory

wget https://raw.githubusercontent.com/RRZE-HPC/kerncraft/master/examples/machine-files/SandyBridgeEP_E5-2680.yml

wget https://raw.githubusercontent.com/RRZE-HPC/kerncraft/master/examples/kernels/2d-5pt.c

  1. Have a look at the machine file and change it to match your targeted machine (above we downloaded a file for a Sandy Bridge EP machine)

  2. Run kerncraft

kerncraft -p ECM -m SandyBridgeEP_E5-2680.yml 2d-5pt.c -D N 10000 -D M 10000 add -vv for more information on the kernel and ECM model analysis.

Citations

When using Kerncraft for your work, please consider citing the following publication:

Kerncraft: A Tool for Analytic Performance Modeling of Loop Kernels (preprint)

J. Hammer, J. Eitzinger, G. Hager, and G. Wellein: Kerncraft: A Tool for Analytic Performance Modeling of Loop Kernels. In: Tools for High Performance Computing 2016, ISBN 978-3-319-56702-0, 1-22 (2017). Proceedings of IPTW 2016, the 10th International Parallel Tools Workshop, October 4-5, 2016, Stuttgart, Germany. Springer, Cham. DOI: 10.1007/978-3-319-56702-0_1, Preprint: arXiv:1702.04653``

Credits

Implementation: Julian Hammer;
ECM Model (theory): Georg Hager, Holger Stengel, Jan Treibig;
LC generalization: Julian Hammer

License

AGPLv3

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kerncraft-0.8.17.tar.gz (599.5 kB view details)

Uploaded Source

File details

Details for the file kerncraft-0.8.17.tar.gz.

File metadata

  • Download URL: kerncraft-0.8.17.tar.gz
  • Upload date:
  • Size: 599.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kerncraft-0.8.17.tar.gz
Algorithm Hash digest
SHA256 f445e253495076baebd4fa53ec7787fa3859d8409466271fa706ca87f0e0a93d
MD5 4f6704d61d51312c2847b60e60b50f3d
BLAKE2b-256 5fa564f2f9e4022b5e373c884792e2cdd6d69eda0f4484a4961350d63c5b597a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page