/*
Stockfish, a UCI chess playing engine derived from Glaurung 2.1
- Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
- Copyright (C) 2008-2012 Marco Costalba, Joona Kiiski, Tord Romstad
+ Copyright (C) 2004-2021 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
*/
#include <algorithm>
+#include <cassert>
+#include <ostream>
#include <sstream>
+#include "evaluate.h"
#include "misc.h"
+#include "search.h"
#include "thread.h"
-#include "ucioption.h"
+#include "tt.h"
+#include "uci.h"
+#include "syzygy/tbprobe.h"
using std::string;
-OptionsMap Options; // Global object
+namespace Stockfish {
+UCI::OptionsMap Options; // Global object
-/// Our case insensitive less() function as required by UCI protocol
-static bool ci_less(char c1, char c2) { return tolower(c1) < tolower(c2); }
+namespace UCI {
+
+/// 'On change' actions, triggered by an option's value change
+void on_clear_hash(const Option&) { Search::clear(); }
+void on_hash_size(const Option& o) { TT.resize(size_t(o)); }
+void on_logger(const Option& o) { start_logger(o); }
+void on_threads(const Option& o) { Threads.set(size_t(o)); }
+void on_tb_path(const Option& o) { Tablebases::init(o); }
+void on_use_NNUE(const Option& ) { Eval::NNUE::init(); }
+void on_eval_file(const Option& ) { Eval::NNUE::init(); }
+/// Our case insensitive less() function as required by UCI protocol
bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
- return lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(), ci_less);
+
+ return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
+ [](char c1, char c2) { return tolower(c1) < tolower(c2); });
}
-/// OptionsMap c'tor initializes the UCI options to their hard coded default
-/// values and initializes the default value of "Threads" and "Min Split Depth"
-/// parameters according to the number of CPU cores detected.
-
-OptionsMap::OptionsMap() {
-
- int cpus = std::min(cpu_count(), MAX_THREADS);
- int msd = cpus < 8 ? 4 : 7;
- OptionsMap& o = *this;
-
- o["Use Search Log"] = UCIOption(false);
- o["Search Log Filename"] = UCIOption("SearchLog.txt");
- o["Book File"] = UCIOption("book.bin");
- o["Best Book Move"] = UCIOption(false);
- o["Mobility (Middle Game)"] = UCIOption(100, 0, 200);
- o["Mobility (Endgame)"] = UCIOption(100, 0, 200);
- o["Passed Pawns (Middle Game)"] = UCIOption(100, 0, 200);
- o["Passed Pawns (Endgame)"] = UCIOption(100, 0, 200);
- o["Space"] = UCIOption(100, 0, 200);
- o["Aggressiveness"] = UCIOption(100, 0, 200);
- o["Cowardice"] = UCIOption(100, 0, 200);
- o["Min Split Depth"] = UCIOption(msd, 4, 7);
- o["Max Threads per Split Point"] = UCIOption(5, 4, 8);
- o["Threads"] = UCIOption(cpus, 1, MAX_THREADS);
- o["Use Sleeping Threads"] = UCIOption(true);
- o["Hash"] = UCIOption(32, 4, 8192);
- o["Clear Hash"] = UCIOption(false, "button");
- o["Ponder"] = UCIOption(true);
- o["OwnBook"] = UCIOption(true);
- o["MultiPV"] = UCIOption(1, 1, 500);
- o["Skill Level"] = UCIOption(20, 0, 20);
- o["Emergency Move Horizon"] = UCIOption(40, 0, 50);
- o["Emergency Base Time"] = UCIOption(200, 0, 30000);
- o["Emergency Move Time"] = UCIOption(70, 0, 5000);
- o["Minimum Thinking Time"] = UCIOption(20, 0, 5000);
- o["UCI_Chess960"] = UCIOption(false);
- o["UCI_AnalyseMode"] = UCIOption(false);
+/// UCI::init() 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, 512, 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["Slow Mover"] << Option(100, 10, 1000);
+ o["nodestime"] << Option(0, 0, 10000);
+ o["UCI_Chess960"] << Option(false);
+ o["UCI_AnalyseMode"] << Option(false);
+ o["UCI_LimitStrength"] << Option(false);
+ o["UCI_Elo"] << Option(1350, 1350, 2850);
+ 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["Use NNUE"] << Option(true, on_use_NNUE);
+ o["EvalFile"] << Option(EvalFileDefaultName, on_eval_file);
}
-/// operator<<() is used to output all the UCI options in chronological insertion
-/// order (the idx field) and in the format defined by the UCI protocol.
+/// operator<<() is 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 (OptionsMap::const_iterator it = om.begin(); it != om.end(); ++it)
- if (it->second.idx == idx)
+ for (size_t idx = 0; idx < om.size(); ++idx)
+ for (const auto& it : om)
+ if (it.second.idx == idx)
{
- const UCIOption& o = it->second;
- os << "\noption name " << it->first << " type " << o.type;
+ const Option& o = it.second;
+ os << "\noption name " << it.first << " type " << o.type;
- if (o.type != "button")
+ if (o.type == "string" || o.type == "check" || o.type == "combo")
os << " default " << o.defaultValue;
if (o.type == "spin")
- os << " min " << o.min << " max " << o.max;
+ os << " default " << int(stof(o.defaultValue))
+ << " min " << o.min
+ << " max " << o.max;
break;
}
+
return os;
}
-/// UCIOption class c'tors
+/// Option class constructors and conversion operators
-UCIOption::UCIOption(const char* v) : type("string"), min(0), max(0), idx(Options.size())
+Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
{ defaultValue = currentValue = v; }
-UCIOption::UCIOption(bool v, string t) : type(t), min(0), max(0), idx(Options.size())
+Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
{ defaultValue = currentValue = (v ? "true" : "false"); }
-UCIOption::UCIOption(int v, int minv, int maxv) : type("spin"), min(minv), max(maxv), idx(Options.size())
-{ std::ostringstream ss; ss << v; defaultValue = currentValue = ss.str(); }
+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(const char* v, const char* cur, OnChange f) : type("combo"), min(0), max(0), on_change(f)
+{ defaultValue = v; currentValue = cur; }
+
+Option::operator double() const {
+ assert(type == "check" || type == "spin");
+ return (type == "spin" ? stof(currentValue) : currentValue == "true");
+}
+
+Option::operator std::string() const {
+ assert(type == "string");
+ return currentValue;
+}
+
+bool Option::operator==(const char* s) const {
+ assert(type == "combo");
+ return !CaseInsensitiveLess()(currentValue, s)
+ && !CaseInsensitiveLess()(s, currentValue);
+}
+
+
+/// operator<<() inits options and assigns idx in the correct printing order
+
+void Option::operator<<(const Option& o) {
+
+ static size_t insert_order = 0;
+
+ *this = o;
+ idx = insert_order++;
+}
-/// UCIOption::operator=() updates currentValue. 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.
+/// operator=() 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.
-void UCIOption::operator=(const string& v) {
+Option& Option::operator=(const string& v) {
assert(!type.empty());
- if ( !v.empty()
- && (type == "check" || type == "button") == (v == "true" || v == "false")
- && (type != "spin" || (atoi(v.c_str()) >= min && atoi(v.c_str()) <= max)))
+ 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