codecov(1) Intel(R) code coverage tool codecov(1) NAME codecov - Invokes the Intel(R) code coverage tool. SYNOPSIS codecov [options] where: · options represents zero or more tool options (listed below). DESCRIPTION The code coverage tool provides the ability to determine how much application code is executed when a specific workload is applied to the application. You must prepare the application code using specific options before you can use the code coverage tool. The code coverage tool is available on IA-32, Intel(R) 64, and IA-64 architectures on Linux*. The tool is available on IA-32 and Intel(R) 64 architectures on Mac OS* X. Note: The complete process of preparing the application for code cov- erage tool use is documented in the Optimizing Applications section of the Intel(R) Compiler Documentation. The major features of the Intel(R) code coverage tool are: · Visually presenting code coverage information for an application with a customizable code coverage coloring scheme. · Displaying dynamic execution counts of each basic block of the application. · Providing differential coverage, or comparison, profile data for two runs of an application. The tool analyzes static profile information generated by the com- piler, as well as dynamic profile information generated by running an instrumented form of the application binaries on the workload. The tool can generate a report in HTML-format and export data in both text- and XML-formatted files. The reports can be further customized to show color-coded, annotated source-code listings that distinguish between used and unused code. OPTIONS -bcolor Sets the HTML color name or code of the uncovered blocks. By default, uncovered blocks are colored yellow (#ffff99). -beginblkdsbl Specifies the C-styled comment that marks the beginning of the code fragment to be ignored by the coverage tool. Multiple such options may be specified. -ccolor Sets the HTML color name or code of the covered code. By default, covered code is colored white (#ffffff). -comp Sets the name of the file that contains the list of files being covered. There is no default component filename. -counts Generates dynamic execution counts. Execution counts are not generated by default. -demang Demangles both argument types of C++ functions and their names. C++ function arguments are not demangled by default on Win- dows*. -dpi Sets the pathname of the dynamic profile information file (.dpi). Default is pgopti.dpi. -endblkdsbl Specifies the C-styled comment that marks the end of the code fragment to be ignored by the coverage tool. Multiple such options may be specified. -fcolor Sets the HTML color name or code of the uncovered functions. By default, uncovered functions are colored hot pink (#ffcccc). -help, -h Prints all the options of the code coverage tool. -icolor Sets the HTML color name or code of the information lines such as basic-block markers and dynamic counts (#ffffff). -maddr
Sets the email address of the web-page owner. Default email address of the web-page owner is nobody. -mname Sets the name of the web-page owner. For two-word names (e.g., Your Name), enter Your_Name. Default web-page owner name is Nobody. -nopartial Treats partially covered code as fully covered code. By default, they are not treated the same. -nopmeter Turns off the progress meter. The meter is on by default. -onelinedsbl Specifies the C-styled comment that marks individual lines of code or the whole functions to be ignored by the coverage tool. Multiple such options may be specified. -pcolor Sets the HTML color name or code of the partially covered code. By default, partially covered code is colored light brown (#fafad2). -prj Sets the project name. There is no default project name. -ref Finds the differential coverage with respect to ref_dpi_file. Differential coverage is not computed by default. -spi Sets the pathname of the static profile information file (.spi). Default is pgopti.spi. -txtbcvrg Exports block coverage for covered functions in text format. The file parameter must be a valid filename. -txtbcvrgfull Exports block coverage for the entire application in text and HTML formats. The file parameter must be a valid filename. -txtdcg Generates the dynamic call-graph information in text format. The file parameter must be a valid filename. -txtfcvrg Exports function coverage for the covered function in text for- mat. The file parameter must be a valid filename. -ucolor Sets the HTML color name or code of the unknown code. By default, unknown code is colored white (#ffffff). -xcolor Sets the HTML color name or code of the not feasible code. By default, not feasible code is colored light green (#90ee90). Option has effect only if markers for not feasible code are specified. -xmlbcvrg Exports block coverage for the covered function in XML format. -xmlbcvrgfull Exports function coverage for the entire application in HTML and XML formats. The file parameter must be a valid filename. -xmlfcvrg Exports function coverage for the covered function in XML for- mat. The file parameter must be a valid filename. EXAMPLES 1) codecov Runs the code coverage tool using all the default settings. Only an HTML file will be generated. 2) codecov -xmlbcvrg blockcov.xml -beginblkdsbl "Begin" -end- blkdsbl "End" Creates an XML block-coverage report. The report will not contain corresponding coverage information. 3) codecov -xmlbcvrgfull blockcov.xml -beginblkdsbl "Begin" -endblkdsbl "End" -ccolor green -bcolor red -xcolor light- green Creates an XML full block-coverage report and an HTML file with customized colors. Corresponding coverage information will not appear in the report, but it will be marked in the HTML file. INSTRUCTIONS ON USING THE CODE COVERAGE TOOL To run the tool: 1) Create the instrumented binary and corresponding static profile information file (.spi) by compiling with -prof- genx. 2) Run the instrumented application. The dynamic profile information file (.dyn) will be created automatically. 3) Merge the dynamic profile information into one file (.dpi) by using the profmerge tool. 4) Run the code coverage tool using the options and syntax listed (above). SEE ALSO Refer to the Using Profile-guided Optimization (PGO) section of Opti- mizing Applications in the Intel(R) Compiler Documentation for detailed information about using this tool. COPYRIGHT INFORMATION INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL(R) PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN INTEL’S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITY WHATSOEVER, AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. UNLESS OTHERWISE AGREED IN WRITING BY INTEL, THE INTEL PRODUCTS ARE NOT DESIGNED NOR INTENDED FOR ANY APPLICATION IN WHICH THE FAILURE OF THE INTEL PRODUCT COULD CREATE A SITUATION WHERE PERSONAL INJURY OR DEATH MAY OCCUR. Intel may make changes to specifications and product descriptions at any time, without notice. Designers must not rely on the absence or characteristics of any features or instructions marked "reserved" or "undefined." Intel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities aris- ing from future changes to them. The information here is subject to change without notice. Do not finalize a design with this information. The products described in this document may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request. Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order. Copies of documents which have an order number and are referenced in this document, or other Intel literature, may be obtained by calling 1-800-548-4725, or by visiting Intel’s Web Site. Intel processor numbers are not a measure of performance. Processor numbers differentiate features within each processor family, not across different processor families. See http://www.intel.com/prod- ucts/processor_number for details. BunnyPeople, Celeron, Celeron Inside, Centrino, Centrino logo, Core Inside, FlashFile, i960, InstantIP, Intel, Intel logo, Intel386, Intel486, Intel740, IntelDX2, IntelDX4, IntelSX2, Intel Core, Intel Inside, Intel Inside logo, Intel. Leap ahead., Intel. Leap ahead. logo, Intel NetBurst, Intel NetMerge, Intel NetStructure, Intel Sin- gleDriver, Intel SpeedStep, Intel StrataFlash, Intel Viiv, Intel vPro, Intel XScale, IPLink, Itanium, Itanium Inside, MCS, MMX, Oplus, Over- Drive, PDCharm, Pentium, Pentium Inside, skoool, Sound Mark, The Jour- ney Inside, VTune, Xeon, and Xeon Inside are trademarks of Intel Cor- poration in the U.S. and other countries. * Other names and brands may be claimed as the property of others. Copyright (C) 2005 - 2007, Intel Corporation. All rights reserved. Copyright(C) 2005-2007 Intel Corporation codecov(1)