soft_float_cg_ext.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework 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 SOFT_FLOAT_CG_EXT_HPP
#define SOFT_FLOAT_CG_EXT_HPP

#include "function_frontend_flow_step.hpp"

#include "bit_lattice.hpp"
#include "call_graph.hpp"
#include "function_behavior.hpp"
#include "tree_node.hpp"

#include "custom_map.hpp"
#include "custom_set.hpp"
#include "refcount.hpp"
#include "string_manipulation.hpp"
#include <array>
#include <tuple>
#include <vector>

REF_FORWARD_DECL(FloatFormat);
REF_FORWARD_DECL(FunctionVersion);
REF_FORWARD_DECL(soft_float_cg_ext);
REF_FORWARD_DECL(tree_manager);
REF_FORWARD_DECL(tree_manipulation);
REF_FORWARD_DECL(tree_node);

class soft_float_cg_ext : public FunctionFrontendFlowStep
{
 private:
   static CustomMap<CallGraph::vertex_descriptor, FunctionVersionRef> funcFF;

   static CustomMap<unsigned int, std::array<tree_nodeRef, 8>> versioning_args;

   static bool inline_math;
   static bool inline_conversion;
   static tree_nodeRef float32_type;
   static tree_nodeRef float32_ptr_type;
   static tree_nodeRef float64_type;
   static tree_nodeRef float64_ptr_type;

   static bool lowering_needed(const ssa_name* ssa);

   enum InterfaceType
   {
      INTERFACE_TYPE_NONE = 0,   // Cast rename not needed
      INTERFACE_TYPE_INPUT = 1,  // Cast rename after definition may be required
      INTERFACE_TYPE_OUTPUT = 2, // Cast rename before usage may be required
      INTERFACE_TYPE_REAL = 4    // Floating-point type must be persisted
   };

   CustomUnorderedSet<unsigned int> already_visited;

   const tree_managerRef TreeM;

   const tree_manipulationRef tree_man;

   function_decl* fd;
   bool isTopFunction;
   std::vector<tree_nodeRef> topReturn;
   bool bindingCompleted;
   std::vector<tree_nodeRef> paramBinding;

   FunctionVersionRef _version;

   tree_nodeRef int_type;
   tree_nodeRef int_ptr_type;

   // Real type variables to be aliased as integer type variables {ssa_name, internal_type}
   CustomMap<ssa_name*, bool> viewConvert;

   // Real to integer view convert statements to be converted into nop statements
   std::vector<tree_nodeRef> nopConvert;

   CustomMap<ssa_name*, std::tuple<FloatFormatRef, std::vector<unsigned int>>> inputInterface;

   CustomMap<ssa_name*, std::tuple<FloatFormatRef, std::vector<tree_nodeRef>>> outputInterface;

   CustomMap<ssa_name*, std::set<unsigned int>> hwParam;

   std::vector<ssa_name*> hwReturn;

   tree_nodeRef int_type_for(const tree_nodeRef& type, bool use_internal) const;

   bool signature_lowering(function_decl* f_decl) const;

   void ssa_lowering(ssa_name* ssa, bool internal_type) const;

   void replaceWithCall(const FloatFormatRef& specFF, const std::string& fu_name, std::vector<tree_nodeRef> args,
                        const tree_nodeRef& current_statement, const tree_nodeRef& current_tree_node,
                        const std::string& current_scrp);

   bool RecursiveExaminate(const tree_nodeRef& current_statement, const tree_nodeRef& current_tree_node,
                           int castRename);

   tree_nodeRef generate_interface(const blocRef& bb, tree_nodeRef stmt, const tree_nodeRef& ssa, FloatFormatRef inFF,
                                   FloatFormatRef outFF) const;

   tree_nodeRef cstCast(uint64_t in, const FloatFormatRef& inFF, const FloatFormatRef& outFF) const;

   tree_nodeRef floatNegate(const tree_nodeRef& op, const FloatFormatRef& ff) const;

   tree_nodeRef floatAbs(const tree_nodeRef& op, const FloatFormatRef& ff) const;

   const CustomUnorderedSet<std::pair<FrontendFlowStepType, FunctionRelationship>>
   ComputeFrontendRelationships(const DesignFlowStep::RelationshipType relationship_type) const override;

 public:
   soft_float_cg_ext(const ParameterConstRef _parameters, const application_managerRef AppM, unsigned int _function_id,
                     const DesignFlowManagerConstRef design_flow_manager);

   ~soft_float_cg_ext() override;

   DesignFlowStep_Status InternalExec() override;

   bool HasToBeExecuted() const override;
};

class FloatFormat
{
 public:
   enum FPRounding
   {
      FPRounding_Truncate = 0,
      FPRounding_NearestEven = 1
   };

   enum FPException
   {
      FPException_Overflow = 0,
      FPException_IEEE = 1,
      FPException_Saturation = 2
   };

   uint8_t exp_bits;
   uint8_t frac_bits;
   int32_t exp_bias;
   FPRounding rounding_mode;
   FPException exception_mode;
   bool has_one;
   bool has_subnorm;
   bit_lattice sign;

   FloatFormat(uint8_t _exp_bits, uint8_t _frac_bits, int32_t _exp_bias,
               FPRounding _rounding_mode = FPRounding_NearestEven, FPException _exception_mode = FPException_IEEE,
               bool _has_one = true, bool _has_subnorm = false, bit_lattice _sign = bit_lattice::U);

   bool operator==(const FloatFormat& other) const;

   bool operator!=(const FloatFormat& other) const;

   bool ieee_format() const;

   std::string ToString() const;

   static FloatFormatRef FromString(std::string ff_str);
};

class FunctionVersion
{
 public:
   // Id of reference function
   const CallGraph::vertex_descriptor function_vertex;

   // Float format required from the user
   FloatFormatRef userRequired;

   // Contains callers function versions'
   std::vector<FunctionVersionRef> callers;

   // True if all caller functions share this function float format or if this is a standard ieee format function
   bool internal;

   FunctionVersion();

   FunctionVersion(CallGraph::vertex_descriptor func_v, const FloatFormatRef& userFormat = nullptr);

   FunctionVersion(const FunctionVersion& other);

   ~FunctionVersion();

   int compare(const FunctionVersion& other, bool format_only = false) const;

   bool operator==(const FunctionVersion& other) const;

   bool operator!=(const FunctionVersion& other) const;

   bool ieee_format() const;

   std::string ToString() const;
};

#endif