/*
Stockfish, a UCI chess playing engine derived from Glaurung 2.1
- Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
- Copyright (C) 2008-2009 Marco Costalba
+ 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/>.
*/
-
-////
-//// Includes
-////
-
#include <algorithm>
#include <cassert>
+#include <cctype>
+#include <cstddef>
+#include <iosfwd>
+#include <istream>
#include <map>
-#include <string>
+#include <ostream>
#include <sstream>
-#include <vector>
+#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;
-////
-//// Local definitions
-////
-
-namespace {
-
- ///
- /// Types
- ///
-
- enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON };
-
- typedef std::vector<string> ComboValues;
-
- struct Option {
-
- string name, defaultValue, currentValue;
- OptionType type;
- size_t idx;
- int minValue, maxValue;
- ComboValues comboValues;
-
- Option();
- Option(const char* defaultValue, OptionType = STRING);
- Option(bool defaultValue, OptionType = CHECK);
- Option(int defaultValue, int minValue, int maxValue);
-
- bool operator<(const Option& o) const { return this->idx < o.idx; }
- };
-
- typedef std::map<string, Option> Options;
-
- ///
- /// Constants
- ///
-
- // load_defaults populates the options map with the hard
- // coded names and default values.
-
- void load_defaults(Options& o) {
-
- o["Use Search Log"] = Option(false);
- o["Search Log Filename"] = Option("SearchLog.txt");
- o["Book File"] = Option("book.bin");
- o["Mobility (Middle Game)"] = Option(100, 0, 200);
- o["Mobility (Endgame)"] = Option(100, 0, 200);
- o["Pawn Structure (Middle Game)"] = Option(100, 0, 200);
- o["Pawn Structure (Endgame)"] = Option(100, 0, 200);
- o["Passed Pawns (Middle Game)"] = Option(100, 0, 200);
- o["Passed Pawns (Endgame)"] = Option(100, 0, 200);
- o["Space"] = Option(100, 0, 200);
- o["Aggressiveness"] = Option(100, 0, 200);
- o["Cowardice"] = Option(100, 0, 200);
- o["King Safety Curve"] = Option("Quadratic", COMBO);
-
- o["King Safety Curve"].comboValues.push_back("Quadratic");
- o["King Safety Curve"].comboValues.push_back("Linear"); /*, "From File"*/
-
- o["King Safety Coefficient"] = Option(40, 1, 100);
- o["King Safety X Intercept"] = Option(0, 0, 20);
- o["King Safety Max Slope"] = Option(30, 10, 100);
- o["King Safety Max Value"] = Option(500, 100, 1000);
- o["Queen Contact Check Bonus"] = Option(3, 0, 8);
- o["Queen Check Bonus"] = Option(2, 0, 4);
- o["Rook Check Bonus"] = Option(1, 0, 4);
- o["Bishop Check Bonus"] = Option(1, 0, 4);
- o["Knight Check Bonus"] = Option(1, 0, 4);
- o["Discovered Check Bonus"] = Option(3, 0, 8);
- o["Mate Threat Bonus"] = Option(3, 0, 8);
- o["Check Extension (PV nodes)"] = Option(2, 0, 2);
- o["Check Extension (non-PV nodes)"] = Option(1, 0, 2);
- o["Single Reply Extension (PV nodes)"] = Option(2, 0, 2);
- o["Single Reply Extension (non-PV nodes)"] = Option(2, 0, 2);
- o["Mate Threat Extension (PV nodes)"] = Option(0, 0, 2);
- o["Mate Threat Extension (non-PV nodes)"] = Option(0, 0, 2);
- o["Pawn Push to 7th Extension (PV nodes)"] = Option(1, 0, 2);
- o["Pawn Push to 7th Extension (non-PV nodes)"] = Option(1, 0, 2);
- o["Passed Pawn Extension (PV nodes)"] = Option(1, 0, 2);
- o["Passed Pawn Extension (non-PV nodes)"] = Option(0, 0, 2);
- o["Pawn Endgame Extension (PV nodes)"] = Option(2, 0, 2);
- o["Pawn Endgame Extension (non-PV nodes)"] = Option(2, 0, 2);
- o["Full Depth Moves (PV nodes)"] = Option(14, 1, 100);
- o["Full Depth Moves (non-PV nodes)"] = Option(3, 1, 100);
- o["Threat Depth"] = Option(5, 0, 100);
- o["Randomness"] = Option(0, 0, 10);
- o["Minimum Split Depth"] = Option(4, 4, 7);
- o["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
- o["Threads"] = Option(1, 1, 8);
- o["Hash"] = Option(32, 4, 4096);
- o["Clear Hash"] = Option(false, BUTTON);
- o["Ponder"] = Option(true);
- o["OwnBook"] = Option(true);
- o["MultiPV"] = Option(1, 1, 500);
- o["UCI_ShowCurrLine"] = Option(false);
- o["UCI_Chess960"] = Option(false);
- o["UCI_AnalyseMode"] = Option(false);
- o["UCI_LimitStrength"] = Option(false);
- o["UCI_Elo"] = Option(2900, 2100, 2900);
-
- // Any option should know its name so to be easily printed
- for (Options::iterator it = o.begin(); it != o.end(); ++it)
- it->second.name = it->first;
- }
-
- ///
- /// Variables
- ///
-
- Options options;
-
- // stringify converts a value of type T to a std::string
- template<typename T>
- string stringify(const T& v) {
-
- std::ostringstream ss;
- ss << v;
- return ss.str();
- }
-
-
- // get_option_value implements the various get_option_value_<type>
- // functions defined later, because only the option value
- // type changes a template seems a proper solution.
-
- template<typename T>
- T get_option_value(const string& optionName) {
-
- T ret = T();
- if (options.find(optionName) == options.end())
- return ret;
-
- std::istringstream ss(options[optionName].currentValue);
- ss >> ret;
- return ret;
- }
-
+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));
}
-////
-//// Functions
-////
-
-/// init_uci_options() initializes the UCI options. Currently, the only
-/// thing this function does is to initialize the default value of the
-/// "Threads" parameter to the number of available CPU cores.
-
-void init_uci_options() {
+// Our case insensitive less() function as required by UCI protocol
+bool CaseInsensitiveLess::operator()(const string& s1, const string& s2) const {
- load_defaults(options);
-
- // Limit the default value of "Threads" to 7 even if we have 8 CPU cores.
- // According to Ken Dail's tests, Glaurung plays much better with 7 than
- // with 8 threads. This is weird, but it is probably difficult to find out
- // why before I have a 8-core computer to experiment with myself.
- assert(options.find("Threads") != options.end());
- assert(options.find("Minimum Split Depth") != options.end());
-
- options["Threads"].defaultValue = stringify(Min(cpu_count(), 7));
- options["Threads"].currentValue = stringify(Min(cpu_count(), 7));
-
- // Increase the minimum split depth when the number of CPUs is big.
- // It would probably be better to let this depend on the number of threads
- // instead.
- if (cpu_count() > 4)
- {
- options["Minimum Split Depth"].defaultValue = "6";
- options["Minimum Split Depth"].currentValue = "6";
- }
+ return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
+ [](char c1, char c2) { return tolower(c1) < tolower(c2); });
}
-/// print_uci_options() prints all the UCI options to the standard output,
-/// in the format defined by the UCI protocol.
-
-void print_uci_options() {
+// 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);
+}
- static const char optionTypeName[][16] = {
- "spin", "combo", "check", "string", "button"
- };
- // Build up a vector out of the options map and sort it according to idx
- // field, that is the chronological insertion order in options map.
- std::vector<Option> vec;
- for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
- vec.push_back(it->second);
+// 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) {
- std::sort(vec.begin(), vec.end());
+ 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;
- for (std::vector<Option>::const_iterator it = vec.begin(); it != vec.end(); ++it)
- {
- std::cout << "\noption name " << it->name
- << " type " << optionTypeName[it->type];
+ if (o.type == "string" || o.type == "check" || o.type == "combo")
+ os << " default " << o.defaultValue;
- if (it->type == BUTTON)
- continue;
+ if (o.type == "spin")
+ os << " default " << int(stof(o.defaultValue)) << " min " << o.min << " max "
+ << o.max;
- if (it->type == CHECK)
- std::cout << " default " << (it->defaultValue == "1" ? "true" : "false");
- else
- std::cout << " default " << it->defaultValue;
+ break;
+ }
- if (it->type == SPIN)
- std::cout << " min " << it->minValue << " max " << it->maxValue;
- else if (it->type == COMBO)
- for (ComboValues::const_iterator itc = it->comboValues.begin();
- itc != it->comboValues.end(); ++itc)
- std::cout << " var " << *itc;
- }
- std::cout << std::endl;
+ return os;
}
-/// get_option_value_bool() returns the current value of a UCI parameter of
-/// type "check".
-
-bool get_option_value_bool(const string& optionName) {
+// Option class constructors and conversion operators
- return get_option_value<bool>(optionName);
+Option::Option(const char* v, OnChange f) :
+ type("string"),
+ min(0),
+ max(0),
+ on_change(f) {
+ defaultValue = currentValue = v;
}
-
-/// get_option_value_int() returns the value of a UCI parameter as an integer.
-/// Normally, this function will be used for a parameter of type "spin", but
-/// it could also be used with a "combo" parameter, where all the available
-/// values are integers.
-
-int get_option_value_int(const string& optionName) {
-
- return get_option_value<int>(optionName);
+Option::Option(bool v, OnChange f) :
+ type("check"),
+ min(0),
+ max(0),
+ on_change(f) {
+ defaultValue = currentValue = (v ? "true" : "false");
}
-
-/// get_option_value_string() returns the current value of a UCI parameter as
-/// a string. It is used with parameters of type "combo" and "string".
-
-string get_option_value_string(const string& optionName) {
-
- return get_option_value<string>(optionName);
+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);
}
-
-/// set_option_value() inserts a new value for a UCI parameter. Note that
-/// the function does not check that the new value is legal for the given
-/// parameter: This is assumed to be the responsibility of the GUI.
-
-void set_option_value(const string& name, const string& value) {
-
- // 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";
-
- if (options.find(name) != options.end())
- options[name].currentValue = v;
- else
- std::cout << "No such option: " << name << std::endl;
+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");
+}
-/// push_button() is used to tell the engine that a UCI parameter of type
-/// "button" has been selected:
-
-void push_button(const string& buttonName) {
+Option::operator std::string() const {
+ assert(type == "string");
+ return currentValue;
+}
- set_option_value(buttonName, "true");
+bool Option::operator==(const char* s) const {
+ assert(type == "combo");
+ return !CaseInsensitiveLess()(currentValue, s) && !CaseInsensitiveLess()(s, currentValue);
}
-/// button_was_pressed() tests whether a UCI parameter of type "button" has
-/// been selected since the last time the function was called, in this case
-/// it also resets the button.
+// Inits options and assigns idx in the correct printing order
-bool button_was_pressed(const string& buttonName) {
+void Option::operator<<(const Option& o) {
- if (!get_option_value<bool>(buttonName))
- return false;
+ static size_t insert_order = 0;
- set_option_value(buttonName, "false");
- return true;
+ *this = o;
+ idx = insert_order++;
}
-namespace {
+// 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) {
- // Define constructors of Option class.
+ assert(!type.empty());
- Option::Option() {} // To allow insertion in a std::map
+ if ((type != "button" && type != "string" && v.empty())
+ || (type == "check" && v != "true" && v != "false")
+ || (type == "spin" && (stof(v) < min || stof(v) > max)))
+ return *this;
- Option::Option(const char* def, OptionType t)
- : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
+ 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;
+ }
- Option::Option(bool def, OptionType t)
- : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
+ if (type != "button")
+ currentValue = v;
- Option::Option(int def, int minv, int maxv)
- : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}
+ if (on_change)
+ on_change(*this);
+ return *this;
}
+
+} // namespace UCI
+
+} // namespace Stockfish
projects / stockfish / blobdiff