]> git.sesse.net Git - stockfish/blob - src/uci.cpp
ed16f24c382ec5d11555f9ab0fab4fa29b42dc47
[stockfish] / src / uci.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
4
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.
9
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.
14
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/>.
17 */
18
19 #include <cassert>
20 #include <cmath>
21 #include <iostream>
22 #include <sstream>
23 #include <string>
24
25 #include "benchmark.h"
26 #include "evaluate.h"
27 #include "movegen.h"
28 #include "position.h"
29 #include "search.h"
30 #include "thread.h"
31 #include "timeman.h"
32 #include "tt.h"
33 #include "uci.h"
34 #include "syzygy/tbprobe.h"
35 #include "nnue/evaluate_nnue.h"
36
37 using namespace std;
38
39 namespace Stockfish {
40
41 namespace {
42
43   // FEN string for the initial position in standard chess
44   const char* StartFEN = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
45
46
47   // position() is called when the engine receives the "position" UCI command.
48   // It sets up the position that is described in the given FEN string ("fen") or
49   // the initial position ("startpos") and then makes the moves given in the following
50   // move list ("moves").
51
52   void position(Position& pos, istringstream& is, StateListPtr& states) {
53
54     Move m;
55     string token, fen;
56
57     is >> token;
58
59     if (token == "startpos")
60     {
61         fen = StartFEN;
62         is >> token; // Consume the "moves" token, if any
63     }
64     else if (token == "fen")
65         while (is >> token && token != "moves")
66             fen += token + " ";
67     else
68         return;
69
70     states = StateListPtr(new std::deque<StateInfo>(1)); // Drop the old state and create a new one
71     pos.set(fen, Options["UCI_Chess960"], &states->back(), Threads.main());
72
73     // Parse the move list, if any
74     while (is >> token && (m = UCI::to_move(pos, token)) != MOVE_NONE)
75     {
76         states->emplace_back();
77         pos.do_move(m, states->back());
78     }
79   }
80
81   // trace_eval() prints the evaluation of the current position, consistent with
82   // the UCI options set so far.
83
84   void trace_eval(Position& pos) {
85
86     StateListPtr states(new std::deque<StateInfo>(1));
87     Position p;
88     p.set(pos.fen(), Options["UCI_Chess960"], &states->back(), Threads.main());
89
90     Eval::NNUE::verify();
91
92     sync_cout << "\n" << Eval::trace(p) << sync_endl;
93   }
94
95
96   // setoption() is called when the engine receives the "setoption" UCI command.
97   // The function updates the UCI option ("name") to the given value ("value").
98
99   void setoption(istringstream& is) {
100
101     string token, name, value;
102
103     is >> token; // Consume the "name" token
104
105     // Read the option name (can contain spaces)
106     while (is >> token && token != "value")
107         name += (name.empty() ? "" : " ") + token;
108
109     // Read the option value (can contain spaces)
110     while (is >> token)
111         value += (value.empty() ? "" : " ") + token;
112
113     if (Options.count(name))
114         Options[name] = value;
115     else
116         sync_cout << "No such option: " << name << sync_endl;
117   }
118
119
120   // go() is called when the engine receives the "go" UCI command. The function
121   // sets the thinking time and other parameters from the input string, then starts
122   // with a search.
123
124   void go(Position& pos, istringstream& is, StateListPtr& states) {
125
126     Search::LimitsType limits;
127     string token;
128     bool ponderMode = false;
129
130     limits.startTime = now(); // The search starts as early as possible
131
132     while (is >> token)
133         if (token == "searchmoves") // Needs to be the last command on the line
134             while (is >> token)
135                 limits.searchmoves.push_back(UCI::to_move(pos, token));
136
137         else if (token == "wtime")     is >> limits.time[WHITE];
138         else if (token == "btime")     is >> limits.time[BLACK];
139         else if (token == "winc")      is >> limits.inc[WHITE];
140         else if (token == "binc")      is >> limits.inc[BLACK];
141         else if (token == "movestogo") is >> limits.movestogo;
142         else if (token == "depth")     is >> limits.depth;
143         else if (token == "nodes")     is >> limits.nodes;
144         else if (token == "movetime")  is >> limits.movetime;
145         else if (token == "mate")      is >> limits.mate;
146         else if (token == "perft")     is >> limits.perft;
147         else if (token == "infinite")  limits.infinite = 1;
148         else if (token == "ponder")    ponderMode = true;
149
150     Threads.start_thinking(pos, states, limits, ponderMode);
151   }
152
153
154   // bench() is called when the engine receives the "bench" command.
155   // Firstly, a list of UCI commands is set up according to the bench
156   // parameters, then it is run one by one, printing a summary at the end.
157
158   void bench(Position& pos, istream& args, StateListPtr& states) {
159
160     string token;
161     uint64_t num, nodes = 0, cnt = 1;
162
163     vector<string> list = setup_bench(pos, args);
164     num = count_if(list.begin(), list.end(), [](const string& s) { return s.find("go ") == 0 || s.find("eval") == 0; });
165
166     TimePoint elapsed = now();
167
168     for (const auto& cmd : list)
169     {
170         istringstream is(cmd);
171         is >> skipws >> token;
172
173         if (token == "go" || token == "eval")
174         {
175             cerr << "\nPosition: " << cnt++ << '/' << num << " (" << pos.fen() << ")" << endl;
176             if (token == "go")
177             {
178                go(pos, is, states);
179                Threads.main()->wait_for_search_finished();
180                nodes += Threads.nodes_searched();
181             }
182             else
183                trace_eval(pos);
184         }
185         else if (token == "setoption")  setoption(is);
186         else if (token == "position")   position(pos, is, states);
187         else if (token == "ucinewgame") { Search::clear(); elapsed = now(); } // Search::clear() may take a while
188     }
189
190     elapsed = now() - elapsed + 1; // Ensure positivity to avoid a 'divide by zero'
191
192     dbg_print();
193
194     cerr << "\n==========================="
195          << "\nTotal time (ms) : " << elapsed
196          << "\nNodes searched  : " << nodes
197          << "\nNodes/second    : " << 1000 * nodes / elapsed << endl;
198   }
199
200   // The win rate model returns the probability of winning (in per mille units) given an
201   // eval and a game ply. It fits the LTC fishtest statistics rather accurately.
202   int win_rate_model(Value v, int ply) {
203
204      // The model only captures up to 240 plies, so limit the input and then rescale
205      double m = std::min(240, ply) / 64.0;
206
207      // The coefficients of a third-order polynomial fit is based on the fishtest data
208      // for two parameters that need to transform eval to the argument of a logistic
209      // function.
210      constexpr double as[] = {   0.38036525,   -2.82015070,   23.17882135,  307.36768407};
211      constexpr double bs[] = {  -2.29434733,   13.27689788,  -14.26828904,   63.45318330 };
212
213      // Enforce that NormalizeToPawnValue corresponds to a 50% win rate at ply 64
214      static_assert(UCI::NormalizeToPawnValue == int(as[0] + as[1] + as[2] + as[3]));
215
216      double a = (((as[0] * m + as[1]) * m + as[2]) * m) + as[3];
217      double b = (((bs[0] * m + bs[1]) * m + bs[2]) * m) + bs[3];
218
219      // Transform the eval to centipawns with limited range
220      double x = std::clamp(double(v), -4000.0, 4000.0);
221
222      // Return the win rate in per mille units rounded to the nearest value
223      return int(0.5 + 1000 / (1 + std::exp((a - x) / b)));
224   }
225
226 } // namespace
227
228
229 /// UCI::loop() waits for a command from the stdin, parses it and then calls the appropriate
230 /// function. It also intercepts an end-of-file (EOF) indication from the stdin to ensure a
231 /// graceful exit if the GUI dies unexpectedly. When called with some command-line arguments,
232 /// like running 'bench', the function returns immediately after the command is executed.
233 /// In addition to the UCI ones, some additional debug commands are also supported.
234
235 void UCI::loop(int argc, char* argv[]) {
236
237   Position pos;
238   string token, cmd;
239   StateListPtr states(new std::deque<StateInfo>(1));
240
241   pos.set(StartFEN, false, &states->back(), Threads.main());
242
243   for (int i = 1; i < argc; ++i)
244       cmd += std::string(argv[i]) + " ";
245
246   do {
247       if (argc == 1 && !getline(cin, cmd)) // Wait for an input or an end-of-file (EOF) indication
248           cmd = "quit";
249
250       istringstream is(cmd);
251
252       token.clear(); // Avoid a stale if getline() returns nothing or a blank line
253       is >> skipws >> token;
254
255       if (    token == "quit"
256           ||  token == "stop")
257           Threads.stop = true;
258
259       // The GUI sends 'ponderhit' to tell that the user has played the expected move.
260       // So, 'ponderhit' is sent if pondering was done on the same move that the user
261       // has played. The search should continue, but should also switch from pondering
262       // to the normal search.
263       else if (token == "ponderhit")
264           Threads.main()->ponder = false; // Switch to the normal search
265
266       else if (token == "uci")
267           sync_cout << "id name " << engine_info(true)
268                     << "\n"       << Options
269                     << "\nuciok"  << sync_endl;
270
271       else if (token == "setoption")  setoption(is);
272       else if (token == "go")         go(pos, is, states);
273       else if (token == "position")   position(pos, is, states);
274       else if (token == "ucinewgame") Search::clear();
275       else if (token == "isready")    sync_cout << "readyok" << sync_endl;
276
277       // Add custom non-UCI commands, mainly for debugging purposes.
278       // These commands must not be used during a search!
279       else if (token == "flip")     pos.flip();
280       else if (token == "bench")    bench(pos, is, states);
281       else if (token == "d")        sync_cout << pos << sync_endl;
282       else if (token == "eval")     trace_eval(pos);
283       else if (token == "compiler") sync_cout << compiler_info() << sync_endl;
284       else if (token == "export_net")
285       {
286           std::optional<std::string> filename;
287           std::string f;
288           if (is >> skipws >> f)
289               filename = f;
290           Eval::NNUE::save_eval(filename);
291       }
292       else if (token == "--help" || token == "help" || token == "--license" || token == "license")
293           sync_cout << "\nStockfish is a powerful chess engine for playing and analyzing."
294                        "\nIt is released as free software licensed under the GNU GPLv3 License."
295                        "\nStockfish is normally used with a graphical user interface (GUI) and implements"
296                        "\nthe Universal Chess Interface (UCI) protocol to communicate with a GUI, an API, etc."
297                        "\nFor any further information, visit https://github.com/official-stockfish/Stockfish#readme"
298                        "\nor read the corresponding README.md and Copying.txt files distributed along with this program.\n" << sync_endl;
299       else if (!token.empty() && token[0] != '#')
300           sync_cout << "Unknown command: '" << cmd << "'. Type help for more information." << sync_endl;
301
302   } while (token != "quit" && argc == 1); // The command-line arguments are one-shot
303 }
304
305
306 /// UCI::value() converts a Value to a string by adhering to the UCI protocol specification:
307 ///
308 /// cp <x>    The score from the engine's point of view in centipawns.
309 /// mate <y>  Mate in 'y' moves (not plies). If the engine is getting mated,
310 ///           uses negative values for 'y'.
311
312 string UCI::value(Value v) {
313
314   assert(-VALUE_INFINITE < v && v < VALUE_INFINITE);
315
316   stringstream ss;
317
318   if (abs(v) < VALUE_TB_WIN_IN_MAX_PLY)
319       ss << "cp " << v * 100 / NormalizeToPawnValue;
320   else if (abs(v) < VALUE_MATE_IN_MAX_PLY)
321   {
322       const int ply = VALUE_MATE_IN_MAX_PLY - 1 - std::abs(v);  // recompute ss->ply
323       ss << "cp " << (v > 0 ? 20000 - ply : -20000 + ply);
324   }
325   else
326       ss << "mate " << (v > 0 ? VALUE_MATE - v + 1 : -VALUE_MATE - v) / 2;
327
328   return ss.str();
329 }
330
331
332 /// UCI::wdl() reports the win-draw-loss (WDL) statistics given an evaluation
333 /// and a game ply based on the data gathered for fishtest LTC games.
334
335 string UCI::wdl(Value v, int ply) {
336
337   stringstream ss;
338
339   int wdl_w = win_rate_model( v, ply);
340   int wdl_l = win_rate_model(-v, ply);
341   int wdl_d = 1000 - wdl_w - wdl_l;
342   ss << " wdl " << wdl_w << " " << wdl_d << " " << wdl_l;
343
344   return ss.str();
345 }
346
347
348 /// UCI::square() converts a Square to a string in algebraic notation (g1, a7, etc.)
349
350 std::string UCI::square(Square s) {
351   return std::string{ char('a' + file_of(s)), char('1' + rank_of(s)) };
352 }
353
354
355 /// UCI::move() converts a Move to a string in coordinate notation (g1f3, a7a8q).
356 /// The only special case is castling where the e1g1 notation is printed in
357 /// standard chess mode and in e1h1 notation it is printed in Chess960 mode.
358 /// Internally, all castling moves are always encoded as 'king captures rook'.
359
360 string UCI::move(Move m, bool chess960) {
361
362   if (m == MOVE_NONE)
363       return "(none)";
364
365   if (m == MOVE_NULL)
366       return "0000";
367
368   Square from = from_sq(m);
369   Square to = to_sq(m);
370
371   if (type_of(m) == CASTLING && !chess960)
372       to = make_square(to > from ? FILE_G : FILE_C, rank_of(from));
373
374   string move = UCI::square(from) + UCI::square(to);
375
376   if (type_of(m) == PROMOTION)
377       move += " pnbrqk"[promotion_type(m)];
378
379   return move;
380 }
381
382
383 /// UCI::to_move() converts a string representing a move in coordinate notation
384 /// (g1f3, a7a8q) to the corresponding legal Move, if any.
385
386 Move UCI::to_move(const Position& pos, string& str) {
387
388   if (str.length() == 5)
389       str[4] = char(tolower(str[4])); // The promotion piece character must be lowercased
390
391   for (const auto& m : MoveList<LEGAL>(pos))
392       if (str == UCI::move(m, pos.is_chess960()))
393           return m;
394
395   return MOVE_NONE;
396 }
397
398 } // namespace Stockfish