# OpenBLAS
+[](https://gitter.im/xianyi/OpenBLAS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Travis CI: [](https://travis-ci.org/xianyi/OpenBLAS)
+
+AppVeyor: [](https://ci.appveyor.com/project/xianyi/openblas/branch/develop)
## Introduction
-OpenBLAS is an optimized BLAS library based on GotoBLAS2 1.13 BSD version. OpenBLAS is an open source project supported by Lab of Parallel Software and Computational Science, ISCAS <http://www.rdcps.ac.cn>.
+OpenBLAS is an optimized BLAS library based on GotoBLAS2 1.13 BSD version.
Please read the documents on OpenBLAS wiki pages <http://github.com/xianyi/OpenBLAS/wiki>.
-## Installation
+## Binary Packages
+We provide binary packages for the following platform.
+
+ * Windows x86/x86_64
+
+You can download them from [file hosting on sourceforge.net](https://sourceforge.net/projects/openblas/files/).
+
+## Installation from Source
Download from project homepage. http://xianyi.github.com/OpenBLAS/
Or, check out codes from git://github.com/xianyi/OpenBLAS.git
make DEBUG=1
-### Install to the directory (Optional)
+### Compile with MASS Support on Power CPU (Optional dependency)
+
+[IBM MASS](http://www-01.ibm.com/software/awdtools/mass/linux/mass-linux.html) library consists of a set of mathematical functions for C, C++, and
+Fortran-language applications that are tuned for optimum performance on POWER architectures. OpenBLAS with MASS requires 64-bit, little-endian OS on POWER.
+The library can be installed as below -
+
+ * On Ubuntu:
+
+ wget -q http://public.dhe.ibm.com/software/server/POWER/Linux/xl-compiler/eval/ppc64le/ubuntu/public.gpg -O- | sudo apt-key add -</br>
+ echo "deb http://public.dhe.ibm.com/software/server/POWER/Linux/xl-compiler/eval/ppc64le/ubuntu/ trusty main" | sudo tee /etc/apt/sources.list.d/ibm-xl-compiler-eval.list</br>
+ sudo apt-get update</br>
+ sudo apt-get install libxlmass-devel.8.1.5</br>
+
+ * On RHEL/CentOS:
+
+ wget http://public.dhe.ibm.com/software/server/POWER/Linux/xl-compiler/eval/ppc64le/rhel7/repodata/repomd.xml.key</br>
+ sudo rpm --import repomd.xml.key</br>
+ wget http://public.dhe.ibm.com/software/server/POWER/Linux/xl-compiler/eval/ppc64le/rhel7/ibm-xl-compiler-eval.repo</br>
+ sudo cp ibm-xl-compiler-eval.repo /etc/yum.repos.d/</br>
+ sudo yum install libxlmass-devel.8.1.5</br>
+
+After installing MASS library, compile openblas with USE_MASS=1.
+
+Example:
+
+Compiling on Power8 with MASS support -
+
+ make USE_MASS=1 TARGET=POWER8
+
+### Install to the directory (optional)
Example:
#### x86/x86-64:
- **Intel Xeon 56xx (Westmere)**: Used GotoBLAS2 Nehalem codes.
-- **Intel Sandy Bridge**: Optimized Level-3 BLAS with AVX on x86-64.
+- **Intel Sandy Bridge**: Optimized Level-3 and Level-2 BLAS with AVX on x86-64.
+- **Intel Haswell**: Optimized Level-3 and Level-2 BLAS with AVX2 and FMA on x86-64.
- **AMD Bobcat**: Used GotoBLAS2 Barcelona codes.
-- **AMD Bulldozer**: x86-64 S/DGEMM AVX kernels. (Thank Werner Saar)
+- **AMD Bulldozer**: x86-64 ?GEMM FMA4 kernels. (Thank Werner Saar)
+- **AMD PILEDRIVER**: Uses Bulldozer codes with some optimizations.
+- **AMD STEAMROLLER**: Uses Bulldozer codes with some optimizations.
#### MIPS64:
- **ICT Loongson 3A**: Optimized Level-3 BLAS and the part of Level-1,2.
- **ICT Loongson 3B**: Experimental
+#### ARM:
+- **ARMV6**: Optimized BLAS for vfpv2 and vfpv3-d16 ( e.g. BCM2835, Cortex M0+ )
+- **ARMV7**: Optimized BLAS for vfpv3-d32 ( e.g. Cortex A8, A9 and A15 )
+
+#### ARM64:
+- **ARMV8**: Experimental
+- **ARM Cortex-A57**: Experimental
+
+#### IBM zEnterprise System:
+- **Z13**: Optimized Level-3 BLAS
+
+
### Support OS:
- **GNU/Linux**
-- **MingWin/Windows**: Please read <https://github.com/xianyi/OpenBLAS/wiki/How-to-use-OpenBLAS-in-Microsoft-Visual-Studio>.
+- **MingWin or Visual Studio(CMake)/Windows**: Please read <https://github.com/xianyi/OpenBLAS/wiki/How-to-use-OpenBLAS-in-Microsoft-Visual-Studio>.
- **Darwin/Mac OS X**: Experimental. Although GotoBLAS2 supports Darwin, we are the beginner on Mac OS X.
-- **FreeBSD**: Supportted by community. We didn't test the library on this OS.
+- **FreeBSD**: Supported by community. We didn't test the library on this OS.
+- **Android**: Supported by community. Please read <https://github.com/xianyi/OpenBLAS/wiki/How-to-build-OpenBLAS-for-Android>.
## Usages
Link with libopenblas.a or -lopenblas for shared library.
-### Set the number of threads with environment variables.
+### Set the number of threads with environment variables.
Examples:
export GOTO_NUM_THREADS=4
- or
+ or
export OMP_NUM_THREADS=4
If you compile this lib with USE_OPENMP=1, you should set OMP_NUM_THREADS environment variable. OpenBLAS ignores OPENBLAS_NUM_THREADS and GOTO_NUM_THREADS with USE_OPENMP=1.
-### Set the number of threads on runtime.
+### Set the number of threads on runtime.
-We provided the below functions to controll the number of threads on runtime.
+We provided the below functions to control the number of threads on runtime.
void goto_set_num_threads(int num_threads);
Please add a issue in https://github.com/xianyi/OpenBLAS/issues
## Contact
-OpenBLAS users mailing list: http://list.rdcps.ac.cn/mailman/listinfo/openblas
+* OpenBLAS users mailing list: https://groups.google.com/forum/#!forum/openblas-users
+* OpenBLAS developers mailing list: https://groups.google.com/forum/#!forum/openblas-dev
## ChangeLog
Please see Changelog.txt to obtain the differences between GotoBLAS2 1.13 BSD version.
* Please read [Faq](https://github.com/xianyi/OpenBLAS/wiki/Faq) at first.
* Please use gcc version 4.6 and above to compile Sandy Bridge AVX kernels on Linux/MingW/BSD.
* Please use Clang version 3.1 and above to compile the library on Sandy Bridge microarchitecture. The Clang 3.0 will generate the wrong AVX binary code.
-* The number of CPUs/Cores should less than or equal to 256.
-* On Linux, OpenBLAS sets the processor affinity by default. This may cause [the conflict with R parallel](https://stat.ethz.ch/pipermail/r-sig-hpc/2012-April/001348.html). You can build the library with NO_AFFINITY=1.
-* On Loongson 3A. make test would be failed because of pthread_create error. The error code is EAGAIN. However, it will be OK when you run the same testcase on shell.
-
-## Specification of Git Branches
-We used the git branching model in this article (http://nvie.com/posts/a-successful-git-branching-model/).
-Now, there are 4 branches in github.com.
- * The master branch. This a main branch to reflect a production-ready state.
- * The develop branch. This a main branch to reflect a state with the latest delivered development changes for the next release.
- * The loongson3a branch. This is a feature branch. We develop Loongson3A codes on this branch. We will merge this feature to develop branch in future.
- * The gh-pages branch. This is for web pages
+* The number of CPUs/Cores should less than or equal to 256. On Linux x86_64(amd64), there is experimental support for up to 1024 CPUs/Cores and 128 numa nodes if you build the library with BIGNUMA=1.
+* OpenBLAS does not set processor affinity by default. On Linux, you can enable processor affinity by commenting the line NO_AFFINITY=1 in Makefile.rule. But this may cause [the conflict with R parallel](https://stat.ethz.ch/pipermail/r-sig-hpc/2012-April/001348.html).
+* On Loongson 3A. make test would be failed because of pthread_create error. The error code is EAGAIN. However, it will be OK when you run the same testcase on shell.
+
+## Contributing
+1. [Check for open issues](https://github.com/xianyi/OpenBLAS/issues) or open a fresh issue to start a discussion around a feature idea or a bug.
+1. Fork the [OpenBLAS](https://github.com/xianyi/OpenBLAS) repository to start making your changes.
+1. Write a test which shows that the bug was fixed or that the feature works as expected.
+1. Send a pull request. Make sure to add yourself to `CONTRIBUTORS.md`.
+
+## Donation
+Please read [this wiki page](https://github.com/xianyi/OpenBLAS/wiki/Donation).
projects / platform / upstream / openblas.git / blobdiff