Add profiling pipeline (#7961)

Author: dibarbet

azure-pipelines-official.yml

@@ -28,7 +28,7 @@ parameters:
   default: auto
 
 variables:
-  defaultDotnetVersion: '8.0.403'
+- template: /azure-pipelines/dotnet-variables.yml@self
 
 resources:
   repositories:

azure-pipelines.yml

@@ -29,8 +29,7 @@ schedules:
         - main
 
 variables:
-- name: defaultDotnetVersion
-  value: '8.0.403'
+- template: /azure-pipelines/dotnet-variables.yml@self
 - name: testVSCodeVersion
   ${{ if eq( variables['Build.Reason'], 'Schedule' ) }}: 
     value: insiders

azure-pipelines/dotnet-variables.yml

@@ -0,0 +1,3 @@
+variables:
+- name: defaultDotnetVersion
+  value: '8.0.403'

azure-pipelines/profiling.yml

@@ -9,20 +9,51 @@ schedules:
 
 variables:
 - name: TRACE_DROP_LOCATION
-  value: $(Build.ArtifactStagingDirectory)/traces/
+  value: $(Build.SourcesDirectory)/out/profiling/
 - name: MERGED_TRACE_LOCATION
-  value: $(Build.ArtifactStagingDirectory)/mergedtrace/
+  value: $(Build.SourcesDirectory)/out/profiling/merged/
+- name: LOGS_DIRECTORY
+  value: $(Build.SourcesDirectory)/out/logs/
+- template: /azure-pipelines/dotnet-variables.yml@self
 
+
+resources:
+  repositories:
+  - repository: 1ESPipelineTemplates
+    type: git
+    name: 1ESPipelineTemplates/1ESPipelineTemplates
+    ref: refs/tags/release
 extends:
   template: v1/1ES.Official.PipelineTemplate.yml@1ESPipelineTemplates
   parameters:
-    pool:
-      name: AzurePipelines-EO
-      image: 1ESPT-Ubuntu20.04
-      os: Linux
+    sdl:
+      sourceAnalysisPool:
+        name: netcore1espool-internal
+        image: 1es-windows-2022
+        os: windows
     stages:
-    - stage: run
+    - stage: Run_Profiling
+      displayName: Run Profiling
       jobs:
-      - job: run
+      - job: Profile
+        pool:
+          name: netcore1espool-internal
+          image: 1es-ubuntu-2204
+          os: linux
+        templateContext:
+          outputs:
+          - output: pipelineArtifact
+            targetPath: $(TRACE_DROP_LOCATION)
+            artifactName: traces
+            displayName: 📢 Publish intermediate trace files
+            condition: failed()
+          - output: pipelineArtifact
+            targetPath: $(MERGED_TRACE_LOCATION)
+            artifactName: merged mibc
+            displayName: 📢 Publish merged MIBC
         steps:
-        - pwsh: echo "Profiling"
+        - template: /azure-pipelines/test.yml@self
+          parameters:
+            dotnetVersion: $(defaultDotnetVersion)
+            npmCommand: profiling
+            testVSCodeVersion: stable

azure-pipelines/test.yml

@@ -44,9 +44,17 @@ steps:
     mergeTestResults: true
     testRunTitle: $(System.StageDisplayName) $(Agent.JobName) (Attempt $(System.JobAttempt))
 
-- task: PublishPipelineArtifact@1
-  condition: failed()
-  displayName: 'Upload integration test logs'
-  inputs:
-    targetPath: '$(Build.SourcesDirectory)/out/logs'
-    artifactName: 'Test Logs ($(System.StageDisplayName)-$(Agent.JobName)-$(System.JobAttempt))'
+- ${{ if eq(variables['System.TeamProject'], 'internal') }}:
+  - task: 1ES.PublishPipelineArtifact@1
+    condition: failed()
+    displayName: 'Upload integration test logs'
+    inputs:
+      path: '$(Build.SourcesDirectory)/out/logs'
+      artifact: 'Test Logs ($(System.StageDisplayName)-$(Agent.JobName)-$(System.JobAttempt))'
+- ${{ else }}: 
+  - task: PublishPipelineArtifact@1
+    condition: failed()
+    displayName: 'Upload integration test logs'
+    inputs:
+      targetPath: '$(Build.SourcesDirectory)/out/logs'
+      artifactName: 'Test Logs ($(System.StageDisplayName)-$(Agent.JobName)-$(System.JobAttempt))'

gulpfile.ts

@@ -11,3 +11,4 @@ require('./tasks/createTagsTasks');
 require('./tasks/debuggerTasks');
 require('./tasks/snapTasks');
 require('./tasks/signingTasks');
+require('./tasks/profilingTasks');

package.json

@@ -73,6 +73,7 @@
     "test:integration:devkit": "tsc -p ./ && gulp test:integration:devkit",
     "test:razor": "tsc -p ./ && npm run compile:razorTextMate && gulp test:razor",
     "test:razorintegration": "tsc -p ./ && gulp test:razorintegration",
+    "profiling": "tsc -p ./ && gulp profiling",
     "test:artifacts": "tsc -p ./ && gulp test:artifacts",
     "omnisharptest": "tsc -p ./ && gulp omnisharptest",
     "omnisharptest:unit": "tsc -p ./ && gulp omnisharptest:unit",

src/lsptoolshost/profiling.ts

@@ -0,0 +1,26 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { EOL } from 'os';
+import { LogOutputChannel } from 'vscode';
+
+export function getProfilingEnvVars(outputChannel: LogOutputChannel): NodeJS.ProcessEnv {
+    let profilingEnvVars = {};
+    if (process.env.ROSLYN_DOTNET_EventPipeOutputPath) {
+        profilingEnvVars = {
+            DOTNET_EnableEventPipe: 1,
+            DOTNET_EventPipeConfig: 'Microsoft-Windows-DotNETRuntime:0x1F000080018:5',
+            DOTNET_EventPipeOutputPath: process.env.ROSLYN_DOTNET_EventPipeOutputPath,
+            DOTNET_ReadyToRun: 0,
+            DOTNET_TieredCompilation: 1,
+            DOTNET_TC_CallCounting: 0,
+            DOTNET_TC_QuickJitForLoops: 1,
+            DOTNET_JitCollect64BitCounts: 1,
+        };
+        outputChannel.trace(`Profiling enabled with:${EOL}${JSON.stringify(profilingEnvVars)}`);
+    }
+
+    return profilingEnvVars;
+}

src/lsptoolshost/roslynLanguageServer.ts

@@ -79,6 +79,7 @@ import { registerSourceGeneratedFilesContentProvider } from './sourceGeneratedFi
 import { registerMiscellaneousFileNotifier } from './miscellaneousFileNotifier';
 import { TelemetryEventNames } from '../shared/telemetryEventNames';
 import { RazorDynamicFileChangedParams } from '../razor/src/dynamicFile/dynamicFileUpdatedParams';
+import { getProfilingEnvVars } from './profiling';
 
 let _channel: vscode.LogOutputChannel;
 let _traceChannel: vscode.OutputChannel;
@@ -664,18 +665,23 @@ export class RoslynLanguageServer {
 
         args.push('--extensionLogDirectory', context.logUri.fsPath);
 
-        const env = dotnetInfo.env;
+        let env = dotnetInfo.env;
         if (!languageServerOptions.useServerGC) {
             // The server by default uses serverGC, if the user opts out we need to set the environment variable to disable it.
             env.DOTNET_gcServer = '0';
             _channel.debug('ServerGC disabled');
         }
 
+        const profilingEnvVars = getProfilingEnvVars(_channel);
+        env = { ...env, ...profilingEnvVars };
+
+        _channel.trace(`Profiling environment variables: ${JSON.stringify(profilingEnvVars)}`);
+
         let childProcess: cp.ChildProcessWithoutNullStreams;
         const cpOptions: cp.SpawnOptionsWithoutStdio = {
             detached: true,
             windowsHide: true,
-            env: dotnetInfo.env,
+            env: env,
         };
 
         if (serverPath.endsWith('.dll')) {

tasks/profilingTasks.ts

@@ -0,0 +1,112 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import fs from 'fs';
+import * as gulp from 'gulp';
+import * as path from 'path';
+import { basicSlnTestProject, runIntegrationTest } from './testHelpers';
+import { outPath } from './projectPaths';
+import { execSync } from 'child_process';
+
+createProfilingTasks();
+
+function createProfilingTasks() {
+    const profilingOutputFolder = path.join(outPath, 'profiling');
+    gulp.task(`profiling:csharp:${basicSlnTestProject}`, async () => {
+        // Ensure the profiling output folder exists, otherwise the outputs will not get written.
+        fs.mkdirSync(path.join(outPath, 'profiling'), { recursive: true });
+
+        await runIntegrationTest(
+            basicSlnTestProject,
+            path.join('lsptoolshost', 'integrationTests'),
+            `[C#][${basicSlnTestProject}]`,
+            undefined,
+            undefined,
+            {
+                ROSLYN_DOTNET_EventPipeOutputPath: path.join(profilingOutputFolder, 'csharp-trace.{pid}.nettrace'),
+            }
+        );
+
+        const files = fs.readdirSync(profilingOutputFolder);
+        const nettraceFiles = files.filter((f) => f.endsWith('.nettrace'));
+        if (nettraceFiles.length === 0) {
+            throw new Error('No .nettrace files found in the profiling output folder.');
+        }
+    });
+
+    gulp.task('mergeTraces', async () => {
+        await mergeTraces(profilingOutputFolder);
+    });
+
+    gulp.task('profiling', gulp.series(`profiling:csharp:${basicSlnTestProject}`, 'mergeTraces'));
+}
+
+async function mergeTraces(profilingOutputFolder: string) {
+    const files = fs.readdirSync(profilingOutputFolder);
+    const nettraceFiles = files.filter((f) => f.endsWith('.nettrace'));
+    if (nettraceFiles.length === 0) {
+        throw new Error('No .nettrace files found in the profiling output folder.');
+    }
+
+    // Function to spawn a tool
+    function spawnTool(command: string, args: string[], warnOnError = false) {
+        try {
+            console.log(`##[command] ${command} ${args.join(' ')}`);
+            execSync(`${command} ${args.join(' ')}`, { stdio: 'inherit' });
+        } catch (error) {
+            if (warnOnError) {
+                console.warn(`Failed: ${error}`);
+            } else {
+                throw error;
+            }
+        }
+    }
+
+    // Ensure the dotnet-pgo tool is installed.
+    // Additional versions of this can be found at https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet8-transport/NuGet/dotnet-pgo/
+    spawnTool('dotnet', [
+        'tool',
+        'update',
+        '-g',
+        'dotnet-pgo',
+        '--version',
+        '8.0.0-rc.2.23479.6',
+        '--add-source',
+        'https://pkgs.dev.azure.com/azure-public/vside/_packaging/msft_consumption/nuget/v3/index.json',
+        '--ignore-failed-sources',
+    ]);
+
+    console.log('##[group] Converting .nettrace to .mibc');
+    nettraceFiles.forEach((file) => {
+        spawnTool(
+            'dotnet-pgo',
+            [
+                'create-mibc',
+                '-t',
+                path.join(profilingOutputFolder, file),
+                '-o',
+                path.join(profilingOutputFolder, `${path.basename(file, '.nettrace')}.mibc`),
+            ],
+            true
+        );
+    });
+    console.log('##[endgroup]');
+
+    const mibcFiles = fs.readdirSync(profilingOutputFolder).filter((f) => f.endsWith('.mibc'));
+    if (mibcFiles.length === 0) {
+        throw new Error('No .mibc files were produced.');
+    }
+
+    const mergedTraceLocation = path.join(profilingOutputFolder, 'merged');
+    fs.mkdirSync(mergedTraceLocation, { recursive: true });
+
+    const inputArgs = ['merge', '--compressed'];
+    mibcFiles.forEach((file) => {
+        inputArgs.push('-i', path.join(profilingOutputFolder, file));
+    });
+    inputArgs.push('-o', path.join(mergedTraceLocation, 'merged.mibc'));
+
+    spawnTool('dotnet-pgo', inputArgs);
+}