2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
5 Stockfish is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 Stockfish is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
35 #include "benchmark.h"
39 #include "nnue/evaluate_nnue.h"
48 // FEN string for the initial position in standard chess
49 const char* StartFEN = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
52 // Called when the engine receives the "position" UCI command.
53 // It sets up the position that is described in the given FEN string ("fen") or
54 // the initial position ("startpos") and then makes the moves given in the following
55 // move list ("moves").
56 void position(Position& pos, std::istringstream& is, StateListPtr& states) {
59 std::string token, fen;
63 if (token == "startpos")
66 is >> token; // Consume the "moves" token, if any
68 else if (token == "fen")
69 while (is >> token && token != "moves")
74 states = StateListPtr(new std::deque<StateInfo>(1)); // Drop the old state and create a new one
75 pos.set(fen, Options["UCI_Chess960"], &states->back(), Threads.main());
77 // Parse the move list, if any
78 while (is >> token && (m = UCI::to_move(pos, token)) != MOVE_NONE)
80 states->emplace_back();
81 pos.do_move(m, states->back());
85 // Prints the evaluation of the current position,
86 // consistent with the UCI options set so far.
87 void trace_eval(Position& pos) {
89 StateListPtr states(new std::deque<StateInfo>(1));
91 p.set(pos.fen(), Options["UCI_Chess960"], &states->back(), Threads.main());
95 sync_cout << "\n" << Eval::trace(p) << sync_endl;
99 // Called when the engine receives the "setoption" UCI command.
100 // The function updates the UCI option ("name") to the given value ("value").
102 void setoption(std::istringstream& is) {
104 Threads.main()->wait_for_search_finished();
106 std::string token, name, value;
108 is >> token; // Consume the "name" token
110 // Read the option name (can contain spaces)
111 while (is >> token && token != "value")
112 name += (name.empty() ? "" : " ") + token;
114 // Read the option value (can contain spaces)
116 value += (value.empty() ? "" : " ") + token;
118 if (Options.count(name))
119 Options[name] = value;
121 sync_cout << "No such option: " << name << sync_endl;
125 // Called when the engine receives the "go" UCI command. The function sets the
126 // thinking time and other parameters from the input string then stars with a search
128 void go(Position& pos, std::istringstream& is, StateListPtr& states) {
130 Search::LimitsType limits;
132 bool ponderMode = false;
134 limits.startTime = now(); // The search starts as early as possible
137 if (token == "searchmoves") // Needs to be the last command on the line
139 limits.searchmoves.push_back(UCI::to_move(pos, token));
141 else if (token == "wtime")
142 is >> limits.time[WHITE];
143 else if (token == "btime")
144 is >> limits.time[BLACK];
145 else if (token == "winc")
146 is >> limits.inc[WHITE];
147 else if (token == "binc")
148 is >> limits.inc[BLACK];
149 else if (token == "movestogo")
150 is >> limits.movestogo;
151 else if (token == "depth")
153 else if (token == "nodes")
155 else if (token == "movetime")
156 is >> limits.movetime;
157 else if (token == "mate")
159 else if (token == "perft")
161 else if (token == "infinite")
163 else if (token == "ponder")
166 Threads.start_thinking(pos, states, limits, ponderMode);
170 // Called when the engine receives the "bench" command.
171 // First, a list of UCI commands is set up according to the bench
172 // parameters, then it is run one by one, printing a summary at the end.
174 void bench(Position& pos, std::istream& args, StateListPtr& states) {
177 uint64_t num, nodes = 0, cnt = 1;
179 std::vector<std::string> list = setup_bench(pos, args);
181 num = count_if(list.begin(), list.end(),
182 [](const std::string& s) { return s.find("go ") == 0 || s.find("eval") == 0; });
184 TimePoint elapsed = now();
186 for (const auto& cmd : list)
188 std::istringstream is(cmd);
189 is >> std::skipws >> token;
191 if (token == "go" || token == "eval")
193 std::cerr << "\nPosition: " << cnt++ << '/' << num << " (" << pos.fen() << ")"
198 Threads.main()->wait_for_search_finished();
199 nodes += Threads.nodes_searched();
204 else if (token == "setoption")
206 else if (token == "position")
207 position(pos, is, states);
208 else if (token == "ucinewgame")
212 } // Search::clear() may take a while
215 elapsed = now() - elapsed + 1; // Ensure positivity to avoid a 'divide by zero'
219 std::cerr << "\n==========================="
220 << "\nTotal time (ms) : " << elapsed << "\nNodes searched : " << nodes
221 << "\nNodes/second : " << 1000 * nodes / elapsed << std::endl;
224 // The win rate model returns the probability of winning (in per mille units) given an
225 // eval and a game ply. It fits the LTC fishtest statistics rather accurately.
226 int win_rate_model(Value v, int ply) {
228 // The model only captures up to 240 plies, so limit the input and then rescale
229 double m = std::min(240, ply) / 64.0;
231 // The coefficients of a third-order polynomial fit is based on the fishtest data
232 // for two parameters that need to transform eval to the argument of a logistic
234 constexpr double as[] = {0.38036525, -2.82015070, 23.17882135, 307.36768407};
235 constexpr double bs[] = {-2.29434733, 13.27689788, -14.26828904, 63.45318330};
237 // Enforce that NormalizeToPawnValue corresponds to a 50% win rate at ply 64
238 static_assert(UCI::NormalizeToPawnValue == int(as[0] + as[1] + as[2] + as[3]));
240 double a = (((as[0] * m + as[1]) * m + as[2]) * m) + as[3];
241 double b = (((bs[0] * m + bs[1]) * m + bs[2]) * m) + bs[3];
243 // Transform the eval to centipawns with limited range
244 double x = std::clamp(double(v), -4000.0, 4000.0);
246 // Return the win rate in per mille units, rounded to the nearest integer
247 return int(0.5 + 1000 / (1 + std::exp((a - x) / b)));
253 // Waits for a command from the stdin, parses it, and then calls the appropriate
254 // function. It also intercepts an end-of-file (EOF) indication from the stdin to ensure a
255 // graceful exit if the GUI dies unexpectedly. When called with some command-line arguments,
256 // like running 'bench', the function returns immediately after the command is executed.
257 // In addition to the UCI ones, some additional debug commands are also supported.
258 void UCI::loop(int argc, char* argv[]) {
261 std::string token, cmd;
262 StateListPtr states(new std::deque<StateInfo>(1));
264 pos.set(StartFEN, false, &states->back(), Threads.main());
266 for (int i = 1; i < argc; ++i)
267 cmd += std::string(argv[i]) + " ";
272 && !getline(std::cin, cmd)) // Wait for an input or an end-of-file (EOF) indication
275 std::istringstream is(cmd);
277 token.clear(); // Avoid a stale if getline() returns nothing or a blank line
278 is >> std::skipws >> token;
280 if (token == "quit" || token == "stop")
283 // The GUI sends 'ponderhit' to tell that the user has played the expected move.
284 // So, 'ponderhit' is sent if pondering was done on the same move that the user
285 // has played. The search should continue, but should also switch from pondering
286 // to the normal search.
287 else if (token == "ponderhit")
288 Threads.main()->ponder = false; // Switch to the normal search
290 else if (token == "uci")
291 sync_cout << "id name " << engine_info(true) << "\n"
292 << Options << "\nuciok" << sync_endl;
294 else if (token == "setoption")
296 else if (token == "go")
298 else if (token == "position")
299 position(pos, is, states);
300 else if (token == "ucinewgame")
302 else if (token == "isready")
303 sync_cout << "readyok" << sync_endl;
305 // Add custom non-UCI commands, mainly for debugging purposes.
306 // These commands must not be used during a search!
307 else if (token == "flip")
309 else if (token == "bench")
310 bench(pos, is, states);
311 else if (token == "d")
312 sync_cout << pos << sync_endl;
313 else if (token == "eval")
315 else if (token == "compiler")
316 sync_cout << compiler_info() << sync_endl;
317 else if (token == "export_net")
319 std::optional<std::string> filename;
321 if (is >> std::skipws >> f)
323 Eval::NNUE::save_eval(filename);
325 else if (token == "--help" || token == "help" || token == "--license" || token == "license")
327 << "\nStockfish is a powerful chess engine for playing and analyzing."
328 "\nIt is released as free software licensed under the GNU GPLv3 License."
329 "\nStockfish is normally used with a graphical user interface (GUI) and implements"
330 "\nthe Universal Chess Interface (UCI) protocol to communicate with a GUI, an API, etc."
331 "\nFor any further information, visit https://github.com/official-stockfish/Stockfish#readme"
332 "\nor read the corresponding README.md and Copying.txt files distributed along with this program.\n"
334 else if (!token.empty() && token[0] != '#')
335 sync_cout << "Unknown command: '" << cmd << "'. Type help for more information."
338 } while (token != "quit" && argc == 1); // The command-line arguments are one-shot
342 // Turns a Value to an integer centipawn number,
343 // without treatment of mate and similar special scores.
344 int UCI::to_cp(Value v) { return 100 * v / UCI::NormalizeToPawnValue; }
346 // Converts a Value to a string by adhering to the UCI protocol specification:
348 // cp <x> The score from the engine's point of view in centipawns.
349 // mate <y> Mate in 'y' moves (not plies). If the engine is getting mated,
350 // uses negative values for 'y'.
351 std::string UCI::value(Value v) {
353 assert(-VALUE_INFINITE < v && v < VALUE_INFINITE);
355 std::stringstream ss;
357 if (abs(v) < VALUE_TB_WIN_IN_MAX_PLY)
358 ss << "cp " << UCI::to_cp(v);
359 else if (abs(v) < VALUE_MATE_IN_MAX_PLY)
361 const int ply = VALUE_MATE_IN_MAX_PLY - 1 - std::abs(v); // recompute ss->ply
362 ss << "cp " << (v > 0 ? 20000 - ply : -20000 + ply);
365 ss << "mate " << (v > 0 ? VALUE_MATE - v + 1 : -VALUE_MATE - v) / 2;
371 // Reports the win-draw-loss (WDL) statistics given an evaluation
372 // and a game ply based on the data gathered for fishtest LTC games.
373 std::string UCI::wdl(Value v, int ply) {
375 std::stringstream ss;
377 int wdl_w = win_rate_model(v, ply);
378 int wdl_l = win_rate_model(-v, ply);
379 int wdl_d = 1000 - wdl_w - wdl_l;
380 ss << " wdl " << wdl_w << " " << wdl_d << " " << wdl_l;
386 // Converts a Square to a string in algebraic notation (g1, a7, etc.)
387 std::string UCI::square(Square s) {
388 return std::string{char('a' + file_of(s)), char('1' + rank_of(s))};
392 // Converts a Move to a string in coordinate notation (g1f3, a7a8q).
393 // The only special case is castling where the e1g1 notation is printed in
394 // standard chess mode and in e1h1 notation it is printed in Chess960 mode.
395 // Internally, all castling moves are always encoded as 'king captures rook'.
396 std::string UCI::move(Move m, bool chess960) {
404 Square from = from_sq(m);
405 Square to = to_sq(m);
407 if (type_of(m) == CASTLING && !chess960)
408 to = make_square(to > from ? FILE_G : FILE_C, rank_of(from));
410 std::string move = UCI::square(from) + UCI::square(to);
412 if (type_of(m) == PROMOTION)
413 move += " pnbrqk"[promotion_type(m)];
419 // Converts a string representing a move in coordinate notation
420 // (g1f3, a7a8q) to the corresponding legal Move, if any.
421 Move UCI::to_move(const Position& pos, std::string& str) {
423 if (str.length() == 5)
424 str[4] = char(tolower(str[4])); // The promotion piece character must be lowercased
426 for (const auto& m : MoveList<LEGAL>(pos))
427 if (str == UCI::move(m, pos.is_chess960()))
433 } // namespace Stockfish