[Profiler] Add support for ARM64

.azure-pipelines/steps/update-github-pipeline-status.yml

@@ -39,7 +39,10 @@ stages:
       - integration_tests_linux_debugger
       - profiler_integration_tests_windows
       - profiler_integration_tests_linux
+      - profiler_integration_tests_arm64
       - asan_profiler_tests
+      - asan_arm64_profiler_tests
+      - ubsan_arm64_profiler_tests
       - ubsan_profiler_tests
       - tsan_profiler_tests
       - integration_tests_arm64
@@ -118,7 +121,10 @@ stages:
          in(dependencies.integration_tests_linux_debugger.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.profiler_integration_tests_windows.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.profiler_integration_tests_linux.result, 'Succeeded','SucceededWithIssues','Skipped'),
+         in(dependencies.profiler_integration_tests_arm64.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.asan_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
+         in(dependencies.asan_arm64_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
+         in(dependencies.ubsan_arm64_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.ubsan_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.tsan_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.integration_tests_arm64.result, 'Succeeded','SucceededWithIssues','Skipped'),
@@ -209,7 +215,10 @@ stages:
       - integration_tests_linux_debugger
       - profiler_integration_tests_windows
       - profiler_integration_tests_linux
+      - profiler_integration_tests_arm64
       - asan_profiler_tests
+      - asan_arm64_profiler_tests
+      - ubsan_arm64_profiler_tests
       - ubsan_profiler_tests
       - tsan_profiler_tests
       - integration_tests_arm64
@@ -288,7 +297,10 @@ stages:
          in(dependencies.integration_tests_linux_debugger.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.profiler_integration_tests_windows.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.profiler_integration_tests_linux.result, 'Succeeded','SucceededWithIssues','Skipped'),
+         in(dependencies.profiler_integration_tests_arm64.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.asan_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
+         in(dependencies.asan_arm64_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
+         in(dependencies.ubsan_arm64_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.ubsan_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.tsan_profiler_tests.result, 'Succeeded','SucceededWithIssues','Skipped'),
          in(dependencies.integration_tests_arm64.result, 'Succeeded','SucceededWithIssues','Skipped'),

.azure-pipelines/ultimate-pipeline.yml

@@ -2907,6 +2907,107 @@ stages:
         testResultsFiles: profiler/build_data/results/**/*.trx
       condition: succeededOrFailed()
 
+- stage: profiler_integration_tests_arm64
+  condition: >
+    and(
+      succeeded(),
+      or(
+        eq(variables.isMainOrReleaseBranch, true),
+        eq(dependencies.generate_variables.outputs['generate_variables_job.generate_variables_step.IsProfilerChanged'], 'True')
+      )
+    )
+  dependsOn: [package_arm64, generate_variables, merge_commit_id]
+  variables:
+    targetShaId: $[ stageDependencies.merge_commit_id.fetch.outputs['set_sha.sha']]
+    targetBranch: $[ stageDependencies.merge_commit_id.fetch.outputs['set_sha.branch']]
+  jobs:
+  - template: steps/update-github-status-jobs.yml
+    parameters:
+      jobs: [Test]
+
+  - job: Test
+    timeoutInMinutes: 60 #default value
+    strategy:
+      matrix:
+        arm64:
+          baseImage: debian
+          artifactSuffix: linux-arm64
+        alpine:
+          baseImage: alpine
+          artifactSuffix: linux-musl-arm64
+
+    variables:
+      IncludeMinorPackageVersions:  $[eq(variables.perform_comprehensive_testing, 'true')]
+
+    pool:
+      name: $(linuxArm64Pool)
+
+    steps:
+    - template: steps/clone-repo.yml
+      parameters:
+        targetShaId: $(targetShaId)
+        targetBranch: $(targetBranch)
+
+    - template: steps/restore-working-directory.yml
+      parameters:
+        artifact: build-$(artifactSuffix)-working-directory
+
+    - template: steps/download-artifact.yml
+      parameters:
+        artifact: linux-monitoring-home-$(artifactSuffix)
+        path: $(monitoringHome)
+
+    - template: steps/download-artifact.yml
+      parameters:
+        artifact: linux-profiler-symbols-$(artifactSuffix)
+        path: $(monitoringHome)
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        build: true
+        baseImage: $(baseImage)
+        command: "BuildProfilerSamples"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+        retryCountForRunCommand: 3
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        baseImage: $(baseImage)
+        command: "BuildAndRunProfilerCpuLimitTests"
+        extraArgs: "--cpus 2 --env CONTAINER_CPUS=1"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+        retryCountForRunCommand: 3
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        baseImage: $(baseImage)
+        command: "BuildAndRunProfilerCpuLimitTests"
+        extraArgs: "--cpus 0.5 --env CONTAINER_CPUS=0.5"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+        retryCountForRunCommand: 3
+
+    - script: |
+        docker-compose -f docker-compose.yml -p $(DockerComposeProjectName) \
+          run --rm \
+          -e baseImage=$(baseImage) \
+          ProfilerIntegrationTests
+      displayName: docker-compose run --no-deps ProfilerIntegrationTests
+      env:
+        DD_LOGGER_DD_API_KEY: $(ddApiKey)
+        baseImage: $(baseImage) # for interpolation in the docker-compose file
+
+    - publish: profiler/build_data
+      artifact: _$(System.StageName)_$(Agent.JobName)_logs_$(System.JobAttempt)
+      condition: always()
+      continueOnError: true
+
+    - task: PublishTestResults@2
+      displayName: publish test results
+      inputs:
+        testResultsFormat: VSTest
+        testResultsFiles: profiler/build_data/results/**/*.trx
+      condition: succeededOrFailed()
+
 - stage: asan_profiler_tests
   #address sanitizer tests
   condition: >
@@ -2992,6 +3093,114 @@ stages:
       condition: always()
       continueOnError: false
 
+- stage: asan_arm64_profiler_tests
+  #address sanitizer tests on arm64
+  condition: >
+    and(
+      succeeded(),
+      eq(dependencies.generate_variables.outputs['generate_variables_job.generate_variables_step.IsProfilerChanged'], 'True')
+    )
+  dependsOn: [merge_commit_id, generate_variables]
+  variables:
+    targetShaId: $[ stageDependencies.merge_commit_id.fetch.outputs['set_sha.sha']]
+    targetBranch: $[ stageDependencies.merge_commit_id.fetch.outputs['set_sha.branch']]
+  jobs:
+  - template: steps/update-github-status-jobs.yml
+    parameters:
+      jobs: [Linux]
+
+  - job: Linux
+    timeoutInMinutes: 60
+
+    pool:
+      name: $(linuxArm64Pool)
+
+    steps:
+    - template: steps/clone-repo.yml
+      parameters:
+        targetShaId: $(targetShaId)
+        targetBranch: $(targetBranch)
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        build: true
+        baseImage: debian
+        command: "BuildProfilerAsanTest -Framework net7.0"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        build: true
+        baseImage: debian
+        command: "BuildProfilerSampleForSanitiserTests -Framework net7.0"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        baseImage: debian
+        command: "RunSampleWithProfilerAsan -Framework net7.0"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+
+    - publish: profiler/build_data
+      displayName: Uploading Address sanitizer test results
+      artifact: _$(System.StageName)_$(Agent.JobName)_test_results_$(System.JobAttempt)
+      condition: always()
+      continueOnError: false
+
+- stage: ubsan_arm64_profiler_tests
+  #undefined behavior sanitizer tests on arm64
+  condition: >
+    and(
+      succeeded(),
+      eq(dependencies.generate_variables.outputs['generate_variables_job.generate_variables_step.IsProfilerChanged'], 'True')
+    )
+  dependsOn: [merge_commit_id, generate_variables]
+  variables:
+    targetShaId: $[ stageDependencies.merge_commit_id.fetch.outputs['set_sha.sha']]
+    targetBranch: $[ stageDependencies.merge_commit_id.fetch.outputs['set_sha.branch']]
+  jobs:
+  - template: steps/update-github-status-jobs.yml
+    parameters:
+      jobs: [Linux]
+
+  - job: Linux
+    timeoutInMinutes: 60
+
+    pool:
+      name: $(linuxArm64Pool)
+
+    steps:
+    - template: steps/clone-repo.yml
+      parameters:
+        targetShaId: $(targetShaId)
+        targetBranch: $(targetBranch)
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        build: true
+        baseImage: debian
+        command: "BuildProfilerUbsanTest -Framework net7.0"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        build: true
+        baseImage: debian
+        command: "BuildProfilerSampleForSanitiserTests -Framework net7.0"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+
+    - template: steps/run-in-docker.yml
+      parameters:
+        baseImage: debian
+        command: "RunSampleWithProfilerUbsan -Framework net7.0"
+        apiKey: $(DD_LOGGER_DD_API_KEY)
+
+    - publish: profiler/build_data
+      displayName: Uploading test results
+      artifact: _$(System.StageName)_$(Agent.JobName)_logs_$(System.JobAttempt)
+      condition: always()
+      continueOnError: false
+
 - stage: ubsan_profiler_tests
 #undefined behavior sanitizer tests
   condition: >

build/cmake/FindLibunwind.cmake

@@ -1,10 +1,29 @@
-SET(LIBUNWIND_VERSION "v1.8.3")
+# We intentionally pin to the DataDog/libunwind fork on tag
+# gleocadie/v1.8.1-custom-3 rather than upstream libunwind v1.8.1 or v1.8.3.
+# The fork carries the following patches that the Continuous Profiler's
+# HybridUnwinder depends on (arm64 Linux):
+#   - unw_cursor_snapshot_t / unw_cursor_snapshot(): a signal-safe public API
+#     to inspect the dwarf cursor (CFA, loc_fp/loc_lr/loc_sp, frame_type,
+#     cfa_reg_sp, cfa_reg_offset, dwarf_step_ret, step_method, loc_info).
+#     Used by UnwinderTracer.h / HybridUnwinder.cpp without having to mirror
+#     libunwind's internal layouts.
+#   - unw_init_local2() + UNW_INIT_SIGNAL_FRAME flag: lets us initialize the
+#     cursor directly from a signal-delivered ucontext_t and flag the first
+#     frame as a signal frame so libunwind returns the interrupted PC instead
+#     of the signal-trampoline PC.
+#   - Additional accessors on the tdep_frame (fp_cfa_offset / lr_cfa_offset /
+#     sp_cfa_offset, cfa_is_unreliable, next_to_signal_frame) consumed by the
+#     tracer for diagnostics.
+# Upstream libunwind 1.8.3 does not expose these APIs. When they land upstream
+# (or when the fork is rebased on top of a newer upstream tag), update this
+# file accordingly.
+SET(LIBUNWIND_VERSION "v1.8.1-custom-3")
 
 SET(LIBUNWIND_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/libunwind-prefix/src/libunwind-build)
 
 ExternalProject_Add(libunwind
     GIT_REPOSITORY https://github.com/DataDog/libunwind.git
-    GIT_TAG gleocadie/v1.8.3
+    GIT_TAG gleocadie/v1.8.1-custom-3
     GIT_PROGRESS true
     INSTALL_COMMAND ""
     UPDATE_COMMAND ""

profiler/src/Demos/Directory.Build.props

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 
@@ -7,7 +7,13 @@
   <PropertyGroup>
     <!-- only run .NET Framework tests on Windows -->
     <TargetFrameworks Condition="'$(OS)' == 'Windows_NT'">net48;netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
-    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT' And '$([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture)' != 'Arm64'">netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
+    <!--
+      netcoreapp3.1 is deliberately excluded on arm64 Linux: the Continuous Profiler
+      refuses to initialize when major < 5 on that platform (see CorProfilerCallback::Initialize),
+      so running the demos against .NET Core 3.1 arm64 would produce no profiles at all.
+    -->
+    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT' And '$([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture)' == 'Arm64'">net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
     <Platforms>AnyCPU;x64;x86</Platforms>
 
     <!-- Hide warnings for EOL .NET Core targets (e.g. netcoreapp3.0) -->

profiler/src/Demos/Samples.BuggyBits/Samples.BuggyBits.csproj

@@ -1,7 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' == 'Windows_NT'">netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT' And '$([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture)' != 'Arm64'">netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT' And '$([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture)' == 'Arm64'">net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
     <Platforms>AnyCPU;x64;x86</Platforms>
 
     <!--This is required for smoke test assembly discovery-->

profiler/src/Demos/Samples.Website-AspNetCore01/Samples.Website-AspNetCore01.csproj

@@ -1,7 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' == 'Windows_NT'">netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT' And '$([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture)' != 'Arm64'">netcoreapp3.1;net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT' And '$([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture)' == 'Arm64'">net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
     <RootNamespace>Samples.Website_AspNetCore01</RootNamespace>
     <Platforms>AnyCPU;x64;x86</Platforms>
 

profiler/src/ProfilerEngine/Datadog.Linux.ApiWrapper/CMakeLists.txt

@@ -37,6 +37,10 @@ endif()
 # ******************************************************
 
 SET(API_WRAPPER_BASENAME Datadog.Linux.ApiWrapper)
+# For arm64, we cannot replace the x64 suffix with arm64.
+# This library is already shipped and used by customers. Their scripts expect the x64 suffix.
+# SSI relies on this file.
+# Changing this would bring little value but lots of headaches.
 SET(API_WRAPPER_SHARED_LIB_NAME ${API_WRAPPER_BASENAME}.x64)
 
 SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${DEPLOY_DIR})

profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/Backtrace2Unwinder.cpp

@@ -8,7 +8,9 @@
 
 Backtrace2Unwinder::Backtrace2Unwinder() = default;
 
-std::int32_t Backtrace2Unwinder::Unwind(void* ctx, std::uintptr_t* buffer, std::size_t bufferSize) const
+std::int32_t Backtrace2Unwinder::Unwind(void* ctx, std::uintptr_t* buffer, std::size_t bufferSize,
+                                        std::uintptr_t stackBase, std::uintptr_t stackEnd,
+                                        UnwinderTracer* tracer) const
 {
     // unw_backtrace2 handles the case ctx == nullptr
     auto* context = reinterpret_cast<unw_context_t*>(ctx);

profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/Backtrace2Unwinder.h

@@ -13,6 +13,8 @@ class Backtrace2Unwinder : public IUnwinder
     ~Backtrace2Unwinder() override = default;
 
     // Returns the number of frames unwound
-    std::int32_t Unwind(void* ctx, std::uintptr_t* buffer, std::size_t bufferSize) const override;
+    std::int32_t Unwind(void* ctx, std::uintptr_t* buffer, std::size_t bufferSize,
+                        std::uintptr_t stackBase = 0, std::uintptr_t stackEnd = 0,
+                        UnwinderTracer* tracer = nullptr) const override;
 
-};
+};