setup memory measurement

Boshen · Boshen · commit 35ddc1c70443 · 2024-06-12T15:53:00.000+08:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,13 +8,13 @@ publish = false
 name = "transformer"
 harness = false
 
-[profile.release]
-opt-level     = 3
-lto           = "fat"
-codegen-units = 1
-strip         = "symbols"
-debug         = false
-panic         = "abort"
+[[bin]]
+name = "oxc"
+path = "src/oxc.rs"
+
+[[bin]]
+name = "swc"
+path = "src/swc.rs"
 
 [dependencies]
 oxc = { version = "0.13.5", features = ["transformer", "codegen"] }
@@ -34,3 +34,12 @@ mimalloc = "0.1.42"
 
 [features]
 codspeed = ["criterion2/codspeed"]
+
+[profile.release]
+opt-level     = 3
+lto           = "fat"
+codegen-units = 1
+strip         = "symbols"
+debug         = false
+panic         = "abort"
+
diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@ A transformer is also known as a transpiler, similar to Babel transform.
 
 The purpose of this benchmark is for people who wants to evaluate and compare the performance characteristics of the two transformer.
 
-The benchmark measures the whole parse -> transform -> codegen pipeline as a realword scenario.
+The benchmark measures the whole parse -> transform -> codegen pipeline as a real-word scenario.
 
-The numbers indicate that Oxc is at least 3 times faster than Swc.
+The numbers indicate that Oxc is at least 2 times faster than Swc.
 
 ## Results
 
@@ -37,7 +37,40 @@ Codspeed measures performance by cpu instructions.
 | parallel      | `195.8 ms` (1.00x) | `437.2 ms` (2.23x) |
 | single-thread | `106.0 ms` (1.00x) | `221.7 ms` (2.09x) |
 
-#### single-thread
+### Run benchmark locally
+
+Run the following command on your machine for replication.
+
+```bash
+cargo bench
+```
+
+Generate the table
+
+```bash
+pnpm i
+pnpm run table
+```
+
+## Maximum Resident Set Size
+
+
+## Setup
+
+* Uses `mimalloc` as the global allocator
+* Uses the following release profile
+
+```toml
+[profile.release]
+opt-level     = 3
+lto           = "fat"
+codegen-units = 1
+strip         = "symbols"
+debug         = false
+panic         = "abort"
+```
+
+### single-thread
 
 This is the standard benchmark run in a single thread.
 
@@ -47,7 +80,7 @@ group.bench_with_input(id, &source, |b, source| {
 });
 ```
 
-#### no-drop
+### no-drop
 
 This uses the [`iter_with_large_drop`](https://docs.rs/criterion/0.5.1/criterion/struct.Bencher.html#method.iter_with_large_drop) function, which does not take AST drop time into account.
 
@@ -60,7 +93,7 @@ group.bench_with_input(id, &source, |b, source| {
 });
 ```
 
-#### parallel
+### parallel
 
 This benchmark uses the total number of physical cores as the total number of files to parse per bench iteration. For example it parses 6 files in parallel on my Mac i7 6 cores.
 
@@ -77,32 +110,3 @@ group.bench_with_input(id, &source, |b, source| {
 });
 ```
 
-## Run
-
-Run the following command on your machine for replication.
-
-```bash
-cargo bench
-```
-
-Generate the table
-
-```bash
-pnpm i
-pnpm run table
-```
-
-## Input
-
-* Uses `mimalloc` as the global allocator
-* Uses the following release profile
-
-```toml
-[profile.release]
-opt-level     = 3
-lto           = "fat"
-codegen-units = 1
-strip         = "symbols"
-debug         = false
-panic         = "abort"
-```
diff --git a/benches/transformer.rs b/benches/transformer.rs
@@ -42,40 +42,7 @@ impl TheBencher for OxcBencher {
     const ID: &'static str = "oxc";
 
     fn run(path: &Path, source_text: &str) -> Self::RunOutput {
-        use oxc::{
-            allocator::Allocator,
-            codegen::{Codegen, CodegenOptions},
-            parser::Parser,
-            span::SourceType,
-            transformer::{ReactOptions, TransformOptions, Transformer, TypeScriptOptions},
-        };
-
-        let allocator = Allocator::default();
-        let source_type = SourceType::from_path(path).unwrap();
-        {
-            let ret = Parser::new(&allocator, source_text, source_type).parse();
-            let trivias = ret.trivias;
-            let mut program = ret.program;
-            let transform_options = TransformOptions {
-                typescript: TypeScriptOptions::default(),
-                react: ReactOptions::default(),
-                ..TransformOptions::default()
-            };
-            Transformer::new(
-                &allocator,
-                Path::new(""),
-                source_type,
-                &source_text,
-                &trivias,
-                transform_options,
-            )
-            .build(&mut program)
-            .unwrap();
-            let _transformed_text =
-                Codegen::<false>::new("", source_text, CodegenOptions::default(), None)
-                    .build(&program);
-        }
-        allocator
+        bench_transformer::oxc::transform(path, source_text)
     }
 }
 
@@ -86,56 +53,8 @@ impl TheBencher for SwcBencher {
 
     const ID: &'static str = "swc";
 
-    fn run(path: &Path, source: &str) -> Self::RunOutput {
-        use std::sync::Arc;
-        use swc::{Compiler, PrintArgs, SwcComments};
-        use swc_common::{chain, source_map::SourceMap, sync::Lrc, Mark, GLOBALS};
-        use swc_ecma_parser::{EsConfig, Parser, StringInput, Syntax, TsConfig};
-        use swc_ecma_transforms_react::{react, Options};
-        use swc_ecma_transforms_typescript::strip;
-        use swc_ecma_visit::FoldWith;
-
-        let cm = Lrc::new(SourceMap::new(swc_common::FilePathMapping::empty()));
-        let compiler = Compiler::new(Arc::clone(&cm));
-        let comments = SwcComments::default();
-        let syntax = match path.extension().unwrap().to_str().unwrap() {
-            "js" => Syntax::Es(EsConfig::default()),
-            "tsx" => Syntax::Typescript(TsConfig {
-                tsx: true,
-                ..TsConfig::default()
-            }),
-            _ => panic!("need to define syntax for swc"),
-        };
-
-        GLOBALS.set(&Default::default(), || {
-            let program = Parser::new(
-                syntax,
-                StringInput::new(source, Default::default(), Default::default()),
-                Some(&comments),
-            )
-            .parse_program()
-            .unwrap();
-
-            let top_level_mark = Mark::new();
-            let unresolved_mark = Mark::new();
-            let mut ast_pass = chain!(
-                strip(top_level_mark),
-                react(
-                    Arc::clone(&cm),
-                    Some(comments),
-                    Options::default(),
-                    top_level_mark,
-                    unresolved_mark
-                ),
-            );
-            let program = program.fold_with(&mut ast_pass);
-
-            let _ret = compiler
-                .print(&program, PrintArgs::default())
-                .expect("print failed");
-
-            program
-        })
+    fn run(path: &Path, source_text: &str) -> Self::RunOutput {
+        bench_transformer::swc::transform(path, source_text)
     }
 }
 
diff --git a/memory.sh b/memory.sh
@@ -0,0 +1,21 @@
+cargo build --release
+
+for FILE in "./files/cal.com.tsx" "./files/typescript.js"
+do
+  echo $FILE
+
+  for APP in oxc swc
+  do
+    hyperfine --warmup 10 --show-output "/usr/bin/time -al ./target/release/$APP $FILE > /dev/null" 2>&1 | \
+      grep "maximum resident set size" | \
+      awk '{ print $1 }' \
+      > ./target/output
+
+    TOTAL=$(awk '{ total += $1 } END { print total }' ./target/output)
+    COUNT=$(wc -l ./target/output| awk '{ print $1 }')
+    AVERAGE_MB=$(echo "$TOTAL $COUNT" | awk '{printf "%.1f", $1 / $2 / 1000 / 1000}')
+
+    echo $APP $AVERAGE_MB mb
+  done
+done
+
diff --git a/src/lib.rs b/src/lib.rs
@@ -0,0 +1,94 @@
+pub mod oxc {
+    use std::path::Path;
+
+    use oxc::{
+        allocator::Allocator,
+        codegen::{Codegen, CodegenOptions},
+        parser::Parser,
+        span::SourceType,
+        transformer::{ReactOptions, TransformOptions, Transformer, TypeScriptOptions},
+    };
+
+    pub fn transform(path: &Path, source_text: &str) -> Allocator {
+        let allocator = Allocator::default();
+        let source_type = SourceType::from_path(path).unwrap();
+        {
+            let ret = Parser::new(&allocator, source_text, source_type).parse();
+            let trivias = ret.trivias;
+            let mut program = ret.program;
+            let transform_options = TransformOptions {
+                typescript: TypeScriptOptions::default(),
+                react: ReactOptions::default(),
+                ..TransformOptions::default()
+            };
+            Transformer::new(
+                &allocator,
+                Path::new(""),
+                source_type,
+                source_text,
+                &trivias,
+                transform_options,
+            )
+            .build(&mut program)
+            .unwrap();
+            let _transformed_text =
+                Codegen::<false>::new("", source_text, CodegenOptions::default(), None)
+                    .build(&program);
+        }
+        allocator
+    }
+}
+
+pub mod swc {
+    use std::path::Path;
+
+    use std::sync::Arc;
+    use swc::{Compiler, PrintArgs, SwcComments};
+    use swc_common::{chain, source_map::SourceMap, sync::Lrc, Mark, GLOBALS};
+    use swc_ecma_ast::Program;
+    use swc_ecma_parser::{EsConfig, Parser, StringInput, Syntax, TsConfig};
+    use swc_ecma_transforms_react::{react, Options};
+    use swc_ecma_transforms_typescript::strip;
+    use swc_ecma_visit::FoldWith;
+
+    pub fn transform(path: &Path, source_text: &str) -> Program {
+        let cm = Lrc::new(SourceMap::new(swc_common::FilePathMapping::empty()));
+        let compiler = Compiler::new(Arc::clone(&cm));
+        let comments = SwcComments::default();
+        let syntax = match path.extension().unwrap().to_str().unwrap() {
+            "js" => Syntax::Es(EsConfig::default()),
+            "tsx" => Syntax::Typescript(TsConfig {
+                tsx: true,
+                ..TsConfig::default()
+            }),
+            _ => panic!("need to define syntax for swc"),
+        };
+
+        GLOBALS.set(&Default::default(), || {
+            let input = StringInput::new(source_text, Default::default(), Default::default());
+            let program = Parser::new(syntax, input, Some(&comments))
+                .parse_program()
+                .unwrap();
+
+            let top_level_mark = Mark::new();
+            let unresolved_mark = Mark::new();
+            let mut ast_pass = chain!(
+                strip(top_level_mark),
+                react(
+                    Arc::clone(&cm),
+                    Some(comments),
+                    Options::default(),
+                    top_level_mark,
+                    unresolved_mark
+                ),
+            );
+            let program = program.fold_with(&mut ast_pass);
+
+            let _ret = compiler
+                .print(&program, PrintArgs::default())
+                .expect("print failed");
+
+            program
+        })
+    }
+}
diff --git a/src/oxc.rs b/src/oxc.rs
@@ -0,0 +1,13 @@
+#[global_allocator]
+static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc;
+
+use std::{env, fs, path::Path};
+
+use bench_transformer::oxc;
+
+pub fn main() {
+    let path = env::args().nth(1).unwrap();
+    let path = Path::new(&path);
+    let source_text = fs::read_to_string(path).unwrap();
+    let _ = oxc::transform(path, &source_text);
+}
diff --git a/src/swc.rs b/src/swc.rs
@@ -0,0 +1,13 @@
+#[global_allocator]
+static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc;
+
+use std::{env, fs, path::Path};
+
+use bench_transformer::swc;
+
+pub fn main() {
+    let path = env::args().nth(1).unwrap();
+    let path = Path::new(&path);
+    let source_text = fs::read_to_string(path).unwrap();
+    let _ = swc::transform(path, &source_text);
+}
