arachne-pnr-840bdfdeb38809f9f6af4d89dd7b22959b176fdd/src/netlist.hh

/* Copyright (C) 2015 Cotton Seed

   This file is part of arachne-pnr.  Arachne-pnr is free software;
   you can redistribute it and/or modify it under the terms of the GNU
   General Public License version 2 as published by the Free Software
   Foundation.

   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 PNR_NETLIST_HH
#define PNR_NETLIST_HH

#include "bitvector.hh"
#include "line_parser.hh"
#include "vector.hh"

#include <string>
#include <vector>
#include <set>
#include <map>

class Net;
class Port;
class Node;
class Instance;
class Model;
class Models;
class Design;

class Identified
{
private:
  template<typename T> friend struct std::hash;
  friend class IdLess;

  static int id_counter;
  int id;

public:
  Identified()
    : id(id_counter++)
  {
  }
};

class IdLess
{
public:
  template<typename T> bool operator()(const T *lhs, const T *rhs) const
  {
    return static_cast<const Identified*>(lhs)->id < static_cast<const Identified*>(rhs)->id;
  }
};

namespace std {

template<>
struct hash<Identified *>
{
public:
  size_t operator()(const Identified *x) const
  {
    std::hash<int> hasher;
    return hasher(x->id);
  }
};

template<> struct hash<Net *> : public std::hash<Identified *> {};
template<> struct hash<Node *> : public std::hash<Identified *> {};
template<> struct hash<Instance *> : public std::hash<Identified *> {};
template<> struct hash<Model *> : public std::hash<Identified *> {};

}

enum class Direction
{
  IN, OUT, INOUT,
};

Direction opposite_direction(Direction d);

enum class Value
{
  ZERO, ONE, X, Z,
};

// for parameters, attributes
class Const
{
private:
  friend std::ostream &operator<<(std::ostream &s, const Const &c);

  LexicalPosition m_lp;
  bool m_is_bits;
  std::string m_strval;
  BitVector m_bitval;

public:
  const LexicalPosition &lexpos() const { return m_lp; }

public:
  Const() : m_is_bits(false) {}
  Const(const std::string &sv)
    : m_is_bits(false), m_strval(sv)
  {}
  Const(const LexicalPosition &lp, const std::string &sv)
    : m_lp(lp), m_is_bits(false), m_strval(sv)
  {}
  Const(const BitVector &bv)
    : m_is_bits(true), m_bitval(bv)
  {}
  Const(const LexicalPosition &lp, const BitVector &bv)
    : m_lp(lp), m_is_bits(true), m_bitval(bv)
  {}

  const std::string &as_string() const
  {
    if (m_is_bits)
      m_lp.fatal("expected string constant");
    return m_strval;
  }

  const BitVector &as_bits() const
  {
    if (!m_is_bits)
      m_lp.fatal("expected integer constant");
    return m_bitval;
  }

  bool get_bit(int i) const
  {
    if (!m_is_bits)
      m_lp.fatal("expected integer constant");
    if (i >= (int)m_bitval.size())
      return 0;
    else
      return m_bitval[i];
  }

  void write_verilog(std::ostream &s) const;
};


class Net : public Identified
{
  friend class Port;
  friend class Model;

  std::string m_name;
  bool m_is_constant;
  Value m_constant;

  std::set<Port *, IdLess> m_connections;

public:
  const std::string &name() const { return m_name; }

  bool is_constant() const { return m_is_constant; }
  void set_is_constant(bool c) { m_is_constant = c; }
  Value constant() const { return m_constant; }
  void set_constant(Value c) { m_constant = c; }

  const std::set<Port *, IdLess> &connections() const { return m_connections; }

  Net(const std::string &n)
    : m_name(n), m_is_constant(false), m_constant(Value::X)
  {
  }

  ~Net()
  {
    assert(m_connections.empty());
  }

  void replace(Net *new_n);
};

class Port : public Identified
{
  Node *m_node;
  std::string m_name;
  Direction m_dir;
  Value m_undriven;
  Net *m_connection;

public:
  Node *node() const { return m_node; }
  const std::string &name() const { return m_name; }
  Direction direction() const { return m_dir; }
  void set_direction(Direction dir) { m_dir = dir; }
  Value undriven() const { return m_undriven; }
  void set_undriven(Value u) { m_undriven = u; }

  Port(Node *node_, const std::string &name_)
    : m_node(node_), m_name(name_), m_dir(Direction::IN), m_undriven(Value::X), m_connection(nullptr)
  {}
  Port(Node *node_, const std::string &name_, Direction dir)
    : m_node(node_), m_name(name_), m_dir(dir), m_undriven(Value::X), m_connection(nullptr)
  {}
  Port(Node *node_, const std::string &name_, Direction dir, Value u)
    : m_node(node_), m_name(name_), m_dir(dir), m_undriven(u), m_connection(nullptr)
  {}
  ~Port()
  {
    assert(m_connection == nullptr);
  }

  /* from the perspective of the body of a model */
  bool is_output() const;
  bool is_input() const;
  bool is_bidir() const { return m_dir == Direction::INOUT; }

  bool connected() const { return m_connection != nullptr; }
  void disconnect();
  void connect(Net *n);
  Net *connection() const { return m_connection; }

  Port *connection_other_port() const;
};

class Node : public Identified
{
protected:
  std::map<std::string, Port *> m_ports;
  std::vector<Port *> m_ordered_ports;

public:
  typedef Node Base;
  enum class Kind
  {
    model,
    instance,
  };
private:
  Kind m_kind;

public:
  const std::map<std::string, Port *> &ports() const { return m_ports; }
  const std::vector<Port *> &ordered_ports() const { return m_ordered_ports; }

  Kind kind() const { return m_kind; }

  Node(Kind k) : m_kind(k) {}
  ~Node();

  Port *add_port(Port *t);
  Port *add_port(const std::string &n, Direction dir);
  Port *add_port(const std::string &n, Direction dir, Value u);
  Port *find_port(const std::string &n);
};

class Instance : public Node
{
  Model *m_parent;
  Model *m_instance_of;

  std::map<std::string, Const> m_params;
  std::map<std::string, Const> m_attrs;

public:
  static const Kind kindof = Kind::instance;

  Model *parent() const { return m_parent; }
  Model *instance_of() const { return m_instance_of; }
  const std::map<std::string, Const> &attrs() const { return m_attrs; }
  const std::map<std::string, Const> &params() const { return m_params; }

  Instance(Model *p, Model *inst_of);

  void set_attr(const std::string &an, const Const &val) { m_attrs[an] = val; }

  bool has_attr(const std::string &an) const
  {
    return contains_key(m_attrs, an);
  }

  const Const &get_attr(const std::string &an) const
  {
    return m_attrs.at(an);
  }
  // Return true if an attr exists and is set to 1, defval otherwise
  // (for binary attributes like ROUTE_THROUGH_FABRIC)
  bool is_attr_set(const std::string &an, bool defval = false) const
  {
    if(!has_attr(an))
      return defval;
    else
      return get_attr(an).get_bit(0);
  }

  void merge_attrs(const Instance *inst);

  void set_param(const std::string &pn, const Const &val) { m_params[pn] = val; }

  bool has_param(const std::string &pn) const;
  const Const &get_param(const std::string &pn) const;

  bool self_has_param(const std::string &pn) const { return contains_key(m_params, pn); }
  const Const &
  self_get_param(const std::string &pn) const
  {
    return m_params.at(pn);
  }

  void remove();

  void dump() const;
  void write_blif(std::ostream &s,
                  const std::map<Net *, std::string, IdLess> &net_name) const;
  void write_verilog(std::ostream &s,
                     const std::map<Net *, std::string, IdLess> &net_name,
                     const std::string &inst_name) const;
};

class Model : public Node
{
  friend class Instance;

  static int counter;

  std::string m_name;
  std::map<std::string, Net *> m_nets;
  std::set<Instance *, IdLess> m_instances;

  std::map<std::string, Const> m_params;

public:
  static const Kind kindof = Kind::model;

  const std::string &name() const { return m_name; }

  const std::set<Instance *, IdLess> &instances() const { return m_instances; }
  const std::map<std::string, Net *> &nets() const { return m_nets; }
  const std::map<std::string, Const> &params() const { return m_params; }

  Model(Design *d, const std::string &n);
  ~Model();

  Net *find_net(const std::string &n);
  Net *find_or_add_net(const std::string &n);
  Net *add_net();
  Net *add_net(const std::string &name);
  Net *add_net(Net *orig) { return add_net(orig->name()); }
  void remove_net(Net *n);
  Instance *add_instance(Model *inst_of);

  void
  set_param(const std::string &pn, const std::string &val)
  {
    m_params[pn] = Const(val);
  }

  void
  set_param(const std::string &pn, const BitVector &val)
  {
    m_params[pn] = Const(val);
  }

  const Const &
  get_param(const std::string &pn)
  {
    return m_params.at(pn);
  }

  bool has_param(const std::string &pn) { return contains_key(m_params, pn); }

  bool is_physical_port(Models &models, const Port *p) const;
  void check_boundary_nets(const Design *d) const;
  std::set<Net *, IdLess> boundary_nets(const Design *d) const;
  std::pair<std::vector<Net *>, std::map<Net *, int, IdLess>>
    index_nets() const;
  std::pair<std::vector<Net *>, std::map<Net *, int, IdLess>>
    index_internal_nets(const Design *d) const;

  std::pair<BasedVector<Instance *, 1>, std::map<Instance *, int, IdLess>>
    index_instances() const;

  void prune();

  std::pair<std::map<Net *, std::string, IdLess>,
            std::set<Net *, IdLess>>
    shared_names() const;
  void write_verilog(std::ostream &s) const;
  void write_blif(std::ostream &s) const;
  void rename_net(Net *n, const std::string &new_name);
#ifndef NDEBUG
  void check(const Design *d) const;
#endif
};

class Design
{
  friend class Model;

  Model *m_top;
  std::map<std::string, Model *> m_models;

public:
  Model *top() const { return m_top; }
  void set_top(Model *t);

  Design();
  ~Design();

  void create_standard_models();
  Model *find_model(const std::string &n) const;
  void prune();
  void write_verilog(std::ostream &s) const;
  void write_blif(std::ostream &s) const;
  void dump() const;
  void check_boundary_nets() const;
#ifndef NDEBUG
  void check() const;
#endif
};

class Models
{
public:
  Model *lut4,
    *carry;
  Model *lc,
    *io,
    *gb,
    *gb_io,
    *ram,
    *ramnr,
    *ramnw,
    *ramnrnw,
    *warmboot,
    *tbuf,
    *io_i3c,
    *io_od;

public:
  Models(const Design *d);

  bool is_dff(Instance *inst) const
  {
    return is_prefix("SB_DFF", inst->instance_of()->name());
  }
  bool is_lut4(Instance *inst) const { return inst->instance_of() == lut4; }
  bool is_carry(Instance *inst) const { return inst->instance_of() == carry; }

  bool is_lc(Instance *inst) const { return inst->instance_of() == lc; }
  bool is_io(Instance *inst) const { return inst->instance_of() == io; }
  bool is_gb(Instance *inst) const { return inst->instance_of() == gb; }
  bool is_gb_io(const Instance *inst) const { return inst->instance_of() == gb_io; }
  bool is_io_i3c(const Instance *inst) const { return inst->instance_of() == io_i3c; }
  bool is_io_od(const Instance *inst) const { return inst->instance_of() == io_od; }

  bool is_ioX(const Instance *inst) const
  {
    return inst->instance_of() == io
      || inst->instance_of() == gb_io
      || inst->instance_of() == io_i3c
      || inst->instance_of() == io_od;

  }
  bool is_gbX(const Instance *inst) const
  {
    return inst->instance_of() == gb
      || inst->instance_of() == gb_io;
  }

  bool is_ram(Instance *inst) const { return inst->instance_of() == ram; }
  bool is_ramnr(Instance *inst) const { return inst->instance_of() == ramnr; }
  bool is_ramnw(Instance *inst) const { return inst->instance_of() == ramnw; }
  bool is_ramnrnw(Instance *inst) const { return inst->instance_of() == ramnrnw; }
  bool is_warmboot(Instance *inst) const { return inst->instance_of() == warmboot; }
  bool is_tbuf(Instance *inst) const { return inst->instance_of() == tbuf; }

  bool is_ramX(Instance *inst) const
  {
    return (inst->instance_of() == ram
            || inst->instance_of() == ramnr
            || inst->instance_of() == ramnw
            || inst->instance_of() == ramnrnw);
  }
  bool is_pllX(const Instance *inst) const
  {
    return is_prefix("SB_PLL40_", inst->instance_of()->name());
  }
  bool is_mac16(const Instance *inst) const {return inst->instance_of()->name() == "SB_MAC16";}
  bool is_spram(const Instance *inst) const {return inst->instance_of()->name() == "SB_SPRAM256KA";}
  bool is_hfosc(const Instance *inst) const {return inst->instance_of()->name() == "SB_HFOSC" || inst->instance_of()->name() == "SB_HFOSC_TRIM";}
  bool is_hfosc_trim(const Instance *inst) const {return inst->instance_of()->name() == "SB_HFOSC_TRIM";}

  bool is_lfosc(const Instance *inst) const {return inst->instance_of()->name() == "SB_LFOSC";}
  bool is_rgba_drv(const Instance *inst) const {return inst->instance_of()->name() == "SB_RGBA_DRV";}
  bool is_ledda_ip(const Instance *inst) const {return inst->instance_of()->name() == "SB_LEDDA_IP";}
  bool is_i2c(const Instance *inst) const {return inst->instance_of()->name() == "SB_I2C";}
  bool is_spi(const Instance *inst) const {return inst->instance_of()->name() == "SB_SPI";}

};


#endif