Node.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __LOCO_IR_NODE_H__
#define __LOCO_IR_NODE_H__
 
#include "loco/ADT/AnnotatedItem.h"
 
#include "loco/IR/Use.h"
#include "loco/IR/Dialect.h"
#include "loco/IR/NodePool.forward.h"
#include "loco/IR/Graph.forward.h"
#include "loco/IR/CastHelpers.h"
 
#include <array>
#include <cstdint>
#include <memory>
#include <set>
 
namespace loco
{
 
struct NodeAnnotation
{
  virtual ~NodeAnnotation() = default;
};
 
enum class SubstQualifier
{
  Default, // Replace all the occurrences as "Use" (by default)
};
 
template <SubstQualifier Q> class Subst;
 
class Node : public AnnotatedItem<NodeAnnotation>
{
public:
  friend class Use;
  friend class Subst<SubstQualifier::Default>;
  friend class NodePool;
  friend std::set<Node *> succs(const Node *node);
 
public:
  Node() = default;
 
  Node(const Node &) = delete;
  Node(Node &&) = delete;
 
  virtual ~Node();
 
public:
  Graph *graph(void) { return _graph; }
  const Graph *graph(void) const { return _graph; }
 
private:
  void graph(Graph *g) { _graph = g; }
 
public:
  virtual const Dialect *dialect(void) const = 0;
 
  virtual uint32_t opnum(void) const = 0;
 
public:
  virtual uint32_t arity(void) const = 0;
 
  virtual Node *arg(uint32_t N) const = 0;
 
  virtual void drop(void) = 0;
 
private:
  Graph *_graph = nullptr;
 
  std::set<Use *> _uses;
};
 
std::set<Node *> preds(const Node *node);
std::set<Node *> succs(const Node *node);
 
template <> class Subst<SubstQualifier::Default>
{
public:
  friend Subst<SubstQualifier::Default> replace(Node *node);
 
private:
  explicit Subst(Node *from);
 
public:
  void with(Node *into) const;
 
private:
  Node *_from;
};
 
Subst<SubstQualifier::Default> replace(Node *node);
 
template <typename T> T must_cast(Node *node) { return _must_cast<T, Node *>(node); }
 
template <typename T> T must_cast(const Node *node) { return _must_cast<T, const Node *>(node); }
 
} // namespace loco
 
#endif // __LOCO_IR_NODE_H__