gtp.c

   1 #define DEBUG
   2 #include <assert.h>
   3 #include <ctype.h>
   4 #include <stdarg.h>
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <string.h>
   8 #include <unistd.h>
   9
  10 #include "board.h"
  11 #include "debug.h"
  12 #include "engine.h"
  13 #include "gtp.h"
  14 #include "mq.h"
  15 #include "uct/uct.h"
  16 #include "version.h"
  17 #include "timeinfo.h"
  18
  19 #define NO_REPLY (-2)
  20
  21 /* Sleep 5 seconds after a game ends to give time to kill the program. */
  22 #define GAME_OVER_SLEEP 5
  23
  24 void
  25 gtp_prefix(char prefix, int id)
  26 {
  27         if (id == NO_REPLY) return;
  28         if (id >= 0)
  29                 printf("%c%d ", prefix, id);
  30         else
  31                 printf("%c ", prefix);
  32 }
  33
  34 void
  35 gtp_flush(void)
  36 {
  37         putchar('\n');
  38         fflush(stdout);
  39 }
  40
  41 void
  42 gtp_output(char prefix, int id, va_list params)
  43 {
  44         if (id == NO_REPLY) return;
  45         gtp_prefix(prefix, id);
  46         char *s;
  47         while ((s = va_arg(params, char *))) {
  48                 fputs(s, stdout);
  49         }
  50         putchar('\n');
  51         gtp_flush();
  52 }
  53
  54 void
  55 gtp_reply(int id, ...)
  56 {
  57         va_list params;
  58         va_start(params, id);
  59         gtp_output('=', id, params);
  60         va_end(params);
  61 }
  62
  63 void
  64 gtp_error(int id, ...)
  65 {
  66         va_list params;
  67         va_start(params, id);
  68         gtp_output('?', id, params);
  69         va_end(params);
  70 }
  71
  72
  73 /* XXX: THIS IS TOTALLY INSECURE!!!!
  74  * Even basic input checking is missing. */
  75
  76 enum parse_code
  77 gtp_parse(struct board *board, struct engine *engine, struct time_info *ti, char *buf)
  78 {
  79 #define next_tok(to_) \
  80         to_ = next; \
  81         next = next + strcspn(next, " \t\r\n"); \
  82         if (*next) { \
  83                 *next = 0; next++; \
  84                 next += strspn(next, " \t\r\n"); \
  85         }
  86
  87         if (strchr(buf, '#'))
  88                 *strchr(buf, '#') = 0;
  89
  90         char *cmd, *next = buf;
  91         next_tok(cmd);
  92
  93         int id = -1;
  94         if (isdigit(*cmd)) {
  95                 id = atoi(cmd);
  96                 next_tok(cmd);
  97         }
  98
  99         if (!*cmd)
 100                 return P_OK;
 101
 102         if (!strcasecmp(cmd, "protocol_version")) {
 103                 gtp_reply(id, "2", NULL);
 104                 return P_OK;
 105
 106         } else if (!strcasecmp(cmd, "name")) {
 107                 /* KGS hack */
 108                 gtp_reply(id, "Pachi ", engine->name, NULL);
 109                 return P_OK;
 110
 111         } else if (!strcasecmp(cmd, "version")) {
 112                 gtp_reply(id, PACHI_VERSION, ": ", engine->comment, NULL);
 113                 return P_OK;
 114
 115                 /* TODO: known_command */
 116
 117         } else if (!strcasecmp(cmd, "list_commands")) {
 118                 /* The internal command pachi-genmoves is not exported,
 119                  * it should only be used between master and slaves of
 120                  * the distributed engine. */
 121                 gtp_reply(id, "protocol_version\n"
 122                               "name\n"
 123                               "version\n"
 124                               "list_commands\n"
 125                               "quit\n"
 126                               "boardsize\n"
 127                               "clear_board\n"
 128                               "kgs-game_over\n"
 129                               "komi\n"
 130                               "kgs-rules\n"
 131                               "play\n"
 132                               "genmove\n"
 133                               "kgs-genmove_cleanup\n"
 134                               "set_free_handicap\n"
 135                               "place_free_handicap\n"
 136                               "final_status_list\n"
 137                               "kgs-chat\n"
 138                               "time_left\n"
 139                               "time_settings\n"
 140                               "kgs-time_settings", NULL);
 141                 return P_OK;
 142         }
 143
 144         if (engine->notify) {
 145                 char *reply;
 146                 enum parse_code c = engine->notify(engine, board, id, cmd, next, &reply);
 147                 if (c == P_NOREPLY) {
 148                         id = NO_REPLY;
 149                 } else if (c == P_DONE_OK) {
 150                         gtp_reply(id, reply, NULL);
 151                         return P_OK;
 152                 } else if (c == P_DONE_ERROR) {
 153                         gtp_error(id, reply, NULL);
 154                         /* This is an internal error for the engine, but
 155                          * it is still OK from main's point of view. */
 156                         return P_OK;
 157                 } else if (c != P_OK) {
 158                         return c;
 159                 }
 160         }
 161
 162         if (!strcasecmp(cmd, "quit")) {
 163                 gtp_reply(id, NULL);
 164                 exit(0);
 165
 166         } else if (!strcasecmp(cmd, "boardsize")) {
 167                 char *arg;
 168                 next_tok(arg);
 169                 board_resize(board, atoi(arg));
 170
 171                 gtp_reply(id, NULL);
 172
 173         } else if (!strcasecmp(cmd, "clear_board") || !strcasecmp(cmd, "kgs-game_over")) {
 174                 board_clear(board);
 175                 if (DEBUGL(1))
 176                         board_print(board, stderr);
 177                 if (!strcasecmp(cmd, "kgs-game_over")) {
 178                         if (DEBUGL(0))
 179                                 fprintf(stderr, "game is over\n");
 180                         /* Sleep before replying, so that kgs doesn't
 181                          * start another game immediately. */
 182                         sleep(GAME_OVER_SLEEP);
 183                 }
 184                 gtp_reply(id, NULL);
 185                 return P_ENGINE_RESET;
 186
 187         } else if (!strcasecmp(cmd, "komi")) {
 188                 char *arg;
 189                 next_tok(arg);
 190                 sscanf(arg, "%f", &board->komi);
 191
 192                 if (DEBUGL(1))
 193                         board_print(board, stderr);
 194                 gtp_reply(id, NULL);
 195
 196         } else if (!strcasecmp(cmd, "kgs-rules")) {
 197                 char *arg;
 198                 next_tok(arg);
 199                 if (!strcasecmp(arg, "japanese")) {
 200                         board->rules = RULES_JAPANESE;
 201                 } else if (!strcasecmp(arg, "chinese")) {
 202                         board->rules = RULES_CHINESE;
 203                 } else if (!strcasecmp(arg, "aga")) {
 204                         board->rules = RULES_AGA;
 205                 } else if (!strcasecmp(arg, "new_zealand")) {
 206                         board->rules = RULES_NEW_ZEALAND;
 207                 } else {
 208                         gtp_error(id, "unknown rules", NULL);
 209                         return P_OK;
 210                 }
 211                 gtp_reply(id, NULL);
 212
 213         } else if (!strcasecmp(cmd, "play")) {
 214                 struct move m;
 215
 216                 char *arg;
 217                 next_tok(arg);
 218                 m.color = str2stone(arg);
 219                 next_tok(arg);
 220                 coord_t *c = str2coord(arg, board_size(board));
 221                 m.coord = *c; coord_done(c);
 222                 char *reply = NULL;
 223
 224                 if (DEBUGL(1))
 225                         fprintf(stderr, "got move %d,%d,%d\n", m.color, coord_x(m.coord, board), coord_y(m.coord, board));
 226
 227                 // This is where kgs starts the timer, not at genmove!
 228                 time_start_timer(&ti[stone_other(m.color)]);
 229
 230                 if (engine->notify_play)
 231                         reply = engine->notify_play(engine, board, &m);
 232                 if (board_play(board, &m) < 0) {
 233                         if (DEBUGL(0)) {
 234                                 fprintf(stderr, "! ILLEGAL MOVE %d,%d,%d\n", m.color, coord_x(m.coord, board), coord_y(m.coord, board));
 235                                 board_print(board, stderr);
 236                         }
 237                         gtp_error(id, "illegal move", NULL);
 238                 } else {
 239                         if (DEBUGL(1))
 240                                 board_print_custom(board, stderr, engine->printhook);
 241                         gtp_reply(id, reply, NULL);
 242                 }
 243
 244         } else if (!strcasecmp(cmd, "genmove") || !strcasecmp(cmd, "kgs-genmove_cleanup")) {
 245                 char *arg;
 246                 next_tok(arg);
 247                 enum stone color = str2stone(arg);
 248
 249                 coord_t *c = engine->genmove(engine, board, &ti[color], color, !strcasecmp(cmd, "kgs-genmove_cleanup"));
 250                 struct move m = { *c, color };
 251                 board_play(board, &m);
 252                 char *str = coord2str(*c, board);
 253                 if (DEBUGL(1))
 254                         fprintf(stderr, "playing move %s\n", str);
 255                 if (DEBUGL(1)) {
 256                         board_print_custom(board, stderr, engine->printhook);
 257                 }
 258                 gtp_reply(id, str, NULL);
 259                 free(str); coord_done(c);
 260
 261                 /* Account for spent time. If our GTP peer keeps our clock, this will
 262                  * be overriden by next time_left GTP command properly. */
 263                 /* (XXX: Except if we pass to byoyomi and the peer doesn't, but that
 264                  * should be absolutely rare situation and we will just spend a little
 265                  * less time than we could on next few moves.) */
 266                 if (ti[color].period != TT_NULL && ti[color].dim == TD_WALLTIME)
 267                         time_sub(&ti[color], time_now() - ti[color].len.t.timer_start, true);
 268
 269         } else if (!strcasecmp(cmd, "pachi-genmoves") || !strcasecmp(cmd, "pachi-genmoves_cleanup")) {
 270                 char *arg;
 271                 next_tok(arg);
 272                 enum stone color = str2stone(arg);
 273
 274                 char *reply = engine->genmoves(engine, board, &ti[color], color, next,
 275                                                !strcasecmp(cmd, "pachi-genmoves_cleanup"));
 276                 if (!reply) {
 277                         gtp_error(id, "genmoves error", NULL);
 278                         return P_OK;
 279                 }
 280                 if (DEBUGL(3))
 281                         fprintf(stderr, "proposing moves %s\n", reply);
 282                 if (DEBUGL(4))
 283                         board_print_custom(board, stderr, engine->printhook);
 284                 gtp_reply(id, reply, NULL);
 285
 286         } else if (!strcasecmp(cmd, "set_free_handicap")) {
 287                 struct move m;
 288                 m.color = S_BLACK;
 289
 290                 char *arg;
 291                 next_tok(arg);
 292                 do {
 293                         coord_t *c = str2coord(arg, board_size(board));
 294                         m.coord = *c; coord_done(c);
 295                         if (DEBUGL(1))
 296                                 fprintf(stderr, "setting handicap %d,%d\n", coord_x(m.coord, board), coord_y(m.coord, board));
 297
 298                         if (board_play(board, &m) < 0) {
 299                                 if (DEBUGL(0))
 300                                         fprintf(stderr, "! ILLEGAL MOVE %d,%d,%d\n", m.color, coord_x(m.coord, board), coord_y(m.coord, board));
 301                                 gtp_error(id, "illegal move", NULL);
 302                         }
 303                         board->handicap++;
 304                         next_tok(arg);
 305                 } while (*arg);
 306                 if (DEBUGL(1))
 307                         board_print(board, stderr);
 308                 gtp_reply(id, NULL);
 309
 310         /* TODO: Engine should choose free handicap; however, it tends to take
 311          * overly long to think it all out, and unless it's clever its
 312          * handicap stones won't be of much help. ;-) */
 313         } else if (!strcasecmp(cmd, "place_free_handicap")
 314                   || !strcasecmp(cmd, "fixed_handicap")) {
 315                 char *arg;
 316                 next_tok(arg);
 317                 int stones = atoi(arg);
 318
 319                 gtp_prefix('=', id);
 320                 board_handicap(board, stones, id == NO_REPLY ? NULL : stdout);
 321                 if (DEBUGL(1))
 322                         board_print(board, stderr);
 323                 if (id == NO_REPLY) return P_OK;
 324                 putchar('\n');
 325                 gtp_flush();
 326
 327         } else if (!strcasecmp(cmd, "final_score")) {
 328                 struct move_queue q = { .moves = 0 };
 329                 if (engine->dead_group_list)
 330                         engine->dead_group_list(engine, board, &q);
 331                 float score = board_official_score(board, &q);
 332                 char str[64];
 333                 if (DEBUGL(1))
 334                         fprintf(stderr, "counted score %.1f\n", score);
 335                 if (score == 0) {
 336                         gtp_reply(id, "0", NULL);
 337                 } else if (score > 0) {
 338                         snprintf(str, 64, "W+%.1f", score);
 339                         gtp_reply(id, str, NULL);
 340                 } else {
 341                         snprintf(str, 64, "B+%.1f", -score);
 342                         gtp_reply(id, str, NULL);
 343                 }
 344
 345         /* XXX: This is a huge hack. */
 346         } else if (!strcasecmp(cmd, "final_status_list")) {
 347                 if (id == NO_REPLY) return P_OK;
 348                 char *arg;
 349                 next_tok(arg);
 350                 struct move_queue q = { .moves = 0 };
 351                 if (engine->dead_group_list)
 352                         engine->dead_group_list(engine, board, &q);
 353                 /* else we return empty list - i.e. engine not supporting
 354                  * this assumes all stones alive at the game end. */
 355                 if (!strcasecmp(arg, "dead")) {
 356                         gtp_prefix('=', id);
 357                         for (unsigned int i = 0; i < q.moves; i++) {
 358                                 foreach_in_group(board, q.move[i]) {
 359                                         printf("%s ", coord2sstr(c, board));
 360                                 } foreach_in_group_end;
 361                                 putchar('\n');
 362                         }
 363                         if (!q.moves)
 364                                 putchar('\n');
 365                         gtp_flush();
 366                 } else if (!strcasecmp(arg, "seki") || !strcasecmp(arg, "alive")) {
 367                         gtp_prefix('=', id);
 368                         bool printed_group = false;
 369                         foreach_point(board) { // foreach_group, effectively
 370                                 group_t g = group_at(board, c);
 371                                 if (!g || g != c) continue;
 372
 373                                 for (unsigned int i = 0; i < q.moves; i++) {
 374                                         if (q.move[i] == g)
 375                                                 goto next_group;
 376                                 }
 377                                 foreach_in_group(board, g) {
 378                                         printf("%s ", coord2sstr(c, board));
 379                                 } foreach_in_group_end;
 380                                 putchar('\n');
 381                                 printed_group = true;
 382 next_group:;
 383                         } foreach_point_end;
 384                         if (!printed_group)
 385                                 putchar('\n');
 386                         gtp_flush();
 387                 } else {
 388                         gtp_error(id, "illegal status specifier", NULL);
 389                 }
 390
 391         /* Custom commands for handling UCT opening book */
 392         } else if (!strcasecmp(cmd, "uct_genbook")) {
 393                 /* Board must be initialized properly, as if for genmove;
 394                  * makes sense only as 'uct_genbook b'. */
 395                 char *arg;
 396                 next_tok(arg);
 397                 enum stone color = str2stone(arg);
 398                 if (uct_genbook(engine, board, &ti[color], color))
 399                         gtp_reply(id, NULL);
 400                 else
 401                         gtp_error(id, "error generating book", NULL);
 402
 403         } else if (!strcasecmp(cmd, "uct_dumpbook")) {
 404                 char *arg;
 405                 next_tok(arg);
 406                 enum stone color = str2stone(arg);
 407                 uct_dumpbook(engine, board, color);
 408                 gtp_reply(id, NULL);
 409
 410         } else if (!strcasecmp(cmd, "kgs-chat")) {
 411                 char *loc;
 412                 next_tok(loc);
 413                 char *src;
 414                 next_tok(src);
 415                 char *msg;
 416                 next_tok(msg);
 417                 char *reply = NULL;
 418                 if (engine->chat)
 419                         reply = engine->chat(engine, board, msg);
 420                 if (reply)
 421                         gtp_reply(id, reply, NULL);
 422                 else
 423                         gtp_error(id, "unknown chat command", NULL);
 424
 425         } else if (!strcasecmp(cmd, "time_left")) {
 426                 char *arg;
 427                 next_tok(arg);
 428                 enum stone color = str2stone(arg);
 429                 next_tok(arg);
 430                 int time = atoi(arg);
 431                 next_tok(arg);
 432                 int stones = atoi(arg);
 433                 if (!ti[color].ignore_gtp) {
 434                         time_left(&ti[color], time, stones);
 435                 } else {
 436                         if (DEBUGL(2)) fprintf(stderr, "ignored time info\n");
 437                 }
 438
 439                 gtp_reply(id, NULL);
 440
 441         } else if (!strcasecmp(cmd, "time_settings") || !strcasecmp(cmd, "kgs-time_settings")) {
 442                 char *time_system;
 443                 char *arg;
 444                 if (!strcasecmp(cmd, "kgs-time_settings")) {
 445                         next_tok(time_system);
 446                 } else {
 447                         time_system = "canadian";
 448                 }
 449
 450                 int main_time = 0, byoyomi_time = 0, byoyomi_stones = 0, byoyomi_periods = 0;
 451                 if (!strcasecmp(time_system, "none")) {
 452                         main_time = -1;
 453                 } else if (!strcasecmp(time_system, "absolute")) {
 454                         next_tok(arg);
 455                         main_time = atoi(arg);
 456                 } else if (!strcasecmp(time_system, "byoyomi")) {
 457                         next_tok(arg);
 458                         main_time = atoi(arg);
 459                         next_tok(arg);
 460                         byoyomi_time = atoi(arg);
 461                         next_tok(arg);
 462                         byoyomi_periods = atoi(arg);
 463                 } else if (!strcasecmp(time_system, "canadian")) {
 464                         next_tok(arg);
 465                         main_time = atoi(arg);
 466                         next_tok(arg);
 467                         byoyomi_time = atoi(arg);
 468                         next_tok(arg);
 469                         byoyomi_stones = atoi(arg);
 470                 }
 471
 472                 if (DEBUGL(1))
 473                         fprintf(stderr, "time_settings %d %d/%d*%d\n",
 474                                 main_time, byoyomi_time, byoyomi_stones, byoyomi_periods);
 475                 if (!ti[S_BLACK].ignore_gtp) {
 476                         time_settings(&ti[S_BLACK], main_time, byoyomi_time, byoyomi_stones, byoyomi_periods);
 477                         ti[S_WHITE] = ti[S_BLACK];
 478                 } else {
 479                         if (DEBUGL(1)) fprintf(stderr, "ignored time info\n");
 480                 }
 481
 482                 gtp_reply(id, NULL);
 483
 484         } else {
 485                 gtp_error(id, "unknown command", NULL);
 486                 return P_UNKNOWN_COMMAND;
 487         }
 488         return P_OK;
 489
 490 #undef next_tok
 491 }