mirror of
https://github.com/JayDDee/cpuminer-opt.git
synced 2025-09-17 23:44:27 +00:00
Updated Getting started (markdown)
JayDDee
@@ -1,324 +0,0 @@
|
||||
# Requirements
|
||||
|
||||
## Hardware requirements.
|
||||
|
||||
### CPU
|
||||
|
||||
A x86_64 architecture CPU with a minimum of SSE2 support. This includes
|
||||
Intel Core2 and newer and AMD equivalents. In order to take advantage of AES_NI
|
||||
optimizations a CPU with AES_NI is required. This includes Intel Westmere
|
||||
and newer and AMD equivalents. Further optimizations are available on some
|
||||
algoritms for CPUs with AVX and AVX2, Sandybridge and Haswell respectively,
|
||||
as well as AVX512, SHA, and VAES avaible on Icelake.
|
||||
|
||||
Older CPUs are supported by cpuminer-multi by TPruvot but at reduced
|
||||
performance.
|
||||
|
||||
ARM, Aarch64, Raspberry Pi are not supported.
|
||||
|
||||
### Memory
|
||||
|
||||
Memory requirements are very dependant on the algorithm. Some algorithms require over 100 MB per thread.
|
||||
GPU mining will also raise memory requirements. It's not a performance issue, it works smoothly or it
|
||||
doesn't.
|
||||
|
||||
## Software requirements
|
||||
|
||||
### Operating system
|
||||
|
||||
64 bit Linux OS. Ubuntu and Fedora based distributions, including Mint and
|
||||
Centos, are known to work and have all dependencies in their repositories.
|
||||
Others may work but may require more effort. Older versions such as Centos 6
|
||||
don't work due to missing features.
|
||||
64 bit Windows OS is supported with mingw_w64 and msys or pre-built binaries.
|
||||
|
||||
FreeBSD and other BSDs may work, YMMV.
|
||||
|
||||
MacOS, OSx, Android, Haiku and reactOS are not supported.
|
||||
|
||||
### Virtualization and Emulation
|
||||
|
||||
It is possible to run cpuminer-opt in a virtual machine but some CPU features may be missing emulation.
|
||||
CygWin has been known to work but has significantly lower performance than running a Windows binary natively.
|
||||
VMs and emulators are nit recommended.
|
||||
|
||||
### Server
|
||||
|
||||
A stratum server for shared mode pool mining. Some pools also offer solo mining.
|
||||
|
||||
A full node wallet for the coin to be mined using getwork.
|
||||
|
||||
GBT is YMMV.
|
||||
|
||||
# Building
|
||||
|
||||
## Building on Linux
|
||||
|
||||
### Building on linux prerequisites:
|
||||
|
||||
It is assumed users know how to install packages on their system and
|
||||
be able to compile standard source packages. This is basic Linux and
|
||||
beyond the scope of cpuminer-opt. Regardless compiling is trivial if you
|
||||
follow the instructions.
|
||||
|
||||
Make sure you have the basic development packages installed.
|
||||
Here is a good start:
|
||||
|
||||
http://askubuntu.com/questions/457526/how-to-install-cpuminer-in-ubuntu
|
||||
|
||||
Install any additional dependencies needed by cpuminer-opt. The list below
|
||||
are some of the ones that may not be in the default install and need to
|
||||
be installed manually. There may be others, read the compiler error messages,
|
||||
they will give a clue as to the missing package.
|
||||
|
||||
The following command should install everything you need on Debian based
|
||||
distributions such as Ubuntu. Fedora and other distributions may have similar
|
||||
but different package names.
|
||||
|
||||
`
|
||||
$ sudo apt-get install build-essential automake libssl-dev libcurl4-openssl-dev libjansson-dev libgmp-dev zlib1g-dev git
|
||||
`
|
||||
|
||||
SHA support on AMD Ryzen CPUs requires gcc version 5 or higher and
|
||||
openssl 1.1.0e or higher. Add one of the following to CFLAGS for SHA
|
||||
support depending on your CPU and compiler version:
|
||||
|
||||
"-march=native" is usually the best choice and is used by build.sh
|
||||
|
||||
"-march=znver1" for Ryzen 1000 & 2000 series, znver2 for 3000.
|
||||
|
||||
"-msha" Add SHA to other tuning options
|
||||
|
||||
Additional instructions for static compilalation can be found here:
|
||||
https://lxadm.com/Static_compilation_of_cpuminer
|
||||
Static builds should only considered in a homogeneous HW and SW environment.
|
||||
Local builds will always have the best performance and compatibility.
|
||||
|
||||
### Download cpuminer-opt
|
||||
|
||||
Download the source code for the latest release from the official repository.
|
||||
|
||||
https://github.com/JayDDee/cpuminer-opt/releases
|
||||
|
||||
Extract the source code.
|
||||
|
||||
`$ tar xvzf cpuminer-opt-x.y.z.tar.gz`
|
||||
|
||||
|
||||
Alternatively it can be cloned from git.
|
||||
|
||||
`$ git clone https://github.com/JayDDee/cpuminer-opt.git`
|
||||
|
||||
### Build cpuminer-opt
|
||||
|
||||
It is recomended to Build with default options, this will usuallly
|
||||
produce the best results.
|
||||
|
||||
`$ ./build.sh`
|
||||
|
||||
or
|
||||
|
||||
|
||||
`$ ./autogen.sh`
|
||||
|
||||
`$ CFLAGS="-O3 -march=native -Wall" ./configure --with-curl`
|
||||
|
||||
`$ make -j n`
|
||||
|
||||
|
||||
n is the number of threads.
|
||||
|
||||
### Start mining.
|
||||
|
||||
|
||||
`$ ./cpuminer -a algo -o url -u username -p password`
|
||||
|
||||
|
||||
## Building for Windows
|
||||
|
||||
Windows compilation using Visual Studio is not supported. Mingw64 is
|
||||
used on a Linux system (bare metal or virtual machine) to cross-compile
|
||||
cpuminer-opt executable binaries for Windows.
|
||||
|
||||
These instructions were written for Debian and Ubuntu compatible distributions
|
||||
but should work on other major distributions as well. However some of the
|
||||
package names or file paths may be different.
|
||||
|
||||
It is assumed a Linux system is already available and running. And the user
|
||||
has enough Linux knowledge to find and install packages and follow these
|
||||
instructions.
|
||||
|
||||
First it is a good idea to create new user specifically for cross compiling.
|
||||
It keeps all mingw stuff contained and isolated from the rest of the system.
|
||||
|
||||
Step by step...
|
||||
|
||||
### Install packages
|
||||
|
||||
Install necessary packages from the distribution's repositories.
|
||||
|
||||
Refer to Linux compile instructions and install required packages.
|
||||
|
||||
Additionally, install mingw-w64.
|
||||
|
||||
`sudo apt-get install mingw-w64`
|
||||
|
||||
|
||||
### Create a local library
|
||||
|
||||
Create a directory for libraries that that need to be compiled in the next stept step.
|
||||
The Suggested location is $HOME/usr/lib/
|
||||
|
||||
`$ mkdir $HOME/usr/lib`
|
||||
|
||||
### Buld libraries
|
||||
|
||||
Download and build other packages for mingw that don't have a mingw64 version available in the repositories.
|
||||
|
||||
Download the following source code packages from their respective and respected download locations,
|
||||
copy them to $HOME/usr/lib/ and uncompress them.
|
||||
|
||||
openssl
|
||||
curl
|
||||
gmp
|
||||
|
||||
In most cases the latest vesrion is ok but it's safest to download
|
||||
the same major and minor version as included in your distribution.
|
||||
|
||||
Run the following commands or follow the supplied instructions.
|
||||
Do not run "make install" unless you are using /usr/lib, which isn't
|
||||
recommended.
|
||||
|
||||
Some instructions insist on running "make check". If make check fails
|
||||
it may still work, YMMV.
|
||||
|
||||
You can speed up "make" by using all CPU cores available with "-j n" where
|
||||
n is the number of CPU threads you want to use.
|
||||
|
||||
openssl:
|
||||
|
||||
|
||||
`./Configure mingw64 shared --cross-compile-prefix=x86_64-w64-mingw32`
|
||||
|
||||
`make`
|
||||
|
||||
|
||||
curl:
|
||||
|
||||
`./configure --with-winssl --with-winidn --host=x86_64-w64-mingw32`
|
||||
|
||||
`make`
|
||||
|
||||
|
||||
gmp:
|
||||
|
||||
|
||||
`./configure --host=x86_64-w64-mingw32`
|
||||
|
||||
`make`
|
||||
|
||||
|
||||
### Tweak the environment.
|
||||
|
||||
This step is required everytime you login or the commands can be added to
|
||||
.bashrc.
|
||||
|
||||
Define some local variables to point to local library.
|
||||
|
||||
|
||||
`$ export LOCAL_LIB="$HOME/usr/lib"`
|
||||
|
||||
`$ export LDFLAGS="-L$LOCAL_LIB/curl/lib/.libs -L$LOCAL_LIB/gmp/.libs -L$LOCAL_LIB/openssl"`
|
||||
|
||||
`$ export CONFIGURE_ARGS="--with-curl=$LOCAL_LIB/curl --with-crypto=$LOCAL_LIB/openssl --host=x86_64-w64-mingw32"`
|
||||
|
||||
|
||||
Create a release directory and copy some dll files previously built.
|
||||
This can be done outside of cpuminer-opt and only needs to be done once.
|
||||
If the release directory is in cpuminer-opt directory it needs to be
|
||||
recreated every a source package is decompressed.
|
||||
|
||||
|
||||
`$ mkdir release`
|
||||
|
||||
`$ cp /usr/x86_64-w64-mingw32/lib/zlib1.dll release/`
|
||||
|
||||
`$ cp /usr/x86_64-w64-mingw32/lib/libwinpthread-1.dll release/`
|
||||
|
||||
`$ cp /usr/lib/gcc/x86_64-w64-mingw32/7.3-win32/libstdc++-6.dll release/`
|
||||
|
||||
`$ cp /usr/lib/gcc/x86_64-w64-mingw32/7.3-win32/libgcc_s_seh-1.dll release/`
|
||||
|
||||
`$ cp $LOCAL_LIB/openssl/libcrypto-1_1-x64.dll release/`
|
||||
|
||||
`$ cp $LOCAL_LIB/curl/lib/.libs/libcurl-4.dll release/`
|
||||
|
||||
|
||||
### Download cpuminer-opt
|
||||
|
||||
The following steps need to be done every time a new source package is
|
||||
opened.
|
||||
|
||||
Download the latest source code package of cpumuner-opt to your desired
|
||||
location. .zip or .tar.gz, your choice.
|
||||
|
||||
https://github.com/JayDDee/cpuminer-opt/releases
|
||||
|
||||
Decompress and change to the cpuminer-opt directory.
|
||||
|
||||
|
||||
### Prepare to compile
|
||||
|
||||
Create a link to the locally compiled version of gmp.h
|
||||
|
||||
`ln -s $LOCAL_LIB/gmp-version/gmp.h ./gmp.h`
|
||||
|
||||
### Compile
|
||||
|
||||
You can use the default compile if you intend to use cpuminer-opt on the
|
||||
same CPU and the virtual machine supports that architecture.
|
||||
|
||||
`$ ./build.sh`
|
||||
|
||||
Otherwise you can compile manually while setting options in CFLAGS.
|
||||
|
||||
Some common options:
|
||||
|
||||
To compile for a specific CPU architecture:
|
||||
|
||||
CFLAGS="-O3 -march=znver1 -Wall" ./configure --with-curl
|
||||
|
||||
This will compile for AMD Ryzen.
|
||||
|
||||
You can compile more generically for a set of specific CPU features
|
||||
if you know what features you want:
|
||||
|
||||
CFLAGS="-O3 -maes -msse4.2 -Wall" ./configure --with-curl
|
||||
|
||||
This will compile for an older CPU that does not have AVX.
|
||||
|
||||
You can find several examples in build-allarch.sh
|
||||
|
||||
If you have a CPU with more than 64 threads and Windows 7 or higher you
|
||||
can enable the CPU Groups feature:
|
||||
|
||||
-D_WIN32_WINNT==0x0601
|
||||
|
||||
Once you have run configure successfully run make with n CPU threads:
|
||||
|
||||
make -j n
|
||||
|
||||
Copy cpuminer.exe to the release directory, compress and copy the release
|
||||
directory to a Windows system and run cpuminer.exe from the command line.
|
||||
|
||||
Run cpuminer
|
||||
|
||||
In a command windows change directories to the unzipped release folder.
|
||||
to get a list of all options:
|
||||
|
||||
cpuminer.exe --help
|
||||
|
||||
Command options are specific to where you mine. Refer to the pool's
|
||||
instructions on how to set them.
|
||||
|
||||
|
||||
52
Requirements.md
Normal file
52
Requirements.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Requirements
|
||||
|
||||
## Hardware requirements.
|
||||
|
||||
### CPU
|
||||
|
||||
A x86_64 architecture CPU with a minimum of SSE2 support. This includes
|
||||
Intel Core2 and newer and AMD equivalents. In order to take advantage of AES_NI
|
||||
optimizations a CPU with AES_NI is required. This includes Intel Westmere
|
||||
and newer and AMD equivalents. Further optimizations are available on some
|
||||
algoritms for CPUs with AVX and AVX2, Sandybridge and Haswell respectively,
|
||||
as well as AVX512, SHA, and VAES avaible on Icelake.
|
||||
|
||||
Older CPUs are supported by cpuminer-multi by TPruvot but at reduced
|
||||
performance.
|
||||
|
||||
ARM, Aarch64, Raspberry Pi are not supported.
|
||||
|
||||
### Memory
|
||||
|
||||
Memory requirements are very dependant on the algorithm. Some algorithms require over 100 MB per thread.
|
||||
GPU mining will also raise memory requirements. It's not a performance issue, it works smoothly or it
|
||||
doesn't.
|
||||
|
||||
## Software requirements
|
||||
|
||||
### Operating system
|
||||
|
||||
64 bit Linux OS. Ubuntu and Fedora based distributions, including Mint and
|
||||
Centos, are known to work and have all dependencies in their repositories.
|
||||
Others may work but may require more effort. Older versions such as Centos 6
|
||||
don't work due to missing features.
|
||||
64 bit Windows OS is supported with mingw_w64 and msys or pre-built binaries.
|
||||
|
||||
FreeBSD and other BSDs may work, YMMV.
|
||||
|
||||
MacOS, OSx, Android, Haiku and reactOS are not supported.
|
||||
|
||||
### Virtualization and Emulation
|
||||
|
||||
It is possible to run cpuminer-opt in a virtual machine but some CPU features may be missing emulation.
|
||||
CygWin has been known to work but has significantly lower performance than running a Windows binary natively.
|
||||
VMs and emulators are nit recommended.
|
||||
|
||||
### Server
|
||||
|
||||
A stratum server for shared mode pool mining. Some pools also offer solo mining.
|
||||
|
||||
A full node wallet for the coin to be mined using getwork.
|
||||
|
||||
GBT is YMMV.
|
||||
|
||||
Reference in New Issue
Block a user