revive-llvm-builder 1.3.0

revive LLVM compiler framework builder
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! The revive LLVM builder arguments.

use clap::Parser;
use revive_llvm_builder::ccache_variant::CcacheVariant;

/// The revive LLVM builder arguments.
#[derive(Debug, Parser)]
#[command(version, about)]
pub struct Arguments {
    /// Target environment to build LLVM (gnu, musl, emscripten).
    #[arg(long, default_value_t = revive_llvm_builder::target_env::TargetEnv::GNU)]
    pub target_env: revive_llvm_builder::target_env::TargetEnv,

    #[command(subcommand)]
    pub subcommand: Subcommand,
}

/// The revive LLVM builder arguments.
#[derive(Debug, clap::Subcommand)]
pub enum Subcommand {
    /// Build the LLVM framework.
    Build {
        /// LLVM build type (`Debug`, `Release`, `RelWithDebInfo`, or `MinSizeRel`).
        #[arg(long, default_value_t = revive_llvm_builder::BuildType::Release)]
        build_type: revive_llvm_builder::BuildType,

        /// Additional targets to build LLVM with.
        #[arg(long)]
        targets: Vec<String>,

        /// LLVM projects to build LLVM with.
        #[arg(long)]
        llvm_projects: Vec<revive_llvm_builder::llvm_project::LLVMProject>,

        /// Whether to build LLVM with run-time type information (RTTI) enabled.
        #[arg(long)]
        enable_rtti: bool,

        /// The default target to build LLVM with.
        #[arg(long)]
        default_target: Option<revive_llvm_builder::target_triple::TargetTriple>,

        /// Whether to build the LLVM tests.
        #[arg(long)]
        enable_tests: bool,

        /// Whether to build LLVM for source-based code coverage.
        #[arg(long)]
        enable_coverage: bool,

        /// Extra arguments to pass to CMake.  
        /// A leading backslash will be unescaped.
        #[arg(long)]
        extra_args: Vec<String>,

        /// Whether to use compiler cache (ccache) to speed-up builds.
        #[arg(long)]
        ccache_variant: Option<CcacheVariant>,

        /// Whether to build with assertions enabled or not.
        #[arg(long, default_value_t = true)]
        enable_assertions: bool,

        /// Build LLVM with sanitizer enabled (`Address`, `Memory`, `MemoryWithOrigins`, `Undefined`, `Thread`, `DataFlow`, or `Address;Undefined`).
        #[arg(long)]
        sanitizer: Option<revive_llvm_builder::sanitizer::Sanitizer>,

        /// Whether to run LLVM unit tests under valgrind or not.
        #[arg(long)]
        enable_valgrind: bool,
    },

    /// Install emsdk
    Emsdk,

    /// Clean the build artifacts.
    Clean,

    /// Build the LLVM compiler-rt builtins for the PolkaVM target.
    Builtins {
        /// LLVM build type (`Debug`, `Release`, `RelWithDebInfo`, or `MinSizeRel`).
        #[arg(long, default_value_t = revive_llvm_builder::BuildType::Release)]
        build_type: revive_llvm_builder::BuildType,

        /// The default target to build LLVM with.
        #[arg(long)]
        default_target: Option<revive_llvm_builder::target_triple::TargetTriple>,

        /// Extra arguments to pass to CMake.  
        /// A leading backslash will be unescaped.
        #[arg(long)]
        extra_args: Vec<String>,

        /// Whether to use compiler cache (ccache) to speed-up builds.
        #[arg(long)]
        ccache_variant: Option<CcacheVariant>,

        /// Build LLVM with sanitizer enabled (`Address`, `Memory`, `MemoryWithOrigins`, `Undefined`, `Thread`, `DataFlow`, or `Address;Undefined`).
        #[arg(long)]
        sanitizer: Option<revive_llvm_builder::sanitizer::Sanitizer>,
    },
}