OpenCL GPU miner
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Con Kolivas 508c5c4b12 Detect when the primary pool is lagging and start queueing requests on backup pools if possible before needing to roll work. 14 years ago
ccan Moved pthread mutex inits up, due to applog using a mutex causing a crash. 14 years ago
compat Move to newer jansson library. 14 years ago
lib Mingw suseconds_t and sigaction fixes. 14 years ago
m4 Mingw suseconds_t and sigaction fixes. 14 years ago
x86_64 Add an sse4 algorithm to CPU mining. 14 years ago
.gitignore Rename code and application binary to cgminer version 1.0.9 preempting version 1.1.0, moving main code to main.c. 14 years ago
AUTHORS Rename code and application binary to cgminer version 1.0.9 preempting version 1.1.0, moving main code to main.c. 14 years ago
COPYING Convert over to autotools. Release version 0.1. 14 years ago
ChangeLog Convert over to autotools. Release version 0.1. 14 years ago
LICENSE Convert over to autotools. Release version 0.1. 14 years ago
Makefile.am Update phatk kernel to one with new parameters for slightly less overhead again. 14 years ago
NEWS Update NEWS. 14 years ago
README Update README. 14 years ago
arg-nonnull.h Added previously missing gnulib files. 14 years ago
autogen.sh autogen.sh fix 14 years ago
c++defs.h Added previously missing gnulib files. 14 years ago
compat.h Fix suseconds_t for OSX. 14 years ago
configure.ac Bump version number to 1.4.0 14 years ago
elist.h Move all RPC I/O to separate thread. 14 years ago
example-cfg.json example-cfg.json: remove extraneous commas, which broke JSON decode 14 years ago
findnonce.c Update phatk kernel to one with new parameters for slightly less overhead again. 14 years ago
findnonce.h Update kernel with a shorter output path, and use 4k output buffer to match OS page sizes. 14 years ago
main.c Detect when the primary pool is lagging and start queueing requests on backup pools if possible before needing to roll work. 14 years ago
miner.h Build support in for all SSE if possible and only set the default according to machine capabilities. 14 years ago
mkinstalldirs Build on windows using mingw32. 14 years ago
mknsis.sh Windows build tweaks. 14 years ago
ocl.c Out of order command queue may fail on osx. Try without if it fails. 14 years ago
ocl.h Make it possible to build without GPU mining by picking up HAVE_OPENCL from config.h. 14 years ago
phatk110722.cl Some hardware might benefit from the less OPS so there's no harm in leaving it there apart from readability of the code. 14 years ago
poclbm110717.cl Rename the poclbm file to ensure a new binary is built since. 14 years ago
sha256_4way.c Update CPU reentrant scan code to work properly for extended periods up to scantime and adjust rate properly. 14 years ago
sha256_cryptopp.c Fix CPU mining with other algorithms not working. 14 years ago
sha256_generic.c Fix CPU mining with other algorithms not working. 14 years ago
sha256_sse2_amd64.c Add an sse4 algorithm to CPU mining. 14 years ago
sha256_sse4_amd64.c Add an sse4 algorithm to CPU mining. 14 years ago
sha256_via.c Fix CPU mining with other algorithms not working. 14 years ago
util.c OSX: fix setsockopt compile bug 14 years ago
warn-on-use.h Added previously missing gnulib files. 14 years ago

README


This is a multi-threaded multi-pool CPU and GPU miner for bitcoin.

License: GPLv2. See COPYING for details.

Dependencies:
libcurl http://curl.haxx.se/libcurl/
jansson http://www.digip.org/jansson/
(jansson is included in-tree and not necessary)
libncurses5-dev (or libpdcurses on WIN32)

Basic *nix build instructions:
To build with GPU mining support:
Install AMD APP sdk, latest version - there is no official place to
install it so just keep track of where it is if you're not installing
the include files and library files into the system directory.
(Do NOT install the ati amd sdk if you are on nvidia)

The easiest way to install the ATI AMD SPP sdk on linux is to actually put it
into a system location. Then building will be simpler. Download the correct
version for either 32 bit or 64 bit from here:
http://developer.amd.com/sdks/AMDAPPSDK/downloads/Pages/default.aspx

This will give you a file with a name like AMD-APP-SDK-v2.4-lnx64.tgz

Then:

sudo su
cd /opt
tar xf /path/to/AMD-APP-SDK-v2.4-lnx64.tgz
cd /
tar xf /opt/AMD-APP-SDK-v2.4-lnx64/icd-registration.tgz
ln -s /opt/AMD-APP-SDK-v2.4-lnx64/include/CL /usr/include
ln -s /opt/AMD-APP-SDK-v2.4-lnx64/lib/x86_64/* /usr/lib/
ldconfig

If you are on 32 bit, x86_64 in the 2nd last line should be x86

To actually build:

./autogen.sh # only needed if building from git repo
CFLAGS="-O3 -Wall -march=native" ./configure
or if you haven't installed the ati files in system locations:
CFLAGS="-O3 -Wall -march=native -I<path to AMD APP include>" LDFLAGS="-L<path to AMD APP lib/x86_64> ./configure
make

If it finds the opencl files it will inform you with
"OpenCL: FOUND. GPU mining support enabled."

Basic WIN32 build instructions (on Fedora 13; requires mingw32):
./autogen.sh # only needed if building from git repo
rm -f mingw32-config.cache
MINGW32_CFLAGS="-O3 -Wall -msse2" mingw32-configure
make
./mknsis.sh

Native WIN32 build instructions (on mingw32, on windows):
Install AMD APP sdk, latest version
(Do NOT install the ati amd sdk if you are on nvidia)
Install mingw32
Install libcurl, copy libcurl.m4 into /mingw/share/aclocal
Run:
autoreconf -fvi
CFLAGS="-O3 -Wall -msse2 -I<path to AMD APP include>" LDFLAGS="-L<path to AMD APP lib/x86>" ./configure
make

Usage instructions: Run "cgminer --help" to see options.

---

EXECUTIVE SUMMARY ON USAGE:

Single pool, regular desktop:

cgminer -o http://pool:port -u username -p password

Single pool, dedicated miner:

cgminer -o http://pool:port -u username -p password -I 8

Multiple pool, dedicated miner:

cgminer -o http://pool1:port -u pool1username -p pool1password -o http://pool2:port -u pool2usernmae -p pool2password -I 8

---

WHILE RUNNING:

The following options are available while running with a single keypress:

[P]ool management [S]ettings [D]isplay options [Q]uit

P gives you:

Current pool management strategy: Failover
[A]dd pool [R]emove pool [D]isable pool [E]nable pool
[C]hange management strategy [S]witch pool [I]nformation


S gives you:

[D]ynamic mode: On
[L]ongpoll: On
[I]ntensity: Dynamic
[Q]ueue: 0
[S]cantime: 60
[R]etries: -1
[P]ause: 5


D gives you:

Toggle: [D]ebug [N]ormal [S]ilent [V]erbose [R]PC debug
[L]og interval [C]lear


and Q quits the application.


---
Also many issues and FAQs are covered in the forum thread
dedicated to this program,
http://forum.bitcoin.org/index.php?topic=28402.0

The output line shows the following:
[(5s):204.4 (avg):203.1 Mh/s] [Q:56 A:51 R:4 HW:0 E:91% U:2.47/m]

Each column is as follows:
A 5 second exponentially decaying average hash rate
An all time average hash rate
The number of requested work items
The number of accepted shares
The number of rejected shares
The number of hardware erorrs
The efficiency defined as the accepted shares / requested work
The utility defines as the number of shares / minute

The cgminer status line shows:
TQ: 1 ST: 1 LS: 0 SS: 0 DW: 0 NB: 1 LW: 8 LO: 1 RF: 1 I: 2

TQ is Total Queued work items.
ST is STaged work items (ready to use).
LS is Longpoll Staged work items (mandatory new work)
SS is Stale Shares discarded (detected and not submitted so don't count as rejects)
DW is Discarded Work items (work from block no longer valid to work on)
NB is New Blocks detected on the network
LW is Locally generated Work items (during slow server providing work)
LO is Local generation Occasions (server slow to provide work)
RF is Remote Fail occasions (server slow to accept work)
I is current Intensity (changes in dynamic mode).

NOTE: Running intensities above 9 with current hardware is likely to only
diminish return performance even if the hash rate might appear better. A good
starting baseline intensity to try on dedicated miners is 8. Higher values are
there to cope with future improvements in hardware.


FAILOVER STRATEGIES WITH MULTIPOOL:
A number of different strategies for dealing with multipool setups are
available. Each has their advantages and disadvantages so multiple strategies
are available by user choice, as per the following list:

FAILOVER:
The default strategy is failover. This means that if you input a number of
pools, it will try to use them as a priority list, moving away from the 1st
to the 2nd, 2nd to 3rd and so on. If any of the earlier pools recover, it will
move back to the higher priority ones.

ROUND ROBIN:
This strategy only moves from one pool to the next when the current one falls
idle and makes no attempt to move otherwise.

ROTATE:
This strategy moves at user-defined intervals from one active pool to the next,
skipping pools that are idle.

LOAD BALANCE:
This strategy sends work in equal amounts to all the pools specified. If any
pool falls idle, the rest will take up the slack keeping the miner busy.