Repository navigation
Expand file tree
/
Copy pathgtp_client.h
More file actions
217 lines (179 loc) · 6.65 KB
/
Copy pathgtp_client.h
File metadata and controls
217 lines (179 loc) · 6.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef CC_GTP_CLIENT_H_
#define CC_GTP_CLIENT_H_
#include <deque>
#include <functional>
#include <map>
#include <memory>
#include <ostream>
#include <string>
#include <type_traits>
#include <utility>
#include <vector>
#include "absl/container/flat_hash_map.h"
#include "absl/strings/str_cat.h"
#include "absl/strings/string_view.h"
#include "absl/time/time.h"
#include "absl/types/span.h"
#include "cc/async/thread_safe_queue.h"
#include "cc/color.h"
#include "cc/mcts_player.h"
#include "cc/model/model.h"
#include "cc/sgf.h"
namespace minigo {
class GtpClient {
public:
struct Options {
// If non-zero, GtpPlayer will print the current state of its tree search
// every report_search_interval to stderr in a format recognized by Minigui.
absl::Duration report_search_interval;
// Maximum number of times to perform TreeSearch when pondering is enabled.
// The engine's ponder count is reset to 0 each time it receives a "ponder"
// GTP command.
int ponder_limit = 0;
// If true, we will always pass if the opponent passes.
bool courtesy_pass = false;
// If true, the subtree of a played move that was expanded during tree
// search will be kept.
// If false, all children of the current root will be deleted before each
// move is played.
bool tree_reuse = true;
};
GtpClient(std::unique_ptr<ModelFactory> model_factory,
std::shared_ptr<InferenceCache> inference_cache,
const std::string& model_descriptor,
const Game::Options& game_options,
const MctsPlayer::Options& player_options,
const GtpClient::Options& client_options);
virtual ~GtpClient();
virtual void Run();
virtual void NewGame();
protected:
// Response from the GTP command handler.
struct Response {
static Response Ok(std::string str = "") {
Response response;
response.str = std::move(str);
response.ok = true;
return response;
}
template <typename... Args>
static Response Error(const Args&... args) {
Response response;
response.str = absl::StrCat(args...);
response.ok = false;
return response;
}
static Response Done() {
Response response;
response.done = true;
return response;
}
void set_cmd_id(int id) {
has_cmd_id = true;
cmd_id = id;
}
friend std::ostream& operator<<(std::ostream& os, const Response& r) {
os << (r.ok ? "=" : "?");
if (r.has_cmd_id) {
os << r.cmd_id;
}
if (!r.str.empty()) {
os << " " << r.str;
}
return os << "\n\n";
}
// Response to print to stdout.
std::string str;
// True if the command completed successfully.
bool ok = false;
// True if the Run loop should exit.
bool done = false;
bool has_cmd_id = false;
int cmd_id = 0;
};
using CmdArgs = const std::vector<absl::string_view>&;
// Helper to register a GTP command handler.
// Templated to allow commands from subclasses to be registered.
template <typename T>
void RegisterCmd(const std::string& cmd, Response (T::*handler)(CmdArgs)) {
static_assert(std::is_base_of<GtpClient, T>::value,
"T must be derived from GtpClient");
cmd_handlers_[cmd] =
std::bind(handler, static_cast<T*>(this), std::placeholders::_1);
}
// Begin pondering again if requested.
void MaybeStartPondering();
// If waiting for the opponent to play, consider thinking for a bit.
// Returns true if we pondered.
bool MaybePonder();
virtual void Ponder();
// Replay a loaded SGF game.
// Called by HandleLoadSgf after the SGF file has been loaded and parsed, and
// a new game has been started.
virtual Response ReplaySgf(
const std::vector<std::unique_ptr<sgf::Node>>& trees);
// Handles a GTP command specified by `line`.
// Returns a (bool, string) pair containing whether the GtpPlayer should
// continue running and the result of the command to write to stdout.
virtual Response HandleCmd(const std::string& line);
Response CheckArgsExact(size_t expected_num_args, CmdArgs args);
Response CheckArgsRange(size_t expected_min_args, size_t expected_max_args,
CmdArgs args);
Response DispatchCmd(const std::string& cmd, CmdArgs args);
// TODO(tommadams): clearly document these methods w.r.t. the GTP standard and
// what public methods they call.
virtual Response HandleBenchmark(CmdArgs args);
virtual Response HandleBoardsize(CmdArgs args);
virtual Response HandleClearBoard(CmdArgs args);
virtual Response HandleFinalScore(CmdArgs args);
virtual Response HandleGenmove(CmdArgs args);
virtual Response HandleKnownCommand(CmdArgs args);
virtual Response HandleKomi(CmdArgs args);
virtual Response HandleListCommands(CmdArgs args);
virtual Response HandleLoadsgf(CmdArgs args);
virtual Response HandleName(CmdArgs args);
virtual Response HandlePlay(CmdArgs args);
virtual Response HandlePonder(CmdArgs args);
virtual Response HandleReadouts(CmdArgs args);
virtual Response HandleShowboard(CmdArgs args);
virtual Response HandleUndo(CmdArgs args);
// Utilities for processing SGF files.
Response ParseSgf(const std::string& sgf_str,
std::vector<std::unique_ptr<sgf::Node>>* trees);
std::unique_ptr<ModelFactory> model_factory_;
std::shared_ptr<InferenceCache> inference_cache_;
std::unique_ptr<MctsPlayer> player_;
std::unique_ptr<Game> game_;
// There are two kinds of pondering supported:
// kReadLimited: pondering will run for a maximum number of reads.
// kTimeLimited: pondering will run for a maximum number of seconds.
enum class PonderType {
kOff,
kReadLimited,
kTimeLimited,
};
PonderType ponder_type_ = PonderType::kOff;
int ponder_read_count_ = 0;
absl::Duration ponder_duration_ = {};
absl::Time ponder_time_limit_ = absl::InfinitePast();
bool ponder_limit_reached_ = false;
Options options_;
absl::flat_hash_map<std::string, std::function<Response(CmdArgs)>>
cmd_handlers_;
ThreadSafeQueue<std::string> stdin_queue_;
};
} // namespace minigo
#endif // CC_GTP_CLIENT_H_