AddressSanitizer

Överblick

C- och C++-språken är kraftfulla, men kan drabbas av en klass buggar som påverkar programmets korrekthet och programsäkerhet. Från och med Visual Studio 2019 version 16.9 stöder kompilatorn Microsoft C/C++ (MSVC) och IDE AddressSanitizer sanitizer. AddressSanitizer (ASan) är en kompilator- och körningsteknologi som exponerar många svårsökta buggar med noll falska positiva identifieringar.

• Alloc/dealloc-missmatch och new/delete typen missmatch
• Allokeringar är för stora för heap-
• calloc spill och alloca spill
• Dubbel frigivning och Använd efter frigivning
• Global variabelöverflöde
• Heap-buffertöverskridning
• Ogiltig justering av justerade värden
• memcpy och strncat parameteröverlappning
• Stack-buffertspill och underrinning
• Stack-användning efter return och användning efter räckvidd
• minnesanvändning när den har förgiftats

Varför använda AddressSanitizer

Använd AddressSanitizer för att minska din tid på:

• Grundläggande korrekthet
• Plattformsoberoende portabilitet
• Säkerhet
• Belastningstest
• Integrera ny kod

AddressSanitizer, som ursprungligen introducerades av Google, tillhandahåller felsökningstekniker som körs och använder dina befintliga byggsystem och befintliga testresurser direkt.

Skapa integrering och kompatibilitet

AddressSanitizer är integrerat med Visual Studio-projektsystemet, CMake-byggsystemet och IDE. Projekt kan aktivera AddressSanitizer genom att ange en projektegenskap eller genom att använda ett extra kompilatoralternativ: /fsanitize=address. Det här alternativet är kompatibelt med alla nivåer av optimering och konfigurationer av x86 och x64. Det är dock inte kompatibelt med redigera och fortsätt, inkrementell länkningoch /RTC.

Stöd för kraschdumpar

Från och med Visual Studio 2019 version 16.9 möjliggör Microsofts AddressSanitizer-teknik integrering med Visual Studio IDE. Funktionen kan valfritt skapa en kraschdumpfil när sanitizern hittar en bugg vid körning. Om du ställer in ASAN_SAVE_DUMPS=MyFileName.dmp miljövariabeln innan du kör ditt program skapas en kraschdumpfil med extra metadata för effektiv post-mortem felsökning av exakt diagnostiserade fel. Dessa dumpfiler gör utökad användning av AddressSanitizer enklare för:

• Testning av lokala datorer
• Lokal distribuerad testning
• Molnbaserade arbetsflöden för testning

Installera AddressSanitizer

C++-arbetsbelastningar i Visual Studio Installer installerar AddressSanitizer-biblioteken och IDE-integreringen som standard. Om du uppgraderar från en äldre version av Visual Studio 2019 använder du installationsprogrammet för att aktivera ASan-stöd efter uppgraderingen. Du kan öppna installationsprogrammet från huvudmenyn Visual Studio genom att välja Tools>Get Tools and Features. Välj Modify på din befintliga Visual Studio installation från Visual Studio Installer för att komma till följande skärm.

Använda AddressSanitizer

Börja skapa körbara filer med alternativet /fsanitize=address kompilator med någon av dessa vanliga utvecklingsmetoder:

• Kompilering från kommandorad
• Visual Studio-projektsystem
• Visual Studio CMake-integrering

Kompilera om koden och kör sedan programmet normalt för att exponera många typer av exakt diagnostiserade buggar. Du kan granska problemen i felsökningsprogrammets IDE, kommandoraden eller dumpfilen.

Microsoft rekommenderar att du använder AddressSanitizer i dessa tre standardarbetsflöden:

• Developer inre loop

  • Visual Studio – kommandorad
  • Visual Studio – Project-system
  • Visual Studio – CMake

• CI/CD – kontinuerlig integrering och kontinuerlig leverans

  • Felrapportering – AddressSanitizer-dumpfiler

• Fuzzing - att bygga med libFuzzer-omslag

  • Azure OneFuzz
  • Lokal dator

Den här artikeln beskriver den information du behöver för att aktivera de tre arbetsflöden som angavs tidigare. Informationen är specifik för plattformsberoende Windows 10-implementering (och senare) av AddressSanitizer. Den här dokumentationen kompletterar dokumentationen från Google, Apple och GCC.

Använd AddressSanitizer från en utvecklarkommandotolk

Använd alternativet /fsanitize=address kompilator i en kommandotolk för utvecklare för att aktivera kompilering för AddressSanitizer-körningen. Alternativet /fsanitize=address är kompatibelt med befintliga C++ eller C-optimeringsnivåer, /Odtill exempel , , /O1/O2och /O2 /GL. Alternativet fungerar med statiska och dynamiska CRT(till exempel /MD, /MDd, /MToch /MTd). Det fungerar oavsett om du skapar en EXE eller en DLL. Felsökningsinformation krävs för optimal formatering av anropsstackar. I följande exempel skickas cl /fsanitize=address /Zi på kommandoraden.

AddressSanitizer-biblioteken (.lib-filer) länkas automatiskt åt dig. Mer information finns i AddressSanitizer språk-, kompilering- och felsökningsreferens.

Exempel – grundläggande global buffertöverskridning

// basic-global-overflow.cpp
#include <stdio.h>
int x[100];
int main() {
    printf("Hello!\n");
    x[100] = 5; // Boom!
    return 0;
}

Kompilera basic-global-overflow.cpp med hjälp av /fsanitize=address /Zi med hjälp av en kommandotolk för utvecklare för Visual Studio 2019.

När du kör den resulterande basic-global-overflow.exe på kommandoraden skapas den formaterade felrapporten som följer.

Tänk på de överlagrade, röda rutorna som markerar sju viktiga informationsdelar:

Röda markeringar, uppifrån och ned

1. Minnessäkerhetsbuggen är en global buffertöverskridning.
2. Det fanns 4 byte (32 bitar) lagrade utanför någon användardefinierad variabel.
3. Lagringen ägde rum i funktionen main() definierad i filen basic-global-overflow.cpp på rad 7.
4. Variabeln med namnet x definieras i basic-global-overflow.cpp på rad 3, med början i kolumn 8.
5. Den här globala variabeln x är av storlek 400 byte.
6. Det exakta skuggbyte som beskrev adressen som skrivningen riktades mot hade värdet 0xf9.
7. Teckenförklaringen för skuggbyten anger att 0xf9 är ett utfyllnadsområde till höger om int x[100].

Använda AddressSanitizer i Visual Studio

AddressSanitizer är integrerat med Visual Studio IDE. Om du vill aktivera AddressSanitizer för ett MSBuild-projekt högerklickar du på projektet i Prieskumník riešení och väljer Egenskaper. I dialogrutan egenskapssidor väljer du Konfigurationsegenskaper>C/C++>Allmäntoch ändrar sedan egenskapen Aktivera AddressSanitizer. Välj OK för att spara ändringarna.

Om du vill skapa från IDE väljer du bort alla inkompatibla alternativ. För ett befintligt projekt som har kompilerats med hjälp av /Od (eller i felsökningsläge) kan du behöva stänga av följande alternativ:

• Inaktivera /ZI (felsökningsinformationsformat)
• Stäng av /RTC1 (körningskontroller)
• Inaktivera /INCREMENTAL (inkrementell länkning)

Om du vill skapa och köra felsökningsprogrammet trycker du på F5. Ett kastat undantag visas i Visual Studio.

Använda AddressSanitizer från Visual Studio: CMake

Så här aktiverar du AddressSanitizer för ett CMake-projekt som skapats för att rikta in sig på Windows:

1. Öppna listrutan Konfigurationer i verktygsfältet överst i IDE och välj Hantera konfigurationer.

   

   Den här åtgärden öppnar redigeraren CMake Project Settings, som återspeglar innehållet i filen project CMakeSettings.json.

2. Välj länken Redigera JSON . Detta val växlar vyn till rå JSON.

3. Om du vill aktivera AddressSanitizer lägger du till följande kodfragment i förinställningen "windows-base" i "configurePresets":.

   "environment": {
     "CFLAGS": "/fsanitize=address",
     "CXXFLAGS": "/fsanitize=address"
   }
   

   "configurePresets" ser ut ungefär så här efteråt:

       "configurePresets": [
         {
           "name": "windows-base",
           "hidden": true,
           "generator": "Ninja",
           "binaryDir": "${sourceDir}/out/build/${presetName}",
           "installDir": "${sourceDir}/out/install/${presetName}",
           "cacheVariables": {
             "CMAKE_C_COMPILER": "cl.exe",
             "CMAKE_CXX_COMPILER": "cl.exe"
           },
           "condition": {
             "type": "equals",
             "lhs": "${hostSystemName}",
             "rhs": "Windows"
           },
           "environment": {
             "CFLAGS": "/fsanitize=address",
             "CXXFLAGS": "/fsanitize=address"
           }
         },
   

4. AddressSanitizer fungerar inte om edit-and-continue har angetts (/ZI), vilket är aktiverat som standard för nya CMake-projekt. I CMakeLists.txtkommenterar du ut (prefix med #) raden som börjar med set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT". Den linjen ser ut ungefär så här:

   # set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "$<IF:$<AND:$<C_COMPILER_ID:MSVC>,$<CXX_COMPILER_ID:MSVC>>,$<$<CONFIG:Debug,RelWithDebInfo>:EditAndContinue>,$<$<CONFIG:Debug,RelWithDebInfo>:ProgramDatabase>>")
   

5. Använd Ctrl+S för att spara den här JSON-filen.

6. Rensa CMake-cachekatalogen och konfigurera om genom att välja från Visual Studio-menyn: Project>Ta bort cache och Konfigurera om. Välj Ja när kommandotolken visas för att rensa cachekatalogen och konfigurera om.

7. Ersätt innehållet i källfilen, till exempel CMakeProject1.cpp, med följande kod:

   // CMakeProject1.cpp : Defines the entry point for the application
   
   #include <stdio.h>
   
   int x[100];
   
   int main()
   {
       printf("Hello!\n");
       x[100] = 5; // Boom!
       return 0;
   }
   

8. Välj F5- för att kompilera om och köra under felsökningsprogrammet.

   Den här skärmbilden fångar upp felet från CMake-versionen.

   

AddressSanitizer kraschdumpar

AddressSanitizer innehåller funktioner för användning med molnbaserade och distribuerade arbetsflöden. Den här funktionen tillåter offlinevisning av ett AddressSanitizer-fel i IDE. Felet läggs över ovanpå källan, precis som du skulle uppleva i en live-felsökningssession.

Dessa dumpfiler kan leda till effektivitetsvinster när du analyserar en bugg. Du behöver inte köra igen, hitta fjärrdata eller leta efter en dator som gick offline.

Så här skapar du en dumpfil som du kan visa i Visual Studio på en annan dator vid ett senare tillfälle:

set ASAN_SAVE_DUMPS=MyFileName.dmp

Från och med Visual Studio 16.9 kan du visa en exakt diagnostiserat fel som lagras i filen *.dmp ovanpå källkoden.

Den här funktionen för kraschdumpar möjliggör molnbaserade arbetsflöden eller distribuerad testning. Den kan också användas för att skapa en detaljerad, åtgärdsbar bugg i alla scenarier.

Exempelfel

AddressSanitizer kan identifiera flera typer av fel vid minnesanvändning. Här är många av körningsfelen som rapporteras när du kör binärfilerna som kompilerats med hjälp av kompileringsalternativet AddressSanitizer (/fsanitize=address) :

• alloc-dealloc-mismatch
• allocation-size-too-big
• calloc-overflow
• double-free
• dynamic-stack-buffer-overflow
• global-buffer-overflow
• heap-buffer-overflow
• heap-use-after-free
• invalid-allocation-alignment
• memcpy-param-overlap
• new-delete-type-mismatch
• stack-buffer-overflow
• stack-buffer-underflow
• stack-use-after-return
• stack-use-after-scope
• strncat-param-overlap
• use-after-poison

Mer information om exemplen finns i AddressSanitizer-felexempel.

Skillnader med Clang 12.0

MSVC skiljer sig för närvarande från Clang 12.0 i två funktionella områden:

• stack-use-after-scope: den här inställningen är aktiverad som standard och kan inte stängas av.
• stack-use-after-return: Den här funktionen kräver ett extra kompilatoralternativ och är inte tillgängligt genom att bara ange ASAN_OPTIONS.

Dessa beslut fattades för att minska den testmatris som krävs för att leverera den första versionen.

Funktioner som kunde leda till falska positiva resultat i Visual Studio 2019 16.9 inkluderades inte. Den disciplinen framtvingade den effektiva testintegritet som krävdes när man övervägde interop med årtionden av befintlig kod. Fler funktioner kan övervägas i senare versioner:

• Initieringsordningsproblem
• överflöde i intra-objekt
• containeröverfyllnad
• pekarens subtraktion/jämförelse

Mer information finns i Building for AddressSanitizer with MSVC.

Branschdokumentation

Det finns omfattande dokumentation för dessa språk- och plattformsberoende implementeringar av AddressSanitizer-tekniken.

• Google
• Apple
• GCC

Det här viktiga dokumentet om AddressSanitizer (extern) beskriver implementeringen.

Se även

• AddressSanitizer kända problem
• AddressSanitizer-bygg- och språkreferens
• AddressSanitizer-körningsreferens
• AddressSanitizer skuggbitar
• AddressSanitizer-moln eller distribuerad testning
• Integrering av AddressSanitizer för felsökning
• AddressSanitizer-felexempel