/*
Stockfish, a UCI chess playing engine derived from Glaurung 2.1
- Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
- Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
+ Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
Stockfish is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include <iostream>
+#include <algorithm>
+#include <cassert>
+#include <cctype>
+#include <cstddef>
+#include <iosfwd>
+#include <istream>
+#include <map>
+#include <ostream>
#include <sstream>
+#include <string>
+#include "evaluate.h"
#include "misc.h"
+#include "search.h"
+#include "syzygy/tbprobe.h"
#include "thread.h"
-#include "ucioption.h"
+#include "tt.h"
+#include "types.h"
+#include "uci.h"
+#include "hashprobe.h"
using std::string;
-using std::cout;
-using std::endl;
-OptionsMap Options;
+namespace Stockfish {
+
+UCI::OptionsMap Options; // Global object
+std::unique_ptr<HashProbeThread> hash_probe_thread;
+
+namespace UCI {
+
+// 'On change' actions, triggered by an option's value change
+static void on_clear_hash(const Option&) { Search::clear(); }
+static void on_hash_size(const Option& o) { TT.resize(size_t(o)); }
+static void on_logger(const Option& o) { start_logger(o); }
+static void on_threads(const Option& o) { Threads.set(size_t(o)); }
+static void on_tb_path(const Option& o) { Tablebases::init(o); }
+static void on_use_NNUE(const Option& ) { Eval::NNUE::init(); }
+static void on_eval_file(const Option& ) { Eval::NNUE::init(); }
+static void on_rpc_server_address(const Option& o) {
+ if (hash_probe_thread) {
+ hash_probe_thread->Shutdown();
+ }
+ std::string addr = o;
+ hash_probe_thread.reset(new HashProbeThread(addr));
+}
-// stringify() converts a value of type T to a std::string
-template<typename T>
-static string stringify(const T& v) {
+// Our case insensitive less() function as required by UCI protocol
+bool CaseInsensitiveLess::operator()(const string& s1, const string& s2) const {
- std::ostringstream ss;
- ss << v;
- return ss.str();
+ return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
+ [](char c1, char c2) { return tolower(c1) < tolower(c2); });
}
-/// init_uci_options() initializes the UCI options to their hard coded default
-/// values and initializes the default value of "Threads" and "Minimum Split Depth"
-/// parameters according to the number of CPU cores.
-
-void init_uci_options() {
-
- Options["Use Search Log"] = Option(false);
- Options["Search Log Filename"] = Option("SearchLog.txt");
- Options["Book File"] = Option("book.bin");
- Options["Best Book Move"] = Option(false);
- Options["Mobility (Middle Game)"] = Option(100, 0, 200);
- Options["Mobility (Endgame)"] = Option(100, 0, 200);
- Options["Pawn Structure (Middle Game)"] = Option(100, 0, 200);
- Options["Pawn Structure (Endgame)"] = Option(100, 0, 200);
- Options["Passed Pawns (Middle Game)"] = Option(100, 0, 200);
- Options["Passed Pawns (Endgame)"] = Option(100, 0, 200);
- Options["Space"] = Option(100, 0, 200);
- Options["Aggressiveness"] = Option(100, 0, 200);
- Options["Cowardice"] = Option(100, 0, 200);
- Options["Check Extension (PV nodes)"] = Option(2, 0, 2);
- Options["Check Extension (non-PV nodes)"] = Option(1, 0, 2);
- Options["Single Evasion Extension (PV nodes)"] = Option(2, 0, 2);
- Options["Single Evasion Extension (non-PV nodes)"] = Option(2, 0, 2);
- Options["Mate Threat Extension (PV nodes)"] = Option(2, 0, 2);
- Options["Mate Threat Extension (non-PV nodes)"] = Option(2, 0, 2);
- Options["Pawn Push to 7th Extension (PV nodes)"] = Option(1, 0, 2);
- Options["Pawn Push to 7th Extension (non-PV nodes)"] = Option(1, 0, 2);
- Options["Passed Pawn Extension (PV nodes)"] = Option(1, 0, 2);
- Options["Passed Pawn Extension (non-PV nodes)"] = Option(0, 0, 2);
- Options["Pawn Endgame Extension (PV nodes)"] = Option(2, 0, 2);
- Options["Pawn Endgame Extension (non-PV nodes)"] = Option(2, 0, 2);
- Options["Minimum Split Depth"] = Option(4, 4, 7);
- Options["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
- Options["Threads"] = Option(1, 1, MAX_THREADS);
- Options["Use Sleeping Master"] = Option(false);
- Options["Hash"] = Option(32, 4, 8192);
- Options["Clear Hash"] = Option(false, "button");
- Options["New Game"] = Option(false, "button");
- Options["Ponder"] = Option(true);
- Options["OwnBook"] = Option(true);
- Options["MultiPV"] = Option(1, 1, 500);
- Options["Emergency Move Horizon"] = Option(40, 0, 50);
- Options["Emergency Base Time"] = Option(200, 0, 60000);
- Options["Emergency Move Time"] = Option(70, 0, 5000);
- Options["Minimum Thinking Time"] = Option(20, 0, 5000);
- Options["UCI_Chess960"] = Option(false); // Just a dummy but needed by GUIs
- Options["UCI_AnalyseMode"] = Option(false);
-
- // Set some SMP parameters accordingly to the detected CPU count
- Option& thr = Options["Threads"];
- Option& msd = Options["Minimum Split Depth"];
-
- thr.defaultValue = thr.currentValue = stringify(cpu_count());
-
- if (cpu_count() >= 8)
- msd.defaultValue = msd.currentValue = stringify(7);
+// Initializes the UCI options to their hard-coded default values
+void init(OptionsMap& o) {
+
+ constexpr int MaxHashMB = Is64Bit ? 33554432 : 2048;
+
+ o["Debug Log File"] << Option("", on_logger);
+ o["Threads"] << Option(1, 1, 1024, on_threads);
+ o["Hash"] << Option(16, 1, MaxHashMB, on_hash_size);
+ o["Clear Hash"] << Option(on_clear_hash);
+ o["Ponder"] << Option(false);
+ o["MultiPV"] << Option(1, 1, 500);
+ o["Skill Level"] << Option(20, 0, 20);
+ o["Move Overhead"] << Option(10, 0, 5000);
+ o["nodestime"] << Option(0, 0, 10000);
+ o["UCI_Chess960"] << Option(false);
+ o["UCI_LimitStrength"] << Option(false);
+ o["UCI_Elo"] << Option(1320, 1320, 3190);
+ o["UCI_ShowWDL"] << Option(false);
+ o["SyzygyPath"] << Option("<empty>", on_tb_path);
+ o["SyzygyProbeDepth"] << Option(1, 1, 100);
+ o["Syzygy50MoveRule"] << Option(true);
+ o["SyzygyProbeLimit"] << Option(7, 0, 7);
+ o["EvalFile"] << Option(EvalFileDefaultName, on_eval_file);
+ o["RPCServerAddress"] << Option("<empty>", on_rpc_server_address);
}
-/// print_uci_options() prints all the UCI options to the standard output,
-/// in chronological insertion order (the idx field) and in the format
-/// defined by the UCI protocol.
-
-void print_uci_options() {
-
- for (size_t i = 0; i <= Options.size(); i++)
- for (OptionsMap::const_iterator it = Options.begin(); it != Options.end(); ++it)
- if (it->second.idx == i)
- {
- const Option& o = it->second;
- cout << "\noption name " << it->first << " type " << o.type;
-
- if (o.type == "check")
- cout << " default " << (o.defaultValue == "1" ? "true" : "false");
- else if (o.type == "string")
- cout << " default " << o.defaultValue;
- else if (o.type == "spin")
- {
- cout << " default " << o.defaultValue
- << " min " << o.minValue << " max " << o.maxValue;
- }
- else if (o.type != "button")
- assert(false);
-
- break;
- }
- cout << endl;
+// Used to print all the options default values in chronological
+// insertion order (the idx field) and in the format defined by the UCI protocol.
+std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
+
+ for (size_t idx = 0; idx < om.size(); ++idx)
+ for (const auto& it : om)
+ if (it.second.idx == idx)
+ {
+ const Option& o = it.second;
+ os << "\noption name " << it.first << " type " << o.type;
+
+ if (o.type == "string" || o.type == "check" || o.type == "combo")
+ os << " default " << o.defaultValue;
+
+ if (o.type == "spin")
+ os << " default " << int(stof(o.defaultValue)) << " min " << o.min << " max "
+ << o.max;
+
+ break;
+ }
+
+ return os;
}
-// Option class c'tors
+// Option class constructors and conversion operators
-Option::Option(): type("UNDEFINED") {}
+Option::Option(const char* v, OnChange f) :
+ type("string"),
+ min(0),
+ max(0),
+ on_change(f) {
+ defaultValue = currentValue = v;
+}
-Option::Option(const char* def, string t) : type(t), idx(Options.size()), minValue(0), maxValue(0)
-{ defaultValue = currentValue = def; }
+Option::Option(bool v, OnChange f) :
+ type("check"),
+ min(0),
+ max(0),
+ on_change(f) {
+ defaultValue = currentValue = (v ? "true" : "false");
+}
-Option::Option(bool def, string t) : type(t), idx(Options.size()), minValue(0), maxValue(0)
-{ defaultValue = currentValue = (def ? "1" : "0"); }
+Option::Option(OnChange f) :
+ type("button"),
+ min(0),
+ max(0),
+ on_change(f) {}
+
+Option::Option(double v, int minv, int maxv, OnChange f) :
+ type("spin"),
+ min(minv),
+ max(maxv),
+ on_change(f) {
+ defaultValue = currentValue = std::to_string(v);
+}
-Option::Option(int def, int minv, int maxv) : type("spin"), idx(Options.size()), minValue(minv), maxValue(maxv)
-{ defaultValue = currentValue = stringify(def); }
+Option::Option(const char* v, const char* cur, OnChange f) :
+ type("combo"),
+ min(0),
+ max(0),
+ on_change(f) {
+ defaultValue = v;
+ currentValue = cur;
+}
+Option::operator int() const {
+ assert(type == "check" || type == "spin");
+ return (type == "spin" ? std::stoi(currentValue) : currentValue == "true");
+}
-// set_value() updates currentValue of the Option object to the passed value
+Option::operator std::string() const {
+ assert(type == "string");
+ return currentValue;
+}
-void Option::set_value(const string& value) {
+bool Option::operator==(const char* s) const {
+ assert(type == "combo");
+ return !CaseInsensitiveLess()(currentValue, s) && !CaseInsensitiveLess()(s, currentValue);
+}
- assert(type != "UNDEFINED");
- // UCI protocol uses "true" and "false" instead of "1" and "0", so convert
- // value according to standard C++ convention before to store it.
- string v(value);
- if (v == "true")
- v = "1";
- else if (v == "false")
- v = "0";
+// Inits options and assigns idx in the correct printing order
- // Normally it's up to the GUI to check for option's limits,
- // but we could receive the new value directly from the user
- // by teminal window. So let's check the bounds anyway.
- if (type == "check" && v != "0" && v != "1")
- return;
+void Option::operator<<(const Option& o) {
- if (type == "spin")
- {
- int val = atoi(v.c_str());
- if (val < minValue || val > maxValue)
- return;
- }
- currentValue = v;
+ static size_t insert_order = 0;
+
+ *this = o;
+ idx = insert_order++;
+}
+
+
+// Updates currentValue and triggers on_change() action. It's up to
+// the GUI to check for option's limits, but we could receive the new value
+// from the user by console window, so let's check the bounds anyway.
+Option& Option::operator=(const string& v) {
+
+ assert(!type.empty());
+
+ if ((type != "button" && type != "string" && v.empty())
+ || (type == "check" && v != "true" && v != "false")
+ || (type == "spin" && (stof(v) < min || stof(v) > max)))
+ return *this;
+
+ if (type == "combo")
+ {
+ OptionsMap comboMap; // To have case insensitive compare
+ string token;
+ std::istringstream ss(defaultValue);
+ while (ss >> token)
+ comboMap[token] << Option();
+ if (!comboMap.count(v) || v == "var")
+ return *this;
+ }
+
+ if (type != "button")
+ currentValue = v;
+
+ if (on_change)
+ on_change(*this);
+
+ return *this;
}
+
+} // namespace UCI
+
+} // namespace Stockfish
projects / stockfish / blobdiff