Annotation Definitions Files
- 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
- For Fortran, add:use advisor_annotate
- For C#, add:using AdvisorAnnotate;(Windows OS systems only)
Where to Add USE Statements in Fortran Programs
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
Specify Build Settings
Redistribute the Annotations Definition File(s)
Special Considerations for C/C++ Applications
- 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 .