/*
 * This file is part of PowerDNS or dnsdist.
 * Copyright -- PowerDNS.COM B.V. and its contributors
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * In addition, for the avoidance of any doubt, permission is granted to
 * link this program with OpenSSL and to (re)distribute the binaries
 * produced as the result of such linking.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#pragma once

#include <sys/time.h>
#include <thread>

union ComboAddress;
namespace boost
{
size_t hash_value(const ComboAddress&);
}

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/key_extractors.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/tag.hpp>

#include "dnsname.hh"
#include "iputils.hh"
#include "qtype.hh"

namespace pdns
{
using namespace ::boost::multi_index;

// ATM we have one task type, if we get more, the unique key in the index needs to be adapted
struct ResolveTask
{
  DNSName d_qname;
  uint16_t d_qtype;
  // Deadline is not part of index and not used by operator<()
  time_t d_deadline;
  // Whether to run this task in normal mode (None) or in the mode that refreshes almost expired
  // rrsets (Regular) or in Forced Mode
  enum RefreshMode : uint8_t
  {
    None,
    Refresh,
    Forced
  };
  RefreshMode d_refreshMode;
  // Use a function pointer as comparing std::functions is a nuisance
  using TaskFunction = void (*)(const struct timeval& now, bool logErrors, const ResolveTask& task);
  TaskFunction d_func;
  // IP used by DoT probe tasks
  ComboAddress d_ip;
  // NS name used by DoT probe task, not part of index and not used by operator<()
  DNSName d_nsname;
  Netmask d_netmask;

  bool operator<(const ResolveTask& task) const
  {
    return std::tie(d_qname, d_qtype, d_refreshMode, d_func, d_ip, d_netmask) < std::tie(task.d_qname, task.d_qtype, task.d_refreshMode, task.d_func, task.d_ip, task.d_netmask);
  }

  [[nodiscard]] bool run(bool logErrors) const;
};

class TaskQueue
{
public:
  [[nodiscard]] bool empty() const
  {
    return d_queue.empty();
  }

  [[nodiscard]] size_t size() const
  {
    return d_queue.size();
  }

  bool push(ResolveTask&& task);
  ResolveTask pop();

  [[nodiscard]] uint64_t getPushes() const
  {
    return d_pushes;
  }

  [[nodiscard]] uint64_t getExpired() const
  {
    return d_expired;
  }

  void incExpired()
  {
    d_expired++;
  }

  void clear()
  {
    d_queue.clear();
  }

private:
  struct HashTag
  {
  };

  struct SequencedTag
  {
  };

  using queue_t = multi_index_container<
    ResolveTask,
    indexed_by<ordered_unique<tag<HashTag>,
                              composite_key<ResolveTask,
                                            member<ResolveTask, DNSName, &ResolveTask::d_qname>,
                                            member<ResolveTask, uint16_t, &ResolveTask::d_qtype>,
                                            member<ResolveTask, ResolveTask::RefreshMode, &ResolveTask::d_refreshMode>,
                                            member<ResolveTask, ResolveTask::TaskFunction, &ResolveTask::d_func>,
                                            member<ResolveTask, ComboAddress, &ResolveTask::d_ip>,
                                            member<ResolveTask, Netmask, &ResolveTask::d_netmask>>>,
               sequenced<tag<SequencedTag>>>>;

  queue_t d_queue;
  uint64_t d_pushes{0};
  uint64_t d_expired{0};
};

}
