diff --git a/clang/docs/analyzer/images/analyzer_html.png b/clang/docs/analyzer/images/analyzer_html.png new file mode 100644 index 00000000000000..607ea1882e71b4 Binary files /dev/null and b/clang/docs/analyzer/images/analyzer_html.png differ diff --git a/clang/docs/analyzer/images/analyzer_xcode.png b/clang/docs/analyzer/images/analyzer_xcode.png new file mode 100644 index 00000000000000..84c69809e8c391 Binary files /dev/null and b/clang/docs/analyzer/images/analyzer_xcode.png differ diff --git a/clang/docs/analyzer/images/scan_build_cmd.png b/clang/docs/analyzer/images/scan_build_cmd.png new file mode 100644 index 00000000000000..464fd4e129a208 Binary files /dev/null and b/clang/docs/analyzer/images/scan_build_cmd.png differ diff --git a/clang/docs/analyzer/user-docs.rst b/clang/docs/analyzer/user-docs.rst index 2292cec6944b1f..08cb5119e810bd 100644 --- a/clang/docs/analyzer/user-docs.rst +++ b/clang/docs/analyzer/user-docs.rst @@ -6,5 +6,9 @@ Contents: .. toctree:: :maxdepth: 2 + user-docs/Installation + user-docs/CommandLineUsage + user-docs/UsingWithXCode + user-docs/FilingBugs user-docs/CrossTranslationUnit user-docs/TaintAnalysisConfiguration diff --git a/clang/docs/analyzer/user-docs/CommandLineUsage.rst b/clang/docs/analyzer/user-docs/CommandLineUsage.rst new file mode 100644 index 00000000000000..d7f8253469df40 --- /dev/null +++ b/clang/docs/analyzer/user-docs/CommandLineUsage.rst @@ -0,0 +1,239 @@ +Command Line Usage: scan-build and CodeChecker +============================================== + +This document provides guidelines for running the static analyzer from the command line on whole projects. +CodeChecker and scan-build are two CLI tools for using CSA on multiple files (tranlation units). +Both provide a way of driving the analyzer, detecting compilation flags, and generating reports. +CodeChecker is more actively maintained, provides heuristics for working with multiple versions of popular compilers and it also comes with a web-based GUI for viewing, filtering, categorizing and suppressing the results. +Therefore CodeChecker is recommended in case you need any of the above features or just more customizability in general. + +Comparison of CodeChecker and scan-build +---------------------------------------- + +The static analyzer is by design a GUI tool originally intended to be consumed by the XCode IDE. +Its purpose is to find buggy execution paths in the program, and such paths are very hard to comprehend by looking at a non-interactive standard output. +It is possible, however, to invoke the static analyzer from the command line in order to obtain analysis results, and then later view them interactively in a graphical interface. +The following tools are used commonly to run the analyzer from the command line. +Both tools are wrapper scripts to drive the analysis and the underlying invocations of the Clang compiler: + +1. scan-build_ is an old and simple command line tool that emits static analyzer warnings as HTML files while compiling your project. You can view the analysis results in your web browser. + - Useful for individual developers who simply want to view static analysis results at their desk, or in a very simple collaborative environment. + - Works on all major platforms (Windows, Linux, macOS) and is available as a package in many Linux distributions. + - Does not include support for cross-translation-unit analysis. + +2. CodeChecker_ is a driver and web server that runs the static analyzer on your projects on demand and maintains a database of issues. + - Perfect for managing large amounts of thee static analyzer warnings in a collaborative environment. + - Generally much more feature-rich than scan-build. + - Supports incremental analysis: Results can be stored in a database, subsequent analysis runs can be compared to list the newly added defects. + - :doc:`CrossTranslationUnit` is supported fully on Linux via CodeChecker. + - Can run clang-tidy checkers too. + - Open source, but out-of-tree, i.e. not part of the LLVM project. + +scan-build +---------- + +**scan-build** is a command line utility that enables a user to run the static analyzer over their codebase as part of performing a regular build (from the command line). + +How does it work? +~~~~~~~~~~~~~~~~~ + +During a project build, as source files are compiled they are also analyzed in tandem by the static analyzer. + +Upon completion of the build, results are then presented to the user within a web browser. + +Will it work with any build system? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**scan-build** has little or no knowledge about how you build your code. It works by overriding the ``CC`` and ``CXX`` environment variables to (hopefully) change your build to use a "fake" compiler instead of the one that would normally build your project. This fake compiler executes either ``clang`` or ``gcc`` (depending on the platform) to compile your code and then executes the static analyzer to analyze your code. + +This "poor man's interposition" works amazingly well in many cases and falls down in others. Please consult the information on this page on making the best use of **scan-build**, which includes getting it to work when the aforementioned hack fails to work. + +.. image:: ../images/scan_build_cmd.png + +.. image:: ../images/analyzer_html.png + +**Viewing static analyzer results in a web browser** + +Basic Usage +~~~~~~~~~~~ + +Basic usage of ``scan-build`` is designed to be simple: just place the word "scan-build" in front of your build command:: + + $ scan-build make + $ scan-build xcodebuild + +In the first case ``scan-build`` analyzes the code of a project built with ``make`` and in the second case ``scan-build`` analyzes a project built using ``xcodebuild``. + +Here is the general format for invoking ``scan-build``:: + + $ scan-build [scan-build options] [command options] + +Operationally, ``scan-build`` literally runs with all of the subsequent options passed to it. For example, one can pass ``-j4`` to ``make`` get a parallel build over 4 cores:: + + $ scan-build make -j4 + +In almost all cases, ``scan-build`` makes no effort to interpret the options after the build command; it simply passes them through. In general, ``scan-build`` should support parallel builds, but **not distributed builds**. + +It is also possible to use ``scan-build`` to analyze specific files:: + + $ scan-build gcc -c t1.c t2.c + +This example causes the files ``t1.c`` and ``t2.c`` to be analyzed. + +For Windows Users +~~~~~~~~~~~~~~~~~ + +Windows users must have Perl installed to use scan-build. + +``scan-build.bat`` script allows you to launch scan-build in the same way as it described in the Basic Usage section above. To invoke scan-build from an arbitrary location, add the path to the folder containing scan-build.bat to your PATH environment variable. + +If you have unexpected compilation/make problems when running scan-build with MinGW/MSYS the following information may be helpful: + +- If getting unexpected ``"fatal error: no input files"`` while building with MSYS make from the Windows cmd, try one of these solutions: + - Use MinGW ``mingw32-make`` instead of MSYS ``make`` and exclude the path to MSYS from PATH to prevent ``mingw32-make`` from using MSYS utils. MSYS utils are dependent on the MSYS runtime and they are not intended for being run from the Windows cmd. Specifically, makefile commands with backslashed quotes may be heavily corrupted when passed for execution. + - Run ``make`` from the sh shell:: + + $ scan-build [scan-build options] sh -c "make [make options]" + +- If getting ``"Error : *** target pattern contains no `%'"`` while using GNU Make 3.81, try to use another version of make. + +Other Options +~~~~~~~~~~~~~ + +As mentioned above, extra options can be passed to ``scan-build``. These options prefix the build command. For example:: + + $ scan-build -k -V make + $ scan-build -k -V xcodebuild + +Here is a subset of useful options: + +- **-o**: Target directory for HTML report files. Subdirectories will be created as needed to represent separate "runs" of the analyzer. If this option is not specified, a directory is created in ``/tmp`` to store the reports. +- **-h** *(or no arguments)*: Display all ``scan-build`` options. +- **-k**, **--keep-going**: Add a "keep on going" option to the specified build command. This option currently supports ``make`` and ``xcodebuild``. This is a convenience option; one can specify this behavior directly using build options. +- **-v**: Verbose output from scan-build and the analyzer. **A second and third "-v" increases verbosity**, and is useful for filing bug reports against the analyzer. +- **-V**: View analysis results in a web browser when the build command completes. +- **--use-analyzer Xcode** *(or)* **--use-analyzer [path to clang]**: ``scan-build`` uses the 'clang' executable relative to itself for static analysis. One can override this behavior with this option by using the 'clang' packaged with Xcode (on OS X) or from the PATH. + +A complete list of options can be obtained by running ``scan-build`` with no arguments. + +Output of scan-build +~~~~~~~~~~~~~~~~~~~~ + +The output of scan-build is a set of HTML files, each one which represents a separate bug report. A single ``index.html`` file is generated for surveying all of the bugs. You can then just open ``index.html`` in a web browser to view the bug reports. + +Where the HTML files are generated is specified with a **-o** option to ``scan-build``. If **-o** isn't specified, a directory in ``/tmp`` is created to store the files (``scan-build`` will print a message telling you where they are). If you want to view the reports immediately after the build completes, pass **-V** to ``scan-build``. + +Recommended Usage Guidelines +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This section describes a few recommendations with running the analyzer. + +Always Analyze a Project in its "Debug" Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Most projects can be built in a "debug" mode that enables assertions. Assertions are picked up by the static analyzer to prune infeasible paths, which in some cases can greatly reduce the number of false positives (bogus error reports) emitted by the tool. + +Another option is to use ``--force-analyze-debug-code`` flag of **scan-build** tool which would enable assertions automatically. + +Use Verbose Output when Debugging scan-build +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +``scan-build`` takes a **-v** option to emit verbose output about what it's doing; two **-v** options emit more information. Redirecting the output of ``scan-build`` to a text file (make sure to redirect standard error) is useful for filing bug reports against ``scan-build`` or the analyzer, as we can see the exact options (and files) passed to the analyzer. For more comprehensible logs, don't perform a parallel build. + +Run './configure' through scan-build +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If an analyzed project uses an autoconf generated ``configure`` script, you will probably need to run ``configure`` script through ``scan-build`` in order to analyze the project. + +**Example**:: + + $ scan-build ./configure + $ scan-build --keep-cc make + +The reason ``configure`` also needs to be run through ``scan-build`` is because ``scan-build`` scans your source files by *interposing* on the compiler. This interposition is currently done by ``scan-build`` temporarily setting the environment variable ``CC`` to ``ccc-analyzer``. The program ``ccc-analyzer`` acts like a fake compiler, forwarding its command line arguments over to the compiler to perform regular compilation and ``clang`` to perform static analysis. + +Running ``configure`` typically generates makefiles that have hardwired paths to the compiler, and by running ``configure`` through ``scan-build`` that path is set to ``ccc-analyzer``. + +Analyzing iPhone Projects +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Conceptually Xcode projects for iPhone applications are nearly the same as their cousins for desktop applications. **scan-build** can analyze these projects as well, but users often encounter problems with just building their iPhone projects from the command line because there are a few extra preparative steps they need to take (e.g., setup code signing). + +Recommendation: use "Build and Analyze" +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The absolute easiest way to analyze iPhone projects is to use the `Analyze feature in Xcode `_ (which is based on the static analyzer). There a user can analyze their project right from a menu without most of the setup described later. + +`Instructions are available <../xcode.html>`_ on this website on how to use open source builds of the analyzer as a replacement for the one bundled with Xcode. + +Using scan-build directly +~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you wish to use **scan-build** with your iPhone project, keep the following things in mind: + +- Analyze your project in the ``Debug`` configuration, either by setting this as your configuration with Xcode or by passing ``-configuration Debug`` to ``xcodebuild``. +- Analyze your project using the ``Simulator`` as your base SDK. It is possible to analyze your code when targeting the device, but this is much easier to do when using Xcode's *Build and Analyze* feature. +- Check that your code signing SDK is set to the simulator SDK as well, and make sure this option is set to ``Don't Code Sign``. + +Note that you can most of this without actually modifying your project. For example, if your application targets iPhoneOS 2.2, you could run **scan-build** in the following manner from the command line:: + + $ scan-build xcodebuild -configuration Debug -sdk iphonesimulator2.2 + +Alternatively, if your application targets iPhoneOS 3.0:: + + $ scan-build xcodebuild -configuration Debug -sdk iphonesimulator3.0 + +Gotcha: using the right compiler +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Recall that **scan-build** analyzes your project by using a compiler to compile the project and ``clang`` to analyze your project. The script uses simple heuristics to determine which compiler should be used (it defaults to ``clang`` on Darwin and ``gcc`` on other platforms). When analyzing iPhone projects, **scan-build** may pick the wrong compiler than the one Xcode would use to build your project. For example, this could be because multiple versions of a compiler may be installed on your system, especially if you are developing for the iPhone. + +When compiling your application to run on the simulator, it is important that **scan-build** finds the correct version of ``gcc/clang``. Otherwise, you may see strange build errors that only happen when you run ``scan-build``. + +**scan-build** provides the ``--use-cc`` and ``--use-c++`` options to hardwire which compiler scan-build should use for building your code. Note that although you are chiefly interested in analyzing your project, keep in mind that running the analyzer is intimately tied to the build, and not being able to compile your code means it won't get fully analyzed (if at all). + +If you aren't certain which compiler Xcode uses to build your project, try just running ``xcodebuild`` (without **scan-build**). You should see the full path to the compiler that Xcode is using, and use that as an argument to ``--use-cc``. + +CodeChecker +----------- + +Basic Usage +~~~~~~~~~~~ + +Install CodeChecker as described here: `CodeChecker Install Guide `_. + +Create a compilation database. If you use cmake then pass the ``-DCMAKE_EXPORT_COMPILE_COMMANDS=1`` parameter to cmake. Cmake will create a ``compile_commands.json`` file. +If you have a Makefile based or similar build system then you can log the build commands with the help of CodeChecker:: + + make clean + CodeChecker log -b "make" -o compile_commands.json + +Analyze your project:: + + CodeChecker analyze compile_commands.json -o ./reports + +View the analysis results. +Print the detailed results in the command line:: + + CodeChecker parse --print-steps ./reports + +Or view the detailed results in a browser:: + + CodeChecker parse ./reports -e html -o ./reports_html + firefox ./reports_html/index.html + +Optional: store the analysis results in a DB:: + + mkdir ./ws + CodeChecker server -w ./ws -v 8555 & + CodeChecker store ./reports --name my-project --url http://localhost:8555/Default + +Optional: manage (categorize, suppress) the results in your web browser:: + + firefox http://localhost:8555/Default + +Detailed Usage +~~~~~~~~~~~~~~ + +For extended documentation please refer to the `official site of CodeChecker `_! + diff --git a/clang/docs/analyzer/user-docs/FilingBugs.rst b/clang/docs/analyzer/user-docs/FilingBugs.rst new file mode 100644 index 00000000000000..4fd7100b38d421 --- /dev/null +++ b/clang/docs/analyzer/user-docs/FilingBugs.rst @@ -0,0 +1,18 @@ +Filing Bugs and Feature Requests +================================ + +We encourage users to file bug reports for any problems that they encounter. +We also welcome feature requests. When filing a bug report, please do the +following: + +- Include the checker build (for prebuilt Mac OS X binaries) or the git hash. + +- Provide a self-contained, reduced test case that exhibits the issue you are + experiencing. + +- Test cases don't tell us everything. Please briefly describe the problem you + are seeing, including what you thought should have been the expected behavior + and why. + +Please `file bugs and feature requests `_ +in `LLVM's issue tracker `_ and label the report with the ``clang:static analyzer`` label. diff --git a/clang/docs/analyzer/user-docs/Installation.rst b/clang/docs/analyzer/user-docs/Installation.rst new file mode 100644 index 00000000000000..f1656fc80c2e30 --- /dev/null +++ b/clang/docs/analyzer/user-docs/Installation.rst @@ -0,0 +1,37 @@ +Obtaining the Static Analyzer +============================= + +This page describes how to download and install the analyzer. Once the analyzer is installed, follow the :doc:`CommandLineUsage` on using the command line to get started analyzing your code. + +.. contents:: + :local: + + +Building the Analyzer from Source +--------------------------------- + +Currently there are no officially supported binary distributions for the static analyzer. +You must build Clang and LLVM manually. +To do so, please follow the instructions for `building Clang from source code `_. + +Once the Clang is built, you need to add the location of the ``clang`` binary and the locations of the command line utilities (`CodeChecker` or ``scan-build`` and ``scan-view``) to you PATH for :doc:`CommandLineUsage`. + +[Legacy] Packaged Builds (Mac OS X) +----------------------------------- + +Semi-regular pre-built binaries of the analyzer used to be available on Mac OS X. These were built to run on OS X 10.7 and later. + +For older builds for MacOS visit https://clang-analyzer.llvm.org/release_notes.html. + +Packaged builds for other platforms may eventually be provided, but we need volunteers who are willing to help provide such regular builds. If you wish to help contribute regular builds of the analyzer on other platforms, please get in touch via `LLVM Discourse `_. + +[Legacy] Using Packaged Builds +------------------------------ + +To use the legacy pacakge builds, simply unpack it anywhere. If the build archive has the name **``checker-XXX.tar.bz2``** then the archive will expand to a directory called **``checker-XXX``**. You do not need to place this directory or the contents of this directory in any special place. Uninstalling the analyzer is as simple as deleting this directory. + +Most of the files in the **``checker-XXX``** directory will be supporting files for the analyzer that you can simply ignore. Most users will only care about two files, which are located at the top of the **``checker-XXX``** directory: + +* **scan-build**: ``scan-build`` is the high-level command line utility for running the analyzer +* **scan-view**: ``scan-view`` a companion command line utility to ``scan-build``, ``scan-view`` is used to view analysis results generated by ``scan-build``. There is an option that one can pass to ``scan-build`` to cause ``scan-view`` to run as soon as it the analysis of a build completes + diff --git a/clang/docs/analyzer/user-docs/UsingWithXCode.rst b/clang/docs/analyzer/user-docs/UsingWithXCode.rst new file mode 100644 index 00000000000000..d4f76afa9fb9a8 --- /dev/null +++ b/clang/docs/analyzer/user-docs/UsingWithXCode.rst @@ -0,0 +1,88 @@ +Running the analyzer within Xcode +================================= + +.. contents:: + :local: + +Since Xcode 3.2, users have been able to run the static analyzer `directly within Xcode `_. + +It integrates directly with the Xcode build system and presents analysis results directly within Xcode's editor. + +Can I use the open source analyzer builds with Xcode? +----------------------------------------------------- + +**Yes**. Instructions are included below. + +.. image:: ../images/analyzer_xcode.png + +**Viewing static analyzer results in Xcode** + +Key features: +------------- + +- **Integrated workflow:** Results are integrated within Xcode. There is no experience of using a separate tool, and activating the analyzer requires a single keystroke or mouse click. +- **Transparency:** Works effortlessly with Xcode projects (including iPhone projects). +- **Cons:** Doesn't work well with non-Xcode projects. For those, consider :doc:`CommandLineUsage`. + +Getting Started +--------------- + +Xcode is available as a free download from Apple on the `Mac App Store `_, with `instructions available `_ for using the analyzer. + +Using open source analyzer builds with Xcode +-------------------------------------------- + +By default, Xcode uses the version of ``clang`` that came bundled with it to analyze your code. It is possible to change Xcode's behavior to use an alternate version of ``clang`` for this purpose while continuing to use the ``clang`` that came with Xcode for compiling projects. + +Why try open source builds? +---------------------------- + +The advantage of using open source analyzer builds (provided on this website) is that they are often newer than the analyzer provided with Xcode, and thus can contain bug fixes, new checks, or simply better analysis. + +On the other hand, new checks can be experimental, with results of variable quality. Users are encouraged to file bug reports (for any version of the analyzer) where they encounter false positives or other issues here: :doc:`FilingBugs`. + +set-xcode-analyzer +------------------ + +Starting with analyzer build checker-234, analyzer builds contain a command line utility called ``set-xcode-analyzer`` that allows users to change what copy of ``clang`` that Xcode uses for analysis:: + + $ set-xcode-analyzer -h + Usage: set-xcode-analyzer [options] + + Options: + -h, --help show this help message and exit + --use-checker-build=PATH + Use the Clang located at the provided absolute path, + e.g. /Users/foo/checker-1 + --use-xcode-clang Use the Clang bundled with Xcode + +Operationally, **set-xcode-analyzer** edits Xcode's configuration files to point it to use the version of ``clang`` you specify for static analysis. Within this model it provides you two basic modes: + +- **--use-xcode-clang:** Switch Xcode (back) to using the ``clang`` that came bundled with it for static analysis. +- **--use-checker-build:** Switch Xcode to using the ``clang`` provided by the specified analyzer build. + +Things to keep in mind +---------------------- + +- You should quit Xcode prior to running ``set-xcode-analyzer``. +- You will need to run ``set-xcode-analyzer`` under **``sudo``** in order to have write privileges to modify the Xcode configuration files. + +Examples +-------- + +**Example 1**: Telling Xcode to use checker-235:: + + $ pwd + /tmp + $ tar xjf checker-235.tar.bz2 + $ sudo checker-235/set-xcode-analyzer --use-checker-build=/tmp/checker-235 + +Note that you typically won't install an analyzer build in ``/tmp``, but the point of this example is that ``set-xcode-analyzer`` just wants a full path to an untarred analyzer build. + +**Example 2**: Telling Xcode to use a very specific version of ``clang``:: + + $ sudo set-xcode-analyzer --use-checker-build=~/mycrazyclangbuild/bin/clang + +**Example 3**: Resetting Xcode to its default behavior:: + + $ sudo set-xcode-analyzer --use-xcode-clang diff --git a/clang/www/analyzer/codechecker.html b/clang/www/analyzer/codechecker.html index 469b3ceaebf8e3..6f6b4896c8f9b2 100644 --- a/clang/www/analyzer/codechecker.html +++ b/clang/www/analyzer/codechecker.html @@ -2,7 +2,9 @@ "http://www.w3.org/TR/html4/strict.dtd"> - CodeChecker: running the analyzer from the command line + The CodeChecker documentation has moved to clang.llvm.org + + @@ -13,61 +15,11 @@
-

CodeChecker: running the analyzer from the command line

+

The Codechecker documentation has moved to clang.llvm.org

+

This page is deprecated and will be removed in release 21.0

+The new site + -

Basic Usage

- -

-Install CodeChecker as described here: CodeChecker Install Guide. -

- -

-Create a compilation database. If you use cmake then pass the -DCMAKE_EXPORT_COMPILE_COMMANDS=1 parameter to cmake. Cmake will create a compile_commands.json file. -If you have a Makefile based or similar build system then you can log the build commands with the help of CodeChecker: -

-make clean
-CodeChecker log -b "make" -o compile_commands.json
-
-

- -

-Analyze your project. -

-CodeChecker analyze compile_commands.json -o ./reports
-
-

- -

-View the analysis results. -Print the detailed results in the command line: -

-CodeChecker parse --print-steps ./reports
-
-Or view the detailed results in a browser: -
-CodeChecker parse ./reports -e html -o ./reports_html
-firefox ./reports_html/index.html
-
-

- -

-Optional: store the analysis results in a DB. -

-mkdir ./ws
-CodeChecker server -w ./ws -v 8555 &
-CodeChecker store ./reports --name my-project --url http://localhost:8555/Default
-
-

- -

-Optional: manage (categorize, suppress) the results in your web browser: -

-firefox http://localhost:8555/Default
-
-

- -

Detailed Usage

- -

-For extended documentation please refer to the official site of CodeChecker! -

+
+ + diff --git a/clang/www/analyzer/command-line.html b/clang/www/analyzer/command-line.html index e536a7706eed79..a91829ed532b82 100644 --- a/clang/www/analyzer/command-line.html +++ b/clang/www/analyzer/command-line.html @@ -2,7 +2,9 @@ "http://www.w3.org/TR/html4/strict.dtd"> - Running the analyzer from the command line + The command line documentation has moved to clang.llvm.org + + @@ -13,55 +15,12 @@
-

Running the analyzer from the command line

+

The command line documentation has moved to clang.llvm.org

+

This page is deprecated and will be removed in release 21.0

+The new site + -

Static Analyzer is by design a GUI tool. Its purpose is to find buggy execution -paths in the program, and such paths are very hard to comprehend by looking at -a non-interactive standard output. It is possible, however, to invoke the -Static Analyzer from the command line in order to obtain analysis results, and -then later view them interactively in a graphical interface. The following -tools are used commonly to run the analyzer from the command line. Both tools -are wrapper scripts to drive the analysis and the underlying invocations of the -Clang compiler: -

    -
  1. Scan-Build - is an old and simple command-line tool that emits static analyzer warnings as HTML files while compiling your project. You can view the analysis results in your web browser. -
    2. -
      -
    • - Useful for individual developers who simply want to view static analysis results at their desk, or in a very simple collaborative environment. -
      • -
    • - Works on all major platforms (Windows, Linux, macOS) and is available as a package in many Linux distributions. -
      • -
    • - Does not include support for cross-translation-unit analysis. -
      • -
    -
  2. CodeChecker - is a web server that runs the Static Analyzer on your projects on demand and maintains a database of issues. -
    3. -
      -
    • - Perfect for managing large amounts of Static Analyzer warnings in a collaborative environment. -
      • -
    • - Generally much more feature-rich than scan-build. -
      • -
    • Supports incremental analysis: Results can be stored in a database, subsequent analysis runs can be compared to list the newly added defects.
      • -
    • Cross Translation Unit (CTU) analysis is supported fully on Linux via CodeChecker.
      • -
    • Can run clang-tidy checkers too.
      • -
    • Open source, but out-of-tree, i.e. not part of the LLVM project.
      • -
    -
-

- -

-

-

-

- -
- + + - + diff --git a/clang/www/analyzer/filing_bugs.html b/clang/www/analyzer/filing_bugs.html index f7183a9a0694b4..b78d9e798dad1a 100644 --- a/clang/www/analyzer/filing_bugs.html +++ b/clang/www/analyzer/filing_bugs.html @@ -2,8 +2,10 @@ "http://www.w3.org/TR/html4/strict.dtd"> + The filing bugs documentation has moved to clang.llvm.org + + - Filing Bugs and Feature Requests @@ -14,32 +16,11 @@
-

Filing Bugs and Feature Requests

+

The filing bugs documentation has moved to clang.llvm.org

+

This page is deprecated and will be removed in release 21.0

+The new site + -

We encourage users to file bug reports for any problems that they encounter. -We also welcome feature requests. When filing a bug report, please do the -following:

- -
    - -
  • Include the checker build (for prebuilt Mac OS X binaries) or the git hash. -
    • - -
  • Provide a self-contained, reduced test case that exhibits the issue you are -experiencing.
    • - -
  • Test cases don't tell us everything. Please briefly describe the problem you -are seeing, including what you thought should have been the expected behavior -and why.
    • - -
- -

Please file -bugs and feature requests in -LLVM's issue tracker -and label the report with the clang:static analyzer label.

- -
- + + - diff --git a/clang/www/analyzer/index.html b/clang/www/analyzer/index.html index 7beef7e912ccb8..ea0ed4967ec7cc 100644 --- a/clang/www/analyzer/index.html +++ b/clang/www/analyzer/index.html @@ -96,7 +96,7 @@

Download

Mac OS X

  • Latest build (10.8+):
    - + checker-279.tar.bz2 (built November 14, 2016)
  • Release notes
  • This build can be used both from the command line and from within Xcode
    • diff --git a/clang/www/analyzer/installation.html b/clang/www/analyzer/installation.html index cb3fa89264a956..b463677a703ca9 100644 --- a/clang/www/analyzer/installation.html +++ b/clang/www/analyzer/installation.html @@ -2,7 +2,9 @@ "http://www.w3.org/TR/html4/strict.dtd"> - Obtaining the Static Analyzer + The installation documentation has moved to clang.llvm.org + + @@ -13,98 +15,11 @@
    -

    Obtaining the Static Analyzer

    +

    The installation documentation has moved to clang.llvm.org

    +

    This page is deprecated and will be removed in release 21.0

    +The new site + -

    This page describes how to download and install the analyzer. Once -the analyzer is installed, follow the instructions on using scan-build to -get started analyzing your code.

    - -

    Packaged Builds (Mac OS X)

    - -

    Semi-regular pre-built binaries of the analyzer are available on Mac -OS X. These are built to run on OS X 10.7 and later.

    - -

    Builds are released frequently. Often the differences between build -numbers being a few bug fixes or minor feature improvements. When using -the analyzer, we recommend that you check back here occasionally for new -builds, especially if the build you are using is more than a couple -weeks old.

    - -

    The latest build is: - -

    - -

    Packaged builds for other platforms may eventually be provided, but -we need volunteers who are willing to help provide such regular builds. -If you wish to help contribute regular builds of the analyzer on other -platforms, please email the Clang -Developers' mailing list.

    - -

    Using Packaged Builds

    - -

    To use a package build, simply unpack it anywhere. If the build -archive has the name checker-XXX.tar.bz2 then the -archive will expand to a directory called checker-XXX. -You do not need to place this directory or the contents of this -directory in any special place. Uninstalling the analyzer is as simple -as deleting this directory.

    - -

    Most of the files in the checker-XXX directory will -be supporting files for the analyzer that you can simply ignore. Most -users will only care about two files, which are located at the top of -the checker-XXX directory:

    - -
      -
    • scan-build: scan-build is the high-level command line utility for running the analyzer
      • -
    • scan-view: scan-view a companion command line -utility to scan-build, scan-view is used to view -analysis results generated by scan-build. There is an option -that one can pass to scan-build to cause scan-view to -run as soon as it the analysis of a build completes
      • -
    - -

    Running scan-build

    - -

    For specific details on using scan-build, please see -scan-build's documentation.

    - -

    To run scan-build, either add the -checker-XXX directory to your path or specify a complete -path for scan-build when running it. It is also possible to use -a symbolic link to scan-build, such one located in a directory -in your path. When scan-build runs it will automatically -determine where to find its accompanying files.

    - -

    Other Platforms (Building the Analyzer from Source)

    - -

    For other platforms, you must build Clang and LLVM manually. To do -so, please follow the instructions for building Clang from -source code.

    - -

    Once the Clang is built, you need to add the following to your path:

    - -
      - -
    • The location of the clang binary. - -

      For example, if you built a Debug+Asserts build of LLVM/Clang (the -default), the resultant clang binary will be in $(OBJDIR)/Debug+Asserts/bin -(where $(OBJDIR) is often the same as the root source directory). You -can also do make install to install the LLVM/Clang libraries and -binaries to the installation directory of your choice (specified when you run -configure).

      • - -
    • The locations of the scan-build and scan-view -programs. - -

      These are installed via make install into the bin directory -when clang is built.

      • - -
    -
    - + + - diff --git a/clang/www/analyzer/latest_checker.html.incl b/clang/www/analyzer/latest_checker.html.incl deleted file mode 100644 index 439a245c8adabb..00000000000000 --- a/clang/www/analyzer/latest_checker.html.incl +++ /dev/null @@ -1 +0,0 @@ -checker-279.tar.bz2 (built November 14, 2016) diff --git a/clang/www/analyzer/scan-build.html b/clang/www/analyzer/scan-build.html index a2e5f6a532bd11..1d42ce00045d88 100644 --- a/clang/www/analyzer/scan-build.html +++ b/clang/www/analyzer/scan-build.html @@ -2,7 +2,9 @@ "http://www.w3.org/TR/html4/strict.dtd"> - scan-build: running the analyzer from the command line + The scan-build documentation has moved to clang.llvm.org + + @@ -13,371 +15,11 @@
    -

    scan-build: running the analyzer from the command line

    +

    The scan-build documentation has moved to clang.llvm.org

    +

    This page is deprecated and will be removed in release 21.0

    +The new site + - - -
    - -

    What is it?

    -

    scan-build is a command line utility that enables a user to run the -static analyzer over their codebase as part of performing a regular build (from -the command line).

    - -

    How does it work?

    -

    During a project build, as source files are compiled they are also analyzed -in tandem by the static analyzer.

    - -

    Upon completion of the build, results are then presented to the user within a -web browser.

    - -

    Will it work with any build system?

    -

    scan-build has little or no knowledge about how you build your code. -It works by overriding the CC and CXX environment variables to -(hopefully) change your build to use a "fake" compiler instead of the -one that would normally build your project. This fake compiler executes either -clang or gcc (depending on the platform) to compile your -code and then executes the static analyzer to analyze your code.

    - -

    This "poor man's interposition" works amazingly well in many cases -and falls down in others. Please consult the information on this page on making -the best use of scan-build, which includes getting it to work when the -aforementioned hack fails to work.

    - -    		 - scan-build
    - analyzer in browser -
    Viewing static analyzer results in a web browser -
    - -

    Contents

    - - - -

    Getting Started

    - -

    The scan-build command can be used to analyze an entire project by -essentially interposing on a project's build process. This means that to run the -analyzer using scan-build, you will use scan-build to analyze -the source files compiled by gcc/clang during a project build. -This means that any files that are not compiled will also not be analyzed.

    - -

    Basic Usage

    - -

    Basic usage of scan-build is designed to be simple: just place the -word "scan-build" in front of your build command:

    - -
    -$ scan-build make
-$ scan-build xcodebuild
-
    - -

    In the first case scan-build analyzes the code of a project built -with make and in the second case scan-build analyzes a project -built using xcodebuild.

    - -

    Here is the general format for invoking scan-build:

    - -
    -$ scan-build [scan-build options] <command> [command options]
-
    - -

    Operationally, scan-build literally runs <command> with all of the -subsequent options passed to it. For example, one can pass -j4 to -make get a parallel build over 4 cores:

    - -
    -$ scan-build make -j4
-
    - -

    In almost all cases, scan-build makes no effort to interpret the -options after the build command; it simply passes them through. In general, -scan-build should support parallel builds, but not distributed -builds.

    - -

    It is also possible to use scan-build to analyze specific -files:

    - -
    - $ scan-build gcc -c t1.c t2.c
-
    - -

    This example causes the files t1.c and t2.c to be analyzed. -

    - -

    For Windows Users

    - -

    Windows users must have Perl installed to use scan-build.

    - -

    scan-build.bat script allows you to launch scan-build in the same -way as it described in the Basic Usage section above. To invoke scan-build from -an arbitrary location, add the path to the folder containing scan-build.bat to -your PATH environment variable.

    - -

    If you have unexpected compilation/make problems when running scan-build -with MinGW/MSYS the following information may be helpful:

    - -
      -
    • If getting unexpected "fatal error: no input files" while -building with MSYS make from the Windows cmd, try one of these solutions:
      • -
        -
      • Use MinGW mingw32-make instead of MSYS make and -exclude the path to MSYS from PATH to prevent mingw32-make from using -MSYS utils. MSYS utils are dependent on the MSYS runtime and they are not -intended for being run from the Windows cmd. Specifically, makefile commands -with backslashed quotes may be heavily corrupted when passed for execution.
        • -
      • Run make from the sh shell: -
        -$ scan-build [scan-build options] sh -c "make [make options]"
-
        • -
      -
    • If getting "Error : *** target pattern contains no `%'" while -using GNU Make 3.81, try to use another version of make.
      • -
    - -

    Other Options

    - -

    As mentioned above, extra options can be passed to scan-build. These -options prefix the build command. For example:

    - -
    - $ scan-build -k -V make
- $ scan-build -k -V xcodebuild
-
    - -

    Here is a subset of useful options:

    - - - - - - - - - - - - - - - -
    OptionDescription
    -oTarget directory for HTML report files. Subdirectories -will be created as needed to represent separate "runs" of the analyzer. If this -option is not specified, a directory is created in /tmp to store the -reports.
    -h
    (or no arguments)    		Display all -scan-build options.
    -k
    --keep-going    		Add a "keep on -going" option to the specified build command.

    This option currently supports -make and xcodebuild.

    This is a convenience option; one -can specify this behavior directly using build options.

    -vVerbose output from scan-build and the analyzer. A -second and third "-v" increases verbosity, and is useful for filing bug -reports against the analyzer.
    -VView analysis results in a web browser when the build -command completes.
    --use-analyzer Xcode
    or
    ---use-analyzer [path to clang]    		scan-build uses the -'clang' executable relative to itself for static analysis. One can override this -behavior with this option by using the 'clang' packaged with Xcode (on OS X) or -from the PATH.

    - -

    A complete list of options can be obtained by running scan-build -with no arguments.

    - -

    Output of scan-build

    - -

    -The output of scan-build is a set of HTML files, each one which represents a -separate bug report. A single index.html file is generated for -surveying all of the bugs. You can then just open index.html in a web -browser to view the bug reports. -

    - -

    -Where the HTML files are generated is specified with a -o option to -scan-build. If -o isn't specified, a directory in /tmp -is created to store the files (scan-build will print a message telling -you where they are). If you want to view the reports immediately after the build -completes, pass -V to scan-build. -

    - - -

    Recommended Usage Guidelines

    - -

    This section describes a few recommendations with running the analyzer.

    - - - -

    Most projects can be built in a "debug" mode that enables assertions. -Assertions are picked up by the static analyzer to prune infeasible paths, which -in some cases can greatly reduce the number of false positives (bogus error -reports) emitted by the tool.

    - -

    Another option is to use --force-analyze-debug-code flag of -scan-build tool which would enable assertions automatically.

    - -

    Use verbose output when debugging scan-build

    - -

    scan-build takes a -v option to emit verbose output about -what it's doing; two -v options emit more information. Redirecting the -output of scan-build to a text file (make sure to redirect standard -error) is useful for filing bug reports against scan-build or the -analyzer, as we can see the exact options (and files) passed to the analyzer. -For more comprehensible logs, don't perform a parallel build.

    - - - -

    If an analyzed project uses an autoconf generated configure script, -you will probably need to run configure script through -scan-build in order to analyze the project.

    - -

    Example

    - -
    -$ scan-build ./configure
-$ scan-build --keep-cc make
-
    - -

    The reason configure also needs to be run through -scan-build is because scan-build scans your source files by -interposing on the compiler. This interposition is currently done by -scan-build temporarily setting the environment variable CC to -ccc-analyzer. The program ccc-analyzer acts like a fake -compiler, forwarding its command line arguments over to the compiler to perform -regular compilation and clang to perform static analysis.

    - -

    Running configure typically generates makefiles that have hardwired -paths to the compiler, and by running configure through -scan-build that path is set to ccc-analyzer.

    - - - -

    Analyzing iPhone Projects

    - -

    Conceptually Xcode projects for iPhone applications are nearly the same as -their cousins for desktop applications. scan-build can analyze these -projects as well, but users often encounter problems with just building their -iPhone projects from the command line because there are a few extra preparative -steps they need to take (e.g., setup code signing).

    - -

    Recommendation: use "Build and Analyze"

    - -

    The absolute easiest way to analyze iPhone projects is to use the -Analyze -feature in Xcode (which is based on the Clang Static Analyzer). There a -user can analyze their project right from a menu without most of the setup -described later.

    - -

    Instructions are available on this -website on how to use open source builds of the analyzer as a replacement for -the one bundled with Xcode.

    - -

    Using scan-build directly

    - -

    If you wish to use scan-build with your iPhone project, keep the -following things in mind:

    - -
      -
    • Analyze your project in the Debug configuration, either by setting -this as your configuration with Xcode or by passing -configuration -Debug to xcodebuild.
      • -
    • Analyze your project using the Simulator as your base SDK. It is -possible to analyze your code when targeting the device, but this is much -easier to do when using Xcode's Build and Analyze feature.
      • -
    • Check that your code signing SDK is set to the simulator SDK as well, and make sure this option is set to Don't Code Sign.
      • -
    - -

    Note that you can most of this without actually modifying your project. For -example, if your application targets iPhoneOS 2.2, you could run -scan-build in the following manner from the command line:

    - -
    -$ scan-build xcodebuild -configuration Debug -sdk iphonesimulator2.2
-
    - -Alternatively, if your application targets iPhoneOS 3.0: - -
    -$ scan-build xcodebuild -configuration Debug -sdk iphonesimulator3.0
-
    - -

    Gotcha: using the right compiler

    - -

    Recall that scan-build analyzes your project by using a compiler to -compile the project and clang to analyze your project. The script uses -simple heuristics to determine which compiler should be used (it defaults to -clang on Darwin and gcc on other platforms). When analyzing -iPhone projects, scan-build may pick the wrong compiler than the one -Xcode would use to build your project. For example, this could be because -multiple versions of a compiler may be installed on your system, especially if -you are developing for the iPhone.

    - -

    When compiling your application to run on the simulator, it is important that scan-build -finds the correct version of gcc/clang. Otherwise, you may see strange build -errors that only happen when you run scan-build. - -

    scan-build provides the --use-cc and --use-c++ -options to hardwire which compiler scan-build should use for building your code. -Note that although you are chiefly interested in analyzing your project, keep in -mind that running the analyzer is intimately tied to the build, and not being -able to compile your code means it won't get fully analyzed (if at all).

    - -

    If you aren't certain which compiler Xcode uses to build your project, try -just running xcodebuild (without scan-build). You should see the -full path to the compiler that Xcode is using, and use that as an argument to ---use-cc.

    - -
    - + + - diff --git a/clang/www/analyzer/xcode.html b/clang/www/analyzer/xcode.html index d6e44bc4f0b390..2a76836669036f 100644 --- a/clang/www/analyzer/xcode.html +++ b/clang/www/analyzer/xcode.html @@ -2,7 +2,9 @@ "http://www.w3.org/TR/html4/strict.dtd"> - Running the analyzer within Xcode + The Xcode documentation has moved to clang.llvm.org + + @@ -13,131 +15,11 @@
    -

    Running the analyzer within Xcode

    +

    The Xcode documentation has moved to clang.llvm.org

    +

    This page is deprecated and will be removed in release 21.0

    +The new site + - - -
    - -

    What is it?

    - -

    Since Xcode 3.2, users have been able to run the Clang Static Analyzer -directly -within Xcode.

    - -

    It integrates directly with the Xcode build system and -presents analysis results directly within Xcode's editor.

    - -

    Can I use the open source analyzer builds with Xcode?

    - -

    Yes. Instructions are included below.

    - -    		 - analyzer in xcode -
    Viewing static analyzer results in Xcode -
    - -

    Key features:

    -
      -
    • Integrated workflow: Results are integrated within Xcode. There is - no experience of using a separate tool, and activating the analyzer requires a - single keystroke or mouse click.
      • -
    • Transparency: Works effortlessly with Xcode projects (including iPhone projects). -
    • Cons: Doesn't work well with non-Xcode projects. For those, - consider using scan-build. -
    - - -

    Getting Started

    - -

    Xcode is available as a free download from Apple on the Mac -App Store, with instructions -available for using the analyzer.

    - -

    Using open source analyzer builds with Xcode

    - -

    By default, Xcode uses the version of clang that came bundled with -it to analyze your code. It is possible to change Xcode's behavior to use an -alternate version of clang for this purpose while continuing to use -the clang that came with Xcode for compiling projects.

    - -

    Why try open source builds?

    - -

    The advantage of using open source analyzer builds (provided on this website) -is that they are often newer than the analyzer provided with Xcode, and thus can -contain bug fixes, new checks, or simply better analysis.

    - -

    On the other hand, new checks can be experimental, with results of variable -quality. Users are encouraged to file bug reports -(for any version of the analyzer) where they encounter false positives or other -issues.

    - -

    set-xcode-analyzer

    - -

    Starting with analyzer build checker-234, analyzer builds contain a command -line utility called set-xcode-analyzer that allows users to change what -copy of clang that Xcode uses for analysis:

    - -
    -$ set-xcode-analyzer -h
-Usage: set-xcode-analyzer [options]
-
-Options:
-  -h, --help            show this help message and exit
-  --use-checker-build=PATH
-                        Use the Clang located at the provided absolute path,
-                        e.g. /Users/foo/checker-1
-  --use-xcode-clang     Use the Clang bundled with Xcode
-
    - -

    Operationally, set-xcode-analyzer edits Xcode's configuration files -to point it to use the version of clang you specify for static -analysis. Within this model it provides you two basic modes:

    - -
      -
    • --use-xcode-clang: Switch Xcode (back) to using the clang that came bundled with it for static analysis.
      • -
    • --use-checker-build: Switch Xcode to using the clang provided by the specified analyzer build.
      • -
    - -

    Things to keep in mind

    - -
      -
    • You should quit Xcode prior to running set-xcode-analyzer.
    • You will need to run set-xcode-analyzer under -sudo in order to have write privileges to modify the Xcode -configuration files.
      • -
    - -

    Examples

    - -

    Example 1: Telling Xcode to use checker-235:

    - -
    -$ pwd
-/tmp
-$ tar xjf checker-235.tar.bz2
-$ sudo checker-235/set-xcode-analyzer --use-checker-build=/tmp/checker-235
-
    - -

    Note that you typically won't install an analyzer build in /tmp, but -the point of this example is that set-xcode-analyzer just wants a full -path to an untarred analyzer build.

    - -

    Example 2: Telling Xcode to use a very specific version of clang:

    - -
    -$ sudo set-xcode-analyzer --use-checker-build=~/mycrazyclangbuild/bin/clang
-
    - -

    Example 3: Resetting Xcode to its default behavior:

    - -
    -$ sudo set-xcode-analyzer --use-xcode-clang
-
    - -
    - + + -