a56a54031d07722673f4e95368a01b22a8b64175
[stockfish] / 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-2017 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 "movegen.h"
28 #include "position.h"
29 #include "search.h"
30 #include "thread.h"
31 #include "tt.h"
32 #include "timeman.h"
33 #include "uci.h"
34 #include "syzygy/tbprobe.h"
35
36 using namespace std;
37
38 extern void benchmark(const Position& pos, istream& is);
39
40 namespace {
41
42   // FEN string of the initial position, normal chess
43   const char* StartFEN = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
44
45   // A list to keep track of the position states along the setup moves (from the
46   // start position to the position just before the search starts). Needed by
47   // 'draw by repetition' detection.
48   StateListPtr States(new std::deque<StateInfo>(1));
49
50
51   // position() is called when engine receives the "position" UCI command.
52   // The function sets up the position described in the given FEN string ("fen")
53   // or the starting position ("startpos") and then makes the moves given in the
54   // following move list ("moves").
55
56   void position(Position& pos, istringstream& is) {
57
58     Move m;
59     string token, fen;
60
61     is >> token;
62
63     if (token == "startpos")
64     {
65         fen = StartFEN;
66         is >> token; // Consume "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));
75     pos.set(fen, Options["UCI_Chess960"], &States->back(), Threads.main());
76
77     // Parse move list (if any)
78     while (is >> token && (m = UCI::to_move(pos, token)) != MOVE_NONE)
79     {
80         States->push_back(StateInfo());
81         pos.do_move(m, States->back());
82     }
83   }
84
85
86   // setoption() is called when engine receives the "setoption" UCI command. The
87   // function updates the UCI option ("name") to the given value ("value").
88
89   void setoption(istringstream& is) {
90
91     string token, name, value;
92
93     is >> token; // Consume "name" token
94
95     // Read option name (can contain spaces)
96     while (is >> token && token != "value")
97         name += string(" ", name.empty() ? 0 : 1) + token;
98
99     // Read option value (can contain spaces)
100     while (is >> token)
101         value += string(" ", value.empty() ? 0 : 1) + token;
102
103     if (Options.count(name))
104         Options[name] = value;
105     else
106         sync_cout << "No such option: " << name << sync_endl;
107   }
108
109
110   // go() is called when engine receives the "go" UCI command. The function sets
111   // the thinking time and other parameters from the input string, then starts
112   // the search.
113
114   void go(Position& pos, istringstream& is) {
115
116     Search::LimitsType limits;
117     string token;
118     bool ponderMode = false;
119
120     limits.startTime = now(); // As early as possible!
121
122     while (is >> token)
123         if (token == "searchmoves")
124             while (is >> token)
125                 limits.searchmoves.push_back(UCI::to_move(pos, token));
126
127         else if (token == "wtime")     is >> limits.time[WHITE];
128         else if (token == "btime")     is >> limits.time[BLACK];
129         else if (token == "winc")      is >> limits.inc[WHITE];
130         else if (token == "binc")      is >> limits.inc[BLACK];
131         else if (token == "movestogo") is >> limits.movestogo;
132         else if (token == "depth")     is >> limits.depth;
133         else if (token == "nodes")     is >> limits.nodes;
134         else if (token == "movetime")  is >> limits.movetime;
135         else if (token == "mate")      is >> limits.mate;
136         else if (token == "infinite")  limits.infinite = 1;
137         else if (token == "ponder")    ponderMode = true;
138
139     Threads.start_thinking(pos, States, limits, ponderMode);
140   }
141
142 } // namespace
143
144
145 /// UCI::loop() waits for a command from stdin, parses it and calls the appropriate
146 /// function. Also intercepts EOF from stdin to ensure gracefully exiting if the
147 /// GUI dies unexpectedly. When called with some command line arguments, e.g. to
148 /// run 'bench', once the command is executed the function returns immediately.
149 /// In addition to the UCI ones, also some additional debug commands are supported.
150
151 void UCI::loop(int argc, char* argv[]) {
152
153   Position pos;
154   string token, cmd;
155   Thread* uiThread = new Thread();
156
157   pos.set(StartFEN, false, &States->back(), uiThread);
158
159   for (int i = 1; i < argc; ++i)
160       cmd += std::string(argv[i]) + " ";
161
162   do {
163       if (argc == 1 && !getline(cin, cmd)) // Block here waiting for input or EOF
164           cmd = "quit";
165
166       istringstream is(cmd);
167
168       token.clear(); // getline() could return empty or blank line
169       is >> skipws >> token;
170
171       // The GUI sends 'ponderhit' to tell us the user has played the expected move.
172       // So 'ponderhit' will be sent if we were told to ponder on the same move the
173       // user has played. We should continue searching but switch from pondering to
174       // normal search. In case Threads.stopOnPonderhit is set we are waiting for
175       // 'ponderhit' to stop the search, for instance if max search depth is reached.
176       if (    token == "quit"
177           ||  token == "stop"
178           || (token == "ponderhit" && Threads.stopOnPonderhit))
179           Threads.stop = true;
180
181       else if (token == "ponderhit")
182           Threads.ponder = false; // Switch to normal search
183
184       else if (token == "uci")
185           sync_cout << "id name " << engine_info(true)
186                     << "\n"       << Options
187                     << "\nuciok"  << sync_endl;
188
189       else if (token == "ucinewgame") Search::clear();
190       else if (token == "isready")    sync_cout << "readyok" << sync_endl;
191       else if (token == "go")         go(pos, is);
192       else if (token == "position")   position(pos, is);
193       else if (token == "setoption")  setoption(is);
194
195       // Additional custom non-UCI commands, useful for debugging
196       else if (token == "flip")       pos.flip();
197       else if (token == "bench")      benchmark(pos, is);
198       else if (token == "d")          sync_cout << pos << sync_endl;
199       else if (token == "eval")       sync_cout << Eval::trace(pos) << sync_endl;
200       else if (token == "perft")
201       {
202           int depth;
203           stringstream ss;
204
205           is >> depth;
206           ss << Options["Hash"]    << " "
207              << Options["Threads"] << " " << depth << " current perft";
208
209           benchmark(pos, ss);
210       }
211       else
212           sync_cout << "Unknown command: " << cmd << sync_endl;
213
214   } while (token != "quit" && argc == 1); // Passed args have one-shot behaviour
215
216   Threads.main()->wait_for_search_finished();
217   delete uiThread;
218 }
219
220
221 /// UCI::value() converts a Value to a string suitable for use with the UCI
222 /// protocol specification:
223 ///
224 /// cp <x>    The score from the engine's point of view in centipawns.
225 /// mate <y>  Mate in y moves, not plies. If the engine is getting mated
226 ///           use negative values for y.
227
228 string UCI::value(Value v) {
229
230   assert(-VALUE_INFINITE < v && v < VALUE_INFINITE);
231
232   stringstream ss;
233
234   if (abs(v) < VALUE_MATE - MAX_PLY)
235       ss << "cp " << v * 100 / PawnValueEg;
236   else
237       ss << "mate " << (v > 0 ? VALUE_MATE - v + 1 : -VALUE_MATE - v) / 2;
238
239   return ss.str();
240 }
241
242
243 /// UCI::square() converts a Square to a string in algebraic notation (g1, a7, etc.)
244
245 std::string UCI::square(Square s) {
246   return std::string{ char('a' + file_of(s)), char('1' + rank_of(s)) };
247 }
248
249
250 /// UCI::move() converts a Move to a string in coordinate notation (g1f3, a7a8q).
251 /// The only special case is castling, where we print in the e1g1 notation in
252 /// normal chess mode, and in e1h1 notation in chess960 mode. Internally all
253 /// castling moves are always encoded as 'king captures rook'.
254
255 string UCI::move(Move m, bool chess960) {
256
257   Square from = from_sq(m);
258   Square to = to_sq(m);
259
260   if (m == MOVE_NONE)
261       return "(none)";
262
263   if (m == MOVE_NULL)
264       return "0000";
265
266   if (type_of(m) == CASTLING && !chess960)
267       to = make_square(to > from ? FILE_G : FILE_C, rank_of(from));
268
269   string move = UCI::square(from) + UCI::square(to);
270
271   if (type_of(m) == PROMOTION)
272       move += " pnbrqk"[promotion_type(m)];
273
274   return move;
275 }
276
277
278 /// UCI::to_move() converts a string representing a move in coordinate notation
279 /// (g1f3, a7a8q) to the corresponding legal Move, if any.
280
281 Move UCI::to_move(const Position& pos, string& str) {
282
283   if (str.length() == 5) // Junior could send promotion piece in uppercase
284       str[4] = char(tolower(str[4]));
285
286   for (const auto& m : MoveList<LEGAL>(pos))
287       if (str == UCI::move(m, pos.is_chess960()))
288           return m;
289
290   return MOVE_NONE;
291 }