Annotation Definitions Files
Intel® Advisor
- For C/C++, theadvisor-annotate.hheader file defines macros that begin withANNOTATE_, so you can use annotations such asANNOTATE_SITE_BEGIN();.
- For Fortran, theadvisor_annotatemodule declares subroutines starting withannotate_, so you cancallannotations such asannotate_site_begin().
- For C# on Windows* OS systems, theAdvisorAnnotateheader declares anAnnotateclass containing member routines, so you can use annotations such asAnnotate.SiteBegin();.C# and .NET support is deprecated startingIntel® Advisor2021.1.
Reference the Annotation Definitions from Your Source Files
Before you add
annotations into your source files, you need to reference the definitions for the
annotations:
Intel® Advisor
Intel® Advisor
- For C/C++, add:#include "advisor-annotate.h"or#include <advisor-annotate.h>(see ).
- For Fortran, add:use advisor_annotate
- For C#, add:using AdvisorAnnotate;(Windows OS systems only)
Where to Add USE Statements in Fortran Programs
Fortran does not have file scope declarations, so the
USE
statement needs to be inside the subroutine, function or main program where the annotation(s) appear. For example:
program F_example ! The main program does not contain annotations, do not add use advisor_annotate here! ! some code . . . ! subroutine F_sub ! This subroutine contains annotations, so add the use advisor_annotate statement use advisor_annotate ! some code . . . ! add Intel Advisor site and task annotations around compute intensive code ! For example, begin a parallel site: call annotate_site_begin(site1) ! end subroutine F_sub ! some code . . . end program F_example
If the call is in a module procedure, the
USE
statement can be at the module level. For more details about placing
USE
statements, see your Fortran compiler documentation.
Specify Build Settings
Specific build settings are needed for each language. Certain build settings are needed for each module that contains
annotations, such as specifying the directory where the annotations definitions are located. For C/C++ and Fortran applications, other build (compiler and linker) settings are needed for all modules in an application, such as full debug information. Read the Build Settings... topics by clicking the links below under See Also for your language.
Intel® Advisor
Redistribute the Annotations Definition File(s)
You only need annotations in your code when you are using the
Suitability and Dependencies tools to predict your serial program's parallel behavior. Before you distribute your application, you will typically replace these annotations when you add the parallel framework code. However, because the annotations do not change how your applications runs unless you use
tools, you can distribute your application with the annotations still present.
Intel® Advisor
Intel® Advisor
For information about redistributing the annotation definition files, see the installed End User License Agreement (
EULA.rtf
or
EULA.txt
) and the
redist.txt
file installed in the
Intel® Advisor
.../documentation/<locale>
directory.
Special Considerations for C/C++ Applications
With C/C++ programs:
- If your program encounters errors when you include theadvisor-annotate.hfile, see Handling Compilation Issues that Appear After Adding advisor-annotate.h (primarily for Windows systems).
- On Windows OS systems: If you do need to modify theadvisor-annotate.hfile, you can add a copy of it for a specific project or solution. If the version ofadvisor-annotate.hchanges, you will need to update your copies of the file. See .If you do not need to modify this file, you can reference the same installedadvisor-annotate.hfrom multiple projects or solutions as a read-only file. If you use theenvironment variable and the version ofIntel® AdvisorIntel® Advisoradvisor-annotate.hchanges, you only need to change this reference if the environment variable name changes, such as for a major version. Thus, using a read-only version can minimize future maintenance.
- On Linux* OS systems: Except in very rare circumstances, you can reference the same installedadvisor-annotate.hfrom multiple projects or solutions as a read-only file.
- Since the annotations do not change the values computed by your program, you can change the expansions of the macro, or suppress expansion altogether, as described in .