/* Target description definitions for remote server for GDB.
   Copyright (C) 2012-2017 Free Software Foundation, Inc.

   This file is part of GDB.

   This program 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.

   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, see <http://www.gnu.org/licenses/>.  */

#ifndef TDESC_H
#define TDESC_H

#include "arch/tdesc.h"

#include "regdef.h"

typedef struct reg *tdesc_reg_p;
DEF_VEC_P(tdesc_reg_p);

struct tdesc_feature
{};

/* A target description.  Inherit from tdesc_feature so that target_desc
   can be used as tdesc_feature.  */

struct target_desc : tdesc_feature
{
  /* A vector of elements of register definitions that
     describe the inferior's register set.  */
  VEC(tdesc_reg_p) *reg_defs;

  /* The register cache size, in bytes.  */
  int registers_size;

#ifndef IN_PROCESS_AGENT
  /* An array of register names.  These are the "expedite" registers:
     registers whose values are sent along with stop replies.  */
  const char **expedite_regs = NULL;

  /* Defines what to return when looking for the "target.xml" file in
     response to qXfer:features:read.  Its contents can either be
     verbatim XML code (prefixed with a '@') or else the name of the
     actual XML file to be used in place of "target.xml".

     It can be NULL, then, its content is got from the following three
     fields features, arch, and osabi in tdesc_get_features_xml.  */
  const char *xmltarget = NULL;

  /* XML features in this target description.  */
  VEC (char_ptr) *features = NULL;

  /* The value of <architecture> element in the XML, replying GDB.  */
  const char *arch = NULL;

  /* The value of <osabi> element in the XML, replying GDB.  */
  const char *osabi = NULL;

public:
  target_desc ()
    : reg_defs (NULL), registers_size (0)
  {}

  ~target_desc ()
  {
    int i;
    struct reg *reg;

    for (i = 0; VEC_iterate (tdesc_reg_p, reg_defs, i, reg); i++)
      xfree (reg);
    VEC_free (tdesc_reg_p, reg_defs);

    xfree ((char *) arch);
    xfree ((char *) osabi);

    char *f;

    for (i = 0; VEC_iterate (char_ptr, features, i, f); i++)
      xfree (f);
    VEC_free (char_ptr, features);
  }

  bool operator== (const target_desc &other) const
  {
    if (VEC_length (tdesc_reg_p, reg_defs)
	!= VEC_length (tdesc_reg_p, other.reg_defs))
      return false;

    struct reg *reg;

    for (int ix = 0;
	 VEC_iterate (tdesc_reg_p, reg_defs, ix, reg);
	 ix++)
      {
	struct reg *reg2
	  = VEC_index (tdesc_reg_p, other.reg_defs, ix);

	if (reg != reg2 && *reg != *reg2)
	  return false;
      }

    /* Compare expedite_regs.  */
    int i = 0;
    for (; expedite_regs[i] != NULL; i++)
      {
	if (strcmp (expedite_regs[i], other.expedite_regs[i]) != 0)
	  return false;
      }
    if (other.expedite_regs[i] != NULL)
      return false;

    return true;
  }

  bool operator!= (const target_desc &other) const
  {
    return !(*this == other);
  }
#endif
};

/* Copy target description SRC to DEST.  */

void copy_target_description (struct target_desc *dest,
			      const struct target_desc *src);

/* Initialize TDESC.  */

void init_target_desc (struct target_desc *tdesc);

/* Return the current inferior's target description.  Never returns
   NULL.  */

const struct target_desc *current_target_desc (void);

#ifndef IN_PROCESS_AGENT
void set_tdesc_architecture (struct target_desc *target_desc,
			     const char *name);
void set_tdesc_osabi (struct target_desc *target_desc, const char *name);

const char *tdesc_get_features_xml (struct target_desc *tdesc);
#endif

#endif /* TDESC_H */