ConanPackages/mimalloc/all/conanfile.py

from conan import ConanFile
from conan.errors import ConanInvalidConfiguration
from conan.tools.cmake import CMake, CMakeToolchain, cmake_layout
from conan.tools.files import apply_conandata_patches, export_conandata_patches, get, copy, rm, rmdir, replace_in_file, collect_libs
from conan.tools.microsoft import is_msvc, is_msvc_static_runtime, VCVars
from conan.tools.env import VirtualBuildEnv
from conan.tools.scm import Version
import os
import shutil

required_conan_version = ">=2"


class MimallocConan(ConanFile):
    name = "mimalloc"
    description = "mimalloc is a compact general purpose allocator with excellent performance."
    license = "MIT"
    url = "https://github.com/conan-io/conan-center-index"
    homepage = "https://github.com/microsoft/mimalloc"
    topics = ("mimalloc", "allocator", "performance", "microsoft")
    package_type = "library"
    settings = "os", "arch", "compiler", "build_type"
    options = {
        "shared": [True, False],
        "fPIC": [True, False],
        "secure": [True, False],
        "override": [True, False],
        "inject": [True, False],
        "single_object": [True, False],
        "guarded": [True, False],
        "win_redirect": [True, False],
        "asan": [True, False],
    }
    default_options = {
        "shared": False,
        "fPIC": True,
        "secure": False,
        "override": False,
        "inject": False,
        "single_object": False,
        "guarded": False,
        "win_redirect": False,
        "asan": False,
    }

    def export_sources(self):
        export_conandata_patches(self)
        copy(self, os.path.join("cmake", "MinjectTargets.cmake"), self.recipe_folder, self.export_sources_folder)

    def config_options(self):
        if self.settings.os == "Windows":
            del self.options.fPIC
        else:
            del self.options.win_redirect

        # single_object and inject are options
        # only when overriding on Unix-like platforms:
        if is_msvc(self):
            del self.options.single_object
            del self.options.inject
        if Version(self.version) < "2.1.9":
            del self.options.guarded

    def configure(self):
        if self.options.shared:
            self.options.rm_safe("fPIC")

            # single_object is valid only for static
            # override:
            self.options.rm_safe("single_object")

        # inject is valid only for Unix-like dynamic override:
        if not self.options.shared:
            self.options.rm_safe("inject")

        # single_object and inject are valid only when
        # overriding on Unix-like platforms:
        if not self.options.override:
            self.options.rm_safe("single_object")
            self.options.rm_safe("inject")


    def layout(self):
        cmake_layout(self, src_folder="src")

    def validate(self):
        # Currently, mimalloc some version do not work properly with shared MD builds.
        # https://github.com/conan-io/conan-center-index/pull/10333#issuecomment-1114110046
        if  Version(self.version) == "1.7.6" and \
            self.options.shared and \
            is_msvc(self) and \
            not is_msvc_static_runtime(self):
            raise ConanInvalidConfiguration(
                f"Currently, {self.ref} doesn't work properly with shared MD builds in CCI. Contributions welcomed")

        if self.options.override and \
            self.options.asan:
                raise ConanInvalidConfiguration(
                    "Asan requires Mimalloc to be compiled without override")

        # Shared overriding requires dynamic runtime for MSVC:
        if self.options.override and \
           self.options.shared and \
           is_msvc(self) and \
           is_msvc_static_runtime(self):
            raise ConanInvalidConfiguration(
                "Dynamic runtime (MD/MDd) is required when using mimalloc as a shared library for override")

        if self.options.get_safe("win_redirect") and not (
            self.options.override and \
            self.options.shared and \
            is_msvc(self) and \
            not is_msvc_static_runtime(self)):
            raise ConanInvalidConfiguration(
                "Windows redirect requires 'override', 'shared' and building against a dynamic runtime (MD/MDd)")

        if self.options.override and \
           self.options.get_safe("single_object") and \
           self.options.get_safe("inject"):
            raise ConanInvalidConfiguration("Single object is incompatible with library injection")

    def build_requirements(self):
        self.tool_requires("cmake/[>=3.18 <4]")

    def source(self):
        get(self, **self.conan_data["sources"][self.version], strip_root=True)

    def generate(self):
        tc = CMakeToolchain(self)
        tc.variables["MI_BUILD_TESTS"] = "OFF"
        tc.variables["MI_BUILD_SHARED"] = self.options.shared
        tc.variables["MI_BUILD_STATIC"] = not self.options.shared
        tc.variables["MI_BUILD_OBJECT"] = self.options.get_safe("single_object", False)
        tc.variables["MI_OVERRIDE"] = "ON" if self.options.override else "OFF"
        tc.variables["MI_SECURE"] = "ON" if self.options.secure else "OFF"
        tc.variables["MI_WIN_REDIRECT"] = "ON" if self.options.get_safe("win_redirect") else "OFF"
        tc.variables["MI_INSTALL_TOPLEVEL"] = "ON"
        tc.variables["MI_GUARDED"] = self.options.get_safe("guarded", False)
        tc.variables["MI_TRACK_ASAN"] = "ON" if self.options.get_safe("asan") else "OFF"
        if Version(self.version) <= "1.7.6":
            tc.cache_variables["CMAKE_POLICY_VERSION_MINIMUM"] = "3.5" # CMake 4 support
        tc.generate()
        venv = VirtualBuildEnv(self)
        venv.generate(scope="build")

        if is_msvc(self):
            vcvars = VCVars(self)
            vcvars.generate()

    def build(self):
        apply_conandata_patches(self)
        if is_msvc(self) and self.settings.arch == "x86" and self.options.shared:
            replace_in_file(self, os.path.join(self.source_folder, "CMakeLists.txt"),
                            "mimalloc-redirect.lib",
                            "mimalloc-redirect32.lib")
        cmake = CMake(self)
        cmake.configure()
        cmake.build()

    def package(self):
        copy(self, pattern="LICENSE", dst=os.path.join(self.package_folder, "licenses"), src=self.source_folder)
        cmake = CMake(self)
        cmake.install()

        rmdir(self, os.path.join(self.package_folder, "cmake"))
        rmdir(self, os.path.join(self.package_folder, "lib", "cmake"))
        rmdir(self, os.path.join(self.package_folder, "lib", "pkgconfig"))

        if self.options.get_safe("single_object"):
            rm(self, "*.a", os.path.join(self.package_folder, "lib"))
            shutil.copy(os.path.join(self.package_folder, "lib", self._obj_name + ".o"),
                        os.path.join(self.package_folder, "lib", self._obj_name))

        if self.settings.os == "Windows" and self.options.shared:
            if self.settings.arch == "x86_64":
                copy(self, "mimalloc-redirect.dll",
                    src=os.path.join(self.source_folder, "bin"),
                    dst=os.path.join(self.package_folder, "bin"))
                copy(self, "minject.exe",
                    src=os.path.join(self.source_folder, "bin"),
                    dst=os.path.join(self.package_folder, "bin"))
            elif self.settings.arch == "x86":
                copy(self, "mimalloc-redirect32.dll",
                    src=os.path.join(self.source_folder, "bin"),
                    dst=os.path.join(self.package_folder, "bin"))
                copy(self, "minject32.exe",
                    src=os.path.join(self.source_folder, "bin"),
                    dst=os.path.join(self.package_folder, "bin"))

        rmdir(self, os.path.join(self.package_folder, "share"))

        copy(self, "MinjectTargets.cmake",
                   src=os.path.join(self.source_folder, os.pardir, "cmake"),
                   dst=os.path.join(self.package_folder, self._module_path))

    @property
    def _obj_name(self):
        name = "mimalloc"
        if self.options.secure:
            name += "-secure"
        if self.settings.build_type not in ("Release", "RelWithDebInfo", "MinSizeRel"):
            name += "-{}".format(str(self.settings.build_type).lower())
        return name

    @property
    def _lib_name(self):
        name = "mimalloc" if self.settings.os == "Windows" else "libmimalloc"

        if self.settings.os == "Windows" and not self.options.shared:
            name += "-static"
        if self.options.secure:
            name += "-secure"
        if self.settings.build_type not in ("Release", "RelWithDebInfo", "MinSizeRel"):
            name += "-{}".format(str(self.settings.build_type).lower())
        return name
    
    @property
    def _module_path(self):
        return os.path.join(self.package_folder, "lib", "cmake")

    def package_info(self):
        if(self.options.asan):
            self.cpp_info.set_property("cmake_file_name", "mimalloc-asan")
            self.cpp_info.set_property("cmake_target_name", "mimalloc-asan")
        else:
            self.cpp_info.set_property("cmake_file_name", "mimalloc")
            self.cpp_info.set_property("cmake_target_name", "mimalloc" if self.options.shared else "mimalloc-static")
        
        if self.options.get_safe("inject"):
            self.cpp_info.includedirs = []
            self.cpp_info.libdirs = []
            self.cpp_info.resdirs = []
            return

        if self.options.get_safe("single_object"):
            obj_ext = "o"
            obj_file = "{}.{}".format(self._obj_name, obj_ext)
            obj_path = os.path.join(self.package_folder, "lib", obj_file)
            self.cpp_info.exelinkflags = [obj_path]
            self.cpp_info.sharedlinkflags = [obj_path]
            self.cpp_info.libdirs = []
            self.cpp_info.bindirs = []
        else:
            self.cpp_info.libs = collect_libs(self)

        if self.settings.os == "Linux":
            self.cpp_info.system_libs.append("pthread")
        if not self.options.shared:
            if self.settings.os == "Windows":
                self.cpp_info.system_libs.extend(["psapi", "shell32", "user32", "bcrypt"])
            elif self.settings.os == "Linux":
                self.cpp_info.system_libs.append("rt")

        if self.settings.os == "Windows" and self.options.shared:
            build_modules = [
                os.path.join(self._module_path, "MinjectTargets.cmake"),
            ]
            self.cpp_info.set_property("cmake_build_modules", build_modules)