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-2008 Tord Romstad (Glaurung author)
   4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
   5   Copyright (C) 2015-2019 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
   6
   7   Stockfish is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   Stockfish is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include <cassert>
  22 #include <iostream>
  23 #include <sstream>
  24 #include <string>
  25
  26 #include "evaluate.h"
  27 #include "cluster.h"
  28 #include "movegen.h"
  29 #include "position.h"
  30 #include "search.h"
  31 #include "thread.h"
  32 #include "timeman.h"
  33 #include "tt.h"
  34 #include "uci.h"
  35 #include "syzygy/tbprobe.h"
  36
  37 using namespace std;
  38
  39 extern vector<string> setup_bench(const Position&, istream&);
  40
  41 namespace {
  42
  43   // FEN string of the initial position, normal chess
  44   const char* StartFEN = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
  45
  46
  47   // position() is called when engine receives the "position" UCI command.
  48   // The function sets up the position described in the given FEN string ("fen")
  49   // or the starting position ("startpos") and then makes the moves given in the
  50   // following 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 "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 old and create a new one
  71     pos.set(fen, Options["UCI_Chess960"], &states->back(), Threads.main());
  72
  73     // Parse 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
  82   // setoption() is called when engine receives the "setoption" UCI command. The
  83   // function updates the UCI option ("name") to the given value ("value").
  84
  85   void setoption(istringstream& is) {
  86
  87     string token, name, value;
  88
  89     is >> token; // Consume "name" token
  90
  91     // Read option name (can contain spaces)
  92     while (is >> token && token != "value")
  93         name += (name.empty() ? "" : " ") + token;
  94
  95     // Read option value (can contain spaces)
  96     while (is >> token)
  97         value += (value.empty() ? "" : " ") + token;
  98
  99     if (Options.count(name))
 100         Options[name] = value;
 101     else if (Cluster::is_root())
 102         sync_cout << "No such option: " << name << sync_endl;
 103   }
 104
 105
 106   // go() is called when engine receives the "go" UCI command. The function sets
 107   // the thinking time and other parameters from the input string, then starts
 108   // the search.
 109
 110   void go(Position& pos, istringstream& is, StateListPtr& states) {
 111
 112     Search::LimitsType limits;
 113     string token;
 114     bool ponderMode = false;
 115
 116     limits.startTime = now(); // As early as possible!
 117
 118     while (is >> token)
 119         if (token == "searchmoves")
 120             while (is >> token)
 121                 limits.searchmoves.push_back(UCI::to_move(pos, token));
 122
 123         else if (token == "wtime")     is >> limits.time[WHITE];
 124         else if (token == "btime")     is >> limits.time[BLACK];
 125         else if (token == "winc")      is >> limits.inc[WHITE];
 126         else if (token == "binc")      is >> limits.inc[BLACK];
 127         else if (token == "movestogo") is >> limits.movestogo;
 128         else if (token == "depth")     is >> limits.depth;
 129         else if (token == "nodes")     is >> limits.nodes;
 130         else if (token == "movetime")  is >> limits.movetime;
 131         else if (token == "mate")      is >> limits.mate;
 132         else if (token == "perft")     is >> limits.perft;
 133         else if (token == "infinite")  limits.infinite = 1;
 134         else if (token == "ponder")    ponderMode = true;
 135
 136     Threads.start_thinking(pos, states, limits, ponderMode);
 137   }
 138
 139
 140   // bench() is called when engine receives the "bench" command. Firstly
 141   // a list of UCI commands is setup according to bench parameters, then
 142   // it is run one by one printing a summary at the end.
 143
 144   void bench(Position& pos, istream& args, StateListPtr& states) {
 145
 146     string token;
 147     uint64_t num, nodes = 0, cnt = 1;
 148
 149     vector<string> list = setup_bench(pos, args);
 150     num = count_if(list.begin(), list.end(), [](string s) { return s.find("go ") == 0; });
 151
 152     TimePoint elapsed = now();
 153
 154     for (const auto& cmd : list)
 155     {
 156         istringstream is(cmd);
 157         is >> skipws >> token;
 158
 159         if (token == "go")
 160         {
 161             if (Cluster::is_root())
 162                 cerr << "\nPosition: " << cnt++ << '/' << num << endl;
 163             go(pos, is, states);
 164             Threads.main()->wait_for_search_finished();
 165             nodes += Cluster::nodes_searched();
 166         }
 167         else if (token == "setoption")  setoption(is);
 168         else if (token == "position")   position(pos, is, states);
 169         else if (token == "ucinewgame") { Search::clear(); elapsed = now(); } // Search::clear() may take some while
 170     }
 171
 172     elapsed = now() - elapsed + 1; // Ensure positivity to avoid a 'divide by zero'
 173
 174     dbg_print(); // Just before exiting
 175
 176     if (Cluster::is_root())
 177         cerr << "\n==========================="
 178              << "\nTotal time (ms) : " << elapsed
 179              << "\nNodes searched  : " << nodes
 180              << "\nNodes/second    : " << 1000 * nodes / elapsed << endl;
 181   }
 182
 183 } // namespace
 184
 185
 186 /// UCI::loop() waits for a command from stdin, parses it and calls the appropriate
 187 /// function. Also intercepts EOF from stdin to ensure gracefully exiting if the
 188 /// GUI dies unexpectedly. When called with some command line arguments, e.g. to
 189 /// run 'bench', once the command is executed the function returns immediately.
 190 /// In addition to the UCI ones, also some additional debug commands are supported.
 191
 192 void UCI::loop(int argc, char* argv[]) {
 193
 194   Position pos;
 195   string token, cmd;
 196   StateListPtr states(new std::deque<StateInfo>(1));
 197
 198   pos.set(StartFEN, false, &states->back(), Threads.main());
 199
 200   for (int i = 1; i < argc; ++i)
 201       cmd += std::string(argv[i]) + " ";
 202
 203   do {
 204       if (argc == 1 && !Cluster::getline(cin, cmd)) // Block here waiting for input or EOF
 205           cmd = "quit";
 206
 207       istringstream is(cmd);
 208
 209       token.clear(); // Avoid a stale if getline() returns empty or blank line
 210       is >> skipws >> token;
 211
 212       if (    token == "quit"
 213           ||  token == "stop")
 214           Threads.stop = true;
 215
 216       // The GUI sends 'ponderhit' to tell us the user has played the expected move.
 217       // So 'ponderhit' will be sent if we were told to ponder on the same move the
 218       // user has played. We should continue searching but switch from pondering to
 219       // normal search.
 220       else if (token == "ponderhit")
 221           Threads.main()->ponder = false; // Switch to normal search
 222
 223       else if (token == "uci" && Cluster::is_root())
 224           sync_cout << "id name " << engine_info(true)
 225                     << "\n"       << Options
 226                     << "\nuciok"  << sync_endl;
 227
 228       else if (token == "setoption")  setoption(is);
 229       else if (token == "go")         go(pos, is, states);
 230       else if (token == "position")   position(pos, is, states);
 231       else if (token == "ucinewgame") Search::clear();
 232       else if (token == "isready" && Cluster::is_root())
 233           sync_cout << "readyok" << sync_endl;
 234
 235       // Additional custom non-UCI commands, mainly for debugging.
 236       // Do not use these commands during a search!
 237       else if (token == "flip")  pos.flip();
 238       else if (token == "bench") bench(pos, is, states);
 239       else if (token == "d" && Cluster::is_root())
 240           sync_cout << pos << sync_endl;
 241       else if (token == "eval" && Cluster::is_root())
 242           sync_cout << Eval::trace(pos) << sync_endl;
 243       else if (Cluster::is_root())
 244           sync_cout << "Unknown command: " << cmd << sync_endl;
 245
 246   } while (token != "quit" && argc == 1); // Command line args are one-shot
 247 }
 248
 249
 250 /// UCI::value() converts a Value to a string suitable for use with the UCI
 251 /// protocol specification:
 252 ///
 253 /// cp <x>    The score from the engine's point of view in centipawns.
 254 /// mate <y>  Mate in y moves, not plies. If the engine is getting mated
 255 ///           use negative values for y.
 256
 257 string UCI::value(Value v) {
 258
 259   assert(-VALUE_INFINITE < v && v < VALUE_INFINITE);
 260
 261   stringstream ss;
 262
 263   if (abs(v) < VALUE_MATE - MAX_PLY)
 264       ss << "cp " << v * 100 / PawnValueEg;
 265   else
 266       ss << "mate " << (v > 0 ? VALUE_MATE - v + 1 : -VALUE_MATE - v) / 2;
 267
 268   return ss.str();
 269 }
 270
 271
 272 /// UCI::square() converts a Square to a string in algebraic notation (g1, a7, etc.)
 273
 274 std::string UCI::square(Square s) {
 275   return std::string{ char('a' + file_of(s)), char('1' + rank_of(s)) };
 276 }
 277
 278
 279 /// UCI::move() converts a Move to a string in coordinate notation (g1f3, a7a8q).
 280 /// The only special case is castling, where we print in the e1g1 notation in
 281 /// normal chess mode, and in e1h1 notation in chess960 mode. Internally all
 282 /// castling moves are always encoded as 'king captures rook'.
 283
 284 string UCI::move(Move m, bool chess960) {
 285
 286   Square from = from_sq(m);
 287   Square to = to_sq(m);
 288
 289   if (m == MOVE_NONE)
 290       return "(none)";
 291
 292   if (m == MOVE_NULL)
 293       return "0000";
 294
 295   if (type_of(m) == CASTLING && !chess960)
 296       to = make_square(to > from ? FILE_G : FILE_C, rank_of(from));
 297
 298   string move = UCI::square(from) + UCI::square(to);
 299
 300   if (type_of(m) == PROMOTION)
 301       move += " pnbrqk"[promotion_type(m)];
 302
 303   return move;
 304 }
 305
 306
 307 /// UCI::to_move() converts a string representing a move in coordinate notation
 308 /// (g1f3, a7a8q) to the corresponding legal Move, if any.
 309
 310 Move UCI::to_move(const Position& pos, string& str) {
 311
 312   if (str.length() == 5) // Junior could send promotion piece in uppercase
 313       str[4] = char(tolower(str[4]));
 314
 315   for (const auto& m : MoveList<LEGAL>(pos))
 316       if (str == UCI::move(m, pos.is_chess960()))
 317           return m;
 318
 319   return MOVE_NONE;
 320 }