API v0.1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
diff --git a/api-example.php b/api-example.php
new file mode 100644
index 0000000..12486c0
--- /dev/null
+++ b/api-example.php
@@ -0,0 +1,117 @@
+<?php
+#
+# Sample Socket I/O to CGMiner API
+#
+function getsock($port)
+{
+ $socket = null;
+ $socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
+ if ($socket === false || $socket === null)
+ {
+ $error = socket_strerror(socket_last_error());
+ $msg = "socket create($port) failed";
+ echo "ERR: $msg '$error'\n";
+ return NULL;
+ }
+
+ $res = socket_connect($socket, '127.0.0.1', $port);
+ if ($res === false)
+ {
+ $error = socket_strerror(socket_last_error());
+ $msg = "socket connect($port) failed";
+ echo "ERR: $msg '$error'\n";
+ socket_close($socket);
+ return NULL;
+ }
+ return $socket;
+}
+#
+# Slow ...
+function readsockline($socket)
+{
+ $line = '';
+ while (true)
+ {
+ $byte = socket_read($socket, 1);
+ if ($byte === false || $byte === '')
+ break;
+ if ($byte === "\0")
+ break;
+ $line .= $byte;
+ }
+ return $line;
+}
+#
+function request($cmd)
+{
+ $socket = getsock(4028);
+ if ($socket != null)
+ {
+ socket_write($socket, $cmd, strlen($cmd));
+ $line = readsockline($socket);
+ socket_close($socket);
+
+ if (strlen($line) == 0)
+ {
+ echo "WARN: '$cmd' returned nothing\n";
+ return $line;
+ }
+
+ print "$cmd returned '$line'\n";
+
+ $data = array();
+
+ $objs = explode('|', $line);
+ foreach ($objs as $obj)
+ {
+ if (strlen($obj) > 0)
+ {
+ $items = explode(',', $obj);
+ $item = $items[0];
+ $id = explode('=', $items[0], 2);
+ if (count($id) == 1)
+ $name = $id[0];
+ else
+ $name = $id[0].$id[1];
+
+ if (strlen($name) == 0)
+ $name = 'null';
+
+ if (isset($data[$name]))
+ {
+ $num = 1;
+ while (isset($data[$name.$num]))
+ $num++;
+ $name .= $num;
+ }
+
+ $counter = 0;
+ foreach ($items as $item)
+ {
+ $id = explode('=', $item, 2);
+ if (count($id) == 2)
+ $data[$name][$id[0]] = $id[1];
+ else
+ $data[$name][$counter] = $id[0];
+
+ $counter++;
+ }
+ }
+ }
+
+ return $data;
+ }
+
+ return null;
+}
+#
+$ver = request('apiversion');
+echo print_r($ver, true)."\n";
+#
+$dev = request('dev');
+echo print_r($dev, true)."\n";
+#
+$pool = request('pool');
+echo print_r($pool, true)."\n";
+#
+?>
diff --git a/api.c b/api.c
new file mode 100644
index 0000000..1f7dd81
--- /dev/null
+++ b/api.c
@@ -0,0 +1,296 @@
+/*
+ * Copyright 2011 Kano
+ * Copyright 2011 Con Kolivas
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version. See COPYING for more details.
+ */
+
+#include "config.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <unistd.h>
+#include <sys/time.h>
+#include <time.h>
+#include <math.h>
+#include <stdarg.h>
+#include <assert.h>
+
+#include <sys/stat.h>
+#include <sys/types.h>
+
+#include "compat.h"
+#include "miner.h"
+
+#if defined(unix)
+ #include <errno.h>
+// #include <fcntl.h>
+// #include <sys/wait.h>
+#endif
+
+// Big enough for largest API request
+// though a PC with 100s of CPUs may exceed the size ...
+// Current code assumes it can socket send this size also
+#define MYBUFSIZ 16384
+
+static char *buffer = NULL;
+
+static const char *UNAVAILABLE = " - API will not be available";
+
+static const char *BLANK = "";
+
+static const char *VERSION = "0.1";
+static const char *DEAD = "DEAD";
+static const char *SICK = "SICK";
+static const char *DISABLED = "DISABLED";
+static const char * = "";
+zzz -> other pool status
+
+static int bye = 0;
+
+char *apiversion(char *params)
+{
+ return VERSION;
+}
+
+void gpustatus(int thr_id)
+{
+ char buf[BUFSIZ];
+ char status_buf[BUFSIZ];
+ char *status;
+ float gt;
+ int gf, gp;
+
+ if (thr_id >= 0 && thr_id < gpu_threads) {
+ int gpu = dev_from_id(thr_id);
+ struct cgpu_info *cgpu = &gpus[gpu];
+
+ cgpu->utility = cgpu->accepted / ( total_secs ? total_secs : 1 ) * 60;
+
+#ifdef HAVE_ADL
+ if (cgpu->has_adl) {
+ gt = gpu_temp(gpu);
+ gf = gpu_fanspeed(gpu);
+ gp = gpu_fanpercent(gpu);
+ }
+ else
+#endif
+ gt = gf = gp = 0;
+
+ if (cgpu->status == LIFE_DEAD)
+ status = DEAD;
+ else if (cgpu->status == LIFE_SICK)
+ status = SICK;
+ else if (!gpu_devices[gpu])
+ status = DISABLED;
+ else {
+ sprintf(status_buf, "%.1f", cgpu->rolling);
+ status = status_buf;
+ }
+
+ sprintf(buf, "G%d=%.2f,%d,%d,%s,%.2f,%d,%d,%d,%.2f,%d|",
+ gpu, gt, gf, gp, status,
+ cgpu->total_mhashes / total_secs,
+ cgpu->accepted, cgpu->rejected, cgpu->hw_errors,
+ cgpu->utility, gpus[gpu].intensity);
+
+ strcat(buffer, buf);
+ }
+}
+
+void cpustatus(int thr_id)
+{
+ char buf[BUFSIZ];
+
+ if (thr_id >= gpu_threads) {
+ int cpu = dev_from_id(thr_id);
+ struct cgpu_info *cgpu = &cpus[cpu];
+
+ cgpu->utility = cgpu->accepted / ( total_secs ? total_secs : 1 ) * 60;
+
+ sprintf(buf, "C%d=%.2f,%.2f,%d,%d,%d,%.2f,%d|",
+ cpu, cgpu->rolling,
+ cgpu->total_mhashes / total_secs,
+ cgpu->accepted, cgpu->rejected, cgpu->hw_errors,
+ cgpu->utility, gpus[gpu].intensity);
+
+ strcat(buffer, buf);
+ }
+}
+
+char *devstatus(char *params)
+{
+ int i;
+
+ *buffer = '\0';
+
+ for (i = 0; i < gpu_threads; i++)
+ gpustatus(i);
+
+ for (i = gpu_threads; i < mining_threads; i++)
+ cpustatus(i);
+
+ return buffer;
+}
+
+char *poolstatus(char *params)
+{
+ char buf[BUFSIZ];
+ char *status;
+ int i;
+
+ *buffer = '\0';
+
+ for (i = 0; i < total_pools; i++) {
+ struct pool *pool = pools[i];
+
+ if (!pool->enabled)
+ status = DISABLED;
+ else
+ status = OK;
+
+ sprintf(buf, "P%d=%s,%s,%d,%d,%d,%d,%d,%d,%d|",
+ i, pool->rpc_url, status,
+ pool->getwork_requested,
+ pool->accepted, pool->rejected,
+ pool->discarded_work,
+ pool->stale_shares,
+ pool->getfail_occasions,
+ pool->remotefail_occasions);
+
+ strcat(buffer, buf);
+ }
+
+ return buffer;
+}
+
+struct CMDS {
+ const char *cmd;
+ char (*func)();
+} cmds[] = {
+ { "apiversion", apiversion },
+ { "dev", devstatus },
+ { "pool", poolstatus }
+};
+
+#define MAXCMD sizeof(cmds)/sizeof(struct CMDS)
+
+void send_result(int c, char *result)
+{
+ int n;
+
+ if (result == NULL)
+ result = BLANK;
+
+ // ignore failure - it's closed immediately anyway
+ n = write(c, result, strlen(result)+1);
+}
+
+static void api()
+{
+ const char *addr;
+ int c, sock, n, bound;
+ char *binderror;
+ time_t bindstart;
+ short int port = 4028;
+ struct sockaddr_in serv;
+ struct sockaddr_in cli;
+ socklen_t clisiz;
+ long long counter;
+ char *result;
+ char *params;
+
+ addr = "127.0.0.1";
+
+ sock = socket(AF_INET, SOCK_STREAM, 0);
+ if (sock < 0) {
+ applog(LOG_ERR, "API1 initialisation failed (%s)%s", strerror(errno), UNAVAILABLE);
+ return NULL;
+ }
+
+ memset(&serv, 0, sizeof(serv));
+
+ serv.sin_family = AF_INET;
+ if (inet_pton(AF_INET, addr, &(serv.sin_addr)) == 0) {
+ applog(LOG_ERR, "API2 initialisation failed (%s)%s", strerror(errno), UNAVAILABLE);
+ return NULL;
+ }
+ serv.sin_port = htons(port);
+
+ // try for 1 minute ... in case the old one hasn't completely gone yet
+ bound = 0;
+ bindstart = time(NULL);
+ while (bound == 0) {
+ if (bind(sock, (struct sockaddr *)(&serv), sizeof(serv)) < 0) {
+ binderror = strerror(errno);
+ if ((time(NULL) - bindstart) > 61)
+ break;
+ else {
+ applog(LOG_ERR, "API bind to port %d failed - trying again in 10sec", port);
+ sleep(10);
+ }
+ }
+ else
+ bound = 1;
+ }
+
+ if (bound == 0) {
+ applog(LOG_ERR, "API bind to port %d failed (%s)%s", port, binderror, UNAVAILABLE);
+ return NULL;
+ }
+
+ if (listen(sock, QUEUE) < 0) {
+ applog(LOG_ERR, "API3 initialisation failed (%s)%s", strerror(errno), UNAVAILABLE);
+ close(sock);
+ return NULL;
+ }
+
+ buffer = malloc(MYBUFSIZ+1);
+
+ counter = 0;
+ while (bye == 0) {
+ counter++;
+
+ clisiz = sizeof(cli);
+ if ((c = accept(sock, (struct sockaddr *)(&cli), &clisiz)) < 0) {
+ applog(LOG_ERR, "API failed (%s)%s", strerror(errno), UNAVAILABLE);
+ close(sock);
+ free(buffer);
+ return NULL;
+ }
+
+ inet_ntop(AF_INET, &(cli.sin_addr), &(tmpaddr[0]), sizeof(tmpaddr)-1);
+ if (strcmp(tmpaddr, addr) != 0)
+ close(c);
+ else {
+ n = read(c, &buf[0], BUFS);
+ if (n < 0)
+ close(c);
+ else {
+ params = strchr(buf, '|');
+ if (params != NULL)
+ *(params++) = '\0';
+
+ for (i = 0; i < CMDMAX; i++) {
+ if (strcmp(buf, cmds[i].name) == 0) {
+ result = cmds[i].func(params);
+ send_result(c, result);
+ close(c);
+ break;
+ }
+ }
+ }
+ }
+ }
+
+ close(sock);
+ free(buffer);
+
+ return NULL;
+}