Merge pull request #3433 from MicrosoftDocs/master

3/8/2021 AM Publish

Author: Taojunshen

docs/_breadcrumb/toc.yml

@@ -58,6 +58,9 @@
     - name: Code analysis
       tocHref: /cpp/code-quality/
       topicHref: /cpp/code-quality/index
+    - name: Code sanitizers
+      tocHref: /cpp/sanitizers/
+      topicHref: /cpp/sanitizers/index
     - name: C++ language
       tocHref: /cpp/cpp/
       topicHref: /cpp/cpp/index

docs/build/cmakesettings-reference.md

@@ -25,8 +25,8 @@ The `configurations` array contains all the configurations for a CMake project.
 
 A `configuration` has these properties:
 
-- `addressSanitizerEnabled`: if **`true`** compiles the program with Address Sanitizer (Experimental on Windows). On Linux, compile with -fno-omit-frame-pointer and compiler optimization level -Os or -Oo for best results.
-- `addressSanitizerRuntimeFlags`: runtime flags passed to AddressSanitizer via the ASAN_OPTIONS environment variable. Format: flag1=value:flag2=value2.
+- `addressSanitizerEnabled`: if **`true`** compiles the program with [AddressSanitizer](../sanitizers/asan.md). On Linux, compile with -fno-omit-frame-pointer and compiler optimization level -Os or -Oo for best results.
+- `addressSanitizerRuntimeFlags`: runtime flags passed to [AddressSanitizer](../sanitizers/asan.md) via the ASAN_OPTIONS environment variable. Format: flag1=value:flag2=value2.
 - `buildCommandArgs`: specifies native build switches passed to CMake after --build --. For example, passing -v when using the Ninja generator forces Ninja to output command lines. See [Ninja command line arguments](#ninja) for more information on Ninja commands.
 - `buildRoot`:  specifies the directory in which CMake generates build scripts for the chosen generator.  Maps to **-DCMAKE_BINARY_DIR** switch and specifies where *CMakeCache.txt* will be created. If the folder does not exist, it is created. Supported macros include `${workspaceRoot}`, `${workspaceHash}`, `${projectFile}`, `${projectDir}`, `${thisFile}`, `${thisFileDir}`, `${name}`, `${generator}`, `${env.VARIABLE}`.
 - `cacheGenerationCommand`: specifies a command line tool and arguments, for example *gencache.bat debug* to generate the cache. The command is run from the shell in the specified environment for the configuration when the user explicitly requests regeneration, or a CMakeLists.txt or CMakeSettings.json file is modified.

docs/build/reference/compiler-options-listed-alphabetically.md

@@ -49,6 +49,7 @@ This table contains an alphabetical list of compiler options. For a list of comp
 | [`/Fp`](fp-name-dot-pch-file.md) | Specifies a precompiled header file name. |
 | [`/FR`](fr-fr-create-dot-sbr-file.md)<br /><br /> [`/Fr`](fr-fr-create-dot-sbr-file.md) | Generates browser files. **`/Fr`** is deprecated. |
 | [`/FS`](fs-force-synchronous-pdb-writes.md) | Forces serialization of all writes to the program database (PDB) file through MSPDBSRV.EXE. |
+| [`/fsanitize`](fsanitize.md) | Enables compilation of sanitizer instrumentation such as AddressSanitizer. |
 | [`/FU`](fu-name-forced-hash-using-file.md) | Forces the use of a file name as if it had been passed to the [`#using`](../../preprocessor/hash-using-directive-cpp.md) directive. |
 | [`/Fx`](fx-merge-injected-code.md) | Merges injected code with source file. |
 | [`/GA`](ga-optimize-for-windows-application.md) | Optimizes code for Windows application. |

docs/build/reference/compiler-options-listed-by-category.md

@@ -155,6 +155,7 @@ This article contains a categorical list of compiler options. For an alphabetica
 | [`/errorReport`](errorreport-report-internal-compiler-errors.md) | Deprecated. Error reporting is controlled by [Windows Error Reporting (WER)](/windows/win32/wer/windows-error-reporting) settings. |
 | [`/FC`](fc-full-path-of-source-code-file-in-diagnostics.md) | Displays the full path of source code files passed to *cl.exe* in diagnostic text. |
 | [`/FS`](fs-force-synchronous-pdb-writes.md) | Forces writes to the PDB file to be serialized through *MSPDBSRV.EXE*. |
+| [`/fsanitize`](fsanitize.md) | Enables compilation of sanitizer instrumentation such as AddressSanitizer. |
 | [`/H`](h-restrict-length-of-external-names.md) | Deprecated. Restricts the length of external (public) names. |
 | [`/HELP`](help-compiler-command-line-help.md) | Lists the compiler options. |
 | [`/J`](j-default-char-type-is-unsigned.md) | Changes the default **`char`** type. |

docs/build/reference/fsanitize.md

@@ -0,0 +1,57 @@
+---
+description: "Learn more about the /fsanitize (enable sanitizers) compiler option"
+title: "/fsanitize (Enable sanitizers)"
+ms.date: 02/24/2021
+f1_keywords: ["/fsanitize", "-fsanitize", "/fsanitize=address", "/fsanitize-address-use-after-return", "-fsanitize-address-use-after-return", "/fno-sanitize-address-vcasan-lib", "-fno-sanitize-address-vcasan-lib"]
+helpviewer_keywords: ["/fsanitize [C++]", "-fsanitize=address [C++]", "address sanitizer compiler option [C++]", "/fsanitize-address-use-after-return", "/fno-sanitize-address-vcasan-lib"]
+---
+# `/fsanitize` (Enable sanitizers)
+
+Use the **`/fsanitize`** compiler options to enable sanitizers. As of Visual Studio 2019 16.9, the only supported sanitizer is [AddressSanitizer](../../sanitizers/asan.md).
+
+## Syntax
+
+> **`/fsanitize=address`**\
+> **`/fsanitize-address-use-after-return`**\
+> **`/fno-sanitize-address-vcasan-lib`**
+
+## Remarks
+
+The **`/fsanitize=address`** compiler option enables [AddressSanitizer](../../sanitizers/asan.md), a powerful compiler and runtime technology to light up [hard-to-find bugs](../../sanitizers/asan.md#error-types).
+
+The **`/fsanitize-address-use-after-return`** and **`/fno-sanitize-address-vcasan-lib`** compiler options, and the [`/INFERASANLIBS` (Use inferred sanitizer libs)](./inferasanlibs.md) and **`/INFERASANLIBS:NO`** linker options offer support for advanced users. For more information, see [AddressSanitizer build and language reference](../../sanitizers/asan-building.md).
+
+The **`/fsanitize`** options are available beginning in Visual Studio 2019 version 16.9.
+
+### To set the **`/fsanitize=address`** compiler option in the Visual Studio development environment
+
+1. Open your project's **Property Pages** dialog box.
+
+1. Select the **Configuration Properties** > **C/C++** > **General** property page.
+
+1. Modify the **Enable Address Sanitizer** property. To enable it, choose **Yes (/fsanitize=address)**.
+
+1. Choose **OK** or **Apply** to save your changes.
+
+### To set the advanced compiler options
+
+1. Open your project's **Property Pages** dialog box.
+
+1. Select the **Configuration Properties** > **C/C++** > **Command Line** property page.
+
+1. Modify the **Additional Options** property to set **/fsanitize-address-use-after-return** or **/fno-sanitize-address-vcasan-lib**.
+
+1. Choose **OK** or **Apply** to save your changes.
+
+### To set this compiler option programmatically
+
+- See <xref:Microsoft.VisualStudio.VCProjectEngine.VCCLCompilerTool.AdditionalOptions%2A>.
+
+## See also
+
+[MSVC compiler options](compiler-options.md)\
+[MSVC compiler command-line syntax](compiler-command-line-syntax.md)\
+[`/INFERASANLIBS` (Use inferred sanitizer libs)](./inferasanlibs.md)\
+[AddressSanitizer overview](../../sanitizers/asan.md)\
+[AddressSanitizer known issues](../../sanitizers/asan-known-issues.md)\
+[AddressSanitizer build and language reference](../../sanitizers/asan-building.md)

docs/build/reference/inferasanlibs.md

@@ -0,0 +1,45 @@
+---
+description: "Learn more about the /INFERASANLIBS (Use inferred sanitizer libs) linker option"
+title: "/INFERASANLIBS (Use inferred sanitizer libs)"
+ms.date: 03/01/2021
+f1_keywords: ["/INFERASANLIBS", "/INFERASANLIBS:NO"]
+helpviewer_keywords: ["/INFERASANLIBS [C++]", "address sanitizer [C++] linker option"]
+---
+# `/INFERASANLIBS` (Use inferred sanitizer libs)
+
+Use the **`/INFERASANLIBS`** linker option to enable or disable linking to the default AddressSanitizer libraries. As of Visual Studio 2019 16.9, the only supported sanitizer is [AddressSanitizer](../../sanitizers/asan.md).
+
+## Syntax
+
+> **`/INFERASANLIBS`**\[**`:NO`**]
+
+## Remarks
+
+The **`/INFERASANLIBS`** linker option enables the default [AddressSanitizer](../../sanitizers/asan.md) libraries. This option is enabled by default.
+
+The **`/INFERASANLIBS`** and **`/INFERASANLIBS:NO`** linker options offer support for advanced users. For more information, see [AddressSanitizer build and language reference](../../sanitizers/asan-building.md).
+
+The **`/INFERASANLIBS`** option is available beginning in Visual Studio 2019 version 16.9.
+
+### To set the **`/INFERASANLIBS`** linker option in the Visual Studio development environment
+
+1. Open your project's **Property Pages** dialog box.
+
+1. Select the **Configuration Properties** > **Linker** > **Command Line** property page.
+
+1. Modify the **Additional Options** property. To enable default libraries, enter **/INFERASANLIBS** in the edit box. To disable default libraries, enter **/INFERASANLIBS:NO** instead.
+
+1. Choose **OK** or **Apply** to save your changes.
+
+### To set this linker option programmatically
+
+- See <xref:Microsoft.VisualStudio.VCProjectEngine.VCLinkerTool.AdditionalOptions%2A>.
+
+## See also
+
+[MSVC linker reference](linking.md)\
+[MSVC linker options](linker-options.md)\
+[`/fsanitize` (Enable sanitizers)](./fsanitize.md)\
+[AddressSanitizer overview](../../sanitizers/asan.md)\
+[AddressSanitizer known issues](../../sanitizers/asan-known-issues.md)\
+[AddressSanitizer build and language reference](../../sanitizers/asan-building.md)

docs/build/reference/linker-options.md

@@ -72,6 +72,7 @@ You can use the [comment](../../preprocessor/comment-c-cpp.md) pragma to specify
 |[/IMPLIB](implib-name-import-library.md)|Overrides the default import library name.|
 |[/INCLUDE](include-force-symbol-references.md)|Forces symbol references.|
 |[/INCREMENTAL](incremental-link-incrementally.md)|Controls incremental linking.|
+|[/INFERASANLIBS](inferasanlibs.md)|Uses inferred sanitizer libraries.|
 |[/INTEGRITYCHECK](integritycheck-require-signature-check.md)|Specifies that the module requires a signature check at load time.|
 |[/KEYCONTAINER](keycontainer-specify-a-key-container-to-sign-an-assembly.md)|Specifies a key container to sign an assembly.|
 |[/KEYFILE](keyfile-specify-key-or-key-pair-to-sign-an-assembly.md)|Specifies a key or key pair to sign an assembly.|

docs/build/reference/unicode-support-in-the-compiler-and-linker.md

@@ -1,13 +1,13 @@
 ---
-description: "Learn more about: Unicode Support in the Compiler and Linker"
+description: "Learn more about: Unicode support in the compiler and linker"
 title: "Unicode Support in the Compiler and Linker"
-ms.date: "12/15/2017"
+ms.date: 03/07/2021
 f1_keywords: ["VC.Project.VCLinkerTool.UseUnicodeResponseFiles", "VC.Project.VCLibrarianTool.UseUnicodeResponseFiles", "VC.Project.VCCLCompilerTool.UseUnicodeResponseFiles", "VC.Project.VCXDCMakeTool.UseUnicodeResponseFiles"]
 helpviewer_keywords: ["Unicode, Visual C++"]
 ---
-# Unicode Support in the Compiler and Linker
+# Unicode support in the compiler and linker
 
-Most Visual C++ build tools support Unicode inputs and outputs.
+Most Microsoft C/C++ (MSVC) build tools support Unicode inputs and outputs.
 
 ## Filenames
 
@@ -25,17 +25,21 @@ Unicode can be input into a source code file in the following encodings:
 
 - UTF-8 with BOM
 
+In the Visual Studio IDE, you can save files in several encoding formats, including Unicode ones. Save them in the **Save File As** dialog by using the dropdown on the **Save** button. Select **Save with Encoding** in the dropdown. Then, in the **Advanced Save Options** dialog, select an encoding from the dropdown list. Choose **OK** to save the file.
+
 ## Output
 
 During compilation, the compiler outputs diagnostics to the console in UTF-16.  The characters that can be displayed at your console depend on the console window properties.  Compiler output redirected to a file is in the current ANSI console codepage.
 
-## Linker response files and .DEF files
+## Linker response files and `.DEF` files
+
+Response files and *`.DEF`* files can be either UTF-16 or UTF-8 with a BOM, or ANSI.
 
-Response files and DEF files can be either UTF-16 with a BOM, or ANSI.
+## `.asm` and `.cod` dumps
 
-## .asm and .cod dumps
+*`.asm`* and *`.cod`* dumps are in ANSI by default for compatibility with MASM. Use [`/FAu`](fa-fa-listing-file.md) to output UTF-8.
 
-.asm and .cod dumps are in ANSI by default for compatibility with MASM. Use [/FAu](fa-fa-listing-file.md) to output UTF-8. Note that if you specify **/FAs**, the intermingled source will just be directly printed and may look garbled, for example if source code is UTF-8 and you didn't specify **/FAsu**.
+If you specify **`/FAs`**, the intermingled source gets printed directly. It may look garbled, for example, when the source code is UTF-8 and you didn't specify **`/FAsu`**.
 
 ## See also
 

docs/build/toc.yml

@@ -339,6 +339,8 @@
   href: ../build/configuring-programs-for-windows-xp.md
 - name: Code analysis for C/C++
   href: ../code-quality/
+- name: "Code sanitizers for C/C++"
+  href: ../sanitizers/
 - name: Compiler and build tools reference
   expanded: false
   items: 
@@ -560,6 +562,8 @@
                   href: ../build/reference/fp-specify-floating-point-behavior.md
                 - name: /FS (Force synchronous PDB writes)
                   href: ../build/reference/fs-force-synchronous-pdb-writes.md
+                - name: /fsanitize (Enable sanitizers)
+                  href: ../build/reference/fsanitize.md
                 - name: /GA (Optimize for Windows application)
                   href: ../build/reference/ga-optimize-for-windows-application.md
                 - name: /Gd, /Gr, /Gv, /Gz (Calling convention)
@@ -939,6 +943,8 @@
               href: ../build/reference/ignore-ignore-specific-warnings.md
             - name: /IGNOREIDL (Don't process attributes into MIDL)
               href: ../build/reference/ignoreidl-don-t-process-attributes-into-midl.md
+            - name: /INFERASANLIBS (Use inferred sanitizer libs)
+              href: ../build/reference/inferasanlibs.md
             - name: /IMPLIB (Name import library)
               href: ../build/reference/implib-name-import-library.md
             - name: /INCLUDE (Force symbol references)

docs/c-runtime-library/c-run-time-library-reference.md

@@ -1,22 +1,18 @@
 ---
 title: "C runtime library reference"
 description: "Links to information and reference for the Microsoft C runtime library functions."
-ms.date: "10/05/2020"
+ms.date: "3/5/2021"
 f1_keywords: ["c.runtime"]
 helpviewer_keywords: ["CRT", "runtime libraries", "CRT, reference"]
-ms.assetid: a503e11c-8dca-4846-84fb-025a826c32b8
 ---
-# C runtime Library Reference
+# Microsoft C runtime library (CRT) reference
 
-The Microsoft runtime library provides routines for programming for the Microsoft Windows operating system. These routines automate many common programming tasks that are not provided by the C and C++ languages.
+The Microsoft runtime library provides routines for programming the Microsoft Windows operating system. These routines automate many common programming tasks that are not provided by the C and C++ languages.
 
 Sample programs are included in the individual reference topics for most routines in the library.
 
 ## In This Section
 
-[C Runtime libraries](crt-library-features.md)\
-Discusses the .lib files that comprise the C runtime libraries.
-
 [Universal C runtime routines by category](run-time-routines-by-category.md)\
 Provides links to the runtime library by category.
 
@@ -41,6 +37,9 @@ Provides links to the C runtime library functions, organized by function family.
 [Language and country/region strings](locale-names-languages-and-country-region-strings.md)\
 Describes how to use the `setlocale` function to set the language and Country/Region strings.
 
+[C runtime (CRT) and C++ Standard Library `.lib` files](crt-library-features.md)\
+Discusses the `.lib` files that make up the C runtime libraries and their associated compiler options and preprocessor directives.
+
 ## Related Sections
 
 [Debug routines](debug-routines.md)\