codegen_helper_visitor.hpp

Go to the documentation of this file.

/*
 * Copyright 2023 Blue Brain Project, EPFL.
 * See the top-level LICENSE file for details.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
/**
 * \file
 * \brief \copybrief nmodl::codegen::CodegenHelperVisitor
 */
 
#include <string>
 
#include "codegen/codegen_info.hpp"
#include "symtab/symbol_table.hpp"
#include "visitors/ast_visitor.hpp"
 
namespace nmodl {
namespace codegen {
 
/**
 * @addtogroup codegen_details
 * @{
 */
 
/**
 * \class CodegenHelperVisitor
 * \brief Helper visitor to gather AST information to help code generation
 *
 * Code generation pass needs various information from AST and symbol
 * table. Different code generation backends will need this information.
 * This helper pass visit ast and collect all information into single
 * class object of CodegenInfo.
 *
 * \todo
 *  - Determine `vectorize` as part of the pass
 *  - Determine `threadsafe` as part of the pass
 *  - Global variable order is not preserved, for example, below gives different order:
 *    - NEURON block:    GLOBAL gq, gp
 *    - PARAMETER block: gp = 11, gq[2]
 *  - POINTER rng and if it's also assigned rng[4] then it is printed as one value.
 *    Need to check what is correct value.
 */
class CodegenHelperVisitor: public visitor::ConstAstVisitor {
    using SymbolType = std::shared_ptr<symtab::Symbol>;
    using SymbolVectorType = std::vector<std::shared_ptr<symtab::Symbol>>;
 
    /// holds all codegen related information
    codegen::CodegenInfo info;
 
    /// Config variable for enabling/disabling CVODE, see `emit_cvode`.
    bool enable_cvode;
 
    /// if visiting net receive block
    bool under_net_receive_block = false;
 
    /// if visiting derivative block
    bool under_derivative_block = false;
 
    /// if visiting breakpoint block
    bool under_breakpoint_block = false;
 
    /// table statement found
    bool table_statement_used = false;
 
    /// symbol table for the program
    symtab::SymbolTable* psymtab = nullptr;
 
    /// lhs of assignment in derivative block
    std::shared_ptr<ast::Expression> assign_lhs;
 
    void find_ion_variables(const ast::Program& node);
    void find_table_variables();
    void find_range_variables();
    void find_non_range_variables();
    void find_neuron_global_variables();
    static void sort_with_mod2c_symbol_order(std::vector<SymbolType>& symbols);
    void check_cvode_codegen(const ast::Program& node);
 
  public:
    CodegenHelperVisitor(bool enable_cvode = false)
        : enable_cvode(enable_cvode) {}
 
    /// run visitor and return information for code generation
    codegen::CodegenInfo analyze(const ast::Program& node);
 
    void visit_electrode_current(const ast::ElectrodeCurrent& node) override;
    void visit_suffix(const ast::Suffix& node) override;
    void visit_function_call(const ast::FunctionCall& node) override;
    void visit_binary_expression(const ast::BinaryExpression& node) override;
    void visit_conductance_hint(const ast::ConductanceHint& node) override;
    void visit_procedure_block(const ast::ProcedureBlock& node) override;
    void visit_function_block(const ast::FunctionBlock& node) override;
    void visit_function_table_block(const ast::FunctionTableBlock& node) override;
    void visit_eigen_newton_solver_block(const ast::EigenNewtonSolverBlock& node) override;
    void visit_eigen_linear_solver_block(const ast::EigenLinearSolverBlock& node) override;
    void visit_statement_block(const ast::StatementBlock& node) override;
    void visit_initial_block(const ast::InitialBlock& node) override;
    void visit_constructor_block(const ast::ConstructorBlock& node) override;
    void visit_destructor_block(const ast::DestructorBlock& node) override;
    void visit_breakpoint_block(const ast::BreakpointBlock& node) override;
    void visit_derivative_block(const ast::DerivativeBlock& node) override;
    void visit_derivimplicit_callback(const ast::DerivimplicitCallback& node) override;
    void visit_net_receive_block(const ast::NetReceiveBlock& node) override;
    void visit_bbcore_pointer(const ast::BbcorePointer& node) override;
    void visit_thread_safe(const ast::ThreadSafe&) override;
    void visit_watch(const ast::Watch& node) override;
    void visit_watch_statement(const ast::WatchStatement& node) override;
    void visit_for_netcon(const ast::ForNetcon& node) override;
    void visit_table_statement(const ast::TableStatement& node) override;
    void visit_program(const ast::Program& node) override;
    void visit_factor_def(const ast::FactorDef& node) override;
    void visit_nrn_state_block(const ast::NrnStateBlock& node) override;
    void visit_cvode_block(const ast::CvodeBlock& node) override;
    void visit_linear_block(const ast::LinearBlock& node) override;
    void visit_non_linear_block(const ast::NonLinearBlock& node) override;
    void visit_discrete_block(const ast::DiscreteBlock& node) override;
    void visit_update_dt(const ast::UpdateDt& node) override;
    void visit_verbatim(const ast::Verbatim& node) override;
    void visit_before_block(const ast::BeforeBlock& node) override;
    void visit_after_block(const ast::AfterBlock& node) override;
    void visit_longitudinal_diffusion_block(const ast::LongitudinalDiffusionBlock& node) override;
};
 
/** @} */  // end of codegen_details
 
}  // namespace codegen
}  // namespace nmodl