git.sesse.net Git - stockfish/blob - 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 "uci.h"
  20
  21 #include <algorithm>
  22 #include <cassert>
  23 #include <cctype>
  24 #include <cmath>
  25 #include <cstdint>
  26 #include <cstdlib>
  27 #include <deque>
  28 #include <iostream>
  29 #include <memory>
  30 #include <optional>
  31 #include <sstream>
  32 #include <string>
  33 #include <vector>
  34
  35 #include "benchmark.h"
  36 #include "evaluate.h"
  37 #include "misc.h"
  38 #include "movegen.h"
  39 #include "nnue/evaluate_nnue.h"
  40 #include "position.h"
  41 #include "search.h"
  42 #include "thread.h"
  43
  44 namespace Stockfish {
  45
  46 namespace {
  47
  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";
  50
  51
  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) {
  57
  58     Move        m;
  59     std::string token, fen;
  60
  61     is >> token;
  62
  63     if (token == "startpos")
  64     {
  65         fen = StartFEN;
  66         is >> token;  // Consume the "moves" token, if any
  67     }
  68     else if (token == "fen")
  69         while (is >> token && token != "moves")
  70             fen += token + " ";
  71     else
  72         return;
  73
  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());
  76
  77     // Parse the move list, if any
  78     while (is >> token && (m = UCI::to_move(pos, token)) != MOVE_NONE)
  79     {
  80         states->emplace_back();
  81         pos.do_move(m, states->back());
  82     }
  83 }
  84
  85 // Prints the evaluation of the current position,
  86 // consistent with the UCI options set so far.
  87 void trace_eval(Position& pos) {
  88
  89     StateListPtr states(new std::deque<StateInfo>(1));
  90     Position     p;
  91     p.set(pos.fen(), Options["UCI_Chess960"], &states->back(), Threads.main());
  92
  93     Eval::NNUE::verify();
  94
  95     sync_cout << "\n" << Eval::trace(p) << sync_endl;
  96 }
  97
  98
  99 // Called when the engine receives the "setoption" UCI command.
 100 // The function updates the UCI option ("name") to the given value ("value").
 101
 102 void setoption(std::istringstream& is) {
 103
 104     Threads.main()->wait_for_search_finished();
 105
 106     std::string token, name, value;
 107
 108     is >> token;  // Consume the "name" token
 109
 110     // Read the option name (can contain spaces)
 111     while (is >> token && token != "value")
 112         name += (name.empty() ? "" : " ") + token;
 113
 114     // Read the option value (can contain spaces)
 115     while (is >> token)
 116         value += (value.empty() ? "" : " ") + token;
 117
 118     if (Options.count(name))
 119         Options[name] = value;
 120     else
 121         sync_cout << "No such option: " << name << sync_endl;
 122 }
 123
 124
 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
 127
 128 void go(Position& pos, std::istringstream& is, StateListPtr& states) {
 129
 130     Search::LimitsType limits;
 131     std::string        token;
 132     bool               ponderMode = false;
 133
 134     limits.startTime = now();  // The search starts as early as possible
 135
 136     while (is >> token)
 137         if (token == "searchmoves")  // Needs to be the last command on the line
 138             while (is >> token)
 139                 limits.searchmoves.push_back(UCI::to_move(pos, token));
 140
 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")
 152             is >> limits.depth;
 153         else if (token == "nodes")
 154             is >> limits.nodes;
 155         else if (token == "movetime")
 156             is >> limits.movetime;
 157         else if (token == "mate")
 158             is >> limits.mate;
 159         else if (token == "perft")
 160             is >> limits.perft;
 161         else if (token == "infinite")
 162             limits.infinite = 1;
 163         else if (token == "ponder")
 164             ponderMode = true;
 165
 166     Threads.start_thinking(pos, states, limits, ponderMode);
 167 }
 168
 169
 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.
 173
 174 void bench(Position& pos, std::istream& args, StateListPtr& states) {
 175
 176     std::string token;
 177     uint64_t    num, nodes = 0, cnt = 1;
 178
 179     std::vector<std::string> list = setup_bench(pos, args);
 180
 181     num = count_if(list.begin(), list.end(),
 182                    [](const std::string& s) { return s.find("go ") == 0 || s.find("eval") == 0; });
 183
 184     TimePoint elapsed = now();
 185
 186     for (const auto& cmd : list)
 187     {
 188         std::istringstream is(cmd);
 189         is >> std::skipws >> token;
 190
 191         if (token == "go" || token == "eval")
 192         {
 193             std::cerr << "\nPosition: " << cnt++ << '/' << num << " (" << pos.fen() << ")"
 194                       << std::endl;
 195             if (token == "go")
 196             {
 197                 go(pos, is, states);
 198                 Threads.main()->wait_for_search_finished();
 199                 nodes += Threads.nodes_searched();
 200             }
 201             else
 202                 trace_eval(pos);
 203         }
 204         else if (token == "setoption")
 205             setoption(is);
 206         else if (token == "position")
 207             position(pos, is, states);
 208         else if (token == "ucinewgame")
 209         {
 210             Search::clear();
 211             elapsed = now();
 212         }  // Search::clear() may take a while
 213     }
 214
 215     elapsed = now() - elapsed + 1;  // Ensure positivity to avoid a 'divide by zero'
 216
 217     dbg_print();
 218
 219     std::cerr << "\n==========================="
 220               << "\nTotal time (ms) : " << elapsed << "\nNodes searched  : " << nodes
 221               << "\nNodes/second    : " << 1000 * nodes / elapsed << std::endl;
 222 }
 223
 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) {
 227
 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;
 230
 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
 233     // function.
 234     constexpr double as[] = {0.38036525, -2.82015070, 23.17882135, 307.36768407};
 235     constexpr double bs[] = {-2.29434733, 13.27689788, -14.26828904, 63.45318330};
 236
 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]));
 239
 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];
 242
 243     // Transform the eval to centipawns with limited range
 244     double x = std::clamp(double(v), -4000.0, 4000.0);
 245
 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)));
 248 }
 249
 250 }  // namespace
 251
 252
 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[]) {
 259
 260     Position     pos;
 261     std::string  token, cmd;
 262     StateListPtr states(new std::deque<StateInfo>(1));
 263
 264     pos.set(StartFEN, false, &states->back(), Threads.main());
 265
 266     for (int i = 1; i < argc; ++i)
 267         cmd += std::string(argv[i]) + " ";
 268
 269     do
 270     {
 271         if (argc == 1
 272             && !getline(std::cin, cmd))  // Wait for an input or an end-of-file (EOF) indication
 273             cmd = "quit";
 274
 275         std::istringstream is(cmd);
 276
 277         token.clear();  // Avoid a stale if getline() returns nothing or a blank line
 278         is >> std::skipws >> token;
 279
 280         if (token == "quit" || token == "stop")
 281             Threads.stop = true;
 282
 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
 289
 290         else if (token == "uci")
 291             sync_cout << "id name " << engine_info(true) << "\n"
 292                       << Options << "\nuciok" << sync_endl;
 293
 294         else if (token == "setoption")
 295             setoption(is);
 296         else if (token == "go")
 297             go(pos, is, states);
 298         else if (token == "position")
 299             position(pos, is, states);
 300         else if (token == "ucinewgame")
 301             Search::clear();
 302         else if (token == "isready")
 303             sync_cout << "readyok" << sync_endl;
 304
 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")
 308             pos.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")
 314             trace_eval(pos);
 315         else if (token == "compiler")
 316             sync_cout << compiler_info() << sync_endl;
 317         else if (token == "export_net")
 318         {
 319             std::optional<std::string> filename;
 320             std::string                f;
 321             if (is >> std::skipws >> f)
 322                 filename = f;
 323             Eval::NNUE::save_eval(filename);
 324         }
 325         else if (token == "--help" || token == "help" || token == "--license" || token == "license")
 326             sync_cout
 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"
 333               << sync_endl;
 334         else if (!token.empty() && token[0] != '#')
 335             sync_cout << "Unknown command: '" << cmd << "'. Type help for more information."
 336                       << sync_endl;
 337
 338     } while (token != "quit" && argc == 1);  // The command-line arguments are one-shot
 339 }
 340
 341
 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; }
 345
 346 // Converts a Value to a string by adhering to the UCI protocol specification:
 347 //
 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) {
 352
 353     assert(-VALUE_INFINITE < v && v < VALUE_INFINITE);
 354
 355     std::stringstream ss;
 356
 357     if (std::abs(v) < VALUE_TB_WIN_IN_MAX_PLY)
 358         ss << "cp " << UCI::to_cp(v);
 359     else if (std::abs(v) <= VALUE_TB)
 360     {
 361         const int ply = VALUE_TB - std::abs(v);  // recompute ss->ply
 362         ss << "cp " << (v > 0 ? 20000 - ply : -20000 + ply);
 363     }
 364     else
 365         ss << "mate " << (v > 0 ? VALUE_MATE - v + 1 : -VALUE_MATE - v) / 2;
 366
 367     return ss.str();
 368 }
 369
 370
 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) {
 374
 375     std::stringstream ss;
 376
 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;
 381
 382     return ss.str();
 383 }
 384
 385
 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))};
 389 }
 390
 391
 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) {
 397
 398     if (m == MOVE_NONE)
 399         return "(none)";
 400
 401     if (m == MOVE_NULL)
 402         return "0000";
 403
 404     Square from = from_sq(m);
 405     Square to   = to_sq(m);
 406
 407     if (type_of(m) == CASTLING && !chess960)
 408         to = make_square(to > from ? FILE_G : FILE_C, rank_of(from));
 409
 410     std::string move = UCI::square(from) + UCI::square(to);
 411
 412     if (type_of(m) == PROMOTION)
 413         move += " pnbrqk"[promotion_type(m)];
 414
 415     return move;
 416 }
 417
 418
 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) {
 422
 423     if (str.length() == 5)
 424         str[4] = char(tolower(str[4]));  // The promotion piece character must be lowercased
 425
 426     for (const auto& m : MoveList<LEGAL>(pos))
 427         if (str == UCI::move(m, pos.is_chess960()))
 428             return m;
 429
 430     return MOVE_NONE;
 431 }
 432
 433 }  // namespace Stockfish