Optimize compile params (#11)

Default CGO_ENABLED to 0 regardless of go env CGO_ENABLED.
Revise command line instructions. Add more examples to README.md.
Use WinPlatform enum for wintun extraction function.
Revise test-run.sh, making it more flexible.

Author: Hammerklavier-cn

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "xray-pack"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2024"
 description = "Script to build and package Xray-core."
 

Cargo.toml

@@ -19,22 +19,18 @@ A Rust-based tool to build and package [Xray-core](https://github.com/XTLS/Xray-
 - [Rust](https://www.rust-lang.org/tools/install), if you want to build from source.
 - [Go](https://go.dev/doc/install) (must be in your `PATH`)
 
-## Installation
+## Build & Installation
+
+Type to the terminal
 
 ```bash
-cargo build --release
+CFLAGS="-O3 -march=native" CXXFLAGS="-O3 -march=native" RUSTFLAGS="-C target-cpu=native" cargo install --path .
 ```
 
-The executable will be in `target/release/Xray-pack.exe`.
+and the most optimized installation programme will be installed.
 
 ## Usage
 
-Enable all features for x86_64 CPU and Linux system (Only use GOAMD=v4 if CPU supports AVX512 instructions):
-
-```bash
-CGO_ENABLED=0 GOAMD64="v4" GOEXPERIMENT="greenteagc,jsonv2,newinliner" ./Xray-pack.exe -s -v --goos linux --goarch amd64
-```
-
 ### Proxy
 
 The programme determines the proxy settings from the environment variables in the following order: `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY` and `all_proxy`.
@@ -49,8 +45,8 @@ Options:
   -p, --source-path <PATH>    Path to Xray-core source code [default: current directory]
   -o, --output-path <PATH>    Output directory [default: dist]
       --xray-version <VER>    Xray-core version/tag/branch [default: main]
-      --goos <GOOS>           Target OS for Go compiler [default: linux]
-      --goarch <GOARCH>       Target architecture for Go compiler [default: amd64]
+      --goos <GOOS>           Target OS for Go compiler. This will override `GOARCH` and `go env GOOS` values. [default: linux]
+      --goarch <GOARCH>       Target architecture for Go compiler. This will override `GOARCH` and `go env GOARCH` values. [default: amd64]
       --gcflags <FLAGS>       Go compiler gcflags [default: all:-l=4]
       --ldflags <FLAGS>       Go compiler ldflags [default: -X github.com/xtls/xray-core/core.build=${COMMID} -s -w -buildid=]
       --region <REGION>       Region for geo files [default: china-mainland] [possible: china-mainland, russia, iran]
@@ -59,6 +55,26 @@ Options:
   -V, --version               Print version
 ```
 
+### Examples
+
+Enable all features for x86_64 CPU and Linux system (Only use GOAMD=v4 if CPU supports AVX512 instructions):
+
+```bash
+CGO_ENABLED=0 GOAMD64="v4" GOEXPERIMENT="greenteagc,jsonv2,newinliner" ./Xray-pack.exe -s -v --goos linux --goarch amd64
+```
+
+Optimize for most x86_64 CPU (with AVX2 support) and Windows system:
+
+```bash
+CGO_ENABLED=0 GOAMD64="v3" ./xray-pack.exe -s -v --goos windows --goarch amd64
+```
+
+Build for ARM64 MacOS, disabling inlining:
+
+```bash
+CGO_ENABLED=0 ./xray-pack.exe -s -v --goos darwin --goarch arm64 --gcflags "all:-l"
+```
+
 ### Output
 
 The packaged zip will be named:

README.md

@@ -19,22 +19,18 @@
 - [Rust](https://www.rust-lang.org/tools/install)（如果你想要从源码编译）
 - [Go](https://go.dev/doc/install)（需在 `PATH` 中）
 
-## 安装
+## 编译&安装
+
+命令行中输入 
 
 ```bash
-cargo build --release
+CFLAGS="-O3 -march=native" CXXFLAGS="-O3 -march=native" RUSTFLAGS="-C target-cpu=native" cargo install --path .
 ```
 
-可执行文件位于 `target/release/xray-pack.exe`。
+以安装最优化的安装程序
 
 ## 使用方法
 
-为 x86_64 CPU 和 Linux 系统启用所有性能特性（若 CPU 支持 AVX512 指令集）：
-
-```bash
-CGO_ENABLED=0 GOAMD64="v4" GOEXPERIMENT="greenteagc,jsonv2,newinliner" ./xray-pack.exe -s -v --goos linux --goarch amd64
-```
-
 ### 代理
 
 程序按以下顺序从环境变量中确定代理设置：`HTTPS_PROXY`、`https_proxy`、`ALL_PROXY` 和 `all_proxy`。
@@ -49,8 +45,8 @@ CGO_ENABLED=0 GOAMD64="v4" GOEXPERIMENT="greenteagc,jsonv2,newinliner" ./xray-pa
   -p, --source-path <路径>    xray-core 源码路径 [默认: 当前目录]
   -o, --output-path <路径>    输出目录 [默认: dist]
       --xray-version <版本>   xray-core 版本/标签/分支 [默认: main]
-      --goos <GOOS>           Go 编译目标操作系统 [默认: linux]
-      --goarch <GOARCH>       Go 编译目标架构 [默认: amd64]
+      --goos <GOOS>           Go 编译目标操作系统。这将覆盖 `GOARCH` 和 `go env GOOS` 值。[默认: linux]
+      --goarch <GOARCH>       Go 编译目标架构。这将覆盖 `GOARCH` 和 `go env GOARCH` 值。[默认: amd64]
       --gcflags <参数>        Go 编译 gcflags [默认: all:-l=4]
       --ldflags <参数>        Go 编译 ldflags [默认: -X github.com/xtls/xray-core/core.build=${COMMID} -s -w -buildid=]
       --region <区域>         Geo 数据区域 [默认: china-mainland] [可选: china-mainland, russia, iran]
@@ -59,6 +55,26 @@ CGO_ENABLED=0 GOAMD64="v4" GOEXPERIMENT="greenteagc,jsonv2,newinliner" ./xray-pa
   -V, --version               显示版本
 ```
 
+### 示例
+
+为 x86_64 CPU 和 Linux 系统启用所有性能特性（若 CPU 支持 AVX512 指令集）：
+
+```bash
+CGO_ENABLED=0 GOAMD64="v4" GOEXPERIMENT="greenteagc,jsonv2,newinliner" ./xray-pack.exe -s -v --goos linux --goarch amd64
+```
+
+为主流 x86_64 CPU 和 Windows 系统启用指令集优化（CPU 只支持到 AVX2 指令集）：
+
+```bash
+CGO_ENABLED=0 GOAMD64="v3" ./xray-pack.exe -s -v --goos windows --goarch amd64
+```
+
+为 ARM64 CPU 和 macOS 编译，禁用内联优化：
+
+```bash
+CGO_ENABLED=0 ./xray-pack.exe -s -v --goos darwin --goarch arm64 --gcflags "all:-l"
+```
+
 ### 输出内容
 
 最终打包的 zip 文件命名为：

README_zh.md

@@ -19,7 +19,8 @@ There are several options to maximize the performance of Xray-core:
 + `GOAMD64` `GO386` `GOARM` environment variables: Specify the microarchitecture of the CPU.
 + `GOEXPERIMENT` environment variable: Specify the experimental features of the Go compiler.
     `jsonv2`, `newinliner`, `greenteagc`, `regabiargs`, `regabiwrappers` might improve performance.
-+ `CGO_ENABLED` environment variable: Specify whether to enable CGO. `CGO_ENABLED=0` is recommended for better performance.
++ `CGO_ENABLED` environment variable: Specify whether to enable CGO. `CGO_ENABLED=0` is recommended for better performance. \
+Note that this programme will override `go env CGO_ENABLED` and set `CGO_ENABLED=0` unless you specify it manually.
 + `--gcflags`: Specify the `-gcflags` for the Go compiler. Default to `all=-l=4`, maximizing inline optimization.\
 "
 )]
@@ -80,14 +81,14 @@ pub struct PathOptions {
 pub struct CompileOptions {
     #[arg(
         long,
-        help = "Specify GOOS for the Go compiler. Default to `linux`",
+        help = "Specify GOOS for the Go compiler. This will override `GOARCH` and `go env GOOS` values.",
         default_value = "linux"
     )]
     pub goos: String,
 
     #[arg(
         long,
-        help = "Specify GOARCH for the Go compiler. Default to `amd64`",
+        help = "Specify GOARCH for the Go compiler. This will override `GOARCH` and `go env GOARCH` values.",
         default_value = "amd64"
     )]
     pub goarch: String,
@@ -106,12 +107,6 @@ pub struct CompileOptions {
 
 #[derive(Debug, Parser)]
 pub struct DownloadOptions {
-    // #[arg(
-    //     long,
-    //     help = "Specify platform for the Wintun driver. This is only required if the platform is Windows.",
-    //     default_value = "amd64"
-    // )]
-    // pub platform: WinPlatform,
     #[arg(
         long,
         help = "Specify region for geo files",
@@ -120,25 +115,6 @@ pub struct DownloadOptions {
     pub region: Region,
 }
 
-// #[derive(Debug, Clone, Copy, ValueEnum)]
-// #[value(rename_all = "lowercase")]
-// pub enum WinPlatform {
-//     X86,
-//     Amd64,
-//     Arm,
-//     Arm64,
-// }
-// impl Display for WinPlatform {
-//     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-//         match self {
-//             WinPlatform::X86 => write!(f, "x86"),
-//             WinPlatform::Amd64 => write!(f, "amd64"),
-//             WinPlatform::Arm => write!(f, "arm"),
-//             WinPlatform::Arm64 => write!(f, "arm64"),
-//         }
-//     }
-// }
-
 /// Three main restricted regions.
 #[derive(Debug, Clone, Copy, ValueEnum)]
 pub enum Region {

src/cli.rs

@@ -22,9 +22,8 @@ pub fn build_xray(commid: &str) -> PackResult<()> {
 
     let mut cmd = Command::new("go");
     let mut ldflags = String::new();
-    cmd.env("GOOS", &args.compile_options.goos)
-        .env("GOARCH", &args.compile_options.goarch)
-        .args([
+    let build_args = {
+        let mut vec = vec![
             "build",
             "-o",
             output_path.to_str().unwrap(),
@@ -38,9 +37,21 @@ pub fn build_xray(commid: &str) -> PackResult<()> {
                     format!("-X github.com/xtls/xray-core/core.build={commid} -s -w -buildid=");
                 &ldflags
             }),
-            "-v",
             "./main",
-        ]);
+        ];
+        if args.verbose {
+            vec.push("-v")
+        }
+        vec
+    };
+
+    cmd.env("GOOS", &args.compile_options.goos)
+        .env("GOARCH", &args.compile_options.goarch)
+        .env(
+            "CGO_ENABLED",
+            std::env::var("CGO_ENABLED").unwrap_or_else(|_| "0".to_string()),
+        )
+        .args(&build_args);
 
     cmd.spawn()
         .map_err(|e| PackError::BuildFailed(e.to_string()))?

src/compile.rs

@@ -1,9 +1,39 @@
+use std::fmt::Display;
+
 use crate::{
     TEMP_DIR,
     download::download_file,
     errors::{PackError, PackResult},
 };
 
+pub enum WinPlatform {
+    X86,
+    Amd64,
+    Arm,
+    Arm64,
+}
+impl Display for WinPlatform {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            WinPlatform::X86 => write!(f, "x86"),
+            WinPlatform::Amd64 => write!(f, "amd64"),
+            WinPlatform::Arm => write!(f, "arm"),
+            WinPlatform::Arm64 => write!(f, "arm64"),
+        }
+    }
+}
+impl From<&str> for WinPlatform {
+    fn from(s: &str) -> Self {
+        match s.to_lowercase().as_str() {
+            "x86" => WinPlatform::X86,
+            "amd64" => WinPlatform::Amd64,
+            "arm" => WinPlatform::Arm,
+            "arm64" => WinPlatform::Arm64,
+            _ => panic!("Invalid platform: {}", s),
+        }
+    }
+}
+
 /// Download wintun
 pub fn download_wintun() -> PackResult<()> {
     let url = "https://www.wintun.net/builds/wintun-0.14.1.zip";
@@ -13,7 +43,7 @@ pub fn download_wintun() -> PackResult<()> {
 }
 
 /// Extract .dll according to platform. Also copy the LICENSE file.
-pub fn extract_wintun(platform: impl AsRef<str>) -> PackResult<()> {
+pub fn extract_wintun(platform: WinPlatform) -> PackResult<()> {
     let zip_path = TEMP_DIR.join("wintun.zip");
     let extract_path = TEMP_DIR.join("wintun.dll");
 
@@ -23,7 +53,7 @@ pub fn extract_wintun(platform: impl AsRef<str>) -> PackResult<()> {
     let reader =
         std::fs::File::open(&zip_path).map_err(|_| PackError::ReadFailed(zip_path.clone()))?;
     let mut zip = zip::ZipArchive::new(reader)?;
-    let mut zip_file = zip.by_path(format!("wintun/bin/{}/wintun.dll", platform.as_ref()))?;
+    let mut zip_file = zip.by_path(format!("wintun/bin/{}/wintun.dll", platform))?;
 
     // create writer
     let mut writer = std::fs::File::create(&extract_path)

src/download/wintun.rs

@@ -4,7 +4,7 @@ use std::{path::PathBuf, sync::LazyLock};
 use clap::Parser;
 
 use crate::download::geodat::download_geodat;
-use crate::download::wintun::{download_wintun, extract_wintun};
+use crate::download::wintun::{WinPlatform, download_wintun, extract_wintun};
 use crate::errors::{PackError, PackResult};
 use crate::package::package_all;
 
@@ -76,9 +76,9 @@ fn main() -> PackResult<()> {
 
     download_geodat(args.download_options.region)?;
 
-    if args.compile_options.goos == "windows" {
+    if args.compile_options.goos.to_lowercase() == "windows" {
         download_wintun()?;
-        extract_wintun(&args.compile_options.goarch)?;
+        extract_wintun(WinPlatform::from(args.compile_options.goarch.as_str()))?;
     }
 
     package_all()?;

src/main.rs

@@ -1,6 +1,23 @@
 #!/usr/bin/bash
 
-cargo run --profile dev-rel -- \
-    --from-source \
-    --xray-version v26.1.18 \
-    --verbose
+show_help() {
+    echo "Usage: $0 [OPTIONS] [ARGS...]"
+    echo ""
+    echo "Run the Xray application with development profile."
+    echo ""
+    echo "Options:"
+    echo "  help     Show this help message"
+    echo ""
+    echo "Arguments passed after options will be forwarded to the application."
+}
+
+# Check if help was requested
+for arg in "$@"; do
+    if [ "$arg" == "help" ]; then
+        show_help
+        exit 0
+    fi
+done
+
+# Run the cargo command with all arguments
+cargo run --profile dev-rel -- "$@"