taiplayer.c

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2020 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 is free software: you can redistribute it
 \___  \____/   __/    and/or modify it under the terms of the GNU  General
     \_       _/          Public License  as published by the Free Software
       | @ @  \_               Foundation, either version 3 of the  License,
       |                              or (at your option) any later version.
     _/     /\                  You should have received  a copy of the GNU
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
 
#include <fc_config.h>
 
#include <QMutexLocker>
 
/* utility */
#include "log.h"
 
/* common */
#include "ai.h"
#include "city.h"
#include "game.h"
#include "unit.h"
 
/* server/advisors */
#include "infracache.h"
 
/* ai/default */
#include "aiplayer.h"
 
/* ai/threaded */
#include "taicity.h"
 
#include "taiplayer.h"
 
/* What level of operation we should abort because
 * of received messages. Lower is more critical;
 * TAI_ABORT_EXIT means that whole thread should exit,
 * TAI_ABORT_NONE means that we can continue what we were doing */
enum tai_abort_msg_class {
  TAI_ABORT_EXIT,
  TAI_ABORT_PHASE_END,
  TAI_ABORT_NONE
};
 
static enum tai_abort_msg_class tai_check_messages(struct ai_type *ait);
 
struct tai_thr {
  int num_players;
  struct tai_msgs msgs_to;
  struct tai_reqs reqs_from;
  bool thread_running;
  fcThread ait;
} thrai;
 
/**********************************************************************/ 
void tai_init_threading(void)
{
  thrai.thread_running = false;
 
  thrai.num_players = 0;
}
 
/**********************************************************************/ 
static void tai_thread_start(void *arg)
{
  bool finished = false;
  struct ai_type *ait = arg;
 
  log_debug("New AI thread launched");
 
  /* Just wait until we are signaled to shutdown */
  QMutexLocker locker(&thrai.msgs_to.mutex);
  while (!finished) {
    thrai.msgs_to.thr_cond.wait(&thrai.msgs_to.mutex);
 
    if (tai_check_messages(ait) <= TAI_ABORT_EXIT) {
      finished = true;
    }
  }
 
  log_debug("AI thread exiting");
}
 
/**********************************************************************/ 
static enum tai_abort_msg_class tai_check_messages(struct ai_type *ait)
{
  enum tai_abort_msg_class ret_abort = TAI_ABORT_NONE;
 
  thrai.msgs_to.msglist.lock();
  while (taimsg_list_size(thrai.msgs_to.msglist) > 0) {
    struct tai_msg *msg;
    enum tai_abort_msg_class new_abort = TAI_ABORT_NONE;
 
    msg = taimsg_list_get(thrai.msgs_to.msglist, 0);
    taimsg_list_remove(thrai.msgs_to.msglist, msg);
    thrai.msgs_to.msglist.unlock();
 
    log_debug("Plr thr got %s", taimsgtype_name(msg->type));
 
    switch (msg->type) {
    case TAI_MSG_FIRST_ACTIVITIES:
      game.server.mutexes.city_list.lock();
 
      initialize_infrastructure_cache(msg->plr);
 
      /* Use _safe iterate in case the main thread
       * destroyes cities while we are iterating through these. */
      city_list_iterate_safe(msg->plr->cities, pcity)
      {
        tai_city_worker_requests_create(ait, msg->plr, pcity);
 
        /* Release mutex for a second in case main thread
         * wants to do something to city list. */
        game.server.mutexes.city_list.unlock();
 
        /* Recursive message check in case phase is finished. */
        new_abort = tai_check_messages(ait);
        game.server.mutexes.city_list.lock();
        if (new_abort < TAI_ABORT_NONE) {
          break;
        }
      }
      city_list_iterate_safe_end;
      game.server.mutexes.city_list.unlock();
 
      tai_send_req(TAI_REQ_TURN_DONE, msg->plr, NULL);
 
      break;
    case TAI_MSG_PHASE_FINISHED:
      new_abort = TAI_ABORT_PHASE_END;
      break;
    case TAI_MSG_THR_EXIT:
      new_abort = TAI_ABORT_EXIT;
      break;
    default:
      qCritical("Illegal message type %s (%d) for threaded ai!",
                taimsgtype_name(msg->type), msg->type);
      break;
    }
 
    if (new_abort < ret_abort) {
      ret_abort = new_abort;
    }
 
    delete msg;
    msg = nullptr;
 
    thrai.msgs_to.msglist.lock();
  }
  thrai.msgs_to.msglist.unlock();
 
  return ret_abort;
}
 
/**********************************************************************/ 
void tai_player_alloc(struct ai_type *ait, struct player *pplayer)
{
  struct tai_plr *player_data = new tai_plr{};
 
  player_set_ai_data(pplayer, ait, player_data);
 
  /* Default AI */
  dai_data_init(ait, pplayer);
}
 
/**********************************************************************/ 
void tai_player_free(struct ai_type *ait, struct player *pplayer)
{
  struct tai_plr *player_data = player_ai_data(pplayer, ait);
 
  /* Default AI */
  dai_data_close(ait, pplayer);
 
  if (player_data != NULL) {
    player_set_ai_data(pplayer, ait, NULL);
    delete player_data;
    player_data = nullptr;
  }
}
 
/**********************************************************************/ 
void tai_control_gained(struct ai_type *ait, struct player *pplayer)
{
  thrai.num_players++;
 
  log_debug("%s now under threaded AI (%d)", pplayer->name,
            thrai.num_players);
 
  if (!thrai.thread_running) {
    thrai.msgs_to.msglist = taimsg_list_new();
    thrai.reqs_from.reqlist = taireq_list_new();
 
    thrai.thread_running = true;
 
    thrai.ait->set_func(tai_thread_start, ait);
    thrai.ait->start(QThread::NormalPriority);
  }
}
 
/**********************************************************************/ 
void tai_control_lost(struct ai_type *ait, struct player *pplayer)
{
  thrai.num_players--;
 
  log_debug("%s no longer under threaded AI (%d)", pplayer->name,
            thrai.num_players);
 
  if (thrai.num_players <= 0) {
    tai_send_msg(TAI_MSG_THR_EXIT, pplayer, NULL);
 
    thrai.ait.wait();
    thrai.thread_running = false;
 
    taimsg_list_destroy(thrai.msgs_to.msglist);
    taireq_list_destroy(thrai.reqs_from.reqlist);
  }
}
 
/**********************************************************************/ 
void tai_refresh(struct ai_type *ait, struct player *pplayer)
{
  if (thrai.thread_running) {
    thrai.reqs_from.reqlist.lock();
    while (taireq_list_size(thrai.reqs_from.reqlist) > 0) {
      struct tai_req *req;
 
      req = taireq_list_get(thrai.reqs_from.reqlist, 0);
      taireq_list_remove(thrai.reqs_from.reqlist, req);
 
      thrai.reqs_from.reqlist.unlock();
 
      log_debug("Plr thr sent %s", taireqtype_name(req->type));
 
      switch (req->type) {
      case TAI_REQ_WORKER_TASK:
        tai_req_worker_task_rcv(req);
        break;
      case TAI_REQ_TURN_DONE:
        req->plr->ai_phase_done = true;
        break;
      }
 
      delete req;
      req = nullptr;
 
      thrai.reqs_from.reqlist.lock();
    }
    thrai.reqs_from.reqlist.unlock();
  }
}
 
/**********************************************************************/ 
void tai_msg_to_thr(struct tai_msg *msg)
{
  QMutexLocker locker(&thrai.msgs_to.mutex);
  taimsg_list_append(thrai.msgs_to.msglist, msg);
  fc_thread_cond_signal(&thrai.msgs_to.thr_cond);
}
 
/**********************************************************************/ 
void tai_req_from_thr(struct tai_req *req)
{
  QMutexLocker locker(&thrai.reqs_from.reqlist);
  taireq_list_append(thrai.reqs_from.reqlist, req);
}
 
/**********************************************************************/ 
bool tai_thread_running(void) { return thrai.thread_running; }