Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 2.83 KB

README.md

File metadata and controls

79 lines (54 loc) · 2.83 KB
Raw

Build Status Build status pipeline status

compass

A drop-in header-only C++ library to detect hardware capabilities at runtime and at compiletime.

How to use it?

You have 2 options:

  1. you can just copy the contents of single_include (or include if you like to have multiple folders and source code files) into your project and off you go

  2. you use the cmake build infrastructure to put compass in a desired folder

    • on *NIX platforms and macOS/OSX
    $ cd repo
$ mkdir build && cd build
$ cmake -DCMAKE_INSTALL_PREFIX=/path/where/compass/needs/to/go ..
$ make && ctest
$ make install #depending on the contents of CMAKE_INSTALL_PREFIX, you may use sudo
    • on Windows platforms (assuming that cmake is in your PATH)
    > cd repo
> mkdir build
> cd build
> cmake.exe -G "Visual Studio 14 2015 Win64" ..
> cmake.exe --build . --target ALL_BUILD --config Release
> ctest.exe -C Release

(3.) tests should only be run on the hardware where cmake was called. CMakeLists.txt is trying hard to detect the hardware features at cmake invocation. They are then included in the unit test suite.

Compass API

Here is a minimal code example that tries to detect SSE4 at runtime:

#include <iostream>
#include "compass.hpp"

using namespace compass;

int main(int argc, char** argv){

    if(runtime::has(feature::sse4()))
        std::cout << "SSE4 found!!\n";
    else
        std::cout << "This is an old machine. I hope I don't break anything.\n";
        
    return 0;

}

if you want to learn more supported features, check this test file.

Help needed

This project is quite small, so here is your chance to boost open-source to the benefit of the entire C++ community.

  • code review the model to extend compass for new compilers/platforms/OSes
  • code review the model to extend compass for new features
  • is thread-safety an issue of the current implementation ?
  • contribute for adding Intel compiler on x86
  • contribute for GPUs (nvcc)
  • extend support for OpenPower (gcc) if you have according hardware available
  • contribute for ARM (gcc/clang) if you have according hardware available

A good place to start and to see what is needed, is llvm Host.cpp file.

License

This project is licensed under the BSD 3-clause open source license. See LICENSE for details.