GOSTSec
/
sgminer
mirror of https://github.com/GOSTSec/sgminer
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

Merge pull request #483 from kanoi/master 

miner.php mcast + docs
nfactor-troky
kanoi 11 years ago
parent
326f5ea632 93d73a8a9a
commit
c9bf6ee1d2
4 changed files with 278 additions and 66 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 228
      API-README
  2. 5
      README
  3. 4
      cgminer.c
  4. 105
      miner.php

228
API-README
Unescape View File

@ -32,6 +32,10 @@ Using the "--api-allow" option overides the "--api-network" option if they @@ -32,6 +32,10 @@ Using the "--api-allow" option overides the "--api-network" option if they
are both specified
With "--api-allow", 127.0.0.1 is not by default given access unless specified
If you start cgminer also with the "--api-mcast" option, it will listen for
a multicast message and reply to it with a message containing it's API port
number, but only if the IP address of the sender is allowed API access
More groups (like the privileged group W:) can be defined using the
--api-groups command
Valid groups are only the letters A-Z (except R & W are predefined) and are
@ -42,7 +46,8 @@ To give an IP address/subnet access to a group you use the group letter @@ -42,7 +46,8 @@ To give an IP address/subnet access to a group you use the group letter
in front of the IP address instead of W: e.g. P:192.168.0/32
An IP address/subnet can only be a member of one group
A sample API group would be:
--api-groups P:switchpool:enablepool:addpool:disablepool:removepool:poolpriority:*
--api-groups
P:switchpool:enablepool:addpool:disablepool:removepool:poolpriority:*
This would create a group 'P' that can do all current pool commands and all
non-priviliged commands - the '*' means all non-priviledged commands
Without the '*' the group would only have access to the pool commands
@ -106,7 +111,7 @@ The STATUS section is: @@ -106,7 +111,7 @@ The STATUS section is:
For API version 1.10 and later:
The list of requests - a (*) means it requires privileged access - and replies are:
The list of requests - a (*) means it requires privileged access - and replies:
Request Reply Section Details
------- ------------- -------
@ -122,7 +127,8 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -122,7 +127,8 @@ The list of requests - a (*) means it requires privileged access - and replies a
ADL in use=X, <- Y or N if any GPU has ADL
Strategy=Name, <- the current pool strategy
Log Interval=N, <- log interval (--log N)
Device Code=GPU ICA , <- spaced list of compiled devices
Device Code=GPU ICA , <- spaced list of compiled
device drivers
OS=Linux/Apple/..., <- operating System
Failover-Only=true/false, <- failover-only setting
ScanTime=N, <- --scan-time setting
@ -132,15 +138,15 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -132,15 +138,15 @@ The list of requests - a (*) means it requires privileged access - and replies a
summary SUMMARY The status summary of the miner
e.g. Elapsed=NNN,Found Blocks=N,Getworks=N,...|
pools POOLS The status of each pool
e.g. Pool=0,URL=http://pool.com:6311,Status=Alive,...|
pools POOLS The status of each pool e.g.
Pool=0,URL=http://pool.com:6311,Status=Alive,...|
devs DEVS Each available GPU, PGA and ASC with their details
e.g. GPU=0,Accepted=NN,MHS av=NNN,...,Intensity=D|
Last Share Time=NNN, <- standand long time in seconds
Last Share Time=NNN, <- standand long time in sec
(or 0 if none) of last accepted share
Last Share Pool=N, <- pool number (or -1 if none)
Last Valid Work=NNN, <- standand long time in seconds
Last Valid Work=NNN, <- standand long time in sec
of last work returned that wasn't an HW:
Will not report PGAs if PGA mining is disabled
Will not report ASCs if ASC mining is disabled
@ -151,7 +157,8 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -151,7 +157,8 @@ The list of requests - a (*) means it requires privileged access - and replies a
pga|N PGA The details of a single PGA number N in the same
format and details as for DEVS
This is only available if PGA mining is enabled
Use 'pgacount' or 'config' first to see if there are any
Use 'pgacount' or 'config' first to see if there
are any
gpucount GPUS Count=N| <- the number of GPUs
@ -206,19 +213,23 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -206,19 +213,23 @@ The list of requests - a (*) means it requires privileged access - and replies a
gpuintensity|N,I (*)
none There is no reply section just the STATUS section
stating the results of setting GPU N intensity to I
stating the results of setting GPU N intensity
to I
gpumem|N,V (*)
none There is no reply section just the STATUS section
stating the results of setting GPU N memoryclock to V MHz
stating the results of setting GPU N memoryclock
to V MHz
gpuengine|N,V (*)
none There is no reply section just the STATUS section
stating the results of setting GPU N clock to V MHz
stating the results of setting GPU N clock
to V MHz
gpufan|N,V (*)
none There is no reply section just the STATUS section
stating the results of setting GPU N fan speed to V%
stating the results of setting GPU N fan speed
to V%
gpuvddc|N,V (*)
none There is no reply section just the STATUS section
@ -226,23 +237,25 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -226,23 +237,25 @@ The list of requests - a (*) means it requires privileged access - and replies a
save|filename (*)
none There is no reply section just the STATUS section
stating success or failure saving the cgminer config
to filename
stating success or failure saving the cgminer
config to filename
The filename is optional and will use the cgminer
default if not specified
quit (*) none There is no status section but just a single "BYE"
reply before cgminer quits
notify NOTIFY The last status and history count of each devices problem
This lists all devices including those not supported
by the 'devs' command
e.g. NOTIFY=0,Name=GPU,ID=0,Last Well=1332432290,...|
notify NOTIFY The last status and history count of each devices
problem
This lists all devices including those not
supported by the 'devs' command e.g.
NOTIFY=0,Name=GPU,ID=0,Last Well=1332432290,...|
privileged (*)
none There is no reply section just the STATUS section
stating an error if you do not have privileged access
to the API and success if you do have privilege
stating an error if you do not have privileged
access to the API and success if you do have
privilege
The command doesn't change anything in cgminer
pgaenable|N (*)
@ -260,25 +273,28 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -260,25 +273,28 @@ The list of requests - a (*) means it requires privileged access - and replies a
none There is no reply section just the STATUS section
stating the results of the identify request
This is only available if PGA mining is enabled
and currently only BFL singles support this command
and currently only BFL singles support this
command
On a BFL single it will flash the led on the front
of the device for appoximately 4s
All other non BFL PGA devices will return a warning
status message stating that they dont support it
This adds a 4s delay to the BFL share being processed
so you may get a message stating that procssing took
longer than 7000ms if the request was sent towards
the end of the timing of any work being worked on
All other non BFL PGA devices will return a
warning status message stating that they dont
support it
This adds a 4s delay to the BFL share being
processed so you may get a message stating that
procssing took longer than 7000ms if the request
was sent towards the end of the timing of any work
being worked on
e.g.: BFL0: took 8438ms - longer than 7000ms
You should ignore this
devdetails DEVDETAILS Each device with a list of their static details
This lists all devices including those not supported
by the 'devs' command
This lists all devices including those not
supported by the 'devs' command
e.g. DEVDETAILS=0,Name=GPU,ID=0,Driver=opencl,...|
restart (*) none There is no status section but just a single "RESTART"
reply before cgminer restarts
restart (*) none There is no status section but just a single
"RESTART" reply before cgminer restarts
stats STATS Each device or pool that has 1 or more getworks
with a list of stats regarding getwork times
@ -303,12 +319,13 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -303,12 +319,13 @@ The list of requests - a (*) means it requires privileged access - and replies a
debug|setting (*)
DEBUG Debug settings
The optional commands for 'setting' are the same as
the screen curses debug settings
The optional commands for 'setting' are the same
as the screen curses debug settings
You can only specify one setting
Only the first character is checked (case insensitive):
Silent, Quiet, Verbose, Debug, RPCProto, PerDevice,
WorkTime, Normal
Only the first character is checked - case
insensitive:
Silent, Quiet, Verbose, Debug, RPCProto,
PerDevice, WorkTime, Normal
The output fields are (as above):
Silent=true/false,
Quiet=true/false,
@ -330,34 +347,39 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -330,34 +347,39 @@ The list of requests - a (*) means it requires privileged access - and replies a
pgaset|N,opt[,val] (*)
none There is no reply section just the STATUS section
stating the results of setting PGA N with opt[,val]
stating the results of setting PGA N with
opt[,val]
This is only available if PGA mining is enabled
If the PGA does not support any set options, it will
always return a WARN stating pgaset isn't supported
If the PGA does not support any set options, it
will always return a WARN stating pgaset isn't
supported
If opt=help it will return an INFO status with a
help message about the options available
The current options are:
MMQ opt=clock val=160 to 230 (and a multiple of 2)
MMQ opt=clock val=160 to 230 (a multiple of 2)
zero|Which,true/false (*)
none There is no reply section just the STATUS section
stating that the zero, and optional summary, was done
If Which='all', all normal cgminer and API statistics
will be zeroed other than the numbers displayed by the
usbstats and stats commands
stating that the zero, and optional summary, was
done
If Which='all', all normal cgminer and API
statistics will be zeroed other than the numbers
displayed by the usbstats and stats commands
If Which='bestshare', only the 'Best Share' values
are zeroed for each pool and the global 'Best Share'
The true/false option determines if a full summary is
shown on the cgminer display like is normally displayed
on exit.
are zeroed for each pool and the global
'Best Share'
The true/false option determines if a full summary
is shown on the cgminer display like is normally
displayed on exit.
hotplug|N (*) none There is no reply section just the STATUS section
stating that the hotplug setting succeeded
If the code is not compiled with hotplug in it, the
the warning reply will be 'Hotplug is not available'
If the code is not compiled with hotplug in it,
the the warning reply will be
'Hotplug is not available'
If N=0 then hotplug will be disabled
If N>0 && <=9999, then hotplug will check for new
devices every N seconds
@ -395,11 +417,13 @@ The list of requests - a (*) means it requires privileged access - and replies a @@ -395,11 +417,13 @@ The list of requests - a (*) means it requires privileged access - and replies a
ascset|N,opt[,val] (*)
none There is no reply section just the STATUS section
stating the results of setting ASC N with opt[,val]
stating the results of setting ASC N with
opt[,val]
This is only available if ASC mining is enabled
If the ASC does not support any set options, it will
always return a WARN stating ascset isn't supported
If the ASC does not support any set options, it
will always return a WARN stating ascset isn't
supported
If opt=help it will return an INFO status with a
help message about the options available
@ -412,7 +436,8 @@ When you enable, disable or restart a GPU, PGA or ASC, you will also get @@ -412,7 +436,8 @@ When you enable, disable or restart a GPU, PGA or ASC, you will also get
Thread messages in the cgminer status window
The 'poolpriority' command can be used to reset the priority order of multiple
pools with a single command - 'switchpool' only sets a single pool to first priority
pools with a single command - 'switchpool' only sets a single pool to first
priority
Each pool should be listed by id number in order of preference (first = most
preferred)
Any pools not listed will be prioritised after the ones that are listed, in the
@ -461,6 +486,12 @@ miner.php - an example web page to access the API @@ -461,6 +486,12 @@ miner.php - an example web page to access the API
Feature Changelog for external applications using the API:
API V1.29 (cgminer v3.4.1)
Muticast identification added to the API
----------
API V1.28 (cgminer v3.3.4)
Modified API commands:
@ -574,8 +605,9 @@ Modified API commands: @@ -574,8 +605,9 @@ Modified API commands:
'pga|N' - add 'Diff1 Work', 'Difficulty Accepted',
'Difficulty Rejected', 'Last Share Difficulty'
'notify' - add '*Dev Throttle' (for BFL Singles)
'pools' - add 'Proxy Type', 'Proxy', 'Difficulty Accepted', 'Difficulty Rejected',
'Difficulty Stale', 'Last Share Difficulty'
'pools' - add 'Proxy Type', 'Proxy', 'Difficulty Accepted',
'Difficulty Rejected', 'Difficulty Stale',
'Last Share Difficulty'
'config' - add 'Queue', 'Expiry'
'stats' - add 'Work Diff', 'Min Diff', 'Max Diff', 'Min Diff Count',
'Max Diff Count' to the pool stats
@ -906,6 +938,22 @@ to @@ -906,6 +938,22 @@ to
See --api-network or --api-allow for more access details
and how to give write access
You can however, also tell miner.php to find your cgminer rigs automatically
on the local subnet
Add the following to each cgminer:
--api-mcast
or in your cgminer.conf
"api-mcast" : true,
And in miner.php set $mcast = true;
This will ignore the value of $rigs and overwrite it with the list of zero or
more rigs found on the network in the timout specified
---------
Once you have a web server with PHP running
@ -991,7 +1039,8 @@ the last one @@ -991,7 +1039,8 @@ the last one
So an example for 3 rigs would be:
$rigs = array('192.168.0.100:4028:A', '192.168.0.102:4028:B', '192.168.0.110:4028:C');
$rigs = array('192.168.0.100:4028:A', '192.168.0.102:4028:B',
'192.168.0.110:4028:C');
Of course each of the rigs listed would also have to have the API
running and be set to allow the web server to access the API - as
@ -1140,6 +1189,54 @@ e.g. $rigs = array('127.0.0.1:4028','myrig.com:4028:Sugoi'); @@ -1140,6 +1189,54 @@ e.g. $rigs = array('127.0.0.1:4028','myrig.com:4028:Sugoi');
---------
Default:
$mcast = false;
Set $mcast to true to look for your rigs and ignore $rigs
---------
Default:
$mcastaddr = '224.0.0.75';
API Multicast address all cgminers are listening on
---------
Default:
$mcastport = 4028;
API Multicast UDP port all cgminers are listening on
---------
Default:
$mcastcode = 'FTW';
The code all cgminers expect in the Multicast message sent
The message sent is "cgm-code-listport"
Don't use the '-' character if you change it
---------
Default:
$mcastlistport = 4027;
UDP port number that is added to the broadcast message sent
that specifies to the cgminers the port to reply on
---------
Default:
$mcasttimeout = 1.5;
Set $mcasttimeout to the number of seconds (floating point)
to wait for replies to the Multicast message
N.B. the accuracy of the timing used to wait for the replies is
~0.1s so there's no point making it more than one decimal place
---------
Default:
$rigipsecurity = true;
@ -1318,11 +1415,14 @@ Looking at the Mobile example: @@ -1318,11 +1415,14 @@ Looking at the Mobile example:
'DEVS.Temperature=Temp', 'DEVS.MHS av=MHS av',
'DEVS.Accepted=Accept', 'DEVS.Rejected=Rej',
'DEVS.Utility=Utility', 'NOTIFY.Last Not Well=Not Well'),
'POOL' => array('POOL', 'Status', 'Accepted', 'Rejected=Rej', 'Last Share Time'));
'POOL' => array('POOL', 'Status', 'Accepted', 'Rejected=Rej',
'Last Share Time'));
$mobilesum = array(
'SUMMARY' => array('MHS av', 'Found Blocks', 'Accepted', 'Rejected', 'Utility'),
'DEVS+NOTIFY' => array('DEVS.MHS av', 'DEVS.Accepted', 'DEVS.Rejected', 'DEVS.Utility'),
'SUMMARY' => array('MHS av', 'Found Blocks', 'Accepted', 'Rejected',
'Utility'),
'DEVS+NOTIFY' => array('DEVS.MHS av', 'DEVS.Accepted', 'DEVS.Rejected',
'DEVS.Utility'),
'POOL' => array('Accepted', 'Rejected'));
$customsummarypages = array('Mobile' => array($mobilepage, $mobilesum));
@ -1409,8 +1509,10 @@ $poolsext = array( @@ -1409,8 +1509,10 @@ $poolsext = array(
'POOL.Stratum Active', 'POOL.Has GBT'),
'calc' => array('POOL.Difficulty Accepted' => 'sum',
'POOL.Difficulty Rejected' => 'sum',
'STATS.Times Sent' => 'sum', 'STATS.Bytes Sent' => 'sum',
'STATS.Times Recv' => 'sum', 'STATS.Bytes Recv' => 'sum'),
'STATS.Times Sent' => 'sum',
'STATS.Bytes Sent' => 'sum',
'STATS.Times Recv' => 'sum',
'STATS.Bytes Recv' => 'sum'),
'having' => array(array('STATS.Bytes Recv', '>', 0)))
);
@ -1460,5 +1562,5 @@ The first 4 are as expected - the numerical sum, average, minimum or maximum @@ -1460,5 +1562,5 @@ The first 4 are as expected - the numerical sum, average, minimum or maximum
'count' is the number of rows in the section specified in the calc e.g.
('DEVS.Name' => 'count') would be the number of DEVS selected in the 'where'
of course any valid 'DEVS.Xyz' would give the same 'count' value
'any' is effectively random: the field value in the first row of the grouped data
'any' is effectively random: the field value in the 1st row of the grouped data
An unrecognised 'function' uses 'any'

5
README
Unescape View File

@ -195,6 +195,11 @@ Options for both config file and command line: @@ -195,6 +195,11 @@ Options for both config file and command line:
By default any command that does not just display data returns access denied
See --api-allow to overcome this
--api-network Allow API (if enabled) to listen on/for any address (default: only 127.0.0.1)
--api-mcast Enable API Multicast listener, (default: disabled)
The listener will only run if the API is also enabled
--api-mcast-addr API Multicast listen address, (default: 224.0.0.75)
--api-mcast-code Code expected in the API Multicast message, don't use '-' (default: "FTW")
--api-mcast-port API Multicast listen port, (default: 4028)
--api-port Port number of miner API (default: 4028)
--auto-fan Automatically adjust all GPU fan speeds to maintain a target temperature
--auto-gpu Automatically adjust all GPU engine clock speeds to maintain a target temperature

4
cgminer.c
Unescape View File

@ -969,10 +969,10 @@ static struct opt_table opt_config_table[] = { @@ -969,10 +969,10 @@ static struct opt_table opt_config_table[] = {
"API Multicast listen address"),
OPT_WITH_ARG("--api-mcast-code",
set_api_mcast_code, NULL, NULL,
"Code expected in the API Multicast"),
"Code expected in the API Multicast message, don't use '-'"),
OPT_WITH_ARG("--api-mcast-port",
set_int_1_to_65535, opt_show_intval, &opt_api_mcast_port,
"Port number of miner API Multicast listener"),
"API Multicast listen port"),
OPT_WITHOUT_ARG("--api-network",
opt_set_bool, &opt_api_network,
"Allow API (if enabled) to listen on/for any address, default: only 127.0.0.1"),

105
miner.php
Unescape View File

@ -2,6 +2,8 @@ @@ -2,6 +2,8 @@
session_start();
#
global $title, $miner, $port, $readonly, $notify, $rigs;
global $mcast, $mcastaddr, $mcastport, $mcastcode;
global $mcastlistport, $mcasttimeout;
global $rigipsecurity, $rigtotals, $forcerigtotals;
global $socksndtimeoutsec, $sockrcvtimeoutsec;
global $checklastshare, $poolinputs, $hidefields;
@ -43,6 +45,25 @@ $poolinputs = false; @@ -43,6 +45,25 @@ $poolinputs = false;
# format: 'IP:Port' or 'Host:Port' or 'Host:Port:Name'
$rigs = array('127.0.0.1:4028');
#
# Set $mcast to true to look for your rigs and ignore $rigs
$mcast = false;
#
# API Multicast address all cgminers are listening on
$mcastaddr = '224.0.0.75';
#
# API Multicast UDP port all cgminers are listening on
$mcastport = 4028;
#
# The code all cgminers expect in the Multicast message sent
$mcastcode = 'FTW';
#
# UDP port cgminers are to reply on (by request)
$mcastlistport = 4027;
#
# Set $mcasttimeout to the number of seconds (floating point)
# to wait for replies to the Multicast message
$mcasttimeout = 1.5;
#
# Set $rigipsecurity to false to show the IP/Port of the rig
# in the socket error messages and also show the full socket message
$rigipsecurity = true;
@ -324,6 +345,88 @@ global $haderror, $error; @@ -324,6 +345,88 @@ global $haderror, $error;
$haderror = false;
$error = null;
#
function getrigs()
{
global $rigs, $mcastaddr, $mcastport, $mcastcode, $mcasttimeout, $error;
$listname = "0.0.0.0";
$rigs = array();
$rep_soc = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
if ($rep_soc === false || $rep_soc == null)
{
$msg = "ERR: mcast listen socket create(UDP) failed";
if ($rigipsecurity === false)
{
$error = socket_strerror(socket_last_error());
$error = "$msg '$error'\n";
}
else
$error = "$msg\n";
return;
}
$res = socket_bind($rep_soc, $listname, $mcastlistport);
if ($res === false)
{
$msg1 = "ERR: mcast listen socket bind(";
$msg2 = ") failed";
if ($rigipsecurity === false)
{
$error = socket_strerror(socket_last_error());
$error = "$msg1$listname,$mcastlistport$msg2 '$error'\n";
}
else
$error = "$msg1$msg2\n";
socket_close($rep_soc);
return;
}
$mcast_soc = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
if ($mcast_soc === false || $mcast_soc == null)
{
$msg = "ERR: mcast send socket create(UDP) failed";
if ($rigipsecurity === false)
{
$error = socket_strerror(socket_last_error());
$error = "$msg '$error'\n";
}
else
$error = "$msg\n";
socket_close($rep_soc);
return;
}
$buf = "cgminer-$mcastcode-$mcastlistport";
socket_sendto($mcast_soc, $buf, strlen($buf), 0, $mcastaddr, $mcastport);
socket_close($mcast_soc);
$stt = microtime(true);
while (true)
{
$got = @socket_recvfrom($rep_soc, $buf, 32, MSG_DONTWAIT, $ip, $p);
if ($got !== false && $got > 0)
{
$ans = explode('-', $buf);
if (count($ans) == 3 && $ans[0] == 'cgm' && $ans[1] == 'FTW')
{
$rp = intval($ans[2]);
$rigs[] = "$ip:$rp";
}
}
if ((microtime(true) - $stt) >= $mcasttimeout)
break;
usleep(100000);
}
socket_close($rep_soc);
}
#
function getsock($rig, $addr, $port)
{
global $rigipsecurity;
@ -2768,6 +2871,8 @@ function display() @@ -2768,6 +2871,8 @@ function display()
pagebuttons(null, null);
}
#
if (isset($mcast) && $mcast === true)
getrigs();
display();
#
?>

Write Preview
Loading…
Cancel
Save