Commit 1a4f5e5

Browse files
StefanStojanovicaduh95
StefanStojanovic
authored and
aduh95
committed
build,win: add PGO workload scripts
Signed-off-by: StefanStojanovic <stefan.stojanovic@janeasystems.com> PR-URL: #63696 Refs: #61964 Reviewed-By: Richard Lau <richard.lau@ibm.com>
1 parent 340b983 commit 1a4f5e5

14 files changed

Lines changed: 5643 additions & 0 deletions

‎pgo.ps1‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# PGO (Profile-Guided Optimization) training script for Node.js (Clang / LLVM)
2+
#
3+
# Runs PGO training workloads against an instrumented Node.js binary
4+
# (Release\node.exe) and merges the resulting .profraw files into
5+
# node.profdata for use with -fprofile-use.
6+
#
7+
# Usage (from a VS Developer Command Prompt):
8+
# .\pgo.ps1 # Run workloads (15s each) and merge
9+
# .\pgo.ps1 -Duration 30 # Run workloads (30s each) and merge
10+
#
11+
# Prerequisites:
12+
# - Release\node.exe must be an instrumented build (built with pgo-generate)
13+
# - llvm-profdata must be available (shipped with VS LLVM toolset)
14+
#
15+
# Output:
16+
# - node.profdata in the repo root (ready for vcbuild.bat pgo-use)
17+
18+
param(
19+
[int]$Duration=15
20+
)
21+
22+
Set-StrictMode-Version Latest
23+
$ErrorActionPreference='Stop'
24+
25+
# ---------------------------------------------------------------------------
26+
# Locate llvm-profdata shipped with Visual Studio's LLVM toolset
27+
# ---------------------------------------------------------------------------
28+
29+
functionFind-LlvmProfdata {
30+
# vcbuild.bat uses %VCINSTALLDIR%\Tools\Llvm\x64\bin for clang.exe - same spot for profdata
31+
$vcInstallDir=$env:VCINSTALLDIR
32+
33+
if ($vcInstallDir) {
34+
$candidate=Join-Path$vcInstallDir"Tools\Llvm\x64\bin\llvm-profdata.exe"
35+
if (Test-Path$candidate) {
36+
return$candidate
37+
}
38+
}
39+
40+
# Fallback: try VS 2022 / 2026 default install locations
41+
$vsPaths=@(
42+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Enterprise\VC\Tools\Llvm\x64\bin",
43+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Community\VC\Tools\Llvm\x64\bin",
44+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Enterprise\VC\Tools\Llvm\x64\bin",
45+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"
46+
)
47+
foreach ($dirin$vsPaths) {
48+
$candidate=Join-Path$dir"llvm-profdata.exe"
49+
if (Test-Path$candidate) {
50+
return$candidate
51+
}
52+
}
53+
54+
# Last resort: PATH
55+
$fromPath=Get-Command llvm-profdata -ErrorAction SilentlyContinue
56+
if ($fromPath) {
57+
return$fromPath.Source
58+
}
59+
60+
return$null
61+
}
62+
63+
# ---------------------------------------------------------------------------
64+
# Validate prerequisites
65+
# ---------------------------------------------------------------------------
66+
67+
$instrumentedNode=Join-Path$PSScriptRoot"Release\node.exe"
68+
if (-not (Test-Path$instrumentedNode)) {
69+
Write-Error"Instrumented binary not found: $instrumentedNode`nBuild with: vcbuild.bat pgo-generate"
70+
exit1
71+
}
72+
73+
$pgoRunAll=Join-Path$PSScriptRoot"tools\pgo\pgo-run-all.js"
74+
if (-not (Test-Path$pgoRunAll)) {
75+
Write-Error"PGO training script not found: $pgoRunAll"
76+
exit1
77+
}
78+
79+
$llvmProfdata=Find-LlvmProfdata
80+
if (-not$llvmProfdata) {
81+
Write-Error"llvm-profdata not found. Install the LLVM toolset via Visual Studio Installer."
82+
exit1
83+
}
84+
85+
# ---------------------------------------------------------------------------
86+
# STEP 1 – Run workloads with the instrumented binary to collect profiles
87+
# ---------------------------------------------------------------------------
88+
89+
Write-Host"`n=== STEP 1: Collect PGO profiles ==="-ForegroundColor Cyan
90+
91+
# Directory that will receive .profraw files from the instrumented binary.
92+
# %p (PID) and %m (module hash) keep concurrent/fork'd processes from colliding.
93+
$profileDir=Join-Path$PSScriptRoot"pgo-profiles"
94+
95+
if (Test-Path$profileDir) {
96+
Remove-Item-Recurse -Force $profileDir
97+
}
98+
New-Item-ItemType Directory -Path $profileDir|Out-Null
99+
100+
$env:LLVM_PROFILE_FILE=Join-Path$profileDir"node-%p-%m.profraw"
101+
102+
Write-Host"Instrumented node : $instrumentedNode"
103+
Write-Host"Profile output : $($env:LLVM_PROFILE_FILE)"
104+
Write-Host"Duration per script: ${Duration}s"
105+
Write-Host""
106+
107+
$sw= [System.Diagnostics.Stopwatch]::StartNew()
108+
$proc=Start-Process`
109+
-FilePath $instrumentedNode`
110+
-ArgumentList "`"$pgoRunAll`" --verbose --duration=$Duration"`
111+
-Wait -PassThru -NoNewWindow
112+
$sw.Stop()
113+
Write-Host ("PGO training completed in {0}m {1}s (exit code: {2})"-f`
114+
$sw.Elapsed.Minutes,$sw.Elapsed.Seconds,$proc.ExitCode)
115+
if ($proc.ExitCode-ne0) {
116+
Write-Warning"PGO training exited with code $($proc.ExitCode) - continuing with merge"
117+
}
118+
119+
# Remove the env var so subsequent builds are not affected
120+
Remove-Item Env:\LLVM_PROFILE_FILE -ErrorAction SilentlyContinue
121+
122+
# ---------------------------------------------------------------------------
123+
# STEP 2 – Merge .profraw files -> node.profdata
124+
# ---------------------------------------------------------------------------
125+
126+
Write-Host"`n=== STEP 2: Merge profile data ==="-ForegroundColor Cyan
127+
128+
Write-Host"Using llvm-profdata: $llvmProfdata"
129+
130+
$profrawFiles=Get-ChildItem-Path $profileDir-Filter "*.profraw"-ErrorAction SilentlyContinue
131+
if ($profrawFiles.Count-eq0) {
132+
Write-Error"No .profraw files found in '$profileDir'. The instrumented binary may not have generated profile data."
133+
exit1
134+
}
135+
136+
$totalSize= ($profrawFiles|Measure-Object-Property Length -Sum).Sum
137+
$totalSizeMB= [math]::Round($totalSize/1MB,1)
138+
Write-Host"Found $($profrawFiles.Count) .profraw file(s), ${totalSizeMB} MB total"
139+
140+
$profdata=Join-Path$PSScriptRoot"node.profdata"
141+
$mergeArgs=@("merge","--output=$profdata") + ($profrawFiles|Select-Object-ExpandProperty FullName)
142+
143+
$mergeStopwatch= [System.Diagnostics.Stopwatch]::StartNew()
144+
&$llvmProfdata@mergeArgs
145+
$mergeExitCode=$LASTEXITCODE
146+
$mergeStopwatch.Stop()
147+
148+
if ($mergeExitCode-ne0) {
149+
Write-Error"llvm-profdata merge failed (exit code $mergeExitCode)"
150+
exit$mergeExitCode
151+
}
152+
153+
$profdataSize= [math]::Round((Get-Item$profdata).Length /1MB,1)
154+
Write-Host"Merge completed in $([math]::Round($mergeStopwatch.Elapsed.TotalSeconds,1))s"
155+
156+
# Clean up .profraw files now that they've been merged
157+
Remove-Item-Recurse -Force $profileDir
158+
Write-Host"Removed $($profrawFiles.Count) .profraw file(s) (${totalSizeMB} MB reclaimed)"
159+
160+
Write-Host"`n=== PGO training complete ==="-ForegroundColor Green
161+
Write-Host" Profile data: $profdata (${profdataSize} MB)"
162+
Write-Host" Next step: vcbuild.bat pgo-use"

‎tools/pgo/README.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Node.js PGO Training Scripts
2+
3+
Training workloads for Profile-Guided Optimization (PGO) builds using
4+
Clang/LLVM (including Clang-CL on Windows).
5+
6+
## What is PGO?
7+
8+
PGO uses runtime profile data to guide compiler optimizations (inlining,
9+
branch prediction, code layout), typically improving throughput by 5-20%.
10+
11+
The process has three phases:
12+
13+
1.**Instrument** — Build with `-fprofile-generate` (produces `.profraw` files)
14+
2.**Train** — Run representative workloads to collect profile data
15+
3.**Optimize** — Merge `.profraw` → `node.profdata` via `llvm-profdata`,
16+
then rebuild with `-fprofile-use`
17+
18+
## Quick Start
19+
20+
From a VS Developer Command Prompt:
21+
22+
```powershell
23+
# Step 1: Build the instrumented binary
24+
vcbuild.bat pgo-generate
25+
26+
# Step 2: Run workloads and merge profile data
27+
.\pgo.ps1
28+
29+
# Step 3: Build the optimized binary
30+
vcbuild.bat pgo-use
31+
```
32+
33+
`pgo.ps1` expects the instrumented binary at `Release\node.exe` (produced by
34+
step 1) and writes `node.profdata` to the repo root (consumed by step 3).
35+
36+
```powershell
37+
# Optionally set a longer training duration (default: 15s per script)
38+
.\pgo.ps1 -Duration 30
39+
```
40+
41+
## Training Scripts
42+
43+
All scripts use only Node.js built-in modules (no npm dependencies).
44+
Each script is run as a separate process via `fork()`, producing its own
45+
`.profraw` file.
46+
47+
| Script | What it exercises |
48+
| ------------------------ | ------------------------------------------------------------- |
49+
|`pgo-http-server.js`| llhttp parser, TCP stack, header serialization, JSON, routing |
50+
|`pgo-json.js`| V8 JSON parser/serializer, string allocation, GC pressure |
51+
|`pgo-crypto.js`| OpenSSL (hashing, HMAC, AES, RSA, ECDSA, random, KDF) |
52+
|`pgo-streams-buffers.js`| Buffer C++ impl, stream state machine, back-pressure |
53+
|`pgo-fs.js`| libuv fs operations, thread pool, path module |
54+
|`pgo-async-patterns.js`| V8 Promises, microtask queue, EventEmitter, timers |
55+
|`pgo-url-string.js`| Ada URL parser, V8 string internals, regex JIT |
56+
|`pgo-compression.js`| zlib, brotli C libraries, streaming compression |
57+
|`pgo-net.js`| libuv TCP/pipe handles, c-ares DNS resolver |
58+
|`pgo-module-loading.js`| Module resolver, V8 script compilation, vm module |
59+
|`pgo-child-workers.js`| Worker thread messaging, SharedArrayBuffer, inline eval |
60+
61+
### Running the Orchestrator Directly
62+
63+
The orchestrator can also be invoked directly (e.g. for testing individual
64+
workloads). When used with `pgo.ps1`, this is handled automatically.
65+
66+
```bash
67+
# Run all scripts
68+
node tools/pgo/pgo-run-all.js --duration=15 --verbose
69+
70+
# Run specific scripts
71+
node tools/pgo/pgo-run-all.js --scripts=http-server,json,crypto --duration=30
72+
73+
# Show help
74+
node tools/pgo/pgo-run-all.js --help
75+
```
76+
77+
Each script reads the `PGO_TRAINING_DURATION` environment variable (in
78+
milliseconds) to determine how long to run. The orchestrator sets this
79+
automatically from the `--duration` flag (in seconds).
80+
81+
## Files
82+
83+
```
84+
tools/pgo/
85+
├── pgo-run-all.js # Training orchestrator
86+
├── pgo-http-server.js # HTTP server + client workload
87+
├── pgo-json.js # JSON parse/stringify workload
88+
├── pgo-crypto.js # Crypto operations workload
89+
├── pgo-streams-buffers.js # Streams and Buffer workload
90+
├── pgo-fs.js # File system operations workload
91+
├── pgo-async-patterns.js # Promise/async, EventEmitter, timers workload
92+
├── pgo-url-string.js # URL parsing, string ops, regex workload
93+
├── pgo-compression.js # Gzip/brotli/deflate compression workload
94+
├── pgo-net.js # TCP networking and DNS workload
95+
├── pgo-module-loading.js # Module require/import, VM compilation workload
96+
├── pgo-child-workers.js # Worker threads workload
97+
└── README.md # This file
98+
```

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Commit 1a4f5e5
Browse files
StefanStojanovicaduh95
StefanStojanovic
authored and
aduh95
committed
build,win: add PGO workload scripts
Signed-off-by: StefanStojanovic <stefan.stojanovic@janeasystems.com>
PR-URL: #63696
Refs: #61964
Reviewed-By: Richard Lau <richard.lau@ibm.com>
1 parent 340b983 commit 1a4f5e5
14 files changed
Lines changed: 5643 additions & 0 deletions
‎pgo.ps1‎
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# PGO (Profile-Guided Optimization) training script for Node.js (Clang / LLVM)
2+
#
3+
# Runs PGO training workloads against an instrumented Node.js binary
4+
# (Release\node.exe) and merges the resulting .profraw files into
5+
# node.profdata for use with -fprofile-use.
6+
#
7+
# Usage (from a VS Developer Command Prompt):
8+
# .\pgo.ps1 # Run workloads (15s each) and merge
9+
# .\pgo.ps1 -Duration 30 # Run workloads (30s each) and merge
10+
#
11+
# Prerequisites:
12+
# - Release\node.exe must be an instrumented build (built with pgo-generate)
13+
# - llvm-profdata must be available (shipped with VS LLVM toolset)
14+
#
15+
# Output:
16+
# - node.profdata in the repo root (ready for vcbuild.bat pgo-use)
17+
18+
param(
19+
 [int]$Duration=15
20+
)
21+
22+
Set-StrictMode-Version Latest
23+
$ErrorActionPreference='Stop'
24+
25+
# ---------------------------------------------------------------------------
26+
# Locate llvm-profdata shipped with Visual Studio's LLVM toolset
27+
# ---------------------------------------------------------------------------
28+
29+
functionFind-LlvmProfdata {
30+
# vcbuild.bat uses %VCINSTALLDIR%\Tools\Llvm\x64\bin for clang.exe - same spot for profdata
31+
$vcInstallDir=$env:VCINSTALLDIR
32+
33+
if ($vcInstallDir) {
34+
$candidate=Join-Path$vcInstallDir"Tools\Llvm\x64\bin\llvm-profdata.exe"
35+
if (Test-Path$candidate) {
36+
return$candidate
37+
 }
38+
 }
39+
40+
# Fallback: try VS 2022 / 2026 default install locations
41+
$vsPaths=@(
42+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Enterprise\VC\Tools\Llvm\x64\bin",
43+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Community\VC\Tools\Llvm\x64\bin",
44+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Enterprise\VC\Tools\Llvm\x64\bin",
45+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"
46+
 )
47+
foreach ($dirin$vsPaths) {
48+
$candidate=Join-Path$dir"llvm-profdata.exe"
49+
if (Test-Path$candidate) {
50+
return$candidate
51+
 }
52+
 }
53+
54+
# Last resort: PATH
55+
$fromPath=Get-Command llvm-profdata -ErrorAction SilentlyContinue
56+
if ($fromPath) {
57+
return$fromPath.Source
58+
 }
59+
60+
return$null
61+
}
62+
63+
# ---------------------------------------------------------------------------
64+
# Validate prerequisites
65+
# ---------------------------------------------------------------------------
66+
67+
$instrumentedNode=Join-Path$PSScriptRoot"Release\node.exe"
68+
if (-not (Test-Path$instrumentedNode)) {
69+
Write-Error"Instrumented binary not found: $instrumentedNode`nBuild with: vcbuild.bat pgo-generate"
70+
exit1
71+
}
72+
73+
$pgoRunAll=Join-Path$PSScriptRoot"tools\pgo\pgo-run-all.js"
74+
if (-not (Test-Path$pgoRunAll)) {
75+
Write-Error"PGO training script not found: $pgoRunAll"
76+
exit1
77+
}
78+
79+
$llvmProfdata=Find-LlvmProfdata
80+
if (-not$llvmProfdata) {
81+
Write-Error"llvm-profdata not found. Install the LLVM toolset via Visual Studio Installer."
82+
exit1
83+
}
84+
85+
# ---------------------------------------------------------------------------
86+
# STEP 1 – Run workloads with the instrumented binary to collect profiles
87+
# ---------------------------------------------------------------------------
88+
89+
Write-Host"`n=== STEP 1: Collect PGO profiles ==="-ForegroundColor Cyan
90+
91+
# Directory that will receive .profraw files from the instrumented binary.
92+
# %p (PID) and %m (module hash) keep concurrent/fork'd processes from colliding.
93+
$profileDir=Join-Path$PSScriptRoot"pgo-profiles"
94+
95+
if (Test-Path$profileDir) {
96+
Remove-Item-Recurse -Force $profileDir
97+
}
98+
New-Item-ItemType Directory -Path $profileDir|Out-Null
99+
100+
$env:LLVM_PROFILE_FILE=Join-Path$profileDir"node-%p-%m.profraw"
101+
102+
Write-Host"Instrumented node : $instrumentedNode"
103+
Write-Host"Profile output : $($env:LLVM_PROFILE_FILE)"
104+
Write-Host"Duration per script: ${Duration}s"
105+
Write-Host""
106+
107+
$sw= [System.Diagnostics.Stopwatch]::StartNew()
108+
$proc=Start-Process`
109+
-FilePath $instrumentedNode`
110+
-ArgumentList "`"$pgoRunAll`" --verbose --duration=$Duration"`
111+
-Wait -PassThru -NoNewWindow
112+
$sw.Stop()
113+
Write-Host ("PGO training completed in {0}m {1}s (exit code: {2})"-f`
114+
$sw.Elapsed.Minutes,$sw.Elapsed.Seconds,$proc.ExitCode)
115+
if ($proc.ExitCode-ne0) {
116+
Write-Warning"PGO training exited with code $($proc.ExitCode) - continuing with merge"
117+
}
118+
119+
# Remove the env var so subsequent builds are not affected
120+
Remove-Item Env:\LLVM_PROFILE_FILE -ErrorAction SilentlyContinue
121+
122+
# ---------------------------------------------------------------------------
123+
# STEP 2 – Merge .profraw files -> node.profdata
124+
# ---------------------------------------------------------------------------
125+
126+
Write-Host"`n=== STEP 2: Merge profile data ==="-ForegroundColor Cyan
127+
128+
Write-Host"Using llvm-profdata: $llvmProfdata"
129+
130+
$profrawFiles=Get-ChildItem-Path $profileDir-Filter "*.profraw"-ErrorAction SilentlyContinue
131+
if ($profrawFiles.Count-eq0) {
132+
Write-Error"No .profraw files found in '$profileDir'. The instrumented binary may not have generated profile data."
133+
exit1
134+
}
135+
136+
$totalSize= ($profrawFiles|Measure-Object-Property Length -Sum).Sum
137+
$totalSizeMB= [math]::Round($totalSize/1MB,1)
138+
Write-Host"Found $($profrawFiles.Count) .profraw file(s), ${totalSizeMB} MB total"
139+
140+
$profdata=Join-Path$PSScriptRoot"node.profdata"
141+
$mergeArgs=@("merge","--output=$profdata") + ($profrawFiles|Select-Object-ExpandProperty FullName)
142+
143+
$mergeStopwatch= [System.Diagnostics.Stopwatch]::StartNew()
144+
&$llvmProfdata@mergeArgs
145+
$mergeExitCode=$LASTEXITCODE
146+
$mergeStopwatch.Stop()
147+
148+
if ($mergeExitCode-ne0) {
149+
Write-Error"llvm-profdata merge failed (exit code $mergeExitCode)"
150+
exit$mergeExitCode
151+
}
152+
153+
$profdataSize= [math]::Round((Get-Item$profdata).Length /1MB,1)
154+
Write-Host"Merge completed in $([math]::Round($mergeStopwatch.Elapsed.TotalSeconds,1))s"
155+
156+
# Clean up .profraw files now that they've been merged
157+
Remove-Item-Recurse -Force $profileDir
158+
Write-Host"Removed $($profrawFiles.Count) .profraw file(s) (${totalSizeMB} MB reclaimed)"
159+
160+
Write-Host"`n=== PGO training complete ==="-ForegroundColor Green
161+
Write-Host" Profile data: $profdata (${profdataSize} MB)"
162+
Write-Host" Next step: vcbuild.bat pgo-use"
‎tools/pgo/README.md‎
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Node.js PGO Training Scripts
2+
3+
Training workloads for Profile-Guided Optimization (PGO) builds using
4+
Clang/LLVM (including Clang-CL on Windows).
5+
6+
## What is PGO?
7+
8+
PGO uses runtime profile data to guide compiler optimizations (inlining,
9+
branch prediction, code layout), typically improving throughput by 5-20%.
10+
11+
The process has three phases:
12+
13+
1.**Instrument** — Build with `-fprofile-generate` (produces `.profraw` files)
14+
2.**Train** — Run representative workloads to collect profile data
15+
3.**Optimize** — Merge `.profraw` → `node.profdata` via `llvm-profdata`,
16+
 then rebuild with `-fprofile-use`
17+
18+
## Quick Start
19+
20+
From a VS Developer Command Prompt:
21+
22+
```powershell
23+
# Step 1: Build the instrumented binary
24+
vcbuild.bat pgo-generate
25+
26+
# Step 2: Run workloads and merge profile data
27+
.\pgo.ps1
28+
29+
# Step 3: Build the optimized binary
30+
vcbuild.bat pgo-use
31+
```
32+
33+
`pgo.ps1` expects the instrumented binary at `Release\node.exe` (produced by
34+
step 1) and writes `node.profdata` to the repo root (consumed by step 3).
35+
36+
```powershell
37+
# Optionally set a longer training duration (default: 15s per script)
38+
.\pgo.ps1 -Duration 30
39+
```
40+
41+
## Training Scripts
42+
43+
All scripts use only Node.js built-in modules (no npm dependencies).
44+
Each script is run as a separate process via `fork()`, producing its own
45+
`.profraw` file.
46+
47+
| Script | What it exercises |
48+
| ------------------------ | ------------------------------------------------------------- |
49+
|`pgo-http-server.js`| llhttp parser, TCP stack, header serialization, JSON, routing |
50+
|`pgo-json.js`| V8 JSON parser/serializer, string allocation, GC pressure |
51+
|`pgo-crypto.js`| OpenSSL (hashing, HMAC, AES, RSA, ECDSA, random, KDF) |
52+
|`pgo-streams-buffers.js`| Buffer C++ impl, stream state machine, back-pressure |
53+
|`pgo-fs.js`| libuv fs operations, thread pool, path module |
54+
|`pgo-async-patterns.js`| V8 Promises, microtask queue, EventEmitter, timers |
55+
|`pgo-url-string.js`| Ada URL parser, V8 string internals, regex JIT |
56+
|`pgo-compression.js`| zlib, brotli C libraries, streaming compression |
57+
|`pgo-net.js`| libuv TCP/pipe handles, c-ares DNS resolver |
58+
|`pgo-module-loading.js`| Module resolver, V8 script compilation, vm module |
59+
|`pgo-child-workers.js`| Worker thread messaging, SharedArrayBuffer, inline eval |
60+
61+
### Running the Orchestrator Directly
62+
63+
The orchestrator can also be invoked directly (e.g. for testing individual
64+
workloads). When used with `pgo.ps1`, this is handled automatically.
65+
66+
```bash
67+
# Run all scripts
68+
node tools/pgo/pgo-run-all.js --duration=15 --verbose
69+
70+
# Run specific scripts
71+
node tools/pgo/pgo-run-all.js --scripts=http-server,json,crypto --duration=30
72+
73+
# Show help
74+
node tools/pgo/pgo-run-all.js --help
75+
```
76+
77+
Each script reads the `PGO_TRAINING_DURATION` environment variable (in
78+
milliseconds) to determine how long to run. The orchestrator sets this
79+
automatically from the `--duration` flag (in seconds).
80+
81+
## Files
82+
83+
```
84+
tools/pgo/
85+
├── pgo-run-all.js # Training orchestrator
86+
├── pgo-http-server.js # HTTP server + client workload
87+
├── pgo-json.js # JSON parse/stringify workload
88+
├── pgo-crypto.js # Crypto operations workload
89+
├── pgo-streams-buffers.js # Streams and Buffer workload
90+
├── pgo-fs.js # File system operations workload
91+
├── pgo-async-patterns.js # Promise/async, EventEmitter, timers workload
92+
├── pgo-url-string.js # URL parsing, string ops, regex workload
93+
├── pgo-compression.js # Gzip/brotli/deflate compression workload
94+
├── pgo-net.js # TCP networking and DNS workload
95+
├── pgo-module-loading.js # Module require/import, VM compilation workload
96+
├── pgo-child-workers.js # Worker threads workload
97+
└── README.md # This file
98+
```
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 1a4f5e5
Browse files
StefanStojanovicaduh95
StefanStojanovic
authored and
aduh95
committed
build,win: add PGO workload scripts
Signed-off-by: StefanStojanovic <stefan.stojanovic@janeasystems.com>
PR-URL: #63696
Refs: #61964
Reviewed-By: Richard Lau <richard.lau@ibm.com>
1 parent 340b983 commit 1a4f5e5
14 files changed
Lines changed: 5643 additions & 0 deletions
‎pgo.ps1‎
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# PGO (Profile-Guided Optimization) training script for Node.js (Clang / LLVM)
2+
#
3+
# Runs PGO training workloads against an instrumented Node.js binary
4+
# (Release\node.exe) and merges the resulting .profraw files into
5+
# node.profdata for use with -fprofile-use.
6+
#
7+
# Usage (from a VS Developer Command Prompt):
8+
# .\pgo.ps1 # Run workloads (15s each) and merge
9+
# .\pgo.ps1 -Duration 30 # Run workloads (30s each) and merge
10+
#
11+
# Prerequisites:
12+
# - Release\node.exe must be an instrumented build (built with pgo-generate)
13+
# - llvm-profdata must be available (shipped with VS LLVM toolset)
14+
#
15+
# Output:
16+
# - node.profdata in the repo root (ready for vcbuild.bat pgo-use)
17+
18+
param(
19+
 [int]$Duration=15
20+
)
21+
22+
Set-StrictMode-Version Latest
23+
$ErrorActionPreference='Stop'
24+
25+
# ---------------------------------------------------------------------------
26+
# Locate llvm-profdata shipped with Visual Studio's LLVM toolset
27+
# ---------------------------------------------------------------------------
28+
29+
functionFind-LlvmProfdata {
30+
# vcbuild.bat uses %VCINSTALLDIR%\Tools\Llvm\x64\bin for clang.exe - same spot for profdata
31+
$vcInstallDir=$env:VCINSTALLDIR
32+
33+
if ($vcInstallDir) {
34+
$candidate=Join-Path$vcInstallDir"Tools\Llvm\x64\bin\llvm-profdata.exe"
35+
if (Test-Path$candidate) {
36+
return$candidate
37+
 }
38+
 }
39+
40+
# Fallback: try VS 2022 / 2026 default install locations
41+
$vsPaths=@(
42+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Enterprise\VC\Tools\Llvm\x64\bin",
43+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Community\VC\Tools\Llvm\x64\bin",
44+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Enterprise\VC\Tools\Llvm\x64\bin",
45+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"
46+
 )
47+
foreach ($dirin$vsPaths) {
48+
$candidate=Join-Path$dir"llvm-profdata.exe"
49+
if (Test-Path$candidate) {
50+
return$candidate
51+
 }
52+
 }
53+
54+
# Last resort: PATH
55+
$fromPath=Get-Command llvm-profdata -ErrorAction SilentlyContinue
56+
if ($fromPath) {
57+
return$fromPath.Source
58+
 }
59+
60+
return$null
61+
}
62+
63+
# ---------------------------------------------------------------------------
64+
# Validate prerequisites
65+
# ---------------------------------------------------------------------------
66+
67+
$instrumentedNode=Join-Path$PSScriptRoot"Release\node.exe"
68+
if (-not (Test-Path$instrumentedNode)) {
69+
Write-Error"Instrumented binary not found: $instrumentedNode`nBuild with: vcbuild.bat pgo-generate"
70+
exit1
71+
}
72+
73+
$pgoRunAll=Join-Path$PSScriptRoot"tools\pgo\pgo-run-all.js"
74+
if (-not (Test-Path$pgoRunAll)) {
75+
Write-Error"PGO training script not found: $pgoRunAll"
76+
exit1
77+
}
78+
79+
$llvmProfdata=Find-LlvmProfdata
80+
if (-not$llvmProfdata) {
81+
Write-Error"llvm-profdata not found. Install the LLVM toolset via Visual Studio Installer."
82+
exit1
83+
}
84+
85+
# ---------------------------------------------------------------------------
86+
# STEP 1 – Run workloads with the instrumented binary to collect profiles
87+
# ---------------------------------------------------------------------------
88+
89+
Write-Host"`n=== STEP 1: Collect PGO profiles ==="-ForegroundColor Cyan
90+
91+
# Directory that will receive .profraw files from the instrumented binary.
92+
# %p (PID) and %m (module hash) keep concurrent/fork'd processes from colliding.
93+
$profileDir=Join-Path$PSScriptRoot"pgo-profiles"
94+
95+
if (Test-Path$profileDir) {
96+
Remove-Item-Recurse -Force $profileDir
97+
}
98+
New-Item-ItemType Directory -Path $profileDir|Out-Null
99+
100+
$env:LLVM_PROFILE_FILE=Join-Path$profileDir"node-%p-%m.profraw"
101+
102+
Write-Host"Instrumented node : $instrumentedNode"
103+
Write-Host"Profile output : $($env:LLVM_PROFILE_FILE)"
104+
Write-Host"Duration per script: ${Duration}s"
105+
Write-Host""
106+
107+
$sw= [System.Diagnostics.Stopwatch]::StartNew()
108+
$proc=Start-Process`
109+
-FilePath $instrumentedNode`
110+
-ArgumentList "`"$pgoRunAll`" --verbose --duration=$Duration"`
111+
-Wait -PassThru -NoNewWindow
112+
$sw.Stop()
113+
Write-Host ("PGO training completed in {0}m {1}s (exit code: {2})"-f`
114+
$sw.Elapsed.Minutes,$sw.Elapsed.Seconds,$proc.ExitCode)
115+
if ($proc.ExitCode-ne0) {
116+
Write-Warning"PGO training exited with code $($proc.ExitCode) - continuing with merge"
117+
}
118+
119+
# Remove the env var so subsequent builds are not affected
120+
Remove-Item Env:\LLVM_PROFILE_FILE -ErrorAction SilentlyContinue
121+
122+
# ---------------------------------------------------------------------------
123+
# STEP 2 – Merge .profraw files -> node.profdata
124+
# ---------------------------------------------------------------------------
125+
126+
Write-Host"`n=== STEP 2: Merge profile data ==="-ForegroundColor Cyan
127+
128+
Write-Host"Using llvm-profdata: $llvmProfdata"
129+
130+
$profrawFiles=Get-ChildItem-Path $profileDir-Filter "*.profraw"-ErrorAction SilentlyContinue
131+
if ($profrawFiles.Count-eq0) {
132+
Write-Error"No .profraw files found in '$profileDir'. The instrumented binary may not have generated profile data."
133+
exit1
134+
}
135+
136+
$totalSize= ($profrawFiles|Measure-Object-Property Length -Sum).Sum
137+
$totalSizeMB= [math]::Round($totalSize/1MB,1)
138+
Write-Host"Found $($profrawFiles.Count) .profraw file(s), ${totalSizeMB} MB total"
139+
140+
$profdata=Join-Path$PSScriptRoot"node.profdata"
141+
$mergeArgs=@("merge","--output=$profdata") + ($profrawFiles|Select-Object-ExpandProperty FullName)
142+
143+
$mergeStopwatch= [System.Diagnostics.Stopwatch]::StartNew()
144+
&$llvmProfdata@mergeArgs
145+
$mergeExitCode=$LASTEXITCODE
146+
$mergeStopwatch.Stop()
147+
148+
if ($mergeExitCode-ne0) {
149+
Write-Error"llvm-profdata merge failed (exit code $mergeExitCode)"
150+
exit$mergeExitCode
151+
}
152+
153+
$profdataSize= [math]::Round((Get-Item$profdata).Length /1MB,1)
154+
Write-Host"Merge completed in $([math]::Round($mergeStopwatch.Elapsed.TotalSeconds,1))s"
155+
156+
# Clean up .profraw files now that they've been merged
157+
Remove-Item-Recurse -Force $profileDir
158+
Write-Host"Removed $($profrawFiles.Count) .profraw file(s) (${totalSizeMB} MB reclaimed)"
159+
160+
Write-Host"`n=== PGO training complete ==="-ForegroundColor Green
161+
Write-Host" Profile data: $profdata (${profdataSize} MB)"
162+
Write-Host" Next step: vcbuild.bat pgo-use"
‎tools/pgo/README.md‎
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Node.js PGO Training Scripts
2+
3+
Training workloads for Profile-Guided Optimization (PGO) builds using
4+
Clang/LLVM (including Clang-CL on Windows).
5+
6+
## What is PGO?
7+
8+
PGO uses runtime profile data to guide compiler optimizations (inlining,
9+
branch prediction, code layout), typically improving throughput by 5-20%.
10+
11+
The process has three phases:
12+
13+
1.**Instrument** — Build with `-fprofile-generate` (produces `.profraw` files)
14+
2.**Train** — Run representative workloads to collect profile data
15+
3.**Optimize** — Merge `.profraw` → `node.profdata` via `llvm-profdata`,
16+
 then rebuild with `-fprofile-use`
17+
18+
## Quick Start
19+
20+
From a VS Developer Command Prompt:
21+
22+
```powershell
23+
# Step 1: Build the instrumented binary
24+
vcbuild.bat pgo-generate
25+
26+
# Step 2: Run workloads and merge profile data
27+
.\pgo.ps1
28+
29+
# Step 3: Build the optimized binary
30+
vcbuild.bat pgo-use
31+
```
32+
33+
`pgo.ps1` expects the instrumented binary at `Release\node.exe` (produced by
34+
step 1) and writes `node.profdata` to the repo root (consumed by step 3).
35+
36+
```powershell
37+
# Optionally set a longer training duration (default: 15s per script)
38+
.\pgo.ps1 -Duration 30
39+
```
40+
41+
## Training Scripts
42+
43+
All scripts use only Node.js built-in modules (no npm dependencies).
44+
Each script is run as a separate process via `fork()`, producing its own
45+
`.profraw` file.
46+
47+
| Script | What it exercises |
48+
| ------------------------ | ------------------------------------------------------------- |
49+
|`pgo-http-server.js`| llhttp parser, TCP stack, header serialization, JSON, routing |
50+
|`pgo-json.js`| V8 JSON parser/serializer, string allocation, GC pressure |
51+
|`pgo-crypto.js`| OpenSSL (hashing, HMAC, AES, RSA, ECDSA, random, KDF) |
52+
|`pgo-streams-buffers.js`| Buffer C++ impl, stream state machine, back-pressure |
53+
|`pgo-fs.js`| libuv fs operations, thread pool, path module |
54+
|`pgo-async-patterns.js`| V8 Promises, microtask queue, EventEmitter, timers |
55+
|`pgo-url-string.js`| Ada URL parser, V8 string internals, regex JIT |
56+
|`pgo-compression.js`| zlib, brotli C libraries, streaming compression |
57+
|`pgo-net.js`| libuv TCP/pipe handles, c-ares DNS resolver |
58+
|`pgo-module-loading.js`| Module resolver, V8 script compilation, vm module |
59+
|`pgo-child-workers.js`| Worker thread messaging, SharedArrayBuffer, inline eval |
60+
61+
### Running the Orchestrator Directly
62+
63+
The orchestrator can also be invoked directly (e.g. for testing individual
64+
workloads). When used with `pgo.ps1`, this is handled automatically.
65+
66+
```bash
67+
# Run all scripts
68+
node tools/pgo/pgo-run-all.js --duration=15 --verbose
69+
70+
# Run specific scripts
71+
node tools/pgo/pgo-run-all.js --scripts=http-server,json,crypto --duration=30
72+
73+
# Show help
74+
node tools/pgo/pgo-run-all.js --help
75+
```
76+
77+
Each script reads the `PGO_TRAINING_DURATION` environment variable (in
78+
milliseconds) to determine how long to run. The orchestrator sets this
79+
automatically from the `--duration` flag (in seconds).
80+
81+
## Files
82+
83+
```
84+
tools/pgo/
85+
├── pgo-run-all.js # Training orchestrator
86+
├── pgo-http-server.js # HTTP server + client workload
87+
├── pgo-json.js # JSON parse/stringify workload
88+
├── pgo-crypto.js # Crypto operations workload
89+
├── pgo-streams-buffers.js # Streams and Buffer workload
90+
├── pgo-fs.js # File system operations workload
91+
├── pgo-async-patterns.js # Promise/async, EventEmitter, timers workload
92+
├── pgo-url-string.js # URL parsing, string ops, regex workload
93+
├── pgo-compression.js # Gzip/brotli/deflate compression workload
94+
├── pgo-net.js # TCP networking and DNS workload
95+
├── pgo-module-loading.js # Module require/import, VM compilation workload
96+
├── pgo-child-workers.js # Worker threads workload
97+
└── README.md # This file
98+
```
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 1a4f5e5
Browse files
StefanStojanovicaduh95
StefanStojanovic
authored and
aduh95
committed
build,win: add PGO workload scripts
Signed-off-by: StefanStojanovic <stefan.stojanovic@janeasystems.com>
PR-URL: #63696
Refs: #61964
Reviewed-By: Richard Lau <richard.lau@ibm.com>
1 parent 340b983 commit 1a4f5e5
14 files changed
Lines changed: 5643 additions & 0 deletions
‎pgo.ps1‎
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# PGO (Profile-Guided Optimization) training script for Node.js (Clang / LLVM)
2+
#
3+
# Runs PGO training workloads against an instrumented Node.js binary
4+
# (Release\node.exe) and merges the resulting .profraw files into
5+
# node.profdata for use with -fprofile-use.
6+
#
7+
# Usage (from a VS Developer Command Prompt):
8+
# .\pgo.ps1 # Run workloads (15s each) and merge
9+
# .\pgo.ps1 -Duration 30 # Run workloads (30s each) and merge
10+
#
11+
# Prerequisites:
12+
# - Release\node.exe must be an instrumented build (built with pgo-generate)
13+
# - llvm-profdata must be available (shipped with VS LLVM toolset)
14+
#
15+
# Output:
16+
# - node.profdata in the repo root (ready for vcbuild.bat pgo-use)
17+
18+
param(
19+
 [int]$Duration=15
20+
)
21+
22+
Set-StrictMode-Version Latest
23+
$ErrorActionPreference='Stop'
24+
25+
# ---------------------------------------------------------------------------
26+
# Locate llvm-profdata shipped with Visual Studio's LLVM toolset
27+
# ---------------------------------------------------------------------------
28+
29+
functionFind-LlvmProfdata {
30+
# vcbuild.bat uses %VCINSTALLDIR%\Tools\Llvm\x64\bin for clang.exe - same spot for profdata
31+
$vcInstallDir=$env:VCINSTALLDIR
32+
33+
if ($vcInstallDir) {
34+
$candidate=Join-Path$vcInstallDir"Tools\Llvm\x64\bin\llvm-profdata.exe"
35+
if (Test-Path$candidate) {
36+
return$candidate
37+
 }
38+
 }
39+
40+
# Fallback: try VS 2022 / 2026 default install locations
41+
$vsPaths=@(
42+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Enterprise\VC\Tools\Llvm\x64\bin",
43+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Community\VC\Tools\Llvm\x64\bin",
44+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Enterprise\VC\Tools\Llvm\x64\bin",
45+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"
46+
 )
47+
foreach ($dirin$vsPaths) {
48+
$candidate=Join-Path$dir"llvm-profdata.exe"
49+
if (Test-Path$candidate) {
50+
return$candidate
51+
 }
52+
 }
53+
54+
# Last resort: PATH
55+
$fromPath=Get-Command llvm-profdata -ErrorAction SilentlyContinue
56+
if ($fromPath) {
57+
return$fromPath.Source
58+
 }
59+
60+
return$null
61+
}
62+
63+
# ---------------------------------------------------------------------------
64+
# Validate prerequisites
65+
# ---------------------------------------------------------------------------
66+
67+
$instrumentedNode=Join-Path$PSScriptRoot"Release\node.exe"
68+
if (-not (Test-Path$instrumentedNode)) {
69+
Write-Error"Instrumented binary not found: $instrumentedNode`nBuild with: vcbuild.bat pgo-generate"
70+
exit1
71+
}
72+
73+
$pgoRunAll=Join-Path$PSScriptRoot"tools\pgo\pgo-run-all.js"
74+
if (-not (Test-Path$pgoRunAll)) {
75+
Write-Error"PGO training script not found: $pgoRunAll"
76+
exit1
77+
}
78+
79+
$llvmProfdata=Find-LlvmProfdata
80+
if (-not$llvmProfdata) {
81+
Write-Error"llvm-profdata not found. Install the LLVM toolset via Visual Studio Installer."
82+
exit1
83+
}
84+
85+
# ---------------------------------------------------------------------------
86+
# STEP 1 – Run workloads with the instrumented binary to collect profiles
87+
# ---------------------------------------------------------------------------
88+
89+
Write-Host"`n=== STEP 1: Collect PGO profiles ==="-ForegroundColor Cyan
90+
91+
# Directory that will receive .profraw files from the instrumented binary.
92+
# %p (PID) and %m (module hash) keep concurrent/fork'd processes from colliding.
93+
$profileDir=Join-Path$PSScriptRoot"pgo-profiles"
94+
95+
if (Test-Path$profileDir) {
96+
Remove-Item-Recurse -Force $profileDir
97+
}
98+
New-Item-ItemType Directory -Path $profileDir|Out-Null
99+
100+
$env:LLVM_PROFILE_FILE=Join-Path$profileDir"node-%p-%m.profraw"
101+
102+
Write-Host"Instrumented node : $instrumentedNode"
103+
Write-Host"Profile output : $($env:LLVM_PROFILE_FILE)"
104+
Write-Host"Duration per script: ${Duration}s"
105+
Write-Host""
106+
107+
$sw= [System.Diagnostics.Stopwatch]::StartNew()
108+
$proc=Start-Process`
109+
-FilePath $instrumentedNode`
110+
-ArgumentList "`"$pgoRunAll`" --verbose --duration=$Duration"`
111+
-Wait -PassThru -NoNewWindow
112+
$sw.Stop()
113+
Write-Host ("PGO training completed in {0}m {1}s (exit code: {2})"-f`
114+
$sw.Elapsed.Minutes,$sw.Elapsed.Seconds,$proc.ExitCode)
115+
if ($proc.ExitCode-ne0) {
116+
Write-Warning"PGO training exited with code $($proc.ExitCode) - continuing with merge"
117+
}
118+
119+
# Remove the env var so subsequent builds are not affected
120+
Remove-Item Env:\LLVM_PROFILE_FILE -ErrorAction SilentlyContinue
121+
122+
# ---------------------------------------------------------------------------
123+
# STEP 2 – Merge .profraw files -> node.profdata
124+
# ---------------------------------------------------------------------------
125+
126+
Write-Host"`n=== STEP 2: Merge profile data ==="-ForegroundColor Cyan
127+
128+
Write-Host"Using llvm-profdata: $llvmProfdata"
129+
130+
$profrawFiles=Get-ChildItem-Path $profileDir-Filter "*.profraw"-ErrorAction SilentlyContinue
131+
if ($profrawFiles.Count-eq0) {
132+
Write-Error"No .profraw files found in '$profileDir'. The instrumented binary may not have generated profile data."
133+
exit1
134+
}
135+
136+
$totalSize= ($profrawFiles|Measure-Object-Property Length -Sum).Sum
137+
$totalSizeMB= [math]::Round($totalSize/1MB,1)
138+
Write-Host"Found $($profrawFiles.Count) .profraw file(s), ${totalSizeMB} MB total"
139+
140+
$profdata=Join-Path$PSScriptRoot"node.profdata"
141+
$mergeArgs=@("merge","--output=$profdata") + ($profrawFiles|Select-Object-ExpandProperty FullName)
142+
143+
$mergeStopwatch= [System.Diagnostics.Stopwatch]::StartNew()
144+
&$llvmProfdata@mergeArgs
145+
$mergeExitCode=$LASTEXITCODE
146+
$mergeStopwatch.Stop()
147+
148+
if ($mergeExitCode-ne0) {
149+
Write-Error"llvm-profdata merge failed (exit code $mergeExitCode)"
150+
exit$mergeExitCode
151+
}
152+
153+
$profdataSize= [math]::Round((Get-Item$profdata).Length /1MB,1)
154+
Write-Host"Merge completed in $([math]::Round($mergeStopwatch.Elapsed.TotalSeconds,1))s"
155+
156+
# Clean up .profraw files now that they've been merged
157+
Remove-Item-Recurse -Force $profileDir
158+
Write-Host"Removed $($profrawFiles.Count) .profraw file(s) (${totalSizeMB} MB reclaimed)"
159+
160+
Write-Host"`n=== PGO training complete ==="-ForegroundColor Green
161+
Write-Host" Profile data: $profdata (${profdataSize} MB)"
162+
Write-Host" Next step: vcbuild.bat pgo-use"
‎tools/pgo/README.md‎
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Node.js PGO Training Scripts
2+
3+
Training workloads for Profile-Guided Optimization (PGO) builds using
4+
Clang/LLVM (including Clang-CL on Windows).
5+
6+
## What is PGO?
7+
8+
PGO uses runtime profile data to guide compiler optimizations (inlining,
9+
branch prediction, code layout), typically improving throughput by 5-20%.
10+
11+
The process has three phases:
12+
13+
1.**Instrument** — Build with `-fprofile-generate` (produces `.profraw` files)
14+
2.**Train** — Run representative workloads to collect profile data
15+
3.**Optimize** — Merge `.profraw` → `node.profdata` via `llvm-profdata`,
16+
 then rebuild with `-fprofile-use`
17+
18+
## Quick Start
19+
20+
From a VS Developer Command Prompt:
21+
22+
```powershell
23+
# Step 1: Build the instrumented binary
24+
vcbuild.bat pgo-generate
25+
26+
# Step 2: Run workloads and merge profile data
27+
.\pgo.ps1
28+
29+
# Step 3: Build the optimized binary
30+
vcbuild.bat pgo-use
31+
```
32+
33+
`pgo.ps1` expects the instrumented binary at `Release\node.exe` (produced by
34+
step 1) and writes `node.profdata` to the repo root (consumed by step 3).
35+
36+
```powershell
37+
# Optionally set a longer training duration (default: 15s per script)
38+
.\pgo.ps1 -Duration 30
39+
```
40+
41+
## Training Scripts
42+
43+
All scripts use only Node.js built-in modules (no npm dependencies).
44+
Each script is run as a separate process via `fork()`, producing its own
45+
`.profraw` file.
46+
47+
| Script | What it exercises |
48+
| ------------------------ | ------------------------------------------------------------- |
49+
|`pgo-http-server.js`| llhttp parser, TCP stack, header serialization, JSON, routing |
50+
|`pgo-json.js`| V8 JSON parser/serializer, string allocation, GC pressure |
51+
|`pgo-crypto.js`| OpenSSL (hashing, HMAC, AES, RSA, ECDSA, random, KDF) |
52+
|`pgo-streams-buffers.js`| Buffer C++ impl, stream state machine, back-pressure |
53+
|`pgo-fs.js`| libuv fs operations, thread pool, path module |
54+
|`pgo-async-patterns.js`| V8 Promises, microtask queue, EventEmitter, timers |
55+
|`pgo-url-string.js`| Ada URL parser, V8 string internals, regex JIT |
56+
|`pgo-compression.js`| zlib, brotli C libraries, streaming compression |
57+
|`pgo-net.js`| libuv TCP/pipe handles, c-ares DNS resolver |
58+
|`pgo-module-loading.js`| Module resolver, V8 script compilation, vm module |
59+
|`pgo-child-workers.js`| Worker thread messaging, SharedArrayBuffer, inline eval |
60+
61+
### Running the Orchestrator Directly
62+
63+
The orchestrator can also be invoked directly (e.g. for testing individual
64+
workloads). When used with `pgo.ps1`, this is handled automatically.
65+
66+
```bash
67+
# Run all scripts
68+
node tools/pgo/pgo-run-all.js --duration=15 --verbose
69+
70+
# Run specific scripts
71+
node tools/pgo/pgo-run-all.js --scripts=http-server,json,crypto --duration=30
72+
73+
# Show help
74+
node tools/pgo/pgo-run-all.js --help
75+
```
76+
77+
Each script reads the `PGO_TRAINING_DURATION` environment variable (in
78+
milliseconds) to determine how long to run. The orchestrator sets this
79+
automatically from the `--duration` flag (in seconds).
80+
81+
## Files
82+
83+
```
84+
tools/pgo/
85+
├── pgo-run-all.js # Training orchestrator
86+
├── pgo-http-server.js # HTTP server + client workload
87+
├── pgo-json.js # JSON parse/stringify workload
88+
├── pgo-crypto.js # Crypto operations workload
89+
├── pgo-streams-buffers.js # Streams and Buffer workload
90+
├── pgo-fs.js # File system operations workload
91+
├── pgo-async-patterns.js # Promise/async, EventEmitter, timers workload
92+
├── pgo-url-string.js # URL parsing, string ops, regex workload
93+
├── pgo-compression.js # Gzip/brotli/deflate compression workload
94+
├── pgo-net.js # TCP networking and DNS workload
95+
├── pgo-module-loading.js # Module require/import, VM compilation workload
96+
├── pgo-child-workers.js # Worker threads workload
97+
└── README.md # This file
98+
```
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Commit 1a4f5e5
Browse files
StefanStojanovicaduh95
StefanStojanovic
authored and
aduh95
committed
build,win: add PGO workload scripts
Signed-off-by: StefanStojanovic <stefan.stojanovic@janeasystems.com>
PR-URL: #63696
Refs: #61964
Reviewed-By: Richard Lau <richard.lau@ibm.com>
1 parent 340b983 commit 1a4f5e5
14 files changed
Lines changed: 5643 additions & 0 deletions
‎pgo.ps1‎
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# PGO (Profile-Guided Optimization) training script for Node.js (Clang / LLVM)
2+
#
3+
# Runs PGO training workloads against an instrumented Node.js binary
4+
# (Release\node.exe) and merges the resulting .profraw files into
5+
# node.profdata for use with -fprofile-use.
6+
#
7+
# Usage (from a VS Developer Command Prompt):
8+
# .\pgo.ps1 # Run workloads (15s each) and merge
9+
# .\pgo.ps1 -Duration 30 # Run workloads (30s each) and merge
10+
#
11+
# Prerequisites:
12+
# - Release\node.exe must be an instrumented build (built with pgo-generate)
13+
# - llvm-profdata must be available (shipped with VS LLVM toolset)
14+
#
15+
# Output:
16+
# - node.profdata in the repo root (ready for vcbuild.bat pgo-use)
17+
18+
param(
19+
 [int]$Duration=15
20+
)
21+
22+
Set-StrictMode-Version Latest
23+
$ErrorActionPreference='Stop'
24+
25+
# ---------------------------------------------------------------------------
26+
# Locate llvm-profdata shipped with Visual Studio's LLVM toolset
27+
# ---------------------------------------------------------------------------
28+
29+
functionFind-LlvmProfdata {
30+
# vcbuild.bat uses %VCINSTALLDIR%\Tools\Llvm\x64\bin for clang.exe - same spot for profdata
31+
$vcInstallDir=$env:VCINSTALLDIR
32+
33+
if ($vcInstallDir) {
34+
$candidate=Join-Path$vcInstallDir"Tools\Llvm\x64\bin\llvm-profdata.exe"
35+
if (Test-Path$candidate) {
36+
return$candidate
37+
 }
38+
 }
39+
40+
# Fallback: try VS 2022 / 2026 default install locations
41+
$vsPaths=@(
42+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Enterprise\VC\Tools\Llvm\x64\bin",
43+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Community\VC\Tools\Llvm\x64\bin",
44+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Enterprise\VC\Tools\Llvm\x64\bin",
45+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"
46+
 )
47+
foreach ($dirin$vsPaths) {
48+
$candidate=Join-Path$dir"llvm-profdata.exe"
49+
if (Test-Path$candidate) {
50+
return$candidate
51+
 }
52+
 }
53+
54+
# Last resort: PATH
55+
$fromPath=Get-Command llvm-profdata -ErrorAction SilentlyContinue
56+
if ($fromPath) {
57+
return$fromPath.Source
58+
 }
59+
60+
return$null
61+
}
62+
63+
# ---------------------------------------------------------------------------
64+
# Validate prerequisites
65+
# ---------------------------------------------------------------------------
66+
67+
$instrumentedNode=Join-Path$PSScriptRoot"Release\node.exe"
68+
if (-not (Test-Path$instrumentedNode)) {
69+
Write-Error"Instrumented binary not found: $instrumentedNode`nBuild with: vcbuild.bat pgo-generate"
70+
exit1
71+
}
72+
73+
$pgoRunAll=Join-Path$PSScriptRoot"tools\pgo\pgo-run-all.js"
74+
if (-not (Test-Path$pgoRunAll)) {
75+
Write-Error"PGO training script not found: $pgoRunAll"
76+
exit1
77+
}
78+
79+
$llvmProfdata=Find-LlvmProfdata
80+
if (-not$llvmProfdata) {
81+
Write-Error"llvm-profdata not found. Install the LLVM toolset via Visual Studio Installer."
82+
exit1
83+
}
84+
85+
# ---------------------------------------------------------------------------
86+
# STEP 1 – Run workloads with the instrumented binary to collect profiles
87+
# ---------------------------------------------------------------------------
88+
89+
Write-Host"`n=== STEP 1: Collect PGO profiles ==="-ForegroundColor Cyan
90+
91+
# Directory that will receive .profraw files from the instrumented binary.
92+
# %p (PID) and %m (module hash) keep concurrent/fork'd processes from colliding.
93+
$profileDir=Join-Path$PSScriptRoot"pgo-profiles"
94+
95+
if (Test-Path$profileDir) {
96+
Remove-Item-Recurse -Force $profileDir
97+
}
98+
New-Item-ItemType Directory -Path $profileDir|Out-Null
99+
100+
$env:LLVM_PROFILE_FILE=Join-Path$profileDir"node-%p-%m.profraw"
101+
102+
Write-Host"Instrumented node : $instrumentedNode"
103+
Write-Host"Profile output : $($env:LLVM_PROFILE_FILE)"
104+
Write-Host"Duration per script: ${Duration}s"
105+
Write-Host""
106+
107+
$sw= [System.Diagnostics.Stopwatch]::StartNew()
108+
$proc=Start-Process`
109+
-FilePath $instrumentedNode`
110+
-ArgumentList "`"$pgoRunAll`" --verbose --duration=$Duration"`
111+
-Wait -PassThru -NoNewWindow
112+
$sw.Stop()
113+
Write-Host ("PGO training completed in {0}m {1}s (exit code: {2})"-f`
114+
$sw.Elapsed.Minutes,$sw.Elapsed.Seconds,$proc.ExitCode)
115+
if ($proc.ExitCode-ne0) {
116+
Write-Warning"PGO training exited with code $($proc.ExitCode) - continuing with merge"
117+
}
118+
119+
# Remove the env var so subsequent builds are not affected
120+
Remove-Item Env:\LLVM_PROFILE_FILE -ErrorAction SilentlyContinue
121+
122+
# ---------------------------------------------------------------------------
123+
# STEP 2 – Merge .profraw files -> node.profdata
124+
# ---------------------------------------------------------------------------
125+
126+
Write-Host"`n=== STEP 2: Merge profile data ==="-ForegroundColor Cyan
127+
128+
Write-Host"Using llvm-profdata: $llvmProfdata"
129+
130+
$profrawFiles=Get-ChildItem-Path $profileDir-Filter "*.profraw"-ErrorAction SilentlyContinue
131+
if ($profrawFiles.Count-eq0) {
132+
Write-Error"No .profraw files found in '$profileDir'. The instrumented binary may not have generated profile data."
133+
exit1
134+
}
135+
136+
$totalSize= ($profrawFiles|Measure-Object-Property Length -Sum).Sum
137+
$totalSizeMB= [math]::Round($totalSize/1MB,1)
138+
Write-Host"Found $($profrawFiles.Count) .profraw file(s), ${totalSizeMB} MB total"
139+
140+
$profdata=Join-Path$PSScriptRoot"node.profdata"
141+
$mergeArgs=@("merge","--output=$profdata") + ($profrawFiles|Select-Object-ExpandProperty FullName)
142+
143+
$mergeStopwatch= [System.Diagnostics.Stopwatch]::StartNew()
144+
&$llvmProfdata@mergeArgs
145+
$mergeExitCode=$LASTEXITCODE
146+
$mergeStopwatch.Stop()
147+
148+
if ($mergeExitCode-ne0) {
149+
Write-Error"llvm-profdata merge failed (exit code $mergeExitCode)"
150+
exit$mergeExitCode
151+
}
152+
153+
$profdataSize= [math]::Round((Get-Item$profdata).Length /1MB,1)
154+
Write-Host"Merge completed in $([math]::Round($mergeStopwatch.Elapsed.TotalSeconds,1))s"
155+
156+
# Clean up .profraw files now that they've been merged
157+
Remove-Item-Recurse -Force $profileDir
158+
Write-Host"Removed $($profrawFiles.Count) .profraw file(s) (${totalSizeMB} MB reclaimed)"
159+
160+
Write-Host"`n=== PGO training complete ==="-ForegroundColor Green
161+
Write-Host" Profile data: $profdata (${profdataSize} MB)"
162+
Write-Host" Next step: vcbuild.bat pgo-use"
‎tools/pgo/README.md‎
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Node.js PGO Training Scripts
2+
3+
Training workloads for Profile-Guided Optimization (PGO) builds using
4+
Clang/LLVM (including Clang-CL on Windows).
5+
6+
## What is PGO?
7+
8+
PGO uses runtime profile data to guide compiler optimizations (inlining,
9+
branch prediction, code layout), typically improving throughput by 5-20%.
10+
11+
The process has three phases:
12+
13+
1.**Instrument** — Build with `-fprofile-generate` (produces `.profraw` files)
14+
2.**Train** — Run representative workloads to collect profile data
15+
3.**Optimize** — Merge `.profraw` → `node.profdata` via `llvm-profdata`,
16+
 then rebuild with `-fprofile-use`
17+
18+
## Quick Start
19+
20+
From a VS Developer Command Prompt:
21+
22+
```powershell
23+
# Step 1: Build the instrumented binary
24+
vcbuild.bat pgo-generate
25+
26+
# Step 2: Run workloads and merge profile data
27+
.\pgo.ps1
28+
29+
# Step 3: Build the optimized binary
30+
vcbuild.bat pgo-use
31+
```
32+
33+
`pgo.ps1` expects the instrumented binary at `Release\node.exe` (produced by
34+
step 1) and writes `node.profdata` to the repo root (consumed by step 3).
35+
36+
```powershell
37+
# Optionally set a longer training duration (default: 15s per script)
38+
.\pgo.ps1 -Duration 30
39+
```
40+
41+
## Training Scripts
42+
43+
All scripts use only Node.js built-in modules (no npm dependencies).
44+
Each script is run as a separate process via `fork()`, producing its own
45+
`.profraw` file.
46+
47+
| Script | What it exercises |
48+
| ------------------------ | ------------------------------------------------------------- |
49+
|`pgo-http-server.js`| llhttp parser, TCP stack, header serialization, JSON, routing |
50+
|`pgo-json.js`| V8 JSON parser/serializer, string allocation, GC pressure |
51+
|`pgo-crypto.js`| OpenSSL (hashing, HMAC, AES, RSA, ECDSA, random, KDF) |
52+
|`pgo-streams-buffers.js`| Buffer C++ impl, stream state machine, back-pressure |
53+
|`pgo-fs.js`| libuv fs operations, thread pool, path module |
54+
|`pgo-async-patterns.js`| V8 Promises, microtask queue, EventEmitter, timers |
55+
|`pgo-url-string.js`| Ada URL parser, V8 string internals, regex JIT |
56+
|`pgo-compression.js`| zlib, brotli C libraries, streaming compression |
57+
|`pgo-net.js`| libuv TCP/pipe handles, c-ares DNS resolver |
58+
|`pgo-module-loading.js`| Module resolver, V8 script compilation, vm module |
59+
|`pgo-child-workers.js`| Worker thread messaging, SharedArrayBuffer, inline eval |
60+
61+
### Running the Orchestrator Directly
62+
63+
The orchestrator can also be invoked directly (e.g. for testing individual
64+
workloads). When used with `pgo.ps1`, this is handled automatically.
65+
66+
```bash
67+
# Run all scripts
68+
node tools/pgo/pgo-run-all.js --duration=15 --verbose
69+
70+
# Run specific scripts
71+
node tools/pgo/pgo-run-all.js --scripts=http-server,json,crypto --duration=30
72+
73+
# Show help
74+
node tools/pgo/pgo-run-all.js --help
75+
```
76+
77+
Each script reads the `PGO_TRAINING_DURATION` environment variable (in
78+
milliseconds) to determine how long to run. The orchestrator sets this
79+
automatically from the `--duration` flag (in seconds).
80+
81+
## Files
82+
83+
```
84+
tools/pgo/
85+
├── pgo-run-all.js # Training orchestrator
86+
├── pgo-http-server.js # HTTP server + client workload
87+
├── pgo-json.js # JSON parse/stringify workload
88+
├── pgo-crypto.js # Crypto operations workload
89+
├── pgo-streams-buffers.js # Streams and Buffer workload
90+
├── pgo-fs.js # File system operations workload
91+
├── pgo-async-patterns.js # Promise/async, EventEmitter, timers workload
92+
├── pgo-url-string.js # URL parsing, string ops, regex workload
93+
├── pgo-compression.js # Gzip/brotli/deflate compression workload
94+
├── pgo-net.js # TCP networking and DNS workload
95+
├── pgo-module-loading.js # Module require/import, VM compilation workload
96+
├── pgo-child-workers.js # Worker threads workload
97+
└── README.md # This file
98+
```
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 1a4f5e5
Browse files
StefanStojanovicaduh95
StefanStojanovic
authored and
aduh95
committed
build,win: add PGO workload scripts
Signed-off-by: StefanStojanovic <stefan.stojanovic@janeasystems.com>
PR-URL: #63696
Refs: #61964
Reviewed-By: Richard Lau <richard.lau@ibm.com>
1 parent 340b983 commit 1a4f5e5
14 files changed
Lines changed: 5643 additions & 0 deletions
‎pgo.ps1‎
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# PGO (Profile-Guided Optimization) training script for Node.js (Clang / LLVM)
2+
#
3+
# Runs PGO training workloads against an instrumented Node.js binary
4+
# (Release\node.exe) and merges the resulting .profraw files into
5+
# node.profdata for use with -fprofile-use.
6+
#
7+
# Usage (from a VS Developer Command Prompt):
8+
# .\pgo.ps1 # Run workloads (15s each) and merge
9+
# .\pgo.ps1 -Duration 30 # Run workloads (30s each) and merge
10+
#
11+
# Prerequisites:
12+
# - Release\node.exe must be an instrumented build (built with pgo-generate)
13+
# - llvm-profdata must be available (shipped with VS LLVM toolset)
14+
#
15+
# Output:
16+
# - node.profdata in the repo root (ready for vcbuild.bat pgo-use)
17+
18+
param(
19+
 [int]$Duration=15
20+
)
21+
22+
Set-StrictMode-Version Latest
23+
$ErrorActionPreference='Stop'
24+
25+
# ---------------------------------------------------------------------------
26+
# Locate llvm-profdata shipped with Visual Studio's LLVM toolset
27+
# ---------------------------------------------------------------------------
28+
29+
functionFind-LlvmProfdata {
30+
# vcbuild.bat uses %VCINSTALLDIR%\Tools\Llvm\x64\bin for clang.exe - same spot for profdata
31+
$vcInstallDir=$env:VCINSTALLDIR
32+
33+
if ($vcInstallDir) {
34+
$candidate=Join-Path$vcInstallDir"Tools\Llvm\x64\bin\llvm-profdata.exe"
35+
if (Test-Path$candidate) {
36+
return$candidate
37+
 }
38+
 }
39+
40+
# Fallback: try VS 2022 / 2026 default install locations
41+
$vsPaths=@(
42+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Enterprise\VC\Tools\Llvm\x64\bin",
43+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Community\VC\Tools\Llvm\x64\bin",
44+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Enterprise\VC\Tools\Llvm\x64\bin",
45+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"
46+
 )
47+
foreach ($dirin$vsPaths) {
48+
$candidate=Join-Path$dir"llvm-profdata.exe"
49+
if (Test-Path$candidate) {
50+
return$candidate
51+
 }
52+
 }
53+
54+
# Last resort: PATH
55+
$fromPath=Get-Command llvm-profdata -ErrorAction SilentlyContinue
56+
if ($fromPath) {
57+
return$fromPath.Source
58+
 }
59+
60+
return$null
61+
}
62+
63+
# ---------------------------------------------------------------------------
64+
# Validate prerequisites
65+
# ---------------------------------------------------------------------------
66+
67+
$instrumentedNode=Join-Path$PSScriptRoot"Release\node.exe"
68+
if (-not (Test-Path$instrumentedNode)) {
69+
Write-Error"Instrumented binary not found: $instrumentedNode`nBuild with: vcbuild.bat pgo-generate"
70+
exit1
71+
}
72+
73+
$pgoRunAll=Join-Path$PSScriptRoot"tools\pgo\pgo-run-all.js"
74+
if (-not (Test-Path$pgoRunAll)) {
75+
Write-Error"PGO training script not found: $pgoRunAll"
76+
exit1
77+
}
78+
79+
$llvmProfdata=Find-LlvmProfdata
80+
if (-not$llvmProfdata) {
81+
Write-Error"llvm-profdata not found. Install the LLVM toolset via Visual Studio Installer."
82+
exit1
83+
}
84+
85+
# ---------------------------------------------------------------------------
86+
# STEP 1 – Run workloads with the instrumented binary to collect profiles
87+
# ---------------------------------------------------------------------------
88+
89+
Write-Host"`n=== STEP 1: Collect PGO profiles ==="-ForegroundColor Cyan
90+
91+
# Directory that will receive .profraw files from the instrumented binary.
92+
# %p (PID) and %m (module hash) keep concurrent/fork'd processes from colliding.
93+
$profileDir=Join-Path$PSScriptRoot"pgo-profiles"
94+
95+
if (Test-Path$profileDir) {
96+
Remove-Item-Recurse -Force $profileDir
97+
}
98+
New-Item-ItemType Directory -Path $profileDir|Out-Null
99+
100+
$env:LLVM_PROFILE_FILE=Join-Path$profileDir"node-%p-%m.profraw"
101+
102+
Write-Host"Instrumented node : $instrumentedNode"
103+
Write-Host"Profile output : $($env:LLVM_PROFILE_FILE)"
104+
Write-Host"Duration per script: ${Duration}s"
105+
Write-Host""
106+
107+
$sw= [System.Diagnostics.Stopwatch]::StartNew()
108+
$proc=Start-Process`
109+
-FilePath $instrumentedNode`
110+
-ArgumentList "`"$pgoRunAll`" --verbose --duration=$Duration"`
111+
-Wait -PassThru -NoNewWindow
112+
$sw.Stop()
113+
Write-Host ("PGO training completed in {0}m {1}s (exit code: {2})"-f`
114+
$sw.Elapsed.Minutes,$sw.Elapsed.Seconds,$proc.ExitCode)
115+
if ($proc.ExitCode-ne0) {
116+
Write-Warning"PGO training exited with code $($proc.ExitCode) - continuing with merge"
117+
}
118+
119+
# Remove the env var so subsequent builds are not affected
120+
Remove-Item Env:\LLVM_PROFILE_FILE -ErrorAction SilentlyContinue
121+
122+
# ---------------------------------------------------------------------------
123+
# STEP 2 – Merge .profraw files -> node.profdata
124+
# ---------------------------------------------------------------------------
125+
126+
Write-Host"`n=== STEP 2: Merge profile data ==="-ForegroundColor Cyan
127+
128+
Write-Host"Using llvm-profdata: $llvmProfdata"
129+
130+
$profrawFiles=Get-ChildItem-Path $profileDir-Filter "*.profraw"-ErrorAction SilentlyContinue
131+
if ($profrawFiles.Count-eq0) {
132+
Write-Error"No .profraw files found in '$profileDir'. The instrumented binary may not have generated profile data."
133+
exit1
134+
}
135+
136+
$totalSize= ($profrawFiles|Measure-Object-Property Length -Sum).Sum
137+
$totalSizeMB= [math]::Round($totalSize/1MB,1)
138+
Write-Host"Found $($profrawFiles.Count) .profraw file(s), ${totalSizeMB} MB total"
139+
140+
$profdata=Join-Path$PSScriptRoot"node.profdata"
141+
$mergeArgs=@("merge","--output=$profdata") + ($profrawFiles|Select-Object-ExpandProperty FullName)
142+
143+
$mergeStopwatch= [System.Diagnostics.Stopwatch]::StartNew()
144+
&$llvmProfdata@mergeArgs
145+
$mergeExitCode=$LASTEXITCODE
146+
$mergeStopwatch.Stop()
147+
148+
if ($mergeExitCode-ne0) {
149+
Write-Error"llvm-profdata merge failed (exit code $mergeExitCode)"
150+
exit$mergeExitCode
151+
}
152+
153+
$profdataSize= [math]::Round((Get-Item$profdata).Length /1MB,1)
154+
Write-Host"Merge completed in $([math]::Round($mergeStopwatch.Elapsed.TotalSeconds,1))s"
155+
156+
# Clean up .profraw files now that they've been merged
157+
Remove-Item-Recurse -Force $profileDir
158+
Write-Host"Removed $($profrawFiles.Count) .profraw file(s) (${totalSizeMB} MB reclaimed)"
159+
160+
Write-Host"`n=== PGO training complete ==="-ForegroundColor Green
161+
Write-Host" Profile data: $profdata (${profdataSize} MB)"
162+
Write-Host" Next step: vcbuild.bat pgo-use"
‎tools/pgo/README.md‎
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Node.js PGO Training Scripts
2+
3+
Training workloads for Profile-Guided Optimization (PGO) builds using
4+
Clang/LLVM (including Clang-CL on Windows).
5+
6+
## What is PGO?
7+
8+
PGO uses runtime profile data to guide compiler optimizations (inlining,
9+
branch prediction, code layout), typically improving throughput by 5-20%.
10+
11+
The process has three phases:
12+
13+
1.**Instrument** — Build with `-fprofile-generate` (produces `.profraw` files)
14+
2.**Train** — Run representative workloads to collect profile data
15+
3.**Optimize** — Merge `.profraw` → `node.profdata` via `llvm-profdata`,
16+
 then rebuild with `-fprofile-use`
17+
18+
## Quick Start
19+
20+
From a VS Developer Command Prompt:
21+
22+
```powershell
23+
# Step 1: Build the instrumented binary
24+
vcbuild.bat pgo-generate
25+
26+
# Step 2: Run workloads and merge profile data
27+
.\pgo.ps1
28+
29+
# Step 3: Build the optimized binary
30+
vcbuild.bat pgo-use
31+
```
32+
33+
`pgo.ps1` expects the instrumented binary at `Release\node.exe` (produced by
34+
step 1) and writes `node.profdata` to the repo root (consumed by step 3).
35+
36+
```powershell
37+
# Optionally set a longer training duration (default: 15s per script)
38+
.\pgo.ps1 -Duration 30
39+
```
40+
41+
## Training Scripts
42+
43+
All scripts use only Node.js built-in modules (no npm dependencies).
44+
Each script is run as a separate process via `fork()`, producing its own
45+
`.profraw` file.
46+
47+
| Script | What it exercises |
48+
| ------------------------ | ------------------------------------------------------------- |
49+
|`pgo-http-server.js`| llhttp parser, TCP stack, header serialization, JSON, routing |
50+
|`pgo-json.js`| V8 JSON parser/serializer, string allocation, GC pressure |
51+
|`pgo-crypto.js`| OpenSSL (hashing, HMAC, AES, RSA, ECDSA, random, KDF) |
52+
|`pgo-streams-buffers.js`| Buffer C++ impl, stream state machine, back-pressure |
53+
|`pgo-fs.js`| libuv fs operations, thread pool, path module |
54+
|`pgo-async-patterns.js`| V8 Promises, microtask queue, EventEmitter, timers |
55+
|`pgo-url-string.js`| Ada URL parser, V8 string internals, regex JIT |
56+
|`pgo-compression.js`| zlib, brotli C libraries, streaming compression |
57+
|`pgo-net.js`| libuv TCP/pipe handles, c-ares DNS resolver |
58+
|`pgo-module-loading.js`| Module resolver, V8 script compilation, vm module |
59+
|`pgo-child-workers.js`| Worker thread messaging, SharedArrayBuffer, inline eval |
60+
61+
### Running the Orchestrator Directly
62+
63+
The orchestrator can also be invoked directly (e.g. for testing individual
64+
workloads). When used with `pgo.ps1`, this is handled automatically.
65+
66+
```bash
67+
# Run all scripts
68+
node tools/pgo/pgo-run-all.js --duration=15 --verbose
69+
70+
# Run specific scripts
71+
node tools/pgo/pgo-run-all.js --scripts=http-server,json,crypto --duration=30
72+
73+
# Show help
74+
node tools/pgo/pgo-run-all.js --help
75+
```
76+
77+
Each script reads the `PGO_TRAINING_DURATION` environment variable (in
78+
milliseconds) to determine how long to run. The orchestrator sets this
79+
automatically from the `--duration` flag (in seconds).
80+
81+
## Files
82+
83+
```
84+
tools/pgo/
85+
├── pgo-run-all.js # Training orchestrator
86+
├── pgo-http-server.js # HTTP server + client workload
87+
├── pgo-json.js # JSON parse/stringify workload
88+
├── pgo-crypto.js # Crypto operations workload
89+
├── pgo-streams-buffers.js # Streams and Buffer workload
90+
├── pgo-fs.js # File system operations workload
91+
├── pgo-async-patterns.js # Promise/async, EventEmitter, timers workload
92+
├── pgo-url-string.js # URL parsing, string ops, regex workload
93+
├── pgo-compression.js # Gzip/brotli/deflate compression workload
94+
├── pgo-net.js # TCP networking and DNS workload
95+
├── pgo-module-loading.js # Module require/import, VM compilation workload
96+
├── pgo-child-workers.js # Worker threads workload
97+
└── README.md # This file
98+
```
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 1a4f5e5
Browse files
StefanStojanovicaduh95
StefanStojanovic
authored and
aduh95
committed
build,win: add PGO workload scripts
Signed-off-by: StefanStojanovic <stefan.stojanovic@janeasystems.com>
PR-URL: #63696
Refs: #61964
Reviewed-By: Richard Lau <richard.lau@ibm.com>
1 parent 340b983 commit 1a4f5e5
14 files changed
Lines changed: 5643 additions & 0 deletions
‎pgo.ps1‎
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# PGO (Profile-Guided Optimization) training script for Node.js (Clang / LLVM)
2+
#
3+
# Runs PGO training workloads against an instrumented Node.js binary
4+
# (Release\node.exe) and merges the resulting .profraw files into
5+
# node.profdata for use with -fprofile-use.
6+
#
7+
# Usage (from a VS Developer Command Prompt):
8+
# .\pgo.ps1 # Run workloads (15s each) and merge
9+
# .\pgo.ps1 -Duration 30 # Run workloads (30s each) and merge
10+
#
11+
# Prerequisites:
12+
# - Release\node.exe must be an instrumented build (built with pgo-generate)
13+
# - llvm-profdata must be available (shipped with VS LLVM toolset)
14+
#
15+
# Output:
16+
# - node.profdata in the repo root (ready for vcbuild.bat pgo-use)
17+
18+
param(
19+
 [int]$Duration=15
20+
)
21+
22+
Set-StrictMode-Version Latest
23+
$ErrorActionPreference='Stop'
24+
25+
# ---------------------------------------------------------------------------
26+
# Locate llvm-profdata shipped with Visual Studio's LLVM toolset
27+
# ---------------------------------------------------------------------------
28+
29+
functionFind-LlvmProfdata {
30+
# vcbuild.bat uses %VCINSTALLDIR%\Tools\Llvm\x64\bin for clang.exe - same spot for profdata
31+
$vcInstallDir=$env:VCINSTALLDIR
32+
33+
if ($vcInstallDir) {
34+
$candidate=Join-Path$vcInstallDir"Tools\Llvm\x64\bin\llvm-profdata.exe"
35+
if (Test-Path$candidate) {
36+
return$candidate
37+
 }
38+
 }
39+
40+
# Fallback: try VS 2022 / 2026 default install locations
41+
$vsPaths=@(
42+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Enterprise\VC\Tools\Llvm\x64\bin",
43+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Community\VC\Tools\Llvm\x64\bin",
44+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Enterprise\VC\Tools\Llvm\x64\bin",
45+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"
46+
 )
47+
foreach ($dirin$vsPaths) {
48+
$candidate=Join-Path$dir"llvm-profdata.exe"
49+
if (Test-Path$candidate) {
50+
return$candidate
51+
 }
52+
 }
53+
54+
# Last resort: PATH
55+
$fromPath=Get-Command llvm-profdata -ErrorAction SilentlyContinue
56+
if ($fromPath) {
57+
return$fromPath.Source
58+
 }
59+
60+
return$null
61+
}
62+
63+
# ---------------------------------------------------------------------------
64+
# Validate prerequisites
65+
# ---------------------------------------------------------------------------
66+
67+
$instrumentedNode=Join-Path$PSScriptRoot"Release\node.exe"
68+
if (-not (Test-Path$instrumentedNode)) {
69+
Write-Error"Instrumented binary not found: $instrumentedNode`nBuild with: vcbuild.bat pgo-generate"
70+
exit1
71+
}
72+
73+
$pgoRunAll=Join-Path$PSScriptRoot"tools\pgo\pgo-run-all.js"
74+
if (-not (Test-Path$pgoRunAll)) {
75+
Write-Error"PGO training script not found: $pgoRunAll"
76+
exit1
77+
}
78+
79+
$llvmProfdata=Find-LlvmProfdata
80+
if (-not$llvmProfdata) {
81+
Write-Error"llvm-profdata not found. Install the LLVM toolset via Visual Studio Installer."
82+
exit1
83+
}
84+
85+
# ---------------------------------------------------------------------------
86+
# STEP 1 – Run workloads with the instrumented binary to collect profiles
87+
# ---------------------------------------------------------------------------
88+
89+
Write-Host"`n=== STEP 1: Collect PGO profiles ==="-ForegroundColor Cyan
90+
91+
# Directory that will receive .profraw files from the instrumented binary.
92+
# %p (PID) and %m (module hash) keep concurrent/fork'd processes from colliding.
93+
$profileDir=Join-Path$PSScriptRoot"pgo-profiles"
94+
95+
if (Test-Path$profileDir) {
96+
Remove-Item-Recurse -Force $profileDir
97+
}
98+
New-Item-ItemType Directory -Path $profileDir|Out-Null
99+
100+
$env:LLVM_PROFILE_FILE=Join-Path$profileDir"node-%p-%m.profraw"
101+
102+
Write-Host"Instrumented node : $instrumentedNode"
103+
Write-Host"Profile output : $($env:LLVM_PROFILE_FILE)"
104+
Write-Host"Duration per script: ${Duration}s"
105+
Write-Host""
106+
107+
$sw= [System.Diagnostics.Stopwatch]::StartNew()
108+
$proc=Start-Process`
109+
-FilePath $instrumentedNode`
110+
-ArgumentList "`"$pgoRunAll`" --verbose --duration=$Duration"`
111+
-Wait -PassThru -NoNewWindow
112+
$sw.Stop()
113+
Write-Host ("PGO training completed in {0}m {1}s (exit code: {2})"-f`
114+
$sw.Elapsed.Minutes,$sw.Elapsed.Seconds,$proc.ExitCode)
115+
if ($proc.ExitCode-ne0) {
116+
Write-Warning"PGO training exited with code $($proc.ExitCode) - continuing with merge"
117+
}
118+
119+
# Remove the env var so subsequent builds are not affected
120+
Remove-Item Env:\LLVM_PROFILE_FILE -ErrorAction SilentlyContinue
121+
122+
# ---------------------------------------------------------------------------
123+
# STEP 2 – Merge .profraw files -> node.profdata
124+
# ---------------------------------------------------------------------------
125+
126+
Write-Host"`n=== STEP 2: Merge profile data ==="-ForegroundColor Cyan
127+
128+
Write-Host"Using llvm-profdata: $llvmProfdata"
129+
130+
$profrawFiles=Get-ChildItem-Path $profileDir-Filter "*.profraw"-ErrorAction SilentlyContinue
131+
if ($profrawFiles.Count-eq0) {
132+
Write-Error"No .profraw files found in '$profileDir'. The instrumented binary may not have generated profile data."
133+
exit1
134+
}
135+
136+
$totalSize= ($profrawFiles|Measure-Object-Property Length -Sum).Sum
137+
$totalSizeMB= [math]::Round($totalSize/1MB,1)
138+
Write-Host"Found $($profrawFiles.Count) .profraw file(s), ${totalSizeMB} MB total"
139+
140+
$profdata=Join-Path$PSScriptRoot"node.profdata"
141+
$mergeArgs=@("merge","--output=$profdata") + ($profrawFiles|Select-Object-ExpandProperty FullName)
142+
143+
$mergeStopwatch= [System.Diagnostics.Stopwatch]::StartNew()
144+
&$llvmProfdata@mergeArgs
145+
$mergeExitCode=$LASTEXITCODE
146+
$mergeStopwatch.Stop()
147+
148+
if ($mergeExitCode-ne0) {
149+
Write-Error"llvm-profdata merge failed (exit code $mergeExitCode)"
150+
exit$mergeExitCode
151+
}
152+
153+
$profdataSize= [math]::Round((Get-Item$profdata).Length /1MB,1)
154+
Write-Host"Merge completed in $([math]::Round($mergeStopwatch.Elapsed.TotalSeconds,1))s"
155+
156+
# Clean up .profraw files now that they've been merged
157+
Remove-Item-Recurse -Force $profileDir
158+
Write-Host"Removed $($profrawFiles.Count) .profraw file(s) (${totalSizeMB} MB reclaimed)"
159+
160+
Write-Host"`n=== PGO training complete ==="-ForegroundColor Green
161+
Write-Host" Profile data: $profdata (${profdataSize} MB)"
162+
Write-Host" Next step: vcbuild.bat pgo-use"
‎tools/pgo/README.md‎
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Node.js PGO Training Scripts
2+
3+
Training workloads for Profile-Guided Optimization (PGO) builds using
4+
Clang/LLVM (including Clang-CL on Windows).
5+
6+
## What is PGO?
7+
8+
PGO uses runtime profile data to guide compiler optimizations (inlining,
9+
branch prediction, code layout), typically improving throughput by 5-20%.
10+
11+
The process has three phases:
12+
13+
1.**Instrument** — Build with `-fprofile-generate` (produces `.profraw` files)
14+
2.**Train** — Run representative workloads to collect profile data
15+
3.**Optimize** — Merge `.profraw` → `node.profdata` via `llvm-profdata`,
16+
 then rebuild with `-fprofile-use`
17+
18+
## Quick Start
19+
20+
From a VS Developer Command Prompt:
21+
22+
```powershell
23+
# Step 1: Build the instrumented binary
24+
vcbuild.bat pgo-generate
25+
26+
# Step 2: Run workloads and merge profile data
27+
.\pgo.ps1
28+
29+
# Step 3: Build the optimized binary
30+
vcbuild.bat pgo-use
31+
```
32+
33+
`pgo.ps1` expects the instrumented binary at `Release\node.exe` (produced by
34+
step 1) and writes `node.profdata` to the repo root (consumed by step 3).
35+
36+
```powershell
37+
# Optionally set a longer training duration (default: 15s per script)
38+
.\pgo.ps1 -Duration 30
39+
```
40+
41+
## Training Scripts
42+
43+
All scripts use only Node.js built-in modules (no npm dependencies).
44+
Each script is run as a separate process via `fork()`, producing its own
45+
`.profraw` file.
46+
47+
| Script | What it exercises |
48+
| ------------------------ | ------------------------------------------------------------- |
49+
|`pgo-http-server.js`| llhttp parser, TCP stack, header serialization, JSON, routing |
50+
|`pgo-json.js`| V8 JSON parser/serializer, string allocation, GC pressure |
51+
|`pgo-crypto.js`| OpenSSL (hashing, HMAC, AES, RSA, ECDSA, random, KDF) |
52+
|`pgo-streams-buffers.js`| Buffer C++ impl, stream state machine, back-pressure |
53+
|`pgo-fs.js`| libuv fs operations, thread pool, path module |
54+
|`pgo-async-patterns.js`| V8 Promises, microtask queue, EventEmitter, timers |
55+
|`pgo-url-string.js`| Ada URL parser, V8 string internals, regex JIT |
56+
|`pgo-compression.js`| zlib, brotli C libraries, streaming compression |
57+
|`pgo-net.js`| libuv TCP/pipe handles, c-ares DNS resolver |
58+
|`pgo-module-loading.js`| Module resolver, V8 script compilation, vm module |
59+
|`pgo-child-workers.js`| Worker thread messaging, SharedArrayBuffer, inline eval |
60+
61+
### Running the Orchestrator Directly
62+
63+
The orchestrator can also be invoked directly (e.g. for testing individual
64+
workloads). When used with `pgo.ps1`, this is handled automatically.
65+
66+
```bash
67+
# Run all scripts
68+
node tools/pgo/pgo-run-all.js --duration=15 --verbose
69+
70+
# Run specific scripts
71+
node tools/pgo/pgo-run-all.js --scripts=http-server,json,crypto --duration=30
72+
73+
# Show help
74+
node tools/pgo/pgo-run-all.js --help
75+
```
76+
77+
Each script reads the `PGO_TRAINING_DURATION` environment variable (in
78+
milliseconds) to determine how long to run. The orchestrator sets this
79+
automatically from the `--duration` flag (in seconds).
80+
81+
## Files
82+
83+
```
84+
tools/pgo/
85+
├── pgo-run-all.js # Training orchestrator
86+
├── pgo-http-server.js # HTTP server + client workload
87+
├── pgo-json.js # JSON parse/stringify workload
88+
├── pgo-crypto.js # Crypto operations workload
89+
├── pgo-streams-buffers.js # Streams and Buffer workload
90+
├── pgo-fs.js # File system operations workload
91+
├── pgo-async-patterns.js # Promise/async, EventEmitter, timers workload
92+
├── pgo-url-string.js # URL parsing, string ops, regex workload
93+
├── pgo-compression.js # Gzip/brotli/deflate compression workload
94+
├── pgo-net.js # TCP networking and DNS workload
95+
├── pgo-module-loading.js # Module require/import, VM compilation workload
96+
├── pgo-child-workers.js # Worker threads workload
97+
└── README.md # This file
98+
```
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Commit 1a4f5e5
Browse files
StefanStojanovicaduh95
StefanStojanovic
authored and
aduh95
committed
build,win: add PGO workload scripts
Signed-off-by: StefanStojanovic <stefan.stojanovic@janeasystems.com>
PR-URL: #63696
Refs: #61964
Reviewed-By: Richard Lau <richard.lau@ibm.com>
1 parent 340b983 commit 1a4f5e5
14 files changed
Lines changed: 5643 additions & 0 deletions
‎pgo.ps1‎
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# PGO (Profile-Guided Optimization) training script for Node.js (Clang / LLVM)
2+
#
3+
# Runs PGO training workloads against an instrumented Node.js binary
4+
# (Release\node.exe) and merges the resulting .profraw files into
5+
# node.profdata for use with -fprofile-use.
6+
#
7+
# Usage (from a VS Developer Command Prompt):
8+
# .\pgo.ps1 # Run workloads (15s each) and merge
9+
# .\pgo.ps1 -Duration 30 # Run workloads (30s each) and merge
10+
#
11+
# Prerequisites:
12+
# - Release\node.exe must be an instrumented build (built with pgo-generate)
13+
# - llvm-profdata must be available (shipped with VS LLVM toolset)
14+
#
15+
# Output:
16+
# - node.profdata in the repo root (ready for vcbuild.bat pgo-use)
17+
18+
param(
19+
 [int]$Duration=15
20+
)
21+
22+
Set-StrictMode-Version Latest
23+
$ErrorActionPreference='Stop'
24+
25+
# ---------------------------------------------------------------------------
26+
# Locate llvm-profdata shipped with Visual Studio's LLVM toolset
27+
# ---------------------------------------------------------------------------
28+
29+
functionFind-LlvmProfdata {
30+
# vcbuild.bat uses %VCINSTALLDIR%\Tools\Llvm\x64\bin for clang.exe - same spot for profdata
31+
$vcInstallDir=$env:VCINSTALLDIR
32+
33+
if ($vcInstallDir) {
34+
$candidate=Join-Path$vcInstallDir"Tools\Llvm\x64\bin\llvm-profdata.exe"
35+
if (Test-Path$candidate) {
36+
return$candidate
37+
 }
38+
 }
39+
40+
# Fallback: try VS 2022 / 2026 default install locations
41+
$vsPaths=@(
42+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Enterprise\VC\Tools\Llvm\x64\bin",
43+
"${env:ProgramFiles}\Microsoft Visual Studio\2026\Community\VC\Tools\Llvm\x64\bin",
44+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Enterprise\VC\Tools\Llvm\x64\bin",
45+
"${env:ProgramFiles}\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"
46+
 )
47+
foreach ($dirin$vsPaths) {
48+
$candidate=Join-Path$dir"llvm-profdata.exe"
49+
if (Test-Path$candidate) {
50+
return$candidate
51+
 }
52+
 }
53+
54+
# Last resort: PATH
55+
$fromPath=Get-Command llvm-profdata -ErrorAction SilentlyContinue
56+
if ($fromPath) {
57+
return$fromPath.Source
58+
 }
59+
60+
return$null
61+
}
62+
63+
# ---------------------------------------------------------------------------
64+
# Validate prerequisites
65+
# ---------------------------------------------------------------------------
66+
67+
$instrumentedNode=Join-Path$PSScriptRoot"Release\node.exe"
68+
if (-not (Test-Path$instrumentedNode)) {
69+
Write-Error"Instrumented binary not found: $instrumentedNode`nBuild with: vcbuild.bat pgo-generate"
70+
exit1
71+
}
72+
73+
$pgoRunAll=Join-Path$PSScriptRoot"tools\pgo\pgo-run-all.js"
74+
if (-not (Test-Path$pgoRunAll)) {
75+
Write-Error"PGO training script not found: $pgoRunAll"
76+
exit1
77+
}
78+
79+
$llvmProfdata=Find-LlvmProfdata
80+
if (-not$llvmProfdata) {
81+
Write-Error"llvm-profdata not found. Install the LLVM toolset via Visual Studio Installer."
82+
exit1
83+
}
84+
85+
# ---------------------------------------------------------------------------
86+
# STEP 1 – Run workloads with the instrumented binary to collect profiles
87+
# ---------------------------------------------------------------------------
88+
89+
Write-Host"`n=== STEP 1: Collect PGO profiles ==="-ForegroundColor Cyan
90+
91+
# Directory that will receive .profraw files from the instrumented binary.
92+
# %p (PID) and %m (module hash) keep concurrent/fork'd processes from colliding.
93+
$profileDir=Join-Path$PSScriptRoot"pgo-profiles"
94+
95+
if (Test-Path$profileDir) {
96+
Remove-Item-Recurse -Force $profileDir
97+
}
98+
New-Item-ItemType Directory -Path $profileDir|Out-Null
99+
100+
$env:LLVM_PROFILE_FILE=Join-Path$profileDir"node-%p-%m.profraw"
101+
102+
Write-Host"Instrumented node : $instrumentedNode"
103+
Write-Host"Profile output : $($env:LLVM_PROFILE_FILE)"
104+
Write-Host"Duration per script: ${Duration}s"
105+
Write-Host""
106+
107+
$sw= [System.Diagnostics.Stopwatch]::StartNew()
108+
$proc=Start-Process`
109+
-FilePath $instrumentedNode`
110+
-ArgumentList "`"$pgoRunAll`" --verbose --duration=$Duration"`
111+
-Wait -PassThru -NoNewWindow
112+
$sw.Stop()
113+
Write-Host ("PGO training completed in {0}m {1}s (exit code: {2})"-f`
114+
$sw.Elapsed.Minutes,$sw.Elapsed.Seconds,$proc.ExitCode)
115+
if ($proc.ExitCode-ne0) {
116+
Write-Warning"PGO training exited with code $($proc.ExitCode) - continuing with merge"
117+
}
118+
119+
# Remove the env var so subsequent builds are not affected
120+
Remove-Item Env:\LLVM_PROFILE_FILE -ErrorAction SilentlyContinue
121+
122+
# ---------------------------------------------------------------------------
123+
# STEP 2 – Merge .profraw files -> node.profdata
124+
# ---------------------------------------------------------------------------
125+
126+
Write-Host"`n=== STEP 2: Merge profile data ==="-ForegroundColor Cyan
127+
128+
Write-Host"Using llvm-profdata: $llvmProfdata"
129+
130+
$profrawFiles=Get-ChildItem-Path $profileDir-Filter "*.profraw"-ErrorAction SilentlyContinue
131+
if ($profrawFiles.Count-eq0) {
132+
Write-Error"No .profraw files found in '$profileDir'. The instrumented binary may not have generated profile data."
133+
exit1
134+
}
135+
136+
$totalSize= ($profrawFiles|Measure-Object-Property Length -Sum).Sum
137+
$totalSizeMB= [math]::Round($totalSize/1MB,1)
138+
Write-Host"Found $($profrawFiles.Count) .profraw file(s), ${totalSizeMB} MB total"
139+
140+
$profdata=Join-Path$PSScriptRoot"node.profdata"
141+
$mergeArgs=@("merge","--output=$profdata") + ($profrawFiles|Select-Object-ExpandProperty FullName)
142+
143+
$mergeStopwatch= [System.Diagnostics.Stopwatch]::StartNew()
144+
&$llvmProfdata@mergeArgs
145+
$mergeExitCode=$LASTEXITCODE
146+
$mergeStopwatch.Stop()
147+
148+
if ($mergeExitCode-ne0) {
149+
Write-Error"llvm-profdata merge failed (exit code $mergeExitCode)"
150+
exit$mergeExitCode
151+
}
152+
153+
$profdataSize= [math]::Round((Get-Item$profdata).Length /1MB,1)
154+
Write-Host"Merge completed in $([math]::Round($mergeStopwatch.Elapsed.TotalSeconds,1))s"
155+
156+
# Clean up .profraw files now that they've been merged
157+
Remove-Item-Recurse -Force $profileDir
158+
Write-Host"Removed $($profrawFiles.Count) .profraw file(s) (${totalSizeMB} MB reclaimed)"
159+
160+
Write-Host"`n=== PGO training complete ==="-ForegroundColor Green
161+
Write-Host" Profile data: $profdata (${profdataSize} MB)"
162+
Write-Host" Next step: vcbuild.bat pgo-use"
‎tools/pgo/README.md‎
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Node.js PGO Training Scripts
2+
3+
Training workloads for Profile-Guided Optimization (PGO) builds using
4+
Clang/LLVM (including Clang-CL on Windows).
5+
6+
## What is PGO?
7+
8+
PGO uses runtime profile data to guide compiler optimizations (inlining,
9+
branch prediction, code layout), typically improving throughput by 5-20%.
10+
11+
The process has three phases:
12+
13+
1.**Instrument** — Build with `-fprofile-generate` (produces `.profraw` files)
14+
2.**Train** — Run representative workloads to collect profile data
15+
3.**Optimize** — Merge `.profraw` → `node.profdata` via `llvm-profdata`,
16+
 then rebuild with `-fprofile-use`
17+
18+
## Quick Start
19+
20+
From a VS Developer Command Prompt:
21+
22+
```powershell
23+
# Step 1: Build the instrumented binary
24+
vcbuild.bat pgo-generate
25+
26+
# Step 2: Run workloads and merge profile data
27+
.\pgo.ps1
28+
29+
# Step 3: Build the optimized binary
30+
vcbuild.bat pgo-use
31+
```
32+
33+
`pgo.ps1` expects the instrumented binary at `Release\node.exe` (produced by
34+
step 1) and writes `node.profdata` to the repo root (consumed by step 3).
35+
36+
```powershell
37+
# Optionally set a longer training duration (default: 15s per script)
38+
.\pgo.ps1 -Duration 30
39+
```
40+
41+
## Training Scripts
42+
43+
All scripts use only Node.js built-in modules (no npm dependencies).
44+
Each script is run as a separate process via `fork()`, producing its own
45+
`.profraw` file.
46+
47+
| Script | What it exercises |
48+
| ------------------------ | ------------------------------------------------------------- |
49+
|`pgo-http-server.js`| llhttp parser, TCP stack, header serialization, JSON, routing |
50+
|`pgo-json.js`| V8 JSON parser/serializer, string allocation, GC pressure |
51+
|`pgo-crypto.js`| OpenSSL (hashing, HMAC, AES, RSA, ECDSA, random, KDF) |
52+
|`pgo-streams-buffers.js`| Buffer C++ impl, stream state machine, back-pressure |
53+
|`pgo-fs.js`| libuv fs operations, thread pool, path module |
54+
|`pgo-async-patterns.js`| V8 Promises, microtask queue, EventEmitter, timers |
55+
|`pgo-url-string.js`| Ada URL parser, V8 string internals, regex JIT |
56+
|`pgo-compression.js`| zlib, brotli C libraries, streaming compression |
57+
|`pgo-net.js`| libuv TCP/pipe handles, c-ares DNS resolver |
58+
|`pgo-module-loading.js`| Module resolver, V8 script compilation, vm module |
59+
|`pgo-child-workers.js`| Worker thread messaging, SharedArrayBuffer, inline eval |
60+
61+
### Running the Orchestrator Directly
62+
63+
The orchestrator can also be invoked directly (e.g. for testing individual
64+
workloads). When used with `pgo.ps1`, this is handled automatically.
65+
66+
```bash
67+
# Run all scripts
68+
node tools/pgo/pgo-run-all.js --duration=15 --verbose
69+
70+
# Run specific scripts
71+
node tools/pgo/pgo-run-all.js --scripts=http-server,json,crypto --duration=30
72+
73+
# Show help
74+
node tools/pgo/pgo-run-all.js --help
75+
```
76+
77+
Each script reads the `PGO_TRAINING_DURATION` environment variable (in
78+
milliseconds) to determine how long to run. The orchestrator sets this
79+
automatically from the `--duration` flag (in seconds).
80+
81+
## Files
82+
83+
```
84+
tools/pgo/
85+
├── pgo-run-all.js # Training orchestrator
86+
├── pgo-http-server.js # HTTP server + client workload
87+
├── pgo-json.js # JSON parse/stringify workload
88+
├── pgo-crypto.js # Crypto operations workload
89+
├── pgo-streams-buffers.js # Streams and Buffer workload
90+
├── pgo-fs.js # File system operations workload
91+
├── pgo-async-patterns.js # Promise/async, EventEmitter, timers workload
92+
├── pgo-url-string.js # URL parsing, string ops, regex workload
93+
├── pgo-compression.js # Gzip/brotli/deflate compression workload
94+
├── pgo-net.js # TCP networking and DNS workload
95+
├── pgo-module-loading.js # Module require/import, VM compilation workload
96+
├── pgo-child-workers.js # Worker threads workload
97+
└── README.md # This file
98+
```
0 commit comments
Comments
 (0)