HP UX Web Development Tools manual Using Cadvise as a wrapper around Compiler or Linker

Page 12

The cadvise command has the following modes of operation:

•Analysis mode

Used to analyze and create the Program Database (PDB). To invoke cadvise in this mode, enter the cadvise command in the following format:

cadvise [cadvise-options] compile-cmd [compile-options]

•Report mode

Used to create reports. To invoke cadvise in this mode, enter the cadvise command in the following format:

cadvise report [report-options] [-pdb <pdb-name> logfile]

For information on PDB, see Using the Program Database (PDB) (page 19).

The cadvise command is used as a wrapper around the compiler or linker. The cadvise report option is used to generate reports.

2.4 Using Cadvise as a wrapper around Compiler or Linker

Cadvise is used with the HP C and HP aC++ compilers; GNU gcc and g++ compilers or HP-UX linker. The cadvise command is used as a wrapper around the compile and link command-line options (hereafter referred to as build line). The cadvise command and options are prefixed to the build line as command line arguments.

For example

The following command lines show how to invoke cadvise:

Regular command line: $ cc -c abc.c def.c

Cadvise command line: $ cadvise -pdb mypdb +wlint cc -c abc.c def.c

$ cadvise -pdb mypdb +wlint cc -c abc.c def.c

$ cadvise -pdb mypdb +wlint ld -r abc.o def.o -o abcdef.o

The cadvise command first executes the user's regular build line, and then analyzes the source code. Cadvise also analyzes the build line and automatically determines the include paths, defines, and language dialect needed for the source code analysis. The -nobuildoption allows you to skip the regular build process, and perform only the source code analysis.

The result of the cadvise analysis can be stored in a program database using the -pdboption. In this case, the PDB also stores the summary information used for cross-file analysis. For more information on PDB, see Using the Program Database (PDB) (page 19).

2.5 Integrating Cadvise with the makefiles and build process

Cadvise can be easily integrated with the makefiles and the build scripts. If a makefile variable is used to define the C and C++ compilers, you can redefine it to include the cadvise invocation.

Example 1 Updating the makefile to integrate cadvise

See the following makefile content:

CADVISE_OPTS= -pdb mypdb +wlint

CADVISE= /opt/cadvise/bin/cadvise

CC= $(CADVISE) $(CADVISE_OPTS) /opt/ansic/bin/cc

CXX= $(CADVISE) $(CADVISE_OPTS) /opt/aCC/bin/aCC

You may also define a wrapper script instead of the standard compiler commands. For example, see the following sample wrapper script:

12 Using Cadvise

Page 11 Page 13
Image 12
Page 11 Page 13
Contents HP Code Advisor C.02.20 User Guide Page Contents Contents Document conventions and symbols About this documentIntended audience Related informationHP encourages your comments Cadvise-help@lists.hp.comFeatures Cadvise user interface FeaturesIntroduction Cadvise user interfaceAdvanced static code analysis $ cadvise cc -c hello.cSupported compilers $ cadvise -pdb ./mypdb +wlint aCC hello.cppUsing Cadvise Steps in using cadviseSupported platforms Installing Cadvise Getting startedInvoking Cadvise Using Cadvise as a wrapper around Compiler or Linker For information on PDB, see Using the Program Database PDBSee the following makefile content Integrating Cadvise with the makefiles and build processEnabling different categories of diagnostic messages Generating code complexity metricsExample 2 Sample wrapper script Example 3 Generating code complexity metrics Objfile.metricsGenerating code complexity metrics Example 4 Code complexity metrics $ cat /tmp/example.c+wcodeguide=rules-library Source structure in the rules library Example 5 Writing a rule to enforce naming conventionUsing the Program Database PDB PDB options table Specifying the PDB locationDeleting PDB Disabling locks in PDB operationsCreating a PDB snapshot at a specified location Displaying PDB versionExample 8 Removing object file information from the PDB Example 9 Creating a PDB snapshotUsing cross-file analysis UsageCross-file analysis options Crossfile=auto Example 15 Specifying the location of object files Configuring diagnostic messages Diagnostic configuration options tableSuppressing warnings selectively Enabling warnings selectivelyInterpreting selective warnings as errors Disabling warnings in a macroManaging warnings in a source file Generating reports Report generation options tableCadvise report report-options -pdb pdbdir Cadvise report report-options logfileGenerating summary reports Generating file summary reportGenerating detailed report $cadvise report -summary -pdb testpdb -noheaderTo save reports, run the following command Generating Html reportExample 23 Generating detailed report $ cadvise report -pdb testpdb -allPrinting diagnostics with specific diagnostic numbers Following example shows the command to generate XML reportGenerating XML report Example 24 Generating an XML reportSuppressing diagnostics for specific files Generating reports based on severity$ cadvise report -pdb testpdb -diag Example 26 Generating reports based on severityReporting diagnostics from specific files Reporting program complexity metrics$ cadvise report -pdb test.pdb -summary -exclude inflate.c $ cadvise report -pdb test.pdb -summary -include inflate.cGenerating report for a module Example 29 Reporting program complexity metrics$ cadvise report -pdb gzip.pdb +metrics -include inflate.c Modifying the default severity level of a diagnostic Suppressing report headerGenerating PDB comparison report $ cadvise report -pdb test.pdb -summary -module test1Example 34 Generating detailed diff report with the header $ cadvise report -pdb tmp.pdb -basepdb tmp1.pdb -allExample 35 Generating diff report for any particular warning $ cadvise report -pdb tmp.pdb -basepdb tmp1.pdb -diag$ cadvise report -pdb tmp.pdb -basepdb tmp1.pdb -severity $ cadvise -pdb pdb1 cc one.c two.cReport options file $ cadvise report -pdb new.pdb -basepdb old.pdb -allExample 42 Generating a report using -migration option Generate report for migration related warningsGenerating consolidated report from multiple PDBs Example 41 Report options fileRecommended process for analyzing the diagnostic messages Generating PDB diffs with multiple PDBsReport options interoperability $ cadvise report -pdb 1.pdb2.pdb3.pdb4.pdb -allExample 44 Reporting options interoperability $ cadvise report -pdb test.pdb -diag 2549 -exclude b.cExample 45 Ignoring the -includeoption $ cadvise report -pdb test.pdb -summary -include a.cb.cExample 48 Using -noabort Miscellaneous driver optionsHelp-h-H Example 47 Displaying the list of cadvise optionsExample 49 Using -nobuild option Following command creates the file cadvdir/foo.cadExample 51 Using -tee option Following example shows the usage of -nobuildoptionExample 52 Using +opts filename option Line generates the following messagesCategories of diagnostics with examples Categories of diagnostics tableDetecting generic programming errors Categories of diagnostics with examples Example 53 Null pointer dereference check Such cases, cadvise generates the following warningExample 54 Potential memory leak check Such cases, cadvise generates the following warningsExample 55 Out of bound access Example 56 Out of scope accessSuch cases, cadvise generates the following error Example 57 Use of pointer after freeExample 58 Allocator/deallocator mismatch Detecting 32-bit to 64-bit migraton issues Detecting endianness migration issuesExample 60 Detecting 32-bit to 64-bit migraton issues Example 59 Signed bit field of lengthDetecting potential security vulnerabilities Example 61 Detecting endian dependent code fragmentsConsider the following code fragment Detecting multi-threaded programming issues This case, cadvise generates the following errorExample 63 Detecting multi-threaded programming issues Running cadvise generates the following errorDetecting potential performance improvement opportunities Detecting potential performance improvement opportunities Fixing the warnings by source change Incompatibilities on PA-RISC based systems AC++ standard conformance and compatibility changesSymbols Index
Top Page Image Contents