rmake.py

#!/usr/bin/python3

# Copyright (C) 2020 - 2022 Advanced Micro Devices, Inc. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""Manage build and installation"""

import re
import sys
import os
import platform
import subprocess
import argparse
import pathlib
import shutil
from fnmatch import fnmatchcase

args = {}
param = {}
OS_info = {}


def parse_args():
    """Parse command-line arguments"""
    parser = argparse.ArgumentParser(description="""Checks build arguments""")
    # common
    parser.add_argument('-g',
                        '--debug',
                        required=False,
                        default=False,
                        action='store_true',
                        help='Generate Debug build (optional, default: False)')
    parser.add_argument('--build_dir',
                        type=str,
                        required=False,
                        default="build",
                        help='Build directory path (optional, default: build)')
    parser.add_argument(
        '--static',
        required=False,
        default=False,
        dest='static_lib',
        action='store_true',
        help='Generate static library build (optional, default: False)')
    parser.add_argument(
        '-c',
        '--clients',
        required=False,
        default=False,
        dest='build_clients',
        action='store_true',
        help='Generate all client builds (optional, default: False)')
    parser.add_argument('-i',
                        '--install',
                        required=False,
                        default=False,
                        dest='install',
                        action='store_true',
                        help='Install after build (optional, default: False)')
    parser.add_argument(
        '--cmake_darg',
        required=False,
        dest='cmake_dargs',
        nargs='+',
        help=
        'List of additional cmake defines for builds (optional, e.g. CMAKE)')
    parser.add_argument('-v',
                        '--verbose',
                        required=False,
                        default=False,
                        action='store_true',
                        help='Verbose build (optional, default: False)')
    # rocFFT options
    parser.add_argument(
        '--gen_pattern',
        nargs='+',
        required=False,
        default=['all'],
        help=
        'Size patterns to generate (none, pow2, pow3, pow5, pow7, 2D, large, small, all)'
    )
    parser.add_argument('--gen_precision',
                        nargs='+',
                        required=False,
                        default=['all'],
                        help='Precision types generate (single, double, all)')
    parser.add_argument('--gen_groups',
                        type=int,
                        required=False,
                        help='Number of small kernel groups')
    parser.add_argument('--manual_small',
                        nargs='+',
                        required=False,
                        help='Small problem sizes to generate')
    parser.add_argument('--manual_large',
                        nargs='+',
                        required=False,
                        help='Large problem sizes to generate')

    return parser.parse_args()


def os_detect():
    global OS_info
    if os.name == "nt":
        OS_info["ID"] = platform.system()
    else:
        inf_file = "/etc/os-release"
        if os.path.exists(inf_file):
            with open(inf_file) as f:
                for line in f:
                    if "=" in line:
                        k, v = line.strip().split("=")
                        OS_info[k] = v.replace('"', '')
    OS_info["NUM_PROC"] = os.cpu_count()
    print(OS_info)


def create_dir(dir_path):
    full_path = ""
    if os.path.isabs(dir_path):
        full_path = dir_path
    else:
        full_path = os.path.join(os.getcwd(), dir_path)
    pathlib.Path(full_path).mkdir(parents=True, exist_ok=True)


def delete_dir(dir_path):
    if os.path.exists(dir_path):
        shutil.rmtree(dir_path)


def cmake_path(os_path):
    if os.name == "nt":
        return os_path.replace("\\", "/")
    else:
        return os_path


def config_cmd():
    global args
    global OS_info
    cwd_path = os.getcwd()
    cmake_executable = "cmake"
    cmake_options = []
    src_path = cmake_path(cwd_path)
    cmake_platform_opts = []
    if os.name == "nt":
        # not really rocm path as none exist, HIP_DIR set in toolchain is more important
        rocm_path = os.getenv('ROCM_CMAKE_PATH',
                              "C:/github/rocm-cmake-master/share/rocm")
        #set CPACK_PACKAGING_INSTALL_PREFIX= defined as blank as it is appended to end of path for archive creation
        cmake_platform_opts.append(f"-DCPACK_PACKAGING_INSTALL_PREFIX=")
        cmake_platform_opts.append(f"-DCMAKE_INSTALL_PREFIX=C:/hipSDK")
        generator = ["-G", "Ninja"]
        cmake_options.extend(generator)
        toolchain = os.path.join(src_path, "toolchain-windows.cmake")
    else:
        rocm_path = os.getenv('ROCM_PATH', "/opt/rocm")
        cmake_platform_opts.append(f"-DROCM_DIR:PATH={rocm_path}")
        cmake_platform_opts.append(
            f"-DCPACK_PACKAGING_INSTALL_PREFIX={rocm_path}")
        cmake_platform_opts.append(f"-DCMAKE_INSTALL_PREFIX=rocfft-install")
        toolchain = "toolchain-linux.cmake"

    print(f"Build source path: {src_path}")

    tools = f"-DCMAKE_TOOLCHAIN_FILE={toolchain}"
    cmake_options.append(tools)

    cmake_options.extend(cmake_platform_opts)

    cmake_base_options = [
        f"-DROCM_PATH={rocm_path}", f"-DCMAKE_PREFIX_PATH:PATH={rocm_path}"
    ]
    cmake_options.extend(cmake_base_options)

    # packaging options
    cmake_pack_options = f"-DCPACK_SET_DESTDIR=OFF"
    cmake_options.append(cmake_pack_options)

    if os.getenv('CMAKE_CXX_COMPILER_LAUNCHER'):
        cmake_options.append(
            f"-DCMAKE_CXX_COMPILER_LAUNCHER={os.getenv('CMAKE_CXX_COMPILER_LAUNCHER')}"
        )

    print(cmake_options)

    # build type
    cmake_config = ""
    build_dir = os.path.abspath(args.build_dir)
    if not args.debug:
        build_path = os.path.join(build_dir, "release")
        cmake_config = "Release"
    else:
        build_path = os.path.join(build_dir, "debug")
        cmake_config = "Debug"

    cmake_options.append(f"-DCMAKE_BUILD_TYPE={cmake_config}")

    # clean
    delete_dir(build_path)

    create_dir(os.path.join(build_path, "clients"))
    os.chdir(build_path)

    if args.static_lib:
        cmake_options.append(f"-DBUILD_SHARED_LIBS=OFF")

    if args.build_clients:
        cmake_options.append(f"-DBUILD_CLIENTS=ON")

    if args.cmake_dargs:
        for i in args.cmake_dargs:
            cmake_options.append(f"-D{i}")

    # rocFFT-specific options
    cmake_options.append(f"-DGENERATOR_PATTERN={','.join(args.gen_pattern)}")
    cmake_options.append(
        f"-DGENERATOR_PRECISION={','.join(args.gen_precision)}")
    if args.gen_groups is not None:
        cmake_options.append(f"-DGENERATOR_GROUP_NUM={args.gen_groups}")
    if args.manual_small:
        cmake_options.append(
            f"-DGENERATOR_MANUAL_SMALL_SIZE={','.join(args.manual_small)}")
    if args.manual_large:
        cmake_options.append(
            f"-DGENERATOR_MANUAL_LARGE_SIZE={','.join(args.manual_large)}")

    cmake_options.append(f"{src_path}")

    return cmake_executable, cmake_options


def make_cmd():
    global args
    global OS_info

    make_options = []

    nproc = OS_info["NUM_PROC"]
    if os.name == "nt":
        make_executable = f"cmake.exe"
        make_options.extend(["--build", "."])  # ninja
        if args.verbose:
            make_options.append("--verbose")
        make_options.extend(["--target", "all"])
        if args.install:
            make_options.extend(["--target", "package", "--target", "install"])
    else:
        make_executable = f"make"
        make_options.append(f"-j{nproc}")
        if args.verbose:
            make_options.append("VERBOSE=1")
        if args.install:
            make_options.append("install")

    return make_executable, make_options


def run_cmd(exe, opts):
    program = [exe] + opts
    print(program)
    proc = subprocess.run(program, check=True, stderr=subprocess.STDOUT)
    return proc.returncode


def main():
    global args
    os_detect()
    args = parse_args()

    # configure
    exe, opts = config_cmd()
    run_cmd(exe, opts)

    # make
    exe, opts = make_cmd()
    run_cmd(exe, opts)


if __name__ == '__main__':
    main()