BaseBuild.py

#  /*******************************************************************************
#   * Copyright 2019 -- 2024 IBM Corporation
#   *
#   * 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.
#  *******************************************************************************/
#

#  *
#  *                       cloudFPGA
#  *    =============================================
#  *     Created: Oct 2021
#  *     Authors: NGL
#  *
#  *     Description:
#  *        Base classes for DOSA build tools
#  *
#  *

import os
import abc
import gradatim.lib.singleton as dosa_singleton
from gradatim.backend.codeGen.VhdlEntity import VhdlEntity


class BaseBuild(metaclass=abc.ABCMeta):

    def __init__(self, name, build_dir=None):
        self.name = name
        self.build_dir = build_dir
        self.node_folder_name = None
        # self.out_dir = out_dir # TODO
        self.global_Makefile = None
        self.makefile_targets = {}

    def create_build_dir(self, node_id: int):
        self.node_folder_name = 'node_{}'.format(node_id)
        new_dir_path = os.path.abspath("{}/{}/".format(dosa_singleton.config.global_build_dir, self.node_folder_name))
        os.system("mkdir -p {}".format(new_dir_path))
        self.build_dir = new_dir_path

    def get_node_folder_name(self):
        return self.node_folder_name

    @abc.abstractmethod
    def write_build_scripts(self):
        print("[DOSA:Build:ERROR] NOT YET IMPLEMENTED.")

    @abc.abstractmethod
    def add_makefile_entry(self, path, target):
        print("[DOSA:Build:ERROR] NOT YET IMPLEMENTED.")


class BaseHwBuild(BaseBuild, metaclass=abc.ABCMeta):

    def __init__(self, name, target_device, build_dir=None):
        super().__init__(name, build_dir)
        self.global_vhdl_entity_path = None
        self.global_vhdl_dir = None
        self.global_tcl = None
        self.ip_dirs_list = {}
        self.target_device = target_device
        self.tcl_lines = []

    @abc.abstractmethod
    def add_ip_dir(self, block_id, path=None):
        print("[DOSA:Build:ERROR] NOT YET IMPLEMENTED.")

    def add_tcl_entry(self, tcl_line):
        self.tcl_lines.append(tcl_line)


class BaseSwBuild(BaseBuild, metaclass=abc.ABCMeta):

    def __init__(self, name, target_device=None, build_dir=None):
        super().__init__(name, build_dir)
        self.global_cpp = None
        self.global_hpp = None
        self.lib_dirs = {}
        self.target_deive = target_device

    @abc.abstractmethod
    def add_lib_dir(self, arch_block, path=None):
        print("[DOSA:Build:ERROR] NOT YET IMPLEMENTED.")


class HwBuildTopVhdl(BaseHwBuild, metaclass=abc.ABCMeta):

    def __init__(self, name, target_device, build_dir=None, use_debug=False):
        super().__init__(name, target_device, build_dir)
        self.topVhdl = VhdlEntity(use_debug=use_debug)