/* * Copyright 2010 Jeff Garzik * * 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 "cpuminer-config.h" #define _GNU_SOURCE #include #include #include #include #include #include #include #include #if defined(WIN32) || defined(WIN64) #include #else #include #include #endif #include #include #include #include "compat.h" #include "miner.h" #define PROGRAM_NAME "minerd" #define DEF_RPC_URL "http://127.0.0.1:9332/" #define LP_SCANTIME 60 #ifdef __linux /* Linux specific policy and affinity management */ #include static inline void drop_policy(void) { struct sched_param param; #ifdef SCHED_IDLE if (unlikely(sched_setscheduler(0, SCHED_IDLE, ¶m) == -1)) #endif #ifdef SCHED_BATCH sched_setscheduler(0, SCHED_BATCH, ¶m); #endif } static inline void affine_to_cpu(int id, int cpu) { cpu_set_t set; CPU_ZERO(&set); CPU_SET(cpu, &set); sched_setaffinity(0, sizeof(&set), &set); applog(LOG_INFO, "Binding thread %d to cpu %d", id, cpu); } #else static inline void drop_policy(void) { } static inline void affine_to_cpu(int id, int cpu) { } #endif enum workio_commands { WC_GET_WORK, WC_SUBMIT_WORK, }; struct workio_cmd { enum workio_commands cmd; struct thr_info *thr; union { struct work *work; } u; }; enum sha256_algos { ALGO_SCRYPT, /* scrypt(1024,1,1) */ }; static const char *algo_names[] = { [ALGO_SCRYPT] = "scrypt", }; bool opt_debug = false; bool opt_protocol = false; bool want_longpoll = true; bool have_longpoll = false; bool use_syslog = false; static bool opt_quiet = false; static int opt_retries = -1; static int opt_fail_pause = 30; int opt_timeout = 180; int opt_scantime = 5; static json_t *opt_config; static const bool opt_time = true; static enum sha256_algos opt_algo = ALGO_SCRYPT; static int opt_n_threads; static int num_processors; static char *rpc_url; static char *rpc_userpass; static char *rpc_user, *rpc_pass; struct thr_info *thr_info; static int work_thr_id; int longpoll_thr_id; struct work_restart *work_restart = NULL; pthread_mutex_t time_lock; pthread_mutex_t stats_lock; static unsigned long accepted_count = 0L; static unsigned long rejected_count = 0L; double *thr_hashrates; static char const usage[] = "\ Usage: " PROGRAM_NAME " [OPTIONS]\n\ Options:\n\ -o, --url=URL URL of mining server (default: " DEF_RPC_URL ")\n\ -O, --userpass=U:P username:password pair for mining server\n\ -u, --user=USERNAME username for mining server\n\ -p, --pass=PASSWORD password for mining server\n\ -t, --threads=N number of miner threads (default: number of processors)\n\ -r, --retries=N number of times to retry if a network call fails\n\ (default: retry indefinitely)\n\ -R, --retry-pause=N time to pause between retries, in seconds (default: 30)\n\ -T, --timeout=N network timeout, in seconds (default: 180)\n\ -s, --scantime=N upper bound on time spent scanning current work,\n\ in seconds (default: 5)\n\ --no-longpoll disable X-Long-Polling support\n\ -q, --quiet disable per-thread hashmeter output\n\ -D, --debug enable debug output\n\ -P, --protocol-dump verbose dump of protocol-level activities\n" #ifdef HAVE_SYSLOG_H "\ --syslog use system log for output messages\n" #endif "\ -c, --config=FILE load a JSON-format configuration file\n\ -V, --version display version information and exit\n\ -h, --help display this help text and exit\n\ "; static char const short_options[] = "a:c:Dhp:Pqr:R:s:t:T:o:u:O:V"; static struct option const options[] = { { "algo", 1, NULL, 'a' }, { "config", 1, NULL, 'c' }, { "debug", 0, NULL, 'D' }, { "help", 0, NULL, 'h' }, { "no-longpoll", 0, NULL, 1003 }, { "pass", 1, NULL, 'p' }, { "protocol-dump", 0, NULL, 'P' }, { "quiet", 0, NULL, 'q' }, { "retries", 1, NULL, 'r' }, { "retry-pause", 1, NULL, 'R' }, { "scantime", 1, NULL, 's' }, #ifdef HAVE_SYSLOG_H { "syslog", 0, NULL, 1004 }, #endif { "threads", 1, NULL, 't' }, { "timeout", 1, NULL, 'T' }, { "url", 1, NULL, 'o' }, { "user", 1, NULL, 'u' }, { "userpass", 1, NULL, 'O' }, { "version", 0, NULL, 'V' }, { } }; struct work { unsigned char data[128]; unsigned char target[32]; unsigned char hash[32]; }; static struct work g_work; static time_t g_work_time; static pthread_mutex_t g_work_lock; static bool jobj_binary(const json_t *obj, const char *key, void *buf, size_t buflen) { const char *hexstr; json_t *tmp; tmp = json_object_get(obj, key); if (unlikely(!tmp)) { applog(LOG_ERR, "JSON key '%s' not found", key); return false; } hexstr = json_string_value(tmp); if (unlikely(!hexstr)) { applog(LOG_ERR, "JSON key '%s' is not a string", key); return false; } if (!hex2bin(buf, hexstr, buflen)) return false; return true; } static bool work_decode(const json_t *val, struct work *work) { if (unlikely(!jobj_binary(val, "data", work->data, sizeof(work->data)))) { applog(LOG_ERR, "JSON inval data"); goto err_out; } if (unlikely(!jobj_binary(val, "target", work->target, sizeof(work->target)))) { applog(LOG_ERR, "JSON inval target"); goto err_out; } memset(work->hash, 0, sizeof(work->hash)); return true; err_out: return false; } static bool submit_upstream_work(CURL *curl, const struct work *work) { char *hexstr = NULL; json_t *val, *res; char s[345]; double hashrate; int i; bool rc = false; /* build hex string */ hexstr = bin2hex(work->data, sizeof(work->data)); if (unlikely(!hexstr)) { applog(LOG_ERR, "submit_upstream_work OOM"); goto out; } /* build JSON-RPC request */ sprintf(s, "{\"method\": \"getwork\", \"params\": [ \"%s\" ], \"id\":1}\r\n", hexstr); /* issue JSON-RPC request */ val = json_rpc_call(curl, rpc_url, rpc_userpass, s, false, false, NULL); if (unlikely(!val)) { applog(LOG_ERR, "submit_upstream_work json_rpc_call failed"); goto out; } res = json_object_get(val, "result"); hashrate = 0.; pthread_mutex_lock(&stats_lock); for (i = 0; i < opt_n_threads; i++) hashrate += thr_hashrates[i]; json_is_true(res) ? accepted_count++ : rejected_count++; pthread_mutex_unlock(&stats_lock); applog(LOG_INFO, "accepted: %lu/%lu (%.2f%%), %.2f khash/s %s", accepted_count, accepted_count + rejected_count, 100. * accepted_count / (accepted_count + rejected_count), 1e-3 * hashrate, json_is_true(res) ? "(yay!!!)" : "(booooo)"); json_decref(val); rc = true; out: free(hexstr); return rc; } static const char *rpc_req = "{\"method\": \"getwork\", \"params\": [], \"id\":0}\r\n"; static bool get_upstream_work(CURL *curl, struct work *work) { json_t *val; bool rc; val = json_rpc_call(curl, rpc_url, rpc_userpass, rpc_req, want_longpoll, false, NULL); if (!val) return false; rc = work_decode(json_object_get(val, "result"), work); json_decref(val); return rc; } static void workio_cmd_free(struct workio_cmd *wc) { if (!wc) return; switch (wc->cmd) { case WC_SUBMIT_WORK: free(wc->u.work); break; default: /* do nothing */ break; } memset(wc, 0, sizeof(*wc)); /* poison */ free(wc); } static bool workio_get_work(struct workio_cmd *wc, CURL *curl) { struct work *ret_work; int failures = 0; ret_work = calloc(1, sizeof(*ret_work)); if (!ret_work) return false; /* obtain new work from bitcoin via JSON-RPC */ while (!get_upstream_work(curl, ret_work)) { if (unlikely((opt_retries >= 0) && (++failures > opt_retries))) { applog(LOG_ERR, "json_rpc_call failed, terminating workio thread"); free(ret_work); return false; } /* pause, then restart work-request loop */ applog(LOG_ERR, "json_rpc_call failed, retry after %d seconds", opt_fail_pause); sleep(opt_fail_pause); } /* send work to requesting thread */ if (!tq_push(wc->thr->q, ret_work)) free(ret_work); return true; } static bool workio_submit_work(struct workio_cmd *wc, CURL *curl) { int failures = 0; /* submit solution to bitcoin via JSON-RPC */ while (!submit_upstream_work(curl, wc->u.work)) { if (unlikely((opt_retries >= 0) && (++failures > opt_retries))) { applog(LOG_ERR, "...terminating workio thread"); return false; } /* pause, then restart work-request loop */ applog(LOG_ERR, "...retry after %d seconds", opt_fail_pause); sleep(opt_fail_pause); } return true; } static void *workio_thread(void *userdata) { struct thr_info *mythr = userdata; CURL *curl; bool ok = true; curl = curl_easy_init(); if (unlikely(!curl)) { applog(LOG_ERR, "CURL initialization failed"); return NULL; } while (ok) { struct workio_cmd *wc; /* wait for workio_cmd sent to us, on our queue */ wc = tq_pop(mythr->q, NULL); if (!wc) { ok = false; break; } /* process workio_cmd */ switch (wc->cmd) { case WC_GET_WORK: ok = workio_get_work(wc, curl); break; case WC_SUBMIT_WORK: ok = workio_submit_work(wc, curl); break; default: /* should never happen */ ok = false; break; } workio_cmd_free(wc); } tq_freeze(mythr->q); curl_easy_cleanup(curl); return NULL; } static bool get_work(struct thr_info *thr, struct work *work) { struct workio_cmd *wc; struct work *work_heap; /* fill out work request message */ wc = calloc(1, sizeof(*wc)); if (!wc) return false; wc->cmd = WC_GET_WORK; wc->thr = thr; /* send work request to workio thread */ if (!tq_push(thr_info[work_thr_id].q, wc)) { workio_cmd_free(wc); return false; } /* wait for response, a unit of work */ work_heap = tq_pop(thr->q, NULL); if (!work_heap) return false; /* copy returned work into storage provided by caller */ memcpy(work, work_heap, sizeof(*work)); free(work_heap); return true; } static bool submit_work(struct thr_info *thr, const struct work *work_in) { struct workio_cmd *wc; /* fill out work request message */ wc = calloc(1, sizeof(*wc)); if (!wc) return false; wc->u.work = malloc(sizeof(*work_in)); if (!wc->u.work) goto err_out; wc->cmd = WC_SUBMIT_WORK; wc->thr = thr; memcpy(wc->u.work, work_in, sizeof(*work_in)); /* send solution to workio thread */ if (!tq_push(thr_info[work_thr_id].q, wc)) goto err_out; return true; err_out: workio_cmd_free(wc); return false; } static void *miner_thread(void *userdata) { struct thr_info *mythr = userdata; int thr_id = mythr->id; uint32_t max_nonce; uint32_t next_nonce; unsigned char *scratchbuf = NULL; /* Set worker threads to nice 19 and then preferentially to SCHED_IDLE * and if that fails, then SCHED_BATCH. No need for this to be an * error if it fails */ setpriority(PRIO_PROCESS, 0, 19); drop_policy(); /* Cpu affinity only makes sense if the number of threads is a multiple * of the number of CPUs */ if (!(opt_n_threads % num_processors)) affine_to_cpu(mythr->id, mythr->id % num_processors); if (opt_algo == ALGO_SCRYPT) { scratchbuf = scrypt_buffer_alloc(); } while (1) { struct work work __attribute__((aligned(128))); unsigned long hashes_done; struct timeval tv_start, tv_end, diff; int64_t max64; bool rc; /* obtain new work from internal workio thread */ pthread_mutex_lock(&g_work_lock); if (!have_longpoll || time(NULL) >= g_work_time + LP_SCANTIME*3/4) { if (unlikely(!get_work(mythr, &g_work))) { applog(LOG_ERR, "work retrieval failed, exiting " "mining thread %d", mythr->id); pthread_mutex_unlock(&g_work_lock); goto out; } time(&g_work_time); if (opt_debug) applog(LOG_DEBUG, "DEBUG: got new work"); } if (memcmp(work.data, g_work.data, 76)) { memcpy(&work, &g_work, sizeof(struct work)); next_nonce = 0xffffffffU / opt_n_threads * thr_id; } pthread_mutex_unlock(&g_work_lock); work_restart[thr_id].restart = 0; /* adjust max_nonce to meet target scan time */ max64 = g_work_time + (have_longpoll ? LP_SCANTIME : opt_scantime) - time(NULL); max64 *= thr_hashrates[thr_id]; if (max64 <= 0) max64 = 0xfffLL; if (next_nonce + max64 > 0xfffffffeLL) max_nonce = 0xfffffffeU; else max_nonce = next_nonce + max64; hashes_done = 0; gettimeofday(&tv_start, NULL); /* scan nonces for a proof-of-work hash */ switch (opt_algo) { case ALGO_SCRYPT: rc = scanhash_scrypt(thr_id, work.data, scratchbuf, work.target, max_nonce, &next_nonce, &hashes_done); break; default: /* should never happen */ goto out; } /* record scanhash elapsed time */ gettimeofday(&tv_end, NULL); timeval_subtract(&diff, &tv_end, &tv_start); if (diff.tv_usec || diff.tv_sec) { pthread_mutex_lock(&stats_lock); thr_hashrates[thr_id] = hashes_done / (diff.tv_sec + 1e-6 * diff.tv_usec); pthread_mutex_unlock(&stats_lock); } if (!opt_quiet) applog(LOG_INFO, "thread %d: %lu hashes, %.2f khash/s", thr_id, hashes_done, 1e-3 * thr_hashrates[thr_id]); /* if nonce found, submit work */ if (rc && !submit_work(mythr, &work)) break; } out: tq_freeze(mythr->q); return NULL; } static void restart_threads(void) { int i; for (i = 0; i < opt_n_threads; i++) work_restart[i].restart = 1; } static void *longpoll_thread(void *userdata) { struct thr_info *mythr = userdata; CURL *curl = NULL; char *copy_start, *hdr_path = NULL, *lp_url = NULL; bool need_slash = false; curl = curl_easy_init(); if (unlikely(!curl)) { applog(LOG_ERR, "CURL initialization failed"); goto out; } start: hdr_path = tq_pop(mythr->q, NULL); if (!hdr_path) goto out; /* full URL */ if (strstr(hdr_path, "://")) { lp_url = hdr_path; hdr_path = NULL; } /* absolute path, on current server */ else { copy_start = (*hdr_path == '/') ? (hdr_path + 1) : hdr_path; if (rpc_url[strlen(rpc_url) - 1] != '/') need_slash = true; lp_url = malloc(strlen(rpc_url) + strlen(copy_start) + 2); if (!lp_url) goto out; sprintf(lp_url, "%s%s%s", rpc_url, need_slash ? "/" : "", copy_start); } applog(LOG_INFO, "Long-polling activated for %s", lp_url); while (1) { json_t *val; int err; val = json_rpc_call(curl, lp_url, rpc_userpass, rpc_req, false, true, &err); if (likely(val)) { applog(LOG_INFO, "LONGPOLL detected new block"); pthread_mutex_lock(&g_work_lock); if (work_decode(json_object_get(val, "result"), &g_work)) { if (opt_debug) applog(LOG_DEBUG, "DEBUG: got new work"); time(&g_work_time); restart_threads(); } pthread_mutex_unlock(&g_work_lock); json_decref(val); } else { pthread_mutex_lock(&g_work_lock); g_work_time -= LP_SCANTIME; pthread_mutex_unlock(&g_work_lock); if (err == CURLE_OPERATION_TIMEDOUT) { restart_threads(); } else { have_longpoll = false; restart_threads(); free(hdr_path); free(lp_url); lp_url = NULL; sleep(opt_fail_pause); goto start; } } } out: free(hdr_path); free(lp_url); tq_freeze(mythr->q); if (curl) curl_easy_cleanup(curl); return NULL; } static void show_version_and_exit(void) { printf("%s\n%s\n", PACKAGE_STRING, curl_version()); exit(0); } static void show_usage_and_exit(int status) { if (status) fprintf(stderr, "Try `" PROGRAM_NAME " --help' for more information.\n"); else printf(usage); exit(status); } static void parse_arg (int key, char *arg) { char *p; int v, i; switch(key) { case 'a': for (i = 0; i < ARRAY_SIZE(algo_names); i++) { if (algo_names[i] && !strcmp(arg, algo_names[i])) { opt_algo = i; break; } } if (i == ARRAY_SIZE(algo_names)) show_usage_and_exit(1); break; case 'c': { json_error_t err; if (opt_config) json_decref(opt_config); #if JANSSON_VERSION_HEX >= 0x020000 opt_config = json_load_file(arg, 0, &err); #else opt_config = json_load_file(arg, &err); #endif if (!json_is_object(opt_config)) { applog(LOG_ERR, "JSON decode of %s failed", arg); exit(1); } break; } case 'q': opt_quiet = true; break; case 'D': opt_debug = true; break; case 'p': free(rpc_pass); rpc_pass = strdup(arg); break; case 'P': opt_protocol = true; break; case 'r': v = atoi(arg); if (v < -1 || v > 9999) /* sanity check */ show_usage_and_exit(1); opt_retries = v; break; case 'R': v = atoi(arg); if (v < 1 || v > 9999) /* sanity check */ show_usage_and_exit(1); opt_fail_pause = v; break; case 's': v = atoi(arg); if (v < 1 || v > 9999) /* sanity check */ show_usage_and_exit(1); opt_scantime = v; break; case 'T': v = atoi(arg); if (v < 1 || v > 99999) /* sanity check */ show_usage_and_exit(1); opt_timeout = v; break; case 't': v = atoi(arg); if (v < 1 || v > 9999) /* sanity check */ show_usage_and_exit(1); opt_n_threads = v; break; case 'u': free(rpc_user); rpc_user = strdup(arg); break; case 'o': /* --url */ if (strncmp(arg, "http://", 7) && strncmp(arg, "https://", 8)) show_usage_and_exit(1); free(rpc_url); rpc_url = strdup(arg); p = strchr(rpc_url, '@'); if (p) { char *ap = strstr(rpc_url, "//") + 2; *p = '\0'; if (!strchr(ap, ':')) show_usage_and_exit(1); free(rpc_userpass); rpc_userpass = strdup(ap); strcpy(ap, p + 1); } break; case 'O': /* --userpass */ if (!strchr(arg, ':')) show_usage_and_exit(1); free(rpc_userpass); rpc_userpass = strdup(arg); break; case 1003: want_longpoll = false; break; case 1004: use_syslog = true; break; case 'V': show_version_and_exit(); case 'h': show_usage_and_exit(0); default: show_usage_and_exit(1); } } static void parse_config(void) { int i; json_t *val; if (!json_is_object(opt_config)) return; for (i = 0; i < ARRAY_SIZE(options); i++) { if (!options[i].name) break; if (!strcmp(options[i].name, "config")) continue; val = json_object_get(opt_config, options[i].name); if (!val) continue; if (options[i].has_arg && json_is_string(val)) { char *s = strdup(json_string_value(val)); if (!s) break; parse_arg(options[i].val, s); free(s); } else if (!options[i].has_arg && json_is_true(val)) parse_arg(options[i].val, ""); else applog(LOG_ERR, "JSON option %s invalid", options[i].name); } } static void parse_cmdline(int argc, char *argv[]) { int key; while (1) { key = getopt_long(argc, argv, short_options, options, NULL); if (key < 0) break; parse_arg(key, optarg); } if (optind < argc) { fprintf(stderr, "%s: unsupported non-option argument '%s'\n", argv[0], argv[optind]); show_usage_and_exit(1); } parse_config(); } int main(int argc, char *argv[]) { struct thr_info *thr; int i; rpc_url = strdup(DEF_RPC_URL); /* parse command line */ parse_cmdline(argc, argv); pthread_mutex_init(&time_lock, NULL); pthread_mutex_init(&stats_lock, NULL); pthread_mutex_init(&g_work_lock, NULL); #if defined(WIN32) || defined(WIN64) SYSTEM_INFO sysinfo; GetSystemInfo(&sysinfo); num_processors = sysinfo.dwNumberOfProcessors; #elif defined(_SC_NPROCESSORS_ONLN) num_processors = sysconf(_SC_NPROCESSORS_ONLN); #elif defined(HW_NCPU) int req[] = { CTL_HW, HW_NCPU }; size_t len = sizeof(num_processors); v = sysctl(req, 2, &num_processors, &len, NULL, 0); #else num_processors = 1; #endif if (num_processors < 1) num_processors = 1; if (!opt_n_threads) opt_n_threads = num_processors; if (!rpc_userpass) { if (!rpc_user || !rpc_pass) { applog(LOG_ERR, "No login credentials supplied"); return 1; } rpc_userpass = malloc(strlen(rpc_user) + strlen(rpc_pass) + 2); if (!rpc_userpass) return 1; sprintf(rpc_userpass, "%s:%s", rpc_user, rpc_pass); } #ifdef HAVE_SYSLOG_H if (use_syslog) openlog("cpuminer", LOG_PID, LOG_USER); #endif work_restart = calloc(opt_n_threads, sizeof(*work_restart)); if (!work_restart) return 1; thr_info = calloc(opt_n_threads + 2, sizeof(*thr)); if (!thr_info) return 1; thr_hashrates = (double *) calloc(opt_n_threads, sizeof(double)); if (!thr_hashrates) return 1; /* init workio thread info */ work_thr_id = opt_n_threads; thr = &thr_info[work_thr_id]; thr->id = work_thr_id; thr->q = tq_new(); if (!thr->q) return 1; /* start work I/O thread */ if (pthread_create(&thr->pth, NULL, workio_thread, thr)) { applog(LOG_ERR, "workio thread create failed"); return 1; } /* init longpoll thread info */ if (want_longpoll) { longpoll_thr_id = opt_n_threads + 1; thr = &thr_info[longpoll_thr_id]; thr->id = longpoll_thr_id; thr->q = tq_new(); if (!thr->q) return 1; /* start longpoll thread */ if (unlikely(pthread_create(&thr->pth, NULL, longpoll_thread, thr))) { applog(LOG_ERR, "longpoll thread create failed"); return 1; } } else longpoll_thr_id = -1; /* start mining threads */ for (i = 0; i < opt_n_threads; i++) { thr = &thr_info[i]; thr->id = i; thr->q = tq_new(); if (!thr->q) return 1; if (unlikely(pthread_create(&thr->pth, NULL, miner_thread, thr))) { applog(LOG_ERR, "thread %d create failed", i); return 1; } } applog(LOG_INFO, "%d miner threads started, " "using '%s' algorithm.", opt_n_threads, algo_names[opt_algo]); /* main loop - simply wait for workio thread to exit */ pthread_join(thr_info[work_thr_id].pth, NULL); applog(LOG_INFO, "workio thread dead, exiting."); return 0; }