Scl function: Difference between revisions

From STRIDE Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 12: Line 12:


=== Syntax ===
=== Syntax ===
The ''scl_function'' pragma allows the user to capture a function. When captured for the purpose of interception (in which case the term '''intercept-able''' is used throughout the documentation) optional arguments allow specification of how the intercept should be executed. The [[s2sinstrument|Instrument Build Tool]] will use those options to generate appropriate function interception code.
The ''scl_function'' pragma allows the user to capture a function. When captured for the purpose of interception ('''intercept-able''') the optional arguments are used to specify how the intercept should be executed. The [[s2sinstrument|Instrument Build Tool]] will use those options to generate appropriate function interception code.


  #pragma scl_function(function-name [,context, name-mangling, group-id])
  #pragma scl_function(function-name [,context, name-mangling, group-id])
Line 28: Line 28:
| ''context''
| ''context''
| String
| String
| Optional. Context in which the function is going to be intercepted. Possible values are ''"REFERENCE"'' - intercept at the function call (aka user) or ''"DEFINITION"'' - intercept at the function definition (aka owner).
| Optional. Context in which the function is going to be intercepted. Possible values are ''"REFERENCE"'' - intercept at the function call (i.e. where the function is called) or ''"DEFINITION"'' - intercept at the function definition (i.e. where the function is implemented).
|-
|-
| ''name-mangling''
| ''name-mangling''
| String
| String
| Optional. Type of [[Name_Mangling|name mangling]] to be used when intercepted. Possible values are ''"EXPLICIT"'' or ''"IMPLICIT"''.  
| Optional. Type of [[Name_Mangling|name mangling]] to be used when intercepted. Possible values are ''"EXPLICIT"'' or ''"IMPLICIT"''. If the ''context'' argument is defined the default will be '''IMPLICIT'''. Note that if '''EXPLICIT''' is set the '''srTEST_INTERCEPT(<function_name>)"''' macro is required.  
|-
|-
| ''group-id''
| ''group-id''
| String
| String
| Optional. User defined identifier representing the group to which this function belongs when solving name mangling conflicts.  
| Optional. User defined identifier representing the group to which this function belongs when enabling interception. The default ''group-id'' is set to '''STRIDE_TEST_GROUP'''.  
|}
|}


=== Notes ===
=== Notes ===
* The function must be declared as a designator with external linkage.  
* The function must be declared as a designator with external linkage.  
* A compilation error is reported if an attempt is made to capture a function more than once (with either [[scl_func]] or scl_function).
* A compilation error is reported if an attempt is made to capture a function more than once.
 
=== Examples ===
Using the defaults for ''IMPLICIT'' and ''STRIDE_TEST_GROUP''
<source lang=c>
void boo(void);
 
#pragma scl_function(boo, "DEFINITION")
</source>
 
 
Setting a specific ''GROUP ID''
<source lang=c>
void boo(void);
 
#pragma scl_function(boo, "DEFINITION", ''IMPLICIT'', ''MY_TEST_GROUP'')
</source>

Revision as of 16:18, 2 July 2015

The SCL function pragma allows capturing a global function for doubling or remoting. During the build process the Stride Compiler generates IM source code that provides the correct logic for the test.

int foo(int x); 

void boo(void);

#pragma scl_function(foo)
#pragma scl_function(boo, "DEFINITION", "IMPLICIT", "TEST_GROUP")

Syntax

The scl_function pragma allows the user to capture a function. When captured for the purpose of interception (intercept-able) the optional arguments are used to specify how the intercept should be executed. The Instrument Build Tool will use those options to generate appropriate function interception code.

#pragma scl_function(function-name [,context, name-mangling, group-id])


Parameters Type Description
function-name Identifier Name of the function to capture.
context String Optional. Context in which the function is going to be intercepted. Possible values are "REFERENCE" - intercept at the function call (i.e. where the function is called) or "DEFINITION" - intercept at the function definition (i.e. where the function is implemented).
name-mangling String Optional. Type of name mangling to be used when intercepted. Possible values are "EXPLICIT" or "IMPLICIT". If the context argument is defined the default will be IMPLICIT. Note that if EXPLICIT is set the srTEST_INTERCEPT(<function_name>)" macro is required.
group-id String Optional. User defined identifier representing the group to which this function belongs when enabling interception. The default group-id is set to STRIDE_TEST_GROUP.

Notes

  • The function must be declared as a designator with external linkage.
  • A compilation error is reported if an attempt is made to capture a function more than once.

Examples

Using the defaults for IMPLICIT and STRIDE_TEST_GROUP

void boo(void);

#pragma scl_function(boo, "DEFINITION")


Setting a specific GROUP ID

void boo(void);

#pragma scl_function(boo, "DEFINITION", ''IMPLICIT'', ''MY_TEST_GROUP'')