gtp.c

   1 #define DEBUG
   2 #include <assert.h>
   3 #include <ctype.h>
   4 #include <math.h>
   5 #include <stdarg.h>
   6 #include <stdio.h>
   7 #include <stdlib.h>
   8 #include <string.h>
   9 #include <unistd.h>
  10
  11 #include "board.h"
  12 #include "debug.h"
  13 #include "engine.h"
  14 #include "fbook.h"
  15 #include "gtp.h"
  16 #include "mq.h"
  17 #include "uct/uct.h"
  18 #include "version.h"
  19 #include "timeinfo.h"
  20
  21 #define NO_REPLY (-2)
  22
  23 /* Sleep 5 seconds after a game ends to give time to kill the program. */
  24 #define GAME_OVER_SLEEP 5
  25
  26 void
  27 gtp_prefix(char prefix, int id)
  28 {
  29         if (id == NO_REPLY) return;
  30         if (id >= 0)
  31                 printf("%c%d ", prefix, id);
  32         else
  33                 printf("%c ", prefix);
  34 }
  35
  36 void
  37 gtp_flush(void)
  38 {
  39         putchar('\n');
  40         fflush(stdout);
  41 }
  42
  43 void
  44 gtp_output(char prefix, int id, va_list params)
  45 {
  46         if (id == NO_REPLY) return;
  47         gtp_prefix(prefix, id);
  48         char *s;
  49         while ((s = va_arg(params, char *))) {
  50                 fputs(s, stdout);
  51         }
  52         putchar('\n');
  53         gtp_flush();
  54 }
  55
  56 void
  57 gtp_reply(int id, ...)
  58 {
  59         va_list params;
  60         va_start(params, id);
  61         gtp_output('=', id, params);
  62         va_end(params);
  63 }
  64
  65 void
  66 gtp_error(int id, ...)
  67 {
  68         va_list params;
  69         va_start(params, id);
  70         gtp_output('?', id, params);
  71         va_end(params);
  72 }
  73
  74 /* List of known gtp commands. The internal command pachi-genmoves is not exported,
  75  * it should only be used between master and slaves of the distributed engine. */
  76 static char *known_commands =
  77         "protocol_version\n"
  78         "echo\n"
  79         "name\n"
  80         "version\n"
  81         "list_commands\n"
  82         "known_command\n"
  83         "quit\n"
  84         "boardsize\n"
  85         "clear_board\n"
  86         "kgs-game_over\n"
  87         "komi\n"
  88         "kgs-rules\n"
  89         "play\n"
  90         "genmove\n"
  91         "kgs-genmove_cleanup\n"
  92         "set_free_handicap\n"
  93         "place_free_handicap\n"
  94         "fixed_handicap\n"
  95         "final_score\n"
  96         "final_status_list\n"
  97         "undo\n"
  98         "pachi-evaluate\n"
  99         "pachi-result\n"
 100         "pachi-gentbook\n"
 101         "pachi-dumptbook\n"
 102         "kgs-chat\n"
 103         "time_left\n"
 104         "time_settings\n"
 105         "kgs-time_settings";
 106
 107
 108 /* Return true if cmd is a valid gtp command. */
 109 bool
 110 gtp_is_valid(const char *cmd)
 111 {
 112         if (!cmd || !*cmd) return false;
 113         const char *s = strcasestr(known_commands, cmd);
 114         if (!s) return false;
 115         if (s != known_commands && s[-1] != '\n') return false;
 116
 117         int len = strlen(cmd);
 118         return s[len] == '\0' || s[len] == '\n';
 119 }
 120
 121 /* XXX: THIS IS TOTALLY INSECURE!!!!
 122  * Even basic input checking is missing. */
 123
 124 enum parse_code
 125 gtp_parse(struct board *board, struct engine *engine, struct time_info *ti, char *buf)
 126 {
 127 #define next_tok(to_) \
 128         to_ = next; \
 129         next = next + strcspn(next, " \t\r\n"); \
 130         if (*next) { \
 131                 *next = 0; next++; \
 132                 next += strspn(next, " \t\r\n"); \
 133         }
 134
 135         if (strchr(buf, '#'))
 136                 *strchr(buf, '#') = 0;
 137
 138         char *cmd, *next = buf;
 139         next_tok(cmd);
 140
 141         int id = -1;
 142         if (isdigit(*cmd)) {
 143                 id = atoi(cmd);
 144                 next_tok(cmd);
 145         }
 146
 147         if (!*cmd)
 148                 return P_OK;
 149
 150         if (!strcasecmp(cmd, "protocol_version")) {
 151                 gtp_reply(id, "2", NULL);
 152                 return P_OK;
 153
 154         } else if (!strcasecmp(cmd, "name")) {
 155                 /* KGS hack */
 156                 gtp_reply(id, "Pachi ", engine->name, NULL);
 157                 return P_OK;
 158
 159         } else if (!strcasecmp(cmd, "echo")) {
 160                 gtp_reply(id, next, NULL);
 161                 return P_OK;
 162
 163         } else if (!strcasecmp(cmd, "version")) {
 164                 gtp_reply(id, PACHI_VERSION, ": ", engine->comment, " Have a nice game!", NULL);
 165                 return P_OK;
 166
 167         } else if (!strcasecmp(cmd, "list_commands")) {
 168                 gtp_reply(id, known_commands, NULL);
 169                 return P_OK;
 170
 171         } else if (!strcasecmp(cmd, "known_command")) {
 172                 char *arg;
 173                 next_tok(arg);
 174                 if (gtp_is_valid(arg)) {
 175                         gtp_reply(id, "true", NULL);
 176                 } else {
 177                         gtp_reply(id, "false", NULL);
 178                 }
 179                 return P_OK;
 180         }
 181
 182         if (engine->notify && gtp_is_valid(cmd)) {
 183                 char *reply;
 184                 enum parse_code c = engine->notify(engine, board, id, cmd, next, &reply);
 185                 if (c == P_NOREPLY) {
 186                         id = NO_REPLY;
 187                 } else if (c == P_DONE_OK) {
 188                         gtp_reply(id, reply, NULL);
 189                         return P_OK;
 190                 } else if (c == P_DONE_ERROR) {
 191                         gtp_error(id, reply, NULL);
 192                         /* This is an internal error for the engine, but
 193                          * it is still OK from main's point of view. */
 194                         return P_OK;
 195                 } else if (c != P_OK) {
 196                         return c;
 197                 }
 198         }
 199
 200         if (!strcasecmp(cmd, "quit")) {
 201                 gtp_reply(id, NULL);
 202                 exit(0);
 203
 204         } else if (!strcasecmp(cmd, "boardsize")) {
 205                 char *arg;
 206                 next_tok(arg);
 207                 int size = atoi(arg);
 208                 if (size < 1 || size > BOARD_MAX_SIZE) {
 209                         gtp_error(id, "illegal board size", NULL);
 210                         return P_OK;
 211                 }
 212                 board_resize(board, size);
 213                 board_clear(board);
 214                 gtp_reply(id, NULL);
 215                 return P_ENGINE_RESET;
 216
 217         } else if (!strcasecmp(cmd, "clear_board")) {
 218                 board_clear(board);
 219                 if (DEBUGL(3) && debug_boardprint)
 220                         board_print(board, stderr);
 221                 gtp_reply(id, NULL);
 222                 return P_ENGINE_RESET;
 223
 224         } else if (!strcasecmp(cmd, "kgs-game_over")) {
 225                 /* The game may not be really over, just adjourned.
 226                  * Do not clear the board to avoid illegal moves
 227                  * if the game is resumed immediately after. KGS
 228                  * may start directly with genmove on resumption. */
 229                 if (DEBUGL(1)) {
 230                         fprintf(stderr, "game is over\n");
 231                         fflush(stderr);
 232                 }
 233                 /* Sleep before replying, so that kgs doesn't
 234                  * start another game immediately. */
 235                 sleep(GAME_OVER_SLEEP);
 236                 gtp_reply(id, NULL);
 237
 238         } else if (!strcasecmp(cmd, "komi")) {
 239                 char *arg;
 240                 next_tok(arg);
 241                 sscanf(arg, PRIfloating, &board->komi);
 242
 243                 if (DEBUGL(3) && debug_boardprint)
 244                         board_print(board, stderr);
 245                 gtp_reply(id, NULL);
 246
 247         } else if (!strcasecmp(cmd, "kgs-rules")) {
 248                 char *arg;
 249                 next_tok(arg);
 250                 if (!board_set_rules(board, arg)) {
 251                         gtp_error(id, "unknown rules", NULL);
 252                         return P_OK;
 253                 }
 254                 gtp_reply(id, NULL);
 255
 256         } else if (!strcasecmp(cmd, "play")) {
 257                 struct move m;
 258
 259                 char *arg;
 260                 next_tok(arg);
 261                 m.color = str2stone(arg);
 262                 next_tok(arg);
 263                 coord_t *c = str2coord(arg, board_size(board));
 264                 m.coord = *c; coord_done(c);
 265                 next_tok(arg);
 266                 char *enginearg = arg;
 267                 char *reply = NULL;
 268
 269                 if (DEBUGL(5))
 270                         fprintf(stderr, "got move %d,%d,%d\n", m.color, coord_x(m.coord, board), coord_y(m.coord, board));
 271
 272                 // This is where kgs starts the timer, not at genmove!
 273                 time_start_timer(&ti[stone_other(m.color)]);
 274
 275                 if (engine->notify_play)
 276                         reply = engine->notify_play(engine, board, &m, enginearg);
 277                 if (board_play(board, &m) < 0) {
 278                         if (DEBUGL(0)) {
 279                                 fprintf(stderr, "! ILLEGAL MOVE %d,%d,%d\n", m.color, coord_x(m.coord, board), coord_y(m.coord, board));
 280                                 board_print(board, stderr);
 281                         }
 282                         gtp_error(id, "illegal move", NULL);
 283                 } else {
 284                         if (DEBUGL(4) && debug_boardprint)
 285                                 board_print_custom(board, stderr, engine->printhook);
 286                         gtp_reply(id, reply, NULL);
 287                 }
 288
 289         } else if (!strcasecmp(cmd, "genmove") || !strcasecmp(cmd, "kgs-genmove_cleanup")) {
 290                 char *arg;
 291                 next_tok(arg);
 292                 enum stone color = str2stone(arg);
 293                 coord_t *c = NULL;
 294                 if (DEBUGL(2) && debug_boardprint)
 295                         board_print_custom(board, stderr, engine->printhook);
 296
 297                 if (!ti[color].len.t.timer_start) {
 298                         /* First game move. */
 299                         time_start_timer(&ti[color]);
 300                 }
 301
 302                 coord_t cf = pass;
 303                 if (board->fbook)
 304                         cf = fbook_check(board);
 305                 if (!is_pass(cf)) {
 306                         c = coord_copy(cf);
 307                 } else {
 308                         c = engine->genmove(engine, board, &ti[color], color, !strcasecmp(cmd, "kgs-genmove_cleanup"));
 309                 }
 310                 struct move m = { *c, color };
 311                 if (board_play(board, &m) < 0) {
 312                         fprintf(stderr, "Attempted to generate an illegal move: [%s, %s]\n", coord2sstr(m.coord, board), stone2str(m.color));
 313                         abort();
 314                 }
 315                 char *str = coord2str(*c, board);
 316                 if (DEBUGL(4))
 317                         fprintf(stderr, "playing move %s\n", str);
 318                 if (DEBUGL(1) && debug_boardprint) {
 319                         board_print_custom(board, stderr, engine->printhook);
 320                 }
 321                 gtp_reply(id, str, NULL);
 322                 free(str); coord_done(c);
 323
 324                 /* Account for spent time. If our GTP peer keeps our clock, this will
 325                  * be overriden by next time_left GTP command properly. */
 326                 /* (XXX: Except if we pass to byoyomi and the peer doesn't, but that
 327                  * should be absolutely rare situation and we will just spend a little
 328                  * less time than we could on next few moves.) */
 329                 if (ti[color].period != TT_NULL && ti[color].dim == TD_WALLTIME)
 330                         time_sub(&ti[color], time_now() - ti[color].len.t.timer_start, true);
 331
 332         } else if (!strcasecmp(cmd, "pachi-genmoves") || !strcasecmp(cmd, "pachi-genmoves_cleanup")) {
 333                 char *arg;
 334                 next_tok(arg);
 335                 enum stone color = str2stone(arg);
 336                 void *stats;
 337                 int stats_size;
 338
 339                 char *reply = engine->genmoves(engine, board, &ti[color], color, next,
 340                                                !strcasecmp(cmd, "pachi-genmoves_cleanup"),
 341                                                &stats, &stats_size);
 342                 if (!reply) {
 343                         gtp_error(id, "genmoves error", NULL);
 344                         return P_OK;
 345                 }
 346                 if (DEBUGL(3))
 347                         fprintf(stderr, "proposing moves %s\n", reply);
 348                 if (DEBUGL(4) && debug_boardprint)
 349                         board_print_custom(board, stderr, engine->printhook);
 350                 gtp_reply(id, reply, NULL);
 351                 if (stats_size > 0) {
 352                         double start = time_now();
 353                         fwrite(stats, 1, stats_size, stdout);
 354                         fflush(stdout);
 355                         if (DEBUGVV(2))
 356                                 fprintf(stderr, "sent reply %d bytes in %.4fms\n",
 357                                         stats_size, (time_now() - start)*1000);
 358                 }
 359
 360         } else if (!strcasecmp(cmd, "set_free_handicap")) {
 361                 struct move m;
 362                 m.color = S_BLACK;
 363
 364                 char *arg;
 365                 next_tok(arg);
 366                 do {
 367                         coord_t *c = str2coord(arg, board_size(board));
 368                         m.coord = *c; coord_done(c);
 369                         if (DEBUGL(4))
 370                                 fprintf(stderr, "setting handicap %d,%d\n", coord_x(m.coord, board), coord_y(m.coord, board));
 371
 372                         if (board_play(board, &m) < 0) {
 373                                 if (DEBUGL(0))
 374                                         fprintf(stderr, "! ILLEGAL MOVE %d,%d,%d\n", m.color, coord_x(m.coord, board), coord_y(m.coord, board));
 375                                 gtp_error(id, "illegal move", NULL);
 376                         }
 377                         board->handicap++;
 378                         next_tok(arg);
 379                 } while (*arg);
 380                 if (DEBUGL(1) && debug_boardprint)
 381                         board_print(board, stderr);
 382                 gtp_reply(id, NULL);
 383
 384         /* TODO: Engine should choose free handicap; however, it tends to take
 385          * overly long to think it all out, and unless it's clever its
 386          * handicap stones won't be of much help. ;-) */
 387         } else if (!strcasecmp(cmd, "place_free_handicap")
 388                   || !strcasecmp(cmd, "fixed_handicap")) {
 389                 char *arg;
 390                 next_tok(arg);
 391                 int stones = atoi(arg);
 392
 393                 gtp_prefix('=', id);
 394                 board_handicap(board, stones, id == NO_REPLY ? NULL : stdout);
 395                 if (DEBUGL(1) && debug_boardprint)
 396                         board_print(board, stderr);
 397                 if (id == NO_REPLY) return P_OK;
 398                 putchar('\n');
 399                 gtp_flush();
 400
 401         } else if (!strcasecmp(cmd, "final_score")) {
 402                 struct move_queue q = { .moves = 0 };
 403                 if (engine->dead_group_list)
 404                         engine->dead_group_list(engine, board, &q);
 405                 floating_t score = board_official_score(board, &q);
 406                 char str[64];
 407                 if (DEBUGL(1))
 408                         fprintf(stderr, "counted score %.1f\n", score);
 409                 if (score == 0) {
 410                         gtp_reply(id, "0", NULL);
 411                 } else if (score > 0) {
 412                         snprintf(str, 64, "W+%.1f", score);
 413                         gtp_reply(id, str, NULL);
 414                 } else {
 415                         snprintf(str, 64, "B+%.1f", -score);
 416                         gtp_reply(id, str, NULL);
 417                 }
 418
 419         /* XXX: This is a huge hack. */
 420         } else if (!strcasecmp(cmd, "final_status_list")) {
 421                 if (id == NO_REPLY) return P_OK;
 422                 char *arg;
 423                 next_tok(arg);
 424                 struct move_queue q = { .moves = 0 };
 425                 if (engine->dead_group_list)
 426                         engine->dead_group_list(engine, board, &q);
 427                 /* else we return empty list - i.e. engine not supporting
 428                  * this assumes all stones alive at the game end. */
 429                 if (!strcasecmp(arg, "dead")) {
 430                         gtp_prefix('=', id);
 431                         for (unsigned int i = 0; i < q.moves; i++) {
 432                                 foreach_in_group(board, q.move[i]) {
 433                                         printf("%s ", coord2sstr(c, board));
 434                                 } foreach_in_group_end;
 435                                 putchar('\n');
 436                         }
 437                         if (!q.moves)
 438                                 putchar('\n');
 439                         gtp_flush();
 440                 } else if (!strcasecmp(arg, "seki") || !strcasecmp(arg, "alive")) {
 441                         gtp_prefix('=', id);
 442                         bool printed_group = false;
 443                         foreach_point(board) { // foreach_group, effectively
 444                                 group_t g = group_at(board, c);
 445                                 if (!g || g != c) continue;
 446
 447                                 for (unsigned int i = 0; i < q.moves; i++) {
 448                                         if (q.move[i] == g)
 449                                                 goto next_group;
 450                                 }
 451                                 foreach_in_group(board, g) {
 452                                         printf("%s ", coord2sstr(c, board));
 453                                 } foreach_in_group_end;
 454                                 putchar('\n');
 455                                 printed_group = true;
 456 next_group:;
 457                         } foreach_point_end;
 458                         if (!printed_group)
 459                                 putchar('\n');
 460                         gtp_flush();
 461                 } else {
 462                         gtp_error(id, "illegal status specifier", NULL);
 463                 }
 464
 465         } else if (!strcasecmp(cmd, "undo")) {
 466                 if (board_undo(board) < 0) {
 467                         if (DEBUGL(1)) {
 468                                 fprintf(stderr, "undo on non-pass move %s\n", coord2sstr(board->last_move.coord, board));
 469                                 board_print(board, stderr);
 470                         }
 471                         gtp_error(id, "cannot undo", NULL);
 472                         return P_OK;
 473                 }
 474                 char *reply = NULL;
 475                 if (engine->undo)
 476                         reply = engine->undo(engine, board);
 477                 if (DEBUGL(3) && debug_boardprint)
 478                         board_print(board, stderr);
 479                 gtp_reply(id, reply, NULL);
 480
 481         /* Custom commands for handling the tree opening tbook */
 482         } else if (!strcasecmp(cmd, "pachi-gentbook")) {
 483                 /* Board must be initialized properly, as if for genmove;
 484                  * makes sense only as 'uct_gentbook b'. */
 485                 char *arg;
 486                 next_tok(arg);
 487                 enum stone color = str2stone(arg);
 488                 if (uct_gentbook(engine, board, &ti[color], color))
 489                         gtp_reply(id, NULL);
 490                 else
 491                         gtp_error(id, "error generating tbook", NULL);
 492
 493         } else if (!strcasecmp(cmd, "pachi-dumptbook")) {
 494                 char *arg;
 495                 next_tok(arg);
 496                 enum stone color = str2stone(arg);
 497                 uct_dumptbook(engine, board, color);
 498                 gtp_reply(id, NULL);
 499
 500         } else if (!strcasecmp(cmd, "pachi-evaluate")) {
 501                 char *arg;
 502                 next_tok(arg);
 503                 enum stone color = str2stone(arg);
 504
 505                 if (!engine->evaluate) {
 506                         gtp_error(id, "pachi-evaluate not supported by engine", NULL);
 507                 } else {
 508                         gtp_prefix('=', id);
 509                         floating_t vals[board->flen];
 510                         engine->evaluate(engine, board, &ti[color], vals, color);
 511                         for (int i = 0; i < board->flen; i++) {
 512                                 if (!board_coord_in_symmetry(board, board->f[i])
 513                                     || isnan(vals[i]) || vals[i] < 0.001)
 514                                         continue;
 515                                 printf("%s %.3f\n", coord2sstr(board->f[i], board), (double) vals[i]);
 516                         }
 517                         gtp_flush();
 518                 }
 519
 520         } else if (!strcasecmp(cmd, "pachi-result")) {
 521                 /* More detailed result of the last genmove. */
 522                 /* For UCT, the output format is: = color move playouts winrate dynkomi */
 523                 char *reply = NULL;
 524                 if (engine->result)
 525                         reply = engine->result(engine, board);
 526                 if (reply)
 527                         gtp_reply(id, reply, NULL);
 528                 else
 529                         gtp_error(id, "unknown pachi-result command", NULL);
 530
 531         } else if (!strcasecmp(cmd, "kgs-chat")) {
 532                 char *loc;
 533                 next_tok(loc);
 534                 bool opponent = !strcasecmp(loc, "game");
 535                 char *from;
 536                 next_tok(from);
 537                 char *msg = next;
 538                 msg += strspn(msg, " \n\t");
 539                 char *end = strchr(msg, '\n');
 540                 if (end) *end = '\0';
 541                 char *reply = NULL;
 542                 if (engine->chat) {
 543                         reply = engine->chat(engine, board, opponent, from, msg);
 544                 }
 545                 if (reply)
 546                         gtp_reply(id, reply, NULL);
 547                 else
 548                         gtp_error(id, "unknown kgs-chat command", NULL);
 549
 550         } else if (!strcasecmp(cmd, "time_left")) {
 551                 char *arg;
 552                 next_tok(arg);
 553                 enum stone color = str2stone(arg);
 554                 next_tok(arg);
 555                 int time = atoi(arg);
 556                 next_tok(arg);
 557                 int stones = atoi(arg);
 558                 if (!ti[color].ignore_gtp) {
 559                         time_left(&ti[color], time, stones);
 560                 } else {
 561                         if (DEBUGL(2)) fprintf(stderr, "ignored time info\n");
 562                 }
 563
 564                 gtp_reply(id, NULL);
 565
 566         } else if (!strcasecmp(cmd, "time_settings") || !strcasecmp(cmd, "kgs-time_settings")) {
 567                 char *time_system;
 568                 char *arg;
 569                 if (!strcasecmp(cmd, "kgs-time_settings")) {
 570                         next_tok(time_system);
 571                 } else {
 572                         time_system = "canadian";
 573                 }
 574
 575                 int main_time = 0, byoyomi_time = 0, byoyomi_stones = 0, byoyomi_periods = 0;
 576                 if (!strcasecmp(time_system, "none")) {
 577                         main_time = -1;
 578                 } else if (!strcasecmp(time_system, "absolute")) {
 579                         next_tok(arg);
 580                         main_time = atoi(arg);
 581                 } else if (!strcasecmp(time_system, "byoyomi")) {
 582                         next_tok(arg);
 583                         main_time = atoi(arg);
 584                         next_tok(arg);
 585                         byoyomi_time = atoi(arg);
 586                         next_tok(arg);
 587                         byoyomi_periods = atoi(arg);
 588                 } else if (!strcasecmp(time_system, "canadian")) {
 589                         next_tok(arg);
 590                         main_time = atoi(arg);
 591                         next_tok(arg);
 592                         byoyomi_time = atoi(arg);
 593                         next_tok(arg);
 594                         byoyomi_stones = atoi(arg);
 595                 }
 596
 597                 if (DEBUGL(1))
 598                         fprintf(stderr, "time_settings %d %d/%d*%d\n",
 599                                 main_time, byoyomi_time, byoyomi_stones, byoyomi_periods);
 600                 if (!ti[S_BLACK].ignore_gtp) {
 601                         time_settings(&ti[S_BLACK], main_time, byoyomi_time, byoyomi_stones, byoyomi_periods);
 602                         ti[S_WHITE] = ti[S_BLACK];
 603                 } else {
 604                         if (DEBUGL(1)) fprintf(stderr, "ignored time info\n");
 605                 }
 606
 607                 gtp_reply(id, NULL);
 608
 609         } else {
 610                 gtp_error(id, "unknown command", NULL);
 611                 return P_UNKNOWN_COMMAND;
 612         }
 613         return P_OK;
 614
 615 #undef next_tok
 616 }