Difference between revisions of "STRIDE Runtime"

From STRIDE Wiki
Jump to: navigation, search
 
(76 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== Overview  ==
+
__NOTOC__
 
 
 
The STRIDE Runtime routes messages both within and between platform boundaries and manages the conversion of interface data as it crosses from one platform to another. This "transparent messaging" model means that your test cases can be located on one platform (e.g., as a script running off-target) and your code on another (on-target).  
 
The STRIDE Runtime routes messages both within and between platform boundaries and manages the conversion of interface data as it crosses from one platform to another. This "transparent messaging" model means that your test cases can be located on one platform (e.g., as a script running off-target) and your code on another (on-target).  
  
The STRIDE Runtime is a combination of processes and libraries that provide services for messaging, remote function calls, and tracing while providing seamless connectivity between the target application and the host operating system. The STRIDE Runtime standardizes how threads and applications communicate with each other, independent of the platform on which they are executing, which eliminates the need to integrate new software on the target hardware. Developers can then incrementally integrate embedded software on a combination of the desktop environment and the target hardware, providing more control over integration and testing. New software functionality under development can be simulated on the desktop environment while the software using this new functionality can run on the target hardware. The tremendous flexibility gained by allowing developers to choose how to integrate different software components and target platforms allows developers to detect integration and testing issues and correct defects much earlier in the development process.  
+
The STRIDE Runtime is a combination of processes and libraries that provide services for messaging, remote function calls, and tracing while providing seamless connectivity between the target application and the host operating system. The STRIDE Runtime standardizes how threads and applications communicate with each other, independent of the platform on which they are executing, which eliminates the need to integrate new software on the target hardware. Developers can then incrementally integrate embedded software on a combination of the desktop environment and the target hardware, providing more control over integration and testing. New software functionality under development can be simulated on the desktop environment while the software using this new functionality can run on the target hardware. This flexibility allows developers to choose how to integrate different software components and target platforms allows developers to detect integration and testing issues and correct defects much earlier in the development process.  
 
 
<br>
 
 
 
[[Image:Runtime Overview.jpg|center|Overview of the STRIDE Runtime]]
 
 
 
The Runtime components consist of the Runtime APIs, the Runtime Thread, the PAL, the Transport Layer, and the Intercept Module. Each is briefly described here, with links provided for more detail.
 
 
 
<br>
 
 
 
== The Platform Abstraction Layer<br>  ==
 
 
 
The&nbsp;Platform Abstraction Layer, or PAL, defines the set of OS functionality required by the platform to support the STRIDE Runtime. The “pal.h” header file provided with the STRIDE installation defines the PAL functionality. The PAL also defines functionality required by the STRIDE Runtime to transmit and receive packets of data (called I-blocks) using the platform’s transport mechanism. These PAL routines enable the STRIDE Runtime to be installed on diverse environments without changing its internal design.<br>
 
 
 
Click [[http://www.s2technologies.com/pdf/s2sPAL.pdf here]] to view the STRIDE Platform Abstraction Layer (PAL) Specification PDF document.
 
 
 
<br>
 
 
 
== The Host Transport Services  ==
 
  
The Host Transport Services define an interface that enables the STRIDE Runtime on your target to send data to and receive data from the target. The STRIDE Transport Server connects the Transport DLL to the STRIDE Runtime running on the host platform, thus providing indirect access to the target from STRIDE Studio, Autoscript, and other STRIDE applications. Several common transports are already supported within the STRIDE Transport Server, including serial and TCP/IP.
+
[[Image:Runtime Overview.jpg|600px|center|Overview of the STRIDE Runtime]]
  
[[Image:Transport diagram.gif|center|Host Transport Services Diagram]]
+
Other related components:
  
The Host Transport Services are defined in "transport.h" and each Transport DLL must implement the interfaces derived from the IStrideTransport class.  
+
* The [[Platform_Abstraction_Layer | '''PAL (Platform Abstraction Layer)''']] - provides a consistent interface for the STRIDE Runtime regardless of the operating system or data transport used. It consists of a small set of functions that provide a virtual link between the target operating system and the STRIDE Runtime. The PAL functionality, defined in the ''pal.h'' header file, allows the STRIDE Runtime to transmit and receive packets of data (called I-blocks) using the platform’s transport mechanism.
  
Click [[http://www.s2technologies.com/pdf/s2sTransport.pdf here]] to view the STRIDE Host Runtime Transport Specification PDF document.  
+
* The [[Intercept_Module | '''Intercept Module''']] - is auot-generated harnessing code that facilitates remote function calls between the host and target.
  
== The Intercept Module  ==
 
  
Follow [[Intercept Module|this link]] for an overview of the Intercept Module concept.<br>
+
Refer to the [[Media:s2sRuntime.pdf|STRIDE Runtime Developer's Guide]] for more details.  
  
[[Name Mangling|This link]] provides more background on the use of name mangling when implementing delegates within an Intercept Module.
+
= Runtime Configuration =
 +
You can configure the STRIDE Runtime by editing '''srcfg.h''' to achieve specific real-time performance objectives. By tailoring the RAM requirements, real-time performance, and traffic across the host-target transport, you can meet your own unique needs. Use the following STRIDE Runtime configuration parameters:
 +
* Total number of STRIDE Transaction Identifiers (STIDs) that may be active simultaneously
 +
* Total number of simultaneous broadcast message subscribers
 +
* Total number of embedded pointers in your interfaces
 +
* Total number of unique interfaces
 +
* Total memory allocated for tracing
 +
* Size of an individual trace buffer
 +
* Frequency that trace buffers are transmitted from target to host
 +
* Remote Function Call settings
 +
* Enabling and configuring Memory Management settings
 +
* Enabling Multi-Process Target settings
 +
* Enabling Variable Arguments
 +
* Timestamp unit
  
<br>
+
The default configuration is generally adequate for most uses, however the configuration may need to be adjusted as more sophisticated tests are developed with more numerous or complex interfaces.
  
== The Runtime Developer's Guide  ==
+
= Runtime Test Services (RTS) =
  
Click [[http://www.s2technologies.com/pdf/s2sRuntime.pdf here]] to view the STRIDE Runtime Developer's Guide PDF document.  
+
The Runtime Test Services (RTS) are a set of APIs implemented using the STRIDE Runtime that facilitate the writing of target based test code. These APIs are considered an optional extension on top of the STRIDE Runtime and can be used to communicate additional information about tests to the host based reporting mechanism. They also allow target test code to create additional test suites and test cases dynamically at runtime.  
  
<br>
+
Please refer to the '''''srtest.h''''' header file and '''[[Runtime Test Services]]''' article for more information on these APIs.
  
== Public Services<br>  ==
+
= Logging Services =
  
<br>
+
The following are the categories available in the Runtime API for logging, that is, collecting and/or displaying, information at the host runtime environment:
  
=== Runtime Test Services (RTS)<br>  ===
+
*'''Setup and Shutdown'''  
 
+
**'''srCreateSTID()''': used to allocate resources required to send and receive trace and print messages that implement the following APIs.  
<br>The Runtime Test Services (RTS) are a set of C-based APIs in the STRIDE Runtime that facilitate the writing of target based test code. These APIs make up an optional portion of the STRIDE Runtime and can be used to communicate additional information about tests to the host based reporting mechanism. These APIs also allow target test code to create additional test suites and test cases dynamically at runtime.<br>These C-based APIs work equally well from '''C Test Functions''' and '''C++ Test Classes'''. If, however, you choose to derive your C++ test classes from the '''STRIDE Runtime Base Class (srTest)''', then you will have access to member objects in the srTest class and its methods that provide the same functionality as the C APIs.<br>
 
 
 
==== <br>C Test Functions<br>  ====
 
 
 
C test functions enable testing of C code similarily to xUnit-style testing. Test functions can be written by users, captured using the scl_function pragma, and executed from the host. C-based Runtime Test Services APIs are available for use in test functions.<br>
 
 
 
==== <br>C++ Test Classes<br>  ====
 
 
 
C++ test classes enable testing of C++ code similarily to xUnit-style testing. Test classes can be written by users, captured using scl_test_class, scl_test_setup and scl_test_teardown pragmas, and executed from the host. C-based Runtime Test Services APIs as well as C++ Runtime Base Class are available for use in test classes.<br>
 
 
 
==== <br>C-based Runtime Test Services APIs provided:<br>  ====
 
 
 
*'''srTestSuiteAddSuite''': creates an additional sub-suite at runtime.
 
*'''srTestSuiteSetName''': sets the name of the specified suite.
 
*'''srTestSuiteSetDescription''': sets the description of the specified suite.
 
*'''srTestSuiteAddTest''': creates an additional test case at runtime.
 
*'''srTestCaseSetName''': sets the name of the specified test case.
 
*'''srTestCaseSetDescription''': sets the description of the specified test case.
 
*'''srTestCaseAddComment''': adds a comment to the specified test case.
 
*'''srTestCaseSetStatus''': explicitly sets the status for the specified test case.
 
*'''srTestCaseSetStatusEx''': explicitly sets the status for the specified test case and allows specification of an extended failure code.
 
 
 
==== <br>Member objects of srTest base class, which provides the same functionality:<br>  ====
 
 
 
*'''testSuite '''member object provides following methods:
 
**'''AddSuite''': creates an additional sub-suite at runtime.
 
**'''SetName''': sets the name of the specified suite.
 
**'''SetDescription''': sets the description of the specified suite.
 
**'''AddTest''': creates an additional test case at runtime.
 
 
 
*'''testCase '''member object provides following methods:
 
**'''SetName'''<span style="font-weight: bold;"></span>: sets the name of the specified test case.
 
**'''SetDescription''': sets the description of the specified test case.
 
**'''AddComment''': adds a comment to the specified test case.
 
**'''SetStatus''': explicitly sets the status for the specified test case.
 
 
 
<br> These services use the '''''srtest.h''''' header file. Please refer to Chapter 4 of the [[http://www.s2technologies.com/pdf/s2sRuntime.pdf Runtime Developer's Guide]] for more information on these APIs.<br>
 
 
 
=== Logging Services  ===
 
 
 
The following are the categories available in the Runtime API for logging events:
 
 
 
*Setup and Shutdown
 
**'''srCreateSTID()''': used to allocate resources required to send and receive trace and print messages that implement the following APIs.
 
 
**'''srDeleteSTID()''': used to free STRIDE Runtime resources previously allocated for an STID.
 
**'''srDeleteSTID()''': used to free STRIDE Runtime resources previously allocated for an STID.
  
*Tracing - Tracing routines are used by target applications for information collection and display by the host runtime environment.
+
*'''Tracing''' - Tracing routines are used by target applications for information collection and display by the host runtime environment.  
**'''srTracePoint()''': used to output a data structure to the tracing window on the host.
+
**'''srTracePoint()''': used to output a data structure to the tracing window on the host.  
 
**'''srTraceStr()''': used to output a string to the tracing window.
 
**'''srTraceStr()''': used to output a string to the tracing window.
  
*Printing - The following printing routines are used by applications to display messages on Trace Views on the host.  
+
*'''Printing''' - These routines are used by applications to log or display messages on Trace Views on the host.  
**'''srPrintInfo()''': used to output a formatted string with variable arguments to be displayed at information level filtering.
+
**'''srPrintInfo()''': used to output a formatted string with variable arguments to be displayed at information level filtering.  
 
**'''srPrintError()''': used to output a formatted string with variable arguments to be displayed at error level filtering.
 
**'''srPrintError()''': used to output a formatted string with variable arguments to be displayed at error level filtering.
 +
*'''Messaging''' - These routines can be used to send and receive messages for logging or any other debugging purposes.
 +
**'''srBroadcast()''': used to “broadcast” information to one or more subscribers. Each subscriber receives its own copy of the message or pointer, depending on the attributes of the payload. If there are multiple subscribers on a remote platform only one copy of the response is transmitted across the link. If there are no subscribers then the routine simply returns.
 +
**'''srSubscribe()''': used to subscribe to a Broadcast message sent using srBroadcast. There has to be at least one subscriber for a broadcast message to be sent.
  
<br> These services use the '''''sr.h''''' header file. Please refer to Chapter 3 of the [[http://www.s2technologies.com/pdf/s2sRuntime.pdf Runtime Developer's Guide]] for more information on these APIs.<br>
 
 
== The Windows Off-Target SDK  ==
 
 
<br>
 
 
== The Transport Server Object Model  ==
 
  
The Transport Server is an out-of-process COM server that provides connection management, loopback and diagnostic features. It can be accessed by clients through the STRIDE.transport Program ID. The Transport Server API is defined in the [[Transport Server Component|Transport Server Object Model]] page.
+
These services are defined in '''''sr.h''''' header file.

Latest revision as of 09:13, 4 July 2015

The STRIDE Runtime routes messages both within and between platform boundaries and manages the conversion of interface data as it crosses from one platform to another. This "transparent messaging" model means that your test cases can be located on one platform (e.g., as a script running off-target) and your code on another (on-target).

The STRIDE Runtime is a combination of processes and libraries that provide services for messaging, remote function calls, and tracing while providing seamless connectivity between the target application and the host operating system. The STRIDE Runtime standardizes how threads and applications communicate with each other, independent of the platform on which they are executing, which eliminates the need to integrate new software on the target hardware. Developers can then incrementally integrate embedded software on a combination of the desktop environment and the target hardware, providing more control over integration and testing. New software functionality under development can be simulated on the desktop environment while the software using this new functionality can run on the target hardware. This flexibility allows developers to choose how to integrate different software components and target platforms allows developers to detect integration and testing issues and correct defects much earlier in the development process.

Overview of the STRIDE Runtime

Other related components:

  • The PAL (Platform Abstraction Layer) - provides a consistent interface for the STRIDE Runtime regardless of the operating system or data transport used. It consists of a small set of functions that provide a virtual link between the target operating system and the STRIDE Runtime. The PAL functionality, defined in the pal.h header file, allows the STRIDE Runtime to transmit and receive packets of data (called I-blocks) using the platform’s transport mechanism.
  • The Intercept Module - is auot-generated harnessing code that facilitates remote function calls between the host and target.


Refer to the STRIDE Runtime Developer's Guide for more details.

Runtime Configuration

You can configure the STRIDE Runtime by editing srcfg.h to achieve specific real-time performance objectives. By tailoring the RAM requirements, real-time performance, and traffic across the host-target transport, you can meet your own unique needs. Use the following STRIDE Runtime configuration parameters:

  • Total number of STRIDE Transaction Identifiers (STIDs) that may be active simultaneously
  • Total number of simultaneous broadcast message subscribers
  • Total number of embedded pointers in your interfaces
  • Total number of unique interfaces
  • Total memory allocated for tracing
  • Size of an individual trace buffer
  • Frequency that trace buffers are transmitted from target to host
  • Remote Function Call settings
  • Enabling and configuring Memory Management settings
  • Enabling Multi-Process Target settings
  • Enabling Variable Arguments
  • Timestamp unit

The default configuration is generally adequate for most uses, however the configuration may need to be adjusted as more sophisticated tests are developed with more numerous or complex interfaces.

Runtime Test Services (RTS)

The Runtime Test Services (RTS) are a set of APIs implemented using the STRIDE Runtime that facilitate the writing of target based test code. These APIs are considered an optional extension on top of the STRIDE Runtime and can be used to communicate additional information about tests to the host based reporting mechanism. They also allow target test code to create additional test suites and test cases dynamically at runtime.

Please refer to the srtest.h header file and Runtime Test Services article for more information on these APIs.

Logging Services

The following are the categories available in the Runtime API for logging, that is, collecting and/or displaying, information at the host runtime environment:

  • Setup and Shutdown
    • srCreateSTID(): used to allocate resources required to send and receive trace and print messages that implement the following APIs.
    • srDeleteSTID(): used to free STRIDE Runtime resources previously allocated for an STID.
  • Tracing - Tracing routines are used by target applications for information collection and display by the host runtime environment.
    • srTracePoint(): used to output a data structure to the tracing window on the host.
    • srTraceStr(): used to output a string to the tracing window.
  • Printing - These routines are used by applications to log or display messages on Trace Views on the host.
    • srPrintInfo(): used to output a formatted string with variable arguments to be displayed at information level filtering.
    • srPrintError(): used to output a formatted string with variable arguments to be displayed at error level filtering.
  • Messaging - These routines can be used to send and receive messages for logging or any other debugging purposes.
    • srBroadcast(): used to “broadcast” information to one or more subscribers. Each subscriber receives its own copy of the message or pointer, depending on the attributes of the payload. If there are multiple subscribers on a remote platform only one copy of the response is transmitted across the link. If there are no subscribers then the routine simply returns.
    • srSubscribe(): used to subscribe to a Broadcast message sent using srBroadcast. There has to be at least one subscriber for a broadcast message to be sent.


These services are defined in sr.h header file.