/*
      This file is part of GNUnet
      Copyright (C) 2021 GNUnet e.V.

      GNUnet is free software: you can redistribute it and/or modify it
      under the terms of the GNU Affero General Public License as published
      by the Free Software Foundation, either version 3 of the License,
      or (at your option) any later version.

      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      Affero General Public License for more details.

      You should have received a copy of the GNU Affero General Public License
      along with this program.  If not, see <http://www.gnu.org/licenses/>.

     SPDX-License-Identifier: AGPL3.0-or-later
 */

/**
 * @file testing_api_cmd_block_until_all_peers_started.c
 * @brief cmd to block the interpreter loop until all peers started.
 * @author t3sserakt
 */
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testing_ng_lib.h"

/**
 * Generic logging shortcut
 */
#define LOG(kind, ...) GNUNET_log (kind, __VA_ARGS__)

/**
 * Struct with information for callbacks.
 *
 */
struct BlockState
{
  /**
   * Flag to indicate if all peers have started.
   *
   */
  unsigned int *stop_blocking;
};


/**
 * Trait function of this cmd does nothing.
 *
 */
static int
block_until_all_peers_started_traits (void *cls,
                                      const void **ret,
                                      const char *trait,
                                      unsigned int index)
{
  return GNUNET_NO;
}


/**
 * The cleanup function of this cmd frees resources the cmd allocated.
 *
 */
static void
block_until_all_peers_started_cleanup (void *cls)
{
  struct BlockState *bs = cls;

  GNUNET_free (bs);
}


/**
 * This function does nothing but to start the cmd.
 *
 */
static void
block_until_all_peers_started_run (void *cls,
                                   struct GNUNET_TESTING_Interpreter *is)
{
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "block_until_all_peers_started_run!\n");
}


/**
 * Function to check if BlockState#all_peers_started is GNUNET_YES. In that case interpreter_next will be called.
 *
 */
static int
block_until_all_peers_started_finish (void *cls,
                                      GNUNET_SCHEDULER_TaskCallback cont,
                                      void *cont_cls)
{
  struct BlockState *bs = cls;
  unsigned int *ret = bs->stop_blocking;

  if (GNUNET_YES == *ret)
  {
    cont (cont_cls);
  }

  return *ret;
}


/**
 * Create command.
 *
 * @param label name for command.
 * @param all_peers_started Flag which will be set from outside.
 * @return command.
 */
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_block_until_external_trigger (const char *label,
                                                 unsigned int *
                                                 stop_blocking)
{
  struct BlockState *bs;

  bs = GNUNET_new (struct BlockState);
  bs->stop_blocking = stop_blocking;

  struct GNUNET_TESTING_Command cmd = {
    .cls = bs,
    .label = label,
    .run = &block_until_all_peers_started_run,
    .finish = &block_until_all_peers_started_finish,
    .cleanup = &block_until_all_peers_started_cleanup,
    .traits = &block_until_all_peers_started_traits
  };

  return cmd;
}