2
This is a multi-threaded multi-pool CPU and GPU miner with ATI GPU monitoring,
3
(over)clocking and fanspeed support for bitcoin and derivative coins.
5
This code is provided entirely free of charge by the programmer in his spare
6
time so donations would be greatly appreciated. Please consider using the
7
--donation feature or donate directly to the address below.
9
Con Kolivas <kernel@kolivas.org>
10
15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ
14
http://ck.kolivas.org/apps/cgminer
18
https://github.com/ckolivas/cgminer
22
http://bitcointalk.org/index.php?topic=28402.0
26
irc://irc.freenode.net/cgminer
28
License: GPLv2. See COPYING for details.
31
curl dev library http://curl.haxx.se/libcurl/
32
(libcurl4-openssl-dev)
34
(libncurses5-dev or libpdcurses on WIN32)
35
pkg-config http://www.freedesktop.org/wiki/Software/pkg-config
36
jansson http://www.digip.org/jansson/
37
(jansson is included in-tree and not necessary)
38
yasm 1.0.1+ http://yasm.tortall.net/
39
(yasm is optional, gives assembly routines for CPU mining)
40
AMD APP SDK http://developer.amd.com/sdks/AMDAPPSDK
41
(This sdk is optional and gives support for GPU mining)
42
AMD ADL SDK http://developer.amd.com/sdks/ADLSDK
43
(This sdk is optional and gives support for ATI GPU monitoring & clocking)
45
Basic *nix build instructions:
46
To build with GPU mining support:
47
Install AMD APP sdk, latest version - there is no official place to
48
install it so just keep track of where it is if you're not installing
49
the include files and library files into the system directory.
50
(Do NOT install the ati amd sdk if you are on nvidia.)
51
To build with GPU monitoring & clocking support:
52
Extract the AMD ADL SDK, latest version - there is also no official
53
place for these files. Copy all the *.h files in the "include"
54
directory into cgminer's ADL_SDK directory.
56
The easiest way to install the ATI AMD SPP sdk on linux is to actually put it
57
into a system location. Then building will be simpler. Download the correct
58
version for either 32 bit or 64 bit from here:
59
http://developer.amd.com/sdks/AMDAPPSDK/downloads/Pages/default.aspx
61
This will give you a file with a name like AMD-APP-SDK-v2.4-lnx64.tgz
67
tar xf /path/to/AMD-APP-SDK-v2.4-lnx64.tgz
69
tar xf /opt/AMD-APP-SDK-v2.4-lnx64/icd-registration.tgz
70
ln -s /opt/AMD-APP-SDK-v2.4-lnx64/include/CL /usr/include
71
ln -s /opt/AMD-APP-SDK-v2.4-lnx64/lib/x86_64/* /usr/lib/
74
If you are on 32 bit, x86_64 in the 2nd last line should be x86
78
./autogen.sh # only needed if building from git repo
79
CFLAGS="-O2 -Wall -march=native" ./configure
80
or if you haven't installed the ati files in system locations:
81
CFLAGS="-O2 -Wall -march=native -I<path to AMD APP include>" LDFLAGS="-L<path to AMD APP lib/x86_64> ./configure
84
If it finds the opencl files it will inform you with
85
"OpenCL: FOUND. GPU mining support enabled."
87
Basic WIN32 build instructions (LIKELY OUTDATED INFO. requires mingw32):
88
./autogen.sh # only needed if building from git repo
89
rm -f mingw32-config.cache
90
MINGW32_CFLAGS="-O2 -Wall -msse2" mingw32-configure
94
Native WIN32 build instructions (on mingw32, on windows):
95
Install the Microsoft platform SDK
96
Install AMD APP sdk, latest version (only if you want GPU mining)
97
Install AMD ADL sdk, latest version (only if you want GPU monitoring)
98
(Do NOT install the ati amd sdk if you are on nvidia)
100
Install libcurl, copy libcurl.m4 into /mingw/share/aclocal
101
Install pkg-config, copy pkg.m4 into /mingw/share/aclocal
104
CFLAGS="-O2 -msse2" ./configure
109
Usage instructions: Run "cgminer --help" to see options:
111
Usage: . [-atDdGCgIKklmpPQqrRsTouvwOchnV]
112
Options for both config file and command line:
113
--algo|-a <arg> Specify sha256 implementation for CPU mining:
114
auto Benchmark at startup and pick fastest algorithm
115
c Linux kernel sha256, implemented in C
116
4way tcatm's 4-way SSE2 implementation
117
via VIA padlock implementation
118
cryptopp Crypto++ C/C++ implementation
119
sse2_64 SSE2 64 bit implementation for x86_64 machines
120
sse4_64 SSE4.1 64 bit implementation for x86_64 machines (default: sse2_64)
121
--auto-fan Automatically adjust all GPU fan speeds to maintain a target temperature
122
--auto-gpu Automatically adjust all GPU engine clock speeds to maintain a target temperature
123
--cpu-threads|-t <arg> Number of miner CPU threads (default: 4)
124
--debug|-D Enable debug output
125
--device|-d <arg> Select device to use, (Use repeat -d for multiple devices, default: all)
126
--disable-gpu|-G Disable GPU mining even if suitable devices exist
127
--donation <arg> Set donation percentage to cgminer author (0.0 - 99.9) (default: 0.0)
128
--enable-cpu|-C Enable CPU mining with GPU mining (default: no CPU mining if suitable GPUs exist)
129
--expiry|-E <arg> Upper bound on how many seconds after getting work we consider a share from it stale (default: 120)
130
--failover-only Don't leak work to backup pools when primary pool is lagging
131
--gpu-threads|-g <arg> Number of threads per GPU (1 - 10) (default: 2)
132
--gpu-engine <arg> GPU engine (over)clock range in Mhz - one value, range and/or comma separated list (e.g. 850-900,900,750-850)
133
--gpu-fan <arg> GPU fan percentage range - one value, range and/or comma separated list (e.g. 25-85,85,65)
134
--gpu-memclock <arg> Set the GPU memory (over)clock in Mhz - one value for all or separate by commas for per card.
135
--gpu-powertune <arg> Set the GPU powertune percentage - one value for all or separate by commas for per card.
136
--gpu-vddc <arg> Set the GPU voltage in Volts - one value for all or separate by commas for per card.
137
--intensity|-I <arg> Intensity of GPU scanning (d or -10 -> 10, default: d to maintain desktop interactivity)
138
--kernel-path|-K <arg> Specify a path to where the kernel .cl files are (default: "/usr/local/bin")
139
--kernel|-k <arg> Select kernel to use (poclbm or phatk - default: auto)
140
--load-balance Change multipool strategy from failover to even load balance
141
--log|-l <arg> Interval in seconds between log output (default: 5)
142
--monitor|-m <arg> Use custom pipe cmd for output messages
143
--no-longpoll Disable X-Long-Polling support
144
--no-restart Do not attempt to restart GPUs that hang
145
--pass|-p <arg> Password for bitcoin JSON-RPC server
146
--per-device-stats Force verbose mode and output per-device statistics
147
--protocol-dump|-P Verbose dump of protocol-level activities
148
--queue|-Q <arg> Minimum number of work items to have queued (0 - 10) (default: 1)
149
--quiet|-q Disable logging output, display status and errors
150
--real-quiet Disable all output
151
--retries|-r <arg> Number of times to retry before giving up, if JSON-RPC call fails (-1 means never) (default: -1)
152
--retry-pause|-R <arg> Number of seconds to pause, between retries (default: 5)
153
--rotate <arg> Change multipool strategy from failover to regularly rotate at N minutes (default: 0)
154
--round-robin Change multipool strategy from failover to round robin on failure
155
--scan-time|-s <arg> Upper bound on time spent scanning current work, in seconds (default: 60)
156
--sched-start <arg> Set a time of day in HH:MM to start mining (a once off without a stop time)
157
--sched-stop <arg> Set a time of day in HH:MM to stop mining (will quit without a start time)
158
--shares <arg> Quit after mining N shares (default: unlimited)
159
--submit-stale Submit shares even if they would normally be considered stale
160
--syslog Use system log for output messages (default: standard error)
161
--temp-cutoff <arg> Temperature where a GPU device will be automatically disabled, one value or comma separated list (default: 95)
162
--temp-hysteresis <arg> Set how much the temperature can fluctuate outside limits when automanaging speeds (default: 3)
163
--temp-overheat <arg> Overheat temperature when automatically managing fan and GPU speeds (default: 85)
164
--temp-target <arg> Target temperature when automatically managing fan and GPU speeds (default: 75)
165
--text-only|-T Disable ncurses formatted screen output
166
--url|-o <arg> URL for bitcoin JSON-RPC server
167
--user|-u <arg> Username for bitcoin JSON-RPC server
168
--vectors|-v <arg> Override detected optimal vector width (1, 2 or 4)
169
--verbose Log verbose output to stderr as well as status output
170
--worksize|-w <arg> Override detected optimal worksize (default: 0)
171
--userpass|-O <arg> Username:Password pair for bitcoin JSON-RPC server
172
Options for command line only:
173
--config|-c <arg> Load a JSON-format configuration file
174
See example-cfg.json for an example configuration.
175
--help|-h Print this message
176
--ndevs|-n Enumerate number of detected GPUs and exit
177
--version|-V Display version and exit
181
EXECUTIVE SUMMARY ON USAGE:
183
Single pool, regular desktop:
185
cgminer -o http://pool:port -u username -p password
187
Single pool, dedicated miner:
189
cgminer -o http://pool:port -u username -p password -I 9
191
Single pool, first card regular desktop, 3 other dedicated cards:
193
cgminer -o http://pool:port -u username -p password -I d,9,9,9
195
Multiple pool, dedicated miner:
197
cgminer -o http://pool1:port -u pool1username -p pool1password -o http://pool2:port -u pool2usernmae -p pool2password -I 9
199
Add overclocking settings, GPU and fan control for all cards:
201
cgminer -o http://pool:port -u username -p password -I 9 --auto-fan --auto-gpu --gpu-engine 750-950 --gpu-memclock 300
203
Add overclocking settings, GPU and fan control with different engine settings for 4 cards:
205
cgminer -o http://pool:port -u username -p password -I 9 --auto-fan --auto-gpu --gpu-engine 750-950,945,700-930,960 --gpu-memclock 300
207
READ WARNINGS AND DOCUMENTATION BELOW ABOUT OVERCLOCKING
209
On Linux you virtually always need to export your display settings before
210
starting to get all the cards recognised and/or temperature+clocking working:
218
The following options are available while running with a single keypress:
220
[P]ool management [G]PU management [S]ettings [D]isplay options [Q]uit
224
Current pool management strategy: Failover
225
[A]dd pool [R]emove pool [D]isable pool [E]nable pool
226
[C]hange management strategy [S]witch pool [I]nformation
240
Toggle: [D]ebug [N]ormal [S]ilent [V]erbose [R]PC debug
241
[L]og interval [C]lear
244
Q quits the application.
247
G gives you something like:
249
GPU 0: [124.2 / 191.3 Mh/s] [Q:212 A:77 R:33 HW:0 E:36% U:1.73/m]
251
Fan Speed: 35% (2500 RPM)
252
Engine Clock: 960 MHz
253
Memory Clock: 480 Mhz
257
Last initialised: [2011-09-06 12:03:56]
258
Thread 0: 62.4 Mh/s Enabled ALIVE
259
Thread 1: 60.2 Mh/s Enabled ALIVE
261
[E]nable [D]isable [R]estart GPU [C]hange settings
262
Or press any other key to continue
266
Also many issues and FAQs are covered in the forum thread
267
dedicated to this program,
268
http://forum.bitcoin.org/index.php?topic=28402.0
270
The output line shows the following:
271
GPU 1: 73.5C 2551RPM | 427.3/443.0Mh/s | A:8 R:0 HW:0 U:4.39/m
273
Each column is as follows:
274
Temperature (if supported)
275
Fanspeed (if supported)
276
A 5 second exponentially decaying average hash rate
277
An all time average hash rate
278
The number of accepted shares
279
The number of rejected shares
280
The number of hardware erorrs
281
The utility defines as the number of shares / minute
283
The cgminer status line shows:
284
TQ: 1 ST: 1 SS: 0 DW: 0 NB: 1 LW: 8 GF: 1 RF: 1
286
TQ is Total Queued work items.
287
ST is STaged work items (ready to use).
288
SS is Stale Shares discarded (detected and not submitted so don't count as rejects)
289
DW is Discarded Work items (work from block no longer valid to work on)
290
NB is New Blocks detected on the network
291
LW is Locally generated Work items
292
GF is Getwork Fail Occasions (server slow to provide work)
293
RF is Remote Fail occasions (server slow to accept work)
295
NOTE: Running intensities above 9 with current hardware is likely to only
296
diminish return performance even if the hash rate might appear better. A good
297
starting baseline intensity to try on dedicated miners is 9. Higher values are
298
there to cope with future improvements in hardware.
303
FAILOVER STRATEGIES WITH MULTIPOOL:
304
A number of different strategies for dealing with multipool setups are
305
available. Each has their advantages and disadvantages so multiple strategies
306
are available by user choice, as per the following list:
309
The default strategy is failover. This means that if you input a number of
310
pools, it will try to use them as a priority list, moving away from the 1st
311
to the 2nd, 2nd to 3rd and so on. If any of the earlier pools recover, it will
312
move back to the higher priority ones.
315
This strategy only moves from one pool to the next when the current one falls
316
idle and makes no attempt to move otherwise.
319
This strategy moves at user-defined intervals from one active pool to the next,
320
skipping pools that are idle.
323
This strategy sends work in equal amounts to all the pools specified. If any
324
pool falls idle, the rest will take up the slack keeping the miner busy.
329
cgminer will log to stderr if it detects stderr is being redirected to a file.
330
To enable logging simply add 2>logfile.txt to your command line and logfile.txt
331
will contain the logged output at the log level you specify (normal, verbose,
334
In other words if you would normally use:
335
./cgminer -o xxx -u yyy -p zzz
337
./cgminer -o xxx -u yyy -p zzz 2>logfile.txt
338
it will log to a file called logfile.txt and otherwise work the same.
341
There is also the -m option on linux which will spawn a command of your choice
342
and pipe the output directly to that command.
345
OVERCLOCKING WARNING AND INFORMATION
347
AS WITH ALL OVERCLOCKING TOOLS YOU ARE ENTIRELY RESPONSIBLE FOR ANY HARM YOU
348
MAY CAUSE TO YOUR HARDWARE. OVERCLOCKING CAN INVALIDATE WARRANTIES, DAMAGE
349
HARDWARE AND EVEN CAUSE FIRES. THE AUTHOR ASSUMES NO RESPONSIBILITY FOR ANY
350
DAMAGE YOU MAY CAUSE OR UNPLANNED CHILDREN THAT MAY OCCUR AS A RESULT.
352
The GPU monitoring, clocking and fanspeed control incorporated into cgminer
353
comes through use of the ATI Display Library. As such, it only supports ATI
354
GPUs. Even if ADL support is successfully built into cgminer, unless the card
355
and driver supports it, no GPU monitoring/settings will be available.
357
Cgminer supports initial setting of GPU engine clock speed, memory clock
358
speed, voltage, fanspeed, and the undocumented powertune feature of 69x0+ GPUs.
359
The setting passed to cgminer is used by all GPUs unless separate values are
360
specified. All settings can all be changed within the menu on the fly on a
364
--gpu-engine 950 --gpu-memclock 825
366
will try to set all GPU engine clocks to 950 and all memory clocks to 825,
368
--gpu-engine 950,945,930,960 --gpu-memclock 300
370
will try to set the engine clock of card 0 to 950, 1 to 945, 2 to 930, 3 to
371
960 and all memory clocks to 825.
374
There are two "auto" modes in cgminer, --auto-fan and --auto-gpu. These can
375
be used independently of each other and are complementary. Both auto modes
376
are designed to safely change settings while trying to maintain a target
377
temperature. By default this is set to 75 degrees C but can be changed with:
382
Sets all cards' target temperature to 80 degrees.
385
Sets card 0 target temperature to 75, and card 1 to 85 degrees.
389
--auto-fan (implies 85% upper limit)
390
--gpu-fan 25-85,65 --auto-fan
392
Fan control in auto fan works off the theory that the minimum possible fan
393
required to maintain an optimal temperature will use less power, make less
394
noise, and prolong the life of the fan. In auto-fan mode, the fan speed is
395
limited to 85% if the temperature is below "overheat" intentionally, as
396
higher fanspeeds on GPUs do not produce signficantly more cooling, yet
397
significanly shorten the lifespan of the fans. If temperature reaches the
398
overheat value, fanspeed will still be increased to 100%. The overheat value
399
is set to 85 degrees by default and can be changed with:
403
--temp-overheat 75,85
404
Sets card 0 overheat threshold to 75 degrees and card 1 to 85.
408
--auto-gpu --gpu-engine 750-950
409
--auto-gpu --gpu-engine 750-950,945,700-930,960
411
GPU control in auto gpu tries to maintain as high a clock speed as possible
412
while not reaching overheat temperatures. As a lower clock speed limit,
413
the auto-gpu mode checks the GPU card's "normal" clock speed and will not go
414
below this unless you have manually set a lower speed in the range. Also,
415
unless a higher clock speed was specified at startup, it will not raise the
416
clockspeed. If the temperature climbs, fanspeed is adjusted and optimised
417
before GPU engine clockspeed is adjusted. If fan speed control is not available
418
or already optimal, then GPU clock speed is only decreased if it goes over
419
the target temperature by the hysteresis amount, which is set to 3 by default
420
and can be changed with:
422
If the temperature drops below the target temperature, and engine clock speed
423
is not at the highest level set at startup, cgminer will raise the clock speed.
424
If at any time you manually set an even higher clock speed successfully in
425
cgminer, it will record this value and use it as its new upper limit (and the
426
same for low clock speeds and lower limits). If the temperature goes over the
427
cutoff limit (95 degrees by default), cgminer will completely disable the GPU
428
from mining and it will not be re-enabled unless manually done so. The cutoff
429
temperature can be changed with:
434
Sets card 0 cutoff temperature to 95 and card 1 to 105.
438
When setting values, it is important to realise that even though the driver
439
may report the value was changed successfully, and the new card power profile
440
information contains the values you set it to, that the card itself may
441
refuse to use those settings. As the performance profile changes dynamically,
442
querying the "current" value on the card can be wrong as well. So when changing
443
values in cgminer, after a pause of 1 second, it will report to you the current
444
values where you should check that your change has taken. An example is that
445
6970 reference cards will accept low memory values but refuse to actually run
446
those lower memory values unless they're within 125 of the engine clock speed.
447
In that scenario, they usually set their real speed back to their default.
449
Cgminer reports the so-called "safe" range of whatever it is you are modifying
450
when you ask to modify it on the fly. However, you can change settings to values
451
outside this range. Despite this, the card can easily refuse to accept your
452
changes, or worse, to accept your changes and then silently ignore them. So
453
there is absolutely to know how far to/from where/to it can set things safely or
454
otherwise, and there is nothing stopping you from at least trying to set them
455
outside this range. Being very conscious of these possible failures is why
456
cgminer will report back the current values for you to examine how exactly the
457
card has responded. Even within the reported range of accepted values by the
458
card, it is very easy to crash just about any card, so it cannot use those
459
values to determine what range to set. You have to provide something meaningful
460
manually for cgminer to work with through experimentation.
463
When cgminer starts up, it tries to read off the current profile information
464
for clock and fan speeds and stores these values. When quitting cgminer, it
465
will then try to restore the original values. Changing settings outside of
466
cgminer while it's running may be reset to the startup cgminer values when
467
cgminer shuts down because of this.
473
Q: cgminer segfaults when I change my shell window size.
474
A: Older versions of libncurses have a bug to do with refreshing a window
475
after a size change. Upgrading to a new version of curses will fix it.
477
Q: Can I mine on servers from different networks (eg smartcoin and bitcoin) at
479
A: No, cgminer keeps a database of the block it's working on to ensure it does
480
not work on stale blocks, and having different blocks from two networks would
481
make it invalidate the work from each other.
483
Q: Can I change the intensity settings individually for each GPU?
484
A: Yes, pass a list separated by commas such as -I d,4,9,9
486
Q: Can I put multiple pools in the json config file?
487
A: Not currently, but you can use multiple config files and specify each with
488
successive -c. e.g.: cgminer -c cfg1.json -c cfg2.json
490
Q: The build fails with gcc is unable to build a binary.
491
A: Remove the "-march=native" component of your CFLAGS as your version of gcc
494
Q: The CPU usage is high.
495
A: The ATI drivers after 11.6 have a bug that makes them consume 100% of one
496
CPU core unnecessarily so downgrade to 11.6. Binding cgminer to one CPU core on
497
windows can minimise it to 100% (instead of more than one core).
499
Q: Can you implement feature X?
500
A: I can, but time is limited, and people who donate are more likely to get
501
their feature requests implemented.
503
Q: My GPU hangs and I have to reboot it to get it going again?
504
A: The more aggressively the mining software uses your GPU, the less overclock
505
you will be able to run. You are more likely to hit your limits with cgminer
506
and you will find you may need to overclock your GPU less aggressively. The
507
software cannot be responsible and make your GPU hang directly. If you simply
508
cannot get it to ever stop hanging, try decreasing the intensity, and if even
509
that fails, try changing to the poclbm kernel with -k poclbm, though you will
510
sacrifice performance.
512
Q: Work keeps going to my backup pool even though my primary pool hasn't
514
A: Cgminer checks for conditions where the primary pool is lagging and will
515
pass some work to the backup servers under those conditions. The reason for
516
doing this is to try its absolute best to keep the GPUs working on something
517
useful and not risk idle periods. You can disable this behaviour with the
518
option --failover-only.
521
A: Cgminer is being packaged with other trojan scripts and some antivirus
522
software is falsely accusing cgminer.exe as being the actual virus, rather
523
than whatever it is being packaged with. If you installed cgminer yourself,
524
then you do not have a virus on your computer. Complain to your antivirus
527
Q: How does the donation feature work and how does it affect my shares?
528
A: The donation feature is disabled by default and only does anything once
529
enabled. It queries the author's website for login credentials and contributes
530
up to a proportion of work to the author's account. While the overall
531
accepted/rejected rates will include this work, none of these will appear in
532
your own accounts. On exiting, the summary will tell you how many shares were
533
contributed to the author.
540
This code is provided entirely free of charge by the programmer in his spare
541
time so donations would be greatly appreciated. Please consider using the
542
--donation feature or donate directly to the address below.
544
Con Kolivas <kernel@kolivas.org>
545
15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ
added
removed
README
